Skip to content
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.

Sign up for GitHub

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

Add support for cloud interop, window state in page saves and better builds #705

Merged
merged 11 commits into from
Apr 12, 2024
Merged

Add support for cloud interop, window state in page saves and better builds #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5d3a5ed
Add additional action for a workspace lifecycle event.
johnman Apr 10, 2024
2b0b4f1
Improving FDC3 docs to make it easier to learn about fdc3 (#704)
johnman Apr 11, 2024
1a52503
Merge branch 'main' into workspace/vnext
johnman Apr 12, 2024
194d60c
Update versioning in docs
johnman Apr 12, 2024
11f4a28
Window state improvements and dependency pinning.
johnman Apr 12, 2024
fc8bbdb
Update the launch script for workspace v18
johnman Apr 12, 2024
bbbb95e
Include window state on page save
johnman Apr 12, 2024
bbc2630
Remove rspack
johnman Apr 12, 2024
94a2ffe
Gave greater control over what is built.
johnman Apr 12, 2024
6592b97
Added Cloud Interop support with documentation.
johnman Apr 12, 2024
a92d043
Merge remote-tracking branch 'origin/workspace/v18.0.0' into workspac…
johnman Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 130 additions & 63 deletions how-to/customize-home-templates/scripts/launch.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* Pressing Ctrl+C/Command+C will terminate the application.
*/
import { connect, launch } from '@openfin/node-adapter';
import { exec } from 'child_process';
import { setDefaultResultOrder } from 'dns';

/**
Expand All @@ -13,82 +14,148 @@ import { setDefaultResultOrder } from 'dns';
*/
async function run(manifestUrl) {
try {
let quitRequested = false;
let quit;

const fin = await launchFromNode(manifestUrl);

if (fin) {
const manifest = await fin.System.fetchManifest(manifestUrl);

if (manifest.platform?.uuid !== undefined) {
quit = async () => {
try {
if (!quitRequested) {
quitRequested = true;
console.log('Calling platform quit');
const platform = fin.Platform.wrapSync({ uuid: manifest.platform.uuid });
await platform.quit();
}
} catch (err) {
if (err.toString().includes('no longer connected')) {
console.log('Platform no longer connected');
console.log('Exiting process');
process.exit();
} else {
console.error(err);
}
}
};
console.log(`Wrapped target platform: ${manifest.platform.uuid}`);
} else {
quit = async () => {
try {
if (!quitRequested) {
quitRequested = true;
console.log('Calling application quit');
const app = fin.Application.wrapSync({ uuid: manifest.startup_app.uuid });
await app.quit();
}
} catch (err) {
console.error(err);
}
};
console.log(`Wrapped classic app: ${manifest.startup_app.uuid}`);
}

// do something when app is closing
process.on('exit', async () => {
console.log('Process exit called');
await quit();
});

// catches ctrl+c event
process.on('SIGINT', async () => {
console.log('Ctrl + C called');
await quit();
});

console.log(`You successfully connected to the manifest: ${manifestUrl}`);
console.log(`Please wait while the sample loads.`);
console.log();
console.log(`If using browser use the Quit option from the main menu.`);
console.log(`Otherwise press Ctrl + C (Windows) or Command + C (Mac) to exit and close the sample.`);
console.log();
if (process.platform === 'darwin') {
await launchFromFinsLink(manifestUrl);
} else {
await launchFromNodeAdapter(manifestUrl);
}
} catch (e) {
console.error(`Error: Connection failed`);
console.error(e.message);
}
}

/**
* Launch the manifest using the node adapter.
* @param manifestUrl the url to launch
*/
async function launchFromNodeAdapter(manifestUrl) {
let quitRequested = false;
let quit;

const fin = await connectAndGetFinAPI(manifestUrl);

if (fin) {
const manifest = await fin.System.fetchManifest(manifestUrl);

if (manifest.platform?.uuid !== undefined) {
quit = async () => {
try {
if (!quitRequested) {
quitRequested = true;
console.log('Calling platform quit');
const platform = fin.Platform.wrapSync({ uuid: manifest.platform.uuid });
await platform.quit();
}
} catch (err) {
if (err.toString().includes('no longer connected')) {
console.log('Platform no longer connected');
console.log('Exiting process');
process.exit();
} else {
console.error(err);
}
}
};
console.log(`Wrapped target platform: ${manifest.platform.uuid}`);
} else {
quit = async () => {
try {
if (!quitRequested) {
quitRequested = true;
console.log('Calling application quit');
const app = fin.Application.wrapSync({ uuid: manifest.startup_app.uuid });
await app.quit();
}
} catch (err) {
console.error(err);
}
};
console.log(`Wrapped classic app: ${manifest.startup_app.uuid}`);
}

// do something when app is closing
process.on('exit', async () => {
console.log('Process exit called');
await quit();
});

// catches ctrl+c event
process.on('SIGINT', async () => {
console.log('Ctrl + C called');
await quit();
});

console.log(`You successfully connected to the manifest: ${manifestUrl}`);
console.log(`Please wait while the sample loads.`);
console.log();
console.log(`If using browser use the Quit option from the main menu.`);
console.log(`Otherwise press Ctrl + C (Windows) or Command + C (Mac) to exit and close the sample.`);
console.log();
}
}

/**
* Launch the manifest using the node adapter.
* @param manifestUrl The manifest to launch.
*/
async function launchFromFinsLink(manifestUrl) {
console.log();
console.log(`Launching manifest...`);
console.log();
const finsLink = manifestUrl.replace('http', 'fin');
const finsProcess = exec(`open ${finsLink}`);

/**
* A simple message to inform the user how to quit the platform.
*/
function logQuitMessage() {
console.log();
console.log('Please quit the platform using:');
console.log();
console.log('- Process Manager (https://start.openfin.co/pm)');
console.log('- the Quit option from the Workspace Browser main menu or Dock.');
console.log('- run npm run kill to kill all OpenFin processes.');
console.log();
console.log();
}

finsProcess.stdout.on('data', (data) => {
console.log(`stdout: ${data}`);
});

finsProcess.stderr.on('data', (data) => {
console.error(`stderr: ${data}`);
});

// do something when app is closing
process.on('exit', async () => {
console.log('Please wait for the OpenFin application to launch.');
logQuitMessage();
});

// catches ctrl+c event
process.on('SIGINT', async () => {
console.log('Ctrl + C called');
logQuitMessage();
});

finsProcess.on('exit', (code) => {
if (code === 0) {
console.log('Manifest launched successfully');
} else {
console.log(`Child process exited with code ${code.toString()}`);
}
});
}

/**
* Launch the manifest using the node adapter.
* @param manifestUrl The manifest to launch.
* @param exitMethod The method to call if the adapter connection exits.
* @returns The fin object representing the connection.
*/
async function launchFromNode(manifestUrl, exitMethod) {
async function connectAndGetFinAPI(manifestUrl, exitMethod) {
try {
console.log(`Launching manifest...`);
console.log();
Expand Down
Loading
Loading