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(application-system-api): Add missing national registry v3 xroad client config #16770

Merged
merged 4 commits into from
Nov 8, 2024

Conversation

thorkellmani
Copy link
Member

@thorkellmani thorkellmani commented Nov 8, 2024

What

  • Inject national registry v3 xroad config into application system api

Why

  • Seems like the client is being imported, but the config isn't.

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

Release Notes

  • New Features

    • Integration with National Registry B2C for user authentication and authorization across multiple services.
    • New environment variables added for seamless connectivity with the B2C identity service.
  • Improvements

    • Standardized health check configurations for enhanced service reliability.
    • Adjusted Horizontal Pod Autoscaler settings for improved scalability under load.
    • Updated ingress configurations for optimized traffic management.

These changes enhance the overall performance and user experience of the application.

@thorkellmani thorkellmani requested a review from a team as a code owner November 8, 2024 09:41
Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Walkthrough

The pull request introduces several updates across multiple configuration files and the application-system-api.ts file. A new export, NationalRegistryB2C, is added to the API, and it is incorporated into the workerSetup and serviceSetup functions. Additionally, multiple environment variables related to the National Registry B2C integration are added across various services in the YAML configuration files, along with standardized health check configurations and adjustments to Horizontal Pod Autoscaler settings.

Changes

File Path Change Summary
apps/application-system/api/infra/application-system-api.ts Added NationalRegistryB2C to import statements and included it in workerSetup and serviceSetup functions.
charts/islandis/values.dev.yaml Added environment variables for NATIONAL_REGISTRY_B2C_CLIENT_ID, NATIONAL_REGISTRY_B2C_ENDPOINT, NATIONAL_REGISTRY_B2C_PATH, and NATIONAL_REGISTRY_B2C_SCOPE across multiple services. Standardized health check configurations and adjusted HPA settings.
charts/islandis/values.prod.yaml Similar to values.dev.yaml, added environment variables for B2C integration and standardized health checks and HPA settings.
charts/islandis/values.staging.yaml Added environment variables for B2C, standardized health checks, adjusted resource specifications, and updated ingress annotations.

Possibly related PRs

Suggested labels

deploy-feature

Suggested reviewers

  • eirikurn
  • lodmfjord
  • thordurhhh
  • robertaandersen

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

@thorkellmani thorkellmani added the automerge Merge this PR as soon as all checks pass label Nov 8, 2024
Copy link
Member

@svanaeinars svanaeinars left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3445c32 and 6720460.

📒 Files selected for processing (4)
  • apps/application-system/api/infra/application-system-api.ts (2 hunks)
  • charts/islandis/values.dev.yaml (1 hunks)
  • charts/islandis/values.prod.yaml (1 hunks)
  • charts/islandis/values.staging.yaml (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
apps/application-system/api/infra/application-system-api.ts (1)

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."
🪛 Gitleaks
charts/islandis/values.dev.yaml

613-613: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

charts/islandis/values.prod.yaml

601-601: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

charts/islandis/values.staging.yaml

610-610: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (4)
apps/application-system/api/infra/application-system-api.ts (2)

39-39: LGTM: Import statement properly added

The NationalRegistryB2C import is correctly added to the existing xroad imports, maintaining alphabetical order and consistent formatting.


271-271: Verify required environment variables for NationalRegistryB2C

While the xroad client is properly added, the configuration appears to be missing the required environment variables mentioned in the AI summary (NATIONAL_REGISTRY_B2C_CLIENT_ID, NATIONAL_REGISTRY_B2C_ENDPOINT, NATIONAL_REGISTRY_B2C_PATH, NATIONAL_REGISTRY_B2C_SCOPE).

Let's verify if these environment variables are defined elsewhere:

✅ Verification successful

Environment variables for NationalRegistryB2C are properly configured

The required environment variables for NationalRegistryB2C are properly configured across the codebase:

  • All necessary variables (NATIONAL_REGISTRY_B2C_CLIENT_ID, NATIONAL_REGISTRY_B2C_ENDPOINT, NATIONAL_REGISTRY_B2C_PATH, NATIONAL_REGISTRY_B2C_SCOPE, NATIONAL_REGISTRY_B2C_CLIENT_SECRET) are defined in:
    • Configuration files (infra/src/dsl/xroad.ts)
    • Environment-specific values files (charts/islandis/values.{dev,staging,prod}.yaml)
    • Client configuration (libs/clients/national-registry/v3/src/lib/nationalRegistryV3.config.ts)

The implementation follows the established pattern and all required environment variables are properly set up.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for National Registry B2C environment variables in the codebase
echo "Searching for National Registry B2C environment variables..."
rg -i "NATIONAL_REGISTRY_B2C_" --type yaml

# Search for any references to these variables in the code
echo "Searching for references to these variables in the code..."
rg -i "nationalRegistryB2C" --type typescript

Length of output: 15746


Script:

#!/bin/bash
# Search for references to these variables in TypeScript/JavaScript files
echo "Searching for references to National Registry B2C in TypeScript/JavaScript files..."
rg -i "nationalRegistryB2C" -g "*.ts" -g "*.js" -A 3

# Search for environment variable definitions in TypeScript/JavaScript files
echo "Searching for environment variable definitions..."
rg -i "NATIONAL_REGISTRY_B2C_" -g "*.ts" -g "*.js" -A 3

Length of output: 13109

charts/islandis/values.prod.yaml (1)

601-604: Configuration pattern is consistently applied across services

The National Registry B2C configuration is correctly applied across multiple services (application-system-api, endorsement-system-api, regulations-admin-backend) with consistent values, which is good for maintainability. The configuration includes all necessary parameters:

  • Client ID
  • Endpoint
  • Path
  • Scope

Also applies to: 601-604, 601-604

🧰 Tools
🪛 Gitleaks

601-601: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

charts/islandis/values.dev.yaml (1)

613-616: Verify National Registry B2C configuration consistency

The National Registry B2C configuration has been added to multiple services. Let's verify the configuration is consistent across all services.

✅ Verification successful

National Registry B2C configuration is consistent across environments

The National Registry B2C configuration is properly configured and consistent across all environments (dev, staging, prod) in both the identity-server and islandis charts. Each environment has its appropriate:

  • Client IDs
  • Endpoints with correct domain names
  • Environment-specific paths (IS-DEV, IS-TEST, IS)
  • Matching scopes per environment
  • Consistent secret paths
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if National Registry B2C configuration is consistent across services

# Search for National Registry B2C configuration
echo "Checking National Registry B2C configuration consistency..."
rg "NATIONAL_REGISTRY_B2C_" -A 3

Length of output: 35577

🧰 Tools
🪛 Gitleaks

613-613: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

charts/islandis/values.staging.yaml Show resolved Hide resolved
charts/islandis/values.staging.yaml Show resolved Hide resolved
charts/islandis/values.prod.yaml Show resolved Hide resolved
charts/islandis/values.dev.yaml Show resolved Hide resolved
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.55%. Comparing base (3445c32) to head (6720460).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #16770   +/-   ##
=======================================
  Coverage   36.55%   36.55%           
=======================================
  Files        6892     6892           
  Lines      143767   143767           
  Branches    40964    40964           
=======================================
  Hits        52557    52557           
  Misses      91210    91210           
Flag Coverage Δ
judicial-system-backend 55.22% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3445c32...6720460. Read the comment docs.

@datadog-island-is
Copy link

Datadog Report

Branch report: fix/missing-nat-reg-v3-xroad-config
Commit report: 1dfbcc1
Test service: judicial-system-backend

✅ 0 Failed, 21110 Passed, 0 Skipped, 16m 15.98s Total Time
➡️ Test Sessions change in coverage: 1 no change

@AndesKrrrrrrrrrrr AndesKrrrrrrrrrrr added high priority VIP-Kodiak PR automerge Merge this PR as soon as all checks pass and removed automerge Merge this PR as soon as all checks pass labels Nov 8, 2024
@kodiakhq kodiakhq bot merged commit a2241ca into main Nov 8, 2024
27 checks passed
@kodiakhq kodiakhq bot deleted the fix/missing-nat-reg-v3-xroad-config branch November 8, 2024 11:09
jonnigs pushed a commit that referenced this pull request Nov 12, 2024
…lient config (#16770)

* fix: init

* chore: charts update dirty files

---------

Co-authored-by: andes-it <builders@andes.is>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Merge this PR as soon as all checks pass high priority VIP-Kodiak PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants