@shipfox/api-server 9.2.0 → 10.0.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@shipfox/api-server",
   "license": "MIT",
   "private": false,
-  "version": "9.2.0",
+  "version": "10.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -22,36 +22,36 @@
     }
   },
   "dependencies": {
-    "@shipfox/annotations": "9.2.0",
+    "@shipfox/annotations": "10.0.0",
     "@shipfox/annotations-dto": "9.0.2",
-    "@shipfox/api-agent": "9.2.0",
-    "@shipfox/api-agent-dto": "9.0.2",
-    "@shipfox/api-auth": "9.2.0",
-    "@shipfox/api-auth-dto": "9.2.0",
-    "@shipfox/api-definitions": "9.2.0",
-    "@shipfox/api-definitions-dto": "9.0.2",
-    "@shipfox/api-dispatcher": "9.0.3",
-    "@shipfox/api-email-challenges": "1.1.4",
-    "@shipfox/api-integration-core": "9.2.0",
+    "@shipfox/api-agent": "10.0.0",
+    "@shipfox/api-agent-dto": "10.0.0",
+    "@shipfox/api-auth": "10.0.0",
+    "@shipfox/api-auth-dto": "10.0.0",
+    "@shipfox/api-definitions": "10.0.0",
+    "@shipfox/api-definitions-dto": "10.0.0",
+    "@shipfox/api-dispatcher": "10.0.0",
+    "@shipfox/api-email-challenges": "1.1.6",
+    "@shipfox/api-integration-core": "10.0.0",
     "@shipfox/api-integration-core-dto": "9.0.2",
-    "@shipfox/api-logs": "9.2.0",
-    "@shipfox/api-projects": "9.2.0",
-    "@shipfox/api-projects-dto": "9.2.0",
-    "@shipfox/api-runners": "9.2.0",
-    "@shipfox/api-runners-dto": "9.0.2",
-    "@shipfox/api-secrets": "9.2.0",
+    "@shipfox/api-logs": "10.0.0",
+    "@shipfox/api-projects": "10.0.0",
+    "@shipfox/api-projects-dto": "10.0.0",
+    "@shipfox/api-runners": "10.0.0",
+    "@shipfox/api-runners-dto": "10.0.0",
+    "@shipfox/api-secrets": "10.0.0",
     "@shipfox/api-secrets-dto": "9.0.2",
-    "@shipfox/api-triggers": "9.2.0",
-    "@shipfox/api-workflows": "9.2.0",
-    "@shipfox/api-workflows-dto": "9.0.2",
-    "@shipfox/api-workspaces-dto": "9.2.0",
-    "@shipfox/api-workspaces": "9.2.0",
+    "@shipfox/api-triggers": "10.0.0",
+    "@shipfox/api-workflows": "10.0.0",
+    "@shipfox/api-workflows-dto": "10.0.0",
+    "@shipfox/api-workspaces-dto": "10.0.0",
+    "@shipfox/api-workspaces": "10.0.0",
     "@shipfox/config": "1.2.4",
     "@shipfox/node-error-monitoring": "0.3.0",
-    "@shipfox/node-fastify": "0.3.3",
+    "@shipfox/node-fastify": "0.4.0",
     "@shipfox/node-jwt": "0.3.2",
-    "@shipfox/node-module": "1.0.2",
-    "@shipfox/node-opentelemetry": "0.6.2",
+    "@shipfox/node-module": "1.0.4",
+    "@shipfox/node-opentelemetry": "0.6.3",
     "@shipfox/node-postgres": "0.4.4"
   },
   "imports": {

package/src/index.ts

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

package/src/instrumentation.ts

@@ -8,5 +8,5 @@ const {version} = createRequire(import.meta.url)('../package.json') as {version:
 await startInstanceInstrumentation({
   serviceName: 'api',
   serviceVersion: version,
-  instrumentations: {fastify: true, http: true, pg: true, awsSdk: true},
+  instrumentations: {fastify: true, http: true, pg: true, awsSdk: true, pino: true},
 });

package/src/modules.test.ts

@@ -21,6 +21,7 @@ const mocks = vi.hoisted(() => ({
   buildAgentToolCatalogs: vi.fn(),
   buildAgentToolSelectionCatalogs: vi.fn(),
   createAgentModule: vi.fn(),
+  createAuthModule: vi.fn(),
   createDefinitionsModule: vi.fn(),
   createIntegrationsContext: vi.fn(),
   createLogsModule: vi.fn(),
@@ -29,11 +30,13 @@ const mocks = vi.hoisted(() => ({
   createSecretsModule: vi.fn(),
   createTriggersModule: vi.fn(),
   createWorkflowsModule: vi.fn(),
+  createWorkspacesModule: vi.fn(),
   createWorkspaceConnectionSnapshotLoader: vi.fn(),
   deleteSecrets: vi.fn(),
   getIntegrationConnectionById: vi.fn(),
   getSecret: vi.fn(),
   getWorkspaceCreator: vi.fn(),
+  getWorkspaceOperatingState: vi.fn(),
   listMembershipsForTokenClaims: vi.fn(),
   setSecrets: vi.fn(),
 }));
@@ -50,20 +53,7 @@ vi.mock('@shipfox/annotations', () => ({
   },
 }));
 vi.mock('@shipfox/api-auth', () => ({
-  createAuthModule: () => ({
-    name: 'auth',
-    interModulePresentations: [
-      {
-        contract: authInterModuleContract,
-        handlers: {
-          mintJobLeaseToken: vi.fn(),
-          mintRunnerSessionToken: vi.fn(),
-          getCurrentAdminRole: vi.fn(),
-          requireAdminRole: vi.fn(),
-        },
-      },
-    ],
-  }),
+  createAuthModule: mocks.createAuthModule,
 }));
 vi.mock('@shipfox/api-agent', () => ({createAgentModule: mocks.createAgentModule}));
 vi.mock('@shipfox/api-auth/config', () => ({
@@ -97,21 +87,7 @@ vi.mock('@shipfox/api-workflows', () => ({
   createWorkflowsModule: mocks.createWorkflowsModule,
 }));
 vi.mock('@shipfox/api-workspaces', () => ({
-  workspacesModule: {
-    name: 'workspaces',
-    interModulePresentations: [
-      {
-        contract: workspacesInterModuleContract,
-        handlers: {
-          listMembershipsForTokenClaims: mocks.listMembershipsForTokenClaims,
-          getWorkspaceCreator: mocks.getWorkspaceCreator,
-          preflightInvitationAcceptance: vi.fn(),
-          acceptInvitation: vi.fn(),
-          requireActiveMembership: vi.fn(),
-        },
-      },
-    ],
-  },
+  createWorkspacesModule: mocks.createWorkspacesModule,
 }));
 
 describe('defaultModules', () => {
@@ -119,6 +95,7 @@ describe('defaultModules', () => {
     mocks.buildAgentToolCatalogs.mockReset();
     mocks.buildAgentToolSelectionCatalogs.mockReset();
     mocks.createAgentModule.mockReset();
+    mocks.createAuthModule.mockReset();
     mocks.createDefinitionsModule.mockReset();
     mocks.createIntegrationsContext.mockReset();
     mocks.createLogsModule.mockReset();
@@ -127,6 +104,7 @@ describe('defaultModules', () => {
     mocks.createSecretsModule.mockReset();
     mocks.createTriggersModule.mockReset();
     mocks.createWorkflowsModule.mockReset();
+    mocks.createWorkspacesModule.mockReset();
     mocks.createWorkspaceConnectionSnapshotLoader.mockReset();
     mocks.deleteSecrets.mockReset();
     mocks.getIntegrationConnectionById.mockReset();
@@ -155,6 +133,20 @@ describe('defaultModules', () => {
     mocks.buildAgentToolCatalogs.mockResolvedValue(new Map());
     mocks.buildAgentToolSelectionCatalogs.mockResolvedValue(new Map());
     mocks.createWorkspaceConnectionSnapshotLoader.mockReturnValue(vi.fn());
+    mocks.createAuthModule.mockReturnValue({
+      name: 'auth',
+      interModulePresentations: [
+        {
+          contract: authInterModuleContract,
+          handlers: {
+            mintJobLeaseToken: vi.fn(),
+            mintRunnerSessionToken: vi.fn(),
+            getCurrentAdminRole: vi.fn(),
+            requireAdminRole: vi.fn(),
+          },
+        },
+      ],
+    });
     mocks.deleteSecrets.mockResolvedValue({deleted: 1});
     mocks.getSecret.mockResolvedValue({value: 'secret'});
     mocks.listMembershipsForTokenClaims.mockResolvedValue({memberships: []});
@@ -165,6 +157,7 @@ describe('defaultModules', () => {
       interModulePresentations: [
         defineInterModulePresentation(projectsInterModuleContract, {
           getProjectById: () => ({project: null}),
+          getWorkspaceProjectCounts: () => ({counts: []}),
           requireProjectForWorkspace: () => ({
             project: {
               id: crypto.randomUUID(),
@@ -211,6 +204,7 @@ describe('defaultModules', () => {
             cancelJobs: vi.fn(),
             enqueueJobExecution: vi.fn(),
             getEffectiveRunnerToolCapabilities: vi.fn(),
+            getWorkspaceJobCounts: vi.fn(),
             getLeaseState: vi.fn(),
             releaseJobExecution: vi.fn(),
           },
@@ -241,6 +235,22 @@ describe('defaultModules', () => {
       ],
     });
     mocks.createTriggersModule.mockReturnValue({name: 'triggers'});
+    mocks.createWorkspacesModule.mockReturnValue({
+      name: 'workspaces',
+      interModulePresentations: [
+        {
+          contract: workspacesInterModuleContract,
+          handlers: {
+            listMembershipsForTokenClaims: mocks.listMembershipsForTokenClaims,
+            getWorkspaceCreator: mocks.getWorkspaceCreator,
+            getWorkspaceOperatingState: mocks.getWorkspaceOperatingState,
+            preflightInvitationAcceptance: vi.fn(),
+            acceptInvitation: vi.fn(),
+            requireActiveMembership: vi.fn(),
+          },
+        },
+      ],
+    });
   });
 
   it('returns the API modules in lifecycle order', async () => {
@@ -291,6 +301,43 @@ describe('defaultModules', () => {
     expect(mocks.createRunnersModule).toHaveBeenCalledWith({auth: expect.any(Object)});
   });
 
+  it('uses the default Auth module factory when none is supplied', async () => {
+    await defaultModules();
+
+    expect(mocks.createAuthModule).toHaveBeenCalledWith({workspaces: expect.any(Object)});
+  });
+
+  it('composes Auth with the shared Workspaces client and registers the supplied module', async () => {
+    const signupPolicy = {isSignupAllowed: vi.fn().mockResolvedValue({allowed: true})};
+    const customAuthModule = mocks.createAuthModule();
+    mocks.createAuthModule.mockClear();
+    let extensionWorkspaces: WorkspacesInterModuleClient | undefined;
+    const extension = vi.fn(({workspaces}: {workspaces: WorkspacesInterModuleClient}) => {
+      extensionWorkspaces = workspaces;
+      return [];
+    });
+    const authModule = vi.fn(({workspaces}: {workspaces: WorkspacesInterModuleClient}) =>
+      mocks.createAuthModule({workspaces, signupPolicy}),
+    );
+
+    const modules = await defaultModules({authModule, extension});
+    const authWorkspaces = authModule.mock.calls[0]?.[0].workspaces;
+
+    expect(authModule).toHaveBeenCalledWith({workspaces: expect.any(Object)});
+    expect(mocks.createAuthModule).toHaveBeenCalledWith({
+      workspaces: authWorkspaces,
+      signupPolicy,
+    });
+    expect(extension).toHaveBeenCalledWith({workspaces: authWorkspaces});
+    expect(extensionWorkspaces).toBe(authWorkspaces);
+    expect(modules).toContain(customAuthModule);
+    expect(
+      modules.flatMap((module) =>
+        (module.interModulePresentations ?? []).map(({contract}) => contract.module),
+      ),
+    ).toContain(authInterModuleContract.module);
+  });
+
   it('lets a host replace only the Runners module with the composed Auth client', async () => {
     const policy = {filterEligibleWorkspaceIds: vi.fn().mockResolvedValue(new Set<string>())};
     const runnersModule = mocks.createRunnersModule({});

package/src/modules.ts

@@ -24,7 +24,7 @@ import {secretsInterModuleContract} from '@shipfox/api-secrets-dto/inter-module'
 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 {createWorkspacesModule} from '@shipfox/api-workspaces';
 import {
   type WorkspacesInterModuleClient,
   workspacesInterModuleContract,
@@ -40,10 +40,14 @@ import {logger} from '@shipfox/node-opentelemetry';
 
 export interface DefaultModulesOptions {
   webhookDeliverySource?: WebhookDeliverySource | undefined;
+  authModule?: DefaultAuthModuleFactory | undefined;
   runnersModule?: DefaultRunnersModuleFactory | undefined;
   extension?: DefaultModulesExtension | undefined;
 }
 
+export type DefaultAuthModuleFactory = (options: {
+  workspaces: WorkspacesInterModuleClient;
+}) => ShipfoxModule;
 export type DefaultRunnersModuleFactory = (options: {auth: AuthInterModuleClient}) => ShipfoxModule;
 export type DefaultModulesExtension = (options: {
   workspaces: WorkspacesInterModuleClient;
@@ -165,8 +169,8 @@ export async function defaultModules(
 
   const modules = [
     emailChallengesModule,
-    createAuthModule({workspaces: workspacesClient}),
-    workspacesModule,
+    (options.authModule ?? createAuthModule)({workspaces: workspacesClient}),
+    createWorkspacesModule({auth: authClient, projects: projectsClient, runners: runnersClient}),
     createSecretsModule(projectsClient),
     createAgentModule({secrets: secretsClient}),
     integrations.module,
@@ -180,6 +184,7 @@ export async function defaultModules(
       projects: projectsClient,
       runners: runnersClient,
       secrets: secretsClient,
+      workspaces: workspacesClient,
       integrations: integrationsClient,
     }),
     annotationsModule,