Research Migration Details

[sydneywalcoff]

Overview

The Create React App(CRA) deprecation leaves EA open to lack of support, security risks, and performance issues. To avoid issues moving forward, EA is migrating to use Vite as our build tool.

Action Items

• read getting started/migration docs
• answer questions
  • do we have CRA specific code that needs to be updated?
  • does this effect testing? if so, how?
• handoff to Dev Conduct Migration #1577
  • add research question results
  • remove dependency The issue or reason why this issue is in the icebox label
  • add ready for dev lead task ready for dev lead to evaluate label
  • move to new issue approval column

Resources/Notes

Vite Docs

Notes & Questions

• Is our type checking and/or linting coming from CRA?

  • linting: no
  • type checking: typescript

• Process?

  • in the /products folder, run npm create vite@latest
  • use the react-ts template
  • call the new folder statement-generator-vite
  • move to the /statement-generator-vite folder and run npm i then runnpm run dev
  • make sure it compiles without any problems
  • install packages AT the version listed in /statement-generator/package.json
    • everything except packages related to @testing-library and react-scripts
  • update /statement-generator-vite/package.json scripts
  • copy over content of /statement-generator/src and /statement-generator/public folders
    • a lot will just be able to be copy-pasted over
    • /statement-generator/public
      • copy everything except:
        • logo192.png
        • logo512.png
      • comment out the manifest.json
    • /statement-generator/src
      • only files not copied over:
        • setupTests.js
        • react-app-env.d.ts
  • rename ENV variables
  • resolve any warnings that may come up
  • translate /statement-generator/tsconfig.json settings into /statement-generator-vite/tsconfig.json
    • if anything is conflicting notate what the default generated setting in /statement-generator-vite/tsconfig.json is and replace it with the value in the CRA set up.
  • update /.github/workflows/master-deploy.yml
    • change folder: products/statement-generator/build to folder: products/statement-generator/dist
  • test locally
    • running the build command and making sure it builds successfully
    • running the preview command and making sure the app looks and runs correctly

• Testing

  • this will affect any test suites that utilize @testing-library which is most of them. I'm setting up a separate issue to migrate our testing stuff once that's complete

[github-actions]

Hey @sydneywalcoff! Thanks for taking this issue.

To help keep everyone in the loop, please comment your Estimated Time to Completion (ETC) below!

Thanks again!

[sydneywalcoff]

ETC: 3 days

[sydneywalcoff]

Progress: I completed the migration from a research perspective on a personal project. I'm now notating the application for EA.
Estimated Time to Completion (ETC): Another couple days (3?)
Blockers: Nope

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!

[github-actions]

Hey @sydneywalcoff! Thanks again for taking this issue.

Time for an update! Please comment the following update:
**Progress:** What's the status of the project? What have you done and what still needs to be done?
**Estimated Time to Completion (ETC):** When do you estimate to be finished?
**Blockers:** Anything preventing you from finishing?

Thanks again!