chore(NA): manage npm dependencies within bazel (#92864)

* chore(NA): full WORKSPACE.bazel logic plus manage yarn dependencies with Bazel * chore(NA): update BUILD.bazel files comments on root and packages * chore(NA): add workspace file with useful data * chore(NA): install deps through bazel * chore(NA): update workspace file * chore(NA): update into last rules nodejs * chore(NA): ensure bazel always run yarn install * chore(NA): support offline mode * chore(NA): remove elastic-datemath * chore(NA): restore bazel 4.0.0 * chore(NA): update kbn pm dist * chore(NA): introduce force-install command * docs(NA): update docs with new yarn kbn bootstrap flags * chore(NA): use path.resolve on kbn bootstrap integrity check verification * chore(NA): update .yarnrc Co-authored-by: Tyler Smalley <[email protected]> * chore(NA): change cli argument typo * chore(NA): fix spacing on kbn pm cli Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Tyler Smalley <[email protected]>
elastic · Mar 3, 2021 · 86f1684 · 86f1684
1 parent a8d45e7
commit 86f1684
Show file tree

Hide file tree

Showing 13 changed files with 1,186 additions and 974 deletions.
diff --git a/.bazelrc b/.bazelrc
@@ -16,3 +16,12 @@ build --workspace_status_command="node ./src/dev/bazel_workspace_status.js"
 # build --build_metadata=VISIBILITY=PUBLIC
 build --build_metadata=TEST_GROUPS=//packages
 
+###############################
+# Offline Support             #
+# Turn on these settings with #
+#  --config=offline           #
+###############################
+
+## Reset remote cache and backend support
+build:offline --bes_backend="" --remote_cache=""
+run:offline --bes_backend="" --remote_cache=""
diff --git a/.bazelrc.common b/.bazelrc.common
@@ -7,7 +7,9 @@
 
 # Local Cache Settings
 ## Avoid cache results from being corrupt when changing source during build
-common --experimental_guard_against_concurrent_changes
+build --experimental_guard_against_concurrent_changes
+run --experimental_guard_against_concurrent_changes
+test --experimental_guard_against_concurrent_changes
 
 ## Cache action outputs on disk so they persist across output_base and bazel shutdown (eg. changing branches)
 build --disk_cache=~/.bazel-cache/disk-cache

diff --git a/.yarnrc b/.yarnrc
@@ -3,3 +3,9 @@ yarn-offline-mirror ".yarn-local-mirror"
 
 # Always look into the cache first before fetching online
 --install.prefer-offline true
+
+# Disable interactive and progress logs as yarn install is now
+# managed by Bazel and we are piping the logs from the underlying
+# process running bazel into the parent one running kbn
+--install.non-interactive true
+--install.no-progress true
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -1,3 +1,5 @@
+# Expose those targets as they are required as part of
+# other packages builds and need to be included as inputs
 exports_files(
   [
     "tsconfig.json",

diff --git a/WORKSPACE.bazel b/WORKSPACE.bazel
@@ -1,3 +1,68 @@
+# Define the workspace base name and a managed directory by bazel
+# that will hold the node_modules called @npm
 workspace(
-    name = "kibana",
+  name = "kibana",
+  managed_directories = {"@npm": ["node_modules"]},
+)
+
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+# Fetch Node.js rules
+http_archive(
+  name = "build_bazel_rules_nodejs",
+  sha256 = "bfacf15161d96a6a39510e7b3d3b522cf61cb8b82a31e79400a84c5abcab5347",
+  urls = ["https://github.com/bazelbuild/rules_nodejs/releases/download/3.2.1/rules_nodejs-3.2.1.tar.gz"],
+)
+
+# Now that we have the rules let's import from them to complete the work
+load("@build_bazel_rules_nodejs//:index.bzl", "check_rules_nodejs_version", "node_repositories", "yarn_install")
+
+# Assure we have at least a given rules_nodejs version
+check_rules_nodejs_version(minimum_version_string = "3.2.1")
+
+# Setup the Node.js toolchain for the architectures we want to support
+#
+# NOTE: darwin-arm64 is not being installed because bazel is not yet available on that architecture.
+# The PR for it was merged and should be available in the next release of bazel and bazelisk. As soon as they have it
+# we can update that rule.
+node_repositories(
+  node_repositories = {
+    "14.16.0-darwin_amd64": ("node-v14.16.0-darwin-x64.tar.gz", "node-v14.16.0-darwin-x64", "14ec767e376d1e2e668f997065926c5c0086ec46516d1d45918af8ae05bd4583"),
+    "14.16.0-linux_arm64": ("node-v14.16.0-linux-arm64.tar.xz", "node-v14.16.0-linux-arm64", "440489a08bfd020e814c9e65017f58d692299ac3f150c8e78d01abb1104c878a"),
+    "14.16.0-linux_s390x": ("node-v14.16.0-linux-s390x.tar.xz", "node-v14.16.0-linux-s390x", "335348e46f45284b6356416ef58f85602d2dee99094588b65900f6c8839df77e"),
+    "14.16.0-linux_amd64": ("node-v14.16.0-linux-x64.tar.xz", "node-v14.16.0-linux-x64", "2e079cf638766fedd720d30ec8ffef5d6ceada4e8b441fc2a093cb9a865f4087"),
+    "14.16.0-windows_amd64": ("node-v14.16.0-win-x64.zip", "node-v14.16.0-win-x64", "716045c2f16ea10ca97bd04cf2e5ef865f9c4d6d677a9bc25e2ea522b594af4f"),
+  },
+  node_version = "14.16.0",
+  node_urls = [
+    "https://nodejs.org/dist/v{version}/{filename}",
+  ],
+  yarn_repositories = {
+    "1.21.1": ("yarn-v1.21.1.tar.gz", "yarn-v1.21.1", "d1d9f4a0f16f5ed484e814afeb98f39b82d4728c6c8beaafb5abc99c02db6674"),
+  },
+  yarn_version = "1.21.1",
+  yarn_urls = [
+    "https://github.com/yarnpkg/yarn/releases/download/v{version}/{filename}",
+  ],
+  package_json = ["//:package.json"],
+)
+
+# Run yarn_install rule to take care of dependencies
+#
+# NOTE: FORCE_COLOR env var forces colors on non tty mode
+yarn_install(
+  name = "npm",
+  environment = {
+    "FORCE_COLOR": "True",
+  },
+  package_json = "//:package.json",
+  yarn_lock = "//:yarn.lock",
+  data = [
+    "//:.yarnrc",
+    "//:preinstall_check.js",
+    "//:node_modules/.yarn-integrity",
+  ],
+  symlink_node_modules = True,
+  quiet = False,
+  frozen_lockfile = False,
 )
diff --git a/docs/developer/getting-started/index.asciidoc b/docs/developer/getting-started/index.asciidoc
@@ -47,6 +47,23 @@ https://github.com/nodejs/node-gyp#installation[https://github.com/nodejs/node-g
 and follow the guide according your platform.
 ____
 
+In case you don't have an internet connection, the `yarn kbn bootstrap` command will 
+fail. As it is likely you have the required node_modules in the 
+offline mirror, you can try to run the step in offline mode by using:
+
+[source,bash]
+----
+yarn kbn bootstrap --offline
+----
+
+In any other circumstance where you want to force the node_modules install step 
+you can use:
+
+[source,bash]
+----
+yarn kbn bootstrap --force-install
+----
+
 (You can also run `yarn kbn` to see the other available commands. For
 more info about this tool, see
 {kib-repo}tree/{branch}/packages/kbn-pm[{kib-repo}tree/{branch}/packages/kbn-pm].)

diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel
@@ -1,4 +1,5 @@
-# Call each package final target
+# Grouping target to call all underlying packages build
+# targets so we can build them all at once
 filegroup(
   name = "build",
   srcs = [],