Skip to content

Stage Android emulator logcat output #3627

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

Draft
sjchmiela wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Stage Android emulator logcat output #3627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 63 additions & 0 deletions packages/build-tools/src/steps/functions/__tests__/startAndroidEmulator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jest.mock('../../../utils/AndroidEmulatorUtils', () => ({
createAsync: jest.fn(),
cloneAsync: jest.fn(),
startAsync: jest.fn(),
startLogcatStreamingAsync: jest.fn(),
getLogcatStagingDirectoryPath: jest.fn(),
waitForReadyAsync: jest.fn(),
disableWindowAndTransitionAnimationsAsync: jest.fn(),
deleteAsync: jest.fn(),
Expand Down Expand Up @@ -59,6 +61,12 @@ describe(createStartAndroidEmulatorBuildFunction, () => {
mockedAndroidUtils.createAsync.mockResolvedValue(undefined);
mockedAndroidUtils.cloneAsync.mockResolvedValue(undefined);
mockedAndroidUtils.startAsync.mockResolvedValue(createStartResult('emulator-default'));
mockedAndroidUtils.startLogcatStreamingAsync.mockResolvedValue({
outputPath: '/non/existent/dir/android-emulator-logcat/emulator-default.log',
});
mockedAndroidUtils.getLogcatStagingDirectoryPath.mockReturnValue(
'/non/existent/dir/android-emulator-logcat'
);
mockedAndroidUtils.waitForReadyAsync.mockResolvedValue(undefined);
mockedAndroidUtils.disableWindowAndTransitionAnimationsAsync.mockResolvedValue(undefined);
mockedAndroidUtils.deleteAsync.mockResolvedValue(undefined);
Expand Down Expand Up @@ -106,6 +114,23 @@ describe(createStartAndroidEmulatorBuildFunction, () => {
serialId: 'emulator-2222',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenNthCalledWith(
1,
expect.objectContaining({
serialId: 'emulator-1111',
outputDir: '/non/existent/dir/android-emulator-logcat',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenNthCalledWith(
2,
expect.objectContaining({
serialId: 'emulator-2222',
outputDir: '/non/existent/dir/android-emulator-logcat',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync.mock.invocationCallOrder[0]).toBeLessThan(
mockedAndroidUtils.waitForReadyAsync.mock.invocationCallOrder[0]
);
expect(mockedAndroidUtils.deleteAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-1111',
Expand Down Expand Up @@ -174,6 +199,26 @@ describe(createStartAndroidEmulatorBuildFunction, () => {
serialId: 'emulator-clone-2-attempt-1',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-base',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-clone-1-attempt-1',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-clone-1-attempt-2',
})
);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-clone-2-attempt-1',
})
);

expect(mockedAndroidUtils.deleteAsync).toHaveBeenCalledWith(
expect.objectContaining({
Expand All @@ -200,6 +245,24 @@ describe(createStartAndroidEmulatorBuildFunction, () => {
})
);
expect(mockedAndroidUtils.deleteAsync).toHaveBeenCalledTimes(3);
expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledTimes(3);
});

it('continues emulator startup when logcat streaming fails', async () => {
mockedAndroidUtils.startLogcatStreamingAsync.mockResolvedValue(null);

await createStep().executeAsync();

expect(mockedAndroidUtils.startLogcatStreamingAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-default',
})
);
expect(mockedAndroidUtils.waitForReadyAsync).toHaveBeenCalledWith(
expect.objectContaining({
serialId: 'emulator-default',
})
);
});

it('skips animation scale adjustments when opt out env var is disabled', async () => {
Expand Down
17 changes: 16 additions & 1 deletion packages/build-tools/src/steps/functions/startAndroidEmulator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export function createStartAndroidEmulatorBuildFunction(): BuildFunction {
allowedValueTypeName: BuildStepInputValueTypeName.NUMBER,
}),
],
fn: async ({ logger }, { inputs, env }) => {
fn: async ({ logger, global }, { inputs, env }) => {
if (env.EAS_NO_EMULATOR_HOST_SUPPORT_CHECK !== '1') {
await assertAndroidEmulatorHostSupportAsync({ env });
} else {
Expand Down Expand Up @@ -100,6 +100,9 @@ export function createStartAndroidEmulatorBuildFunction(): BuildFunction {

let emulatorPromise = null;
let serialId = null;
const logcatOutputDir = AndroidEmulatorUtils.getLogcatStagingDirectoryPath({
buildLogsDirectory: global.buildLogsDirectory,
});
await retryAsync(
async attemptCount => {
const timeoutMs = ANDROID_STARTUP_ATTEMPT_TIMEOUT_MS[attemptCount];
Expand All @@ -124,6 +127,12 @@ export function createStartAndroidEmulatorBuildFunction(): BuildFunction {
env,
});
attemptSerialId = startResult.serialId;
await AndroidEmulatorUtils.startLogcatStreamingAsync({
serialId: attemptSerialId,
outputDir: logcatOutputDir,
env,
logger,
});
await AndroidEmulatorUtils.waitForReadyAsync({
env,
serialId: attemptSerialId,
Expand Down Expand Up @@ -213,6 +222,12 @@ export function createStartAndroidEmulatorBuildFunction(): BuildFunction {
env,
});
cloneSerialId = startResult.serialId;
await AndroidEmulatorUtils.startLogcatStreamingAsync({
serialId: cloneSerialId,
outputDir: logcatOutputDir,
env,
logger,
});

logger.info('Waiting for emulator to become ready');
await AndroidEmulatorUtils.waitForReadyAsync({
Expand Down
60 changes: 60 additions & 0 deletions packages/build-tools/src/utils/AndroidEmulatorUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ export namespace AndroidEmulatorUtils {
process.arch === 'arm64' ? 'arm64-v8a' : 'x86_64'
}`;

export function getLogcatStagingDirectoryPath({
buildLogsDirectory,
}: {
buildLogsDirectory: string;
}): string {
return path.join(buildLogsDirectory, 'android-emulator-logcat');
}

export async function getAvailableDevicesAsync({
env,
}: {
Expand Down Expand Up @@ -490,6 +498,58 @@ export namespace AndroidEmulatorUtils {
return { outputPath };
}

export async function startLogcatStreamingAsync({
serialId,
outputDir,
env,
logger,
}: {
serialId: AndroidDeviceSerialId;
outputDir: string;
env: NodeJS.ProcessEnv;
logger: bunyan;
}): Promise<{ outputPath: string } | null> {
try {
await fs.promises.mkdir(outputDir, { recursive: true });

const logcatPromise = spawn('adb', ['-s', serialId, 'logcat', '-v', 'threadtime'], {
env,
stdio: ['ignore', 'pipe', 'pipe'],
});
const { child } = logcatPromise;

if (!child.stdout) {
throw new Error('"adb logcat" did not start correctly.');
}

const safeSerialId = serialId.replace(/[^a-zA-Z0-9_.-]/g, '_');
const outputPath = path.join(outputDir, `${child.pid}-${safeSerialId}.log`);
const writeStream = fs.createWriteStream(outputPath);
child.stdout.pipe(writeStream);
child.stdout.on('error', err => {
logger.warn({ err }, `Failed to read Android emulator logcat for ${serialId}.`);
});
writeStream.on('error', err => {
logger.warn({ err }, `Failed to write Android emulator logcat for ${serialId}.`);
});
child.on('close', () => {
writeStream.end();
});
child.unref();

void logcatPromise.catch(err => {
logger.warn({ err }, `Android emulator logcat stream for ${serialId} stopped.`);
});

logger.info(`Streaming Android emulator logcat for ${serialId} to ${outputPath}.`);

return { outputPath };
} catch (err) {
logger.warn({ err }, `Failed to start Android emulator logcat stream for ${serialId}.`);
return null;
}
}

export async function stopAsync({
serialId,
env,
Expand Down
78 changes: 78 additions & 0 deletions packages/build-tools/src/utils/__tests__/AndroidEmulatorUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import spawn from '@expo/turtle-spawn';
import { EventEmitter } from 'node:events';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { PassThrough } from 'node:stream';

import { createMockLogger } from '../../__tests__/utils/logger';
import { AndroidEmulatorUtils } from '../AndroidEmulatorUtils';
Expand All @@ -22,6 +27,79 @@ describe('AndroidEmulatorUtils', () => {
mockedRetryAsync.mockImplementation(async fn => await fn(0));
});

describe(AndroidEmulatorUtils.startLogcatStreamingAsync, () => {
function createSpawnPromise() {
const child = Object.assign(new EventEmitter(), {
pid: 1234,
stdout: new PassThrough(),
stderr: new PassThrough(),
unref: jest.fn(),
});
const spawnPromise = Promise.resolve({ stdout: '', stderr: '' }) as any;
spawnPromise.child = child;
return { child, spawnPromise };
}

it('streams logcat to a staged file', async () => {
const outputDir = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'logcat-staging-'));
const logger = createMockLogger();
const { child, spawnPromise } = createSpawnPromise();
mockedSpawn.mockReturnValueOnce(spawnPromise);

const result = await AndroidEmulatorUtils.startLogcatStreamingAsync({
serialId: 'emulator-5554' as any,
outputDir,
env: process.env,
logger,
});

expect(result).not.toBeNull();
expect(mockedSpawn).toHaveBeenCalledWith(
'adb',
['-s', 'emulator-5554', 'logcat', '-v', 'threadtime'],
{
env: process.env,
stdio: ['ignore', 'pipe', 'pipe'],
}
);
expect(child.unref).toHaveBeenCalled();

child.stdout.write('log line\n');
child.emit('close', 0);
await new Promise(resolve => setTimeout(resolve, 10));

expect(result!.outputPath.startsWith(outputDir)).toBe(true);
await expect(fs.promises.readFile(result!.outputPath, 'utf-8')).resolves.toContain(
'log line'
);
expect(path.basename(result!.outputPath)).toBe('1234-emulator-5554.log');
});

it('returns null and warns when logcat cannot start', async () => {
const outputDir = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'logcat-staging-'));
const logger = createMockLogger();
mockedSpawn.mockImplementationOnce(() => {
throw new Error('spawn failed');
});

await expect(
AndroidEmulatorUtils.startLogcatStreamingAsync({
serialId: 'emulator-5554' as any,
outputDir,
env: process.env,
logger,
})
).resolves.toBeNull();

expect(logger.warn).toHaveBeenCalledWith(
expect.objectContaining({
err: expect.objectContaining({ message: 'spawn failed' }),
}),
'Failed to start Android emulator logcat stream for emulator-5554.'
);
});
});

describe(AndroidEmulatorUtils.waitForReadyAsync, () => {
it('checks boot completion and verifies network with netcat to 1.1.1.1:443', async () => {
mockedSpawn.mockImplementation((async (_command: string, args: string[]) => {
Expand Down
Loading