fix: delay addon discovery until we know it will be needed (i.e. the addon will be built)

This allows us to always load devDeps as addons. We used to only load devDeps for root builders, but
that becomes problematic for addons that are build on the fly, i.e. symlinked or git dep addons. SO
now we always load devDeps for an addon that is being built, since if the addon its being built, it
will likely need any devDep addons like language compilers

Author: davewasmer

lib/builders/base.ts

@@ -67,7 +67,7 @@ export default class BaseBuilder {
 
   unitTestDir = path.join('test', 'unit');
 
-  packageFiles = [ 'package.json' ];
+  packageFiles: string[] = [];
 
   private _cachedTree: Tree;
 
@@ -91,22 +91,22 @@ export default class BaseBuilder {
     this.debug = createDebug(`denali-cli:builder:${ this.logicalDependencyPath.join('>') }`);
     this.debug(`created builder for ${ this.pkg.name }@${ this.pkg.version }`);
 
-    this.addons = this.discoverAddons();
   }
 
   /**
    * Look for addons in the node_modules folder. Only search packages explicitly
    * mentioned in package.json, and look for the `denali-addon` keyword in their
    * package.json's. Then create a Builder for each one.
    */
-  protected discoverAddons(): AddonBuilder[] {
+  protected discoverAddons(options: { include: string[] } = { include: [] }): AddonBuilder[] {
     this.debug(`searching for child addons in ${ this.dir }`);
     return findPlugins({
       dir: this.dir,
       keyword: 'denali-addon',
       sort: true,
-      includeDev: !this.parent, // only include devdeps if this is the root builder
-      configName: 'denali'
+      includeDev: true,
+      configName: 'denali',
+      include: options.include
     }).map((addon) => {
       this.debug(`discovered child addon: ${ addon.pkg.name }`);
       return <AddonBuilder>BaseBuilder.createFor(addon.dir, this.environment, this);
@@ -134,6 +134,7 @@ export default class BaseBuilder {
    * Assemble the main build pipeline
    */
   assembleTree() {
+    this.addons = this.discoverAddons();
     let baseTree = this.toBaseTree();
     let finalTrees: Tree[] = [];
 

lib/builders/dummy.ts

@@ -1,15 +1,24 @@
 import * as path from 'path';
+import * as fs from 'fs';
+import * as assert from 'assert';
 import AppBuilder from './app';
 import AddonBuilder from './addon';
 import * as MergeTree from 'broccoli-merge-trees';
+import * as writeFile from 'broccoli-file-creator';
 import * as Funnel from 'broccoli-funnel';
 
 export default class DummyBuilder extends AppBuilder {
 
+  packageFiles = [ 'package.json' ];
+
   addonBuilderUnderTest: AddonBuilder;
 
+  get addonDirUnderTest() {
+    return path.join(this.dir, '..', '..');
+  }
+
   discoverAddons(): AddonBuilder[] {
-    let addons = super.discoverAddons();
+    let addons = super.discoverAddons({ include: [ this.addonDirUnderTest ] });
     this.flagAddonUnderTest(addons);
     return addons;
   }
@@ -23,8 +32,8 @@ export default class DummyBuilder extends AppBuilder {
    * We should find a better way to detect the addon under test.
    */
   protected flagAddonUnderTest(addons: AddonBuilder[]) {
-    let dirForAddonUnderTest = path.join(this.dir, '..', '..');
-    this.addonBuilderUnderTest = addons.find((addonBuilder) => addonBuilder.dir === dirForAddonUnderTest);
+    this.addonBuilderUnderTest = addons.find((addonBuilder) => addonBuilder.dir === this.addonDirUnderTest);
+    assert(this.addonBuilderUnderTest, 'Unable to find the builder for the addon under test');
     this.addonBuilderUnderTest.underTest = true;
   }
 
@@ -51,11 +60,14 @@ export default class DummyBuilder extends AppBuilder {
     // should work automatically, since node will walk up from tmp/-dummy to
     // find the addon's real node_modules folder, and check there. But this
     // won't work for the addon itself, hence:
+    let addonPackageFiles = [ 'denali-build.js', 'package.json' ].map((file) => {
+      return writeFile(path.join('node_modules', this.addonBuilderUnderTest.pkg.name, file), fs.readFileSync(path.join(this.addonBuilderUnderTest.dir, file), 'utf-8'));
+    });
     let compiledAddon = new Funnel(addonTree, {
       exclude: [ 'test' ],
-      destDir: `node_modules/${this.addonBuilderUnderTest.pkg.name}`
+      destDir: `node_modules/${this.addonBuilderUnderTest.pkg.name}/dist`
     });
-    return new MergeTree([ tree, addonTests, compiledAddon ], { annotation: 'merge addon tests into dummy' });
+    return new MergeTree([ tree, addonTests, ...addonPackageFiles, compiledAddon ], { overwrite: true, annotation: 'merge addon tests into dummy' });
   }
 
 }