8000 feat(utils): fixing date of birth error + format validation by thomasyopes · Pull Request #3827 · metriport/metriport · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat(utils): fixing date of birth error + format validation #3827

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

Draft
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

thomasyopes
Copy link
Contributor
@thomasyopes thomasyopes commented May 12, 2025

Ref: ENG-241

Issues:

Description

  • reverts pre1900 logic to not require ISO date format
  • introduces safe versions of pre1900 + validatePeriod
  • requires formatting of ISO or American (MM/DD/YYYY) for dates of birth
  • throws BadRequest error from date of birth normalization

Testing

  • Local
    • unit testing
  • Staging
    • unit testing
  • Sandbox
    • N/A
  • Production
    • unit testing

Release Plan

  • Release NPM packages
  • Merge this

Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Copy link
linear bot commented May 12, 2025

Copy link
coderabbitai bot commented May 12, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Thomas Yopes added 6 commits May 12, 2025 13:35
Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Ref: ENG-241

Ref: #1040
Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
… 241-bad-request-on-invalid-dob

Signed-off-by: Thomas Yopes <thomasyopes@Thomass-MBP.attlocal.net>
Comment on lines 4 to 9
export function normalizeDobSafe(date: string): string | undefined {
const trimmedDate = date.trim();
if (trimmedDate.length < 1) return undefined;
if (!validateDateOfBirth(trimmedDate)) throw new Error("Invalid date of birth.");
if (!validateDateOfBirthSafe(trimmedDate)) return undefined;
return buildDayjs(trimmedDate).format(ISO_DATE);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

lol we were throwing an error inside of something called normalizeDobSafe?? 😬

Copy link
Member
@leite08 leite08 May 19, 2025

Choose a reason for hiding this comment

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

Worse, we only call it on a function that throws an error if the return is undefined... 😆

And I think this function is not just normalization, it's parsing. Normalization is just trying to make a value more "normalized", it should not return undefined if the value is not undefined, for example. This is parsing.

@@ -16,6 +18,8 @@ export function normalizeGenderSafe(gender: string): "F" | "M" | "O" | "U" | und

export function normalizeGender(gender: string): GenderAtBirth {
const genderOrUndefined = normalizeGenderSafe(gender);
if (!genderOrUndefined) throw new Error("Invalid gender");
if (!genderOrUndefined) {
throw new BadRequestError("Invalid gender", undefined, { gender });
Copy link
Contributor
@lucasdellabella lucasdellabella May 13, 2025

Choose a reason for hiding this comment

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

nit maybe this should be InvalidArgumentError since its a general purpose function used to validate data?

Copy link
Member

Choose a reason for hiding this comment

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

We don't have a InvalidArgumentError, are you suggesting we create one?

I think it makes sense, it's semantically better to throw InvalidArgumentError from the command inward than use BadRequestError (that hints to "request" as in "http request").

To minimize the impact on existing code we could make InvalidArgumentError extends BadRequestError.

Def not required for this PR, but I'd ticket it if we decide not to do it now.

Comment on lines -25 to +26
return validateIsPastOrPresent(patient.dob) && validateDateOfBirth(patient.dob);
validateDateOfBirth(patient.dob);
return true;
Copy link
Contributor

Choose a reason for hiding this comment

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

weird to me that this function can both return false and throw errors. Shouldn't we return false instead of throwing?

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
0