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

CU_86byp4xw2: Add ability to register Reprocessor UI with core #307

Merged
merged 10 commits into from
May 29, 2024

Conversation

ItsMurumba
Copy link
Collaborator

@ItsMurumba ItsMurumba commented May 24, 2024

Summary by CodeRabbit

  • New Features

    • Added configuration settings for the "Reprocess" microfrontends app, including URL, access roles, and icon.
    • Enabled interaction with OpenHIM API for importing configurations and rebuilding import maps.
  • Updates

    • Updated Docker Compose configurations to use new environment variables for image versions.
    • Changed version references for the reprocess mediator and its UI to specific image references.
  • Chores

    • Changed default JSON formatter in VS Code settings for better compatibility.
    • Updated deployment script to include a call for deploying config importer.

Copy link
Contributor

coderabbitai bot commented May 24, 2024

Walkthrough

The updates introduce new configurations for the reprocess-mediator project, focusing on integrating with OpenHIM and refining deployment setups. Key changes include adding a Docker Compose configuration for importing OpenHIM settings, updating environment variables, and adjusting Docker image version references. Additionally, the openhimConfig.js script now handles HTTPS requests to interact with OpenHIM. Minor tweaks include modifying VS Code settings for JSON formatting.

Changes

Files Change Summary
reprocess-mediator/docker-compose.config.yml Introduces configurations for a container to execute config import scripts for OpenHIM channels.
reprocess-mediator/openhimConfig.js Adds functionality to interact with the OpenHIM API and import configurations using HTTPS requests.
reprocess-mediator/reprocess-ui-app.json Defines configuration settings for a microfrontends app named "Reprocess" in the HIE Configuration.
reprocess-mediator/docker-compose.yml Updates environment variables for image versions in the docker-compose.yml file.
reprocess-mediator/package-metadata.json Updates version references for the reprocess mediator and its UI.
reprocess-mediator/swarm.sh Adds a call to docker::deploy_config_importer in the initialize_package function.
.vscode/settings.json Changes the default formatter for JSON files and adjusts the formatting of the fileMatch array.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Docker
    participant Mediator
    participant OpenHIM

    User->>Docker: Start Docker Compose
    Docker->>Mediator: Deploy reprocess-mediator services
    Mediator->>OpenHIM: Make HTTPS requests to import configurations
    OpenHIM-->>Mediator: Acknowledge configurations
    Mediator-->>Docker: Services running with new configurations
    Docker-->>User: Deployment complete
Loading

Poem

In the land of code, where bytes do roam,
A mediator rises, finding its home.
With Docker's aid and OpenHIM's grace,
Configs are set in their rightful place.
JSON formatted, all neat and clear,
A digital dance, let’s give a cheer!
🐰✨🚀


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>.
    • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

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: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 679e2b6 and 3712680.
Files selected for processing (4)
  • reprocess-mediator/docker-compose.config.yml (1 hunks)
  • reprocess-mediator/openhimConfig.js (1 hunks)
  • reprocess-mediator/reprocess-ui-app.json (1 hunks)
  • reprocess-mediator/swarm.sh (1 hunks)
Files skipped from review due to trivial changes (1)
  • reprocess-mediator/reprocess-ui-app.json
Additional Context Used
Biome (5)
reprocess-mediator/openhimConfig.js (5)

1-1: A Node.js builtin module should be imported with the node: protocol.


2-2: A Node.js builtin module should be imported with the node: protocol.


3-3: A Node.js builtin module should be imported with the node: protocol.


18-18: Use === instead of ==.
== is only allowed when comparing against null


19-19: Do not use template literals if interpolation and special-character handling are not needed.

Additional comments not posted (5)
reprocess-mediator/docker-compose.config.yml (3)

5-20: The configuration for reprocess-config-importer is well-defined and uses environment variables effectively.


26-36: The configs section correctly maps the necessary configuration files into the service container.


38-42: The network configuration is appropriate, connecting the service to the necessary external network.

reprocess-mediator/swarm.sh (1)

49-49: The addition of docker::deploy_config_importer in initialize_package is correctly implemented to deploy the configuration importer service.

reprocess-mediator/openhimConfig.js (1)

42-72: The API request options are well-defined and the requests are correctly made using these options.

reprocess-mediator/openhimConfig.js Outdated Show resolved Hide resolved
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: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 3712680 and 8c31ca5.
Files selected for processing (4)
  • reprocess-mediator/docker-compose.yml (2 hunks)
  • reprocess-mediator/openhimConfig.js (1 hunks)
  • reprocess-mediator/package-metadata.json (1 hunks)
  • reprocess-mediator/swarm.sh (2 hunks)
Files skipped from review due to trivial changes (2)
  • reprocess-mediator/docker-compose.yml
  • reprocess-mediator/package-metadata.json
Files skipped from review as they are similar to previous changes (1)
  • reprocess-mediator/swarm.sh
Additional Context Used
Biome (4)
reprocess-mediator/openhimConfig.js (4)

1-1: A Node.js builtin module should be imported with the node: protocol.


2-2: A Node.js builtin module should be imported with the node: protocol.


3-3: A Node.js builtin module should be imported with the node: protocol.


18-18: Use === instead of ==.
== is only allowed when comparing against null

Additional comments not posted (6)
reprocess-mediator/openhimConfig.js (6)

7-11: Constants for OpenHIM configuration are well-defined and used appropriately.


16-34: The makeRequest function is well-structured and handles HTTPS requests and errors effectively.


37-40: JSON parsing and stringifying are handled correctly for configuration management.


42-69: The setup of HTTPS request options is secure and uses best practices.


71-72: API requests are correctly made to import and manage OpenHIM configurations.


19-19: Simplify the error message as it does not require template literals.

- throw new Error(`Incorrect OpenHIM API credentials`);
+ throw new Error("Incorrect OpenHIM API credentials");

Likely invalid or redundant comment.

reprocess-mediator/openhimConfig.js Show resolved Hide resolved
reprocess-mediator/openhimConfig.js Show resolved Hide resolved
@drizzentic drizzentic marked this pull request as draft May 24, 2024 10:45
@drizzentic drizzentic marked this pull request as ready for review May 24, 2024 11:08
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8c31ca5 and ebdedcd.
Files selected for processing (3)
  • .vscode/settings.json (1 hunks)
  • reprocess-mediator/package-metadata.json (1 hunks)
  • reprocess-mediator/reprocess-ui-app.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • .vscode/settings.json
Files skipped from review as they are similar to previous changes (2)
  • reprocess-mediator/package-metadata.json
  • reprocess-mediator/reprocess-ui-app.json

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between ebdedcd and 0a95208.
Files selected for processing (2)
  • reprocess-mediator/package-metadata.json (1 hunks)
  • reprocess-mediator/reprocess-ui-app.json (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • reprocess-mediator/package-metadata.json
  • reprocess-mediator/reprocess-ui-app.json

.vscode/settings.json Outdated Show resolved Hide resolved
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0a95208 and 17912a7.
Files selected for processing (1)
  • .vscode/settings.json (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .vscode/settings.json

@drizzentic drizzentic merged commit 4347be6 into main May 29, 2024
1 check passed
@drizzentic drizzentic deleted the CU_86byp4xw2 branch May 29, 2024 08:25
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.

3 participants