Add AppSignal example

.github/workflows/test-npm.yaml

@@ -17,7 +17,6 @@ jobs:
       - run: corepack enable
 
       - uses: actions/checkout@v4
-      - run: npm --no-workspaces ci
       - run: npm run generate
       - run: npm --workspaces ci
       - run: npm --workspaces test

SkiffaExamples.code-workspace

@@ -1,5 +1,9 @@
 {
   "folders": [
+    {
+      "name": ".github/workflows",
+      "path": ".github/workflows",
+    },
     {
       "name": "specifications",
       "path": "specifications",
@@ -16,6 +20,10 @@
       "name": "npm/todo",
       "path": "packages/npm/todo",
     },
+    {
+      "name": "npm/appsignal",
+      "path": "packages/npm/appsignal",
+    },
   ],
   "settings": {
     "window.title": "Skiffa Examples",

cspell.config.yaml

@@ -1,5 +1,6 @@
 version: "0.2"
 words:
+  - APPSIGNAL
   - esbenp
   - iife
   - openapi

package.json

@@ -10,11 +10,12 @@
   "scripts": {
     "spelling": "cspell",
     "formatting": "prettier --check *",
-    "generate": "node ./scripts/generate.mjs",
-    "initialize": "node ./scripts/initialize.mjs"
+    "generate": "$npm_node_execpath ./scripts/generate.mjs",
+    "build": "$npm_execpath run --workspaces --if-present build",
+    "pretest": "$npm_execpath run --workspaces --if-present pretest",
+    "test": "$npm_node_execpath --test packages/npm/*/transpiled/**/*.test.js"
   },
   "devDependencies": {
-    "@skiffa/generator": "^0.13.20",
     "cspell": "^8.14.2",
     "prettier": "^3.3.3"
   }

packages/npm/appsignal/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "run file",
+      "program": "${file}",
+      "args": [],
+      "cwd": "${workspaceFolder}",
+      "sourceMaps": true,
+      "outFiles": ["${workspaceFolder}/transpiled/**/*.js"],
+      "preLaunchTask": "build",
+      "outputCapture": "std"
+    }
+  ]
+}

packages/npm/appsignal/.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "label": "build",
+      "script": "build",
+      "problemMatcher": ["$tsc"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
+}

packages/npm/appsignal/README.md

@@ -0,0 +1,3 @@
+# AppSignal example
+
+To test AppSignal.

packages/npm/appsignal/package.json

@@ -0,0 +1,29 @@
+{
+  "private": true,
+  "type": "commonjs",
+  "scripts": {
+    "prepack": "$npm_node_execpath ./scripts/build.mjs",
+    "pretest": "$npm_node_execpath ./scripts/build.mjs",
+    "prestart": "$npm_node_execpath ./scripts/build.mjs",
+    "start": "$npm_node_execpath transpiled/server.js",
+    "build": "$npm_node_execpath ./scripts/build.mjs",
+    "test": "$npm_node_execpath --test ./transpiled/**/*.test.js"
+  },
+  "dependencies": {
+    "@appsignal/nodejs": "^3.5.0",
+    "@skiffa/appsignal": "^0.3.3",
+    "@types/node": "^18.19.45",
+    "msecs": "^1.0.4",
+    "noop-api": "^0.1.0",
+    "shared": "^0.1.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@tsconfig/node18": "^18.2.4",
+    "rollup": "^4.21.0",
+    "typescript": "^5.5.4"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

packages/npm/appsignal/scripts/build.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+import cp from "child_process";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const projectRoot = path.resolve(dirname, "..");
+
+const options = { shell: true, stdio: "inherit", env: process.env, cwd: projectRoot };
+
+cp.execFileSync(process.env.npm_execpath, ["--workspace", "todo-api", "run", "build"], options);
+
+cp.execFileSync("tsc", ["--build"], options);

packages/npm/appsignal/src/appsignal.ts

@@ -0,0 +1,12 @@
+import { Appsignal } from "@appsignal/nodejs";
+import * as skiffaAppsignal from "@skiffa/appsignal";
+
+const appsignalPushApiKey = process.env.APPSIGNAL_PUSH_API_KEY;
+
+export const appsignal = new Appsignal({
+  active: appsignalPushApiKey != null,
+  environment: process.env.NODE_ENV,
+  name: "skiffa-examples/appsignal",
+  pushApiKey: appsignalPushApiKey,
+  additionalInstrumentations: [new skiffaAppsignal.Instrumentation()],
+});

packages/npm/appsignal/src/operation-handlers.ts

@@ -0,0 +1 @@
+export * from "./operation-handlers/noop.js";

packages/npm/appsignal/src/operation-handlers/noop.test.ts

@@ -0,0 +1,14 @@
+import test from "node:test";
+import * as api from "noop-api";
+import * as operationHandlers from "../operation-handlers.js";
+
+test("noop", async () => {
+  const server = new api.server.Server();
+  server.registerNoopOperation(operationHandlers.noop);
+
+  await using listener = await api.lib.listen(server);
+
+  const baseUrl = new URL(`http://localhost:${listener.port}`);
+
+  await api.client.noop({ baseUrl });
+});

packages/npm/appsignal/src/operation-handlers/noop.ts

@@ -0,0 +1,7 @@
+import { second } from "msecs";
+import * as api from "noop-api";
+import timers from "timers/promises";
+
+export const noop: api.server.NoopOperationHandler<{}> = async () => {
+  await timers.setTimeout(2 * second);
+};

packages/npm/appsignal/src/root.ts

@@ -0,0 +1,12 @@
+import path from "path";
+import { fileURLToPath } from "url";
+
+/**
+ * the absolute path to this projects root directory
+ */
+export const projectRoot = makeProjectRoot();
+
+function makeProjectRoot() {
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+  return path.resolve(dirname, "..");
+}

packages/npm/appsignal/src/server.ts

@@ -0,0 +1,38 @@
+import "./appsignal.js";
+
+import * as api from "noop-api";
+import * as shared from "shared";
+import * as operationHandlers from "./operation-handlers.js";
+
+main();
+
+// entrypoint for the server
+async function main() {
+  // create the server
+  const server = new api.server.Server();
+
+  // register all operations
+  server.registerOperations(operationHandlers);
+
+  // get port to listen to from the environment or use the default
+  const port = Number(process.env.PORT ?? 8080);
+
+  console.info(`Starting server...`);
+  {
+    // listen to the specified port and send requests to the server. We are
+    // using the `using` syntax here, the server will be disposed (terminated)
+    // at the end of the current block.
+    await using listener = await api.lib.listen(server, { port });
+
+    console.info(`Server started (${listener.port})`);
+
+    // wait for a user to send a signal and eventually stop listening.
+    await shared.waitForSignal("SIGINT", "SIGTERM");
+
+    console.info("Stopping server...");
+
+    // Thanks to the `using` keyword (and a proper implementation of the dispose)
+    // the server is terminated here, at the end of this block.
+  }
+  console.info(`Server stopped`);
+}

packages/npm/appsignal/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/node18",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./transpiled",
+    "declarationDir": "./typed",
+    "sourceMap": true,
+    "declaration": true,
+    "composite": true
+  },
+  "include": ["src/**/*"],
+  "references": [{ "path": "../shared/" }]
+}

packages/npm/reverse/package.json

@@ -2,22 +2,20 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "prepack": "node ./scripts/build.js",
-    "pretest": "node ./scripts/build.js",
-    "prestart": "node ./scripts/build.js",
-    "start": "node transpiled/server.js",
-    "build": "node ./scripts/build.js",
-    "test": "node --test ./transpiled/**/*.test.js"
+    "prepack": "tsc",
+    "pretest": "tsc",
+    "prestart": "tsc",
+    "start": "$npm_node_execpath transpiled/server.js",
+    "build": "tsc",
+    "test": "$npm_node_execpath --test ./transpiled/**/*.test.js"
   },
   "dependencies": {
     "@types/node": "^18.19.45",
     "reverse-api": "^0.1.0",
     "shared": "^0.1.0"
   },
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^15.2.3",
     "@tsconfig/node18": "^18.2.4",
-    "rollup": "^4.21.0",
     "typescript": "^5.5.4"
   },
   "engines": {

packages/npm/todo/scripts/build.js → packages/npm/reverse/scripts/build.mjs

@@ -9,7 +9,7 @@ const projectRoot = path.resolve(dirname, "..");
 
 const options = { shell: true, stdio: "inherit", env: process.env, cwd: projectRoot };
 
-cp.execFileSync("npm", ["--workspace", "todo-api", "run", "build"], options);
+cp.execFileSync(process.env.npm_execpath, ["--workspace", "reverse-api", "run", "build"], options);
 
 cp.execFileSync("tsc", ["--build"], options);
 

packages/npm/shared/package.json

@@ -20,7 +20,7 @@
     "pretest": "tsc --build",
     "prestart": "tsc --build",
     "build": "tsc --build",
-    "test": "node --test ./transpiled/**/*.test.js"
+    "test": "$npm_node_execpath --test ./transpiled/**/*.test.js"
   },
   "dependencies": {
     "@types/node": "^18.19.45"

packages/npm/shared/src/id.ts

@@ -2,7 +2,7 @@ let lastId = Date.now();
 
 export function nextId() {
   const id = ++lastId;
-  return id
+  return id;
 }
 
 export function nextStringId(prefix: string) {

packages/npm/shared/src/main.ts

@@ -1,3 +1,2 @@
 export * from "./id.js";
 export * from "./signal.js";
-

packages/npm/todo/package.json

@@ -3,12 +3,12 @@
   "version": "1.0.0",
   "type": "module",
   "scripts": {
-    "prepack": "node ./scripts/build.js",
-    "pretest": "node ./scripts/build.js",
-    "prestart": "node ./scripts/build.js",
-    "start": "node transpiled/server.js",
-    "build": "node ./scripts/build.js",
-    "test": "node --test ./transpiled/operation-handlers/todo.test.js"
+    "prepack": "$npm_node_execpath ./scripts/build.mjs",
+    "pretest": "$npm_node_execpath ./scripts/build.mjs",
+    "prestart": "$npm_node_execpath ./scripts/build.mjs",
+    "start": "$npm_node_execpath transpiled/server.js",
+    "build": "$npm_node_execpath ./scripts/build.mjs",
+    "test": "$npm_node_execpath --test ./transpiled/**/*.test.js"
   },
   "keywords": [],
   "author": "",

packages/npm/reverse/scripts/build.js → packages/npm/todo/scripts/build.mjs

@@ -9,7 +9,7 @@ const projectRoot = path.resolve(dirname, "..");
 
 const options = { shell: true, stdio: "inherit", env: process.env, cwd: projectRoot };
 
-cp.execFileSync("npm", ["--workspace", "reverse-api", "run", "build"], options);
+cp.execFileSync(process.env.npm_execpath, ["--workspace", "todo-api", "run", "build"], options);
 
 cp.execFileSync("tsc", ["--build"], options);
 

packages/npm/todo/src/operation-handlers/todo.test.ts

@@ -26,7 +26,7 @@ test("todo test scenario", async () => {
   await using listener = await api.lib.listen(server);
   const baseUrl = new URL(`http://localhost:${listener.port}`);
 
-  let id: number
+  let id: number;
 
   await test("list (expect empty list)", async () => {
     const listTodo = await api.client.listTodoItems({ baseUrl });

scripts/generate.mjs

@@ -9,12 +9,17 @@ const workspaceRoot = path.resolve(dirname, "..");
 
 const options = { shell: true, stdio: "inherit", env: process.env };
 
-const names = ["reverse-api", "todo-api"];
+const names = ["reverse-api", "todo-api", "noop-api"];
 
 for (const name of names) {
   cp.execFileSync(
-    "skiffa-generator",
+    "npx",
     [
+      "--yes",
+      "--package",
+      "@skiffa/generator@0.13.20",
+      "--",
+      "skiffa-generator",
       "package",
       path.resolve(workspaceRoot, "specifications", `${name}.yaml`),
       "--package-directory",
@@ -26,7 +31,4 @@ for (const name of names) {
     ],
     options,
   );
-
-  cp.execFileSync(process.env.npm_execpath, ["--workspace", name, "install"], options);
-  cp.execFileSync(process.env.npm_execpath, ["--workspace", name, "run", "build"], options);
 }