@link-assistant/web-capture 2.0.0 → 2.0.1

package/examples/js/image_download.js

@@ -1,36 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const url = process.argv[2] || 'https://example.com';
-const endpoint = `http://localhost:3000/image?url=${encodeURIComponent(url)}`;
-
-fetch(endpoint)
-  .then((res) => {
-    console.log('Status:', res.status);
-    console.log('Content-Type:', res.headers.get('content-type'));
-    if (!res.ok) {
-      throw new Error(`HTTP error! status: ${res.status}`);
-    }
-    return res.arrayBuffer();
-  })
-  .then((buffer) => {
-    const buf = Buffer.from(buffer);
-    const pngSignature = Buffer.from([
-      0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a,
-    ]);
-    if (buf.slice(0, 8).equals(pngSignature)) {
-      const outputPath = path.join(__dirname, 'downloaded.png');
-      fs.writeFileSync(outputPath, buf);
-      console.log(`Image saved to ${outputPath} (valid PNG)`);
-    } else {
-      console.log(
-        'Response is not a valid PNG! First bytes:',
-        buf.slice(0, 16)
-      );
-    }
-  })
-  .catch((err) => {
-    console.error('Error:', err);
-  });

package/examples/js/markdown_download.js

@@ -1,23 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const url = process.argv[2] || 'https://example.com';
-const endpoint = `http://localhost:3000/markdown?url=${encodeURIComponent(url)}`;
-
-fetch(endpoint)
-  .then((res) => {
-    if (!res.ok) {
-      throw new Error(`HTTP error! status: ${res.status}`);
-    }
-    return res.text();
-  })
-  .then((text) => {
-    const outputPath = path.join(__dirname, 'downloaded.md');
-    fs.writeFileSync(outputPath, text, 'utf-8');
-    console.log(`Markdown saved to ${outputPath}`);
-  })
-  .catch((err) => {
-    console.error('Error:', err);
-  });

package/examples/js/playwright_example.js

@@ -1,23 +0,0 @@
-import fetch from 'node-fetch';
-import fs from 'fs';
-
-const baseUrl = 'http://localhost:3000';
-const targetUrl = 'https://example.com';
-
-console.log('Fetching HTML using Playwright engine...');
-const htmlResponse = await fetch(
-  `${baseUrl}/html?url=${encodeURIComponent(targetUrl)}&engine=playwright`
-);
-const html = await htmlResponse.text();
-fs.writeFileSync('output/playwright_html.html', html);
-console.log('HTML saved to output/playwright_html.html');
-
-console.log('Fetching screenshot using Playwright engine...');
-const imageResponse = await fetch(
-  `${baseUrl}/image?url=${encodeURIComponent(targetUrl)}&engine=playwright`
-);
-const imageBuffer = Buffer.from(await imageResponse.arrayBuffer());
-fs.writeFileSync('output/playwright_screenshot.png', imageBuffer);
-console.log('Screenshot saved to output/playwright_screenshot.png');
-
-console.log('Done! Both requests used Playwright engine.');

package/examples/python/capture_client.py

@@ -1,20 +0,0 @@
-"""Shared request policy for the capture-service examples."""
-import os
-from pathlib import Path
-import sys
-import requests
-
-
-def capture(kind, url=None, **options):
-    if url is None:
-        url = sys.argv[1] if len(sys.argv) > 1 else 'https://example.com'
-    endpoint = os.environ.get('WEB_CAPTURE_URL', 'http://localhost:3000').rstrip('/')
-    response = requests.get(f'{endpoint}/{kind}', params={'url': url, **options}, timeout=30)
-    response.raise_for_status()
-    return response
-
-
-def download_text(kind, filename):
-    output = Path(__file__).with_name(filename)
-    output.write_text(capture(kind).text, encoding='utf-8')
-    print(f'{kind.title()} saved to {output}')

package/examples/python/html_download.py

@@ -1,3 +0,0 @@
-from capture_client import download_text
-
-download_text('html', 'downloaded.html')

package/examples/python/image_download.py

@@ -1,16 +0,0 @@
-from capture_client import capture
-import os
-
-response = capture('image')
-print('Status:', response.status_code)
-print('Content-Type:', response.headers.get('content-type'))
-
-# PNG signature: first 8 bytes
-png_signature = b'\x89PNG\r\n\x1a\n'
-if response.content[:8] == png_signature:
-    output_path = os.path.join(os.path.dirname(__file__), 'downloaded.png')
-    with open(output_path, 'wb') as f:
-        f.write(response.content)
-    print(f'Image saved to {output_path} (valid PNG)')
-else:
-    print('Response is not a valid PNG! First bytes:', response.content[:16])

package/examples/python/markdown_download.py

@@ -1,3 +0,0 @@
-from capture_client import download_text
-
-download_text('markdown', 'downloaded.md')

package/examples/python/playwright_example.py

@@ -1,22 +0,0 @@
-import sys
-from capture_client import capture
-import os
-
-target_url = sys.argv[1] if len(sys.argv) > 1 else 'https://example.com'
-
-# Create output directory if it doesn't exist
-os.makedirs('output', exist_ok=True)
-
-print('Fetching HTML using Playwright engine...')
-html_response = capture('html', target_url, engine='playwright')
-with open('output/playwright_html.html', 'w', encoding='utf-8') as f:
-    f.write(html_response.text)
-print('HTML saved to output/playwright_html.html')
-
-print('Fetching screenshot using Playwright engine...')
-image_response = capture('image', target_url, engine='playwright')
-with open('output/playwright_screenshot.png', 'wb') as f:
-    f.write(image_response.content)
-print('Screenshot saved to output/playwright_screenshot.png')
-
-print('Done! Both requests used Playwright engine.')

package/jest.config.mjs

@@ -1,17 +0,0 @@
-export default {
-  transform: {},
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  testEnvironment: 'node',
-  verbose: true,
-  testMatch: [
-    '**/tests/ci/**/*.test.js',
-    '**/tests/unit/**/*.test.js',
-    '**/tests/mock/**/*.test.js',
-    '**/tests/e2e/**/*.test.js',
-    '**/tests/integration/**/*.test.js',
-    '**/tests/xpaste/**/*.test.js',
-  ],
-  setupFiles: ['./tests/jest.setup.mjs'],
-};

package/tests/ci/dependency-freshness.test.js

@@ -1,74 +0,0 @@
-import { jest } from '@jest/globals';
-import { checkVersions } from '../../../scripts/check-dependency-freshness.mjs';
-
-const latest = async () => '2.0.0';
-const dependencies = [{ name: 'example', current: '1.0.0' }];
-const blockers = {
-  example: {
-    issue: 'https://github.com/example/repo/issues/1',
-    reason: 'Upstream API breaks packaged consumers',
-  },
-};
-
-test('freshness rejects old releases, missing packages and undocumented exceptions', async () => {
-  for (const current of ['1.0.0', '(missing)']) {
-    await expect(
-      checkVersions([{ name: 'example', current }], {}, latest, jest.fn())
-    ).rejects.toThrow('behind 2.0.0');
-  }
-});
-test('freshness permits only documented open issues', async () => {
-  await expect(
-    checkVersions(dependencies, blockers, latest, async () => ({
-      state: 'open',
-    }))
-  ).resolves.toBeUndefined();
-  await expect(
-    checkVersions(dependencies, blockers, latest, async () => ({
-      state: 'closed',
-    }))
-  ).rejects.toThrow('is closed');
-  await expect(
-    checkVersions(
-      dependencies,
-      { example: { ...blockers.example, reason: '' } },
-      latest,
-      jest.fn()
-    )
-  ).rejects.toThrow('document an open issue');
-  await expect(
-    checkVersions(
-      dependencies,
-      { example: { ...blockers.example, reason: '   ' } },
-      latest,
-      jest.fn()
-    )
-  ).rejects.toThrow('document an open issue');
-});
-test('registry and issue failures fail the check rather than treating dependencies as fresh', async () => {
-  await expect(
-    checkVersions(
-      dependencies,
-      {},
-      async () => {
-        throw new Error('registry down');
-      },
-      jest.fn()
-    )
-  ).rejects.toThrow('registry down');
-  await expect(
-    checkVersions(dependencies, blockers, latest, async () => {
-      throw new Error('issue unavailable');
-    })
-  ).rejects.toThrow('issue unavailable');
-});
-test('current releases need no exception', async () => {
-  const getIssue = jest.fn();
-  await checkVersions(
-    [{ name: 'example', current: '2.0.0' }],
-    {},
-    latest,
-    getIssue
-  );
-  expect(getIssue).not.toHaveBeenCalled();
-});

package/tests/ci/detect-code-changes.test.js

@@ -1,187 +0,0 @@
-import { execFileSync } from 'child_process';
-import {
-  mkdirSync,
-  mkdtempSync,
-  readFileSync,
-  rmSync,
-  writeFileSync,
-} from 'fs';
-import { tmpdir } from 'os';
-import { dirname, join, resolve } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const repoRoot = resolve(__dirname, '../../..');
-const detectorPath = resolve(repoRoot, 'scripts/detect-code-changes.mjs');
-
-function run(command, args, cwd, options = {}) {
-  return execFileSync(command, args, {
-    cwd,
-    encoding: 'utf8',
-    stdio: ['ignore', 'pipe', 'pipe'],
-    ...options,
-  });
-}
-
-function git(repoPath, args) {
-  return run('git', args, repoPath);
-}
-
-function writeTrackedFile(repoPath, relativePath, contents) {
-  const filePath = join(repoPath, relativePath);
-  mkdirSync(dirname(filePath), { recursive: true });
-  writeFileSync(filePath, contents);
-}
-
-function commitAll(repoPath, message) {
-  git(repoPath, ['add', '.']);
-  git(repoPath, ['commit', '-m', message]);
-}
-
-function createMergedFeatureRepo({
-  featureCode = true,
-  baseCode = false,
-} = {}) {
-  const repoPath = mkdtempSync(join(tmpdir(), 'web-capture-detect-'));
-
-  initializeRepo(repoPath);
-
-  writeTrackedFile(repoPath, 'README.md', '# fixture\n');
-  commitAll(repoPath, 'initial commit');
-
-  git(repoPath, ['checkout', '-b', 'feature']);
-  if (featureCode) {
-    writeTrackedFile(repoPath, 'rust/src/lib.rs', 'pub fn capture() {}\n');
-    commitAll(repoPath, 'add rust code');
-  }
-
-  writeTrackedFile(repoPath, 'docs/notes.md', '# docs only tail commit\n');
-  commitAll(repoPath, 'document rust change');
-
-  git(repoPath, ['checkout', 'main']);
-  if (baseCode) {
-    writeTrackedFile(repoPath, 'rust/src/lib.rs', 'pub fn base_capture() {}\n');
-    commitAll(repoPath, 'base branch code change');
-  }
-  git(repoPath, ['merge', '--no-ff', 'feature', '-m', 'merge feature']);
-
-  return repoPath;
-}
-
-function createSingleCommitRepo() {
-  return createSingleCommitRepoWithFiles({
-    'js/src/index.js': 'export const ok = true;\n',
-  });
-}
-
-function createSingleCommitRepoWithFiles(files) {
-  const repoPath = mkdtempSync(join(tmpdir(), 'web-capture-detect-'));
-
-  initializeRepo(repoPath);
-  for (const [relativePath, contents] of Object.entries(files)) {
-    writeTrackedFile(repoPath, relativePath, contents);
-  }
-  commitAll(repoPath, 'initial commit');
-
-  return repoPath;
-}
-
-function initializeRepo(repoPath) {
-  git(repoPath, ['init']);
-  git(repoPath, ['config', 'user.email', 'ci@example.test']);
-  git(repoPath, ['config', 'user.name', 'CI Test']);
-  git(repoPath, ['checkout', '-b', 'main']);
-}
-
-function parseOutputs(outputFile) {
-  return Object.fromEntries(
-    readFileSync(outputFile, 'utf8')
-      .trim()
-      .split('\n')
-      .filter(Boolean)
-      .map((line) => {
-        const separatorIndex = line.indexOf('=');
-        return [line.slice(0, separatorIndex), line.slice(separatorIndex + 1)];
-      })
-  );
-}
-
-function runDetector(repoPath, eventName) {
-  const outputFile = join(repoPath, `github-output-${eventName}.txt`);
-  const env = {
-    ...process.env,
-    GITHUB_EVENT_NAME: eventName,
-    GITHUB_OUTPUT: outputFile,
-  };
-  delete env.GITHUB_BASE_SHA;
-  delete env.GITHUB_HEAD_SHA;
-
-  run(process.execPath, [detectorPath], repoPath, { env });
-
-  return parseOutputs(outputFile);
-}
-
-describe('detect-code-changes', () => {
-  let repoPath;
-
-  afterEach(() => {
-    if (repoPath) {
-      rmSync(repoPath, { recursive: true, force: true });
-      repoPath = undefined;
-    }
-  });
-
-  test.each(['push', 'pull_request'])(
-    'detects code before a docs-only final commit for %s',
-    (eventName) => {
-      repoPath = createMergedFeatureRepo();
-
-      expect(runDetector(repoPath, eventName)).toMatchObject({
-        'rust-code-changed': 'true',
-        'rust-changed': 'true',
-        'any-rust-code-changed': 'true',
-        'any-code-changed': 'true',
-        'docs-changed': 'true',
-      });
-    }
-  );
-
-  test.each([
-    ['docs-only', { featureCode: false }],
-    ['base branch code only', { featureCode: false, baseCode: true }],
-  ])('keeps code checks disabled for %s PRs', (_name, options) => {
-    repoPath = createMergedFeatureRepo(options);
-
-    expect(runDetector(repoPath, 'pull_request')).toMatchObject({
-      'rust-code-changed': 'false',
-      'any-code-changed': 'false',
-      'docs-changed': 'true',
-    });
-  });
-
-  test('detects files when a push only has one commit', () => {
-    repoPath = createSingleCommitRepo();
-
-    const outputs = runDetector(repoPath, 'push');
-
-    expect(outputs['js-code-changed']).toBe('true');
-    expect(outputs['js-changed']).toBe('true');
-    expect(outputs['any-js-code-changed']).toBe('true');
-    expect(outputs['any-code-changed']).toBe('true');
-  });
-
-  test('runs JS checks for CI tests without requiring a changeset', () => {
-    repoPath = createSingleCommitRepoWithFiles({
-      'js/jest.config.mjs': 'export default {};\n',
-      'js/tests/ci/workflow-policy.test.js': 'test("ok", () => {});\n',
-    });
-
-    const outputs = runDetector(repoPath, 'push');
-
-    expect(outputs['js-code-changed']).toBe('false');
-    expect(outputs['js-changed']).toBe('true');
-    expect(outputs['any-js-code-changed']).toBe('true');
-    expect(outputs['any-code-changed']).toBe('true');
-  });
-});

package/tests/ci/docker-install.test.js

@@ -1,31 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { spawnSync } from 'node:child_process';
-
-test.each(['js', 'rust'])(
-  '%s Docker build fails when every browser package installation attempt fails',
-  (implementation) => {
-    const dockerfile = readFileSync(
-      new globalThis.URL(
-        `../../../${implementation}/Dockerfile`,
-        import.meta.url
-      ),
-      'utf8'
-    );
-    const loop = dockerfile.match(/for i in 1 2 3; do[\s\S]*?done/)[0];
-    // Execute only the finite retry loop; stub installation and waiting.
-    const result = spawnSync(
-      'bash',
-      [
-        '-c',
-        `
-      apt-get() { printf '%s\\n' "$1"; [ "$1" = update ]; }
-      sleep() { return 0; }
-      ${loop}
-    `,
-      ],
-      { encoding: 'utf8' }
-    );
-    expect(result.stdout.match(/^install$/gm)).toHaveLength(3);
-    expect(result.status).toBe(1);
-  }
-);

package/tests/ci/rust-dockerfile.test.js

@@ -1,54 +0,0 @@
-import { readFileSync } from 'fs';
-import { dirname, resolve } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const repoRoot = resolve(__dirname, '../../..');
-
-function parseVersion(version) {
-  return version.split('.').map((part) => Number(part));
-}
-
-function compareVersions(left, right) {
-  const leftParts = parseVersion(left);
-  const rightParts = parseVersion(right);
-  const maxLength = Math.max(leftParts.length, rightParts.length);
-
-  for (let index = 0; index < maxLength; index += 1) {
-    const leftPart = leftParts[index] || 0;
-    const rightPart = rightParts[index] || 0;
-
-    if (leftPart !== rightPart) {
-      return leftPart - rightPart;
-    }
-  }
-
-  return 0;
-}
-
-describe('Rust Dockerfile', () => {
-  test('uses a Rust builder image that satisfies Cargo.toml rust-version', () => {
-    const cargoToml = readFileSync(
-      resolve(repoRoot, 'rust/Cargo.toml'),
-      'utf8'
-    );
-    const dockerfile = readFileSync(
-      resolve(repoRoot, 'rust/Dockerfile'),
-      'utf8'
-    );
-
-    const requiredRustVersion = cargoToml.match(
-      /^rust-version = "([^"]+)"/m
-    )?.[1];
-    const dockerRustVersion = dockerfile.match(
-      /^FROM rust:(\d+(?:\.\d+){1,2})[-\s]/m
-    )?.[1];
-
-    expect(requiredRustVersion).toBeDefined();
-    expect(dockerRustVersion).toBeDefined();
-    expect(
-      compareVersions(dockerRustVersion, requiredRustVersion)
-    ).toBeGreaterThanOrEqual(0);
-  });
-});

package/tests/ci/workflow-policy.test.js

@@ -1,79 +0,0 @@
-import { readFileSync } from 'fs';
-import { dirname, resolve } from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const repoRoot = resolve(__dirname, '../../..');
-
-const workflowFiles = [
-  '.github/workflows/js.yml',
-  '.github/workflows/rust.yml',
-  '.github/workflows/parity.yml',
-];
-
-function readRootFile(relativePath) {
-  return readFileSync(resolve(repoRoot, relativePath), 'utf8');
-}
-
-function readWorkflow(relativePath) {
-  return readRootFile(relativePath);
-}
-
-describe('workflow policy', () => {
-  test.each(workflowFiles)(
-    '%s uses release-safe concurrency cancellation',
-    (workflowFile) => {
-      const workflow = readWorkflow(workflowFile);
-
-      expect(workflow).toContain(
-        "cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}"
-      );
-      expect(workflow).not.toContain(
-        "cancel-in-progress: ${{ github.ref == 'refs/heads/main' }}"
-      );
-    }
-  );
-
-  test.each(workflowFiles)(
-    '%s uses the current checkout action',
-    (workflowFile) => {
-      const workflow = readWorkflow(workflowFile);
-
-      expect(workflow).toContain('uses: actions/checkout@v7.0.1');
-      expect(workflow).not.toContain('uses: actions/checkout@v4');
-    }
-  );
-
-  test('Rust workflow uses the current cache action', () => {
-    const workflow = readWorkflow('.github/workflows/rust.yml');
-
-    expect(workflow).toContain('uses: actions/cache@v6.1.0');
-    expect(workflow).not.toContain('uses: actions/cache@v4');
-  });
-
-  test('parity check ignores repository-level CI tests', () => {
-    const parityScript = readRootFile('scripts/check-js-rust-parity.mjs');
-
-    expect(parityScript).toContain('"js/tests/ci/"');
-    expect(parityScript).toContain(
-      'matchingFiles(files, JS_PARITY_PATHS, JS_PARITY_IGNORE_PATHS)'
-    );
-  });
-});
-
-test('release workflows require dependency health gates', () => {
-  const js = readWorkflow('.github/workflows/js.yml');
-  expect(js).toContain('npm audit --package-lock-only --audit-level=moderate');
-  expect(js).toContain('check-dependency-freshness.mjs npm');
-  expect(js).toContain('needs: [lint, test, dependency-health]');
-  const rust = readWorkflow('.github/workflows/rust.yml');
-  expect(rust).toContain('check-dependency-freshness.mjs cargo');
-  expect(rust).toContain('cargo update --dry-run');
-  expect(rust).toContain('needs: [lint, test, build, dependency-health]');
-  for (const workflow of [js, rust]) {
-    expect(
-      workflow.match(/needs\.dependency-health\.result == 'success'/g)
-    ).toHaveLength(2);
-  }
-});