-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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: release-profiler on web #44432
Merged
stitesExpensify
merged 21 commits into
Expensify:main
from
margelo:feat/release-profiler-on-web
Jul 22, 2024
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
2e7d7cf
feat: release-profiler on web
kirillzyusko 0bfd198
fix: use old profiling names
kirillzyusko 4333ea8
feat: enable profiling for prod desktop
kirillzyusko d9d115f
docs: update readme
kirillzyusko cd989c2
chore: temporary commit that shouldn't live in remote too long
kirillzyusko eeb33c6
fix combine script
hannojg 90c76fe
chore: code cleanup
kirillzyusko 125e8e8
fix: changes after rebase
kirillzyusko 236228e
chore: changes after self review
kirillzyusko 39dbe50
fix: another attempt to fix CI
kirillzyusko 5db459c
chore: migrate electron-serve to ts
kirillzyusko 50369ea
fix: make serve actually working
kirillzyusko 45b3a71
feat: upload source maps
kirillzyusko d5993fe
fix: remove patch
kirillzyusko 8c627ae
fix: unit tests
kirillzyusko abeb684
fix: partially workflow test fixes
kirillzyusko 92add2f
feat: add share button on web for logs trace
kirillzyusko 1674da7
fix: disable share button
kirillzyusko c6765ba
fix: prettier
kirillzyusko 67a0ab5
fix: changes after code review
kirillzyusko 6f7f259
fix: re-generate package-lock.json
kirillzyusko 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,106 @@ | ||
/* eslint-disable @typescript-eslint/no-misused-promises */ | ||
|
||
/* eslint-disable rulesdir/no-negated-variables */ | ||
|
||
/* eslint-disable @lwc/lwc/no-async-await */ | ||
|
||
/** | ||
* This file is a modified version of the electron-serve package. | ||
* We keep the same interface, but instead of file protocol we use buffer protocol (with support of JS self profiling). | ||
*/ | ||
import type {BrowserWindow, Protocol} from 'electron'; | ||
import {app, protocol, session} from 'electron'; | ||
import fs from 'fs'; | ||
import path from 'path'; | ||
|
||
type RegisterBufferProtocol = Protocol['registerBufferProtocol']; | ||
type HandlerType = Parameters<RegisterBufferProtocol>[1]; | ||
type Optional<T> = T | null | undefined; | ||
|
||
const FILE_NOT_FOUND = -6; | ||
|
||
const getPath = async (filePath: string): Promise<Optional<string>> => { | ||
try { | ||
const result = await fs.promises.stat(filePath); | ||
|
||
if (result.isFile()) { | ||
return filePath; | ||
} | ||
|
||
if (result.isDirectory()) { | ||
// eslint-disable-next-line @typescript-eslint/return-await | ||
return getPath(path.join(filePath, 'index.html')); | ||
} | ||
} catch { | ||
return null; | ||
} | ||
}; | ||
|
||
type ServeOptions = { | ||
directory: string; | ||
isCorsEnabled?: boolean; | ||
scheme?: string; | ||
hostname?: string; | ||
file?: string; | ||
partition?: string; | ||
}; | ||
|
||
export default function electronServe(options: ServeOptions) { | ||
const mandatoryOptions = { | ||
isCorsEnabled: true, | ||
scheme: 'app', | ||
hostname: '-', | ||
file: 'index', | ||
...options, | ||
}; | ||
|
||
if (!mandatoryOptions.directory) { | ||
throw new Error('The `directory` option is required'); | ||
} | ||
|
||
mandatoryOptions.directory = path.resolve(app.getAppPath(), mandatoryOptions.directory); | ||
|
||
const handler: HandlerType = async (request, callback) => { | ||
const filePath = path.join(mandatoryOptions.directory, decodeURIComponent(new URL(request.url).pathname)); | ||
const resolvedPath = (await getPath(filePath)) ?? path.join(mandatoryOptions.directory, `${mandatoryOptions.file}.html`); | ||
|
||
try { | ||
const data = await fs.promises.readFile(resolvedPath); | ||
callback({ | ||
mimeType: 'text/html', | ||
data: Buffer.from(data), | ||
headers: { | ||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
'Document-Policy': 'js-profiling', | ||
}, | ||
}); | ||
} catch (error) { | ||
callback({error: FILE_NOT_FOUND}); | ||
} | ||
}; | ||
|
||
protocol.registerSchemesAsPrivileged([ | ||
{ | ||
scheme: mandatoryOptions.scheme, | ||
privileges: { | ||
standard: true, | ||
secure: true, | ||
allowServiceWorkers: true, | ||
supportFetchAPI: true, | ||
corsEnabled: mandatoryOptions.isCorsEnabled, | ||
}, | ||
}, | ||
]); | ||
|
||
app.on('ready', () => { | ||
const partitionSession = mandatoryOptions.partition ? session.fromPartition(mandatoryOptions.partition) : session.defaultSession; | ||
|
||
partitionSession.protocol.registerBufferProtocol(mandatoryOptions.scheme, handler); | ||
}); | ||
|
||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
return async (window_: BrowserWindow, searchParameters?: URLSearchParams) => { | ||
const queryString = searchParameters ? `?${new URLSearchParams(searchParameters).toString()}` : ''; | ||
await window_.loadURL(`${mandatoryOptions.scheme}://${mandatoryOptions.hostname}${queryString}`); | ||
}; | ||
} |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Oops, something went wrong.
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.
Note: I believe this may have caused issue #46048 by overriding the
Content-Type
response header for non-html responses.