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.

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

feat: handle plugins with Vite [LIBS-610] #863

Merged
merged 35 commits into from
Jul 25, 2024
Merged

feat: handle plugins with Vite [LIBS-610] #863

merged 35 commits into from
Jul 25, 2024

Conversation

KaiVandivier
Copy link
Contributor

@KaiVandivier KaiVandivier commented Jul 11, 2024 •
edited
Loading

LIBS-610

Accomplishes some nice things:

  1. Pretty much instant startup for plugins
  2. Removes webpack config and related CLI code
  3. Shared code & assets between app and plugin is great ✨ -- testing builds of the PWA example app with a plugin between master and this branch, the total build size is now less than half
  4. App and plugin are conceptually separated more in the CLI -- it's now easier to build a plugin without building an app
  5. Smaller cache size when developing a PWA app locally -- this was actually a problem with the webpack dev server too

Changes made:

  1. Vite config moved a file in shell to a function in the CLI to be more dynamic based on config. Requires Node API; used dynamic import and MJS
    1. Moved Vite deps to CLI from shell
    2. No longer need to execute ‘start’ and ‘build’ scripts in shell dir to make things happen
    3. Changed up Env handling a bit; need to do some more manual string replacement on things that were previously added to env via the CLI
  2. Added dynamic inputs to build process (don’t need it for the dev server; Vite just fires up everything in the root dir)
  3. Apps and plugins are now handled in the same process; don’t need two scripts
  4. Fixed up ‘deploy’ script for plugin without an app
  5. Changed up config validation & build process a bit to make it easier to handle plugins without apps
    1. Removed need for ‘getOriginalEntrypoints’ to tell if something actually has an app entrypoint defined or not
  6. Service worker
    1. Don’t need plugin precache manifest (it’s part of the rest)
    2. Added a special “Dev Network First” caching strategy to "hit two flies in one swing": avoid "cache bloat" from constantly updating source files with new version hashes, and enable going offline immediately after HMR updates (long story)
  7. Shell plugin files updated
    1. Refactored dynamic import — I forget exactly what was happening, but I think if an app was built without a plugin, the plugin HTML still tried to find that entry point but it wouldn't exist after the App replaced it
    2. Since app and plugin now run on the same script and have the same env vars, needed a new way to determine the ‘IS_PLUGIN’ var -- I chose to do a string replacement at bootstrapping time, which helps with dead code elimination (apps can drop all the plugin stuff). I used self.__IS_PLUGIN as the replacement target to distinguish it from other vars that are being populated from the env (kinda)

@KaiVandivier
chore: update yarn.lock
db8d796
@KaiVandivier
refactor: use Vite Node API for starting apps
905cb08
@KaiVandivier
chore: extend gitignore
d7766f5
@KaiVandivier
feat: use Vite Node API to build apps
59cfc54
@KaiVandivier
feat: build & serve plugins with Vite
76c4947
@KaiVandivier
chore: clean up unused "start app or plugin" logic
9212652
@KaiVandivier
chore: clean up old plugin code (yay!)
3dafe62
@KaiVandivier
chore: update pwa example app to jsx extensions
ac59f88
@KaiVandivier
chore: one more JSX
d7a50f3
@KaiVandivier
feat: make building apps and plugins independent
5244f53
@KaiVandivier
chore: update vite dependency location
b76c09e
@KaiVandivier
fix(deploy): support deploying plugins without an app
90bcc11
@KaiVandivier
chore: comment
1d76c45
@KaiVandivier
Merge branch 'alpha' into libs-610-vite-for-plugins
0dc2188
@KaiVandivier
fix: default config type
53bf5e5
@KaiVandivier
fix: solve clunky exit from start script with ctrl-C
fc7193d
@KaiVandivier
fix: handle undefined defaults
77a7460
@KaiVandivier
fix: leaner caching in dev (wip)
a5788de
@KaiVandivier
fix: handling 400+ & 500+ responses
2131356
@KaiVandivier
refactor: move strategies to new file
be612f4
@KaiVandivier
fix: dev caching strategy
c6a5a01
@KaiVandivier
refactor: inject isPlugin var at bootstrap time
03a507a
@KaiVandivier
chore: delete unused static vite config
92a4d93
@KaiVandivier KaiVandivier requested a review from a team July 12, 2024 11:45
@KaiVandivier KaiVandivier merged commit ca5be0d into alpha Jul 25, 2024
5 checks passed
@KaiVandivier KaiVandivier deleted the libs-610-vite-for-plugins branch July 25, 2024 14:42
dhis2-bot added a commit that referenced this pull request Jul 25, 2024
@dhis2-bot
chore(release): cut 12.0.0-alpha.5 [skip release]
7cc9afb 
# [12.0.0-alpha.5](v12.0.0-alpha.4...v12.0.0-alpha.5) (2024-07-25)

### Features

* handle plugins with Vite [LIBS-610] ([#863](#863)) ([ca5be0d](ca5be0d))
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 12.0.0-alpha.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

dhis2-bot added a commit that referenced this pull request Dec 13, 2024
@dhis2-bot
chore(release): cut 12.0.0 [skip release]
bbcd124 
# [12.0.0](v11.7.5...v12.0.0) (2024-12-13)

### Bug Fixes

* **deps:** upgrade app-runtime and ui ([#895](#895)) ([8ed0ec3](8ed0ec3))
* **deps:** upgrade react to 18 in example apps ([#900](#900)) ([7fd16d7](7fd16d7))
* **deps:** use npm v6 before publishing ([01ad502](01ad502))
* **init:** update bootstrap script branch ([#896](#896)) ([33c261a](33c261a))
* **plugin:** clean up resize observer and handle sonarqube warnings ([#898](#898)) ([f113dd5](f113dd5))
* alerts from plugins [LIBS-695] ([#881](#881)) ([21be0d2](21be0d2))
* allow serving files from cwd node_modules ([0233949](0233949))
* base url env & refactor [LIBS-635] ([#872](#872)) ([7f19259](7f19259))
* bump ui library ([#882](#882)) ([1ae9569](1ae9569))
* clear only required build dirs ([#894](#894)) ([179305f](179305f))
* env refactor for Vite wrap-up [LIBS-690] ([#889](#889)) ([84da4e6](84da4e6))
* injectPrecacheManifest warning logging ([a0d266e](a0d266e))
* normalize to .js extensions when compiling libraries ([#893](#893)) ([58b33a8](58b33a8))
* **service-worker:** handle undefined config vars in injectPrecacheManifest ([a90a4e0](a90a4e0))
* correct app shell paths ([#883](#883)) ([a1af71c](a1af71c))
* handle jsx in js support [LIBS-633] ([#871](#871)) ([595a35d](595a35d))
* increase precache max file size to 3 MB ([b20ed22](b20ed22))
* remove custom eslint from TS template ([71cef4b](71cef4b))
* update deps ([1e7ce93](1e7ce93))
* update workbox deps to avoid deprecation warnings ([9a81c4a](9a81c4a))
* use strings for 'boolean' env vars ([eaf5e66](eaf5e66))

### Features

* create initial TS template ([#868](#868)) ([2795f79](2795f79))
* enable HMR for .js files ([5f4683c](5f4683c))
* handle plugins with Vite [LIBS-610] ([#863](#863)) ([ca5be0d](ca5be0d))
* jsx migration script ([#869](#869)) ([7764f49](7764f49))
* migrate snap files too ([#878](#878)) ([521f483](521f483))
* replace CRA with Vite [LIBS-598] ([#847](#847)) ([3dd0e59](3dd0e59))
* upgrade react to v18 ([#876](#876)) ([77ecf10](77ecf10))
* **init:** set direction: 'auto' and import locales for new apps [LIBS-645] ([#867](#867)) ([4eda4a9](4eda4a9))

### BREAKING CHANGES

* require react version 18

* fix: pin react version to 18

* test: update test and test libraries for react 18
* Supported Node versions are 18.x or 20+

* ci: upgrade Node version

* fix: always add PWA_ENABLED to app env for better static analysis

* chore: pause precache manifest injection

* fix: building SW without CRA

* chore: comment update

* fix: group moment locales in their own dir

* refactor: clean up precache injection

* fix: locale utils and handling moment in jest

* fix: compile correctly after merging changes

* chore: comment in compile.js

* chore: some clean-up

* chore: comments

* fix: use port 3000 for the dev server

* fix: improve moment locale chunk naming

* chore: remove CRA

* fix: use mjs build of Vite

* fix: bump cli-style for CRA fix

* feat: use interactive dev server output from Vite

* fix: make dev server port configurable

* chore: remove old index.html

* fix: env tweaks
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 12.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kabaros kabaros kabaros approved these changes

Assignees
No one assigned
Labels
released on @alpha released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@KaiVandivier @dhis2-bot @kabaros