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: Email invitation bug #8505

Merged
merged 2 commits into from
May 17, 2024
Merged

Conversation

pranavxc
Copy link
Member

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

Copy link
Contributor

coderabbitai bot commented May 17, 2024

Walkthrough

Walkthrough

The change in emailUtils.ts introduces an optional parameter content in the sanitiseEmailContent function, allowing it to handle null or undefined values gracefully by using optional chaining (?.) before applying content sanitization. This update aims to prevent errors that occur when attempting to sanitize undefined content, thereby addressing a bug related to sending email invitations. In upgradeNcGui.js, the removal of a reference to litestream in file paths suggests structural or dependency changes in the nocodb package.

Changes

File Path Change Summary
packages/nocodb/src/utils/emailUtils.ts Updated sanitiseEmailContent function to accept an optional content parameter and use optional chaining.
scripts/upgradeNcGui.js Removed references to litestream in file paths related to the nocodb package.

Assessment against linked issues

Objective Addressed Explanation
Fix the "Cannot read properties of undefined (reading 'replace')" error when sending email invitations (#8493)

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

@pranavxc pranavxc requested a review from mertmit May 17, 2024 06:34
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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between eacfa2a and f12098f.
Files selected for processing (1)
  • packages/nocodb/src/utils/emailUtils.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/nocodb/src/utils/emailUtils.ts

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.

Actionable comments posted: 0

Out of diff range and nitpick comments (3)
scripts/upgradeNcGui.js (3)

Line range hint 1-3: Ensure consistent use of require statements.

Consider destructuring require statements for consistency and clarity, e.g., const { execSync } = require('child_process');.


[!TIP]
Codebase Verification

The current implementation of the replacePackageName and replacePackageVersion functions in scripts/upgradeNcGui.js and scripts/upgradeNocodbSdk.js uses nested callbacks within Promises, which can lead to callback hell and reduced readability. Refactoring these functions to use async/await can improve readability and maintainability.

Recommendation:

Refactor the replacePackageName and replacePackageVersion functions to use async/await for better readability and error handling.

Example Refactoring:

const fs = require('fs').promises;

const replacePackageName = async (filePath) => {
    try {
        const data = await fs.readFile(filePath, 'utf8');
        const result = data.replace(/nc-lib-gui/g, ncLibPackage.name);
        await fs.writeFile(filePath, result, 'utf8');
    } catch (err) {
        throw err;
    }
};

const replacePackageVersion = async (filePath) => {
    try {
        const data = await fs.readFile(filePath, 'utf8');
        const rgx = new RegExp(`"${nocodbSdkPackage.name}": ".*"`, "g");
        const result = data.replace(rgx, `"${nocodbSdkPackage.name}": "${nocodbSdkPackage.version}"`);
        await fs.writeFile(filePath, result, 'utf8');
    } catch (err) {
        throw err;
    }
};
  • Refactor replacePackageName in scripts/upgradeNcGui.js and scripts/upgradeNocodbSdk.js.
  • Refactor replacePackageVersion in scripts/upgradeNocodbSdk.js.
Analysis chain

Line range hint 9-19: Check error handling in asynchronous operations.

The replacePackageName function uses callbacks which might lead to callback hell. Consider refactoring to use Promises or async/await for better readability and error handling.


Let's review the specific instances of reject(err) in the scripts/upgradeNcGui.js and scripts/upgradeNocodbSdk.js files to understand the current error handling patterns and determine if refactoring to Promises or async/await is warranted.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify error handling in asynchronous operations.

# Test: Search for error handling patterns in asynchronous functions.
rg --type js 'reject\(err\)'

Length of output: 617



Script:

#!/bin/bash
# Extract lines around the instances of `reject(err)` to review the context of error handling.

# Extract lines around `reject(err)` in scripts/upgradeNcGui.js
rg --type js --context 5 'reject\(err\)' scripts/upgradeNcGui.js

# Extract lines around `reject(err)` in scripts/upgradeNocodbSdk.js
rg --type js --context 5 'reject\(err\)' scripts/upgradeNocodbSdk.js

Length of output: 2074


Line range hint 32-44: Optimize Promise handling and ensure error propagation.

The handling of Promises in the conditional block could be optimized by using async/await for better readability and error handling. Consider refactoring to ensure errors are not swallowed.

- Promise.all(filePaths.map(filePath => { return replacePackageName(filePath) })).then(() => {
-     bumbVersionAndSave();
- })
+ async function updatePackages() {
+     try {
+         await Promise.all(filePaths.map(filePath => replacePackageName(filePath)));
+         bumbVersionAndSave();
+     } catch (error) {
+         console.error('Failed to update packages:', error);
+     }
+ }
+ updatePackages();
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f12098f and bcbc4db.
Files selected for processing (1)
  • scripts/upgradeNcGui.js (1 hunks)
Additional comments not posted (1)
scripts/upgradeNcGui.js (1)

Line range hint 21-30: Review the use of environment variables and version bump logic.

The function bumbVersionAndSave uses environment variables and performs a version bump. Ensure that the environment variables are documented and the version bump logic is tested.

Copy link
Contributor

github-actions bot commented May 17, 2024

Uffizzi Preview deployment-51879 was deleted.

@pranavxc pranavxc merged commit 661524b into develop May 17, 2024
23 checks passed
@pranavxc pranavxc deleted the nc-fix/8493-email-template-issue branch May 17, 2024 08:01
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: Send invitation causes "Cannot read properties of undefined (reading 'replace')"
2 participants