Refactored tests to be independent of store implementation (#420)

* Refactored tests to be independent of store implementation
* Updated CONTRIBUTING.md

Author: thehenrytsai

CONTRIBUTING.md

@@ -39,6 +39,16 @@ We suggest the following process when picking up one of these issues:
 * Running the `npm run test:browser` command from the root of the project will run the tests in browser environments.
   * Please make sure there are no failing tests before switching your PR to ready for review! This validation is automated when you open a new pull request.
 
+### Developing and testing custom store implementations
+Here is a guide on how to develop and test a custom implementation of the data store:
+
+> Please note that we aim to improve the experience over time, such as exporting the interface definitions as their own module.
+
+1. Fork the repository.
+1. Implement one or a combination of the `DataStore`, `MessageStore`, and `EventLog` interfaces.
+1. Override the store initialization logic in the `TestStoreInitializer` class.
+1. Run the tests as you would normally to ensure the functionality and correctness of your custom implementation.
+
 ### Running benchmarks
 
 Benchmarks should be run directly using `node` (e.g. `node benchmarks/store/index/search-index.js`).

package-lock.json

@@ -133,6 +133,7 @@
     "rimraf": "3.0.2",
     "search-index": "3.4.0",
     "sinon": "13.0.1",
+    "ts-sinon": "^2.0.2",
     "typescript": "4.8.2",
     "util": "0.12.4"
   },
@@ -161,4 +162,4 @@
     "license-check": "license-report --only=prod > license-report.json && node ./build/license-check.cjs",
     "publish:unstable": "./build/publish-unstable.sh"
   }
-}
+}

package.json

@@ -45,6 +45,11 @@ export interface DataStore {
    * @param messageCid CID of the message that references the data.
    */
   delete(tenant: string, messageCid: string, dataCid: string): Promise<void>;
+
+  /**
+   * Clears the entire store. Mainly used for cleaning up in test environment.
+   */
+  clear(): Promise<void>;
 }
 
 /**

src/types/data-store.ts

@@ -30,17 +30,17 @@ export interface EventLog {
   /**
    * retrieves all of a tenant's events that occurred after the watermark provided.
    * If no watermark is provided, all events for a given tenant will be returned.
-   *
-   * @param tenant
-   * @param watermark
    */
   getEvents(tenant: string, options?: GetEventsOptions): Promise<Array<Event>>
 
   /**
    * deletes any events that have any of the cids provided
-   * @param tenant
-   * @param cids
    * @returns {Promise<number>} the number of events deleted
    */
   deleteEventsByCid(tenant: string, cids: Array<string>): Promise<number>
+
+  /**
+   * Clears the entire store. Mainly used for cleaning up in test environment.
+   */
+  clear(): Promise<void>;
 }

src/types/event-log.ts

@@ -41,4 +41,9 @@ export interface MessageStore {
    * Deletes the message associated with the id provided.
    */
   delete(tenant: string, cid: string, options?: MessageStoreOptions): Promise<void>;
+
+  /**
+   * Clears the entire store. Mainly used for cleaning up in test environment.
+   */
+  clear(): Promise<void>;
 }

src/types/message-store.ts

@@ -1,42 +1,34 @@
+import type { DataStore, EventLog, MessageStore } from '../src/index.js';
 import type { EventsGetReply, RecordsWriteMessage, TenantGate } from '../src/index.js';
 
 import chaiAsPromised from 'chai-as-promised';
 import sinon from 'sinon';
 import chai, { expect } from 'chai';
 
-import { DataStoreLevel } from '../src/store/data-store-level.js';
 import { DidKeyResolver } from '../src/did/did-key-resolver.js';
 import { Dwn } from '../src/dwn.js';
 import { Encoder } from '../src/index.js';
-import { EventLogLevel } from '../src/event-log/event-log-level.js';
-import { MessageStoreLevel } from '../src/store/message-store-level.js';
+import { stubInterface } from 'ts-sinon';
 import { TestDataGenerator } from './utils/test-data-generator.js';
+import { TestStoreInitializer } from './test-store-initializer.js';
 import { DwnInterfaceName, DwnMethodName, Message } from '../src/core/message.js';
 import { Jws, RecordsRead } from '../src/index.js';
 
 chai.use(chaiAsPromised);
 
 describe('DWN', () => {
-  let messageStore: MessageStoreLevel;
-  let dataStore: DataStoreLevel;
-  let eventLog: EventLogLevel;
+  let messageStore: MessageStore;
+  let dataStore: DataStore;
+  let eventLog: EventLog;
   let dwn: Dwn;
 
+  // important to follow the `before` and `after` pattern to initialize and clean the stores in tests
+  // so that different test suites can reuse the same backend store for testing
   before(async () => {
-    // important to follow this pattern to initialize the message store in tests
-    // so that different suites can reuse the same block store and index location for testing
-    messageStore = new MessageStoreLevel({
-      blockstoreLocation : 'TEST-MESSAGESTORE',
-      indexLocation      : 'TEST-INDEX'
-    });
-
-    dataStore = new DataStoreLevel({
-      blockstoreLocation: 'TEST-DATASTORE'
-    });
-
-    eventLog = new EventLogLevel({
-      location: 'TEST-EVENTLOG'
-    });
+    const stores = TestStoreInitializer.initializeStores();
+    messageStore = stores.messageStore;
+    dataStore = stores.dataStore;
+    eventLog = stores.eventLog;
 
     dwn = await Dwn.create({ messageStore, dataStore, eventLog });
   });
@@ -144,9 +136,9 @@ describe('DWN', () => {
         }
       };
 
-      const messageStoreStub = sinon.createStubInstance(MessageStoreLevel);
-      const dataStoreStub = sinon.createStubInstance(DataStoreLevel);
-      const eventLogStub = sinon.createStubInstance(EventLogLevel);
+      const messageStoreStub = stubInterface<MessageStore>();
+      const dataStoreStub = stubInterface<DataStore>();
+      const eventLogStub = stubInterface<EventLog>();
 
       const dwnWithConfig = await Dwn.create({
         tenantGate   : blockAllTenantGate,
@@ -285,9 +277,9 @@ describe('DWN', () => {
         }
       };
 
-      const messageStoreStub = sinon.createStubInstance(MessageStoreLevel);
-      const dataStoreStub = sinon.createStubInstance(DataStoreLevel);
-      const eventLogStub = sinon.createStubInstance(EventLogLevel);
+      const messageStoreStub = stubInterface<MessageStore>();
+      const dataStoreStub = stubInterface<DataStore>();
+      const eventLogStub = stubInterface<EventLog>();
 
       const dwnWithConfig = await Dwn.create({
         tenantGate   : blockAllTenantGate,

tests/dwn.spec.ts

@@ -1,42 +1,37 @@
-import type { EventsGetReply } from '../../src/index.js';
+import type {
+  DataStore,
+  EventLog,
+  EventsGetReply,
+  MessageStore
+} from '../../src/index.js';
 
 import { expect } from 'chai';
 import { TestDataGenerator } from '../utils/test-data-generator.js';
 import {
-  DataStoreLevel,
   DidKeyResolver,
   DidResolver,
-  Dwn,
-  EventLogLevel,
-  MessageStoreLevel,
+  Dwn
 } from '../../src/index.js';
 
 import { Message } from '../../src/core/message.js';
+import { TestStoreInitializer } from '../test-store-initializer.js';
 
 describe('EventsGetHandler.handle()', () => {
   let didResolver: DidResolver;
-  let messageStore: MessageStoreLevel;
-  let dataStore: DataStoreLevel;
-  let eventLog: EventLogLevel;
+  let messageStore: MessageStore;
+  let dataStore: DataStore;
+  let eventLog: EventLog;
   let dwn: Dwn;
 
+  // important to follow the `before` and `after` pattern to initialize and clean the stores in tests
+  // so that different test suites can reuse the same backend store for testing
   before(async () => {
     didResolver = new DidResolver([new DidKeyResolver()]);
 
-    // important to follow this pattern to initialize and clean the message and data store in tests
-    // so that different suites can reuse the same block store and index location for testing
-    messageStore = new MessageStoreLevel({
-      blockstoreLocation : 'TEST-MESSAGESTORE',
-      indexLocation      : 'TEST-INDEX'
-    });
-
-    dataStore = new DataStoreLevel({
-      blockstoreLocation: 'TEST-DATASTORE'
-    });
-
-    eventLog = new EventLogLevel({
-      location: 'TEST-EVENTLOG'
-    });
+    const stores = TestStoreInitializer.initializeStores();
+    messageStore = stores.messageStore;
+    dataStore = stores.dataStore;
+    eventLog = stores.eventLog;
 
     dwn = await Dwn.create({ didResolver, messageStore, dataStore, eventLog });
   });