@seeka-labs/cli-apps 3.5.2 → 3.5.4

package/dist/init-template/app/server-azurefunc/README.md

@@ -0,0 +1,105 @@
+# Seeka app - Azure functions
+
+## Development
+
+- See [Configure your environment](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-typescript?pivots=nodejs-model-v4#configure-your-environment) for dependencies
+- For emulating Azure storage queues, blobs and tables: `docker run --name azurite -p 10000:10000 -p 10001:10001 -p 10002:10002 --detach mcr.microsoft.com/azure-storage/azurite`
+- Set `AzureWebJobsStorage` setting in local.settings.json to `UseDevelopmentStorage=true`
+    - If not using WSL: 
+    `UseDevelopmentStorage=true`
+    - If using WSL, the following may be required to allow your app to reach Azure storage emulator: 
+
+        Replace `MY-MACHINE-NAME` with your hostname. Below connection string allows running Azurite on your host machine and lets WSL connect to it
+        `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://MY-MACHINE-NAME.local:10000/devstoreaccount1;QueueEndpoint=http://MY-MACHINE-NAME.local:10001/devstoreaccount1;TableEndpoint=http://MY-MACHINE-NAME.local:10002/devstoreaccount1;`
+- Install Azure Storage explorer and create your queues (see `./src/lib/jobs/index.ts` for `queueNames`). Azure Storage explorer can be used to view your queue items.
+- `yarn install`
+- `yarn dev`
+
+### Debugging
+Supports VSCode debugging via the debugger and utilisation of breakpoints. 
+This is only tested on Linux but may work on Windows. 
+If using Windows then use WSL with an Ubuntu distro for support of attaching the VS code debugger
+
+### Live urls
+You can expose your app locally to the internet via Ngrok to test your app before deploying.
+
+#### Setup
+1. Sign up for a Ngrok account
+2. Get your auth token
+3. `yarn ngrok config add-authtoken [auth token here]` replacing `[auth token]` with the auth token retrieved from your Ngrok dashboard
+
+#### Running
+1. `yarn start` OR start debugging in VSCode
+2. In separate terminal window run `yarn tunnel` and observe the log entry that starts with `Live url exposed`.
+3. Input the URL into your Seeka app configuration as the "Webook URL" via the Seeka UI.
+
+## Included example functions
+### Seeka app webhook 
+`src/functions/seekaAppWebhook.ts`
+
+Handles inbound webhooks sent from Seeka to your app.
+
+### Queue example 
+`src/functions/queueExample.ts`
+
+Handles taking a message and placing it on an Azure storage queue for later processing. This concept can be used to offload long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected.
+
+### Polling example 
+`src/functions/pollingExample.ts`
+
+Handles scheduled invoking of a function. This concept can be used to "fan out" long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected by splitting long running operations into smaller, less time consuming parts.
+
+## Invoking functions
+### Development environment
+Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -X POST http://localhost:7072/admin/functions/pollingExample`
+
+### Azure cloud
+Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -H "x-functions-key: <key from azure portal>" -X POST https://example-app-name.azurewebsites.net/admin/functions/pollingExample`
+
+See [this doc](https://learn.microsoft.com/en-us/azure/azure-functions/functions-manually-run-non-http?tabs=azure-portal#get-the-master-key) on how to get the functions (master) key
+
+## Logging
+Centralised logging handled by [Winston](https://www.npmjs.com/package/winston). Winston is installed in this template and is also used in the Seeka SDK NPM packages.
+
+[Seq](https://datalust.co/seq) Winston transport is installed in this template (optional).
+
+To configure Seq options, see `_SEQ_` environment variables.
+
+To install Seq on your development machine
+1. Run `docker run --name seq -d --restart=always -e ACCEPT_EULA=Y -p 5341:80 datalust/seq:2024.2`
+2. Update your `LOGGING_SEQ_SERVERURL` environment variable to `http://localhost:5341` or `http://[YOUR MACHINE NAME].local:5341` if using WSL.
+
+If creating an API key for Seq, only permission that is required is `Ingest`.
+
+## State management
+Installations of your app and other state required for your app to function is stored in Redis. Another state provider can be swapped out for Redis, see `src/lib/state/seeka/installations.ts` for the file that manages the state of the installations.
+
+### Upstash (optional)
+If you dont want to use Upstash for Redis then the connection strings in `.env` can be swapped with your Redis instance. 
+
+> If using Upstash then create a database before following the below guide to deploying your AWS lambda function.
+
+> When choosing region - use a region that is closest to the Azure region that your function app is hosted in to reduce latency between the function and the Redis database. 
+
+## Deployment
+This project comes ready to deploy for free to Azure functions with database backed by Redis hosted by Upstash and queues, blobs and tables backed by Azure Storage.
+
+1. Create Azure function app via the portal with below settings
+    - Function app name: example-app-name
+    - Code or container image: Code
+    - Runtime stack: Node.js
+    - Version: 18 LTS
+    - Region: Closest region to where your upstash "master / write" database is located
+    - Operating system: linux
+    - Hosting: Consumption
+    - Enable public access: On
+2. Set environment variables of the Azure web app - reference local.settings.json "Values" 
+3. If your app receives calls directly from the browser (eg. your browser app plugin) then CORS needs to be enabled for all origins from within the settings of the Function app in Azure portal.
+3. `yarn deploy`
+
+### Continuous delivery
+This template includes a GitLab CD pipeline that can be used to trigger deployments of your app when changes are pushed to your Git repository.
+
+## References
+- https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite
+- https://learn.microsoft.com/en-us/azure/storage/queues/storage-quickstart-queues-nodejs?tabs=connection-string%2Croles-azure-portal%2Cenvironment-variable-windows%2Csign-in-azure-cli

package/dist/init-template/app/server-azurefunc/host.json

@@ -0,0 +1,31 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "extensions": {
+    "http": {
+      "routePrefix": ""
+    },
+    "queues": {
+      "batchSize": 32,
+      "newBatchThreshold": 8,
+      "maxDequeueCount": 1,
+      "visibilityTimeout": "00:00:30"
+    }
+  },
+  "functionTimeout": "00:10:00",
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[4.*, 5.0.0)"
+  },
+  "concurrency": {
+    "dynamicConcurrencyEnabled": true,
+    "snapshotPersistenceEnabled": true
+  }
+}

package/dist/init-template/app/server-azurefunc/local.settings.template.json

@@ -0,0 +1,34 @@
+{
+  "IsEncrypted": false,
+  "Host": {
+    "CORS": "*"
+  },
+  "Values": {
+    "FUNCTIONS_WORKER_RUNTIME": "node",
+    "FUNCTIONS_EXTENSION_VERSION": "~4",
+    "AzureWebJobsFeatureFlags": "EnableWorkerIndexing",
+    "SEEKA_DEBUG_ENABLED": "true",
+    "NODE_TLS_REJECT_UNAUTHORIZED": "0",
+    "REDIS_CONNECTION_USER": "default",
+    "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT": "",
+    "OTEL_EXPORTER_OTLP_LOGS_HEADERS": "",
+    "SEEKA_INGEST_URL": "",
+    "SEEKA_ISSUER_URL": "",
+    "SEEKA_APP_ID": "",
+    "SEEKA_APP_SECRET": "",
+    "REDIS_CONNECTION_HOST": "",
+    "REDIS_CONNECTION_PASSWORD": "",
+    "AzureWebJobsStorage": "",
+    "SEEKA_TELEMETRY_URL": "",
+    "REDIS_CONNECTION_PORT": "6379",
+    "REDIS_CONNECTION_TLS": "true",
+    "OTEL_LOG_LEVEL": "debug",
+    "LOGGING_LEVEL": "silly",
+    "SELF_HOST_BASEURL": "",
+    "APP_UI_BASE_PATH": "",
+    "OTEL_TRACES_EXPORTER": "none",
+    "OTEL_METRICS_EXPORTER": "none",
+    "OTEL_LOGS_EXPORTER": "none",
+    "OTEL_PROPAGATORS": "none"
+  }
+}

package/dist/init-template/app/server-azurefunc/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@example-org-name/example-app-name-server-azurefunc",
+  "version": "3.5.4",
+  "description": "Seeka Azure Serverless function app example-app-name",
+  "author": "Seeka <administrator@seeka.co>",
+  "license": "MIT",
+  "main": "dist/src/functions/*.js",
+  "private": true,
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "lint": "eslint",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc",
+    "watch": "tsc -w",
+    "clean": "rimraf dist",
+    "prestart": "yarn build",
+    "dev": "func start --port 7072",
+    "tunnel": "ngrok http 7072 --hostname=seeka-app-example-app-name-localdev.au.ngrok.io --region au --log=stdout --log-format=term",
+    "deploy": "func azure functionapp publish example-app-name --no-build --javascript",
+    "dev:queue:create": "node scripts/dev-queue-setup.js activity-track-queue && node scripts/dev-queue-setup.js activity-track-queue-poison"
+  },
+  "dependencies": {
+    "@azure/functions": "^4",
+    "@azure/storage-queue": "^12",
+    "@example-org-name/example-app-name-lib": "workspace:*",
+    "@opentelemetry/api": "^1",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0",
+    "@opentelemetry/instrumentation-grpc": "^0",
+    "@opentelemetry/instrumentation-http": "^0",
+    "@opentelemetry/instrumentation-ioredis": "^0",
+    "@opentelemetry/instrumentation-net": "^0",
+    "@opentelemetry/instrumentation-undici": "^0",
+    "@opentelemetry/instrumentation-winston": "^0",
+    "@opentelemetry/sdk-node": "^0",
+    "@opentelemetry/sdk-trace-node": "^2",
+    "@opentelemetry/winston-transport": "^0",
+    "@redis/client": "^5",
+    "@redis/json": "^5",
+    "@seeka-labs/sdk-apps-core": "../../../workspace:* || ^3",
+    "@seeka-labs/sdk-apps-server": "../../../workspace:* || ^3",
+    "@seeka-labs/sdk-apps-server-host": "../../../workspace:* || ^3",
+    "@seeka-labs/sdk-apps-server-telemetry-core": "../../../workspace:* || ^3",
+    "@seeka-labs/sdk-apps-server-telemetry-logging": "../../../workspace:* || ^3",
+    "axios": "^1",
+    "jsonwebtoken": "^9",
+    "lodash-es": "^4",
+    "memory-cache": "^0",
+    "openid-client": "^6",
+    "redis": "^5",
+    "undici": "^7",
+    "winston": "^3",
+    "yup": "^1"
+  },
+  "devDependencies": {
+    "@types/jsonwebtoken": "^9",
+    "@types/lodash-es": "^4",
+    "@types/node": "^22",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "eslint": "^9",
+    "rimraf": "^6",
+    "typescript": "^5"
+  }
+}

package/dist/init-template/app/server-azurefunc/scripts/dev-queue-setup.js

@@ -0,0 +1,55 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+const { QueueClient } = require("@azure/storage-queue");
+const fs = require("fs");
+const path = require("path");
+
+function getAzureWebJobsStorageConnectionString() {
+    // local.settings.json lives one level above this script (../local.settings.json)
+    const localSettingsPath = path.join(__dirname, "..", "local.settings.json");
+
+    let raw;
+    try {
+        raw = fs.readFileSync(localSettingsPath, "utf8");
+    }
+    catch (e) {
+        throw new Error(
+            `Unable to read ${localSettingsPath}. Ensure local.settings.json exists and is readable. Original error: ${e && e.message ? e.message : e}`
+        );
+    }
+
+    let json;
+    try {
+        json = JSON.parse(raw);
+    }
+    catch (e) {
+        throw new Error(
+            `Invalid JSON in ${localSettingsPath}. Original error: ${e && e.message ? e.message : e}`
+        );
+    }
+
+    const connectionString = json?.Values?.AzureWebJobsStorage;
+    if (typeof connectionString !== "string" || connectionString.trim() === "") {
+        throw new Error(
+            `Missing or empty Values.AzureWebJobsStorage in ${localSettingsPath}`
+        );
+    }
+
+    return connectionString;
+}
+
+(async function () {
+    // https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cqueue-storage#azure-sdks
+    // Dev / emulator / azurite
+    const connectionString = getAzureWebJobsStorageConnectionString();
+    var client = new QueueClient(
+        connectionString, process.argv[2]
+    );
+    const res = await client.createIfNotExists();
+    if (res.succeeded) {
+        console.log("Queue created - " + process.argv[2]);
+    }
+    else {
+        console.log("Queue already exists - " + process.argv[2]);
+    }
+})();

package/dist/init-template/app/server-azurefunc/src/app/api/router.ts

@@ -0,0 +1,14 @@
+import {ExampleAppAppInstallContext, ExampleAppAppInstallState} from "@example-org-name/example-app-name-lib";
+import {getInstallationSettings} from "./routes/getInstallationSettings";
+import {setInstallationSettings} from "./routes/setInstallationSettings";
+import { SeekaAppInstallContext } from "@seeka-labs/sdk-apps-core";
+import { Logger } from "winston";
+import { AppUiHttpRequestResponse, HttpMethod } from "@seeka-labs/sdk-apps-server-host";
+import {HttpRequest, InvocationContext} from "@azure/functions";
+
+export const apiRouteHandler = async (req: HttpRequest, context: InvocationContext, requestedPath: string, requestedMethod: HttpMethod, installation: ExampleAppAppInstallContext, logger: Logger ): Promise<AppUiHttpRequestResponse | null> => {
+    if (requestedPath === '/api/settings' && requestedMethod === 'GET') return await getInstallationSettings(installation, req, context, logger);
+    if (requestedPath === '/api/settings' && requestedMethod === 'POST') return await setInstallationSettings(installation, req, context, logger);
+
+    return null;
+}

package/dist/init-template/app/server-azurefunc/src/app/api/routes/getInstallationSettings.ts

@@ -0,0 +1,13 @@
+import { HttpRequest, HttpResponseInit, InvocationContext } from "@azure/functions";
+import { ExampleAppAppInstallContext, ExampleAppAppInstallSettings } from "@example-org-name/example-app-name-lib";
+import { AppUiHttpRequestResponse } from "@seeka-labs/sdk-apps-server-host";
+import { Logger } from "winston";
+
+export const getInstallationSettings = async (installation: ExampleAppAppInstallContext, req: HttpRequest, context: InvocationContext, logger: Logger): Promise<AppUiHttpRequestResponse> => {
+    // Important to not expose any sensitive data to the client via this endpoint
+    // Be selective, no spread operator here, only the fields you want to expose
+     return {
+        status: 200,
+        jsonBody: installation.installationState?.installationSettings as ExampleAppAppInstallSettings
+    }
+}

package/dist/init-template/app/server-azurefunc/src/app/api/routes/setInstallationSettings.ts

@@ -0,0 +1,35 @@
+import { HttpRequest, InvocationContext } from "@azure/functions";
+import { Logger } from "winston";
+
+import { ExampleAppAppInstallContext, ExampleAppAppInstallSettings, validateInstallationSettings } from "@example-org-name/example-app-name-lib";
+import { AppUiHttpRequestResponse, createOrUpdateInstallation } from "@seeka-labs/sdk-apps-server-host";
+
+export const setInstallationSettings = async (installation: ExampleAppAppInstallContext, req: HttpRequest, context: InvocationContext, logger: Logger): Promise<AppUiHttpRequestResponse> => {
+    // Validate
+    const newSettings = (await req.json()) as ExampleAppAppInstallSettings  | null;
+    if (!newSettings) {
+        return {
+            status: 400,
+            jsonBody: { error: 'Settings are required' }
+        };
+    }
+
+    const error = await validateInstallationSettings(newSettings, logger);
+    if (error) return {
+        status: 400,
+        jsonBody: { error }
+    }
+
+    installation.installationState = {
+        ...installation.installationState,
+        installationSettings: {
+            ...installation.installationState.installationSettings,
+            ...newSettings
+        }
+    };
+    await createOrUpdateInstallation(installation, logger);
+
+    return {
+        status: 200
+    };
+}

package/dist/init-template/app/server-azurefunc/src/app/jobs/index.ts

@@ -0,0 +1,61 @@
+import { QueueClient, QueueSendMessageOptions } from '@azure/storage-queue';
+import type { Logger } from 'winston';
+import {BackgroundJobRequestContext} from "@seeka-labs/sdk-apps-server-host";
+
+export const queueNames = {
+    trackActivity: 'activity-track-queue',
+}
+
+export const triggerBackgroundJob = async <TPayload>(queueName: string, context: BackgroundJobRequestContext<TPayload>, logger: Logger, queueSendOptions?: QueueSendMessageOptions): Promise<void> => {
+    const queueClient = new QueueClient(process.env.AzureWebJobsStorage as string, queueName);
+    return await triggerBackgroundJobWithQueue(queueClient, context, logger, queueSendOptions);
+}
+
+const serialiseQueuePayload = (payload: unknown): string => {
+    const jsonString = JSON.stringify(payload)
+    return Buffer.from(jsonString).toString('base64')
+}
+
+export const deserialiseQueuePayload = <TPayload>(payload: string): TPayload => {
+    const jsonString = Buffer.from(payload, 'base64').toString()
+    return JSON.parse(jsonString) as TPayload;
+}
+
+export const triggerBackgroundJobWithQueue = async <TPayload>(queueClient: QueueClient, context: BackgroundJobRequestContext<TPayload>, logger: Logger, queueSendOptions?: QueueSendMessageOptions): Promise<void> => {
+    const body = {
+        ...context
+    }
+    const bodyStr = serialiseQueuePayload(body);
+
+    const response = await queueClient.sendMessage(bodyStr, queueSendOptions);
+
+    if (response.errorCode) {
+        const { requestId, date, errorCode } = response;
+        logger.error("Failed to trigger background job", { body, requestId, date, errorCode })
+        throw new Error(`Failed to trigger background job: ${response.errorCode}`);
+    }
+    else {
+        logger.info("Background job triggered for " + queueClient.name, { body, messageId: response.messageId, context })
+    }
+}
+
+export const sendQueueMessageToPoisonQueue = async <TPayload>(queueName: string, context: BackgroundJobRequestContext<TPayload>, logger: Logger): Promise<void> => {
+    const body = {
+        ...context
+    }
+    const bodyStr = serialiseQueuePayload(body);
+
+    // https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-storage-queue-trigger?tabs=python-v2%2Cisolated-process%2Cnodejs-v4%2Cextensionv5&pivots=programming-language-typescript#poison-messages
+    const queueClient = new QueueClient(process.env.AzureWebJobsStorage as string, `${queueName}-poison`);
+
+    const response = await queueClient.sendMessage(bodyStr, { messageTimeToLive: -1 });
+
+    if (response.errorCode) {
+        const { requestId, date, errorCode } = response;
+        logger.error("Failed to push to poison queue", { body, requestId, date, errorCode })
+        throw new Error(`Failed to push to poison queue: ${response.errorCode}`);
+    }
+    else {
+        logger.verbose("Message pushed to poison queue", { body, messageId: response.messageId, context })
+    }
+}

package/dist/init-template/app/server-azurefunc/src/app/logging/index.ts

@@ -0,0 +1,4 @@
+import * as packageJson from '../../../package.json';
+import {registerSeekaAppOpenTelemetry} from "@seeka-labs/sdk-apps-server-telemetry-logging";
+
+registerSeekaAppOpenTelemetry(packageJson.name, packageJson.version, 'azure', 'azure_function', process.env);

package/dist/init-template/app/server-azurefunc/src/app/models/index.ts

@@ -0,0 +1,12 @@
+
+import {SeekaActivityAcceptedWebhookContent} from "@seeka-labs/sdk-apps-server";
+import { BackgroundJobRequestContext } from "@seeka-labs/sdk-apps-server-host";
+
+export type TrackExampleAppActivityQueueItem = BackgroundJobRequestContext<TrackSeekaExampleAppActivityPayload> & {
+
+}
+
+export type TrackSeekaExampleAppActivityPayload = {
+    seekaActivity: SeekaActivityAcceptedWebhookContent
+}
+

package/dist/init-template/app/server-azurefunc/src/app/services/activites.ts

@@ -0,0 +1,8 @@
+
+import {Logger} from "winston";
+import {TrackSeekaExampleAppActivityPayload} from "../models";
+import {SeekaAppInstallContext} from "@seeka-labs/sdk-apps-core";
+
+export const sendActivityToAnotherSoftware = async (payload: TrackSeekaExampleAppActivityPayload, installation: SeekaAppInstallContext<any>, causationId: string, correlationId: string, logger: Logger): Promise<void> => {
+ // Anything
+}

package/dist/init-template/app/server-azurefunc/src/functions/healthCheck.ts

@@ -0,0 +1,19 @@
+import { app, HttpRequest, HttpResponseInit, InvocationContext } from '@azure/functions';
+import '../app/logging'
+import { appLogger } from "@seeka-labs/sdk-apps-server-host";
+
+app.http('healthCheck', {
+    methods: ['GET', 'HEAD'],
+    authLevel: 'anonymous',
+    route: 'api/health',
+    handler: healthCheck
+});
+
+export async function healthCheck(req: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
+    // logger.verbose('Health check request received', { status: res.status, url: req.url });
+    appLogger.verbose('Health check', { url: req.url });
+
+    return {
+        status: 200
+    }
+}