1180996 - Initial support for WiFi Debugging for Fennec

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: General, defect)

Description

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Initial support for Fennec WiFi debugging, to be refined as needed in follow ups.

Comment 1

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Try: https://treeherder.mozilla.org/#/jobs?repo=try&revision=122a71e18a31

Comment 2

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Attachment: MozReview Request: Bug 1180996 - Enable DevTools security on Android. r=margaret

Bug 1180996 - Enable DevTools security on Android. r=margaret

Comment 3

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Attachment: MozReview Request: Bug 1180996 - Extract remote debugger to separate file. r=margaret

Bug 1180996 - Extract remote debugger to separate file. r=margaret

Comment 4

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Attachment: MozReview Request: Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

Comment 5

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Attachment: MozReview Request: Bug 1180996 - Basic device name on Android. r=margaret

Bug 1180996 - Basic device name on Android. r=margaret

Comment 6

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Margaret, please redirect if there's a better person to review!  I wasn't sure.

With the patch set applied, you can try WiFi debugging with the following steps:

1. Fennec -> Settings -> Developer Tools -> Enable "Remote debugging via Wi-Fi"
2. Open WebIDE in desktop Firefox
3. Open the Runtime menu in WebIDE
4. Select your Android device, which should appear under Wi-Fi devices
5. On the device, choose "Scan" or "Scan and Remember" at the incoming connection prompt
6. Scan the QR code

From here, you can choose a debug target by accessing a tab or the main process from WebIDE's project list.

Comment 7

[:Margaret Leibovic]

Comment on attachment 8630292 [details]
MozReview Request: Bug 1180996 - Enable DevTools security on Android. r=margaret

https://reviewboard.mozilla.org/r/12697/#review11317

::: mobile/android/installer/package-manifest.in:134
(Diff revision 1)
> +@BINPATH@/components/devtools_security.xpt

I'm a bit concerned about this increasing our APK size for all users, when only some will use it. However, I looked at your try run, and it looks like the APK11+ build there is only about 2kb bigger than the current fx-team builds, so that's not really a big deal.

Comment 8

[:Margaret Leibovic]

Comment on attachment 8630293 [details]
MozReview Request: Bug 1180996 - Extract remote debugger to separate file. r=margaret

https://reviewboard.mozilla.org/r/12699/#review11319

::: mobile/android/chrome/content/browser.js:130
(Diff revision 1)
> +  ["RemoteDebugger", "chrome://browser/content/RemoteDebugger.js"],

Yay lazy-loading! And yay for removing stuff from browser.js!

::: mobile/android/chrome/content/RemoteDebugger.js:11
(Diff revision 1)
> +  init() {

Huh, I didn't know about this syntax (as opposed to `propertyName: function()`). Is this new?

Comment 9

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

(In reply to :Margaret Leibovic from comment #8)
> ::: mobile/android/chrome/content/RemoteDebugger.js:11
> (Diff revision 1)
> > +  init() {
> 
> Huh, I didn't know about this syntax (as opposed to `propertyName:
> function()`). Is this new?

New-ish, I guess.  Added in Firefox 34 it appears[1].

[1]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/New_in_JavaScript/ECMAScript_6_support_in_Mozilla#Other_features

Comment 10

[:Margaret Leibovic]

Comment on attachment 8630294 [details]
MozReview Request: Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

https://reviewboard.mozilla.org/r/12701/#review11321

I don't feel confident reviewing the debugger server parts of this, so you should probably have a devtools person give this a once-over as well. But I did test this out locally and it worked!

::: mobile/android/base/DevToolsAuthHelper.java:21
(Diff revision 1)
> +        final Intent intent = InputOptionsUtils.createQRCodeReaderIntent();

Sweet, this is some new code that you're using :)

::: mobile/android/base/locales/en-US/android_strings.dtd:159
(Diff revision 1)
> +<!ENTITY pref_developer_remotedebugging_wifi "Remote debugging via Wi-Fi">

In testing this, and in talking to Karim, I realized that this only works if you have a specific QR code reader app installed [1]. You may want to mention that here, or link to this in the MDN docs.

[1] https://play.google.com/store/apps/details?id=com.google.zxing.client.android

Comment 11

[:Margaret Leibovic]

Comment on attachment 8630295 [details]
MozReview Request: Bug 1180996 - Basic device name on Android. r=margaret

https://reviewboard.mozilla.org/r/12703/#review11325

Ship It!

Comment 12

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

https://reviewboard.mozilla.org/r/12701/#review11345

Panos, could you review the RemoteDebugger.js file here?  It's similar to the FxOS changes made for WiFi debugging.

Comment 13

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8630294 [details]
MozReview Request: Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

Comment 14

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8630294 [details]
MozReview Request: Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

Keeping Margaret's r+.

Comment 15

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

https://reviewboard.mozilla.org/r/12701/#review11321

> In testing this, and in talking to Karim, I realized that this only works if you have a specific QR code reader app installed [1]. You may want to mention that here, or link to this in the MDN docs.
> 
> [1] https://play.google.com/store/apps/details?id=com.google.zxing.client.android

Right, good point!  I think MDN docs might be right place for this at the moment.

Comment 16

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Talos / Autophone Try:

https://treeherder.mozilla.org/#/jobs?repo=try&revision=a6266b7786af

Comment 17

[Panos Astithas (he/him) [:past] (please ni?)]

Comment on attachment 8630294 [details]
MozReview Request: Bug 1180996 - Remote debugging via WiFi for Android. r=margaret

https://reviewboard.mozilla.org/r/12701/#review11489

Ship It!

Comment 18

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

(In reply to J. Ryan Stinnett [:jryans] (use ni?) from comment #16)
> Talos / Autophone Try:
> 
> https://treeherder.mozilla.org/#/jobs?repo=try&revision=a6266b7786af

My first time looking at Autophone, but from what I can tell these patches have not altered Talos or Autophone results.  Seems safe to land.

Comment 19

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/548ea0123943
https://hg.mozilla.org/integration/fx-team/rev/1e83acbe8946
https://hg.mozilla.org/integration/fx-team/rev/57300bbb8aa8
https://hg.mozilla.org/integration/fx-team/rev/3ed620385cca

Comment 20

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/548ea0123943
https://hg.mozilla.org/mozilla-central/rev/1e83acbe8946
https://hg.mozilla.org/mozilla-central/rev/57300bbb8aa8
https://hg.mozilla.org/mozilla-central/rev/3ed620385cca

Comment 21

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Release Note Request (optional, but appreciated)
[Why is this notable]: Important feature for developer usability
[Suggested wording]: Debug websites over WiFi (no USB cable or ADB needed)
[Links (documentation, blog post, etc)]: https://convolv.es/blog/2015/08/05/wifi-debug-fennec/

Comment 22

[Sylvestre Ledru [:Sylvestre]]

Added to the release notes with "Remote website debugging over WiFi (no USB cable or ADB needed)" as wording.
Using your blog post for now but having non-personnal blog post would be appreciated

Comment 23

[Will Bamberg [:wbamberg]]

Docs page, shamelessly stolen from your blog: https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_over_Wifi.

Let me know if this is OK.

Note that I've also relocated the stuff on connecting to Firefox OS into separate pages:
https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_OS_over_USB
https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_OS_over_Wifi

...to make things more consistent. All these pages are listed under https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging.

Comment 24

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

(In reply to Will Bamberg [:wbamberg] from comment #23)
> Docs page, shamelessly stolen from your blog:
> https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/
> Debugging_Firefox_for_Android_over_Wifi.
> 
> Let me know if this is OK.

Yes, fine with me!

> Note that I've also relocated the stuff on connecting to Firefox OS into
> separate pages:
> https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/
> Debugging_Firefox_OS_over_USB
> https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/
> Debugging_Firefox_OS_over_Wifi
> 
> ...to make things more consistent. All these pages are listed under
> https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging.

Great, this looks good to me!

Also, it seems fine to remove the pre-36 Android instructions.

Comment 25

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Sylvestre, you can update the relnote with the new MDN link:

https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_over_Wifi

Comment 26

[Sylvestre Ledru [:Sylvestre]]

Thanks, updated!