Assert registry directory is subset, not deep equal #519
Conversation
| const expectedStat = await stat(expectedFile); | ||
| const actualStat = await stat(actualFile); | ||
| assert.strictEqual(expectedStat.isDirectory(), actualStat.isDirectory()); | ||
| if (expectedStat.isDirectory()) { | ||
| await assertDirectoriesEqual(expectedFile, actualFile, options); | ||
| await assertDirectoryIsSubset(expectedFile, actualFile, options); | ||
| } else { | ||
| assert.strictEqual(await readFile(actualFile), await readFile(expectedFile)); |
There was a problem hiding this comment.
This is still asserting that the file contents are exactly equal. The set of files that exist in types-registry doesn't change, but the content of index.json does.
There was a problem hiding this comment.
So is the right fix just to add "index.json" to validate's ignore function?
There was a problem hiding this comment.
Or should I change the function to read specific (JSON) files and pass them on to another function, which then makes a subset assertion about JSON instead of file structure?
There was a problem hiding this comment.
assertDirectoriesEqual is a red herring because index.json is the only really important file in types-registry. Though we do want to assert that no extra files somehow made there way there and the package.json isn't corrupted somehow.
We should assert that the published index.json doesn't contain anything it shouldn't, so its contents should be a subset of what a fully up-to-date index.json would contain.
It might also be nice to assert that the published index.json does contain everything it should, which means every package more than a week old. But that's less important to fix right now.
There was a problem hiding this comment.
Since types-registry only contains package.json, index.json, and README.md, having a recursive assertDirectoriesEqual utility may be overkill.
Fixes #518