1233298 - Telemetry for FxAccountsClient includes query params in the key.

Status: RESOLVED FIXED

Description

[Mark Hammond [:markh]]

If you look at telemetry dashboards for FXA_SERVER_ERROR, at least one "path" is reported as /account/status?uid=..., which implies all telemetry reported by this module will include query params in the "key", making some analysis somewhere between difficult and impossible :) Fortunately this seems rare, and it may be we remove other otherwise tweak these probes, but it's worth having this in a bug.

Comment 1

[Lina Cambridge (she/her) [:lina]]

This probe was removed in bug 1236383.

Comment 2

[Lina Cambridge (she/her) [:lina]]

We should make sure other paths omit the query params, though.

Comment 3

[Mark Hammond [:markh]]

(In reply to Kit Cambridge [:kitcambridge] from comment #1)
> This probe was removed in bug 1236383.
> We should make sure other paths omit the query params, though.

Yeah - that bug is leaving one probe using the path as a key - it probably never has query params today but they could slip in tomorrow, so I think we should still sanitize it.

Comment 4

[Lina Cambridge (she/her) [:lina]]

Created attachment 8708075 [details]
MozReview Request: Bug 1233298 - Remove query params from the `FXA_HAWK_ERRORS` probe. r?markh

Review commit: https://reviewboard.mozilla.org/r/30961/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/30961/

Comment 5

[Mark Hammond [:markh]]

Comment on attachment 8708075 [details]
MozReview Request: Bug 1233298 - Remove query params from the `FXA_HAWK_ERRORS` probe. r?markh

https://reviewboard.mozilla.org/r/30961/#review28589

::: services/fxaccounts/FxAccountsClient.jsm:417
(Diff revision 1)
> -            "FXA_HAWK_ERRORS").add(path);
> +            "FXA_HAWK_ERRORS").add(uri.filePath);

I don't really see the value in a new public method on hawk just for this one probe. We know |path| must be a string here, so can we consider (say) a regex that strips anything past a '?' or '#'? It looks like it would then be a 1 line change.

::: services/fxaccounts/tests/xpcshell/test_client.js:655
(Diff revision 1)
> +    service: "sync",

why is this change necessary as part of this patch?

Comment 6

[Lina Cambridge (she/her) [:lina]]

https://reviewboard.mozilla.org/r/30961/#review28591

::: services/fxaccounts/FxAccountsClient.jsm:417
(Diff revision 1)
> -            "FXA_HAWK_ERRORS").add(path);
> +            "FXA_HAWK_ERRORS").add(uri.filePath);

Works for me. I considered using a regex, but `RESTRequest` parses the string into an `nsIURI`, so I thought we might as well convert early.

::: services/fxaccounts/tests/xpcshell/test_client.js:655
(Diff revision 1)
> +    service: "sync",

This adds a `service` query param to the path.

Comment 7

[Lina Cambridge (she/her) [:lina]]

Comment on attachment 8708075 [details]
MozReview Request: Bug 1233298 - Remove query params from the `FXA_HAWK_ERRORS` probe. r?markh

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/30961/diff/1-2/

Comment 8

[Mark Hammond [:markh]]

Comment on attachment 8708075 [details]
MozReview Request: Bug 1233298 - Remove query params from the `FXA_HAWK_ERRORS` probe. r?markh

https://reviewboard.mozilla.org/r/30961/#review28595

Awesome, thanks!

Comment 9

[Pulsebot]

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

Comment 10

[Carsten Book [:Tomcat]]

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