fix: [PL-56199]: support Open API yaml URL with Github API

.github/workflows/pull_request.yaml

@@ -5,6 +5,8 @@ on:
       - opened
       - reopened
       - synchronize
+env:
+  CI: true
 jobs:
   eslint:
     name: ESLint

packages/cli/.env.example

@@ -0,0 +1,4 @@
+GITHUB_PAT=GITHUB_PAT
+ORGANIZATION=ORGANIZATION
+REPO=REPO
+DEFAULT_BRANCH=DEFAULT_BRANCH 

packages/cli/README.md

@@ -37,6 +37,21 @@ Options:
 
 ### Available commands
 
+#### Environment Variables
+
+Consumer needs to pass these environment variables to fetch OpenAPI yaml of respective service from respective repository.
+These should be kept in a .env file and keep the file in the root folder of consumer.
+
+**GITHUB_PAT**=GITHUB_PAT // Github Personal Access Token
+
+**ORGANIZATION**=ORGANIZATION // 'harness', 'wings-software' etc.
+
+**REPO**=REPO // 'harness-core' etc.
+
+**DEFAULT_BRANCH**=DEFAULT_BRANCH
+
+Use .env.example file in the current folder to quick start.
+
 ### import
 
 ```

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/oats-cli",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "license": "MIT",
   "type": "module",
   "repository": {

packages/cli/src/helpers.mts

@@ -10,6 +10,17 @@ import { has } from 'lodash-es';
 
 const DIR_NAME = getDirNameForCurrentFile(import.meta);
 
+// helpers when when working with url to generate service
+export const GITHUB_PAT = process.env.GITHUB_PAT;
+const ORGANIZATION = process.env.ORGANIZATION || 'harness';
+const REPO = process.env.REPO || 'harness-core';
+const DEFAULT_BRANCH = process.env.DEFAULT_BRANCH || 'develop';
+
+const URL_PREFIX = `https://api.github.com/repos/${ORGANIZATION}/${REPO}/contents/`;
+
+export const generateGithubApiEndpointUrl = (yamlPath: string) =>
+	`${URL_PREFIX}${yamlPath}?ref=${DEFAULT_BRANCH}`;
+
 // internal function
 export function _convertToOpenAPI(schema: unknown): Promise<OpenAPIV3.Document> {
 	return new Promise((resolve, reject) => {
@@ -53,3 +64,15 @@ export function getDirNameForCurrentFile(meta: ImportMeta): string {
 export function pathToTemplate(val: string): string {
 	return val.replace(/\{/g, '${');
 }
+
+export function b64DecodeUnicode(str: any) {
+	// Going backwards: from bytestream, to percent-encoding, to original string.
+	return decodeURIComponent(
+		atob(str)
+			.split('')
+			.map(function (c) {
+				return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2);
+			})
+			.join(''),
+	);
+}

packages/cli/src/loadSpecFromFileOrUrl.mts

@@ -6,7 +6,13 @@ import type { OpenAPIV3 } from 'openapi-types';
 import yaml from 'js-yaml';
 
 import { generateOpenAPISpec } from './generateOpenAPISpec.mjs';
-import { _convertToOpenAPI, logInfo } from './helpers.mjs';
+import {
+	generateGithubApiEndpointUrl,
+	GITHUB_PAT,
+	_convertToOpenAPI,
+	b64DecodeUnicode,
+	logInfo,
+} from './helpers.mjs';
 import type { IServiceConfig } from './config.mjs';
 import type { IPluginReturn } from './plugin.mjs';
 
@@ -33,28 +39,46 @@ export async function loadSpecFromFileOrUrl(config: IServiceConfig): Promise<IPl
 					? yaml.load(content, { json: true, schema: yaml.JSON_SCHEMA })
 					: JSON.parse(content);
 		} catch (_) {
-			throw new Error('Something went wrong while trying to parse contents');
+			throw new Error('Something went wrong while trying to parse contents from FILE');
 		}
 
 		// transform the spec using given transformer
 	} else if (config.url) {
 		// read from URL
 		logInfo('Fetching data from URL');
-		const response = await fetch(config.url);
+
+		if (!GITHUB_PAT && !process.env.CI) {
+			throw new Error(
+				'GITHUB_PAT (Personal Access Token) is not defined, please set GITHUB_PAT environment variable',
+			);
+		}
+
+		const configUrl = process.env.CI ? config.url : generateGithubApiEndpointUrl(config.url);
+		const configHeaders = process.env.CI
+			? {}
+			: { headers: { Authorization: `Bearer ${GITHUB_PAT}` } };
+
+		const response = await fetch(configUrl, {
+			...configHeaders,
+		});
+
 		const contentType = response.headers.get('Content-Type');
 		try {
 			logInfo('Parsing data from API');
+			if (contentType === 'application/json; charset=utf-8') {
+				const responseJson: any = await response.json();
+				const yamlContent = responseJson.content;
+				spec = yaml.load(b64DecodeUnicode(yamlContent)) as OpenAPIV3.Document;
 
-			if (contentType === 'application/json') {
-				spec = (await response.json()) as OpenAPIV3.Document;
 				logInfo(`Detected format: JSON`);
 			} else {
 				const txt = await response.text();
 				spec = yaml.load(txt) as OpenAPIV3.Document;
+
 				logInfo(`Detected format: YAML`);
 			}
 		} catch (_) {
-			throw new Error('Something went wrong while trying to parse contents');
+			throw new Error('Something went wrong while trying to parse contents from URL');
 		}
 	} else {
 		throw new Error('Neither file nor url provided');