Skip to content
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

fix plausible site domain env validation #9168

Merged

Conversation

rithviknishad
Copy link
Member

@rithviknishad rithviknishad commented Nov 20, 2024

Issue

Builds failing due to incorrect env validation (from #9032)

image

Proposed Changes

  • fixes plausible site domain env validation
image image

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features
    • Updated validation for the REACT_PLAUSIBLE_SITE_DOMAIN environment variable to enforce a specific domain name format.
    • Added descriptive messaging to clarify the expected domain name format for users.

@rithviknishad rithviknishad requested a review from a team as a code owner November 20, 2024 13:36
Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes in this pull request focus on modifying the validation schema for the REACT_PLAUSIBLE_SITE_DOMAIN environment variable in the Vite configuration file. The validation criteria have shifted from requiring a URL string to enforcing a regex pattern that specifies a valid domain name format. This update includes an alphanumeric start, permissible characters, and a requirement for a valid top-level domain, along with a descriptive message to clarify the expected format.

Changes

File Change Summary
vite.config.mts Updated validation schema for REACT_PLAUSIBLE_SITE_DOMAIN from URL to regex pattern with a description.

Poem

In the land of code where rabbits play,
A domain's format found its way.
No more URLs, just a regex dance,
With alphanumeric hops, it takes a chance.
So let the domains leap and bound,
In Vite's embrace, new rules are found! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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.

@rithviknishad rithviknishad self-assigned this Nov 20, 2024
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit b7603f5
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/673de5f5ff1c520008840ea9
😎 Deploy Preview https://deploy-preview-9168--care-ohc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rithviknishad rithviknishad added P1 breaking issue or vital feature needs review labels Nov 20, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
vite.config.mts (1)

114-119: Consider enhancing the domain validation regex.

The current regex pattern has some limitations:

  1. Doesn't support international domain names (IDN)
  2. Allows consecutive dots which might be invalid
  3. Allows underscores which are technically invalid in domain names per RFC

Consider using this enhanced regex pattern:

-            .regex(/^[a-zA-Z0-9][a-zA-Z0-9-_.]*\.[a-zA-Z]{2,}$/)
+            .regex(/^[a-zA-Z0-9](?:[a-zA-Z0-9-](?!-)|\.(?!\.)){1,61}[a-zA-Z0-9]\.[a-zA-Z]{2,}$/)

This pattern:

  • Prevents consecutive dots and hyphens
  • Removes underscore support (technically invalid in domains)
  • Enforces length limits
  • Still maintains the core requirement of no protocol
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2d08896 and b7603f5.

📒 Files selected for processing (1)
  • vite.config.mts (1 hunks)
🔇 Additional comments (1)
vite.config.mts (1)

114-119: LGTM! Please verify the domain format requirements.

The validation has been updated to enforce a stricter domain name format without protocol. This aligns with the PR objective to fix the plausible site domain validation.

@nihal467
Copy link
Member

LGTM

Copy link

cypress bot commented Nov 20, 2024

CARE    Run #3937

Run Properties:  status check failed Failed #3937  •  git commit b7603f5335: fix plausible site domain env validation
Project CARE
Branch Review rithviknishad/fix/env-validation-plausible-site-domain
Run status status check failed Failed #3937
Run duration 05m 00s
Commit git commit b7603f5335: fix plausible site domain env validation
Committer Rithvik Nishad
View all properties for this run ↗︎

Test results
Tests that failed  Failures 1
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 128
View all changes introduced in this branch ↗︎

Tests for review

Failed  cypress/e2e/patient_spec/PatientPrescription.cy.ts • 1 failed test • UI-Chrome

View Output

Test Artifacts
Patient Medicine Administration > Add a new titrated medicine for a patient | Individual Administeration | Test Replay Screenshots

@rithviknishad rithviknishad merged commit 10369c5 into develop Nov 20, 2024
67 of 69 checks passed
@rithviknishad rithviknishad deleted the rithviknishad/fix/env-validation-plausible-site-domain branch November 20, 2024 13:46
Copy link

@rithviknishad @rithviknishad Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

Rishith25 pushed a commit to Rishith25/care_fe that referenced this pull request Nov 25, 2024
UdaySagar-Git pushed a commit to UdaySagar-Git/care_fe that referenced this pull request Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs review P1 breaking issue or vital feature tested
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants