@instantdb/core/__tests__/src/store.test.ts

Instant's core local abstraction

import { test, expect } from 'vitest';
import zenecaAttrs from './data/zeneca/attrs.json';
import zenecaTriples from './data/zeneca/triples.json';
import {
  createStore,
  allMapValues,
  toJSON,
  fromJSON,
  transact,
  AttrsStoreClass,
  getAttrByFwdIdentName,
  Store,
  AttrsStore,
  attrsStoreFromJSON,
} from '../../src/store';
import query from '../../src/instaql';
import uuid from '../../src/utils/id';
import { tx } from '../../src/instatx';
import * as instaml from '../../src/instaml';
import * as datalog from '../../src/datalog';
import * as instatx from '../../src/instatx';
import { i, id } from '../../src';
import { createLinkIndex } from '../../src/utils/linkIndex';

const zenecaAttrsStore = new AttrsStoreClass(
  zenecaAttrs.reduce((res, x) => {
    res[x.id] = x;
    return res;
  }, {}),
  null,
);

const store = createStore(
  zenecaAttrsStore,
  zenecaTriples as [string, string, any, number][],
);

function checkIndexIntegrity({
  store,
  attrsStore,
}: {
  store: Store;
  attrsStore: AttrsStore;
}) {
  const tripleSort = (a, b) => {
    const [e_a, aid_a, v_a, t_a] = a;
    const [e_b, aid_b, v_b, t_b] = b;

    const e_compare = e_a.localeCompare(e_b);
    if (e_compare !== 0) {
      return e_compare;
    }
    const a_compare = aid_a.localeCompare(aid_b);
    if (a_compare !== 0) {
      return a_compare;
    }
    const v_compare = JSON.stringify(v_a).localeCompare(JSON.stringify(v_b));
    if (v_compare !== 0) {
      return v_compare;
    }
    return t_a - t_b;
  };
  const eavTriples = allMapValues(store.eav, 3).sort(tripleSort);
  const aevTriples = allMapValues(store.aev, 3).sort(tripleSort);
  const vaeTriples = allMapValues(store.vae, 3);

  // Check eav and aev have all the same triples
  for (let i = 0; i < eavTriples.length; i++) {
    const et = eavTriples[i];
    const at = aevTriples[i];
    expect(et).toEqual(at);
  }
  expect(eavTriples.length).toEqual(aevTriples.length);

  // Check vae doesn't have extra triples
  for (const triple of vaeTriples) {
    const [e, a, v] = triple;
    expect(store.eav.get(e)?.get(a)?.get(v)).toEqual(triple);
  }

  // Check vae has all of the triples it should have
  for (const triple of eavTriples) {
    const [e, a, v] = triple;
    const attr = attrsStore.getAttr(a)!;
    if (attr['value-type'] === 'ref') {
      expect(store.vae.get(v)?.get(a)?.get(e)).toEqual(triple);
    }
  }
}

test('simple add', () => {
  const id = uuid();
  const chunk = tx.users[id].update({ handle: 'bobby' });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, chunk);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  expect(query(newCtx, { users: {} }).data.users.map((x) => x.handle)).contains(
    'bobby',
  );

  checkIndexIntegrity(newCtx);
});

test('cardinality-one add', () => {
  const id = uuid();
  const chunk = tx.users[id]
    .update({ handle: 'bobby' })
    .update({ handle: 'bob' });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, chunk);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  const ret = datalog
    .query(newCtx.store, {
      find: ['?v'],
      where: [[id, '?attr', '?v']],
    })
    .flatMap((vec) => vec[0]);
  expect(ret).contains('bob');
  expect(ret).not.contains('bobby');
  checkIndexIntegrity(newCtx);
});

test('link/unlink', () => {
  const bookshelfId = uuid();
  const userId = uuid();
  const userChunk = tx.users[userId]
    .update({ handle: 'bobby' })
    .link({ bookshelves: bookshelfId });
  const bookshelfChunk = tx.bookshelves[bookshelfId].update({
    name: 'my books',
  });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    userChunk,
    bookshelfChunk,
  ]);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  expect(
    query(newCtx, {
      users: {
        $: { where: { handle: 'bobby' } },
        bookshelves: {},
      },
    }).data.users.map((x) => [x.handle, x.bookshelves.map((x) => x.name)]),
  ).toEqual([['bobby', ['my books']]]);
  checkIndexIntegrity(newCtx);

  const secondBookshelfId = uuid();
  const secondBookshelfChunk = tx.bookshelves[secondBookshelfId].update({
    name: 'my second books',
  });
  const unlinkFirstChunk = tx.users[userId]
    .unlink({
      bookshelves: bookshelfId,
    })
    .link({ bookshelves: secondBookshelfId });
  const secondTxSteps = instaml.transform({ attrsStore: newCtx.attrsStore }, [
    unlinkFirstChunk,
    secondBookshelfChunk,
  ]);
  const secondCtx = transact(newCtx.store, newCtx.attrsStore, secondTxSteps);
  expect(
    query(secondCtx, {
      users: {
        $: { where: { handle: 'bobby' } },
        bookshelves: {},
      },
    }).data.users.map((x) => [x.handle, x.bookshelves.map((x) => x.name)]),
  ).toEqual([['bobby', ['my second books']]]);
  checkIndexIntegrity(secondCtx);
});

test('link/unlink multi', () => {
  const bookshelfId1 = uuid();
  const bookshelfId2 = uuid();
  const userId = uuid();
  const userChunk = tx.users[userId]
    .update({ handle: 'bobby' })
    .link({ bookshelves: [bookshelfId1, bookshelfId2] });

  const bookshelf1Chunk = tx.bookshelves[bookshelfId1].update({
    name: 'my books 1',
  });
  const bookshelf2Chunk = tx.bookshelves[bookshelfId2].update({
    name: 'my books 2',
  });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    userChunk,
    bookshelf1Chunk,
    bookshelf2Chunk,
  ]);

  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  expect(
    query(newCtx, {
      users: {
        $: { where: { handle: 'bobby' } },
        bookshelves: {},
      },
    }).data.users.map((x) => [x.handle, x.bookshelves.map((x) => x.name)]),
  ).toEqual([['bobby', ['my books 1', 'my books 2']]]);
  checkIndexIntegrity(newCtx);

  const bookshelfId3 = uuid();
  const bookshelf3Chunk = tx.bookshelves[bookshelfId3].update({
    name: 'my books 3',
  });
  const unlinkChunk = tx.users[userId]
    .unlink({
      bookshelves: [bookshelfId1, bookshelfId2],
    })
    .link({ bookshelves: bookshelfId3 });
  const secondTxSteps = instaml.transform({ attrsStore: newCtx.attrsStore }, [
    unlinkChunk,
    bookshelf3Chunk,
  ]);
  const secondCtx = transact(newCtx.store, newCtx.attrsStore, secondTxSteps);
  expect(
    query(secondCtx, {
      users: {
        $: { where: { handle: 'bobby' } },
        bookshelves: {},
      },
    }).data.users.map((x) => [x.handle, x.bookshelves.map((x) => x.name)]),
  ).toEqual([['bobby', ['my books 3']]]);
  checkIndexIntegrity(secondCtx);
});

test('link/unlink without update', () => {
  const bookshelfId = uuid();
  const userId = uuid();
  const userChunk = tx.users[userId].update({ handle: 'bobby' });
  const bookshelfChunk = tx.bookshelves[bookshelfId].update({
    name: 'my books',
  });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    userChunk,
    bookshelfChunk,
  ]);
  const ctx2 = transact(store, zenecaAttrsStore, txSteps);

  const linkChunk = tx.users[userId].link({ bookshelves: bookshelfId });
  const ctx3 = transact(
    ctx2.store,
    ctx2.attrsStore,
    instaml.transform(ctx2, [linkChunk]),
  );

  expect(
    query(ctx3, {
      users: {
        $: { where: { handle: 'bobby' } },
        bookshelves: {},
      },
    }).data.users.map((x) => [x.handle, x.bookshelves.map((x) => x.name)]),
  ).toEqual([['bobby', ['my books']]]);
  checkIndexIntegrity(ctx3);
});

test('delete entity', () => {
  const bookshelfId = uuid();
  const userId = uuid();
  const userChunk = tx.users[userId]
    .update({ handle: 'bobby' })
    .link({ bookshelves: bookshelfId });
  const bookshelfChunk = tx.bookshelves[bookshelfId].update({
    name: 'my books',
  });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    userChunk,
    bookshelfChunk,
  ]);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  checkIndexIntegrity(newCtx);

  const retOne = datalog
    .query(newCtx.store, {
      find: ['?v'],
      where: [[bookshelfId, '?attr', '?v']],
    })
    .flatMap((vec) => vec[0]);
  const retTwo = datalog
    .query(newCtx.store, {
      find: ['?v'],
      where: [['?v', '?attr', bookshelfId]],
    })
    .flatMap((vec) => vec[0]);
  expect(retOne).contains('my books');
  expect(retTwo).contains(userId);

  const txStepsTwo = instaml.transform(
    newCtx,
    tx.bookshelves[bookshelfId].delete(),
  );
  const newCtxTwo = transact(newCtx.store, newCtx.attrsStore, txStepsTwo);
  const retThree = datalog
    .query(newCtxTwo.store, {
      find: ['?v'],
      where: [[bookshelfId, '?attr', '?v']],
    })
    .flatMap((vec) => vec[0]);
  const retFour = datalog
    .query(newCtxTwo.store, {
      find: ['?v'],
      where: [['?v', '?attr', bookshelfId]],
    })
    .flatMap((vec) => vec[0]);

  expect(retThree).toEqual([]);
  expect(retFour).toEqual([]);
  checkIndexIntegrity(newCtxTwo);
});

test('on-delete cascade', () => {
  const book1 = uuid();
  const book2 = uuid();
  const book3 = uuid();
  const chunk1 = tx.books[book1].update({
    title: 'book1',
    description: 'series',
  });
  const chunk2 = tx.books[book2]
    .update({ title: 'book2', description: 'series' })
    .link({ prequel: book1 });
  const chunk3 = tx.books[book3]
    .update({ title: 'book3', description: 'series' })
    .link({ prequel: book2 });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    chunk1,
    chunk2,
    chunk3,
  ]);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  checkIndexIntegrity(newCtx);
  expect(
    query(newCtx, {
      books: { $: { where: { description: 'series' } } },
    }).data.books.map((x) => x.title),
  ).toEqual(['book1', 'book2', 'book3']);

  const txStepsTwo = instaml.transform(newCtx, tx.books[book1].delete());
  const newCtxTwo = transact(newCtx.store, newCtx.attrsStore, txStepsTwo);
  expect(
    query(newCtxTwo, {
      books: { $: { where: { description: 'series' } } },
    }).data.books.map((x) => x.title),
  ).toEqual([]);
});

test('on-delete-reverse cascade', () => {
  const book1 = uuid();
  const book2 = uuid();
  const book3 = uuid();

  const chunk2 = tx.books[book2].update({
    title: 'book2',
    description: 'series',
  });
  const chunk3 = tx.books[book3].update({
    title: 'book3',
    description: 'series',
  });
  const chunk1 = tx.books[book1]
    .update({
      title: 'book1',
      description: 'series',
    })
    .link({ next: [book2, book3] });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    chunk2,
    chunk3,
    chunk1,
  ]);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  checkIndexIntegrity(newCtx);
  expect(
    query(newCtx, {
      books: { $: { where: { description: 'series' } } },
    }).data.books.map((x) => x.title),
  ).toEqual(['book2', 'book3', 'book1']);

  const txStepsTwo = instaml.transform(newCtx, tx.books[book1].delete());
  const newCtxTwo = transact(newCtx.store, newCtx.attrsStore, txStepsTwo);
  expect(
    query(newCtxTwo, {
      books: { $: { where: { description: 'series' } } },
    }).data.books.map((x) => x.title),
  ).toEqual([]);
});

test('new attrs', () => {
  const colorId = uuid();
  const userId = uuid();
  const userChunk = tx.users[userId]
    .update({ handle: 'bobby' })
    .link({ colors: colorId });
  const colorChunk = tx.colors[colorId].update({ name: 'red' });
  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, [
    userChunk,
    colorChunk,
  ]);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  expect(
    query(newCtx, {
      users: {
        $: { where: { handle: 'bobby' } },
        colors: {},
      },
    }).data.users.map((x) => [x.handle, x.colors.map((x) => x.name)]),
  ).toEqual([['bobby', ['red']]]);

  checkIndexIntegrity(newCtx);
});

test('delete attr', () => {
  expect(
    query(
      { store, attrsStore: zenecaAttrsStore },
      { users: {} },
    ).data.users.map((x) => [x.handle, x.fullName]),
  ).toEqual([
    ['joe', 'Joe Averbukh'],
    ['alex', 'Alex'],
    ['stopa', 'Stepan Parunashvili'],
    ['nicolegf', 'Nicole'],
  ]);
  const fullNameAttr = getAttrByFwdIdentName(
    zenecaAttrsStore,
    'users',
    'fullName',
  );
  const newCtx = transact(store, zenecaAttrsStore, [
    ['delete-attr', fullNameAttr!.id],
  ]);
  expect(
    query(newCtx, { users: {} }).data.users.map((x) => [x.handle, x.fullName]),
  ).toEqual([
    ['joe', undefined],
    ['alex', undefined],
    ['stopa', undefined],
    ['nicolegf', undefined],
  ]);

  checkIndexIntegrity(newCtx);
});

test('update attr', () => {
  expect(
    query(
      { store, attrsStore: zenecaAttrsStore },
      { users: {} },
    ).data.users.map((x) => [x.handle, x.fullName]),
  ).toEqual([
    ['joe', 'Joe Averbukh'],
    ['alex', 'Alex'],
    ['stopa', 'Stepan Parunashvili'],
    ['nicolegf', 'Nicole'],
  ]);
  const fullNameAttr = getAttrByFwdIdentName(
    zenecaAttrsStore,
    'users',
    'fullName',
  );
  const fwdIdent = fullNameAttr!['forward-identity'];
  const newCtx = transact(store, zenecaAttrsStore, [
    [
      'update-attr',
      {
        id: fullNameAttr!.id,
        'forward-identity': [fwdIdent[0], 'users', 'fullNamez'],
      },
    ],
  ]);
  expect(
    query(newCtx, { users: {} }).data.users.map((x) => [x.handle, x.fullNamez]),
  ).toEqual([
    ['joe', 'Joe Averbukh'],
    ['alex', 'Alex'],
    ['stopa', 'Stepan Parunashvili'],
    ['nicolegf', 'Nicole'],
  ]);
});

test('JSON serialization round-trips', () => {
  const newStore = fromJSON(zenecaAttrsStore, toJSON(store));
  expect(store).toEqual(newStore);
});

test('ruleParams no-ops', () => {
  const id = uuid();
  const chunk = tx.users[id]
    .ruleParams({ guestId: 'bobby' })
    .update({ handle: 'bobby' });

  const txSteps = instaml.transform({ attrsStore: zenecaAttrsStore }, chunk);
  const newCtx = transact(store, zenecaAttrsStore, txSteps);
  expect(query(newCtx, { users: {} }).data.users.map((x) => x.handle)).contains(
    'bobby',
  );

  checkIndexIntegrity(newCtx);
});

test('deepMerge', () => {
  const gameId = uuid();
  const gameCtx = transact(
    store,
    zenecaAttrsStore,
    instaml.transform(
      { attrsStore: zenecaAttrsStore },
      tx.games[gameId].update({
        state: {
          score: 100,
          playerStats: { health: 50, mana: 30, ambitions: { win: true } },
          inventory: ['sword', 'potion'],
          locations: ['forest', 'castle'],
          level: 2,
        },
      }),
    ),
  );

  checkIndexIntegrity(gameCtx);

  const updatedCtx = transact(
    gameCtx.store,
    gameCtx.attrsStore,
    instaml.transform(
      gameCtx,
      tx.games[gameId].merge({
        state: {
          // Objects update deeply
          playerStats: {
            mana: 40,
            stamina: 20,
            ambitions: { acquireWisdom: true, find: ['love'] },
          },
          // arrays overwrite
          inventory: ['shield'],
          // null removes the key
          score: null,
          // undefined is ignored
          level: undefined,
          // undefined is kept in arrays
          locations: ['forest', undefined, 'castle'],
        },
      }),
    ),
  );

  const updatedGame = query(updatedCtx, {
    games: { $: { where: { id: gameId } } },
  }).data.games[0];
  expect(updatedGame.state).toEqual({
    playerStats: {
      health: 50,
      mana: 40,
      stamina: 20,
      ambitions: { win: true, acquireWisdom: true, find: ['love'] },
    },
    level: 2,
    inventory: ['shield'],
    locations: ['forest', undefined, 'castle'],
  });
  checkIndexIntegrity(updatedCtx);
});

test('recursive links w same id', () => {
  const schema = i.schema({
    entities: {
      $files: i.entity({
        path: i.string().unique().indexed(),
        url: i.string(),
      }),
      fakeUsers: i.entity({
        email: i.string().unique().indexed().optional(),
      }),
      todos: i.entity({
        completed: i.boolean().optional(),
        title: i.string().optional(),
      }),
    },
    links: {
      todosCreatedBy: {
        forward: {
          on: 'todos',
          has: 'one',
          label: 'createdBy',
          onDelete: 'cascade',
        },
        reverse: {
          on: 'fakeUsers',
          has: 'many',
          label: 'todos',
        },
      },
    },
  });
  const sameId = id();
  const ops = [
    instatx.tx.todos[sameId].update({
      title: 'todo',
      completed: false,
    }),
    instatx.tx.fakeUsers[sameId].update({
      email: 'test@test.com',
    }),
    instatx.tx.todos[sameId].link({
      createdBy: sameId,
    }),
  ];

  const attrsStore = new AttrsStoreClass({}, createLinkIndex(schema));
  const steps = instaml.transform({ attrsStore, schema }, ops);
  const store = createStore(attrsStore, [], true, !!schema);
  const newCtx = transact(store, attrsStore, steps);

  const result = query(newCtx, {
    todos: {},
    fakeUsers: {},
  });

  expect(result.data.todos.length).toBe(1);
  expect(result.data.fakeUsers.length).toBe(1);

  const removeOp = [instatx.tx.todos[sameId].delete()];

  const removeSteps = instaml.transform(newCtx, removeOp);
  const postRemoveCtx = transact(newCtx.store, newCtx.attrsStore, removeSteps);

  const removeResult = query(postRemoveCtx, {
    todos: {},
    fakeUsers: {},
  });

  expect(removeResult.data.todos.length).toBe(0);
  expect(removeResult.data.fakeUsers.length).toBe(1);
});

test('date conversion', () => {
  expect(() => {
    const schema = i.schema({
      entities: {
        todos: i.entity({
          completed: i.boolean().optional(),
          createdAt: i.date().optional(),
          title: i.string().optional(),
        }),
      },
    });
    const sameId = id();
    const ops = [
      instatx.tx.todos[sameId].update({
        title: 'todo',
        completed: false,
        createdAt: new Date(),
      }),
    ];

    const attrsStore = new AttrsStoreClass({}, null);
    const steps = instaml.transform({ attrsStore, schema }, ops);
    const store = createStore(attrsStore, [], true, true);
    const newCtx = transact(store, attrsStore, steps);

    const result = query(newCtx, {
      todos: {},
    });

    expect(result.data.todos.length).toBe(1);
    expect(result.data.todos[0].createdAt).toBeInstanceOf(Date);
  }).not.toThrow();

  expect(() => {
    const schema = i.schema({
      entities: {
        todos: i.entity({
          completed: i.boolean().optional(),
          createdAt: i.date().optional(),
          title: i.string().optional(),
        }),
      },
    });
    const sameId = id();
    const ops = [
      instatx.tx.todos[sameId].update({
        title: 'todo',
        completed: false,
        createdAt: 99999999999999,
      }),
    ];

    const attrsStore = new AttrsStoreClass({}, null);
    const steps = instaml.transform({ attrsStore, schema }, ops);
    const store = createStore(attrsStore, [], true, false);
    const newCtx = transact(store, attrsStore, steps);

    const result = query(newCtx, {
      todos: {},
    });

    expect(result.data.todos.length).toBe(1);
    expect(result.data.todos[0].createdAt).toBeTypeOf('number');
  }).not.toThrow();
});

test('v0 store restores', () => {
  function toJSONOld(store) {
    return {
      __type: store.__type,
      attrs: store.attrs,
      triples: allMapValues(store.eav, 3),
      cardinalityInference: store.cardinalityInference,
      linkIndex: store.linkIndex,
      useDateObjects: store.useDateObjects,
    };
  }
  const v0Json = toJSONOld({ ...store, attrs: zenecaAttrsStore.attrs });
  const attrsStore = attrsStoreFromJSON(null, v0Json);
  const restored = fromJSON(attrsStore!, v0Json);
  expect(restored).toEqual(store);
});