1066506 - Allow easy debugging of websockets and sdk

Status: RESOLVED FIXED

(Hello (Loop) :: Client, defect)

Description

[Mark Banner (:standard8)]

Currently, there is no way that the standalone client can easily have debugging for websockets and/or the sdk turned on - the only way is to alter the code itself.

Additionally, the desktop has no way for debugging the sdk easily since bug 1066219 landed which turned off debugging.

I think the best way to do this is to either get the preference value from mozLoop, or fallback to using localStorage.

That way, developers can either set a preference in Firefox (for the built-in components), or adjust localStorage via the console.

Comment 1

[Mark Banner (:standard8)]

Attachment: Allow easy debugging of websockets and sdk for Loop.

This makes it so that either devs can set a pref for built-in components, or tweak via localStorage if in the standalone UI.

Comment 2

[Mark Banner (:standard8)]

Attachment: Allow easy debugging of websockets and sdk for Loop.

Now with the missing test file.

Comment 3

[Nicolas Perriault (:NiKo`) — needinfo me if you need my attention]

Comment on attachment 8488620 [details] [diff] [review]
Allow easy debugging of websockets and sdk for Loop.

Review of attachment 8488620 [details] [diff] [review]:
-----------------------------------------------------------------

LGTM with minor comments for tests to be addressed before landing.

::: browser/components/loop/test/shared/utils_test.js
@@ +24,5 @@
> +  describe("#getBoolPreference", function() {
> +    var savedMozLoop = navigator.mozLoop;
> +
> +    beforeEach(function() {
> +      savedMozLoop = navigator.mozLoop;

I don't see the point of storing and reverting this; in a test page, mozLoop is most likely to be undefined…

@@ +28,5 @@
> +      savedMozLoop = navigator.mozLoop;
> +    });
> +
> +    afterEach(function() {
> +      navigator.mozLoop = savedMozLoop;

So this is undeeded.

@@ +39,5 @@
> +          getLoopBoolPref: function(prefName) {
> +            return prefName === "test.true";
> +          }
> +        };
> +      });

Here you'll want an afterEach() resetting navigator.mozLoop to undefined.

@@ +42,5 @@
> +        };
> +      });
> +
> +      it("should return the mozLoop preference", function() {
> +        expect(sharedUtils.getBoolPreference("test.true")).to.be.true;

Nit: .eql(true)

@@ +48,5 @@
> +
> +      it("should not use the localStorage value", function() {
> +        localStorage.setItem("test.false", true);
> +
> +        expect(sharedUtils.getBoolPreference("test.false")).to.be.false;

Nit: eql(false)

@@ +54,5 @@
> +    });
> +
> +    describe("mozLoop not set", function() {
> +      beforeEach(function() {
> +        navigator.mozLoop = undefined;

Unneeded.

@@ +60,5 @@
> +
> +      it("should return the localStorage value", function() {
> +        localStorage.setItem("test.true", true);
> +
> +        expect(sharedUtils.getBoolPreference("test.true")).to.be.true;

Nit: eql(true)

Comment 4

[Mark Banner (:standard8)]

https://hg.mozilla.org/integration/fx-team/rev/e0bfb21715fe

Comment 5

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/e0bfb21715fe

Comment 6

[u279076]

Untracking for QE verification. Please needinfo me to request testing.

Comment 7

[Mark Banner (:standard8)]

Pushed a bugfix for the ui-showcase with rs=dmose over irc:

https://hg.mozilla.org/integration/fx-team/rev/3be4f9ecef3c

Comment 8

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

https://hg.mozilla.org/mozilla-central/rev/3be4f9ecef3c

Comment 9

[Maire Reavy [:mreavy]]

We want this for easier SDK debugging in Fx34.

Comment 10

[Randell Jesup [:jesup] (needinfo me)]

Comment on attachment 8488620 [details] [diff] [review]
Allow easy debugging of websockets and sdk for Loop.

Approval Request Comment
Uplift request for patches staged and tested on Fig

Comment 11

[Randell Jesup [:jesup] (needinfo me)]

https://hg.mozilla.org/releases/mozilla-aurora/rev/d4797a01c3a8
https://hg.mozilla.org/releases/mozilla-aurora/rev/98b285915390

Comment 12

[Lawrence Mandel [:lmandel] (use needinfo)]

Comment on attachment 8488620 [details] [diff] [review]
Allow easy debugging of websockets and sdk for Loop.

I worked with Randell and Maire on uplifting a large number of Loop bugs at once. All of the bugs have been staged on Fig and tested by QE before uplift to Aurora. As well, all of the bugs are isolated to the Loop client. Randell handled the uplift with my approval. I am adding approval to the bug after the fact for bookkeeping.