Nc fix: Miscellaneous bug fixes

[rameshmane7218]

Change Summary

• Closes 🐛 Bug: for self HM links, lookup field doesn't list BT #9059
• Closes 🐛 Bug: Hide RO columns in new form #9312

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]

📝 Walkthrough

Walkthrough

This pull request refines the column filtering logic across several Vue components. In the LookupOptions component, the import statements for types have been adjusted for clarity. The RollupOptions component's computed property now includes self-referencing system columns when their relation type is either many-to-many, one-to-one, or belongs-to. The expanded-form component updates the logic to hide read-only fields upon new record creation by incorporating an isReadOnlyColumn check. Additionally, a new utility function isReadOnlyColumn is implemented in the SDK and exported accordingly.

Changes

File(s)	Change Summary
packages/nc-gui/components/smartsheet/column/LookupOptions.vue	Modified import statements for types: RelationTypes is now a regular import, while ColumnType, LinkToAnotherRecordType, LookupType, and TableType are type imports.
packages/nc-gui/components/smartsheet/column/RollupOptions.vue	Updated filtering logic in refTables to include specific system columns based on their self-referencing relation types.
packages/nc-gui/components/smartsheet/expanded-form/index.vue	Modified the fields computed property to hide read-only columns during new record creation and updated import statements to include isReadOnlyColumn.
packages/nocodb-sdk/src/lib/UITypes.ts	Enhanced isReadOnlyColumn function to include new criteria for determining read-only columns.
packages/nocodb-sdk/src/lib/index.ts	Added export for the isReadOnlyColumn function.
packages/nocodb/src/models/Model.ts	Corrected a typographical error in a comment within the primaryKey getter.

Suggested labels

🐛 Type: Bug, size:L, lgtm

Suggested reviewers

• dstala
• 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 14043d2 and a4cd979.

📒 Files selected for processing (10)

• packages/nc-gui/components/smartsheet/column/LookupOptions.vue (2 hunks)
• packages/nc-gui/components/smartsheet/column/RollupOptions.vue (1 hunks)
• packages/nc-gui/components/smartsheet/expanded-form/index.vue (2 hunks)
• packages/nocodb-sdk/src/lib/UITypes.ts (1 hunks)
• packages/nocodb-sdk/src/lib/index.ts (1 hunks)
• packages/nc-gui/components/smartsheet/column/LookupOptions.vue (1 hunks)
• packages/nc-gui/components/smartsheet/expanded-form/index.vue (1 hunks)
• packages/nocodb-sdk/src/lib/UITypes.ts (1 hunks)
• packages/nocodb/src/models/Model.ts (1 hunks)
• packages/nc-gui/components/smartsheet/expanded-form/index.vue (6 hunks)

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

• packages/nocodb-sdk/src/lib/index.ts
• packages/nocodb-sdk/src/lib/UITypes.ts
• packages/nc-gui/components/smartsheet/column/LookupOptions.vue
• packages/nc-gui/components/smartsheet/column/RollupOptions.vue
• packages/nocodb/src/models/Model.ts
• packages/nc-gui/components/smartsheet/expanded-form/index.vue
• packages/nc-gui/components/smartsheet/expanded-form/index.vue

🧰 Additional context used

🧠 Learnings (1)

packages/nc-gui/components/smartsheet/column/LookupOptions.vue (1)

Learnt from: rameshmane7218
PR: nocodb/nocodb#8578
File: packages/nc-gui/components/smartsheet/column/LookupOptions.vue:79-85
Timestamp: 2024-11-12T03:23:04.401Z
Learning: When optimizing reactive properties in Vue.js, ensure to check if the property is already set to the expected value before updating it to avoid unnecessary rendering processes.

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: release-docker / buildx
• GitHub Check: unit-tests-pg
• GitHub Check: unit-tests

🔇 Additional comments (6)

packages/nocodb-sdk/src/lib/UITypes.ts (1)

534-562: Well-designed reusable function with excellent documentation

The new isReadOnlyColumn function centralizes the logic for determining read-only columns, making it reusable across the application. The implementation correctly checks for various conditions that would make a column read-only, and the JSDoc comments provide clear documentation.

The function includes comprehensive checks for:

1. Predefined read-only UI types (Lookup, Rollup, Formula, etc.)
2. System-generated user tracking fields (CreatedBy, LastModifiedBy)
3. System-generated timestamp fields (CreatedTime, LastModifiedTime)
4. Row ordering columns

packages/nc-gui/components/smartsheet/column/LookupOptions.vue (2)

3-3: Improved import statement with better type annotations

The modified import statement now properly distinguishes between type imports and regular imports, which is a TypeScript best practice. This makes the code more maintainable by clearly showing which imports are types versus runtime values.

---

41-52: Fixed filtering logic to include self-referencing system columns

The updated filtering logic now correctly includes system columns if they are self-referencing (where their source_id matches meta.value?.source_id) and have specific relation types (MANY_TO_MANY, ONE_TO_ONE, BELONGS_TO). This is an important bug fix that allows proper handling of self-referencing relationships.

The addition of explanatory comments also improves code readability by clarifying the intent behind the filtering conditions.

packages/nc-gui/components/smartsheet/expanded-form/index.vue (3)

3-3: Added import for new isReadOnlyColumn utility

The import statement has been updated to include the new isReadOnlyColumn utility function which will be used to filter fields in the expanded form.

---

95-106: Enhanced fields computation to hide read-only columns for new records

This change improves the user experience by filtering out read-only columns when creating a new record. Since read-only columns cannot be edited, there's no reason to display them during new record creation.

The code now injects fieldsFromParent and conditionally filters based on whether it's a new record or not, which is a more logical approach.

---

162-164: Updated hiddenFields computation to maintain consistency with fields filtering

This change ensures consistency between fields and hiddenFields computed properties by applying the same read-only column filtering logic. This prevents fields that should be hidden from showing up in the hidden fields list when creating new records.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

[github-actions]

Uffizzi Preview deployment-61762 was deleted.