385d9ded57
Summary: Creation of the adb client requires the logger to already be initialized, so this should never be called at the global scope in a module, or you'll get weird import-order related bugs. I noticed this while debugging, I don't think it's impacting anything right now, but have made it lazy just to avoid confusion in future. Reviewed By: passy Differential Revision: D16162266 fbshipit-source-id: 5363292d5cfcf2867a2654777cd8f4baed01d2c0
98 lines
2.9 KiB
JavaScript
98 lines
2.9 KiB
JavaScript
/**
|
|
* Copyright 2018-present Facebook.
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
* @format
|
|
*/
|
|
|
|
/*
|
|
* This file is intentionally separate from androidContainerUtility so the
|
|
* opaque types will ensure the commands are only ever run on validated
|
|
* arguments.
|
|
*/
|
|
import {getAdbClient} from './adbClient';
|
|
import {UnsupportedError} from './metrics';
|
|
const adbkit = require('adbkit-fb');
|
|
|
|
const allowedAppNameRegex = /^[a-zA-Z0-9._\-]+$/;
|
|
const appNotDebuggableRegex = /debuggable/;
|
|
const operationNotPermittedRegex = /not permitted/;
|
|
const logTag = 'androidContainerUtility';
|
|
|
|
export opaque type AppName = string;
|
|
export opaque type Command = string;
|
|
export opaque type FilePath = string;
|
|
export opaque type FileContent = string;
|
|
|
|
export function validateAppName(app: string): Promise<AppName> {
|
|
if (app.match(allowedAppNameRegex)) {
|
|
return Promise.resolve(app);
|
|
}
|
|
return Promise.reject(new Error(`Disallowed run-as user: ${app}`));
|
|
}
|
|
|
|
export function validateFilePath(filePath: string): Promise<FilePath> {
|
|
if (!filePath.match(/[']/)) {
|
|
return Promise.resolve(filePath);
|
|
}
|
|
return Promise.reject(new Error(`Disallowed escaping filepath: ${filePath}`));
|
|
}
|
|
|
|
export function validateFileContent(content: string): Promise<FileContent> {
|
|
if (!content.match(/["]/)) {
|
|
return Promise.resolve(content);
|
|
}
|
|
return Promise.reject(
|
|
new Error(`Disallowed escaping file content: ${content}`),
|
|
);
|
|
}
|
|
|
|
export function _push(
|
|
deviceId: string,
|
|
app: AppName,
|
|
filename: FilePath,
|
|
contents: FileContent,
|
|
): Promise<void> {
|
|
console.debug(`Deploying ${filename} to ${deviceId}:${app}`, logTag);
|
|
return executeCommandAsApp(
|
|
deviceId,
|
|
app,
|
|
`echo "${contents}" > '${filename}' && chmod 600 '${filename}'`,
|
|
).then(output => undefined);
|
|
}
|
|
|
|
export function _pull(
|
|
deviceId: string,
|
|
app: AppName,
|
|
path: FilePath,
|
|
): Promise<string> {
|
|
return executeCommandAsApp(deviceId, app, `cat '${path}'`);
|
|
}
|
|
|
|
// Keep this method private since it relies on pre-validated arguments
|
|
function executeCommandAsApp(
|
|
deviceId: string,
|
|
app: string,
|
|
command: string,
|
|
): Promise<string> {
|
|
return getAdbClient()
|
|
.then(client =>
|
|
client.shell(deviceId, `echo '${command}' | run-as '${app}'`),
|
|
)
|
|
.then(adbkit.util.readAll)
|
|
.then(buffer => buffer.toString())
|
|
.then(output => {
|
|
if (output.match(appNotDebuggableRegex)) {
|
|
throw new Error(
|
|
`Android app ${app} is not debuggable. To use it with Flipper, add android:debuggable="true" to the application section of AndroidManifest.xml`,
|
|
);
|
|
}
|
|
if (output.toLowerCase().match(operationNotPermittedRegex)) {
|
|
throw new UnsupportedError(
|
|
`Your android device (${deviceId}) does not support the adb shell run-as command. We're tracking this at https://github.com/facebook/flipper/issues/92`,
|
|
);
|
|
}
|
|
return output;
|
|
});
|
|
}
|