Remove service-glean's hard-dependency on httpurlconnection #6875

badboy · 2020-05-05T14:06:54Z

Remove service-glean's hard-dependency on httpurlconnection

We still test with it, so we keep it around.

BREAKING CHANGE:

Users will need to supply a configuration with a ping uploader to Glean
now.
A default lib-fetch-httpurlconnection implementation can be used like
this:

import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient;
import mozilla.components.service.glean.config.Configuration;
import mozilla.components.service.glean.net.ConceptFetchHttpUploader;

val config = Configuration(httpClient = ConceptFetchHttpUploader(lazy { HttpURLConnectionClient() }))
Glean.initialize(context, true, config)

For Java this becomes:

import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient;
import mozilla.components.service.glean.config.Configuration;
import mozilla.components.service.glean.net.ConceptFetchHttpUploader;

ConceptFetchHttpUploader httpClient = ConceptFetchHttpUploader.fromClient(new HttpURLConnectionClient());
Configuration config = new Configuration(httpClient);
Glean.INSTANCE.initialize(context, true, config);

Fixes #6660 (at least partly)

I'm not familiar enough with service-experiments, so @travis79 would need to take a look.

cc @pocmo for visibility.

Pull Request checklist

Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
Tests: This PR includes thorough tests or an explanation of why it does not
Changelog: This PR includes a changelog entry or does not need one
Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

After merge

Milestone: Make sure issues closed by this pull request are added to the milestone of the version currently in development.
Breaking Changes: If this is a breaking change, please push a draft PR on Reference Browser to address the breaking issues.

Dexterp37 · 2020-05-05T14:16:20Z

components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt

+        if (httpClient != null) {
+            return GleanCoreConfiguration(serverEndpoint, channel, maxEvents, httpClient)
+        } else {
+            return GleanCoreConfiguration(serverEndpoint, channel, maxEvents)


Is our default behaving the same as lib-fetch-httpurlconnection? Please note that this will have impact on Lockwise and Firefox Reality. I'd rather making this explicit..

Make it explicit how?
We don't want to depend on lib-fetch-httpurlconnection.
We implement a ping uploader here: https://github.com/mozilla/glean/blob/4aab82a58c0e9db1577ebd10019447155bb846e7/glean-core/android/src/main/java/mozilla/telemetry/glean/net/HttpURLConnectionUploader.kt#L20
It's defering upload to java.net.HttpURLConnection.

IMO it makes more sense to not redefine anything like that in a-c.
That only means we would now introduce a second place we need to change if we ever touch the Glean core uploader.

Sorry I wasn't clear :-) I mean let's just drop any default and force users to explicitly state what they want.

If we only drop it here than that configuration API differs between a-c and direct use, which seems ... not good

The API already differs between a-c and direct use: a-c depends on ConceptFetch while direct use doesn't know about it.

If the intent here is to make sure Mozilla users are intentional with the upload mechanism, I'm afraid this is the only option.

That would mean we're also breaking all the current users, as they are now forced to pass this explicitly.
Are we okay with doing that?

Are we okay with doing that?

This is what @pocmo was asking: I'm not a fan of this dance, to be honest, but we're living in A-C and we should respect the A-C's guidelines :-)

but we're living in A-C and we should respect the A-C's guidelines :-)

I'm open to discussing this though. :)

I think it is a fairly cheap breakage: Apps can fix this with one line of code. Fenix shouldn't break since Fenix should never use anything but Gecko for network communication. If it breaks Fenix then this would be good. :)

Lockwise: Yeah, they would probably need to add HttpUrlConnectionClient manually once. I think that is fine.

Firefox Reality: Haven't looked at it yet. But if it breaks then this may actually be good since I assume there is a strong reason to also use Gecko for all network communication in Firefox Reality. And if they have been using HttpUrlConnection instead then this may exactly be one of the cases where the default was not obvious (or having the choice) and where the default is the opposite of what we wanted.

Firefox Reality seems to use the default and I filed an issue for changing that: MozillaReality/FirefoxReality#3339

badboy · 2020-05-06T10:25:47Z

I updated the PR now. I still need to test that it still works in the mentioned apps and probably prepare PRs for them.

components/service/glean/src/main/java/mozilla/components/service/glean/config/Configuration.kt

docs/changelog.md

Dexterp37 · 2020-05-06T11:08:14Z

...service/glean/src/main/java/mozilla/components/service/glean/net/ConceptFetchHttpUploader.kt

+         * This looses the lazyness of creating the `client`.
+         */
+        @JvmStatic
+        fun fromClient(client: Client): ConceptFetchHttpUploader {


Firefox Reality would need to use a different uploader. Do we need to do this for other uploaders as well? @pocmo

I'm not sure I fully understand. The 1:1 migration for Firefox Reality would be to continue using HttpUrlConnectionClient (MozillaReality/FirefoxReality#3339)?

Client is coming from concept-fetch.
So as long as whatever they want to use adheres to that they're fine.

docs/changelog.md

Dexterp37

LGTM. Let's update our Glean docs for A-C consumers. Also cc @mdboom

codecov · 2020-05-06T14:39:04Z

Codecov Report

Merging #6875 into master will increase coverage by 0.17%.
The diff coverage is 66.66%.

@@             Coverage Diff              @@
##             master    #6875      +/-   ##
============================================
+ Coverage     77.07%   77.24%   +0.17%     
+ Complexity     4867     4711     -156     
============================================
  Files           653      641      -12     
  Lines         24011    23290     -721     
  Branches       3519     3409     -110     
============================================
- Hits          18506    17991     -515     
+ Misses         4040     3898     -142     
+ Partials       1465     1401      -64

Impacted Files	Coverage Δ	Complexity Δ
...ain/java/mozilla/components/service/glean/Glean.kt	`62.50% <ø> (-2.21%)`	`4.00 <0.00> (-1.00)`
...a/components/service/glean/config/Configuration.kt	`83.33% <50.00%> (-16.67%)`	`3.00 <0.00> (ø)`
...ents/service/glean/net/ConceptFetchHttpUploader.kt	`100.00% <100.00%> (ø)`	`7.00 <0.00> (ø)`
...r/toolbar/behavior/BrowserToolbarBottomBehavior.kt	`71.05% <0.00%> (-8.95%)`	`13.00% <0.00%> (-11.00%)`
...java/mozilla/components/lib/crash/CrashReporter.kt	`84.70% <0.00%> (-1.01%)`	`30.00% <0.00%> (-2.00%)`
...components/browser/awesomebar/BrowserAwesomeBar.kt	`95.69% <0.00%> (-0.14%)`	`32.00% <0.00%> (ø%)`
...ozilla/components/feature/tabs/ext/BrowserState.kt	`100.00% <0.00%> (ø)`	`0.00% <0.00%> (ø%)`
...lla/components/feature/tabs/ext/TabSessionState.kt	`100.00% <0.00%> (ø)`	`0.00% <0.00%> (ø%)`
...ponents/feature/tabs/tabstray/TabsTrayPresenter.kt	`93.93% <0.00%> (ø)`	`9.00% <0.00%> (ø%)`
...ts/concept/engine/manifest/WebAppManifestParser.kt	`85.34% <0.00%> (ø)`	`6.00% <0.00%> (ø%)`
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c29ab1d...5bb9171. Read the comment docs.

...service/glean/src/main/java/mozilla/components/service/glean/net/ConceptFetchHttpUploader.kt

We still test with it, so we keep it around. ⚠️ **BREAKING CHANGE** ⚠️ Users will need to supply a configuration with a ping uploader to Glean now. A default lib-fetch-httpurlconnection implementation can be used like this: ```kotlin import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient; import mozilla.components.service.glean.config.Configuration; import mozilla.components.service.glean.net.ConceptFetchHttpUploader; val config = Configuration(httpClient = ConceptFetchHttpUploader(lazy { HttpURLConnectionClient() })) Glean.initialize(context, true, config) ``` For Java this becomes: ```java import mozilla.components.lib.fetch.httpurlconnection.HttpURLConnectionClient; import mozilla.components.service.glean.config.Configuration; import mozilla.components.service.glean.net.ConceptFetchHttpUploader; ConceptFetchHttpUploader httpClient = ConceptFetchHttpUploader.fromClient(new HttpURLConnectionClient()); Configuration config = new Configuration(httpClient); Glean.INSTANCE.initialize(context, true, config); ``` Co-authored-by: Alessio Placitelli <[email protected]>

Dexterp37 · 2020-05-13T15:02:42Z

Please go ahead and merge this ;)

badboy · 2020-05-13T15:02:49Z

bors r=Dexterp37

pocmo

👍

bors · 2020-05-13T16:47:09Z

Build succeeded:

complete-push

badboy requested a review from Dexterp37 May 5, 2020 14:06

Dexterp37 reviewed May 5, 2020

View reviewed changes

badboy force-pushed the glean-remove-hard-dependency-on-httpurl branch from 202d52d to 7f05b79 Compare May 6, 2020 10:24

badboy requested review from pocmo and Dexterp37 May 6, 2020 10:28

Dexterp37 suggested changes May 6, 2020

View reviewed changes

Dexterp37 approved these changes May 6, 2020

View reviewed changes

badboy force-pushed the glean-remove-hard-dependency-on-httpurl branch 3 times, most recently from 148be00 to 510fad9 Compare May 6, 2020 14:10

travis79 reviewed May 7, 2020

View reviewed changes

...service/glean/src/main/java/mozilla/components/service/glean/net/ConceptFetchHttpUploader.kt Show resolved Hide resolved

badboy force-pushed the glean-remove-hard-dependency-on-httpurl branch 2 times, most recently from f79abaf to 51219e9 Compare May 11, 2020 14:48

psymoon assigned pocmo May 11, 2020

badboy and others added 2 commits May 13, 2020 16:50

Update all sample applications to define an http client

5bb9171

badboy force-pushed the glean-remove-hard-dependency-on-httpurl branch from 51219e9 to 5bb9171 Compare May 13, 2020 14:53

pocmo approved these changes May 13, 2020

View reviewed changes

bors bot merged commit 6719e01 into mozilla-mobile:master May 13, 2020

badboy deleted the glean-remove-hard-dependency-on-httpurl branch May 19, 2020 08:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove service-glean's hard-dependency on httpurlconnection #6875

Remove service-glean's hard-dependency on httpurlconnection #6875

badboy commented May 5, 2020 •

edited

Loading

Dexterp37 May 5, 2020

badboy May 5, 2020

Dexterp37 May 5, 2020

badboy May 5, 2020

Dexterp37 May 5, 2020

badboy May 6, 2020

Dexterp37 May 6, 2020

pocmo May 6, 2020

pocmo May 6, 2020

badboy commented May 6, 2020

Dexterp37 May 6, 2020

pocmo May 6, 2020

badboy May 6, 2020

Dexterp37 left a comment

codecov bot commented May 6, 2020 •

edited

Loading

Dexterp37 commented May 13, 2020

badboy commented May 13, 2020

pocmo left a comment

bors bot commented May 13, 2020

Remove service-glean's hard-dependency on httpurlconnection #6875

Remove service-glean's hard-dependency on httpurlconnection #6875

Conversation

badboy commented May 5, 2020 • edited Loading

Pull Request checklist

After merge

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

badboy commented May 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Dexterp37 left a comment

Choose a reason for hiding this comment

codecov bot commented May 6, 2020 • edited Loading

Codecov Report

Dexterp37 commented May 13, 2020

badboy commented May 13, 2020

pocmo left a comment

Choose a reason for hiding this comment

bors bot commented May 13, 2020

badboy commented May 5, 2020 •

edited

Loading

codecov bot commented May 6, 2020 •

edited

Loading