@wdio/electron-utils/test/pnpm.spec.ts

Utilities for WebdriverIO Electron Service

import fs from 'node:fs/promises';
import path from 'node:path';

import { expect, it, vi, describe } from 'vitest';
import { findPnpmCatalogVersion } from '../src/pnpm.js';
import { PKG_NAME_ELECTRON, PNPM_WORKSPACE_YAML } from '../src/constants.js';

function getPnpmFixtureDirPath(subPath?: string[]) {
  const fixtureDir = path.resolve(process.cwd(), '..', '..', 'fixtures', 'pnpm');
  if (subPath) {
    return path.join(fixtureDir, ...subPath);
  }
  return fixtureDir;
}

// Additional tests for findPnpmCatalogVersion to cover edge cases
describe('PNPM Catalog Versions Edge Cases', () => {
  it('should handle default catalog names', async () => {
    const readFileSpy = vi.spyOn(fs, 'readFile');
    const version = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.STABLE, 'catalog:', getPnpmFixtureDirPath());
    expect(version).toBe('^29.4.1');
    expect(readFileSpy).toHaveBeenCalled();
  });

  it('should handle named catalog names', async () => {
    const readFileSpy = vi.spyOn(fs, 'readFile');
    const version = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.STABLE, 'catalog:sample1', getPnpmFixtureDirPath());
    expect(version).toBe('^35.0.3');
    // expect cache would be work, not read the file when same project directory path were inputted.
    expect(readFileSpy).not.toHaveBeenCalled();
  });

  it('should handle default catalog names of nightly-version', async () => {
    const version = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.NIGHTLY, 'catalog:', getPnpmFixtureDirPath());
    expect(version).toBe('33.0.0-nightly.20240621');
  });

  it('should handle named catalog names of nightly-version', async () => {
    const version = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.NIGHTLY, 'catalog:sample2', getPnpmFixtureDirPath());
    expect(version).toBe('^37.0.0-nightly.20250320');
  });

  it('should return undefined when projectDir is not set', async () => {
    const version = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.STABLE, 'catalog:not-exist');
    expect(version).toBeUndefined();
  });

  it('should return undefined when catalog name which not exist is set', async () => {
    const version = await findPnpmCatalogVersion(
      PKG_NAME_ELECTRON.STABLE,
      'catalog:not-exist',
      getPnpmFixtureDirPath(),
    );
    expect(version).toBeUndefined();
  });

  it('should return undefined when pnpm-workspace.yaml was not found', async () => {
    const version = await findPnpmCatalogVersion(
      PKG_NAME_ELECTRON.STABLE,
      'catalog:name',
      path.parse(getPnpmFixtureDirPath()).root,
    );
    expect(version).toBeUndefined();
  });

  it('should handle YAML parse errors', async () => {
    const version = await findPnpmCatalogVersion(
      PKG_NAME_ELECTRON.STABLE,
      'catalog:name',
      getPnpmFixtureDirPath(['packages', 'app2']),
    );
    expect(version).toBeUndefined();
  });

  it('should handle other errors in findPnpmCatalogVersion', async () => {
    // Mock a function that throws an error when called
    vi.spyOn(fs, 'readFile').mockImplementation(() => {
      throw new Error('Some unexpected error');
    });

    // the catch block in findPnpmCatalogVersion
    const result = await findPnpmCatalogVersion(PKG_NAME_ELECTRON.STABLE, 'catalog:', '/non-existent-dir');
    expect(result).toBeUndefined();
  });

  it('should traverse up directory tree to find pnpm-workspace.yaml', async () => {
    const readFileSpy = vi.spyOn(fs, 'readFile');

    const version = await findPnpmCatalogVersion(
      PKG_NAME_ELECTRON.STABLE,
      'catalog:sample1',
      getPnpmFixtureDirPath(['packages', 'app1']),
    );

    // Should find the version in parent directory
    expect(version).toBe('^35.0.3');

    // Verify that readFile was called multiple times as it traversed up
    expect(readFileSpy).toHaveBeenCalledTimes(3);

    // Normalize paths to forward slashes for comparison
    expect(readFileSpy).toHaveBeenNthCalledWith(
      1,
      path.join(getPnpmFixtureDirPath(['packages', 'app1']), PNPM_WORKSPACE_YAML),
      'utf8',
    );
    expect(readFileSpy).toHaveBeenNthCalledWith(
      2,
      path.join(getPnpmFixtureDirPath(['packages']), PNPM_WORKSPACE_YAML),
      'utf8',
    );
    expect(readFileSpy).toHaveBeenNthCalledWith(3, path.join(getPnpmFixtureDirPath([]), PNPM_WORKSPACE_YAML), 'utf8');
  });
});