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

fix: remove dependency listening to success or failure of mock ds api for initializing app #39135

Merged
merged 1 commit into from
Feb 7, 2025

Conversation

AmanAgarwal041
Copy link
Contributor

@AmanAgarwal041 AmanAgarwal041 commented Feb 7, 2025

Description

Removing the listener to mock api error or success action to avoid breaking the apps and continue initialization process of the app. This will avoid breaking of apps if the mock datasource api is not working.

Fixes #39114
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

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


Fri, 07 Feb 2025 14:50:20 UTC

Communication

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

  • Yes
  • No

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the reliability of data loading by adjusting how external resources are managed. The application now provides continued access to full functionality even when external data encounters issues, such as during offline scenarios. This improvement leads to a more stable and seamless editing experience for all users.

Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

Walkthrough

The pull request updates the loadPluginsAndDatasources method in AppEditorEngine by removing the success and error actions associated with fetching mock datasources. Instead of blocking application progress on API errors, a comment now explains that the application should continue operating even if the mock datasources API fails. No additional methods or exported entity changes have been introduced.

Changes

File Change Summary
app/.../AppEditorEngine.ts Removed explicit success/error actions for fetching mock datasources in loadPluginsAndDatasources and added a comment explaining why API failure should not hinder app functionality.

Sequence Diagram(s)

sequenceDiagram
    participant Engine as AppEditorEngine
    participant PluginService
    participant DatasourceService as ConsolidatedAPI
    Engine->>PluginService: Load plugins
    Engine->>DatasourceService: Fetch datasources
    DatasourceService-->>Engine: Return datasources
    Engine->>Engine: Process and load datasources
    Note right of Engine: Bypasses mock datasource API error handling
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent application break/infinite loading due to mock datasources API failure (#39114)

Possibly related PRs

Suggested labels

Bug, ok-to-test, Integrations Pod, Integrations Product

Suggested reviewers

  • ApekshaBhosale

Poem

In the code’s dance, a change takes flight,
No more endless waits in error's night.
A comment now shines as clear as day,
Guiding data’s path in a smoother way.
Cheers to the fix—code smiles today! 🎉


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ac41ad2 and 8bbb33d.

📒 Files selected for processing (1)
  • app/client/src/entities/Engine/AppEditorEngine.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: perform-test / rts-build / build
  • GitHub Check: perform-test / client-build / client-build
  • GitHub Check: perform-test / server-build / server-unit-tests
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-build / client-build
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-prettier / prettier-check
🔇 Additional comments (1)
app/client/src/entities/Engine/AppEditorEngine.ts (1)

230-239: Well documented change that improves app resilience!

The removal of success/error actions for mock datasources makes the app more resilient by continuing initialization even if the mock datasources API fails. The comment clearly explains the rationale and edge cases handled.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

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.

@AmanAgarwal041 AmanAgarwal041 added the ok-to-test Required label for CI label Feb 7, 2025
@github-actions github-actions bot added Bug Something isn't working DevOps Pod Issues related to devops Mock Data Issues related to mock databases Needs Triaging Needs attention from maintainers to triage Query & Widgets Pod All issues related to Query, JS, Eval, and Widgets labels Feb 7, 2025
@AmanAgarwal041 AmanAgarwal041 merged commit 15b2327 into release Feb 7, 2025
87 checks passed
@AmanAgarwal041 AmanAgarwal041 deleted the fix/mock-ds-api branch February 7, 2025 18:59
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working DevOps Pod Issues related to devops Mock Data Issues related to mock databases Needs Triaging Needs attention from maintainers to triage ok-to-test Required label for CI Query & Widgets Pod All issues related to Query, JS, Eval, and Widgets
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Application breaks when mock datasources api fails
3 participants