@gcoredev/proxy-wasm-sdk-as 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,15 @@
 # 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)
+[![GitHub License](https://img.shields.io/github/license/G-Core/proxy-wasm-sdk-as)](https://github.com/G-Core/proxy-wasm-sdk-as/blob/main/LICENSE)
+[![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
 
@@ -25,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 {
@@ -70,7 +77,7 @@ registerRootContext((context_id: u32) => {
 }, "add_header");
 ```
 
-## build
+## Build
 
 To build, simply run:
 
@@ -78,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/fastedge.ts

@@ -0,0 +1,66 @@
+import * as imports from "./imports";
+
+import { globalArrayBufferReference, LogLevelValues } from "./runtime";
+
+let logLevel: LogLevelValues = LogLevelValues.info;
+
+export function setLogLevel(level: LogLevelValues): void {
+  logLevel = level;
+}
+
+export 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");
+  }
+}
+
+export function getEnvVar(key: string): string {
+  const hasKey = process.env.has(key);
+  if (hasKey) {
+    return process.env.get(key);
+  }
+  return "";
+}
+
+export 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);
+}
+
+export 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 { LogLevelValues };

package/assembly/imports.ts

@@ -173,3 +173,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/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 {

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.0",
+  "version": "1.0.2",
   "main": "assembly/index.ts",
   "directories": {
     "doc": "docs"