chore(lint,scripts): migrate to release array

Author: caugner

lint/linter/test-browsers-data.test.ts

@@ -22,16 +22,18 @@ describe('test-browsers-data', () => {
       type: 'server',
       accepts_flags: true,
       accepts_webextensions: false,
-      releases: {
-        '20.6.0': {
+      releases: [
+        {
+          version: '20.6.0',
           release_date: '2023-09-04',
           status: 'current',
         },
-        '21.2.0': {
+        {
+          version: '21.2.0',
           release_date: '2023-11-14',
           status: 'current',
         },
-      },
+      ],
     };
 
     test.check(logger, { data, path: { browser } });
@@ -45,10 +47,10 @@ describe('test-browsers-data', () => {
       type: 'desktop',
       accepts_flags: true,
       accepts_webextensions: true,
-      releases: {
-        '1': { status: 'nightly' },
-        '2': { status: 'nightly' },
-      },
+      releases: [
+        { version: '1', status: 'nightly' },
+        { version: '2', status: 'nightly' },
+      ],
     };
     test.check(logger, { data, path: { browser } });
     assert.equal(logger.messages.length, 1);
@@ -61,10 +63,10 @@ describe('test-browsers-data', () => {
       type: 'server',
       accepts_flags: true,
       accepts_webextensions: false,
-      releases: {
-        '1': { status: 'nightly' },
-        '2': { status: 'nightly' },
-      },
+      releases: [
+        { version: '1', status: 'nightly' },
+        { version: '2', status: 'nightly' },
+      ],
     };
     test.check(logger, { data, path: { browser } });
     assert.equal(logger.messages.length, 1);
@@ -78,7 +80,7 @@ describe('test-browsers-data', () => {
       upstream: browser,
       accepts_flags: false,
       accepts_webextensions: false,
-      releases: {},
+      releases: [],
     };
 
     test.check(logger, { data, path: { browser } });
@@ -93,7 +95,7 @@ describe('test-browsers-data', () => {
       upstream: 'unknown' as any,
       accepts_flags: false,
       accepts_webextensions: false,
-      releases: {},
+      releases: [],
     };
 
     test.check(logger, { data, path: { browser } });
@@ -109,18 +111,20 @@ describe('test-browsers-data', () => {
       pref_url: 'opera://flags',
       accepts_flags: true,
       accepts_webextensions: true,
-      releases: {
-        '97': {
+      releases: [
+        {
+          version: '97',
           status: 'retired',
           engine: 'Blink',
           engine_version: '111',
         },
-        '98': {
+        {
+          version: '98',
           status: 'current',
           engine: 'Blink',
           engine_version: '112',
         },
-      },
+      ],
     };
     test.check(logger, { data, path: { browser } });
     assert.equal(logger.messages.length, 2);

lint/linter/test-browsers-data.ts

@@ -20,9 +20,9 @@ const processData = (
   logger: Logger,
 ): void => {
   for (const status of ['current', 'nightly']) {
-    const releasesForStatus = Object.entries(data.releases)
-      .filter(([, data]) => data.status == status)
-      .map(([version]) => version);
+    const releasesForStatus = data.releases
+      .filter((data) => data.status == status)
+      .map(({ version }) => version);
 
     if (releasesForStatus.length > 1) {
       logger.error(
@@ -56,12 +56,12 @@ const processData = (
       // Ignore Oculus Browser, because release dates for versions 5.0 to 15.1 are not publicly documented.
       continue;
     }
-    const releasesWithoutDate = Object.entries(data.releases)
+    const releasesWithoutDate = data.releases
       .filter(
-        ([, data]) =>
+        (data) =>
           data.status == status && typeof data.release_date === 'undefined',
       )
-      .map(([version]) => version);
+      .map(({ version }) => version);
 
     if (releasesWithoutDate.length > 0) {
       logger.error(

lint/linter/test-obsolete.test.ts

@@ -17,11 +17,11 @@ const errorTime = new Date(),
   warningTime = new Date();
 errorTime.setFullYear(errorTime.getFullYear() - 2.5);
 warningTime.setFullYear(warningTime.getFullYear() - 2);
-const release = Object.entries(browsers.chrome.releases).find((r) => {
-  if (r[1].release_date === undefined) {
+const release = browsers.chrome.releases.find((r) => {
+  if (r.release_date === undefined) {
     return false;
   }
-  const date = new Date(r[1].release_date);
+  const date = new Date(r.release_date);
   return errorTime < date && date < warningTime;
 });
 
@@ -100,7 +100,7 @@ describe('implementedAndRemoved', () => {
         chrome: [
           {
             version_added: '2',
-            version_removed: release[0],
+            version_removed: release.version,
           },
           {
             version_added: '1',
@@ -130,7 +130,7 @@ describe('implementedAndRemoved', () => {
       implementedAndRemoved({
         chrome: {
           version_added: '1',
-          version_removed: Object.keys(browsers.chrome.releases)[-1],
+          version_removed: browsers.chrome.releases.at(-1)?.version,
         },
       }),
       false,
@@ -140,7 +140,7 @@ describe('implementedAndRemoved', () => {
         chrome: [
           {
             version_added: '2',
-            version_removed: Object.keys(browsers.chrome.releases)[-1],
+            version_removed: browsers.chrome.releases.at(-1)?.version,
           },
           {
             version_added: '1',
@@ -161,7 +161,7 @@ describe('implementedAndRemoved', () => {
   it('rule 2 warning: returns "warning" for features which were implemented and removed some time ago', () => {
     // Make sure there is a suitable release
     assert.ok(release);
-    const version_removed = release[0];
+    const version_removed = release.version;
     assert.equal(
       implementedAndRemoved({
         chrome: {
@@ -260,7 +260,7 @@ describe('processData', () => {
     const logger = new Logger('', '');
     // Make sure there is a suitable release
     assert.ok(release);
-    const version_removed = release[0];
+    const version_removed = release.version;
     processData(logger, {
       support: {
         chrome: {

lint/linter/test-obsolete.ts

@@ -3,7 +3,13 @@
 
 import chalk from 'chalk-template';
 
-import { Linter, Logger, LinterData, LinterMessageLevel } from '../utils.js';
+import {
+  findBrowserRelease,
+  Linter,
+  Logger,
+  LinterData,
+  LinterMessageLevel,
+} from '../utils.js';
 import { BrowserName, CompatStatement } from '../../types/types.js';
 import {
   InternalSupportBlock,
@@ -85,8 +91,11 @@ export const implementedAndRemoved = (
         return false;
       }
 
-      const releaseDateData =
-        browsers[browser].releases[d.version_removed].release_date;
+      const releaseDateData = findBrowserRelease(
+        browsers,
+        browser,
+        d.version_removed,
+      )?.release_date;
 
       // No browser release date
       if (!releaseDateData) {

lint/linter/test-status.ts

@@ -38,7 +38,7 @@ export const checkExperimental = (data: CompatStatement): boolean => {
     const engineSupport = new Set();
 
     for (const browser of browserSupport) {
-      const currentRelease = Object.values(browsers[browser].releases).find(
+      const currentRelease = browsers[browser].releases.find(
         (r) => r.status === 'current',
       );
       const engine = currentRelease?.engine;

lint/linter/test-versions.ts

@@ -4,7 +4,7 @@
 import { compare, validate } from 'compare-versions';
 import chalk from 'chalk-template';
 
-import { Linter, Logger, LinterData } from '../utils.js';
+import { findBrowserRelease, Linter, Logger, LinterData } from '../utils.js';
 import {
   BrowserName,
   SimpleSupportStatement,
@@ -78,7 +78,7 @@ const isValidVersion = (
     if (version === 'preview') {
       return !!browsers[browser].preview_name;
     }
-    return Object.hasOwn(browsers[browser].releases, version.replace('≤', ''));
+    return !!findBrowserRelease(browsers, browser, version.replace('≤', ''));
   } else if (
     realValuesRequired[category].includes(browser) &&
     version !== false
@@ -185,8 +185,7 @@ const checkVersions = (
         }
 
         if (typeof version === 'string' && version.startsWith('≤')) {
-          const releaseData =
-            browsers[browser].releases[version.replace('≤', '')];
+          const releaseData = findBrowserRelease(browsers, browser, version);
           if (
             !releaseData ||
             !releaseData.release_date ||

lint/utils.ts

@@ -6,7 +6,7 @@ import { platform } from 'node:os';
 import chalk from 'chalk-template';
 
 import { DataType } from '../types/index.js';
-import { BrowserName } from '../types/types.js';
+import { BrowserName, Browsers, ReleaseStatement } from '../types/types.js';
 
 export interface LintOptions {
   only?: string[];
@@ -268,3 +268,21 @@ export class Linters {
     }
   }
 }
+
+/**
+ * Finds a browser release.
+ * @param browsers the browser data.
+ * @param browser the name of the browser.
+ * @param version the version of the release.
+ * @returns the browser release if it exists, or undefined.
+ */
+export const findBrowserRelease = (
+  browsers: Browsers,
+  browser: string,
+  version: string,
+): ReleaseStatement | undefined => {
+  version = version.replace('≤', '');
+  return browsers[browser].releases.find(
+    (release) => release.version === version,
+  );
+};

scripts/build/index.ts

@@ -88,8 +88,8 @@ const getPreviousVersion = (
   version: VersionValue,
 ): VersionValue => {
   if (typeof version === 'string' && !version.startsWith('≤')) {
-    const browserVersions = Object.keys(bcd.browsers[browser].releases).sort(
-      compareVersions,
+    const browserVersions = bcd.browsers[browser].releases.map(
+      ({ version }) => version,
     );
     const currentVersionIndex = browserVersions.indexOf(version);
     if (currentVersionIndex > 0) {

scripts/build/mirror.ts

@@ -10,6 +10,7 @@ import {
   SupportStatement,
 } from '../../types/types.js';
 import { InternalSupportBlock } from '../../types/index.js';
+import { findBrowserRelease } from '../lib/browsers.js';
 
 const { browsers } = bcd;
 
@@ -71,17 +72,24 @@ export const getMatchingBrowserVersion = (
     if (v) {
       return (range ? '≤' : '') + v;
     }
-    if (sourceVersion.replace('≤', '') in browserData.releases) {
+    if (
+      browserData.releases
+        .map(({ version }) => version)
+        .includes(sourceVersion.replace('≤', ''))
+    ) {
       return sourceVersion;
     }
     throw new Error(`Cannot find iOS version matching Safari ${sourceVersion}`);
   }
 
-  const releaseKeys = Object.keys(browserData.releases);
-  releaseKeys.sort(compareVersions);
+  const releaseVersions = browserData.releases.map((r) => r.version);
+  releaseVersions.sort(compareVersions);
 
-  const sourceRelease =
-    browsers[browserData.upstream].releases[sourceVersion.replace('≤', '')];
+  const sourceRelease = findBrowserRelease(
+    browsers,
+    browserData.upstream,
+    sourceVersion,
+  );
 
   if (!sourceRelease) {
     throw new Error(
@@ -91,8 +99,8 @@ export const getMatchingBrowserVersion = (
 
   let previousReleaseEngine;
 
-  for (const r of releaseKeys) {
-    const release = browserData.releases[r];
+  for (const v of releaseVersions) {
+    const release = browserData.releases.find((r) => r.version === v)!;
 
     // Add a range delimiter if there were previous releases of the downstream browser that used the same engine before this one (ex. after Edge 79)
     const rangeDelimiter =
@@ -112,7 +120,7 @@ export const getMatchingBrowserVersion = (
       compare(release.engine_version, sourceRelease.engine_version, '>=');
 
     if (isChromeWebKitToBlink || isMatchingVersion) {
-      return rangeDelimiter ? `≤${r}` : r;
+      return rangeDelimiter ? `≤${v}` : v;
     }
 
     previousReleaseEngine = release.engine;

scripts/lib/browsers.ts

@@ -0,0 +1,19 @@
+import { Browsers, ReleaseStatement } from '../../types/types.js';
+
+/**
+ * Finds a browser release.
+ * @param browsers the browser data.
+ * @param browser the name of the browser.
+ * @param version the version of the release.
+ * @returns the browser release if it exists, or undefined.
+ */
+export const findBrowserRelease = (
+  browsers: Browsers,
+  browser: string,
+  version: string,
+): ReleaseStatement | undefined => {
+  version = version.replace('≤', '');
+  return browsers[browser].releases.find(
+    (release) => release.version === version,
+  );
+};

scripts/lib/stringify-and-order-properties.test.ts

@@ -33,16 +33,16 @@ describe('Order Properties', () => {
     const input = {
       browsers: {
         firefox: {
-          releases: {
-            '1.5': { version: '1.5', release_date: '2008-11-14' },
-            '1': { version: '1', release_date: '2008-09-02' },
-          },
+          releases: [
+            { version: '1.5', release_date: '2008-11-14' },
+            { version: '1', release_date: '2008-09-02' },
+          ],
         },
       },
     };
 
     const expected =
-      '{\n  "browsers": {\n    "firefox": {\n      "releases": {\n        "1": {\n          "release_date": "2008-09-02"\n        },\n        "1.5": {\n          "release_date": "2008-11-14"\n        }\n      }\n    }\n  }\n}';
+      '{\n  "browsers": {\n    "firefox": {\n      "releases": [\n        {\n          "version": "1",\n          "release_date": "2008-09-02"\n        },\n        {\n          "version": "1.5",\n          "release_date": "2008-11-14"\n        }\n      ]\n    }\n  }\n}';
 
     const result = stringifyAndOrderProperties(input);
     assert.deepEqual(result, expected);