2008554 - [meta] Single source of truth for policy capabilities

Status: RESOLVED FIXED

(Enterprise Products :: General, task, P1)

Description

[Gian-Carlo Pascutto [:gcp]]

Different Firefox versions might support different policies, and might support different configuration options within those policies, and be or not be able to support un-setting the policy or changing it live (without restarting). We want a single source of truth for these capabilities that the console can pull from to display the proper UI.

Comment 1

[Gian-Carlo Pascutto [:gcp]]

This can also include whether the policy is relevant to Firefox for Enterprise (e.g. Firefox Accounts settings).

Comment 2

[Gian-Carlo Pascutto [:gcp]]

Note: https://github.com/mozilla-firefox/firefox/commit/983c21b678c9b8d2c45b048deb899d5f237efab2

But: https://github.com/mozilla/policy-templates/issues/135 wasn't entirely followed up on.

Comment 3

[Brian Thomas Smith [:bsmth]]

I have the impression we are converging on having this in data in https://github.com/mozilla-firefox/firefox/blob/main/browser/components/enterprisepolicies/schemas/policies-schema.json

But containing additional members, like:

{
  "DisableTelemetry": {
    "description": "Disables the collection and submission of telemetry data.",
    "x-requires_restart": true,
    "x-compatibility": {
      "firefox": {
        "version_added": "50"
      },
      "firefox_esr": {
        "version_added": "50"
      },
      "firefox_enterprise": {
        "version_added": "70"
      }
    }
  }
}

For validation, it may look like this example I was roughly drafting: https://github.com/bsmth/policy-compat-data/blob/main/data/policy-compat-data.schema.json

Historical context:

1. Version support info removed in https://github.com/mozilla-firefox/firefox/commit/983c21b678c9b8d2c45b048deb899d5f237efab2
2. Descriptions moved out into ftl files for translations https://github.com/mozilla-firefox/firefox/commit/4bc09a8e18cd3a797cd5f96fa14ba40ec4dba987

edit:

• Adding x- prefix for non-standard fields

Comment 4

[BMO Github Automation]

Attachment: [mozilla/enterprise-firefox] Bug 2008554 - Add a linter for current policy JSON schema (#910)

Comment 5

[Brian Thomas Smith [:bsmth]]

I'm proposing a linter in https://github.com/mozilla/enterprise-firefox/pull/910 to enforce the current shape of policies-schema.json.

Comment 7

[Brian Thomas Smith [:bsmth]]

Attachment: Bug 2008554 - Validate enterprise policy schema with xpcshell tests. r?mkaply

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/b201e2a68fb5
https://hg.mozilla.org/integration/autoland/rev/23780b70f281
Validate enterprise policy schema with xpcshell tests. r=mkaply,Standard8

Comment 9

[rperta]

https://hg.mozilla.org/mozilla-central/rev/23780b70f281

Comment 10

[Brian Thomas Smith [:bsmth]]

There's still some work to do on this, so reopening. The tests have now landed, so all new policies must have description, category, and examples. The missing parts are compat and 'restart required' info, they're coming in follow-up patches.

Comment 11

[Brian Thomas Smith [:bsmth]]

We can close as done now, well done!