Merge branch 'main' of github.com:thim81/openapi-format into overlay110

# Conflicts:
#	CHANGELOG.md
#	test/__utils__/test-utils.js

Author: thim81

CHANGELOG.md

@@ -3,6 +3,7 @@
 - Overlay: add OpenAPI Overlay 1.1.0 support
 - Overlay: add `copy` action support with strict `from` validation
 - Overlay: enforce strict action validation and type compatibility for update/copy actions
+- CLI: improve CLI playground URL handling
 - Types: extend overlay typings with `copy`, `from`, and overlay metadata fields
 - Docs: update overlay examples and guidance to 1.1.0
 

bin/cli.js

@@ -440,7 +440,10 @@ async function run(oaFile, options) {
 
   if (options?.playground) {
     try {
-      const playgroundEndpoint = 'https://openapi-format-playground.vercel.app/api/share';
+      const playgroundEndpoints = [
+        'https://playground.openapi-format.com/api/share',
+        'https://openapi-format-playground.vercel.app/api/share'
+      ];
       const config = {};
 
       if (options.sortSet !== undefined) config.sortSet = await stringify(options.sortSet);
@@ -457,14 +460,20 @@ async function run(oaFile, options) {
       };
 
       if (!process.env.CI) {
-        const response = await fetch(playgroundEndpoint, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            Source: 'openapi-format-cli'
-          },
-          body: JSON.stringify(payload)
-        });
+        let response;
+        for (const playgroundEndpoint of playgroundEndpoints) {
+          response = await fetch(playgroundEndpoint, {
+            method: 'POST',
+            headers: {
+              'Content-Type': 'application/json',
+              Source: 'openapi-format-cli'
+            },
+            body: JSON.stringify(payload)
+          });
+
+          if (response.ok) break;
+          if (response.status !== 405) break;
+        }
 
         if (!response.ok) {
           throw new Error(`HTTP error! status: ${response.status}`);

bin/cli.test.js

@@ -338,17 +338,43 @@ describe('openapi-format CLI command', () => {
     fs.unlinkSync(outputPath);
   });
 
-  it.skip('should generate a playground share URL', async () => {
+  it('should handle --playground in CI mode', async () => {
     const path = `test/yaml-filter-custom`;
     const inputFile = `${path}/input.yaml`;
-    const outputFile = `${path}/output.yaml`;
-    const output = await getLocalFile(outputFile);
     const setting = `${path}/customFilter.yaml`;
 
-    let result = await testUtils.cli([inputFile, `--filterFile ${setting}`, `--playground`], '.');
-    // console.log('result', result)
+    let result = await testUtils.cli([inputFile, `--filterFile ${setting}`, `--playground`], '.', {CI: 'true'});
+    expect(result.code).toBe(0);
+    expect(result.stderr).toContain('Running in CI/CD environment, no Share URL generated');
+  });
+
+  it('should handle -p in CI mode', async () => {
+    const path = `test/yaml-filter-custom`;
+    const inputFile = `${path}/input.yaml`;
+    const setting = `${path}/customFilter.yaml`;
+
+    let result = await testUtils.cli([inputFile, `--filterFile ${setting}`, `-p`], '.', {CI: 'true'});
     expect(result.code).toBe(0);
-    expect(result.stdout).toContain('🌐');
+    expect(result.stderr).toContain('Running in CI/CD environment, no Share URL generated');
+  });
+
+  it('should handle playground share URL generation based on environment', async () => {
+    const path = `test/yaml-filter-custom`;
+    const inputFile = `${path}/input.yaml`;
+    const setting = `${path}/customFilter.yaml`;
+    const args = [inputFile, `--filterFile ${setting}`, `--playground`];
+
+    console.log('playground request args:', args);
+    let result = await testUtils.cli(args, '.');
+    console.log('playground response stdout:', result.stdout);
+    console.log('playground response stderr:', result.stderr);
+    expect(result.code).toBe(0);
+    if (process.env.CI) {
+      expect(result.stderr).toContain('Running in CI/CD environment, no Share URL generated');
+    } else {
+      expect(result.stdout).toContain('🌐');
+      expect(result.stdout).toContain('playground.openapi-format.com');
+    }
   });
 
   it('should use the sortComponentsFile', async () => {

test/__utils__/test-utils.js

@@ -42,9 +42,9 @@ async function loadTest(folder, inputType = 'yaml', outType = 'yaml') {
   };
 }
 
-function cli(args, cwd) {
+function cli(args, cwd, envOverrides = {}) {
   return new Promise(resolve => {
-    const env = {...process.env};
+    const env = {...process.env, ...envOverrides};
     if (env.FORCE_COLOR && env.NO_COLOR) {
       delete env.NO_COLOR;
     }