test: add more comprehensive test to type detection (#57)

Author: MengLinMaker

.github/workflows/CI.yml

@@ -1,7 +1,5 @@
 name: CI
 on:
-  push:
-    branches: [main]
   pull_request:
     branches:
       - '**'

biome.json

@@ -11,6 +11,9 @@
       "recommended": true,
       "complexity": {
         "useLiteralKeys": "off"
+      },
+      "style": {
+        "noNonNullAssertion": "off"
       }
     }
   },

packages/data/package.json

@@ -14,5 +14,11 @@
   },
   "dependencies": {
     "runtime-compat-data": "0.0.5"
+  },
+  "peerDependencies": {
+    "@cloudflare/workers-types": "*",
+    "@types/bun": "*",
+    "@types/deno": "*",
+    "@types/node": "*"
   }
 }

packages/data/preprocess.ts

@@ -2,6 +2,7 @@ import { writeFileSync } from 'node:fs'
 import type { CompatStatement, Identifier, StatusBlock } from 'runtime-compat-data'
 import rawCompatData from 'runtime-compat-data'
 import type { PreprocessCompatData, PreprocessCompatStatement } from './src/types'
+import { parseJsonKeys, stringifyJsonKeys } from './src/utils'
 
 /**
  * Compress raw compat data to single level flatmap
@@ -48,7 +49,7 @@ const mapCompatData = new Map<string, PreprocessCompatStatement>()
       const subData = compatData[key]
       if (key === '__compat') {
         const preprocessCompatStatement = extractPreprocessCompatStatement(subData as never)
-        mapCompatData.set(JSON.stringify(parentKeys), preprocessCompatStatement)
+        mapCompatData.set(stringifyJsonKeys(parentKeys), preprocessCompatStatement)
       } else {
         // Only chain keys if "__compat" exists
         const nodeHasCompatData = !keys.includes('__compat')
@@ -61,7 +62,7 @@ const mapCompatData = new Map<string, PreprocessCompatStatement>()
 }
 
 /**
- * Sort mapped compat data into different AST detection scenarios
+ * Sort mapped compat data into different AST detection apiContext
  */
 const preprocessCompatData: PreprocessCompatData = {
   class: {},
@@ -75,7 +76,7 @@ const preprocessCompatData: PreprocessCompatData = {
   const isPascalCase = (s: string | undefined) => s?.match(/^[A-Z]+.*/)
 
   for (const [jsonKeys, preprocessCompatStatement] of mapCompatData.entries()) {
-    const keys = JSON.parse(jsonKeys) as string[]
+    const keys = parseJsonKeys(jsonKeys)
     if (keys.length === 1) {
       if (isPascalCase(keys[0])) {
         // PascalCase, hence a class
@@ -87,24 +88,24 @@ const preprocessCompatData: PreprocessCompatData = {
     } else if (keys.length === 2) {
       if (keys[0] === keys[1])
         // Duplicate keys are class constructors
-        preprocessCompatData.class[JSON.stringify([keys[0]])] = preprocessCompatStatement
+        preprocessCompatData.class[stringifyJsonKeys([keys[0]!])] = preprocessCompatStatement
       else if (keys[1]?.match('_static')) {
         // Static methods have '_static'
-        const newKeys = JSON.stringify([keys[0], keys[1]?.replace('_static', '')])
+        const newKeys = stringifyJsonKeys([keys[0]!, keys[1]?.replace('_static', '')])
         if (isPascalCase(keys[0]))
           preprocessCompatData.classProperty[newKeys] = preprocessCompatStatement
         else preprocessCompatData.globalClassProperty[newKeys] = preprocessCompatStatement
       } else if (keys[1]?.match('_event')) {
         // Events have '_event'
-        const newKeys = JSON.stringify([keys[0], keys[1]?.replace('_event', '')])
+        const newKeys = stringifyJsonKeys([keys[0]!, keys[1]?.replace('_event', '')])
         preprocessCompatData.eventListener[newKeys] = preprocessCompatStatement
       } else if (!keys[1]?.match('_'))
         // Normal class property
         preprocessCompatData.classProperty[jsonKeys] = preprocessCompatStatement
       else preprocessCompatData.misc[jsonKeys] = preprocessCompatStatement
     } else {
       // Not sure how to analyse
-      preprocessCompatData.misc[JSON.stringify([keys[0]])] = preprocessCompatStatement
+      preprocessCompatData.misc[stringifyJsonKeys([keys[0]!])] = preprocessCompatStatement
     }
   }
 }

packages/data/src/index.ts

@@ -1,5 +1,12 @@
 import type { RuntimeName } from 'runtime-compat-data'
 import { filterPreprocessCompatData, preprocessCompatData } from './runtime'
+import { objectKeys, parseJsonKeys, stringifyJsonKeys } from './utils'
 
 export type { RuntimeName }
-export { filterPreprocessCompatData, preprocessCompatData }
+export {
+  filterPreprocessCompatData,
+  preprocessCompatData,
+  objectKeys,
+  parseJsonKeys,
+  stringifyJsonKeys,
+}

packages/data/src/objectKeys.ts

@@ -1,12 +1,12 @@
 import type { RuntimeName, StatusBlock } from 'runtime-compat-data'
-import { objectKeys } from './objectKeys'
 import _preprocessCompatData from './preprocessCompatData.json'
 import type {
   PreprocessCompatData,
   PreprocessCompatStatement,
   RuntimeCompatData,
   RuntimeCompatStatement,
 } from './types.js'
+import { objectKeys } from './utils'
 
 const preprocessCompatData: PreprocessCompatData = _preprocessCompatData
 export { preprocessCompatData }

packages/data/src/runtime.ts

@@ -1,7 +1,7 @@
 import type { RuntimeName } from 'runtime-compat-data'
 import { describe, expect, it } from 'vitest'
-import { objectKeys } from '../objectKeys'
 import { filterPreprocessCompatData, preprocessCompatData } from '../runtime'
+import { objectKeys } from '../utils'
 
 describe('filterPreprocessCompatData', () => {
   const filterRuntimes: RuntimeName[] = ['node']

packages/data/src/tests/runtime.test.ts

@@ -8,6 +8,8 @@ type ApiClassification =
   | 'globalClassProperty'
   | 'misc'
 
+export type JsonKeys = string
+
 /**
  * Types for preprocessing
  */

packages/data/src/types.ts

@@ -0,0 +1,22 @@
+import type { JsonKeys } from './types'
+
+/**
+ * Extracts the keys of an object to array with correct TypeScript.
+ * @param object - The object.
+ * @return Object key array.
+ */
+export const objectKeys = <T extends object>(object: T) => Object.keys(object) as (keyof T)[]
+
+/**
+ * Parse stringified JSON string array.
+ * @param jsonKeys
+ * @returns
+ */
+export const parseJsonKeys = (jsonKeys: JsonKeys) => JSON.parse(jsonKeys) as string[]
+
+/**
+ * Stringify JSON string array.
+ * @param stringArray
+ * @returns
+ */
+export const stringifyJsonKeys = (stringArray: string[]) => JSON.stringify(stringArray) as JsonKeys