Move desktop-related code to "desktop" subfolder (#872)
Summary: Pull Request resolved: https://github.com/facebook/flipper/pull/872 Move all the JS code related to desktop app to "desktop" subfolder. The structure of "desktop" folder: - `src` - JS code of Flipper desktop app executing in Electron Renderer (Chrome) process. This folder also contains all the Flipper plugins in subfolder "src/plugins". - `static` - JS code of Flipper desktop app bootstrapping executing in Electron Main (Node.js) process - `pkg` - Flipper packaging lib and CLI tool - `doctor` - Flipper diagnostics lib and CLI tool - `scripts` - Build scripts for Flipper desktop app - `headless` - Headless version of Flipper app - `headless-tests` - Integration tests running agains Flipper headless version Reviewed By: passy Differential Revision: D20249304 fbshipit-source-id: 9a51c63b51b92b758a02fc8ebf7d3d116770efe9
This commit is contained in:
Anton Nikolaev
committed by
Facebook GitHub Bot
Facebook GitHub Bot
parent
a60e6fee87
commit
85c13bb1f3
36
desktop/doctor/src/cli.ts
Normal file
36
desktop/doctor/src/cli.ts
Normal file
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
*/
|
||||
|
||||
import {getHealthchecks} from './index';
|
||||
import {getEnvInfo} from './environmentInfo';
|
||||
|
||||
(async () => {
|
||||
const environmentInfo = await getEnvInfo();
|
||||
console.log(JSON.stringify(environmentInfo));
|
||||
const healthchecks = getHealthchecks();
|
||||
const results = await Promise.all(
|
||||
Object.entries(healthchecks).map(async ([key, category]) => [
|
||||
key,
|
||||
category.isSkipped
|
||||
? category
|
||||
: {
|
||||
label: category.label,
|
||||
results: await Promise.all(
|
||||
category.healthchecks.map(async ({key, label, run}) => ({
|
||||
key,
|
||||
label,
|
||||
result: await run(environmentInfo),
|
||||
})),
|
||||
),
|
||||
},
|
||||
]),
|
||||
);
|
||||
|
||||
console.log(JSON.stringify(results, null, 2));
|
||||
})();
|
||||
48
desktop/doctor/src/environmentInfo.ts
Normal file
48
desktop/doctor/src/environmentInfo.ts
Normal file
@@ -0,0 +1,48 @@
|
||||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
*/
|
||||
|
||||
import {run} from 'envinfo';
|
||||
|
||||
export type EnvironmentInfo = {
|
||||
SDKs: {
|
||||
'iOS SDK': {
|
||||
Platforms: string[];
|
||||
};
|
||||
'Android SDK':
|
||||
| {
|
||||
'API Levels': string[] | 'Not Found';
|
||||
'Build Tools': string[] | 'Not Found';
|
||||
'System Images': string[] | 'Not Found';
|
||||
'Android NDK': string | 'Not Found';
|
||||
}
|
||||
| 'Not Found';
|
||||
};
|
||||
IDEs: {
|
||||
Xcode: {
|
||||
version: string;
|
||||
path: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
async function retrieveAndParseEnvInfo(): Promise<any> {
|
||||
return JSON.parse(
|
||||
await run(
|
||||
{
|
||||
SDKs: ['iOS SDK'],
|
||||
IDEs: ['Xcode'],
|
||||
},
|
||||
{json: true, showNotFound: true},
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
export async function getEnvInfo(): Promise<EnvironmentInfo> {
|
||||
return await retrieveAndParseEnvInfo();
|
||||
}
|
||||
10
desktop/doctor/src/globals.d.ts
vendored
Normal file
10
desktop/doctor/src/globals.d.ts
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
*/
|
||||
|
||||
declare module 'envinfo';
|
||||
294
desktop/doctor/src/index.ts
Normal file
294
desktop/doctor/src/index.ts
Normal file
@@ -0,0 +1,294 @@
|
||||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @format
|
||||
*/
|
||||
|
||||
import {exec} from 'child_process';
|
||||
import {promisify} from 'util';
|
||||
import {EnvironmentInfo, getEnvInfo} from './environmentInfo';
|
||||
export {EnvironmentInfo, getEnvInfo} from './environmentInfo';
|
||||
import * as watchman from 'fb-watchman';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
export type HealthcheckCategory = {
|
||||
label: string;
|
||||
isSkipped: false;
|
||||
isRequired: boolean;
|
||||
healthchecks: Healthcheck[];
|
||||
};
|
||||
|
||||
export type SkippedHealthcheckCategory = {
|
||||
label: string;
|
||||
isSkipped: true;
|
||||
skipReason: string;
|
||||
};
|
||||
|
||||
export type Healthchecks = {
|
||||
common: HealthcheckCategory | SkippedHealthcheckCategory;
|
||||
android: HealthcheckCategory | SkippedHealthcheckCategory;
|
||||
ios: HealthcheckCategory | SkippedHealthcheckCategory;
|
||||
};
|
||||
|
||||
export type Healthcheck = {
|
||||
key: string;
|
||||
label: string;
|
||||
isRequired?: boolean;
|
||||
run: (env: EnvironmentInfo) => Promise<HealthchecRunResult>;
|
||||
};
|
||||
|
||||
export type HealthchecRunResult = {
|
||||
hasProblem: boolean;
|
||||
message: string;
|
||||
};
|
||||
|
||||
export type CategoryResult = [
|
||||
string,
|
||||
{
|
||||
label: string;
|
||||
results: Array<{
|
||||
key: string;
|
||||
label: string;
|
||||
isRequired: boolean;
|
||||
result: {hasProblem: boolean};
|
||||
}>;
|
||||
},
|
||||
];
|
||||
|
||||
export function getHealthchecks(): Healthchecks {
|
||||
return {
|
||||
common: {
|
||||
label: 'Common',
|
||||
isRequired: true,
|
||||
isSkipped: false,
|
||||
healthchecks: [
|
||||
{
|
||||
key: 'common.openssl',
|
||||
label: 'OpenSSL Installed',
|
||||
run: async (_: EnvironmentInfo) => {
|
||||
const result = await tryExecuteCommand('openssl version');
|
||||
const hasProblem = result.hasProblem;
|
||||
const message = hasProblem
|
||||
? `OpenSSL (https://wiki.openssl.org/index.php/Binaries) is not installed or not added to PATH. ${result.message}.`
|
||||
: `OpenSSL (https://wiki.openssl.org/index.php/Binaries) is installed and added to PATH. ${result.message}.`;
|
||||
return {
|
||||
hasProblem,
|
||||
message,
|
||||
};
|
||||
},
|
||||
},
|
||||
{
|
||||
key: 'common.watchman',
|
||||
label: 'Watchman Installed',
|
||||
run: async (_: EnvironmentInfo) => {
|
||||
const isAvailable = await isWatchmanAvailable();
|
||||
return {
|
||||
hasProblem: !isAvailable,
|
||||
message: isAvailable
|
||||
? 'Watchman file watching service (https://facebook.github.io/watchman/) is installed and added to PATH. Live reloading after changes during Flipper plugin development is enabled.'
|
||||
: 'Watchman file watching service (https://facebook.github.io/watchman/) is not installed or not added to PATH. Live reloading after changes during Flipper plugin development is disabled.',
|
||||
};
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
android: {
|
||||
label: 'Android',
|
||||
isRequired: false,
|
||||
isSkipped: false,
|
||||
healthchecks: [
|
||||
{
|
||||
key: 'android.sdk',
|
||||
label: 'SDK Installed',
|
||||
isRequired: true,
|
||||
run: async (_: EnvironmentInfo) => {
|
||||
if (process.env.ANDROID_HOME) {
|
||||
const androidHome = process.env.ANDROID_HOME;
|
||||
if (!fs.existsSync(androidHome)) {
|
||||
return {
|
||||
hasProblem: true,
|
||||
message: `ANDROID_HOME points to a folder which does not exist: ${androidHome}.`,
|
||||
};
|
||||
}
|
||||
const platformToolsDir = path.join(androidHome, 'platform-tools');
|
||||
if (!fs.existsSync(path.join(androidHome, 'platform-tools'))) {
|
||||
return {
|
||||
hasProblem: true,
|
||||
message: `Android SDK Platform Tools not found at the expected location "${platformToolsDir}". Probably they are not installed.`,
|
||||
};
|
||||
}
|
||||
return await tryExecuteCommand(
|
||||
path.join(platformToolsDir, 'adb') + ' version',
|
||||
);
|
||||
}
|
||||
return await tryExecuteCommand('adb version');
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
ios: {
|
||||
label: 'iOS',
|
||||
...(process.platform === 'darwin'
|
||||
? {
|
||||
isRequired: false,
|
||||
isSkipped: false,
|
||||
healthchecks: [
|
||||
{
|
||||
key: 'ios.sdk',
|
||||
label: 'SDK Installed',
|
||||
isRequired: true,
|
||||
run: async (e: EnvironmentInfo) => {
|
||||
const hasProblem =
|
||||
!e.SDKs['iOS SDK'] ||
|
||||
!e.SDKs['iOS SDK'].Platforms ||
|
||||
!e.SDKs['iOS SDK'].Platforms.length;
|
||||
const message = hasProblem
|
||||
? 'iOS SDK is not installed. You can install it using Xcode (https://developer.apple.com/xcode/).'
|
||||
: `iOS SDK is installed for the following platforms: ${JSON.stringify(
|
||||
e.SDKs['iOS SDK'].Platforms,
|
||||
)}.`;
|
||||
return {
|
||||
hasProblem,
|
||||
message,
|
||||
};
|
||||
},
|
||||
},
|
||||
{
|
||||
key: 'ios.xcode',
|
||||
label: 'XCode Installed',
|
||||
isRequired: true,
|
||||
run: async (e: EnvironmentInfo) => {
|
||||
const hasProblem = e.IDEs == null || e.IDEs.Xcode == null;
|
||||
const message = hasProblem
|
||||
? 'Xcode (https://developer.apple.com/xcode/) is not installed.'
|
||||
: `Xcode version ${e.IDEs.Xcode.version} is installed at "${e.IDEs.Xcode.path}".`;
|
||||
return {
|
||||
hasProblem,
|
||||
message,
|
||||
};
|
||||
},
|
||||
},
|
||||
{
|
||||
key: 'ios.xcode-select',
|
||||
label: 'xcode-select set',
|
||||
isRequired: true,
|
||||
run: async (_: EnvironmentInfo) => {
|
||||
const result = await tryExecuteCommand('xcode-select -p');
|
||||
const hasProblem = result.hasProblem;
|
||||
const message = hasProblem
|
||||
? `Xcode version is not selected. You can select it using command "sudo xcode-select -switch <path/to/>Xcode.app". ${result.message}.`
|
||||
: `Xcode version is selected. ${result.message}.`;
|
||||
return {
|
||||
hasProblem,
|
||||
message,
|
||||
};
|
||||
},
|
||||
},
|
||||
{
|
||||
key: 'ios.instruments',
|
||||
label: 'Instruments exists',
|
||||
isRequired: true,
|
||||
run: async (_: EnvironmentInfo) => {
|
||||
const result = await tryExecuteCommand('which instruments');
|
||||
const hasProblem = result.hasProblem;
|
||||
const message = hasProblem
|
||||
? `Instruments not found. Please try to re-install Xcode (https://developer.apple.com/xcode/). ${result.message}.`
|
||||
: `Instruments are installed. ${result.message}.`;
|
||||
return {
|
||||
hasProblem,
|
||||
message,
|
||||
};
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
: {
|
||||
isSkipped: true,
|
||||
skipReason: `Healthcheck is skipped, because iOS development is not supported on the current platform "${process.platform}".`,
|
||||
}),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export async function runHealthchecks(): Promise<
|
||||
Array<CategoryResult | SkippedHealthcheckCategory>
|
||||
> {
|
||||
const environmentInfo = await getEnvInfo();
|
||||
const healthchecks: Healthchecks = getHealthchecks();
|
||||
const results: Array<
|
||||
CategoryResult | SkippedHealthcheckCategory
|
||||
> = await Promise.all(
|
||||
Object.entries(healthchecks).map(async ([key, category]) => {
|
||||
if (category.isSkipped) {
|
||||
return category;
|
||||
}
|
||||
const categoryResult: CategoryResult = [
|
||||
key,
|
||||
{
|
||||
label: category.label,
|
||||
results: await Promise.all(
|
||||
category.healthchecks.map(
|
||||
async ({key, label, run, isRequired}) => ({
|
||||
key,
|
||||
label,
|
||||
isRequired: isRequired ?? true,
|
||||
result: await run(environmentInfo).catch(e => {
|
||||
console.error(e);
|
||||
// TODO Improve result type to be: OK | Problem(message, fix...)
|
||||
return {
|
||||
hasProblem: true,
|
||||
};
|
||||
}),
|
||||
}),
|
||||
),
|
||||
),
|
||||
},
|
||||
];
|
||||
return categoryResult;
|
||||
}),
|
||||
);
|
||||
return results;
|
||||
}
|
||||
|
||||
async function tryExecuteCommand(
|
||||
command: string,
|
||||
): Promise<HealthchecRunResult> {
|
||||
try {
|
||||
const output = await promisify(exec)(command);
|
||||
return {
|
||||
hasProblem: false,
|
||||
message: `Command "${command}" successfully executed with output: ${output.stdout}`,
|
||||
};
|
||||
} catch (err) {
|
||||
return {
|
||||
hasProblem: true,
|
||||
message: `Command "${command}" failed to execute with output: ${err.message}`,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
async function isWatchmanAvailable(): Promise<boolean> {
|
||||
const client = new watchman.Client();
|
||||
return new Promise(resolve => {
|
||||
const complete = (result: boolean) => {
|
||||
resolve(result);
|
||||
client.removeAllListeners('error');
|
||||
client.end();
|
||||
};
|
||||
client.once('error', () => complete(false));
|
||||
client.capabilityCheck(
|
||||
{optional: [], required: ['relative_root']},
|
||||
error => {
|
||||
if (error) {
|
||||
complete(false);
|
||||
return;
|
||||
}
|
||||
complete(true);
|
||||
},
|
||||
);
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user