@graffiti-garden/implementation-local 0.4.1 → 0.4.2

package/src/database.ts

@@ -10,7 +10,6 @@ import {
   GraffitiErrorForbidden,
   GraffitiErrorPatchError,
 } from "@graffiti-garden/api";
-import PouchDB from "pouchdb";
 import {
   locationToUri,
   unpackLocationOrUri,
@@ -22,8 +21,8 @@ import {
   compileGraffitiObjectSchema,
 } from "./utilities.js";
 import { Repeater } from "@repeaterjs/repeater";
-import Ajv from "ajv";
-import { applyPatch } from "fast-json-patch";
+import type Ajv from "ajv";
+import type { applyPatch } from "fast-json-patch";
 
 /**
  * Constructor options for the GraffitiPoubchDB class.
@@ -43,6 +42,22 @@ export interface GraffitiLocalOptions {
    * Defaults to `"local"`.
    */
   sourceName?: string;
+  /**
+   * Whether to allow putting objects with a different than the
+   * default source name. Defaults to `false`.
+   *
+   * Allows this implementation to be used as a client-side cache
+   * for remote sources.
+   */
+  allowOtherSources?: boolean;
+  /**
+   * Whether to allow the user to set the lastModified field
+   * when putting objects. Defaults to `false`.
+   *
+   * Allows this implementation to be used as a client-side cache
+   * for remote sources.
+   */
+  allowSettinngLastModified?: boolean;
   /**
    * The time in milliseconds to keep tombstones before deleting them.
    * See the {@link https://api.graffiti.garden/classes/Graffiti.html#discover | `discover` }
@@ -51,10 +66,14 @@ export interface GraffitiLocalOptions {
   tombstoneRetention?: number;
   /**
    * An optional Ajv instance to use for schema validation.
+   * If not provided, an internal instance will be created.
    */
   ajv?: Ajv;
 }
 
+const DEFAULT_TOMBSTONE_RETENTION = 86400000; // 1 day in milliseconds
+const DEFAULT_SOURCE_NAME = "local";
+
 /**
  * An implementation of only the database operations of the
  * GraffitiAPI without synchronization or session management.
@@ -72,91 +91,121 @@ export class GraffitiLocalDatabase
       | "channelStats"
     >
 {
-  protected readonly db: PouchDB.Database<GraffitiObjectBase>;
-  protected readonly source: string = "local";
-  protected readonly tombstoneRetention: number = 86400000; // 1 day in ms
-  protected readonly ajv: Ajv;
+  protected db_: Promise<PouchDB.Database<GraffitiObjectBase>> | undefined;
+  protected applyPatch_: Promise<typeof applyPatch> | undefined;
+  protected ajv_: Promise<Ajv> | undefined;
+  protected readonly options: GraffitiLocalOptions;
+
+  get db() {
+    if (!this.db_) {
+      this.db_ = (async () => {
+        const { default: PouchDB } = await import("pouchdb");
+        const pouchDbOptions = {
+          name: "graffitiDb",
+          ...this.options.pouchDBOptions,
+        };
+        const db = new PouchDB<GraffitiObjectBase>(
+          pouchDbOptions.name,
+          pouchDbOptions,
+        );
+        await db
+          //@ts-ignore
+          .put({
+            _id: "_design/indexes",
+            views: {
+              objectsPerChannelAndLastModified: {
+                map: function (object: GraffitiObjectBase) {
+                  const paddedLastModified = object.lastModified
+                    .toString()
+                    .padStart(15, "0");
+                  object.channels.forEach(function (channel) {
+                    const id =
+                      encodeURIComponent(channel) + "/" + paddedLastModified;
+                    //@ts-ignore
+                    emit(id);
+                  });
+                }.toString(),
+              },
+              orphansPerActorAndLastModified: {
+                map: function (object: GraffitiObjectBase) {
+                  if (object.channels.length === 0) {
+                    const paddedLastModified = object.lastModified
+                      .toString()
+                      .padStart(15, "0");
+                    const id =
+                      encodeURIComponent(object.actor) +
+                      "/" +
+                      paddedLastModified;
+                    //@ts-ignore
+                    emit(id);
+                  }
+                }.toString(),
+              },
+              channelStatsPerActor: {
+                map: function (object: GraffitiObjectBase) {
+                  if (object.tombstone) return;
+                  object.channels.forEach(function (channel) {
+                    const id =
+                      encodeURIComponent(object.actor) +
+                      "/" +
+                      encodeURIComponent(channel);
+                    //@ts-ignore
+                    emit(id, object.lastModified);
+                  });
+                }.toString(),
+                reduce: "_stats",
+              },
+            },
+          })
+          //@ts-ignore
+          .catch((error) => {
+            if (
+              error &&
+              typeof error === "object" &&
+              "name" in error &&
+              error.name === "conflict"
+            ) {
+              // Design document already exists
+              return;
+            } else {
+              throw error;
+            }
+          });
+        return db;
+      })();
+    }
+    return this.db_;
+  }
 
-  constructor(options?: GraffitiLocalOptions) {
-    this.ajv = options?.ajv ?? new Ajv({ strict: false });
-    this.source = options?.sourceName ?? this.source;
-    this.tombstoneRetention =
-      options?.tombstoneRetention ?? this.tombstoneRetention;
-    const pouchDbOptions = {
-      name: "graffitiDb",
-      ...options?.pouchDBOptions,
-    };
-    this.db = new PouchDB<GraffitiObjectBase>(
-      pouchDbOptions.name,
-      pouchDbOptions,
-    );
+  get applyPatch() {
+    if (!this.applyPatch_) {
+      this.applyPatch_ = (async () => {
+        const { applyPatch } = await import("fast-json-patch");
+        return applyPatch;
+      })();
+    }
+    return this.applyPatch_;
+  }
 
-    this.db
-      //@ts-ignore
-      .put({
-        _id: "_design/indexes",
-        views: {
-          objectsPerChannelAndLastModified: {
-            map: function (object: GraffitiObjectBase) {
-              const paddedLastModified = object.lastModified
-                .toString()
-                .padStart(15, "0");
-              object.channels.forEach(function (channel) {
-                const id =
-                  encodeURIComponent(channel) + "/" + paddedLastModified;
-                //@ts-ignore
-                emit(id);
-              });
-            }.toString(),
-          },
-          orphansPerActorAndLastModified: {
-            map: function (object: GraffitiObjectBase) {
-              if (object.channels.length === 0) {
-                const paddedLastModified = object.lastModified
-                  .toString()
-                  .padStart(15, "0");
-                const id =
-                  encodeURIComponent(object.actor) + "/" + paddedLastModified;
-                //@ts-ignore
-                emit(id);
-              }
-            }.toString(),
-          },
-          channelStatsPerActor: {
-            map: function (object: GraffitiObjectBase) {
-              if (object.tombstone) return;
-              object.channels.forEach(function (channel) {
-                const id =
-                  encodeURIComponent(object.actor) +
-                  "/" +
-                  encodeURIComponent(channel);
-                //@ts-ignore
-                emit(id, object.lastModified);
-              });
-            }.toString(),
-            reduce: "_stats",
-          },
-        },
-      })
-      //@ts-ignore
-      .catch((error) => {
-        if (
-          error &&
-          typeof error === "object" &&
-          "name" in error &&
-          error.name === "conflict"
-        ) {
-          // Design document already exists
-          return;
-        } else {
-          throw error;
-        }
-      });
+  get ajv() {
+    if (!this.ajv_) {
+      this.ajv_ = (async () => {
+        const { default: Ajv } = await import("ajv");
+        return new Ajv({ strict: false });
+      })();
+    }
+    return this.ajv_;
+  }
+
+  constructor(options?: GraffitiLocalOptions) {
+    this.options = options ?? {};
   }
 
   protected async queryByLocation(location: GraffitiLocation) {
     const uri = locationToUri(location) + "/";
-    const results = await this.db.allDocs({
+    const results = await (
+      await this.db
+    ).allDocs({
       startkey: uri,
       endkey: uri + "\uffff", // \uffff is the last unicode character
       include_docs: true,
@@ -201,7 +250,7 @@ export class GraffitiLocalDatabase
     // if the user is not the owner
     maskGraffitiObject(object, [], session);
 
-    const validate = compileGraffitiObjectSchema(this.ajv, schema);
+    const validate = compileGraffitiObjectSchema(await this.ajv, schema);
     if (!validate(object)) {
       throw new GraffitiErrorSchemaMismatch();
     }
@@ -252,7 +301,9 @@ export class GraffitiLocalDatabase
 
     const lastModified = keepLatest ? latestModified : new Date().getTime();
 
-    const deleteResults = await this.db.bulkDocs<GraffitiObjectBase>(
+    const deleteResults = await (
+      await this.db
+    ).bulkDocs<GraffitiObjectBase>(
       docsToDelete.map((doc) => ({
         ...doc,
         tombstone: true,
@@ -300,24 +351,37 @@ export class GraffitiLocalDatabase
     if (objectPartial.actor && objectPartial.actor !== session.actor) {
       throw new GraffitiErrorForbidden();
     }
-    if (objectPartial.source && objectPartial.source !== this.source) {
+    if (
+      objectPartial.source &&
+      objectPartial.source !==
+        (this.options.sourceName ?? DEFAULT_SOURCE_NAME) &&
+      !(this.options.allowOtherSources ?? false)
+    ) {
       throw new GraffitiErrorForbidden(
         "Putting an object that does not match this source",
       );
     }
 
+    const lastModified =
+      ((this.options.allowSettinngLastModified ?? false) &&
+        objectPartial.lastModified) ||
+      new Date().getTime();
+
     const object: GraffitiObjectBase = {
       value: objectPartial.value,
       channels: objectPartial.channels,
       allowed: objectPartial.allowed,
       name: objectPartial.name ?? randomBase64(),
-      source: this.source,
+      source:
+        objectPartial.source ?? this.options.sourceName ?? DEFAULT_SOURCE_NAME,
       actor: session.actor,
       tombstone: false,
-      lastModified: new Date().getTime(),
+      lastModified,
     };
 
-    await this.db.put({
+    await (
+      await this.db
+    ).put({
       _id: this.docId(object),
       ...object,
     });
@@ -353,7 +417,7 @@ export class GraffitiLocalDatabase
     // Patch it outside of the database
     const patchObject: GraffitiObjectBase = { ...originalObject };
     for (const prop of ["value", "channels", "allowed"] as const) {
-      applyGraffitiPatch(applyPatch, prop, patch, patchObject);
+      applyGraffitiPatch(await this.applyPatch, prop, patch, patchObject);
     }
 
     // Make sure the value is an object
@@ -387,7 +451,9 @@ export class GraffitiLocalDatabase
     }
 
     patchObject.lastModified = new Date().getTime();
-    await this.db.put({
+    await (
+      await this.db
+    ).put({
       ...patchObject,
       _id: this.docId(patchObject),
     });
@@ -451,7 +517,6 @@ export class GraffitiLocalDatabase
 
   discover: Graffiti["discover"] = (...args) => {
     const [channels, schema, session] = args;
-    const validate = compileGraffitiObjectSchema(this.ajv, schema);
 
     const { startKeySuffix, endKeySuffix } =
       this.queryLastModifiedSuffixes(schema);
@@ -459,6 +524,8 @@ export class GraffitiLocalDatabase
     const repeater: ReturnType<
       typeof Graffiti.prototype.discover<typeof schema>
     > = new Repeater(async (push, stop) => {
+      const validate = compileGraffitiObjectSchema(await this.ajv, schema);
+
       const processedIds = new Set<string>();
 
       for (const channel of channels) {
@@ -466,7 +533,9 @@ export class GraffitiLocalDatabase
         const startkey = keyPrefix + startKeySuffix;
         const endkey = keyPrefix + endKeySuffix;
 
-        const result = await this.db.query<GraffitiObjectBase>(
+        const result = await (
+          await this.db
+        ).query<GraffitiObjectBase>(
           "indexes/objectsPerChannelAndLastModified",
           { startkey, endkey, include_docs: true },
         );
@@ -497,7 +566,8 @@ export class GraffitiLocalDatabase
       }
       stop();
       return {
-        tombstoneRetention: this.tombstoneRetention,
+        tombstoneRetention:
+          this.options.tombstoneRetention ?? DEFAULT_TOMBSTONE_RETENTION,
       };
     });
 
@@ -505,8 +575,6 @@ export class GraffitiLocalDatabase
   };
 
   recoverOrphans: Graffiti["recoverOrphans"] = (schema, session) => {
-    const validate = compileGraffitiObjectSchema(this.ajv, schema);
-
     const { startKeySuffix, endKeySuffix } =
       this.queryLastModifiedSuffixes(schema);
     const keyPrefix = encodeURIComponent(session.actor) + "/";
@@ -516,10 +584,15 @@ export class GraffitiLocalDatabase
     const repeater: ReturnType<
       typeof Graffiti.prototype.recoverOrphans<typeof schema>
     > = new Repeater(async (push, stop) => {
-      const result = await this.db.query<GraffitiObjectBase>(
-        "indexes/orphansPerActorAndLastModified",
-        { startkey, endkey, include_docs: true },
-      );
+      const validate = compileGraffitiObjectSchema(await this.ajv, schema);
+
+      const result = await (
+        await this.db
+      ).query<GraffitiObjectBase>("indexes/orphansPerActorAndLastModified", {
+        startkey,
+        endkey,
+        include_docs: true,
+      });
 
       for (const row of result.rows) {
         const doc = row.doc;
@@ -535,7 +608,8 @@ export class GraffitiLocalDatabase
       }
       stop();
       return {
-        tombstoneRetention: this.tombstoneRetention,
+        tombstoneRetention:
+          this.options.tombstoneRetention ?? DEFAULT_TOMBSTONE_RETENTION,
       };
     });
 
@@ -546,7 +620,9 @@ export class GraffitiLocalDatabase
     const repeater: ReturnType<typeof Graffiti.prototype.channelStats> =
       new Repeater(async (push, stop) => {
         const keyPrefix = encodeURIComponent(session.actor) + "/";
-        const result = await this.db.query("indexes/channelStatsPerActor", {
+        const result = await (
+          await this.db
+        ).query("indexes/channelStatsPerActor", {
           startkey: keyPrefix,
           endkey: keyPrefix + "\uffff",
           reduce: true,