Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflow dispatch and improve error logging in AWS Staging workflow #4049

Merged
merged 7 commits into from
Nov 8, 2024

Conversation

piotrwitek
Copy link
Contributor

@piotrwitek piotrwitek commented Nov 8, 2024

Introduce a manual trigger for the AWS Staging workflow, add a new environment variable for subgraph URLs, and enhance error logging for missing token prices.

Summary by CodeRabbit

  • New Features

    • Introduced a new environment variable SUBGRAPH_BASE for enhanced configuration options.
    • Added manual triggering capability for AWS deployment workflows.
  • Bug Fixes

    • Improved error handling and logging for token price retrieval, simplifying error messages for better clarity.
  • Chores

    • Updated Docker build process to include the new SUBGRAPH_BASE argument in production and staging workflows.

Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Warning

Rate limit exceeded

@piotrwitek has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 38 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between bfeb5b6 and 7f699c9.

Walkthrough

The changes in this pull request introduce a new environment variable SUBGRAPH_BASE across multiple files, including .env.template, Dockerfiles, and GitHub Actions workflows. This variable is intended to facilitate configuration for subgraph-related URLs and is incorporated into the build processes for both production and staging environments. Additionally, the error handling in the blockchain/prices.ts file is refined to improve clarity in logging without altering existing functionality.

Changes

File Change Summary
.env.template Added SUBGRAPH_BASE variable with an empty value before the "APIs" section.
.github/workflows/aws-prod.yaml Added --build-arg SUBGRAPH_BASE=${{ secrets.SUBGRAPH_BASE }} to Docker build command.
.github/workflows/aws-staging.yaml Added workflow_dispatch trigger and SUBGRAPH_BASE variable in the Build standalone app step.
Dockerfile.production Added ARG SUBGRAPH_BASE='' and ENV SUBGRAPH_BASE=$SUBGRAPH_BASE, modifying handling of existing variables.
blockchain/prices.ts Refined error logging in createTokenPriceInUSD$ function to improve clarity without changing existing logic.

Possibly related PRs

Suggested reviewers

  • marcinciarka
  • piekczyk

Poem

🐇 In the land of code where rabbits play,
A new variable hops in to brighten the day.
SUBGRAPH_BASE joins the fun,
With workflows and Docker, the changes are spun.
Error messages clearer, no more dismay,
Hooray for the updates, hip-hip-hooray! 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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.

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: 4

🧹 Outside diff range and nitpick comments (3)
.env.template (1)

20-22: Consider consolidating subgraph-related variables.

The new SUBGRAPH_BASE variable should be moved to the existing "Subgraphs & Cache" section for better organization and maintainability. Additionally, please add documentation explaining its purpose and expected value format.

Apply this diff to reorganize and document the variable:

-# Subgraph URLs
-SUBGRAPH_BASE=
-
 # APIs
 ETHERSCAN_API_KEY="34JVYM6RPM3J1SK8QXQFRNSHD9XG4UHXVU"
 ONE_INCH_API_URL="https://api-oasis.1inch.io"
...
 # Subgraphs & Cache
+# Base URL for subgraph endpoints (e.g., https://api.thegraph.com/subgraphs/name/your-org)
+SUBGRAPH_BASE=
+
 AJNA_SUBGRAPH_URL=""
 AJNA_SUBGRAPH_URL_GOERLI=""
.github/workflows/aws-prod.yaml (2)

77-77: Fix indentation for consistency.

The new build argument is correctly added, but the indentation is slightly off compared to other similar lines.

-                        --build-arg SUBGRAPH_BASE=${{ secrets.SUBGRAPH_BASE }} \
+                       --build-arg SUBGRAPH_BASE=${{ secrets.SUBGRAPH_BASE }} \

Line range hint 1-4: Add workflow_dispatch trigger as per PR objectives.

The PR objectives mention adding a manual trigger for the workflow, but the current configuration only allows automatic triggers on push to main branch.

Add the workflow_dispatch trigger:

 on:
+  workflow_dispatch:
   push:
     branches:
       - main
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5822cb9 and bfeb5b6.

📒 Files selected for processing (5)
  • .env.template (1 hunks)
  • .github/workflows/aws-prod.yaml (1 hunks)
  • .github/workflows/aws-staging.yaml (2 hunks)
  • Dockerfile.production (2 hunks)
  • blockchain/prices.ts (1 hunks)
🔇 Additional comments (3)
Dockerfile.production (1)

40-41: LGTM! Build arguments properly declared.

The new build arguments REFERRAL_SUBGRAPH_URL and SUBGRAPH_BASE are correctly declared with default empty string values, maintaining consistency with other similar declarations.

.github/workflows/aws-staging.yaml (1)

5-5: LGTM: Manual trigger added successfully.

The addition of workflow_dispatch trigger allows for manual workflow execution, which enhances flexibility in deployment processes.

blockchain/prices.ts (1)

121-122: LGTM! Error logging improvements look good.

The separation of token identifier and error object in logs provides better clarity for debugging.

.env.template Outdated Show resolved Hide resolved
Dockerfile.production Outdated Show resolved Hide resolved
.github/workflows/aws-staging.yaml Outdated Show resolved Hide resolved
blockchain/prices.ts Show resolved Hide resolved
marcinciarka
marcinciarka previously approved these changes Nov 8, 2024
@piotrwitek piotrwitek merged commit e2d8757 into dev Nov 8, 2024
13 checks passed
@piotrwitek piotrwitek deleted the pw/extend-workflows branch November 8, 2024 10:05
@coderabbitai coderabbitai bot mentioned this pull request Nov 15, 2024
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