Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions charts/platform-server/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ lifecycle: {}
livenessProbe:
enabled: true
httpGet:
path: /healthz
path: /health
port: http
initialDelaySeconds: 10
periodSeconds: 10
Expand All @@ -113,9 +113,9 @@ livenessProbe:
failureThreshold: 6

readinessProbe:
enabled: true
enabled: false
httpGet:
path: /readyz
path: /health
port: http
initialDelaySeconds: 5
periodSeconds: 10
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
import { FastifyAdapter } from '@nestjs/platform-fastify';
import { Test } from '@nestjs/testing';

import { HealthController } from '../../../src/infra/health/health.controller';
import {
DockerRunnerStatusService,
DockerRunnerStatusSnapshot,
} from '../../../src/infra/container/dockerRunnerStatus.service';

type DockerRunnerStub = {
getSnapshot: () => DockerRunnerStatusSnapshot;
};

const createApp = async (service?: DockerRunnerStub) => {
const moduleRef = await Test.createTestingModule({
controllers: [HealthController],
providers: [
{
provide: DockerRunnerStatusService,
useFactory: () => service as unknown as DockerRunnerStatusService | undefined,
},
],
}).compile();

const app = moduleRef.createNestApplication(new FastifyAdapter());
await app.init();
await app.getHttpAdapter().getInstance().ready();

return app;
};

describe('HealthController', () => {
it('returns docker runner snapshot when dependency is present', async () => {
const snapshot: DockerRunnerStatusSnapshot = {
status: 'up',
optional: false,
endpoint: 'grpc://runner:50051',
lastCheckedAt: new Date().toISOString(),
lastSuccessAt: new Date().toISOString(),
consecutiveFailures: 0,
};

const app = await createApp({
getSnapshot: () => snapshot,
});

try {
const response = await app.getHttpAdapter().getInstance().inject({
method: 'GET',
url: '/health',
});

expect(response.statusCode).toBe(200);
expect(response.headers['cache-control']).toBe('no-store');

const payload = JSON.parse(response.payload) as {
status: string;
timestamp: string;
checks: { dockerRunner: DockerRunnerStatusSnapshot };
};

expect(payload.status).toBe('ok');
expect(new Date(payload.timestamp).toString()).not.toBe('Invalid Date');
expect(payload.checks.dockerRunner).toEqual(snapshot);
} finally {
await app.close();
}
});

it('marks docker runner check as skipped when dependency is missing', async () => {
const app = await createApp();

try {
const response = await app.getHttpAdapter().getInstance().inject({
method: 'GET',
url: '/health',
});

expect(response.statusCode).toBe(200);

const payload = JSON.parse(response.payload) as {
checks: {
dockerRunner: {
status: string;
optional: boolean;
error?: { name?: string; message: string };
};
};
};

expect(payload.checks.dockerRunner.status).toBe('skipped');
expect(payload.checks.dockerRunner.optional).toBe(true);
expect(payload.checks.dockerRunner.error?.message).toContain('not registered');
} finally {
await app.close();
}
});

it('degrades docker runner check when dependency throws', async () => {
const app = await createApp({
getSnapshot: () => {
throw new Error('boom');
},
});

try {
const response = await app.getHttpAdapter().getInstance().inject({
method: 'GET',
url: '/health',
});

expect(response.statusCode).toBe(200);

const payload = JSON.parse(response.payload) as {
checks: {
dockerRunner: {
status: string;
optional: boolean;
error?: { name?: string; message: string };
};
};
};

expect(payload.checks.dockerRunner.status).toBe('error');
expect(payload.checks.dockerRunner.optional).toBe(true);
expect(payload.checks.dockerRunner.error?.message).toBe('boom');
} finally {
await app.close();
}
});
});
70 changes: 64 additions & 6 deletions packages/platform-server/src/infra/health/health.controller.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,76 @@
import { Controller, Get } from '@nestjs/common';
import { DockerRunnerStatusService } from '../container/dockerRunnerStatus.service';
import { Controller, Get, Header, Inject, Optional } from '@nestjs/common';
import { DockerRunnerStatusService, DockerRunnerStatusSnapshot } from '../container/dockerRunnerStatus.service';

type DegradedDockerRunnerCheck =
| {
status: 'skipped';
optional: true;
error?: { name?: string; message: string };
}
| {
status: 'error';
optional: true;
error: { name?: string; message: string };
};

type DockerRunnerCheck = DockerRunnerStatusSnapshot | DegradedDockerRunnerCheck;

@Controller()
export class HealthController {
constructor(private readonly dockerRunnerStatus: DockerRunnerStatusService) {}
constructor(
@Optional()
@Inject(DockerRunnerStatusService)
private readonly dockerRunnerStatus?: DockerRunnerStatusService,
) {}

@Get('health')
getHealth() {
@Header('Cache-Control', 'no-store')
getHealth(): { status: 'ok'; timestamp: string; checks: { dockerRunner: DockerRunnerCheck } } {
const dockerRunner = this.resolveDockerRunnerCheck();

return {
status: 'ok',
timestamp: new Date().toISOString(),
dependencies: {
dockerRunner: this.dockerRunnerStatus.getSnapshot(),
checks: {
dockerRunner,
},
};
}

private resolveDockerRunnerCheck(): DockerRunnerCheck {
if (!this.dockerRunnerStatus) {
return {
status: 'skipped',
optional: true,
error: {
name: 'DependencyUnavailable',
message: 'DockerRunnerStatusService not registered',
},
};
}

try {
return this.dockerRunnerStatus.getSnapshot();
} catch (error) {
return {
status: 'error',
optional: true,
error: HealthController.serializeError(error),
};
}
}

private static serializeError(error: unknown): { name?: string; message: string } {
if (error instanceof Error) {
return {
name: error.name,
message: error.message,
};
}

return {
name: 'Error',
message: typeof error === 'string' ? error : String(error),
};
}
}
Loading