refactor: use custom implementation of read-package-up

goosewobbler · goosewobbler · commit f860e3dc37e2 · 2026-03-13T10:25:42.000Z
- Added `find-up` dependency version 6.3.0 to `pnpm-lock.yaml` and `package.json`.
- Updated `@electron/asar` dependency to version 3.4.1 in `pnpm-lock.yaml`.
- Refactored imports in `launcher.ts`, `pathResolver.ts`, and other files to use the new `NormalizedReadResult` type from `package.ts` instead of `read-package-up`.
diff --git a/packages/electron-service/src/launcher.ts b/packages/electron-service/src/launcher.ts
@@ -15,10 +15,10 @@ import {
 
 const log = createLogger('wdio-electron-service', 'launcher');
 
+import type { NormalizedReadResult } from '@wdio/native-utils';
 import { readPackageUp } from '@wdio/native-utils';
 import type { Capabilities, Options, Services } from '@wdio/types';
 import getPort from 'get-port';
-import type { NormalizedReadResult } from 'read-package-up';
 import { SevereServiceError } from 'webdriverio';
 import { applyApparmorWorkaround } from './apparmor.js';
 import {
diff --git a/packages/electron-service/src/pathResolver.ts b/packages/electron-service/src/pathResolver.ts
@@ -1,7 +1,12 @@
 import { access } from 'node:fs/promises';
 import path from 'node:path';
-import { getAppBuildInfo, getBinaryPath, getElectronVersion, readPackageUp } from '@wdio/native-utils';
-import type { NormalizedReadResult } from 'read-package-up';
+import {
+  getAppBuildInfo,
+  getBinaryPath,
+  getElectronVersion,
+  type NormalizedReadResult,
+  readPackageUp,
+} from '@wdio/native-utils';
 
 /**
  * Validate that a file path exists and is accessible
diff --git a/packages/electron-service/test/pathResolver.spec.ts b/packages/electron-service/test/pathResolver.spec.ts
@@ -1,5 +1,5 @@
 import { access } from 'node:fs/promises';
-import type { NormalizedReadResult } from 'read-package-up';
+import type { NormalizedReadResult } from '@wdio/native-utils';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { resolveAppPaths, validateFilePath } from '../src/pathResolver.js';
 
diff --git a/packages/native-types/src/electron.ts b/packages/native-types/src/electron.ts
@@ -4,7 +4,18 @@ import type { Mock, MockResultType, fn as vitestFn } from '@wdio/native-spy';
 import type { Capabilities, Options } from '@wdio/types';
 import type { ArchType } from 'builder-util';
 import type * as Electron from 'electron';
-import type { PackageJson } from 'read-package-up';
+
+export type PackageJson = {
+  name?: string;
+  version?: string;
+  description?: string;
+  main?: string;
+  type?: string;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+  [key: string]: unknown;
+};
+
 import type {
   AbstractFn,
   BaseServiceGlobalOptions,
@@ -433,4 +444,4 @@ export interface ElectronBrowserExtension extends BrowserBase {
 }
 
 // Re-export types needed for global declarations
-export type { Electron, PackageJson, vitestFn };
+export type { Electron, vitestFn };
diff --git a/packages/native-types/src/index.ts b/packages/native-types/src/index.ts
@@ -41,6 +41,12 @@ export type {
   WdioElectronWindowObj,
   WebdriverClientFunc,
 } from './electron.js';
+// Package.json types
+export type {
+  NormalizedPackageJson,
+  NormalizedReadResult,
+  ReadPackageUpOptions,
+} from './package.js';
 // Shared types
 export type {
   AbstractFn,
diff --git a/packages/native-types/src/package.ts b/packages/native-types/src/package.ts
@@ -0,0 +1,29 @@
+export type NormalizedPackageJson = {
+  name?: string;
+  version?: string;
+  description?: string;
+  main?: string;
+  type?: string;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+  build?: {
+    extends?: string | string[] | null;
+    productName?: string;
+    directories?: { output?: string };
+    executableName?: string;
+    [key: string]: unknown;
+  };
+  forge?: unknown;
+  exports?: Record<string, unknown>;
+  module?: string;
+  [key: string]: unknown;
+};
+
+export type NormalizedReadResult = {
+  packageJson: NormalizedPackageJson;
+  path: string;
+};
+
+export type ReadPackageUpOptions = {
+  cwd?: string | URL;
+};
diff --git a/packages/native-utils/package.json b/packages/native-utils/package.json
@@ -43,6 +43,7 @@
     "debug": "^4.4.3",
     "deepmerge-ts": "^7.1.5",
     "esbuild": "^0.27.3",
+    "find-up": "^6.3.0",
     "find-versions": "^6.0.0",
     "json5": "^2.2.3",
     "read-package-up": "^12.0.0",
diff --git a/packages/native-utils/src/appBuildInfo.ts b/packages/native-utils/src/appBuildInfo.ts
@@ -1,5 +1,4 @@
 import type { AppBuildInfo } from '@wdio/native-types';
-import type { NormalizedReadResult } from 'read-package-up';
 import { getConfig as getBuilderConfig } from './config/builder.js';
 import { getConfig as getForgeConfig } from './config/forge.js';
 import {
@@ -9,6 +8,7 @@ import {
   MULTIPLE_BUILD_TOOL_WARNING,
 } from './constants.js';
 import { createLogger } from './log.js';
+import type { NormalizedReadResult } from './package.js';
 
 const log = createLogger('electron-service', 'config');
 
diff --git a/packages/native-utils/src/config/builder.ts b/packages/native-utils/src/config/builder.ts
@@ -1,9 +1,9 @@
 import path from 'node:path';
 import type { BuilderBuildInfo, BuilderConfig } from '@wdio/native-types';
 import { deepmerge as deepMerge } from 'deepmerge-ts';
-import type { NormalizedReadResult } from 'read-package-up';
 import { APP_NAME_DETECTION_ERROR } from '../constants.js';
 import { createLogger } from '../log.js';
+import type { NormalizedReadResult } from '../package.js';
 import { readConfig } from './read.js';
 
 const log = createLogger('electron-service', 'config');
@@ -13,7 +13,7 @@ export async function getConfig(
   customConfigPath?: string,
 ): Promise<BuilderBuildInfo | undefined> {
   const rootDir = path.dirname(pkg.path);
-  let builderConfig: BuilderConfig = pkg.packageJson.build;
+  let builderConfig: BuilderConfig | undefined = pkg.packageJson.build;
   let configDir = rootDir;
 
   // If custom config path provided, use it directly
@@ -82,7 +82,7 @@ function getBuilderConfigCandidates(configFileName = 'electron-builder') {
 
 function builderBuildInfo(builderConfig: BuilderConfig, pkg: NormalizedReadResult): BuilderBuildInfo {
   log.debug(`Builder configuration detected: \n${JSON.stringify(builderConfig)}`);
-  const appName: string = pkg.packageJson.productName || builderConfig?.productName || pkg.packageJson.name;
+  const appName = ((pkg.packageJson.productName || builderConfig?.productName || pkg.packageJson.name) as string) ?? '';
 
   if (!appName) {
     throw new Error(APP_NAME_DETECTION_ERROR);
diff --git a/packages/native-utils/src/config/forge.ts b/packages/native-utils/src/config/forge.ts
@@ -1,15 +1,16 @@
 import path from 'node:path';
 import type { ForgeBuildInfo, ForgeConfig } from '@wdio/native-types';
-import type { NormalizedReadResult } from 'read-package-up';
 import { APP_NAME_DETECTION_ERROR } from '../constants.js';
 import { createLogger } from '../log.js';
+import type { NormalizedReadResult } from '../package.js';
 import { readConfig } from './read.js';
 
 const log = createLogger('electron-service', 'config');
 
 function forgeBuildInfo(forgeConfig: ForgeConfig, pkg: NormalizedReadResult): ForgeBuildInfo {
   log.debug(`Forge configuration detected: \n${JSON.stringify(forgeConfig)}`);
-  const appName: string = pkg.packageJson.productName || forgeConfig?.packagerConfig?.name || pkg.packageJson.name;
+  const appName =
+    ((pkg.packageJson.productName || forgeConfig?.packagerConfig?.name || pkg.packageJson.name) as string) ?? '';
 
   if (!appName) {
     throw new Error(APP_NAME_DETECTION_ERROR);
@@ -24,7 +25,8 @@ function forgeBuildInfo(forgeConfig: ForgeConfig, pkg: NormalizedReadResult): Fo
 }
 
 export async function getConfig(pkg: NormalizedReadResult): Promise<ForgeBuildInfo | undefined> {
-  const forgePackageJsonConfig = pkg.packageJson.config?.forge;
+  const pkgJson = pkg.packageJson as { config?: { forge?: unknown }; productName?: string };
+  const forgePackageJsonConfig = pkgJson.config?.forge;
   // if config.forge is a string it is a custom config file path
   const isConfigFilePath = typeof forgePackageJsonConfig === 'string';
 
diff --git a/packages/native-utils/src/electronVersion.ts b/packages/native-utils/src/electronVersion.ts
@@ -1,7 +1,7 @@
 import { dirname } from 'node:path';
 import findVersions from 'find-versions';
-import type { NormalizedReadResult } from 'read-package-up';
 import { PKG_NAME_ELECTRON, PNPM_CATALOG_PREFIX } from './constants.js';
+import type { NormalizedReadResult } from './package.js';
 import { findPnpmCatalogVersion } from './pnpm.js';
 
 export async function getElectronVersion(pkg: NormalizedReadResult) {
diff --git a/packages/native-utils/src/index.ts b/packages/native-utils/src/index.ts
@@ -15,7 +15,7 @@ export {
 } from './diagnostics.js';
 export { getElectronVersion } from './electronVersion.js';
 export type { LogArea } from './log.js';
-export { readPackageUp } from './package.js';
+export { type NormalizedReadResult, readPackageUp, readPackageUpSync } from './package.js';
 export {
   Err,
   isErr,
diff --git a/packages/native-utils/src/package.ts b/packages/native-utils/src/package.ts
@@ -1,6 +1,39 @@
-import type { NormalizedReadResult } from 'read-package-up';
+import { readFileSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { cwd } from 'node:process';
+import type { NormalizedPackageJson, NormalizedReadResult, ReadPackageUpOptions } from '@wdio/native-types';
+import { findUp, findUpSync } from 'find-up';
 
-export async function readPackageUp(options: { cwd: string }): Promise<NormalizedReadResult | undefined> {
-  const { readPackageUp: readPkg } = await import('read-package-up');
-  return readPkg(options);
+export type { NormalizedPackageJson, NormalizedReadResult, ReadPackageUpOptions };
+
+export async function readPackageUp(options: ReadPackageUpOptions = {}): Promise<NormalizedReadResult | undefined> {
+  const cwdPath = typeof options.cwd === 'string' ? options.cwd : options.cwd?.pathname || cwd();
+  const filePath = await findUp('package.json', { cwd: cwdPath });
+  if (!filePath) {
+    return undefined;
+  }
+
+  const content = await readFile(filePath, 'utf-8');
+  const packageJson = JSON.parse(content) as NormalizedPackageJson;
+
+  return {
+    packageJson,
+    path: filePath,
+  };
+}
+
+export function readPackageUpSync(options: ReadPackageUpOptions = {}): NormalizedReadResult | undefined {
+  const cwdPath = typeof options.cwd === 'string' ? options.cwd : options.cwd?.pathname || cwd();
+  const filePath = findUpSync('package.json', { cwd: cwdPath });
+  if (!filePath) {
+    return undefined;
+  }
+
+  const content = readFileSync(filePath, 'utf-8');
+  const packageJson = JSON.parse(content) as NormalizedPackageJson;
+
+  return {
+    packageJson,
+    path: filePath,
+  };
 }
diff --git a/packages/native-utils/test/electronVersion.spec.ts b/packages/native-utils/test/electronVersion.spec.ts
@@ -1,6 +1,6 @@
-import type { NormalizedPackageJson, NormalizedReadResult } from 'read-package-up';
 import { describe, expect, it, vi } from 'vitest';
 import { getElectronVersion } from '../src/electronVersion.js';
+import type { NormalizedPackageJson, NormalizedReadResult } from '../src/package.js';
 import { findPnpmCatalogVersion } from '../src/pnpm.js';
 
 vi.mock('../src/pnpm', async () => {
diff --git a/packages/native-utils/test/package.spec.ts b/packages/native-utils/test/package.spec.ts
@@ -0,0 +1,70 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { readPackageUp, readPackageUpSync } from '../src/package.js';
+
+describe('readPackageUp', () => {
+  const testDir = path.resolve(process.cwd(), 'test-tmp-package-up');
+  const pkgJsonPath = path.join(testDir, 'package.json');
+
+  beforeAll(async () => {
+    await fs.mkdir(testDir, { recursive: true });
+    await fs.writeFile(
+      pkgJsonPath,
+      JSON.stringify({
+        name: 'test-package',
+        version: '1.0.0',
+      }),
+    );
+  });
+
+  afterAll(async () => {
+    await fs.rm(testDir, { recursive: true, force: true });
+  });
+
+  it('should find package.json in parent directories', async () => {
+    const result = await readPackageUp({ cwd: testDir });
+    expect(result).toBeDefined();
+    expect(result?.packageJson.name).toBe('test-package');
+    expect(result?.packageJson.version).toBe('1.0.0');
+    expect(result?.path).toBe(pkgJsonPath);
+  });
+
+  it('should return undefined when package.json is not found', async () => {
+    const result = await readPackageUp({ cwd: '/' });
+    expect(result).toBeUndefined();
+  });
+});
+
+describe('readPackageUpSync', () => {
+  const testDir = path.resolve(process.cwd(), 'test-tmp-package-up-sync');
+  const pkgJsonPath = path.join(testDir, 'package.json');
+
+  beforeAll(async () => {
+    await fs.mkdir(testDir, { recursive: true });
+    await fs.writeFile(
+      pkgJsonPath,
+      JSON.stringify({
+        name: 'test-package-sync',
+        version: '2.0.0',
+      }),
+    );
+  });
+
+  afterAll(async () => {
+    await fs.rm(testDir, { recursive: true, force: true });
+  });
+
+  it('should find package.json synchronously', () => {
+    const result = readPackageUpSync({ cwd: testDir });
+    expect(result).toBeDefined();
+    expect(result?.packageJson.name).toBe('test-package-sync');
+    expect(result?.packageJson.version).toBe('2.0.0');
+    expect(result?.path).toBe(pkgJsonPath);
+  });
+
+  it('should return undefined when package.json is not found', () => {
+    const result = readPackageUpSync({ cwd: '/' });
+    expect(result).toBeUndefined();
+  });
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/turbo.json b/turbo.json
@@ -123,11 +123,11 @@
       "cache": false
     },
     "@wdio/bundler#build": {
-      "dependsOn": ["typecheck"],
+      "dependsOn": ["@wdio/native-types#build", "typecheck"],
       "outputs": ["dist/**"]
     },
     "@wdio/native-types#build": {
-      "dependsOn": ["@wdio/bundler#build", "typecheck"],
+      "dependsOn": ["typecheck"],
       "outputs": ["dist/**"]
     },
     "@wdio/native-utils#build": {
@@ -164,7 +164,7 @@
       "outputs": ["dist/**"]
     },
     "@wdio/native-spy#build": {
-      "dependsOn": ["@wdio/bundler#build", "typecheck"],
+      "dependsOn": ["typecheck"],
       "outputs": ["dist/**"]
     },
     "electron-builder-e2e-app#build": {
