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

Switch to using zod for validation for patch endpoint. #1579

Merged
merged 9 commits into from
Apr 28, 2024

Conversation

Victor-M-Giraldo
Copy link
Contributor

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

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.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@Victor-M-Giraldo Victor-M-Giraldo changed the title zod validation for patch Switch to using zod for validation for patch endpoint. Mar 28, 2024
@Victor-M-Giraldo
Copy link
Contributor Author

I think this is in the right direction. Would just like some feedback before I continue

@Victor-M-Giraldo
Copy link
Contributor Author

Victor-M-Giraldo commented Apr 8, 2024

Just giving an update on this one. Still working on it, I'm aware I need to narrow the type down but I'm also encountering an issue after I do that. It's a WIP though.

Also, I know you said there are some endpoints just with the querys from the URL. What file are those in? Can't find them and I figure I might work on them since they might be easier than this one.

@dyc3
Copy link
Owner

dyc3 commented Apr 8, 2024

IIRC the only endpoint that uses query params is /api/data/previewAdd, which is in data.ts

@dyc3
Copy link
Owner

dyc3 commented Apr 9, 2024

As discussed offline:

for handling grants, create a new object from body

probably something like

const foo = {
...body,
grants: new Grants(body.grants)
}

be careful to not add it if it doesn't exist on the body

@Victor-M-Giraldo
Copy link
Contributor Author

I know you said not to do else if ('visibility' in body) but if I just do else I get type errors on the grants. Also, I'm getting type errors when trying to update the settings to just be the body and it says the Grants is missing some properties.

@Victor-M-Giraldo
Copy link
Contributor Author

Still need to fix tests.

@dyc3 dyc3 marked this pull request as ready for review April 28, 2024 14:43
Copy link

codecov bot commented Apr 28, 2024

Codecov Report

Attention: Patch coverage is 31.16883% with 53 lines in your changes are missing coverage. Please review.

Project coverage is 62.8078%. Comparing base (5ac968b) to head (6fa0f8e).
Report is 166 commits behind head on master.

Files Patch % Lines
common/models/zod-schemas.ts 0.0000% 32 Missing ⚠️
server/api/room.ts 43.2432% 21 Missing ⚠️
Additional details and impacted files
@@               Coverage Diff                @@
##             master      #1579        +/-   ##
================================================
+ Coverage   56.3149%   62.8078%   +6.4928%     
================================================
  Files           164        168         +4     
  Lines         25004      24852       -152     
  Branches       1441       1444         +3     
================================================
+ Hits          14081      15609      +1528     
+ Misses        10869       9190      -1679     
+ Partials         54         53         -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dyc3 dyc3 merged commit e581552 into dyc3:master Apr 28, 2024
20 of 21 checks passed
Copy link

cypress bot commented Apr 28, 2024

Passing run #1896 ↗︎

0 82 1 0 Flakiness 0

Details:

Switch to using zod for validation for patch endpoint. (#1579)
Project: OpenTogetherTube Commit: e581552422
Status: Passed Duration: 04:51 💡
Started: Apr 28, 2024 2:56 PM Ended: Apr 28, 2024 3:01 PM

Review all test suite changes for PR #1579 ↗︎

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.

2 participants