tree d10f003ebe7fe9f75b4d22451a889dc91faebe88
parent 7670e67e72d6d4aaac174b91f4465a67479e1026
author Leopold Schabel <leo@nexantic.com> 1573823265 +0100
committer Leopold Schabel <leo@nexantic.com> 1573823265 +0100

Bazel IntelliJ plugin support

This eliminates the need for manually synchronizing generated files.

The plugin authors advise against checking in the .iwjb directory,
which we resolutely ignore. The recommended method is to provide a
template .bazelproject file that everyone needs to manually import and
update. However, checking in the directory is supported and no different
than checking in .idea. This allows us to version things like watchers
and run configurations, at the expense of requiring everyone to use
the same IntelliJ and Bazel plugin versions.

How it works:

- Source code and execroot paths are identical inside and outside the
  container. This requires a bind mount. To avoid conflicts with a
  local Bazel instance, a separate directory is used.

  The wrapper script injects a --output_user_root startup parameter.
  We cannot set this in .bazelrc since we cannot substitute the
  user home. This means that running bazel inside the container,
  without the wrapper, will no longer work/blow up the overlayfs.

  Did anyone do this?

- The tmpfs and other caches are eliminated.
  Forcing it hasn't been ideal anyway due to
  the excessive memory usage, and it can still be accomplished
  by mounting a tmpfs to `~/.cache/bazel-nxt` or symlinking it to
  `/dev/shm` or similar (set proper permissions!).

- The plugin configures a custom local repository that has helper
  scripts. Since we need to be on the same IntelliJ version, we can
  simply hardcode the path and bind mount it (read only).

  The alternative would be to copy the files into the container and
  override the command line option using sync_flags
  (https://github.com/bazelbuild/intellij/issues/397), but bind
  mounting seems muche easier at no disadvantage.

- IntelliJ needs a somewhat obscure custom startup option (see README)
  for BEP temp files (https://github.com/bazelbuild/intellij/issues/407).

Test Plan:
- Running tests works:

  {F16996}

- Full and partial sync works:

  {F17000}

- Updating a protobuf file triggered the watcher, which rebuilt the
  generated files. After triggering an source sync, the changes
  are visible in the IDE (I suspect that IntelliJ does not inotify-
  watch the generated files since they are outside the project directory.

X-Origin-Diff: phab/D263
GitOrigin-RevId: 39c50665575c2a0131c492385b0981b7ee2588d8