modify circular deps checker to output images of circular deps graphs

x-pack/plugins/security_solution/scripts/check_circular_deps/run_check_circular_deps_cli.js

@@ -4,17 +4,17 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { resolve } from 'path';
-
 /* eslint-disable-next-line import/no-extraneous-dependencies */
 import madge from 'madge';
 /* eslint-disable-next-line import/no-extraneous-dependencies */
 import { run, createFailError } from '@kbn/dev-utils';
+import * as os from 'os';
+import * as path from 'path';
 
 run(
   async ({ log }) => {
     const result = await madge(
-      [resolve(__dirname, '../../public'), resolve(__dirname, '../../common')],
+      [path.resolve(__dirname, '../../public'), path.resolve(__dirname, '../../common')],
       {
         fileExtensions: ['ts', 'js', 'tsx'],
         excludeRegExp: [
@@ -34,6 +34,29 @@ run(
 
     const circularFound = result.circular();
     if (circularFound.length !== 0) {
+      let count = 0;
+      for (const found of circularFound) {
+        count++;
+        try {
+          const specificGraph = await madge(found, {
+            fileExtensions: ['ts', 'js', 'tsx'],
+          });
+          const imagePath = await specificGraph.image(
+            path.join(os.tmpdir(), `siem-circular-deps-${count}.svg`)
+          );
+          console.log('wrote image to: ', imagePath);
+        } catch (error) {
+          if (
+            error.message === 'Graphviz could not be found. Ensure that "gvpr" is in your $PATH.'
+          ) {
+            console.log(
+              `Tried to save an image of the dependency graph but failed. ${error.message}`
+            );
+          } else {
+            throw error;
+          }
+        }
+      }
       throw createFailError(
         `SIEM circular dependencies of imports has been found:\n - ${circularFound.join('\n - ')}`
       );