@vrplatform/kysely 1.3.1 → 1.3.2

package/build/module/local/index.js

@@ -2,9 +2,10 @@ import { join } from 'node:path';
 import { PGlite } from '@electric-sql/pglite';
 import { CamelCasePlugin, Kysely } from 'kysely';
 import { KyselyPGlite } from 'kysely-pglite';
+import { KyselyPganalyzeCommentPlugin } from '../pganalyze-comment-plugin';
 export const root = join(__dirname, '../..');
 export const dumpPath = join(root, '.data.tar');
-export async function useLocalKysely() {
+export async function useLocalKysely(args = {}) {
     let isDestroyed = false;
     const now = performance.now();
     const dump = Bun.file(dumpPath);
@@ -14,7 +15,13 @@ export async function useLocalKysely() {
     const { dialect } = new KyselyPGlite(pglite);
     const kysely = new Kysely({
         dialect,
-        plugins: [new CamelCasePlugin()],
+        log: args.log === true ? ['query', 'error'] : args.log,
+        plugins: [
+            new CamelCasePlugin(),
+            new KyselyPganalyzeCommentPlugin({
+                repository: args.repositoryName ?? 'localTesting',
+            }),
+        ],
     });
     const originalDestroy = kysely.destroy.bind(kysely);
     kysely.destroy = async () => {

package/build/module/local/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["local/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAG7C,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AAC7C,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AAEhD,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAE9B,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEhC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,UAAU;IACV,MAAM,MAAM,CAAC,GAAG,CAAA,UAAU,CAAC;IAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAK;QAC5B,OAAO;QACP,OAAO,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;KACjC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE;QAC1B,IAAI,WAAW;YAAE,OAAO;QACxB,WAAW,GAAG,IAAI,CAAC;QACnB,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACtC,MAAM,eAAe,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CACT,uBAAuB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,IAAI,CACvE,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { join } from 'node:path';\nimport { PGlite } from '@electric-sql/pglite';\nimport { CamelCasePlugin, Kysely } from 'kysely';\nimport { KyselyPGlite } from 'kysely-pglite';\nimport type { DB } from '../v1.generated';\n\nexport const root = join(__dirname, '../..');\nexport const dumpPath = join(root, '.data.tar');\n\nexport async function useLocalKysely() {\n  let isDestroyed = false;\n  const now = performance.now();\n\n  const dump = Bun.file(dumpPath);\n\n  const pglite = new PGlite({ loadDataDir: dump });\n  // warm up\n  await pglite.sql`SELECT 1`;\n  const { dialect } = new KyselyPGlite(pglite);\n  const kysely = new Kysely<DB>({\n    dialect,\n    plugins: [new CamelCasePlugin()],\n  });\n\n  const originalDestroy = kysely.destroy.bind(kysely);\n  kysely.destroy = async () => {\n    if (isDestroyed) return;\n    isDestroyed = true;\n    const destroyTime = performance.now();\n    await originalDestroy().catch(() => undefined);\n    await pglite.close().catch(() => undefined);\n    console.log(\n      `Database destroyed: ${Math.round(performance.now() - destroyTime)}ms`\n    );\n  };\n\n  console.log(`Database initialized: ${Math.round(performance.now() - now)}ms`);\n\n  return kysely;\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["local/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,EAAkB,MAAM,QAAQ,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAG3E,MAAM,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AAC7C,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AAMhD,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAA8B,EAAE;IACnE,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAE9B,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEhC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,UAAU;IACV,MAAM,MAAM,CAAC,GAAG,CAAA,UAAU,CAAC;IAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,MAAM,CAAK;QAC5B,OAAO;QACP,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG;QACtD,OAAO,EAAE;YACP,IAAI,eAAe,EAAE;YACrB,IAAI,4BAA4B,CAAC;gBAC/B,UAAU,EAAE,IAAI,CAAC,cAAc,IAAI,cAAc;aAClD,CAAC;SACH;KACF,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE;QAC1B,IAAI,WAAW;YAAE,OAAO;QACxB,WAAW,GAAG,IAAI,CAAC;QACnB,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACtC,MAAM,eAAe,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CACT,uBAAuB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC,IAAI,CACvE,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IAE9E,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { join } from 'node:path';\nimport { PGlite } from '@electric-sql/pglite';\nimport { CamelCasePlugin, Kysely, type LogConfig } from 'kysely';\nimport { KyselyPGlite } from 'kysely-pglite';\nimport { KyselyPganalyzeCommentPlugin } from '../pganalyze-comment-plugin';\nimport type { DB } from '../v1.generated';\n\nexport const root = join(__dirname, '../..');\nexport const dumpPath = join(root, '.data.tar');\n\nexport type UseLocalKyselyOptions = {\n  repositoryName?: string;\n  log?: true | LogConfig;\n};\nexport async function useLocalKysely(args: UseLocalKyselyOptions = {}) {\n  let isDestroyed = false;\n  const now = performance.now();\n\n  const dump = Bun.file(dumpPath);\n\n  const pglite = new PGlite({ loadDataDir: dump });\n  // warm up\n  await pglite.sql`SELECT 1`;\n  const { dialect } = new KyselyPGlite(pglite);\n  const kysely = new Kysely<DB>({\n    dialect,\n    log: args.log === true ? ['query', 'error'] : args.log,\n    plugins: [\n      new CamelCasePlugin(),\n      new KyselyPganalyzeCommentPlugin({\n        repository: args.repositoryName ?? 'localTesting',\n      }),\n    ],\n  });\n\n  const originalDestroy = kysely.destroy.bind(kysely);\n  kysely.destroy = async () => {\n    if (isDestroyed) return;\n    isDestroyed = true;\n    const destroyTime = performance.now();\n    await originalDestroy().catch(() => undefined);\n    await pglite.close().catch(() => undefined);\n    console.log(\n      `Database destroyed: ${Math.round(performance.now() - destroyTime)}ms`\n    );\n  };\n\n  console.log(`Database initialized: ${Math.round(performance.now() - now)}ms`);\n\n  return kysely;\n}\n"]}

package/build/module/pganalyze-comment-plugin/comment-transformer.d.ts

@@ -0,0 +1,21 @@
+import { type DeleteQueryNode, type InsertQueryNode, OperationNodeTransformer, type RootOperationNode, type SelectQueryNode, type UpdateQueryNode } from 'kysely';
+/**
+ * Transformer that adds a SQL comment to queries for pganalyze tracking.
+ * The comment format is: repository: REPOSITORY_NAME
+ *
+ * This works by appending the comment to queries using the endModifiers property,
+ * similar to how modifyEnd works.
+ */
+export declare class CommentTransformer extends OperationNodeTransformer {
+    readonly _repositoryName: string;
+    constructor(_repositoryName: string);
+    transformRootNode(node: RootOperationNode): RootOperationNode;
+    protected transformSelectQuery(node: SelectQueryNode): SelectQueryNode;
+    protected transformInsertQuery(node: InsertQueryNode): InsertQueryNode;
+    protected transformUpdateQuery(node: UpdateQueryNode): UpdateQueryNode;
+    protected transformDeleteQuery(node: DeleteQueryNode): DeleteQueryNode;
+    private addCommentToSelectQuery;
+    private addCommentToInsertQuery;
+    private addCommentToUpdateQuery;
+    private addCommentToDeleteQuery;
+}

package/build/module/pganalyze-comment-plugin/comment-transformer.js

@@ -0,0 +1,87 @@
+import { OperationNodeTransformer, SelectModifierNode, sql, } from 'kysely';
+function createCommentNode(repositoryName) {
+    return SelectModifierNode.createWithExpression(sql.raw(`/* repository: ${repositoryName} */`).toOperationNode());
+}
+/**
+ * Transformer that adds a SQL comment to queries for pganalyze tracking.
+ * The comment format is: repository: REPOSITORY_NAME
+ *
+ * This works by appending the comment to queries using the endModifiers property,
+ * similar to how modifyEnd works.
+ */
+export class CommentTransformer extends OperationNodeTransformer {
+    _repositoryName;
+    constructor(_repositoryName) {
+        super();
+        this._repositoryName = _repositoryName;
+    }
+    transformRootNode(node) {
+        if (node.kind === 'SelectQueryNode') {
+            return this.transformSelectQuery(node);
+        }
+        if (node.kind === 'InsertQueryNode') {
+            return this.transformInsertQuery(node);
+        }
+        if (node.kind === 'UpdateQueryNode') {
+            return this.transformUpdateQuery(node);
+        }
+        if (node.kind === 'DeleteQueryNode') {
+            return this.transformDeleteQuery(node);
+        }
+        return node;
+    }
+    transformSelectQuery(node) {
+        const transformed = super.transformSelectQuery(node);
+        return this.addCommentToSelectQuery(transformed);
+    }
+    transformInsertQuery(node) {
+        const transformed = super.transformInsertQuery(node);
+        return this.addCommentToInsertQuery(transformed);
+    }
+    transformUpdateQuery(node) {
+        const transformed = super.transformUpdateQuery(node);
+        return this.addCommentToUpdateQuery(transformed);
+    }
+    transformDeleteQuery(node) {
+        const transformed = super.transformDeleteQuery(node);
+        return this.addCommentToDeleteQuery(transformed);
+    }
+    addCommentToSelectQuery(node) {
+        // Append comment using endModifiers property, similar to modifyEnd
+        const commentNode = createCommentNode(this._repositoryName);
+        return {
+            ...node,
+            endModifiers: node.endModifiers
+                ? [...node.endModifiers, commentNode]
+                : [commentNode],
+        };
+    }
+    addCommentToInsertQuery(node) {
+        const commentNode = createCommentNode(this._repositoryName);
+        return {
+            ...node,
+            endModifiers: node.endModifiers
+                ? [...node.endModifiers, commentNode]
+                : [commentNode],
+        };
+    }
+    addCommentToUpdateQuery(node) {
+        const commentNode = createCommentNode(this._repositoryName);
+        return {
+            ...node,
+            endModifiers: node.endModifiers
+                ? [...node.endModifiers, commentNode]
+                : [commentNode],
+        };
+    }
+    addCommentToDeleteQuery(node) {
+        const commentNode = createCommentNode(this._repositoryName);
+        return {
+            ...node,
+            endModifiers: node.endModifiers
+                ? [...node.endModifiers, commentNode]
+                : [commentNode],
+        };
+    }
+}
+//# sourceMappingURL=comment-transformer.js.map

package/build/module/pganalyze-comment-plugin/comment-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-transformer.js","sourceRoot":"src/","sources":["pganalyze-comment-plugin/comment-transformer.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,wBAAwB,EAExB,kBAAkB,EAElB,GAAG,GAEJ,MAAM,QAAQ,CAAC;AAEhB,SAAS,iBAAiB,CAAC,cAAsB;IAC/C,OAAO,kBAAkB,CAAC,oBAAoB,CAC5C,GAAG,CAAC,GAAG,CAAC,kBAAkB,cAAc,KAAK,CAAC,CAAC,eAAe,EAAE,CACjE,CAAC;AACJ,CAAC;AACD;;;;;;GAMG;AACH,MAAM,OAAO,kBAAmB,SAAQ,wBAAwB;IACzC;IAArB,YAAqB,eAAuB;QAC1C,KAAK,EAAE,CAAC;QADW,oBAAe,GAAf,eAAe,CAAQ;IAE5C,CAAC;IAED,iBAAiB,CAAC,IAAuB;QACvC,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEkB,oBAAoB,CACrC,IAAqB;QAErB,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEkB,oBAAoB,CACrC,IAAqB;QAErB,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEkB,oBAAoB,CACrC,IAAqB;QAErB,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEkB,oBAAoB,CACrC,IAAqB;QAErB,MAAM,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEO,uBAAuB,CAAC,IAAqB;QACnD,mEAAmE;QACnE,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE5D,OAAO;YACL,GAAG,IAAI;YACP,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC7B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC;gBACrC,CAAC,CAAC,CAAC,WAAW,CAAC;SAClB,CAAC;IACJ,CAAC;IAEO,uBAAuB,CAAC,IAAqB;QACnD,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE5D,OAAO;YACL,GAAG,IAAI;YACP,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC7B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC;gBACrC,CAAC,CAAC,CAAC,WAAW,CAAC;SAClB,CAAC;IACJ,CAAC;IAEO,uBAAuB,CAAC,IAAqB;QACnD,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE5D,OAAO;YACL,GAAG,IAAI;YACP,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC7B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC;gBACrC,CAAC,CAAC,CAAC,WAAW,CAAC;SAClB,CAAC;IACJ,CAAC;IAEO,uBAAuB,CAAC,IAAqB;QACnD,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAE5D,OAAO;YACL,GAAG,IAAI;YACP,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC7B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC;gBACrC,CAAC,CAAC,CAAC,WAAW,CAAC;SAClB,CAAC;IACJ,CAAC;CACF","sourcesContent":["import {\n  type DeleteQueryNode,\n  type InsertQueryNode,\n  OperationNodeTransformer,\n  type RootOperationNode,\n  SelectModifierNode,\n  type SelectQueryNode,\n  sql,\n  type UpdateQueryNode,\n} from 'kysely';\n\nfunction createCommentNode(repositoryName: string): SelectModifierNode {\n  return SelectModifierNode.createWithExpression(\n    sql.raw(`/* repository: ${repositoryName} */`).toOperationNode()\n  );\n}\n/**\n * Transformer that adds a SQL comment to queries for pganalyze tracking.\n * The comment format is: repository: REPOSITORY_NAME\n *\n * This works by appending the comment to queries using the endModifiers property,\n * similar to how modifyEnd works.\n */\nexport class CommentTransformer extends OperationNodeTransformer {\n  constructor(readonly _repositoryName: string) {\n    super();\n  }\n\n  transformRootNode(node: RootOperationNode): RootOperationNode {\n    if (node.kind === 'SelectQueryNode') {\n      return this.transformSelectQuery(node);\n    }\n    if (node.kind === 'InsertQueryNode') {\n      return this.transformInsertQuery(node);\n    }\n    if (node.kind === 'UpdateQueryNode') {\n      return this.transformUpdateQuery(node);\n    }\n    if (node.kind === 'DeleteQueryNode') {\n      return this.transformDeleteQuery(node);\n    }\n    return node;\n  }\n\n  protected override transformSelectQuery(\n    node: SelectQueryNode\n  ): SelectQueryNode {\n    const transformed = super.transformSelectQuery(node);\n    return this.addCommentToSelectQuery(transformed);\n  }\n\n  protected override transformInsertQuery(\n    node: InsertQueryNode\n  ): InsertQueryNode {\n    const transformed = super.transformInsertQuery(node);\n    return this.addCommentToInsertQuery(transformed);\n  }\n\n  protected override transformUpdateQuery(\n    node: UpdateQueryNode\n  ): UpdateQueryNode {\n    const transformed = super.transformUpdateQuery(node);\n    return this.addCommentToUpdateQuery(transformed);\n  }\n\n  protected override transformDeleteQuery(\n    node: DeleteQueryNode\n  ): DeleteQueryNode {\n    const transformed = super.transformDeleteQuery(node);\n    return this.addCommentToDeleteQuery(transformed);\n  }\n\n  private addCommentToSelectQuery(node: SelectQueryNode): SelectQueryNode {\n    // Append comment using endModifiers property, similar to modifyEnd\n    const commentNode = createCommentNode(this._repositoryName);\n\n    return {\n      ...node,\n      endModifiers: node.endModifiers\n        ? [...node.endModifiers, commentNode]\n        : [commentNode],\n    };\n  }\n\n  private addCommentToInsertQuery(node: InsertQueryNode): InsertQueryNode {\n    const commentNode = createCommentNode(this._repositoryName);\n\n    return {\n      ...node,\n      endModifiers: node.endModifiers\n        ? [...node.endModifiers, commentNode]\n        : [commentNode],\n    };\n  }\n\n  private addCommentToUpdateQuery(node: UpdateQueryNode): UpdateQueryNode {\n    const commentNode = createCommentNode(this._repositoryName);\n\n    return {\n      ...node,\n      endModifiers: node.endModifiers\n        ? [...node.endModifiers, commentNode]\n        : [commentNode],\n    };\n  }\n\n  private addCommentToDeleteQuery(node: DeleteQueryNode): DeleteQueryNode {\n    const commentNode = createCommentNode(this._repositoryName);\n\n    return {\n      ...node,\n      endModifiers: node.endModifiers\n        ? [...node.endModifiers, commentNode]\n        : [commentNode],\n    };\n  }\n}\n"]}

package/build/module/pganalyze-comment-plugin/index.d.ts

@@ -0,0 +1,9 @@
+import type { KyselyPlugin, PluginTransformQueryArgs, PluginTransformResultArgs, QueryResult, RootOperationNode, UnknownRow } from 'kysely';
+export declare class KyselyPganalyzeCommentPlugin implements KyselyPlugin {
+    #private;
+    constructor(options: {
+        repository: string;
+    });
+    transformQuery(args: PluginTransformQueryArgs): RootOperationNode;
+    transformResult(args: PluginTransformResultArgs): Promise<QueryResult<UnknownRow>>;
+}

package/build/module/pganalyze-comment-plugin/index.js

@@ -0,0 +1,14 @@
+import { CommentTransformer } from './comment-transformer';
+export class KyselyPganalyzeCommentPlugin {
+    #transformer;
+    constructor(options) {
+        this.#transformer = new CommentTransformer(options.repository);
+    }
+    transformQuery(args) {
+        return this.#transformer.transformRootNode(args.node);
+    }
+    async transformResult(args) {
+        return args.result;
+    }
+}
+//# sourceMappingURL=index.js.map

package/build/module/pganalyze-comment-plugin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["pganalyze-comment-plugin/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,MAAM,OAAO,4BAA4B;IAC9B,YAAY,CAAqB;IAE1C,YAAY,OAA+B;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAED,cAAc,CAAC,IAA8B;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAA+B;QAE/B,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF","sourcesContent":["import type {\n  KyselyPlugin,\n  PluginTransformQueryArgs,\n  PluginTransformResultArgs,\n  QueryResult,\n  RootOperationNode,\n  UnknownRow,\n} from 'kysely';\nimport { CommentTransformer } from './comment-transformer';\n\nexport class KyselyPganalyzeCommentPlugin implements KyselyPlugin {\n  readonly #transformer: CommentTransformer;\n\n  constructor(options: { repository: string }) {\n    this.#transformer = new CommentTransformer(options.repository);\n  }\n\n  transformQuery(args: PluginTransformQueryArgs): RootOperationNode {\n    return this.#transformer.transformRootNode(args.node);\n  }\n\n  async transformResult(\n    args: PluginTransformResultArgs\n  ): Promise<QueryResult<UnknownRow>> {\n    return args.result;\n  }\n}\n"]}

package/build/module/test/index.d.ts

@@ -0,0 +1,15 @@
+import type { Kysely } from 'kysely';
+import { type UseLocalKyselyOptions } from '../local';
+import type { DB } from '../v1.generated';
+/**
+ * @deprecated Use `useLocalKyselyResource` instead.
+ */
+export declare function useTestKysely(cleanupStrategy: 'afterAll', args?: UseLocalKyselyOptions): Promise<{
+    kysely: Kysely<DB>;
+}>;
+export declare function useTestAutoCleanupKysely(args?: UseLocalKyselyOptions): Promise<Kysely<DB>>;
+type ReturnType = Kysely<DB> & {
+    [Symbol.dispose]: () => Promise<void>;
+};
+export declare function useLocalKyselyResource(args?: UseLocalKyselyOptions): Promise<ReturnType>;
+export {};

package/build/module/test/index.js

@@ -0,0 +1,42 @@
+import { afterAll } from 'bun:test';
+import { useLocalKysely } from '../local';
+/**
+ * @deprecated Use `useLocalKyselyResource` instead.
+ */
+export async function useTestKysely(cleanupStrategy, args) {
+    const kysely = await useLocalKysely(args);
+    if (cleanupStrategy === 'afterAll')
+        afterAll(async () => {
+            await kysely.destroy();
+        });
+    return {
+        kysely,
+    };
+}
+export async function useTestAutoCleanupKysely(args) {
+    const kysely = await useLocalKysely(args);
+    afterAll(async () => {
+        await kysely.destroy();
+    });
+    return kysely;
+}
+export async function useLocalKyselyResource(args) {
+    const kysely = await useLocalKysely(args);
+    return new Proxy({}, {
+        get(_target, prop) {
+            if (prop === Symbol.dispose) {
+                return async () => {
+                    await kysely.destroy();
+                };
+            }
+            if (prop === 'kysely') {
+                return kysely;
+            }
+            if (typeof kysely[prop] === 'function') {
+                return kysely[prop].bind(kysely);
+            }
+            return kysely[prop];
+        },
+    });
+}
+//# sourceMappingURL=index.js.map

package/build/module/test/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["test/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAA8B,cAAc,EAAE,MAAM,UAAU,CAAC;AAGtE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,eAA2B,EAC3B,IAA4B;IAE5B,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAE1C,IAAI,eAAe,KAAK,UAAU;QAChC,QAAQ,CAAC,KAAK,IAAI,EAAE;YAClB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IAEL,OAAO;QACL,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAC,IAA4B;IACzE,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAE1C,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAMD,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,IAA4B;IAE5B,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;IAE1C,OAAO,IAAI,KAAK,CACd,EAAE,EACF;QACE,GAAG,CAAC,OAAO,EAAE,IAAI;YACf,IAAI,IAAI,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO,KAAK,IAAI,EAAE;oBAChB,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;gBACzB,CAAC,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACtB,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE,CAAC;gBACvC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF,CACY,CAAC;AAClB,CAAC","sourcesContent":["import { afterAll } from 'bun:test';\nimport type { Kysely } from 'kysely';\nimport { type UseLocalKyselyOptions, useLocalKysely } from '../local';\nimport type { DB } from '../v1.generated';\n\n/**\n * @deprecated Use `useLocalKyselyResource` instead.\n */\nexport async function useTestKysely(\n  cleanupStrategy: 'afterAll',\n  args?: UseLocalKyselyOptions\n) {\n  const kysely = await useLocalKysely(args);\n\n  if (cleanupStrategy === 'afterAll')\n    afterAll(async () => {\n      await kysely.destroy();\n    });\n\n  return {\n    kysely,\n  };\n}\n\nexport async function useTestAutoCleanupKysely(args?: UseLocalKyselyOptions) {\n  const kysely = await useLocalKysely(args);\n\n  afterAll(async () => {\n    await kysely.destroy();\n  });\n\n  return kysely;\n}\n\ntype ReturnType = Kysely<DB> & {\n  [Symbol.dispose]: () => Promise<void>;\n};\n\nexport async function useLocalKyselyResource(\n  args?: UseLocalKyselyOptions\n): Promise<ReturnType> {\n  const kysely = await useLocalKysely(args);\n\n  return new Proxy(\n    {},\n    {\n      get(_target, prop) {\n        if (prop === Symbol.dispose) {\n          return async () => {\n            await kysely.destroy();\n          };\n        }\n        if (prop === 'kysely') {\n          return kysely;\n        }\n        if (typeof kysely[prop] === 'function') {\n          return kysely[prop].bind(kysely);\n        }\n        return kysely[prop];\n      },\n    }\n  ) as ReturnType;\n}\n"]}

package/build/module/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/index.ts","../../src/test.ts","../../src/v1.generated.ts","../../src/local/generate.ts","../../src/local/index.ts"],"version":"5.9.3"}
+{"root":["../../src/index.ts","../../src/v1.generated.ts","../../src/local/generate.ts","../../src/local/index.ts","../../src/pganalyze-comment-plugin/comment-transformer.ts","../../src/pganalyze-comment-plugin/index.ts","../../src/test/index.ts"],"version":"5.9.3"}

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "",
   "main": "build/main/index.js",
   "module": "build/module/index.js",

package/src/index.ts

@@ -1,5 +1,11 @@
 import { serializeError } from '@finalytic/utils';
-import { CamelCasePlugin, Kysely as K, type Transaction as T } from 'kysely';
+import {
+  CamelCasePlugin,
+  Kysely as K,
+  type KyselyPlugin,
+  type LogConfig,
+  type Transaction as T,
+} from 'kysely';
 import { PostgresJSDialect } from 'kysely-postgres-js';
 import postgres, { type Sql } from 'postgres';
 
@@ -21,11 +27,17 @@ export { jsonArrayFrom } from 'kysely/helpers/postgres';
 export * from './v1.generated';
 
 import { join, relative } from 'node:path';
+import { KyselyPganalyzeCommentPlugin } from './pganalyze-comment-plugin';
 import type { DB } from './v1.generated';
 
 export type Transaction = T<DB>;
 export { sql } from 'kysely';
 
+type KyselyOpts = {
+  repositoryName?: string;
+  log?: true | LogConfig;
+};
+
 type PgOpt = {
   forceDisableSSL?: boolean;
   retries?: false | number;
@@ -36,14 +48,22 @@ export type Postgres = Sql;
 /**
  * @deprecated This method is deprecated in favor of the useAsyncKysely method.
  */
-export function useKysely(postgres: Sql, options: { log?: boolean } = {}) {
+export function useKysely(postgres: Sql, options?: KyselyOpts) {
   console.debug('Creating Kysely instance');
+  const plugins: KyselyPlugin[] = [new CamelCasePlugin()];
+  if (options?.repositoryName) {
+    plugins.push(
+      new KyselyPganalyzeCommentPlugin({
+        repository: options.repositoryName,
+      })
+    );
+  }
   const kysely = new K<DB>({
     dialect: new PostgresJSDialect({
       postgres,
     }),
-    plugins: [new CamelCasePlugin()],
-    log: options?.log ? ['query', 'error'] : undefined,
+    plugins,
+    log: options?.log === true ? ['query', 'error'] : options?.log,
   });
 
   kysely.destroy = async () => {
@@ -78,8 +98,8 @@ export async function useAsyncPostgres(connectionString: string, opt?: PgOpt) {
         ssl: ssl ? 'require' : false,
         // connect_timeout: 10
         // idle_timeout: 10
-        // disable prepare statements since we use pgbouncer
-        prepare: false,
+        // enable prepare statements, pgbouncer on crunchy allows for prepared statements
+        prepare: true,
         connect_timeout: 10,
         idle_timeout: 60,
       });
@@ -107,9 +127,12 @@ export async function useAsyncPostgres(connectionString: string, opt?: PgOpt) {
   throw new Error('Unable to connect to Postgres');
 }
 
-export async function useAsyncKysely(connectionString: string, opt?: PgOpt) {
+export async function useAsyncKysely(
+  connectionString: string,
+  opt?: PgOpt & KyselyOpts
+) {
   const sql = await useAsyncPostgres(connectionString, opt);
-  return useKysely(sql);
+  return useKysely(sql, opt);
 }
 
 /**

package/src/local/index.ts

@@ -1,13 +1,18 @@
 import { join } from 'node:path';
 import { PGlite } from '@electric-sql/pglite';
-import { CamelCasePlugin, Kysely } from 'kysely';
+import { CamelCasePlugin, Kysely, type LogConfig } from 'kysely';
 import { KyselyPGlite } from 'kysely-pglite';
+import { KyselyPganalyzeCommentPlugin } from '../pganalyze-comment-plugin';
 import type { DB } from '../v1.generated';
 
 export const root = join(__dirname, '../..');
 export const dumpPath = join(root, '.data.tar');
 
-export async function useLocalKysely() {
+export type UseLocalKyselyOptions = {
+  repositoryName?: string;
+  log?: true | LogConfig;
+};
+export async function useLocalKysely(args: UseLocalKyselyOptions = {}) {
   let isDestroyed = false;
   const now = performance.now();
 
@@ -19,7 +24,13 @@ export async function useLocalKysely() {
   const { dialect } = new KyselyPGlite(pglite);
   const kysely = new Kysely<DB>({
     dialect,
-    plugins: [new CamelCasePlugin()],
+    log: args.log === true ? ['query', 'error'] : args.log,
+    plugins: [
+      new CamelCasePlugin(),
+      new KyselyPganalyzeCommentPlugin({
+        repository: args.repositoryName ?? 'localTesting',
+      }),
+    ],
   });
 
   const originalDestroy = kysely.destroy.bind(kysely);

package/src/pganalyze-comment-plugin/comment-transformer.ts

@@ -0,0 +1,117 @@
+import {
+  type DeleteQueryNode,
+  type InsertQueryNode,
+  OperationNodeTransformer,
+  type RootOperationNode,
+  SelectModifierNode,
+  type SelectQueryNode,
+  sql,
+  type UpdateQueryNode,
+} from 'kysely';
+
+function createCommentNode(repositoryName: string): SelectModifierNode {
+  return SelectModifierNode.createWithExpression(
+    sql.raw(`/* repository: ${repositoryName} */`).toOperationNode()
+  );
+}
+/**
+ * Transformer that adds a SQL comment to queries for pganalyze tracking.
+ * The comment format is: repository: REPOSITORY_NAME
+ *
+ * This works by appending the comment to queries using the endModifiers property,
+ * similar to how modifyEnd works.
+ */
+export class CommentTransformer extends OperationNodeTransformer {
+  constructor(readonly _repositoryName: string) {
+    super();
+  }
+
+  transformRootNode(node: RootOperationNode): RootOperationNode {
+    if (node.kind === 'SelectQueryNode') {
+      return this.transformSelectQuery(node);
+    }
+    if (node.kind === 'InsertQueryNode') {
+      return this.transformInsertQuery(node);
+    }
+    if (node.kind === 'UpdateQueryNode') {
+      return this.transformUpdateQuery(node);
+    }
+    if (node.kind === 'DeleteQueryNode') {
+      return this.transformDeleteQuery(node);
+    }
+    return node;
+  }
+
+  protected override transformSelectQuery(
+    node: SelectQueryNode
+  ): SelectQueryNode {
+    const transformed = super.transformSelectQuery(node);
+    return this.addCommentToSelectQuery(transformed);
+  }
+
+  protected override transformInsertQuery(
+    node: InsertQueryNode
+  ): InsertQueryNode {
+    const transformed = super.transformInsertQuery(node);
+    return this.addCommentToInsertQuery(transformed);
+  }
+
+  protected override transformUpdateQuery(
+    node: UpdateQueryNode
+  ): UpdateQueryNode {
+    const transformed = super.transformUpdateQuery(node);
+    return this.addCommentToUpdateQuery(transformed);
+  }
+
+  protected override transformDeleteQuery(
+    node: DeleteQueryNode
+  ): DeleteQueryNode {
+    const transformed = super.transformDeleteQuery(node);
+    return this.addCommentToDeleteQuery(transformed);
+  }
+
+  private addCommentToSelectQuery(node: SelectQueryNode): SelectQueryNode {
+    // Append comment using endModifiers property, similar to modifyEnd
+    const commentNode = createCommentNode(this._repositoryName);
+
+    return {
+      ...node,
+      endModifiers: node.endModifiers
+        ? [...node.endModifiers, commentNode]
+        : [commentNode],
+    };
+  }
+
+  private addCommentToInsertQuery(node: InsertQueryNode): InsertQueryNode {
+    const commentNode = createCommentNode(this._repositoryName);
+
+    return {
+      ...node,
+      endModifiers: node.endModifiers
+        ? [...node.endModifiers, commentNode]
+        : [commentNode],
+    };
+  }
+
+  private addCommentToUpdateQuery(node: UpdateQueryNode): UpdateQueryNode {
+    const commentNode = createCommentNode(this._repositoryName);
+
+    return {
+      ...node,
+      endModifiers: node.endModifiers
+        ? [...node.endModifiers, commentNode]
+        : [commentNode],
+    };
+  }
+
+  private addCommentToDeleteQuery(node: DeleteQueryNode): DeleteQueryNode {
+    const commentNode = createCommentNode(this._repositoryName);
+
+    return {
+      ...node,
+      endModifiers: node.endModifiers
+        ? [...node.endModifiers, commentNode]
+        : [commentNode],
+    };
+  }
+}

package/src/pganalyze-comment-plugin/index.ts

@@ -0,0 +1,27 @@
+import type {
+  KyselyPlugin,
+  PluginTransformQueryArgs,
+  PluginTransformResultArgs,
+  QueryResult,
+  RootOperationNode,
+  UnknownRow,
+} from 'kysely';
+import { CommentTransformer } from './comment-transformer';
+
+export class KyselyPganalyzeCommentPlugin implements KyselyPlugin {
+  readonly #transformer: CommentTransformer;
+
+  constructor(options: { repository: string }) {
+    this.#transformer = new CommentTransformer(options.repository);
+  }
+
+  transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
+    return this.#transformer.transformRootNode(args.node);
+  }
+
+  async transformResult(
+    args: PluginTransformResultArgs
+  ): Promise<QueryResult<UnknownRow>> {
+    return args.result;
+  }
+}

package/src/test/index.ts

@@ -0,0 +1,63 @@
+import { afterAll } from 'bun:test';
+import type { Kysely } from 'kysely';
+import { type UseLocalKyselyOptions, useLocalKysely } from '../local';
+import type { DB } from '../v1.generated';
+
+/**
+ * @deprecated Use `useLocalKyselyResource` instead.
+ */
+export async function useTestKysely(
+  cleanupStrategy: 'afterAll',
+  args?: UseLocalKyselyOptions
+) {
+  const kysely = await useLocalKysely(args);
+
+  if (cleanupStrategy === 'afterAll')
+    afterAll(async () => {
+      await kysely.destroy();
+    });
+
+  return {
+    kysely,
+  };
+}
+
+export async function useTestAutoCleanupKysely(args?: UseLocalKyselyOptions) {
+  const kysely = await useLocalKysely(args);
+
+  afterAll(async () => {
+    await kysely.destroy();
+  });
+
+  return kysely;
+}
+
+type ReturnType = Kysely<DB> & {
+  [Symbol.dispose]: () => Promise<void>;
+};
+
+export async function useLocalKyselyResource(
+  args?: UseLocalKyselyOptions
+): Promise<ReturnType> {
+  const kysely = await useLocalKysely(args);
+
+  return new Proxy(
+    {},
+    {
+      get(_target, prop) {
+        if (prop === Symbol.dispose) {
+          return async () => {
+            await kysely.destroy();
+          };
+        }
+        if (prop === 'kysely') {
+          return kysely;
+        }
+        if (typeof kysely[prop] === 'function') {
+          return kysely[prop].bind(kysely);
+        }
+        return kysely[prop];
+      },
+    }
+  ) as ReturnType;
+}

package/src/test.ts

@@ -1,19 +0,0 @@
-import { afterAll } from 'bun:test';
-import { useLocalKysely } from './local';
-
-export async function useTestKysely(
-  cleanupStrategy: 'afterAll' | 'using' | 'manual'
-) {
-  const kysely = await useLocalKysely();
-
-  if (cleanupStrategy === 'afterAll')
-    afterAll(async () => {
-      await kysely.destroy();
-    });
-  return {
-    kysely,
-    [Symbol.dispose]: async () => {
-      await kysely.destroy();
-    },
-  };
-}