Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(server): check for multi-region when retrieving all registered db… #3675

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

iainsproat
Copy link
Contributor

@iainsproat iainsproat commented Dec 11, 2024

Description & motivation

In servers which do not have multi-region enabled, the following error is thrown:

{
  "@l": "Error",
  "err":
    {
      "type": "MisconfiguredEnvironmentError",
      "message": "MULTI_REGION_CONFIG_PATH env var not configured",
      "stack": "MisconfiguredEnvironmentError: MULTI_REGION_CONFIG_PATH env var not configured\n    at getStringFromEnv (/speckle-server/packages/server/dist/modules/shared/helpers/envHelper.js:86:15)\n    at getMultiRegionConfigPath (/speckle-server/packages/server/dist/modules/shared/helpers/envHelper.js:428:12)\n    at getMultiRegionConfig (/speckle-server/packages/server/dist/modules/multiregion/regionConfig.js:33:71)\n    at getAvailableRegionConfig (/speckle-server/packages/server/dist/modules/multiregion/regionConfig.js:48:19)\n    at getRegisteredRegionConfigs (/speckle-server/packages/server/dist/modules/multiregion/utils/regionSelector.js:16:80)\n    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n    at async initializeRegisteredRegionClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:62:21)\n    at async getRegisteredRegionClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:77:35)\nat async getAllRegisteredDbClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:85:23)\n    at async updateFreeDbConnectionSamplers (/speckle-server/packages/server/dist/healthchecks/index.js:18:24)",
      "name": "MisconfiguredEnvironmentError",
      "jse_shortmsg": "MULTI_REGION_CONFIG_PATH env var not configured",
      "jse_info":
        { "code": "MISCONFIGURED_ENVIRONMENT_ERROR", "statusCode": 424 },
    },
  "@t": "2024-12-11T11:34:02.209Z",
  "@x": "MisconfiguredEnvironmentError: MULTI_REGION_CONFIG_PATH env var not configured\n    at getStringFromEnv (/speckle-server/packages/server/dist/modules/shared/helpers/envHelper.js:86:15)\n    at getMultiRegionConfigPath (/speckle-server/packages/server/dist/modules/shared/helpers/envHelper.js:428:12)\n    at getMultiRegionConfig (/speckle-server/packages/server/dist/modules/multiregion/regionConfig.js:33:71)\n    at getAvailableRegionConfig (/speckle-server/packages/server/dist/modules/multiregion/regionConfig.js:48:19)\n    at getRegisteredRegionConfigs (/speckle-server/packages/server/dist/modules/multiregion/utils/regionSelector.js:16:80)\n    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n    at async initializeRegisteredRegionClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:62:21)\n    at async getRegisteredRegionClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:77:35)\n    at async getAllRegisteredDbClients (/speckle-server/packages/server/dist/modules/multiregion/utils/dbSelector.js:85:23)\n    at async updateFreeDbConnectionSamplers (/speckle-server/packages/server/dist/healthchecks/index.js:18:24)",
  "@mt": "Failed to start server. Exiting with non-zero exit code...",
}

Retrieving all clients (getAllRegisteredDbClients) should handle both the non-multi-region and multi-region case.

Changes:

To-do before merge:

Screenshots:

Validation of changes:

Checklist:

  • My pull request follows the guidelines in the Contributing guide?
  • My pull request does not duplicate any other open Pull Requests for the same update/change?
  • My commits are related to the pull request and do not amend unrelated code or documentation.
  • My code follows a similar style to existing code.
  • I have added appropriate tests.
  • I have updated or added relevant documentation.

References

@gjedlicska gjedlicska merged commit 0a2bebd into main Dec 11, 2024
26 of 28 checks passed
@gjedlicska gjedlicska deleted the iain/fix-healthchecks-non-multi-region branch December 11, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants