Skip to content

Open-source and local-first Slack and Notion alternative that puts you in control of your data

Send emails on workspace invitation (#321)

Hakan Shehud88ef72f3783
diff --git a/apps/server/config.example.json b/apps/server/config.example.json
index 9bc26ee5..88462720 100644
--- a/apps/server/config.example.json
+++ b/apps/server/config.example.json
@@ -3,6 +3,9 @@
"_docs": "https://colanode.com/docs/self-hosting/configuration/",
"name": "Colanode Local",
+ "web": {
+ "domain": "localhost:4000"
+ },
"mode": "standalone",
"cors": {
"origin": "http://localhost:4000",
diff --git a/apps/server/src/api/client/routes/workspaces/users/users-create.ts b/apps/server/src/api/client/routes/workspaces/users/users-create.ts
index 89f654ad..747429f3 100644
--- a/apps/server/src/api/client/routes/workspaces/users/users-create.ts
+++ b/apps/server/src/api/client/routes/workspaces/users/users-create.ts
@@ -17,6 +17,7 @@ import { database } from '@colanode/server/data/database';
import { SelectAccount } from '@colanode/server/data/schema';
import { eventBus } from '@colanode/server/lib/event-bus';
import { getNameFromEmail } from '@colanode/server/lib/utils';
+import { jobService } from '@colanode/server/services/job-service';
export const usersCreateRoute: FastifyPluginCallbackZod = (
instance,
@@ -138,6 +139,11 @@ export const usersCreateRoute: FastifyPluginCallbackZod = (
workspaceId: workspaceId,
});
+ await jobService.addJob({
+ type: 'email.workspace.invitation.send',
+ userId: userId,
+ });
+
output.users.push({
id: newUser.id,
email: newUser.email,
diff --git a/apps/server/src/jobs/email-workspace-invitation-send.ts b/apps/server/src/jobs/email-workspace-invitation-send.ts
new file mode 100644
index 00000000..667fee2e
--- /dev/null
+++ b/apps/server/src/jobs/email-workspace-invitation-send.ts
@@ -0,0 +1,22 @@
+import { JobHandler } from '@colanode/server/jobs';
+import { sendWorkspaceInvitationEmail } from '@colanode/server/lib/accounts';
+
+export type EmailWorkspaceInvitationSendInput = {
+ type: 'email.workspace.invitation.send';
+ userId: string;
+};
+
+declare module '@colanode/server/jobs' {
+ interface JobMap {
+ 'email.workspace.invitation.send': {
+ input: EmailWorkspaceInvitationSendInput;
+ };
+ }
+}
+
+export const emailWorkspaceInvitationSendHandler: JobHandler<
+ EmailWorkspaceInvitationSendInput
+> = async (input) => {
+ const { userId } = input;
+ await sendWorkspaceInvitationEmail(userId);
+};
diff --git a/apps/server/src/jobs/index.ts b/apps/server/src/jobs/index.ts
index eefbda2b..a00a6a5d 100644
--- a/apps/server/src/jobs/index.ts
+++ b/apps/server/src/jobs/index.ts
@@ -5,6 +5,7 @@ import { cleanupHandler } from '@colanode/server/jobs/cleanup';
import { documentUpdatesMergeHandler } from '@colanode/server/jobs/document-updates-merge';
import { emailPasswordResetSendHandler } from '@colanode/server/jobs/email-password-reset-sent';
import { emailVerifySendHandler } from '@colanode/server/jobs/email-verify-send';
+import { emailWorkspaceInvitationSendHandler } from '@colanode/server/jobs/email-workspace-invitation-send';
import { nodeCleanHandler } from '@colanode/server/jobs/node-clean';
// import { nodeEmbedHandler } from '@colanode/server/jobs/node-embed';
// import { nodeEmbedScanHandler } from '@colanode/server/jobs/node-embed-scan';
@@ -25,6 +26,7 @@ type JobHandlerMap = {
export const jobHandlerMap: JobHandlerMap = {
'email.verify.send': emailVerifySendHandler,
'email.password.reset.send': emailPasswordResetSendHandler,
+ 'email.workspace.invitation.send': emailWorkspaceInvitationSendHandler,
'workspace.clean': workspaceCleanHandler,
'node.clean': nodeCleanHandler,
// 'node.embed': nodeEmbedHandler,
diff --git a/apps/server/src/lib/accounts.ts b/apps/server/src/lib/accounts.ts
index fa447a30..5c0c084b 100644
--- a/apps/server/src/lib/accounts.ts
+++ b/apps/server/src/lib/accounts.ts
@@ -27,6 +27,7 @@ import { jobService } from '@colanode/server/services/job-service';
import {
emailPasswordResetTemplate,
emailVerifyTemplate,
+ workspaceInvitationTemplate,
} from '@colanode/server/templates';
import { ClientContext } from '@colanode/server/types/api';
import { DeviceType } from '@colanode/server/types/devices';
@@ -261,3 +262,54 @@ export const sendEmailPasswordResetEmail = async (
html,
});
};
+
+export const sendWorkspaceInvitationEmail = async (
+ userId: string
+): Promise<void> => {
+ if (!config.email.enabled || !config.web) {
+ return;
+ }
+
+ const user = await database
+ .selectFrom('users')
+ .where('id', '=', userId)
+ .selectAll()
+ .executeTakeFirst();
+
+ if (!user) {
+ return;
+ }
+
+ const workspace = await database
+ .selectFrom('workspaces')
+ .where('id', '=', user.workspace_id)
+ .selectAll()
+ .executeTakeFirst();
+
+ if (!workspace) {
+ return;
+ }
+
+ const inviterAccount = await database
+ .selectFrom('accounts')
+ .where('id', '=', user.created_by)
+ .selectAll()
+ .executeTakeFirst();
+
+ if (!inviterAccount) {
+ return;
+ }
+
+ const html = workspaceInvitationTemplate({
+ inviteeName: user.name,
+ inviterName: inviterAccount.name,
+ workspaceName: workspace.name,
+ invitationUrl: `${config.web.protocol}://${config.web.domain}`,
+ });
+
+ await emailService.sendEmail({
+ subject: `${inviterAccount.name} invited you to ${workspace.name} on Colanode`,
+ to: user.email,
+ html,
+ });
+};
diff --git a/apps/server/src/lib/config/index.ts b/apps/server/src/lib/config/index.ts
index 96634f6e..bf042071 100644
--- a/apps/server/src/lib/config/index.ts
+++ b/apps/server/src/lib/config/index.ts
@@ -22,6 +22,12 @@ const serverModeSchema = z.enum(['standalone', 'cluster']);
const configSchema = z.object({
name: z.string().default('Colanode Server').transform(resolveConfigReference),
avatar: z.string().optional().transform(resolveOptionalConfigReference),
+ web: z
+ .object({
+ domain: z.string().transform(resolveConfigReference),
+ protocol: z.string().default('https').transform(resolveConfigReference),
+ })
+ .optional(),
mode: serverModeSchema
.default('standalone')
.transform(resolveConfigReference),
diff --git a/apps/server/src/templates/email-password-reset.html b/apps/server/src/templates/email-password-reset.html
index b76a9433..48ecd67b 100644
--- a/apps/server/src/templates/email-password-reset.html
+++ b/apps/server/src/templates/email-password-reset.html
@@ -21,7 +21,7 @@
>
<div style="margin-bottom: 20px">
<img
- src="https://colanode.com/assets/logo-black.png"
+ src="https://static.colanode.com/web/brand/icon-main-128x128.jpg"
alt="Colanode logo"
style="height: 50px; width: auto; border: none; display: inline-block"
/>
diff --git a/apps/server/src/templates/email-verify.html b/apps/server/src/templates/email-verify.html
index cc14374e..19173c7a 100644
--- a/apps/server/src/templates/email-verify.html
+++ b/apps/server/src/templates/email-verify.html
@@ -21,7 +21,7 @@
>
<div style="margin-bottom: 20px">
<img
- src="https://colanode.com/assets/logo-black.png"
+ src="https://static.colanode.com/web/brand/icon-main-128x128.jpg"
alt="Colanode logo"
style="height: 50px; width: auto; border: none; display: inline-block"
/>
diff --git a/apps/server/src/templates/index.ts b/apps/server/src/templates/index.ts
index eb2dc461..94ed37ce 100644
--- a/apps/server/src/templates/index.ts
+++ b/apps/server/src/templates/index.ts
@@ -17,6 +17,13 @@ export const emailPasswordResetTemplate = handlebars.compile(
fs.readFileSync(path.join(templatesDir, 'email-password-reset.html'), 'utf8')
);
+export const workspaceInvitationTemplate = handlebars.compile(
+ fs.readFileSync(
+ path.join(templatesDir, 'workspace-invitation.html'),
+ 'utf8'
+ )
+);
+
export const homeTemplate = handlebars.compile(
fs.readFileSync(path.join(templatesDir, 'home.html'), 'utf8')
);
diff --git a/apps/server/src/templates/workspace-invitation.html b/apps/server/src/templates/workspace-invitation.html
new file mode 100644
index 00000000..6452e8fd
--- /dev/null
+++ b/apps/server/src/templates/workspace-invitation.html
@@ -0,0 +1,65 @@
+<!doctype html>
+<html>
+ <body
+ style="
+ margin: 0;
+ padding: 0;
+ font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+ background-color: white;
+ color: #333;
+ "
+ >
+ <div
+ style="
+ max-width: 600px;
+ margin: 20px auto;
+ padding: 40px;
+ background-color: #ffffff;
+ border-radius: 5px;
+ box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+ "
+ >
+ <div style="margin-bottom: 20px">
+ <img
+ src="https://static.colanode.com/web/brand/icon-main-128x128.jpg"
+ alt="Colanode logo"
+ style="height: 50px; width: auto; border: none; display: inline-block"
+ />
+ </div>
+ <p>Hello <b>{{inviteeName}}</b>,</p>
+ <p>
+ <b>{{inviterName}}</b> has invited you to join the
+ <b>{{workspaceName}}</b> workspace on Colanode.
+ </p>
+ <p>Click the button below to get started:</p>
+ <div style="margin: 30px 0; text-align: center">
+ <a
+ href="{{invitationUrl}}"
+ style="
+ display: inline-block;
+ padding: 12px 24px;
+ background-color: #333;
+ color: #ffffff;
+ text-decoration: none;
+ border-radius: 5px;
+ font-size: 16px;
+ "
+ >Join Workspace</a
+ >
+ </div>
+ <p style="color: #666; font-size: 14px">
+ If the button above doesn't work, copy and paste this link into your
+ browser:
+ <br />
+ <a href="{{invitationUrl}}" style="color: #666">{{invitationUrl}}</a>
+ </p>
+ <hr style="border: 0; border-top: 1px solid #f5f5f5" />
+ <p style="color: #666; font-size: 14px">
+ If you did not expect this invitation, please disregard this email.
+ </p>
+ <p style="color: #777; font-size: 12px">
+ Warm regards, <br />The Colanode Team
+ </p>
+ </div>
+ </body>
+</html>