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

chore: Add error logs for consolidated API #35779

Merged
merged 1 commit into from
Aug 20, 2024
Merged

Conversation

abhvsn
Copy link
Contributor

@abhvsn abhvsn commented Aug 20, 2024

Description

PR to add error logs in the consolidated-api as whenever DB operation fails we are not logging these anywhere and ends up in the response only.

/test Sanity

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/10466559600
Commit: c04482e
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Tue, 20 Aug 2024 07:27:38 UTC

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced error logging for asynchronous operations, improving diagnostics for failures in data fetching related to user profiles, feature flags, and more.
  • Improvements
    • Augmented observability and robustness of the application through detailed error messages for data retrieval issues.

@abhvsn abhvsn added the ok-to-test Required label for CI label Aug 20, 2024
Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

The recent changes enhance error logging within the getConsolidatedInfoForPageLoad method of the ConsolidatedAPIServiceCEImpl class. Asynchronous operations are now equipped with .doOnError handlers, which log specific error messages when exceptions occur. This improvement allows for better observability and debugging of the application by capturing failures related to various critical data-fetching processes. The overall control flow remains unchanged, ensuring resilience in data retrieval.

Changes

Files and Directories Change Summary
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java Introduced error logging for asynchronous operations in getConsolidatedInfoForPageLoad, enhancing observability and error handling without altering existing logic.

Poem

In code where errors quietly creep,
New logs awaken, no more to sleep.
With every fetch, a tale we weave,
Of troubleshooting ease, we now believe.
So let us cheer, for clarity gained,
In the world of code, our errors have waned! 🎉


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Aug 20, 2024
@abhvsn abhvsn enabled auto-merge (squash) August 20, 2024 06:43
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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6628635 and c04482e.

Files selected for processing (1)
  • app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java (17 hunks)
Additional context used
Learnings (1)
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java (1)
Learnt from: sumitsum
PR: appsmithorg/appsmith#29875
File: app/server/appsmith-server/src/main/java/com/appsmith/server/services/ConsolidatedAPIServiceImpl.java:0-0
Timestamp: 2023-12-27T21:27:19.887Z
Learning: Test cases for the `getConsolidatedInfoForPageLoad` method have already been added, and the refactoring of the method into smaller methods is planned for later and is being tracked in a separate GitHub issue.
Additional comments not posted (11)
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java (11)

157-157: Well done on adding error logging!

The error logging for fetching user profile data is clear and descriptive.


166-166: Great job on the error logging!

The error logging for fetching feature flags is concise and informative.


177-177: Nice addition of error logging!

The error logging for fetching tenant configuration is well-placed and clear.


236-236: Error logging looks good!

The error logging for fetching application pages is appropriately detailed.


247-247: Effective error logging!

The error logging for fetching the current theme is clear and precise.


258-258: Error logging is well-implemented!

The error logging for fetching themes is informative and well-placed.


268-268: Good work on the error logging!

The error logging for fetching custom JS libraries is clear and descriptive.


278-278: Error logging is clear!

The error logging for fetching the current page is well-structured and informative.


294-294: Excellent error logging!

The error logging for fetching actions in view mode is precise and helpful.


305-305: Great error logging!

The error logging for fetching action collections in view mode is clear and effective.


371-371: Well-placed error logging!

The error logging for fetching plugins is informative and well-placed.

@abhvsn abhvsn merged commit 619fc2d into release Aug 20, 2024
46 checks passed
@abhvsn abhvsn deleted the chore/add-error-logs branch August 20, 2024 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants