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: Use column title as alias in bulk insert return statement #7946

Merged
merged 2 commits into from
Mar 23, 2024

Conversation

pranavxc
Copy link
Member

@pranavxc pranavxc commented Mar 23, 2024

Change Summary

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Provide summary of changes.

Additional information / screenshots (optional)

Anything for maintainers to be made aware of

Summary by CodeRabbit

  • Refactor
    • Enhanced data handling by transitioning from array to key-value pair storage for improved efficiency.
    • Expanded support in the includes method to accommodate more UI types for a broader application scope.

Signed-off-by: Pranav C <pranavxc@gmail.com>
Copy link
Contributor

coderabbitai bot commented Mar 23, 2024

Walkthrough

Walkthrough

The recent changes involve significant updates to the handling of data return mechanisms in the API, specifically targeting the Insert data API(v2). The modifications include the transition from using an array to manage returned data to a more structured key-value pair object, enhancing the logic for data return, and expanding support for additional UI types. These adjustments aim to refine the response structure and align with user expectations for data representation, directly addressing issues with the current response format.

Changes

File Path Change Summary
packages/nocodb/src/db/BaseModelSqlv2.ts - Modified returningArr to returningObj
- Updated returning method logic
- Expanded includes method for additional UITypes

Assessment against linked issues

Objective Addressed Explanation
🐛 Bug: Insert data API(v2) not returning proper response (#7945)
Should return record with column alias and not with actual column name (#7945)

The changes made in the codebase directly address the objectives outlined in issue #7945. By transitioning from returningArr to returningObj, the update ensures that the API returns data in a more structured format, potentially resolving the issue of returning actual column names instead of aliases. This structural change, along with the updated logic in the returning method, aligns with the desired behavior of returning records with column aliases, thereby meeting the primary objectives of the linked issue.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 25afed4 and caf7160.
Files selected for processing (1)
  • packages/nocodb/src/db/BaseModelSqlv2.ts (2 hunks)
Additional comments: 1
packages/nocodb/src/db/BaseModelSqlv2.ts (1)
  • 6625-6630: The method extractCondition uses a hardcoded list of UITypes to determine if a column supports sub-operations like isWithin. This approach is not scalable and might lead to maintenance issues if new UITypes are added or if the logic for determining supported sub-operations changes.

Consider refactoring this logic to a more centralized approach, where each UIType can declare its supported operations and sub-operations. This would make the code more maintainable and easier to extend in the future.

packages/nocodb/src/db/BaseModelSqlv2.ts Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Mar 23, 2024

Uffizzi Preview deployment-48842 was deleted.

Signed-off-by: Pranav C <pranavxc@gmail.com>
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between caf7160 and 74b3514.
Files selected for processing (1)
  • packages/nocodb/src/db/BaseModelSqlv2.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/nocodb/src/db/BaseModelSqlv2.ts

@pranavxc pranavxc merged commit 1d54166 into develop Mar 23, 2024
20 of 21 checks passed
@pranavxc pranavxc deleted the fix/v2-insert-api-response branch March 23, 2024 13:03
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.

🐛 Bug: Insert data API(v2) not returning proper response
2 participants