fix: Only try to select Safari if it is enabled for automation

[mykola-mokhnach]

Safari does not return any pages if it is not available for automation

[mykola-mokhnach]

@KazuCocoa Do you think it makes sense to enable this condition for any web views or it is only applicable to Safari only?

[github-actions]

🎉 This issue has been resolved in version 12.1.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[KazuCocoa]

Let me check a bit carefully with some combinations. I think the true/false conditions themselves should be the same for both Safari/WebView, but I need to double check the Ui Automation and the WebInspector config in the settings app.

UI Automation in Safari settings may not affect the remote debugger (WebInspector) usage but Web Inspector affects it.

[KazuCocoa]

[debug] [RemoteDebugger] Selecting application
[debug] [RemoteDebugger] Current applications available:
[debug] [RemoteDebugger]     Application: "PID:726"
[debug] [RemoteDebugger]         id: "PID:726"
[debug] [RemoteDebugger]         isProxy: false
[debug] [RemoteDebugger]         name: "amsengagementd"
[debug] [RemoteDebugger]         bundleId: "com.apple.amsengagementd"
[debug] [RemoteDebugger]         hostId: undefined
[debug] [RemoteDebugger]         isActive: false
[debug] [RemoteDebugger]         isAutomationEnabled: "Unknown"
[debug] [RemoteDebugger]     Application: "PID:1046"
[debug] [RemoteDebugger]         id: "PID:1046"
[debug] [RemoteDebugger]         isProxy: false
[debug] [RemoteDebugger]         name: "Safari"
[debug] [RemoteDebugger]         bundleId: "com.apple.mobilesafari"
[debug] [RemoteDebugger]         hostId: undefined
[debug] [RemoteDebugger]         isActive: true
[debug] [RemoteDebugger]         isAutomationEnabled: "Unknown"
[debug] [RemoteDebugger]     Application: "PID:298"
[debug] [RemoteDebugger]         id: "PID:298"
[debug] [RemoteDebugger]         isProxy: false
[debug] [RemoteDebugger]         name: "HeuristicInterpreter"
[debug] [RemoteDebugger]         bundleId: "process-HeuristicInterpreter"
[debug] [RemoteDebugger]         hostId: undefined
[debug] [RemoteDebugger]         isActive: false
[debug] [RemoteDebugger]         isAutomationEnabled: "Unknown"
[debug] [RemoteDebugger] Checking for bundle identifiers: com.apple.WebKit.WebContent, process-com.apple.WebKit.WebContent, process-SafariViewService, com.apple.SafariViewService, *, com.apple.mobilesafari
[debug] [RemoteDebugger] Found app id key 'PID:1046' for bundle 'com.apple.mobilesafari'
[debug] [RemoteDebugger] Trying out the possible app ids: PID:1046 (try #1 of 10)

Just a note: as https://github.com/mykola-mokhnach/appium-remote-debugger/blob/e959dbb66aed40a97955b241227acf4019a6a6f9/lib/utils.js#L66-L67, we have a case isAutomationEnable is configured as "Unknown". It is a valid value for automation via Web Inspector.

[KazuCocoa]

Another note for a webview app (uikitcatalog):

isInspectable was false:

[debug] [RemoteDebugger]     Application: "PID:1209"
[debug] [RemoteDebugger]         id: "PID:1209"
[debug] [RemoteDebugger]         isProxy: false
[debug] [RemoteDebugger]         name: "UIKitCatalog"
[debug] [RemoteDebugger]         bundleId: "com.kazucocoa.apple-samplecode.UICatalog"
[debug] [RemoteDebugger]         hostId: undefined
[debug] [RemoteDebugger]         isActive: true
[debug] [RemoteDebugger]         isAutomationEnabled: "Unknown"
[debug] [RemoteDebugger] Checking for bundle identifiers: com.apple.WebKit.WebContent, process-com.apple.WebKit.WebContent, process-SafariViewService, com.apple.SafariViewService, *, com.kazucocoa.apple-samplecode.UICatalog
[debug] [RemoteDebugger] Found app id key 'PID:1209' for bundle 'com.kazucocoa.apple-samplecode.UICatalog'
[debug] [RemoteDebugger] Trying out the possible app ids: PID:1209 (try #20 of 20)
[debug] [RemoteDebugger] Attempting app 'PID:1209'
[debug] [RemoteDebugger] Sending '_rpc_forwardGetListing:' message to app 'PID:1209' (id: 58): 'connectToApp'
[debug] [ios-device] Sent message to Web Inspector:
[debug] [ios-device] {
  "__argument": {
    "WIRConnectionIdentifierKey": "af249c12-b1bb-411a-9ee4-d5e1a62452e9",
    "WIRApplicationIdentifierKey": "PID:1209"
  },
  "__selector": "_rpc_forwardGetListing:"
}
[debug] [ios-device] Received message from Web Inspector:
[debug] [ios-device] {
  "__argument": {
    "WIRApplicationIdentifierKey": "PID:1209",
    "WIRListingKey": {}
  },
  "__selector": "_rpc_applicationSentListing:"
}
[debug] [RemoteDebugger] Received response from send (id: 58): '["PID:1209",{}]'
[debug] [RemoteDebugger] Sending to Web Inspector took 6ms
[debug] [RemoteDebugger] Error: Empty page dictionary received
    at /Users/kazu/GitHub/appium-remote-debugger/lib/rpc/rpc-client.js:757:20
[RemoteDebugger] Error checking application PID:1209: 'Empty page dictionary received'

isInspectable was true:

...
      "PID:1215": {
        "WIRApplicationIconKey": "�PNG\r\n\u001a\n\u0000\u0000\u0000\rIHDR\u0000\u0000\u0000(\u0000\u0000\u0000(\b\u0006\u0000\u0000\u0000���m\u0000\u0000\u0000\u0001sRGB\u0000��\u001c�\u0000\u0000\u00008eXIfMM\u0000*\u0000\u0000\u0000\b\u0000\u0001�i\u0000\u0004\u0000\u0000\u0000\u0001\u0000\u0000\u0000\u001a\u0000\u0000\u0000\u0000\u0000\u0002�\u0002\u0000\u0004\u0000\u0000\u0000\u0001\u0000\u0000\u0000(�\u0003\u0000\u0004\u0000\u0000\u0000\u0001\u0000\u0000\u0000(\u0000\u0000\u0000\u0000Y.D�\u0000\u0000\u0006[IDATX\t͘�N]G\u0010���`0�`l��\u0014\u0006��\u0010��\u0017HĬ�E�\"��\u0017�3�)X���AfA`� 0C\u0010\b�,fl3sS_��I��}�\"H���}�����ԃ1\u0001J�R���,�7i��\u000e��I�~���taZ^^Nђ(=�JƑ�Ld�\u0003]�\u0003PL���0}#�H{������\"/?�J�Gg���D�;������KzKY�088�mvv�������S�p}}�C__�\u001f�\u0016�rCCC\u0003yyye�����,\u0019����O�>���RSYYi\u001e=zd�����֖����Zs~~nNOO���9<<4����������&~7|333e\u0017\u0017\u0017\u0003��\u0015�T\u0017�ֲ��6\u0018L\b���Y\\\\��>}j***�X<�L�\u000b\u000b\u000b\r�\u000f\u0000�X����Y�\u0013\u0013\u0013���ɔ�����\u00190LNNb!0�g\u000bR���\u001c\u0002a����� �\u0016\u0018�\u0001\f����\u0000g\u0007\u0012~\u0000�\u001c\b\u0019��c�\r�����72ރ\t����]�|��Ԕ9991]]]����e��32��Ld���[�a\u0018\u0007���\u001e���M{\u0018[ZŻ\u000f\u001fll�����\\�\u0006�{�,dJ̛��i�+\u0000\u000e\u0005�\u0000��������-|!.�oB&I��ѥ���4\u00000�oKKK6�H\u0016M��@J֙��#���g�:2��H\"7��A��3@5���\u001d [)\r�\t�1Iv\u0003V�/���6����˗/��������Zbaa�\u0002en}}}�l��ԭ���ؘ������\u0010�y����jll�Ŝ\u000b\u0012\u001e,477g㳡��\u0002��eVVV\u00186�\u0007X�\f�����f;�\u001f�����D'�;;;-_�'/�����=g��,@]!p\t�C�p����;PYp-��ǭd��Օ�����q}���1\u001b\u001b\u001b�\u0015�$�\bו��G��\u0003�q\u000f�5��s5�(+����\u000ee��N`p)\u0006�����e�R��ݘ\u0004@\u0012)8��\u0014h�K����&<1�I�%\n0��\u0017/\"���\f�c2\t���\u001e��\u001f|\f1��JBD�c�\u001fO\u0002�\u0004\u000eٸ��:��\u0001d�\u0014\"��7�� ���\f-TJ���B١v��ǐ��\u00073��P\f��!Xy�w\u0015`\u0019w?��h>1��[[[�@�q���Y�g��t%��`O��Z�W��6'����c7���'\u0004���§s�Oc��)\u001f�R�f���\\��ٳg�ɓ':\u0014�d�Ǐ\u001f#\u001d1\u000b�M\u000f\u0011��\b�H�\u0001����&�Mu�\u000f@V�\u0010��1�\u0000r�\b\u0011��LƊ.���$r\u0013ǏC�WTT����\u0018b\u0000qM�rrrly �����x\u0012H\n~]]��e�>�\u0018@�&\u0005/�\r-���S�!��0��n��1�\u001c\r�\"��\u0002��qS��� \u0019c��\u0006�K\u000f~�EY����;\u0017�N����W�$�S��ÖOb�>s\u000f#\u001bӈ�w�����llS###)I2;\u0017\u0019��\t��\u0014�<^����\u0016�q\u001c�9��2�z@n�ɡ�n�\u0019������zƖ_K\u0011�\u000b搑�����\r�\u0006i\tr�$�odq>��\u0012\u0004'�\"����Q��g\u000f�#���I���RH���D|q�|��\u0005�Ǜ\u001b�\n\u0012]��o\u001b�\u0006�mi�j�\u0017�s��\u001b\u0006\u0015$C\u0019�e��@\\bǟ?�������\u001e��Eg����\u0015���F\t[p\u0004���y���Ld�\u0003]���rW\u00008�+���b��y�8�/B\u00162�M\u0018�\u000b�\u0001\u001a\u0005�[w��9����\u000e�nrn�\u001c�_\t\u0019�b-F6:4q\u0002 ��\u0016�\u000e��w(v��[1=�M���pKҊc\u0019�\u001fx�\u0003!\u0003Y�T��1�|'���M�\u00047\u0017��\\`ޔ\u0010(��)�/\u0004�}d�=^`��\u0003��\u0017��.�^\u0001c�����ߥ%�S�3x���g�in�\u0017�\\�G��R�~\u0015�s��/Lܺr���![nn��js�\u0013Y]��B\u0014KV/\u0016\b��2G%y+�ɇ\u0018�\r\r�\n#\u0015��2\u0000\u0000\u0000\u0000IEND�B`�",
        "WIRIsApplicationActiveKey": 2,
        "WIRIsApplicationReadyKey": true,
        "WIRApplicationIdentifierKey": "PID:1215",
        "WIRIsApplicationProxyKey": false,
        "WIRApplicationNameKey": "UIKitCatalog",
        "WIRApplicationBundleIdentifierKey": "com.kazucocoa.apple-samplecode.UICatalog",
        "WIRAutomationAvailabilityKey": "WIRAutomationAvailabilityUnknown"
      }
...
[debug] [RemoteDebugger] Sending '_rpc_forwardGetListing:' message to app 'PID:1215' (id: 2): 'connectToApp'
[debug] [ios-device] Sent message to Web Inspector:
[debug] [ios-device] {
  "__argument": {
    "WIRConnectionIdentifierKey": "ba4b9e99-7e91-4077-9864-a0dcdc187aba",
    "WIRApplicationIdentifierKey": "PID:1215"
  },
  "__selector": "_rpc_forwardGetListing:"
}
[debug] [ios-device] Received message from Web Inspector:
[debug] [ios-device] {
  "__argument": {
    "WIRApplicationIdentifierKey": "PID:1215",
    "WIRListingKey": {
      "1": {
        "WIRTitleKey": "WKWebView",
        "WIRTypeKey": "WIRTypeWebPage",
        "WIRURLKey": "file:///private/var/containers/Bundle/Application/3D4087F5-61AA-48C3-B225-DE28DCE44979/UIKitCatalog.app/Base.lproj/content.html",
        "WIRPageIdentifierKey": 1,
        "WIRHostApplicationIdentifierKey": "PID:1215",
        "WIROverrideNameKey": ""
      }
    }
  },
  "__selector": "_rpc_applicationSentListing:"
}
[debug] [RemoteDebugger] Received response from send (id: 2): '["PID:1215",{"1":{"WIRTitleKey":"WKWebView","WIRTypeKey":"WIRTypeWebPage","WIRURLKey":"file:///private/var/containers/Bundle/Application/3D4087F5-61AA-48C3-B225-DE28DCE44979/UIKitCatalog.app/Base.l...'

So, based on a couple of combinations, I think no much diff between Safari and WebView app in terms of properties like isAutomationEnabled