@shipfox/api-runners 4.0.0 → 6.0.0

package/dist/presentation/routes/reconcile-provisioned-runners.js

@@ -1,27 +0,0 @@
-import { requireProvisionerContext } from '@shipfox/api-auth-context';
-import { reconcileProvisionedRunnersBodySchema, reconcileProvisionedRunnersResponseSchema } from '@shipfox/api-runners-dto';
-import { defineRoute } from '@shipfox/node-fastify';
-import { reconcileProvisionedRunners } from '#core/index.js';
-import { toReconcileProvisionedRunnersResponseDto } from '#presentation/dto/index.js';
-export const reconcileProvisionedRunnersRoute = defineRoute({
-    method: 'POST',
-    path: '/provisioned-runners/reconcile',
-    description: 'Reconcile provisioned runner state for a provisioner',
-    schema: {
-        body: reconcileProvisionedRunnersBodySchema,
-        response: {
-            200: reconcileProvisionedRunnersResponseSchema
-        }
-    },
-    handler: async (request)=>{
-        const { provisionerTokenId, workspaceId } = requireProvisionerContext(request);
-        const result = await reconcileProvisionedRunners({
-            workspaceId,
-            provisionerId: provisionerTokenId,
-            observedProvisionedRunnerIds: request.body.observed_provisioned_runner_ids
-        });
-        return toReconcileProvisionedRunnersResponseDto(result);
-    }
-});
-
-//# sourceMappingURL=reconcile-provisioned-runners.js.map

package/dist/presentation/routes/reconcile-provisioned-runners.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/presentation/routes/reconcile-provisioned-runners.ts"],"sourcesContent":["import {requireProvisionerContext} from '@shipfox/api-auth-context';\nimport {\n  reconcileProvisionedRunnersBodySchema,\n  reconcileProvisionedRunnersResponseSchema,\n} from '@shipfox/api-runners-dto';\nimport {defineRoute} from '@shipfox/node-fastify';\nimport {reconcileProvisionedRunners} from '#core/index.js';\nimport {toReconcileProvisionedRunnersResponseDto} from '#presentation/dto/index.js';\n\nexport const reconcileProvisionedRunnersRoute = defineRoute({\n  method: 'POST',\n  path: '/provisioned-runners/reconcile',\n  description: 'Reconcile provisioned runner state for a provisioner',\n  schema: {\n    body: reconcileProvisionedRunnersBodySchema,\n    response: {\n      200: reconcileProvisionedRunnersResponseSchema,\n    },\n  },\n  handler: async (request) => {\n    const {provisionerTokenId, workspaceId} = requireProvisionerContext(request);\n    const result = await reconcileProvisionedRunners({\n      workspaceId,\n      provisionerId: provisionerTokenId,\n      observedProvisionedRunnerIds: request.body.observed_provisioned_runner_ids,\n    });\n\n    return toReconcileProvisionedRunnersResponseDto(result);\n  },\n});\n"],"names":["requireProvisionerContext","reconcileProvisionedRunnersBodySchema","reconcileProvisionedRunnersResponseSchema","defineRoute","reconcileProvisionedRunners","toReconcileProvisionedRunnersResponseDto","reconcileProvisionedRunnersRoute","method","path","description","schema","body","response","handler","request","provisionerTokenId","workspaceId","result","provisionerId","observedProvisionedRunnerIds","observed_provisioned_runner_ids"],"mappings":"AAAA,SAAQA,yBAAyB,QAAO,4BAA4B;AACpE,SACEC,qCAAqC,EACrCC,yCAAyC,QACpC,2BAA2B;AAClC,SAAQC,WAAW,QAAO,wBAAwB;AAClD,SAAQC,2BAA2B,QAAO,iBAAiB;AAC3D,SAAQC,wCAAwC,QAAO,6BAA6B;AAEpF,OAAO,MAAMC,mCAAmCH,YAAY;IAC1DI,QAAQ;IACRC,MAAM;IACNC,aAAa;IACbC,QAAQ;QACNC,MAAMV;QACNW,UAAU;YACR,KAAKV;QACP;IACF;IACAW,SAAS,OAAOC;QACd,MAAM,EAACC,kBAAkB,EAAEC,WAAW,EAAC,GAAGhB,0BAA0Bc;QACpE,MAAMG,SAAS,MAAMb,4BAA4B;YAC/CY;YACAE,eAAeH;YACfI,8BAA8BL,QAAQH,IAAI,CAACS,+BAA+B;QAC5E;QAEA,OAAOf,yCAAyCY;IAClD;AACF,GAAG"}

package/dist/presentation/routes/report-provisioned-runners.d.ts

@@ -1,2 +0,0 @@
-export declare const reportProvisionedRunnersRoute: import("@shipfox/node-fastify").RouteDefinition;
-//# sourceMappingURL=report-provisioned-runners.d.ts.map

package/dist/presentation/routes/report-provisioned-runners.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"report-provisioned-runners.d.ts","sourceRoot":"","sources":["../../../src/presentation/routes/report-provisioned-runners.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,6BAA6B,iDA8BxC,CAAC"}

package/dist/presentation/routes/report-provisioned-runners.js

@@ -1,37 +0,0 @@
-import { requireProvisionerContext } from '@shipfox/api-auth-context';
-import { reportProvisionedRunnersBodySchema, reportProvisionedRunnersResponseSchema } from '@shipfox/api-runners-dto';
-import { defineRoute } from '@shipfox/node-fastify';
-import { reportProvisionedRunners } from '#core/index.js';
-import { toReportProvisionedRunnersResponseDto } from '#presentation/dto/index.js';
-export const reportProvisionedRunnersRoute = defineRoute({
-    method: 'POST',
-    path: '/provisioned-runners/report',
-    description: 'Report provisioned runner lifecycle state',
-    schema: {
-        body: reportProvisionedRunnersBodySchema,
-        response: {
-            200: reportProvisionedRunnersResponseSchema
-        }
-    },
-    handler: async (request)=>{
-        const { provisionerTokenId, workspaceId } = requireProvisionerContext(request);
-        const result = await reportProvisionedRunners({
-            workspaceId,
-            provisionerId: provisionerTokenId,
-            events: request.body.events.map((event)=>({
-                    provisionedRunnerId: event.provisioned_runner_id,
-                    reservationId: event.reservation_id ?? null,
-                    templateKey: event.template_key ?? null,
-                    labels: event.labels,
-                    state: event.state,
-                    reason: event.reason ?? null,
-                    runnerSessionId: event.runner_session_id ?? null,
-                    providerKind: event.provider_kind ?? null,
-                    reportedAt: new Date(event.reported_at)
-                }))
-        });
-        return toReportProvisionedRunnersResponseDto(result);
-    }
-});
-
-//# sourceMappingURL=report-provisioned-runners.js.map

package/dist/presentation/routes/report-provisioned-runners.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/presentation/routes/report-provisioned-runners.ts"],"sourcesContent":["import {requireProvisionerContext} from '@shipfox/api-auth-context';\nimport {\n  reportProvisionedRunnersBodySchema,\n  reportProvisionedRunnersResponseSchema,\n} from '@shipfox/api-runners-dto';\nimport {defineRoute} from '@shipfox/node-fastify';\nimport {reportProvisionedRunners} from '#core/index.js';\nimport {toReportProvisionedRunnersResponseDto} from '#presentation/dto/index.js';\n\nexport const reportProvisionedRunnersRoute = defineRoute({\n  method: 'POST',\n  path: '/provisioned-runners/report',\n  description: 'Report provisioned runner lifecycle state',\n  schema: {\n    body: reportProvisionedRunnersBodySchema,\n    response: {\n      200: reportProvisionedRunnersResponseSchema,\n    },\n  },\n  handler: async (request) => {\n    const {provisionerTokenId, workspaceId} = requireProvisionerContext(request);\n    const result = await reportProvisionedRunners({\n      workspaceId,\n      provisionerId: provisionerTokenId,\n      events: request.body.events.map((event) => ({\n        provisionedRunnerId: event.provisioned_runner_id,\n        reservationId: event.reservation_id ?? null,\n        templateKey: event.template_key ?? null,\n        labels: event.labels,\n        state: event.state,\n        reason: event.reason ?? null,\n        runnerSessionId: event.runner_session_id ?? null,\n        providerKind: event.provider_kind ?? null,\n        reportedAt: new Date(event.reported_at),\n      })),\n    });\n\n    return toReportProvisionedRunnersResponseDto(result);\n  },\n});\n"],"names":["requireProvisionerContext","reportProvisionedRunnersBodySchema","reportProvisionedRunnersResponseSchema","defineRoute","reportProvisionedRunners","toReportProvisionedRunnersResponseDto","reportProvisionedRunnersRoute","method","path","description","schema","body","response","handler","request","provisionerTokenId","workspaceId","result","provisionerId","events","map","event","provisionedRunnerId","provisioned_runner_id","reservationId","reservation_id","templateKey","template_key","labels","state","reason","runnerSessionId","runner_session_id","providerKind","provider_kind","reportedAt","Date","reported_at"],"mappings":"AAAA,SAAQA,yBAAyB,QAAO,4BAA4B;AACpE,SACEC,kCAAkC,EAClCC,sCAAsC,QACjC,2BAA2B;AAClC,SAAQC,WAAW,QAAO,wBAAwB;AAClD,SAAQC,wBAAwB,QAAO,iBAAiB;AACxD,SAAQC,qCAAqC,QAAO,6BAA6B;AAEjF,OAAO,MAAMC,gCAAgCH,YAAY;IACvDI,QAAQ;IACRC,MAAM;IACNC,aAAa;IACbC,QAAQ;QACNC,MAAMV;QACNW,UAAU;YACR,KAAKV;QACP;IACF;IACAW,SAAS,OAAOC;QACd,MAAM,EAACC,kBAAkB,EAAEC,WAAW,EAAC,GAAGhB,0BAA0Bc;QACpE,MAAMG,SAAS,MAAMb,yBAAyB;YAC5CY;YACAE,eAAeH;YACfI,QAAQL,QAAQH,IAAI,CAACQ,MAAM,CAACC,GAAG,CAAC,CAACC,QAAW,CAAA;oBAC1CC,qBAAqBD,MAAME,qBAAqB;oBAChDC,eAAeH,MAAMI,cAAc,IAAI;oBACvCC,aAAaL,MAAMM,YAAY,IAAI;oBACnCC,QAAQP,MAAMO,MAAM;oBACpBC,OAAOR,MAAMQ,KAAK;oBAClBC,QAAQT,MAAMS,MAAM,IAAI;oBACxBC,iBAAiBV,MAAMW,iBAAiB,IAAI;oBAC5CC,cAAcZ,MAAMa,aAAa,IAAI;oBACrCC,YAAY,IAAIC,KAAKf,MAAMgB,WAAW;gBACxC,CAAA;QACF;QAEA,OAAOhC,sCAAsCY;IAC/C;AACF,GAAG"}

package/src/core/provisioned-runners.ts

@@ -1,301 +0,0 @@
-import type {ProvisionedRunner, ProvisionedRunnerState} from '#core/entities/provisioned-runner.js';
-import {
-  isTerminalState,
-  listActiveProvisionedRunners,
-  listActiveRunningJobExecutions,
-  type ProvisionedRunnerReportEvent,
-  reconcileProvisionedRunners as reconcileProvisionedRunnersDb,
-  reportProvisionedRunners as reportProvisionedRunnersDb,
-} from '#db/index.js';
-import type {
-  ActiveRunningJobExecution,
-  ProvisionedRunnerBoundJobExecution,
-} from '#db/job-executions.js';
-import {
-  provisionedRunnerAbsentTerminatedCount,
-  provisionedRunnerReconcileCallCount,
-  provisionedRunnerReportCount,
-  provisionedRunnerTerminateIntentHonoredCount,
-  provisionedRunnerTerminateIntentIssuedCount,
-  reservationReleasedCount,
-} from '#metrics/instance.js';
-import {config} from '../config.js';
-
-export interface ReportProvisionedRunnersParams {
-  workspaceId: string;
-  provisionerId: string;
-  events: ProvisionedRunnerReportEvent[];
-}
-
-export interface ReportProvisionedRunnersResult {
-  accepted: number;
-  reservationsReleased: number;
-}
-
-export interface ReconcileProvisionedRunnersParams {
-  workspaceId: string;
-  provisionerId: string;
-  observedProvisionedRunnerIds: string[];
-}
-
-export type ReconcileDesiredIntent = 'keep' | 'terminate';
-type ReconcileDesiredIntentReason = 'job-cancelled' | 'terminal-state';
-
-export interface ReconciledBoundJobExecution {
-  jobId: string;
-  jobExecutionId: string;
-  workflowRunAttemptId: string;
-  lastHeartbeatAt: Date;
-  cancellationRequestedAt: Date | null;
-}
-
-export interface ReconciledProvisionedRunner {
-  provisionedRunnerId: string;
-  state: ProvisionedRunnerState | null;
-  reservationId: string | null;
-  runnerSessionId: string | null;
-  boundJobExecution: ReconciledBoundJobExecution | null;
-  desiredIntent: ReconcileDesiredIntent;
-  desiredIntentReason: ReconcileDesiredIntentReason | null;
-}
-
-export interface ReconcileProvisionedRunnersResult {
-  runners: ReconciledProvisionedRunner[];
-  terminatedAbsentProvisionedRunnerIds: string[];
-}
-
-export type ActiveRunnerState = 'starting' | 'running' | 'stopping' | 'busy';
-
-export interface ActiveRunner {
-  runnerSessionId: string | null;
-  provisionedRunnerId: string | null;
-  provisionerId: string | null;
-  state: ActiveRunnerState;
-  labels: string[];
-  templateKey: string | null;
-  providerKind: string | null;
-  jobId: string | null;
-  workflowRunAttemptId: string | null;
-  projectId: string | null;
-  reportedAt: Date | null;
-  lastHeartbeatAt: Date | null;
-}
-
-export async function reportProvisionedRunners(
-  params: ReportProvisionedRunnersParams,
-): Promise<ReportProvisionedRunnersResult> {
-  const result = await reportProvisionedRunnersDb(params);
-
-  for (const event of params.events) {
-    provisionedRunnerReportCount.add(1, {state: event.state});
-  }
-  for (const intent of result.terminateIntentsHonored) {
-    provisionedRunnerTerminateIntentHonoredCount.add(1, {reason: intent.reason});
-  }
-  if (result.reservationsReleased > 0) reservationReleasedCount.add(result.reservationsReleased);
-
-  return result;
-}
-
-export async function reconcileProvisionedRunners(
-  params: ReconcileProvisionedRunnersParams,
-): Promise<ReconcileProvisionedRunnersResult> {
-  const result = await reconcileProvisionedRunnersDb({
-    ...params,
-    terminateGraceSeconds: config.RUNNER_RECONCILE_TERMINATE_GRACE_SECONDS,
-  });
-
-  if (result.reservationsReleased > 0) reservationReleasedCount.add(result.reservationsReleased);
-  provisionedRunnerReconcileCallCount.add(1);
-  if (result.absentIds.length > 0)
-    provisionedRunnerAbsentTerminatedCount.add(result.absentIds.length);
-
-  const runners = reconcileProvisionedRunnersFromDbResult({
-    observedProvisionedRunnerIds: params.observedProvisionedRunnerIds,
-    observedRows: result.observedRows,
-    boundJobExecutionsByProvisionedRunnerId: result.boundJobExecutionsByProvisionedRunnerId,
-  });
-  for (const runner of runners) {
-    if (runner.desiredIntentReason) {
-      provisionedRunnerTerminateIntentIssuedCount.add(1, {
-        surface: 'reconcile',
-        reason: runner.desiredIntentReason,
-      });
-    }
-  }
-
-  return {
-    runners,
-    terminatedAbsentProvisionedRunnerIds: result.absentIds,
-  };
-}
-
-export function reconcileProvisionedRunnersFromDbResult(params: {
-  observedProvisionedRunnerIds: string[];
-  observedRows: ProvisionedRunner[];
-  boundJobExecutionsByProvisionedRunnerId: Map<string, ProvisionedRunnerBoundJobExecution>;
-}): ReconciledProvisionedRunner[] {
-  const rowsByProvisionedRunnerId = new Map(
-    params.observedRows.map((row) => [row.provisionedRunnerId, row]),
-  );
-
-  return params.observedProvisionedRunnerIds.map((provisionedRunnerId) => {
-    const row = rowsByProvisionedRunnerId.get(provisionedRunnerId);
-    const boundJobExecution =
-      params.boundJobExecutionsByProvisionedRunnerId.get(provisionedRunnerId);
-
-    const desiredIntentReason = getDesiredIntentReason(row, boundJobExecution);
-
-    return {
-      provisionedRunnerId,
-      state: row?.state ?? null,
-      reservationId: row?.reservationId ?? null,
-      runnerSessionId: row?.runnerSessionId ?? null,
-      boundJobExecution: boundJobExecution
-        ? toReconciledBoundJobExecution(boundJobExecution)
-        : null,
-      desiredIntent: desiredIntentReason ? 'terminate' : 'keep',
-      desiredIntentReason,
-    };
-  });
-}
-
-export async function listActiveRunners(params: {workspaceId: string}): Promise<ActiveRunner[]> {
-  const [provisionedRunnerRows, jobExecutionRows] = await Promise.all([
-    listActiveProvisionedRunners({
-      workspaceId: params.workspaceId,
-      windowSeconds: config.RUNNER_ACTIVE_WINDOW_SECONDS,
-    }),
-    listActiveRunningJobExecutions({
-      workspaceId: params.workspaceId,
-      windowSeconds: config.RUNNER_ACTIVE_WINDOW_SECONDS,
-    }),
-  ]);
-
-  return mergeActiveRunners(provisionedRunnerRows, jobExecutionRows);
-}
-
-function toReconciledBoundJobExecution(
-  jobExecution: ProvisionedRunnerBoundJobExecution,
-): ReconciledBoundJobExecution {
-  return {
-    jobId: jobExecution.jobId,
-    jobExecutionId: jobExecution.jobExecutionId,
-    workflowRunAttemptId: jobExecution.workflowRunAttemptId,
-    lastHeartbeatAt: jobExecution.lastHeartbeatAt,
-    cancellationRequestedAt: jobExecution.cancellationRequestedAt,
-  };
-}
-
-export function desiredIntent(
-  row: ProvisionedRunner | undefined,
-  boundJobExecution: ProvisionedRunnerBoundJobExecution | undefined,
-): ReconcileDesiredIntent {
-  return getDesiredIntentReason(row, boundJobExecution) ? 'terminate' : 'keep';
-}
-
-function getDesiredIntentReason(
-  row: ProvisionedRunner | undefined,
-  boundJobExecution: ProvisionedRunnerBoundJobExecution | undefined,
-): ReconcileDesiredIntentReason | null {
-  if (!row) return null;
-  if (isTerminalState(row.state)) return 'terminal-state';
-  if (boundJobExecution?.cancellationRequestedAt) return 'job-cancelled';
-  return null;
-}
-
-function mergeActiveRunners(
-  provisionedRunners: ProvisionedRunner[],
-  jobExecutions: ActiveRunningJobExecution[],
-): ActiveRunner[] {
-  const jobExecutionsByRunnerSessionId = new Map<string, ActiveRunningJobExecution[]>();
-  const jobExecutionsByProvisionedRunnerId = new Map<string, ActiveRunningJobExecution[]>();
-  for (const jobExecution of jobExecutions) {
-    const runnerJobExecutions =
-      jobExecutionsByRunnerSessionId.get(jobExecution.runnerSessionId) ?? [];
-    runnerJobExecutions.push(jobExecution);
-    jobExecutionsByRunnerSessionId.set(jobExecution.runnerSessionId, runnerJobExecutions);
-
-    if (jobExecution.provisionerId && jobExecution.provisionedRunnerId) {
-      const key = provisionedRunnerKey(
-        jobExecution.provisionerId,
-        jobExecution.provisionedRunnerId,
-      );
-      const provisionedRunnerJobExecutions = jobExecutionsByProvisionedRunnerId.get(key) ?? [];
-      provisionedRunnerJobExecutions.push(jobExecution);
-      jobExecutionsByProvisionedRunnerId.set(key, provisionedRunnerJobExecutions);
-    }
-  }
-
-  const merged: ActiveRunner[] = [];
-  const usedJobExecutionIds = new Set<string>();
-
-  for (const provisionedRunner of provisionedRunners) {
-    const provisionedRunnerJobExecutions =
-      jobExecutionsByProvisionedRunnerId.get(
-        provisionedRunnerKey(
-          provisionedRunner.provisionerId,
-          provisionedRunner.provisionedRunnerId,
-        ),
-      ) ??
-      (provisionedRunner.runnerSessionId
-        ? jobExecutionsByRunnerSessionId.get(provisionedRunner.runnerSessionId)
-        : undefined);
-    if (!provisionedRunnerJobExecutions || provisionedRunnerJobExecutions.length === 0) {
-      merged.push(toActiveRunner(provisionedRunner, undefined));
-      continue;
-    }
-
-    let emitted = false;
-    for (const jobExecution of provisionedRunnerJobExecutions) {
-      if (usedJobExecutionIds.has(jobExecution.jobExecutionId)) continue;
-      usedJobExecutionIds.add(jobExecution.jobExecutionId);
-      merged.push(toActiveRunner(provisionedRunner, jobExecution));
-      emitted = true;
-    }
-    if (!emitted) merged.push(toActiveRunner(provisionedRunner, undefined));
-  }
-
-  for (const jobExecution of jobExecutions) {
-    if (usedJobExecutionIds.has(jobExecution.jobExecutionId)) continue;
-    merged.push(toActiveRunner(undefined, jobExecution));
-  }
-
-  return merged.sort(compareActiveRunners);
-}
-
-function provisionedRunnerKey(provisionerId: string, provisionedRunnerId: string): string {
-  return `${provisionerId}:${provisionedRunnerId}`;
-}
-
-function toActiveRunner(
-  provisionedRunner: ProvisionedRunner | undefined,
-  jobExecution: ActiveRunningJobExecution | undefined,
-): ActiveRunner {
-  return {
-    runnerSessionId: provisionedRunner?.runnerSessionId ?? jobExecution?.runnerSessionId ?? null,
-    provisionedRunnerId:
-      provisionedRunner?.provisionedRunnerId ?? jobExecution?.provisionedRunnerId ?? null,
-    provisionerId: provisionedRunner?.provisionerId ?? jobExecution?.provisionerId ?? null,
-    state: jobExecution ? 'busy' : toActiveRunnerState(provisionedRunner?.state ?? 'running'),
-    labels: provisionedRunner?.labels ?? jobExecution?.runnerLabels ?? [],
-    templateKey: provisionedRunner?.templateKey ?? null,
-    providerKind: provisionedRunner?.providerKind ?? null,
-    jobId: jobExecution?.jobId ?? null,
-    workflowRunAttemptId: jobExecution?.workflowRunAttemptId ?? null,
-    projectId: jobExecution?.projectId ?? null,
-    reportedAt: provisionedRunner?.reportedAt ?? null,
-    lastHeartbeatAt: jobExecution?.lastHeartbeatAt ?? null,
-  };
-}
-
-function toActiveRunnerState(state: ProvisionedRunnerState): ActiveRunnerState {
-  if (state === 'starting' || state === 'stopping') return state;
-  return 'running';
-}
-
-function compareActiveRunners(a: ActiveRunner, b: ActiveRunner): number {
-  const aTime = Math.max(a.lastHeartbeatAt?.getTime() ?? 0, a.reportedAt?.getTime() ?? 0);
-  const bTime = Math.max(b.lastHeartbeatAt?.getTime() ?? 0, b.reportedAt?.getTime() ?? 0);
-  return bTime - aTime;
-}