Issues using snapshots with expect.it() in a nested structure

[alexjeffburke]

I had a case where I tried to check that a function was called with an object that contained a key whose value was a snapshotted string, so I used one of the "satisfying" assertions in -sinon. The following is a simplified reproduction case:

const expect = require("unexpected")
  .clone()
  .use(require("unexpected-snapshot"));

const makeSomeStuff = () => "foo bar baz\nbaz bar foo";

it("should work", () => {
  expect(
    [
      {
        stuff: makeSomeStuff()
      }
    ],
    "to satisfy",
    [
      {
        stuff: expect.it("to equal snapshot")
      }
    ]
  );
});

Running mocha on the above in snapshot update mode as-is, I receive the following TypeError:

     TypeError: Cannot read property 'replace' of undefined
      at fixUnexpected (node_modules/unexpected-snapshot/lib/applyFixes.js:87:62)
      at Traverser.enter [as _enter] (node_modules/unexpected-snapshot/lib/applyFixes.js:209:26)

If I force the insertion point by modifying the expect.it to read expect.it('to equal snapshot', '') it gets further, but the injection of the snapshot removes the nested spec structure on the RHS and instead injects at the top level resulting in:

it("should work", () => {
  expect(
    [
      {
        stuff: makeSomeStuff()
      }
    ],
    "to satisfy",
    expect.unindent`
      foo bar baz
      baz bar foo
    `
  );
});

[papandreou]

unexpected-snapshot does not support expect.it at the moment. It'll be rather tricky, so we decided to leave it out initially. Would be nice if it failed a bit more gracefully, though.

[papandreou]

I added a nicer warning in 1.0.2.

[alexjeffburke]

@papandreou I confess that I wasn't aware this wasn't intended to work per se, and choosing to show a clear message in this case is a really good shout - keep the user informed etc.

I'll try the change in situ so I get some perspective on encountering it in person but otherwise I think we can say this is addressed. And we can already revisit if/when we tackle it.