Integrate remote cache server for Bazel

p0deje commented 4 months ago

Related to #18

This pull request introduces a significant enhancement to the setup-bazel action by implementing a remote cache server for Bazel build outputs, aiming to improve build performance and cache utilization.

Implements a remote cache server: Adds a new file remote-cache-server.js that creates an HTTP server compatible with Bazel's remote caching API. This server handles GET and PUT requests to store and retrieve cache objects, leveraging @actions/cache for underlying storage.
Integrates the remote cache server with the action: Modifies index.js to start the remote cache server as a detached process during the action's execution. The server's URL is then added to .bazelrc to enable Bazel to use it for caching.
Enhances configuration: Updates config.js to include settings for the remote cache server's URL and log file path, ensuring that these new features are configurable.
Ensures clean shutdown: Adjusts post.js to stop the remote cache server gracefully at the end of the action's execution and logs the server's output for debugging purposes.
Build script update: Modifies package.json to include the remote cache server in the build process, ensuring that all necessary components are compiled and ready for use.

For more details, open the Copilot Workspace session.

chickenandpork commented 1 month ago

Is the dist/main/ directory included by accident? Many files seem duplicate between . and dist/main/, for example, dist/main/remote-cache-server.js is in both paths.

p0deje commented 1 month ago

@chickenandpork It's included intentionally, so I could test the branch in GHA directly. This however is not intended to be used directly as it's not really working stable. Are you interested in taking over and finishing this PR?

chickenandpork commented 1 month ago

@chickenandpork It's included intentionally, so I could test the branch in GHA directly. This however is not intended to be used directly as it's not really working stable.

OK, I understand; it looked like an error of duplicate code!

Are you interested in taking over and finishing this PR?

I don't think my javascript is sufficient. I only worked javascript (and coffeescript!) briefly around 2020. Sorry :(

Personally I use a local buchgr cache and I set up the same in ephemeral build clusters.

JohnAmican commented 1 month ago

@chickenandpork It's included intentionally, so I could test the branch in GHA directly. This however is not intended to be used directly as it's not really working stable. Are you interested in taking over and finishing this PR?

I'm interested in picking this up. What's not stable? What else is outstanding?

p0deje commented 1 month ago

@JohnAmican The summary is in https://github.com/bazel-contrib/setup-bazel/issues/18#issuecomment-2143683673, the stability is the main issue as on large projects the REST API calls to the GHA cache get rate limited.

bazel-contrib / setup-bazel

Integrate remote cache server for Bazel #21