Refactor out devTools to use an external pacakge (#418)

Author: patrick-tolosa

.code-generation/config.js

@@ -61,7 +61,7 @@ module.exports = {
       }
     },
     unsupportedTxParams: ['fl_waveform', 'fl_animated', 'e_tint', 'u_', 'e_theme', 'l_fetch', 'l_text', 'u_text', 'af_'],
-    unsupportedCode: ['.stroke(', '.textFit(', 'Animated.edit', '.RoundCorners(', 'getVideoFrame', 'Source.image']
+    unsupportedCode: ['.stroke(', '.textFit(', 'Animated.edit', '.RoundCorners(', 'getVideoFrame', 'Source.image', '.transcode(']
   },
   "overwrites": {
     qualifiers: {

devTools/sanity/createTestFile.ts

@@ -2,13 +2,10 @@
 /* eslint-disable require-jsdoc */
 
 
-import {ITxResult} from "./index";
-
-const fs = require('fs');
-
+import {IFrameworkResponse} from "sdk-sanity-generator/dist/interfaces";
 const prettier = require('prettier');
 
-function createTestFile(txs: ITxResult[]){
+function createTestFile(txs: IFrameworkResponse[]){
   let file = `
   // In the future, we'll support HOTER tests without name duplication issues, for now it's commented out
   // It's stored here since this is built manually, and it's best to keep the work :)
@@ -153,35 +150,34 @@ import { FontStyle } from "qualifiers/fontStyle";
 import {Volume} from "../src/qualifiers/volume";
 import {FontAntialias} from "../src/qualifiers/FontAntialias";
 import {Animated} from "../src/actions/animated";
-const CloudinaryImage = CloudinaryMedia;
-const CloudinaryVideo = CloudinaryMedia;
+import {CloudinaryImage, CloudinaryVideo, CloudinaryMedia} from "../src"
       `;
 
   file += `describe("Testing", () => {\n`;
 
   file += txs.map((txResult) => {
-    let test = `it("${txResult.txString}", () => {`;
+    let test = `it("${txResult.transformation}", () => {`;
     // If the SDK does not support the transformation, we comment out the test
 
     if (txResult.status === 11) {
       test += txResult.status === 11 ? '/* SUCCESS, BUT NO GENERATED CODE - THE SDK DOES NOT SUPPORT THIS TRANSFORMATION' : '';
     }
 
     if (txResult.status !== 11) {
-      test += `const tAsset = ${txResult.parsedCode}`;
+      test += `const tAsset = ${txResult.code}`;
 
-      if (txResult.txString.startsWith('http')) {
+      if (txResult.transformation.startsWith('http')) {
 
         // For URLS, If not a demo cloud, we do not support the compilation test.
-        if (!txResult.txString.includes('/demo/')) {
-          throw `Unsupported URL: ${txResult.txString}`;
+        if (!txResult.transformation.includes('/demo/')) {
+          throw `Unsupported URL: ${txResult.transformation}`;
         }
 
         test += `tAsset.setCloudConfig({cloudName: 'demo'});`;
         test += `tAsset.setURLConfig({analytics:false});`;
-        test += `expect(tAsset.toURL()).toBe('${txResult.txString}');`;
+        test += `expect(tAsset.toURL()).toBe('${txResult.transformation}');`;
       } else {
-        test += `const parts = '${txResult.txString}'.replace(/\\//g, ',').split(',');\n\n`;
+        test += `const parts = '${txResult.transformation}'.replace(/\\//g, ',').split(',');\n\n`;
         test += `parts.forEach((part) => { expect(tAsset.toString()).toContain(part)})`;
       }
     }

devTools/sanity/index.ts

@@ -1,109 +1,19 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable require-jsdoc */
-const querystring = require('querystring');
-const fs = require('fs');
-const nodeFetch = require('node-fetch');
-const file = fs.readFileSync(`${__dirname}/txList`, 'utf-8');
-const createTestFile = require('./createTestFile');
-
-export interface ITxResult {
-  error: string;
-  txString: string;
-  parsedCode: string;
-  status: number;
-}
-
-export interface ITXResults {
-  success: ITxResult[],
-  fail: ITxResult[]
-}
-
-/*
- * Remove duplicates and clean lines starting with #
- * @type {string[]}
- */
-const transformationStrings = ([...new Set(file.split('\n'))] as string[])
-  .filter((a) => a[0] !== '#').filter((a) => a);
-
-/*
- *  Set the SDK Code Snippets Service URL (Change domain/port only
- */
-const baseURL = `https://staging-code-snippets.cloudinary.com/v1/generate-code`;
-
-const results:ITXResults = {
-  success:[],
-  fail: []
-};
-
-console.log(`Attempting to generate code for ${transformationStrings.length} transformations\n`);
-
-
-let counter = 0;
-transformationStrings.forEach(async (txString, i) => {
-  // Space requests apart
-  await new Promise((res) => {
-    setTimeout(() => {
-      res();
-    }, 30 * i + 1);
-  });
-
-  console.log('Processing transformation:', i);
 
-  let url = `https://res.cloudinary.com/demo/image/upload/${txString}/sample`;
-  if (txString.startsWith('http')) {
-    url = txString;
-  }
+import {ISanityGeneratorResponse} from "sdk-sanity-generator";
 
-  const queryArgs = {
-    frameworks: ['js_2'],
-    url,
-    hideActionGroups:0
-  };
-
-  const queryString = querystring.stringify(queryArgs, '&', '=', {
-    encodeURIComponent(a: string) {
-      return a;
-    }
-  });
-
-  const URL = `${baseURL}?${queryString}`;
-
-  const res = await nodeFetch(URL).catch((e: Error) => {
-    console.log(e);
-  });
-
-  const frameworksWithCode = await res.json();
-
-  // get JS snippets
-  const JSSnippet = frameworksWithCode[0];
-
-  // Fail, but not by design (11 = Expected unnsupported feature
-  if (JSSnippet.error && JSSnippet.status !== 11) {
-    results.fail.push({
-      txString,
-      error: JSSnippet.raw_code,
-      parsedCode: null,
-      status: JSSnippet.status
-    });
-  } else { // Success
-    results.success.push({
-      txString,
-      parsedCode: JSSnippet.raw_code,
-      error: null,
-      status: JSSnippet.status
-    });
-  }
+const fs = require('fs');
+const sanityGenerator = require('sdk-sanity-generator').sanityGenerator;
+const createTestFile = require('./createTestFile');
 
-  /*
-   *  Store the result in a file of your choosing
-   */
-  if (counter === transformationStrings.length - 1) {
-    console.log (`Successful transformations: ${results.success.length}`);
-    console.log (`Failed transformations: ${results.fail.length}`);
-    fs.writeFileSync(`${__dirname}/results.json`, JSON.stringify(results));
-    fs.writeFileSync(`${__dirname}/../../__TESTS__/compilation.test.ts`, createTestFile(results.success));
-  }
-  counter++;
+sanityGenerator({
+  framework: 'js_2',
+  requestSpreading: 70
+}).then((res: ISanityGeneratorResponse) => {
+  console.log(res);
+  console.log(`Successful transformations: ${res.success.length}`);
+  console.log(`Failed transformations: ${res.error.length}`);
+  fs.writeFileSync(`${__dirname}/results.json`, JSON.stringify(res.success));
+  fs.writeFileSync(`${__dirname}/../../__TESTS__/compilation.test.ts`, createTestFile(res.success));
 });
-
-