fix(auth-admin-api): Add missing xroad config to auth admin api

[saevarma]

What

Add missing xroad variables in auth admin api infra

Why

To fix auth admin api.

Screenshots / Gifs

Attach Screenshots / Gifs to help reviewers understand the scope of the pull request

Checklist:

• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• Formatting passes locally with my changes
• I have rebased against main before asking for a review

Summary by CodeRabbit

• New Features

  • Enhanced integration with the X-Road framework, allowing for more robust service interactions.
  • Added new environment variables for improved configuration and secure communication with X-Road services across development, staging, and production environments.

• Bug Fixes

  • Adjusted service configuration to utilize additional foundational and client-specific functionalities.

[coderabbitai]

Walkthrough

The pull request includes modifications to the auth-admin-api.ts file, enhancing the configuration of the xroad service by adding new entities to the import statements and updating the service setup. Additionally, new environment variables related to X-Road integration have been introduced across three configuration files: values.dev.yaml, values.prod.yaml, and values.staging.yaml. These changes aim to improve the API's capabilities for secure communication and integration with the X-Road framework.

Changes

File Path	Change Summary
apps/services/auth/admin-api/infra/auth-admin-api.ts	Updated import statements to include Base and Client, and modified .xroad configuration to include these new entities.
charts/identity-server/values.dev.yaml	Added new environment variables for X-Road configuration: XROAD_BASE_PATH, XROAD_BASE_PATH_WITH_ENV, XROAD_CLIENT_ID, XROAD_TLS_BASE_PATH, XROAD_TLS_BASE_PATH_WITH_ENV.
charts/identity-server/values.prod.yaml	Added new environment variables for X-Road configuration similar to the dev file.
charts/identity-server/values.staging.yaml	Added new environment variables for X-Road configuration similar to the dev file.

Assessment against linked issues

Objective	Addressed	Explanation
Enhance integration with X-Road services (undefined)	✅

Possibly related issues

• None

Possibly related PRs

• feat(auth-admin): Delegation admin module #15867: This PR relates to the xroad service configuration enhancements, aligning with the changes made in this PR.
• fix(chore): missing env for application system #15926: This PR's modifications to the serviceSetup function suggest a similar expansion of service capabilities through X-Road integration.

Suggested labels

automerge

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 128e557 and 9f73909.

Files selected for processing (4)

• apps/services/auth/admin-api/infra/auth-admin-api.ts (2 hunks)
• charts/identity-server/values.dev.yaml (1 hunks)
• charts/identity-server/values.prod.yaml (1 hunks)
• charts/identity-server/values.staging.yaml (1 hunks)

Additional context used

Path-based instructions (1)

apps/services/auth/admin-api/infra/auth-admin-api.ts (2)

Pattern apps/services/**/*: "Confirm that the code adheres to the following:

• NestJS architecture, including modules, services, and controllers.
• Dependency injection patterns and service encapsulation.
• Integration and unit testing coverage and practices."

---

Pattern apps/**/*: "Confirm that the code adheres to the following:

• NextJS best practices, including file structure, API routes, and static generation methods.
• Efficient state management and server-side rendering techniques.
• Optimal use of TypeScript for component and utility type safety."

Additional comments not posted (10)

apps/services/auth/admin-api/infra/auth-admin-api.ts (3)

7-7: LGTM!

The import statement change is necessary to support the configuration change in the serviceSetup function. The addition of Base and Client is consistent with the PR objective of adding missing X-Road configuration variables.

---

70-70: Verify the impact of the X-Road configuration change.

The .xroad configuration change is consistent with the PR objective and reflects an expansion of the service's integration with the X-Road framework. However, this change may have an impact on the existing functionality.

Please ensure that the change is thoroughly tested, including:

• Unit tests to verify the correct initialization of the X-Road clients.
• Integration tests to confirm the successful interaction with the X-Road services.
• End-to-end tests to validate the overall functionality of the auth admin API.

---

Line range hint 1-112: Verify the X-Road configuration change.

To ensure that the X-Road configuration change is correctly applied and the service is functioning as expected, please run the following verification script:

The script performs the following checks:

1. Verifies that the Base and Client imports are present and used in the file.
2. Confirms that the .xroad configuration includes Base, Client, and RskProcuring.

If any of the checks fail, the script will output an error message and exit with a non-zero status code.

Please run this script and ensure that it passes before merging the PR.

Verification successful

---

X-Road configuration change verified successfully.

The verification script confirmed that the Base and Client imports are present and used, and the .xroad configuration includes Base, Client, and RskProcuring. The X-Road configuration change is correctly applied in the auth-admin-api service.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash

echo "Verifying X-Road configuration change in auth-admin-api service..."

# Check if the Base and Client imports are used in the file
if ! grep -q "Base" apps/services/auth/admin-api/infra/auth-admin-api.ts || 
   ! grep -q "Client" apps/services/auth/admin-api/infra/auth-admin-api.ts; then
  echo "ERROR: Base and Client imports are missing or not used in the file."
  exit 1
fi

# Check if the .xroad configuration includes Base, Client, and RskProcuring
if ! grep -q ".xroad(Base, Client, RskProcuring)" apps/services/auth/admin-api/infra/auth-admin-api.ts; then
  echo "ERROR: .xroad configuration does not include Base, Client, and RskProcuring."
  exit 1
fi

echo "X-Road configuration change verified successfully."

Length of output: 491

charts/identity-server/values.prod.yaml (5)

224-224: Verify if using http instead of https for the X-Road security server URL is intentional.

The addition of the XROAD_BASE_PATH environment variable with the value http://securityserver.island.is looks good. However, using the http protocol instead of https for the security server URL might be a security concern. Please confirm if this is intentional or if https should be used instead to ensure secure communication with the X-Road security server.

---

225-225: Verify if using http instead of https for the X-Road security server URL with environment path is intentional.

The addition of the XROAD_BASE_PATH_WITH_ENV environment variable with the value http://securityserver.island.is/r1/IS looks good. However, similar to the previous comment, using the http protocol instead of https for the security server URL might be a security concern. Please confirm if this is intentional or if https should be used instead to ensure secure communication with the X-Road security server.

---

226-226: LGTM!

The addition of the XROAD_CLIENT_ID environment variable with the value IS/GOV/5501692829/island-is-client looks good. The client identifier follows the expected format of INSTANCE/MEMBER_CLASS/MEMBER_CODE/SUBSYSTEM_CODE.

---

233-233: LGTM!

The addition of the XROAD_TLS_BASE_PATH environment variable with the value https://securityserver.island.is looks good. Using the https protocol ensures secure communication with the X-Road security server.

---

234-234: LGTM!

The addition of the XROAD_TLS_BASE_PATH_WITH_ENV environment variable with the value https://securityserver.island.is/r1/IS looks good. Using the https protocol ensures secure communication with the X-Road security server.

charts/identity-server/values.staging.yaml (1)

227-237: LGTM! The added X-Road configuration variables are necessary for the staging environment.

The new environment variables XROAD_BASE_PATH, XROAD_BASE_PATH_WITH_ENV, XROAD_CLIENT_ID, XROAD_TLS_BASE_PATH, and XROAD_TLS_BASE_PATH_WITH_ENV are added to facilitate connections to the X-Road security server in the staging environment.

These variables provide the necessary HTTP and HTTPS endpoints along with the specific client ID (IS-TEST/GOV/5501692829/island-is-client) for X-Road integration in the staging setup. The inclusion of these variables enhances the configuration by specifying the paths and identifiers required for secure communication and service interactions within the staging environment.

charts/identity-server/values.dev.yaml (1)

227-237: The addition of X-Road configuration variables looks good!

The new environment variables for X-Road integration are formatted correctly and the values seem appropriate for the dev environment.

To ensure the integration works as expected, please verify that these variables are being used correctly in the application code. You can use the following script to search for the usage of these variables:

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[brynjarorng]

LGTM