Basic procedure calling

Author: coolreader18

Cargo.lock

@@ -175,6 +175,7 @@ enum-map = "2.6.3"
 env_logger = "0.10"
 ethnum = { version = "1.5.0", features = ["serde"] }
 flate2 = "1.0.24"
+flume = { version = "0.11", default-features = false, features = ["async"] }
 foldhash = "0.1.4"
 fs-err = "2.9.0"
 fs_extra = "1.3.0"

Cargo.toml

@@ -0,0 +1,78 @@
+import { AlgebraicType, ProductType } from '../lib/algebraic_type';
+import BinaryReader from '../lib/binary_reader';
+import BinaryWriter from '../lib/binary_writer';
+import type { ConnectionId } from '../lib/connection_id';
+import type { Identity } from '../lib/identity';
+import type { Timestamp } from '../lib/timestamp';
+import type { ParamsObj } from './reducers';
+import { MODULE_DEF, type UntypedSchemaDef } from './schema';
+import type { Infer, InferTypeOfRow, TypeBuilder } from './type_builders';
+import { bsatnBaseSize } from './util';
+
+export type ProcedureFn<
+  S extends UntypedSchemaDef,
+  Params extends ParamsObj,
+  Ret extends TypeBuilder<any, any>,
+> = (ctx: ProcedureCtx<S>, args: InferTypeOfRow<Params>) => Infer<Ret>;
+
+export type ProcedureCtx<S extends UntypedSchemaDef> = Readonly<{
+  sender: Identity;
+  timestamp: Timestamp;
+  connectionId: ConnectionId | null;
+}>;
+
+export function procedure<
+  S extends UntypedSchemaDef,
+  Params extends ParamsObj,
+  Ret extends TypeBuilder<any, any>,
+>(name: string, params: Params, ret: Ret, fn: ProcedureFn<S, Params, Ret>) {
+  const paramsType: ProductType = {
+    elements: Object.entries(params).map(([n, c]) => ({
+      name: n,
+      algebraicType: c.algebraicType,
+    })),
+  };
+  const returnType = ret.algebraicType;
+
+  MODULE_DEF.miscExports.push({
+    tag: 'Procedure',
+    value: {
+      name,
+      params: paramsType,
+      returnType,
+    },
+  });
+
+  PROCEDURES.push({
+    fn,
+    paramsType,
+    returnType,
+    returnTypeBaseSize: bsatnBaseSize(MODULE_DEF.typespace, returnType),
+  });
+}
+
+const PROCEDURES: Array<{
+  fn: ProcedureFn<any, any, any>;
+  paramsType: ProductType;
+  returnType: AlgebraicType;
+  returnTypeBaseSize: number;
+}> = [];
+
+export function callProcedure(
+  id: number,
+  sender: Identity,
+  connectionId: ConnectionId | null,
+  timestamp: Timestamp,
+  argsBuf: Uint8Array
+): Uint8Array {
+  const { fn, paramsType, returnType, returnTypeBaseSize } = PROCEDURES[id];
+  const args = ProductType.deserializeValue(
+    new BinaryReader(argsBuf),
+    paramsType,
+    MODULE_DEF.typespace
+  );
+  const ret = fn(Object.freeze({ sender, connectionId, timestamp }), args);
+  const retBuf = new BinaryWriter(returnTypeBaseSize);
+  AlgebraicType.serializeValue(retBuf, returnType, ret, MODULE_DEF.typespace);
+  return retBuf.getBuffer();
+}

crates/bindings-typescript/src/server/procedures.ts

@@ -1,4 +1,4 @@
-import { AlgebraicType } from '../lib/algebraic_type';
+import { AlgebraicType, ProductType } from '../lib/algebraic_type';
 import RawModuleDef from '../lib/autogen/raw_module_def_type';
 import type RawModuleDefV9 from '../lib/autogen/raw_module_def_v_9_type';
 import type RawTableDefV9 from '../lib/autogen/raw_table_def_v_9_type';
@@ -36,6 +36,7 @@ import {
   type ViewCtx,
 } from './views';
 import { bsatnBaseSize } from './util';
+import { callProcedure } from './procedures';
 
 const { freeze } = Object;
 
@@ -229,9 +230,9 @@ export const hooks_v1_1: import('spacetime:sys@1.1').ModuleHooks = {
       // at runtime
       db: getDbView(),
     });
-    const args = AlgebraicType.deserializeValue(
+    const args = ProductType.deserializeValue(
       new BinaryReader(argsBuf),
-      AlgebraicType.Product(params),
+      params,
       MODULE_DEF.typespace
     );
     const ret = fn(ctx, args);
@@ -247,9 +248,9 @@ export const hooks_v1_1: import('spacetime:sys@1.1').ModuleHooks = {
       // at runtime
       db: getDbView(),
     });
-    const args = AlgebraicType.deserializeValue(
+    const args = ProductType.deserializeValue(
       new BinaryReader(argsBuf),
-      AlgebraicType.Product(params),
+      params,
       MODULE_DEF.typespace
     );
     const ret = fn(ctx, args);
@@ -259,6 +260,18 @@ export const hooks_v1_1: import('spacetime:sys@1.1').ModuleHooks = {
   },
 };
 
+export const hooks_v1_2: import('spacetime:sys@1.2').ModuleHooks = {
+  __call_procedure__(id, sender, connection_id, timestamp, args) {
+    return callProcedure(
+      id,
+      new Identity(sender),
+      ConnectionId.nullIfZero(new ConnectionId(connection_id)),
+      new Timestamp(timestamp),
+      args
+    );
+  },
+};
+
 let DB_VIEW: DbView<any> | null = null;
 function getDbView() {
   DB_VIEW ??= makeDbView(MODULE_DEF);

crates/bindings-typescript/src/server/runtime.ts

@@ -29,6 +29,7 @@ import {
   type ViewOpts,
   type ViewReturnTypeBuilder,
 } from './views';
+import { procedure, type ProcedureFn } from './procedures';
 
 /**
  * The global module definition that gets populated by calls to `reducer()` and lifecycle hooks.
@@ -348,6 +349,32 @@ class Schema<S extends UntypedSchemaDef> {
   //   }
   // }
 
+  procedure<Params extends ParamsObj, Ret extends TypeBuilder<any, any>>(
+    name: string,
+    params: Params,
+    ret: Ret,
+    fn: ProcedureFn<S, Params, Ret>
+  ): ProcedureFn<S, Params, Ret>;
+  procedure<Ret extends TypeBuilder<any, any>>(
+    name: string,
+    ret: Ret,
+    fn: ProcedureFn<S, {}, Ret>
+  ): ProcedureFn<S, {}, Ret>;
+  procedure<Params extends ParamsObj, Ret extends TypeBuilder<any, any>>(
+    name: string,
+    paramsOrRet: Ret | Params,
+    retOrFn: ProcedureFn<S, {}, Ret> | Ret,
+    maybeFn?: ProcedureFn<S, Params, Ret>
+  ): ProcedureFn<S, Params, Ret> {
+    if (typeof retOrFn === 'function') {
+      procedure(name, {}, paramsOrRet as Ret, retOrFn);
+      return retOrFn;
+    } else {
+      procedure(name, paramsOrRet as Params, retOrFn, maybeFn!);
+      return maybeFn!;
+    }
+  }
+
   clientVisibilityFilter = {
     sql(filter: string): void {
       MODULE_DEF.rowLevelSecurity.push({ sql: filter });

crates/bindings-typescript/src/server/schema.ts

@@ -75,3 +75,17 @@ declare module 'spacetime:sys@1.1' {
 
   export function register_hooks(hooks: ModuleHooks);
 }
+
+declare module 'spacetime:sys@1.2' {
+  export type ModuleHooks = {
+    __call_procedure__(
+      id: u32,
+      sender: u256,
+      connection_id: u128,
+      timestamp: bigint,
+      args: Uint8Array
+    ): Uint8Array;
+  };
+
+  export function register_hooks(hooks: ModuleHooks);
+}

crates/bindings-typescript/src/server/sys.d.ts

@@ -120,6 +120,7 @@ jwks.workspace = true
 async_cache = "0.3.1"
 faststr = "0.2.23"
 core_affinity = "0.8"
+flume.workspace = true
 
 [target.'cfg(not(target_env = "msvc"))'.dependencies]
 tikv-jemallocator = {workspace = true}