#3059: Upgrade to RJSF5 #4913

fregante · 2022-12-30T07:03:23Z

What does this PR do?

Part of Support RJSF Schema validation in strict CSP #3059

Reviewer Tips

Migration details in https://rjsf-team.github.io/react-jsonschema-form/docs/migration-guides/v5.x%20upgrade%20guide

Remaining Work

Field title/label not showing up in preview or rendered form (see broken test)
Form Description no longer supports markdown - need to track down what part of the theme renders the description
Fix broken Dropdown with labels field test. Likely due to enumOptions change in behavior: https://rjsf-team.github.io/react-jsonschema-form/docs/migration-guides/v5.x%20upgrade%20guide#enumoptions-widgets-breaking-changes
Double-check our custom templates match the logic in the RJSF 5 Bootstrap 4 templates. (They moved where some of the handling takes place)

Future Work

Attempt to replace ajv 6 with CloudFlare’s validator in our repo
Potentially upstream it (could be a substantial amount of work)

Checklist

Do some smoke tests
Double-check updated snapshots
Designate a primary reviewer

fregante · 2022-12-30T09:16:29Z

package.json

+    "@rjsf/bootstrap-4": "^5.0.0-beta.15",
+    "@rjsf/core": "^5.0.0-beta.15",
+    "@rjsf/utils": "^5.0.0-beta.15",
+    "@rjsf/validator-ajv6": "^5.0.0-beta.15",


I'm only updating rjsf here, not the validator. Let's ensure it works first and then move to CloudFlare’s validator, not ajv 8

fregante · 2022-12-30T09:18:10Z

src/components/formBuilder/preview/FormPreviewBooleanField.tsx

 import React from "react";
 import FormPreviewFieldTemplate, {
  type FormPreviewFieldProps,
 } from "./FormPreviewFieldTemplate";
 import styles from "./FormPreviewBooleanField.module.scss";

-const RjsfBooleanField = RjsfTheme.fields.BooleanField;
+const RjsfBooleanField = getDefaultRegistry().fields.BooleanField;


Double check that this produces the output we expect

According to the upgrade guide, they reduced duplicated code so it's possible that these fields are shared now. Maybe the theme needs to be applied separately though

codecov · 2022-12-30T09:19:58Z

Codecov Report

Attention: 17 lines in your changes are missing coverage. Please review.

Comparison is base (838a5ad) 70.96% compared to head (23f398a) 70.96%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/bricks/renderers/CustomFormComponent.tsx	37.50%	5 Missing ⚠️
src/components/formBuilder/FieldTemplate.tsx	68.75%	5 Missing ⚠️
...omponents/formBuilder/DescriptionFieldTemplate.tsx	72.72%	3 Missing ⚠️
src/pageEditor/slices/editorSlice.ts	66.66%	2 Missing ⚠️
...ionConsole/pages/integrations/IntegrationsPage.tsx	0.00%	1 Missing ⚠️
src/pageEditor/slices/editorSliceHelpers.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4913   +/-   ##
=======================================
  Coverage   70.96%   70.96%           
=======================================
  Files        1204     1206    +2     
  Lines       37237    37260   +23     
  Branches     6972     6983   +11     
=======================================
+ Hits        26424    26442   +18     
- Misses      10813    10818    +5

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

fregante · 2023-01-04T15:38:53Z

So this seems to work already. Could you review the code changes, the snapshots and double-check that the document builder works as expected? I did some testing and saw zero issues.

This might be a good time to re-confirm that we're going to stay on RJSF and not migrating to greener pastures (if any exist.) For example you could look at the buglist to see if you see any dealbreakers https://github.com/rjsf-team/react-jsonschema-form/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug

twschiller · 2023-01-23T13:35:29Z

This might be a good time to re-confirm that we're going to stay on RJSF

We're staying on RJSF. I don't know of any greener pastures

Looks like they'll be releasing final 5.0 version this month (hopefully): rjsf-team/react-jsonschema-form#3144

twschiller · 2023-01-23T13:47:18Z

twschiller · 2023-01-23T13:59:05Z

@fregante see here: #4913 (comment)

I bumped to the latest beta. The story shot changes look fine to me. They just changed the id format for fields

twschiller

See regressions

grahamlangford · 2023-11-27T18:21:24Z

Looks good other than the failing test. I'll add it to my list to debug.

… into F/deps/upgrade-to-rjsf-5

…view.tsx

src/tinyPages/ephemeralForm.html

github-actions · 2023-12-04T22:00:36Z

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.

fregante · 2023-12-04T22:13:27Z

fregante added 2 commits December 30, 2022 14:59

Upgrade to RJSF5

cc7f6d1

Fix tests

239eae8

vercel bot deployed to Preview December 30, 2022 09:14 View deployment

fregante commented Dec 30, 2022

View reviewed changes

twschiller added the do not merge Merging of this PR is blocked by another one label Dec 30, 2022

twschiller assigned fregante and twschiller Dec 30, 2022

Merge branch 'main' into F/deps/upgrade-to-rjsf-5

4d98fde

fregante marked this pull request as ready for review January 4, 2023 15:38

vercel bot deployed to Preview January 4, 2023 15:38 View deployment

fregante requested a review from twschiller January 4, 2023 15:41

Merge with origin/main; bump to beta 17

890914f

vercel bot deployed to Preview January 23, 2023 13:44 View deployment

twschiller requested changes Jan 23, 2023

View reviewed changes

twschiller added this to the 1.7.20 milestone Jan 26, 2023

fregante removed their assignment Jan 28, 2023

twschiller removed this from the 1.7.20 milestone Feb 10, 2023

twschiller added 2 commits February 11, 2023 14:52

Merge with main

f7de299

Bump to 5.1.0 and merge in main

321a838

twschiller removed the do not merge Merging of this PR is blocked by another one label Feb 11, 2023

vercel bot deployed to Preview February 11, 2023 19:58 View deployment

Add test cases

fd471d9

vercel bot deployed to Preview February 11, 2023 20:29 View deployment

Fix title; add some tests

819288f

twschiller marked this pull request as draft February 11, 2023 20:57

fregante assigned BLoe and unassigned twschiller Nov 24, 2023

fregante requested a review from BLoe November 24, 2023 07:45

Merge remote-tracking branch 'origin/main' into F/deps/upgrade-to-rjsf-5

b372744

vercel bot deployed to Preview November 29, 2023 06:19 View deployment

fregante added 2 commits November 29, 2023 15:29

Merge branch 'main' of https://github.com/pixiebrix/pixiebrix-extension…

f773b10

… into F/deps/upgrade-to-rjsf-5

Run prettier

ac5abe0

vercel bot deployed to Preview November 29, 2023 07:32 View deployment

Discard changes to src/components/formBuilder/preview/SelectWidgetPre…

622dbba

…view.tsx

vercel bot deployed to Preview November 29, 2023 07:34 View deployment

merge main and fix type issues

8e42e56

vercel bot deployed to Preview December 4, 2023 18:36 View deployment

fixes issue with rendering markdown in rjsf

cc553b0

vercel bot deployed to Preview December 4, 2023 20:11 View deployment

github-advanced-security bot found potential problems Dec 4, 2023

View reviewed changes

src/tinyPages/ephemeralForm.html Fixed Show fixed Hide fixed

grahamlangford added 2 commits December 4, 2023 14:12

removes console log

022be5c

comment out react dev tools code

1b9bb64

vercel bot deployed to Preview December 4, 2023 20:15 View deployment

grahamlangford added 2 commits December 4, 2023 15:06

fix snapshot

b8f8a9b

resolves strictNullChecks error

23f398a

grahamlangford requested a review from twschiller December 4, 2023 21:59

grahamlangford approved these changes Dec 4, 2023

View reviewed changes

vercel bot deployed to Preview December 4, 2023 22:00 View deployment

twschiller approved these changes Dec 4, 2023

View reviewed changes

twschiller merged commit 5624ac3 into main Dec 4, 2023
17 checks passed

twschiller deleted the F/deps/upgrade-to-rjsf-5 branch December 4, 2023 23:28

grahamlangford added this to the 1.8.5 milestone Dec 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#3059: Upgrade to RJSF5 #4913

#3059: Upgrade to RJSF5 #4913

fregante commented Dec 30, 2022 •

edited by twschiller

fregante Dec 30, 2022

fregante Dec 30, 2022

codecov bot commented Dec 30, 2022 •

edited

fregante commented Jan 4, 2023 •

edited

twschiller commented Jan 23, 2023

twschiller commented Jan 23, 2023 •

edited

twschiller commented Jan 23, 2023

twschiller left a comment

grahamlangford commented Nov 27, 2023

github-actions bot commented Dec 4, 2023

fregante commented Dec 4, 2023

#3059: Upgrade to RJSF5 #4913

#3059: Upgrade to RJSF5 #4913

Conversation

fregante commented Dec 30, 2022 • edited by twschiller

What does this PR do?

Reviewer Tips

Remaining Work

Future Work

Checklist

fregante Dec 30, 2022

Choose a reason for hiding this comment

fregante Dec 30, 2022

Choose a reason for hiding this comment

codecov bot commented Dec 30, 2022 • edited

Codecov Report

fregante commented Jan 4, 2023 • edited

twschiller commented Jan 23, 2023

twschiller commented Jan 23, 2023 • edited

Potential bugs/regressions:

Confirmed working

twschiller commented Jan 23, 2023

twschiller left a comment

Choose a reason for hiding this comment

grahamlangford commented Nov 27, 2023

github-actions bot commented Dec 4, 2023

fregante commented Dec 4, 2023

fregante commented Dec 30, 2022 •

edited by twschiller

codecov bot commented Dec 30, 2022 •

edited

fregante commented Jan 4, 2023 •

edited

twschiller commented Jan 23, 2023 •

edited