-
Notifications
You must be signed in to change notification settings - Fork 10.3k
/
webpack.config.js
924 lines (827 loc) · 28.9 KB
/
webpack.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
require(`v8-compile-cache`)
const crypto = require(`crypto`)
const fs = require(`fs-extra`)
const path = require(`path`)
const dotenv = require(`dotenv`)
const { CoreJSResolver } = require(`./webpack/plugins/corejs-resolver`)
const {
CacheFolderResolver,
} = require(`./webpack/plugins/cache-folder-resolver`)
const { store } = require(`../redux`)
const { actions } = require(`../redux/actions`)
const { getPublicPath } = require(`./get-public-path`)
const debug = require(`debug`)(`gatsby:webpack-config`)
const report = require(`gatsby-cli/lib/reporter`)
import { withBasePath, withTrailingSlash } from "./path"
import { getGatsbyDependents } from "./gatsby-dependents"
const apiRunnerNode = require(`./api-runner-node`)
import { createWebpackUtils } from "./webpack-utils"
import { hasLocalEslint } from "./local-eslint-config-finder"
import { getAbsolutePathForVirtualModule } from "./gatsby-webpack-virtual-modules"
import { StaticQueryMapper } from "./webpack/plugins/static-query-mapper"
import { ForceCssHMRForEdgeCases } from "./webpack/plugins/force-css-hmr-for-edge-cases"
import { WebpackLoggingPlugin } from "./webpack/plugins/webpack-logging"
import { hasES6ModuleSupport } from "./browserslist"
import { builtinModules } from "module"
import { shouldGenerateEngines } from "./engines-helpers"
import { ROUTES_DIRECTORY } from "../constants"
const { BabelConfigItemsCacheInvalidatorPlugin } = require(`./babel-loader`)
const FRAMEWORK_BUNDLES = [`react`, `react-dom`, `scheduler`, `prop-types`]
// Four stages or modes:
// 1) develop: for `gatsby develop` command, hot reload and CSS injection into page
// 2) develop-html: same as develop without react-hmre in the babel config for html renderer
// 3) build-javascript: Build JS and CSS chunks for production
// 4) build-html: build all HTML files
module.exports = async (
program,
directory,
suppliedStage,
port,
{ parentSpan } = {}
) => {
let fastRefreshPlugin
const modulesThatUseGatsby = await getGatsbyDependents()
const directoryPath = withBasePath(directory)
// We combine develop & develop-html stages for purposes of generating the
// webpack config.
const stage = suppliedStage
const { rules, loaders, plugins } = createWebpackUtils(stage, program)
const { assetPrefix, pathPrefix } = store.getState().config
const publicPath = getPublicPath({ assetPrefix, pathPrefix, ...program })
function processEnv(stage, defaultNodeEnv) {
debug(`Building env for "${stage}"`)
// node env should be DEVELOPMENT | PRODUCTION as these are commonly used in node land
// this variable is used inside webpack
const nodeEnv = process.env.NODE_ENV || `${defaultNodeEnv}`
// config env is dependent on the env that it's run, this can be anything from staging-production
// this allows you to set use different .env environments or conditions in gatsby files
const configEnv = process.env.GATSBY_ACTIVE_ENV || nodeEnv
const envFile = path.join(process.cwd(), `./.env.${configEnv}`)
let parsed = {}
try {
parsed = dotenv.parse(fs.readFileSync(envFile, { encoding: `utf8` }))
} catch (err) {
if (err.code !== `ENOENT`) {
report.error(
`There was a problem processing the .env file (${envFile})`,
err
)
}
}
const envObject = Object.keys(parsed).reduce((acc, key) => {
acc[key] = JSON.stringify(parsed[key])
return acc
}, {})
const gatsbyVarObject = Object.keys(process.env).reduce((acc, key) => {
if (key.match(/^GATSBY_/)) {
acc[key] = JSON.stringify(process.env[key])
}
return acc
}, {})
// Don't allow overwriting of NODE_ENV, PUBLIC_DIR as to not break gatsby things
envObject.NODE_ENV = JSON.stringify(nodeEnv)
envObject.PUBLIC_DIR = JSON.stringify(`${process.cwd()}/public`)
envObject.BUILD_STAGE = JSON.stringify(stage)
envObject.CYPRESS_SUPPORT = JSON.stringify(process.env.CYPRESS_SUPPORT)
envObject.GATSBY_EXPERIMENTAL_QUERY_ON_DEMAND = JSON.stringify(
!!process.env.GATSBY_EXPERIMENTAL_QUERY_ON_DEMAND
)
if (stage === `develop`) {
envObject.GATSBY_SOCKET_IO_DEFAULT_TRANSPORT = JSON.stringify(
process.env.GATSBY_SOCKET_IO_DEFAULT_TRANSPORT || `websocket`
)
}
const mergedEnvVars = Object.assign(envObject, gatsbyVarObject)
return Object.keys(mergedEnvVars).reduce(
(acc, key) => {
acc[`process.env.${key}`] = mergedEnvVars[key]
return acc
},
{
"process.env": `({})`,
}
)
}
function getHmrPath() {
// ref: https://github.com/gatsbyjs/gatsby/issues/8348
let hmrBasePath = `/`
const hmrSuffix = `__webpack_hmr&reload=true&overlay=false`
if (process.env.GATSBY_WEBPACK_PUBLICPATH) {
const pubPath = process.env.GATSBY_WEBPACK_PUBLICPATH
if (pubPath.substr(-1) === `/`) {
hmrBasePath = pubPath
} else {
hmrBasePath = withTrailingSlash(pubPath)
}
}
return hmrBasePath + hmrSuffix
}
debug(`Loading webpack config for stage "${stage}"`)
function getOutput() {
switch (stage) {
case `develop`:
return {
path: directory,
filename: `[name].js`,
// Add /* filename */ comments to generated require()s in the output.
pathinfo: true,
// Point sourcemap entries to original disk location (format as URL on Windows)
publicPath: process.env.GATSBY_WEBPACK_PUBLICPATH || `/`,
devtoolModuleFilenameTemplate: info =>
path.resolve(info.absoluteResourcePath).replace(/\\/g, `/`),
// Avoid React cross-origin errors
// See https://reactjs.org/docs/cross-origin-errors.html
crossOriginLoading: `anonymous`,
}
case `build-html`:
case `develop-html`:
// Generate the file needed to SSR pages.
// Deleted by build-html.js, since it's not needed for production.
return {
path: directoryPath(ROUTES_DIRECTORY),
filename: `[name].js`,
chunkFilename: `[name].js`,
library: {
type: `commonjs`,
},
publicPath: withTrailingSlash(publicPath),
}
case `build-javascript`:
return {
filename: `[name]-[contenthash].js`,
chunkFilename: `[name]-[contenthash].js`,
path: directoryPath(`public`),
publicPath: withTrailingSlash(publicPath),
}
default:
throw new Error(`The state requested ${stage} doesn't exist.`)
}
}
function getEntry() {
switch (stage) {
case `develop`:
return hasES6ModuleSupport(directory)
? {
commons: [directoryPath(`.cache/app`)],
}
: {
polyfill: directoryPath(`.cache/polyfill-entry`),
commons: [directoryPath(`.cache/app`)],
}
case `develop-html`:
return {
"render-page": process.env.GATSBY_EXPERIMENTAL_DEV_SSR
? directoryPath(`.cache/ssr-develop-static-entry`)
: directoryPath(`.cache/develop-static-entry`),
}
case `build-html`: {
return {
"render-page": directoryPath(`.cache/static-entry`),
}
}
case `build-javascript`:
return hasES6ModuleSupport(directory)
? {
app: directoryPath(`.cache/production-app`),
}
: {
polyfill: directoryPath(`.cache/polyfill-entry`),
app: directoryPath(`.cache/production-app`),
}
default:
throw new Error(`The state requested ${stage} doesn't exist.`)
}
}
function getPlugins() {
let configPlugins = [
plugins.moment(),
// Add a few global variables. Set NODE_ENV to production (enables
// optimizations for React) and what the link prefix is (__PATH_PREFIX__).
plugins.define({
...processEnv(stage, `development`),
__BASE_PATH__: JSON.stringify(program.prefixPaths ? pathPrefix : ``),
__PATH_PREFIX__: JSON.stringify(program.prefixPaths ? publicPath : ``),
__ASSET_PREFIX__: JSON.stringify(
program.prefixPaths ? assetPrefix : ``
),
// TODO Improve asset passing to pages
BROWSER_ESM_ONLY: JSON.stringify(hasES6ModuleSupport(directory)),
}),
plugins.virtualModules(),
new BabelConfigItemsCacheInvalidatorPlugin(),
process.env.GATSBY_WEBPACK_LOGGING?.split(`,`)?.includes(stage) &&
new WebpackLoggingPlugin(program.directory, report, program.verbose),
].filter(Boolean)
switch (stage) {
case `develop`: {
configPlugins = configPlugins
.concat([
(fastRefreshPlugin = plugins.fastRefresh({ modulesThatUseGatsby })),
new ForceCssHMRForEdgeCases(),
plugins.hotModuleReplacement(),
plugins.noEmitOnErrors(),
plugins.eslintGraphqlSchemaReload(),
new StaticQueryMapper(store),
])
.filter(Boolean)
configPlugins.push(
plugins.extractText({
filename: `[name].css`,
chunkFilename: `[id].css`,
})
)
if (process.env.GATSBY_EXPERIMENTAL_DEV_SSR) {
configPlugins.push(plugins.extractStats())
}
const isCustomEslint = hasLocalEslint(program.directory)
// get schema to pass to eslint config and program for directory
const { schema } = store.getState()
// if no local eslint config, then add gatsby config
if (!isCustomEslint) {
configPlugins.push(plugins.eslint(schema))
}
// Enforce fast-refresh rules even with local eslint config
if (isCustomEslint) {
configPlugins.push(plugins.eslintRequired())
}
break
}
case `build-javascript`: {
configPlugins = configPlugins.concat([
plugins.extractText({
filename: `[name].[contenthash].css`,
chunkFilename: `[name].[contenthash].css`,
}),
// Write out stats object mapping named dynamic imports (aka page
// components) to all their async chunks.
plugins.extractStats(),
new StaticQueryMapper(store),
])
break
}
case `develop-html`:
case `build-html`: {
// Add global fetch in node environments
configPlugins.push(
plugins.provide({
fetch: require.resolve(`node-fetch`),
"global.fetch": require.resolve(`node-fetch`),
})
)
break
}
}
return configPlugins
}
function getDevtool() {
switch (stage) {
case `develop`:
return `eval-cheap-module-source-map`
// use a normal `source-map` for the html phases since
// it gives better line and column numbers
case `develop-html`:
case `build-html`:
case `build-javascript`:
return `source-map`
default:
return false
}
}
function getMode() {
switch (stage) {
case `develop`:
case `develop-html`:
return `development`
case `build-javascript`:
case `build-html`:
default:
return `production`
}
}
function getModule() {
// Common config for every env.
// prettier-ignore
let configRules = [
// Webpack expects extensions when importing ESM modules as that's what the spec describes.
// Not all libraries have adapted so we don't enforce its behaviour
// @see https://github.com/webpack/webpack/issues/11467
{
test: /\.mjs$/i,
resolve: {
byDependency: {
esm: {
fullySpecified: false
}
}
}
},
{
test: /\.js$/i,
descriptionData: {
type: `module`
},
resolve: {
byDependency: {
esm: {
fullySpecified: false
}
}
}
},
rules.js({
modulesThatUseGatsby,
}),
rules.yaml(),
rules.fonts(),
rules.images(),
rules.media(),
rules.miscAssets(),
// This is a hack that exports one of @reach/router internals (BaseContext)
// to export list. We need it to reset basepath and baseuri context after
// Gatsby main router changes it, to keep v2 behaviour.
// We will need to most likely remove this for v3.
{
test: require.resolve(`@gatsbyjs/reach-router/es/index`),
type: `javascript/auto`,
use: [{
loader: require.resolve(`./reach-router-add-basecontext-export-loader`),
}],
}
]
// Speedup 🏎️💨 the build! We only include transpilation of node_modules on javascript production builds
// TODO create gatsby plugin to enable this behaviour on develop (only when people are requesting this feature)
if (stage === `build-javascript`) {
configRules.push(
rules.dependencies({
modulesThatUseGatsby,
})
)
}
switch (stage) {
case `develop`: {
configRules = configRules.concat([
{
oneOf: [rules.cssModules(), rules.css()],
},
])
break
}
case `build-html`:
case `develop-html`:
// We don't deal with CSS at all when building the HTML.
// The 'null' loader is used to prevent 'module not found' errors.
// On the other hand CSS modules loaders are necessary.
// prettier-ignore
configRules = configRules.concat([
{
oneOf: [
rules.cssModules(),
{
...rules.css(),
use: [loaders.null()],
},
],
},
])
break
case `build-javascript`:
// We don't deal with CSS at all when building JavaScript but we still
// need to process the CSS so offline-plugin knows about the various
// assets referenced in your CSS.
//
// It's also necessary to process CSS Modules so your JS knows the
// classNames to use.
configRules = configRules.concat([
{
oneOf: [rules.cssModules(), rules.css()],
},
])
break
}
return { rules: configRules }
}
function getPackageRoot(pkg) {
return path.dirname(require.resolve(`${pkg}/package.json`))
}
function getResolve(stage) {
const { program } = store.getState()
const resolve = {
// Use the program's extension list (generated via the
// 'resolvableExtensions' API hook).
extensions: [...program.extensions],
alias: {
gatsby$: directoryPath(path.join(`.cache`, `gatsby-browser-entry.js`)),
// Using directories for module resolution is mandatory because
// relative path imports are used sometimes
// See https://stackoverflow.com/a/49455609/6420957 for more details
"@babel/runtime": getPackageRoot(`@babel/runtime`),
"@reach/router": getPackageRoot(`@gatsbyjs/reach-router`),
"react-lifecycles-compat": directoryPath(
`.cache/react-lifecycles-compat.js`
),
"@pmmmwh/react-refresh-webpack-plugin": getPackageRoot(
`@pmmmwh/react-refresh-webpack-plugin`
),
"socket.io-client": getPackageRoot(`socket.io-client`),
"webpack-hot-middleware": getPackageRoot(
`@gatsbyjs/webpack-hot-middleware`
),
$virtual: getAbsolutePathForVirtualModule(`$virtual`),
},
plugins: [
new CoreJSResolver(),
new CacheFolderResolver(path.join(program.directory, `.cache`)),
],
}
const target =
stage === `build-html` || stage === `develop-html` ? `node` : `web`
if (target === `web`) {
resolve.alias[`@reach/router`] = path.join(
getPackageRoot(`@gatsbyjs/reach-router`),
`es`
)
}
if (stage === `build-javascript` && program.profile) {
resolve.alias[`react-dom$`] = `react-dom/profiling`
resolve.alias[`scheduler/tracing`] = `scheduler/tracing-profiling`
}
// SSR can have many react versions as some packages use their own version. React works best with 1 version.
// By resolving react,react-dom from gatsby we'll get the site versions of react & react-dom because it's specified as a peerdependency.
//
// we need to put this below our resolve.alias for profiling as webpack picks the first one that matches
// @see https://github.com/gatsbyjs/gatsby/issues/31098
resolve.alias[`react`] = getPackageRoot(`react`)
resolve.alias[`react-dom`] = getPackageRoot(`react-dom`)
return resolve
}
function getResolveLoader() {
const root = [path.resolve(directory, `node_modules`)]
const userLoaderDirectoryPath = path.resolve(directory, `loaders`)
try {
if (fs.statSync(userLoaderDirectoryPath).isDirectory()) {
root.push(userLoaderDirectoryPath)
}
} catch (err) {
debug(`Error resolving user loaders directory`, err)
}
return {
modules: [...root, path.join(__dirname, `../loaders`), `node_modules`],
}
}
const config = {
name: stage,
// Context is the base directory for resolving the entry option.
context: directory,
entry: getEntry(),
output: getOutput(),
module: getModule(),
plugins: getPlugins(),
devtool: getDevtool(),
// Turn off performance hints as we (for now) don't want to show the normal
// webpack output anywhere.
performance: {
hints: false,
},
mode: getMode(),
resolveLoader: getResolveLoader(),
resolve: getResolve(stage),
}
if (stage === `build-html` || stage === `develop-html`) {
const [major, minor] = process.version.replace(`v`, ``).split(`.`)
config.target = `node14.15`
} else {
config.target = [`web`, `es5`]
}
const isCssModule = module => module.type === `css/mini-extract`
if (stage === `develop`) {
config.optimization = {
splitChunks: {
chunks: `all`,
cacheGroups: {
default: false,
defaultVendors: false,
framework: {
chunks: `all`,
name: `framework`,
// This regex ignores nested copies of framework libraries so they're bundled with their issuer.
test: new RegExp(
`(?<!node_modules.*)[\\\\/]node_modules[\\\\/](${FRAMEWORK_BUNDLES.join(
`|`
)})[\\\\/]`
),
priority: 40,
// Don't let webpack eliminate this chunk (prevents this chunk from becoming a part of the commons chunk)
enforce: true,
},
// Bundle all css & lazy css into one stylesheet to make sure lazy components do not break
// TODO make an exception for css-modules
styles: {
test(module) {
return isCssModule(module)
},
name: `commons`,
priority: 40,
enforce: true,
},
},
},
minimize: false,
}
}
if (stage === `build-html` || stage === `develop-html`) {
config.optimization = {
splitChunks: {
cacheGroups: {
default: false,
defaultVendors: false,
},
},
minimize: false,
}
}
if (stage === `build-javascript`) {
const componentsCount = store.getState().components.size
const splitChunks = {
chunks: `all`,
cacheGroups: {
default: false,
defaultVendors: false,
framework: {
chunks: `all`,
name: `framework`,
// This regex ignores nested copies of framework libraries so they're bundled with their issuer.
test: new RegExp(
`(?<!node_modules.*)[\\\\/]node_modules[\\\\/](${FRAMEWORK_BUNDLES.join(
`|`
)})[\\\\/]`
),
priority: 40,
// Don't let webpack eliminate this chunk (prevents this chunk from becoming a part of the commons chunk)
enforce: true,
},
// if a module is bigger than 160kb from node_modules we make a separate chunk for it
lib: {
test(module) {
return (
!isCssModule(module) &&
module.size() > 160000 &&
/node_modules[/\\]/.test(module.identifier())
)
},
name(module) {
const hash = crypto.createHash(`sha1`)
if (!module.libIdent) {
throw new Error(
`Encountered unknown module type: ${module.type}. Please open an issue.`
)
}
hash.update(module.libIdent({ context: program.directory }))
return hash.digest(`hex`).substring(0, 8)
},
priority: 30,
minChunks: 1,
reuseExistingChunk: true,
},
commons: {
name: `commons`,
// if a chunk is used on all components we put it in commons (we need at least 2 components)
minChunks: Math.max(componentsCount, 2),
priority: 20,
},
// If a chunk is used in at least 2 components we create a separate chunk
shared: {
test(module) {
return !isCssModule(module)
},
name(module, chunks) {
const hash = crypto
.createHash(`sha1`)
.update(chunks.reduce((acc, chunk) => acc + chunk.name, ``))
.digest(`hex`)
return hash
},
priority: 10,
minChunks: 2,
reuseExistingChunk: true,
},
// Bundle all css & lazy css into one stylesheet to make sure lazy components do not break
// TODO make an exception for css-modules
styles: {
test(module) {
return isCssModule(module)
},
name: `styles`,
priority: 40,
enforce: true,
},
},
// We load our pages async through async-requires, maxInitialRequests doesn't have an effect on chunks derived from page components.
// By default webpack has set maxAsyncRequests to 6, in some cases this isn't enough an actually makes the bundle size blow up.
// We've set maxAsyncRequests to Infinity to negate this. This could potentionally exceed the 25 initial requests that we set before
// sadly I do not have a better solution.
maxAsyncRequests: Infinity,
maxInitialRequests: 25,
minSize: 20000,
}
config.optimization = {
runtimeChunk: {
name: `webpack-runtime`,
},
splitChunks,
minimizer: [
// TODO: maybe this option should be noMinimize?
!program.noUglify &&
plugins.minifyJs(
program.profile
? {
terserOptions: {
keep_classnames: true,
keep_fnames: true,
},
}
: {}
),
plugins.minifyCss(),
].filter(Boolean),
}
}
if (stage === `build-html` || stage === `develop-html`) {
// externalize react, react-dom when develop-html or build-html(when not generating engines)
const shouldMarkPackagesAsExternal =
stage === `develop-html` ||
!(_CFLAGS_.GATSBY_MAJOR === `4` && shouldGenerateEngines())
// tracking = build-html (when not generating engines)
const shouldTrackBuiltins =
stage === `build-html` &&
!(_CFLAGS_.GATSBY_MAJOR === `4` && shouldGenerateEngines())
// removes node internals from bundle
// https://webpack.js.org/configuration/externals/#externalspresets
config.externalsPresets = {
// use it only when not tracking builtins (tracking builtins provide their own fallbacks)
node: !shouldTrackBuiltins,
}
config.externals = []
if (shouldMarkPackagesAsExternal) {
// Packages we want to externalize to save some build time
// https://github.com/gatsbyjs/gatsby/pull/14208#pullrequestreview-240178728
// const externalList = [`common-tags`, `lodash`, `semver`, /^lodash\//]
// Packages we want to externalize because meant to be user-provided
const userExternalList = [`react`, /^react-dom\//]
const checkItem = (item, request) => {
if (typeof item === `string` && item === request) {
return true
} else if (item instanceof RegExp && item.test(request)) {
return true
}
return false
}
config.externals.push(function (
{ context, getResolve, request },
callback
) {
// allows us to resolve webpack aliases from our config
// helpful for when react is aliased to preact-compat
// Force commonjs as we're in node land
const resolver = getResolve({
dependencyType: `commonjs`,
})
// User modules that do not need to be part of the bundle
if (userExternalList.some(item => checkItem(item, request))) {
// TODO figure out to make preact work with this too
resolver(context, request, (err, newRequest) => {
if (err) {
callback(err)
return
}
callback(null, newRequest)
})
return
}
// TODO look into re-enabling, breaks builds right now because of esm
// User modules that do not need to be part of the bundle
// if (externalList.some(item => checkItem(item, request))) {
// resolver(context, request, (err, request) => {
// if (err) {
// callback(err)
// return
// }
// callback(null, `commonjs2 ${request}`)
// })
// return
// }
callback()
})
}
if (shouldTrackBuiltins) {
if (stage === `build-html`) {
const builtinModulesToTrack = [
`fs`,
`http`,
`http2`,
`https`,
`child_process`,
]
const builtinsExternalsDictionary = builtinModules.reduce(
(acc, builtinModule) => {
if (builtinModulesToTrack.includes(builtinModule)) {
acc[builtinModule] = `commonjs ${path.join(
program.directory,
`.cache`,
`ssr-builtin-trackers`,
builtinModule
)}`
} else {
acc[builtinModule] = `commonjs ${builtinModule}`
}
return acc
},
{}
)
config.externals.unshift(builtinsExternalsDictionary)
}
}
}
if (stage === `develop`) {
config.externals = {
"socket.io-client": `io`,
}
}
if (
stage === `build-javascript` ||
stage === `build-html` ||
(process.env.GATSBY_EXPERIMENTAL_DEV_WEBPACK_CACHE &&
(stage === `develop` || stage === `develop-html`))
) {
const cacheLocation = path.join(
program.directory,
`.cache`,
`webpack`,
`stage-` + stage
)
const cacheConfig = {
type: `filesystem`,
name: stage,
cacheLocation,
buildDependencies: {
config: [
__filename,
...store
.getState()
.flattenedPlugins.filter(plugin =>
plugin.nodeAPIs.includes(`onCreateWebpackConfig`)
)
.map(plugin => path.join(plugin.resolve, `gatsby-node.js`)),
],
},
}
config.cache = cacheConfig
}
store.dispatch(actions.replaceWebpackConfig(config))
const getConfig = () => store.getState().webpack
await apiRunnerNode(`onCreateWebpackConfig`, {
getConfig,
// we will converge to build-html later on but for now this was the fastest way to get SSR to work
stage,
rules,
loaders,
plugins,
parentSpan,
})
if (fastRefreshPlugin) {
// Fast refresh plugin has `include` option that determines
// wether HMR code gets injected. We need to make sure all custom loaders
// (like .ts or .mdx) that use our babel-loader will be taken into account
// when deciding which modules get fast-refresh HMR addition.
const fastRefreshIncludes = []
const babelLoaderLoc = require.resolve(`./babel-loader`)
for (const rule of getConfig().module.rules) {
if (!rule.use && !rule.loader) {
continue
}
const ruleLoaders = Array.isArray(rule.use)
? rule.use.map(useEntry =>
typeof useEntry === `string` ? useEntry : useEntry.loader
)
: [rule.use?.loader ?? rule.loader]
const hasBabelLoader = ruleLoaders.some(
loader => loader === babelLoaderLoc
)
if (hasBabelLoader) {
fastRefreshIncludes.push(rule.test)
}
}
// start with default include of fast refresh plugin
const includeRegex = /\.([jt]sx?|flow)$/i
includeRegex.test = modulePath => {
// drop query param from request (i.e. ?type=component for mdx-loader)
// so loader rule test work well
const queryParamStartIndex = modulePath.indexOf(`?`)
if (queryParamStartIndex !== -1) {
modulePath = modulePath.substr(0, queryParamStartIndex)
}
return fastRefreshIncludes.some(re => re.test(modulePath))
}
fastRefreshPlugin.options.include = includeRegex
}
return getConfig()
}