Skip to content

Conversation

leite08
Copy link
Member

@leite08 leite08 commented Jun 6, 2025

Backmerge master into develop

Summary by CodeRabbit

  • Refactor
    • Improved document reference handling by updating how existing FHIR documents are checked before downloading, reducing redundant downloads and streamlining processing. No visible changes to user interface or workflows.

Orta21 and others added 3 commits June 5, 2025 23:38
RELEASE: PCP AI Improvements
Ref eng-422

Signed-off-by: Rafael Leite <2132564+leite08@users.noreply.github.com>
…fhir-server-on-dq

PATCH RELEASE ENG-422 Minimize hits to FHIR DB upon CQ DQ
Copy link

coderabbitai bot commented Jun 6, 2025

Walkthrough

The changes refactor the getNonExistentDocRefs function to accept FHIR document references as a parameter instead of fetching them internally. Correspondingly, getRespWithDocsToDownload is updated to fetch these references and supply them to getNonExistentDocRefs, modifying the document filtering logic accordingly.

Changes

File(s) Change Summary
.../get-non-existent-doc-refs.ts Refactored getNonExistentDocRefs to accept fhirDocRefs as a parameter; removed internal fetching.
.../process-outbound-document-query-resps.ts Updated getRespWithDocsToDownload to fetch FHIR doc refs and pass them to getNonExistentDocRefs.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant processOutboundDocumentQueryResps
    participant getDocuments
    participant getNonExistentDocRefs
    participant checkDocRefsExistInS3

    Caller->>processOutboundDocumentQueryResps: call getRespWithDocsToDownload(cxId, patientId, ...)
    processOutboundDocumentQueryResps->>getDocuments: fetch FHIR doc refs (cxId, patientId)
    getDocuments-->>processOutboundDocumentQueryResps: return fhirDocRefs
    processOutboundDocumentQueryResps->>getNonExistentDocRefs: pass documents, patientId, cxId, fhirDocRefs
    getNonExistentDocRefs->>checkDocRefsExistInS3: check existence in S3
    checkDocRefsExistInS3-->>getNonExistentDocRefs: return existence results
    getNonExistentDocRefs-->>processOutboundDocumentQueryResps: return non-existent doc refs
    processOutboundDocumentQueryResps-->>Caller: return response with docs to download
Loading

Possibly related PRs

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error code ERR_SSL_WRONG_VERSION_NUMBER
npm error errno ERR_SSL_WRONG_VERSION_NUMBER
npm error request to https://10.0.0.28:4873/punycode/-/punycode-2.3.1.tgz failed, reason: C08CF333DA7F0000:error:0A00010B:SSL routines:ssl3_get_record:wrong version number:../deps/openssl/openssl/ssl/record/ssl3_record.c:354:
npm error
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-06T15_05_11_039Z-debug-0.log


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 88ff31f and b1a6de9.

📒 Files selected for processing (2)
  • packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts (2 hunks)
  • packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.ts`: - Use the Onion Pattern to organize a package's code in layers - Try to use immutable code and avoid sharing state across different functions, objects, and systems - Try...

**/*.ts: - Use the Onion Pattern to organize a package's code in layers

  • Try to use immutable code and avoid sharing state across different functions, objects, and systems
  • Try to build code that's idempotent whenever possible
  • Prefer functional programming style functions: small, deterministic, 1 input, 1 output
  • Minimize coupling / dependencies
  • Avoid modifying objects received as parameter
  • Only add comments to code to explain why something was done, not how it works
  • Naming
    • classes, enums: PascalCase
    • constants, variables, functions: camelCase
    • file names: kebab-case
    • table and column names: snake_case
    • Use meaningful names, so whoever is reading the code understands what it means
    • Don’t use negative names, like notEnabled, prefer isDisabled
    • For numeric values, if the type doesn’t convey the unit, add the unit to the name
  • Typescript
    • Use types
    • Prefer const instead of let
    • Avoid any and casting from any to other types
    • Type predicates: only applicable to narrow down the type, not to force a complete type conversion
    • Prefer deconstructing parameters for functions instead of multiple parameters that might be of
      the same type
    • Don’t use null inside the app, only on code interacting with external interfaces/services,
      like DB and HTTP; convert to undefined before sending inwards into the code
    • Use async/await instead of .then()
    • Use the strict equality operator ===, don’t use abstract equality operator ==
    • When calling a Promise-returning function asynchronously (i.e., not awaiting), use .catch() to
      handle errors (see processAsyncError and emptyFunction depending on the case)
    • Date and Time
      • Always use buildDayjs() to create dayjs instances
      • Prefer dayjs.duration(...) to create duration consts and keep them as duration
  • Prefer Nullish Coalesce (??) than the OR operator (||) to provide a default value
  • Avoid creating arrow functions
  • Use truthy syntax instead of in - i.e., if (data.link) not if ('link' in data)
  • Error handling
    • Pass the original error as the new one’s cause so the stack trace is persisted
    • Error messages should have a static message - add dynamic data to MetriportError's additionalInfo prop
    • Avoid sending multiple events to Sentry for a single error
  • Global constants and variables
    • Move literals to constants declared after imports when possible (avoid magic numbers)
    • Avoid shared, global objects
  • Avoid using console.log and console.error in packages other than utils, infra and shared,
    and try to use out().log instead
  • Avoid multi-line logs
    • don't send objects as a second parameter to console.log() or out().log()
    • don't create multi-line strings when using JSON.stringify()
  • Use eslint to enforce code style
  • Use prettier to format code
  • max column length is 100 chars
  • multi-line comments use /** */
  • scripts: top-level comments go after the import
  • packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts
  • packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts
🧠 Learnings (1)
📓 Common learnings
Learnt from: leite08
PR: metriport/metriport#0
File: :0-0
Timestamp: 2025-03-05T18:43:30.389Z
Learning: For backmerge PRs at metriport/metriport, only verify two things: (1) that the source branch is `master` and destination branch is `develop`, and (2) that there's a link to at least one PR (usually a "patch" PR) in the description. No need for detailed review comments or updates to the PR description unless there's an issue with these criteria.
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: Analyze (javascript)
  • GitHub Check: api-prod / deploy
🔇 Additional comments (2)
packages/api/src/external/carequality/document/process-outbound-document-query-resps.ts (1)

5-5: LGTM - Coordinated refactoring changes for backmerge

This appears to be a legitimate backmerge from master to develop with coordinated changes that improve separation of concerns by moving FHIR document fetching to the caller level. The function signature updates and import changes are properly aligned between files.

Also applies to: 247-248, 270-271

packages/api/src/external/carequality/document/get-non-existent-doc-refs.ts (1)

3-3: LGTM - Function signature and implementation properly updated

The function has been correctly refactored to accept FHIR document references as a parameter instead of fetching them internally. The import changes and parameter additions align with the coordinated changes in the calling code.

Also applies to: 19-21, 22-26

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

@leite08 leite08 marked this pull request as ready for review June 6, 2025 15:02
@leite08 leite08 enabled auto-merge June 6, 2025 15:02
@leite08 leite08 added this pull request to the merge queue Jun 6, 2025
Merged via the queue into develop with commit 5bcdde3 Jun 6, 2025
68 checks passed
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