fixup! code review

Author: avivkeller

apps/site/app/[locale]/next-data/og/[category]/[title]/route.tsx

@@ -26,12 +26,12 @@ type StaticParams = {
 export const GET = async (_: Request, props: StaticParams) => {
   const params = await props.params;
 
-  const categoryColor =
+  const categoryColour =
     params.category in CATEGORY_TO_THEME_COLOUR_MAP
       ? CATEGORY_TO_THEME_COLOUR_MAP[params.category]
       : CATEGORY_TO_THEME_COLOUR_MAP[DEFAULT_CATEGORY_OG_TYPE];
 
-  const gridBackground = `radial-gradient(circle, ${categoryColor}, transparent)`;
+  const gridBackground = `radial-gradient(circle, ${categoryColour}, transparent)`;
 
   return new ImageResponse(
     (

apps/site/components/Downloads/DownloadButton/index.tsx

@@ -7,7 +7,7 @@ import type { FC, PropsWithChildren } from 'react';
 import Button from '#site/components/Common/Button';
 import { useClientContext } from '#site/hooks';
 import type { NodeRelease } from '#site/types';
-import { getNodeDownloadUrl } from '#site/util/download';
+import { getNodeDownloadUrl } from '#site/util/url';
 import { getUserPlatform } from '#site/util/userAgent';
 
 import styles from './index.module.css';

apps/site/components/Downloads/DownloadLink.tsx

@@ -5,7 +5,7 @@ import type { FC, PropsWithChildren } from 'react';
 import LinkWithArrow from '#site/components/LinkWithArrow';
 import { useClientContext } from '#site/hooks';
 import type { DownloadKind, NodeRelease } from '#site/types';
-import { getNodeDownloadUrl } from '#site/util/download';
+import { getNodeDownloadUrl } from '#site/util/url';
 import { getUserPlatform } from '#site/util/userAgent';
 
 type DownloadLinkProps = { release: NodeRelease; kind?: DownloadKind };

apps/site/components/Downloads/MinorReleasesTable/index.tsx

@@ -7,7 +7,7 @@ import type { FC } from 'react';
 import Link from '#site/components/Link';
 import { BASE_CHANGELOG_URL } from '#site/next.constants.mjs';
 import type { MinorVersion } from '#site/types';
-import { getNodeApiLink } from '#site/util/api';
+import { getNodeApiUrl } from '#site/util/url';
 
 import styles from './index.module.css';
 
@@ -50,7 +50,7 @@ export const MinorReleasesTable: FC<MinorReleasesTableProps> = ({
                 <Separator orientation="vertical" />
                 <Link
                   kind="neutral"
-                  href={getNodeApiLink(`v${release.version}`)}
+                  href={getNodeApiUrl(`v${release.version}`)}
                 >
                   {t('actions.docs')}
                 </Link>

apps/site/components/Downloads/Release/PrebuiltDownloadButtons.tsx

@@ -11,8 +11,8 @@ import { ReleaseContext } from '#site/providers/releaseProvider';
 import {
   OS_NOT_SUPPORTING_INSTALLERS,
   OperatingSystemLabel,
-  getNodeDownloadUrl,
 } from '#site/util/download';
+import { getNodeDownloadUrl } from '#site/util/url';
 
 // Retrieves the pure extension piece from the input string
 const getExtension = (input: string) => String(input.split('.').slice(-1));

apps/site/util/__tests__/api.test.mjs

@@ -8,11 +8,8 @@ import {
   INSTALL_METHODS,
   PACKAGE_MANAGERS,
   PLATFORMS,
-  getNodeDownloadUrl,
 } from '#site/util/download';
 
-const version = 'v18.16.0';
-
 describe('parseCompat', () => {
   it('should handle all OS, install methods, and package managers', () => {
     OPERATING_SYSTEMS.forEach(os => {
@@ -147,53 +144,3 @@ describe('nextItem', () => {
     assert.equal(nextItem('valid', items), 'valid');
   });
 });
-
-describe('getNodeDownloadUrl', () => {
-  it('should return the correct download URL for Mac', () => {
-    const os = 'MAC';
-    const bitness = 86;
-    const expectedUrl = 'https://nodejs.org/dist/v18.16.0/node-v18.16.0.pkg';
-
-    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
-  });
-
-  it('should return the correct download URL for Windows (32-bit)', () => {
-    const os = 'WIN';
-    const bitness = 86;
-    const expectedUrl =
-      'https://nodejs.org/dist/v18.16.0/node-v18.16.0-x86.msi';
-
-    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
-  });
-
-  it('should return the correct download URL for Windows (64-bit)', () => {
-    const os = 'WIN';
-    const bitness = 64;
-    const expectedUrl =
-      'https://nodejs.org/dist/v18.16.0/node-v18.16.0-x64.msi';
-
-    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
-  });
-
-  it('should return the default download URL for other operating systems', () => {
-    const os = 'OTHER';
-    const bitness = 86;
-    const expectedUrl = 'https://nodejs.org/dist/v18.16.0/node-v18.16.0.tar.gz';
-
-    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
-  });
-
-  describe('MAC', () => {
-    it('should return .pkg link for installer', () => {
-      const url = getNodeDownloadUrl('v18.0.0', 'MAC', 'x64', 'installer');
-      assert.ok(url.includes('.pkg'));
-    });
-  });
-
-  describe('WIN', () => {
-    it('should return an MSI link for installer', () => {
-      const url = getNodeDownloadUrl('v18.0.0', 'WIN', 'x64', 'installer');
-      assert.ok(url.includes('.msi'));
-    });
-  });
-});

apps/site/util/__tests__/download.test.mjs

@@ -0,0 +1,104 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import { getNodeDownloadUrl, getNodeApiUrl } from '../url';
+
+const version = 'v18.16.0';
+
+describe('getNodeApiUrl', () => {
+  it('should return the correct API link for versions >=0.3.1 and <0.5.1', () => {
+    const version = '0.4.0';
+    const expectedLink = `https://nodejs.org/docs/${version}/api/`;
+
+    const result = getNodeApiUrl(version);
+
+    assert.equal(result, expectedLink);
+  });
+
+  it('should return the correct URL for versions >=0.3.1 and <0.5.1', () => {
+    const url = getNodeApiUrl('v0.4.10');
+    assert.ok(url.includes('/api/'));
+  });
+
+  it('should return the correct API link for versions >=0.1.14 and <0.3.1', () => {
+    const version = '0.2.0';
+    const expectedLink = `https://nodejs.org/docs/${version}/api.html`;
+
+    const result = getNodeApiUrl(version);
+
+    assert.equal(result, expectedLink);
+  });
+
+  it('should return the correct API link for versions >=1.0.0 and <4.0.0', () => {
+    const version = '2.3.0';
+    const expectedLink = `https://iojs.org/dist/${version}/docs/api/`;
+
+    const result = getNodeApiUrl(version);
+
+    assert.equal(result, expectedLink);
+  });
+
+  it('should form the correct URL for versions >=1.0.0 and <4.0.0', () => {
+    const url = getNodeApiUrl('v1.2.3');
+    assert.ok(url.includes('iojs.org/dist/v1.2.3/docs/api/'));
+  });
+
+  it('should return the correct API link for other versions', () => {
+    const version = '5.0.0';
+    const expectedLink = `https://nodejs.org/dist/${version}/docs/api/`;
+
+    const result = getNodeApiUrl(version);
+
+    assert.equal(result, expectedLink);
+  });
+});
+
+describe('getNodeDownloadUrl', () => {
+  it('should return the correct download URL for Mac', () => {
+    const os = 'MAC';
+    const bitness = 86;
+    const expectedUrl = 'https://nodejs.org/dist/v18.16.0/node-v18.16.0.pkg';
+
+    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
+  });
+
+  it('should return the correct download URL for Windows (32-bit)', () => {
+    const os = 'WIN';
+    const bitness = 86;
+    const expectedUrl =
+      'https://nodejs.org/dist/v18.16.0/node-v18.16.0-x86.msi';
+
+    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
+  });
+
+  it('should return the correct download URL for Windows (64-bit)', () => {
+    const os = 'WIN';
+    const bitness = 64;
+    const expectedUrl =
+      'https://nodejs.org/dist/v18.16.0/node-v18.16.0-x64.msi';
+
+    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
+  });
+
+  it('should return the default download URL for other operating systems', () => {
+    const os = 'OTHER';
+    const bitness = 86;
+    const expectedUrl = 'https://nodejs.org/dist/v18.16.0/node-v18.16.0.tar.gz';
+
+    assert.equal(getNodeDownloadUrl(version, os, bitness), expectedUrl);
+  });
+
+  describe('MAC', () => {
+    it('should return .pkg link for installer', () => {
+      const url = getNodeDownloadUrl('v18.0.0', 'MAC', 'x64', 'installer');
+      assert.ok(url.includes('.pkg'));
+    });
+  });
+
+  describe('WIN', () => {
+    it('should return an MSI link for installer', () => {
+      const url = getNodeDownloadUrl('v18.0.0', 'WIN', 'x64', 'installer');
+      assert.ok(url.includes('.msi'));
+    });
+  });
+});

apps/site/util/__tests__/url.test.mjs

@@ -5,13 +5,11 @@ import * as PackageManagerIcons from '@node-core/ui-components/Icons/PackageMana
 import type { ElementType } from 'react';
 import satisfies from 'semver/functions/satisfies';
 
-import { DIST_URL } from '#site/next.constants.mjs';
 import type {
   IntlMessageKeys,
   NodeReleaseStatus,
   UserOS,
   UserPlatform,
-  DownloadKind,
 } from '#site/types';
 import type * as Types from '#site/types/release';
 
@@ -155,74 +153,3 @@ export const PLATFORMS = Object.fromEntries(
     })),
   ])
 ) as Record<UserOS | 'LOADING', Array<DownloadDropdownItem<UserPlatform>>>;
-
-export const getNodeDownloadUrl = (
-  versionWithPrefix: string,
-  os: UserOS | 'LOADING',
-  platform: UserPlatform = 'x64',
-  kind: DownloadKind = 'installer'
-) => {
-  const baseURL = `${DIST_URL}${versionWithPrefix}`;
-
-  if (kind === 'source') {
-    return `${baseURL}/node-${versionWithPrefix}.tar.gz`;
-  }
-
-  switch (os) {
-    case 'MAC':
-      // Prepares a downloadable Node.js installer link for the x64, ARM64 platforms
-      if (kind === 'installer') {
-        return `${baseURL}/node-${versionWithPrefix}.pkg`;
-      }
-
-      // Prepares a downloadable Node.js link for the ARM64 platform
-      if (typeof platform === 'string') {
-        return `${baseURL}/node-${versionWithPrefix}-darwin-${platform}.tar.gz`;
-      }
-
-      // Prepares a downloadable Node.js link for the x64 platform.
-      // Since the x86 platform is not officially supported, returns the x64
-      // link as the default value.
-      return `${baseURL}/node-${versionWithPrefix}-darwin-x64.tar.gz`;
-    case 'WIN': {
-      if (kind === 'installer') {
-        // Prepares a downloadable Node.js installer link for the ARM platforms
-        if (typeof platform === 'string') {
-          return `${baseURL}/node-${versionWithPrefix}-${platform}.msi`;
-        }
-
-        // Prepares a downloadable Node.js installer link for the x64 and x86 platforms
-        return `${baseURL}/node-${versionWithPrefix}-x${platform}.msi`;
-      }
-
-      // Prepares a downloadable Node.js link for the ARM64 platform
-      if (typeof platform === 'string') {
-        return `${baseURL}/node-${versionWithPrefix}-win-${platform}.zip`;
-      }
-
-      // Prepares a downloadable Node.js link for the x64 and x86 platforms
-      return `${baseURL}/node-${versionWithPrefix}-win-x${platform}.zip`;
-    }
-    case 'LINUX':
-      // Prepares a downloadable Node.js link for the ARM platforms such as
-      // ARMv7 and ARMv8
-      if (typeof platform === 'string') {
-        return `${baseURL}/node-${versionWithPrefix}-linux-${platform}.tar.xz`;
-      }
-
-      // Prepares a downloadable Node.js link for the x64 platform.
-      // Since the x86 platform is not officially supported, returns the x64
-      // link as the default value.
-      return `${baseURL}/node-${versionWithPrefix}-linux-x64.tar.xz`;
-    case 'AIX':
-      // Prepares a downloadable Node.js link for AIX
-      if (typeof platform === 'string') {
-        return `${baseURL}/node-${versionWithPrefix}-aix-${platform}.tar.gz`;
-      }
-
-      return `${baseURL}/node-${versionWithPrefix}-aix-ppc64.tar.gz`;
-    default:
-      // Prepares a downloadable Node.js source code link
-      return `${baseURL}/node-${versionWithPrefix}.tar.gz`;
-  }
-};