@teamkeel/functions-runtime 0.337.0 → 0.339.0

package/src/ModelAPI.js

@@ -44,11 +44,10 @@ class DatabaseError extends Error {
 class ModelAPI {
   /**
    * @param {string} tableName The name of the table this API is for
-   * @param {Function} defaultValues A function that returns the default values for a row in this table
+   * @param {Function} _ Used to be a function that returns the default values for a row in this table. No longer used.
    * @param {TableConfigMap} tableConfigMap
    */
-  constructor(tableName, defaultValues, tableConfigMap = {}) {
-    this._defaultValues = defaultValues;
+  constructor(tableName, _, tableConfigMap = {}) {
     this._tableName = tableName;
     this._tableConfigMap = tableConfigMap;
     this._modelName = upperCamelCase(this._tableName);
@@ -60,12 +59,10 @@ class ModelAPI {
 
     return tracing.withSpan(name, async (span) => {
       try {
-        const defaults = this._defaultValues();
         const query = db
           .insertInto(this._tableName)
           .values(
             snakeCaseObject({
-              ...defaults,
               ...values,
             })
           )

package/src/ModelAPI.test.js

@@ -4,9 +4,6 @@ const { sql } = require("kysely");
 const { useDatabase } = require("./database");
 const KSUID = require("ksuid");
 
-process.env.KEEL_DB_CONN_TYPE = "pg";
-process.env.KEEL_DB_CONN = `postgresql://postgres:postgres@localhost:5432/functions-runtime`;
-
 let personAPI;
 let postAPI;
 let authorAPI;
@@ -54,47 +51,22 @@ beforeEach(async () => {
     },
   };
 
-  personAPI = new ModelAPI(
-    "person",
-    () => {
-      return {
-        id: KSUID.randomSync().string,
-        date: new Date("2022-01-01"),
-      };
-    },
-    tableConfigMap
-  );
+  personAPI = new ModelAPI("person", undefined, tableConfigMap);
 
-  postAPI = new ModelAPI(
-    "post",
-    () => {
-      return {
-        id: KSUID.randomSync().string,
-      };
-    },
-    tableConfigMap
-  );
+  postAPI = new ModelAPI("post", undefined, tableConfigMap);
 
-  authorAPI = new ModelAPI(
-    "author",
-    () => {
-      return {
-        id: KSUID.randomSync().string,
-      };
-    },
-    tableConfigMap
-  );
+  authorAPI = new ModelAPI("author", undefined, tableConfigMap);
 });
 
 test("ModelAPI.create", async () => {
   const row = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   expect(row.name).toEqual("Jim");
   expect(row.married).toEqual(false);
-  expect(row.date).toEqual(new Date("2022-01-01"));
   expect(row.favouriteNumber).toEqual(10);
   expect(KSUID.parse(row.id).string).toEqual(row.id);
 });
@@ -102,6 +74,7 @@ test("ModelAPI.create", async () => {
 test("ModelAPI.create - throws if not not null constraint violation", async () => {
   await expect(
     authorAPI.create({
+      id: KSUID.randomSync().string,
       name: null,
     })
   ).rejects.toThrow('null value in column "name" violates not-null constraint');
@@ -109,11 +82,13 @@ test("ModelAPI.create - throws if not not null constraint violation", async () =
 
 test("ModelAPI.create - throws if database constraint fails", async () => {
   const row = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   const promise = personAPI.create({
+    id: KSUID.randomSync().string,
     id: row.id,
     name: "Jim",
     married: false,
@@ -126,6 +101,7 @@ test("ModelAPI.create - throws if database constraint fails", async () => {
 
 test("ModelAPI.findOne", async () => {
   const created = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
@@ -138,11 +114,13 @@ test("ModelAPI.findOne", async () => {
 
 test("ModelAPI.findOne - relationships - one to many", async () => {
   const person = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   const post = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Post",
     authorId: person.id,
   });
@@ -164,16 +142,19 @@ test("ModelAPI.findOne - return null if not found", async () => {
 
 test("ModelAPI.findMany", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   const bob = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
     married: true,
     favouriteNumber: 11,
   });
   const sally = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Sally",
     married: true,
     favouriteNumber: 12,
@@ -189,9 +170,11 @@ test("ModelAPI.findMany", async () => {
 
 test("ModelAPI.findMany - no where conditions", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
   });
 
@@ -202,9 +185,11 @@ test("ModelAPI.findMany - no where conditions", async () => {
 
 test("ModelAPI.findMany - startsWith", async () => {
   const jim = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
   });
   const rows = await personAPI.findMany({
@@ -220,9 +205,11 @@ test("ModelAPI.findMany - startsWith", async () => {
 
 test("ModelAPI.findMany - endsWith", async () => {
   const jim = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
   });
   const rows = await personAPI.findMany({
@@ -238,12 +225,15 @@ test("ModelAPI.findMany - endsWith", async () => {
 
 test("ModelAPI.findMany - contains", async () => {
   const billy = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Billy",
   });
   const sally = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Sally",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   const rows = await personAPI.findMany({
@@ -259,12 +249,15 @@ test("ModelAPI.findMany - contains", async () => {
 
 test("ModelAPI.findMany - oneOf", async () => {
   const billy = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Billy",
   });
   const sally = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Sally",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   const rows = await personAPI.findMany({
@@ -280,9 +273,11 @@ test("ModelAPI.findMany - oneOf", async () => {
 
 test("ModelAPI.findMany - greaterThan", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 1,
   });
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 2,
   });
   const rows = await personAPI.findMany({
@@ -298,12 +293,15 @@ test("ModelAPI.findMany - greaterThan", async () => {
 
 test("ModelAPI.findMany - greaterThanOrEquals", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 1,
   });
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 2,
   });
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 3,
   });
   const rows = await personAPI.findMany({
@@ -319,9 +317,11 @@ test("ModelAPI.findMany - greaterThanOrEquals", async () => {
 
 test("ModelAPI.findMany - lessThan", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 1,
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 2,
   });
   const rows = await personAPI.findMany({
@@ -337,12 +337,15 @@ test("ModelAPI.findMany - lessThan", async () => {
 
 test("ModelAPI.findMany - lessThanOrEquals", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 1,
   });
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 2,
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     favouriteNumber: 3,
   });
   const rows = await personAPI.findMany({
@@ -358,9 +361,11 @@ test("ModelAPI.findMany - lessThanOrEquals", async () => {
 
 test("ModelAPI.findMany - before", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-01"),
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-02"),
   });
   const rows = await personAPI.findMany({
@@ -376,10 +381,12 @@ test("ModelAPI.findMany - before", async () => {
 
 test("ModelAPI.findMany - empty where", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-01"),
   });
 
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-02"),
   });
 
@@ -398,12 +405,15 @@ test("ModelAPI.findMany - empty where", async () => {
 
 test("ModelAPI.findMany - onOrBefore", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-01"),
   });
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-02"),
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-03"),
   });
   const rows = await personAPI.findMany({
@@ -419,19 +429,19 @@ test("ModelAPI.findMany - onOrBefore", async () => {
 
 test("ModelAPI.findMany - limit", async () => {
   await personAPI.create({
-    id: "1",
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   await personAPI.create({
-    id: "2",
+    id: KSUID.randomSync().string,
     name: "Bob",
     married: true,
     favouriteNumber: 11,
   });
   await personAPI.create({
-    id: "3",
+    id: KSUID.randomSync().string,
     name: "Sally",
     married: true,
     favouriteNumber: 12,
@@ -439,6 +449,9 @@ test("ModelAPI.findMany - limit", async () => {
 
   const rows = await personAPI.findMany({
     limit: 2,
+    orderBy: {
+      favouriteNumber: "asc",
+    },
   });
 
   expect(rows.map((r) => r.name)).toEqual(["Jim", "Bob"]);
@@ -446,21 +459,21 @@ test("ModelAPI.findMany - limit", async () => {
 
 test("ModelAPI.findMany - orderBy", async () => {
   await personAPI.create({
-    id: "1",
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
     date: new Date(2023, 12, 29),
   });
   await personAPI.create({
-    id: "2",
+    id: KSUID.randomSync().string,
     name: "Bob",
     married: true,
     favouriteNumber: 11,
     date: new Date(2023, 12, 30),
   });
   await personAPI.create({
-    id: "3",
+    id: KSUID.randomSync().string,
     name: "Sally",
     married: true,
     favouriteNumber: 12,
@@ -506,21 +519,21 @@ test("ModelAPI.findMany - orderBy", async () => {
 
 test("ModelAPI.findMany - offset", async () => {
   await personAPI.create({
-    id: "1",
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
     date: new Date(2023, 12, 29),
   });
   await personAPI.create({
-    id: "2",
+    id: KSUID.randomSync().string,
     name: "Bob",
     married: true,
     favouriteNumber: 11,
     date: new Date(2023, 12, 30),
   });
   await personAPI.create({
-    id: "3",
+    id: KSUID.randomSync().string,
     name: "Sally",
     married: true,
     favouriteNumber: 12,
@@ -559,9 +572,11 @@ test("ModelAPI.findMany - offset", async () => {
 
 test("ModelAPI.findMany - after", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-01"),
   });
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-02"),
   });
   const rows = await personAPI.findMany({
@@ -577,12 +592,15 @@ test("ModelAPI.findMany - after", async () => {
 
 test("ModelAPI.findMany - onOrAfter", async () => {
   await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-01"),
   });
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-02"),
   });
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     date: new Date("2022-01-03"),
   });
   const rows = await personAPI.findMany({
@@ -598,9 +616,11 @@ test("ModelAPI.findMany - onOrAfter", async () => {
 
 test("ModelAPI.findMany - equals", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Sally",
   });
   const rows = await personAPI.findMany({
@@ -616,9 +636,11 @@ test("ModelAPI.findMany - equals", async () => {
 
 test("ModelAPI.findMany - notEquals", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Sally",
   });
   const rows = await personAPI.findMany({
@@ -634,16 +656,19 @@ test("ModelAPI.findMany - notEquals", async () => {
 
 test("ModelAPI.findMany - complex query", async () => {
   const p = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jake",
     favouriteNumber: 8,
     date: new Date("2021-12-31"),
   });
   await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jane",
     favouriteNumber: 12,
     date: new Date("2022-01-11"),
   });
   const p2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Billy",
     favouriteNumber: 16,
     date: new Date("2022-01-05"),
@@ -674,20 +699,25 @@ test("ModelAPI.findMany - complex query", async () => {
 
 test("ModelAPI.findMany - relationships - one to many", async () => {
   const person = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   const person2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
   });
   const post1 = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My First Post",
     authorId: person.id,
   });
   const post2 = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Second Post",
     authorId: person.id,
   });
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Third Post",
     authorId: person2.id,
   });
@@ -705,17 +735,21 @@ test("ModelAPI.findMany - relationships - one to many", async () => {
 
 test("ModelAPI.findMany - relationships - many to one", async () => {
   const person = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My First Post",
     authorId: person.id,
   });
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Second Post",
     authorId: person.id,
   });
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Second Post",
     authorId: person.id,
   });
@@ -740,16 +774,20 @@ test("ModelAPI.findMany - relationships - many to one", async () => {
 
 test("ModelAPI.findMany - relationships - duplicate joins handled", async () => {
   const person = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   const person2 = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
   });
   const post1 = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My First Post",
     authorId: person.id,
   });
   const post2 = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "My Second Post",
     authorId: person2.id,
   });
@@ -773,11 +811,13 @@ test("ModelAPI.findMany - relationships - duplicate joins handled", async () =>
 
 test("ModelAPI.update", async () => {
   let jim = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
   });
   let bob = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Bob",
     married: false,
     favouriteNumber: 11,
@@ -811,6 +851,7 @@ test("ModelAPI.update - throws if not found", async () => {
 
 test("ModelAPI.update - throws if not not null constraint violation", async () => {
   const jim = await authorAPI.create({
+    id: KSUID.randomSync().string,
     name: "jim",
   });
 
@@ -830,6 +871,7 @@ test("ModelAPI.update - throws if not not null constraint violation", async () =
 
 test("ModelAPI.delete", async () => {
   const jim = await personAPI.create({
+    id: KSUID.randomSync().string,
     name: "Jim",
   });
   const id = jim.id;
@@ -843,15 +885,19 @@ test("ModelAPI.delete", async () => {
 
 test("ModelAPI chained findMany with offset/limit/order by", async () => {
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "adam",
   });
   await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "dave",
   });
   const three = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "jon",
   });
   const four = await postAPI.create({
+    id: KSUID.randomSync().string,
     title: "jon bretman",
   });
 

package/src/database.js

@@ -1,4 +1,4 @@
-const { Kysely, PostgresDialect } = require("kysely");
+const { Kysely, PostgresDialect, CamelCasePlugin } = require("kysely");
 const { AsyncLocalStorage } = require("async_hooks");
 const pg = require("pg");
 const { PROTO_ACTION_TYPES } = require("./consts");
@@ -35,24 +35,51 @@ async function withDatabase(db, actionType, cb) {
 }
 
 let db = null;
+
 const dbInstance = new AsyncLocalStorage();
 
 // useDatabase will retrieve the database client set by withDatabase from the local storage
 function useDatabase() {
+  // retrieve the instance of the database client from the store which is aware of
+  // which context the current connection to the db is running in - e.g does the context
+  // require a transaction or not?
   let fromStore = dbInstance.getStore();
   if (fromStore) {
     return fromStore;
   }
 
+  // if the NODE_ENV is 'test' then we know we are inside of the vitest environment
+  // which covers any test files ending in *.test.ts. Custom function code runs in a different node process which will not have this environment variable. Tests written using our testing
+  // framework call actions (and in turn custom function code) over http using the ActionExecutor class
+  if ("NODE_ENV" in process.env && process.env.NODE_ENV == "test") {
+    return getDatabaseClient();
+  }
+
+  // If we've gotten to this point, then we know that we are in a custom function runtime server
+  // context and we haven't been able to retrieve the in-context instance of Kysely, which means we should throw an error.
+  throw new Error("useDatabase must be called within a function");
+}
+
+// getDatabaseClient will return a brand new instance of Kysely. Every instance of Kysely
+// represents an individual connection to the database.
+// not to be exported externally from our sdk - consumers should use useDatabase
+function getDatabaseClient() {
+  // 'db' represents the singleton connection to the database which is stored
+  // as a module scope variable.
   if (db) {
     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(),
+    plugins: [
+      // allows users to query using camelCased versions of the database column names, which
+      // should match the names we use in our schema.
+      // https://kysely-org.github.io/kysely/classes/CamelCasePlugin.html
+      // If they don't, then we can create a custom implementation of the plugin where we control
+      // the casing behaviour (see url above for example)
+      new CamelCasePlugin(),
+    ],
     log(event) {
       if ("DEBUG" in process.env) {
         if (event.level === "query") {
@@ -66,14 +93,6 @@ function useDatabase() {
   return db;
 }
 
-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);
@@ -127,5 +146,17 @@ function getDialect() {
   }
 }
 
+function mustEnv(key) {
+  const v = process.env[key];
+  if (!v) {
+    throw new Error(`expected environment variable ${key} to be set`);
+  }
+  return v;
+}
+
+// initialise the database client at module scope level so the db variable is set
+getDatabaseClient();
+
+module.exports.getDatabaseClient = getDatabaseClient;
 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 { useDatabase } = require("./database");
+const { getDatabaseClient } = 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 = useDatabase();
+        const db = getDatabaseClient();
         const customFunction = functions[request.method];
 
         const result = await tryExecuteFunction(