Skip to content

Conversation

@dstala
Copy link
Member

@dstala dstala commented Jan 31, 2025

Change Summary

Provide summary of changes with issue number if any.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a new asynchronous function getLinkedColumnDisplayValue in the formulaQueryBuilderv2.ts file. This function retrieves the display value of linked columns based on the model and optional alias mapping. The changes also modify the _formulaQueryBuilder function to incorporate this new logic for handling linked columns, specifically for BELONGS_TO and HAS_MANY relation types, allowing for more dynamic and complex display value retrieval.

Changes

File Change Summary
packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts Added new async function getLinkedColumnDisplayValue and updated _formulaQueryBuilder function signature to enhance linked column display value retrieval

Possibly related PRs

Suggested labels

🐛 Type: Bug, size:S, lgtm

Suggested reviewers

  • rameshmane7218

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f664c5 and d4e8dff.

📒 Files selected for processing (1)
  • packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: release-docker / buildx
  • GitHub Check: pre-build-for-playwright / playwright
  • GitHub Check: unit-tests-pg
  • GitHub Check: unit-tests
🔇 Additional comments (3)
packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts (3)

670-679: ⚠️ Potential issue

Ensuring Consistent Use of getLinkedColumnDisplayValue in BELONGS_TO Branch

In this branch, the linked display value is retrieved and then used to construct the select query. The code checks whether the returned value is a string or an object with a .builder property. However, if getLinkedColumnDisplayValue returns undefined (as it previously did when no display value was present), this would result in a runtime error when trying to access .builder.
Suggestion:
Make sure the helper function always returns a consistent fallback as shown above. Also consider adding an explicit check here to handle an unexpected undefined value gracefully.


705-718: ⚠️ Potential issue

Consistent Fallback for Child Display Value in HAS_MANY Branch

Similarly, for the HAS_MANY relation type, the function getLinkedColumnDisplayValue is used to obtain the display value for the child model. The current type check assumes that the return value is either a string or an object with a .builder property. If the helper returns undefined, the subsequent code (childDisplayValue.builder) will fail.
Recommendation:
Ensure the helper is modified to never return undefined (as suggested above) or add additional validations here to guard against undefined values.


75-105: ⚠️ Potential issue

Safe Handling of Missing Display Value Column in getLinkedColumnDisplayValue

In the new asynchronous helper, when params.model.displayValue is absent the function currently returns undefined. However, downstream code (e.g. line 670 and following) assumes a consistent return type (either a string or an object with a .builder property). Not returning a safe fallback here can lead to runtime errors.
Recommended Fix:
Return a safe fallback object instead of undefined so that consumers of this function can reliably access the .builder property. For example:

-    if (!displayValueColumn) {
-      return undefined;
-    }
+    if (!displayValueColumn) {
+      return { builder: 'NULL' };
+    }
✨ 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.

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.

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: 1

🧹 Nitpick comments (1)
packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts (1)

721-724: Refactor to unify string vs. builder returns.
Consider always returning a consistent object structure from getLinkedColumnDisplayValue. This avoids repeated ternary checks and potential runtime errors when the value might be undefined.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18e7841 and 2f664c5.

📒 Files selected for processing (1)
  • packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: release-docker / buildx
  • GitHub Check: unit-tests
  • GitHub Check: unit-tests-pg
🔇 Additional comments (5)
packages/nocodb/src/db/formulav2/formulaQueryBuilderv2.ts (5)

19-19: No action needed.
This is a trivial type import line.


110-110: No action needed.
This is just a blank line addition.


674-678: Same potential undefined return concern.
getLinkedColumnDisplayValue returning undefined would break the code at lines 680-684.


680-684: Ensure handling of non-string returns.
This segment expects either a string or an object with a .builder, but will fail if linkedDisplayValue is undefined.


710-714: Propagate the same undefined handling fix here.
The variable childDisplayValue could be undefined, leading to a runtime error in subsequent usage.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 31, 2025

Uffizzi Ephemeral Environment Deploying

☁️ https://app.uffizzi.com/github.com/nocodb/nocodb/pull/10378

⚙️ Updating now by workflow run 13084288663.

What is Uffizzi? Learn more!

@o1lab o1lab force-pushed the nc-fix/formula-display-value-link branch from 2f664c5 to d4e8dff Compare February 1, 2025 02:26
@pranavxc pranavxc merged commit 8999c27 into develop Feb 1, 2025
23 checks passed
@pranavxc pranavxc deleted the nc-fix/formula-display-value-link branch February 1, 2025 07:14
@coderabbitai coderabbitai bot mentioned this pull request Feb 26, 2025
7 tasks
@coderabbitai coderabbitai bot mentioned this pull request Mar 17, 2025
7 tasks
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.

4 participants