chore: Adding the logic to fetch datasource structure for schema tab, if empty

[ankitakinger]

Description

Adding the logic to fetch datasource structure for schema tab, if empty

Fixes #37247

Automation

/ok-to-test tags="@tag.Sanity, @tag.IDE"

🔍 Cypress test results

Tip

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

---

Wed, 06 Nov 2024 12:13:19 UTC

Communication

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

• Yes
• No

Summary by CodeRabbit

• New Features
  • Enhanced data-fetching logic for plugin datasource components.
  • Introduced a new selector to retrieve plugin datasource components by ID.
• Improvements
  • Refined conditions for fetching datasource structure, improving performance and reliability.
  • Maintained consistent user interface while updating backend logic.

[coderabbitai]

Walkthrough

The changes in this pull request enhance the Schema component by introducing a new selector, getPluginDatasourceComponentFromId, and a state variable, pluginDatasourceForm, to manage datasource components more effectively. The useEffect hook is modified to conditionally fetch the datasource structure based on the state of pluginDatasourceForm and datasourceStructure. Additionally, the fetchDatasourceStructure action is imported, indicating a more robust approach to managing datasource states while preserving the component's rendering logic.

Changes

File Path	Change Summary
app/client/src/PluginActionEditor/components/PluginActionResponse/components/Schema.tsx	Introduced getPluginDatasourceComponentFromId selector, added pluginDatasourceForm state, modified useEffect to conditionally fetch datasource structure based on state.
ee/selectors/entitiesSelector	Method added: getPluginDatasourceComponentFromId.
actions/datasourceActions	Method added: fetchDatasourceStructure, imported alongside refreshDatasourceStructure.

Assessment against linked issues

Objective	Addressed	Explanation
Fetch Datasource structure if empty for schema tab (#37247)	✅

Possibly related PRs

• fix: Add pane issues #33627: This PR modifies the entitiesSelector.ts file, which is relevant as the main PR introduces a new selector, getPluginDatasourceComponentFromId, in a similar context of managing datasource components.
• fix: datasource name not reflecting in schema pane #37131: This PR adds a new selector, getDatasource, which is closely related to the main PR's focus on enhancing the handling of datasource information within the Schema component.

Suggested labels

Enhancement, Task, IDE Product, IDE Pod, skip-changelog

Suggested reviewers

• hetunandu
• ApekshaBhosale

🎉 In the code's dance, a new step we find,
A selector added, oh so refined!
With conditions set, fetching's a breeze,
Schema's now smarter, aiming to please.
Data flows smoothly, like a gentle stream,
In the world of code, we continue to dream! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

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

🧹 Outside diff range and nitpick comments (2)

app/client/src/PluginActionEditor/components/PluginActionResponse/components/Schema.tsx (2)

73-75: Consider adding type annotation for better type safety

The selector usage looks good, but consider adding an explicit type annotation for pluginDatasourceForm.

- const pluginDatasourceForm = useSelector((state) =>
+ const pluginDatasourceForm: DatasourceComponentTypes = useSelector((state) =>
    getPluginDatasourceComponentFromId(state, pluginId || ""),
  );

---

81-95: Consider adding error handling for fetch operation

The fetch operation should include error handling to improve user experience when the fetch fails.

  useEffect(() => {
    if (
      props.datasourceId &&
      datasourceStructure === undefined &&
      pluginDatasourceForm !== DatasourceComponentTypes.RestAPIDatasourceForm
    ) {
      dispatch(
        fetchDatasourceStructure(
          props.datasourceId,
          true,
          DatasourceStructureContext.QUERY_EDITOR,
+         // Consider handling the promise rejection
+       ).catch((error) => {
+         // Handle error appropriately
+         console.error('Failed to fetch datasource structure:', error);
        ),
      );
    }
  }, [props.datasourceId, datasourceStructure, dispatch, pluginDatasourceForm]);

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b23ba1d and 7045b99.

📒 Files selected for processing (1)

• app/client/src/PluginActionEditor/components/PluginActionResponse/components/Schema.tsx (2 hunks)

🔇 Additional comments (2)

app/client/src/PluginActionEditor/components/PluginActionResponse/components/Schema.tsx (2)

15-15: LGTM: Import changes are well-organized

The new imports are properly grouped and align with the feature requirements.

Also applies to: 22-25

---

81-95: LGTM: Conditional fetching logic is well-implemented

The useEffect hook correctly implements the requirement to fetch datasource structure when empty, with proper conditions and dependency tracking.