feat(client): client/src/cordova/dev action #2111
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // Copyright 2024 The Outline Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import replace from 'replace-in-file'; | ||
|
|
||
| export async function makeReplacements(replacements) { | ||
| let results = []; | ||
|
|
||
| for (const replacement of replacements) { | ||
| results = [...results, ...(await replace(replacement))]; | ||
| } | ||
| } |
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,142 @@ | ||
| // Copyright 2022 The Outline Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| import os from 'os'; | ||
| import path from 'path'; | ||
| import url from 'url'; | ||
|
|
||
| import {createReloadServer} from '@outline/infrastructure/build/create_reload_server.mjs'; | ||
| import {getRootDir} from '@outline/infrastructure/build/get_root_dir.mjs'; | ||
| import {runAction} from '@outline/infrastructure/build/run_action.mjs'; | ||
| import {spawnStream} from '@outline/infrastructure/build/spawn_stream.mjs'; | ||
| import {hashElement} from 'folder-hash'; | ||
| import * as fs from 'fs-extra'; | ||
| import minimist from 'minimist'; | ||
|
|
||
| import {makeReplacements} from '../../build/make_replacements.mjs'; | ||
|
|
||
| const OUTPUT_PATH = 'output/build/client/macos'; | ||
| const OUTLINE_APP_PATH = 'Debug/Outline.app'; | ||
| const OUTLINE_APP_WWW_PATH = 'Contents/Resources/www'; | ||
| const RELOAD_SERVER_PORT = 35729; | ||
|
|
||
| const getUIHash = async () => { | ||
| const hashResult = await hashElement( | ||
| path.join(getRootDir(), 'client/src/www'), | ||
| { | ||
| files: {include: ['**/*.ts', '**/*.html', '**/*.css', '**/*.js']}, | ||
| } | ||
| ); | ||
|
|
||
| return hashResult.hash; | ||
| }; | ||
|
|
||
| /** | ||
| * @description Runs the cordova app in development mode. | ||
| * | ||
| * @param {string[]} parameters | ||
| */ | ||
| export async function main(...givenParameters) { | ||
| const { | ||
| _: [platform = 'macos'], | ||
| buildMode = 'release', | ||
| sentryDsn = 'https://public@sentry.example.com/1', | ||
| versionName = '0.0.0-dev', | ||
| } = minimist(givenParameters); | ||
|
|
||
| if (platform !== 'macos') { | ||
| throw new Error('This action currently only works for the MacOS platform.'); | ||
| } | ||
|
|
||
| if (buildMode !== 'release') { | ||
| throw new Error('MacOS only renders properly in the release build mode.'); | ||
| } | ||
|
|
||
| if (os.platform() !== 'darwin') { | ||
| throw new Error('You must be on MacOS to develop for MacOS.'); | ||
| } | ||
|
|
||
| const parameters = [ | ||
| 'macos', | ||
| '--buildMode=release', | ||
| `--sentryDsn=${sentryDsn}`, | ||
| `--versionName=${versionName}`, | ||
| ]; | ||
|
|
||
| await runAction('client/src/www/build', ...parameters); | ||
| await runAction('client/go/build', ...parameters); | ||
| await runAction('client/src/cordova/setup', ...parameters); | ||
|
|
||
| await makeReplacements([ | ||
| { | ||
| files: path.join( | ||
| getRootDir(), | ||
| 'client/platforms/osx/**/index_cordova.html' | ||
| ), | ||
| from: '<app-root></app-root>', | ||
| to: `<app-root></app-root> | ||
|
|
||
| <script> | ||
| try { | ||
| const reloadSocket = new WebSocket("ws://localhost:35729"); | ||
|
There was a problem hiding this comment. Do you need to hard-code the server? Can this be a dynamic port of a unix socket instead? You start the reload server, so you might as well use a dynamic port to avoid port conflicts. |
||
|
|
||
| reloadSocket.onopen = () => console.log("LiveReload connected~"); | ||
| reloadSocket.onmessage = ({ data }) => data === "reload" && location.reload(); | ||
| } catch (e) { | ||
| // nevermind | ||
| } | ||
| </script>`, | ||
| }, | ||
| ]); | ||
|
|
||
| await spawnStream( | ||
| 'xcodebuild', | ||
| '-scheme', | ||
| 'Outline', | ||
| '-workspace', | ||
| path.join(getRootDir(), 'client/src/cordova/apple/macos.xcworkspace'), | ||
| `SYMROOT=${path.join(getRootDir(), OUTPUT_PATH)}` | ||
| ); | ||
|
|
||
| await spawnStream( | ||
| 'open', | ||
| path.join(getRootDir(), OUTPUT_PATH, OUTLINE_APP_PATH) | ||
| ); | ||
|
|
||
| let previousUIHashResult = await getUIHash(); | ||
|
|
||
| console.log(`Starting reload server @ port ${RELOAD_SERVER_PORT}...`); | ||
| createReloadServer(async () => { | ||
| const currentUIHashResult = await getUIHash(); | ||
|
|
||
| if (previousUIHashResult === currentUIHashResult) { | ||
| return false; | ||
| } | ||
|
|
||
| previousUIHashResult = currentUIHashResult; | ||
|
|
||
| await runAction('client/src/www/build', ...parameters); | ||
|
|
||
| await fs.copy( | ||
| path.join(getRootDir(), 'client/www'), | ||
| path.join(OUTPUT_PATH, OUTLINE_APP_PATH, OUTLINE_APP_WWW_PATH) | ||
| ); | ||
|
|
||
| return true; | ||
| }).listen(RELOAD_SERVER_PORT); | ||
|
There was a problem hiding this comment. I believe you are listening on the "any" address here. This is a security issue. Please change this to localhost. Also, use port zero, so that the OS assign a port for you. Then read the port (really, the full address) to pass it to the websocket url. There was a problem hiding this comment. Thanks for the tips - this is great. Since we merged this I'll do it in a follow up PR ASAP. |
||
| } | ||
|
|
||
| if (import.meta.url === url.pathToFileURL(process.argv[1]).href) { | ||
| await main(...process.argv.slice(2)); | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -26,5 +26,4 @@ | |
| </head> | ||
| <body unresolved> | ||
| <app-root></app-root> | ||
| </html> | ||
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.
Nice, thanks. This is better.