@teambit/envs 1.0.493 → 1.0.495

package/dist/env-jsonc.detector.d.ts

@@ -0,0 +1,5 @@
+import { DependencyDetector, FileContext } from '@teambit/dependency-resolver';
+export declare class EnvJsoncDetector implements DependencyDetector {
+    isSupported(context: FileContext): boolean;
+    detect(source: string): string[];
+}

package/dist/env-jsonc.detector.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EnvJsoncDetector = void 0;
+function _commentJson() {
+  const data = require("comment-json");
+  _commentJson = function () {
+    return data;
+  };
+  return data;
+}
+class EnvJsoncDetector {
+  isSupported(context) {
+    return context.filename.endsWith('env.jsonc');
+  }
+  detect(source) {
+    const parsed = (0, _commentJson().parse)(source);
+    if (!parsed.extends) return [];
+    return [parsed.extends];
+  }
+}
+exports.EnvJsoncDetector = EnvJsoncDetector;
+
+//# sourceMappingURL=env-jsonc.detector.js.map

package/dist/env-jsonc.detector.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_commentJson","data","require","EnvJsoncDetector","isSupported","context","filename","endsWith","detect","source","parsed","parse","extends","exports"],"sources":["env-jsonc.detector.ts"],"sourcesContent":["import { parse } from 'comment-json';\nimport { DependencyDetector, FileContext } from '@teambit/dependency-resolver';\n\nexport class EnvJsoncDetector implements DependencyDetector {\n  isSupported(context: FileContext): boolean {\n    return context.filename.endsWith('env.jsonc');\n  }\n\n  detect(source: string): string[] {\n    const parsed = parse(source);\n    if (!parsed.extends) return [];\n    return [parsed.extends];\n  }\n}\n"],"mappings":";;;;;;AAAA,SAAAA,aAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,YAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAGO,MAAME,gBAAgB,CAA+B;EAC1DC,WAAWA,CAACC,OAAoB,EAAW;IACzC,OAAOA,OAAO,CAACC,QAAQ,CAACC,QAAQ,CAAC,WAAW,CAAC;EAC/C;EAEAC,MAAMA,CAACC,MAAc,EAAY;IAC/B,MAAMC,MAAM,GAAG,IAAAC,oBAAK,EAACF,MAAM,CAAC;IAC5B,IAAI,CAACC,MAAM,CAACE,OAAO,EAAE,OAAO,EAAE;IAC9B,OAAO,CAACF,MAAM,CAACE,OAAO,CAAC;EACzB;AACF;AAACC,OAAA,CAAAV,gBAAA,GAAAA,gBAAA","ignoreList":[]}

package/dist/environments.main.runtime.d.ts

@@ -1,3 +1,4 @@
+import { Dependency as LegacyDependency } from '@teambit/legacy.consumer-component';
 import { SourceFile } from '@teambit/component.sources';
 import { CLIMain } from '@teambit/cli';
 import { Component, ComponentMain } from '@teambit/component';
@@ -16,14 +17,21 @@ import { Runtime } from './runtime';
 import { EnvDefinition } from './env-definition';
 import { EnvServiceList } from './env-service-list';
 import { EnvPlugin } from './env.plugin';
+import { EnvJsoncDetector } from './env-jsonc.detector';
 export type EnvJsonc = {
     extends?: string;
     policy?: EnvPolicyConfigObject;
     patterns?: EnvJsoncPatterns;
 };
+/**
+ * The resolved env jsonc is the env jsonc after it was resolved from all the parent envs
+ */
+export type ResolvedEnvJsonc = Omit<EnvJsonc, 'extends'>;
 export type EnvJsoncMergeCustomizer = (parentObj: EnvJsonc, childObj: EnvJsonc) => Partial<EnvJsonc>;
+export type EnvJsoncResolver = (parentId: string, envExtendsDeps?: LegacyDependency[]) => Promise<ResolvedEnvJsonc>;
 export type EnvsRegistry = SlotRegistry<Environment>;
 export type EnvJsoncMergeCustomizerRegistry = SlotRegistry<EnvJsoncMergeCustomizer>;
+export type EnvJsoncResolverRegistry = SlotRegistry<EnvJsoncResolver>;
 export type EnvsConfig = {
     env: string;
     options: EnvOptions;
@@ -42,6 +50,7 @@ export type RegularCompDescriptor = {
     description?: string;
 };
 export type EnvCompDescriptorProps = RegularCompDescriptor & {
+    resolvedEnvJsonc?: ResolvedEnvJsonc;
     services?: {
         env: {
             id: string;
@@ -81,6 +90,7 @@ export declare class EnvsMain {
     private loggerMain;
     private workerMain;
     private envJsoncMergeCustomizerSlot;
+    private envJsoncResolverSlot;
     /**
      * Envs that are failed to load
      */
@@ -114,7 +124,7 @@ export declare class EnvsMain {
     /**
      * slot for allowing extensions to register new environment.
      */
-    envSlot: EnvsRegistry, logger: Logger, servicesRegistry: ServicesRegistry, componentMain: ComponentMain, loggerMain: LoggerMain, workerMain: WorkerMain, envJsoncMergeCustomizerSlot: EnvJsoncMergeCustomizerRegistry);
+    envSlot: EnvsRegistry, logger: Logger, servicesRegistry: ServicesRegistry, componentMain: ComponentMain, loggerMain: LoggerMain, workerMain: WorkerMain, envJsoncMergeCustomizerSlot: EnvJsoncMergeCustomizerRegistry, envJsoncResolverSlot: EnvJsoncResolverRegistry);
     /**
      * creates a new runtime environments for a set of components.
      */
@@ -164,8 +174,10 @@ export declare class EnvsMain {
      * function returns `undefined`.
      */
     hasEnvManifest(envComponent?: Component, legacyFiles?: SourceFile[]): boolean | undefined;
-    getEnvManifest(envComponent?: Component, legacyFiles?: SourceFile[]): EnvJsonc | undefined;
-    recursivelyMergeWithParentManifest(object: EnvJsonc, originPath: string): EnvJsonc;
+    getEnvManifest(envComponent: Component): ResolvedEnvJsonc | undefined;
+    getOrCalculateEnvManifest(component: Component, legacyFiles?: SourceFile[], envExtendsDeps?: LegacyDependency[]): Promise<ResolvedEnvJsonc | undefined>;
+    calculateEnvManifest(envComponent?: Component, legacyFiles?: SourceFile[], envExtendsDeps?: LegacyDependency[]): Promise<EnvJsonc | undefined>;
+    recursivelyMergeWithParentManifest(object: EnvJsonc, envExtendsDeps?: LegacyDependency[]): Promise<EnvJsonc>;
     mergeEnvManifests(parent: EnvJsonc, child: EnvJsonc): EnvJsonc;
     hasEnvManifestById(envId: string, requesting: string): Promise<boolean | undefined>;
     getEnvData(component: Component): Descriptor;
@@ -202,6 +214,7 @@ export declare class EnvsMain {
      * This is safe to be used on onLoad as well
      */
     getOrCalculateEnv(component: Component): EnvDefinition;
+    getOrCalculateEnvId(component: Component): Promise<ComponentID>;
     /**
      * get an environment Descriptor.
      */
@@ -245,6 +258,7 @@ export declare class EnvsMain {
     getAllRegisteredEnvsIds(): string[];
     getAllRegisteredEnvs(): Environment[];
     getAllRegisteredEnvJsoncCustomizers(): EnvJsoncMergeCustomizer[];
+    getAllRegisteredEnvJsoncResolvers(): EnvJsoncResolver[];
     getEnvPlugin(): EnvPlugin;
     /**
      * an env can be configured on a component in two ways:
@@ -322,12 +336,14 @@ export declare class EnvsMain {
      * register an env.jsonc merge customizer.
      */
     registerEnvJsoncMergeCustomizer(customizer: EnvJsoncMergeCustomizer): void;
+    registerEnvJsoncResolver(resolver: EnvJsoncResolver): void;
+    getEnvJsoncDetector(): EnvJsoncDetector;
     addNonLoadedEnvAsComponentIssues(components: Component[]): Promise<void>;
     private createRuntime;
     private aggregateByDefs;
     private getEnvAspectDef;
     private throwForDuplicateComponents;
-    static slots: (((registerFn: () => string) => SlotRegistry<Environment>) | ((registerFn: () => string) => SlotRegistry<EnvService<any, {}, {}>>) | ((registerFn: () => string) => SlotRegistry<EnvJsoncMergeCustomizerRegistry>))[];
+    static slots: (((registerFn: () => string) => SlotRegistry<Environment>) | ((registerFn: () => string) => SlotRegistry<EnvService<any, {}, {}>>) | ((registerFn: () => string) => SlotRegistry<EnvJsoncMergeCustomizerRegistry>) | ((registerFn: () => string) => SlotRegistry<EnvJsoncResolverRegistry>))[];
     static dependencies: import("@teambit/harmony").Aspect[];
     static provider([graphql, loggerAspect, component, cli, worker, issues]: [
         GraphqlMain,
@@ -336,10 +352,11 @@ export declare class EnvsMain {
         CLIMain,
         WorkerMain,
         IssuesMain
-    ], config: EnvsConfig, [envSlot, servicesRegistry, envJsoncMergeCustomizerSlot]: [
+    ], config: EnvsConfig, [envSlot, servicesRegistry, envJsoncMergeCustomizerSlot, envJsoncResolverSlot]: [
         EnvsRegistry,
         ServicesRegistry,
-        EnvJsoncMergeCustomizerRegistry
+        EnvJsoncMergeCustomizerRegistry,
+        EnvJsoncResolverRegistry
     ], context: Harmony): Promise<EnvsMain>;
 }
 export {};

package/dist/environments.main.runtime.js

@@ -4,34 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.EnvsMain = exports.DEFAULT_ENV = void 0;
-function _path() {
-  const data = require("path");
-  _path = function () {
-    return data;
-  };
-  return data;
-}
-function _findRoot() {
-  const data = _interopRequireDefault(require("find-root"));
-  _findRoot = function () {
-    return data;
-  };
-  return data;
-}
-function _toolboxModules() {
-  const data = require("@teambit/toolbox.modules.module-resolver");
-  _toolboxModules = function () {
-    return data;
-  };
-  return data;
-}
-function _fsExtra() {
-  const data = require("fs-extra");
-  _fsExtra = function () {
-    return data;
-  };
-  return data;
-}
 function _pLocate() {
   const data = _interopRequireDefault(require("p-locate"));
   _pLocate = function () {
@@ -200,12 +172,23 @@ function _env2() {
   };
   return data;
 }
+function _envJsonc() {
+  const data = require("./env-jsonc.detector");
+  _envJsonc = function () {
+    return data;
+  };
+  return data;
+}
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * The resolved env jsonc is the env jsonc after it was resolved from all the parent envs
+ */
+
 const DEFAULT_ENV = exports.DEFAULT_ENV = 'teambit.harmony/node';
 class EnvsMain {
   /**
@@ -228,7 +211,7 @@ class EnvsMain {
   /**
    * slot for allowing extensions to register new environment.
    */
-  envSlot, logger, servicesRegistry, componentMain, loggerMain, workerMain, envJsoncMergeCustomizerSlot) {
+  envSlot, logger, servicesRegistry, componentMain, loggerMain, workerMain, envJsoncMergeCustomizerSlot, envJsoncResolverSlot) {
     this.config = config;
     this.harmony = harmony;
     this.envSlot = envSlot;
@@ -238,6 +221,7 @@ class EnvsMain {
     this.loggerMain = loggerMain;
     this.workerMain = workerMain;
     this.envJsoncMergeCustomizerSlot = envJsoncMergeCustomizerSlot;
+    this.envJsoncResolverSlot = envJsoncResolverSlot;
     /**
      * Envs that are failed to load
      */
@@ -380,7 +364,19 @@ class EnvsMain {
     if (!envJson) return false;
     return true;
   }
-  getEnvManifest(envComponent, legacyFiles) {
+  getEnvManifest(envComponent) {
+    const data = this.getEnvData(envComponent);
+    if (!data) return undefined;
+    return data.resolvedEnvJsonc;
+  }
+  async getOrCalculateEnvManifest(component, legacyFiles, envExtendsDeps) {
+    try {
+      return this.getEnvManifest(component) || (await this.calculateEnvManifest(component, legacyFiles, envExtendsDeps));
+    } catch {
+      return this.calculateEnvManifest(component);
+    }
+  }
+  async calculateEnvManifest(envComponent, legacyFiles, envExtendsDeps) {
     // TODO: maybe throw an error here?
     if (!envComponent && !legacyFiles) return undefined;
     // @ts-ignore
@@ -390,29 +386,18 @@ class EnvsMain {
     });
     if (!envJson) return undefined;
     const object = (0, _commentJson().parse)(envJson.contents.toString('utf8'), undefined, true);
-    const resolvedObject = this.recursivelyMergeWithParentManifest(object, envJson.path);
+    if (!object.extends) return object;
+    const resolvedObject = await this.recursivelyMergeWithParentManifest(object, envExtendsDeps);
     return resolvedObject;
   }
-  recursivelyMergeWithParentManifest(object, originPath) {
+  async recursivelyMergeWithParentManifest(object, envExtendsDeps) {
     if (!object.extends) return object;
-    const parentPackageName = object.extends;
-    const parentPath = (0, _toolboxModules().resolveFrom)(originPath, [parentPackageName]);
-    const parentResolvedPath = (0, _findRoot().default)(parentPath);
-    if (!parentResolvedPath || !(0, _fsExtra().existsSync)(parentResolvedPath)) {
-      this.logger.info(`failed finding parent manifest for ${parentPackageName} at ${parentResolvedPath}`);
-    }
-    const parentEnvJsoncPath = ['env.jsonc', 'env.json'].map(fileName => (0, _path().join)(parentResolvedPath, fileName)).find(filePath => {
-      return (0, _fsExtra().existsSync)(filePath);
-    });
-    if (!parentEnvJsoncPath) {
-      this.logger.consoleWarning(`failed finding parent manifest for ${parentPackageName} at ${parentResolvedPath} referred from ${originPath}`);
-      return object;
-    }
-    const parentStr = (0, _fsExtra().readFileSync)(parentEnvJsoncPath).toString('utf8');
-    const parentObject = (0, _commentJson().parse)(parentStr, undefined, true);
+    const parentEnvId = object.extends;
+    const resolver = this.getAllRegisteredEnvJsoncResolvers()[0];
+    const parentObject = await resolver(parentEnvId, envExtendsDeps);
     const mergedObject = this.mergeEnvManifests(parentObject, object);
     if (mergedObject.extends) {
-      return this.recursivelyMergeWithParentManifest(mergedObject, parentEnvJsoncPath);
+      return this.recursivelyMergeWithParentManifest(mergedObject);
     }
     return mergedObject;
   }
@@ -423,6 +408,8 @@ class EnvsMain {
       const oneMerged = customizer(parent, child);
       merged = _objectSpread(_objectSpread({}, merged), oneMerged);
     }
+    // This is important to make sure we won't keep the extends from the child
+    delete child.extends;
     // Take extends specifically from the parent so we can propagate it to the next parent
     if (parent.extends) {
       merged.extends = parent.extends;
@@ -540,6 +527,14 @@ class EnvsMain {
       return this.calculateEnv(component);
     }
   }
+  getOrCalculateEnvId(component) {
+    try {
+      const idStr = this.getEnvId(component);
+      return Promise.resolve(_componentId().ComponentID.fromString(idStr));
+    } catch {
+      return this.calculateEnvId(component);
+    }
+  }
 
   /**
    * get an environment Descriptor.
@@ -553,9 +548,16 @@ class EnvsMain {
     const componentDescriptor = await this.getComponentEnvDescriptor(component, opts);
     if (!componentDescriptor) return undefined;
     const envComponentSelfDescriptor = await this.getEnvSelfDescriptor(component);
-    const result = envComponentSelfDescriptor ? _objectSpread(_objectSpread({}, componentDescriptor), {}, {
-      self: envComponentSelfDescriptor
-    }) : componentDescriptor;
+    // const resolvedEnvJsonc = await this.calculateEnvManifest(component);
+    const result = componentDescriptor;
+    if (envComponentSelfDescriptor) {
+      // @ts-ignore
+      result.self = envComponentSelfDescriptor;
+    }
+    // if (resolvedEnvJsonc) {
+    //   // @ts-ignore
+    //   result.resolvedEnvJsonc = resolvedEnvJsonc;
+    // }
     return result;
   }
 
@@ -742,6 +744,9 @@ class EnvsMain {
   getAllRegisteredEnvJsoncCustomizers() {
     return this.envJsoncMergeCustomizerSlot.toArray().map(customizerEntry => customizerEntry[1]);
   }
+  getAllRegisteredEnvJsoncResolvers() {
+    return this.envJsoncResolverSlot.toArray().map(resolver => resolver[1]);
+  }
   getEnvPlugin() {
     return new (_env2().EnvPlugin)(this.envSlot, this.servicesRegistry, this.loggerMain, this.workerMain, this.harmony);
   }
@@ -1043,6 +1048,12 @@ class EnvsMain {
   registerEnvJsoncMergeCustomizer(customizer) {
     return this.envJsoncMergeCustomizerSlot.register(customizer);
   }
+  registerEnvJsoncResolver(resolver) {
+    return this.envJsoncResolverSlot.register(resolver);
+  }
+  getEnvJsoncDetector() {
+    return new (_envJsonc().EnvJsoncDetector)();
+  }
   async addNonLoadedEnvAsComponentIssues(components) {
     await (0, _pMapSeries().default)(components, async component => {
       const envId = await this.calculateEnvId(component);
@@ -1112,9 +1123,9 @@ class EnvsMain {
       throw new Error(`found duplicated components: ${duplications.join(', ')}`);
     }
   }
-  static async provider([graphql, loggerAspect, component, cli, worker, issues], config, [envSlot, servicesRegistry, envJsoncMergeCustomizerSlot], context) {
+  static async provider([graphql, loggerAspect, component, cli, worker, issues], config, [envSlot, servicesRegistry, envJsoncMergeCustomizerSlot, envJsoncResolverSlot], context) {
     const logger = loggerAspect.createLogger(_environments().EnvsAspect.id);
-    const envs = new EnvsMain(config, context, envSlot, logger, servicesRegistry, component, loggerAspect, worker, envJsoncMergeCustomizerSlot);
+    const envs = new EnvsMain(config, context, envSlot, logger, servicesRegistry, component, loggerAspect, worker, envJsoncMergeCustomizerSlot, envJsoncResolverSlot);
     component.registerShowFragments([new (_env().EnvFragment)(envs)]);
     if (issues) issues.registerAddComponentsIssues(envs.addNonLoadedEnvAsComponentIssues.bind(envs));
     const envsCmd = new (_envs().EnvsCmd)(envs, component);
@@ -1126,7 +1137,7 @@ class EnvsMain {
 }
 exports.EnvsMain = EnvsMain;
 _defineProperty(EnvsMain, "runtime", _cli().MainRuntime);
-_defineProperty(EnvsMain, "slots", [_harmony().Slot.withType(), _harmony().Slot.withType(), _harmony().Slot.withType()]);
+_defineProperty(EnvsMain, "slots", [_harmony().Slot.withType(), _harmony().Slot.withType(), _harmony().Slot.withType(), _harmony().Slot.withType()]);
 _defineProperty(EnvsMain, "dependencies", [_graphql().GraphqlAspect, _logger().LoggerAspect, _component().ComponentAspect, _cli().CLIAspect, _worker().WorkerAspect, _issues().IssuesAspect]);
 _environments().EnvsAspect.addRuntime(EnvsMain);