Reference data event bus through SSM parameter #731

landonshumway-ia · 2025-04-12T05:11:53Z

While testing the pipeline migration, we hit an issue where the event bus needs to be renamed, as it is using the pipeline stack as part of its name. This creates a cross stack reference issue since it is being referenced by several other stacks, and you cannot change a stack export value while it is still being referenced by other stacks. In order to address this, this PR replaces the direct reference with an SSM parameter, which can be changed without causing the stacks to fail deployment. This PR will need to be merged and deployed first, before the subsequent pipeline change can be run through.

This change is a precursor to the following tickets: #705 #580 #424

Summary by CodeRabbit

New Features
- Centralized configuration management for event integration has been introduced, enabling uniform retrieval of event bus parameters across components.
Refactor
- Updated several service integrations to rely on the new parameter-based configuration approach, improving decoupling and consistency in event operations.
- Introduced private attributes for better encapsulation and management of event bus resources.

coderabbitai · 2025-04-12T05:11:59Z

Walkthrough

The changes introduce a new utility file that encapsulates the management of AWS SSM parameters for an EventBus ARN. A new class, SSMParameterUtility, provides methods to store and retrieve the ARN, enabling AWS stacks to decouple direct resource references. Multiple files in API, Ingest, Persistent stacks, and tests have been updated to use this utility, changing direct property access to calls into SSMParameterUtility along with adjustments to environment variable assignments and metric dimensions.

Changes

File(s)	Change Summary
`backend/compact-connect/common_constructs/ssm_parameter_utility.py`	Added new `SSMParameterUtility` class with static methods (`set_data_event_bus_arn_ssm_parameter` and `load_data_event_bus_from_ssm_parameter`) for managing the EventBus ARN in SSM Parameter Store.
`backend/compact-connect/stacks/api_stack/v1_api/query_providers.py`, `backend/compact-connect/stacks/ingest_stack.py`, `backend/compact-connect/stacks/persistent_stack/__init__.py`, `backend/compact-connect/stacks/persistent_stack/data_event_table.py`, `backend/compact-connect/tests/app/base.py`	Updated various stack components and tests to replace direct EventBus references with calls to `SSMParameterUtility`. Changed public property access to a private attribute in `PersistentStack`, modified method signatures and environment variable assignments, and adjusted metric dimensions accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant PS as PersistentStack
    participant SSM as SSMParameterUtility
    participant API as API Stack
    participant IS as IngestStack

    PS->>SSM: set_data_event_bus_arn_ssm_parameter(scope, eventBus)
    Note right of SSM: ARN stored in SSM Parameter Store
    API->>SSM: load_data_event_bus_from_ssm_parameter(scope)
    SSM-->>API: Returns EventBus ARN
    IS->>SSM: load_data_event_bus_from_ssm_parameter(scope)
    SSM-->>IS: Returns EventBus ARN

Poem

In a field of code I hop so free,
A new utility brings clarity to me.
No more tangled direct links in the mist,
SSM stores the ARN that we now insist.
With each stack refreshed, I cheer and play—
A rabbit's delight in this new code day!
🐇🎉

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 847e3c9 and a907889.

📒 Files selected for processing (6)

backend/compact-connect/common_constructs/ssm_parameter_utility.py (1 hunks)
backend/compact-connect/stacks/api_stack/v1_api/query_providers.py (3 hunks)
backend/compact-connect/stacks/ingest_stack.py (5 hunks)
backend/compact-connect/stacks/persistent_stack/__init__.py (5 hunks)
backend/compact-connect/stacks/persistent_stack/data_event_table.py (1 hunks)
backend/compact-connect/tests/app/base.py (1 hunks)

🪧 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 plan to trigger planning for file edits and PR creation.
@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.

CodeRabbit Configuration 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.

jusdino

Looks great! 🚀

landonshumway-ia · 2025-04-14T16:59:17Z

@jlkravitz We are currently working on updating our pipeline architecture to support a beta environment, and as part of that pipeline migration, we will need this change merged to both the development and main branches in order to avoid having to delete the API and Ingest stacks for the test and prod environments. After this change is merged to development and run through the test environment, we can open another PR to merge this commit into the main branch as well. Let us know if you have questions. Thank you

jlkravitz

one typo, otherwise looks good.

Is this PR blocking others? If not, it might be more straightforward to merge this in with the sprint PR (next week, say). If it is blocking, though, we can merge per your suggestion to both development and main. @landonshumway-ia

backend/compact-connect/stacks/persistent_stack/__init__.py

Co-authored-by: Joshua Kravitz <[email protected]>

landonshumway-ia · 2025-04-14T18:30:42Z

@jlkravitz Unfortunately, this PR is a blocker for our pipeline migration effort, which we hope to roll out no later than this week as several states are looking to test out the system in the beta environment. So we will want to get this rolled out to both branches sooner rather than later. Likewise, we have another PR upcoming for the actual pipeline architecture itself, which will also need to follow a similar process of being pulled into development as well as the main branch in order to get everything wired up correctly.

jlkravitz

@isabeleliassen good to merge this!

While testing the pipeline migration, we hit an issue where the event bus needs to be renamed, as it is using the pipeline stack as part of its name. This creates a cross stack reference issue since it is being referenced by several other stacks, and you cannot change a stack export value while it is still being referenced by other stacks. In order to address this, this PR replaces the direct reference with an SSM parameter, which can be changed without causing the stacks to fail deployment. This PR will need to be merged and deployed first, before the subsequent pipeline change can be run through. This change is a precursor to the following tickets: csg-org#705 csg-org#580 csg-org#424  ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Centralized configuration management for event integration has been introduced, enabling uniform retrieval of event bus parameters across components. - **Refactor** - Updated several service integrations to rely on the new parameter-based configuration approach, improving decoupling and consistency in event operations. - Introduced private attributes for better encapsulation and management of event bus resources.  --------- Co-authored-by: Joshua Kravitz <[email protected]>

While testing the pipeline migration, we hit an issue where the event bus needs to be renamed, as it is using the pipeline stack as part of its name. This creates a cross stack reference issue since it is being referenced by several other stacks, and you cannot change a stack export value while it is still being referenced by other stacks. In order to address this, this PR replaces the direct reference with an SSM parameter, which can be changed without causing the stacks to fail deployment. This PR will need to be merged and deployed first, before the subsequent pipeline change can be run through. This change is a precursor to the following tickets: #705 #580 #424 Co-authored-by: Joshua Kravitz <[email protected]>

landonshumway-ia force-pushed the feat/beta-pipeline-support-part-1 branch from 5bbca8e to cdf251e Compare April 12, 2025 05:13

landonshumway-ia requested a review from jusdino April 12, 2025 05:22

Reference data event bus through SSM parameter

3dc2295

landonshumway-ia force-pushed the feat/beta-pipeline-support-part-1 branch from cdf251e to 3dc2295 Compare April 12, 2025 05:47

landonshumway-ia added 2 commits April 14, 2025 10:54

Setting the ssm parameter in the utility class

5322649

formatting

0311f5f

landonshumway-ia marked this pull request as ready for review April 14, 2025 15:57

jusdino approved these changes Apr 14, 2025

View reviewed changes

landonshumway-ia requested a review from jlkravitz April 14, 2025 15:58

jlkravitz reviewed Apr 14, 2025

View reviewed changes

backend/compact-connect/stacks/persistent_stack/__init__.py Outdated Show resolved Hide resolved

Update backend/compact-connect/stacks/persistent_stack/__init__.py

a907889

Co-authored-by: Joshua Kravitz <[email protected]>

landonshumway-ia requested a review from jlkravitz April 15, 2025 15:55

jlkravitz approved these changes Apr 15, 2025

View reviewed changes

isabeleliassen self-requested a review April 15, 2025 16:21

isabeleliassen approved these changes Apr 15, 2025

View reviewed changes

isabeleliassen merged commit c648997 into csg-org:development Apr 15, 2025
3 checks passed

landonshumway-ia mentioned this pull request Apr 15, 2025

Feat/beta pipeline support part 1 #735

Closed

coderabbitai bot mentioned this pull request May 28, 2025

Feat/purchase email #733

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reference data event bus through SSM parameter #731

Reference data event bus through SSM parameter #731

Uh oh!

landonshumway-ia commented Apr 12, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 12, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

jusdino left a comment

Uh oh!

landonshumway-ia commented Apr 14, 2025

Uh oh!

jlkravitz left a comment

Uh oh!

Uh oh!

landonshumway-ia commented Apr 14, 2025

Uh oh!

jlkravitz left a comment

Uh oh!

Uh oh!

Uh oh!

Reference data event bus through SSM parameter #731

Reference data event bus through SSM parameter #731

Uh oh!

Conversation

landonshumway-ia commented Apr 12, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

jusdino left a comment

Choose a reason for hiding this comment

Uh oh!

landonshumway-ia commented Apr 14, 2025

Uh oh!

jlkravitz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

landonshumway-ia commented Apr 14, 2025

Uh oh!

jlkravitz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

landonshumway-ia commented Apr 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 12, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)