@seeka-labs/cli-apps 1.1.24 → 1.1.25

package/dist/init-templates/azure-function/src/functions/queueExample.ts

@@ -1,67 +1,67 @@
-import winston from 'winston';
-
-import { app, InvocationContext } from '@azure/functions';
-
-import { BackgroundJobRequestContext, deserialiseQueuePayload, queueNames, sendQueueMessageToPoisonQueue } from '../lib/jobs';
-import { backgroundJobLogger } from '../lib/logging';
-import { startServices } from '../lib/services';
-import { groupBy } from 'lodash';
-import { SeekaAppInstallState, tryGetInstallation } from '../lib/state/seeka/installations';
-import { SeekaActivityAcceptedWebhookContent } from '@seeka-labs/sdk-apps-server';
-
-app.storageQueue('queueExample', {
-    queueName: queueNames.queueItemExampleQueueName,
-    connection: 'AzureWebJobsStorage',
-    handler: queueExample
-});
-
-export interface MyQueueItem extends BackgroundJobRequestContext {
-    items: SeekaActivityAcceptedWebhookContent[];
-}
-
-export async function queueExample(queueItem: any, context: InvocationContext): Promise<void> {
-    const logger = backgroundJobLogger(queueNames.queueItemExampleQueueName, undefined, context);
-    logger.profile(`queue.${queueNames.queueItemExampleQueueName}`)
-    try {
-        // queueItem can either be a single item or an array of items
-        const payload = deserialiseQueuePayload<MyQueueItem>(queueItem, logger);
-
-        // Group by applicationInstallId
-        const grouped = groupBy(payload, e => e.applicationInstallId);
-
-        logger.verbose('Received queue batch to handle queue message', { batchSize: payload.length });
-
-        // Process each group
-        await startServices(logger);
-        for (const [applicationInstallId, items] of Object.entries(grouped)) {
-            if (items.length === 0) {
-                logger.warn('No items to process for applicationInstallId', { applicationInstallId });
-                continue;
-            }
-            const thisLogger = backgroundJobLogger(queueNames.queueItemExampleQueueName, items[0], context);
-            try {
-                const installation = await tryGetInstallation(applicationInstallId, true, thisLogger) as SeekaAppInstallState;
-
-                // Execute sync
-                // const batchItems = items.flatMap(e => e.items || []).filter(Boolean)
-                // await executeLongRunningTask(batchItems, logger);
-            }
-            catch (err) {
-                thisLogger.error('Error handling queue item to handle queue message', { ex: winston.exceptions.getAllInfo(err) })
-                await sendQueueMessageToPoisonQueue(queueNames.queueItemExampleQueueName, {
-                    ...items[0],
-                    causationId: items[0].causationId,
-                    correlationId: context.invocationId,
-                    rows: items.flatMap(e => e.items || []).filter(Boolean)
-                } as MyQueueItem, thisLogger);
-            }
-        }
-    }
-    catch (err) {
-        logger.error('Error handling queue item to handle queue message', { ex: winston.exceptions.getAllInfo(err) })
-        throw err; // Will retry based on host.json > extensions.queues.maxDequeueCount and then push to poison queue
-    }
-    finally {
-        logger.profile(`queue.${queueNames.queueItemExampleQueueName}`)
-    }
+import winston from 'winston';
+
+import { app, InvocationContext } from '@azure/functions';
+
+import { BackgroundJobRequestContext, deserialiseQueuePayload, queueNames, sendQueueMessageToPoisonQueue } from '../lib/jobs';
+import { backgroundJobLogger } from '../lib/logging';
+import { startServices } from '../lib/services';
+import { groupBy } from 'lodash';
+import { SeekaAppInstallState, tryGetInstallation } from '../lib/state/seeka/installations';
+import { SeekaActivityAcceptedWebhookContent } from '@seeka-labs/sdk-apps-server';
+
+app.storageQueue('queueExample', {
+    queueName: queueNames.queueItemExampleQueueName,
+    connection: 'AzureWebJobsStorage',
+    handler: queueExample
+});
+
+export interface MyQueueItem extends BackgroundJobRequestContext {
+    items: SeekaActivityAcceptedWebhookContent[];
+}
+
+export async function queueExample(queueItem: any, context: InvocationContext): Promise<void> {
+    const logger = backgroundJobLogger(queueNames.queueItemExampleQueueName, undefined, context);
+    logger.profile(`queue.${queueNames.queueItemExampleQueueName}`)
+    try {
+        // queueItem can either be a single item or an array of items
+        const payload = deserialiseQueuePayload<MyQueueItem>(queueItem, logger);
+
+        // Group by applicationInstallId
+        const grouped = groupBy(payload, e => e.applicationInstallId);
+
+        logger.verbose('Received queue batch to handle queue message', { batchSize: payload.length });
+
+        // Process each group
+        await startServices(logger);
+        for (const [applicationInstallId, items] of Object.entries(grouped)) {
+            if (items.length === 0) {
+                logger.warn('No items to process for applicationInstallId', { applicationInstallId });
+                continue;
+            }
+            const thisLogger = backgroundJobLogger(queueNames.queueItemExampleQueueName, items[0], context);
+            try {
+                const installation = await tryGetInstallation(applicationInstallId, true, thisLogger) as SeekaAppInstallState;
+
+                // Execute sync
+                // const batchItems = items.flatMap(e => e.items || []).filter(Boolean)
+                // await executeLongRunningTask(batchItems, logger);
+            }
+            catch (err) {
+                thisLogger.error('Error handling queue item to handle queue message', { ex: winston.exceptions.getAllInfo(err) })
+                await sendQueueMessageToPoisonQueue(queueNames.queueItemExampleQueueName, {
+                    ...items[0],
+                    causationId: items[0].causationId,
+                    correlationId: context.invocationId,
+                    rows: items.flatMap(e => e.items || []).filter(Boolean)
+                } as MyQueueItem, thisLogger);
+            }
+        }
+    }
+    catch (err) {
+        logger.error('Error handling queue item to handle queue message', { ex: winston.exceptions.getAllInfo(err) })
+        throw err; // Will retry based on host.json > extensions.queues.maxDequeueCount and then push to poison queue
+    }
+    finally {
+        logger.profile(`queue.${queueNames.queueItemExampleQueueName}`)
+    }
 }

package/dist/init-templates/azure-function/src/functions/seekaAppWebhook.ts

@@ -1,237 +1,237 @@
-import winston from 'winston';
-
-import { app, HttpRequest, HttpResponseInit, InvocationContext } from '@azure/functions';
-import {
-    PersonIdentifiers, SeekaActivityAcceptedWebhookPayload, SeekaAppInstalledWebhookPayload,
-    SeekaAppInstallSettingsUpdatedWebhookPayload, SeekaAppUninstalledWebhookPayload,
-    SeekaIdentityChangedWebhookPayload, SeekaWebhookCallType, SeekaWebhookPayload,
-    throwOnInvalidWebhookSignature
-} from '@seeka-labs/sdk-apps-server';
-
-import { queueNames, triggerBackgroundJob } from '../lib/jobs';
-// START: component:browser
-import { getSeekaBrowserPlugin } from '../lib/browser'
-// END: component:browser
-
-import { webhookLogger } from '../lib/logging';
-import { startServices } from '../lib/services';
-import {
-    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
-} from '../lib/state/seeka/installations';
-
-import type { Logger } from 'winston';
-import { MyQueueItem } from './queueExample';
-app.http('seekaAppWebhook', {
-    methods: ['POST'],
-    authLevel: 'anonymous',
-    route: 'webhook/seeka/app',
-    handler: seekaAppWebhook
-});
-
-export async function seekaAppWebhook(req: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
-    const bodyStr = (await req.text()) as string;
-    if (!bodyStr) {
-        return {
-            status: 400,
-            jsonBody: { error: "Body missing. Ensure body is present and either specify the Content-Length request header OR set Transfer-Encoding request header to 'chunked'" }
-        }
-    }
-    const body = JSON.parse(bodyStr) as SeekaWebhookPayload;
-
-    const logger = webhookLogger(body, context);
-    logger.profile('http.seeka.webhook.app')
-    logger.verbose('Received webhook from Seeka', { body });
-
-    // Handle probe
-    if (body.type === SeekaWebhookCallType.Probe) {
-        return {
-            status: 204
-        }
-    }
-
-    // Validate webhook
-    try {
-        throwOnInvalidWebhookSignature(process.env.SEEKA_APP_SECRET as string, req.headers, bodyStr);
-        logger.debug('Webhook signature validated', { body });
-    }
-    catch {
-        logger.warn('Webhook signature invalid', { body });
-        return {
-            status: 401,
-            jsonBody: { error: "Webhook call invalid" }
-        }
-    }
-
-    if (body.isTest) {
-        // This is a test webhook call
-        return {
-            status: 204
-        }
-    }
-
-    await startServices(logger);
-
-    // Check if the webhook is for an app we have installed
-    let installation: SeekaAppInstallState | null = null;
-    if (body.type != SeekaWebhookCallType.AppInstalled) {
-        installation = await tryGetInstallation((body as SeekaAppInstalledWebhookPayload).context?.applicationInstallId as string, false, logger);
-        if (installation == null) {
-            logger.warn('Webhook call cannot be processed as the installation ID is not known by this app', { body });
-
-            return {
-                status: 422,
-                jsonBody: { error: "App not installed" }
-            }
-        }
-    }
-
-    // Do something
-    let errorMessage: string | null = null;
-    try {
-        switch (body.type) {
-            case SeekaWebhookCallType.AppInstalled:
-                {
-                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
-                    break;
-                }
-            case SeekaWebhookCallType.AppInstallSettingsUpdated:
-                {
-                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
-                    break;
-                }
-            case SeekaWebhookCallType.AppUninstalled:
-                {
-                    if (!body.isTest) {
-                        const payload = body as SeekaAppUninstalledWebhookPayload;
-                        await deleteInstallation(payload.context?.applicationInstallId as string, logger)
-                    }
-                    break;
-                }
-            case SeekaWebhookCallType.ActivityAccepted:
-                {
-                    const payload = body as SeekaActivityAcceptedWebhookPayload;
-                    await handleSeekaActivity(payload, logger);
-
-                    break;
-                }
-            case SeekaWebhookCallType.IdentityChanged:
-                {
-                    const payload = body as SeekaIdentityChangedWebhookPayload;
-
-                    break;
-                }
-            // START: component:browser
-            case SeekaWebhookCallType.BrowserSdkPlugin: {
-                const plugin = await getSeekaBrowserPlugin(installation as SeekaAppInstallState, logger);
-
-                logger.profile('http.seeka.webhook.app')
-                return {
-                    status: 200,
-                    body: JSON.stringify(plugin),
-                    headers: {
-                        'Content-Type': 'application/json'
-                    }
-                }
-            }
-            // END: component:browser
-        }
-    }
-    catch (err) {
-        logger.error('Failed to handle webhook', { ex: winston.exceptions.getAllInfo(err) });
-        return {
-            status: 500,
-            jsonBody: { error: "Request failed" }
-        }
-    }
-    finally {
-        logger.profile('http.seeka.webhook.app')
-        logger.verbose('Seeka webhook handled');
-    }
-
-    if (errorMessage) {
-        logger.warn('Webhook call failed', { errorMessage });
-        return {
-            status: 400,
-            jsonBody: { error: { message: errorMessage } }
-        }
-    }
-
-    return {
-        status: 204
-    }
-}
-
-const validateInstallationSettings = async (installSettings: SampleAppInstallSettings, logger: Logger): Promise<string | null> => {
-    // Returning an error message string here will block the installation request or settings update request by the user installing the app
-
-
-    return null;
-}
-
-const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger): Promise<string | null> => {
-    if (payload.isTest) return null;
-
-    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
-    if (errorMessage) return errorMessage;
-
-    const installation = await createOrUpdateInstallation({
-        ...payload.context,
-        installationState: {
-            grantedPermissions: payload.content?.grantedPermissions || []
-        },
-        applicationInstallId: payload.context?.applicationInstallId as string,
-        organisationBrandId: payload.context?.organisationBrandId as string,
-        organisationId: payload.context?.organisationId as string,
-        installedAt: new Date().toISOString(),
-        installationSettings: payload.content?.installationSettings || {}
-    }, logger)
-
-    try {
-        await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
-            ...payload.context,
-            causationId: payload.causationId,
-            correlationId: payload.requestId
-        }, logger)
-    }
-    catch (err) {
-        await deleteInstallation(installation.applicationInstallId, logger)
-        return 'Failed to complete install';
-    }
-
-    return null;
-}
-
-const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger): Promise<string | null> => {
-    if (payload.isTest) return null;
-
-    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
-    if (errorMessage) return errorMessage;
-
-    const existingInstallation = await tryGetInstallation(payload.context?.applicationInstallId as string, true, logger) as SeekaAppInstallState;
-    const installation = await createOrUpdateInstallation({
-        ...existingInstallation,
-        installationState: {
-            ...existingInstallation.installationState,
-            grantedPermissions: payload.content?.grantedPermissions || []
-        },
-        installationSettings: payload.content?.installationSettings || {},
-    }, logger)
-
-    await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
-        ...payload.context,
-        causationId: payload.causationId,
-        correlationId: payload.requestId
-    }, logger)
-
-    return null;
-}
-
-const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {
-    // Will be handled by queueExample
-    await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
-        ...activity.context,
-        causationId: activity.causationId,
-        correlationId: activity.requestId,
-        items: [activity]
-    } as MyQueueItem, logger)
+import winston from 'winston';
+
+import { app, HttpRequest, HttpResponseInit, InvocationContext } from '@azure/functions';
+import {
+    PersonIdentifiers, SeekaActivityAcceptedWebhookPayload, SeekaAppInstalledWebhookPayload,
+    SeekaAppInstallSettingsUpdatedWebhookPayload, SeekaAppUninstalledWebhookPayload,
+    SeekaIdentityChangedWebhookPayload, SeekaWebhookCallType, SeekaWebhookPayload,
+    throwOnInvalidWebhookSignature
+} from '@seeka-labs/sdk-apps-server';
+
+import { queueNames, triggerBackgroundJob } from '../lib/jobs';
+// START: component:browser
+import { getSeekaBrowserPlugin } from '../lib/browser'
+// END: component:browser
+
+import { webhookLogger } from '../lib/logging';
+import { startServices } from '../lib/services';
+import {
+    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
+} from '../lib/state/seeka/installations';
+
+import type { Logger } from 'winston';
+import { MyQueueItem } from './queueExample';
+app.http('seekaAppWebhook', {
+    methods: ['POST'],
+    authLevel: 'anonymous',
+    route: 'webhook/seeka/app',
+    handler: seekaAppWebhook
+});
+
+export async function seekaAppWebhook(req: HttpRequest, context: InvocationContext): Promise<HttpResponseInit> {
+    const bodyStr = (await req.text()) as string;
+    if (!bodyStr) {
+        return {
+            status: 400,
+            jsonBody: { error: "Body missing. Ensure body is present and either specify the Content-Length request header OR set Transfer-Encoding request header to 'chunked'" }
+        }
+    }
+    const body = JSON.parse(bodyStr) as SeekaWebhookPayload;
+
+    const logger = webhookLogger(body, context);
+    logger.profile('http.seeka.webhook.app')
+    logger.verbose('Received webhook from Seeka', { body });
+
+    // Handle probe
+    if (body.type === SeekaWebhookCallType.Probe) {
+        return {
+            status: 204
+        }
+    }
+
+    // Validate webhook
+    try {
+        throwOnInvalidWebhookSignature(process.env.SEEKA_APP_SECRET as string, req.headers, bodyStr);
+        logger.debug('Webhook signature validated', { body });
+    }
+    catch {
+        logger.warn('Webhook signature invalid', { body });
+        return {
+            status: 401,
+            jsonBody: { error: "Webhook call invalid" }
+        }
+    }
+
+    if (body.isTest) {
+        // This is a test webhook call
+        return {
+            status: 204
+        }
+    }
+
+    await startServices(logger);
+
+    // Check if the webhook is for an app we have installed
+    let installation: SeekaAppInstallState | null = null;
+    if (body.type != SeekaWebhookCallType.AppInstalled) {
+        installation = await tryGetInstallation((body as SeekaAppInstalledWebhookPayload).context?.applicationInstallId as string, false, logger);
+        if (installation == null) {
+            logger.warn('Webhook call cannot be processed as the installation ID is not known by this app', { body });
+
+            return {
+                status: 422,
+                jsonBody: { error: "App not installed" }
+            }
+        }
+    }
+
+    // Do something
+    let errorMessage: string | null = null;
+    try {
+        switch (body.type) {
+            case SeekaWebhookCallType.AppInstalled:
+                {
+                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
+                    break;
+                }
+            case SeekaWebhookCallType.AppInstallSettingsUpdated:
+                {
+                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
+                    break;
+                }
+            case SeekaWebhookCallType.AppUninstalled:
+                {
+                    if (!body.isTest) {
+                        const payload = body as SeekaAppUninstalledWebhookPayload;
+                        await deleteInstallation(payload.context?.applicationInstallId as string, logger)
+                    }
+                    break;
+                }
+            case SeekaWebhookCallType.ActivityAccepted:
+                {
+                    const payload = body as SeekaActivityAcceptedWebhookPayload;
+                    await handleSeekaActivity(payload, logger);
+
+                    break;
+                }
+            case SeekaWebhookCallType.IdentityChanged:
+                {
+                    const payload = body as SeekaIdentityChangedWebhookPayload;
+
+                    break;
+                }
+            // START: component:browser
+            case SeekaWebhookCallType.BrowserSdkPlugin: {
+                const plugin = await getSeekaBrowserPlugin(installation as SeekaAppInstallState, logger);
+
+                logger.profile('http.seeka.webhook.app')
+                return {
+                    status: 200,
+                    body: JSON.stringify(plugin),
+                    headers: {
+                        'Content-Type': 'application/json'
+                    }
+                }
+            }
+            // END: component:browser
+        }
+    }
+    catch (err) {
+        logger.error('Failed to handle webhook', { ex: winston.exceptions.getAllInfo(err) });
+        return {
+            status: 500,
+            jsonBody: { error: "Request failed" }
+        }
+    }
+    finally {
+        logger.profile('http.seeka.webhook.app')
+        logger.verbose('Seeka webhook handled');
+    }
+
+    if (errorMessage) {
+        logger.warn('Webhook call failed', { errorMessage });
+        return {
+            status: 400,
+            jsonBody: { error: { message: errorMessage } }
+        }
+    }
+
+    return {
+        status: 204
+    }
+}
+
+const validateInstallationSettings = async (installSettings: SampleAppInstallSettings, logger: Logger): Promise<string | null> => {
+    // Returning an error message string here will block the installation request or settings update request by the user installing the app
+
+
+    return null;
+}
+
+const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger): Promise<string | null> => {
+    if (payload.isTest) return null;
+
+    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
+    if (errorMessage) return errorMessage;
+
+    const installation = await createOrUpdateInstallation({
+        ...payload.context,
+        installationState: {
+            grantedPermissions: payload.content?.grantedPermissions || []
+        },
+        applicationInstallId: payload.context?.applicationInstallId as string,
+        organisationBrandId: payload.context?.organisationBrandId as string,
+        organisationId: payload.context?.organisationId as string,
+        installedAt: new Date().toISOString(),
+        installationSettings: payload.content?.installationSettings || {}
+    }, logger)
+
+    try {
+        await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
+            ...payload.context,
+            causationId: payload.causationId,
+            correlationId: payload.requestId
+        }, logger)
+    }
+    catch (err) {
+        await deleteInstallation(installation.applicationInstallId, logger)
+        return 'Failed to complete install';
+    }
+
+    return null;
+}
+
+const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger): Promise<string | null> => {
+    if (payload.isTest) return null;
+
+    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
+    if (errorMessage) return errorMessage;
+
+    const existingInstallation = await tryGetInstallation(payload.context?.applicationInstallId as string, true, logger) as SeekaAppInstallState;
+    const installation = await createOrUpdateInstallation({
+        ...existingInstallation,
+        installationState: {
+            ...existingInstallation.installationState,
+            grantedPermissions: payload.content?.grantedPermissions || []
+        },
+        installationSettings: payload.content?.installationSettings || {},
+    }, logger)
+
+    await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
+        ...payload.context,
+        causationId: payload.causationId,
+        correlationId: payload.requestId
+    }, logger)
+
+    return null;
+}
+
+const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {
+    // Will be handled by queueExample
+    await triggerBackgroundJob(queueNames.queueItemExampleQueueName, {
+        ...activity.context,
+        causationId: activity.causationId,
+        correlationId: activity.requestId,
+        items: [activity]
+    } as MyQueueItem, logger)
 }

package/dist/init-templates/azure-function/src/index.test.ts

@@ -1,7 +1,7 @@
-import { describe, expect, test } from '@jest/globals';
-
-describe('test example module', () => {
-    test('should be false', () => {
-        expect(false).toBeFalsy();
-    });
+import { describe, expect, test } from '@jest/globals';
+
+describe('test example module', () => {
+    test('should be false', () => {
+        expect(false).toBeFalsy();
+    });
 });