[legacy-framework] Add support for `blitz.config.ts` #1325

jamiedavenport · 2020-10-14T18:18:40Z

Closes: blitz-js/legacy-framework#632

What are the changes and their implications?

Checklist

Tests added for changes
PR submitted to blitzjs.com for any user facing changes

…ext.config.js

…ig.js

packages/installer/src/executors/executor.tsx

packages/installer/src/executors/file-transform-executor.tsx

jamiedavenport · 2020-10-14T18:24:52Z

A couple of things to note:

This solution copies the config over into the root as _blitz.config.js because I was experiencing this problem ([legacy-framework] Fix global middleware not running with blitz start --production #726) but I'm sure there must be a more elegant way.
Wrt testing, I'm not sure what a good unit test would look like for this yet. So I've relied on the cypress tests in the auth example. Do we think that's sufficient enough?

github-actions · 2020-10-14T18:28:09Z

Size Change: +1.35 kB (0%)

Total Size: 193 kB

Filename	Size	Change
`packages/config/dist/config.cjs.development.js`	1.4 kB	+48 B (3%)
`packages/config/dist/config.cjs.production.min.js`	943 B	+26 B (2%)
`packages/config/dist/config.esm.js`	1.33 kB	+49 B (3%)
`packages/file-pipeline/dist/file-pipeline.cjs.development.js`	5.96 kB	+74 B (1%)
`packages/file-pipeline/dist/file-pipeline.cjs.production.min.js`	3.06 kB	+49 B (1%)
`packages/file-pipeline/dist/file-pipeline.esm.js`	5.81 kB	+58 B (0%)
`packages/server/dist/server.cjs.development.js`	21.3 kB	+415 B (1%)
`packages/server/dist/server.cjs.production.min.js`	12.3 kB	+210 B (1%)
`packages/server/dist/server.esm.js`	21.4 kB	+424 B (1%)

ℹ️ View Unchanged

Filename	Size	Change
`packages/blitz/dist/cli.js`	15.7 kB	0 B
`packages/blitz/dist/index.js`	245 B	0 B
`packages/config/dist/index.js`	143 B	0 B
`packages/core/dist/core.cjs.development.js`	12.9 kB	0 B
`packages/core/dist/core.cjs.production.min.js`	6.98 kB	0 B
`packages/core/dist/core.esm.js`	12.5 kB	0 B
`packages/core/dist/index.js`	141 B	0 B
`packages/display/dist/display.cjs.development.js`	1.43 kB	0 B
`packages/display/dist/display.cjs.production.min.js`	819 B	0 B
`packages/display/dist/display.esm.js`	1.33 kB	0 B
`packages/display/dist/index.js`	144 B	0 B
`packages/file-pipeline/dist/index.js`	147 B	0 B
`packages/generator/dist/generator.cjs.development.js`	15.7 kB	0 B
`packages/generator/dist/generator.cjs.production.min.js`	9.51 kB	0 B
`packages/generator/dist/generator.esm.js`	15.4 kB	0 B
`packages/generator/dist/index.js`	145 B	0 B
`packages/generator/dist/templates/app/babel.config.js`	77 B	0 B
`packages/generator/dist/templates/app/blitz.config.js`	324 B	0 B
`packages/generator/dist/templates/app/jest.config.js`	682 B	0 B
`packages/generator/dist/templates/app/test/__mocks__/fileMock.js`	54 B	0 B
`packages/installer/dist/index.js`	145 B	0 B
`packages/installer/dist/installer.cjs.development.js`	7.69 kB	0 B
`packages/installer/dist/installer.cjs.production.min.js`	5.14 kB	0 B
`packages/installer/dist/installer.esm.js`	7.54 kB	0 B
`packages/repl/dist/index.js`	141 B	0 B
`packages/repl/dist/repl.cjs.development.js`	1.81 kB	0 B
`packages/repl/dist/repl.cjs.production.min.js`	1.08 kB	0 B
`packages/repl/dist/repl.esm.js`	1.69 kB	0 B
`packages/server/dist/index.js`	142 B	0 B

_{compressed-size-action}

ryardley · 2020-10-14T20:46:26Z

Sweet thanks for looking at this. I would recommend having a look at the workoptimizer test https://github.com/blitz-js/blitz/blob/5572c9c3239b7beb001cec1914e4b59fe5ee10c2/packages/file-pipeline/src/helpers/work-optimizer/work-optimizer.test.ts and writing one for the config stage.

The other stages need to be done too but that is out of the scope of this PR.

ryardley · 2020-10-14T20:52:39Z

This solution copies the config over into the root as _blitz.config.js because I was experiencing this problem (#726) but I'm sure there must be a more elegant way.

Not sure I understand what is going on here? Sounds to me like we probably shouldn't have to do this.

flybayer

Sweet!!

First thing: we must also be able to import other .ts files into blitz.config.ts and have it work correctly. I don't think this will work right now with this pr, right? Because for this to work, we basically need to run webpack on the config file to bundle it, right? I should have thought about and mentioned this in slack when we were talking about just using babel.

As for where to put the built file... My first thought is to put it at .next/__blitz.config.js because that's where we are bundling the db/index.ts file to as .next/__db.js. We can ensure that the .js blitz config always lives there, and then we can change @blitzjs/config to read from there. And then also the config stage would need changed to read from there too.

flybayer · 2020-10-14T20:36:34Z

packages/server/package.json

@@ -29,6 +29,7 @@
  "module": "dist/server.esm.js",
  "types": "dist/packages/server/src/index.d.ts",
  "dependencies": {
+    "@babel/core": "7.11.6",


Let's use a ^ range here so that we use the same version Next.js. Or, even we could maybe remove it from here since next includes it.

flybayer · 2020-10-14T20:58:51Z

ncc would be the easy way to bundle blitz.config.ts

jamiedavenport · 2020-10-18T14:08:03Z

packages/server/src/stages/config/index.ts

+    if (isBlitzTsConfigPath(file.path)) {
+      const res = await bundle(file.path, {
+        quiet: true,
+        externals: ["@blitzjs/server", "@next/bundle-analyzer"], // FIXME: Figure out why this wouldn't work? Do we need to bundle everything?


Not sure what to do here. ncc failed to bundle these 3rd party modules, although it shouldn't have to because they're already built. ncc doesn't seem to provide a nice way to do this (vercel/ncc#409) so I'm considering:

Maintain this list manually, thinking that there shouldn't be a lot of 3rd party modules that the config will be expected to import (mostly just auth stuff?)

Programmatically get all installed modules with yarn list --json or similar

What are your thoughts? @flybayer

flybayer · 2020-10-25T19:46:59Z

@jamiedavenport sorry I haven't had time to dig into this yet. Had some other life stuff interfere this week and some high priority bugs I'm working through. I'll get back to this as soon as I can.

jamiedavenport · 2020-11-17T21:00:50Z

@ryardley @flybayer would either of you guys be able to review this soon? 😃

flybayer · 2020-11-24T01:01:20Z

@jamiedavenport yeah, so sorry. I've been focused 100% on fixing a bunch of bugs for official beta status, and new features are a bit lower priority than that.

This week I'm very busy and have vacation, so hopefully I can give this full attention in first part of December.

flybayer · 2020-11-24T01:02:19Z

I need to really think through all potential edge cases and also test in multiple production deployments (Vercel and Render).

flybayer · 2021-01-21T16:10:36Z

NOTE: also need to update recipes to work with blitz.config.ts

flybayer · 2021-04-29T17:11:42Z

@jamiedavenport I'm really sorry I let this drop. I think subconsciously I knew ncc wasn't the right approach here (but at the time I didn't understand some of these tools well enough to know what else to do).

I've now implemented this using esbuild in a much cleaner way: #2283

I really, really appreciate the effort you put into this. I know it's a bummer to put a lot of effort into something that doesn't even get used. So for that I'm sorry 🙏

jamiedavenport added 8 commits October 12, 2020 20:51

Add check for blitz.config.ts file

20314c3

Add transpilation step to the config stage

fbc9b88

Add check for both .ts and .js config files

712e658

Update the auth example to use blitz.config.ts

6221782

Use module.exports instead of export default for compatability with n…

c08dc7d

…ext.config.js

Refactor the blitz.config.js code generation

fa7bb69

At build, move the plain or transpiled blitz.config.js to _blitz.conf…

4c05972

…ig.js

Merge branch 'canary' into support-blitz.config.ts

c5435fd

jamiedavenport requested review from aem, flybayer and ryardley as code owners October 14, 2020 18:18

blitzjs-bot bot added the status/in-review label Oct 14, 2020

jamiedavenport commented Oct 14, 2020

View reviewed changes

packages/installer/src/executors/executor.tsx Outdated Show resolved Hide resolved

jamiedavenport commented Oct 14, 2020

View reviewed changes

packages/installer/src/executors/file-transform-executor.tsx Outdated Show resolved Hide resolved

Fix the server unit tests

5572c9c

flybayer reviewed Oct 14, 2020

View reviewed changes

jamiedavenport added 8 commits October 14, 2020 23:42

Add ncc

a6a09d6

Get ncc working

fe9ced9

Output the bundled config at .next/__blitz.config.js

3d9d021

Fix next.config.js blitz config resolution

026f104

Remove __blitz.config.js generation

da87679

Remove _blitz.config.js from the gitignore template

b3b0535

Revert tree shaking

411c321

Copy blitz.config.js to .next directory on build

437d337

jamiedavenport added 4 commits October 15, 2020 22:17

Swap ?? for ternary operators

9df8448

Add tests for the config stage

5126214

Add test for tranpiling the ts config

714db48

Merge branch 'canary' into support-blitz.config.ts

6b8e2c7

jamiedavenport requested a review from merelinguist as a code owner October 18, 2020 13:07

Increase the transpile test timeout

38ed560

jamiedavenport requested a review from flybayer October 18, 2020 13:56

jamiedavenport commented Oct 18, 2020

View reviewed changes

jamiedavenport added 5 commits November 16, 2020 18:38

Merge branch 'canary' into support-blitz.config.ts

9f96c07

Fix config test imports

3b15f36

Upgrade ncc

203c24c

Merge branch 'canary' into support-blitz.config.ts

d4bfa15

Fix failing .config.ts build

cf92448

flybayer mentioned this pull request Jan 6, 2021

[legacy-framework] Add custom server support! #1492

Merged

2 tasks

blitzjs-bot bot added status/in-progress and removed status/in-review labels Feb 10, 2021

flybayer closed this Apr 29, 2021

blitzjs-bot added status/done and removed status/in-progress labels Apr 29, 2021

dillondotzip changed the title ~~Add support for blitz.config.ts~~ [legacy-framework] Add support for blitz.config.ts Jul 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[legacy-framework] Add support for `blitz.config.ts` #1325

[legacy-framework] Add support for `blitz.config.ts` #1325

jamiedavenport commented Oct 14, 2020 •

edited

Loading

jamiedavenport commented Oct 14, 2020

github-actions bot commented Oct 14, 2020 •

edited

Loading

ryardley commented Oct 14, 2020 •

edited

Loading

ryardley commented Oct 14, 2020

flybayer left a comment

flybayer Oct 14, 2020

flybayer commented Oct 14, 2020

jamiedavenport Oct 18, 2020

flybayer commented Oct 25, 2020

jamiedavenport commented Nov 17, 2020

flybayer commented Nov 24, 2020

flybayer commented Nov 24, 2020

flybayer commented Jan 21, 2021

flybayer commented Apr 29, 2021

[legacy-framework] Add support for blitz.config.ts #1325

[legacy-framework] Add support for blitz.config.ts #1325

Conversation

jamiedavenport commented Oct 14, 2020 • edited Loading

What are the changes and their implications?

Checklist

jamiedavenport commented Oct 14, 2020

github-actions bot commented Oct 14, 2020 • edited Loading

ryardley commented Oct 14, 2020 • edited Loading

ryardley commented Oct 14, 2020

flybayer left a comment

Choose a reason for hiding this comment

flybayer Oct 14, 2020

Choose a reason for hiding this comment

flybayer commented Oct 14, 2020

jamiedavenport Oct 18, 2020

Choose a reason for hiding this comment

flybayer commented Oct 25, 2020

jamiedavenport commented Nov 17, 2020

flybayer commented Nov 24, 2020

flybayer commented Nov 24, 2020

flybayer commented Jan 21, 2021

flybayer commented Apr 29, 2021

[legacy-framework] Add support for `blitz.config.ts` #1325

[legacy-framework] Add support for `blitz.config.ts` #1325

jamiedavenport commented Oct 14, 2020 •

edited

Loading

github-actions bot commented Oct 14, 2020 •

edited

Loading

ryardley commented Oct 14, 2020 •

edited

Loading