chore(NA): introduce new yarn kbn reset command to support bazel workflow

.bazelrc

@@ -1,4 +1,4 @@
-# Inspired on from https://raw.githubusercontent.com/bazelbuild/rules_nodejs/master/.bazelrc
+# Inspired on https://raw.githubusercontent.com/bazelbuild/rules_nodejs/master/.bazelrc
 # Import shared settings first so we can override below
 import %workspace%/.bazelrc.common
 

.bazelrc.common

@@ -1,4 +1,4 @@
-# Inspired on from https://raw.githubusercontent.com/bazelbuild/rules_nodejs/master/common.bazelrc
+# Inspired on https://raw.githubusercontent.com/bazelbuild/rules_nodejs/master/common.bazelrc
 # Common Bazel settings for JavaScript/NodeJS workspaces
 # This rc file is automatically discovered when Bazel is run in this workspace,
 # see https://docs.bazel.build/versions/master/guide.html#bazelrc

packages/kbn-dev-utils/stdio/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../target/stdio"
+}

packages/kbn-pm/src/commands/clean.ts

@@ -6,28 +6,31 @@
  * Public License, v 1.
  */
 
+import dedent from 'dedent';
 import del from 'del';
 import ora from 'ora';
 import { join, relative } from 'path';
 
+import { runBazel } from '../utils/bazel';
 import { isDirectory } from '../utils/fs';
 import { log } from '../utils/log';
 import { ICommand } from './';
 
 export const CleanCommand: ICommand = {
-  description: 'Remove the node_modules and target directories from all projects.',
+  description:
+    'Remove target directories from all projects, remove extra patterns and runs a Bazel state soft clean.',
   name: 'clean',
 
   async run(projects) {
+    log.warning(dedent`
+
+      'yarn kbn clean' does not remove node_modules now. It runs a more soft clean and should be used as the way to go between branches using Bazel.
+      When switching between a non Bazel branch and a Bazel branch or for situations where you need a deeper clean, run 'yarn kbn destroy' instead.
+
+    `);
+
     const toDelete = [];
     for (const project of projects.values()) {
-      if (await isDirectory(project.nodeModulesLocation)) {
-        toDelete.push({
-          cwd: project.path,
-          pattern: relative(project.path, project.nodeModulesLocation),
-        });
-      }
-
       if (await isDirectory(project.targetLocation)) {
         toDelete.push({
           cwd: project.path,
@@ -44,6 +47,10 @@ export const CleanCommand: ICommand = {
       }
     }
 
+    // Runs Bazel soft clean
+    await runBazel(['clean']);
+    log.success('Soft cleaned bazel');
+
     if (toDelete.length === 0) {
       log.success('Nothing to delete');
     } else {

packages/kbn-pm/src/commands/destroy.ts

@@ -0,0 +1,91 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * and the Server Side Public License, v 1; you may not use this file except in
+ * compliance with, at your election, the Elastic License or the Server Side
+ * Public License, v 1.
+ */
+
+import dedent from 'dedent';
+import del from 'del';
+import ora from 'ora';
+import { join, relative } from 'path';
+
+import { runBazel } from '../utils/bazel';
+import { isDirectory } from '../utils/fs';
+import { log } from '../utils/log';
+import { ICommand } from './';
+
+export const DestroyCommand: ICommand = {
+  description:
+    'Remove the node_modules, remove target directories from all projects, remove extra patterns and runs a Bazel state hard clean.',
+  name: 'destroy',
+
+  async run(projects) {
+    log.warning(dedent`
+
+      'yarn kbn destroy' is the most deeper and destroying clean command. Use it only when switching between a non Bazel branch into a
+      Bazel branch or when you are having problems with node_modules.
+      Otherwise please just run 'yarn kbn clean'.
+
+    `);
+
+    const toDelete = [];
+    for (const project of projects.values()) {
+      if (await isDirectory(project.nodeModulesLocation)) {
+        toDelete.push({
+          cwd: project.path,
+          pattern: relative(project.path, project.nodeModulesLocation),
+        });
+      }
+
+      if (await isDirectory(project.targetLocation)) {
+        toDelete.push({
+          cwd: project.path,
+          pattern: relative(project.path, project.targetLocation),
+        });
+      }
+
+      const { extraPatterns } = project.getCleanConfig();
+      if (extraPatterns) {
+        toDelete.push({
+          cwd: project.path,
+          pattern: extraPatterns,
+        });
+      }
+    }
+
+    // Runs Bazel hard clean
+    await runBazel(['clean', '--expunge']);
+    log.success('Hard cleaned bazel');
+
+    if (toDelete.length === 0) {
+      return;
+    }
+
+    /**
+     * In order to avoid patterns like `/build` in packages from accidentally
+     * impacting files outside the package we use `process.chdir()` to change
+     * the cwd to the package and execute `del()` without the `force` option
+     * so it will check that each file being deleted is within the package.
+     *
+     * `del()` does support a `cwd` option, but it's only for resolving the
+     * patterns and does not impact the cwd check.
+     */
+    const originalCwd = process.cwd();
+    try {
+      for (const { pattern, cwd } of toDelete) {
+        process.chdir(cwd);
+        const promise = del(pattern);
+
+        if (log.wouldLogLevel('info')) {
+          ora.promise(promise, relative(originalCwd, join(cwd, String(pattern))));
+        }
+
+        await promise;
+      }
+    } finally {
+      process.chdir(originalCwd);
+    }
+  },
+};

packages/kbn-pm/src/commands/index.ts

@@ -24,13 +24,15 @@ export interface ICommand {
 
 import { BootstrapCommand } from './bootstrap';
 import { CleanCommand } from './clean';
+import { DestroyCommand } from './destroy';
 import { RunCommand } from './run';
 import { WatchCommand } from './watch';
 import { Kibana } from '../utils/kibana';
 
 export const commands: { [key: string]: ICommand } = {
   bootstrap: BootstrapCommand,
   clean: CleanCommand,
+  destroy: DestroyCommand,
   run: RunCommand,
   watch: WatchCommand,
 };

packages/kbn-pm/src/utils/bazel/index.ts

@@ -7,3 +7,4 @@
  */
 
 export * from './install_tools';
+export * from './run';

packages/kbn-pm/src/utils/bazel/run.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * and the Server Side Public License, v 1; you may not use this file except in
+ * compliance with, at your election, the Elastic License or the Server Side
+ * Public License, v 1.
+ */
+
+import chalk from 'chalk';
+import execa from 'execa';
+import * as Rx from 'rxjs';
+import { tap } from 'rxjs/operators';
+import { observeLines } from '@kbn/dev-utils/stdio';
+import { spawn } from '../child_process';
+import { log } from '../log';
+
+export async function runBazel(bazelArgs: string[], runOpts: execa.Options = {}) {
+  // Force logs to pipe in order to control the output of them
+  const bazelOpts: execa.Options = {
+    ...runOpts,
+    stdio: 'pipe',
+  };
+
+  const bazelProc = spawn('bazel', bazelArgs, bazelOpts);
+
+  const bazelLogs$ = new Rx.Subject<string>();
+
+  // Bazel outputs machine readable output into stdout and human readable output goes to stderr.
+  // Therefore we need to get both. In order to get errors we need to parse the actual text line
+  const bazelLogSubscription = Rx.merge(
+    observeLines(bazelProc.stdout!).pipe(
+      tap((line) => log.info(`${chalk.cyan('[bazel]')} ${line}`))
+    ),
+    observeLines(bazelProc.stderr!).pipe(
+      tap((line) => log.info(`${chalk.cyan('[bazel]')} ${line}`))
+    )
+  ).subscribe(bazelLogs$);
+
+  // Wait for process and logs to finish, unsubscribing in the end
+  await bazelProc;
+  await bazelLogs$.toPromise();
+  await bazelLogSubscription.unsubscribe();
+}