make tests pass

Author: avivkeller

src/__tests__/generators.test.mjs

@@ -1,26 +1,27 @@
-import { readdir } from 'node:fs/promises';
-import { cpus } from 'node:os';
-import { basename, extname, join } from 'node:path';
+import { basename, join, relative, sep } from 'node:path';
 import { after, before, describe, it } from 'node:test';
 
+import { globSync } from 'tinyglobby';
+
 import createWorkerPool from '../../../threading/index.mjs';
 import createParallelWorker from '../../../threading/parallel.mjs';
+import { setConfig } from '../../../utils/configuration/index.mjs';
 import astJs from '../../ast-js/index.mjs';
 import apiLinks from '../index.mjs';
 
-const FIXTURES_DIRECTORY = join(import.meta.dirname, 'fixtures');
-const fixtures = await readdir(FIXTURES_DIRECTORY);
+const relativePath = relative(process.cwd(), import.meta.dirname);
+
+const sourceFiles = globSync('*.js', {
+  cwd: new URL(import.meta.resolve('./fixtures')),
+});
 
-const sourceFiles = fixtures
-  .filter(fixture => extname(fixture) === '.js')
-  .map(fixture => join(FIXTURES_DIRECTORY, fixture));
+const config = await setConfig({});
 
 describe('api links', () => {
-  const threads = cpus().length;
   let pool;
 
   before(() => {
-    pool = createWorkerPool(threads);
+    pool = createWorkerPool(config.threads);
   });
 
   after(async () => {
@@ -30,24 +31,20 @@ describe('api links', () => {
   describe('should work correctly for all fixtures', () => {
     sourceFiles.forEach(sourceFile => {
       it(`${basename(sourceFile)}`, async t => {
-        const worker = createParallelWorker('ast-js', pool, {
-          threads,
-          chunkSize: 10,
-        });
+        config['ast-js'].input = [
+          join(relativePath, 'fixtures', sourceFile).replaceAll(sep, '/'),
+        ];
+
+        const worker = createParallelWorker('ast-js', pool, config);
 
         // Collect results from the async generator
         const astJsResults = [];
 
-        for await (const chunk of astJs.generate(undefined, {
-          input: [sourceFile],
-          worker,
-        })) {
+        for await (const chunk of astJs.generate(undefined, worker)) {
           astJsResults.push(...chunk);
         }
 
-        const actualOutput = await apiLinks.generate(astJsResults, {
-          gitRef: 'https://github.com/nodejs/node/tree/HEAD',
-        });
+        const actualOutput = await apiLinks.generate(astJsResults);
 
         for (const [k, v] of Object.entries(actualOutput)) {
           actualOutput[k] = v.replace(/.*(?=lib\/)/, '');

src/generators/api-links/__tests__/fixtures.test.mjs

@@ -62,7 +62,7 @@ export default {
 
       checkIndirectReferences(program, exports, nameToLineNumberMap);
 
-      const fullGitUrl = `${populate(GITHUB_BLOB_URL)}/lib/${baseName}.js`;
+      const fullGitUrl = `${populate(GITHUB_BLOB_URL, config)}/lib/${baseName}.js`;
 
       // Add the exports we found in this program to our output
       Object.keys(nameToLineNumberMap).forEach(key => {

src/generators/api-links/index.mjs

@@ -21,6 +21,10 @@ export default {
 
   dependsOn: 'metadata',
 
+  defaultConfiguration: {
+    ref: 'main',
+  },
+
   /**
    * Process a chunk of items in a worker thread.
    * Transforms metadata entries into JSX AST nodes.

src/generators/jsx-ast/index.mjs

@@ -1,14 +1,18 @@
 import assert from 'node:assert/strict';
 import { describe, it, mock } from 'node:test';
 
-import semver from 'semver';
+import { SemVer } from 'semver';
+
+import { setConfig } from '../../../../utils/configuration/index.mjs';
+import * as generatorsExports from '../../../../utils/generators.mjs';
 
 mock.module('reading-time', {
   defaultExport: () => ({ text: '5 min read' }),
 });
 
 mock.module('../../../../utils/generators.mjs', {
   namedExports: {
+    ...generatorsExports,
     getCompatibleVersions: () => [
       { version: '18.0.0', isLts: true, isCurrent: false },
       { version: '19.0.0', isLts: false, isCurrent: true },
@@ -26,6 +30,14 @@ const {
   buildSideBarProps,
 } = await import('../buildBarProps.mjs');
 
+await setConfig({
+  version: 'v17.0.0',
+  changelog: [
+    { version: new SemVer('16.0.0'), isLts: true, isCurrent: false },
+    { version: new SemVer('17.0.0'), isLts: false, isCurrent: true },
+  ],
+});
+
 describe('extractTextContent', () => {
   it('combines text and code node values from entries', () => {
     const entries = [
@@ -82,7 +94,7 @@ describe('buildMetaBarProps', () => {
     const result = buildMetaBarProps(head, entries);
 
     assert.equal(result.addedIn, 'v1.0.0');
-    assert.equal(result.readingTime, '5 min read');
+    assert.equal(result.readingTime, '1 min read');
     assert.deepEqual(result.viewAs, [
       ['JSON', 'fs.json'],
       ['MD', 'fs.md'],
@@ -110,30 +122,29 @@ describe('buildMetaBarProps', () => {
 describe('formatVersionOptions', () => {
   it('formats version options with proper labels', () => {
     const versions = [
-      { version: '16.0.0', isLts: true, isCurrent: false },
-      { version: '17.0.0', isLts: false, isCurrent: true },
-      { version: '18.0.0', isLts: false, isCurrent: false },
+      { version: new SemVer('16.0.0'), isLts: true, isCurrent: false },
+      { version: new SemVer('17.0.0'), isLts: false, isCurrent: true },
+      { version: new SemVer('18.0.0'), isLts: false, isCurrent: false },
     ];
 
     const api = 'http';
 
     const result = formatVersionOptions(versions, api);
 
-    assert.equal(result.length, 3);
-    assert.deepEqual(result[0], {
-      value: '/api/16/http',
-      label: 'v16 (LTS)',
-    });
-
-    assert.deepEqual(result[1], {
-      value: '/api/17/http',
-      label: 'v17 (Current)',
-    });
-
-    assert.deepEqual(result[2], {
-      value: '/api/18/http',
-      label: 'v18',
-    });
+    assert.deepStrictEqual(result, [
+      {
+        label: 'v16.x (LTS)',
+        value: 'https://nodejs.org/docs/latest-v16.x/api/http.html',
+      },
+      {
+        label: 'v17.x (Current)',
+        value: 'https://nodejs.org/docs/latest-v17.x/api/http.html',
+      },
+      {
+        label: 'v18.x',
+        value: 'https://nodejs.org/docs/latest-v18.x/api/http.html',
+      },
+    ]);
   });
 });
 
@@ -144,25 +155,15 @@ describe('buildSideBarProps', () => {
       introduced_in: 'v0.10.0',
     };
 
-    const releases = [
-      { version: '16.0.0', isLts: true, isCurrent: false },
-      { version: '17.0.0', isLts: false, isCurrent: true },
-    ];
-
-    const version = new semver.SemVer('17.0.0');
-
     const docPages = [
       ['HTTP', 'http.html'],
       ['HTTPS', 'https.html'],
     ];
 
-    const result = buildSideBarProps(entry, releases, version, docPages);
+    const result = buildSideBarProps(entry, docPages);
 
     assert.equal(result.currentVersion, 'v17.0.0');
     assert.equal(result.pathname, 'http.html');
     assert.deepEqual(result.docPages, docPages);
-    assert.equal(result.versions.length, 2);
-    assert.equal(result.versions[0].label, 'v18 (LTS)');
-    assert.equal(result.versions[1].label, 'v19 (Current)');
   });
 });

src/generators/jsx-ast/utils/__tests__/buildBarProps.test.mjs

@@ -1,6 +1,7 @@
 import assert from 'node:assert/strict';
 import { describe, it } from 'node:test';
 
+import { setConfig } from '../../../../utils/configuration/index.mjs';
 import { transformHeadingNode } from '../buildContent.mjs';
 
 const heading = {
@@ -20,6 +21,8 @@ const makeParent = typeText => ({
   ],
 });
 
+await setConfig({});
+
 describe('transformHeadingNode (deprecation Type -> AlertBox level)', () => {
   it('maps documentation/compilation to info', () => {
     const entry = { api: 'deprecations' };

src/generators/jsx-ast/utils/__tests__/buildContent.test.mjs

@@ -90,7 +90,7 @@ export const extractHeadings = entries =>
  * @param {ApiDocMetadataEntry} head - Main API metadata entry (used as reference point)
  * @param {Array<ApiDocMetadataEntry>} entries - All documentation entries for a given API item
  */
-export const buildMetaBarProps = async (head, entries) => {
+export const buildMetaBarProps = (head, entries) => {
   const { 'jsx-ast': config } = getConfig();
 
   return {

src/generators/jsx-ast/utils/buildBarProps.mjs

@@ -319,7 +319,7 @@ export const createDocumentLayout = (
  */
 const buildContent = async (metadataEntries, head, sideBarProps, remark) => {
   // Build props for the MetaBar from head and entries
-  const metaBarProps = await buildMetaBarProps(head, metadataEntries);
+  const metaBarProps = buildMetaBarProps(head, metadataEntries);
 
   // Create root document AST with all layout components and processed content
   const root = createDocumentLayout(