Function stubNoteTest

packages/engine-test-utils/src/noteStore.common.ts:276–340

(
  noteStoreFactory: (
    wsRoot: string,
    vaults: DVault[],
    engine: DEngineClient
  ) => Promise<INoteStore<string>>
)

}

function stubNoteTest(
  noteStoreFactory: (
    wsRoot: string,
    vaults: DVault[],
    engine: DEngineClient
  ) => Promise<INoteStore<string>>
) {
  test("WHEN writing a stub note, THEN get and getMetadata should retrieve same note", async () => {
    await runEngineTestV5(
      async ({ vaults, wsRoot, engine }) => {
        const vault = vaults[0];

        const noteStore = await noteStoreFactory(wsRoot, vaults, engine);
        const newNote = await NoteTestUtilsV4.createNote({
          fname: "foobar",
          body: "",
          vault,
          wsRoot,
          stub: true,
        });

        let note = await noteStore.get(newNote.id);
        expect(note.data).toBeFalsy();
        await noteStore.write({ key: newNote.id, note: newNote });

        // Make sure note is not written to filesystem
        const vpath = vault2Path({ vault, wsRoot });
        expect(_.includes(fs.readdirSync(vpath), "foobar.md")).toBeFalsy();

        // Test NoteStore.get
        note = await noteStore.get(newNote.id);
        expect(note.data!.fname).toEqual(newNote.fname);
        expect(note.data!.body.trim()).toEqual(newNote.body.trim());
        expect(note.data!.contentHash).toBeTruthy();

        // Test NoteStore.getMetadata
        const noteMetadata = await noteStore.getMetadata(newNote.id);
        expect(noteMetadata.data!.fname).toEqual(newNote.fname);

        // Test NoteStore.findMetadata
        let findResp = await noteStore.findMetaData({ fname: "foobar" });
        expect(findResp.data![0].fname).toEqual(newNote.fname);

        // Test NoteStore.findMetadata excludeStub = true
        findResp = await noteStore.findMetaData({
          fname: "foobar",
          excludeStub: true,
        });
        expect(findResp.data!.length).toEqual(0);

        // Test NoteStore.findMetadata excludeStub = false
        findResp = await noteStore.findMetaData({
          excludeStub: false,
        });

        expect(
          findResp.data!.map((meta) => meta.fname).includes(newNote.fname)
        ).toBeTruthy();