Backed out changeset fc8a2b80e9f6 (bug 1776480) for causing Gecko Dec…

…ision bustage. CLOSED TREE

.eslintrc-test-paths.js

@@ -263,6 +263,7 @@ const extraChromeTestPaths = [
   "layout/svg/tests/",
   "layout/xul/test/",
   "toolkit/components/aboutmemory/tests/",
+  "toolkit/components/osfile/tests/mochi/",
   "toolkit/components/printing/tests/",
   "toolkit/components/url-classifier/tests/mochitest/",
   "toolkit/components/viewsource/test/",

.eslintrc.js

@@ -310,6 +310,7 @@ module.exports = {
         "toolkit/components/narrate/Narrator.jsm",
         "toolkit/components/nimbus/**",
         "toolkit/components/normandy/**",
+        "toolkit/components/osfile/**",
         "toolkit/components/passwordmgr/**",
         "toolkit/components/pdfjs/**",
         "toolkit/components/pictureinpicture/**",
@@ -612,6 +613,13 @@ module.exports = {
         "devtools/**",
       ],
     },
+    {
+      // Turn off the osfile rule for osfile.
+      files: ["toolkit/components/osfile/**"],
+      rules: {
+        "mozilla/reject-osfile": "off",
+      },
+    },
     {
       // Exempt files with these paths since they have to use http for full coverage
       files: httpTestingPaths.map(path => `${path}**`),

browser/base/content/test/performance/browser_startup.js

@@ -102,6 +102,7 @@ const startupPhases = {
       modules: new Set([
         "resource://gre/modules/AsyncPrefs.sys.mjs",
         "resource://gre/modules/LoginManagerContextMenu.sys.mjs",
+        "resource://gre/modules/osfile.jsm",
         "resource://pdf.js/PdfStreamConverter.sys.mjs",
       ]),
     },

browser/base/content/test/static/browser_all_files_referenced.js

@@ -71,6 +71,12 @@ var gExceptionPaths = [
 
   // Localization file added programatically in featureCallout.jsm
   "resource://app/localization/en-US/browser/featureCallout.ftl",
+
+  // Will be removed in bug 1737308
+  "resource://gre/modules/lz4.js",
+  "resource://gre/modules/lz4_internal.js",
+  "resource://gre/modules/osfile.jsm",
+  "resource://gre/modules/osfile/",
 ];
 
 // These are not part of the omni.ja file, so we find them only when running

docs/code-quality/lint/linters/eslint-plugin-mozilla.rst

@@ -58,6 +58,7 @@ The plugin implements the following rules:
    eslint-plugin-mozilla/reject-lazy-imports-into-globals
    eslint-plugin-mozilla/reject-mixing-eager-and-lazy
    eslint-plugin-mozilla/reject-multiple-getters-calls
+   eslint-plugin-mozilla/reject-osfile
    eslint-plugin-mozilla/reject-relative-requires
    eslint-plugin-mozilla/reject-requires-await
    eslint-plugin-mozilla/reject-scriptableunicodeconverter

docs/code-quality/lint/linters/eslint-plugin-mozilla/reject-osfile.rst

@@ -0,0 +1,13 @@
+reject-osfile
+=============
+
+Rejects calls into ``OS.File`` and ``OS.Path``. This is configured as a warning.
+You should use |IOUtils|_ and |PathUtils|_ respectively for new code.  If
+modifying old code, please consider swapping it in if possible; if this is
+tricky please ensure a bug is on file.
+
+.. |IOUtils| replace:: ``IOUtils``
+.. _IOUtils: https://searchfox.org/mozilla-central/source/dom/chrome-webidl/IOUtils.webidl
+
+.. |PathUtils| replace:: ``PathUtils``
+.. _PathUtils: https://searchfox.org/mozilla-central/source/dom/chrome-webidl/PathUtils.webidl

dom/system/OSFileConstants.cpp

@@ -248,8 +248,10 @@ nsresult OSFileConstantsService::InitOSFileConstants() {
  *
  * Produces a |ConstantSpec|.
  */
-#define INT_CONSTANT(name) \
-  { #name, JS::Int32Value(name) }
+#define INT_CONSTANT(name)      \
+  {                             \
+#    name, JS::Int32Value(name) \
+  }
 
 /**
  * Define a simple read-only property holding an unsigned integer.
@@ -259,8 +261,10 @@ nsresult OSFileConstantsService::InitOSFileConstants() {
  *
  * Produces a |ConstantSpec|.
  */
-#define UINT_CONSTANT(name) \
-  { #name, JS::NumberValue(name) }
+#define UINT_CONSTANT(name)      \
+  {                              \
+#    name, JS::NumberValue(name) \
+  }
 
 /**
  * End marker for ConstantSpec
@@ -835,12 +839,97 @@ bool OSFileConstantsService::DefineOSFileConstants(
     return false;
   }
 
+  nsCOMPtr<nsIXULRuntime> runtime =
+      do_GetService(XULRUNTIME_SERVICE_CONTRACTID);
+  if (runtime) {
+    nsAutoCString os;
+    DebugOnly<nsresult> rv = runtime->GetOS(os);
+    MOZ_ASSERT(NS_SUCCEEDED(rv));
+
+    JSString* strVersion = JS_NewStringCopyZ(aCx, os.get());
+    if (!strVersion) {
+      return false;
+    }
+
+    JS::Rooted<JS::Value> valVersion(aCx, JS::StringValue(strVersion));
+    if (!JS_SetProperty(aCx, objSys, "Name", valVersion)) {
+      return false;
+    }
+  }
+
+#if defined(DEBUG)
+  JS::Rooted<JS::Value> valDebug(aCx, JS::TrueValue());
+  if (!JS_SetProperty(aCx, objSys, "DEBUG", valDebug)) {
+    return false;
+  }
+#endif
+
+#if defined(HAVE_64BIT_BUILD)
+  JS::Rooted<JS::Value> valBits(aCx, JS::Int32Value(64));
+#else
+  JS::Rooted<JS::Value> valBits(aCx, JS::Int32Value(32));
+#endif  // defined (HAVE_64BIT_BUILD)
+  if (!JS_SetProperty(aCx, objSys, "bits", valBits)) {
+    return false;
+  }
+
   if (!JS_DefineProperty(
           aCx, objSys, "umask", mUserUmask,
           JSPROP_ENUMERATE | JSPROP_READONLY | JSPROP_PERMANENT)) {
     return false;
   }
 
+  // Build OS.Constants.Path
+
+  JS::Rooted<JSObject*> objPath(aCx);
+  if (!(objPath = GetOrCreateObjectProperty(aCx, objConstants, "Path"))) {
+    return false;
+  }
+
+  // Locate libxul
+  // Note that we don't actually provide the full path, only the name of the
+  // library, which is sufficient to link to the library using js-ctypes.
+
+#if defined(XP_MACOSX)
+  // Under MacOS X, for some reason, libxul is called simply "XUL",
+  // and we need to provide the full path.
+  nsAutoString libxul;
+  libxul.Append(mPaths->libDir);
+  libxul.AppendLiteral("/XUL");
+#else
+  // On other platforms, libxul is a library "xul" with regular
+  // library prefix/suffix.
+  nsAutoString libxul;
+  libxul.AppendLiteral(MOZ_DLL_PREFIX);
+  libxul.AppendLiteral("xul");
+  libxul.AppendLiteral(MOZ_DLL_SUFFIX);
+#endif  // defined(XP_MACOSX)
+
+  if (!SetStringProperty(aCx, objPath, "libxul", libxul)) {
+    return false;
+  }
+
+  if (!SetStringProperty(aCx, objPath, "libDir", mPaths->libDir)) {
+    return false;
+  }
+
+  if (!SetStringProperty(aCx, objPath, "tmpDir", mPaths->tmpDir)) {
+    return false;
+  }
+
+  // Configure profileDir only if it is available at this stage
+  if (!mPaths->profileDir.IsVoid() &&
+      !SetStringProperty(aCx, objPath, "profileDir", mPaths->profileDir)) {
+    return false;
+  }
+
+  // Configure localProfileDir only if it is available at this stage
+  if (!mPaths->localProfileDir.IsVoid() &&
+      !SetStringProperty(aCx, objPath, "localProfileDir",
+                         mPaths->localProfileDir)) {
+    return false;
+  }
+
   return true;
 }
 

dom/system/moz.build

@@ -8,6 +8,9 @@
 with Files("**"):
     BUG_COMPONENT = ("Core", "DOM: Core & HTML")
 
+with Files("*OSFile*"):
+    BUG_COMPONENT = ("Toolkit", "OS.File")
+
 with Files("*ocationProvider*"):
     BUG_COMPONENT = ("Core", "DOM: Geolocation")
 

dom/system/tests/chrome.ini

@@ -1,8 +1,8 @@
 [DEFAULT]
-
-[test_constants.xhtml]
 support-files =
   worker_constants.js
+
+[test_constants.xhtml]
 [test_pathutils.html]
 [test_pathutils_worker.xhtml]
 support-files =

dom/system/tests/ioutils/test_ioutils_read_write.html

@@ -15,6 +15,11 @@
     const { Assert } = ChromeUtils.import("resource://testing-common/Assert.jsm");
     const { ObjectUtils } = ChromeUtils.import("resource://gre/modules/ObjectUtils.jsm");
 
+    // This is presently only used to test compatability between OS.File and
+    // IOUtils when it comes to writing compressed files. The import and the
+    // test `test_lz4_osfile_compat` can be removed with OS.File is removed.
+    const { OS } = ChromeUtils.import("resource://gre/modules/osfile.jsm");
+
     add_task(async function test_read_failure() {
       const doesNotExist = PathUtils.join(PathUtils.tempDir, "does_not_exist.tmp");
       await Assert.rejects(
@@ -335,6 +340,31 @@
       await cleanup(tmpFileName);
     });
 
+    add_task(async function test_lz4_osfile_compat() {
+      const osfileTmpFile = PathUtils.join(PathUtils.tempDir, "test_ioutils_lz4_compat_osfile.tmp");
+      const ioutilsTmpFile = PathUtils.join(PathUtils.tempDir, "test_ioutils_lz4_compat_ioutils.tmp");
+
+      info("Test OS.File and IOUtils write the same file with LZ4 compression enabled")
+      const repeatedBytes = Uint8Array.of(...new Array(50).fill(1));
+      let expectedBytes = 23;
+      let ioutilsBytes = await IOUtils.write(ioutilsTmpFile, repeatedBytes, { compress: true });
+      let osfileBytes = await OS.File.writeAtomic(osfileTmpFile, repeatedBytes, { compression: "lz4" });
+      is(ioutilsBytes, expectedBytes, "IOUtils writes the expected number of bytes for compression");
+      is(osfileBytes, ioutilsBytes, "OS.File and IOUtils write the same number of bytes for LZ4 compression");
+
+      info("Test OS.File can read a file compressed by IOUtils");
+      const osfileReadBytes = await OS.File.read(ioutilsTmpFile, { compression: "lz4" });
+      ok(osfileReadBytes.every(byte => byte === 1), "OS.File can read a file compressed by IOUtils");
+      is(osfileReadBytes.length, 50, "OS.File reads the right number of bytes from a file compressed by IOUtils")
+
+      info("Test IOUtils can read a file compressed by OS.File");
+      const ioutilsReadBytes = await IOUtils.read(osfileTmpFile, { decompress: true });
+      ok(ioutilsReadBytes.every(byte => byte === 1), "IOUtils can read a file compressed by OS.File");
+      is(ioutilsReadBytes.length, 50, "IOUtils reads the right number of bytes from a file compressed by OS.File")
+
+      await cleanup(osfileTmpFile, ioutilsTmpFile);
+    });
+
     add_task(async function test_lz4_bad_call() {
       const tmpFileName = PathUtils.join(PathUtils.tempDir, "test_ioutils_lz4_bad_call.tmp");
 

dom/system/tests/ioutils/test_ioutils_read_write_utf8.html

@@ -15,6 +15,11 @@
     const { Assert } = ChromeUtils.import("resource://testing-common/Assert.jsm");
     const { ObjectUtils } = ChromeUtils.import("resource://gre/modules/ObjectUtils.jsm");
 
+    // This is presently only used to test compatability between OS.File and
+    // IOUtils when it comes to writing compressed files. The import and the
+    // test `test_lz4_osfile_compat` can be removed with OS.File is removed.
+    const { OS } = ChromeUtils.import("resource://gre/modules/osfile.jsm");
+
     // This is an impossible sequence of bytes in an UTF-8 encoded file.
     // See section 3.5.3 of this text:
     // https://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt
@@ -285,6 +290,29 @@
       await cleanup(tmpFileName);
     });
 
+    add_task(async function test_utf8_lz4_osfile_compat() {
+      const osfileTmpFile = PathUtils.join(PathUtils.tempDir, "test_ioutils_utf8_lz4_compat_osfile.tmp");
+      const ioutilsTmpFile = PathUtils.join(PathUtils.tempDir, "test_ioutils_utf8_lz4_compat_ioutils.tmp");
+
+      info("Test OS.File and IOUtils write the same UTF-8 file with LZ4 compression enabled")
+      const emoji = "☕️ ⚧️ 😀 🖖🏿 🤠 🏳️‍🌈 🥠 🏴‍☠️ 🪐";
+      let expectedBytes = 83;
+      let ioutilsBytes = await IOUtils.writeUTF8(ioutilsTmpFile, emoji, { compress: true });
+      let osfileBytes = await OS.File.writeAtomic(osfileTmpFile, emoji, { compression: "lz4" });
+      is(ioutilsBytes, expectedBytes, "IOUtils writes the expected number of bytes for compression");
+      is(osfileBytes, ioutilsBytes, "OS.File and IOUtils write the same number of bytes for LZ4 compression");
+
+      info("Test OS.File can read an UTF-8 file compressed by IOUtils");
+      const osfileReadStr = await OS.File.read(ioutilsTmpFile, { compression: "lz4", encoding: "utf-8" });
+      is(osfileReadStr, emoji, "OS.File can read an UTF-8 file compressed by IOUtils")
+
+      info("Test IOUtils can read an UTF-8 file compressed by OS.File");
+      const ioutilsReadString = await IOUtils.readUTF8(ioutilsTmpFile, { decompress: true });
+      is(ioutilsReadString, emoji, "IOUtils can read an UTF-8 file compressed by OS.File");
+
+      await cleanup(osfileTmpFile, ioutilsTmpFile);
+    });
+
     add_task(async function test_utf8_lz4_bad_call() {
       const tmpFileName = PathUtils.join(PathUtils.tempDir, "test_ioutils_utf8_lz4_bad_call.tmp");
 

dom/system/tests/test_constants.xhtml

@@ -16,6 +16,21 @@
 
 let worker;
 
+function test_xul() {
+  let lib;
+  isnot(null, OS.Constants.Path.libxul, "libxulpath is defined");
+  try {
+    lib = ctypes.open(OS.Constants.Path.libxul);
+    lib.declare("DumpJSStack", ctypes.default_abi, ctypes.void_t);
+  } catch (x) {
+    ok(false, "Could not open libxul " + x);
+  }
+  if (lib) {
+    lib.close();
+  }
+  ok(true, "test_xul: opened libxul successfully");
+}
+
 // Test that OS.Constants.libc is defined
 function test_libc() {
   isnot(null, OS.Constants.libc, "OS.Constants.libc is defined");
@@ -43,6 +58,11 @@ function test_Win() {
   }
 }
 
+// Test that OS.Constants.Sys.DEBUG is set properly on main thread
+function test_debugBuildMainThread(isDebugBuild) {
+  is(isDebugBuild, !!OS.Constants.Sys.DEBUG, "OS.Constants.Sys.DEBUG is set properly on main thread");
+}
+
 // Test that OS.Constants.Sys.umask is set properly on main thread
 function test_umaskMainThread(umask) {
   is(umask, OS.Constants.Sys.umask,
@@ -59,9 +79,13 @@ function test() {
     getService(Ci.nsIOSFileConstantsService).
     init();
   ({ctypes} = ChromeUtils.import("resource://gre/modules/ctypes.jsm"));
+  test_xul();
   test_libc();
   test_Win();
 
+  let isDebugBuild = Cc["@mozilla.org/xpcom/debug;1"]
+                            .getService(Ci.nsIDebug2).isDebugBuild;
+  test_debugBuildMainThread(isDebugBuild);
 
   let umask = Cc["@mozilla.org/system-info;1"].
     getService(Ci.nsIPropertyBag2).
@@ -99,6 +123,7 @@ function test() {
   // pass expected values that are unavailable off-main-thread
   // to the worker
   worker.postMessage({
+    isDebugBuild: isDebugBuild,
     umask: umask
   });
   ok(true, "test_constants.xhtml: Test in progress");