1622864 - In searchengine-devtools, always show a telemetry id, not 'undefined'

Status: RESOLVED FIXED

(Firefox :: Search, task, P2)

Description

[Mark Banner (:standard8)]

The current 'undefined' value for a telemetry ID is where a search engine does not explicitly have a telemetry ID defined.

However, in such cases we fall back to the short name, which is the first part of the WebExtension ID.

We should list that in the table to make it explicit and clear what the telemetry ID will be reported as.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1622864 - Avoid sanitizing a name for app-provided engines, and clarify the WebExtension id in the search engine schema. r?daleharvey!

makeEngineFromConfig currently initialises SearchEngine with the full name which is then sanitized, only for it to be overriden when calling _initFromMetadata. Being able to pass shortName directly, makes it clearer as to what is happening.

By being explicit about if we're passing shortName or the display name, we can avoid the awkward sanitizeName option.

Also updating the schema to provide validation of the WebExtension Id so that we have the format we expect there (which shortName is based on).

Comment 2

[Mark Banner (:standard8)]

Bumping to a 3, as I'm including work that I could have split to an extra bug, but seemed to make sense to include here as I spent time working out what was going on in order to do the searchengine-devtools patch.

@Dale: https://github.com/mozilla/searchengine-devtools/pull/4 is the PR to do the telemetryId improvement.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/692660018507
Avoid sanitizing a name for app-provided engines, and clarify the WebExtension id in the search engine schema. r=daleharvey

Comment 4

[Noemi Erli[:noemi_erli]]

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

Comment 5

[Mark Banner (:standard8)]

Should have left this open whilst we land the github part.

Comment 6

[Dale Harvey (:daleharvey)]

and reviewed

Comment 7

[Mark Banner (:standard8)]

Thank you