Harmony/merge extension simple config (#2552)

* write configs added by extensions into package.json in the component capsule
* add stub tests for configs
* export component factory extension from api
* related to #2456
* related to #2537

e2e/fixtures/extensions/extension-add-config/simple-config/index.js

@@ -0,0 +1 @@
+module.exports = require('./simple-config.manifest');

e2e/fixtures/extensions/extension-add-config/simple-config/simple-config.manifest.js

@@ -0,0 +1,15 @@
+const ComponentFactoryExt = require('bit-bin').ComponentFactoryExt;
+
+module.exports = {
+  name: 'simple config',
+  dependencies: [ComponentFactoryExt],
+  provider: async ([component]) => {
+    console.log('simple config runs');
+    component.registerAddConfig('simple-config', config => {
+      console.log('config registration hook is running');
+      return {
+        'my-custom-key': 'my-custom-val'
+      };
+    });
+  }
+};

src/api.ts

@@ -5,6 +5,8 @@ import Extension from './legacy-extensions/extension';
 import HooksManager from './hooks';
 import { BaseLoadArgsProps } from './legacy-extensions/base-extension';
 
+export { ComponentFactoryExt, ComponentFactory } from './extensions/component';
+
 HooksManager.init();
 
 export * from '@teambit/harmony';

src/api/consumer/lib/isolate.ts

@@ -34,6 +34,7 @@ export default (async function isolate(
 });
 
 async function isolateUsingCapsule(componentId: string, opts: IsolateOptions) {
+  opts.applyExtensionsAddedConfig = true;
   const consumer = await loadConsumer();
   const bitId = consumer.getParsedId(componentId);
   const isolator: Isolator = await Isolator.getInstance('fs', consumer.scope, consumer, opts.writeToPath);

src/consumer/component-ops/component-writer.ts

@@ -36,6 +36,7 @@ export type ComponentWriterProps = {
   existingComponentMap?: ComponentMap;
   excludeRegistryPrefix?: boolean;
   capsulePaths?: CapsulePaths;
+  applyExtensionsAddedConfig?: boolean;
 };
 
 export default class ComponentWriter {
@@ -53,6 +54,7 @@ export default class ComponentWriter {
   existingComponentMap: ComponentMap | undefined;
   excludeRegistryPrefix: boolean;
   capsulePaths?: CapsulePaths;
+  applyExtensionsAddedConfig?: boolean;
   constructor({
     component,
     writeToPath,
@@ -67,7 +69,8 @@ export default class ComponentWriter {
     deleteBitDirContent,
     existingComponentMap,
     capsulePaths,
-    excludeRegistryPrefix = false
+    excludeRegistryPrefix = false,
+    applyExtensionsAddedConfig = false
   }: ComponentWriterProps) {
     this.component = component;
     this.writeToPath = writeToPath;
@@ -83,6 +86,7 @@ export default class ComponentWriter {
     this.existingComponentMap = existingComponentMap;
     this.excludeRegistryPrefix = excludeRegistryPrefix;
     this.capsulePaths = capsulePaths;
+    this.applyExtensionsAddedConfig = applyExtensionsAddedConfig;
   }
 
   static getInstance(componentWriterProps: ComponentWriterProps): ComponentWriter {
@@ -168,6 +172,9 @@ export default class ComponentWriter {
       componentConfig.compiler = this.component.compiler ? this.component.compiler.toBitJsonObject() : {};
       componentConfig.tester = this.component.tester ? this.component.tester.toBitJsonObject() : {};
       packageJson.addOrUpdateProperty('bit', componentConfig.toPlainObject());
+      if (this.applyExtensionsAddedConfig) {
+        this._mergePackageJsonPropsFromExtensions(packageJson);
+      }
       this._mergeChangedPackageJsonProps(packageJson);
       this._mergePackageJsonPropsFromOverrides(packageJson);
       this.component.dataToPersist.addFile(packageJson.toVinylFile());
@@ -205,6 +212,17 @@ export default class ComponentWriter {
     });
   }
 
+  /**
+   * these changes were added by extensions
+   */
+  _mergePackageJsonPropsFromExtensions(packageJson: PackageJsonFile) {
+    // The special keys will be merged in other place
+    const specialKeys = ['extensions', 'dependencies', 'devDependencies', 'peerDependencies'];
+    if (!this.component.extensionsAddedConfig || R.isEmpty(this.component.extensionsAddedConfig)) return;
+    const valuesToMerge = R.omit(specialKeys, this.component.extensionsAddedConfig);
+    packageJson.mergePackageJsonObject(valuesToMerge);
+  }
+
   /**
    * these changes were entered manually by a user via `overrides` key
    */

src/consumer/component-ops/many-components-writer.ts

@@ -44,6 +44,7 @@ export interface ManyComponentsWriterParams {
   installProdPackagesOnly?: boolean;
   excludeRegistryPrefix?: boolean;
   capsulePaths?: CapsulePaths;
+  applyExtensionsAddedConfig?: boolean;
 }
 
 /**
@@ -83,6 +84,8 @@ export default class ManyComponentsWriter {
   basePath?: string;
   capsulePaths?: CapsulePaths;
   pacackgeManager?: string;
+  // Apply config added by extensions
+  applyExtensionsAddedConfig?: boolean;
 
   constructor(params: ManyComponentsWriterParams) {
     this.consumer = params.consumer;
@@ -107,6 +110,7 @@ export default class ManyComponentsWriter {
     this.bitMap = this.consumer ? this.consumer.bitMap : new BitMap();
     this.capsulePaths = params.capsulePaths;
     this.pacackgeManager = params.packageManager;
+    this.applyExtensionsAddedConfig = params.applyExtensionsAddedConfig;
     if (this.consumer && !this.isolated) this.basePath = this.consumer.getPath();
   }
   _setBooleanDefault(field: boolean | null | undefined, defaultValue: boolean): boolean {
@@ -224,6 +228,7 @@ export default class ManyComponentsWriter {
       consumer: this.consumer,
       bitMap: this.bitMap,
       isolated: this.isolated,
+      applyExtensionsAddedConfig: this.applyExtensionsAddedConfig,
       excludeRegistryPrefix: this.excludeRegistryPrefix
     };
   }

src/environment/environment.ts

@@ -71,7 +71,8 @@ export default class Environment {
       installProdPackagesOnly: opts.installProdPackagesOnly,
       verbose: opts.verbose,
       excludeRegistryPrefix: !!opts.excludeRegistryPrefix,
-      silentPackageManagerResult: opts.silentPackageManagerResult
+      silentPackageManagerResult: opts.silentPackageManagerResult,
+      applyExtensionsAddedConfig: opts.applyExtensionsAddedConfig
     };
     const manyComponentsWriter = new ManyComponentsWriter(concreteOpts);
     await manyComponentsWriter.writeAll();

src/environment/isolator.ts

@@ -43,6 +43,7 @@ export interface IsolateOptions {
   verbose?: boolean; // Print more logs
   excludeRegistryPrefix?: boolean; // exclude the registry prefix from the component's name in the package.json
   silentPackageManagerResult?: boolean; // Print environment install result
+  applyExtensionsAddedConfig?: boolean; // apply configs added by extension in the package.json
 }
 
 export default class Isolator {
@@ -119,6 +120,7 @@ export default class Isolator {
       verbose: opts.verbose,
       excludeRegistryPrefix: !!opts.excludeRegistryPrefix,
       silentPackageManagerResult: opts.silentPackageManagerResult,
+      applyExtensionsAddedConfig: opts.applyExtensionsAddedConfig,
       isolated: true
     };
     this.componentWithDependencies = componentWithDependencies;

src/extensions/isolator/write-components-to-capsules.ts

@@ -52,7 +52,8 @@ export default async function writeComponentsToCapsules(
     silentPackageManagerResult: false,
     isolated: true,
     capsulePaths,
-    packageManager
+    packageManager,
+    applyExtensionsAddedConfig: true
   };
   componentsWithDependencies.map(cmp => normalizeComponentDir(cmp));
   const manyComponentsWriter = new ManyComponentsWriter(concreteOpts);