refactor, move src/consumer/component/sources into a new component "teambit.component/sources" (#9016)

Author: davidfirst

.bitmap

@@ -1556,6 +1556,13 @@
         "mainFile": "index.ts",
         "rootDir": "scopes/component/snapping"
     },
+    "sources": {
+        "name": "sources",
+        "scope": "teambit.component",
+        "version": "0.0.1",
+        "mainFile": "index.ts",
+        "rootDir": "scopes/component/sources"
+    },
     "stash": {
         "name": "stash",
         "scope": "teambit.component",

components/legacy/component-diff/components-diff.ts

@@ -4,7 +4,7 @@ import R from 'ramda';
 import { ComponentID } from '@teambit/component-id';
 import { diffFiles } from './diff-files';
 import { PathOsBased } from '@teambit/toolbox.path.path';
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
+import { SourceFile } from '@teambit/component.sources';
 
 export type DiffStatus = 'MODIFIED' | 'UNCHANGED' | 'NEW' | 'DELETED';
 

package.json

@@ -118,6 +118,7 @@
     "@pnpm/node-fetch": "^1.0.0",
     "@teambit/defender.fs.global-bit-temp-dir": "0.0.1",
     "@teambit/legacy.analytics": "~0.0.1",
+    "@teambit/component.sources": "~0.0.1",
     "@teambit/bit.get-bit-version": "~0.0.1",
     "@teambit/legacy.utils": "~0.0.2",
     "@teambit/legacy.bit-map": "~0.0.4",

scopes/compilation/compiler/dist-artifact.ts

@@ -1,4 +1,4 @@
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { AbstractVinyl } from '@teambit/component.sources';
 import { pathNormalizeToLinux } from '@teambit/toolbox.path.path';
 
 export class DistArtifact {

scopes/compilation/compiler/workspace-compiler.ts

@@ -12,8 +12,7 @@ import { ComponentID } from '@teambit/component-id';
 import { Logger } from '@teambit/logger';
 import loader from '@teambit/legacy/dist/cli/loader';
 import { DEFAULT_DIST_DIRNAME } from '@teambit/legacy/dist/constants';
-import { AbstractVinyl, Dist } from '@teambit/legacy/dist/consumer/component/sources';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
+import { AbstractVinyl, Dist, DataToPersist, RemovePath } from '@teambit/component.sources';
 import {
   linkToNodeModulesByComponents,
   removeLinksFromNodeModules,
@@ -22,7 +21,6 @@ import { AspectLoaderMain } from '@teambit/aspect-loader';
 import { DependencyResolverMain } from '@teambit/dependency-resolver';
 import { PathOsBasedAbsolute, PathOsBasedRelative } from '@teambit/toolbox.path.path';
 import { componentIdToPackageName } from '@teambit/pkg.modules.component-package-name';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
 import { UiMain } from '@teambit/ui';
 import { readBitRootsDir } from '@teambit/bit-roots';
 import { groupBy, uniq } from 'lodash';

scopes/component/checkout/checkout-version.ts

@@ -2,10 +2,8 @@ import * as path from 'path';
 import { Consumer } from '@teambit/legacy/dist/consumer';
 import { ComponentID } from '@teambit/component-id';
 import Version from '@teambit/legacy/dist/scope/models/version';
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
+import { SourceFile, RemovePath, DataToPersist } from '@teambit/component.sources';
 import { pathNormalizeToLinux, PathOsBased } from '@teambit/legacy.utils';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
 import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
 import { BitError } from '@teambit/bit-error';
 import chalk from 'chalk';

scopes/component/component-writer/component-writer.main.runtime.ts

@@ -19,7 +19,7 @@ import {
 } from '@teambit/legacy.utils';
 import { ComponentMap } from '@teambit/legacy.bit-map';
 import { COMPONENT_CONFIG_FILE_NAME } from '@teambit/legacy/dist/constants';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
+import { DataToPersist } from '@teambit/component.sources';
 import { ConfigMergerAspect, ConfigMergerMain, WorkspaceConfigUpdateResult } from '@teambit/config-merger';
 import { MergeStrategy } from '@teambit/merging';
 import Consumer from '@teambit/legacy/dist/consumer/consumer';

scopes/component/component-writer/component-writer.ts

@@ -3,8 +3,7 @@ import { Scope } from '@teambit/legacy/dist/scope';
 import { PathLinuxRelative, pathNormalizeToLinux } from '@teambit/legacy.utils';
 import { BitMap, ComponentMap } from '@teambit/legacy.bit-map';
 import Component from '@teambit/legacy/dist/consumer/component/consumer-component';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
+import { DataToPersist, RemovePath } from '@teambit/component.sources';
 import Consumer from '@teambit/legacy/dist/consumer/consumer';
 import { isHash } from '@teambit/component-version';
 import { Ref } from '@teambit/legacy/dist/scope/objects';

scopes/component/component/component-fs.ts

@@ -1,5 +1,5 @@
 import { MemoryFS } from '@teambit/any-fs';
-import type { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import type { AbstractVinyl } from '@teambit/component.sources';
 import * as eol from '@teambit/toolbox.string.eol';
 import path from 'path';
 import { matchPatterns, splitPatterns } from '@teambit/toolbox.path.match-patterns';

scopes/component/dev-files/dev-files.main.runtime.ts

@@ -1,4 +1,4 @@
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
+import { SourceFile } from '@teambit/component.sources';
 import { MainRuntime } from '@teambit/cli';
 import { ScopeAspect, ScopeMain } from '@teambit/scope';
 import { flatten, isFunction } from 'lodash';

scopes/component/isolator/isolator.main.runtime.ts

@@ -34,26 +34,26 @@ import {
   CFG_CAPSULES_SCOPES_ASPECTS_DATED_DIR,
 } from '@teambit/legacy/dist/constants';
 import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
-import PackageJsonFile from '@teambit/legacy/dist/consumer/component/package-json-file';
 import {
+  PackageJsonFile,
   ArtifactFiles,
   deserializeArtifactFiles,
   getArtifactFilesByExtension,
   getArtifactFilesExcludeExtension,
   importMultipleDistsArtifacts,
-} from '@teambit/legacy/dist/consumer/component/sources/artifact-files';
+  AbstractVinyl,
+  ArtifactVinyl,
+  DataToPersist,
+  RemovePath,
+} from '@teambit/component.sources';
 import { pathNormalizeToLinux, PathOsBasedAbsolute } from '@teambit/legacy.utils';
 import { concurrentComponentsLimit } from '@teambit/harmony.modules.concurrency';
 import { componentIdToPackageName } from '@teambit/pkg.modules.component-package-name';
 import { Scope } from '@teambit/legacy/dist/scope';
 import fs, { copyFile } from 'fs-extra';
 import hash from 'object-hash';
 import path, { basename } from 'path';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
 import { PackageJsonTransformer } from '@teambit/workspace.modules.node-modules-linker';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { ArtifactVinyl } from '@teambit/legacy/dist/consumer/component/sources/artifact';
 import pMap from 'p-map';
 import { Capsule } from './capsule';
 import CapsuleList from './capsule-list';

scopes/component/merging/merge-version/three-way-merge.ts

@@ -7,7 +7,7 @@ import { PathLinux, pathNormalizeToLinux, PathOsBased } from '@teambit/toolbox.p
 import * as eol from '@teambit/toolbox.string.eol';
 import { mergeFiles, MergeFileParams, MergeFileResult } from '../merge-files';
 import Component from '@teambit/legacy/dist/consumer/component';
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
+import { SourceFile } from '@teambit/component.sources';
 import { Scope } from '@teambit/legacy/dist/scope';
 import { isEmpty } from 'lodash';
 

scopes/component/mover/mover.main.runtime.ts

@@ -8,7 +8,7 @@ import { isDir, PathOsBasedAbsolute, PathOsBasedRelative } from '@teambit/legacy
 import { linkToNodeModulesByIds } from '@teambit/workspace.modules.node-modules-linker';
 import { PathChangeResult } from '@teambit/legacy.bit-map';
 import Component from '@teambit/legacy/dist/consumer/component/consumer-component';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
+import { RemovePath } from '@teambit/component.sources';
 import { MoverAspect } from './mover.aspect';
 import { MoveCmd } from './move-cmd';
 

scopes/component/refactoring/refactoring.main.runtime.ts

@@ -5,7 +5,7 @@ import { compact } from 'lodash';
 import { replacePackageName } from '@teambit/legacy.utils';
 import { ComponentAspect, Component, ComponentID, ComponentMain } from '@teambit/component';
 import { BitError } from '@teambit/bit-error';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { AbstractVinyl } from '@teambit/component.sources';
 import { PkgAspect, PkgMain } from '@teambit/pkg';
 import { EnvsAspect, EnvsMain } from '@teambit/envs';
 import {

scopes/component/remove/delete-component-files.ts

@@ -1,7 +1,6 @@
 import { ComponentIdList } from '@teambit/component-id';
 import logger from '@teambit/legacy/dist/logger/logger';
-import DataToPersist from '@teambit/legacy/dist/consumer/component/sources/data-to-persist';
-import RemovePath from '@teambit/legacy/dist/consumer/component/sources/remove-path';
+import { DataToPersist, RemovePath } from '@teambit/component.sources';
 import Consumer from '@teambit/legacy/dist/consumer/consumer';
 
 export async function deleteComponentsFiles(consumer: Consumer, bitIds: ComponentIdList) {

scopes/component/snapping/generate-comp-from-scope.ts

@@ -1,7 +1,7 @@
 import { ComponentID } from '@teambit/component-id';
 import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
 import { Dependency } from '@teambit/legacy/dist/consumer/component/dependencies';
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
+import { SourceFile } from '@teambit/component.sources';
 import { ScopeMain } from '@teambit/scope';
 import ComponentOverrides from '@teambit/legacy/dist/consumer/config/component-overrides';
 import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config';

scopes/component/snapping/snapping.main.runtime.ts

@@ -34,11 +34,7 @@ import UnmergedComponents from '@teambit/legacy/dist/scope/lanes/unmerged-compon
 import { isHash, isTag } from '@teambit/component-version';
 import { BitObject, Ref, Repository } from '@teambit/legacy/dist/scope/objects';
 import { GlobalConfigAspect, GlobalConfigMain } from '@teambit/global-config';
-import {
-  ArtifactFiles,
-  ArtifactSource,
-  getArtifactsFiles,
-} from '@teambit/legacy/dist/consumer/component/sources/artifact-files';
+import { ArtifactFiles, ArtifactSource, getArtifactsFiles, SourceFile } from '@teambit/component.sources';
 import {
   VersionNotFound,
   ComponentNotFound,
@@ -47,7 +43,6 @@ import {
 } from '@teambit/legacy/dist/scope/exceptions';
 import { AutoTagResult } from '@teambit/legacy/dist/scope/component-ops/auto-tag';
 import { DependenciesAspect, DependenciesMain } from '@teambit/dependencies';
-import { SourceFile } from '@teambit/legacy/dist/consumer/component/sources';
 import Version, { DepEdge, DepEdgeType, Log } from '@teambit/legacy/dist/scope/models/version';
 import { SnapCmd } from './snap-cmd';
 import { SnappingAspect } from './snapping.aspect';

src/consumer/component/sources/abstract-vinyl.ts renamed to scopes/component/sources/abstract-vinyl.ts

@@ -2,8 +2,8 @@ import fs from 'fs-extra';
 import * as path from 'path';
 import Vinyl from 'vinyl';
 
-import logger from '../../../logger/logger';
-import Source from '../../../scope/models/source';
+import logger from '@teambit/legacy/dist/logger/logger';
+import Source from '@teambit/legacy/dist/scope/models/source';
 import { PathOsBased } from '@teambit/toolbox.path.path';
 import * as eol from '@teambit/toolbox.string.eol';
 import { FileConstructor } from './vinyl-types';
@@ -15,6 +15,7 @@ type AbstractVinylProps = {
   contents: Buffer;
 };
 
+// @ts-ignore
 export default class AbstractVinyl extends (Vinyl as FileConstructor) {
   override = true;
   verbose = false;

src/consumer/component/sources/artifact-files.ts renamed to scopes/component/sources/artifact-files.ts

@@ -2,17 +2,16 @@ import fs from 'fs-extra';
 import { filter } from 'bluebird';
 import path from 'path';
 import { ComponentID } from '@teambit/component-id';
-import R from 'ramda';
 import { BitError } from '@teambit/bit-error';
-import logger from '../../../logger/logger';
-import { Scope } from '../../../scope';
-import { Lane, Source } from '../../../scope/models';
-import { Ref } from '../../../scope/objects';
+import logger from '@teambit/legacy/dist/logger/logger';
+import { Scope } from '@teambit/legacy/dist/scope';
+import { Lane, Source } from '@teambit/legacy/dist/scope/models';
+import { Ref } from '@teambit/legacy/dist/scope/objects';
 import { pathNormalizeToLinux } from '@teambit/toolbox.path.path';
-import { ExtensionDataList } from '../../config';
-import Component from '../consumer-component';
+import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config';
+import Component from '@teambit/legacy/dist/consumer/component/consumer-component';
 import { ArtifactVinyl } from './artifact';
-import { MissingObjects } from '../../../scope/exceptions/missing-objects';
+import { MissingObjects } from '@teambit/legacy/dist/scope/exceptions/missing-objects';
 
 export type ArtifactRef = { relativePath: string; ref: Ref; url?: string };
 export type ArtifactModel = { relativePath: string; file: string; url?: string };
@@ -264,7 +263,7 @@ export async function importAllArtifactsFromLane(scope: Scope, components: Compo
         groupHashesFallBack,
         `to get all artifacts for ${components.length} components from main`
       );
-    } catch (err) {
+    } catch (err: any) {
       logger.error('failed fetching the following hashes from both lane and main', {
         groupedHashes: groupedHashesOnLane,
         debugHashesOrigin,
@@ -297,7 +296,7 @@ export function refsToModelObjects(refs: ArtifactRef[]): ArtifactModel[] {
 export function getRefsFromExtensions(extensions: ExtensionDataList): Ref[] {
   const artifactsFiles = getArtifactsFiles(extensions);
   const refs = artifactsFiles.map((artifactFiles) => artifactFiles.refs.map((r) => r.ref));
-  return R.flatten(refs).filter((ref) => ref);
+  return refs.flat().filter((ref) => ref);
 }
 
 export function getArtifactFilesByExtension(extensions: ExtensionDataList, extensionName: string): ArtifactFiles[] {

src/consumer/component/sources/artifact.ts renamed to scopes/component/sources/artifact.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import * as path from 'path';
 
-import DataToPersist from './data-to-persist';
+import { DataToPersist } from './data-to-persist';
 
 describe('DataToPersist', function () {
   // @ts-ignore

src/consumer/component/sources/data-to-persist.spec.ts renamed to scopes/component/sources/data-to-persist.spec.ts

@@ -1,14 +1,14 @@
-import Bluebird from 'bluebird';
+import { pMapPool } from '@teambit/toolbox.promise.map-pool';
 import fs from 'fs-extra';
 import * as path from 'path';
 import { concurrentIOLimit } from '@teambit/harmony.modules.concurrency';
-import Symlink from '../../../links/symlink';
-import logger from '../../../logger/logger';
+import Symlink from '@teambit/legacy/dist/links/symlink';
+import logger from '@teambit/legacy/dist/logger/logger';
 import { removeFilesAndEmptyDirsRecursively } from './remove-files-and-empty-dirs-recursively';
 import AbstractVinyl from './abstract-vinyl';
-import RemovePath from './remove-path';
+import { RemovePath } from './remove-path';
 
-export default class DataToPersist {
+export class DataToPersist {
   files: AbstractVinyl[];
   symlinks: Symlink[];
   remove: RemovePath[];
@@ -163,11 +163,10 @@ export default class DataToPersist {
   }
   async _persistFilesToFS() {
     const concurrency = concurrentIOLimit();
-    return Bluebird.map(this.files, (file) => file.write(), { concurrency });
+    return pMapPool(this.files, (file) => file.write(), { concurrency });
   }
   async _persistSymlinksToFS() {
-    const concurrency = concurrentIOLimit();
-    return Bluebird.map(this.symlinks, (symlink) => symlink.write(), { concurrency });
+    this.symlinks.forEach((symlink) => symlink.write());
   }
   async _deletePathsFromFS() {
     const pathWithRemoveItsDirIfEmptyEnabled = this.remove.filter((p) => p.removeItsDirIfEmpty).map((p) => p.path);
@@ -176,7 +175,7 @@ export default class DataToPersist {
       await removeFilesAndEmptyDirsRecursively(pathWithRemoveItsDirIfEmptyEnabled);
     }
     const concurrency = concurrentIOLimit();
-    return Bluebird.map(restPaths, (removePath) => removePath.persistToFS(), { concurrency });
+    return pMapPool(restPaths, (removePath) => removePath.persistToFS(), { concurrency });
   }
   _validateAbsolute() {
     // it's important to make sure that all paths are absolute before writing them to the

src/consumer/component/sources/data-to-persist.ts renamed to scopes/component/sources/data-to-persist.ts

@@ -0,0 +1,26 @@
+import AbstractVinyl from './abstract-vinyl';
+import Dist from './dist';
+import License from './license';
+import SourceFile from './source-file';
+
+export { AbstractVinyl, Dist, License, SourceFile };
+export { PackageJsonFile } from './package-json-file';
+export { DataToPersist } from './data-to-persist';
+export { RemovePath } from './remove-path';
+export { ArtifactVinyl } from './artifact';
+export {
+  ArtifactSource,
+  ArtifactObject,
+  ArtifactFiles,
+  getArtifactsFiles,
+  getRefsFromExtensions,
+  deserializeArtifactFiles,
+  getArtifactFilesByExtension,
+  getArtifactFilesExcludeExtension,
+  importMultipleDistsArtifacts,
+  importAllArtifactsFromLane,
+  convertBuildArtifactsFromModelObject,
+  convertBuildArtifactsToModelObject,
+  reStructureBuildArtifacts,
+} from './artifact-files';
+export { JsonVinyl } from './json-vinyl';

src/consumer/component/sources/dist.ts renamed to scopes/component/sources/dist.ts

@@ -1,10 +1,10 @@
 import fs from 'fs-extra';
 
-import ValidationError from '../../../error/validation-error';
-import logger from '../../../logger/logger';
+import ValidationError from '@teambit/legacy/dist/error/validation-error';
+import logger from '@teambit/legacy/dist/logger/logger';
 import AbstractVinyl from './abstract-vinyl';
 
-export default class JSONFile extends AbstractVinyl {
+export class JSONFile extends AbstractVinyl {
   override = false;
 
   async write(): Promise<string> {

src/consumer/component/exceptions/file-source-not-found.ts renamed to scopes/component/sources/file-source-not-found.ts

@@ -2,10 +2,9 @@ import { dirname, basename } from 'path';
 import fs from 'fs-extra';
 import stringifyPackage from 'stringify-package';
 import writeFileAtomic from 'write-file-atomic';
-
-import ValidationError from '../../error/validation-error';
-import logger from '../../logger/logger';
-import AbstractVinyl from './sources/abstract-vinyl';
+import ValidationError from '@teambit/legacy/dist/error/validation-error';
+import logger from '@teambit/legacy/dist/logger/logger';
+import AbstractVinyl from './abstract-vinyl';
 
 /**
  * When writing the `package.json`, it uses the package `stringifyPackage` from the NPM guys, which

scopes/component/sources/index.ts

@@ -1,6 +1,6 @@
 import fs from 'fs-extra';
 
-import { LICENSE_FILENAME } from '../../../constants';
+import { LICENSE_FILENAME } from '@teambit/legacy/dist/constants';
 import { AbstractVinyl } from '.';
 
 export default class License extends AbstractVinyl {