@teamkeel/functions-runtime 0.388.1 → 0.389.0-next.2

package/package.json

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

package/src/InlineFile.js

@@ -0,0 +1,68 @@
+class InlineFile {
+  constructor(filename, contentType, size, url) {
+    this.filename = filename;
+    this.contentType = contentType;
+    this.size = size;
+    this.url = url;
+  }
+
+  // Create an InlineFile instance from a given json object.
+  static fromObject(obj) {
+    if (obj.dataURL) {
+      var file = InlineFile.fromDataURL(obj.dataURL);
+      file._dataURL = obj.dataURL;
+      return file;
+    }
+
+    return new InlineFile(obj.filename, obj.contentType, obj.size, obj.url);
+  }
+
+  // Create an InlineFile instance from a given dataURL
+  static fromDataURL(dataURL) {
+    var info = dataURL.split(",")[0].split(":")[1];
+    var data = dataURL.split(",")[1];
+
+    var mime = info.split(";")[0];
+    var name = info.split(";")[1].split("=")[1];
+    var byteString = Buffer.from(data, "base64");
+    var blob = new Blob([byteString], { type: mime });
+
+    var file = new InlineFile(name, mime, blob.size);
+    file._dataURL = dataURL;
+    return file;
+  }
+
+  // Read the contents of the file. If URL is set, it will be read from the remote storage, otherwise, if dataURL is set
+  // on the instance, it will return a blob with the file contents
+  read() {
+    if (this.url) {
+      // TODO: read from store
+    }
+
+    if (this._dataURL) {
+      var data = this._dataURL.split(",")[1];
+      var byteString = Buffer.from(data, "base64");
+      return new Blob([byteString], { type: this.contentType });
+    }
+  }
+
+  store() {
+    //TODO: actually store and generate a key
+    this.key = uuidv4();
+  }
+
+  toJSON() {
+    return {
+      __typename: "InlineFile",
+      dataURL: this._dataURL,
+      filename: this.filename,
+      contentType: this.contentType,
+      size: this.size,
+      url: this.url,
+    };
+  }
+}
+
+module.exports = {
+  InlineFile,
+};

package/src/ModelAPI.test.js

@@ -1,4 +1,5 @@
 import { test, expect, beforeEach, describe } from "vitest";
+import { InlineFile } from "./InlineFile";
 const { ModelAPI } = require("./ModelAPI");
 const { sql } = require("kysely");
 const { useDatabase } = require("./database");
@@ -8,6 +9,8 @@ let personAPI;
 let postAPI;
 let authorAPI;
 
+const imgDataURL = `data:image/png;name=my-avatar.png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAACnCAYAAAABm/BPAAABRmlDQ1BJQ0MgUHJvZmlsZQAAKJFjYGASSSwoyGFhYGDIzSspCnJ3UoiIjFJgf8bABYQcDIYMoonJxQWOAQE+QCUMMBoVfLvGwAiiL+uCzHJ8xnLWPCCkLE+1q1pt05x/mOpRAFdKanEykP4DxGnJBUUlDAyMKUC2cnlJAYjdAWSLFAEdBWTPAbHTIewNIHYShH0ErCYkyBnIvgFkCyRnJALNYHwBZOskIYmnI7Gh9oIAj4urj49CqJG5oakHAeeSDkpSK0pAtHN+QWVRZnpGiYIjMJRSFTzzkvV0FIwMjIwYGEBhDlH9ORAcloxiZxBi+YsYGCy+MjAwT0CIJc1kYNjeysAgcQshprKAgYG/hYFh2/mCxKJEuAMYv7EUpxkbQdg8TgwMrPf+//+sxsDAPpmB4e+E//9/L/r//+9ioPl3GBgO5AEAzGpgJI9yWQgAAABWZVhJZk1NACoAAAAIAAGHaQAEAAAAAQAAABoAAAAAAAOShgAHAAAAEgAAAESgAgAEAAAAAQAAAOSgAwAEAAAAAQAAAKcAAAAAQVNDSUkAAABTY3JlZW5zaG905/7QcgAAAdZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8ZXhpZjpQaXhlbFlEaW1lbnNpb24+MTY3PC9leGlmOlBpeGVsWURpbWVuc2lvbj4KICAgICAgICAgPGV4aWY6UGl4ZWxYRGltZW5zaW9uPjIyODwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlVzZXJDb21tZW50PlNjcmVlbnNob3Q8L2V4aWY6VXNlckNvbW1lbnQ+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgpCGUzcAAAEGUlEQVR4Ae3TsQ0AIRADwefrICGi/wpBoooN5iqw5uyx5j6fI0AgIfAnUghBgMATMEhFIBASMMjQM0QhYJA6QCAkYJChZ4hCwCB1gEBIwCBDzxCFgEHqAIGQgEGGniEKAYPUAQIhAYMMPUMUAgapAwRCAgYZeoYoBAxSBwiEBAwy9AxRCBikDhAICRhk6BmiEDBIHSAQEjDI0DNEIWCQOkAgJGCQoWeIQsAgdYBASMAgQ88QhYBB6gCBkIBBhp4hCgGD1AECIQGDDD1DFAIGqQMEQgIGGXqGKAQMUgcIhAQMMvQMUQgYpA4QCAkYZOgZohAwSB0gEBIwyNAzRCFgkDpAICRgkKFniELAIHWAQEjAIEPPEIWAQeoAgZCAQYaeIQoBg9QBAiEBgww9QxQCBqkDBEICBhl6higEDFIHCIQEDDL0DFEIGKQOEAgJGGToGaIQMEgdIBASMMjQM0QhYJA6QCAkYJChZ4hCwCB1gEBIwCBDzxCFgEHqAIGQgEGGniEKAYPUAQIhAYMMPUMUAgapAwRCAgYZeoYoBAxSBwiEBAwy9AxRCBikDhAICRhk6BmiEDBIHSAQEjDI0DNEIWCQOkAgJGCQoWeIQsAgdYBASMAgQ88QhYBB6gCBkIBBhp4hCgGD1AECIQGDDD1DFAIGqQMEQgIGGXqGKAQMUgcIhAQMMvQMUQgYpA4QCAkYZOgZohAwSB0gEBIwyNAzRCFgkDpAICRgkKFniELAIHWAQEjAIEPPEIWAQeoAgZCAQYaeIQoBg9QBAiEBgww9QxQCBqkDBEICBhl6higEDFIHCIQEDDL0DFEIGKQOEAgJGGToGaIQMEgdIBASMMjQM0QhYJA6QCAkYJChZ4hCwCB1gEBIwCBDzxCFgEHqAIGQgEGGniEKAYPUAQIhAYMMPUMUAgapAwRCAgYZeoYoBAxSBwiEBAwy9AxRCBikDhAICRhk6BmiEDBIHSAQEjDI0DNEIWCQOkAgJGCQoWeIQsAgdYBASMAgQ88QhYBB6gCBkIBBhp4hCgGD1AECIQGDDD1DFAIGqQMEQgIGGXqGKAQMUgcIhAQMMvQMUQgYpA4QCAkYZOgZohAwSB0gEBIwyNAzRCFgkDpAICRgkKFniELAIHWAQEjAIEPPEIWAQeoAgZCAQYaeIQoBg9QBAiEBgww9QxQCBqkDBEICBhl6higEDFIHCIQEDDL0DFEIGKQOEAgJGGToGaIQMEgdIBASMMjQM0QhYJA6QCAkYJChZ4hCwCB1gEBIwCBDzxCFgEHqAIGQgEGGniEKAYPUAQIhAYMMPUMUAgapAwRCAgYZeoYoBAxSBwiEBAwy9AxRCBikDhAICRhk6BmiEDBIHSAQEjDI0DNEIWCQOkAgJGCQoWeIQsAgdYBASOACCAICsR8kFlUAAAAASUVORK5CYII=`;
+
 beforeEach(async () => {
   const db = useDatabase();
 
@@ -21,6 +24,7 @@ beforeEach(async () => {
       name             text UNIQUE,
       married          boolean,
       favourite_number integer,
+      avatar           jsonb,
       date             timestamp
   );
   CREATE TABLE post(
@@ -61,15 +65,19 @@ beforeEach(async () => {
 });
 
 test("ModelAPI.create", async () => {
+  var file = InlineFile.fromDataURL(imgDataURL);
   const row = await personAPI.create({
     id: KSUID.randomSync().string,
     name: "Jim",
     married: false,
     favouriteNumber: 10,
+    avatar: file,
   });
   expect(row.name).toEqual("Jim");
   expect(row.married).toEqual(false);
   expect(row.favouriteNumber).toEqual(10);
+  expect(row.avatar.filename).toEqual("my-avatar.png");
+  expect(row.avatar.size).toEqual(2024);
   expect(KSUID.parse(row.id).string).toEqual(row.id);
 });
 

package/src/handleJob.js

@@ -9,6 +9,7 @@ const opentelemetry = require("@opentelemetry/api");
 const { withSpan } = require("./tracing");
 const { PROTO_ACTION_TYPES } = require("./consts");
 const { tryExecuteJob } = require("./tryExecuteJob");
+const { parseParams } = require("./parsing");
 
 // Generic handler function that is agnostic to runtime environment (local or lambda)
 // to execute a job function based on the contents of a jsonrpc-2.0 payload object.
@@ -57,8 +58,11 @@ async function handleJob(request, config) {
         await tryExecuteJob(
           { request, permitted, db, actionType },
           async () => {
+            // parse request params to convert objects into rich field types (e.g. InlineFile)
+            const inputs = parseParams(request.params);
+
             // Return the job function to the containing tryExecuteJob block
-            return jobFunction(ctx, request.params);
+            return jobFunction(ctx, inputs);
           }
         );
 

package/src/handleRequest.js

@@ -8,6 +8,7 @@ const { tryExecuteFunction } = require("./tryExecuteFunction");
 const { errorToJSONRPCResponse, RuntimeErrors } = require("./errors");
 const opentelemetry = require("@opentelemetry/api");
 const { withSpan } = require("./tracing");
+const { parseParams } = require("./parsing");
 
 // Generic handler function that is agnostic to runtime environment (local or lambda)
 // to execute a custom function based on the contents of a jsonrpc-2.0 payload object.
@@ -64,24 +65,16 @@ async function handleRequest(request, config) {
         const result = await tryExecuteFunction(
           { request, ctx, permitted, db, permissionFns, actionType },
           async () => {
+            // parse request params to convert objects into rich field types (e.g. InlineFile)
+            const inputs = parseParams(request.params);
+
             // Return the custom function to the containing tryExecuteFunction block
             // Once the custom function is called, tryExecuteFunction will check the schema's permission rules to see if it can continue committing
             // the transaction to the db. If a permission rule is violated, any changes made inside the transaction are rolled back.
-            return customFunction(ctx, request.params);
+            return customFunction(ctx, inputs);
           }
         );
 
-        // Sometimes a custom function may be coded in such a way that nothing is returned from it.
-        // We see this as an error so handle accordingly.
-        if (result === undefined) {
-          // no result returned from custom function
-          return createJSONRPCErrorResponse(
-            request.id,
-            RuntimeErrors.NoResultError,
-            `no result returned from function '${request.method}'`
-          );
-        }
-
         const response = createJSONRPCSuccessResponse(request.id, result);
 
         const responseHeaders = {};

package/src/handleRequest.test.js

@@ -47,38 +47,6 @@ test("when the custom function returns expected value", async () => {
   });
 });
 
-test("when the custom function doesnt return a value", async () => {
-  const config = {
-    functions: {
-      createPost: async (ctx, inputs) => {
-        new Permissions().allow();
-      },
-    },
-    permissions: {},
-    actionTypes: {
-      createPost: PROTO_ACTION_TYPES.CREATE,
-    },
-    createContextAPI: () => {
-      return {
-        response: {
-          headers: new Headers(),
-        },
-      };
-    },
-  };
-
-  const rpcReq = createJSONRPCRequest("123", "createPost", { title: "a post" });
-
-  expect(await handleRequest(rpcReq, config)).toEqual({
-    id: "123",
-    jsonrpc: "2.0",
-    error: {
-      code: RuntimeErrors.NoResultError,
-      message: "no result returned from function 'createPost'",
-    },
-  });
-});
-
 test("when there is no matching function for the path", async () => {
   const config = {
     functions: {

package/src/index.js

@@ -11,6 +11,7 @@ const {
   checkBuiltInPermissions,
 } = require("./permissions");
 const tracing = require("./tracing");
+const { InlineFile } = require("./InlineFile");
 
 module.exports = {
   ModelAPI,
@@ -19,6 +20,7 @@ module.exports = {
   handleJob,
   handleSubscriber,
   useDatabase,
+  InlineFile,
   Permissions,
   PERMISSION_STATE,
   checkBuiltInPermissions,

package/src/parsing.js

@@ -0,0 +1,28 @@
+const { InlineFile } = require("./InlineFile");
+
+// parseParams takes a set of inputs and creates objects for the ones that are of a complex type.
+//
+// inputs that are objects and contain a "__typename" field are resolved to instances of the complex type
+// they represent. At the moment, the only supported type is `InlineFile`
+function parseParams(inputs) {
+  if (inputs != null) {
+    Object.keys(inputs).forEach((i) => {
+      if (inputs[i] !== null && typeof inputs[i] === "object") {
+        if ("__typename" in inputs[i]) {
+          switch (inputs[i].__typename) {
+            case "InlineFile":
+              inputs[i] = InlineFile.fromObject(inputs[i]);
+              break;
+
+            default:
+              break;
+          }
+        }
+      }
+    });
+  }
+
+  return inputs;
+}
+
+module.exports.parseParams = parseParams;