@workglow/storage 0.2.6 → 0.2.8

package/dist/kv/KvViaTabularStorage.d.ts

@@ -6,19 +6,14 @@
 import type { BaseTabularStorage } from "../tabular/BaseTabularStorage";
 import { DefaultKeyValueKey, DefaultKeyValueSchema } from "./IKvStorage";
 import { KvStorage } from "./KvStorage";
-/**
- * Abstract base class for key-value storage repositories that uses a tabular repository for storage.
- * Has a basic event emitter for listening to repository events.
- *
- * @template Key - The type of the primary key
- * @template Value - The type of the value being stored
- * @template Combined - Combined type of Key & Value
- */
 export declare abstract class KvViaTabularStorage<Key extends string = string, Value extends any = any, Combined = {
     key: Key;
     value: Value;
 }> extends KvStorage<Key, Value, Combined> {
     abstract tabularRepository: BaseTabularStorage<typeof DefaultKeyValueSchema, typeof DefaultKeyValueKey>;
+    /** Whether values need JSON serialization (cached from schema) */
+    private get needsJsonSerialization();
+    private _needsJsonSerialization;
     /**
      * Sets up the database for the repository.
      * Must be called before using any other methods.

package/dist/kv/KvViaTabularStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KvViaTabularStorage.d.ts","sourceRoot":"","sources":["../../src/kv/KvViaTabularStorage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;GAOG;AACH,8BAAsB,mBAAmB,CACvC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,KAAK,SAAS,GAAG,GAAG,GAAG,EACvB,QAAQ,GAAG;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CACrC,SAAQ,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC;IACvC,SAAgB,iBAAiB,EAAE,kBAAkB,CACnD,OAAO,qBAAqB,EAC5B,OAAO,kBAAkB,CAC1B,CAAC;IAEF;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;;OAIG;IACU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CActD;IAED;;;OAGG;IACU,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAkB5E;IAED;;;;;;OAMG;IACU,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAuBrD;IAED;;;OAGG;IACU,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3C;IAED;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CA4BrD;IAED;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAEtC;IAED;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnC;IAED;;OAEG;IACH,OAAO,IAAI,IAAI,CAEd;CACF"}
+{"version":3,"file":"KvViaTabularStorage.d.ts","sourceRoot":"","sources":["../../src/kv/KvViaTabularStorage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAaxC,8BAAsB,mBAAmB,CACvC,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,KAAK,SAAS,GAAG,GAAG,GAAG,EACvB,QAAQ,GAAG;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CACrC,SAAQ,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC;IACvC,SAAgB,iBAAiB,EAAE,kBAAkB,CACnD,OAAO,qBAAqB,EAC5B,OAAO,kBAAkB,CAC1B,CAAC;IAEF,kEAAkE;IAClE,OAAO,KAAK,sBAAsB,GAWjC;IACD,OAAO,CAAC,uBAAuB,CAAsB;IAErD;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;;OAIG;IACU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAKtD;IAED;;;OAGG;IACU,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,GAAG,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAM5E;IAED;;;;;;OAMG;IACU,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAYrD;IAED;;;OAGG;IACU,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3C;IAED;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,CAoBrD;IAED;;OAEG;IACU,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAEtC;IAED;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAEnC;IAED;;OAEG;IACH,OAAO,IAAI,IAAI,CAEd;CACF"}

package/dist/node.js

@@ -398,30 +398,36 @@ class InMemoryTabularStorage extends BaseTabularStorage {
   }
   async put(value) {
     let entityToStore = value;
-    if (this.hasAutoGeneratedKey() && this.autoGeneratedKeyName) {
-      const keyName = this.autoGeneratedKeyName;
-      const clientProvidedValue = value[keyName];
-      const hasClientValue = clientProvidedValue !== undefined && clientProvidedValue !== null;
-      let shouldGenerate = false;
-      if (this.clientProvidedKeys === "never") {
-        shouldGenerate = true;
-      } else if (this.clientProvidedKeys === "always") {
-        if (!hasClientValue) {
-          throw new Error(`Auto-generated key "${keyName}" is required when clientProvidedKeys is "always"`);
+    const savedCounter = this.autoIncrementCounter;
+    try {
+      if (this.hasAutoGeneratedKey() && this.autoGeneratedKeyName) {
+        const keyName = this.autoGeneratedKeyName;
+        const clientProvidedValue = value[keyName];
+        const hasClientValue = clientProvidedValue !== undefined && clientProvidedValue !== null;
+        let shouldGenerate = false;
+        if (this.clientProvidedKeys === "never") {
+          shouldGenerate = true;
+        } else if (this.clientProvidedKeys === "always") {
+          if (!hasClientValue) {
+            throw new Error(`Auto-generated key "${keyName}" is required when clientProvidedKeys is "always"`);
+          }
+          shouldGenerate = false;
+        } else {
+          shouldGenerate = !hasClientValue;
+        }
+        if (shouldGenerate) {
+          const generatedValue = this.generateKeyValue(keyName, this.autoGeneratedKeyStrategy);
+          entityToStore = { ...value, [keyName]: generatedValue };
         }
-        shouldGenerate = false;
-      } else {
-        shouldGenerate = !hasClientValue;
-      }
-      if (shouldGenerate) {
-        const generatedValue = this.generateKeyValue(keyName, this.autoGeneratedKeyStrategy);
-        entityToStore = { ...value, [keyName]: generatedValue };
       }
+      const { key } = this.separateKeyValueFromCombined(entityToStore);
+      const id = await makeFingerprint2(key);
+      this._lastPutWasInsert = !this.values.has(id);
+      this.values.set(id, entityToStore);
+    } catch (e) {
+      this.autoIncrementCounter = savedCounter;
+      throw e;
     }
-    const { key } = this.separateKeyValueFromCombined(entityToStore);
-    const id = await makeFingerprint2(key);
-    this._lastPutWasInsert = !this.values.has(id);
-    this.values.set(id, entityToStore);
     this.events.emit("put", entityToStore);
     return entityToStore;
   }
@@ -1277,46 +1283,42 @@ class KvStorage {
 }
 
 // src/kv/KvViaTabularStorage.ts
+var PRIMITIVE_SCHEMA_TYPES = new Set(["number", "boolean", "string", "blob"]);
+
 class KvViaTabularStorage extends KvStorage {
+  get needsJsonSerialization() {
+    if (this._needsJsonSerialization === undefined) {
+      const schemaType = typeof this.valueSchema === "object" && this.valueSchema !== null && "type" in this.valueSchema ? this.valueSchema.type : undefined;
+      this._needsJsonSerialization = !PRIMITIVE_SCHEMA_TYPES.has(schemaType);
+    }
+    return this._needsJsonSerialization;
+  }
+  _needsJsonSerialization;
   async setupDatabase() {
     await this.tabularRepository.setupDatabase?.();
   }
   async put(key, value) {
-    const schemaType = typeof this.valueSchema === "object" && this.valueSchema !== null && "type" in this.valueSchema ? this.valueSchema.type : undefined;
-    const shouldStringify = !["number", "boolean", "string", "blob"].includes(schemaType);
-    if (shouldStringify) {
+    if (this.needsJsonSerialization) {
       value = JSON.stringify(value);
     }
     await this.tabularRepository.put({ key, value });
   }
   async putBulk(items) {
-    const schemaType = typeof this.valueSchema === "object" && this.valueSchema !== null && "type" in this.valueSchema ? this.valueSchema.type : undefined;
-    const shouldStringify = !["number", "boolean", "string", "blob"].includes(schemaType);
-    const entities = items.map(({ key, value }) => {
-      if (shouldStringify) {
-        value = JSON.stringify(value);
-      }
-      return { key, value };
-    });
+    const entities = this.needsJsonSerialization ? items.map(({ key, value }) => ({ key, value: JSON.stringify(value) })) : items;
     await this.tabularRepository.putBulk(entities);
   }
   async get(key) {
     const result = await this.tabularRepository.get({ key });
-    if (result) {
-      const schemaType = typeof this.valueSchema === "object" && this.valueSchema !== null && "type" in this.valueSchema ? this.valueSchema.type : undefined;
-      const shouldParse = !["number", "boolean", "string", "blob"].includes(schemaType);
-      if (shouldParse) {
-        try {
-          return JSON.parse(result.value);
-        } catch (e) {
-          return result.value;
-        }
-      } else {
+    if (!result)
+      return;
+    if (this.needsJsonSerialization) {
+      try {
+        return JSON.parse(result.value);
+      } catch (e) {
         return result.value;
       }
-    } else {
-      return;
     }
+    return result.value;
   }
   async delete(key) {
     return await this.tabularRepository.delete({ key });
@@ -1327,9 +1329,7 @@ class KvViaTabularStorage extends KvStorage {
       return values.map((value) => ({
         key: value.key,
         value: (() => {
-          const schemaType = typeof this.valueSchema === "object" && this.valueSchema !== null && "type" in this.valueSchema ? this.valueSchema.type : undefined;
-          const shouldParse = !["number", "boolean", "string"].includes(schemaType);
-          if (shouldParse && typeof value.value === "string") {
+          if (this.needsJsonSerialization && typeof value.value === "string") {
             try {
               return JSON.parse(value.value);
             } catch (e) {
@@ -2503,31 +2503,40 @@ import { createServiceToken as createServiceToken13 } from "@workglow/util";
 // src/tabular/BaseSqlTabularStorage.ts
 class BaseSqlTabularStorage extends BaseTabularStorage {
   table;
+  _pkColsCache = new Map;
+  _valColsCache = new Map;
+  _pkColListCache = new Map;
+  _valColListCache = new Map;
   constructor(table = "tabular_store", schema, primaryKeyNames, indexes = [], clientProvidedKeys = "if-missing") {
     super(schema, primaryKeyNames, indexes, clientProvidedKeys);
     this.table = table;
     this.validateTableAndSchema();
   }
   constructPrimaryKeyColumns($delimiter = "") {
-    const cols = Object.entries(this.primaryKeySchema.properties).map(([key, typeDef]) => {
-      const sqlType = this.mapTypeToSQL(typeDef);
-      return `${$delimiter}${key}${$delimiter} ${sqlType} NOT NULL`;
-    }).join(", ");
-    return cols;
+    let cached = this._pkColsCache.get($delimiter);
+    if (cached === undefined) {
+      cached = Object.entries(this.primaryKeySchema.properties).map(([key, typeDef]) => {
+        const sqlType = this.mapTypeToSQL(typeDef);
+        return `${$delimiter}${key}${$delimiter} ${sqlType} NOT NULL`;
+      }).join(", ");
+      this._pkColsCache.set($delimiter, cached);
+    }
+    return cached;
   }
   constructValueColumns($delimiter = "") {
-    const requiredSet = new Set(this.valueSchema.required ?? []);
-    const cols = Object.entries(this.valueSchema.properties).map(([key, typeDef]) => {
-      const sqlType = this.mapTypeToSQL(typeDef);
-      const isRequired = requiredSet.has(key);
-      const nullable = !isRequired || this.isNullable(typeDef);
-      return `${$delimiter}${key}${$delimiter} ${sqlType}${nullable ? " NULL" : " NOT NULL"}`;
-    }).join(", ");
-    if (cols.length > 0) {
-      return `, ${cols}`;
-    } else {
-      return "";
-    }
+    let cached = this._valColsCache.get($delimiter);
+    if (cached === undefined) {
+      const requiredSet = new Set(this.valueSchema.required ?? []);
+      const cols = Object.entries(this.valueSchema.properties).map(([key, typeDef]) => {
+        const sqlType = this.mapTypeToSQL(typeDef);
+        const isRequired = requiredSet.has(key);
+        const nullable = !isRequired || this.isNullable(typeDef);
+        return `${$delimiter}${key}${$delimiter} ${sqlType}${nullable ? " NULL" : " NOT NULL"}`;
+      }).join(", ");
+      cached = cols.length > 0 ? `, ${cols}` : "";
+      this._valColsCache.set($delimiter, cached);
+    }
+    return cached;
   }
   isNullable(typeDef) {
     if (typeof typeDef === "boolean")
@@ -2547,10 +2556,20 @@ class BaseSqlTabularStorage extends BaseTabularStorage {
     return false;
   }
   primaryKeyColumnList($delimiter = "") {
-    return $delimiter + this.primaryKeyColumns().join(`${$delimiter}, ${$delimiter}`) + $delimiter;
+    let cached = this._pkColListCache.get($delimiter);
+    if (cached === undefined) {
+      cached = $delimiter + this.primaryKeyColumns().join(`${$delimiter}, ${$delimiter}`) + $delimiter;
+      this._pkColListCache.set($delimiter, cached);
+    }
+    return cached;
   }
   valueColumnList($delimiter = "") {
-    return $delimiter + this.valueColumns().join(`${$delimiter}, ${$delimiter}`) + $delimiter;
+    let cached = this._valColListCache.get($delimiter);
+    if (cached === undefined) {
+      cached = $delimiter + this.valueColumns().join(`${$delimiter}, ${$delimiter}`) + $delimiter;
+      this._valColListCache.set($delimiter, cached);
+    }
+    return cached;
   }
   getNonNullType(typeDef) {
     if (typeof typeDef === "boolean")
@@ -4285,6 +4304,7 @@ class SupabaseKvStorage extends KvViaTabularStorage {
 // src/queue/PostgresQueueStorage.ts
 import { createServiceToken as createServiceToken21, makeFingerprint as makeFingerprint6, uuid4 as uuid45 } from "@workglow/util";
 var POSTGRES_QUEUE_STORAGE = createServiceToken21("jobqueue.storage.postgres");
+var SAFE_IDENTIFIER = /^[a-zA-Z][a-zA-Z0-9_]*$/;
 
 class PostgresQueueStorage {
   db;
@@ -4297,6 +4317,11 @@ class PostgresQueueStorage {
     this.queueName = queueName;
     this.prefixes = options?.prefixes ?? [];
     this.prefixValues = options?.prefixValues ?? {};
+    for (const prefix of this.prefixes) {
+      if (!SAFE_IDENTIFIER.test(prefix.name)) {
+        throw new Error(`Prefix column name must start with a letter and contain only letters, digits, and underscores, got: ${prefix.name}`);
+      }
+    }
     if (this.prefixes.length > 0) {
       const prefixNames = this.prefixes.map((p) => p.name).join("_");
       this.tableName = `job_queue_${prefixNames}`;
@@ -4331,7 +4356,13 @@ class PostgresQueueStorage {
   async setupDatabase() {
     let sql;
     try {
-      sql = `CREATE TYPE job_status AS ENUM (${Object.values(JobStatus).map((v) => `'${v}'`).join(",")})`;
+      const enumValues = Object.values(JobStatus);
+      for (const v of enumValues) {
+        if (!SAFE_IDENTIFIER.test(v)) {
+          throw new Error(`Invalid JobStatus enum value: ${v}`);
+        }
+      }
+      sql = `CREATE TYPE job_status AS ENUM (${enumValues.map((v) => `'${v}'`).join(",")})`;
       await this.db.query(sql);
     } catch (e) {
       if (e.code !== "42710")
@@ -8340,4 +8371,4 @@ export {
   BaseTabularStorage
 };
 
-//# debugId=BD55FF0C4CA671A364756E2164756E21
+//# debugId=BF385EFC980250A064756E2164756E21