feat(hmr): add in hmr capabilities #1400

brandonseydel · 2022-04-25T04:37:29Z

Pull Request

📖 Description

🎫 Issues

👩‍💻 Reviewer Notes

📑 Test Plan

⏭ Next Steps

bigopon

Looks great! Can we have some demo gif pls 😄

packages-cjs/plugin-conventions/src/preprocess-resource.ts

3cp · 2022-04-25T05:20:54Z

I am against to add HMR inside conventions.

HMR sounds like has nothing to do with conventions.
If user manually writes customElement decorator, it will bypass conventions logic. But we still want to support HMR in that use case. I believe the implementation here didn't cover the use case.

User can also write Aurelia 2 app without using our conventions in the toolchain at all. Aka, totally manual and verbose code.

For the above two arguments, I suggest to invest the possibility to add HMR support in other place (or a standalone npm package like we did for Aurelia v1).

brandonseydel · 2022-04-25T13:13:50Z

I am against to add HMR inside conventions.

HMR sounds like has nothing to do with conventions.

If user manually writes customElement decorator, it will bypass conventions logic. But we still want to support HMR in that use case. I believe the implementation here didn't cover the use case.

User can also write Aurelia 2 app without using our conventions in the toolchain at all. Aka, totally manual and verbose code.

For the above two arguments, I suggest to invest the possibility to add HMR support in other place (or a standalone npm package like we did for Aurelia v1).

I think plugin-conventions is just a naming problem and this code indeed belongs here. We shouldn't be making double processing a thing from our one plugin. There is an issue with a standalone package as it would be one file with not really any code (more an interpolated string). This is overkill. I would suggest just renaming conventions and letting it include more than just conventions in the plugin.

@aurelia/cli
@aurelia/processor

…as well

…at/hmr

Sayan751 · 2022-04-25T16:01:54Z

I think not everyone would like to use the convention, though. I think it would be better to create multiple plugins (if not multiple packages) that focuses on a single aspect, and then an umbrella plugin to aggregate the config or whatever for the ease of use (although it can be postponed if super complicated or if the individual plugins can be easily used). IMO, it is important to ensure that HMR works individually without relying on convention.

brandonseydel · 2022-04-25T16:27:45Z

I think not everyone would like to use the convention, though. I think it would be better to create multiple plugin (if not multiple packages) that focuses on a single aspect, and then an umbrella plugin to aggregate the config or whatever for the ease of use (although it might be postponed if super complicated or if the individual plugins can be easily used). IMO, it is important to ensure that HMR works individually without relying on convention.

It doesn't rely on convention. HMR operates by itself entirely in the plugin-convention package. That is why I am thinking it is named improperly as it takes care of more than just one thing. We can seperate out into many packages, but there should be one entry into code manipulation I feel.

3cp · 2022-04-27T04:37:48Z

I recall, quite some time ago, we talked about moving all package-cjs into individual repos.

Those packages are not core packages. Putting them into monorepo actually hurts development more than helping, especially the cjs/esm mode build switching for local setup.

We should revisit the idea before production release.

bigopon · 2022-04-27T06:46:30Z

cjs/esm mode build switching for local setup

With rollup, we no longer need to switch to build. Though we are still switching the main and module fields to run the tests of these packages. If we are to split it out, I'd imagine it'd be more difficult.

When running test with mocha, we still need to do this because some reasons I'm not sure 100% yet. Running mocha --loader esm or mocha --register ts-node/esm didn't seem to work. I'll need to investigate that.

3cp · 2022-04-27T07:02:43Z

If you don't use "type": "module" in package.json, you can still ship both cjs and esm with explicit .cjs and .mjs files. And mocha should work better. At least my ava setup is happier with default commonjs type in package.json.

"main": "dist/index.cjs",
  "module": "dist/index.mjs",
  "types": "dist/index.d.ts",
  "exports": {
// works with require(...)
    "require": "dist/index.cjs",
// works with import.
    "import": "dist/index.mjs"
  },

Ref: https://github.com/gorbjs/shared/blob/main/package.json

bigopon · 2022-04-27T11:46:50Z

@3cp thanks, I'll be applying that.

brandonseydel · 2022-04-27T14:26:33Z

I guess our next task is to find a name that is appropriate for the package. Any suggestion on that? Some immediate candidates:

component-processor

resource-processor
maybe add pre prefix to processor. Any suggestions?

@bigopon some more

@aurelia/processor
@aurelia/pre-processor

…/hmr

bigopon · 2022-04-28T12:54:34Z

I've created a discussion for our rename here #1404
I think we can go ahead first, with a rename later.

codecov · 2022-04-28T13:02:20Z

Codecov Report

Merging #1400 (0561f22) into master (585d94c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1400   +/-   ##
=======================================
  Coverage   87.07%   87.07%           
=======================================
  Files         212      212           
  Lines       17505    17505           
  Branches     4106     4106           
=======================================
  Hits        15243    15243           
  Misses       2262     2262

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

…at/hmr

3cp · 2022-04-28T23:44:40Z

@brandonseydel BTW, I could not get my head around how to support vite prod build.

Vite uses different path for dev and prod build. The prod build tries to parse our html as html, but we already transpiled html into js code. The whole rollup chain does not have concept of asset type, nor allowing changing extname in id (the file name).

When you are on Vite, see if you can come up with any workaround, thx.

For reference: the vite au2 plugin which works (kind of) in dev mode:
https://github.com/3cp/au2-vite/blob/main/vite.config.ts

brandonseydel · 2022-04-29T02:28:57Z

@brandonseydel BTW, I could not get my head around how to support vite prod build.

Vite uses different path for dev and prod build. The prod build tries to parse our html as html, but we already transpiled html into js code. The whole rollup chain does not have concept of asset type, nor allowing changing extname in id (the file name).

When you are on Vite, see if you can come up with any workaround, thx.

For reference: the vite au2 plugin which works (kind of) in dev mode: https://github.com/3cp/au2-vite/blob/main/vite.config.ts

Yea been fighting with vite some on the mangler side of things. It doesn't seem to want to listen when using esbuild.....

3cp · 2023-04-26T23:22:39Z

packages-cjs/plugin-conventions/src/preprocess.ts

@@ -27,7 +27,12 @@ export function preprocess(
        unit.filePair = path.basename(filePair);
      }
    }
-    return preprocessHtmlTemplate(unit, allOptions);
+
+    const hasViewModel = Boolean(allOptions.jsExtensions.map(e =>


@brandonseydel I might be confused, but I don't think this ever worked. We don't unit test hmr setup, so might missed this bug.

Boolean([false, false]) yields true

cc @bigopon

@brandonseydel @bigopon my bad, I miss understood the code :(

feat(hmr): add in hmr capabilities

1273a7a

bigopon force-pushed the master branch from e8b3426 to c741413 Compare April 25, 2022 04:54

bigopon reviewed Apr 25, 2022

View reviewed changes

packages-cjs/plugin-conventions/src/preprocess-resource.ts Outdated Show resolved Hide resolved

packages-cjs/plugin-conventions/src/preprocess-resource.ts Outdated Show resolved Hide resolved

bigopon force-pushed the master branch from c741413 to adb69a2 Compare April 25, 2022 05:13

bigopon force-pushed the master branch 18 times, most recently from 23d93cc to 8a0fb9c Compare April 25, 2022 12:09

Merge branch 'master' into feat/hmr

b725434

brandonseydel added 3 commits April 25, 2022 10:12

chore(fix): cleanup some code and make it work for decorated classes …

6e3efe4

…as well

Merge branch 'feat/hmr' of https://github.com/aurelia/aurelia into fe…

1f4308d

…at/hmr

chore(clean): remove console.log

f375857

brandonseydel added 3 commits April 26, 2022 16:45

fix(tests): fix some tests

fd7307c

fix(build): fix some build errors

6c1613a

fix(tests): fix some tests

f8fd73a

fix(lint): fix some linting issues

9c28505

brandonseydel added 2 commits April 27, 2022 06:49

fix(test): fix all the tests

e5b70a1

fix(lint): fix issue with curly

f7a656a

brandonseydel and others added 4 commits April 27, 2022 09:29

fix(lint): fix lint error again

950c425

fix(tests): fix some tests

192f60c

chore(fix): remove interfaces we don't need any longer from import

89faa49

Merge branch 'master' of https://github.com/aurelia/aurelia into feat…

122a1c8

…/hmr

fix(hmr): also import IHydrationContext

f419318

bigopon added this to the v2.0-beta milestone Apr 28, 2022

brandonseydel added 3 commits April 28, 2022 13:59

feat(vite): prepare for vite hmr

b45fc05

Merge branch 'feat/hmr' of https://github.com/aurelia/aurelia into fe…

dc30899

…at/hmr

fix(vite): for some reason the accept has to be off the import directly

11ca2ca

brandonseydel and others added 3 commits April 28, 2022 21:32

fix(tests): add in explicit hmrmodule for testing

7886938

Merge branch 'master' into feat/hmr

3028b40

fix(hmr): reexport LifecycleFlags from runtime

0561f22

bigopon merged commit 6d932a7 into master May 5, 2022

bigopon deleted the feat/hmr branch May 5, 2022 23:08

3cp reviewed Apr 26, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(hmr): add in hmr capabilities #1400

feat(hmr): add in hmr capabilities #1400

brandonseydel commented Apr 25, 2022

bigopon left a comment

3cp commented Apr 25, 2022

brandonseydel commented Apr 25, 2022 •

edited

Sayan751 commented Apr 25, 2022 •

edited

brandonseydel commented Apr 25, 2022

3cp commented Apr 27, 2022

bigopon commented Apr 27, 2022

3cp commented Apr 27, 2022

bigopon commented Apr 27, 2022

brandonseydel commented Apr 27, 2022 •

edited

bigopon commented Apr 28, 2022

codecov bot commented Apr 28, 2022 •

edited

3cp commented Apr 28, 2022

brandonseydel commented Apr 29, 2022

3cp Apr 26, 2023

3cp Apr 26, 2023

feat(hmr): add in hmr capabilities #1400

feat(hmr): add in hmr capabilities #1400

Conversation

brandonseydel commented Apr 25, 2022

Pull Request

📖 Description

🎫 Issues

👩‍💻 Reviewer Notes

📑 Test Plan

⏭ Next Steps

bigopon left a comment

Choose a reason for hiding this comment

3cp commented Apr 25, 2022

brandonseydel commented Apr 25, 2022 • edited

Sayan751 commented Apr 25, 2022 • edited

brandonseydel commented Apr 25, 2022

3cp commented Apr 27, 2022

bigopon commented Apr 27, 2022

3cp commented Apr 27, 2022

bigopon commented Apr 27, 2022

brandonseydel commented Apr 27, 2022 • edited

bigopon commented Apr 28, 2022

codecov bot commented Apr 28, 2022 • edited

Codecov Report

3cp commented Apr 28, 2022

brandonseydel commented Apr 29, 2022

3cp Apr 26, 2023

Choose a reason for hiding this comment

3cp Apr 26, 2023

Choose a reason for hiding this comment

brandonseydel commented Apr 25, 2022 •

edited

Sayan751 commented Apr 25, 2022 •

edited

brandonseydel commented Apr 27, 2022 •

edited

codecov bot commented Apr 28, 2022 •

edited