-
-
Notifications
You must be signed in to change notification settings - Fork 491
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.
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
feat: add support for loading webpack assets via custom protocol #3511
Draft
MarshallOfSound
wants to merge
1
commit into
main
Choose a base branch
from
add-custom-protocol-support-in-webpack
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,63 @@ | ||
| import * as path from 'path'; | ||
|
|
||
| // eslint-disable-next-line node/no-unpublished-import | ||
| import { protocol } from 'electron'; | ||
|
|
||
| import type { WebpackPluginConfig } from '../Config'; | ||
|
|
||
| type InternalConfig = Required<Required<WebpackPluginConfig>['customProtocolForPackagedAssets']>; | ||
| declare const __ELECTRON_FORGE_INTERNAL_PROTOCOL_CONFIGURATION__: InternalConfig; | ||
|
|
||
| const config: InternalConfig = __ELECTRON_FORGE_INTERNAL_PROTOCOL_CONFIGURATION__ as any; | ||
|
|
||
| const appRoot = path.join(__dirname, '..'); | ||
| const rendererRoot = path.join(appRoot, 'renderer'); | ||
|
|
||
| const STATUS_CODE_BAD_REQUEST = 400; | ||
| const STATUS_CODE_FORBIDDEN = 403; | ||
| const STATUS_CODE_INTERNAL_SERVER_ERROR = 500; | ||
|
|
||
| protocol.registerFileProtocol(config.protocolName, (request, cb) => { | ||
| try { | ||
| const requestUrl = new URL(decodeURI(request.url)); | ||
|
|
||
| if (requestUrl.protocol !== `${config.protocolName}:`) { | ||
| return cb({ statusCode: STATUS_CODE_BAD_REQUEST }); | ||
| } | ||
|
|
||
| if (request.url.includes('..')) { | ||
| return cb({ statusCode: STATUS_CODE_FORBIDDEN }); | ||
| } | ||
|
|
||
| if (requestUrl.host !== 'renderer') { | ||
| return cb({ statusCode: STATUS_CODE_BAD_REQUEST }); | ||
| } | ||
|
|
||
| if (!requestUrl.pathname || requestUrl.pathname === '/') { | ||
| return cb({ statusCode: STATUS_CODE_BAD_REQUEST }); | ||
| } | ||
|
|
||
| // Resolve relative to appRoot | ||
| const filePath = path.join(appRoot, requestUrl.pathname); | ||
| // But ensure we are within the rendererRoot | ||
| const relative = path.relative(rendererRoot, filePath); | ||
| const isSafe = relative && !relative.startsWith('..') && !path.isAbsolute(relative); | ||
|
|
||
| if (!isSafe) { | ||
| return cb({ statusCode: STATUS_CODE_BAD_REQUEST }); | ||
| } | ||
|
|
||
| return cb({ path: filePath }); | ||
| } catch (error) { | ||
| const errorMessage = `Unexpected error in ${config.protocolName}:// protocol handler.`; | ||
| console.error(errorMessage, error); | ||
| return cb({ statusCode: STATUS_CODE_INTERNAL_SERVER_ERROR }); | ||
| } | ||
| }); | ||
|
|
||
| protocol.registerSchemesAsPrivileged([ | ||
| { | ||
| scheme: config.protocolName, | ||
| privileges: config.privileges, | ||
| }, | ||
| ]); | ||
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
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.
Isn't this call deprecated in the recent Electron versions and instead one should use "handle"?
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.
Yeah, but it's not gonna be removed any time soon and we can migrate at some point in the future. This at the moment is more performant that
handlefor complicated reasons so to avoid issues around that we'll use the deprecated API for a bit