@teamkeel/functions-runtime 0.335.0 → 0.337.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamkeel/functions-runtime",
-  "version": "0.335.0",
+  "version": "0.337.0",
   "description": "Internal package used by @teamkeel/sdk",
   "main": "src/index.js",
   "scripts": {
@@ -21,7 +21,6 @@
   "dependencies": {
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/exporter-trace-otlp-proto": "^0.38.0",
-    "@opentelemetry/instrumentation": "^0.40.0",
     "@opentelemetry/resources": "^1.12.0",
     "@opentelemetry/sdk-trace-base": "^1.12.0",
     "@opentelemetry/sdk-trace-node": "^1.12.0",

package/pnpm-lock.yaml

@@ -7,9 +7,6 @@ dependencies:
   '@opentelemetry/exporter-trace-otlp-proto':
     specifier: ^0.38.0
     version: 0.38.0(@opentelemetry/api@1.4.1)
-  '@opentelemetry/instrumentation':
-    specifier: ^0.40.0
-    version: 0.40.0(@opentelemetry/api@1.4.1)
   '@opentelemetry/resources':
     specifier: ^1.12.0
     version: 1.12.0(@opentelemetry/api@1.4.1)
@@ -282,22 +279,6 @@ packages:
       '@opentelemetry/sdk-trace-base': 1.12.0(@opentelemetry/api@1.4.1)
     dev: false
 
-  /@opentelemetry/instrumentation@0.40.0(@opentelemetry/api@1.4.1):
-    resolution: {integrity: sha512-23TzBKPflUS1uEq5SXymnQKQDSda35KvHjnvxdcDQGE+wg6hwDHgScUCWiBmZW4sxAaPcANfs+Wc9B7yDuyT6Q==}
-    engines: {node: '>=14'}
-    peerDependencies:
-      '@opentelemetry/api': ^1.3.0
-    dependencies:
-      '@opentelemetry/api': 1.4.1
-      '@types/shimmer': 1.0.2
-      import-in-the-middle: 1.3.5
-      require-in-the-middle: 7.1.1
-      semver: 7.5.0
-      shimmer: 1.2.1
-    transitivePeerDependencies:
-      - supports-color
-    dev: false
-
   /@opentelemetry/otlp-exporter-base@0.38.0(@opentelemetry/api@1.4.1):
     resolution: {integrity: sha512-VWQo7vUDyW/7/FT8RErAtM/29i/fllCc9xMtnK7kDuheAjJU68zrZ88bQOsLamHvOCU3KVpozjfTZVxZKQRYXw==}
     engines: {node: '>=14'}
@@ -464,10 +445,6 @@ packages:
   /@types/node@18.11.18:
     resolution: {integrity: sha512-DHQpWGjyQKSHj3ebjFI/wRKcqQcdR+MoFBygntYOZytCqNfkd2ZC4ARDJ2DQqhjH5p85Nnd3jhUJIXrszFX/JA==}
 
-  /@types/shimmer@1.0.2:
-    resolution: {integrity: sha512-dKkr1bTxbEsFlh2ARpKzcaAmsYixqt9UyCdoEZk8rHyE4iQYcDCyvSjDSf7JUWJHlJiTtbIoQjxKh6ViywqDAg==}
-    dev: false
-
   /acorn-walk@8.2.0:
     resolution: {integrity: sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==}
     engines: {node: '>=0.4.0'}
@@ -568,6 +545,7 @@ packages:
         optional: true
     dependencies:
       ms: 2.1.2
+    dev: true
 
   /deep-eql@4.1.3:
     resolution: {integrity: sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==}
@@ -623,6 +601,7 @@ packages:
 
   /function-bind@1.1.1:
     resolution: {integrity: sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==}
+    dev: true
 
   /get-func-name@2.0.0:
     resolution: {integrity: sha512-Hm0ixYtaSZ/V7C8FJrtZIuBBI+iSgL+1Aq82zSu8VQNB4S3Gk8e7Qs3VwBDJAhmRZcFqkl3tQu36g/Foh5I5ig==}
@@ -633,6 +612,7 @@ packages:
     engines: {node: '>= 0.4.0'}
     dependencies:
       function-bind: 1.1.1
+    dev: true
 
   /header-case@2.0.4:
     resolution: {integrity: sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==}
@@ -641,16 +621,11 @@ packages:
       tslib: 2.4.1
     dev: false
 
-  /import-in-the-middle@1.3.5:
-    resolution: {integrity: sha512-yzHlBqi1EBFrkieAnSt8eTgO5oLSl+YJ7qaOpUH/PMqQOMZoQ/RmDlwnTLQrwYto+gHYjRG+i/IbsB1eDx32NQ==}
-    dependencies:
-      module-details-from-path: 1.0.3
-    dev: false
-
   /is-core-module@2.11.0:
     resolution: {integrity: sha512-RRjxlvLDkD1YJwDbroBHMb+cukurkDWNyHx7D3oNB5x9rb5ogcksMC5wHCadcXoo67gVr/+3GFySh3134zi6rw==}
     dependencies:
       has: 1.0.3
+    dev: true
 
   /json-rpc-2.0@1.4.2:
     resolution: {integrity: sha512-oqiMRhWN4Q+2ySitZR5GA9vtiNOK19GTDDad0yn8/T/ND+Ap81QP6+3UMl738H4bmRbCEwhQkkBruNqx7EXfUQ==}
@@ -712,12 +687,9 @@ packages:
       ufo: 1.0.1
     dev: true
 
-  /module-details-from-path@1.0.3:
-    resolution: {integrity: sha512-ySViT69/76t8VhE1xXHK6Ch4NcDd26gx0MzKXLO+F7NOtnqH68d9zF94nT8ZWSxXh8ELOERsnJO/sWt1xZYw5A==}
-    dev: false
-
   /ms@2.1.2:
     resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==}
+    dev: true
 
   /nanoid@3.3.4:
     resolution: {integrity: sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==}
@@ -759,6 +731,7 @@ packages:
 
   /path-parse@1.0.7:
     resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==}
+    dev: true
 
   /pathe@0.2.0:
     resolution: {integrity: sha512-sTitTPYnn23esFR3RlqYBWn4c45WGeLcsKzQiUpXJAyfcWkolvlYpV8FLo7JishK946oQwMFUCHXQ9AjGPKExw==}
@@ -896,17 +869,6 @@ packages:
       long: 5.2.3
     dev: false
 
-  /require-in-the-middle@7.1.1:
-    resolution: {integrity: sha512-OScOjQjrrjhAdFpQmnkE/qbIBGCRFhQB/YaJhcC3CPOlmhe7llnW46Ac1J5+EjcNXOTnDdpF96Erw/yedsGksQ==}
-    engines: {node: '>=8.6.0'}
-    dependencies:
-      debug: 4.3.4
-      module-details-from-path: 1.0.3
-      resolve: 1.22.1
-    transitivePeerDependencies:
-      - supports-color
-    dev: false
-
   /resolve@1.22.1:
     resolution: {integrity: sha512-nBpuuYuY5jFsli/JIs1oldw6fOQCBioohqWZg/2hiaOybXOft4lonv85uDOKXdf8rhyK159cxU5cDcK/NKk8zw==}
     hasBin: true
@@ -914,6 +876,7 @@ packages:
       is-core-module: 2.11.0
       path-parse: 1.0.7
       supports-preserve-symlinks-flag: 1.0.0
+    dev: true
 
   /rollup@3.10.0:
     resolution: {integrity: sha512-JmRYz44NjC1MjVF2VKxc0M1a97vn+cDxeqWmnwyAF4FvpjK8YFdHpaqvQB+3IxCvX05vJxKZkoMDU8TShhmJVA==}
@@ -939,10 +902,6 @@ packages:
       upper-case-first: 2.0.2
     dev: false
 
-  /shimmer@1.2.1:
-    resolution: {integrity: sha512-sQTKC1Re/rM6XyFM6fIAGHRPVGvyXfgzIDvzoq608vM+jeyVD0Tu1E6Np0Kc2zAIFWIj963V2800iF/9LPieQw==}
-    dev: false
-
   /siginfo@2.0.0:
     resolution: {integrity: sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==}
     dev: true
@@ -989,6 +948,7 @@ packages:
   /supports-preserve-symlinks-flag@1.0.0:
     resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==}
     engines: {node: '>= 0.4'}
+    dev: true
 
   /tinybench@2.3.1:
     resolution: {integrity: sha512-hGYWYBMPr7p4g5IarQE7XhlyWveh1EKhy4wUBS1LrHXCKYgvz+4/jCqgmJqZxxldesn05vccrtME2RLLZNW7iA==}

package/src/ModelAPI.js

@@ -1,4 +1,4 @@
-const { getDatabase } = require("./database");
+const { useDatabase } = require("./database");
 const { QueryBuilder } = require("./QueryBuilder");
 const { QueryContext } = require("./QueryContext");
 const { applyWhereConditions } = require("./applyWhereConditions");
@@ -56,7 +56,7 @@ class ModelAPI {
 
   async create(values) {
     const name = tracing.spanNameForModelAPI(this._modelName, "create");
-    const db = getDatabase();
+    const db = useDatabase();
 
     return tracing.withSpan(name, async (span) => {
       try {
@@ -83,7 +83,7 @@ class ModelAPI {
 
   async findOne(where = {}) {
     const name = tracing.spanNameForModelAPI(this._modelName, "findOne");
-    const db = getDatabase();
+    const db = useDatabase();
 
     return tracing.withSpan(name, async (span) => {
       let builder = db
@@ -108,7 +108,7 @@ class ModelAPI {
 
   async findMany(params) {
     const name = tracing.spanNameForModelAPI(this._modelName, "findMany");
-    const db = getDatabase();
+    const db = useDatabase();
     const where = params?.where || {};
 
     return tracing.withSpan(name, async (span) => {
@@ -164,7 +164,7 @@ class ModelAPI {
 
   async update(where, values) {
     const name = tracing.spanNameForModelAPI(this._modelName, "update");
-    const db = getDatabase();
+    const db = useDatabase();
 
     return tracing.withSpan(name, async (span) => {
       let builder = db.updateTable(this._tableName).returningAll();
@@ -189,7 +189,7 @@ class ModelAPI {
 
   async delete(where) {
     const name = tracing.spanNameForModelAPI(this._modelName, "delete");
-    const db = getDatabase();
+    const db = useDatabase();
 
     return tracing.withSpan(name, async (span) => {
       let builder = db.deleteFrom(this._tableName).returning(["id"]);
@@ -210,7 +210,7 @@ class ModelAPI {
   }
 
   where(where) {
-    const db = getDatabase();
+    const db = useDatabase();
 
     let builder = db
       .selectFrom(this._tableName)

package/src/ModelAPI.test.js

@@ -1,7 +1,7 @@
 import { test, expect, beforeEach } from "vitest";
-const { ModelAPI, DatabaseError } = require("./ModelAPI");
+const { ModelAPI } = require("./ModelAPI");
 const { sql } = require("kysely");
-const { getDatabase } = require("./database");
+const { useDatabase } = require("./database");
 const KSUID = require("ksuid");
 
 process.env.KEEL_DB_CONN_TYPE = "pg";
@@ -12,7 +12,7 @@ let postAPI;
 let authorAPI;
 
 beforeEach(async () => {
-  const db = getDatabase();
+  const db = useDatabase();
 
   await sql`
   DROP TABLE IF EXISTS post;

package/src/QueryBuilder.js

@@ -5,8 +5,8 @@ const {
   applyOrderBy,
 } = require("./applyAdditionalQueryConstraints");
 const { applyJoins } = require("./applyJoins");
-const { camelCaseObject, upperCamelCase } = require("./casing");
-const { getDatabase } = require("./database");
+const { camelCaseObject } = require("./casing");
+const { useDatabase } = require("./database");
 const { QueryContext } = require("./QueryContext");
 const tracing = require("./tracing");
 
@@ -45,7 +45,7 @@ class QueryBuilder {
 
   async findMany(params) {
     const name = tracing.spanNameForModelAPI(this._modelName, "findMany");
-    const db = getDatabase();
+    const db = useDatabase();
 
     return tracing.withSpan(name, async (span) => {
       const context = new QueryContext([this._tableName], this._tableConfigMap);

package/src/database.js

@@ -2,56 +2,43 @@ const { Kysely, PostgresDialect } = require("kysely");
 const { AsyncLocalStorage } = require("async_hooks");
 const pg = require("pg");
 const { PROTO_ACTION_TYPES } = require("./consts");
+const { withSpan } = require("./tracing");
+
+// withDatabase is responsible for setting the correct database client in our AsyncLocalStorage
+// so that the the code in a custom function uses the correct client.
+// For GET and LIST action types, no transaction is used, but for
+// actions that mutate data such as CREATE, DELETE & UPDATE, all of the code inside
+// the user's custom function is wrapped in a transaction so we can rollback
+// the transaction if something goes wrong.
+// withDatabase shouldn't be exposed in the public api of the sdk
+async function withDatabase(db, actionType, cb) {
+  let requiresTransaction = true;
 
-// withTransaction wraps the containing code with a transaction
-// and sets the transaction in the AsyncLocalStorage so consumers further
-// down the hierarchy can access the current transaction.
-// For read type operations such as list & get, no transaction is used
-async function withTransaction(db, actionType, cb) {
   switch (actionType) {
     case PROTO_ACTION_TYPES.GET:
     case PROTO_ACTION_TYPES.LIST:
-      return dbInstance.run(db, async () => {
-        return cb({ transaction: db });
-      });
-    default:
-      return db.transaction().execute(async (transaction) => {
-        return dbInstance.run(transaction, async () => {
-          return cb({ transaction });
-        });
-      });
+      requiresTransaction = false;
+      break;
   }
-}
 
-function mustEnv(key) {
-  const v = process.env[key];
-  if (!v) {
-    throw new Error(`expected environment variable ${key} to be set`);
-  }
-  return v;
-}
-
-function getDialect() {
-  const dbConnType = process.env["KEEL_DB_CONN_TYPE"];
-  switch (dbConnType) {
-    case "pg":
-      return new PostgresDialect({
-        pool: new pg.Pool({
-          connectionString: mustEnv("KEEL_DB_CONN"),
-        }),
+  if (requiresTransaction) {
+    return db.transaction().execute(async (transaction) => {
+      return dbInstance.run(transaction, async () => {
+        return cb({ transaction });
       });
-
-    default:
-      throw Error("unexpected KEEL_DB_CONN_TYPE: " + dbConnType);
+    });
   }
+
+  return dbInstance.run(db, async () => {
+    return cb({ transaction: db });
+  });
 }
 
 let db = null;
 const dbInstance = new AsyncLocalStorage();
 
-// getDatabase will first check for an instance of Kysely in AsyncLocalStorage,
-// otherwise it will create a new instance and reuse it..
-function getDatabase() {
+// useDatabase will retrieve the database client set by withDatabase from the local storage
+function useDatabase() {
   let fromStore = dbInstance.getStore();
   if (fromStore) {
     return fromStore;
@@ -61,6 +48,9 @@ function getDatabase() {
     return db;
   }
 
+  // todo: ideally we wouldn't want to give you a fresh Kysely instance here if nothing
+  // has been found in the context, but the @teamkeel/testing package needs some restructuring
+  // to allow for the database client to be set in the store so that this method can throw an error at this line instead of returning a fresh kysely instance.
   db = new Kysely({
     dialect: getDialect(),
     log(event) {
@@ -76,5 +66,66 @@ function getDatabase() {
   return db;
 }
 
-module.exports.getDatabase = getDatabase;
-module.exports.withTransaction = withTransaction;
+function mustEnv(key) {
+  const v = process.env[key];
+  if (!v) {
+    throw new Error(`expected environment variable ${key} to be set`);
+  }
+  return v;
+}
+
+class InstrumentedPool extends pg.Pool {
+  async connect(...args) {
+    const _super = super.connect.bind(this);
+    return withSpan("Database Connect", function () {
+      return _super(...args);
+    });
+  }
+}
+
+const txStatements = {
+  begin: "Transaction Begin",
+  commit: "Transaction Commit",
+  rollback: "Transaction Rollback",
+};
+
+class InstrumentedClient extends pg.Client {
+  async query(...args) {
+    const _super = super.query.bind(this);
+    const sql = args[0];
+
+    let sqlAttribute = false;
+
+    let spanName = txStatements[sql.toLowerCase()];
+    if (!spanName) {
+      spanName = "Database Query";
+      sqlAttribute = true;
+    }
+
+    return withSpan(spanName, function (span) {
+      if (sqlAttribute) {
+        span.setAttribute("sql", args[0]);
+      }
+      return _super(...args);
+    });
+  }
+}
+
+function getDialect() {
+  const dbConnType = process.env["KEEL_DB_CONN_TYPE"];
+  switch (dbConnType) {
+    case "pg":
+      return new PostgresDialect({
+        pool: new InstrumentedPool({
+          Client: InstrumentedClient,
+          connectionString: mustEnv("KEEL_DB_CONN"),
+        }),
+      });
+
+    default:
+      throw Error("unexpected KEEL_DB_CONN_TYPE: " + dbConnType);
+  }
+}
+
+module.exports.useDatabase = useDatabase;
+module.exports.withDatabase = withDatabase;

package/src/handleRequest.js

@@ -3,7 +3,7 @@ const {
   createJSONRPCSuccessResponse,
   JSONRPCErrorCode,
 } = require("json-rpc-2.0");
-const { getDatabase } = require("./database");
+const { useDatabase } = require("./database");
 const { tryExecuteFunction } = require("./tryExecuteFunction");
 const { errorToJSONRPCResponse, RuntimeErrors } = require("./errors");
 const opentelemetry = require("@opentelemetry/api");
@@ -57,7 +57,7 @@ async function handleRequest(request, config) {
             ? true
             : null;
 
-        const db = getDatabase();
+        const db = useDatabase();
         const customFunction = functions[request.method];
 
         const result = await tryExecuteFunction(

package/src/handleRequest.test.js

@@ -3,7 +3,7 @@ import { sql } from "kysely";
 import { handleRequest, RuntimeErrors } from "./handleRequest";
 import { test, expect, beforeEach, describe } from "vitest";
 import { ModelAPI } from "./ModelAPI";
-import { getDatabase } from "./database";
+import { useDatabase } from "./database";
 const { Permissions } = require("./permissions");
 import { PROTO_ACTION_TYPES } from "./consts";
 import KSUID from "ksuid";
@@ -188,7 +188,7 @@ describe("ModelAPI error handling", () => {
     process.env.KEEL_DB_CONN_TYPE = "pg";
     process.env.KEEL_DB_CONN = `postgresql://postgres:postgres@localhost:5432/functions-runtime`;
 
-    db = getDatabase();
+    db = useDatabase();
 
     await sql`
     DROP TABLE IF EXISTS post;

package/src/index.js

@@ -2,7 +2,7 @@ const { ModelAPI } = require("./ModelAPI");
 const { RequestHeaders } = require("./RequestHeaders");
 const { handleRequest } = require("./handleRequest");
 const KSUID = require("ksuid");
-const { getDatabase } = require("./database");
+const { useDatabase } = require("./database");
 const {
   Permissions,
   PERMISSION_STATE,
@@ -14,7 +14,7 @@ module.exports = {
   ModelAPI,
   RequestHeaders,
   handleRequest,
-  getDatabase,
+  useDatabase,
   Permissions,
   PERMISSION_STATE,
   checkBuiltInPermissions,

package/src/permissions.test.js

@@ -6,7 +6,7 @@ const {
   checkBuiltInPermissions,
 } = require("./permissions");
 
-import { getDatabase } from "./database";
+import { useDatabase } from "./database";
 
 import { beforeEach, describe, expect, test } from "vitest";
 
@@ -15,7 +15,7 @@ process.env.KEEL_DB_CONN = `postgresql://postgres:postgres@localhost:5432/functi
 
 let permissions;
 let ctx = {};
-let db = getDatabase();
+let db = useDatabase();
 
 describe("explicit", () => {
   beforeEach(() => {

package/src/tryExecuteFunction.js

@@ -1,4 +1,4 @@
-const { withTransaction } = require("./database");
+const { withDatabase } = require("./database");
 const {
   withPermissions,
   PERMISSION_STATE,
@@ -16,7 +16,7 @@ function tryExecuteFunction(
   const actionType = actionTypes[request.method];
 
   return withPermissions(permitted, async ({ getPermissionState }) => {
-    return withTransaction(db, actionType, async ({ transaction }) => {
+    return withDatabase(db, actionType, async ({ transaction }) => {
       const fnResult = await cb();
 
       // api.permissions maintains an internal state of whether the current operation has been *explicitly* permitted/denied by the user in the course of their custom function, or if execution has already been permitted by a role based permission (evaluated in the main runtime).