vercel/packages/cli/test/unit/util/dev/builder-cache.test.ts

import npa from 'npm-package-arg';
import {
  filterPackage,
  getBuildUtils,
  isBundledBuilder,
} from '../../../../src/util/dev/builder-cache';

describe('filterPackage', () => {
  const cliPkg = {
    dependencies: {
      '@vercel/build-utils': '0.0.1',
    },
  };

  it('should filter package that does not appear in CLI package.json', () => {
    const result = filterPackage('@vercel/other', {}, cliPkg);
    expect(result).toEqual(true);
  });

  it('should not filter "latest", cached canary', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1-canary.0',
      },
    };
    const result = filterPackage('@vercel/build-utils', buildersPkg, cliPkg);
    expect(result).toEqual(false);
  });

  it('should filter install "canary", cached stable', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1',
      },
    };
    const result = filterPackage(
      '@vercel/build-utils@canary',
      buildersPkg,
      cliPkg
    );
    expect(result).toEqual(false);
  });

  it('should filter install "latest", cached stable', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1',
      },
    };
    const result = filterPackage('@vercel/build-utils', buildersPkg, cliPkg);
    expect(result).toEqual(false);
  });

  it('should filter install "canary", cached canary', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1-canary.0',
      },
    };
    const result = filterPackage(
      '@vercel/build-utils@canary',
      buildersPkg,
      cliPkg
    );
    expect(result).toEqual(false);
  });

  it('should filter install URL, cached stable', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1',
      },
    };
    const result = filterPackage('https://tarball.now.sh', buildersPkg, cliPkg);
    expect(result).toEqual(true);
  });

  it('should filter install URL, cached canary', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': '0.0.1-canary.0',
      },
    };
    const result = filterPackage('https://tarball.now.sh', buildersPkg, cliPkg);
    expect(result).toEqual(true);
  });

  it('should filter install "latest", cached URL - canary', () => {
    const buildersPkg = {
      dependencies: {
        '@vercel/build-utils': 'https://tarball.now.sh',
      },
    };
    const result = filterPackage('@vercel/build-utils', buildersPkg, cliPkg);
    expect(result).toEqual(false);
  });

  it('should filter install not bundled version, cached same version', () => {
    const buildersPkg = {
      dependencies: {
        'not-bundled-package': '0.0.1',
      },
    };
    const result = filterPackage(
      'not-bundled-package@0.0.1',
      buildersPkg,
      cliPkg
    );
    expect(result).toEqual(false);
  });

  it('should filter install not bundled version, cached different version', () => {
    const buildersPkg = {
      dependencies: {
        'not-bundled-package': '0.0.9',
      },
    };
    const result = filterPackage(
      'not-bundled-package@0.0.1',
      buildersPkg,
      cliPkg
    );
    expect(result).toEqual(true);
  });

  it('should filter install not bundled stable, cached version', () => {
    const buildersPkg = {
      dependencies: {
        'not-bundled-package': '0.0.1',
      },
    };
    const result = filterPackage('not-bundled-package', buildersPkg, cliPkg);
    expect(result).toEqual(true);
  });

  it('should filter install not bundled tagged, cached tagged', () => {
    const buildersPkg = {
      dependencies: {
        'not-bundled-package': '16.9.0-alpha.0',
      },
    };
    const result = filterPackage(
      'not-bundled-package@alpha',
      buildersPkg,
      cliPkg
    );
    expect(result).toEqual(true);
  });
});

describe('getBuildUtils', () => {
  const tests: [string[], string][] = [
    [['@vercel/static', '@vercel/node@canary'], 'canary'],
    [['@vercel/static', '@vercel/node@0.7.4-canary.0'], 'canary'],
    [['@vercel/static', '@vercel/node@0.8.0'], 'latest'],
    [['@vercel/static', '@vercel/node'], 'latest'],
    [['@vercel/static'], 'latest'],
    [['@vercel/md@canary'], 'canary'],
    [['custom-builder'], 'latest'],
    [['custom-builder@canary'], 'canary'],
    [['canary-bird'], 'latest'],
    [['canary-bird@4.0.0'], 'latest'],
    [['canary-bird@canary'], 'canary'],
    [['@canary/bird'], 'latest'],
    [['@canary/bird@0.1.0'], 'latest'],
    [['@canary/bird@canary'], 'canary'],
    [['https://example.com'], 'latest'],
    [[''], 'latest'],
  ];

  for (const [input, expected] of tests) {
    it(`should install "${expected}" with input ${JSON.stringify(
      input
    )}`, () => {
      const result = getBuildUtils(input);
      expect(result).toEqual(`@vercel/build-utils@${expected}`);
    });
  }
});

describe('isBundledBuilder', () => {
  const cliPkg = {
    dependencies: {
      '@vercel/node': '0.0.1',
    },
  };

  it('should not detect when dependency does not appear in CLI package.json', () => {
    const parsed = npa('@vercel/node');
    const result = isBundledBuilder(parsed, {});
    expect(result).toEqual(false);
  });

  it('should detect "canary" tagged releases', () => {
    const parsed = npa('@vercel/node@canary');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(true);
  });

  it('should detect "canary" versioned releases', () => {
    const parsed = npa('@vercel/node@1.6.1-canary.0');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(true);
  });

  it('should detect latest releases', () => {
    const parsed = npa('@vercel/node');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(true);
  });

  it('should detect "latest" tagged releases', () => {
    const parsed = npa('@vercel/node@latest');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(true);
  });

  it('should detect versioned releases', () => {
    const parsed = npa('@vercel/node@1.6.1');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(true);
  });

  it('should NOT detect URL releases', () => {
    const parsed = npa('https://example.com');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(false);
  });

  it('should NOT detect git url releases', () => {
    const parsed = npa('git://example.com/repo.git');
    const result = isBundledBuilder(parsed, cliPkg);
    expect(result).toEqual(false);
  });
});