@shipfox/api-server 2.0.0 → 4.0.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@shipfox/api-server",
   "license": "MIT",
   "private": false,
-  "version": "2.0.0",
+  "version": "4.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -41,32 +41,32 @@
     }
   },
   "dependencies": {
-    "@shipfox/api-auth": "2.0.0",
-    "@shipfox/api-agent": "2.0.0",
-    "@shipfox/api-dispatcher": "2.0.0",
-    "@shipfox/annotations": "2.0.0",
-    "@shipfox/api-integration-core": "2.0.0",
-    "@shipfox/api-definitions": "2.0.0",
-    "@shipfox/api-logs": "2.0.0",
-    "@shipfox/api-projects": "2.0.0",
-    "@shipfox/api-workspaces": "2.0.0",
-    "@shipfox/api-triggers": "2.0.0",
+    "@shipfox/annotations": "4.0.0",
+    "@shipfox/api-agent": "4.0.0",
+    "@shipfox/api-auth": "4.0.0",
+    "@shipfox/api-definitions": "4.0.0",
+    "@shipfox/api-dispatcher": "4.0.0",
+    "@shipfox/api-integration-core": "4.0.0",
+    "@shipfox/api-logs": "4.0.0",
+    "@shipfox/api-projects": "4.0.0",
+    "@shipfox/api-runners": "4.0.0",
+    "@shipfox/api-secrets": "4.0.0",
+    "@shipfox/api-triggers": "4.0.0",
+    "@shipfox/api-workflows": "4.0.0",
+    "@shipfox/api-workspaces": "4.0.0",
     "@shipfox/config": "1.2.1",
-    "@shipfox/node-fastify": "0.2.1",
     "@shipfox/node-error-monitoring": "0.1.2",
-    "@shipfox/api-workflows": "2.0.0",
-    "@shipfox/node-module": "0.2.0",
-    "@shipfox/api-secrets": "2.0.0",
-    "@shipfox/node-postgres": "0.4.1",
-    "@shipfox/api-runners": "2.0.0",
-    "@shipfox/node-opentelemetry": "0.5.0"
+    "@shipfox/node-fastify": "0.2.2",
+    "@shipfox/node-module": "0.3.1",
+    "@shipfox/node-opentelemetry": "0.5.1",
+    "@shipfox/node-postgres": "0.4.1"
   },
   "devDependencies": {
-    "@shipfox/ts-config": "1.3.8",
     "@shipfox/biome": "1.8.1",
     "@shipfox/swc": "1.2.5",
-    "@shipfox/vitest": "1.2.2",
-    "@shipfox/typescript": "1.1.6"
+    "@shipfox/ts-config": "1.3.8",
+    "@shipfox/typescript": "1.1.6",
+    "@shipfox/vitest": "1.2.2"
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/modules.test.ts

@@ -96,7 +96,7 @@ describe('defaultModules', () => {
     ]);
   });
 
-  it('uses the leased-step loader and namespaced Linear secrets', async () => {
+  it('uses the leased-step loader and namespaced provider secrets', async () => {
     await defaultModules();
 
     expect(mocks.createIntegrationsContext).toHaveBeenCalledWith({
@@ -107,6 +107,11 @@ describe('defaultModules', () => {
           getSecret: expect.any(Function),
           setSecrets: expect.any(Function),
         },
+        slack: {
+          deleteSecrets: expect.any(Function),
+          getSecret: expect.any(Function),
+          setSecrets: expect.any(Function),
+        },
       },
       agentTools: {loadLeasedAgentStep: mocks.loadRunningLeasedStep},
     });
@@ -118,11 +123,19 @@ describe('defaultModules', () => {
           getSecret: (params: {namespace: string}) => unknown;
           setSecrets: (params: {namespace: string}) => unknown;
         };
+        slack: {
+          deleteSecrets: (params: {namespace: string}) => unknown;
+          getSecret: (params: {namespace: string}) => unknown;
+          setSecrets: (params: {namespace: string}) => unknown;
+        };
       };
     };
     integrationsOptions.secrets.linear.getSecret({namespace: 'workspace'});
     integrationsOptions.secrets.linear.setSecrets({namespace: 'workspace'});
     integrationsOptions.secrets.linear.deleteSecrets({namespace: 'workspace'});
+    integrationsOptions.secrets.slack.getSecret({namespace: 'workspace'});
+    integrationsOptions.secrets.slack.setSecrets({namespace: 'workspace'});
+    integrationsOptions.secrets.slack.deleteSecrets({namespace: 'workspace'});
 
     expect(mocks.getSecret).toHaveBeenCalledWith({
       namespace: 'system/integrations/linear/workspace',
@@ -133,5 +146,14 @@ describe('defaultModules', () => {
     expect(mocks.deleteSecrets).toHaveBeenCalledWith({
       namespace: 'system/integrations/linear/workspace',
     });
+    expect(mocks.getSecret).toHaveBeenCalledWith({
+      namespace: 'system/integrations/slack/workspace',
+    });
+    expect(mocks.setSecrets).toHaveBeenCalledWith({
+      namespace: 'system/integrations/slack/workspace',
+    });
+    expect(mocks.deleteSecrets).toHaveBeenCalledWith({
+      namespace: 'system/integrations/slack/workspace',
+    });
   });
 });

package/src/modules.ts

@@ -45,6 +45,23 @@ export async function defaultModules(): Promise<ShipfoxModule[]> {
             namespace: `system/integrations/linear/${params.namespace}`,
           }),
       },
+      slack: {
+        getSecret: (params) =>
+          getSecret({
+            ...params,
+            namespace: `system/integrations/slack/${params.namespace}`,
+          }),
+        setSecrets: (params) =>
+          setSecrets({
+            ...params,
+            namespace: `system/integrations/slack/${params.namespace}`,
+          }),
+        deleteSecrets: (params) =>
+          deleteSecrets({
+            ...params,
+            namespace: `system/integrations/slack/${params.namespace}`,
+          }),
+      },
     },
     agentTools: {loadLeasedAgentStep: loadRunningLeasedStep},
   });

package/src/server.test.ts

@@ -17,6 +17,7 @@ const mocks = vi.hoisted(() => {
     createE2eAdminAuthMethod: vi.fn(),
     createE2eRouteGroup: vi.fn(),
     createPostgresClient: vi.fn(),
+    aggregateLoginMethods: vi.fn(),
     initializeModules: vi.fn(),
     listen: vi.fn(),
     logger: {error: vi.fn(), info: vi.fn()},
@@ -47,6 +48,7 @@ vi.mock('@shipfox/node-fastify', () => ({
   listen: mocks.listen,
 }));
 vi.mock('@shipfox/node-module', () => ({
+  aggregateLoginMethods: mocks.aggregateLoginMethods,
   initializeModules: mocks.initializeModules,
   registerModuleMetrics: mocks.registerModuleMetrics,
   resetPublishers: mocks.resetPublishers,
@@ -73,7 +75,7 @@ vi.mock('./e2e.js', () => ({
 }));
 
 function module(): ShipfoxModule {
-  return {name: 'test'};
+  return {name: 'test', loginMethods: [{id: 'test-login'}]};
 }
 
 function worker(taskQueue = 'runtime-queue'): ModuleWorker {
@@ -101,6 +103,7 @@ function resetMocks(): void {
   mocks.createE2eAdminAuthMethod.mockReset();
   mocks.createE2eRouteGroup.mockReset();
   mocks.createPostgresClient.mockReset();
+  mocks.aggregateLoginMethods.mockReset();
   mocks.initializeModules.mockReset();
   mocks.listen.mockReset();
   mocks.logger.error.mockReset();
@@ -122,6 +125,7 @@ function resetMocks(): void {
   mocks.closeErrorMonitoring.mockResolvedValue(true);
   mocks.closePostgresClient.mockResolvedValue(undefined);
   mocks.createApp.mockResolvedValue({});
+  mocks.aggregateLoginMethods.mockReturnValue([{id: 'test-login'}]);
   mocks.createE2eRouteGroup.mockReturnValue([]);
   mocks.initializeModules.mockResolvedValue({
     auth: [],
@@ -166,6 +170,7 @@ describe('createServer', () => {
     await createTestServer({modules});
 
     expect(mocks.startServiceMetrics).toHaveBeenCalledWith({serviceName: 'api'});
+    expect(mocks.aggregateLoginMethods).toHaveBeenCalledWith({modules});
     expect(mocks.createPostgresClient).toHaveBeenCalledOnce();
     expect(mocks.initializeModules).toHaveBeenCalledWith({modules});
     expect(mocks.registerModuleMetrics).toHaveBeenCalledWith({modules});
@@ -177,6 +182,28 @@ describe('createServer', () => {
     });
   });
 
+  it('fails before startup side effects when no login method is configured', async () => {
+    const failure = new Error('No login methods are configured');
+    mocks.aggregateLoginMethods.mockImplementationOnce(() => {
+      throw failure;
+    });
+
+    const result = createTestServer({modules: [module()]});
+
+    await expect(result).rejects.toBe(failure);
+    expect(mocks.startServiceMetrics).not.toHaveBeenCalled();
+    expect(mocks.createPostgresClient).not.toHaveBeenCalled();
+  });
+
+  it('constructs and starts when a module contributes a login method', async () => {
+    const server = await createTestServer({modules: [module()]});
+
+    await server.start();
+
+    expect(mocks.startModuleWorkers).toHaveBeenCalledOnce();
+    expect(mocks.listen).toHaveBeenCalledOnce();
+  });
+
   it('starts module workers before listening for HTTP requests', async () => {
     const server = await createTestServer({modules: [module()]});
     let resolveWorkers: ((handle: ModuleWorkersHandle) => void) | undefined;

package/src/server.ts

@@ -1,6 +1,7 @@
 import {captureException, closeErrorMonitoring} from '@shipfox/node-error-monitoring';
 import {closeApp, createApp, listen} from '@shipfox/node-fastify';
 import {
+  aggregateLoginMethods,
   initializeModules,
   type ModuleWorker,
   type ModuleWorkersHandle,
@@ -43,6 +44,7 @@ export async function createServer(options: CreateServerOptions): Promise<Server
   hasActiveServer = true;
 
   try {
+    aggregateLoginMethods({modules: options.modules});
     startServiceMetrics({serviceName: 'api'});
     createPostgresClient();