fix: sanitise workspace/base name in invite email

[dstala]

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]

Walkthrough

Walkthrough

The recent update focuses on enhancing security within the BaseUsersService class by sanitizing the baseName and roles properties using a new sanitiseEmailContent function. This function, introduced in the emailUtils.ts file, ensures that email content is free from link/URL injections and special character issues. Additionally, the emailUtils functions have been made accessible throughout the project by exporting them from the utils/index.ts file.

Changes

File Path	Change Summary
.../services/base-users/base-users.service.ts	Updated BaseUsersService class to sanitize baseName and roles properties using sanitiseEmailContent function.
.../utils/emailUtils.ts	Introduced functions for HTML encoding strings and sanitizing email content to prevent link/URL injections and encode special characters.
.../utils/index.ts	Added export of emailUtils functions to make them accessible throughout the project.

---

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

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

[coderabbitai]

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ea634ff and 79c5a23.

Files selected for processing (3)

• packages/nocodb/src/services/base-users/base-users.service.ts (2 hunks)
• packages/nocodb/src/utils/emailUtils.ts (1 hunks)
• packages/nocodb/src/utils/index.ts (1 hunks)

Additional comments not posted (3)

packages/nocodb/src/utils/index.ts (1)

3-3: Export statement for emailUtils looks good.

packages/nocodb/src/utils/emailUtils.ts (1)

15-19: The sanitiseEmailContent function is well-implemented and serves its purpose effectively.

packages/nocodb/src/services/base-users/base-users.service.ts (1)

365-371: Sanitizing baseName and roles in the sendInviteEmail method is a good security enhancement.

[github-actions]

Uffizzi Preview deployment-51675 was deleted.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 79c5a23 and 42bae93.

Files selected for processing (1)

• packages/nocodb/src/utils/emailUtils.ts (1 hunks)

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

• packages/nocodb/src/utils/emailUtils.ts