tests: add basic example of exception handling working in Modus

Author: JairusSW

sdk/assemblyscript/examples/exception-handling/.gitignore

@@ -0,0 +1 @@
+.modusdb/

sdk/assemblyscript/examples/exception-handling/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["assemblyscript-prettier"]
+}

sdk/assemblyscript/examples/exception-handling/README.md

@@ -0,0 +1,5 @@
+# Modus Exception Handling Example
+
+This example shows how to catch exceptions with `try/catch/finally` using [JairusSW/try-as](https://github.com/JairusSW/try-as)
+
+See [./assembly/index.ts](./assembly/index.ts) for the implementation.

sdk/assemblyscript/examples/exception-handling/asconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./node_modules/@hypermode/modus-sdk-as/plugin.asconfig.json",
+  "options": {
+    "transform": ["@hypermode/modus-sdk-as/transform", "json-as/transform","try-as/transform"]
+  }
+}

sdk/assemblyscript/examples/exception-handling/assembly/classes.ts

@@ -0,0 +1,18 @@
+/*
+ * This example is part of the Modus project, licensed under the Apache License 2.0.
+ * You may modify and use this example in accordance with the license.
+ * See the LICENSE file that accompanied this code for further details.
+ */
+
+// These classes are used by the example functions in the index.ts file.
+
+@json
+export class Quote {
+
+  @alias("q")
+  quote: string | null = null;
+
+
+  @alias("a")
+  author: string | null = null;
+}

sdk/assemblyscript/examples/exception-handling/assembly/index.tmp.ts

@@ -0,0 +1,88 @@
+import {
+  Exception as __Exception,
+  ExceptionState as __ExceptionState
+} from "try-as/assembly/types/exception";
+import {
+  ErrorState as __ErrorState
+} from "try-as/assembly/types/error";
+import {
+  UnreachableState as __UnreachableState
+} from "try-as/assembly/types/unreachable";
+import {
+  AbortState as __AbortState
+} from "try-as/assembly/types/abort";
+import {
+  http
+} from "@hypermode/modus-sdk-as";
+import {
+  Quote
+} from "./classes";
+import {
+  Exception
+} from "try-as";
+export function __try_getRandomQuote(): Quote {
+  if (__ExceptionState.Failures > 0) {
+    if (isBoolean<Quote>()) return false;
+else if (isInteger<Quote>() || isFloat<Quote>()) return 0;
+else if (isManaged<Quote>() || isReference<Quote>()) return changetype<Quote>(0);
+else return;
+  }
+  const request = new http.Request("https://zenquotes.io/api/random");
+  const response = http.fetch(request);
+  if (!response.ok) {
+    __ErrorState.error(new Error(`Failed to fetch quote. Received: ${response.status} ${response.statusText}`), "assembly/index.ts", 16, 5);
+    if (isBoolean<Quote>()) return false;
+else if (isInteger<Quote>() || isFloat<Quote>()) return 0;
+else if (isManaged<Quote>() || isReference<Quote>()) return changetype<Quote>(0);
+else return;
+  }
+  return response.json<Array<Quote>>()[0];
+}
+export function getRandomQuote(): Quote {
+  const request = new http.Request("https://zenquotes.io/api/random");
+  const response = http.fetch(request);
+  if (!response.ok) {
+    throw new Error(`Failed to fetch quote. Received: ${response.status} ${response.statusText}`);
+  }
+  return response.json<Array<Quote>>()[0];
+}
+export function safeFetchQuote(): Quote {
+  do {
+    return __try_getRandomQuote();
+  } while (false);
+  if (__ExceptionState.Failures > 0) {
+    let e = new __Exception(__ExceptionState.Type);
+    __ExceptionState.Failures--;
+    return {
+      author: "Unknown",
+      quote: "Failed to fetch quote"
+    }
+  }
+}
+export function testCatching(shouldThrow: boolean): string {
+  do {
+    if (shouldThrow) {
+      __ErrorState.error(new Error("Test error"), "assembly/index.ts", 38, 7);
+      break;
+    }
+    return "Success";
+  } while (false);
+  if (__ExceptionState.Failures > 0) {
+    let e = new __Exception(__ExceptionState.Type);
+    __ExceptionState.Failures--;
+    const err = e as Exception;
+    return "Caught error: " + err.toString();
+  }
+  return "";
+}
+export function parseI8OrFallback(s: string, fallback: i8): i8 {
+  do {
+    let n = i8.parse(s);
+    return n;
+  } while (false);
+  if (__ExceptionState.Failures > 0) {
+    let _ = new __Exception(__ExceptionState.Type);
+    __ExceptionState.Failures--;
+    return fallback;
+  }
+}

sdk/assemblyscript/examples/exception-handling/assembly/index.ts

@@ -0,0 +1,55 @@
+/*
+ * This example is part of the Modus project, licensed under the Apache License 2.0.
+ * You may modify and use this example in accordance with the license.
+ * See the LICENSE file that accompanied this code for further details.
+ */
+
+import { http } from "@hypermode/modus-sdk-as";
+import { Quote } from "./classes";
+import { Exception } from "try-as";
+
+export function getRandomQuote(): Quote {
+  const request = new http.Request("https://zenquotes.io/api/random");
+
+  const response = http.fetch(request);
+  if (!response.ok) {
+    throw new Error(
+      `Failed to fetch quote. Received: ${response.status} ${response.statusText}`,
+    );
+  }
+
+  return response.json<Quote[]>()[0];
+}
+
+export function safeFetchQuote(): Quote {
+  try {
+    return getRandomQuote();
+  } catch (e) {
+    return {
+      author: "Unknown",
+      quote: "Failed to fetch quote",
+    };
+  }
+}
+
+export function testCatching(shouldThrow: boolean): string {
+  try {
+    if (shouldThrow) {
+      throw new Error("Test error");
+    }
+    return "Success";
+  } catch (e) {
+    const err = e as Exception;
+    return "Caught error: " + err.toString();
+  }
+  return "";
+}
+
+export function parseI8OrFallback(s: string, fallback: i8): i8 {
+  try {
+    let n = i8.parse(s)
+    return n;
+  } catch (_) {
+    return fallback;
+  }
+}

sdk/assemblyscript/examples/exception-handling/assembly/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "assemblyscript/std/assembly.json",
+  "include": ["./**/*.ts"]
+}

sdk/assemblyscript/examples/exception-handling/eslint.config.js

@@ -0,0 +1,11 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import aseslint from "@hypermode/modus-sdk-as/tools/assemblyscript-eslint-local";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  aseslint.config,
+);

sdk/assemblyscript/examples/exception-handling/modus.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://schema.hypermode.com/modus.json",
+  "endpoints": {
+    "default": {
+      "type": "graphql",
+      "path": "/graphql",
+      "auth": "bearer-token"
+    }
+  },
+  "connections": {
+    // These are the hosts used by the functions in this example project.
+    // Where secrets are required, {{SECRET_NAME}} templates are replaced with
+    // the values specified in the Hypermode Console.
+    // Note that "baseUrl" is specified instead of "endpoint", to allow for
+    // customization of the URL in the function code.
+    "example": {
+      "type": "http",
+      "baseUrl": "https://example.com/"
+    },
+    "zenquotes": {
+      "type": "http",
+      "baseUrl": "https://zenquotes.io/"
+    },
+    "picsum": {
+      "type": "http",
+      "baseUrl": "https://picsum.photos/"
+    },
+    "github": {
+      "type": "http",
+      "baseUrl": "https://api.github.com/",
+      "headers": {
+        "Authorization": "Bearer {{AUTH_TOKEN}}"
+      }
+    }
+  }
+}