feat(conditional-page-builds): track potentially unsafe Node.js builtin modules usage #29560
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| body { | ||
| background: yellow; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,12 @@ | ||
| import * as React from "react" | ||
| import * as fs from "fs" | ||
|
|
||
| export function onRenderBody({ setHeadComponents }) { | ||
| setHeadComponents( | ||
| <style | ||
| dangerouslySetInnerHTML={{ | ||
| __html: `body {\nbackground: white;\n}`, | ||
| }} | ||
| /> | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /* eslint-disable filenames/match-regex */ | ||
| const { wrapModuleWithTracking } = require(`./tracking-unsafe-module-wrapper`) | ||
|
|
||
| module.exports = wrapModuleWithTracking(`child_process`) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const { wrapModuleWithTracking } = require(`./tracking-unsafe-module-wrapper`) | ||
|
|
||
| module.exports = wrapModuleWithTracking(`fs`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const { wrapModuleWithTracking } = require(`./tracking-unsafe-module-wrapper`) | ||
|
|
||
| module.exports = wrapModuleWithTracking(`http`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const { wrapModuleWithTracking } = require(`./tracking-unsafe-module-wrapper`) | ||
|
|
||
| module.exports = wrapModuleWithTracking(`http2`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| const { wrapModuleWithTracking } = require(`./tracking-unsafe-module-wrapper`) | ||
|
|
||
| module.exports = wrapModuleWithTracking(`https`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // initializing global here for unsafe builtin usage at import time | ||
| global.unsafeBuiltinUsage = [] | ||
|
|
||
| function createProxyHandler(prefix) { | ||
| return { | ||
| get: function (target, key) { | ||
| const value = target[key] | ||
| if (typeof value === `function`) { | ||
| return function wrapper(...args) { | ||
| const myErrorHolder = { | ||
| name: `Unsafe builtin usage ${prefix}.${key}`, | ||
| } | ||
| Error.captureStackTrace(myErrorHolder, wrapper) | ||
|
|
||
| global.unsafeBuiltinUsage.push(myErrorHolder.stack) | ||
| return value.apply(target, args) | ||
| } | ||
| } else if (typeof value === `object` && value !== null) { | ||
| return new Proxy( | ||
| value, | ||
| createProxyHandler( | ||
| key && key.toString ? `${prefix}.${key.toString()}` : prefix | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| return value | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| function wrapModuleWithTracking(moduleName) { | ||
| const mod = require(moduleName) | ||
| return new Proxy(mod, createProxyHandler(moduleName)) | ||
| } | ||
|
|
||
| exports.wrapModuleWithTracking = wrapModuleWithTracking |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,10 @@ export default ({ | |
| reversedStyles, | ||
| reversedScripts, | ||
| }) => { | ||
| // for this to work we need this function to be sync or at least ensure there is single execution of it at a time | ||
| global.unsafeBuiltinUsage = [] | ||
|
There was a problem hiding this comment. This hurts my feelings, but I essentially need "context" that "unconnected" arbitrary code can access and push to. |
||
|
|
||
| try { | ||
| let bodyHtml = `` | ||
| let headComponents = [ | ||
| <meta | ||
|
|
@@ -134,7 +138,9 @@ export default ({ | |
| } | ||
|
|
||
| const setPreBodyComponents = components => { | ||
| preBodyComponents = preBodyComponents.concat( | ||
| sanitizeComponents(components) | ||
| ) | ||
| } | ||
|
|
||
| const setPostBodyComponents = components => { | ||
|
|
@@ -413,5 +419,9 @@ export default ({ | |
| /> | ||
| )}` | ||
|
|
||
| return { html, unsafeBuiltinsUsage: global.unsafeBuiltinUsage } | ||
| } catch (e) { | ||
| e.unsafeBuiltinsUsage = global.unsafeBuiltinUsage | ||
| throw e | ||
|
Comment on lines
+422
to
+425
There was a problem hiding this comment. did anything change except this? There was a problem hiding this comment. I suggest checking with "hide whitespace changes" ( https://github.com/gatsbyjs/gatsby/pull/29560/files?w=1#diff-4cd5b620539129dfa79254b9cdae3bd9b619426b83b412d2647cfb416730d362 ) This whole file added at the start of the function, changed return to return object instead of string and wrapped everything in try/catch to decorate caught error with |
||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is because filename (
child_process.jsdoesn't match our eslint rule :( )