fides icon indicating copy to clipboard operation
fides copied to clipboard

Migrate `fidesui` to `fides/clients`

Open gilluminate opened this issue 1 year ago • 3 comments

Closes PROD-2067

Description Of Changes

  • Include as part of the clients monorepo using turbo
  • Replace imports in Privacy Center and Admin UI with this new package version
  • Build/Bundle as part of those project using NextJS transpileModules
  • Include all components as one flat package instead of splitting between react and components
  • New README explaining the migration and package

Code Changes

  • FidesUI is now part of the turbo monorepo as an Internal Package
  • Fides UI now gets bundled by NextJS using the next-transpile-modules npm package
  • For now does not have a Storybook implementation as we investigate and determine the future of this project.
  • In light of all of the above, Lerna is no longer needed or included.
  • Sub-directories are now all collapsed to a single index
  • search/replace any instances of the following with fidesui
    • @fidesui/react
    • @fidesui/components
    • @chakra-ui/react
    • @chakra-ui/icons
  • rename FidesProvider to FidesUIProvider for clarity
  • New README.md file for FidesUI explaining the migration and current usage

Steps to Confirm

  • Run cypress tests for admin-ui and privacy-center
  • General smoke testing and regression testing.

Pre-Merge Checklist

  • [ ] All CI Pipelines Succeeded
  • [x] Issue Requirements are Met
  • [x] Relevant Follow-Up Issues Created
  • [ ] Update CHANGELOG.md

gilluminate avatar May 10 '24 21:05 gilluminate

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
fides-plus-nightly ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 14, 2024 8:17pm

vercel[bot] avatar May 10 '24 21:05 vercel[bot]

Passing run #7728 ↗︎

0 4 0 0 Flakiness 0
⚠️ You've recorded test results over your free plan limit.
Upgrade your plan to view test results.

Details:

Merge f4479c2e4eb45b7f595af10bec6af20499d212e6 into be252e4ebbcba681878f51e01fe5...
Project: fides Commit: 8cc8e25977 ℹ️
Status: Passed Duration: 00:35 💡
Started: May 14, 2024 8:26 PM Ended: May 14, 2024 8:27 PM

Review all test suite changes for PR #4880 ↗︎

cypress[bot] avatar May 10 '24 21:05 cypress[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.75%. Comparing base (be252e4) to head (f4479c2).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4880      +/-   ##
==========================================
- Coverage   86.76%   86.75%   -0.01%     
==========================================
  Files         347      347              
  Lines       20927    20927              
  Branches     2736     2736              
==========================================
- Hits        18157    18156       -1     
- Misses       2294     2295       +1     
  Partials      476      476              

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 10 '24 22:05 codecov[bot]

Starting review...

eastandwestwind avatar May 14 '24 15:05 eastandwestwind