feat(logs): improve android logging #5755
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,9 @@ import { DeviceAndroidDebugBridge } from "./device-android-debug-bridge"; | |
|
|
||
| interface IDeviceLoggingData { | ||
| loggingProcess: ChildProcess; | ||
| appStartTrackingProcess: ChildProcess; | ||
| lineStream: any; | ||
| rawLineStream: any; | ||
| keepSingleProcess: boolean; | ||
| } | ||
|
|
||
|
|
@@ -32,16 +34,18 @@ export class LogcatHelper implements Mobile.ILogcatHelper { | |
| loggingProcess: null, | ||
| lineStream: null, | ||
| keepSingleProcess: options.keepSingleProcess, | ||
| appStartTrackingProcess: null, | ||
| rawLineStream: null, | ||
| }; | ||
|
|
||
| const logcatStream = await this.getLogcatStream( | ||
| deviceIdentifier, | ||
| options.pid | ||
| ); | ||
|
|
||
| const lineStream = byline(logcatStream.stdout); | ||
| this.mapDevicesLoggingData[deviceIdentifier].loggingProcess = | ||
| logcatStream; | ||
| this.mapDevicesLoggingData[deviceIdentifier].lineStream = lineStream; | ||
| logcatStream.stderr.on("data", (data: Buffer) => { | ||
| this.$logger.trace("ADB logcat stderr: " + data.toString()); | ||
|
|
@@ -71,6 +75,41 @@ export class LogcatHelper implements Mobile.ILogcatHelper { | |
| ); | ||
| } | ||
| }); | ||
|
|
||
| const appStartTrackingStream = await this.getAppStartTrackingLogcatStream( | ||
| deviceIdentifier, | ||
| options.appId | ||
| ); | ||
|
|
||
| this.mapDevicesLoggingData[deviceIdentifier].appStartTrackingProcess = | ||
| appStartTrackingStream; | ||
|
|
||
| const rawLineStream = byline(appStartTrackingStream.stdout); | ||
| this.mapDevicesLoggingData[deviceIdentifier].rawLineStream = | ||
| rawLineStream; | ||
|
|
||
| rawLineStream.on("data", (lineBuffer: Buffer) => { | ||
| if (!this.mapDevicesLoggingData[deviceIdentifier]?.loggingProcess) | ||
| return; | ||
| const lines = (lineBuffer.toString() || "").split("\n"); | ||
| for (let line of lines) { | ||
| // 09-11 17:50:26.311 598 1979 I ActivityTaskManager: START u0 {flg=0x10000000 cmp=org.nativescript.myApp/com.tns.NativeScriptActivity} from uid 2000 | ||
| // ^^^^^ ^^^^^^^^^^^^^^^^^^^^^^ ^^^^ | ||
| // action appId pid | ||
|
|
||
| if ( | ||
| // action | ||
| line.includes("START") && | ||
| // appId | ||
| line.includes(options.appId) && | ||
| // pid - only if it's not the current pid... | ||
| !line.includes(options.pid) | ||
| ) { | ||
| this.forceStop(deviceIdentifier); | ||
| options.onAppRestarted?.(); | ||
|
There was a problem hiding this comment. Note: not |
||
| } | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -108,39 +147,92 @@ export class LogcatHelper implements Mobile.ILogcatHelper { | |
| } | ||
|
|
||
| private forceStop(deviceIdentifier: string): void { | ||
| const loggingData = this.mapDevicesLoggingData[deviceIdentifier]; | ||
| loggingData.loggingProcess?.removeAllListeners(); | ||
| loggingData.loggingProcess?.kill("SIGINT"); | ||
| loggingData.lineStream?.removeAllListeners(); | ||
|
|
||
| loggingData.appStartTrackingProcess?.kill("SIGINT"); | ||
| loggingData.lineStream?.removeAllListeners(); | ||
|
|
||
| delete this.mapDevicesLoggingData[deviceIdentifier]; | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated - we likely don't need this anymore, and can simplify the code... | ||
| */ | ||
| private async isLogcatPidSupported(deviceIdentifier: string) { | ||
| const device = await this.$devicesService.getDevice(deviceIdentifier); | ||
| const minAndroidWithLogcatPidSupport = "7.0.0"; | ||
| return ( | ||
| !!device.deviceInfo.version && | ||
| semver.gte( | ||
| semver.coerce(device.deviceInfo.version), | ||
| minAndroidWithLogcatPidSupport | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| private async getLogcatStream(deviceIdentifier: string, pid?: string) { | ||
| const isLogcatPidSupported = await this.isLogcatPidSupported( | ||
| deviceIdentifier | ||
| ); | ||
| const adb: Mobile.IDeviceAndroidDebugBridge = this.$injector.resolve( | ||
| DeviceAndroidDebugBridge, | ||
| { identifier: deviceIdentifier } | ||
| ); | ||
|
|
||
| // -T 1 - shows only new logs after starting adb logcat | ||
| const logcatCommand = ["logcat", "-T", "1"]; | ||
|
|
||
| const acceptedTags = [ | ||
| "chromium", | ||
| '"Web Console"', | ||
| "JS", | ||
| "System.err", | ||
| "TNS.Native", | ||
| "TNS.Java", | ||
| ]; | ||
|
|
||
| if (pid && isLogcatPidSupported) { | ||
| logcatCommand.push(`--pid=${pid}`); | ||
|
|
||
| acceptedTags.forEach((tag) => { | ||
| // -s <tag> - shows only logs with the specified tag | ||
| logcatCommand.push("-s", tag); | ||
| }); | ||
|
Comment on lines
+188
to
+203
There was a problem hiding this comment. @ammarahm-ed this is a great idea to move here - technically if I've extracted the |
||
| } | ||
|
|
||
| const logcatStream = await adb.executeCommand(logcatCommand, { | ||
| returnChildProcess: true, | ||
| }); | ||
|
|
||
| return logcatStream; | ||
| } | ||
|
|
||
| private async getAppStartTrackingLogcatStream( | ||
| deviceIdentifier: string, | ||
| appId?: string | ||
| ) { | ||
| const adb: Mobile.IDeviceAndroidDebugBridge = this.$injector.resolve( | ||
| DeviceAndroidDebugBridge, | ||
| { identifier: deviceIdentifier } | ||
| ); | ||
|
|
||
| // -b system - shows the system buffer/logs only | ||
| // -T 1 - shows only new logs after starting adb logcat | ||
| const logcatCommand = [`logcat`, `-b`, `system`, `-T`, `1`]; | ||
|
There was a problem hiding this comment. Note: Added the |
||
|
|
||
| if (appId) { | ||
| logcatCommand.push(`--regex=START.*${appId}`); | ||
| } | ||
|
|
||
| const appStartTrackingStream = await adb.executeCommand(logcatCommand, { | ||
| returnChildProcess: true, | ||
| }); | ||
|
|
||
| return appStartTrackingStream; | ||
| } | ||
| } | ||
|
|
||
| injector.register("logcatHelper", LogcatHelper); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: I flipped this condition to speed up matching by optimizing for API23 first and then falling back to legacy regex.