@teambit/workspace 1.0.1135 → 1.0.1136

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace",
-  "version": "1.0.1135",
+  "version": "1.0.1136",
   "homepage": "https://bit.cloud/teambit/workspace/workspace",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace",
-    "version": "1.0.1135"
+    "version": "1.0.1136"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -30,41 +30,24 @@
     "reset-css": "5.0.1",
     "@teambit/component-id": "1.2.4",
     "@teambit/harmony": "0.4.12",
-    "@teambit/legacy.extension-data": "0.0.152",
-    "@teambit/legacy.scope": "0.0.150",
     "@teambit/component-version": "1.0.4",
-    "@teambit/legacy.consumer-component": "0.0.151",
-    "@teambit/legacy.consumer": "0.0.150",
     "@teambit/bit-error": "0.0.404",
     "@teambit/lane-id": "0.0.312",
-    "@teambit/legacy.bit-map": "0.0.207",
     "@teambit/toolbox.fs.last-modified": "0.0.19",
     "@teambit/toolbox.path.path": "0.0.21",
     "@teambit/graph.cleargraph": "0.0.11",
-    "@teambit/logger": "0.0.1470",
-    "@teambit/cli": "0.0.1377",
-    "@teambit/config-store": "0.0.258",
     "@teambit/legacy.constants": "0.0.42",
     "@teambit/component.ui.component-status-resolver": "0.0.510",
     "@teambit/harmony.modules.load-trace": "0.0.13",
     "@teambit/harmony.modules.resolved-component": "0.0.525",
     "@teambit/legacy.utils": "0.0.49",
-    "@teambit/scope.remotes": "0.0.150",
-    "@teambit/config": "0.0.1552",
     "@teambit/harmony.modules.requireable-component": "0.0.525",
     "@teambit/toolbox.modules.module-resolver": "0.0.24",
-    "@teambit/workspace.modules.node-modules-linker": "0.0.381",
-    "@teambit/global-config": "0.0.1381",
-    "@teambit/legacy.consumer-config": "0.0.150",
-    "@teambit/variants": "0.0.1645",
     "@teambit/component-issues": "0.0.184",
-    "@teambit/component.sources": "0.0.202",
     "@teambit/dependencies.modules.packages-excluder": "1.0.8",
     "@teambit/git.modules.git-executable": "0.0.43",
     "@teambit/harmony.modules.in-memory-cache": "0.0.46",
     "@teambit/legacy-bit-id": "1.1.3",
-    "@teambit/legacy.component-list": "0.0.204",
-    "@teambit/legacy.scope-api": "0.0.205",
     "@teambit/toolbox.path.is-path-inside": "0.0.513",
     "@teambit/workspace.modules.match-pattern": "0.0.533",
     "@teambit/component.ui.component-drawer": "0.0.503",
@@ -101,23 +84,40 @@
     "@teambit/workspace.hooks.use-url-change-broadcaster": "0.0.2",
     "@teambit/workspace.ui.preserve-workspace-mode": "0.0.3",
     "@teambit/evangelist.elements.icon": "1.0.5",
-    "@teambit/component": "1.0.1135",
-    "@teambit/dependency-resolver": "1.0.1135",
-    "@teambit/envs": "1.0.1135",
-    "@teambit/objects": "0.0.642",
-    "@teambit/scope": "1.0.1135",
-    "@teambit/graph": "1.0.1135",
-    "@teambit/isolator": "1.0.1135",
-    "@teambit/component-tree": "1.0.1135",
-    "@teambit/watcher": "1.0.1135",
-    "@teambit/aspect-loader": "1.0.1135",
-    "@teambit/graphql": "1.0.1135",
-    "@teambit/bundler": "1.0.1135",
-    "@teambit/ui": "1.0.1135",
-    "@teambit/command-bar": "1.0.1135",
-    "@teambit/sidebar": "1.0.1135",
-    "@teambit/pubsub": "1.0.1135",
-    "@teambit/deprecation": "1.0.1135"
+    "@teambit/component": "1.0.1136",
+    "@teambit/dependency-resolver": "1.0.1136",
+    "@teambit/envs": "1.0.1136",
+    "@teambit/legacy.extension-data": "0.0.153",
+    "@teambit/legacy.scope": "0.0.151",
+    "@teambit/legacy.consumer-component": "0.0.152",
+    "@teambit/legacy.consumer": "0.0.151",
+    "@teambit/legacy.bit-map": "0.0.208",
+    "@teambit/logger": "0.0.1471",
+    "@teambit/objects": "0.0.643",
+    "@teambit/scope": "1.0.1136",
+    "@teambit/graph": "1.0.1136",
+    "@teambit/cli": "0.0.1378",
+    "@teambit/config-store": "0.0.259",
+    "@teambit/isolator": "1.0.1136",
+    "@teambit/component-tree": "1.0.1136",
+    "@teambit/watcher": "1.0.1136",
+    "@teambit/scope.remotes": "0.0.151",
+    "@teambit/aspect-loader": "1.0.1136",
+    "@teambit/config": "0.0.1553",
+    "@teambit/workspace.modules.node-modules-linker": "0.0.382",
+    "@teambit/graphql": "1.0.1136",
+    "@teambit/bundler": "1.0.1136",
+    "@teambit/global-config": "0.0.1382",
+    "@teambit/legacy.consumer-config": "0.0.151",
+    "@teambit/ui": "1.0.1136",
+    "@teambit/variants": "0.0.1646",
+    "@teambit/component.sources": "0.0.203",
+    "@teambit/legacy.component-list": "0.0.205",
+    "@teambit/legacy.scope-api": "0.0.206",
+    "@teambit/command-bar": "1.0.1136",
+    "@teambit/sidebar": "1.0.1136",
+    "@teambit/pubsub": "1.0.1136",
+    "@teambit/deprecation": "1.0.1136"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",

package/workspace-component/workspace-component-loader.ts

@@ -29,6 +29,7 @@ import {
   reportLoadFailure,
 } from '@teambit/harmony.modules.load-trace';
 import type { AspectLoaderMain } from '@teambit/aspect-loader';
+import { AsyncLocalStorage } from 'async_hooks';
 import type { Workspace } from '../workspace';
 import { WorkspaceComponent } from './workspace-component';
 import { MergeConfigConflict } from '../exceptions/merge-config-conflict';
@@ -110,6 +111,17 @@ export class WorkspaceComponentLoader {
   }>;
 
   private componentLoadedSelfAsAspects: InMemoryCache<boolean>; // cache loaded components
+
+  /**
+   * ids being loaded through the getMany pipeline within the current async call-chain, on behalf
+   * of a single `get` call. a re-entrant `get` of the same id from inside that pipeline (e.g. an
+   * onLoad subscriber asking for the component it's calculating) must use the direct flow,
+   * otherwise it recurses forever. an unrelated concurrent `get` of the same id is not part of
+   * the chain and awaits the in-flight load (singleLoadsInFlight) instead.
+   * see shouldDelegateToGetMany and loadOneThroughGetMany.
+   */
+  private singleLoadChainContext = new AsyncLocalStorage<Set<string>>();
+  private singleLoadsInFlight = new Map<string, Promise<Component | undefined>>();
   constructor(
     private workspace: Workspace,
     private logger: Logger,
@@ -849,8 +861,14 @@ export class WorkspaceComponentLoader {
       return fromCache;
     }
     span.setAttribute('componentsCache', 'miss');
-    let consumerComponent = legacyComponent;
     const inWs = await this.isInWsIncludeDeleted(id);
+    if (!legacyComponent && this.shouldDelegateToGetMany(id, inWs, useCache, storeInCache, loadOpts)) {
+      const fromGetMany = await this.loadOneThroughGetMany(id);
+      if (fromGetMany) return fromGetMany;
+      // the grouped pipeline didn't yield the component (e.g. an out-of-sync id changed during
+      // the load). fall through so the flow below reports the precise error for the requested id.
+    }
+    let consumerComponent = legacyComponent;
     if (inWs && !consumerComponent) {
       consumerComponent = await loadSpan('consumer-fs-load', { id: id.toString() }, () =>
         this.getConsumerComponent(id, loadOptsWithDefaults)
@@ -868,6 +886,67 @@ export class WorkspaceComponentLoader {
     return component;
   }
 
+  /**
+   * a cold single-component load resolves the component's env lazily in the middle of its own
+   * load, without the env-first group ordering of the getMany pipeline (see buildLoadGroups).
+   * when the env fails to load at that point, dependency policies silently fall back to defaults,
+   * producing a component with wrong dependency data (which then surfaces as phantom
+   * modifications in status/diff/merge). to keep one source of truth, a plain cache-miss load of
+   * a workspace component is delegated to the grouped pipeline.
+   */
+  private shouldDelegateToGetMany(
+    id: ComponentID,
+    inWs: boolean,
+    useCache: boolean,
+    storeInCache: boolean,
+    loadOpts?: ComponentLoadOptions
+  ): boolean {
+    if (!inWs) return false; // scope components load from the model, no dependency-policy calculation
+    if (!useCache || !storeInCache) return false; // getMany always uses and populates the cache
+    // any custom load-option means a caller-specific contract (partial load, docs/compositions
+    // flags, etc.). the getMany pipeline manages these options itself per load-stage, so only a
+    // plain full load can be delegated.
+    const isDefaultLoadOpts =
+      !loadOpts ||
+      Object.entries(loadOpts).every(
+        ([key, value]) =>
+          value === undefined || ((key === 'loadExtensions' || key === 'executeLoadSlot') && value === true)
+      );
+    if (!isDefaultLoadOpts) return false;
+    // re-entrance from within the pipeline of the same id (e.g. an onLoad subscriber asking for
+    // the component it's calculating) must use the direct flow, otherwise it recurses forever.
+    return !this.singleLoadChainContext.getStore()?.has(id.toString());
+  }
+
+  private async loadOneThroughGetMany(id: ComponentID): Promise<Component | undefined> {
+    const idStr = id.toString();
+    // an unrelated concurrent load of the same id joins the in-flight grouped load, rather than
+    // being mistaken for pipeline re-entrance and sent through the direct flow.
+    const inFlight = this.singleLoadsInFlight.get(idStr);
+    if (inFlight) return inFlight;
+    const chainIds = this.singleLoadChainContext.getStore() ?? new Set<string>();
+    // the promise is created inside run() so the whole load executes within the chain context.
+    // (assigned via `let` because some @types/node versions type `run` as returning void)
+    let loadPromise!: Promise<Component | undefined>;
+    this.singleLoadChainContext.run(new Set([...chainIds, idStr]), () => {
+      loadPromise = this.getMany([id]).then(({ components }) => {
+        if (components.length === 1) return components[0];
+        // the load may have fixed an out-of-sync .bitmap and changed the component-id in the
+        // process (e.g. a stale version was removed or bumped). in that case getMany filtered the
+        // component out because it no longer matches the requested id. look it up by its updated
+        // .bitmap id.
+        const updatedBitmapId = this.workspace.consumer.bitmapIdsFromCurrentLaneIncludeRemoved.searchWithoutVersion(id);
+        if (updatedBitmapId && updatedBitmapId.version !== id.version) {
+          return this.getFromCache(updatedBitmapId, { loadExtensions: true, executeLoadSlot: true });
+        }
+        return undefined;
+      });
+    });
+    const withCleanup = loadPromise.finally(() => this.singleLoadsInFlight.delete(idStr));
+    this.singleLoadsInFlight.set(idStr, withCleanup);
+    return withCleanup;
+  }
+
   async getIfExist(componentId: ComponentID) {
     try {
       return await this.get(componentId);