document-drive 1.0.0-websockets.1 → 1.0.1

package/README.md

@@ -0,0 +1 @@
+# Document Drive

package/package.json

@@ -1,89 +1,75 @@
 {
-    "name": "document-drive",
-    "version": "1.0.0-websockets.1",
-    "license": "AGPL-3.0-only",
-    "type": "module",
-    "module": "./src/index.ts",
-    "types": "./src/index.ts",
-    "exports": {
-        ".": "./src/index.ts",
-        "./server": "./src/server/index.ts",
-        "./storage": "./src/storage/index.ts",
-        "./storage/browser": "./src/storage/browser.ts",
-        "./storage/filesystem": "./src/storage/filesystem.ts",
-        "./storage/memory": "./src/storage/memory.ts",
-        "./storage/prisma": "./src/storage/prisma.ts",
-        "./cache/redis": "./src/cache/redis.ts",
-        "./cache/memory": "./src/cache/memory.ts",
-        "./queue/redis": "./src/queue/redis.ts",
-        "./queue/base": "./src/queue/base.ts",
-        "./utils": "./src/utils/index.ts",
-        "./utils/graphql": "./src/utils/graphql.ts",
-        "./logger": "./src/utils/logger.ts"
-    },
-    "files": [
-        "./src"
-    ],
-    "scripts": {
-        "check-types": "tsc --noemit --emitDeclarationOnly false --project tsconfig.json",
-        "lint": "eslint src --ext .js,.jsx,.ts,.tsx && yarn check-types",
-        "lint:fix": "eslint src --ext .js,.jsx,.ts,.tsx --fix",
-        "format": "prettier . --write",
-        "release": "semantic-release",
-        "test": "vitest run --coverage",
-        "test:watch": "vitest watch"
-    },
-    "peerDependencies": {
-        "document-model": "^1.4.0",
-        "document-model-libs": "^1.62.0-websockets"
-    },
-    "optionalDependencies": {
-        "@prisma/client": "5.14.0",
-        "graphql-ws": "^5.16.0",
-        "isomorphic-ws": "^5.0.0",
-        "localforage": "^1.10.0",
-        "redis": "^4.6.13",
-        "sequelize": "^6.35.2",
-        "sqlite3": "^5.1.7",
-        "ws": "^8.17.0"
-    },
-    "dependencies": {
-        "exponential-backoff": "^3.1.1",
-        "graphql": "^16.8.1",
-        "graphql-request": "^6.1.0",
-        "json-stringify-deterministic": "^1.0.12",
-        "nanoevents": "^9.0.0",
-        "sanitize-filename": "^1.6.3",
-        "uuid": "^9.0.1"
-    },
-    "devDependencies": {
-        "@commitlint/cli": "^18.6.1",
-        "@commitlint/config-conventional": "^18.6.3",
-        "@prisma/client": "5.11.0",
-        "@semantic-release/changelog": "^6.0.3",
-        "@semantic-release/git": "^10.0.1",
-        "@total-typescript/ts-reset": "^0.5.1",
-        "@types/node": "^20.12.7",
-        "@types/uuid": "^9.0.8",
-        "@types/ws": "^8.5.10",
-        "@typescript-eslint/eslint-plugin": "^6.21.0",
-        "@typescript-eslint/parser": "^6.21.0",
-        "@vitest/coverage-v8": "^1.4.0",
-        "document-model": "^1.4.0",
-        "document-model-libs": "^1.62.0-websockets",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "^9.1.0",
-        "fake-indexeddb": "^5.0.2",
-        "localforage": "^1.10.0",
-        "msw": "^2.2.13",
-        "prettier": "^3.2.5",
-        "prettier-plugin-organize-imports": "^3.2.4",
-        "prisma": "^5.14.0",
-        "semantic-release": "^23.0.8",
-        "sequelize": "^6.37.2",
-        "sqlite3": "^5.1.7",
-        "typescript": "^5.4.4",
-        "vitest": "^1.6.0"
-    },
-    "packageManager": "pnpm@9.1.4+sha256.30a1801ac4e723779efed13a21f4c39f9eb6c9fbb4ced101bce06b422593d7c9"
-}
+  "name": "document-drive",
+  "version": "1.0.1",
+  "license": "AGPL-3.0-only",
+  "type": "module",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./server": "./src/server/index.ts",
+    "./storage": "./src/storage/index.ts",
+    "./storage/browser": "./src/storage/browser.ts",
+    "./storage/filesystem": "./src/storage/filesystem.ts",
+    "./storage/memory": "./src/storage/memory.ts",
+    "./storage/prisma": "./src/storage/prisma.ts",
+    "./cache/redis": "./src/cache/redis.ts",
+    "./cache/memory": "./src/cache/memory.ts",
+    "./queue/redis": "./src/queue/redis.ts",
+    "./queue/base": "./src/queue/base.ts",
+    "./utils": "./src/utils/index.ts",
+    "./utils/graphql": "./src/utils/graphql.ts",
+    "./utils/migrations": "./src/utils/migrations.ts",
+    "./logger": "./src/utils/logger.ts"
+  },
+  "files": [
+    "./src"
+  ],
+  "peerDependencies": {
+    "document-model": "^2.1.0",
+    "document-model-libs": "^1.92.0"
+  },
+  "optionalDependencies": {
+    "@prisma/client": "^5.18.0",
+    "localforage": "^1.10.0",
+    "redis": "^4.6.15",
+    "sequelize": "^6.37.3",
+    "sqlite3": "^5.1.7"
+  },
+  "dependencies": {
+    "change-case": "^5.4.4",
+    "exponential-backoff": "^3.1.1",
+    "graphql": "^16.9.0",
+    "graphql-request": "^6.1.0",
+    "json-stringify-deterministic": "^1.0.12",
+    "nanoevents": "^9.0.0",
+    "sanitize-filename": "^1.6.3",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@prisma/client": "5.17.0",
+    "@types/node": "^20.14.11",
+    "@types/uuid": "^9.0.8",
+    "document-model": "2.2.0",
+    "document-model-libs": "1.93.2",
+    "fake-indexeddb": "^5.0.2",
+    "localforage": "^1.10.0",
+    "msw": "^2.3.1",
+    "prisma": "^5.18.0",
+    "sequelize": "^6.37.2",
+    "sqlite3": "^5.1.7",
+    "webdriverio": "^9.0.9",
+    "vitest-fetch-mock": "^0.3.0"
+  },
+  "scripts": {
+    "check-types": "tsc --noEmit",
+    "postlint": "npm run check-types",
+    "lint": "eslint",
+    "release": "semantic-release",
+    "test": "vitest run --coverage --exclude \"test/flaky/**\"",
+    "test:watch": "vitest watch",
+    "clean": "rimraf dist",
+    "clean:node_modules": "rimraf node_modules",
+    "build": "prisma generate"
+  }
+}

package/src/cache/index.ts

@@ -1,2 +1,2 @@
-export * from './memory';
-export * from './types';
+export * from "./memory";
+export * from "./types";

package/src/cache/memory.ts

@@ -2,23 +2,32 @@ import { Document } from "document-model/document";
 import { ICache } from "./types";
 
 class InMemoryCache implements ICache {
-    private cache = new Map<string, Map<string, Document>>();
+  private cache = new Map<string, Map<string, Document>>();
 
-    async setDocument(drive: string, id: string, document: Document) {
-        if (!this.cache.has(drive)) {
-            this.cache.set(drive, new Map());
-        }
-        this.cache.get(drive)?.set(id, document);
-        return true;
+  async setDocument(drive: string, id: string, document: Document) {
+    const global = document.operations.global.map((e) => {
+      delete e.resultingState;
+      return e;
+    });
+    const local = document.operations.local.map((e) => {
+      delete e.resultingState;
+      return e;
+    });
+    const doc = { ...document, operations: { global, local } };
+    if (!this.cache.has(drive)) {
+      this.cache.set(drive, new Map());
     }
+    this.cache.get(drive)?.set(id, doc);
+    return true;
+  }
 
-    async deleteDocument(drive: string, id: string) {
-        return this.cache.get(drive)?.delete(id) ?? false;
-    }
+  async deleteDocument(drive: string, id: string) {
+    return this.cache.get(drive)?.delete(id) ?? false;
+  }
 
-    async getDocument(drive: string, id: string) {
-        return this.cache.get(drive)?.get(id);
-    }
+  async getDocument(drive: string, id: string) {
+    return this.cache.get(drive)?.get(id);
+  }
 }
 
 export default InMemoryCache;

package/src/cache/redis.ts

@@ -1,29 +1,56 @@
 import { Document } from "document-model/document";
-import { ICache } from "./types";
 import type { RedisClientType } from "redis";
-import { logger } from "../utils/logger";
+import { ICache } from "./types";
 
 class RedisCache implements ICache {
-    private redis: RedisClientType;
+  private redis: RedisClientType;
+  private timeoutInSeconds: number;
 
-    constructor(redis: RedisClientType) {
-        this.redis = redis;
-        this.redis.flushAll().catch(logger.error);
-    }
+  constructor(
+    redis: RedisClientType,
+    timeoutInSeconds: number | undefined = 5 * 60,
+  ) {
+    this.redis = redis;
+    this.timeoutInSeconds = timeoutInSeconds;
+  }
 
-    async setDocument(drive: string, id: string, document: Document) {
-        return (await this.redis.hSet(drive, id, JSON.stringify(document))) > 0;
-    }
+  private static _getId(drive: string, id: string) {
+    return `cache:${drive}:${id}`;
+  }
 
-    async getDocument(drive: string, id: string) {
-        const doc = await this.redis.hGet(drive, id);
+  async setDocument(drive: string, id: string, document: Document) {
+    const global = document.operations.global.map((e) => {
+      delete e.resultingState;
+      return e;
+    });
+    const local = document.operations.local.map((e) => {
+      delete e.resultingState;
+      return e;
+    });
+    const doc = { ...document, operations: { global, local } };
+    const redisId = RedisCache._getId(drive, id);
+    const result = await this.redis.set(redisId, JSON.stringify(doc), {
+      EX: this.timeoutInSeconds ? this.timeoutInSeconds : undefined,
+    });
 
-        return doc ? JSON.parse(doc) as Document : undefined;
+    if (result === "OK") {
+      return true;
     }
 
-    async deleteDocument(drive: string, id: string) {
-        return (await this.redis.hDel(drive, id)) > 0;
-    }
+    return false;
+  }
+
+  async getDocument(drive: string, id: string) {
+    const redisId = RedisCache._getId(drive, id);
+    const doc = await this.redis.get(redisId);
+
+    return doc ? (JSON.parse(doc) as Document) : undefined;
+  }
+
+  async deleteDocument(drive: string, id: string) {
+    const redisId = RedisCache._getId(drive, id);
+    return (await this.redis.del(redisId)) > 0;
+  }
 }
 
 export default RedisCache;

package/src/cache/types.ts

@@ -1,9 +1,9 @@
 import type { Document } from "document-model/document";
 
 export interface ICache {
-    setDocument(drive: string, id: string, document: Document): Promise<boolean>
-    getDocument(drive: string, id: string): Promise<Document | undefined>
+  setDocument(drive: string, id: string, document: Document): Promise<boolean>;
+  getDocument(drive: string, id: string): Promise<Document | undefined>;
 
-    // @returns — true if a document existed and has been removed, or false if the document is not cached.
-    deleteDocument(drive: string, id: string): Promise<boolean>
+  // @returns — true if a document existed and has been removed, or false if the document is not cached.
+  deleteDocument(drive: string, id: string): Promise<boolean>;
 }

package/src/index.ts

@@ -1,3 +1,6 @@
-export * from './server';
-export * from './storage';
-export * from './utils';
+export * from "./server";
+export * from "./server/error";
+export * from "./storage";
+export * from "./utils";
+
+export const test = "test";