@yume-chan/android-bin 0.0.15 → 0.0.17

package/src/demo-mode.ts

@@ -1,179 +1,179 @@
-// cspell: ignore carriernetworkchange
-// cspell: ignore powersave
-// cspell: ignore nosim
-// cspell: ignore systemui
-// cspell: ignore sysui
-
-import { Adb, AdbCommandBase } from '@yume-chan/adb';
-import { Settings } from "./settings.js";
-
-export enum DemoModeSignalStrength {
-    Hidden = 'null',
-    Level0 = '0',
-    Level1 = '1',
-    Level2 = '2',
-    Level3 = '3',
-    Level4 = '4',
-}
-
-// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/policy/NetworkControllerImpl.java;l=1073
-export const DemoModeMobileDataTypes = ['1x', '3g', '4g', '4g+', '5g', '5ge', '5g+',
-    'e', 'g', 'h', 'h+', 'lte', 'lte+', 'dis', 'not', 'null'] as const;
-
-export type DemoModeMobileDataType = (typeof DemoModeMobileDataTypes)[number];
-
-// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBar.java;l=3136
-export const DemoModeStatusBarModes = ['opaque', 'translucent', 'semi-transparent', 'transparent', 'warning'] as const;
-
-export type DemoModeStatusBarMode = (typeof DemoModeStatusBarModes)[number];
-
-export class DemoMode extends AdbCommandBase {
-    private settings: Settings;
-
-    constructor(adb: Adb) {
-        super(adb);
-        this.settings = new Settings(adb);
-    }
-
-    public static readonly AllowedSettingKey = 'sysui_demo_allowed';
-
-    // Demo Mode actually doesn't have a setting indicates its enablement
-    // However Developer Mode menu uses this key
-    // So we can only try our best to guess if it's enabled
-    public static readonly EnabledSettingKey = 'sysui_tuner_demo_on';
-
-    public async getAllowed(): Promise<boolean> {
-        const output = await this.settings.get('global', DemoMode.AllowedSettingKey);
-        return output.trim() === '1';
-    }
-
-    public async setAllowed(value: boolean): Promise<void> {
-        if (value) {
-            await this.settings.put('global', DemoMode.AllowedSettingKey, '1');
-        } else {
-            await this.setEnabled(false);
-            await this.settings.delete('global', DemoMode.AllowedSettingKey);
-        }
-    }
-
-    public async getEnabled(): Promise<boolean> {
-        const result = await this.settings.get('global', DemoMode.EnabledSettingKey);
-        return result.trim() === '1';
-    }
-
-    public async setEnabled(value: boolean): Promise<void> {
-        if (value) {
-            await this.settings.put('global', DemoMode.EnabledSettingKey, '1');
-        } else {
-            await this.settings.delete('global', DemoMode.EnabledSettingKey);
-            await this.broadcast('exit');
-        }
-    }
-
-    public async broadcast(command: string, extra?: Record<string, string>): Promise<void> {
-        await this.adb.subprocess.spawnAndWaitLegacy([
-            'am',
-            'broadcast',
-            '-a',
-            'com.android.systemui.demo',
-            '-e',
-            'command',
-            command,
-            ...(extra ? Object.entries(extra).flatMap(([key, value]) => ['-e', key, value]) : []),
-        ]);
-    }
-
-    public async setBatteryLevel(level: number): Promise<void> {
-        await this.broadcast('battery', { level: level.toString() });
-    }
-
-    public async setBatteryCharging(value: boolean): Promise<void> {
-        await this.broadcast('battery', { plugged: value.toString() });
-    }
-
-    public async setPowerSaveMode(value: boolean): Promise<void> {
-        await this.broadcast('battery', { powersave: value.toString() });
-    }
-
-    public async setAirplaneMode(show: boolean): Promise<void> {
-        await this.broadcast('network', { airplane: show ? 'show' : 'hide' });
-    }
-
-    public async setWifiSignalStrength(value: DemoModeSignalStrength): Promise<void> {
-        await this.broadcast('network', { wifi: 'show', level: value });
-    }
-
-    public async setMobileDataType(value: DemoModeMobileDataType): Promise<void> {
-        for (let i = 0; i < 2; i += 1) {
-            await this.broadcast('network', {
-                mobile: 'show',
-                sims: '1',
-                nosim: 'hide',
-                slot: '0',
-                datatype: value,
-                fully: 'true',
-                roam: 'false',
-                level: '4',
-                inflate: 'false',
-                activity: 'in',
-                carriernetworkchange: 'hide',
-            });
-        }
-    }
-
-    public async setMobileSignalStrength(value: DemoModeSignalStrength): Promise<void> {
-        await this.broadcast('network', { mobile: 'show', level: value });
-    }
-
-    public async setNoSimCardIcon(show: boolean): Promise<void> {
-        await this.broadcast('network', { nosim: show ? 'show' : 'hide' });
-    }
-
-    public async setStatusBarMode(mode: DemoModeStatusBarMode): Promise<void> {
-        await this.broadcast('bars', { mode });
-    }
-
-    public async setVibrateModeEnabled(value: boolean): Promise<void> {
-        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/DemoStatusIcons.java;l=103
-        await this.broadcast('status', { volume: value ? 'vibrate' : 'hide' });
-    }
-
-    public async setBluetoothConnected(value: boolean): Promise<void> {
-        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/DemoStatusIcons.java;l=114
-        await this.broadcast('status', { bluetooth: value ? 'connected' : 'hide' });
-    }
-
-    public async setLocatingIcon(show: boolean): Promise<void> {
-        await this.broadcast('status', { location: show ? 'show' : 'hide' });
-    }
-
-    public async setAlarmIcon(show: boolean): Promise<void> {
-        await this.broadcast('status', { alarm: show ? 'show' : 'hide' });
-    }
-
-    public async setSyncingIcon(show: boolean): Promise<void> {
-        await this.broadcast('status', { sync: show ? 'show' : 'hide' });
-    }
-
-    public async setMuteIcon(show: boolean): Promise<void> {
-        await this.broadcast('status', { mute: show ? 'show' : 'hide' });
-    }
-
-    public async setSpeakerPhoneIcon(show: boolean): Promise<void> {
-        await this.broadcast('status', { speakerphone: show ? 'show' : 'hide' });
-    }
-
-    public async setNotificationsVisibility(show: boolean): Promise<void> {
-        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBar.java;l=3131
-        await this.broadcast('notifications', { visible: show.toString() });
-    }
-
-    public async setTime(hour: number, minute: number): Promise<void> {
-        await this.broadcast('clock', {
-            // cspell: disable-next-line
-            hhmm:
-                hour.toString().padStart(2, '0') +
-                minute.toString().padStart(2, '0'),
-        });
-    }
-}
+// cspell: ignore carriernetworkchange
+// cspell: ignore powersave
+// cspell: ignore nosim
+// cspell: ignore systemui
+// cspell: ignore sysui
+
+import { Adb, AdbCommandBase } from '@yume-chan/adb';
+import { Settings } from "./settings.js";
+
+export enum DemoModeSignalStrength {
+    Hidden = 'null',
+    Level0 = '0',
+    Level1 = '1',
+    Level2 = '2',
+    Level3 = '3',
+    Level4 = '4',
+}
+
+// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/connectivity/NetworkControllerImpl.java;l=1362;drc=3b775bf7ad89902f94e03d191b0d8fbdebf2bdbf
+export const DemoModeMobileDataTypes = ['1x', '3g', '4g', '4g+', '5g', '5ge', '5g+',
+    'e', 'g', 'h', 'h+', 'lte', 'lte+', 'dis', 'not', 'null'] as const;
+
+export type DemoModeMobileDataType = (typeof DemoModeMobileDataTypes)[number];
+
+// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBar.java;l=3136
+export const DemoModeStatusBarModes = ['opaque', 'translucent', 'semi-transparent', 'transparent', 'warning'] as const;
+
+export type DemoModeStatusBarMode = (typeof DemoModeStatusBarModes)[number];
+
+export class DemoMode extends AdbCommandBase {
+    private settings: Settings;
+
+    constructor(adb: Adb) {
+        super(adb);
+        this.settings = new Settings(adb);
+    }
+
+    public static readonly AllowedSettingKey = 'sysui_demo_allowed';
+
+    // Demo Mode actually doesn't have a setting indicates its enablement
+    // However Developer Mode menu uses this key
+    // So we can only try our best to guess if it's enabled
+    public static readonly EnabledSettingKey = 'sysui_tuner_demo_on';
+
+    public async getAllowed(): Promise<boolean> {
+        const output = await this.settings.get('global', DemoMode.AllowedSettingKey);
+        return output.trim() === '1';
+    }
+
+    public async setAllowed(value: boolean): Promise<void> {
+        if (value) {
+            await this.settings.put('global', DemoMode.AllowedSettingKey, '1');
+        } else {
+            await this.setEnabled(false);
+            await this.settings.delete('global', DemoMode.AllowedSettingKey);
+        }
+    }
+
+    public async getEnabled(): Promise<boolean> {
+        const result = await this.settings.get('global', DemoMode.EnabledSettingKey);
+        return result.trim() === '1';
+    }
+
+    public async setEnabled(value: boolean): Promise<void> {
+        if (value) {
+            await this.settings.put('global', DemoMode.EnabledSettingKey, '1');
+        } else {
+            await this.settings.delete('global', DemoMode.EnabledSettingKey);
+            await this.broadcast('exit');
+        }
+    }
+
+    public async broadcast(command: string, extra?: Record<string, string>): Promise<void> {
+        await this.adb.subprocess.spawnAndWaitLegacy([
+            'am',
+            'broadcast',
+            '-a',
+            'com.android.systemui.demo',
+            '-e',
+            'command',
+            command,
+            ...(extra ? Object.entries(extra).flatMap(([key, value]) => ['-e', key, value]) : []),
+        ]);
+    }
+
+    public async setBatteryLevel(level: number): Promise<void> {
+        await this.broadcast('battery', { level: level.toString() });
+    }
+
+    public async setBatteryCharging(value: boolean): Promise<void> {
+        await this.broadcast('battery', { plugged: value.toString() });
+    }
+
+    public async setPowerSaveMode(value: boolean): Promise<void> {
+        await this.broadcast('battery', { powersave: value.toString() });
+    }
+
+    public async setAirplaneMode(show: boolean): Promise<void> {
+        await this.broadcast('network', { airplane: show ? 'show' : 'hide' });
+    }
+
+    public async setWifiSignalStrength(value: DemoModeSignalStrength): Promise<void> {
+        await this.broadcast('network', { wifi: 'show', level: value });
+    }
+
+    public async setMobileDataType(value: DemoModeMobileDataType): Promise<void> {
+        for (let i = 0; i < 2; i += 1) {
+            await this.broadcast('network', {
+                mobile: 'show',
+                sims: '1',
+                nosim: 'hide',
+                slot: '0',
+                datatype: value,
+                fully: 'true',
+                roam: 'false',
+                level: '4',
+                inflate: 'false',
+                activity: 'in',
+                carriernetworkchange: 'hide',
+            });
+        }
+    }
+
+    public async setMobileSignalStrength(value: DemoModeSignalStrength): Promise<void> {
+        await this.broadcast('network', { mobile: 'show', level: value });
+    }
+
+    public async setNoSimCardIcon(show: boolean): Promise<void> {
+        await this.broadcast('network', { nosim: show ? 'show' : 'hide' });
+    }
+
+    public async setStatusBarMode(mode: DemoModeStatusBarMode): Promise<void> {
+        await this.broadcast('bars', { mode });
+    }
+
+    public async setVibrateModeEnabled(value: boolean): Promise<void> {
+        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/DemoStatusIcons.java;l=103
+        await this.broadcast('status', { volume: value ? 'vibrate' : 'hide' });
+    }
+
+    public async setBluetoothConnected(value: boolean): Promise<void> {
+        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/DemoStatusIcons.java;l=114
+        await this.broadcast('status', { bluetooth: value ? 'connected' : 'hide' });
+    }
+
+    public async setLocatingIcon(show: boolean): Promise<void> {
+        await this.broadcast('status', { location: show ? 'show' : 'hide' });
+    }
+
+    public async setAlarmIcon(show: boolean): Promise<void> {
+        await this.broadcast('status', { alarm: show ? 'show' : 'hide' });
+    }
+
+    public async setSyncingIcon(show: boolean): Promise<void> {
+        await this.broadcast('status', { sync: show ? 'show' : 'hide' });
+    }
+
+    public async setMuteIcon(show: boolean): Promise<void> {
+        await this.broadcast('status', { mute: show ? 'show' : 'hide' });
+    }
+
+    public async setSpeakerPhoneIcon(show: boolean): Promise<void> {
+        await this.broadcast('status', { speakerphone: show ? 'show' : 'hide' });
+    }
+
+    public async setNotificationsVisibility(show: boolean): Promise<void> {
+        // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/packages/SystemUI/src/com/android/systemui/statusbar/phone/StatusBar.java;l=3131
+        await this.broadcast('notifications', { visible: show.toString() });
+    }
+
+    public async setTime(hour: number, minute: number): Promise<void> {
+        await this.broadcast('clock', {
+            // cspell: disable-next-line
+            hhmm:
+                hour.toString().padStart(2, '0') +
+                minute.toString().padStart(2, '0'),
+        });
+    }
+}

package/src/index.ts

@@ -1,6 +1,6 @@
-// cspell: ignore logcat
-
-export * from './bug-report.js';
-export * from './demo-mode.js';
-export * from './logcat.js';
-export * from './settings.js';
+// cspell: ignore logcat
+
+export * from './bug-report.js';
+export * from './demo-mode.js';
+export * from './logcat.js';
+export * from './settings.js';

package/src/logcat.ts

@@ -1,7 +1,8 @@
 // cspell: ignore logcat
 
-import { AdbCommandBase, BufferedStream, BufferedStreamEndedError, DecodeUtf8Stream, ReadableStream, SplitLineStream, WritableStream } from "@yume-chan/adb";
-import Struct, { StructAsyncDeserializeStream } from "@yume-chan/struct";
+import { AdbCommandBase, AdbSubprocessNoneProtocol } from '@yume-chan/adb';
+import { BufferedTransformStream, DecodeUtf8Stream, SplitStringStream, WrapReadableStream, WritableStream, type ReadableStream } from '@yume-chan/stream-extra';
+import Struct, { decodeUtf8, StructAsyncDeserializeStream } from '@yume-chan/struct';
 
 // `adb logcat` is an alias to `adb shell logcat`
 // so instead of adding to core library, it's implemented here
@@ -19,10 +20,12 @@ export enum LogId {
     Kernel,
 }
 
-export enum LogPriority {
+// https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/include/android/log.h;l=73;drc=82b5738732161dbaafb2e2f25cce19cd26b9157d
+export enum AndroidLogPriority {
     Unknown,
     Default,
     Verbose,
+    Debug,
     Info,
     Warn,
     Error,
@@ -30,6 +33,41 @@ export enum LogPriority {
     Silent,
 }
 
+// https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/logprint.cpp;l=140;drc=8dbf3b2bb6b6d1652d9797e477b9abd03278bb79
+export const AndroidLogPriorityToCharacter: Record<AndroidLogPriority, string> = {
+    [AndroidLogPriority.Unknown]: '?',
+    [AndroidLogPriority.Default]: '?',
+    [AndroidLogPriority.Verbose]: 'V',
+    [AndroidLogPriority.Debug]: 'D',
+    [AndroidLogPriority.Info]: 'I',
+    [AndroidLogPriority.Warn]: 'W',
+    [AndroidLogPriority.Error]: 'E',
+    [AndroidLogPriority.Fatal]: 'F',
+    [AndroidLogPriority.Silent]: 'S',
+};
+
+export enum LogcatFormat {
+    Brief,
+    Process,
+    Tag,
+    Thread,
+    Raw,
+    Time,
+    ThreadTime,
+    Long
+}
+
+export interface LogcatFormatModifiers {
+    usec?: boolean;
+    printable?: boolean;
+    year?: boolean;
+    zone?: boolean;
+    epoch?: boolean;
+    monotonic?: boolean;
+    uid?: boolean;
+    descriptive?: boolean;
+}
+
 export interface LogcatOptions {
     pid?: number;
     ids?: LogId[];
@@ -56,17 +94,60 @@ export const LoggerEntry =
 
 export type LoggerEntry = typeof LoggerEntry['TDeserializeResult'];
 
-export interface LogMessage extends LoggerEntry {
-    priority: LogPriority;
-    payload: Uint8Array;
+// https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/logprint.cpp;drc=bbe77d66e7bee8bd1f0bc7e5492b5376b0207ef6;bpv=0
+export interface AndroidLogEntry extends LoggerEntry {
+    priority: AndroidLogPriority;
+    tag: string;
+    message: string;
+}
+
+// https://cs.android.com/android/platform/superproject/+/master:system/logging/liblog/logprint.cpp;l=1415;drc=8dbf3b2bb6b6d1652d9797e477b9abd03278bb79
+export function formatAndroidLogEntry(
+    entry: AndroidLogEntry,
+    format: LogcatFormat = LogcatFormat.Brief,
+    modifier?: LogcatFormatModifiers
+) {
+    const uid = modifier?.uid ? `${entry.uid.toString().padStart(5)}:` : '';
+
+    switch (format) {
+        // TODO: implement other formats
+        default:
+            return `${AndroidLogPriorityToCharacter[entry.priority]}/${entry.tag.padEnd(8)}(${uid}${entry.pid.toString().padStart(5)}): ${entry.message}`;
+    }
+}
+
+function findTagEnd(payload: Uint8Array) {
+    for (const separator of [0, ' '.charCodeAt(0), ':'.charCodeAt(0)]) {
+        const index = payload.indexOf(separator);
+        if (index !== -1) {
+            return index;
+        }
+    }
+
+    const index = payload.findIndex(x => x >= 0x7f);
+    if (index !== -1) {
+        return index;
+    }
+
+    return payload.length;
 }
 
-export async function deserializeLogMessage(stream: StructAsyncDeserializeStream): Promise<LogMessage> {
-    const entry = await LoggerEntry.deserialize(stream);
-    await stream.read(entry.headerSize - LoggerEntry.size);
-    const priority = (await stream.read(1))[0] as LogPriority;
-    const payload = await stream.read(entry.payloadSize - 1);
-    return { ...entry, priority, payload };
+export async function deserializeAndroidLogEntry(stream: StructAsyncDeserializeStream): Promise<AndroidLogEntry> {
+    const entry = await LoggerEntry.deserialize(stream) as unknown as AndroidLogEntry;
+    if (entry.headerSize !== LoggerEntry.size) {
+        await stream.read(entry.headerSize - LoggerEntry.size);
+    }
+    let payload = await stream.read(entry.payloadSize);
+
+    // https://cs.android.com/android/platform/superproject/+/master:system/logging/logcat/logcat.cpp;l=193-194;drc=bbe77d66e7bee8bd1f0bc7e5492b5376b0207ef6
+    // TODO: payload for some log IDs are in binary format.
+    entry.priority = payload[0] as AndroidLogPriority;
+
+    payload = payload.subarray(1);
+    const tagEnd = findTagEnd(payload);
+    entry.tag = decodeUtf8(payload.subarray(0, tagEnd));
+    entry.message = tagEnd < payload.length - 1 ? decodeUtf8(payload.subarray(tagEnd + 1)) : '';
+    return entry;
 }
 
 export interface LogSize {
@@ -115,7 +196,7 @@ export class Logcat extends AdbCommandBase {
         const result: LogSize[] = [];
         await stdout
             .pipeThrough(new DecodeUtf8Stream())
-            .pipeThrough(new SplitLineStream())
+            .pipeThrough(new SplitStringStream('\n'))
             .pipeTo(new WritableStream({
                 write(chunk) {
                     let match = chunk.match(Logcat.LOG_SIZE_REGEX_11);
@@ -154,34 +235,22 @@ export class Logcat extends AdbCommandBase {
         ]);
     }
 
-    public binary(options?: LogcatOptions): ReadableStream<LogMessage> {
-        let bufferedStream: BufferedStream;
-        return new ReadableStream({
-            start: async () => {
-                const { stdout } = await this.adb.subprocess.spawn([
-                    'logcat',
-                    '-B',
-                    ...(options?.pid ? ['--pid', options.pid.toString()] : []),
-                    ...(options?.ids ? ['-b', Logcat.joinLogId(options.ids)] : [])
-                ]);
-                bufferedStream = new BufferedStream(stdout);
-            },
-            async pull(controller) {
-                try {
-                    const entry = await deserializeLogMessage(bufferedStream);
-                    controller.enqueue(entry);
-                } catch (e) {
-                    if (e instanceof BufferedStreamEndedError) {
-                        controller.close();
-                        return;
-                    }
-
-                    throw e;
-                }
-            },
-            cancel() {
-                bufferedStream.close();
-            },
-        });
+    public binary(options?: LogcatOptions): ReadableStream<AndroidLogEntry> {
+        return new WrapReadableStream(async () => {
+            // TODO: make `spawn` return synchronously with streams pending
+            // so it's easier to chain them.
+            const { stdout } = await this.adb.subprocess.spawn([
+                'logcat',
+                '-B',
+                ...(options?.pid ? ['--pid', options.pid.toString()] : []),
+                ...(options?.ids ? ['-b', Logcat.joinLogId(options.ids)] : [])
+            ], {
+                // PERF: None protocol is 150% faster then Shell protocol
+                protocols: [AdbSubprocessNoneProtocol],
+            });
+            return stdout;
+        }).pipeThrough(new BufferedTransformStream(stream => {
+            return deserializeAndroidLogEntry(stream);
+        }));
     }
 }