8000 Backmerge master into develop by leite08 · Pull Request #3921 · metriport/metriport · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Backmerge master into develop #3921

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
May 30, 2025
Merged

Backmerge master into develop #3921

merged 13 commits into from
May 30, 2025

Conversation

leite08
Copy link
Member
@leite08 leite08 commented May 30, 2025 •
edited by coderabbitai bot
Loading

Backmerge master into develop

Summary by CodeRabbit

  • Documentation
    • Added documentation for a new query parameter that allows inclusion of detailed pharmacy and PBM medication history in the "Start Document Query" API endpoint.
    • Removed decorative emojis from section headers and lists in the quickstart guide for a cleaner appearance.

lucasdellabella and others added 13 commits May 28, 2025 05:47
@lucasdellabella
Merge pull request #3907 from metriport/develop
9ed9b1d 
RELEASE
@Orta21
build: add new med dash
b4b76de 
Part of eng-373

Signed-off-by: Jorge Orta <36802074+Orta21@users.noreply.github.com>
@Orta21
Merge pull request #3909 from metriport/eng-373-update-readme
062cd8a 
PATCH: Update readme
@Orta21
build: update docs
f0c9d33 
Part of eng-373

Signed-off-by: Jorge Orta <36802074+Orta21@users.noreply.github.com>
@Orta21
Merge pull request #3910 from metriport/eng-373-update-readme
1bff8f1 
PATCH: DOCS links not working
@leite08
Merge pull request #3911 from metriport/develop
dc91294 
RELEASE Update utils
@keshavsaharia
docs(docs): added pharmacies query parameter to start document query …
3183c4c 
…for launch week

metriport/metriport-internal#1040

Signed-off-by: Keshav Saharia <keshav@metriport.com>
8000
@keshavsaharia
docs(docs): update with review comment on wording
c487c8d 
metriport/metriport-internal#1040

Signed-off-by: Keshav Saharia <keshav@metriport.com>
@keshavsaharia
Merge pull request #3915 from metriport/docs-pharmacy-query-param
e224d4a 
PATCH: added pharmacies query parameter to start document query
@leite08
Merge pull request #3914 from metriport/develop
795c03d 
RELEASE Patient global search v0
@leite08
Merge pull request #3917 from metriport/develop
44465a8 
RELEASE ENG-268 Enable ingestion on consolidate recreate
@leite08
fix: messageDedupId uses UUID instead of nanoid
840e386 
Ref eng-268

Signed-off-by: Rafael Leite <2132564+leite08@users.noreply.github.com>
@leite08
Merge pull request #3920 from metriport/799-fix-ingestion-sqs-dedup-id
d62a3ef 
PATCH RELEASE ENG-268 Fix ingestion sqs setup
@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 30, 2025 •
edited
Loading

Walkthrough

This update introduces a new pharmacies boolean query parameter to the "Start Document Query" API documentation, updates the quickstart documentation by removing decorative emojis, and changes the method for generating SQS message deduplication IDs from nanoid to a local uuidv7 utility in the core package.

Changes

File(s) Change Summary
docs/medical-api/api-reference/document/start-document-query.mdx Added pharmacies boolean query parameter to API endpoint documentation.
docs/medical-api/getting-started/quickstart.mdx Removed decorative emojis from section headers and numbered list items.
packages/core/src/command/consolidated/search/fhir-resource/ingest-consolidated-sqs.ts Replaced nanoid with local uuidv7 utility for SQS deduplication ID generation.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant PharmacyDataSource

    Client->>API: Start Document Query (pharmacies=true)
    API->>PharmacyDataSource: Fetch medication history (1 year)
    PharmacyDataSource-->>API: Return medication fill data
    API-->>Client: Return document query results (including pharmacy data)
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: C00CC024A07F0000: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-05-30T02_36_59_960Z-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 5e77007 and d62a3ef.

⛔ Files ignored due to path filters (1)
  • assets/medical-dashboard.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • docs/medical-api/api-reference/document/start-document-query.mdx (1 hunks)
  • docs/medical-api/getting-started/quickstart.mdx (3 hunks)
  • packages/core/src/command/consolidated/search/fhir-resource/ingest-consolidated-sqs.ts (2 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/core/src/command/consolidated/search/fhir-resource/ingest-consolidated-sqs.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.
🧬 Code Graph Analysis (1)
packages/core/src/command/consolidated/search/fhir-resource/ingest-consolidated-sqs.ts (1)
packages/shared/src/util/uuid-v7.ts (1)
  • uuidv7 (368-368)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: e2e-tests / E2E Tests
  • GitHub Check: infra-api-lambdas-sandbox / deploy
  • GitHub Check: check-pr / lint-build-test
  • GitHub Check: Analyze (javascript)
  • GitHub Check: api-sandbox / deploy
🔇 Additional comments (3)
packages/core/src/command/consolidated/search/fhir-resource/ingest-consolidated-sqs.ts (1)

9-9: LGTM! Clean replacement of nanoid with local uuidv7 utility.

The change from nanoid to the local uuidv7 utility for generating SQS message deduplication IDs is appropriate and maintains the same functionality while using an internal utility.

Also applies to: 70-70

docs/medical-api/api-reference/document/start-document-query.mdx (1)

43-50: LGTM! Well-documented new pharmacies parameter.

The new pharmacies boolean parameter is clearly documented with appropriate description of its functionality for retrieving medication history from pharmacies and PBMs. The additional info section about the one-year timeframe provides helpful context for users.

docs/medical-api/getting-started/quickstart.mdx (1)

18-19: LGTM! Cleaner documentation without decorative emojis.

Removing the decorative emojis from section headers and list items creates a more professional and consistent documentation style.

Also applies to: 167-167, 187-187

✨ 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 May 30, 2025 02:36
keshavsaharia
keshavsaharia approved these changes May 30, 2025
View reviewed changes
Copy link
Contributor
@keshavsaharia keshavsaharia left a comment •
edited
Loading

Choose a reason for hiding this comment

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

While this is mainly documentation changes, the only code change from nanoid() to uuidv7() intuitively seems like a harmless change since this is well within SQS' limit of 128 characters for a MessageDeduplicationId (nanoid is ~21 characters and uuidv7 is 36 characters), and also a pattern I've seen elsewhere in the codebase.

@keshavsaharia keshavsaharia enabled auto-merge May 30, 2025 03:01
Orta21
Orta21 ap 8000 proved these changes May 30, 2025
View reviewed changes
@keshavsaharia keshavsaharia added this pull request to the merge queue May 30, 2025
Merged via the queue into develop with commit 51bd737 May 30, 2025
71 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@keshavsaharia keshavsaharia keshavsaharia approved these changes

@Orta21 Orta21 Orta21 approved these changes

@Goncharo Goncharo Awaiting requested review from Goncharo Goncharo is a code owner

@RamilGaripov RamilGaripov Awaiting requested review from RamilGaripov RamilGaripov is a code owner

@thomasyopes thomasyopes Awaiting requested review from thomasyopes thomasyopes is a code owner

@lucasdellabella lucasdellabella Awaiting requested review from lucasdellabella lucasdellabella is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull r 3B03 equest may close these issues.
4 participants
@leite08 @keshavsaharia @Orta21 @lucasdellabella
0