fix(core): always replace the doc on s3 after dr #4322

RamilGaripov · 2025-08-07T15:53:50Z

Part of ENG-620

Issues:

https://linear.app/metriport/issue/ENG-620

Description

The XML redownload FF decides whether a document needs to be re-queried from the networks. We find them on the networks, download, and then we don't replace the files on S3?? Why?
I removed the check for whether the file already exists on s3, so we can just update it with the newer version. I don't see any drawback in doing that, but not 100% sure

Testing

Staging
- Test with a CW connection
Production
- Rerun DQ on some of the affected patients and make sure the doc gets redownloaded

Release Plan

Merge this

Summary by CodeRabbit

Bug Fixes
- Files are now always uploaded to S3, regardless of whether they already exist.

Part of ENG-620 Signed-off-by: Ramil Garipov <ramil@metriport.com>

linear · 2025-08-07T15:53:53Z

ENG-620 XML Force Redownload not always working

coderabbitai · 2025-08-07T15:53:57Z

Walkthrough

The logic in the processDocumentReference function was updated to always upload files to S3, regardless of their prior existence. The previous conditional check that skipped the upload if the file already existed was removed. No changes were made to exported or public entity declarations or signatures.

Changes

Cohort / File(s)	Change Summary
S3 Upload Logic Update `packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts`	Removed the conditional preventing file upload to S3 if the file already existed; files are now always uploaded.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5-10 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 9f42a54 and 956abb1.

📒 Files selected for processing (1)

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursorrules)

**/*.{js,jsx,ts,tsx}: 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 const whenever possible
Use async/await instead of .then()
Naming: classes, enums: PascalCase
Naming: constants, variables, functions: camelCase
Naming: file names: kebab-case
Naming: Don’t use negative names, like notEnabled, prefer isDisabled
If possible, use decomposing objects for function parameters
Prefer Nullish Coalesce (??) than the OR operator (||) when you want 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)
While handling errors, keep the stack trace around: if you create a new Error (e.g., MetriportError), make sure to pass the original error as the new one’s cause so the stack trace is available upstream.
max column length is 100 chars
multi-line comments use /** */
top-level comments go after the import (save pre-import to basic file header, like license)
move literals to constants declared after imports when possible

Files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.cursorrules)

Use types whenever possible

Files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

**/*.ts

⚙️ CodeRabbit Configuration File

**/*.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

U...

Files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

🧠 Learnings (10)

📓 Common learnings

Learnt from: leite08
PR: metriport/metriport#4255
File: packages/core/src/command/analytics-platform/fhir-to-csv/command/fhir-to-csv/fhir-to-csv-direct.ts:19-20
Timestamp: 2025-07-27T00:40:32.149Z
Learning: User leite08 acknowledged the duplicate inputBundle spread issue in packages/core/src/command/analytics-platform/fhir-to-csv/command/fhir-to-csv/fhir-to-csv-direct.ts and will fix it in a follow-up PR rather than in the current patch release PR #4255.

Learnt from: leite08
PR: metriport/metriport#3814
File: packages/api/src/routes/internal/medical/patient-consolidated.ts:141-174
Timestamp: 2025-05-20T21:26:26.804Z
Learning: The functionality introduced in packages/api/src/routes/internal/medical/patient-consolidated.ts is planned to be refactored in downstream PR #3857, including improvements to error handling and validation.

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.

Learnt from: leite08
PR: metriport/metriport#3550
File: packages/api/src/external/commonwell/__tests__/patient.test.ts:5-5
Timestamp: 2025-04-01T20:57:29.282Z
Learning: PR #3574 is the follow-up PR that moves the domain feature flags from packages/api/src/aws/app-config.ts to packages/core/src/command/feature-flags/domain-ffs.ts.

Learnt from: leite08
PR: metriport/metriport#3463
File: packages/api-sdk/src/medical/models/patient.ts:1-1
Timestamp: 2025-03-19T13:58:17.253Z
Learning: When changes are made to SDK packages (`api-sdk`, `commonwell-sdk`, `carequality-sdk`) or `packages/shared` in the Metriport codebase, alpha versions need to be published to NPM before merging the PR.

Learnt from: thomasyopes
PR: metriport/metriport#3882
File: packages/core/src/external/ehr/command/get-bundle-by-resource-type.ts:31-37
Timestamp: 2025-06-05T14:09:59.683Z
Learning: When EHR handlers in mapping objects are set to `undefined` and there are downstream PRs mentioned in the PR objectives, this typically indicates a staged rollout approach where the core structure is implemented first and specific handler implementations follow in subsequent PRs.

Learnt from: leite08
PR: metriport/metriport#4215
File: packages/core/src/command/analytics-platform/config.ts:4-13
Timestamp: 2025-07-20T01:18:28.093Z
Learning: User leite08 prefers that code improvement suggestions (like consolidating duplicated schemas) be made on feature PRs rather than release PRs. Such improvements should be deferred to follow-up PRs during the release cycle.

Learnt from: thomasyopes
PR: metriport/metriport#3466
File: packages/api/src/routes/ehr/elation/chart.ts:20-37
Timestamp: 2025-03-17T15:30:34.647Z
Learning: The request body parsing in packages/api/src/routes/ehr/elation/chart.ts is tracked with TODO referencing issue #2170 and will be handled in a separate PR, not in PR #3466.

Learnt from: leite08
PR: metriport/metriport#3975
File: packages/core/src/command/consolidated/search/fhir-resource/__tests__/search-consolidated.test.ts:8-9
Timestamp: 2025-06-07T16:31:23.929Z
Learning: User prefers to minimize changes in release PRs to reduce risk, even when acknowledging that suggested improvements would be beneficial. They prioritize stability over minor improvements in release contexts.

Learnt from: thomasyopes
PR: metriport/metriport#3484
File: packages/api/src/routes/internal/medical/organization.ts:7-15
Timestamp: 2025-03-18T23:49:35.819Z
Learning: Typo fixes and other minor code quality improvements should not be addressed in release PRs to minimize risk and maintain stability.

Learnt from: RamilGaripov
PR: metriport/metriport#4176
File: packages/fhir-converter/src/lib/handlebars-converter/handlebars-helpers.js:296-320
Timestamp: 2025-07-17T21:24:37.077Z
Learning: RamilGaripov prefers to maintain consistency with existing patterns in a file rather than making isolated fixes to coding guideline violations like var vs const declarations, when the pattern is already established throughout the codebase.

Learnt from: RamilGaripov
PR: metriport/metriport#3675
File: packages/api/src/routes/internal/hl7/index.ts:0-0
Timestamp: 2025-04-23T06:31:50.128Z
Learning: RamilGaripov prefers using Zod schema validation for parsing and validating all query parameters in routes as it's a cleaner way to write route logic, rather than using separate validation methods like getUUIDFrom().orFail() followed by schema validation.

Learnt from: RamilGaripov
PR: metriport/metriport#4259
File: packages/utils/src/document/reconversion-kickoff-loader.ts:78-81
Timestamp: 2025-07-27T23:42:34.014Z
Learning: For utility scripts in packages/utils, RamilGaripov prefers to keep them simple without extensive validation or error handling, as they are local developer tools where the developer controls the input and execution environment.

📚 Learning: the writemedicationtochart function in packages/api/src/external/ehr/athenahealth/command/write-back...

Learnt from: thomasyopes
PR: metriport/metriport#3970
File: packages/api/src/external/ehr/athenahealth/command/write-back/medication.ts:17-17
Timestamp: 2025-06-06T16:45:31.832Z
Learning: The writeMedicationToChart function in packages/api/src/external/ehr/athenahealth/command/write-back/medication.ts returns a response that is not currently used by any consumers, so changes to its return type are not breaking changes in practice.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: in packages/core/src/external/sftp/surescripts/client.ts, the standalone getpatientloadfilename func...

Learnt from: keshavsaharia
PR: metriport/metriport#3885
File: packages/core/src/external/sftp/surescripts/client.ts:1-134
Timestamp: 2025-05-28T19:23:20.179Z
Learning: In packages/core/src/external/sftp/surescripts/client.ts, the standalone getPatientLoadFileName function intentionally omits the transmission ID from the filename, which differs from the class method getPatientLoadFileName. This difference in filename generation is expected behavior.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: the functionality introduced in packages/api/src/routes/internal/medical/patient-consolidated.ts is ...

Learnt from: leite08
PR: metriport/metriport#3814
File: packages/api/src/routes/internal/medical/patient-consolidated.ts:141-174
Timestamp: 2025-05-20T21:26:26.804Z
Learning: The functionality introduced in packages/api/src/routes/internal/medical/patient-consolidated.ts is planned to be refactored in downstream PR #3857, including improvements to error handling and validation.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: user leite08 accepted the risk of parameter mutation in packages/carequality-sdk/src/client/carequal...

Learnt from: leite08
PR: metriport/metriport#4193
File: packages/carequality-sdk/src/client/carequality-fhir.ts:198-208
Timestamp: 2025-07-16T00:54:56.156Z
Learning: User leite08 accepted the risk of parameter mutation in packages/carequality-sdk/src/client/carequality-fhir.ts when modifying org.active = false directly on input parameters, choosing to proceed despite the violation of the "Avoid modifying objects received as parameter" coding guideline.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: the webhook signature verification code in packages/core/src/util/webhook.ts is copied directly from...

Learnt from: thomasyopes
PR: metriport/metriport#3771
File: packages/core/src/util/webhook.ts:34-45
Timestamp: 2025-05-01T16:10:45.273Z
Learning: The webhook signature verification code in packages/core/src/util/webhook.ts is copied directly from Healthie's documentation and should not be modified to maintain exact compliance with their implementation.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: in packages/core/src/command/conversion-fhir/conversion-fhir-direct.ts, the conversionfhirdirect cla...

Learnt from: thomasyopes
PR: metriport/metriport#4090
File: packages/core/src/command/conversion-fhir/conversion-fhir-direct.ts:18-25
Timestamp: 2025-06-25T01:56:08.732Z
Learning: In packages/core/src/command/conversion-fhir/conversion-fhir-direct.ts, the ConversionFhirDirect class is designed for local testing purposes and does not require comprehensive error handling for HTTP requests, as confirmed by the user thomasyopes.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: in packages/core/src/external/ehr/healthie/index.ts, the immunization.cvx_code field is required and...

Learnt from: thomasyopes
PR: metriport/metriport#4164
File: packages/core/src/external/ehr/healthie/index.ts:939-953
Timestamp: 2025-07-09T17:18:16.731Z
Learning: In packages/core/src/external/ehr/healthie/index.ts, the immunization.cvx_code field is required and non-nullable according to the zod schema validation (z.coerce.string()), so null checks are not needed in the convertImmunizationToFhir method.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: the request body parsing in packages/api/src/routes/ehr/elation/chart.ts is tracked with todo refere...

Learnt from: thomasyopes
PR: metriport/metriport#3466
File: packages/api/src/routes/ehr/elation/chart.ts:20-37
Timestamp: 2025-03-17T15:30:34.647Z
Learning: The request body parsing in packages/api/src/routes/ehr/elation/chart.ts is tracked with TODO referencing issue #2170 and will be handled in a separate PR, not in PR #3466.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

📚 Learning: in packages/core/src/command/consolidated/search/fhir-resource/ingest-lexical.ts, the processerrors ...

Learnt from: leite08
PR: metriport/metriport#3944
File: packages/core/src/command/consolidated/search/fhir-resource/ingest-lexical.ts:53-53
Timestamp: 2025-06-01T02:28:19.913Z
Learning: In packages/core/src/command/consolidated/search/fhir-resource/ingest-lexical.ts, the processErrors function intentionally throws MetriportError to bubble errors up the call stack rather than handling them locally. This is by design - errors from ingestPatientConsolidated should propagate upward rather than being caught at immediate calling locations.

Applied to files:

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts

🧬 Code Graph Analysis (1)

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts (1)

packages/mllp-server/src/utils.ts (1)

s3Utils (18-18)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: check-pr / lint-build-test
GitHub Check: Analyze (javascript)

🔇 Additional comments (1)

packages/core/src/external/carequality/ihe-gateway-v2/outbound/xca/process/dr-response.ts (1)

109-114: LGTM! Change aligns with PR objectives to always replace documents on S3.

The removal of the conditional check ensures that documents are always uploaded to S3, regardless of their prior existence. This directly addresses the issue described in the PR where files weren't being replaced during XML redownload operations. The fileInfo.exists check is still used appropriately to set the isNew flag on line 139.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch eng-620-xml-force-redownload-dr-fix

🪧 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.
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.

Support

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

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 generate unit tests to generate unit tests for 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

Looks good as an isolated change. Need to double check CW's logic and whether this actually fixes the original issue.

fix(core): always replace the doc on s3 after dr

956abb1

Part of ENG-620 Signed-off-by: Ramil Garipov <ramil@metriport.com>

RamilGaripov requested review from Goncharo, leite08, Orta21, thomasyopes, lucasdellabella and keshavsaharia as code owners August 7, 2025 15:53

leite08 approved these changes Aug 7, 2025

View reviewed changes

RamilGaripov added this pull request to the merge queue Aug 7, 2025

Merged via the queue into develop with commit 100197e Aug 7, 2025
14 checks passed

RamilGaripov deleted the eng-620-xml-force-redownload-dr-fix branch August 7, 2025 23:52

RamilGaripov mentioned this pull request Aug 8, 2025

RELEASE CQ DQ updates #4329

Merged

1 task

This was referenced Aug 11, 2025

fix(core): remove rendered files on xml redownload #4344

Merged

RELEASE Delete rendered docs #4352

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(core): always replace the doc on s3 after dr #4322

fix(core): always replace the doc on s3 after dr #4322

Uh oh!

RamilGaripov commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

linear bot commented Aug 7, 2025

Uh oh!

coderabbitai bot commented Aug 7, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

leite08 left a comment

Uh oh!

Uh oh!

Uh oh!

fix(core): always replace the doc on s3 after dr #4322

fix(core): always replace the doc on s3 after dr #4322

Uh oh!

Conversation

RamilGaripov commented Aug 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Release Plan

Summary by CodeRabbit

Uh oh!

linear bot commented Aug 7, 2025

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

leite08 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RamilGaripov commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)