bug 1567320: add support for funnel_experiment and funnel_variation a… #95

oremj · 2019-07-19T16:53:13Z

…ttribution keys

hoosteeno

r+wc

hoosteeno · 2019-12-17T15:56:30Z

attributioncode/validator.go

-	if len(unEscapedCode) > 200 {
-		logEntry.WithField("code_len", len(code)).Error("code longer than 200 characters")
-		return "", errors.New("code longer than 200 characters")
+	if len(unEscapedCode) > 400 {


We've talked about increasing this to e.g. 600 or 800 to make sure we can accommodate a long UA string if needed.

Making a length increase should be fine long term as long as we keep in mind there are existing Firefox releases that reject attribution over 200 characters: https://hg.mozilla.org/releases/mozilla-release/file/2c8be14a89c92e56dbfc10ad32284e628a517a93/browser/components/attribution/AttributionCode.jsm#l24

I thought the size limitation had something to do with the stub installer.

I have a patch that increases the length firefox accepts: https://phabricator.services.mozilla.com/D57906

Mardak · 2019-12-17T19:38:17Z

attributioncode/validator.go

+	"funnel_experiment": true,
+	"funnel_variation":  true,


@mixedpuppy just making sure, on windows, the expected keys have no funnel_? https://hg.mozilla.org/releases/mozilla-release/file/2c8be14a89c92e56dbfc10ad32284e628a517a93/browser/components/attribution/AttributionCode.jsm#l66

We should aim for consistency here. funnel_ is not adding anything to these parameters. If Firefox expects experiment and variation, then we should plan on those being sent all the way from the start. Bedrock work hasn't begun, so we can get this in.

IIRC funnel_ was requested. On windows portions are stripped somewhere along the way to reduce data size I think, but they are not for osx (which doesn't work anyway, I noticed Mardak comment on some bug about using the quarantine data, that's what we tried).

Looks like this was the last comment in the firefox bug re: prefix or not:
https://bugzilla.mozilla.org/show_bug.cgi?id=1515172#c37

This seems to say the url may contain "utm_" and "funnel_" that then end up getting stripped before stored as attribution.

Looking at the AttributionCode.jsm logic, it does seem to support "utm_" and "funnel_" and no-prefix for url-based attribution for mac while on windows, it only wants the stripped versions, e.g., "source" "medium" as before and the new "experiment"

prefixed is supported of osx. non-prefixed is for windows. The stub installer is limited to 200 characters.

mozilla/bedrock#7474 (comment)

prefixed is supported of osx. non-prefixed is for windows. The stub installer is limited to 200 characters.

Let's walk backwards:

does telemetry require any particular param format?

does the stub binary require any particular param format?

can we simplify to avoid different behavior per platform?

Since we're working on the stubattribution service here, presumably we can plan to support those requirements.

And since we're working on Bedrock in mozilla/bedrock#7474, we can plan to support them there, too.

mozilla/bedrock#7474 (comment)

Where, specifically, is the constraint? In https://bugzilla.mozilla.org/show_bug.cgi?id=1406005#c49, mhowell says the stub binary is limited to 1010. In this PR, we can see that it was limited to 200, and is now set to 400, and I'm requesting 600-800. Are there any other hard constraints to be aware of?

I've no opinions here, just attempting to relay what I can remember (hopefully relatively accurate) from when I looked at this last...

I didn't run into anything with specific limits/formats in the telemetry data.

To my knowledge the windows stub binary wouldn't require any specific format. The download service that builds the stub might, and IIRC that is a) where the prefix is stripped, b) has a hard coded list of what keys are allowed into the stub.

I'd verify in current code what the current limit is. Seems like 1000 as mentioned should be enough.

osx attributions (if a workaround is ever figured out) happen via the quarantine database, so the param keys are unchanged from whatever the referrer url was. That is why the service tries to support both with/without prefix.

It looks like the time this logic here (stubattribution validator.go) is used, there's a combined attribution_code that is parsed and handles keys like "source" and pretty sure there's no knowledge of "utm" anywhere in this repository.

From my searching around, stripping of "utm_" happens on bedrock backend as part of the hmac signature generation process which currently accepts {utm_source, utm_medium, …} json and returns {attribution_code, attribution_sig} json where the "attribution_code" has the concatenated prefix-stripped keys.

https://github.com/mozilla/bedrock/blob/67a2debdfcbd4a72cc3b5b0998a136aea7964704/bedrock/firefox/views.py#L95-L96

So yes it looks like validator.go should use "experiment" and "variation" without "funnel_" just like it doesn't currently expect "utm_*". And these prefix-less attribution will work with existing windows firefox 71.

(And attribution doesn't work quite right on osx anyway, and doesn't get called from bedrock anyway, so we don't really need to worry about compatibility yet. https://bugzilla.mozilla.org/show_bug.cgi?id=1525076 )

hoosteeno

I can't review for code quality but the implementation changes in the most recent 2 commits look good to me. r+

Mardak · 2020-01-06T21:58:58Z

stubservice/main.go

@@ -148,6 +148,8 @@ func pingdomHandler(w http.ResponseWriter, req *http.Request) {
 	attrQuery.Set("medium", "pingdom")
 	attrQuery.Set("campaign", "pingdom")
 	attrQuery.Set("content", "pingdom")
+	attrQuery.Set("funnel_experiment", "pingdom")
+	attrQuery.Set("funnel_variation", "pingdom")


I'm not sure how this pingdom stuff works (or if it's used?), but I would guess the query params should be the funnel_-less versions.

Mardak · 2020-01-06T21:59:02Z

attributioncode/validator.go

+	"campaign":   true,
+	"content":    true,
+	"experiment": true,
+	"variation":  true,


Just noting, and we probably don't need to change anything here -- this allows experiment or variation to be set without the other, which could totally be valid, e.g., some experiment with no variation compared against a baseline no-experiment.

Oh, does this need "ua"? https://searchfox.org/mozilla-central/rev/a92ed79b0bc746159fc31af1586adbfa9e45e264/browser/components/attribution/AttributionCode.jsm#35

Probably could use a comment in the code for validAttributionKeys that it should match what is in firefox also.

Mardak · 2020-01-06T22:02:44Z

attributioncode/validator.go

 	"net/url"
 	"time"

 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )

+const maxUnescapedCodeLen = 600


Also just noting and probably don't need to change anything here either -- Firefox does a length check against the escaped code length while the check here is against the unescaped length.

At least, I think it should match what fx has, with a comment pointing to it.

https://searchfox.org/mozilla-central/rev/a92ed79b0bc746159fc31af1586adbfa9e45e264/browser/components/attribution/AttributionCode.jsm#24

Mardak

Main potential concern is the pingdom using funnel_ prefix and rest should be fine.

mixedpuppy

This all looks ok functionally, just my question about the set of required attributes should be answered prior to landing.

mixedpuppy · 2020-01-07T19:27:14Z

attributioncode/validator.go

 	"net/url"
 	"time"

 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )

+const maxUnescapedCodeLen = 600


At least, I think it should match what fx has, with a comment pointing to it.

https://searchfox.org/mozilla-central/rev/a92ed79b0bc746159fc31af1586adbfa9e45e264/browser/components/attribution/AttributionCode.jsm#24

mixedpuppy · 2020-01-07T19:29:06Z

attributioncode/validator.go

+	"variation":  true,
+}
+
+var requiredAttributionKeys = []string{


I'm not familiar with the code here, so just going on what I see here, name indicates to me that all these must be present.

Do we really require all these to be present? At this point I don't remember what AMO passes in (or if that functionality still exists on AMO, or if this change would affect that). Perhaps @jvillalobos can answer the AMO part.

For links going to AMO we require source and medium and, depending on the case, campaign or content.

Ok, if we do not always include campaign or content, then we probably shouldn't have a set of required attributes here.

I don't have all the details about the decision to make attributes required, but I do suspect it relates in part to concerns about passing web history into client telemetry (which is a data classification concern). That is primarily an issue with the "source" param, hinted at in an origin bug for this feature. Since we only allow attribution for a subset of possible sources, we have to require source.

It's also true that without a source and some other value, attribution isn't particularly useful. Source is required; medium and campaign are very valuable; content is not always helpful, and often omitted.

On www, we fill up some empty params with default values to ensure they can pass this validation, which does not provide any information value over simply making them optional.

On www, we fill up some empty params with default values to ensure they can pass this validation, which does not provide any information value over simply making them optional.

Ahh, that might be reasonable then, but a code comment here explaining that would be helpful.

Mardak

Sorry for the late change, with Firefox 73 supporting ua going to release in about a month, we would like to get that change in to stubattribution sooner than later. https://hg.mozilla.org/mozilla-central/rev/325f8606c0c1

Hopefully this should be relatively straightforward with the existing refactoring done in this PR.

oremj · 2020-01-09T18:27:30Z

@Mardak I think I've addressed all your concerts, will you please you re-review?

Mardak · 2020-01-09T18:38:56Z

attributioncode/validator.go

+
+	if code == "" {
+		logEntry.Error("code is empty")
+		return "", errors.New("code is empty")


When does this trigger? Or is the validCodes test with "" wrong? Should empty code result in the 3 "not set" and "other" source?

Oh I see fixed in 5cfc62f

This only triggers if attributioncode="" or no attribution code parameter is in the query string. In that case, it just redirects to a standard non-attributed installer.

I've also updated the tests.

oremj added 3 commits July 19, 2019 09:52

bug 1567320: add support for funnel_experiment and funnel_variation a…

1ced173

…ttribution keys

add funnel params to test and fix length test

494a9d1

add original test back

d1d236f

hoosteeno suggested changes Dec 17, 2019

View reviewed changes

Mardak reviewed Dec 17, 2019

View reviewed changes

oremj added 2 commits December 20, 2019 10:31

validator: increase accepted code length to 600

f19edac

s/funnel_//

78f9e23

hoosteeno mentioned this pull request Jan 6, 2020

Experiment: Design experiment for Mac vs. Windows install rates mozilla/bedrock#8389

Closed

2 tasks

hoosteeno approved these changes Jan 6, 2020

View reviewed changes

Mardak reviewed Jan 6, 2020

View reviewed changes

Mardak approved these changes Jan 6, 2020

View reviewed changes

This was referenced Jan 7, 2020

Handle additional parameters for stub attribution (Fixes #7474) mozilla/bedrock#8363

Merged

Increase max length for stub attribution string mozilla/bedrock#8399

Closed

mixedpuppy approved these changes Jan 7, 2020

View reviewed changes

Mardak suggested changes Jan 8, 2020

View reviewed changes

oremj added 5 commits January 9, 2020 10:04

set maxUnescapedCodeLen to match AttributionCode.jsm

6b21306

fix pingdom test

0c93aad

fix tests and allow blank inputs

c5dd20e

add ua attribution key

0e4f2e5

return error if code is empty

92dc49f

tests to account for code is empty

5cfc62f

Mardak reviewed Jan 9, 2020

View reviewed changes

Mardak approved these changes Jan 9, 2020

View reviewed changes

Mardak mentioned this pull request Jan 10, 2020

Set up an experiment for UA attribution with coarse user agent detection mozilla/bedrock#8405

Closed

oremj merged commit 2c30f89 into master Jan 10, 2020

oremj deleted the bug-1567320-additional-parameters branch January 10, 2020 23:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bug 1567320: add support for funnel_experiment and funnel_variation a… #95

bug 1567320: add support for funnel_experiment and funnel_variation a… #95

oremj commented Jul 19, 2019

hoosteeno left a comment

hoosteeno Dec 17, 2019

Mardak Dec 17, 2019

mixedpuppy Dec 17, 2019

Mardak Dec 19, 2019

Mardak Dec 17, 2019

hoosteeno Dec 17, 2019

mixedpuppy Dec 17, 2019

Mardak Dec 17, 2019 •

edited

mixedpuppy Dec 17, 2019

hoosteeno Dec 17, 2019

mixedpuppy Dec 17, 2019

Mardak Dec 17, 2019

hoosteeno left a comment

Mardak Jan 6, 2020

Mardak Jan 6, 2020

mixedpuppy Jan 7, 2020

Mardak Jan 6, 2020

mixedpuppy Jan 7, 2020

Mardak left a comment

mixedpuppy left a comment

mixedpuppy Jan 7, 2020

mixedpuppy Jan 7, 2020

jvillalobos Jan 7, 2020 •

edited

mixedpuppy Jan 7, 2020

hoosteeno Jan 7, 2020 •

edited

mixedpuppy Jan 7, 2020

Mardak left a comment

oremj commented Jan 9, 2020

Mardak Jan 9, 2020

Mardak Jan 9, 2020

oremj Jan 9, 2020

oremj Jan 9, 2020

bug 1567320: add support for funnel_experiment and funnel_variation a… #95

bug 1567320: add support for funnel_experiment and funnel_variation a… #95

Conversation

oremj commented Jul 19, 2019

hoosteeno left a 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

Mardak Dec 17, 2019 • edited

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

hoosteeno left a 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

Mardak left a comment

Choose a reason for hiding this comment

mixedpuppy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvillalobos Jan 7, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoosteeno Jan 7, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mardak left a comment

Choose a reason for hiding this comment

oremj commented Jan 9, 2020

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

Mardak Dec 17, 2019 •

edited

jvillalobos Jan 7, 2020 •

edited

hoosteeno Jan 7, 2020 •

edited