fix: Query instance failure caused by missing prepared statement obj #36493

albinAppsmith · 2024-09-24T04:54:05Z

Description

Query instance was breaking because of missing prepared statement obj in the action configuration.

PR caused this issue: #36407

Fixes #Issue Number
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/11007670447
Commit: 420801e
Cypress dashboard.
Tags: @tag.All
Spec:

Tue, 24 Sep 2024 07:04:23 UTC

Communication

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

Yes
No

Summary by CodeRabbit

New Features
- Enhanced logic for displaying warnings related to prepared statements, improving user experience by streamlining checks.
Bug Fixes
- Resolved issues with warning display for prepared statements, ensuring accurate notifications based on user actions.

coderabbitai · 2024-09-24T04:54:14Z

Walkthrough

The changes in the QueryResponseTab.tsx file focus on refining the logic for displaying warnings related to prepared statements. The code now checks for the presence of pluginSpecifiedTemplates and its first value, simplifying the previous checks. Additionally, a new variable, hasPreparedStatement, is introduced to determine if a prepared statement is present. The warning display logic is updated to streamline these checks, enhancing clarity and efficiency in the code.

Changes

File Path	Change Summary
app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx	Simplified logic for showing warnings about prepared statements by consolidating checks into fewer variables.

Possibly related PRs

feat: Added warning message in response pane while prepared statement is on #36407: This PR introduces a warning message related to prepared statements in the QueryResponseTab, which aligns with the changes made in the main PR that also modifies the logic for displaying warnings about prepared statements.

Suggested reviewers

hetunandu
AmanAgarwal041

Poem

In the code where warnings dwell,
A clearer path now casts its spell.
With checks refined, they shine so bright,
Prepared statements now take flight!
Logic simplified, a joyful cheer,
For coding wizards, the end is near! ✨

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 37776ef and 420801e.

Files selected for processing (1)

app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (1)

app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx

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.

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 (1)

app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx (1)
205-212: Well done, class! Let's review these changes together.

I'm pleased to see the improvements in our code. You've introduced two new variables, hasPluginSpecifiedTemplates and hasPreparedStatement, which make our code more readable. It's like giving clear labels to our ingredients before we start cooking!

The condition for showing the prepared statement warning has been expanded, which is excellent. It's like widening our net to catch more fish!

However, I have a small suggestion to make this even better:

Consider extracting the complex condition into a separate function for improved readability. Here's an example:
const shouldShowPreparedStatementWarning = (error: string | undefined, hasPluginSpecifiedTemplates: boolean, hasPreparedStatement: boolean) => {
  return error && (hasPluginSpecifiedTemplates || hasPreparedStatement);
};

// Usage
showPreparedStatementWarning = shouldShowPreparedStatementWarning(error, hasPluginSpecifiedTemplates, hasPreparedStatement);
This change would make our code even clearer, like writing our recipe steps on separate index cards. What do you think, class?

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4a70072 and 37776ef.

Files selected for processing (1)

app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx (1 hunks)

mohanarpit · 2024-09-24T10:35:03Z

app/client/src/pages/Editor/QueryEditor/QueryResponseTab.tsx

+    // oracle have different key for prepared statements
+    const hasPreparedStatement =
+      actionConfiguration?.formData?.preparedStatement?.data === true;


@albinAppsmith Why is Oracle plugin different from other plugins in this regard?

@AmanAgarwal041 Can you help here with the reasoning behind this?
@mohanarpit I have already created an issue for tracking this.
#36495

@albinAppsmith I am not really sure about this, why is this different. Will have to check

@AmanAgarwal041 any update on this?

…ppsmithorg#36493) ## Description Query instance was breaking because of missing prepared statement obj in the action configuration. PR caused this issue: appsmithorg#36407 Fixes #`Issue Number` _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/11007670447> > Commit: 420801e > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11007670447&attempt=2" target="_blank">Cypress dashboard</a>. > Tags: `@tag.All` > Spec: > <hr>Tue, 24 Sep 2024 07:04:23 UTC  ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [x] No  ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Enhanced logic for displaying warnings related to prepared statements, improving user experience by streamlining checks. - **Bug Fixes** - Resolved issues with warning display for prepared statements, ensuring accurate notifications based on user actions.

fix: Query instance failure caused by missing prepared statement obj

37776ef

albinAppsmith requested review from AmanAgarwal041 and hetunandu September 24, 2024 04:54

albinAppsmith added the ok-to-test Required label for CI label Sep 24, 2024

github-actions bot added the Bug Something isn't working label Sep 24, 2024

albinAppsmith requested a review from ashit-rath September 24, 2024 04:56

coderabbitai bot reviewed Sep 24, 2024

View reviewed changes

hetunandu previously approved these changes Sep 24, 2024

View reviewed changes

ashit-rath previously approved these changes Sep 24, 2024

View reviewed changes

fix: made plugin config obj optional

420801e

albinAppsmith dismissed stale reviews from ashit-rath and hetunandu via 420801e September 24, 2024 05:35

albinAppsmith requested a review from hetunandu September 24, 2024 05:37

hetunandu approved these changes Sep 24, 2024

View reviewed changes

albinAppsmith merged commit 9731728 into release Sep 24, 2024
84 checks passed

albinAppsmith deleted the fix/queryInstanceFailure branch September 24, 2024 07:32

mohanarpit reviewed Sep 24, 2024

View reviewed changes

albinAppsmith mentioned this pull request Oct 1, 2024

[Task]: Use prepared statement not showing in workflows settings page #36425

Closed

coderabbitai bot mentioned this pull request Oct 14, 2024

fix: bug run button not disabled in response pane #36864

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Query instance failure caused by missing prepared statement obj #36493

fix: Query instance failure caused by missing prepared statement obj #36493

albinAppsmith commented Sep 24, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented Sep 24, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

mohanarpit Sep 24, 2024

albinAppsmith Sep 24, 2024

AmanAgarwal041 Sep 24, 2024

albinAppsmith Oct 1, 2024

fix: Query instance failure caused by missing prepared statement obj #36493

fix: Query instance failure caused by missing prepared statement obj #36493

Conversation

albinAppsmith commented Sep 24, 2024 • edited by github-actions bot Loading

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai bot commented Sep 24, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

mohanarpit Sep 24, 2024

Choose a reason for hiding this comment

albinAppsmith Sep 24, 2024

Choose a reason for hiding this comment

AmanAgarwal041 Sep 24, 2024

Choose a reason for hiding this comment

albinAppsmith Oct 1, 2024

Choose a reason for hiding this comment

albinAppsmith commented Sep 24, 2024 •

edited by github-actions bot

Loading

coderabbitai bot commented Sep 24, 2024 •

edited

Loading