#244 - use the same parameter types for `MessageStoreLevel.prototype.…

…query` and `IndexLevel.prototype.query` (#257) this makes the API simpler to understand as `ExactCriterion` and `RangeCriterion` are expressed in the types rather than two separate parameters it also entirely removes any chance of clashing if the same property is provided in both `exactCriteria` and `rangeCriteria`
decentralized-identity · Mar 11, 2023 · d21765b · d21765b
1 parent 019f9bf
commit d21765b
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 218 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 # Decentralized Web Node (DWN) SDK
 
 Code Coverage
-![Statements](https://img.shields.io/badge/statements-94.79%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-92.95%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-93.36%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-94.79%25-brightgreen.svg?style=flat)
+![Statements](https://img.shields.io/badge/statements-94.91%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-92.93%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-93.27%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-94.91%25-brightgreen.svg?style=flat)
 
 ## Introduction
 

diff --git a/src/core/types.ts b/src/core/types.ts
@@ -44,3 +44,15 @@ export type DataReferencingMessage = {
 
   encodedData: string;
 };
+
+export type EqualFilter = string | number | boolean;
+
+export type OneOfFilter = EqualFilter[];
+
+type GT = ({ gt: string } & { gte?: never }) | ({ gt?: never } & { gte: string });
+type LT = ({ lt: string } & { lte?: never }) | ({ lt?: never } & { lte: string });
+export type RangeFilter = (GT | LT) & Partial<GT> & Partial<LT>;
+
+export type Filter = {
+  [property: string]: EqualFilter | OneOfFilter | RangeFilter
+};
diff --git a/src/interfaces/records/handlers/records-query.ts b/src/interfaces/records/handlers/records-query.ts
@@ -68,16 +68,13 @@ export class RecordsQueryHandler implements MethodHandler {
    */
   private async fetchRecordsAsOwner(tenant: string, recordsQuery: RecordsQuery): Promise<BaseMessage[]> {
     // fetch all published records matching the query
-    const exactCriteria = RecordsQuery.getExactCriteria(recordsQuery.message.descriptor.filter);
-    const completeExactCriteria = {
-      ...exactCriteria,
+    const filter = {
+      ...RecordsQuery.convertFilter(recordsQuery.message.descriptor.filter),
       interface         : DwnInterfaceName.Records,
       method            : DwnMethodName.Write,
       isLatestBaseState : true
     };
-
-    const rangeCriteria = RecordsQuery.getRangeCriteria(recordsQuery.message.descriptor.filter);
-    const records = await StorageController.query(this.messageStore, this.dataStore, tenant, completeExactCriteria, rangeCriteria);
+    const records = await StorageController.query(this.messageStore, this.dataStore, tenant, filter);
     return records;
   }
 
@@ -100,17 +97,14 @@ export class RecordsQueryHandler implements MethodHandler {
    */
   private async fetchPublishedRecords(tenant: string, recordsQuery: RecordsQuery): Promise<BaseMessage[]> {
     // fetch all published records matching the query
-    const exactCriteria = RecordsQuery.getExactCriteria(recordsQuery.message.descriptor.filter);
-    const completeExactCriteria = {
-      ...exactCriteria,
+    const filter = {
+      ...RecordsQuery.convertFilter(recordsQuery.message.descriptor.filter),
       interface         : DwnInterfaceName.Records,
       method            : DwnMethodName.Write,
       published         : true,
       isLatestBaseState : true
     };
-
-    const rangeCriteria = RecordsQuery.getRangeCriteria(recordsQuery.message.descriptor.filter);
-    const publishedRecords = await StorageController.query(this.messageStore, this.dataStore, tenant, completeExactCriteria, rangeCriteria);
+    const publishedRecords = await StorageController.query(this.messageStore, this.dataStore, tenant, filter);
     return publishedRecords;
   }
 
@@ -119,24 +113,15 @@ export class RecordsQueryHandler implements MethodHandler {
    */
   private async fetchUnpublishedRecordsForRequester(tenant: string, recordsQuery: RecordsQuery): Promise<BaseMessage[]> {
   // include records where recipient is requester
-    const exactCriteria = RecordsQuery.getExactCriteria(recordsQuery.message.descriptor.filter);
-    const completeExactCriteria = {
-      ...exactCriteria,
+    const filter = {
+      ...RecordsQuery.convertFilter(recordsQuery.message.descriptor.filter),
       interface         : DwnInterfaceName.Records,
       method            : DwnMethodName.Write,
       recipient         : recordsQuery.author,
       isLatestBaseState : true,
       published         : false
     };
-
-    const rangeCriteria = RecordsQuery.getRangeCriteria(recordsQuery.message.descriptor.filter);
-    const unpublishedRecordsForRequester = await StorageController.query(
-      this.messageStore,
-      this.dataStore,
-      tenant,
-      completeExactCriteria,
-      rangeCriteria
-    );
+    const unpublishedRecordsForRequester = await StorageController.query(this.messageStore, this.dataStore, tenant, filter);
     return unpublishedRecordsForRequester;
   }
 
@@ -145,25 +130,15 @@ export class RecordsQueryHandler implements MethodHandler {
    */
   private async fetchUnpublishedRecordsByRequester(tenant: string, recordsQuery: RecordsQuery): Promise<BaseMessage[]> {
     // include records where recipient is requester
-    const exactCriteria = RecordsQuery.getExactCriteria(recordsQuery.message.descriptor.filter);
-    const completeExactCriteria = {
-      ...exactCriteria,
+    const filter = {
+      ...RecordsQuery.convertFilter(recordsQuery.message.descriptor.filter),
       author            : recordsQuery.author,
       interface         : DwnInterfaceName.Records,
       method            : DwnMethodName.Write,
       isLatestBaseState : true,
       published         : false
     };
-
-    const rangeCriteria = RecordsQuery.getRangeCriteria(recordsQuery.message.descriptor.filter);
-
-    const unpublishedRecordsForRequester = await StorageController.query(
-      this.messageStore,
-      this.dataStore,
-      tenant,
-      completeExactCriteria,
-      rangeCriteria
-    );
+    const unpublishedRecordsForRequester = await StorageController.query(this.messageStore, this.dataStore, tenant, filter);
     return unpublishedRecordsForRequester;
   }
 }

diff --git a/src/interfaces/records/messages/records-query.ts b/src/interfaces/records/messages/records-query.ts
@@ -1,5 +1,6 @@
 import type { SignatureInput } from '../../../jose/jws/general/types.js';
-import type { ExactCriterion, RangeCriterion, RecordsQueryDescriptor, RecordsQueryFilter, RecordsQueryMessage } from '../types.js';
+import type { Filter, RangeFilter } from '../../../core/types.js';
+import type { RecordsQueryDescriptor, RecordsQueryFilter, RecordsQueryMessage } from '../types.js';
 
 import { getCurrentTimeInHighPrecision } from '../../../utils/time.js';
 import { Message } from '../../../core/message.js';
@@ -70,25 +71,28 @@ export class RecordsQuery extends Message {
     }
   }
 
-  /**
-   * Gets the criteria for exact matches and exclude other types of criteria such as range criteria.
-   * @returns object contain all exact-match criteria; empty object if no exact-match criterion is found.
-   */
-  public static getExactCriteria(filter: RecordsQueryFilter): { [key:string]: ExactCriterion } {
-    const filterCopy = { ... filter };
-    delete filterCopy.dateCreated;
-
-    removeUndefinedProperties(filterCopy);
-
-    return filterCopy as { [key:string]: ExactCriterion };
-  }
-
-  /**
-   * Gets the list of range criteria (e.g. `dateCreated`) and exclude other types of criteria such as exact matches.
-   * @returns object contain all range criteria; empty object if no range criterion is found.
-   */
-  public static getRangeCriteria(filter: RecordsQueryFilter): { [key:string]: RangeCriterion } {
-    const rangeCriteria = filter.dateCreated ? { dateCreated: filter.dateCreated } : { };
-    return rangeCriteria;
+  public static convertFilter(filter: RecordsQueryFilter): Filter {
+    const result: Filter = { };
+    for (const key in filter) {
+      switch (key) {
+      case 'dateCreated':
+        var rangeFilter: RangeFilter = {
+          gte : filter.dateCreated.from,
+          lte : filter.dateCreated.to
+        };
+        if (rangeFilter.gte === undefined) {
+          delete rangeFilter.gte;
+        }
+        if (rangeFilter.lte === undefined) {
+          delete rangeFilter.lte;
+        }
+        result.dateCreated = rangeFilter;
+        break;
+      default:
+        result[key] = filter[key];
+        break;
+      }
+    }
+    return result;
   }
 }
diff --git a/src/interfaces/records/types.ts b/src/interfaces/records/types.ts
@@ -56,14 +56,6 @@ export type RecordsQueryFilter = {
   dateCreated?: RangeCriterion;
 };
 
-/**
- * An exact criterion in a query filter.
- */
-export type ExactCriterion = unknown;
-
-/**
- * A range criterion in a query filter.
- */
 export type RangeCriterion = {
   /**
    * Inclusive starting date-time.

diff --git a/src/store/index-level.ts b/src/store/index-level.ts
@@ -1,5 +1,6 @@
 import type { LevelDatabase } from './create-level.js';
 import type { AbstractBatchDelOperation, AbstractBatchOperation, AbstractIteratorOptions } from 'abstract-level';
+import type { Filter, RangeFilter } from '../core/types.js';
 
 import { abortOr } from '../utils/abort.js';
 import { createLevelDatabase } from './create-level.js';
@@ -10,18 +11,6 @@ export type Entry = {
   [property: string]: unknown
 };
 
-export type EqualFilter = string | number | boolean;
-
-export type OneOfFilter = EqualFilter[];
-
-type GT = ({ gt: string } & { gte?: never }) | ({ gt?: never } & { gte: string });
-type LT = ({ lt: string } & { lte?: never }) | ({ lt?: never } & { lte: string });
-export type RangeFilter = (GT | LT) & Partial<GT> & Partial<LT>;
-
-export type Filter = {
-  [property: string]: EqualFilter | OneOfFilter | RangeFilter
-};
-
 export interface IndexLevelOptions {
   signal?: AbortSignal;
 }

diff --git a/src/store/message-store-level.ts b/src/store/message-store-level.ts
@@ -1,5 +1,4 @@
-import type { BaseMessage } from '../core/types.js';
-import type { Filter, RangeFilter } from './index-level.js';
+import type { BaseMessage, Filter } from '../core/types.js';
 import type { MessageStore, MessageStoreOptions } from './message-store.js';
 
 import * as block from 'multiformats/block';
@@ -9,10 +8,8 @@ import { abortOr } from '../utils/abort.js';
 import { BlockstoreLevel } from './blockstore-level.js';
 import { CID } from 'multiformats/cid';
 import { createLevelDatabase } from './create-level.js';
-import { flatten } from '../utils/object.js';
 import { IndexLevel } from './index-level.js';
 import { sha256 } from 'multiformats/hashes/sha2';
-import { ExactCriterion, RangeCriterion } from '../interfaces/records/types.js';
 
 /**
  * A simple implementation of {@link MessageStore} that works in both the browser and server-side.
@@ -79,21 +76,12 @@ export class MessageStoreLevel implements MessageStore {
     return messageJson;
   }
 
-  async query(
-    tenant: string,
-    exactCriteria: { [key: string]: ExactCriterion },
-    rangeCriteria?: { [key: string]: RangeCriterion },
-    options?: MessageStoreOptions
-  ): Promise<BaseMessage[]> {
+  async query(tenant: string, filter: Filter, options?: MessageStoreOptions): Promise<BaseMessage[]> {
     options?.signal?.throwIfAborted();
 
     const messages: BaseMessage[] = [];
 
-    // parse criteria into a query that is compatible with the indexing DB we're using
-    const exactTerms = MessageStoreLevel.buildExactQueryTerms({ ...exactCriteria, tenant });
-    const rangeTerms = MessageStoreLevel.buildRangeQueryTerms(rangeCriteria);
-
-    const resultIds = await this.index.query({ ...rangeTerms, ...exactTerms }, options);
+    const resultIds = await this.index.query({ ...filter, tenant }, options);
 
     for (const id of resultIds) {
       const message = await this.get(tenant, id, options);
@@ -148,39 +136,6 @@ export class MessageStoreLevel implements MessageStore {
     await this.blockstore.clear();
     await this.index.clear();
   }
-
-  private static buildExactQueryTerms(
-    exactCriteria: { [key: string]: ExactCriterion } = { }
-  ): Filter {
-    return flatten(exactCriteria) as Filter;
-  }
-
-  private static buildRangeQueryTerms(
-    rangeCriteria: { [key: string]: RangeCriterion} = { }
-  ): Filter {
-    const filter: Filter = { };
-
-    for (const propertyName in rangeCriteria) {
-      const rangeCriterion = rangeCriteria[propertyName];
-
-      const rangeFilter: RangeFilter = {
-        gte : rangeCriterion.from,
-        lte : rangeCriterion.to
-      };
-
-      if (rangeFilter.gte === undefined) {
-        delete rangeFilter.gte;
-      }
-
-      if (rangeFilter.lte === undefined) {
-        delete rangeFilter.lte;
-      }
-
-      filter[propertyName] = rangeFilter;
-    }
-
-    return filter;
-  }
 }
 
 type MessageStoreLevelConfig = {

diff --git a/src/store/message-store.ts b/src/store/message-store.ts
@@ -1,5 +1,4 @@
-import type { BaseMessage } from '../core/types.js';
-import type { ExactCriterion, RangeCriterion } from '../interfaces/records/types.js';
+import type { BaseMessage, Filter } from '../core/types.js';
 
 export interface MessageStoreOptions {
   signal?: AbortSignal;
@@ -34,18 +33,9 @@ export interface MessageStore {
   get(tenant: string, cid: string, options?: MessageStoreOptions): Promise<BaseMessage | undefined>;
 
   /**
-   * Queries the underlying store for messages that match the query provided.
-   * The provided criteria are combined to form an AND filter for the query.
-   * Returns an empty array if no messages are found
-   * @param exactCriteria - criteria for exact matches
-   * @param rangeCriteria - criteria for range matches
+   * Queries the underlying store for messages that match the provided filter.
    */
-  query(
-    tenant: string,
-    exactCriteria: { [key: string]: ExactCriterion },
-    rangeCriteria?: { [key: string]: RangeCriterion },
-    options?: MessageStoreOptions
-  ): Promise<BaseMessage[]>;
+  query(tenant: string, filter: Filter, options?: MessageStoreOptions ): Promise<BaseMessage[]>;
 
   /**
    * Deletes the message associated with the id provided.

diff --git a/src/store/storage-controller.ts b/src/store/storage-controller.ts
@@ -1,8 +1,7 @@
-import { BaseMessage } from '../core/types.js';
 import { DataStore } from './data-store.js';
 import { MessageStore } from './message-store.js';
 import { Readable } from 'readable-stream';
-import { ExactCriterion, RangeCriterion } from '../interfaces/records/types.js';
+import { BaseMessage, Filter } from '../core/types.js';
 
 import { DataStream, Encoder } from '../index.js';
 import { DwnError, DwnErrorCode } from '../core/dwn-error.js';
@@ -80,11 +79,10 @@ export class StorageController {
     messageStore: MessageStore,
     dataStore: DataStore,
     tenant: string,
-    exactCriteria: { [key: string]: ExactCriterion },
-    rangeCriteria?: { [key: string]: RangeCriterion }
+    filter: Filter
   ): Promise<BaseMessage[]> {
 
-    const messages = await messageStore.query(tenant, exactCriteria, rangeCriteria);
+    const messages = await messageStore.query(tenant, filter);
 
     for (const message of messages) {
       const dataCid = message.descriptor.dataCid;