@teamkeel/functions-runtime 0.335.0 → 0.336.0

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

@@ -3,55 +3,41 @@ const { AsyncLocalStorage } = require("async_hooks");
 const pg = require("pg");
 const { PROTO_ACTION_TYPES } = require("./consts");
 
-// 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) {
+// 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;
+
   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 +47,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 +65,28 @@ 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;
+}
+
+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"),
+        }),
+      });
+
+    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).