feat: testing comparing two different openapi files from base and head ref

Author: jaychang99

package-lock.json

@@ -82,6 +82,7 @@
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
     "make-coverage-badge": "^1.2.0",
+    "openapi-types": "^12.1.3",
     "prettier": "^3.2.5",
     "prettier-eslint": "^16.3.0",
     "ts-jest": "^29.1.2",

package.json

@@ -1,13 +1,32 @@
 import * as core from '@actions/core'
 import { wait } from './wait'
 import { stdout } from 'process'
+import { getFileFromBranch } from 'src/utils/getFileFromBranch'
+import { diffOpenapiObject } from 'src/utils/diffOpenapiObject'
 
 /**
  * The main function for the action.
  * @returns {Promise<void>} Resolves when the action is complete.
  */
 export async function run(): Promise<void> {
   try {
+    // parse two openapi files
+    const baseBranch = process.env.GITHUB_BASE_REF!
+    const headBranch = process.env.GITHUB_HEAD_REF!
+    const filePath = './openapi.json'
+
+    const baseFile = JSON.parse(
+      getFileFromBranch(baseBranch, filePath).toString()
+    )
+    const headFile = JSON.parse(
+      getFileFromBranch(headBranch, filePath).toString()
+    )
+
+    const diff = diffOpenapiObject(baseFile, headFile)
+
+    console.log('diff', diff)
+    const result = JSON.stringify(diff, null, 2)
+
     const ms: string = core.getInput('milliseconds')
 
     // Debug logs are only output if the `ACTIONS_STEP_DEBUG` secret is true
@@ -25,22 +44,20 @@ export async function run(): Promise<void> {
 
     stdout.write('This is a single-line string\n')
 
-    const result = `
-    This is a multi-line string
-    
-    # API Differences
-
-    ## ADDED
-    ---
+    // const result = `
+    // This is a multi-line string
 
+    // # API Differences
 
-    ## MODIFIED
-    ---
+    // ## ADDED
+    // ---
 
+    // ## MODIFIED
+    // ---
 
-    ## DELETED
-    ---
-    `
+    // ## DELETED
+    // ---
+    // `
 
     console.log(result)
 

src/main.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIV3 } from "openapi-types";
+
+export type OpenapiTypes =  OpenAPIV3.Document;

src/types/openapiTypes.ts

@@ -0,0 +1,39 @@
+import { OpenapiTypes } from 'src/types/openapiTypes'
+
+export type DiffOpenapiObject = (
+  startOpenapiObj: OpenapiTypes,
+  targetOpenapiObj: OpenapiTypes
+) => OpenapiTypes
+
+export const diffOpenapiObject: DiffOpenapiObject = (
+  startOpenapiObj,
+  targetOpenapiObj
+) => {
+  // diff two objects and return the diff
+  // diff not only keys but values, too.
+  // if the value is an object, diff it recursively
+  // if value is same don't return
+  // return startOpenapiObj;
+  const diff = (startObj: any, targetObj: any) => {
+    const keys = new Set([...Object.keys(startObj), ...Object.keys(targetObj)])
+    const diffObj: any = {}
+    keys.forEach(key => {
+      if (
+        startObj[key] &&
+        targetObj[key] &&
+        typeof startObj[key] === 'object' &&
+        typeof targetObj[key] === 'object'
+      ) {
+        const diffResult = diff(startObj[key], targetObj[key])
+        if (Object.keys(diffResult).length > 0) {
+          diffObj[key] = diffResult
+        }
+      } else if (startObj[key] !== targetObj[key]) {
+        diffObj[key] = targetObj[key]
+      }
+    })
+    return diffObj
+  }
+
+  return diff(startOpenapiObj, targetOpenapiObj)
+}

src/utils/diffOpenapiObject.ts

@@ -0,0 +1,8 @@
+import { execSync } from 'child_process'
+import { readFileSync } from 'fs'
+
+export function getFileFromBranch(branch: string, filePath: string): Buffer {
+  execSync(`git fetch origin ${branch}`)
+  execSync(`git checkout FETCH_HEAD -- ${filePath}`)
+  return readFileSync(filePath)
+}