chore(NA): tool to find plugins circular dependencies between plugins

STYLEGUIDE.md

@@ -589,6 +589,24 @@ Do not use setters, they cause more problems than they can solve.
 
 [sideeffect]: http://en.wikipedia.org/wiki/Side_effect_(computer_science)
 
+### Avoid circular dependencies
+
+As part of a future effort to use correct and idempotent build tools we need our code to be
+able to be represented as a directed acyclic graph. We must avoid having circular dependencies 
+both on code and type imports to achieve that. One of the most critical parts is the plugins 
+code. We've developed a tool to identify plugins with circular dependencies which 
+has allowed us to build a list of plugins who have circular dependencies 
+between each other. 
+
+When building plugins we should avoid importing from plugins 
+who are known to have circular dependencies at the moment as well as introducing 
+new circular dependencies. You can run the same tool we use on our CI locally by 
+typing `node scripts/find_plugins_with_circular_deps --debug`. It will error out in 
+case new circular dependencies has been added with your changes 
+(which will also happen in the CI) as well as print out the current list of
+the known circular dependencies which, as mentioned before, should not be imported 
+by your code until the circular dependencies on these have been solved. 
+
 ## SASS files
 
 When writing a new component, create a sibling SASS file of the same name and import directly into the **top** of the JS/TS component file. Doing so ensures the styles are never separated or lost on import and allows for better modularization (smaller individual plugin asset footprint).

docs/developer/best-practices/typescript.asciidoc

@@ -19,7 +19,7 @@ More details are available in the https://www.typescriptlang.org/docs/handbook/p
 ==== Caveats
 This architecture imposes several limitations to which we must comply:
 
-- Projects cannot have circular dependencies. Even though the Kibana platform doesn't support circular dependencies between Kibana plugins, TypeScript (and ES6 modules) does allow circular imports between files. So in theory, you may face a problem when migrating to the TS project references and you will have to resolve this circular dependency. https://github.com/elastic/kibana/issues/78162 is going to provide a tool to find such problem places.
+- Projects cannot have circular dependencies. Even though the Kibana platform doesn't support circular dependencies between Kibana plugins, TypeScript (and ES6 modules) does allow circular imports between files. So in theory, you may face a problem when migrating to the TS project references and you will have to resolve this circular dependency. We've built a tool that can be used to find such problems. Please read the prerequisites section below to know how to use it.
 - A project must emit its type declaration. It's not always possible to generate a type declaration if the compiler cannot infer a type. There are two basic cases:
 
 1. Your plugin exports a type inferring an internal type declared in Kibana codebase. In this case, you'll have to either export an internal type or to declare an exported type explicitly.
@@ -30,6 +30,8 @@ This architecture imposes several limitations to which we must comply:
 Since project refs rely on generated `d.ts` files, the migration order does matter. You can migrate your plugin only when all the plugin dependencies already have migrated. It creates a situation where commonly used plugins (such as `data` or `kibana_react`) have to migrate first.
 Run `node scripts/find_plugins_without_ts_refs.js --id your_plugin_id` to get a list of plugins that should be switched to TS project refs to unblock your plugin migration.
 
+Additionally, in order to migrate into project refs, you also need to make sure your plugin doesn't have circular dependencies with other plugins both on code and type imports. We run a job in the CI for each PR trying to find if new circular dependencies are being added which runs our tool with `node scripts/find_plugins_with_circular_deps`. However there are also a couple of circular dependencies already identified and that are in an allowed list to be solved. You also need to make sure your plugin don't rely in any other plugin into that allowed list. For a complete overview of the circular dependencies both found and in the allowed list as well as the complete circular dependencies path please run the following script locally with the debug flag `node scripts/find_plugins_with_circular_deps --debug` .
+
 [discrete]
 ==== Implementation
 - Make sure all the plugins listed as dependencies in *requiredPlugins*, *optionalPlugins* & *requiredBundles* properties of `kibana.json` manifest file have migrated to TS project references.

package.json

@@ -619,6 +619,7 @@
     "delete-empty": "^2.0.0",
     "dependency-check": "^4.1.0",
     "diff": "^4.0.1",
+    "dpdm": "3.5.0",
     "ejs": "^3.1.5",
     "enzyme": "^3.11.0",
     "enzyme-adapter-react-16": "^1.15.2",

scripts/find_plugin_circular_deps.js → scripts/find_plugins_with_circular_deps.js

@@ -18,4 +18,4 @@
  */
 
 require('../src/setup_node_env');
-require('../src/dev/run_find_plugin_circular_deps');
+require('../src/dev/run_find_plugins_with_circular_deps');

src/dev/plugin_discovery/find_plugins.ts

@@ -17,9 +17,12 @@
  * under the License.
  */
 import Path from 'path';
-import { REPO_ROOT } from '@kbn/dev-utils';
 import { getPluginSearchPaths } from '@kbn/config';
-import { KibanaPlatformPlugin, simpleKibanaPlatformPluginDiscovery } from '@kbn/dev-utils';
+import {
+  KibanaPlatformPlugin,
+  REPO_ROOT,
+  simpleKibanaPlatformPluginDiscovery,
+} from '@kbn/dev-utils';
 
 export interface SearchOptions {
   oss: boolean;

src/dev/run_find_plugins_with_circular_deps.ts

@@ -0,0 +1,214 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import dedent from 'dedent';
+import { parseDependencyTree, parseCircular, prettyCircular } from 'dpdm';
+import { relative } from 'path';
+import { getPluginSearchPaths } from '@kbn/config';
+import { REPO_ROOT, run } from '@kbn/dev-utils';
+
+interface Options {
+  debug?: boolean;
+  filter?: string;
+}
+
+type CircularDepList = Set<string>;
+
+const allowedList: CircularDepList = new Set([
+  'src/plugins/charts -> src/plugins/expressions',
+  'src/plugins/charts -> src/plugins/vis_default_editor',
+  'src/plugins/data -> src/plugins/embeddable',
+  'src/plugins/data -> src/plugins/expressions',
+  'src/plugins/data -> src/plugins/ui_actions',
+  'src/plugins/embeddable -> src/plugins/ui_actions',
+  'src/plugins/expressions -> src/plugins/visualizations',
+  'src/plugins/vis_default_editor -> src/plugins/visualizations',
+  'src/plugins/vis_default_editor -> src/plugins/visualize',
+  'src/plugins/visualizations -> src/plugins/visualize',
+  'x-pack/plugins/actions -> x-pack/plugins/case',
+  'x-pack/plugins/apm -> x-pack/plugins/infra',
+  'x-pack/plugins/lists -> x-pack/plugins/security_solution',
+  'x-pack/plugins/security -> x-pack/plugins/spaces',
+]);
+
+run(
+  async ({ flags, log }) => {
+    const { debug, filter } = flags as Options;
+    const foundList: CircularDepList = new Set();
+
+    const pluginSearchPathGlobs = getPluginSearchPaths({
+      rootDir: REPO_ROOT,
+      oss: false,
+      examples: true,
+    }).map((pluginFolderPath) => `${relative(REPO_ROOT, pluginFolderPath)}/**/*`);
+
+    const depTree = await parseDependencyTree(pluginSearchPathGlobs, {
+      context: REPO_ROOT,
+    });
+
+    // Build list of circular dependencies as well as the circular dependencies full paths
+    const circularDependenciesFullPaths = parseCircular(depTree).filter((circularDeps) => {
+      const first = circularDeps[0];
+      const last = circularDeps[circularDeps.length - 1];
+      const matchRegex = /(?<pluginFolder>(src|x-pack)\/plugins|examples|x-pack\/examples)\/(?<pluginName>[^\/]*)\/.*/;
+      const firstMatch = first.match(matchRegex);
+      const lastMatch = last.match(matchRegex);
+
+      if (
+        firstMatch?.groups?.pluginFolder &&
+        firstMatch?.groups?.pluginName &&
+        lastMatch?.groups?.pluginFolder &&
+        lastMatch?.groups?.pluginName
+      ) {
+        const firstPlugin = `${firstMatch.groups.pluginFolder}/${firstMatch.groups.pluginName}`;
+        const lastPlugin = `${lastMatch.groups.pluginFolder}/${lastMatch.groups.pluginName}`;
+        const sortedPlugins = [firstPlugin, lastPlugin].sort();
+
+        // Exclude if both plugin paths involved in the circular dependency
+        // doesn't includes the provided filter
+        if (filter && !firstPlugin.includes(filter) && !lastPlugin.includes(filter)) {
+          return false;
+        }
+
+        if (firstPlugin !== lastPlugin) {
+          foundList.add(`${sortedPlugins[0]} -> ${sortedPlugins[1]}`);
+          return true;
+        }
+      }
+
+      return false;
+    });
+
+    if (!debug && filter) {
+      log.warning(
+        dedent(`
+      !!!!!!!!!!!!!! WARNING: FILTER WITHOUT DEBUG !!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      ! Using the --filter flag without using --debug flag    !
+      ! will not allow you to see the filtered list of        !
+      ! the correct results.                                  !
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      `)
+      );
+    }
+
+    if (debug && filter) {
+      log.warning(
+        dedent(`
+      !!!!!!!!!!!!!!! WARNING: FILTER FLAG IS ON !!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      ! Be aware the following results are not complete as    !
+      ! --filter flag has been passed. Ignore suggestions     !
+      ! to update the allowedList or any reports of failures  !
+      ! or successes.                                         !
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+      The following filter has peen passed: ${filter}
+      `)
+      );
+    }
+
+    // Log the full circular dependencies path if we are under debug flag
+    if (debug && circularDependenciesFullPaths.length > 0) {
+      log.debug(
+        dedent(`
+      !!!!!!!!!!!!!! CIRCULAR DEPENDENCIES FOUND !!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      ! Circular dependencies were found, you can find below  !
+      ! all the paths involved.                               !
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      `)
+      );
+      log.debug(`${prettyCircular(circularDependenciesFullPaths)}\n`);
+    }
+
+    // Always log the result of comparing the found list with the allowed list
+    const diffSet = (first: CircularDepList, second: CircularDepList) =>
+      new Set([...first].filter((circularDep) => !second.has(circularDep)));
+
+    const printList = (list: CircularDepList) => {
+      return Array.from(list)
+        .sort()
+        .reduce((listStr, entry) => {
+          return listStr ? `${listStr}\n'${entry}',` : `'${entry}',`;
+        }, '');
+    };
+
+    const foundDifferences = diffSet(foundList, allowedList);
+
+    if (debug && !foundDifferences.size) {
+      log.debug(
+        dedent(`
+      !!!!!!!!!!!!!!!!! UP TO DATE ALLOWED LIST !!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      ! The declared circular dependencies allowed list is up    !
+      ! to date and includes every plugin listed in above paths. !
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+      The allowed circular dependencies list is (#${allowedList.size}):
+      ${printList(allowedList)}
+      `)
+      );
+    }
+
+    if (foundDifferences.size > 0) {
+      log.error(
+        dedent(`
+      !!!!!!!!!!!!!!!!! OUT OF DATE ALLOWED LIST !!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      ! The declared circular dependencies allowed list is out   !
+      ! of date. Please run the following locally to know more:  !
+      !                                                          !
+      ! 'node scripts/find_plugins_with_circular_deps --debug'   !
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+      The allowed circular dependencies list is (#${allowedList.size}):
+      ${printList(allowedList)}
+
+      The found circular dependencies list is (#${foundList.size}):
+      ${printList(foundList)}
+
+      The differences between both are (#${foundDifferences.size}):
+      ${printList(foundDifferences)}
+
+      FAILED: circular dependencies in the allowed list declared on the file '${__filename}' did not match the found ones.
+      `)
+      );
+
+      process.exit(1);
+    }
+
+    log.success('None non allowed circular dependencies were found');
+  },
+  {
+    description:
+      'Searches circular dependencies between plugins located under src/plugins, x-pack/plugins, examples and x-pack/examples',
+    flags: {
+      boolean: ['debug'],
+      string: ['filter'],
+      default: {
+        debug: false,
+      },
+      help: `
+        --debug            Run the script in debug mode which enables detailed path logs for circular dependencies
+        --filter           It will only include in the results circular deps where the plugin paths contains parts of the passed string in the filter
+      `,
+    },
+  }
+);

test/scripts/checks/plugins_with_circular_deps.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+source src/dev/ci_setup/setup_env.sh
+
+checks-reporter-with-killswitch "Check plugins with circular dependencies" \
+  node scripts/find_plugins_with_circular_deps

vars/tasks.groovy

@@ -12,6 +12,7 @@ def check() {
     kibanaPipeline.scriptTask('Check i18n', 'test/scripts/checks/i18n.sh'),
     kibanaPipeline.scriptTask('Check File Casing', 'test/scripts/checks/file_casing.sh'),
     kibanaPipeline.scriptTask('Check Licenses', 'test/scripts/checks/licenses.sh'),
+    kibanaPipeline.scriptTask('Check Plugins With Circular Dependencies', 'test/scripts/checks/plugins_with_circular_deps.sh'),
     kibanaPipeline.scriptTask('Verify NOTICE', 'test/scripts/checks/verify_notice.sh'),
     kibanaPipeline.scriptTask('Test Projects', 'test/scripts/checks/test_projects.sh'),
     kibanaPipeline.scriptTask('Test Hardening', 'test/scripts/checks/test_hardening.sh'),