feat: puter workers

* experimental Cloudflare Workers for Platforms support

* add support for the puter driver

* stop hardcoding api.puter.localhost

* support destroy from express route as well

* initial worker support

* xhrshim + fixes (incomplete)

* change order of readyState + load event

* remove some debug logs

* change worker/puterUtils into a cjs module

* Cloudflare workers eventtarget workaround

* worker preamble webpack

* edit worker readme to reflect reality

* allow a way to code in api endpoint instead of hardcoding it to api.puter.com

* move cloudflare eventtarget fix to puter-portable template

This is so it gets run before the rest of puter-js initializes

* remove express route for worker

Author: ProgrammerIn-wonderland

src/backend/package.json

@@ -4,7 +4,8 @@
   "description": "Backend/Kernel for Puter",
   "main": "exports.js",
   "scripts": {
-    "test": "npx mocha src/**/*.test.js && node ./tools/test.js"
+    "test": "npx mocha src/**/*.test.js && node ./tools/test.js",
+    "build:worker": "cd src/services/worker && npm run build"
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.26.1",

src/backend/src/CoreModule.js

@@ -391,6 +391,9 @@ const install = async ({ services, app, useapi, modapi }) => {
 
     const { ChatAPIService } = require('./services/ChatAPIService');
     services.registerService('__chat-api', ChatAPIService);
+
+    const { WorkerService } = require('./services/worker/WorkerService');
+    services.registerService("worker-service", WorkerService)
 }
 
 const install_legacy = async ({ services }) => {

src/backend/src/services/worker/.gitignore

@@ -0,0 +1 @@
+dist/

src/backend/src/services/worker/README.md

@@ -0,0 +1,53 @@
+# Worker Service
+
+This directory contains the worker service components for Puter's server-to-web (s2w) worker functionality.
+
+## Build Process
+
+The `dist/workerPreamble.js` file is **generated** by webpack and c-preprocessor and should not be edited directly. Instead, edit the source files in the `src/` directory and rebuild.
+
+### Building
+
+To build the worker preamble:
+
+```bash
+# From this directory
+npm install
+npm run build
+```
+
+Or from the backend root:
+
+```bash
+npm run build:worker
+```
+
+### Development
+
+For development with auto-rebuild:
+
+```bash
+npm run build:watch
+```
+
+This will watch for changes in the source files and automatically rebuild the `workerPreamble.js`.
+
+## Source Files
+
+- `template/puter-portable.js` - Puter portable API wrapper
+- `src/s2w-router.js` - Server-to-web router implementation
+- `src/index.js` - Main entry point that combines both components
+
+## Dependencies
+
+- `path-to-regexp` - URL pattern matching library used by the s2w router
+
+## Generated Output
+
+The webpack build process creates `dist/workerPreamble.js` which contains:
+1. The bundled `path-to-regexp` library
+2. The puter portable API
+3. The s2w router with proper initialization
+4. Initialization code that sets up both systems
+
+This file is then read by `WorkerService.js` and injected into worker environments. 

src/backend/src/services/worker/WorkerService.js

@@ -0,0 +1,143 @@
+/*
+ * Copyright (C) 2024-present Puter Technologies Inc.
+ * 
+ * This file is part of Puter.
+ * 
+ * Puter is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+const configurable_auth = require("../../middleware/configurable_auth");
+const { Endpoint } = require("../../util/expressutil");
+const BaseService = require("../BaseService");
+const fs = require("node:fs");
+
+const { createWorker, setCloudflareKeys, deleteWorker } = require("./workerUtils/cloudflareDeploy");
+const { getUserInfo } = require("./workerUtils/puterUtils");
+
+// This file is generated by webpack. To rebuild: cd to this directory and run `npm run build`
+let preamble;
+try {
+    preamble = fs.readFileSync(__dirname + "/dist/workerPreamble.js", "utf-8");
+} catch (e) {
+    preamble = "";
+    console.error("WORKERS ERROR: Preamble has not been built! Workers will not have access to puter.js\nTo fix this cd into src/backend/src/worker and run npm run build")
+} 
+const PREAMBLE_LENGTH = preamble.split("\n").length - 1
+
+class WorkerService extends BaseService {
+    ['__on_install.routes'](_, { app }) {
+        setCloudflareKeys(this.config);
+
+    }
+    static IMPLEMENTS = {
+        ['workers']: {
+            async create({ fileData, workerName, authorization }) {
+                try {
+                    const userData = await getUserInfo(authorization, this.global_config.api_base_url);
+                    return await createWorker(userData, authorization, workerName, preamble + fileData, PREAMBLE_LENGTH);
+                } catch (e) {
+                    return {success: false, e}
+                }
+            },
+            async destroy({ workerName, authorization }) {
+                try {
+                    const userData = await getUserInfo(authorization, this.global_config.api_base_url);
+                    return await deleteWorker(userData, authorization, workerName);
+                } catch (e) {
+                    return {success: false, e}
+                }
+            },
+            async startLogs({ workerName, authorization }) {
+                return await this.exec_({ runtime, code });
+            },
+            async endLogs({ workerName, authorization }) {
+                return await this.exec_({ runtime, code });
+            },
+        }
+    }
+    async ['__on_driver.register.interfaces']() {
+        const svc_registry = this.services.get('registry');
+        const col_interfaces = svc_registry.get('interfaces');
+
+        col_interfaces.set('workers', {
+            description: 'Execute code with various languages.',
+            methods: {
+                create: {
+                    description: 'Create a backend worker',
+                    parameters: {
+                        fileData: {
+                            type: "string",
+                            description: "The code of the worker to upload"
+                        },
+                        workerName: {
+                            type: "string",
+                            description: "The name of the worker you want to upload"
+                        },
+                        authorization: {
+                            type: "string",
+                            description: "Puter token"
+                        }
+                    },
+                    result: { type: 'json' },
+                },
+                startLogs: {
+                    description: 'Get logs for your backend worker',
+                    parameters: {
+                        workerName: {
+                            type: "string",
+                            description: "The name of the worker you want the logs of"
+                        },
+                        authorization: {
+                            type: "string",
+                            description: "Puter token"
+                        }
+                    },
+                    result: { type: 'json' },
+                },
+                endLogs: {
+                    description: 'Get logs for your backend worker',
+                    parameters: {
+                        workerName: {
+                            type: "string",
+                            description: "The name of the worker you want the logs of"
+                        },
+                        authorization: {
+                            type: "string",
+                            description: "Puter token"
+                        }
+                    },
+                    result: { type: 'json' },
+                },
+                destroy: {
+                    description: 'Get rid of your backend worker',
+                    parameters: {
+                        workerName: {
+                            type: "string",
+                            description: "The name of the worker you want to destroy"
+                        },
+                        authorization: {
+                            type: "string",
+                            description: "Puter token"
+                        }
+                    },
+                    result: { type: 'json' },
+                },
+            }
+        });
+    }
+}
+
+module.exports = {
+    WorkerService,
+};

src/backend/src/services/worker/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@heyputer/worker-service",
+  "version": "1.0.0",
+  "description": "Worker service components for Puter",
+  "main": "src/index.js",
+  "scripts": {
+    "build": "webpack --mode production && npm run preprocess",
+    "preprocess": "c-preprocessor template/puter-portable.js dist/workerPreamble.js"
+  },
+  "dependencies": {
+    "c-preprocessor": "^0.2.13",
+    "path-to-regexp": "^8.2.0"
+  },
+  "devDependencies": {
+    "imports-loader": "^5.0.0",
+    "raw-loader": "^4.0.2",
+    "script-loader": "^0.7.2",
+    "terser-webpack-plugin": "^5.3.14",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.1"
+  },
+  "author": "Puter Technologies Inc.",
+  "license": "AGPL-3.0-only"
+}

src/backend/src/services/worker/src/index.js

@@ -0,0 +1,4 @@
+import inits2w from './s2w-router.js';
+// Initialize s2w router
+inits2w();
+

src/backend/src/services/worker/src/s2w-router.js

@@ -0,0 +1,64 @@
+import { match } from 'path-to-regexp';
+
+function inits2w() {
+    // s2w router itself: Not part of any package, just a simple router.
+    const s2w = {
+        routing: true,
+        map: new Map(),
+        custom(eventName, route, eventListener) {
+            const matchExp = match(route);
+            if (!this.map.has(eventName)) {
+                this.map.set(eventName, [[matchExp, eventListener]])
+            } else {
+                this.map.get(eventName).push([matchExp, eventListener])
+            }
+        },
+        get(...args) {
+            this.custom("GET", ...args)
+        },
+        post(...args) {
+            this.custom("POST", ...args)
+        },
+        options(...args) {
+            this.custom("OPTIONS", ...args)
+        },
+        put(...args) {
+            this.custom("PUT", ...args)
+        },
+        delete(...args) {
+            this.custom("DELETE", ...args)
+        },
+        async route(event) {
+            if (!globalThis.puter) {
+                console.log("Puter not loaded, initializing...");
+                const success = init_puter_portable(globalThis.puter_auth, globalThis.puter_endpoint || "https://api.puter.com");
+                console.log("Puter.js initialized successfully");
+            }
+            
+            const mappings = this.map.get(event.request.method);
+            const url = new URL(event.request.url);
+            try {
+                for (const mapping of mappings) {
+                    // return new Response(JSON.stringify(mapping))
+                    const results = mapping[0](url.pathname)
+                    if (results) {
+                        event.params = results.params;
+                        return mapping[1](event);
+                    }
+                }
+            } catch (e) {
+                return new Response(e, {status: 500, statusText: "Server Error"})
+            }
+
+            return new Response("Path not found", {status: 404, statusText: "Not found"});
+        }
+    }
+    globalThis.s2w = s2w;
+    self.addEventListener("fetch", (event)=> {
+        if (!s2w.routing)
+            return false;
+        event.respondWith(s2w.route(event));
+    })
+}
+
+export default inits2w; 

src/backend/src/services/worker/template/puter-portable.js

@@ -0,0 +1,33 @@
+// This file is not actually in the webpack project, it is handled seperately.
+
+if (globalThis.Cloudflare) {
+    // Cloudflare Workers has a faulty EventTarget implementation which doesn't bind "this" to the event handler
+    // This is a workaround to bind "this" to the event handler
+    // https://github.com/cloudflare/workerd/issues/4453
+    const __cfEventTarget = EventTarget;
+    globalThis.EventTarget = class EventTarget extends __cfEventTarget {
+        constructor(...args) {
+            super(...args)
+        }
+        addEventListener(type, listener, options) {
+            super.addEventListener(type, listener.bind(this), options);
+        }
+    }
+}
+
+globalThis.init_puter_portable = (auth, apiOrigin) => {
+    console.log("Starting puter.js initialization");
+
+    // Who put C in my JS??
+    /*
+     *  This is a hack to include the puter.js file.
+     *  It is not a good idea to do this, but it is the only way to get the puter.js file to work.
+     *  The puter.js file is handled by the C preprocessor here because webpack cant behave with already minified files.
+     * The C preprocessor basically just includes the file and then we can use the puter.js file in the worker.
+     */
+    #include "../../../../../puter-js/dist/puter.js"
+    puter.setAPIOrigin(apiOrigin);
+    puter.setAuthToken(auth);
+}
+#include "../dist/webpackPreamplePart.js"
+