add skipLogCapture #878

KazuCocoa · 2019-02-22T09:43:23Z

I ensured below:

@@driver.logs.get :syslog # worked if `skipLogCapture` is false or undefined
@@driver.logs.get :syslog # raised an error if `skipLogCapture` is true <= expected error

showIOSLog appears on appium console at the same time

mykola-mokhnach

It is not so easy with iOS. Please check all getLog occurrences in the code, because this will most likely throw an error if called with logging disabled. Also, it is necessary to check how such change would influence Simulator startup, because previously the fact that Simulator has started was checked via logs scanning. Which means that Simulator startup is going to always throw an error if the capability is set to true

KazuCocoa · 2019-02-22T11:25:17Z

Okay. thanks. Will check getLog and related things.

quick look:

Simulator launched as below from no-simulator process.

[XCUITest] Not scrubbing third party app in anticipation of uninstall
[debug] [BaseDriver] Event 'resetComplete' logged at 1550834491026 (20:21:31 GMT+0900 (Japan Standard Time))
[XCUITest] 'skipLogCapture' is set. Skipping starting logs such as crash, system, safari console and safari network.
[XCUITest] Setting up simulator
[debug] [iOSSim] Checking whether simulator has been run before: yes
[debug] [iOSSim] Updating reduce motion. Setting to true.
[debug] [iOS] No reason to set locale
[debug] [iOS] No iOS / app preferences to set
[debug] [iOSSim] Setting preferences of 8CB5BE32-3600-4007-B894-13E48EFB4D65 Simulator to {"ConnectHardwareKeyboard":false}
[debug] [iOSSim] Setting common Simulator preferences to {"RotateWindowWhenSignaledByGuest":true,"ConnectHardwareKeyboard":false}
[debug] [iOSSim] Updated 8CB5BE32-3600-4007-B894-13E48EFB4D65 Simulator preferences at '/Users/kazu/Library/Preferences/com.apple.iphonesimulator.plist' with {"DevicePreferences":{"8CB5BE32-3600-4007-B894-13E48EFB4D65":{"ConnectHardwareKeyboard":false}},"RotateWindowWhenSignaledByGuest":true,"ConnectHardwareKeyboard":false}
[iOSSim] Booting Simulator with UDID 8CB5BE32-3600-4007-B894-13E48EFB4D65...
[iOSSim] Starting Simulator UI with command: open -Fn /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app --args -CurrentDeviceUDID 8CB5BE32-3600-4007-B894-13E48EFB4D65 -ConnectHardwareKeyboard 0
[iOSSim] Simulator with UDID 8CB5BE32-3600-4007-B894-13E48EFB4D65 booted in 6 seconds
[debug] [BaseDriver] Event 'simStarted' logged at 1550834497933 (20:21:37 GMT+0900 (Japan Standard Time))
[XCUITest] 'skipLogCapture' is set. Skipping starting logs such as crash, system, safari console and safari network.
[debug] [XCUITest] Verifying application platform
[debug] [XCUITest] CFBundleSupportedPlatforms: ["iPhoneSimulator"]
[debug] [XCUITest] Reset requested. Removing app with id 'com.example.apple-samplecode.UICatalog' from the device
[debug] [XCUITest] Installing '/var/folders/34/2222sh8n27d6rcp7jqlkw8km0000gn/T/2019122-93066-17uvsy1.yppf/UICatalog.app' on Simulator with UUID '8CB5BE32-3600-4007-B894-13E48EFB4D65'...

jumois · 2019-02-22T11:39:38Z

There's also getAllLogs.

Are they used? I didn't find any usages for them.

KazuCocoa · 2019-02-22T12:19:45Z

browserName=safari also worked
- with no-simulator process
- with running simulator process
15 getLogs (including android)
- https://github.com/search?q=org%3Aappium+getLogs&type=Code
6 getAllLogs (including android)
- https://github.com/search?q=org%3Aappium+getAllLogs&type=Code
logs.safariConsole and logs.safariNetwork are called when swhitching context to webview
- no problem
logs.syslog, logs.crashlog
- are not called except for getting log command by clients

$ cd appium-ios-simulator/
$ git grep "getLogs"

$ cd appium-ios-driver/
$ git grep "getLogs"
lib/commands/logging.js:  const logs = logObject ? await logObject.getLogs() : null;
lib/device-log/ios-crash-log.js:  async getLogs () {
lib/device-log/ios-log.js:  async getLogs () { // eslint-disable-line require-await
lib/device-log/ios-performance-log.js:  async getLogs () { // eslint-disable-line require-await
lib/device-log/ios-performance-log.js:    return this.getLogs();
test/unit/ios-crash-log-specs.js:    (await log.getLogs()).should.have.length(0);
test/unit/ios-crash-log-specs.js:    let end = await log.getLogs();
test/unit/ios-crash-log-specs.js:    let middle = await log.getLogs();
test/unit/ios-crash-log-specs.js:    let end = await log.getLogs();
test/unit/ios-log-specs.js:    let recentLogs = await log.getLogs();
test/unit/ios-log-specs.js:        recentLogs = await log.getLogs();
test/unit/ios-performance-log-specs.js:    (await log.getLogs()).should.eql([message]);
test/unit/ios-performance-log-specs.js:    (await log.getLogs()).should.eql([message]);
test/unit/ios-performance-log-specs.js:    (await log.getLogs()).should.eql([]);

$ cd ../appium-xcuitest-driver/
$ git grep "getLogs"
lib/device-log/rotating-log.js:  async getLogs () { // eslint-disable-line require-await
lib/device-log/safari-network-log.js:  async getLogs () {
lib/device-log/safari-network-log.js:    const logs = await super.getLogs();

$ git grep "getAllLogs"
lib/device-log/rotating-log.js:  async getAllLogs () { // eslint-disable-line require-await

$ cd appium-ios-driver/
$ git grep "getAllLogs"
lib/device-log/ios-crash-log.js:  async getAllLogs () {
lib/device-log/ios-log.js:  async getAllLogs () { // eslint-disable-line require-await
lib/device-log/ios-performance-log.js:  async getAllLogs () { // eslint-disable-line require-await

$ cd ../appium-ios-simulator/
$ git grep "getAllLogs"
$

KazuCocoa · 2019-02-22T12:37:36Z

I grepped with some wordings and took a look at them.
I also ran some commands, but nothing wrong happened, so far.
(simulator)

imurchie · 2019-02-22T14:44:04Z

I don't think simulator startup should be a problem. Logs were only used for pre-iOS 8, and even then it uses tail in a separate process (distinct from capturing the logs in the downstream drivers).

imurchie · 2019-02-22T14:44:32Z

lib/desired-caps.js

  screenshotQuality: {
    isNumber: true
  },
+  skipLogCapture: {


This is not necessary if the desired capability is specified in appium-ios-driver.

Will remove here after appium-boneyard/appium-ios-driver#355 and publish new version.
(In this PR or as another PR)

imurchie · 2019-02-22T14:51:49Z

lib/driver.js

-    const isLogCaptureStarted = await startLogCapture();
+
+    if (this.opts.skipLogCapture) {
+      log.info("'skipLogCapture' is set. Skipping starting logs such as crash, system, safari console and safari network.");


This log line is repeated twice. Perhaps it would be better to move the check into the startLogCapture function on line 337?

const startLogCapture = async () => { if (this.opts.skipLogCapture) { log.info("'skipLogCapture' is set. Skipping starting logs such as crash, system, safari console and safari network."); return false; } const result = await this.startLogCapture(); if (result) { this.logEvent('logCaptureStarted'); } return result; };

make sense than mine 👍

lib/driver.js

mykola-mokhnach · 2019-02-22T18:39:35Z

extensions.setContext will throw an error if this.logs in undefined. It probably makes sense to set this var to an empty object in the driver constructor

lib/driver.js

mykola-mokhnach · 2019-02-27T05:51:43Z

lib/driver.js


    await this.runReset();

+    const memoizedSkipLogCaptureLog = _.memoize(function () {


memoizedLogInfo

mykola-mokhnach · 2019-02-27T05:54:44Z

Please add the new capability into readme

* add skipLogCapture * fix reviews * use memoize to prevent duplicated log * append skipLogCapture in caps table, tweak method name

add skipLogCapture

1d9be9b

This was referenced Feb 22, 2019

add skipLogcatCapture, skipLogCapture appium/appium#12206

Merged

idevicesyslog managed by appium when not requested appium/appium#10849

Closed

mykola-mokhnach requested changes Feb 22, 2019

View reviewed changes

imurchie reviewed Feb 22, 2019

View reviewed changes

mykola-mokhnach reviewed Feb 22, 2019

View reviewed changes

lib/driver.js Outdated Show resolved Hide resolved

fix reviews

3b21638

KazuCocoa mentioned this pull request Feb 23, 2019

add skipLogCapture appium-boneyard/appium-ios-driver#355

Merged

mykola-mokhnach reviewed Feb 25, 2019

View reviewed changes

lib/driver.js Outdated Show resolved Hide resolved

use memoize to prevent duplicated log

355096d

mykola-mokhnach reviewed Feb 27, 2019

View reviewed changes

mykola-mokhnach approved these changes Feb 27, 2019

View reviewed changes

append skipLogCapture in caps table, tweak method name

df3255b

KazuCocoa merged commit 6d39998 into appium:master Feb 27, 2019

KazuCocoa deleted the add-skip-capture-log branch February 27, 2019 14:27

KazuCocoa mentioned this pull request Mar 19, 2019

CHANGELOG 1.12 appium/appium#12348

Merged

khanayan123 pushed a commit to khanayan123/appium-xcuitest-driver that referenced this pull request May 10, 2021

add skipLogCapture (appium#878)

297591b

* add skipLogCapture * fix reviews * use memoize to prevent duplicated log * append skipLogCapture in caps table, tweak method name


		await this.runReset();

		const memoizedSkipLogCaptureLog = _.memoize(function () {

Uh oh!

add skipLogCapture #878

add skipLogCapture #878

Uh oh!

Conversation

KazuCocoa commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mykola-mokhnach left a comment

Choose a reason for hiding this comment

Uh oh!

KazuCocoa commented Feb 22, 2019

Uh oh!

jumois commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KazuCocoa commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KazuCocoa commented Feb 22, 2019

Uh oh!

imurchie commented Feb 22, 2019

Uh oh!

imurchie Feb 22, 2019

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Feb 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imurchie Feb 22, 2019

Choose a reason for hiding this comment

Uh oh!

KazuCocoa Feb 23, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mykola-mokhnach commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mykola-mokhnach Feb 27, 2019

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach commented Feb 27, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

KazuCocoa commented Feb 22, 2019 •

edited

Loading

jumois commented Feb 22, 2019 •

edited

Loading

KazuCocoa commented Feb 22, 2019 •

edited

Loading

KazuCocoa Feb 23, 2019 •

edited

Loading

mykola-mokhnach commented Feb 22, 2019 •

edited

Loading