Fixes

Author: elena-shostak

.gitignore

@@ -160,3 +160,4 @@ x-pack/test/security_solution_playwright/playwright/.cache/
 x-pack/test/security_solution_playwright/.auth/
 x-pack/test/security_solution_playwright/.env
 .codeql
+.dependency-graph-log.json

packages/kbn-dependency-usage/README.md

@@ -9,7 +9,7 @@ A CLI tool for analyzing dependencies across packages and plugins. This tool pro
 1. [Usage](#usage)
    - [Show all packages/plugins using a dependency](#show-all-packagesplugins-using-a-dependency)
    - [Show dependencies grouped by code owner](#show-dependencies-grouped-by-code-owner)
-   - [List all dependencies for a package or directory](#list-all-dependencies-for-a-package-or-directory)
+   - [List all dependencies for a package or directory](#list-all-dependencies-for-source-directory)
    - [Group by code owner with adjustable collapse depth](#group-by-code-owner-with-adjustable-collapse-depth)
    - [Show dependencies matching a pattern](#show-dependencies-matching-a-pattern)
    - [Verbose flag to debug dependency graph issues](#verbose-flag-to-debug-dependency-graph-issues)

packages/kbn-dependency-usage/src/cli.test.ts

@@ -66,8 +66,8 @@ describe('dependency-usage CLI', () => {
   });
 
   it('should use default values when optional arguments are not provided', () => {
-    const argv = parser.parse(['--paths', './src']);
-    expect(argv.paths).toEqual(['./src']);
+    const argv = parser.parse([]);
+    expect(argv.paths).toEqual(['.']);
     expect(argv['dependency-name']).toBeUndefined();
     expect(argv['collapse-depth']).toBe(1);
     expect(argv.verbose).toBe(false);
@@ -79,11 +79,6 @@ describe('dependency-usage CLI', () => {
     }).toThrow('Summary option can only be used when a dependency name is provided');
   });
 
-  it('should set default values for unspecified options', () => {
-    const argv = parser.parse(['--paths', './src']);
-    expect(argv['collapse-depth']).toBe(1);
-  });
-
   it('should validate collapse-depth as a positive integer', () => {
     expect(() => {
       parser.parse(['--paths', './src', '--collapse-depth', '0']);

packages/kbn-dependency-usage/src/cli.ts

@@ -85,7 +85,6 @@ export const configureYargs = () => {
 
             return true;
           })
-          .demandOption(['paths'], 'Please provide at least one path to search within')
           .example(
             '--dependency-name lodash --paths ./src ./lib',
             chalk.blue(

packages/kbn-dependency-usage/src/dependency_graph/common/constants.ts

@@ -21,7 +21,6 @@ export const excludePaths = [
   '(^|/)target($|/)',
   '^kbn',
   '^@kbn',
-  '@elastic',
   '^.buildkite',
   '^docs',
   '^dev_docs',

packages/kbn-dependency-usage/src/dependency_graph/providers/cruiser.test.ts

@@ -19,6 +19,15 @@ const codeOwners: Record<string, string[]> = {
   'plugins/data_charts': ['team_visualization'],
   'plugins/analytics': ['team_analytics'],
   'plugins/notification': ['team_alerts', 'team_notifications'],
+  'plugins/security_solution/public/entity_analytics/components': ['team_security_analytics'],
+  'plugins/security_solution/public/entity_analytics/components/componentA.ts': [
+    'team_security_analytics',
+  ],
+  'plugins/security_solution/public/entity_analytics/components/componentB.ts': [
+    'team_security_analytics',
+  ],
+  'plugins/security_solution/server/lib/analytics/analytics.ts': ['team_security_analytics'],
+  'plugins/security_solution/common/api/detection_engine': ['team_security_solution'],
 };
 
 jest.mock('dependency-cruiser', () => ({
@@ -285,4 +294,61 @@ describe('identifyDependencyUsage', () => {
       },
     });
   });
+
+  it('should search for specific dependency and group by owner', async () => {
+    const customCruiseResult = {
+      output: {
+        summary: {
+          violations: [
+            {
+              from: 'plugins/security_solution/public/entity_analytics/components/componentA.ts',
+              to: 'node_modules/lodash/fp.js',
+            },
+            {
+              from: 'plugins/security_solution/public/entity_analytics/components/componentB.ts',
+              to: 'node_modules/lodash/partition.js',
+            },
+            {
+              from: 'plugins/security_solution/server/lib/analytics/analytics.ts',
+              to: 'node_modules/lodash/partition.js',
+            },
+            {
+              from: 'plugins/security_solution/server/lib/analytics/analytics.ts',
+              to: 'node_modules/lodash/cloneDeep.js',
+            },
+            {
+              from: 'plugins/security_solution/common/api/detection_engine',
+              to: 'node_modules/lodash/sortBy.js',
+            },
+          ],
+        },
+        modules: [],
+      },
+    };
+    (cruise as jest.Mock).mockResolvedValue(customCruiseResult);
+
+    const result = await identifyDependencyUsage([], 'lodash', {
+      groupBy: 'owner',
+      collapseDepth: 3,
+      summary: false,
+    });
+
+    expect(cruise).toHaveBeenCalled();
+    expect(result).toEqual({
+      team_security_analytics: {
+        modules: [
+          'plugins/security_solution/public/entity_analytics/components/componentA.ts',
+          'plugins/security_solution/public/entity_analytics/components/componentB.ts',
+          'plugins/security_solution/server/lib/analytics/analytics.ts',
+        ],
+        deps: ['lodash/fp.js', 'lodash/partition.js', 'lodash/cloneDeep.js'],
+        teams: ['team_security_analytics'],
+      },
+      team_security_solution: {
+        modules: ['plugins/security_solution/common/api/detection_engine'],
+        deps: ['lodash/sortBy.js'],
+        teams: ['team_security_solution'],
+      },
+    });
+  });
 });

packages/kbn-dependency-usage/src/dependency_graph/providers/cruiser.ts

@@ -112,6 +112,10 @@ export async function identifyDependencyUsageWithCruiser(
 
   const { violations } = result.output.summary;
 
+  if (groupBy === 'owner') {
+    return groupFilesByOwners(violations);
+  }
+
   if (dependencyName) {
     const dependencyRegex = new RegExp(`node_modules/${dependencyName}`);
 
@@ -139,9 +143,5 @@ export async function identifyDependencyUsageWithCruiser(
     };
   }
 
-  if (groupBy === 'owner') {
-    return groupFilesByOwners(violations);
-  }
-
   return groupBySource(violations);
 }

packages/kbn-dependency-usage/src/lib/group_by_owners.ts

@@ -26,7 +26,7 @@ export function groupFilesByOwners(dependencies: Array<{ from: string; to: strin
     const { from, to } = dep;
 
     const owners = getCodeOwnersForFile(from, reversedCodeowners) ?? [UNKNOWN_OWNER];
-    const ownerKey = owners.length > 1 ? MULTIPLE_TEAMS_OWNER : owners.join(',');
+    const ownerKey = owners.length > 1 ? MULTIPLE_TEAMS_OWNER : owners[0];
 
     if (ownerKey === MULTIPLE_TEAMS_OWNER) {
       if (!ownerFilesMap.has(ownerKey)) {

scripts/dependency_usage.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Need to tun the script with ts-node/esm since dependency-cruiser is only available as an ESM module.
-# We dpecify the correct tsconfig.json file to ensure compatibility, as our current setup doesn’t fully support ESM modules.
+# We specify the correct tsconfig.json file to ensure compatibility, as our current setup doesn’t fully support ESM modules.
 # Should be resolved after https://github.com/elastic/kibana/issues/198790 is done.
 NODE_NO_WARNINGS=1 TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=packages/kbn-dependency-usage/tsconfig.json \
 node --loader ts-node/esm packages/kbn-dependency-usage/src/cli.ts "$@"