Volland · Volland · Dec 17, 2023 · Dec 17, 2023 · Dec 17, 2023 · Dec 17, 2023
diff --git a/benchmarks/message-store-benchmark-runner.ts b/benchmarks/message-store-benchmark-runner.ts
@@ -0,0 +1,32 @@
+import { CozoClosableAdapter } from '../src/adapters/cozo-closable-adapter.js';
+import { MessageStoreCozo } from '../src/message-store-cozo.js';
+import { runMessageStoreBenchmark } from './message-store-benchmark.js';
+
+import { MessageStoreLevel } from '@tbd54566975/dwn-sdk-js/dist/esm/src/store/message-store-level.js';
+
+const rocksdb = new CozoClosableAdapter('rocksdb', './rocksdb');
+const results = {};
+
+const rocksMessageStore = new MessageStoreCozo(rocksdb);
+const rocksResults = await runMessageStoreBenchmark(rocksMessageStore);
+results['rocksdb'] = rocksResults;
+const mem = new CozoClosableAdapter('mem');
+const memMessageStore = new MessageStoreCozo(mem);
+const memResults = await runMessageStoreBenchmark(memMessageStore);
+results['mem'] = memResults;
+const sqliteCozo = new CozoClosableAdapter('sqlite', './test.db');
+const sqliteMessageStore = new MessageStoreCozo(sqliteCozo);
+const sqliteResults = await runMessageStoreBenchmark(sqliteMessageStore);
+results['sqlite'] = sqliteResults;
+
+const messageStore = new MessageStoreLevel({
+  blockstoreLocation : 'BENCHMARK-BLOCK',
+  indexLocation      : 'BENCHMARK-INDEX',
+});
+const levelResults = await runMessageStoreBenchmark(messageStore);
+results['level'] = levelResults;
+
+console.log(JSON.stringify(results, null, 2));
+
+
+
diff --git a/benchmarks/message-store-benchmark.ts b/benchmarks/message-store-benchmark.ts
@@ -0,0 +1,294 @@
+
+import { GenericMessage, MessageStore, SortDirection } from '@tbd54566975/dwn-sdk-js';
+import  { TestDataGenerator } from '@tbd54566975/dwn-sdk-js/dist/esm/tests/utils/test-data-generator.js';
+import  { Time } from '@tbd54566975/dwn-sdk-js/dist/esm/src/utils/time.js';
+
+interface BenchMarkResults {
+  create: number;
+  clearBefore: number;
+  put: number;
+  paginationSmallSubset: number;
+  paginationSmallSubsetDesc: number;
+  paginationLargeSubset: number;
+  paginationNonOwner: number;
+  paginationDescNonOwner: number;
+  querySmallSetEqual: number;
+  queryRange: number;
+  queryEqual: number;
+  queryMultipleEqual: number;
+  queryGTRange: number;
+  queryLTRange: number;
+  queryMultipleRange: number;
+  clearAfter: number;
+}
+
+export const runMessageStoreBenchmark = async (messageStore: MessageStore , items: number = 10_000): Promise<BenchMarkResults> => {
+  const tenant = 'did:xyz:alice';
+  const benchMarkResults:BenchMarkResults = {
+    create                    : 0,
+    clearBefore               : 0,
+    put                       : 0,
+    paginationSmallSubset     : 0,
+    paginationSmallSubsetDesc : 0,
+    paginationLargeSubset     : 0,
+    paginationNonOwner        : 0,
+    paginationDescNonOwner    : 0,
+    querySmallSetEqual        : 0,
+    queryRange                : 0,
+    queryEqual                : 0,
+    queryMultipleEqual        : 0,
+    queryGTRange              : 0,
+    queryLTRange              : 0,
+    queryMultipleRange        : 0,
+    clearAfter                : 0
+  };
+  console.log('message store benchmarks');
+
+  // pre-generate messages
+  const insertMessages = Array(items).fill(0).map((_,i) => {
+  // random schema from 1-5
+    const schemaId = Math.floor(Math.random() * 5) + 1;
+    const schema = `schema${schemaId}`;
+
+    //random protocol from 1-10
+    const protocolId = Math.floor(Math.random() * 9);
+    const protocol = `proto${protocolId}`;
+
+    const bobId = i % 25;
+    const recipient = `bob${bobId + 1}`;
+    const author = i % 50 === 0 ? 'bob1' : 'alice';
+    const published = i % 100 === 0 ? true : false;
+
+    let year;
+    const mod = i % 3;
+    switch (mod) {
+    case 0:
+      year = 2022;
+      break;
+    case 1:
+      year = 2023;
+      break;
+    default:
+      year = 2024;
+    }
+
+    const messageTimestamp = TestDataGenerator.randomTimestamp({ year });
+    const dateCreated = TestDataGenerator.randomTimestamp({ year });
+    const message = {
+      descriptor: {
+        interface : 'Records',
+        method    : 'Write',
+        messageTimestamp
+      }
+    };
+    const indexes = {
+      ...message.descriptor,
+      schema,
+      protocol,
+      dateCreated,
+      recipient,
+      author,
+      published,
+    };
+    return { message, indexes };
+  });
+
+  // create
+  const createStart = Date.now();
+  await messageStore.open();
+  const createEnd = Date.now();
+  benchMarkResults.create = createEnd - createStart;
+  console.log('\tcreate\t\t\t\t:', createEnd - createStart, 'ms');
+
+  // clear - before
+
+  const clearBeforeStart = Date.now();
+  await messageStore.clear();
+  const clearBeforeEnd = Date.now();
+  console.log('\tclear - before\t\t\t:', clearBeforeEnd - clearBeforeStart, 'ms');
+  benchMarkResults.clearBefore = clearBeforeEnd - clearBeforeStart;
+
+  // put
+  const putStart = Date.now();
+  await Promise.all(insertMessages.map(({ message, indexes }) => messageStore.put(tenant, message, indexes)));
+  const putEnd = Date.now();
+  console.log('\tput\t\t\t\t:', putEnd - putStart, 'ms');
+  benchMarkResults.put = putEnd - putStart;
+
+  const firstDayOf2024 = Time.createTimestamp({ year: 2024, month: 1, day: 1 });
+
+  // advanced query
+  const ascOrder = { messageTimestamp: SortDirection.Ascending };
+  const descOrder = { messageTimestamp: SortDirection.Descending };
+
+  // paginate 10 pages of 20 results for a specific schema
+  // note: published: true is a smaller subset so will perform better if index optimizes for equality filter
+  let page = 0;
+  let cursor:string | undefined = undefined;
+  let messages:GenericMessage[] = [];
+  let results:GenericMessage[] = [];
+  const paginationStart = Date.now();
+  while (page < 10) {
+    page++;
+    ({ messages, cursor } = await messageStore.query(tenant, [
+      { published: true, schema: 'schema2', protocol: 'proto6' }
+    ], ascOrder, { limit: 20, cursor } ));
+    results.push(...messages);
+    if (cursor === undefined) {
+      break;
+    }
+  }
+  const paginationEnd = Date.now();
+  console.log('\tpagination small subset\t\t:', paginationEnd - paginationStart, 'ms', 'results ', results.length);
+  benchMarkResults.paginationSmallSubset = paginationEnd - paginationStart;
+
+  // descending order
+  results = [];
+  page = 0;
+  cursor = undefined;
+  const paginationDescStart = Date.now();
+  while (page < 10) {
+    page++;
+    ({ messages, cursor } = await messageStore.query(tenant, [
+      { published: true, schema: 'schema2', protocol: 'proto6' }
+    ], descOrder, { limit: 20, cursor } ));
+    results.push(...messages);
+    if (cursor === undefined) {
+      break;
+    }
+  }
+  const paginationDescEnd = Date.now();
+  console.log('\tpagination small subset des\t:', paginationDescEnd - paginationDescStart, 'ms', ' results', results.length);
+  benchMarkResults.paginationSmallSubsetDesc = paginationDescEnd - paginationDescStart;
+
+  // filter for a larger result set.
+  results = [];
+  page = 0;
+  cursor = undefined;
+  const paginationLargeStart = Date.now();
+  while (page < 10) {
+    page++;
+    ({ messages, cursor } = await messageStore.query(tenant, [
+      { published: true, schema: 'schema2', protocol: 'proto6' },
+      { published: false, schema: 'schema2', protocol: 'proto6' }
+    ], ascOrder, { limit: 20, cursor } ));
+    results.push(...messages);
+    if (cursor === undefined) {
+      break;
+    }
+  }
+  const paginationLargeEnd = Date.now();
+  console.log('\tpagination large subset\t\t:', paginationLargeEnd - paginationLargeStart, 'ms', ' results', results.length);
+  benchMarkResults.paginationLargeSubset = paginationLargeEnd - paginationLargeStart;
+
+  // ascending multiple filters. similar to non-owner query
+  results = [];
+  page = 0;
+  cursor = undefined;
+  const paginationNonOwnerStart = Date.now();
+  while (page < 10) {
+    page++;
+    ({ messages, cursor } = await messageStore.query(tenant, [
+      { schema: 'schema2', published: false, author: 'bob1', protocol: 'proto6' },
+      { schema: 'schema2', published: true, protocol: 'proto6' },
+      { schema: 'schema2', published: false, recipient: 'bob1', protocol: 'proto6' },
+    ], ascOrder, { limit: 20, cursor } ));
+    results.push(...messages);
+    if (cursor === undefined) {
+      break;
+    }
+  }
+  const paginationNonOwnerEnd = Date.now();
+  console.log('\tpagination non owner\t\t:', paginationNonOwnerEnd - paginationNonOwnerStart, 'ms', ' results', results.length);
+  benchMarkResults.paginationNonOwner = paginationNonOwnerEnd - paginationNonOwnerStart;
+
+  // descending multiple filters. similar to non-owner query
+  results = [];
+  page = 0;
+  cursor = undefined;
+  const paginationDescNonOwnerStart = Date.now();
+  while (page < 10) {
+    page++;
+    ({ messages, cursor } = await messageStore.query(tenant, [
+      { schema: 'schema2', published: false, author: 'bob1', protocol: 'proto6' },
+      { schema: 'schema2', published: true, protocol: 'proto6' },
+      { schema: 'schema2', published: false, recipient: 'bob1', protocol: 'proto6' },
+    ], descOrder, { limit: 20, cursor } ));
+    results.push(...messages);
+    if (cursor === undefined) {
+      break;
+    }
+  }
+  const paginationDescNonOwnerEnd = Date.now();
+  console.log('\tpagination desc non owner\t:', paginationDescNonOwnerEnd - paginationDescNonOwnerStart, 'ms', ' results', results.length);
+  benchMarkResults.paginationDescNonOwner = paginationDescNonOwnerEnd - paginationDescNonOwnerStart;
+
+  const smallResultSetStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{ published: true, recipient: 'bob1' }]));
+  const smallResultSetEnd = Date.now();
+  console.log('\tquery asc - small set equal\t:', smallResultSetEnd - smallResultSetStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.querySmallSetEqual = smallResultSetEnd - smallResultSetStart;
+
+  const lastDayOf2022 = Time.createTimestamp({ year: 2022, month: 12, day: 31 });
+  const lastDayOf2023 = Time.createTimestamp({ year: 2023, month: 12, day: 31 });
+  const queryRangeStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{
+    dateCreated: { gt: lastDayOf2022, lt: lastDayOf2023 }
+  }]));
+  const queryRangeEnd = Date.now();
+  console.log('\tquery - range\t\t\t:', queryRangeEnd - queryRangeStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+ benchMarkResults.queryRange = queryRangeEnd - queryRangeStart;
+
+  // larger result set
+  const queryEqualStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{ schema: 'schema2' }]));
+  const queryEqualEnd = Date.now();
+  console.log('\tquery - equal\t\t\t:', queryEqualEnd - queryEqualStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.queryEqual = queryEqualEnd - queryEqualStart;
+  // multiple queries
+  const multipleEqualStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{ schema: ['schema2', 'schema1'] }, { published: true }]));
+  const multipleEqualEnd = Date.now();
+  console.log('\tquery - multiple equal\t\t:', multipleEqualEnd - multipleEqualStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.queryMultipleEqual = multipleEqualEnd - multipleEqualStart;
+
+  //range queries
+  // gt
+  const queryGTRangeStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{
+    dateCreated: { gt: lastDayOf2022 }
+  }]));
+  const queryGTRangeEnd = Date.now();
+  console.log('\tquery - gt range\t\t:', queryGTRangeEnd - queryGTRangeStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.queryGTRange = queryGTRangeEnd - queryGTRangeStart;
+  // lt
+  const queryLTRangeStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [{
+    dateCreated: { lt: lastDayOf2022 }
+  }]));
+  const queryLTRangeEnd = Date.now();
+  console.log('\tquery - lt range\t\t:', queryLTRangeEnd - queryLTRangeStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.queryLTRange = queryLTRangeEnd - queryLTRangeStart;
+  // query - range multiple
+  const multipleRangeStart = Date.now();
+  ({ messages } = await messageStore.query(tenant, [
+    { dateCreated: { gt: lastDayOf2022 } },
+    { dateCreated: { lt: firstDayOf2024, gt: lastDayOf2023 } },
+  ]));
+  const multipleRangeEnd = Date.now();
+  console.log('\tquery - multiple range\t\t:', multipleRangeEnd - multipleRangeStart, 'ms');
+  console.log('\t\tresults count\t\t:', messages.length);
+  benchMarkResults.queryMultipleRange = multipleRangeEnd - multipleRangeStart;
+  // clear - after
+  const clearAfterStart = Date.now();
+  await messageStore.clear();
+  const clearAfterEnd = Date.now();
+  console.log('\tclear - after\t\t\t:', clearAfterEnd - clearAfterStart, 'ms');
+  return benchMarkResults;
+};
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dwn-cozo-store",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "description": "dwn cozo store ",
   "repository": {
@@ -17,6 +17,10 @@
     "require": "./dist/cjs/main.js",
     "types": "./dist/types/src/main.d.ts"
   },
+  "files": [
+    "dist",
+    "src"
+  ],
   "react-native": "./dist/esm/src/main.js",
   "scripts": {
     "build:esm": "yarn run clean & tsc",

diff --git a/tsconfig.json b/tsconfig.json
@@ -17,5 +17,5 @@
       "esModuleInterop": true,
       "strictNullChecks": true
     },
-    "include": ["./src"],
+    "include": ["./src", "./tests"],
   }