services/settings/Utils.sys.mjs

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
   6 import { ServiceRequest } from "resource://gre/modules/ServiceRequest.sys.mjs";
   7 import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
   8
   9 const lazy = {};
  10
  11 ChromeUtils.defineESModuleGetters(lazy, {
  12   SharedUtils: "resource://services-settings/SharedUtils.sys.mjs",
  13 });
  14
  15 XPCOMUtils.defineLazyServiceGetter(
  16   lazy,
  17   "CaptivePortalService",
  18   "@mozilla.org/network/captive-portal-service;1",
  19   "nsICaptivePortalService"
  20 );
  21 XPCOMUtils.defineLazyServiceGetter(
  22   lazy,
  23   "gNetworkLinkService",
  24   "@mozilla.org/network/network-link-service;1",
  25   "nsINetworkLinkService"
  26 );
  27
  28 // Create a new instance of the ConsoleAPI so we can control the maxLogLevel with a pref.
  29 // See LOG_LEVELS in Console.sys.mjs. Common examples: "all", "debug", "info",
  30 // "warn", "error".
  31 const log = (() => {
  32   const { ConsoleAPI } = ChromeUtils.importESModule(
  33     "resource://gre/modules/Console.sys.mjs"
  34   );
  35   return new ConsoleAPI({
  36     maxLogLevel: "warn",
  37     maxLogLevelPref: "services.settings.loglevel",
  38     prefix: "services.settings",
  39   });
  40 })();
  41
  42 ChromeUtils.defineLazyGetter(lazy, "isRunningTests", () => {
  43   if (Services.env.get("MOZ_DISABLE_NONLOCAL_CONNECTIONS") === "1") {
  44     // Allow to override the server URL if non-local connections are disabled,
  45     // usually true when running tests.
  46     return true;
  47   }
  48   return false;
  49 });
  50
  51 // Overriding the server URL is normally disabled on Beta and Release channels,
  52 // except under some conditions.
  53 ChromeUtils.defineLazyGetter(lazy, "allowServerURLOverride", () => {
  54   if (!AppConstants.RELEASE_OR_BETA) {
  55     // Always allow to override the server URL on Nightly/DevEdition.
  56     return true;
  57   }
  58
  59   if (lazy.isRunningTests) {
  60     return true;
  61   }
  62
  63   if (Services.env.get("MOZ_REMOTE_SETTINGS_DEVTOOLS") === "1") {
  64     // Allow to override the server URL when using remote settings devtools.
  65     return true;
  66   }
  67
  68   if (lazy.gServerURL != AppConstants.REMOTE_SETTINGS_SERVER_URL) {
  69     log.warn("Ignoring preference override of remote settings server");
  70     log.warn(
  71       "Allow by setting MOZ_REMOTE_SETTINGS_DEVTOOLS=1 in the environment"
  72     );
  73   }
  74
  75   return false;
  76 });
  77
  78 XPCOMUtils.defineLazyPreferenceGetter(
  79   lazy,
  80   "gServerURL",
  81   "services.settings.server",
  82   AppConstants.REMOTE_SETTINGS_SERVER_URL
  83 );
  84
  85 XPCOMUtils.defineLazyPreferenceGetter(
  86   lazy,
  87   "gPreviewEnabled",
  88   "services.settings.preview_enabled",
  89   false
  90 );
  91
  92 function _isUndefined(value) {
  93   return typeof value === "undefined";
  94 }
  95
  96 export var Utils = {
  97   get SERVER_URL() {
  98     return lazy.allowServerURLOverride
  99       ? lazy.gServerURL
 100       : AppConstants.REMOTE_SETTINGS_SERVER_URL;
 101   },
 102
 103   CHANGES_PATH: "/buckets/monitor/collections/changes/changeset",
 104
 105   /**
 106    * Logger instance.
 107    */
 108   log,
 109
 110   get CERT_CHAIN_ROOT_IDENTIFIER() {
 111     if (this.SERVER_URL == AppConstants.REMOTE_SETTINGS_SERVER_URL) {
 112       return Ci.nsIContentSignatureVerifier.ContentSignatureProdRoot;
 113     }
 114     if (this.SERVER_URL.includes("allizom.")) {
 115       return Ci.nsIContentSignatureVerifier.ContentSignatureStageRoot;
 116     }
 117     if (this.SERVER_URL.includes("dev.")) {
 118       return Ci.nsIContentSignatureVerifier.ContentSignatureDevRoot;
 119     }
 120     if (Services.env.exists("XPCSHELL_TEST_PROFILE_DIR")) {
 121       return Ci.nsIX509CertDB.AppXPCShellRoot;
 122     }
 123     return Ci.nsIContentSignatureVerifier.ContentSignatureLocalRoot;
 124   },
 125
 126   get LOAD_DUMPS() {
 127     // Load dumps only if pulling data from the production server, or in tests.
 128     return (
 129       this.SERVER_URL == AppConstants.REMOTE_SETTINGS_SERVER_URL ||
 130       lazy.isRunningTests
 131     );
 132   },
 133
 134   get PREVIEW_MODE() {
 135     // We want to offer the ability to set preview mode via a preference
 136     // for consumers who want to pull from the preview bucket on startup.
 137     if (_isUndefined(this._previewModeEnabled) && lazy.allowServerURLOverride) {
 138       return lazy.gPreviewEnabled;
 139     }
 140     return !!this._previewModeEnabled;
 141   },
 142
 143   /**
 144    * Internal method to enable pulling data from preview buckets.
 145    * @param enabled
 146    */
 147   enablePreviewMode(enabled) {
 148     const bool2str = v =>
 149       // eslint-disable-next-line no-nested-ternary
 150       _isUndefined(v) ? "unset" : v ? "enabled" : "disabled";
 151     this.log.debug(
 152       `Preview mode: ${bool2str(this._previewModeEnabled)} -> ${bool2str(
 153         enabled
 154       )}`
 155     );
 156     this._previewModeEnabled = enabled;
 157   },
 158
 159   /**
 160    * Returns the actual bucket name to be used. When preview mode is enabled,
 161    * this adds the *preview* suffix.
 162    *
 163    * See also `SharedUtils.loadJSONDump()` which strips the preview suffix to identify
 164    * the packaged JSON file.
 165    *
 166    * @param bucketName the client bucket
 167    * @returns the final client bucket depending whether preview mode is enabled.
 168    */
 169   actualBucketName(bucketName) {
 170     let actual = bucketName.replace("-preview", "");
 171     if (this.PREVIEW_MODE) {
 172       actual += "-preview";
 173     }
 174     return actual;
 175   },
 176
 177   /**
 178    * Check if network is down.
 179    *
 180    * Note that if this returns false, it does not guarantee
 181    * that network is up.
 182    *
 183    * @return {bool} Whether network is down or not.
 184    */
 185   get isOffline() {
 186     try {
 187       return (
 188         Services.io.offline ||
 189         lazy.CaptivePortalService.state ==
 190           lazy.CaptivePortalService.LOCKED_PORTAL ||
 191         !lazy.gNetworkLinkService.isLinkUp
 192       );
 193     } catch (ex) {
 194       log.warn("Could not determine network status.", ex);
 195     }
 196     return false;
 197   },
 198
 199   /**
 200    * A wrapper around `ServiceRequest` that behaves like `fetch()`.
 201    *
 202    * Use this in order to leverage the `beConservative` flag, for
 203    * example to avoid using HTTP3 to fetch critical data.
 204    *
 205    * @param input a resource
 206    * @param init request options
 207    * @returns a Response object
 208    */
 209   async fetch(input, init = {}) {
 210     return new Promise(function (resolve, reject) {
 211       const request = new ServiceRequest();
 212       function fallbackOrReject(err) {
 213         if (
 214           // At most one recursive Utils.fetch call (bypassProxy=false to true).
 215           bypassProxy ||
 216           Services.startup.shuttingDown ||
 217           Utils.isOffline ||
 218           !request.isProxied ||
 219           !request.bypassProxyEnabled
 220         ) {
 221           reject(err);
 222           return;
 223         }
 224         ServiceRequest.logProxySource(request.channel, "remote-settings");
 225         resolve(Utils.fetch(input, { ...init, bypassProxy: true }));
 226       }
 227
 228       request.onerror = () =>
 229         fallbackOrReject(new TypeError("NetworkError: Network request failed"));
 230       request.ontimeout = () =>
 231         fallbackOrReject(new TypeError("Timeout: Network request failed"));
 232       request.onabort = () =>
 233         fallbackOrReject(new DOMException("Aborted", "AbortError"));
 234       request.onload = () => {
 235         // Parse raw response headers into `Headers` object.
 236         const headers = new Headers();
 237         const rawHeaders = request.getAllResponseHeaders();
 238         rawHeaders
 239           .trim()
 240           .split(/[\r\n]+/)
 241           .forEach(line => {
 242             const parts = line.split(": ");
 243             const header = parts.shift();
 244             const value = parts.join(": ");
 245             headers.set(header, value);
 246           });
 247
 248         const responseAttributes = {
 249           status: request.status,
 250           statusText: request.statusText,
 251           url: request.responseURL,
 252           headers,
 253         };
 254         resolve(new Response(request.response, responseAttributes));
 255       };
 256
 257       const { method = "GET", headers = {}, bypassProxy = false } = init;
 258
 259       request.open(method, input, { bypassProxy });
 260       // By default, XMLHttpRequest converts the response based on the
 261       // Content-Type header, or UTF-8 otherwise. This may mangle binary
 262       // responses. Avoid that by requesting the raw bytes.
 263       request.responseType = "arraybuffer";
 264
 265       for (const [name, value] of Object.entries(headers)) {
 266         request.setRequestHeader(name, value);
 267       }
 268
 269       request.send();
 270     });
 271   },
 272
 273   /**
 274    * Check if local data exist for the specified client.
 275    *
 276    * @param {RemoteSettingsClient} client
 277    * @return {bool} Whether it exists or not.
 278    */
 279   async hasLocalData(client) {
 280     const timestamp = await client.db.getLastModified();
 281     return timestamp !== null;
 282   },
 283
 284   /**
 285    * Check if we ship a JSON dump for the specified bucket and collection.
 286    *
 287    * @param {String} bucket
 288    * @param {String} collection
 289    * @return {bool} Whether it is present or not.
 290    */
 291   async hasLocalDump(bucket, collection) {
 292     try {
 293       await fetch(
 294         `resource://app/defaults/settings/${bucket}/${collection}.json`,
 295         {
 296           method: "HEAD",
 297         }
 298       );
 299       return true;
 300     } catch (e) {
 301       return false;
 302     }
 303   },
 304
 305   /**
 306    * Look up the last modification time of the JSON dump.
 307    *
 308    * @param {String} bucket
 309    * @param {String} collection
 310    * @return {int} The last modification time of the dump. -1 if non-existent.
 311    */
 312   async getLocalDumpLastModified(bucket, collection) {
 313     if (!this._dumpStats) {
 314       if (!this._dumpStatsInitPromise) {
 315         this._dumpStatsInitPromise = (async () => {
 316           try {
 317             let res = await fetch(
 318               "resource://app/defaults/settings/last_modified.json"
 319             );
 320             this._dumpStats = await res.json();
 321           } catch (e) {
 322             log.warn(`Failed to load last_modified.json: ${e}`);
 323             this._dumpStats = {};
 324           }
 325           delete this._dumpStatsInitPromise;
 326         })();
 327       }
 328       await this._dumpStatsInitPromise;
 329     }
 330     const identifier = `${bucket}/${collection}`;
 331     let lastModified = this._dumpStats[identifier];
 332     if (lastModified === undefined) {
 333       const { timestamp: dumpTimestamp } = await lazy.SharedUtils.loadJSONDump(
 334         bucket,
 335         collection
 336       );
 337       // Client recognize -1 as missing dump.
 338       lastModified = dumpTimestamp ?? -1;
 339       this._dumpStats[identifier] = lastModified;
 340     }
 341     return lastModified;
 342   },
 343
 344   /**
 345    * Fetch the list of remote collections and their timestamp.
 346    * ```
 347    *   {
 348    *     "timestamp": 1486545678,
 349    *     "changes":[
 350    *       {
 351    *         "host":"kinto-ota.dev.mozaws.net",
 352    *         "last_modified":1450717104423,
 353    *         "bucket":"blocklists",
 354    *         "collection":"certificates"
 355    *       },
 356    *       ...
 357    *     ],
 358    *     "metadata": {}
 359    *   }
 360    * ```
 361    * @param {String} serverUrl         The server URL (eg. `https://server.org/v1`)
 362    * @param {int}    expectedTimestamp The timestamp that the server is supposed to return.
 363    *                                   We obtained it from the Megaphone notification payload,
 364    *                                   and we use it only for cache busting (Bug 1497159).
 365    * @param {String} lastEtag          (optional) The Etag of the latest poll to be matched
 366    *                                   by the server (eg. `"123456789"`).
 367    * @param {Object} filters
 368    */
 369   async fetchLatestChanges(serverUrl, options = {}) {
 370     const { expectedTimestamp, lastEtag = "", filters = {} } = options;
 371
 372     let url = serverUrl + Utils.CHANGES_PATH;
 373     const params = {
 374       ...filters,
 375       _expected: expectedTimestamp ?? 0,
 376     };
 377     if (lastEtag != "") {
 378       params._since = lastEtag;
 379     }
 380     if (params) {
 381       url +=
 382         "?" +
 383         Object.entries(params)
 384           .map(([k, v]) => `${k}=${encodeURIComponent(v)}`)
 385           .join("&");
 386     }
 387     const response = await Utils.fetch(url);
 388
 389     if (response.status >= 500) {
 390       throw new Error(`Server error ${response.status} ${response.statusText}`);
 391     }
 392
 393     const is404FromCustomServer =
 394       response.status == 404 &&
 395       Services.prefs.prefHasUserValue("services.settings.server");
 396
 397     const ct = response.headers.get("Content-Type");
 398     if (!is404FromCustomServer && (!ct || !ct.includes("application/json"))) {
 399       throw new Error(`Unexpected content-type "${ct}"`);
 400     }
 401
 402     let payload;
 403     try {
 404       payload = await response.json();
 405     } catch (e) {
 406       payload = e.message;
 407     }
 408
 409     if (!payload.hasOwnProperty("changes")) {
 410       // If the server is failing, the JSON response might not contain the
 411       // expected data. For example, real server errors (Bug 1259145)
 412       // or dummy local server for tests (Bug 1481348)
 413       if (!is404FromCustomServer) {
 414         throw new Error(
 415           `Server error ${url} ${response.status} ${
 416             response.statusText
 417           }: ${JSON.stringify(payload)}`
 418         );
 419       }
 420     }
 421
 422     const { changes = [], timestamp } = payload;
 423
 424     let serverTimeMillis = Date.parse(response.headers.get("Date"));
 425     // Since the response is served via a CDN, the Date header value could have been cached.
 426     const cacheAgeSeconds = response.headers.has("Age")
 427       ? parseInt(response.headers.get("Age"), 10)
 428       : 0;
 429     serverTimeMillis += cacheAgeSeconds * 1000;
 430
 431     // Age of data (time between publication and now).
 432     const ageSeconds = (serverTimeMillis - timestamp) / 1000;
 433
 434     // Check if the server asked the clients to back off.
 435     let backoffSeconds;
 436     if (response.headers.has("Backoff")) {
 437       const value = parseInt(response.headers.get("Backoff"), 10);
 438       if (!isNaN(value)) {
 439         backoffSeconds = value;
 440       }
 441     }
 442
 443     return {
 444       changes,
 445       currentEtag: `"${timestamp}"`,
 446       serverTimeMillis,
 447       backoffSeconds,
 448       ageSeconds,
 449     };
 450   },
 451
 452   /**
 453    * Test if a single object matches all given filters.
 454    *
 455    * @param  {Object} filters  The filters object.
 456    * @param  {Object} entry    The object to filter.
 457    * @return {Boolean}
 458    */
 459   filterObject(filters, entry) {
 460     return Object.entries(filters).every(([filter, value]) => {
 461       if (Array.isArray(value)) {
 462         return value.some(candidate => candidate === entry[filter]);
 463       } else if (typeof value === "object") {
 464         return Utils.filterObject(value, entry[filter]);
 465       } else if (!Object.prototype.hasOwnProperty.call(entry, filter)) {
 466         console.error(`The property ${filter} does not exist`);
 467         return false;
 468       }
 469       return entry[filter] === value;
 470     });
 471   },
 472
 473   /**
 474    * Sorts records in a list according to a given ordering.
 475    *
 476    * @param  {String} order The ordering, eg. `-last_modified`.
 477    * @param  {Array}  list  The collection to order.
 478    * @return {Array}
 479    */
 480   sortObjects(order, list) {
 481     const hasDash = order[0] === "-";
 482     const field = hasDash ? order.slice(1) : order;
 483     const direction = hasDash ? -1 : 1;
 484     return list.slice().sort((a, b) => {
 485       if (a[field] && _isUndefined(b[field])) {
 486         return direction;
 487       }
 488       if (b[field] && _isUndefined(a[field])) {
 489         return -direction;
 490       }
 491       if (_isUndefined(a[field]) && _isUndefined(b[field])) {
 492         return 0;
 493       }
 494       return a[field] > b[field] ? direction : -direction;
 495     });
 496   },
 497 };