test: add tests for upgrade

src/commands/upgrade.ts

@@ -11,18 +11,26 @@ import { normalizePinnedPackages, loadPlebConfig } from '../utils/config.js';
 
 const { gt, coerce } = semver;
 
+type RequiredRegistryApi = Pick<NpmRegistry, 'fetchDistTags' | 'dispose'>;
+
 export interface UpgradeOptions {
   directoryPath: string;
   dryRun?: boolean;
   registryUrl?: string;
+  createRegistry?: (url: string, token?: string) => RequiredRegistryApi;
   log?: (message: unknown) => void;
   logError?: (message: unknown) => void;
 }
 
+function createDefaultRegistry(url: string, token?: string) {
+  return new NpmRegistry(url, token);
+}
+
 export async function upgrade({
   directoryPath,
   registryUrl,
   dryRun,
+  createRegistry = createDefaultRegistry,
   log = console.log,
   logError = console.error,
 }: UpgradeOptions): Promise<void> {
@@ -33,7 +41,7 @@ export async function upgrade({
   const npmConfig = await loadEnvNpmConfig({ basePath: directoryPath });
   const resolvedRegistryUrl = registryUrl ?? npmConfig['registry'] ?? officialNpmRegistryUrl;
   const token = npmConfig[`${uriToIdentifier(resolvedRegistryUrl)}:_authToken`];
-  const registry = new NpmRegistry(resolvedRegistryUrl, token);
+  const registry = createRegistry(resolvedRegistryUrl, token);
 
   const internalPackageNames = new Set<string>(packages.map(({ packageJson }) => packageJson.name!));
 
@@ -148,7 +156,7 @@ export async function upgrade({
 }
 
 export interface IFetchLatestPackageVersionsOptions {
-  registry: NpmRegistry;
+  registry: RequiredRegistryApi;
   packageNames: Set<string>;
   logError: (message: unknown) => void;
 }

test/fixtures/dependencies-exact/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "pleb-dependencies-exact",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "package-a": "1.0.0"
+  }
+}

test/fixtures/dependencies-file-ref/inner-dep/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "pleb-dependencies-file-ref-inner",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "package-b": "^1.0.0"
+  }
+}

test/fixtures/dependencies-file-ref/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "pleb-dependencies-file-ref",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "package-a": "file:./inner-dep"
+  }
+}

test/fixtures/dependencies-pinned/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "pleb-dependencies",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "package-a": "~1.0.0",
+    "package-b": "~1.0.0"
+  }
+}

test/fixtures/dependencies-pinned/pleb.config.mjs

@@ -0,0 +1,3 @@
+export default {
+  pinnedPackages: [{ name: 'package-b', reason: 'broken stuff' }],
+};

test/fixtures/dependencies/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "pleb-dependencies",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "package-a": "~1.0.0",
+    "package-b": "~1.0.0",
+    "package-c": "^1.0.0"
+  }
+}

test/fixtures/lerna-workspace/packages/a/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "scripts": {},
   "dependencies": {
-    "lerna-workspace-b": "^1.0.0"
+    "lerna-workspace-b": "^1.0.0",
+    "external-a": "^1.0.0"
   }
 }

test/fixtures/lerna-workspace/packages/b/package.json

@@ -1,5 +1,8 @@
 {
   "name": "lerna-workspace-b",
   "version": "1.0.0",
-  "scripts": {}
+  "scripts": {},
+  "dependencies": {
+    "external-b": "^1.0.0"
+  }
 }

test/fixtures/yarn-workspace/packages/a/package.json

@@ -5,6 +5,7 @@
     "prepack": "echo \"prepack yarn-workspace-a\""
   },
   "dependencies": {
-    "yarn-workspace-b": "^1.0.0"
+    "yarn-workspace-b": "^1.0.0",
+    "external-a": "^1.0.0"
   }
 }

test/fixtures/yarn-workspace/packages/b/package.json

@@ -3,5 +3,8 @@
   "version": "1.0.0",
   "scripts": {
     "prepack": "echo \"prepack yarn-workspace-b\""
+  },
+  "dependencies": {
+    "external-b": "^1.0.0"
   }
 }

test/tsconfig.json

@@ -2,6 +2,7 @@
   "extends": "../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "../dist/test",
-    "types": ["node", "mocha"]
-  }
+    "types": ["node", "mocha"],
+  },
+  "references": [{ "path": "../src" }]
 }

test/upgrade.test.ts

@@ -0,0 +1,233 @@
+import { join } from 'path';
+import { fileURLToPath } from 'url';
+import { expect } from 'chai';
+import { upgrade } from 'pleb';
+
+const fixturesRoot = fileURLToPath(new URL('../../test/fixtures', import.meta.url));
+
+describe('pleb upgrade', () => {
+  function createMockRegistry(packagesData: Record<string, { latest: string; [tag: string]: string | undefined }>) {
+    return {
+      async fetchDistTags(packageName: string) {
+        return Promise.resolve(packagesData[packageName]!);
+      },
+      dispose() {
+        /**/
+      },
+    };
+  }
+
+  function createMockOutput() {
+    const output: { type: 'log' | 'error'; message: unknown }[] = [];
+    return {
+      output,
+      log(this: void, message: unknown) {
+        output.push({ type: 'log', message });
+      },
+      logError(this: void, message: unknown) {
+        output.push({ type: 'error', message });
+      },
+    };
+  }
+
+  it('should report nothing to upgrade for an empty project', async () => {
+    const newPackagePath = join(fixturesRoot, 'new-package');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () => createMockRegistry({}),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 0 dependencies...' },
+      { type: 'log', message: 'Nothing to upgrade.' },
+    ]);
+  });
+
+  it('should report nothing to upgrade when everything is up to date', async () => {
+    const newPackagePath = join(fixturesRoot, 'dependencies');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'package-a': { latest: '1.0.0' },
+          'package-b': { latest: '1.0.0' },
+          'package-c': { latest: '1.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 3 dependencies...' },
+      { type: 'log', message: 'Nothing to upgrade.' },
+    ]);
+  });
+
+  it('should report on dependencies with newer versions', async () => {
+    const newPackagePath = join(fixturesRoot, 'dependencies');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'package-a': { latest: '1.0.0' },
+          'package-b': { latest: '2.0.0' },
+          'package-c': { latest: '2.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 3 dependencies...' },
+      { type: 'log', message: 'Changes:' },
+      { type: 'log', message: '  package-b     ~1.0.0 -> ~2.0.0' },
+      { type: 'log', message: '  package-c     ^1.0.0 -> ^2.0.0' },
+    ]);
+  });
+
+  it('should force exact version to caret (opinionated)', async () => {
+    const newPackagePath = join(fixturesRoot, 'dependencies-exact');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'package-a': { latest: '1.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 1 dependencies...' },
+      { type: 'log', message: 'Changes:' },
+      { type: 'log', message: '  package-a      1.0.0 -> ^1.0.0' },
+    ]);
+  });
+
+  it('should not update file reference', async () => {
+    const newPackagePath = join(fixturesRoot, 'dependencies-file-ref');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'package-a': { latest: '2.0.0' },
+          'package-b': { latest: '1.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 1 dependencies...' },
+      { type: 'log', message: 'Nothing to upgrade.' },
+    ]);
+  });
+
+  it('should report from multiple yarn workspaces (only on external packages)', async () => {
+    const newPackagePath = join(fixturesRoot, 'yarn-workspace');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'yarn-workspace-b': { latest: '2.0.0' },
+          'external-a': { latest: '2.0.0' },
+          'external-b': { latest: '2.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 2 dependencies...' },
+      { type: 'log', message: 'Changes:' },
+      { type: 'log', message: '  external-b     ^1.0.0 -> ^2.0.0' },
+      { type: 'log', message: '  external-a     ^1.0.0 -> ^2.0.0' },
+    ]);
+  });
+
+  it('should report from multiple lerna workspaces (only on external packages)', async () => {
+    const newPackagePath = join(fixturesRoot, 'lerna-workspace');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'lerna-workspace-b': { latest: '2.0.0' },
+          'external-a': { latest: '2.0.0' },
+          'external-b': { latest: '2.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 2 dependencies...' },
+      { type: 'log', message: 'Changes:' },
+      { type: 'log', message: '  external-b     ^1.0.0 -> ^2.0.0' },
+      { type: 'log', message: '  external-a     ^1.0.0 -> ^2.0.0' },
+    ]);
+  });
+
+  it('should skip pinned packages', async () => {
+    const newPackagePath = join(fixturesRoot, 'dependencies-pinned');
+    const { log, logError, output } = createMockOutput();
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await upgrade({
+      dryRun: true,
+      directoryPath: newPackagePath,
+      registryUrl: '',
+      createRegistry: () =>
+        createMockRegistry({
+          'package-a': { latest: '2.0.0' },
+          'package-b': { latest: '2.0.0' },
+        }),
+      log,
+      logError,
+    });
+
+    expect(output).to.eql([
+      { type: 'log', message: 'Getting "latest" version for 2 dependencies...' },
+      { type: 'log', message: 'Changes:' },
+      { type: 'log', message: '  package-a     ~1.0.0 -> ~2.0.0' },
+      { type: 'log', message: 'Skipped:' },
+      { type: 'log', message: '  package-b     ~1.0.0 -> ~2.0.0 (broken stuff)' },
+    ]);
+  });
+});