Bug 1733535 - Replace OS.File with IOUtils in the attribution code. r=Standard8

Differential Revision: https://phabricator.services.mozilla.com/D128715

browser/components/attribution/AttributionCode.jsm

@@ -3,7 +3,16 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 "use strict";
 
-var EXPORTED_SYMBOLS = ["AttributionCode"];
+var EXPORTED_SYMBOLS = ["AttributionCode", "AttributionIOUtils"];
+
+/**
+ * This is a policy object used to override behavior for testing.
+ */
+const AttributionIOUtils = {
+  write: async (path, bytes) => IOUtils.write(path, bytes),
+  read: async path => IOUtils.read(path),
+  exists: async path => IOUtils.exists(path),
+};
 
 const { XPCOMUtils } = ChromeUtils.import(
   "resource://gre/modules/XPCOMUtils.jsm"
@@ -13,7 +22,6 @@ ChromeUtils.defineModuleGetter(
   "AppConstants",
   "resource://gre/modules/AppConstants.jsm"
 );
-ChromeUtils.defineModuleGetter(this, "OS", "resource://gre/modules/osfile.jsm");
 ChromeUtils.defineModuleGetter(
   this,
   "Services",
@@ -124,7 +132,7 @@ var AttributionCode = {
       // Ignore the exception due to a directory that already exists.
     }
     let bytes = new TextEncoder().encode(code);
-    await OS.File.writeAtomic(file.path, bytes);
+    await AttributionIOUtils.write(file.path, bytes);
   },
 
   /**
@@ -259,7 +267,7 @@ var AttributionCode = {
 
     if (
       AppConstants.platform == "macosx" &&
-      !(await OS.File.exists(attributionFile.path))
+      !(await AttributionIOUtils.exists(attributionFile.path))
     ) {
       log.debug(
         `getAttrDataAsync: macOS && !exists("${attributionFile.path}")`
@@ -317,9 +325,9 @@ var AttributionCode = {
 
     let bytes;
     try {
-      bytes = await OS.File.read(attributionFile.path);
+      bytes = await AttributionIOUtils.read(attributionFile.path);
     } catch (ex) {
-      if (ex instanceof OS.File.Error && ex.becauseNoSuchFile) {
+      if (ex instanceof DOMException && ex.name == "NotFoundError") {
         log.debug(
           `getAttrDataAsync: !exists("${
             attributionFile.path
@@ -379,7 +387,7 @@ var AttributionCode = {
    */
   async deleteFileAsync() {
     try {
-      await OS.File.remove(this.attributionFile.path);
+      await IOUtils.remove(this.attributionFile.path);
     } catch (ex) {
       // The attribution file may already have been deleted,
       // or it may have never been installed at all;

browser/components/attribution/MacAttribution.jsm

@@ -54,6 +54,7 @@ function getQuarantineDatabasePath() {
  * @throws NS_ERROR_UNEXPECTED if there is a quarantine GUID, but it is malformed.
  */
 async function getQuarantineAttributes(path) {
+  // TODO: Bug 1736331 replace OS.File.macGetXAttr with an alternative.
   let bytes = await OS.File.macGetXAttr(path, "com.apple.quarantine");
   if (!bytes) {
     throw new Components.Exception(

browser/components/attribution/test/browser/browser_AttributionCode_Mac_telemetry.js

@@ -6,6 +6,9 @@ ChromeUtils.defineModuleGetter(
 const { MacAttribution } = ChromeUtils.import(
   "resource:///modules/MacAttribution.jsm"
 );
+const { AttributionIOUtils } = ChromeUtils.import(
+  "resource:///modules/AttributionCode.jsm"
+);
 const { sinon } = ChromeUtils.import("resource://testing-common/Sinon.jsm");
 
 async function assertCacheExistsAndIsEmpty() {
@@ -16,11 +19,11 @@ async function assertCacheExistsAndIsEmpty() {
   );
   histogram.clear();
 
-  ok(await OS.File.exists(AttributionCode.attributionFile.path));
+  ok(await AttributionIOUtils.exists(AttributionCode.attributionFile.path));
   Assert.deepEqual(
     "",
     new TextDecoder().decode(
-      await OS.File.read(AttributionCode.attributionFile.path)
+      await AttributionIOUtils.read(AttributionCode.attributionFile.path)
     )
   );
 
@@ -49,21 +52,19 @@ add_task(async function test_write_error() {
     "BROWSER_ATTRIBUTION_ERRORS"
   );
 
+  let oldExists = AttributionIOUtils.exists;
+  let oldWrite = AttributionIOUtils.write;
   try {
     // Clear any existing telemetry
     histogram.clear();
 
     // Force the file to not exist and then cause a write error.  This is delicate
-    // because various background tasks may invoke `OS.File.writeAtomic` while
+    // because various background tasks may invoke `IOUtils.writeAtomic` while
     // this test is running.  Be careful to only stub the one call.
-    const writeAtomic = sandbox.stub(OS.File, "writeAtomic");
-    writeAtomic
-      .withArgs(
-        sinon.match(AttributionCode.attributionFile.path),
-        sinon.match.any
-      )
-      .throws(() => new Error("write_error"));
-    OS.File.writeAtomic.callThrough();
+    AttributionIOUtils.exists = () => false;
+    AttributionIOUtils.write = () => {
+      throw new Error("write_error");
+    };
 
     // Try to read the attribution code.
     let result = await AttributionCode.getAttrDataAsync();
@@ -75,6 +76,8 @@ add_task(async function test_write_error() {
 
     TelemetryTestUtils.assertHistogram(histogram, INDEX_WRITE_ERROR, 1);
   } finally {
+    AttributionIOUtils.exists = oldExists;
+    AttributionIOUtils.write = oldWrite;
     await AttributionCode.deleteFileAsync();
     AttributionCode._clearCache();
     histogram.clear();
@@ -214,6 +217,7 @@ add_task(async function test_broken_referrer() {
     generateQuarantineGUID(),
   ].join(";");
   let bytes = new TextEncoder().encode(string);
+  // TODO: Bug 1736331 replace OS.File.macSetXAttr with an alternative.
   await OS.File.macSetXAttr(
     MacAttribution.applicationPath,
     "com.apple.quarantine",

browser/components/attribution/test/browser/browser_AttributionCode_telemetry.js

@@ -3,7 +3,9 @@ ChromeUtils.defineModuleGetter(
   "TelemetryTestUtils",
   "resource://testing-common/TelemetryTestUtils.jsm"
 );
-const { sinon } = ChromeUtils.import("resource://testing-common/Sinon.jsm");
+const { AttributionIOUtils } = ChromeUtils.import(
+  "resource:///modules/AttributionCode.jsm"
+);
 
 add_task(async function test_parse_error() {
   if (AppConstants.platform == "macosx") {
@@ -62,7 +64,7 @@ add_task(async function test_read_error() {
   const histogram = Services.telemetry.getHistogramById(
     "BROWSER_ATTRIBUTION_ERRORS"
   );
-  const sandbox = sinon.createSandbox();
+
   // Delete the file to trigger a read error
   await AttributionCode.deleteFileAsync();
   AttributionCode._clearCache();
@@ -70,10 +72,19 @@ add_task(async function test_read_error() {
   histogram.clear();
 
   // Force the file to exist but then cause a read error
-  const exists = sandbox.stub(OS.File, "exists");
-  exists.resolves(true);
-  const read = sandbox.stub(OS.File, "read");
-  read.throws(() => new Error("read_error"));
+  let oldExists = AttributionIOUtils.exists;
+  AttributionIOUtils.exists = () => true;
+
+  let oldRead = AttributionIOUtils.read;
+  AttributionIOUtils.read = () => {
+    throw new Error("read_error");
+  };
+
+  registerCleanupFunction(() => {
+    AttributionIOUtils.exists = oldExists;
+    AttributionIOUtils.read = oldRead;
+  });
+
   // Try to read the file
   await AttributionCode.getAttrDataAsync();
 
@@ -82,5 +93,4 @@ add_task(async function test_read_error() {
 
   // Clear any existing telemetry
   histogram.clear();
-  sandbox.restore();
 });

browser/components/attribution/test/xpcshell/head.js

@@ -84,7 +84,6 @@ async function setupStubs() {
   const { AppConstants } = ChromeUtils.import(
     "resource://gre/modules/AppConstants.jsm"
   );
-  const { OS } = ChromeUtils.import("resource://gre/modules/osfile.jsm");
   const { sinon } = ChromeUtils.import("resource://testing-common/Sinon.jsm");
 
   // This depends on the caller to invoke it by name.  We do try to
@@ -117,5 +116,7 @@ async function setupStubs() {
   // directory for the attribution file, needed on both macOS and Windows.  We
   // don't ignore existing paths because we're inside a temporary directory:
   // this should never be invoked twice for the same test.
-  await OS.File.makeDir(applicationFile.path, { from: do_get_tempdir().path });
+  await IOUtils.makeDirectory(applicationFile.path, {
+    from: do_get_tempdir().path,
+  });
 }