Updated dev notes with Bazel installation instructions and java error fix

[kumar-zlai]

Summary

Updated dev notes with Bazel installation instructions and java error fix

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested
• Documentation update

Summary by CodeRabbit

• Documentation
  • Enhanced setup guidance for Bazel installation on both Mac and Linux.
  • Provided clear instructions for resolving Java-related issues on Mac.
  • Updated testing procedures by replacing previous instructions with streamlined Bazel commands.

[coderabbitai]

Walkthrough

The changes update the devnotes.md file by adding new documentation for Bazel setup. It introduces a "Bazel Setup" section with subsections on installing Bazel on Mac (using brew for bazelisk) and Linux (download and permission commands), along with a "Java not found error on Mac" subsection that advises installing Amazon Corretto-17. Outdated SBT testing instructions are removed in favor of Bazel commands for building and testing modules.

Changes

File	Change Summary
devnotes.md	Added "Bazel Setup" section with the following: - Installing Bazel: Instructions for Mac (brew bazelisk) and Linux (download command with permission set). - Java not found error on Mac: Guidance to install Amazon Corretto-17. - Removed SBT testing instructions and replaced with Bazel commands for module build and test.

Possibly related PRs

• chore: install bazelisk #313: Addresses Bazelisk usage, paralleling the new Bazel setup documentation.
• Bazel changes to avoid runtime errors while running Spark and Flume jobs #274: Involves Bazel build file modifications, aligning with the focus on Bazel configuration.

Suggested reviewers

• nikhil-zlai
• piyush-zlai
• tchow-zlai

Poem

In the realm of docs so bright,
Bazel steps into the light.
Mac and Linux paths align,
SBT fades, Bazel commands shine.
A little tweak, a guiding star—
Our code docs now raise the bar!
🚀✨

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

tools/build_rules/thrift/thrift.bzl (1)

103-114: Consider adding language support configuration.

The TODO indicates plans for multi-language support. Consider adding a languages attribute to configure which languages to generate.

 def thrift_gen_library(name, srcs, **kwargs):
+    languages = kwargs.pop("languages", ["java"])
     _thrift_gen_library(
         name = name,
         srcs = srcs,
+        languages = languages,
         thrift_binary = select({

devnotes.md (2)

68-77: IntelliJ Configuration Instructions.
Use asterisks for list items to meet markdown style guidelines.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~74-~74: Consider adding a hyphen.
Context: ...ile - We should see a bazel icon in the top right corner to the left of search bar - U...

(TOP_LEFT_CORNER)

🪛 markdownlint-cli2 (0.17.2)

70-70: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

71-71: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

72-72: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

72-72: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

73-73: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

73-73: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

74-74: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

75-75: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

75-75: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

76-76: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

123-169: Legacy SBT Setup Section Present.
Retaining old SBT instructions. Confirm this is intentional for legacy support.

🧰 Tools

🪛 LanguageTool

[grammar] ~135-~135: Did you mean “copying and pasting”?
Context: ...17-fails-with-illegalaccesserror-cl) by copy pasting into the run configuration arguments li...

(COPY_PASTE)

🪛 markdownlint-cli2 (0.17.2)

127-127: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

128-128: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

129-129: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

130-130: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

133-133: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

---

151-151: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

---

154-154: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

---

155-155: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

156-156: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

161-161: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)

---

164-164: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 2da45f8 and 9f65f5e.

📒 Files selected for processing (14)

• .github/workflows/test_scala_no_spark.yaml (1 hunks)
• .github/workflows/test_scala_spark.yaml (1 hunks)
• aggregator/BUILD.bazel (3 hunks)
• api/BUILD.bazel (2 hunks)
• cloud_gcp/BUILD.bazel (3 hunks)
• devnotes.md (1 hunks)
• flink/BUILD.bazel (4 hunks)
• hub/BUILD.bazel (3 hunks)
• online/BUILD.bazel (3 hunks)
• orchestration/BUILD.bazel (3 hunks)
• service/BUILD.bazel (1 hunks)
• service_commons/BUILD.bazel (1 hunks)
• spark/BUILD.bazel (3 hunks)
• tools/build_rules/thrift/thrift.bzl (3 hunks)

🧰 Additional context used

🪛 LanguageTool

devnotes.md

[uncategorized] ~74-~74: Consider adding a hyphen.
Context: ...ile - We should see a bazel icon in the top right corner to the left of search bar - U...

(TOP_LEFT_CORNER)

🪛 markdownlint-cli2 (0.17.2)

devnotes.md

70-70: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

71-71: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

72-72: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

72-72: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

73-73: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

73-73: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

74-74: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

75-75: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

---

75-75: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

76-76: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

🔇 Additional comments (30)

cloud_gcp/BUILD.bazel (4)

7-7: LGTM: Dependency update aligns with project-wide standardization.

The change from //api:thrift to //api:thrift_java matches the standardization effort.

---

49-49: LGTM: Consistent dependency update in test_deps.

Matches the same dependency update as in cloud_gcp_lib.

---

87-87: LGTM: Library name follows new convention.

Renaming from cloud_gcp_test_lib to test_lib aligns with project standards.

---

95-95: LGTM: Test suite updates are consistent.

Both the target name change to "tests" and the dependency update to ":test_lib" follow the standardization.

Also applies to: 100-100

orchestration/BUILD.bazel (1)

7-7: LGTM! Consistent dependency and naming updates.

Also applies to: 17-17, 28-28, 35-35, 38-38

service_commons/BUILD.bazel (1)

21-21: LGTM! Consistent with project-wide updates.

Also applies to: 29-29, 36-36, 40-40

service/BUILD.bazel (1)

35-35: LGTM! Naming standardization applied correctly.

Also applies to: 42-42, 46-46

aggregator/BUILD.bazel (1)

7-7: LGTM! All changes align with project standards.

Also applies to: 23-23, 50-50, 57-57, 60-60

api/BUILD.bazel (3)

8-19: LGTM: Explicit java_library naming.

Clear dependency separation between generated code and Java sources.

---

21-60: LGTM: Consistent dependency and naming updates.

---

1-6: LGTM: New thrift_gen_library rule looks good.

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Verify thrift files exist
fd -e thrift . thrift/

Length of output: 119

---

I'll re-run the verification by checking for thrift files relative to the BUILD file’s directory. Let's execute a script that looks into the api/thrift folder:

---

🏁 Script executed:

#!/bin/bash
# Check for thrift files under api/thrift (BUILD file location)
if [ -d "api/thrift" ]; then
  find api/thrift -type f -name "*.thrift"
else
  echo "Directory api/thrift does not exist"
fi

Length of output: 225

---

Thrift Gen Rule Verified

• api/BUILD.bazel correctly uses glob(["thrift/*.thrift"]) relative to the BUILD file.
• The api/thrift directory exists and contains the expected thrift files.

hub/BUILD.bazel (1)

1-71: LGTM: Consistent dependency and naming updates.

online/BUILD.bazel (1)

1-78: LGTM: Consistent dependency and naming updates.

flink/BUILD.bazel (1)

1-92: LGTM: Improved naming clarity with module prefixes.

Binary names now clearly indicate their module context.

tools/build_rules/thrift/thrift.bzl (2)

50-55: LGTM! Function renamed for better extensibility.

The implementation function is now named more generically.

---

87-101: LGTM! Rule renamed consistently.

The rule name matches the implementation function.

spark/BUILD.bazel (3)

8-8: LGTM! Dependency updated.

Updated to use the new Java-specific Thrift library.

---

89-93: LGTM! Test naming standardized.

Test library and suite names follow the new convention.

Also applies to: 95-103

---

105-110: LGTM! Binary name clarified.

More descriptive name for the Spark assembly.

.github/workflows/test_scala_spark.yaml (1)

47-47: LGTM! Test target updated.

Matches the renamed test suite in BUILD.bazel.

.github/workflows/test_scala_no_spark.yaml (1)

54-54: LGTM! Test targets updated consistently.

All module test targets follow the new naming convention.

Also applies to: 61-61, 68-68, 75-75, 82-82, 89-89, 96-96

devnotes.md (9)

51-52: New Bazel Setup Section Added.
The new header clearly demarcates the Bazel instructions from the rest.

---

53-60: Bazel Installation (Mac) Instructions.
Concise commands; consider linking to Bazelisk docs for additional context.

---

61-66: Bazel Installation (Linux) Instructions.
Clear steps; verify URL/version remains current.

---

78-82: Remote Caching Instructions.
Straightforward and clear; no issues found.

---

83-87: Java Not Found Error Fix.
Clear and actionable fix; installs Amazon Corretto-17 as required.

---

88-100: Uber Jar Build Commands.
Commands are clear; placeholders indicate where to insert module/target values.

---

102-107: Module Test Command.
Simple and effective instruction for running all tests in a module.

---

108-112: Individual Test File Command.
Clear example for testing a specific file using placeholders.

---

114-121: Repository Clean Commands.
Commands are accurate and well explained.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

devnotes.md (2)

53-67: Bazel Setup: Clear and concise instructions.
The Bazel installation steps for Mac and Linux are well documented. Consider noting that the PATH update on Linux may need to be added permanently to your shell configuration.

---

83-86: Java Error Fix: Good solution.
The instructions for resolving the Java not found error on Mac are clear. You might add a brief note on setting JAVA_HOME if needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 9f65f5e and 8b06939.

📒 Files selected for processing (1)

• devnotes.md (3 hunks)