selenium-pw-migrator 0.0.0-preview.8

package/README.md

@@ -0,0 +1,47 @@
+# selenium-pw-migrator npm wrapper
+
+This package is a thin npm wrapper around the standalone Selenium Playwright Migrator CLI. It does **not** require the .NET SDK or .NET Runtime on the target machine.
+
+During `npm install`, the package downloads the matching standalone release archive for the current OS/architecture and stores the native CLI under `native/<runtime>/` inside the installed package.
+
+## Install
+
+```bash
+npm install -g selenium-pw-migrator
+selenium-pw-migrator --version
+```
+
+
+Install directly from a GitHub Release asset before the package is published to npm:
+
+```bash
+npm install -g https://github.com/AlexanderLevenskikh/selenium-playwright-ast-migrator/releases/download/v0.0.0-preview.5/selenium-pw-migrator-0.0.0-preview.5.tgz
+selenium-pw-migrator --version
+```
+
+Supported runtimes:
+
+- `win-x64`
+- `linux-x64`
+- `osx-x64`
+- `osx-arm64`
+
+## Configuration
+
+The installer supports these environment variables:
+
+| Variable | Purpose |
+|---|---|
+| `SELENIUM_PW_MIGRATOR_VERSION` | Override the release version to download. Defaults to the npm package version. |
+| `SELENIUM_PW_MIGRATOR_BASE_URL` | Override the GitHub/Nexus/static release asset directory. |
+| `SELENIUM_PW_MIGRATOR_RUNTIME` | Override runtime detection, for example `win-x64`. |
+| `SELENIUM_PW_MIGRATOR_ARCHIVE_PATH` | Use a local standalone archive instead of downloading. Useful for smoke tests. |
+| `SELENIUM_PW_MIGRATOR_CHECKSUMS_PATH` | Verify a local archive using a local `checksums.sha256`. |
+| `SELENIUM_PW_MIGRATOR_SKIP_DOWNLOAD` | Skip native download during install. |
+
+Example internal mirror install:
+
+```bash
+SELENIUM_PW_MIGRATOR_BASE_URL=https://nexus.example/repository/migrator/releases/v0.0.0-preview.5 \
+  npm install -g selenium-pw-migrator@0.0.0-preview.5
+```

package/bin/selenium-pw-migrator.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+'use strict';
+
+const childProcess = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const packageRoot = path.resolve(__dirname, '..');
+const SUPPORTED_RUNTIMES = new Set(['win-x64', 'linux-x64', 'osx-x64', 'osx-arm64']);
+const runtime = validateRuntime(process.env.SELENIUM_PW_MIGRATOR_RUNTIME || resolveRuntime());
+const exeName = runtime.startsWith('win-') ? 'selenium-pw-migrator.exe' : 'selenium-pw-migrator';
+const explicitInstallDir = process.env.SELENIUM_PW_MIGRATOR_INSTALL_DIR || '';
+const binaryPath = explicitInstallDir
+  ? path.join(explicitInstallDir, exeName)
+  : path.join(packageRoot, 'native', runtime, exeName);
+
+if (!fs.existsSync(binaryPath)) {
+  const installer = path.join(packageRoot, 'scripts', 'install.js');
+  const installResult = childProcess.spawnSync(process.execPath, [installer], { stdio: 'inherit' });
+  if (installResult.error) throw installResult.error;
+  if (installResult.status !== 0) process.exit(installResult.status || 1);
+}
+
+const result = childProcess.spawnSync(binaryPath, process.argv.slice(2), { stdio: 'inherit' });
+if (result.error) {
+  console.error(`[selenium-pw-migrator] Failed to start native CLI: ${result.error.message}`);
+  process.exit(1);
+}
+
+if (typeof result.status === 'number') {
+  process.exit(result.status);
+}
+
+process.exit(result.signal ? 1 : 0);
+
+function validateRuntime(value) {
+  if (!SUPPORTED_RUNTIMES.has(value)) {
+    throw new Error(`Unsupported runtime: ${value}. Supported runtimes: ${Array.from(SUPPORTED_RUNTIMES).join(', ')}`);
+  }
+  return value;
+}
+
+function resolveRuntime() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  let osPart;
+  if (platform === 'win32') osPart = 'win';
+  else if (platform === 'linux') osPart = 'linux';
+  else if (platform === 'darwin') osPart = 'osx';
+  else throw new Error(`Unsupported platform: ${platform}`);
+
+  let archPart;
+  if (arch === 'x64') archPart = 'x64';
+  else if (arch === 'arm64') archPart = 'arm64';
+  else throw new Error(`Unsupported architecture: ${arch}`);
+
+  return `${osPart}-${archPart}`;
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "selenium-pw-migrator",
+  "version": "0.0.0-preview.8",
+  "description": "Node/npm wrapper for the Selenium Playwright Migrator standalone CLI.",
+  "license": "MIT",
+  "homepage": "https://github.com/AlexanderLevenskikh/selenium-playwright-ast-migrator#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlexanderLevenskikh/selenium-playwright-ast-migrator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AlexanderLevenskikh/selenium-playwright-ast-migrator/issues"
+  },
+  "bin": {
+    "selenium-pw-migrator": "bin/selenium-pw-migrator.js"
+  },
+  "scripts": {
+    "postinstall": "node scripts/install.js",
+    "install-native": "node scripts/install.js",
+    "smoke": "node bin/selenium-pw-migrator.js --version"
+  },
+  "files": [
+    "bin/",
+    "scripts/",
+    "README.md",
+    "package.json"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}

package/scripts/install.js

@@ -0,0 +1,210 @@
+#!/usr/bin/env node
+'use strict';
+
+const childProcess = require('child_process');
+const crypto = require('crypto');
+const fs = require('fs');
+const http = require('http');
+const https = require('https');
+const os = require('os');
+const path = require('path');
+
+const packageRoot = path.resolve(__dirname, '..');
+const packageJson = require(path.join(packageRoot, 'package.json'));
+const SUPPORTED_RUNTIMES = new Set(['win-x64', 'linux-x64', 'osx-x64', 'osx-arm64']);
+
+const env = process.env;
+const skipDownload = env.SELENIUM_PW_MIGRATOR_SKIP_DOWNLOAD === '1' || env.SELENIUM_PW_MIGRATOR_SKIP_DOWNLOAD === 'true';
+const version = env.SELENIUM_PW_MIGRATOR_VERSION || packageJson.version;
+const runtime = validateRuntime(env.SELENIUM_PW_MIGRATOR_RUNTIME || resolveRuntime());
+const baseUrl = normalizeBaseUrl(env.SELENIUM_PW_MIGRATOR_BASE_URL || `https://github.com/AlexanderLevenskikh/selenium-playwright-ast-migrator/releases/download/v${version}`);
+const archivePathOverride = env.SELENIUM_PW_MIGRATOR_ARCHIVE_PATH || '';
+const checksumsPathOverride = env.SELENIUM_PW_MIGRATOR_CHECKSUMS_PATH || '';
+const installDir = env.SELENIUM_PW_MIGRATOR_INSTALL_DIR || path.join(packageRoot, 'native', runtime);
+const archiveName = resolveArchiveName(version, runtime, archivePathOverride);
+
+main().catch(error => {
+  console.error(`[selenium-pw-migrator] ${error.message}`);
+  process.exit(1);
+});
+
+async function main() {
+  if (skipDownload) {
+    console.log('[selenium-pw-migrator] Native download skipped because SELENIUM_PW_MIGRATOR_SKIP_DOWNLOAD is set.');
+    return;
+  }
+
+  fs.rmSync(installDir, { recursive: true, force: true });
+  fs.mkdirSync(installDir, { recursive: true });
+
+  const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'selenium-pw-migrator-npm-'));
+  try {
+    const archivePath = archivePathOverride
+      ? path.resolve(archivePathOverride)
+      : path.join(tempDir, archiveName);
+
+    if (archivePathOverride) {
+      if (!fs.existsSync(archivePath)) {
+        throw new Error(`SELENIUM_PW_MIGRATOR_ARCHIVE_PATH was not found: ${archivePath}`);
+      }
+      console.log(`[selenium-pw-migrator] Using local archive: ${archivePath}`);
+    } else {
+      const archiveUrl = `${baseUrl}/${archiveName}`;
+      console.log(`[selenium-pw-migrator] Downloading ${archiveUrl}`);
+      await downloadFile(archiveUrl, archivePath);
+    }
+
+    const checksumsPath = checksumsPathOverride
+      ? path.resolve(checksumsPathOverride)
+      : path.join(tempDir, 'checksums.sha256');
+
+    if (checksumsPathOverride) {
+      verifyChecksum(archivePath, checksumsPath, path.basename(archivePath));
+    } else {
+      try {
+        await downloadFile(`${baseUrl}/checksums.sha256`, checksumsPath);
+        verifyChecksum(archivePath, checksumsPath, archiveName);
+      } catch (error) {
+        console.warn(`[selenium-pw-migrator] Checksum verification skipped: ${error.message}`);
+      }
+    }
+
+    const extractDir = path.join(tempDir, 'extract');
+    fs.mkdirSync(extractDir, { recursive: true });
+    extractArchive(archivePath, extractDir, runtime);
+    copyDirectoryContents(extractDir, installDir);
+    ensureExecutable(path.join(installDir, executableName(runtime)));
+
+    console.log(`[selenium-pw-migrator] Installed native CLI to ${installDir}`);
+  } finally {
+    fs.rmSync(tempDir, { recursive: true, force: true });
+  }
+}
+
+function resolveRuntime() {
+  const platform = process.platform;
+  const arch = process.arch;
+
+  let osPart;
+  if (platform === 'win32') osPart = 'win';
+  else if (platform === 'linux') osPart = 'linux';
+  else if (platform === 'darwin') osPart = 'osx';
+  else throw new Error(`Unsupported platform: ${platform}`);
+
+  let archPart;
+  if (arch === 'x64') archPart = 'x64';
+  else if (arch === 'arm64') archPart = 'arm64';
+  else throw new Error(`Unsupported architecture: ${arch}`);
+
+  return `${osPart}-${archPart}`;
+}
+
+function validateRuntime(value) {
+  if (!SUPPORTED_RUNTIMES.has(value)) {
+    throw new Error(`Unsupported runtime: ${value}. Supported runtimes: ${Array.from(SUPPORTED_RUNTIMES).join(', ')}`);
+  }
+  return value;
+}
+
+function resolveArchiveName(packageVersion, rid, explicitArchivePath) {
+  if (explicitArchivePath) return path.basename(explicitArchivePath);
+  const extension = rid.startsWith('win-') ? '.zip' : '.tar.gz';
+  return `selenium-pw-migrator-${packageVersion}-${rid}${extension}`;
+}
+
+function normalizeBaseUrl(value) {
+  return String(value).replace(/\/+$/, '');
+}
+
+function executableName(rid) {
+  return rid.startsWith('win-') ? 'selenium-pw-migrator.exe' : 'selenium-pw-migrator';
+}
+
+function downloadFile(url, destination) {
+  return new Promise((resolve, reject) => {
+    const client = url.startsWith('https:') ? https : http;
+    const request = client.get(url, response => {
+      if (response.statusCode >= 300 && response.statusCode < 400 && response.headers.location) {
+        response.resume();
+        downloadFile(new URL(response.headers.location, url).toString(), destination).then(resolve, reject);
+        return;
+      }
+
+      if (response.statusCode !== 200) {
+        response.resume();
+        reject(new Error(`HTTP ${response.statusCode} while downloading ${url}`));
+        return;
+      }
+
+      const file = fs.createWriteStream(destination);
+      response.pipe(file);
+      file.on('finish', () => file.close(resolve));
+      file.on('error', reject);
+    });
+
+    request.on('error', reject);
+  });
+}
+
+function verifyChecksum(archivePath, checksumsPath, expectedArchiveName) {
+  if (!fs.existsSync(checksumsPath)) {
+    throw new Error(`Checksums file was not found: ${checksumsPath}`);
+  }
+
+  const checksums = fs.readFileSync(checksumsPath, 'utf8').split(/\r?\n/);
+  const escaped = escapeRegExp(expectedArchiveName);
+  const line = checksums.find(value => new RegExp(`\\s${escaped}$`).test(value.trim()));
+  if (!line) {
+    throw new Error(`No checksum entry for ${expectedArchiveName} in ${checksumsPath}`);
+  }
+
+  const expected = line.trim().split(/\s+/)[0].toLowerCase();
+  const actual = crypto.createHash('sha256').update(fs.readFileSync(archivePath)).digest('hex').toLowerCase();
+  if (expected !== actual) {
+    throw new Error(`Checksum mismatch for ${expectedArchiveName}. Expected ${expected}, actual ${actual}.`);
+  }
+
+  console.log('[selenium-pw-migrator] Checksum verified.');
+}
+
+function extractArchive(archivePath, destination, rid) {
+  if (rid.startsWith('win-')) {
+    const command = [
+      '$ErrorActionPreference = "Stop";',
+      'Expand-Archive',
+      '-LiteralPath', quotePowerShell(archivePath),
+      '-DestinationPath', quotePowerShell(destination),
+      '-Force'
+    ].join(' ');
+    run('powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command', command]);
+    return;
+  }
+
+  run('tar', ['-xzf', archivePath, '-C', destination]);
+}
+
+function run(command, args) {
+  const result = childProcess.spawnSync(command, args, { stdio: 'inherit' });
+  if (result.error) throw result.error;
+  if (result.status !== 0) throw new Error(`${command} ${args.join(' ')} failed with exit code ${result.status}`);
+}
+
+function copyDirectoryContents(source, target) {
+  for (const entry of fs.readdirSync(source)) {
+    fs.cpSync(path.join(source, entry), path.join(target, entry), { recursive: true, force: true });
+  }
+}
+
+function ensureExecutable(filePath) {
+  if (fs.existsSync(filePath) && process.platform !== 'win32') {
+    fs.chmodSync(filePath, 0o755);
+  }
+}
+
+function escapeRegExp(value) {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+function quotePowerShell(value) {
+  return `'${String(value).replace(/'/g, "''")}'`;
+}