fix: avoid duplicate email and bring missing base name in invite template

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

packages/nocodb/src/services/base-users/base-users.service.ts

@@ -1,4 +1,4 @@
-import { Injectable } from '@nestjs/common';
+import { Injectable, Logger } from '@nestjs/common';
 import {
   AppEvents,
   extractRolesObj,
@@ -26,6 +26,8 @@ import { sanitiseEmailContent } from '~/utils';
 
 @Injectable()
 export class BaseUsersService {
+  private readonly logger = new Logger(BaseUsersService.name);
+
   constructor(protected appHooksService: AppHooksService) {}
 
   async userList(
@@ -171,17 +173,29 @@ export class BaseUsersService {
           });
 
           // in case of single user check for smtp failure
-          // and send back token if failed
+          // and send back token if email not configured
-          if (
+          if (emails.length === 1) {
-            emails.length === 1 &&
+            // variable to keep invite mail send status
-            !(await this.sendInviteEmail(email, invite_token, param.req))
+            const mailSendStatus = await this.sendInviteEmail({
-          ) {
+              email,
+              token: invite_token,
+              req: param.req,
+              baseName: base.title,
+            });
+
+            if (!mailSendStatus) {
               return { invite_token, email };
+            }
           } else {
-            this.sendInviteEmail(email, invite_token, param.req);
+            await this.sendInviteEmail({
+              email,
+              token: invite_token,
+              req: param.req,
+              baseName: base.title,
+            });
           }
         } catch (e) {
-          console.log(e);
+          this.logger.error(e.message, e.stack);
           if (emails.length === 1) {
             throw e;
           } else {
@@ -402,7 +416,12 @@ export class BaseUsersService {
       );
     }
 
-    await this.sendInviteEmail(user.email, invite_token, param.req);
+    await this.sendInviteEmail({
+      email: user.email,
+      token: invite_token,
+      req: param.req,
+      baseName: base.title,
+    });
 
     this.appHooksService.emit(AppEvents.PROJECT_USER_RESEND_INVITE, {
       base,
@@ -416,13 +435,32 @@ export class BaseUsersService {
     return true;
   }
 
-  // todo: refactor the whole function
+  async sendInviteEmail({
-  async sendInviteEmail(email: string, token: string, req: any): Promise<any> {
+    email,
+    token,
+    req,
+    baseName,
+    useOrgTemplate,
+  }: {
+    email: string;
+    token: string;
+    req: NcRequest;
+    baseName?: string;
+    useOrgTemplate?: boolean;
+  }): Promise<any> {
     try {
-      const template = (
+      let template: string;
+
+      // if useOrgTemplate is true then use org template
+      if (useOrgTemplate) {
+        template = (
+          await import('~/services/base-users/ui/emailTemplates/org-invite')
+        ).default;
+      } else {
+        template = (
           await import('~/services/base-users/ui/emailTemplates/invite')
         ).default;
-
+      }
       const emailAdapter = await NcPluginMgrv2.emailAdapter();
 
       if (emailAdapter) {
@@ -433,7 +471,7 @@ export class BaseUsersService {
             signupLink: `${req.ncSiteUrl}${
               Noco.getConfig()?.dashboardPath
             }#/signup/${token}`,
-            baseName: sanitiseEmailContent(req.body?.baseName),
+            baseName: sanitiseEmailContent(baseName || req.body?.baseName),
             roles: sanitiseEmailContent(
               (req.body?.roles || '')
                 .split(',')
@@ -446,10 +484,10 @@ export class BaseUsersService {
         return true;
       }
     } catch (e) {
-      console.log(
+      this.logger.warn(
-        'Warning : `mailSend` failed, Please configure emailClient configuration.',
+        'Warning : `mailSend` failed, Please re-configure emailClient configuration.',
-        e.message,
       );
+      this.logger.error(e.message, e.stack);
       throw e;
     }
   }

packages/nocodb/src/services/base-users/ui/emailTemplates/invite.ts

@@ -3,7 +3,7 @@ export default `<!doctype html>
 <head>
     <meta name="viewport" content="width=device-width">
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-    <title>Simple Transactional Email</title>
+    <title><%= baseName %> - Invite</title>
     <style>
         @media only screen and (max-width: 620px) {
             table[class=body] h1 {
@@ -101,7 +101,7 @@ export default `<!doctype html>
 <body class=""
       style="background-color: #f6f6f6; font-family: sans-serif; -webkit-font-smoothing: antialiased; font-size: 14px; line-height: 1.4; margin: 0; padding: 0; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;">
 <span class="preheader"
-      style="color: transparent; display: none; height: 0; max-height: 0; max-width: 0; opacity: 0; overflow: hidden; mso-hide: all; visibility: hidden; width: 0;">This is preheader text. Some clients will show this text as a preview.</span>
+      style="color: transparent; display: none; height: 0; max-height: 0; max-width: 0; opacity: 0; overflow: hidden; mso-hide: all; visibility: hidden; width: 0;">You have been invited to become "<%= roles -%>" of the NocoDB base "<%= baseName %>".</span>
 <table role="presentation" border="0" cellpadding="0" cellspacing="0" class="body"
        style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f6f6f6; width: 100%;"
        width="100%" bgcolor="#f6f6f6">

packages/nocodb/src/services/base-users/ui/emailTemplates/org-invite.ts

@@ -0,0 +1,210 @@
+export default `<!doctype html>
+<html>
+<head>
+    <meta name="viewport" content="width=device-width">
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>NocoDB Invitation</title>
+    <style>
+        @media only screen and (max-width: 620px) {
+            table[class=body] h1 {
+                font-size: 28px !important;
+                margin-bottom: 10px !important;
+            }
+
+            table[class=body] p,
+            table[class=body] ul,
+            table[class=body] ol,
+            table[class=body] td,
+            table[class=body] span,
+            table[class=body] a {
+                font-size: 16px !important;
+            }
+
+            table[class=body] .wrapper,
+            table[class=body] .article {
+                padding: 10px !important;
+            }
+
+            table[class=body] .content {
+                padding: 0 !important;
+            }
+
+            table[class=body] .container {
+                padding: 0 !important;
+                width: 100% !important;
+            }
+
+            table[class=body] .main {
+                border-left-width: 0 !important;
+                border-radius: 0 !important;
+                border-right-width: 0 !important;
+            }
+
+            table[class=body] .btn table {
+                width: 100% !important;
+            }
+
+            table[class=body] .btn a {
+                width: 100% !important;
+            }
+
+            table[class=body] .img-responsive {
+                height: auto !important;
+                max-width: 100% !important;
+                width: auto !important;
+            }
+        }
+
+        @media all {
+            .ExternalClass {
+                width: 100%;
+            }
+
+            .ExternalClass,
+            .ExternalClass p,
+            .ExternalClass span,
+            .ExternalClass font,
+            .ExternalClass td,
+            .ExternalClass div {
+                line-height: 100%;
+            }
+
+            .apple-link a {
+                color: inherit !important;
+                font-family: inherit !important;
+                font-size: inherit !important;
+                font-weight: inherit !important;
+                line-height: inherit !important;
+                text-decoration: none !important;
+            }
+
+            #MessageViewBody a {
+                color: inherit;
+                text-decoration: none;
+                font-size: inherit;
+                font-family: inherit;
+                font-weight: inherit;
+                line-height: inherit;
+            }
+
+            .btn-primary table td:hover {
+                background-color: #34495e !important;
+            }
+
+            .btn-primary a:hover {
+                background-color: #34495e !important;
+                border-color: #34495e !important;
+            }
+        }
+    </style>
+</head>
+<body class=""
+      style="background-color: #f6f6f6; font-family: sans-serif; -webkit-font-smoothing: antialiased; font-size: 14px; line-height: 1.4; margin: 0; padding: 0; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;">
+<span class="preheader"
+      style="color: transparent; display: none; height: 0; max-height: 0; max-width: 0; opacity: 0; overflow: hidden; mso-hide: all; visibility: hidden; width: 0;">
+      NocoDB Invitation
+</span>
+<table role="presentation" border="0" cellpadding="0" cellspacing="0" class="body"
+       style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f6f6f6; width: 100%;"
+       width="100%" bgcolor="#f6f6f6">
+    <tr>
+        <td style="font-family: sans-serif; font-size: 14px; vertical-align: top;" valign="top">&nbsp;</td>
+        <td class="container"
+            style="font-family: sans-serif; font-size: 14px; vertical-align: top; display: block; max-width: 580px; padding: 10px; width: 580px; margin: 0 auto;"
+            width="580" valign="top">
+            <div class="content"
+                 style="box-sizing: border-box; display: block; margin: 0 auto; max-width: 580px; padding: 10px;">
+
+                <!-- START CENTERED WHITE CONTAINER -->
+                <table role="presentation" class="main"
+                       style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background: #ffffff; border-radius: 3px; width: 100%;"
+                       width="100%">
+
+                    <!-- START MAIN CONTENT AREA -->
+                    <tr>
+                        <td class="wrapper"
+                            style="font-family: sans-serif; font-size: 14px; vertical-align: top; box-sizing: border-box; padding: 20px;"
+                            valign="top">
+                            <table role="presentation" border="0" cellpadding="0" cellspacing="0"
+                                   style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: 100%;"
+                                   width="100%">
+                                <tr>
+                                    <td style="font-family: sans-serif; font-size: 14px; vertical-align: top;"
+                                        valign="top">
+                                        <p style="font-family: sans-serif; font-size: 14px; font-weight: normal; margin: 0; margin-bottom: 15px;">
+                                            Hi,</p>
+                                        <p style="font-family: sans-serif; font-size: 14px; font-weight: normal; margin: 0; margin-bottom: 15px;">
+                                            You have been invited to become "<%= roles -%>" in NocoDB application.
+                                            Click the button below to accept the invitation.</p>
+                                        <table role="presentation" border="0" cellpadding="0" cellspacing="0"
+                                               class="btn btn-primary"
+                                               style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; box-sizing: border-box; width: 100%;"
+                                               width="100%">
+                                            <tbody>
+                                            <tr>
+                                                <td align="left"
+                                                    style="font-family: sans-serif; font-size: 14px; vertical-align: top; padding-bottom: 15px;"
+                                                    valign="top">
+                                                    <table role="presentation" border="0" cellpadding="0"
+                                                           cellspacing="0"
+                                                           style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: auto;">
+                                                        <tbody>
+                                                        <tr>
+                                                            <td style="font-family: sans-serif; font-size: 14px; vertical-align: top; border-radius: 5px; text-align: center; background-color: #3498db;"
+                                                                valign="top" align="center" bgcolor="#1088ff"><a
+                                                                        href="<%= signupLink %>" target="_blank"
+                                                                        style="border: solid 1px rgb(23, 139, 255); border-radius: 5px; box-sizing: border-box; cursor: pointer; display: inline-block; font-size: 14px; font-weight: bold; margin: 0; padding: 12px 25px; text-decoration: none; text-transform: capitalize; background-color: rgb(23, 139, 255); border-color: #3498db; color: #ffffff;">Signup</a>
+                                                            </td>
+                                                        </tr>
+                                                        </tbody>
+                                                    </table>
+                                                </td>
+                                            </tr>
+                                            </tbody>
+                                        </table>
+                                        <p style="font-family: sans-serif; font-size: 14px; font-weight: normal; margin: 0; margin-bottom: 15px;">
+                                            Have a nice day,<br><%= adminEmail %></p>
+                                    </td>
+                                </tr>
+                            </table>
+                        </td>
+                    </tr>
+
+                    <!-- END MAIN CONTENT AREA -->
+                </table>
+                <!-- END CENTERED WHITE CONTAINER -->
+
+                <!-- START FOOTER -->
+                <div class="footer" style="clear: both; margin-top: 10px; text-align: center; width: 100%;">
+                    <table role="presentation" border="0" cellpadding="0" cellspacing="0"
+                           style="border-collapse: separate; mso-table-lspace: 0pt; mso-table-rspace: 0pt; width: 100%;"
+                           width="100%">
+                        <tr>
+                            <td class="content-block"
+                                style="font-family: sans-serif; vertical-align: top; padding-bottom: 10px; padding-top: 10px; color: #999999; font-size: 12px; text-align: center;"
+                                valign="top" align="center">
+                                <span class="apple-link"
+                                      style="color: #999999; font-size: 12px; text-align: center;"></span>
+                                <!--                <br> Don't like these emails? <a href="http://i.imgur.com/CScmqnj.gif">Unsubscribe</a>.-->
+                            </td>
+                        </tr>
+                        <tr>
+                            <td class="content-block powered-by"
+                                style="font-family: sans-serif; vertical-align: top; padding-bottom: 10px; padding-top: 10px; color: #999999; font-size: 12px; text-align: center;"
+                                valign="top" align="center">
+                                <a href="http://nocodb.com/">NocoDB</a>
+                                <!--                Powered by <a href="http://htmlemail.io">HTMLemail</a>.-->
+                            </td>
+                        </tr>
+                    </table>
+                </div>
+                <!-- END FOOTER -->
+
+            </div>
+        </td>
+        <td style="font-family: sans-serif; font-size: 14px; vertical-align: top;" valign="top">&nbsp;</td>
+    </tr>
+</table>
+</body>
+</html>
+`;

packages/nocodb/src/services/org-users.service.ts

@@ -161,21 +161,23 @@ export class OrgUsersService {
 
           // in case of single user check for smtp failure
           // and send back token if failed
+          if (emails.length === 1) {
             if (
-            emails.length === 1 &&
+              !(await this.baseUsersService.sendInviteEmail({
-            !(await this.baseUsersService.sendInviteEmail(
                 email,
-              invite_token,
+                token: invite_token,
-              param.req,
+                useOrgTemplate: true,
-            ))
+                req: param.req,
-          ) {
+              }))
+            )
               return { invite_token, email };
           } else {
-            this.baseUsersService.sendInviteEmail(
+            await this.baseUsersService.sendInviteEmail({
               email,
-              invite_token,
+              token: invite_token,
-              param.req,
+              req: param.req,
-            );
+              useOrgTemplate: true,
+            });
           }
         } catch (e) {
           console.log(e);
@@ -234,11 +236,12 @@ export class OrgUsersService {
       );
     }
 
-    await this.baseUsersService.sendInviteEmail(
+    await this.baseUsersService.sendInviteEmail({
-      user.email,
+      email: user.email,
-      invite_token,
+      token: invite_token,
-      param.req,
+      req: param.req,
-    );
+      useOrgTemplate: true,
+    });
 
     this.appHooksService.emit(AppEvents.ORG_USER_RESEND_INVITE, {
       invitedBy: param.req.user,