@teamkeel/functions-runtime 0.371.1 → 0.373.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamkeel/functions-runtime",
-  "version": "0.371.1",
+  "version": "0.373.0",
   "description": "Internal package used by @teamkeel/sdk",
   "main": "src/index.js",
   "scripts": {

package/src/QueryBuilder.js

@@ -134,8 +134,7 @@ class QueryBuilder {
 
       span.setAttribute("sql", builder.compile().sql);
 
-      const row = await builder.executeTakeFirstOrThrow();
-
+      const row = await builder.executeTakeFirst();
       if (!row) {
         return null;
       }

package/src/errors.js

@@ -26,25 +26,13 @@ const RuntimeErrors = {
 
 // errorToJSONRPCResponse transforms a JavaScript Error instance (or derivative) into a valid JSONRPC response object to pass back to the Keel runtime.
 function errorToJSONRPCResponse(request, e) {
-  if (!e.error) {
-    // it isnt wrapped
-
-    if (e instanceof PermissionError) {
+  switch (e.constructor.name) {
+    case "PermissionError":
       return createJSONRPCErrorResponse(
         request.id,
         RuntimeErrors.PermissionError,
         e.message
       );
-    }
-
-    return createJSONRPCErrorResponse(
-      request.id,
-      RuntimeErrors.UnknownError,
-      e.message
-    );
-  }
-  // we want to switch on instanceof but there is no way to do that in js, so best to check the constructor class of the error
-  switch (e.error.constructor.name) {
     // Any error thrown in the ModelAPI class is
     // wrapped in a DatabaseError in order to differentiate 'our code' vs the user's own code.
     case "NoResultError":
@@ -56,23 +44,38 @@ function errorToJSONRPCResponse(request, e) {
         e.message
       );
     case "DatabaseError":
-      const { error: originalError } = e;
+      let err = e;
+
+      // If wrapped error then unwrap
+      if (e instanceof DatabaseError) {
+        err = e.error;
+      }
+
+      if (err.constructor.name == "NoResultError") {
+        return createJSONRPCErrorResponse(
+          request.id,
+
+          // to be matched to https://github.com/teamkeel/keel/blob/e3115ffe381bfc371d4f45bbf96a15072a994ce5/runtime/actions/update.go#L54-L54
+          RuntimeErrors.RecordNotFoundError,
+          err.message
+        );
+      }
 
-      // if the originalError responds to 'code' then assume it has other pg error message keys
+      // if the error contains 'code' then assume it has other pg error message keys
       // todo: make this more ironclad.
       // when using lib-pq, should match https://github.com/brianc/node-postgres/blob/master/packages/pg-protocol/src/parser.ts#L371-L386
-      if ("code" in originalError) {
-        const { code, detail, table } = originalError;
+      if ("code" in err) {
+        const { code, detail, table } = err;
 
         let rpcErrorCode, column, value;
-        const [col, val] = parseKeyMessage(originalError.detail);
+        const [col, val] = parseKeyMessage(err.detail);
         column = col;
         value = val;
 
         switch (code) {
           case "23502":
             rpcErrorCode = RuntimeErrors.NotNullConstraintError;
-            column = originalError.column;
+            column = err.column;
             break;
           case "23503":
             rpcErrorCode = RuntimeErrors.ForeignKeyConstraintError;

package/src/handleRequest.js

@@ -88,7 +88,10 @@ async function handleRequest(request, config) {
         for (const pair of headers.entries()) {
           responseHeaders[pair[0]] = pair[1].split(", ");
         }
-        response.meta = { headers: responseHeaders };
+        response.meta = {
+          headers: responseHeaders,
+          status: ctx.response.status,
+        };
 
         return response;
       } catch (e) {

package/src/handleRequest.test.js

@@ -23,7 +23,13 @@ test("when the custom function returns expected value", async () => {
     actionTypes: {
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -52,7 +58,13 @@ test("when the custom function doesnt return a value", async () => {
     actionTypes: {
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -75,7 +87,13 @@ test("when there is no matching function for the path", async () => {
     actionTypes: {
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   const rpcReq = createJSONRPCRequest("123", "unknown", { title: "a post" });
@@ -100,7 +118,13 @@ test("when there is an unexpected error in the custom function", async () => {
     actionTypes: {
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -128,7 +152,13 @@ test("when a role based permission has already been granted by the main runtime"
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
     createModelAPI: () => {},
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   let rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -159,7 +189,13 @@ test("when there is an unexpected object thrown in the custom function", async (
     actionTypes: {
       createPost: PROTO_ACTION_TYPES.CREATE,
     },
-    createContextAPI: () => {},
+    createContextAPI: () => {
+      return {
+        response: {
+          headers: new Headers(),
+        },
+      };
+    },
   };
 
   const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
@@ -244,7 +280,13 @@ describe("ModelAPI error handling", () => {
           return deleted;
         },
       },
-      createContextAPI: () => ({}),
+      createContextAPI: () => {
+        return {
+          response: {
+            headers: new Headers(),
+          },
+        };
+      },
     };
   });
 

package/src/index.d.ts

@@ -59,6 +59,7 @@ export type ContextAPI = {
 
 export type Response = {
   headers: Headers;
+  status?: number;
 };
 
 export type PageInfo = {
@@ -69,11 +70,8 @@ export type PageInfo = {
   count: number;
 };
 
-// Request headers query API
-export type RequestHeaders = {
-  get(name: string): string;
-  has(name: string): boolean;
-};
+// Request headers cannot be mutated, so remove any methods that mutate
+export type RequestHeaders = Omit<Headers, "append" | "delete" | "set">;
 
 export declare class Permissions {
   constructor();