@shipfox/api-server 7.1.0 → 8.0.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@shipfox/api-server",
   "license": "MIT",
   "private": false,
-  "version": "7.1.0",
+  "version": "8.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -25,37 +25,37 @@
     }
   },
   "dependencies": {
-    "@shipfox/annotations": "7.1.0",
-    "@shipfox/api-agent": "7.1.0",
+    "@shipfox/annotations": "8.0.0",
     "@shipfox/annotations-dto": "6.0.0",
-    "@shipfox/api-agent-dto": "6.0.0",
+    "@shipfox/api-agent": "8.0.0",
+    "@shipfox/api-agent-dto": "8.0.0",
     "@shipfox/api-auth": "7.1.0",
     "@shipfox/api-auth-dto": "7.1.0",
+    "@shipfox/api-definitions": "8.0.0",
     "@shipfox/api-definitions-dto": "6.0.0",
     "@shipfox/api-dispatcher": "7.1.0",
     "@shipfox/api-email-challenges": "0.3.0",
-    "@shipfox/api-definitions": "7.1.0",
-    "@shipfox/api-integration-core": "7.1.0",
-    "@shipfox/api-projects": "7.1.0",
-    "@shipfox/api-logs": "7.1.0",
-    "@shipfox/api-projects-dto": "6.0.0",
-    "@shipfox/api-runners": "7.1.0",
+    "@shipfox/api-integration-core": "8.0.0",
+    "@shipfox/api-integration-core-dto": "8.0.0",
+    "@shipfox/api-logs": "8.0.0",
+    "@shipfox/api-projects": "8.0.0",
+    "@shipfox/api-projects-dto": "8.0.0",
+    "@shipfox/api-runners": "8.0.0",
     "@shipfox/api-runners-dto": "7.0.1",
-    "@shipfox/api-secrets": "7.1.0",
-    "@shipfox/api-integration-core-dto": "6.0.0",
-    "@shipfox/api-workflows": "7.1.0",
+    "@shipfox/api-secrets": "8.0.0",
     "@shipfox/api-secrets-dto": "6.0.0",
-    "@shipfox/api-triggers": "7.1.0",
+    "@shipfox/api-triggers": "8.0.0",
+    "@shipfox/api-workflows": "8.0.0",
+    "@shipfox/api-workflows-dto": "8.0.0",
     "@shipfox/api-workspaces-dto": "6.0.0",
-    "@shipfox/api-workflows-dto": "6.0.0",
     "@shipfox/api-workspaces": "7.1.0",
     "@shipfox/config": "1.2.2",
-    "@shipfox/node-fastify": "0.3.0",
     "@shipfox/node-error-monitoring": "0.2.0",
+    "@shipfox/node-fastify": "0.3.0",
     "@shipfox/node-jwt": "0.3.0",
-    "@shipfox/node-postgres": "0.4.2",
     "@shipfox/node-module": "0.5.0",
-    "@shipfox/node-opentelemetry": "0.6.0"
+    "@shipfox/node-opentelemetry": "0.6.0",
+    "@shipfox/node-postgres": "0.4.2"
   },
   "scripts": {
     "build": "shipfox-swc",

package/src/auth-token-interoperability.test.ts

@@ -0,0 +1,52 @@
+import {AUTH_LEASED_JOB, requireLeasedJobContext} from '@shipfox/api-auth-context';
+import {closeApp, createApp, defineRoute} from '@shipfox/node-fastify';
+import {afterEach, describe, expect, it} from '@shipfox/vitest/vi';
+
+process.env.AUTH_ROOT_KEY ??= 'MDEyMzQ1Njc4OWFiY2RlZjAxMjM0NTY3ODlhYmNkZWY=';
+
+const leaseRoute = defineRoute({
+  method: 'GET',
+  path: '/lease',
+  description: 'Auth composition test route.',
+  handler: (request) => {
+    const lease = requireLeasedJobContext(request);
+    return {job_id: lease.jobId, step_id: lease.currentStepId};
+  },
+});
+
+describe('Auth token interoperability', () => {
+  afterEach(async () => {
+    await closeApp();
+  });
+
+  it('accepts an Auth-issued step lease through the server route boundary', async () => {
+    const {createLeaseTokenAuthMethod, issueJobLeaseToken} = await import('@shipfox/api-auth');
+    const jobId = crypto.randomUUID();
+    const stepId = crypto.randomUUID();
+    const token = await issueJobLeaseToken({
+      jobId,
+      jobExecutionId: crypto.randomUUID(),
+      workflowRunId: crypto.randomUUID(),
+      workflowRunAttemptId: crypto.randomUUID(),
+      projectId: crypto.randomUUID(),
+      workspaceId: crypto.randomUUID(),
+      runnerSessionId: crypto.randomUUID(),
+      currentStepId: stepId,
+      currentStepAttempt: 1,
+    });
+    const app = await createApp({
+      auth: [createLeaseTokenAuthMethod()],
+      routes: [{prefix: '/runs/jobs/current', auth: AUTH_LEASED_JOB, routes: [leaseRoute]}],
+      swagger: false,
+    });
+
+    const res = await app.inject({
+      method: 'GET',
+      url: '/runs/jobs/current/lease',
+      headers: {authorization: `Bearer ${token}`},
+    });
+
+    expect(res.statusCode).toBe(200);
+    expect(res.json()).toEqual({job_id: jobId, step_id: stepId});
+  });
+});

package/src/index.ts

@@ -1,4 +1,5 @@
 export {
+  type DefaultModulesExtension,
   type DefaultModulesOptions,
   type DefaultRunnersModuleFactory,
   defaultModules,

package/src/modules.test.ts

@@ -2,15 +2,18 @@ import {annotationsInterModuleContract} from '@shipfox/annotations-dto/inter-mod
 import {agentInterModuleContract} from '@shipfox/api-agent-dto/inter-module';
 import {authInterModuleContract} from '@shipfox/api-auth-dto/inter-module';
 import {definitionsInterModuleContract} from '@shipfox/api-definitions-dto/inter-module';
-import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto';
-import {projectsInterModuleContract} from '@shipfox/api-projects-dto';
+import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto/inter-module';
+import {projectsInterModuleContract} from '@shipfox/api-projects-dto/inter-module';
 import {runnersInterModuleContract} from '@shipfox/api-runners-dto/inter-module';
 import {
   type SecretsInterModuleClient,
   secretsInterModuleContract,
 } from '@shipfox/api-secrets-dto/inter-module';
 import {workflowsInterModuleContract} from '@shipfox/api-workflows-dto/inter-module';
-import {workspacesInterModuleContract} from '@shipfox/api-workspaces-dto/inter-module';
+import {
+  type WorkspacesInterModuleClient,
+  workspacesInterModuleContract,
+} from '@shipfox/api-workspaces-dto/inter-module';
 import {defineInterModulePresentation} from '@shipfox/inter-module';
 import {defaultModules} from './modules.js';
 
@@ -30,6 +33,7 @@ const mocks = vi.hoisted(() => ({
   deleteSecrets: vi.fn(),
   getIntegrationConnectionById: vi.fn(),
   getSecret: vi.fn(),
+  listMembershipsForTokenClaims: vi.fn(),
   setSecrets: vi.fn(),
 }));
 
@@ -96,7 +100,7 @@ vi.mock('@shipfox/api-workspaces', () => ({
       {
         contract: workspacesInterModuleContract,
         handlers: {
-          listMembershipsForTokenClaims: vi.fn(),
+          listMembershipsForTokenClaims: mocks.listMembershipsForTokenClaims,
           preflightInvitationAcceptance: vi.fn(),
           acceptInvitation: vi.fn(),
           requireActiveMembership: vi.fn(),
@@ -123,6 +127,7 @@ describe('defaultModules', () => {
     mocks.deleteSecrets.mockReset();
     mocks.getIntegrationConnectionById.mockReset();
     mocks.getSecret.mockReset();
+    mocks.listMembershipsForTokenClaims.mockReset();
     mocks.setSecrets.mockReset();
 
     mocks.createIntegrationsContext.mockResolvedValue({
@@ -147,6 +152,7 @@ describe('defaultModules', () => {
     mocks.createWorkspaceConnectionSnapshotLoader.mockReturnValue(vi.fn());
     mocks.deleteSecrets.mockResolvedValue({deleted: 1});
     mocks.getSecret.mockResolvedValue({value: 'secret'});
+    mocks.listMembershipsForTokenClaims.mockResolvedValue({memberships: []});
     mocks.setSecrets.mockResolvedValue({});
     mocks.createProjectsModule.mockReturnValue({
       name: 'projects',
@@ -182,7 +188,11 @@ describe('defaultModules', () => {
       interModulePresentations: [
         {
           contract: agentInterModuleContract,
-          handlers: {resolveAgentConfig: vi.fn(), resolveRuntimeCredentials: vi.fn()},
+          handlers: {
+            getValidationCatalog: vi.fn(),
+            resolveAgentConfig: vi.fn(),
+            resolveRuntimeCredentials: vi.fn(),
+          },
         },
       ],
     });
@@ -288,6 +298,27 @@ describe('defaultModules', () => {
     ]);
   });
 
+  it('extends the default module list with the composed Workspaces client', async () => {
+    let workspaces: WorkspacesInterModuleClient | undefined;
+    const extensionModule = {name: 'cloud'};
+    const extension = vi.fn((options: {workspaces: WorkspacesInterModuleClient}) => {
+      workspaces = options.workspaces;
+      return [extensionModule];
+    });
+
+    const modules = await defaultModules({extension});
+    const userId = crypto.randomUUID();
+    const memberships = await workspaces?.listMembershipsForTokenClaims({userId});
+
+    expect(extension).toHaveBeenCalledWith({workspaces: expect.any(Object)});
+    expect(memberships).toEqual({memberships: []});
+    expect(mocks.listMembershipsForTokenClaims).toHaveBeenCalledWith(
+      {userId},
+      expect.objectContaining({signal: expect.any(AbortSignal)}),
+    );
+    expect(modules.at(-1)).toBe(extensionModule);
+  });
+
   it('injects Workflows into integrations and logs and namespaces provider secrets', async () => {
     await defaultModules();
 

package/src/modules.ts

@@ -13,10 +13,10 @@ import {definitionsInterModuleContract} from '@shipfox/api-definitions-dto/inter
 import {dispatcherModule} from '@shipfox/api-dispatcher';
 import {emailChallengesModule} from '@shipfox/api-email-challenges';
 import {createIntegrationsContext, type WebhookDeliverySource} from '@shipfox/api-integration-core';
-import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto';
+import {integrationsInterModuleContract} from '@shipfox/api-integration-core-dto/inter-module';
 import {createLogsModule} from '@shipfox/api-logs';
 import {createProjectsModule} from '@shipfox/api-projects';
-import {projectsInterModuleContract} from '@shipfox/api-projects-dto';
+import {projectsInterModuleContract} from '@shipfox/api-projects-dto/inter-module';
 import {createRunnersModule} from '@shipfox/api-runners';
 import {runnersInterModuleContract} from '@shipfox/api-runners-dto/inter-module';
 import {createSecretsModule} from '@shipfox/api-secrets';
@@ -25,7 +25,10 @@ import {createTriggersModule} from '@shipfox/api-triggers';
 import {createWorkflowsModule} from '@shipfox/api-workflows';
 import {workflowsInterModuleContract} from '@shipfox/api-workflows-dto/inter-module';
 import {workspacesModule} from '@shipfox/api-workspaces';
-import {workspacesInterModuleContract} from '@shipfox/api-workspaces-dto/inter-module';
+import {
+  type WorkspacesInterModuleClient,
+  workspacesInterModuleContract,
+} from '@shipfox/api-workspaces-dto/inter-module';
 import {reportError} from '@shipfox/node-error-monitoring';
 import {durationToSeconds} from '@shipfox/node-jwt';
 import type {ShipfoxModule} from '@shipfox/node-module';
@@ -38,9 +41,13 @@ import {logger} from '@shipfox/node-opentelemetry';
 export interface DefaultModulesOptions {
   webhookDeliverySource?: WebhookDeliverySource | undefined;
   runnersModule?: DefaultRunnersModuleFactory | undefined;
+  extension?: DefaultModulesExtension | undefined;
 }
 
 export type DefaultRunnersModuleFactory = (options: {auth: AuthInterModuleClient}) => ShipfoxModule;
+export type DefaultModulesExtension = (options: {
+  workspaces: WorkspacesInterModuleClient;
+}) => ShipfoxModule[];
 
 export async function defaultModules(
   options: DefaultModulesOptions = {},
@@ -151,8 +158,10 @@ export async function defaultModules(
   const projectsModule = createProjectsModule({integrations: integrationsClient});
   const definitionsModule = createDefinitionsModule({
     projects: projectsClient,
+    agent: agentClient,
     integrations: integrationsClient,
   });
+  const extensionModules = options.extension?.({workspaces: workspacesClient}) ?? [];
 
   const modules = [
     emailChallengesModule,
@@ -181,6 +190,7 @@ export async function defaultModules(
     }),
     createTriggersModule({workflows: workflowsClient}),
     dispatcherModule,
+    ...extensionModules,
   ];
   registerInterModulePresentations({transport: interModuleTransport, modules});
   interModuleTransport.seal();