Skip to main content

​
WASM Plugins

Collabase features a native WebAssembly (WASM) plugin engine that allows you to securely extend the core backend. Unlike Frontend SDK Apps which run visually in an iFrame, WASM plugins run completely headless on your server. They interface directly with the Collabase backend engine via a high-performance, strictly controlled execution sandbox.

​
Why WebAssembly?

  • Sandboxed Execution: Plugins cannot crash the main Node.js event loop or application thread. Memory leaks, infinite loops, or segmentation faults inside the plugin are securely isolated.
  • Zero Overhead Background Processing: Ideal for listening to system events (e.g., synchronously mutating a task payload before it saves) without the latency and network overhead of traditional HTTP webhooks.
  • Polyglot Freedom: Write your backend logic in AssemblyScript, Rust, Go, or C/C++, and compile it down to a standard .wasm binary.

​
The Sandbox Environment

When the Collabase engine executes a WASM plugin, it runs within strict boundaries enforced by the host:
  • memoryLimit: Configurable per plugin (default 64MB).
  • timeout: Configurable execution time limit to prevent CPU monopolization (default 5000ms).
Plugins do not have arbitrary native file system access, raw network socket access, or unrestricted environment variable access unless explicitly granted via Host Functions.

​
Hook Points

WASM Plugins are triggered by “Hook Points.” A Hook Point is a subscription to a system event or an interception path within the main backend architecture. Define your hook points in your plugin’s metadata manifest: 
{
  "name": "Task Auto-Tagger",
  "version": "1.0.0",
  "hookPoints": ["task:created", "page:updated", "automation:custom_node"]
}
Whenever a user modifies a task or an automation flow hits your custom node, the Collabase engine invokes your WASM module’s entry point, passing the serialized payload and execution context.

​
Available Hook Points

Below is the list of hooks currently exposed to the WASM engine:
HookPayload DescriptionTypical Developer Use Case
task:createdFull Task object.Automatic tagging, custom routing, or strict validation upon creation.
task:updatedTask object and changedFields.Auditing specific status transitions or computing derived states.
task:deletedtaskId string.Triggering cleanup jobs in related external system databases.
page:createdPage object (excluding MDX body).Initiating external approval workflows for new documentation.
page:updatedPage object and diff AST.Tracking stale content or automatically triggering translation tasks.
page:deletedpageId string.Archiving logic.
user:createdUser profile object.Provisioning the user automatically in external LDAP or SCIM integrations.
project:createdProject object.Bootstrapping default folders, task queues, or sprint schedules for new projects.
automation:custom_nodeNode context, params, and variables.Executing highly specialized, memory-intensive logic required by an automation flowchart.

​
Host Functions

The engine provides specific “Host Functions” that bridge your isolated WASM sandbox to the underlying Collabase platform APIs.

​
Context and Logging

The most important host function is collabase:log. This allows your plugin to stream execution logs directly to the Admin Dashboard’s live log viewer. AssemblyScript Example: 
// Import the host function from the Collabase environment
@external("collabase", "log")
declare function collabaseLog(level: string, message: string): void;

export function onActivate(): void {
  collabaseLog("INFO", "WASM Plugin has been activated successfully!");
}

export function onEvent(eventName: string, payload: string): void {
  collabaseLog("DEBUG", `Received event hook: ${eventName}`);
  
  if (eventName == "task:created") {
    // Deserialize the payload and process the task
    // TODO: Implement custom routing logic here
    collabaseLog("INFO", "Processed new task creation via WASM.");
  }
}

​
Compiling Your Plugin

Depending on your language of choice, compile your source code to the wasm32-unknown-unknown or equivalent target.
1

Write Logic

Implement your logic using the exposed Collabase host functions and your preferred language.
2

Compile (AssemblyScript)

Use the AssemblyScript compiler:
asc src/index.ts -b build/plugin.wasm --optimize
3

Compile (Rust)

Use the standard Cargo build target:
cargo build --target wasm32-unknown-unknown --release

​
Installing and Updating

Once your .wasm binary is compiled, you must deploy it to the Collabase instance.

​
Via the Admin Interface

1

Open Plugins

Navigate to System Administration → Plugins.
2

Select Tab

Switch to the WASM Plugins tab.
3

Click Install

Click Install WASM Plugin.
4

Upload

Upload your compiled .wasm file along with its metadata JSON.

​
Reviewing Live Execution Logs

In the WASM Plugins tab, expand any installed plugin row to reveal the Live Log Viewer. Every time your plugin calls the collabase:log host function (or encounters a sandbox panic, segmentation fault, or timeout), the engine instantly streams the stdout/stderr here. You can filter logs by Level (INFO, ERROR, DEBUG) to monitor background execution in production environments.