Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactoring, get rid of legacy src/consumer/component/package-json(-utils) files #9010

Merged
merged 4 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions scopes/component/remove/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ export type { RemoveMain, RemoveInfo } from './remove.main.runtime';
export type { RemovedLocalObjects } from './removed-local-objects';
export { deleteComponentsFiles } from './delete-component-files';
export { removeTemplate } from './remove-template';
export { removeComponentsFromNodeModules } from './remove-components';
export default RemoveAspect;
export { RemoveAspect };
27 changes: 18 additions & 9 deletions scopes/component/remove/remove-components.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import fs from 'fs-extra';
import groupArray from 'group-array';
import partition from 'lodash.partition';
import { Workspace } from '@teambit/workspace';
import { ComponentIdList } from '@teambit/component-id';
import { isEmpty } from 'lodash';
import { compact, isEmpty } from 'lodash';
import { CENTRAL_BIT_HUB_NAME, CENTRAL_BIT_HUB_URL, LATEST_BIT_VERSION } from '@teambit/legacy/dist/constants';
import { BitError } from '@teambit/bit-error';
import enrichContextFromGlobal from '@teambit/legacy/dist/hooks/utils/enrich-context-from-global';
Expand All @@ -14,8 +15,10 @@ import { deleteComponentsFiles } from './delete-component-files';
import ComponentsList from '@teambit/legacy/dist/consumer/component/components-list';
import Component from '@teambit/legacy/dist/consumer/component/consumer-component';
import RemovedObjects from '@teambit/legacy/dist/scope/removed-components';
import * as packageJsonUtils from '@teambit/legacy/dist/consumer/component/package-json-utils';
import pMapSeries from 'p-map-series';
import { Consumer } from '@teambit/legacy/dist/consumer';
import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
import { getNodeModulesPathOfComponent } from '@teambit/pkg.modules.component-package-name';
import { RemovedLocalObjects } from './removed-local-objects';

export type RemoveComponentsResult = { localResult: RemovedLocalObjects; remoteResult: RemovedObjects[] };
Expand Down Expand Up @@ -156,7 +159,7 @@ If you understand the risks and wish to proceed with the removal, please use the
const idsToCleanFromWorkspace = ComponentIdList.fromArray(
idsToRemove.filter((id) => newComponents.hasWithoutVersion(id))
);
const { components: componentsToRemove, invalidComponents } = await consumer.loadComponents(idsToRemove, false);
const { components: componentsToRemove } = await consumer.loadComponents(idsToRemove, false);
const { removedComponentIds, missingComponents, dependentBits, removedFromLane } = await consumer.scope.removeMany(
idsToRemoveFromScope,
force,
Expand All @@ -167,13 +170,9 @@ If you understand the risks and wish to proceed with the removal, please use the
if (idsToCleanFromWorkspace.length) {
if (deleteFiles) await deleteComponentsFiles(consumer, idsToCleanFromWorkspace);
if (!track) {
const invalidComponentsIds = invalidComponents.map((i) => i.id);
const removedComponents = componentsToRemove.filter((c) => idsToCleanFromWorkspace.hasWithoutVersion(c.id));
await packageJsonUtils.removeComponentsFromWorkspacesAndDependencies(
consumer,
removedComponents,
invalidComponentsIds
);
await consumer.packageJson.removeComponentsFromDependencies(removedComponents);
await removeComponentsFromNodeModules(consumer, removedComponents);
await consumer.cleanFromBitMap(idsToCleanFromWorkspace);
await workspace.cleanFromConfig(idsToCleanFromWorkspace);
}
Expand All @@ -186,3 +185,13 @@ If you understand the risks and wish to proceed with the removal, please use the
removedFromLane
);
}

export async function removeComponentsFromNodeModules(consumer: Consumer, components: ConsumerComponent[]) {
logger.debug(`removeComponentsFromNodeModules: ${components.map((c) => c.id.toString()).join(', ')}`);
const pathsToRemoveWithNulls = components.map((c) => {
return getNodeModulesPathOfComponent({ ...c, id: c.id });
});
const pathsToRemove = compact(pathsToRemoveWithNulls);
logger.debug(`deleting the following paths: ${pathsToRemove.join('\n')}`);
return Promise.all(pathsToRemove.map((componentPath) => fs.remove(consumer.toAbsolutePath(componentPath))));
}
3 changes: 1 addition & 2 deletions scopes/component/remove/remove.main.runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ import { IssuesAspect, IssuesMain } from '@teambit/issues';
import pMapSeries from 'p-map-series';
import { NoHeadNoVersion } from '@teambit/legacy/dist/scope/exceptions/no-head-no-version';
import { ComponentAspect, Component, ComponentMain } from '@teambit/component';
import { removeComponentsFromNodeModules } from '@teambit/legacy/dist/consumer/component/package-json-utils';
import { deleteComponentsFiles } from './delete-component-files';
import { RemoveCmd } from './remove-cmd';
import { RemoveComponentsResult, removeComponents } from './remove-components';
import { RemoveComponentsResult, removeComponents, removeComponentsFromNodeModules } from './remove-components';
import { RemoveAspect } from './remove.aspect';
import { RemoveFragment } from './remove.fragment';
import { RecoverCmd, RecoverOptions } from './recover-cmd';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ export class AutoDetectDeps {
// some files such as scss/json are needed to be imported as non-main
return;
}
const pkgRootDir = dependencyPkgData.packageJsonContent?.componentRootFolder;
const pkgRootDir = dependencyPkgData.packageJsonPath && path.dirname(dependencyPkgData.packageJsonPath);
if (pkgRootDir && !fs.existsSync(path.join(pkgRootDir, DEFAULT_DIST_DIRNAME))) {
// the dependency wasn't compiled yet. the issue is probably because depMain points to the dist
// and depFullPath is in the source.
Expand Down
6 changes: 3 additions & 3 deletions scopes/dependencies/dependencies/resolve-pkg-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { ComponentID } from '@teambit/component-id';
import path from 'path';
import readPkgUp from 'read-pkg-up';
import { PACKAGE_JSON } from '@teambit/legacy/dist/constants';
import PackageJson from '@teambit/legacy/dist/consumer/component/package-json';
import PackageJsonFile from '@teambit/legacy/dist/consumer/component/package-json-file';
import { PathLinuxAbsolute, PathOsBased, PathOsBasedAbsolute } from '@teambit/toolbox.path.path';
import { resolvePackageNameByPath } from '@teambit/legacy.utils';

Expand Down Expand Up @@ -83,8 +83,8 @@ function enrichDataFromDependency(packageData: ResolvedPackageData) {
// if you have 2 authored component which one dependent on the other
// we will look for the package.json on the dependency but won't find it
// if we propagate we will take the version from the root's package json which has nothing with the component version
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
const packageInfo = PackageJson.loadSync(packageDir);
const packageJsonFile = PackageJsonFile.loadSync(packageDir);
const packageInfo = packageJsonFile.packageJsonObject;

// the version can be empty when creating the package.json for author, or when using custom-module-resolution
// that's fine, we still need the component-id in this case.
Expand Down
7 changes: 2 additions & 5 deletions scopes/workspace/eject/components-ejector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ import defaultErrorHandler from '@teambit/legacy/dist/cli/default-error-handler'
import { getScopeRemotes } from '@teambit/legacy/dist/scope/scope-remotes';
import { componentIdToPackageName } from '@teambit/pkg.modules.component-package-name';
import Component from '@teambit/legacy/dist/consumer/component/consumer-component';
import PackageJsonFile from '@teambit/legacy/dist/consumer/component/package-json-file';
import * as packageJsonUtils from '@teambit/legacy/dist/consumer/component/package-json-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 { Logger } from '@teambit/logger';
import { InstallMain } from '@teambit/install';
import { removeComponentsFromNodeModules } from '@teambit/remove';

export type EjectResults = {
ejectedComponents: ComponentIdList;
Expand All @@ -46,8 +45,6 @@ export class ComponentsEjector {
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
notEjectedDependents: Array<{ dependent: Component; ejectedDependencies: Component[] }>;
failedComponents: FailedComponents;
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
packageJsonFilesBeforeChanges: PackageJsonFile[]; // for rollback in case of errors
constructor(
private workspace: Workspace,
private install: InstallMain,
Expand Down Expand Up @@ -127,7 +124,7 @@ export class ComponentsEjector {
const action = 'Eject: removing the existing components from node_modules';
this.logger.setStatusLine(action);
this.logger.debug(action);
await packageJsonUtils.removeComponentsFromNodeModules(this.consumer, this.componentsToEject);
await removeComponentsFromNodeModules(this.consumer, this.componentsToEject);
this.logger.consoleSuccess(action);
}

Expand Down
15 changes: 13 additions & 2 deletions src/consumer/component/package-json-file.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,11 @@ export default class PackageJsonFile {
}

addDependencies(dependencies: Record<string, any>) {
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
this.packageJsonObject.dependencies = Object.assign({}, this.packageJsonObject.dependencies, dependencies);
}

addDevDependencies(dependencies: Record<string, any>) {
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
this.packageJsonObject.devDependencies = Object.assign({}, this.packageJsonObject.devDependencies, dependencies);
}
Expand Down Expand Up @@ -241,6 +239,19 @@ export default class PackageJsonFile {
this.packageJsonObject = Object.assign(this.packageJsonObject, packageJsonObject);
}

/*
* remove components from package.json dependencies
*/
async removeComponentsFromDependencies(components: Component[]) {
if (!this.fileExist) return;
const deps = this.packageJsonObject.dependencies;
if (!deps) return;
components.forEach((c) => {
this.removeDependency(componentIdToPackageName(c));
});
await this.write();
}

clone(): PackageJsonFile {
// @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
const clone = new PackageJsonFile(this);
Expand Down
59 changes: 0 additions & 59 deletions src/consumer/component/package-json-utils.ts

This file was deleted.

Loading