Split apart and add unit tests for getTelemetryFor. (#127)

Author: Robert Jackson

.eslintrc.js

@@ -11,5 +11,13 @@ module.exports = {
   plugins: ["prettier"],
   rules: {
     "prettier/prettier": "error"
-  }
+  },
+  overrides: [
+    {
+      files: ['**/*.test.js'],
+      env: {
+        jest: true
+      }
+    }
+  ]
 };

transforms/helpers/parse-helper.js

@@ -6,7 +6,7 @@ const {
   getOptions,
   startsWithUpperCaseLetter
 } = require("./util");
-const getTelemetryFor = require("./util/get-telemetry-for");
+const { getTelemetryFor } = require("./util/get-telemetry-for");
 const {
   hasValidProps,
   isFileOfType,

transforms/helpers/util/get-telemetry-for.js

@@ -6,7 +6,7 @@ const cache = require("../../../lib/cache");
 const telemetry = cache.has("telemetry")
   ? JSON.parse(cache.get("telemetry").value)
   : {};
-const addonFilePaths = {};
+const ADDON_PATHS = {};
 
 let packagePaths = walkSync("./", {
   globs: ["**/package.json"],
@@ -16,34 +16,51 @@ let packagePaths = walkSync("./", {
 for (let packagePath of packagePaths) {
   let { name } = fs.readJsonSync(packagePath);
 
-  addonFilePaths[path.dirname(path.resolve(".", packagePath))] = name;
+  ADDON_PATHS[path.dirname(path.resolve(".", packagePath))] = name;
 }
 
 /**
- * Get the runtime data for the file being transformed
+ * Transforms a literal "on disk" path to a "module path".
  *
- * @param {String} filePath Absolute path of the file to read data from
- * @returns {Object} Runtime configuration object
+ * @param {String} filePath the path on disk (from current working directory)
+ * @returns {String} The in-browser module path for the specified filePath
  */
-module.exports = function getTelemetryData(filePath) {
+function getModulePathFor(filePath, addonPaths = ADDON_PATHS) {
   let fileSegments = filePath.split("/");
   let addonSegments = [];
 
   while (fileSegments.length > 0) {
     addonSegments.push(fileSegments.shift());
 
-    if (addonFilePaths[addonSegments.join("/")]) {
+    if (addonPaths[addonSegments.join("/")]) {
       break;
     }
   }
 
   let addonFilePath = addonSegments.join("/");
-  let addonName = addonFilePaths[addonFilePath];
+  let addonName = addonPaths[addonFilePath];
 
   let relativeFilePath = fileSegments
     .join("/")
     .replace(/^(addon|app)\//, "")
     .replace(/\.[^/.]+$/, "");
 
-  return telemetry[`${addonName}/${relativeFilePath}`];
+  return `${addonName}/${relativeFilePath}`;
+}
+
+/**
+ * Get the runtime data for the file being transformed
+ *
+ * @param {String} filePath Absolute path of the file to read data from
+ * @returns {Object} Runtime configuration object
+ */
+function getTelemetryFor(filePath) {
+  let modulePath = getModulePathFor(filePath);
+
+  return telemetry[modulePath];
+}
+
+module.exports = {
+  getTelemetryFor,
+  getModulePathFor
 };

transforms/helpers/util/get-telemetry-for.test.js

@@ -0,0 +1,17 @@
+const { getModulePathFor } = require("./get-telemetry-for");
+
+describe("getModulePathFor", () => {
+  test("accesses telemetry data for the specified app module", () => {
+    const addonPaths = {
+      "/User/whomever/voyager-web/lib/invitation-platform":
+        "invitation-platform"
+    };
+
+    expect(
+      getModulePathFor(
+        "/User/whomever/voyager-web/lib/invitation-platform/addon/components/fuse-limit-alert",
+        addonPaths
+      )
+    ).toEqual("invitation-platform/components/fuse-limit-alert");
+  });
+});