Skip to content

refactor: versioning and migration mechanism for public data structures #3457

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 11 commits into from
Nov 2, 2023
Merged

refactor: versioning and migration mechanism for public data structures #3457

merged 11 commits into from
Nov 2, 2023

Conversation

AndrewBastin
Copy link
Contributor

Closes HFE-276

This PR intends to introduce Zod schemas and Verzod into @hoppscotch/data to power updated migrations.

Description

  • chore add verzod and zod as dependencies
  • bump typescript version
  • update REST Request, GraphQL Request and Environment systems to use Verzod schemas
  • add ValidContentTypesList to contentTypes module in @hoppscotch/data
  • deprecated couple of functions in @hoppscotch/data.

Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

jamesgeorge007
jamesgeorge007 reviewed Oct 17, 2023
View reviewed changes
@jamesgeorge007 jamesgeorge007 mentioned this pull request Oct 25, 2023
Merged
2 tasks
@jamesgeorge007 jamesgeorge007 force-pushed the refactor/hopp-data-migrations branch 2 times, most recently from 71a2593 to 978335a Compare October 25, 2023 16:02
jamesgeorge007
jamesgeorge007 requested changes Oct 25, 2023
View reviewed changes
Copy link
Member

@jamesgeorge007 jamesgeorge007 left a comment

Choose a reason for hiding this comment

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

Visiting /graphql results in the following error. Strangely there aren't any console errors coming up.

image

Also, failing tests need investigation.

@jamesgeorge007
Copy link
Member

jamesgeorge007 commented Oct 25, 2023 •
edited
Loading

The above error relating to the GraphQL page crashing was due to some underlying dependency bumps. I've reverted updates to the lock file apart from the dependency additions that are in scope as part of 5d304d7.

@jamesgeorge007 jamesgeorge007 force-pushed the refactor/hopp-data-migrations branch from 9247fb5 to 5d304d7 Compare October 25, 2023 17:21
@jamesgeorge007
Copy link
Member

@AndrewBastin, tests were failing since js-sandbox had node specified as the testEnvironment and it failed to recognize Blob since it wasn't getting imported. We can go with the polyfill path, but an easier fix will be to specify the environment as the browser via jsdom. Lmk your thoughts.
cc @amk-dev

@jamesgeorge007 jamesgeorge007 force-pushed the refactor/hopp-data-migrations branch from 7fedff1 to 17cedb3 Compare October 26, 2023 07:39
amk-dev
amk-dev reviewed Oct 26, 2023
View reviewed changes
amk-dev
amk-dev reviewed Oct 26, 2023
View reviewed changes
amk-dev
amk-dev reviewed Oct 26, 2023
View reviewed changes
@AndrewBastin AndrewBastin force-pushed the refactor/hopp-data-migrations branch from 3e21f83 to 28847ff Compare November 2, 2023 10:46
jamesgeorge007
jamesgeorge007 approved these changes Nov 2, 2023
View reviewed changes
Copy link
Member

@jamesgeorge007 jamesgeorge007 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.

The GraphQL page crashing and Codemirror syntax highlighting issues are to be handled separately.

@AndrewBastin AndrewBastin merged commit cbe3e14 into hoppscotch:release/2023.8.3 Nov 2, 2023
@AndrewBastin AndrewBastin deleted the refactor/hopp-data-migrations branch November 2, 2023 13:24
@jamesgeorge007 jamesgeorge007 mentioned this pull request Mar 19, 2024
Merged
2 tasks
@jamesgeorge007 jamesgeorge007 mentioned this pull request Jul 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamesgeorge007 jamesgeorge007 jamesgeorge007 approved these changes

+1 more reviewer

@amk-dev amk-dev amk-dev approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@AndrewBastin @jamesgeorge007 @amk-dev @nivedin