Develop

[saadmoumou]

Summary

• What does this PR change?

Why

• Why is this change needed?

Checklist

• Added/updated tests (if behavior changed)
• npm run lint passes
• npm run typecheck passes
• npm test passes
• npm run build passes
• Added a changeset (npx changeset) if this affects consumers

Notes

• Anything reviewers should pay attention to?

[Copilot]

Pull request overview

This PR repurposes the NestJS module template into @ciscode/health-kit, adding a health-check module with liveness/readiness endpoints, built-in indicators, and supporting tooling/CI configuration.

Changes:

• Added HealthKitModule + HealthService with /live and /ready endpoints and indicator orchestration.
• Introduced built-in health indicators (Postgres/Redis/HTTP) plus APIs for custom indicators (createIndicator, BaseHealthIndicator, @HealthIndicator).
• Updated repo configuration (TS path aliases, Jest thresholds/mappers, ESLint/lint-staged, workflows) to support the new package.

Reviewed changes

Copilot reviewed 35 out of 38 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
tsconfig.json	Adds TS path aliases for new interfaces/ and indicators/ modules.
tsconfig.build.json	Ensures build emits CommonJS with Node module resolution.
src/services/health.service.ts	Implements indicator orchestration and aggregates results.
src/services/health.service.spec.ts	Adds unit tests for liveness/readiness behavior and failure handling.
src/interfaces/health-indicator.interface.ts	Defines health indicator contract and result types.
src/indicators/redis.indicator.ts	Adds Redis PING-based health indicator.
src/indicators/redis.indicator.spec.ts	Tests Redis indicator success/error/timeout cases.
src/indicators/postgres.indicator.ts	Adds Postgres SELECT 1 health indicator.
src/indicators/postgres.indicator.spec.ts	Tests Postgres indicator success/error/timeout cases.
src/indicators/http.indicator.ts	Adds HTTP GET health indicator using fetch + AbortController timeout.
src/indicators/http.indicator.spec.ts	Tests HTTP indicator for 2xx/non-2xx/network errors/timeouts.
src/indicators/create-indicator.ts	Adds factory for inline custom indicators with timeout support.
src/indicators/create-indicator.spec.ts	Tests createIndicator behaviors including timeout/rejections.
src/indicators/base.indicator.ts	Adds base class helper for DI-based indicators.
src/indicators/base.indicator.spec.ts	Tests BaseHealthIndicator result helper behavior.
src/index.ts	Replaces template exports with health-kit public API exports.
src/health-kit.module.ts	Adds dynamic module wiring for endpoints + indicator registration (sync/async).
src/health-kit.module.spec.ts	Adds module-level tests for indicator registration and wiring.
src/decorators/health-indicator.decorator.ts	Adds decorator to tag indicators for liveness/readiness routing.
src/decorators/health-indicator.decorator.spec.ts	Tests decorator metadata behavior.
src/controllers/health.controller.ts	Adds controller factory for configured health route prefix.
src/controllers/health.controller.spec.ts	Tests controller behavior and 503 handling.
README.md	Replaces template README with package docs and usage examples.
package.json	Renames package, updates metadata/peers, keeps Changesets-based release scripts.
package-lock.json	Updates lockfile package name and dependency metadata.
lint-staged.config.mjs	Adds lint-staged config for prettier + eslint.
jest.config.ts	Raises global coverage thresholds and adds new moduleNameMapper aliases.
eslint.config.mjs	Updates ESLint flat config, adds import rules, sets ignores.
eslint.config.js	Removes duplicate/old ESLint config file.
CHANGELOG.md	Adds initial changelog for @ciscode/health-kit v0.1.0.
.husky/pre-commit	Simplifies pre-commit hook to run lint-staged.
.github/workflows/release-check.yml	Updates CI checks and makes Sonar steps unconditional + status reporting.
.github/workflows/publish.yml	Updates publish trigger and adds tag validation + provenance publishing.
.github/workflows/pr-validation.yml	Bumps Node version for PR validation workflow.
.github/dependabot.yml	Adds Dependabot config for npm dependencies.
.github/CODEOWNERS	Adds CODEOWNERS entry for repository.
.changeset/thick-maps-raise.md	Removes an old template changeset.
.changeset/config.json	Updates Changesets repo metadata to HealthKit.

[Copilot]

This module calls Reflect.getMetadata(...) below; without importing reflect-metadata in this file, consumers that import HealthKitModule via a deep import (or before the package entrypoint runs) can hit Reflect.getMetadata is not a function at runtime. Import reflect-metadata here (or switch to Nest’s metadata helpers such as SetMetadata/Reflector) to make the module self-contained.

[Copilot]

The JSDoc example uses HealthModule/MongoHealthIndicator, but the exported module in this package is HealthKitModule and there is no MongoHealthIndicator in this PR. Please update the example to reflect the actual public API so consumers don’t copy/paste broken code.

Suggested change

	* import { HealthModule } from '@ciscode/health-kit';
	* import { MongoHealthIndicator } from '@ciscode/health-kit';
	*
	* @Module({
	* imports: [
	* HealthModule.register({
	* path: 'health',
	* liveness: [],
	* readiness: [new MongoHealthIndicator(dataSource)],
	* import { Module } from '@nestjs/common';
	* import { HealthKitModule } from '@ciscode/health-kit';
	*
	* @Module({
	* imports: [
	* HealthKitModule.register({
	* path: 'health',
	* liveness: [],
	* readiness: [],

[Copilot]

When an indicator rejects/throws, the fallback name uses constructor.name, which will be unhelpful for factory-created indicators (e.g. createIndicator(...) returns a plain object so this becomes "Object"). Consider preferring an optional name property on the indicator instance (if present) or extending IHealthIndicator to include a name field, so failures are attributed correctly.

[Copilot]

The docs say "throws → indicator reports "down" with the error message", but check() currently lets exceptions/timeout rejections bubble (the returned promise rejects) instead of resolving a { status: 'down', message } result. Either adjust the docstring to match the current behavior or catch errors and return a down result (consistent with the built-in indicators).

[Copilot]

This test file contains garbled/invalid characters in comment separators (e.g. ÔöÇÔöÇ ...). This is likely an encoding artifact and should be replaced with normal ASCII so diffs remain readable and tooling doesn’t choke on non-UTF8 sequences.

[Copilot]

This publish workflow requires a v${package.json version} git tag to already exist, but the repo’s release flow uses Changesets (npm run release / changeset publish) which does not inherently create git tags. Unless tagging is guaranteed elsewhere, this step will block publishes; consider removing the tag requirement or generating/verifying tags as part of the Changesets release process instead.

[Copilot]

SonarCloud scan/quality gate now runs unconditionally on every PR to master. For PRs from forks, SONAR_TOKEN is not provided by GitHub, so these steps will fail and block merges. Add a guard (e.g. only run when secrets.SONAR_TOKEN is available or when the PR is from the same repo).

[Copilot]

Promise.race([ping, this._timeout()]) leaves the setTimeout pending even when ping() resolves quickly. This creates unnecessary timers (and can keep the event loop busy under frequent checks). Consider implementing a timeout helper that clearTimeouts on completion (similar to the HTTP indicator’s finally { clearTimeout(...) }).

[Copilot]

Same as Redis indicator: the timeout created in _timeout() is never cleared when the query succeeds, so each successful check still schedules a timer until it fires. Consider using a clearTimeout-based helper (or AbortSignal where applicable) to avoid accumulating unnecessary timers.

[Copilot]

The timeout setTimeout(...) is never cleared when run() finishes first, so successful indicators still leave a pending timer until it fires. Consider keeping the timeout handle and clearing it once run() settles to avoid unnecessary timers during frequent health checks.

Suggested change

	const timeoutPromise = new Promise<never>((_, reject) =>
	setTimeout(() => reject(new Error(`${name} timed out after ${timeout}ms`)), timeout),
	);
	return Promise.race([run(), timeoutPromise]);
	let timeoutHandle: ReturnType<typeof setTimeout>;
	const timeoutPromise = new Promise<never>((_, reject) => {
	timeoutHandle = setTimeout(() => reject(new Error(`${name} timed out after ${timeout}ms`)), timeout);
	});
	const runPromise = run().finally(() => clearTimeout(timeoutHandle));
	return Promise.race([runPromise, timeoutPromise]);

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud