Add SERVICE_NAME env var and improve health check versioning

[nevil-mathew]

Summary by CodeRabbit

• New Features

  • Added SERVICE_NAME environment variable for service configuration.

• Chores

  • Version updated to 3.3.24.
  • Updated health check library dependency.
  • Health check responses now include actual package version information.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)

• develop

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The PR adds a SERVICE_NAME environment variable for health checks, updates health check implementation to dynamically read the package.json version instead of using a hard-coded value, removes version fields from health check responses, and bumps package version from 1.0.0 to 3.3.24 with updated dependencies.

Changes

Cohort / File(s)	Change Summary
Environment Configuration src/.env.sample, src/envVariables.js	Added SERVICE_NAME environment variable with default value 'UserService' and optional flag. Includes comment for health check service naming.
Health Check Implementation src/health-checks/health-check.js, src/health-checks/health.config.js	Removed hard-coded version field from configuration and responses. Updated health-check.js to read version from package.json and pass it to healthCheckHandler.
Dependencies src/package.json	Bumped package version from 1.0.0 to 3.3.24. Updated elevate-services-health-check dependency from ^0.0.6 to ^0.0.9.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Version handling change: Verify that dynamic version reading from package.json integrates correctly with the updated elevate-services-health-check dependency (^0.0.9).
• Dependency compatibility: Confirm that the health check implementation remains compatible with the new dependency version and that response payload changes align with expected formats.
• SERVICE_NAME propagation: Ensure the new SERVICE_NAME environment variable is properly utilized throughout the health check flow.

Possibly related PRs

• kafka-fix #862: Adds identical SERVICE_NAME environment variable configuration across the codebase, indicating coordinated environment setup changes.
• adding-version-from-package-file-for-healthCheck #864: Implements the same health check versioning refactor with identical changes to package.json version handling and health.config.js structure.
• change-in-version #803: Updates the elevate-services-health-check dependency version, sharing the same dependency bump pattern in package.json.

Poem

🐰 A version hops from hard-code's cage,
Now dancing free on package's page,
SERVICE_NAME joins the health-check call,
Dynamic versions serve them all,
From 1.0 to 3.3.24—spring! ✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[nevil-mathew]

@coderabbitai summary

[coderabbitai]

✅ Actions performed

Summary regeneration triggered.