@teambit/objects 0.0.726 → 0.0.728

package/models/scopeMeta.ts

@@ -4,7 +4,7 @@ import type Ref from '../objects/ref';
 
 type ScopeMetaProps = {
   name: string;
-  license: string;
+  license?: string | null;
 };
 
 // TODO: fix parse
@@ -39,13 +39,11 @@ export default class ScopeMeta extends BitObject {
   }
 
   static fromScopeName(name: string): Ref {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
     return ScopeMeta.fromObject({ name }).hash();
   }
 
   static parse(propsStr: string | Buffer): ScopeMeta {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-    return this.fromObject(JSON.parse(propsStr));
+    return this.fromObject(JSON.parse(propsStr.toString()));
   }
 
   static fromObject(props: ScopeMetaProps): ScopeMeta {

package/models/version.spec.ts

@@ -119,6 +119,27 @@ describe('Version', () => {
       expect(first.getLoadedFlattenedDependencies()).to.not.equal(second.getLoadedFlattenedDependencies());
       expect(first.getLoadedFlattenedDependencies()[0]).to.equal(second.getLoadedFlattenedDependencies()[0]);
     });
+    it('should share the same id and edge instances for flattenedEdges', () => {
+      const edgeFromObj1 = Version.depEdgeFromObject({
+        source: { scope: 'my-scope', name: 'comp-a', version: '0.0.1' },
+        target: { scope: 'my-scope', name: 'is-type', version: '0.0.1' },
+        type: 'prod',
+      });
+      const edgeFromObj2 = Version.depEdgeFromObject({
+        source: { scope: 'my-scope', name: 'comp-a', version: '0.0.1' },
+        target: { scope: 'my-scope', name: 'is-type', version: '0.0.1' },
+        type: 'prod',
+      });
+      expect(edgeFromObj1).to.equal(edgeFromObj2);
+      expect(edgeFromObj1.source).to.equal(edgeFromObj2.source);
+      expect(edgeFromObj1.target).to.equal(edgeFromObj2.target);
+
+      const edgeFromArr1 = Version.depEdgeFromArray(['my-scope/comp-a@0.0.1', 'my-scope/is-type@0.0.1', 'prod']);
+      const edgeFromArr2 = Version.depEdgeFromArray(['my-scope/comp-a@0.0.1', 'my-scope/is-type@0.0.1', 'prod']);
+      expect(edgeFromArr1).to.equal(edgeFromArr2);
+      expect(edgeFromArr1.source).to.equal(edgeFromArr2.source);
+      expect(edgeFromArr1.target).to.equal(edgeFromArr2.target);
+    });
     it('should keep a list that was set, and serialize it', () => {
       const version = getVersionWithDepsFixture();
       version.flattenedDependencies = new ComponentIdList(ComponentID.fromString('my-scope/is-type@0.0.3'));

package/models/version.ts

@@ -4,7 +4,7 @@ import { ComponentID, ComponentIdList } from '@teambit/component-id';
 import { LaneId } from '@teambit/lane-id';
 import { v4 } from 'uuid';
 import type { BuildStatus } from '@teambit/legacy.constants';
-import { DEFAULT_BUNDLE_FILENAME, Extensions } from '@teambit/legacy.constants';
+import { Extensions } from '@teambit/legacy.constants';
 import type { ConsumerComponent } from '@teambit/legacy.consumer-component';
 import {
   isSchemaSupport,
@@ -37,12 +37,17 @@ const flattenedIdsCache = new Map<string, Map<string, Map<string, ComponentID>>>
 const flattenedIdStrsCache = new Map<string, ComponentID>();
 const MAX_CACHED_FLATTENED_IDS = 100_000;
 let cachedFlattenedIds = 0;
+let flattenedEdgesCache = new WeakMap<ComponentID, Map<ComponentID, Map<DepEdgeType, DepEdge>>>();
+const MAX_CACHED_FLATTENED_EDGES = 100_000;
+let cachedFlattenedEdges = 0;
 
 function countCachedFlattenedId() {
   if (cachedFlattenedIds >= MAX_CACHED_FLATTENED_IDS) {
     flattenedIdsCache.clear();
     flattenedIdStrsCache.clear();
     cachedFlattenedIds = 0;
+    flattenedEdgesCache = new WeakMap();
+    cachedFlattenedEdges = 0;
   }
   cachedFlattenedIds += 1;
 }
@@ -77,6 +82,30 @@ function getFlattenedId(dep: string | Record<string, any>): ComponentID {
   return id;
 }
 
+function getFlattenedEdge(source: ComponentID, target: ComponentID, type: DepEdgeType): DepEdge {
+  if (cachedFlattenedEdges >= MAX_CACHED_FLATTENED_EDGES) {
+    flattenedEdgesCache = new WeakMap();
+    cachedFlattenedEdges = 0;
+  }
+  let byTarget = flattenedEdgesCache.get(source);
+  if (!byTarget) {
+    byTarget = new Map();
+    flattenedEdgesCache.set(source, byTarget);
+  }
+  let byType = byTarget.get(target);
+  if (!byType) {
+    byType = new Map();
+    byTarget.set(target, byType);
+  }
+  let edge = byType.get(type);
+  if (!edge) {
+    cachedFlattenedEdges += 1;
+    edge = { source, target, type };
+    byType.set(type, edge);
+  }
+  return edge;
+}
+
 // the deprecated `Version.flattenedDependencies` getter warns only once per process.
 let warnedFlattenedDependenciesGetter = false;
 
@@ -542,11 +571,7 @@ export default class Version extends BitObject {
     };
   }
   static depEdgeFromObject(depEdgeObj: Record<string, any>): DepEdge {
-    return {
-      source: ComponentID.fromObject(depEdgeObj.source),
-      target: ComponentID.fromObject(depEdgeObj.target),
-      type: depEdgeObj.type,
-    };
+    return getFlattenedEdge(getFlattenedId(depEdgeObj.source), getFlattenedId(depEdgeObj.target), depEdgeObj.type);
   }
   /**
    * until 1.9.86, we used depEdgeToObject.
@@ -558,11 +583,7 @@ export default class Version extends BitObject {
   }
   static depEdgeFromArray(depEdgeArr: string[]): DepEdge {
     const [sourceStr, targetStr, type] = depEdgeArr;
-    return {
-      source: ComponentID.fromString(sourceStr),
-      target: ComponentID.fromString(targetStr),
-      type: type as DepEdgeType,
-    };
+    return getFlattenedEdge(getFlattenedId(sourceStr), getFlattenedId(targetStr), type as DepEdgeType);
   }
   static flattenedEdgeToSource(flattenedEdges?: DepEdge[]): Source | undefined {
     if (!flattenedEdges) return undefined;
@@ -842,7 +863,7 @@ export default class Version extends BitObject {
       dependenciesGraphRef: dependenciesGraph?.hash(),
       flattenedDependencies: component.flattenedDependencies,
       // not saved in the Version when `flattenedEdgesRef` is set, see `toObject()`.
-      flattenedEdges: component.flattenedEdges,
+      flattenedEdges: flattenedEdges ? [] : component.flattenedEdges,
       flattenedEdgesRef: flattenedEdges?.hash(),
       schema: component.schema,
       overrides: component.overrides.componentOverridesData,
@@ -882,16 +903,6 @@ export default class Version extends BitObject {
       : undefined;
   }
 
-  setDist(dist: Source | undefined) {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-    this.dist = dist
-      ? {
-          file: dist.hash(),
-          name: DEFAULT_BUNDLE_FILENAME,
-        }
-      : null;
-  }
-
   hasParent(ref: Ref) {
     return this.parents.find((p) => p.toString() === ref.toString());
   }

package/objects/object.ts

@@ -46,7 +46,7 @@ export default class BitObject {
   }
 
   async collectRefs(repo: Repository): Promise<Ref[]> {
-    const refsCollection = [];
+    const refsCollection: Ref[] = [];
     const objectType = this.getType();
     const objectId = objectType === 'Component' ? `Component ${this.id()}` : objectType;
 
@@ -63,7 +63,6 @@ path: ${err.path}`);
         throw err;
       }
 
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       refsCollection.push(...refs);
       await Promise.all(objs.map((obj) => addRefs(obj)));
     }

package/objects/raw-object.ts

@@ -1,7 +1,6 @@
 import { NULL_BYTE, SPACE_DELIMITER } from '@teambit/legacy.constants';
 import { getStringifyArgs, inflate } from '@teambit/legacy.utils';
 import { typesObj as types } from '@teambit/legacy.scope';
-import type BitObject from './object';
 import { clone } from 'lodash';
 
 export default class BitRawObject {
@@ -12,11 +11,11 @@ export default class BitRawObject {
   _ref: string;
 
   constructor(
-    buffer: Buffer,
-    ref: string | null | undefined,
-    type: string | null | undefined,
-    content: Buffer | null | undefined,
-    parsedContent: any | null | undefined
+    buffer?: Buffer,
+    ref?: string | null,
+    type?: string | null,
+    content?: Buffer | null,
+    parsedContent?: any | null
   ) {
     let headers;
     let contentFromBuffer;
@@ -28,10 +27,8 @@ export default class BitRawObject {
     this.content = content || contentFromBuffer;
     this.headers = headers ? headers.split(SPACE_DELIMITER) : undefined;
     const typeFromHeader = this.headers ? this.headers[0] : undefined;
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-    this.type = type || typeFromHeader;
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-    this._ref = ref;
+    this.type = (type || typeFromHeader)!;
+    this._ref = ref!;
     this.parsedContent = parsedContent || this.getParsedContent();
   }
 
@@ -109,8 +106,7 @@ export default class BitRawObject {
     return [];
   }
 
-  static async fromDeflatedBuffer(fileContents: Buffer, ref: string | null | undefined): Promise<BitObject> {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  static async fromDeflatedBuffer(fileContents: Buffer, ref: string | null | undefined): Promise<BitRawObject> {
     return inflate(fileContents).then((buffer) => new BitRawObject(buffer, ref));
   }
 
@@ -126,7 +122,6 @@ export default class BitRawObject {
   clone() {
     const parsedContent = this.parsedContent ? clone(this.parsedContent) : undefined;
     // TODO: Should also clone the buffers (content)
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
     return new BitRawObject(undefined, this._ref, this.type, this.content, parsedContent);
   }
 }

package/objects/repository.ts

@@ -31,7 +31,7 @@ import Ref from './ref';
 import { LiveObjects } from './live-objects';
 import type { InMemoryCache } from '@teambit/harmony.modules.in-memory-cache';
 import { getCacheOptionsForObjects, createInMemoryCache } from '@teambit/harmony.modules.in-memory-cache';
-import { ScopeMeta, Lane, ModelComponent } from '../models';
+import { ScopeMeta, Lane, ModelComponent, type Source } from '../models';
 
 type ContentTransformer = (content: Buffer) => Buffer;
 const OBJECTS_BACKUP_DIR = `${OBJECTS_DIR}.bak`;
@@ -180,8 +180,7 @@ export default class Repository {
     return path.join(this.scopePath, TRASH_DIR);
   }
 
-  getLicense(): Promise<string> {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  getLicense(): Promise<string | null | undefined> {
     return this.scopeJson.getPopulatedLicense();
   }
 
@@ -564,7 +563,7 @@ export default class Repository {
       if (throws) {
         throw new HashNotFound(ref.toString());
       }
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+      // @ts-expect-error @todo: it should return BitObject | null (same as `load()`)
       return null;
     }
   }
@@ -629,7 +628,8 @@ export default class Repository {
     // leave the following commented log message, it is very useful for debugging but too verbose when not needed.
     // logger.debug(`repository: adding object ${object.hash().toString()} which consist of the following id: ${object.id()}`);
     this.objects[object.hash().toString()] = object;
-    this.setCache(object);
+    const size = (object as Source).contents?.byteLength;
+    this.setCache(object, size);
     return this;
   }
 
@@ -845,13 +845,12 @@ export default class Repository {
     await this.writeObjectFile(objectPath, transformedContent, options);
     // once written, the object is the up-to-date one. this also replaces the size-estimate of objects that
     // were cached by `add()`.
-    if (this.cache.has(hash.toString())) this.cache.set(hash.toString(), object, inflatedSize);
-    this.liveObjects.set(
-      hash.toString(),
-      object,
-      inflatedSize,
-      transformedContent.byteLength < MAX_COMPRESSED_SIZE_TO_CACHE
-    );
+    const cacheable = transformedContent.byteLength < MAX_COMPRESSED_SIZE_TO_CACHE;
+    if (this.cache.has(hash.toString())) {
+      if (cacheable) this.cache.set(hash.toString(), object, inflatedSize);
+      else this.cache.delete(hash.toString());
+    }
+    this.liveObjects.set(hash.toString(), object, inflatedSize, cacheable);
   }
 
   async writeObjectsToPendingDir(objectList: ObjectList, pendingDir: PathOsBasedAbsolute) {

package/objects/scope-index.spec.ts

@@ -11,7 +11,6 @@ describe('ComponentsIndex', () => {
       scopeIndex = new ScopeIndex('scope-path');
     });
     it('should add to the index array', () => {
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       const modelComponent = new ModelComponent({ scope: 'my-scope', name: 'is-string' });
       scopeIndex.addOne(modelComponent);
       const allItems = scopeIndex.getAll();
@@ -19,7 +18,6 @@ describe('ComponentsIndex', () => {
       expect(allItems[0].id).to.deep.equal({ scope: 'my-scope', name: 'is-string' });
     });
     it('should not add the same component multiple times', () => {
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       const modelComponent = new ModelComponent({ scope: 'my-scope', name: 'is-string' });
       scopeIndex.addOne(modelComponent);
       scopeIndex.addOne(modelComponent);
@@ -27,8 +25,7 @@ describe('ComponentsIndex', () => {
       expect(scopeIndex.getAll()).to.have.lengthOf(1);
     });
     it('should not add BitObjects that are not Symlink nor ModelComponent', () => {
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-      const bitObject = new BitObject({ scope: 'my-scope', name: 'is-string' });
+      const bitObject = new BitObject();
       const result = scopeIndex.addOne(bitObject);
       expect(scopeIndex.getAll()).to.have.lengthOf(0);
       expect(result).to.be.false;
@@ -40,7 +37,6 @@ describe('ComponentsIndex', () => {
       scopeIndex = new ScopeIndex('scope-path');
     });
     it('should remove from the index array', () => {
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       const modelComponent = new ModelComponent({ scope: 'my-scope', name: 'is-string' });
       scopeIndex.addOne(modelComponent);
       expect(scopeIndex.getAll()).to.have.lengthOf(1);
@@ -48,9 +44,7 @@ describe('ComponentsIndex', () => {
       expect(scopeIndex.getAll()).to.have.lengthOf(0);
     });
     it('should remove the correct one when there are multiple', () => {
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       const isStringComponent = new ModelComponent({ scope: 'my-scope', name: 'is-string' });
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       const isTypeComponent = new ModelComponent({ scope: 'my-scope', name: 'is-type' });
       scopeIndex.addOne(isStringComponent);
       scopeIndex.addOne(isTypeComponent);
@@ -68,9 +62,7 @@ describe('ComponentsIndex', () => {
     let isTypeComponent;
     beforeEach(() => {
       scopeIndex = new ScopeIndex('scope-path');
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       isStringComponent = new ModelComponent({ scope: 'my-scope', name: 'is-string' });
-      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
       isTypeComponent = new ModelComponent({ scope: 'my-scope', name: 'is-type' });
       scopeIndex.addMany([isStringComponent, isTypeComponent]);
       expect(scopeIndex.getAll()).to.have.lengthOf(2);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/objects",
-  "version": "0.0.726",
+  "version": "0.0.728",
   "homepage": "https://bit.cloud/teambit/scope/objects",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.scope",
     "name": "objects",
-    "version": "0.0.726"
+    "version": "0.0.728"
   },
   "dependencies": {
     "@pnpm/lockfile.types": "1100.0.19",
@@ -26,28 +26,28 @@
     "@teambit/component-version": "1.0.4",
     "@teambit/component.snap-distance": "0.0.191",
     "@teambit/lane-id": "0.0.312",
+    "@teambit/legacy.cli.error": "0.0.71",
     "@teambit/legacy.constants": "0.0.50",
+    "@teambit/legacy.logger": "0.0.70",
     "@teambit/toolbox.crypto.sha1": "0.0.24",
+    "@teambit/component.sources": "0.0.243",
     "@teambit/harmony.modules.concurrency": "0.0.51",
     "@teambit/legacy-bit-id": "1.1.4",
     "@teambit/legacy-component-log": "0.0.434",
+    "@teambit/legacy.consumer-component": "0.0.192",
+    "@teambit/legacy.consumer-config": "0.0.191",
+    "@teambit/legacy.extension-data": "0.0.193",
     "@teambit/pkg.modules.semver-helper": "0.0.38",
     "@teambit/toolbox.array.duplications-finder": "0.0.19",
     "@teambit/toolbox.promise.map-pool": "0.0.24",
     "@teambit/graph.cleargraph": "0.0.11",
     "@teambit/bit.get-bit-version": "0.0.31",
+    "@teambit/semantics.doc-parser": "0.0.199",
     "@teambit/harmony.modules.in-memory-cache": "0.0.55",
     "@teambit/toolbox.fs.remove-empty-dir": "0.0.22",
-    "@teambit/harmony.modules.get-basic-log": "0.0.193",
-    "@teambit/config-store": "0.0.304",
-    "@teambit/legacy.cli.error": "0.0.71",
-    "@teambit/legacy.logger": "0.0.70",
-    "@teambit/legacy.scope": "0.0.192",
-    "@teambit/component.sources": "0.0.243",
-    "@teambit/legacy.consumer-component": "0.0.192",
-    "@teambit/legacy.consumer-config": "0.0.191",
-    "@teambit/legacy.extension-data": "0.0.193",
-    "@teambit/semantics.doc-parser": "0.0.199"
+    "@teambit/harmony.modules.get-basic-log": "0.0.194",
+    "@teambit/config-store": "0.0.305",
+    "@teambit/legacy.scope": "0.0.193"
   },
   "devDependencies": {
     "@types/semver": "7.5.8",