@gcoredev/proxy-wasm-sdk-as 1.0.1 → 1.1.0

package/README.md

@@ -1,6 +1,5 @@
 # WebAssembly for Proxies (AssemblyScript SDK)
 
-
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/G-Core/proxy-wasm-sdk-as/deploy.yaml)](https://github.com/G-Core/proxy-wasm-sdk-as)
 [![GitHub commit activity](https://img.shields.io/github/commit-activity/t/G-Core/proxy-wasm-sdk-as)](https://github.com/G-Core/proxy-wasm-sdk-as)
 [![GitHub top language](https://img.shields.io/github/languages/top/G-Core/proxy-wasm-sdk-as)](https://github.com/G-Core/proxy-wasm-sdk-as)
@@ -8,8 +7,9 @@
 [![NPM Version](https://img.shields.io/npm/v/@gcoredev/proxy-wasm-sdk-as)](https://www.npmjs.com/package/@gcoredev/proxy-wasm-sdk-as)
 
 This is a friendly fork of https://github.com/Kong/proxy-wasm-assemblyscript-sdk/,
-temporarily mantained to address an incompatibility between the AssemblyScript
-SDK and the Rust SDK.
+mantained to address an incompatibility between the AssemblyScript SDK and the Rust SDK,
+
+It also adds some FastEdge specific functionality.
 
 ## How to use this SDK
 
@@ -32,21 +32,21 @@ the options passed to `asc` compiler:
 }
 ```
 
-Add `"@gcoredev/proxy-wasm-sdk-as": "0.0.1"` to your dependencies then run `npm install`.
+Add `"@gcoredev/proxy-wasm-sdk-as": "^1.0.2"` to your dependencies then run `npm install`.
 
 ## Hello, World
 
 Copy this into assembly/index.ts:
 
 ```ts
-export * from "@gcoredev/proxy-wasm-sdk-as/proxy";
+export * from "@gcoredev/proxy-wasm-sdk-as/assembly/proxy";
 import {
   RootContext,
   Context,
   registerRootContext,
   FilterHeadersStatusValues,
   stream_context,
-} from "@gcoredev/proxy-wasm-sdk-as";
+} from "@gcoredev/proxy-wasm-sdk-as/assembly";
 
 class AddHeaderRoot extends RootContext {
   createContext(context_id: u32): Context {
@@ -77,7 +77,7 @@ registerRootContext((context_id: u32) => {
 }, "add_header");
 ```
 
-## build
+## Build
 
 To build, simply run:
 
@@ -85,25 +85,17 @@ To build, simply run:
 npm run asbuild
 ```
 
-build results will be in the build folder. `untouched.wasm` and `optimized.wasm` are the compiled
-file that we will use (you only need one of them, if unsure use `optimized.wasm`).
+build results will be in the build folder. `debug.wasm` and `release.wasm` are the compiled
+file that we will use (you only need one of them, if unsure use `release.wasm`).
 
 ## Run
 
-Configure envoy with your filter:
-
-```yaml
-- name: envoy.filters.http.wasm
-  config:
-    config:
-      name: "add_header"
-      root_id: "add_header"
-      configuration: "what ever you want"
-      vm_config:
-        vm_id: "my_vm_id"
-        runtime: "envoy.wasm.runtime.v8"
-        code:
-          local:
-            filename: /PATH/TO/CODE/build/optimized.wasm
-        allow_precompiled: false
-```
+These binaries can then be uploaded and attached to your CDN applications within the FastEdge UI portal.
+
+For some binaries (the above example for instance) you can test localy using envoy.
+
+Please see [Envoy.md](./ENVOY.md)
+
+## Examples
+
+For more examples on how to use this `proxy-wasm-sdk-as` please see our [examples repo](https://github.com/G-Core/FastEdge-examples/tree/main/assemblyscript)

package/assembly/exports.ts

@@ -1,4 +1,12 @@
-import { getBaseContext, getContext, getRootContext, ensureContext, ensureRootContext, deleteContext, PeerTypeValues } from "./runtime";
+import {
+  getBaseContext,
+  getContext,
+  getRootContext,
+  ensureContext,
+  ensureRootContext,
+  deleteContext,
+  PeerTypeValues,
+} from "./runtime";
 
 ///// CALLS IN
 type FilterStatus = i32;
@@ -10,17 +18,26 @@ type GrpcStatus = i32;
 type WasmOnDoneResult = u32;
 
 // Calls in.
-export function proxy_abi_version_0_2_1(): void { }
+export function proxy_abi_version_0_2_1(): void {}
 
-export function proxy_on_vm_start(root_context_id: u32, configuration_size: u32): u32 {
+export function proxy_on_vm_start(
+  root_context_id: u32,
+  configuration_size: u32
+): u32 {
   let root_context = getRootContext(root_context_id);
   return root_context.onStart(configuration_size) ? 1 : 0;
 }
-export function proxy_validate_configuration(root_context_id: u32, configuration_size: u32): u32 {
+export function proxy_validate_configuration(
+  root_context_id: u32,
+  configuration_size: u32
+): u32 {
   let root_context = getRootContext(root_context_id);
   return root_context.validateConfiguration(configuration_size) ? 1 : 0;
 }
-export function proxy_on_configure(root_context_id: u32, configuration_size: u32): u32 {
+export function proxy_on_configure(
+  root_context_id: u32,
+  configuration_size: u32
+): u32 {
   let root_context = getRootContext(root_context_id);
   return root_context.onConfigure(configuration_size) ? 1 : 0;
 }
@@ -28,7 +45,11 @@ export function proxy_on_tick(root_context_id: u32): void {
   let root_context = getRootContext(root_context_id);
   root_context.onTick();
 }
-export function proxy_on_foreign_function(root_context_id: u32, function_id: u32, data_size: u32): void {
+export function proxy_on_foreign_function(
+  root_context_id: u32,
+  function_id: u32,
+  data_size: u32
+): void {
   // TODO: implement me
 }
 
@@ -37,7 +58,10 @@ export function proxy_on_queue_ready(root_context_id: u32, token: u32): void {
   root_context.onQueueReady(token);
 }
 // Stream calls.
-export function proxy_on_context_create(context_id: u32, root_context_id: u32): void {
+export function proxy_on_context_create(
+  context_id: u32,
+  root_context_id: u32
+): void {
   if (root_context_id != 0) {
     ensureContext(context_id, root_context_id);
   } else {
@@ -45,77 +69,159 @@ export function proxy_on_context_create(context_id: u32, root_context_id: u32):
   }
 }
 
-export function proxy_on_request_headers(context_id: u32, headers: u32, end_of_stream: u32): FilterHeadersStatus {
+export function proxy_on_request_headers(
+  context_id: u32,
+  headers: u32,
+  end_of_stream: u32
+): FilterHeadersStatus {
   let ctx = getContext(context_id);
-  return ctx.onRequestHeaders(headers, end_of_stream != 0) as FilterHeadersStatus;
-}
-export function proxy_on_request_body(context_id: u32, body_buffer_length: u32, end_of_stream: u32): FilterDataStatus {
+  return ctx.onRequestHeaders(
+    headers,
+    end_of_stream != 0
+  ) as FilterHeadersStatus;
+}
+export function proxy_on_request_body(
+  context_id: u32,
+  body_buffer_length: u32,
+  end_of_stream: u32
+): FilterDataStatus {
   let ctx = getContext(context_id);
-  return ctx.onRequestBody(body_buffer_length, end_of_stream != 0) as FilterDataStatus;
-}
-export function proxy_on_request_trailers(context_id: u32, trailers: u32): FilterTrailersStatus {
+  return ctx.onRequestBody(
+    body_buffer_length,
+    end_of_stream != 0
+  ) as FilterDataStatus;
+}
+export function proxy_on_request_trailers(
+  context_id: u32,
+  trailers: u32
+): FilterTrailersStatus {
   let ctx = getContext(context_id);
   return ctx.onRequestTrailers(trailers) as FilterTrailersStatus;
 }
-export function proxy_on_request_metadata(context_id: u32, nelements: u32): FilterMetadataStatus {
+export function proxy_on_request_metadata(
+  context_id: u32,
+  nelements: u32
+): FilterMetadataStatus {
   let ctx = getContext(context_id);
   return ctx.onRequestMetadata(nelements) as FilterMetadataStatus;
 }
-export function proxy_on_response_headers(context_id: u32, headers: u32, end_of_stream: u32): FilterHeadersStatus {
+export function proxy_on_response_headers(
+  context_id: u32,
+  headers: u32,
+  end_of_stream: u32
+): FilterHeadersStatus {
   let ctx = getContext(context_id);
-  return ctx.onResponseHeaders(headers, end_of_stream != 0) as FilterHeadersStatus;
-}
-export function proxy_on_response_body(context_id: u32, body_buffer_length: u32, end_of_stream: u32): FilterDataStatus {
+  return ctx.onResponseHeaders(
+    headers,
+    end_of_stream != 0
+  ) as FilterHeadersStatus;
+}
+export function proxy_on_response_body(
+  context_id: u32,
+  body_buffer_length: u32,
+  end_of_stream: u32
+): FilterDataStatus {
   let ctx = getContext(context_id);
-  return ctx.onResponseBody(body_buffer_length, end_of_stream != 0) as FilterDataStatus;
-}
-export function proxy_on_response_trailers(context_id: u32, trailers: u32): FilterTrailersStatus {
+  return ctx.onResponseBody(
+    body_buffer_length,
+    end_of_stream != 0
+  ) as FilterDataStatus;
+}
+export function proxy_on_response_trailers(
+  context_id: u32,
+  trailers: u32
+): FilterTrailersStatus {
   let ctx = getContext(context_id);
   return ctx.onResponseTrailers(trailers) as FilterTrailersStatus;
 }
-export function proxy_on_response_metadata(context_id: u32, nelements: u32): FilterMetadataStatus {
+export function proxy_on_response_metadata(
+  context_id: u32,
+  nelements: u32
+): FilterMetadataStatus {
   let ctx = getContext(context_id);
   return ctx.onResponseMetadata(nelements) as FilterMetadataStatus;
 }
 
 // HTTP/gRPC.
-export function proxy_on_http_call_response(context_id: u32, token: u32, headers: u32, body_size: u32, trailers: u32): void {
+export function proxy_on_http_call_response(
+  context_id: u32,
+  token: u32,
+  headers: u32,
+  body_size: u32,
+  trailers: u32
+): void {
   let ctx = getRootContext(context_id);
   ctx.onHttpCallResponse(token, headers, body_size, trailers);
 }
-export function proxy_on_grpc_receive_initial_metadata(context_id: u32, token: u32, headers: u32): void {
-  getRootContext(context_id).on_grpc_receive_initial_metadata(token, headers)
-}
-export function proxy_on_grpc_trailing_metadata(context_id: u32, token: u32, trailers: u32): void {
-  getRootContext(context_id).on_grpc_trailing_metadata(token, trailers)
-}
-export function proxy_on_grpc_receive(context_id: u32, token: u32, response_size: u32): void {
-  getRootContext(context_id).on_grpc_receive(token, response_size)
-}
-export function proxy_on_grpc_close(context_id: u32, token: u32, status_code: u32): void {
-  getRootContext(context_id).on_grpc_close(token, status_code)
+export function proxy_on_grpc_receive_initial_metadata(
+  context_id: u32,
+  token: u32,
+  headers: u32
+): void {
+  getRootContext(context_id).on_grpc_receive_initial_metadata(token, headers);
+}
+export function proxy_on_grpc_trailing_metadata(
+  context_id: u32,
+  token: u32,
+  trailers: u32
+): void {
+  getRootContext(context_id).on_grpc_trailing_metadata(token, trailers);
+}
+export function proxy_on_grpc_receive(
+  context_id: u32,
+  token: u32,
+  response_size: u32
+): void {
+  getRootContext(context_id).on_grpc_receive(token, response_size);
+}
+export function proxy_on_grpc_close(
+  context_id: u32,
+  token: u32,
+  status_code: u32
+): void {
+  getRootContext(context_id).on_grpc_close(token, status_code);
 }
 
 // NETWORK_FILTER support (TCP and, perhaps one day, UDP).
-export function proxy_on_downstream_data(context_id: u32, body_buffer_length: u32, end_of_stream: u32): FilterStatus {
-    let ctx = getContext(context_id);
-    return ctx.onDownstreamData(body_buffer_length, end_of_stream != 0) as FilterStatus;
-}
-export function proxy_on_upstream_data(context_id: u32, body_buffer_length: u32, end_of_stream: u32): FilterStatus {
-    let ctx = getContext(context_id);
-    return ctx.onUpstreamData(body_buffer_length, end_of_stream != 0) as FilterStatus;
-}
-export function proxy_on_upstream_connection_close(context_id: u32, peer_type: u32): void {
-    let ctx = getContext(context_id);
-    ctx.onUpstreamConnectionClose(peer_type as PeerTypeValues);
+export function proxy_on_downstream_data(
+  context_id: u32,
+  body_buffer_length: u32,
+  end_of_stream: u32
+): FilterStatus {
+  let ctx = getContext(context_id);
+  return ctx.onDownstreamData(
+    body_buffer_length,
+    end_of_stream != 0
+  ) as FilterStatus;
+}
+export function proxy_on_upstream_data(
+  context_id: u32,
+  body_buffer_length: u32,
+  end_of_stream: u32
+): FilterStatus {
+  let ctx = getContext(context_id);
+  return ctx.onUpstreamData(
+    body_buffer_length,
+    end_of_stream != 0
+  ) as FilterStatus;
+}
+export function proxy_on_upstream_connection_close(
+  context_id: u32,
+  peer_type: u32
+): void {
+  let ctx = getContext(context_id);
+  ctx.onUpstreamConnectionClose(peer_type as PeerTypeValues);
 }
-export function proxy_on_downstream_connection_close(context_id: u32, peer_type: u32): void {
-    let ctx = getContext(context_id);
-    ctx.onDownstreamConnectionClose(peer_type as PeerTypeValues);
+export function proxy_on_downstream_connection_close(
+  context_id: u32,
+  peer_type: u32
+): void {
+  let ctx = getContext(context_id);
+  ctx.onDownstreamConnectionClose(peer_type as PeerTypeValues);
 }
 export function proxy_on_new_connection(context_id: u32): FilterStatus {
-    let ctx = getContext(context_id);
-    return ctx.onNewConnection() as FilterStatus;
+  let ctx = getContext(context_id);
+  return ctx.onNewConnection() as FilterStatus;
 }
 
 // The stream/vm has completed.

package/assembly/fastedge.ts

@@ -0,0 +1,82 @@
+import * as imports from "./imports";
+
+import {
+  get_current_time_nanoseconds,
+  globalArrayBufferReference,
+  LogLevelValues,
+} from "./runtime";
+
+let logLevel: LogLevelValues = LogLevelValues.info;
+
+function setLogLevel(level: LogLevelValues): void {
+  logLevel = level;
+}
+
+function log(level: LogLevelValues, logMessage: string): void {
+  // Temporary fix for proxy_log not being implemented in fastedge:
+  // relies on @assemblyscript/wasi-shim to print to standard output
+  if (level >= logLevel) {
+    process.stdout.write(logMessage + "\n");
+  }
+}
+
+function getCurrentTime(): u64 {
+  return get_current_time_nanoseconds() / 1_000_000; // Convert nanoseconds to milliseconds
+}
+
+function getEnvVar(key: string): string {
+  const hasKey = process.env.has(key);
+  if (hasKey) {
+    return process.env.get(key);
+  }
+  return "";
+}
+
+function getSecretVar(key: string): string {
+  const buffer = String.UTF8.encode(key);
+  const status = imports.proxy_get_secret(
+    changetype<usize>(buffer),
+    buffer.byteLength,
+    globalArrayBufferReference.bufferPtr(),
+    globalArrayBufferReference.sizePtr()
+  );
+  if (status != 0) {
+    // Something went wrong - returns 0 with an empty ArrayBuffer if not found
+    return "";
+  }
+  const arrBuff = globalArrayBufferReference.toArrayBuffer();
+  if (arrBuff.byteLength == 0) {
+    return ""; // Not found
+  }
+  return String.UTF8.decode(arrBuff);
+}
+
+function getSecretVarEffectiveAt(key: string, at: u32): string {
+  const buffer = String.UTF8.encode(key);
+  const status = imports.proxy_get_effective_at_secret(
+    changetype<usize>(buffer),
+    buffer.byteLength,
+    at,
+    globalArrayBufferReference.bufferPtr(),
+    globalArrayBufferReference.sizePtr()
+  );
+  if (status != 0) {
+    // Something went wrong - returns 0 with an empty ArrayBuffer if not found
+    return "";
+  }
+  const arrBuff = globalArrayBufferReference.toArrayBuffer();
+  if (arrBuff.byteLength == 0) {
+    return ""; // Not found
+  }
+  return String.UTF8.decode(arrBuff);
+}
+
+export {
+  getCurrentTime,
+  getEnvVar,
+  getSecretVar,
+  getSecretVarEffectiveAt,
+  log,
+  LogLevelValues,
+  setLogLevel,
+};

package/assembly/imports.ts

@@ -124,6 +124,10 @@ export declare function proxy_get_buffer_bytes(typ: BufferType, start: u32, leng
 // @ts-ignore: decorator
 @external("env", "proxy_get_buffer_status")
 export declare function proxy_get_buffer_status(typ: BufferType, length_ptr: ptr<usize>, flags_ptr: ptr<u32>): WasmResult;
+// @ts-ignore: decorator
+@external("env", "proxy_set_buffer_bytes")
+export declare function proxy_set_buffer_bytes(typ: BufferType, start: u32, length: u32, ptr: ptr<ptr<char>>, size: ptr<usize>): WasmResult;
+
 
 // HTTP
 // @ts-ignore: decorator
@@ -173,3 +177,27 @@ export declare function proxy_call_foreign_function(function_name: ptr<char>,
   name_size: size_t, arguments: ptr<char>,
   arguments_size: size_t, results: ptr<ptr<char>>,
   results_size: ptr<size_t>): WasmResult;
+
+// FastEdge HOST Apis
+
+// Secrets
+// @ts-ignore: decorator
+@external("env", "proxy_get_secret")
+export declare function proxy_get_secret(
+  key_data: usize,
+  key_size: usize,
+  return_value_data: usize,
+  return_value_size: usize
+): u32;
+
+
+// @ts-ignore: decorator
+@external("env", "proxy_get_effective_at_secret")
+export declare function proxy_get_effective_at_secret(
+  key_data: usize,
+  key_size: usize,
+  at: u32,
+  return_value_data: usize,
+  return_value_size: usize
+): u32;
+

package/assembly/index.ts

@@ -1,15 +1,51 @@
 export {
-    BaseContext, RootContext, Context, registerRootContext,
-    BufferTypeValues, LogLevelValues, WasmResultValues, GrpcStatusValues,
-    FilterStatusValues,
-    FilterHeadersStatusValues,
-    FilterMetadataStatusValues,
-    FilterTrailersStatusValues,
-    FilterDataStatusValues, stream_context,
-    HeaderPair, Headers, makeHeaderPair,
-    Gauge, Histogram, Counter, log,
-    HttpCallback, send_local_response, send_http_response, continue_request, continue_response,
-    proxy_set_effective_context, set_property, get_property, get_shared_data, GetSharedData, set_shared_data, set_tick_period_milliseconds,
-    register_shared_queue, resolve_shared_queue, enqueue_shared_queue, dequeue_shared_queue,
-    get_buffer_bytes, call_foreign_function, get_current_time_nanoseconds
+  BaseContext,
+  BufferTypeValues,
+  call_foreign_function,
+  Context,
+  continue_request,
+  continue_response,
+  Counter,
+  dequeue_shared_queue,
+  enqueue_shared_queue,
+  FilterDataStatusValues,
+  FilterHeadersStatusValues,
+  FilterMetadataStatusValues,
+  FilterStatusValues,
+  FilterTrailersStatusValues,
+  Gauge,
+  get_buffer_bytes,
+  get_current_time_nanoseconds,
+  get_property,
+  get_shared_data,
+  GetSharedData,
+  GrpcStatusValues,
+  HeaderPair,
+  Headers,
+  Histogram,
+  HttpCallback,
+  log,
+  LogLevelValues,
+  makeHeaderPair,
+  proxy_set_effective_context,
+  register_shared_queue,
+  registerRootContext,
+  resolve_shared_queue,
+  RootContext,
+  send_http_response,
+  send_local_response,
+  set_buffer_bytes,
+  set_property,
+  set_shared_data,
+  set_tick_period_milliseconds,
+  stream_context,
+  WasmResultValues,
 } from "./runtime";
+
+export {
+  getCurrentTime,
+  getEnvVar,
+  getSecretVar,
+  getSecretVarEffectiveAt,
+  setLogLevel,
+} from "./fastedge";

package/assembly/runtime.ts

@@ -1,6 +1,8 @@
 import * as imports from "./imports";
 import { free } from "./malloc";
 
+import { log as wasiLog } from "./fastedge";
+
 // abort function.
 // use with:
 // --use abort=index/abort_proc_exit
@@ -69,7 +71,7 @@ class ArrayBufferReference {
   }
 }
 
-var globalArrayBufferReference = new ArrayBufferReference();
+export const globalArrayBufferReference = new ArrayBufferReference();
 let globalU32Ref = new Reference<u32>();
 let globalLogLevelRef = new Reference<imports.LogLevel>();
 let globalU64Ref = new Reference<u64>();
@@ -217,8 +219,11 @@ export enum StreamTypeValues {
 export function log(level: LogLevelValues, logMessage: string): void {
   // from the docs:
   // Like JavaScript, AssemblyScript stores strings in UTF-16 encoding represented by the API as UCS-2,
-  let buffer = String.UTF8.encode(logMessage);
-  imports.proxy_log(level as imports.LogLevel, changetype<usize>(buffer), buffer.byteLength);
+  // let buffer = String.UTF8.encode(logMessage);
+  // imports.proxy_log(level as imports.LogLevel, changetype<usize>(buffer), buffer.byteLength);
+
+  // Temporary fix for proxy_log not being implemented in fastedge:
+  wasiLog(level, logMessage);
 }
 
 export function logLevel(): LogLevelValues {
@@ -251,8 +256,12 @@ export function get_current_time_nanoseconds(): u64 {
 
 export function get_property(path: string): ArrayBuffer {
   let buffer = String.UTF8.encode(path);
-  CHECK_RESULT(imports.proxy_get_property(changetype<usize>(buffer), buffer.byteLength, globalArrayBufferReference.bufferPtr(), globalArrayBufferReference.sizePtr()));
-  return globalArrayBufferReference.toArrayBuffer();
+  const result = imports.proxy_get_property(changetype<usize>(buffer), buffer.byteLength, globalArrayBufferReference.bufferPtr(), globalArrayBufferReference.sizePtr());
+  CHECK_RESULT(result);
+  if (result == WasmResultValues.Ok) {
+    return globalArrayBufferReference.toArrayBuffer();
+  }
+  return new ArrayBuffer(0); // result == WasmResultValues.NotFound
 }
 
 export function set_property(path: string, data: ArrayBuffer): WasmResultValues {
@@ -622,6 +631,12 @@ export function get_buffer_bytes(typ: BufferTypeValues, start: u32, length: u32)
   return new ArrayBuffer(0);
 }
 
+export function set_buffer_bytes(typ: BufferTypeValues, start: u32, length: u32, value: ArrayBuffer): WasmResultValues {
+  const result = imports.proxy_set_buffer_bytes(typ, start, length, changetype<usize>(value), value.byteLength);
+	wasiLog(LogLevelValues.info, 'Farq: setBuffer result: ' + result.toString());
+  return result
+}
+
 // returning tuples is not supported.
 class BufferStatusResult {
   result: WasmResultValues;
@@ -1112,3 +1127,5 @@ export function registerRootContext(
   name: string): void {
   root_context_factory = context_factory;
 }
+
+

package/package.json

@@ -7,6 +7,7 @@
     "docs": "typedoc"
   },
   "devDependencies": {
+    "@assemblyscript/wasi-shim": "^0.1.0",
     "@semantic-release/changelog": "^6.0.3",
     "assemblyscript": "^0.27.34",
     "http-server": "^14.1.1",
@@ -16,7 +17,7 @@
   },
   "name": "@gcoredev/proxy-wasm-sdk-as",
   "description": "Use this SDK to write extensions for the proxy WASM ABI",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "assembly/index.ts",
   "directories": {
     "doc": "docs"