1591677 - TEST-UNEXPECTED-FAIL | toolkit/components/telemetry/tests/unit/test_TelemetryEnvironment.js when run in the Thunderbird environment

Status: RESOLVED FIXED

(Firefox :: Sync, defect)

Description

[Jorg K (CEST = GMT+2)]

That's the X4 failure that showed up on today's Daily run:
https://treeherder.mozilla.org/#/jobs?repo=comm-central&revision=b2b10252b7913be853ffceb5a37e4a26e3c431f4

https://hg.mozilla.org/mozilla-central/pushloghtml?fromchange=f915da42169e70bdd6711457966620e80f&tochange=0b9d0a86ebfd89cfb89b8044a72e89ce74

Looks like
bc70189de0004f410b6e5d8bf287a7eb5500c087 Thom Chiovoloni — Bug 1238810 - Replace {FXA,WEAVE}_CONFIGURED with entries in the telemetry environment. r=chutten,markh,loines
https://hg.mozilla.org/mozilla-central/rev/bc70189de0004f410b6e5d8bf287a7eb5500c087

Comment 1

[Intermittent Failures Robot]

8 failures in 4182 pushes (0.002 failures/push) were associated with this bug in the last 7 days.

Repository breakdown:

• comm-central: 8

Platform breakdown:

• macosx1014-64-shippable: 2
• linux64-shippable: 2
• linux32-shippable: 2
• windows7-32-shippable: 1
• windows10-64-shippable: 1

For more details, see:
https://treeherder.mozilla.org/intermittent-failures.html#/bugdetails?bug=1591677&startday=2019-10-21&endday=2019-10-27&tree=all

Comment 2

[Ben Campbell]

The test fails for me like this:

ERROR Unexpected exception TypeError: Cc['@mozilla.org/weave/service;1'] is undefined at resource://gre/modules/TelemetryEnvironment.jsm:1792

Inside the _updateServicesInfo() function.

That line was added by the changeset you pointed at.
So it looks to me like the "weave" service (the historical name for Sync's XPCOM service) wasn't being registered under Thunderbird, but it wasn't a problem because it wasn't being used... but now it is?

I think there are two possibilities:

1. the "Weave" service isn't available in Thunderbird, but should be.
2. "Weave" isn't relevant to Thunderbird, so _updateServicesInfo() should be modified to deal with it not being there.

I don't know if TB uses Sync services in any way shape or form, so I really don't know what the correct solution is.

Some further notes:

_updateServicesInfo() is called from two places:

1. the failing test, test_environmentServicesInfo().
2. by TelemetryEnvironment, in response to an observer callback.

So we could easily decide the test wasn't relevant to TB and disable it, but that still leaves the observer use, which could potentially bite elsewhere.

Comment 3

[Jorg K (CEST = GMT+2)]

If I'm not mistaken, the "weave" service comes from Weave.jsm:
https://searchfox.org/mozilla-central/rev/11d9c7b7fa82fdfb8ac2a8f0864e9d8d5fe2b926/services/sync/components.conf#10

I can't see right now how that service is included/packaged(?) into FF:
https://searchfox.org/mozilla-central/search?q=Weave.jsm&case=false&regexp=false&path=

So what is "Sync" in general? The Firefox account sync service for bookmarks, history, etc.?

Ben, can we whip up something quickly since the constant test failures aren't much fun.

I'm also adding Chris since he seems to be involved with Telemetry.

Comment 4

[Chris H-C :chutten]

The observer notification comes from the service itself, if I'm not mistaken, so I'm not as worried about being bitten elsewhere. The test appears to be specifically testing sync and FxA which we can probably "just" skip if TB.

Comment 5

[Jorg K (CEST = GMT+2)]

Attachment: Bug 1591677 - Disable test_TelemetryEnvironment.js::test_environmentServicesInfo for Thunderbird. r=chutten

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/83c6ab83905c
Disable test_TelemetryEnvironment.js::test_environmentServicesInfo for Thunderbird. r=chutten

Comment 7

[Ben Campbell]

(In reply to Jorg K (GMT+2) from comment #3)

So what is "Sync" in general? The Firefox account sync service for bookmarks, history, etc.?

That was my assumption (backed up by nothing but guesswork :-)
I didn't think TB used it, but I figured if I was wrong it'd ring some bells with you.
Your patch looks good to me.

(In reply to Chris H-C :chutten from comment #4)

The observer notification comes from the service itself, if I'm not mistaken, so I'm not as worried about being bitten elsewhere. The test appears to be specifically testing sync and FxA which we can probably "just" skip if TB.

Thanks Chris, that clarifies things nicely!

Comment 8

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/83c6ab83905c

Comment 9

[Jorg K (CEST = GMT+2)]

Comment on attachment 9104942 [details]
Bug 1591677 - Disable test_TelemetryEnvironment.js::test_environmentServicesInfo for Thunderbird. r=chutten

Beta/Release Uplift Approval Request

• User impact if declined: This is a test-only for Thunderbird.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Zero, just disables a test for TB.
• String changes made/needed:

Comment 10

[Jorg K (CEST = GMT+2)]

Sorry, I can never remember. "Test only" doesn't need approval, just set "checkin needed beta" on the whiteboard.

This needs uplift since bug 1238810 was also uplifted to FF 71 beta 6.

Comment 11

[Daniel Varga [:dvarga]]

https://hg.mozilla.org/releases/mozilla-beta/rev/effeb2aa5795