fix(Plugin resolution): Use the require resolution to retrieve configs

nfroidure · Feb 3, 2019 · 87946c2 · 87946c2
1 parent 9a6fac4
commit 87946c2
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 75 deletions.
diff --git a/src/assets.js b/src/assets.js
@@ -1,15 +1,11 @@
 const { autoHandler } = require('knifecycle');
 const path = require('path');
-const {
-  identity,
-  buildMetapakModulePath,
-  mapConfigsSequentially,
-} = require('./utils');
+const { identity, mapConfigsSequentially } = require('./utils');
 
 module.exports = autoHandler(initBuildPackageAssets);
 
 async function initBuildPackageAssets(
-  { PROJECT_DIR, fs, log, glob, require, mkdirp },
+  { PROJECT_DIR, fs, log, glob, require, mkdirp, resolveModule },
   packageConf,
   metapakModulesSequence,
   metapakModulesConfigs
@@ -18,18 +14,15 @@ async function initBuildPackageAssets(
     metapakModulesSequence,
     metapakModulesConfigs,
     (metapakModuleName, metapakModuleConfig) => {
-      const packageAssetsDir = buildMetapakModulePath(
-        PROJECT_DIR,
-        packageConf,
-        metapakModuleName,
+      const modulePath = resolveModule(metapakModuleName);
+      const packageAssetsDir = path.join(
+        modulePath,
         'src',
         metapakModuleConfig,
         'assets'
       );
-      const packageAssetsTransformerPath = buildMetapakModulePath(
-        PROJECT_DIR,
-        packageConf,
-        metapakModuleName,
+      const packageAssetsTransformerPath = path.join(
+        modulePath,
         'src',
         metapakModuleConfig,
         'assets.js'

diff --git a/src/assets.mocha.js b/src/assets.mocha.js
@@ -41,6 +41,12 @@ describe('buildPackageAssets', () => {
       })
     );
     $.register(constant('require', requireStub));
+    $.register(
+      constant(
+        'resolveModule',
+        moduleName => `project/dir/node_modules/${moduleName}`
+      )
+    );
     $.register(initBuildPackageAssets);
   });
 

diff --git a/src/gitHooks.js b/src/gitHooks.js
@@ -1,17 +1,11 @@
-'use strict';
-
-const { autoHandler } = require('knifecycle');
-const {
-  buildMetapakModulePath,
-  mapConfigsSequentially,
-  identity,
-} = require('./utils');
 const path = require('path');
+const { autoHandler } = require('knifecycle');
+const { mapConfigsSequentially, identity } = require('./utils');
 
 module.exports = autoHandler(initBuildPackageGitHooks);
 
 async function initBuildPackageGitHooks(
-  { ENV, PROJECT_DIR, GIT_HOOKS_DIR, fs, os, log, require },
+  { ENV, PROJECT_DIR, GIT_HOOKS_DIR, fs, os, log, require, resolveModule },
   packageConf,
   metapakModulesSequence,
   metapakModulesConfigs
@@ -31,10 +25,8 @@ async function initBuildPackageGitHooks(
     metapakModulesSequence,
     metapakModulesConfigs,
     (metapakModuleName, metapakModuleConfig) => {
-      const packageHooksPath = buildMetapakModulePath(
-        PROJECT_DIR,
-        packageConf,
-        metapakModuleName,
+      const packageHooksPath = path.join(
+        resolveModule(metapakModuleName),
         'src',
         metapakModuleConfig,
         'hooks.js'

diff --git a/src/gitHooks.mocha.js b/src/gitHooks.mocha.js
@@ -32,6 +32,12 @@ describe('buildPackageGitHooks', () => {
       })
     );
     $.register(constant('require', requireStub));
+    $.register(
+      constant(
+        'resolveModule',
+        moduleName => `/home/whoiam/project/dir/node_modules/${moduleName}`
+      )
+    );
     $.register(initBuildPackageGitHooks);
   });
 

diff --git a/src/metapak.js b/src/metapak.js
@@ -1,10 +1,7 @@
-'use strict';
-
 const path = require('path');
 const Promise = require('bluebird');
 const YError = require('yerror');
 const { autoService } = require('knifecycle');
-const { buildMetapakModulePath } = require('./utils');
 
 const MAX_PACKAGE_BUILD_ITERATIONS = 15;
 
@@ -19,6 +16,7 @@ async function initMetapak({
   buildPackageConf,
   buildPackageAssets,
   buildPackageGitHooks,
+  resolveModule,
 }) {
   return async function metapak() {
     return _loadJSONFile({ fs }, path.join(PROJECT_DIR, 'package.json'))
@@ -49,9 +47,9 @@ async function initMetapak({
             fs,
             log,
           },
-          packageConf,
           metapakModulesSequence,
-          metapackConfigsSequence
+          metapackConfigsSequence,
+          resolveModule
         )
           .then(metapakModulesConfigs =>
             Promise.all([
@@ -187,23 +185,18 @@ function _reorderMetapakModulesNames(
 }
 
 function _getPackageMetapakModulesConfigs(
-  { PROJECT_DIR, fs, log },
-  packageConf,
+  { fs, log },
   metapakModulesSequence,
-  metapackConfigsSequence
+  metapackConfigsSequence,
+  resolveModule
 ) {
   return Promise.props(
     metapakModulesSequence.reduce(
       (metapakModulesConfigs, metapakModuleName) => {
+        const modulePath = path.join(resolveModule(metapakModuleName), 'src');
+
         metapakModulesConfigs[metapakModuleName] = fs
-          .readdirAsync(
-            buildMetapakModulePath(
-              PROJECT_DIR,
-              packageConf,
-              metapakModuleName,
-              'src'
-            )
-          )
+          .readdirAsync(modulePath)
           .then(metapakModuleConfigs => {
             metapakModuleConfigs = metapackConfigsSequence.filter(
               metapakModuleConfig =>

diff --git a/src/metapak.mocha.js b/src/metapak.mocha.js
@@ -29,6 +29,12 @@ describe('metapak', () => {
     $.register(constant('log', sinon.stub()));
     $.register(constant('exit', sinon.stub()));
     $.register(constant('PROJECT_DIR', 'project/dir'));
+    $.register(
+      constant(
+        'resolveModule',
+        moduleName => `project/dir/node_modules/${moduleName}`
+      )
+    );
     buildPackageConfStub = sinon.stub();
     $.register(constant('buildPackageConf', buildPackageConfStub));
     buildPackageAssetsStub = sinon.stub();

diff --git a/src/packageConf.js b/src/packageConf.js
@@ -4,19 +4,14 @@ const sortKeys = require('sort-keys');
 // when supporting only Node 10+
 const isDeepStrictEqual = require('deep-strict-equal');
 const path = require('path');
-const {
-  buildMetapakModulePath,
-  mapConfigsSequentially,
-  identity,
-  buildDiff,
-} = require('./utils');
+const { mapConfigsSequentially, identity, buildDiff } = require('./utils');
 
 const METAPAK_SCRIPT = 'metapak';
 
 module.exports = autoHandler(initBuildPackageConf);
 
 async function initBuildPackageConf(
-  { ENV, PROJECT_DIR, fs, require, log },
+  { ENV, PROJECT_DIR, fs, require, log, resolveModule },
   packageConf,
   metapakModulesSequence,
   metapakModulesConfigs
@@ -28,10 +23,8 @@ async function initBuildPackageConf(
     metapakModulesSequence,
     metapakModulesConfigs,
     async (metapakModuleName, metapakModuleConfig) => {
-      const packageTransformPath = buildMetapakModulePath(
-        PROJECT_DIR,
-        packageConf,
-        metapakModuleName,
+      const packageTransformPath = path.join(
+        resolveModule(metapakModuleName),
         'src',
         metapakModuleConfig,
         'package.js'

diff --git a/src/packageConf.mocha.js b/src/packageConf.mocha.js
@@ -30,6 +30,12 @@ describe('buildPackageConf', () => {
       })
     );
     $.register(constant('require', requireStub));
+    $.register(
+      constant(
+        'resolveModule',
+        moduleName => `project/dir/node_modules/${moduleName}`
+      )
+    );
     $.register(initBuildPackageConf);
   });
 

diff --git a/src/resolveModule.js b/src/resolveModule.js
@@ -0,0 +1,15 @@
+const YError = require('yerror');
+const path = require('path');
+const { autoService } = require('knifecycle');
+
+module.exports = autoService(initResolveModule);
+
+async function initResolveModule() {
+  return function resolveModule(metapakModuleName) {
+    try {
+      return path.dirname(require.resolve(`${metapakModuleName}/package`));
+    } catch (err) {
+      throw YError.wrap(err, 'E_MODULE_NOT_FOUND', metapakModuleName);
+    }
+  };
+}
diff --git a/src/runMetapak.js b/src/runMetapak.js
@@ -1,5 +1,3 @@
-'use strict';
-
 const {
   default: Knifecycle,
   constant,
@@ -22,6 +20,7 @@ const initBuildPackageConf = require('../src/packageConf');
 const initBuildPackageAssets = require('../src/assets');
 const initBuildPackageGitHooks = require('../src/gitHooks');
 const initProjectDir = require('../src/projectDir');
+const initResolveModule = require('../src/resolveModule');
 
 module.exports = { runMetapak, prepareMetapak };
 
@@ -62,6 +61,7 @@ async function prepareMetapak($ = new Knifecycle()) {
   $.register(initBuildPackageConf);
   $.register(initBuildPackageAssets);
   $.register(initBuildPackageGitHooks);
+  $.register(initResolveModule);
 
   program
     .version(require(path.join(__dirname, '..', 'package.json')).version)

diff --git a/src/utils.js b/src/utils.js
@@ -1,31 +1,12 @@
-const path = require('path');
 const chalk = require('chalk');
 const diff = require('diff');
 
 module.exports = {
   identity: x => x,
-  buildMetapakModulePath,
   mapConfigsSequentially,
   buildDiff,
 };
 
-function buildMetapakModulePath(
-  PROJECT_DIR,
-  packageConf,
-  metapakModuleName,
-  ...parts
-) {
-  // Take in count the edge case of self applying metapak module
-  parts = [PROJECT_DIR]
-    .concat(
-      packageConf.name !== metapakModuleName
-        ? ['node_modules', metapakModuleName]
-        : []
-    )
-    .concat(parts);
-  return path.join(...parts);
-}
-
 async function mapConfigsSequentially(
   metapakModulesSequence,
   metapakModulesConfigs,