Skip to content

Conversation

@ken-zlai
Copy link
Contributor

@ken-zlai ken-zlai commented Jan 8, 2025

Summary

Added caching for Node modules and Thrift compiler in the frontend CI workflow to improve build times and reduce resource usage. Using actions/setup-node for npm dependencies and awalsh128/cache-apt-pkgs-action for the Thrift compiler.

This change will speed up CI runs by caching dependencies between workflow executions, reducing the time spent on package installation and downloads by about 10%.

Checklist

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

Summary by CodeRabbit

  • Chores
    • Updated frontend testing workflow configuration
    • Implemented caching for npm dependencies
    • Streamlined Thrift compiler installation process
    • Enhanced CI performance through package caching

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow for frontend testing by introducing caching mechanisms for npm and apt packages. The changes optimize the CI process by caching dependencies using package-lock.json and implementing a new caching strategy for the Thrift compiler installation. The workflow's core structure remains unchanged, with improvements focused on dependency management and performance.

Changes

File Change Summary
.github/workflows/test_frontend.yaml - Added npm caching with cache and cache-dependency-path parameters
- Replaced direct Thrift compiler installation with awalsh128/cache-apt-pkgs-action
- Streamlined package dependency caching strategy

Possibly related PRs

  • Setup frontend CI #139: Introduces a new GitHub Actions workflow for frontend testing, showing a direct connection in CI process improvements.

Suggested reviewers

  • sean-zlai
  • nikhil-zlai

Poem

🚀 Caching magic in the CI lane,
Dependencies dance, no more mundane!
Npm and Thrift, swift and light,
Workflows singing with pure delight!
Performance soars, efficiency gleams ✨

Warning

Review ran into problems

🔥 Problems

GitHub Actions: 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.


📜 Recent 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 436485a and ccadcab.

📒 Files selected for processing (1)
  • .github/workflows/test_frontend.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/test_frontend.yaml

🪧 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.

@ken-zlai ken-zlai changed the title cache node and thrift ci: optimize frontend github actions Jan 8, 2025
@ken-zlai ken-zlai marked this pull request as ready for review January 8, 2025 18:12
@ken-zlai ken-zlai requested a review from sean-zlai January 8, 2025 18:12
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
.github/workflows/test_frontend.yaml (1)

Line range hint 47-75: Track disabled test configurations

Multiple disabled test sections should be tracked in issues.

Want me to create GitHub issues to track these TODOs?

📜 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 8aede2d and 436485a.

📒 Files selected for processing (1)
  • .github/workflows/test_frontend.yaml (1 hunks)
🔇 Additional comments (1)
.github/workflows/test_frontend.yaml (1)

35-36: LGTM: Proper npm caching configuration

Copy link
Contributor

@sean-zlai sean-zlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ken-zlai, this is great!

I compared before/after PR runs and noticed the Setup Node step took a few extra seconds (1s => 3s), but could just be a simple run to run difference (and quite a tiny change regardless).

Before After
image image

The apt-get step did drop a good bit as expected (12s => 3s). This is a nice action / abstraction from using actions/cache directly.

If we ever need to do something more complex to setup the environment, we could look at a custom Docker container approach (similar to the python workflow)

@ken-zlai
Copy link
Contributor Author

ken-zlai commented Jan 8, 2025

Thanks @ken-zlai, this is great!

I compared before/after PR runs and noticed the Setup Node step took a few extra seconds (1s => 3s), but could just be a simple run to run difference (and quite a tiny change regardless).

Before After
image image
The apt-get step did drop a good bit as expected (12s => 3s). This is a nice action / abstraction from using actions/cache directly.

If we ever need to do something more complex to setup the environment, we could look at a custom Docker container approach (similar to the python workflow)

Yeah, I've noticed that most of the steps have an inconsistent runtime. I've seen the optimized node runtime at 1s and also 3s like you mentioned :)

@ken-zlai ken-zlai merged commit 13b621f into main Jan 8, 2025
4 checks passed
@ken-zlai ken-zlai deleted the ken/optimize-github-actions branch January 8, 2025 21:05
tchow-zlai pushed a commit that referenced this pull request Jan 9, 2025
## Summary
Added caching for Node modules and Thrift compiler in the frontend CI
workflow to improve build times and reduce resource usage. Using
[actions/setup-node](https://github.com/actions/setup-node#caching-global-packages-data)
for npm dependencies and
[awalsh128/cache-apt-pkgs-action](https://github.com/awalsh128/cache-apt-pkgs-action)
for the Thrift compiler.

This change will speed up CI runs by caching dependencies between
workflow executions, reducing the time spent on package installation and
downloads by about 10%.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Chores**
    - Updated frontend testing workflow configuration
    - Implemented caching for npm dependencies
    - Streamlined Thrift compiler installation process
    - Enhanced CI performance through package caching
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Thomas Chow <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request Jan 31, 2025
4 tasks
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary
Added caching for Node modules and Thrift compiler in the frontend CI
workflow to improve build times and reduce resource usage. Using
[actions/setup-node](https://github.com/actions/setup-node#caching-global-packages-data)
for npm dependencies and
[awalsh128/cache-apt-pkgs-action](https://github.com/awalsh128/cache-apt-pkgs-action)
for the Thrift compiler.

This change will speed up CI runs by caching dependencies between
workflow executions, reducing the time spent on package installation and
downloads by about 10%.

## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Chores**
    - Updated frontend testing workflow configuration
    - Implemented caching for npm dependencies
    - Streamlined Thrift compiler installation process
    - Enhanced CI performance through package caching
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants