Snapshot failing even though nothing changed

[rodoabad]

  {
    "businessContactSelected": false,
    "machineConfigHasChanged": false,
    "machineHeaderHasChanged": false,
    "cancellable": false,
    "editable": false,
    "selected": false,
    "machineSelected": false,
    "isFeatured": false,
    "isBranch": false,
    "failedApplySelections": false,
    "invalidConfiguration": false,
    "purchaseOrderNumber": "",
    "sapOrderNumber": "",
    "isIsgAgreementAccepted": false,
    "isBranchStock": false,
    "isAttachment": false,
    "referenceComment": "",
    "linkType": "",
    "featured": false,
    "branch": false,
    "branchStock": false
  }
]

Missing content at line 21:
  ["    "branch": false,"]

Extra content at line 23:
  ["    "branch": false,"]

How is this possible that test is failing?

[rodoabad]

Another run (this time in CI).

  {
    "businessContactSelected": false,
    "machineConfigHasChanged": false,
    "machineHeaderHasChanged": false,
    "cancellable": false,
    "editable": false,
    "selected": false,
    "machineSelected": false,
    "isFeatured": false,
    "isBranch": false,
    "failedApplySelections": false,
    "invalidConfiguration": false,
    "purchaseOrderNumber": "",
    "sapOrderNumber": "",
    "isIsgAgreementAccepted": false,
    "isBranchStock": false,
    "isAttachment": false,
    "referenceComment": "",
    "linkType": "",
    "branch": false,
    "featured": false,
    "branchStock": false
  }
]

Missing content at line 21:
  ["    "featured": false,"]

Extra content at line 23:
  ["    "featured": false,"]

[rodoabad]

How can the order change?

[grimsa]

@rodoabad How is this JSON produced? There might be a difference in iteration order somewhere.

I've seen similar issues when we were doing something like this:

toJson(
  Map.of(
    key1, value1,
    key2, value2
  )
);

Turns out Map.of entry iteration order is undefined and it varies between JVM versions/implementations.
Same could probably be true for hash-based collections.

[rodoabad]

@grimsa basically...

expect(new Foo())toMatchSnapshot();

[rodoabad]

Might be a good idea to sort alphabetically before saving the snapshot.