✨ Feat: Create separate tags for waitlist and sign up (#425)

* 🐛 Fix: use string for schemaVersion in waitlist.controller.test

* ✨ Feat: create EMAILER_USER_TAG_ID

And use this tag when a user signs up (instead of _WAITLIST_ID)

Author: tyler-dane

packages/backend/.env.example

@@ -71,7 +71,8 @@ PROD_DOMAIN=app.yourdomain.com
 # integration during signup will be skipped
 
 EMAILER_API_SECRET=UNIQUE_SECRET_FROM_YOUR_KIT_ACCOUNT
-EMAILER_TAG_ID=YOUR_TAG_ID # get this from Kit
+EMAILER_WAITLIST_TAG_ID=YOUR_WAITLIST_TAG_ID 
+EMAILER_USER_TAG_ID=YOUR_USER_TAG_ID 
 
 ####################################################
 # 7. Debug (optional)                              #

packages/backend/src/__tests__/backend.test.init.js

@@ -12,6 +12,7 @@ process.env.CHANNEL_EXPIRATION_MIN = 5;
 process.env.SUPERTOKENS_URI = "sTUri";
 process.env.SUPERTOKENS_KEY = "sTKey";
 process.env.EMAILER_API_SECRET = "emailerApiSecret";
-process.env.EMAILER_TAG_ID = 1234567;
+process.env.EMAILER_WAITLIST_TAG_ID = 1234567;
+process.env.EMAILER_USER_TAG_ID = 910111213;
 process.env.TOKEN_GCAL_NOTIFICATION = "secretToken1";
 process.env.TOKEN_COMPASS_SYNC = "secretToken2";

packages/backend/src/common/constants/env.constants.ts

@@ -20,7 +20,8 @@ const EnvSchema = z
     CLIENT_SECRET: z.string().nonempty(),
     DB: z.string().nonempty(),
     EMAILER_SECRET: z.string().nonempty().optional(),
-    EMAILER_TAG_ID: z.string().nonempty().optional(),
+    EMAILER_WAITLIST_TAG_ID: z.string().nonempty().optional(),
+    EMAILER_USER_TAG_ID: z.string().nonempty().optional(),
     MONGO_URI: z.string().nonempty(),
     NODE_ENV: z.nativeEnum(NodeEnv),
     ORIGINS_ALLOWED: z.array(z.string().nonempty()).default([]),
@@ -41,7 +42,8 @@ export const ENV = {
   CLIENT_SECRET: process.env["CLIENT_SECRET"],
   DB: IS_DEV ? "dev_calendar" : "prod_calendar",
   EMAILER_SECRET: process.env["EMAILER_API_SECRET"],
-  EMAILER_TAG_ID: process.env["EMAILER_TAG_ID"],
+  EMAILER_WAITLIST_TAG_ID: process.env["EMAILER_WAITLIST_TAG_ID"],
+  EMAILER_USER_TAG_ID: process.env["EMAILER_USER_TAG_ID"],
   MONGO_URI: process.env["MONGO_URI"],
   NODE_ENV: _nodeEnv,
   ORIGINS_ALLOWED: process.env["CORS"] ? process.env["CORS"].split(",") : [],

packages/backend/src/common/constants/env.util.ts

@@ -0,0 +1,9 @@
+import { ENV } from "./env.constants";
+
+export const isMissingUserTagId = () => {
+  return !ENV.EMAILER_SECRET || !ENV.EMAILER_USER_TAG_ID;
+};
+
+export const isMissingWaitlistTagId = () => {
+  return !ENV.EMAILER_SECRET || !ENV.EMAILER_WAITLIST_TAG_ID;
+};

packages/backend/src/user/services/user.service.ts

@@ -10,6 +10,7 @@ import compassAuthService from "@backend/auth/services/compass.auth.service";
 import { getGcalClient } from "@backend/auth/services/google.auth.service";
 import calendarService from "@backend/calendar/services/calendar.service";
 import { ENV } from "@backend/common/constants/env.constants";
+import { isMissingUserTagId } from "@backend/common/constants/env.util";
 import { AuthError } from "@backend/common/errors/auth/auth.errors";
 import { error } from "@backend/common/errors/handlers/error.handler";
 import { initSupertokens } from "@backend/common/middleware/supertokens.middleware";
@@ -126,13 +127,16 @@ class UserService {
     const cUser = await this.createUser(gUser, gRefreshToken);
     const { userId } = cUser;
 
-    if (!ENV.EMAILER_TAG_ID || !ENV.EMAILER_SECRET) {
+    if (isMissingUserTagId()) {
       logger.warn(
         "Did not tag subscriber due to missing EMAILER_ ENV value(s)",
       );
     } else {
       const subscriber = mapCompassUserToEmailSubscriber(cUser);
-      await EmailService.addTagToSubscriber(subscriber, ENV.EMAILER_TAG_ID);
+      await EmailService.addTagToSubscriber(
+        subscriber,
+        ENV.EMAILER_USER_TAG_ID!,
+      );
     }
 
     const gCalendarIds = await initSync(gcalClient, userId);

packages/backend/src/waitlist/controller/waitlist.controller.test.ts

@@ -80,7 +80,7 @@ describe("POST /api/waitlist", () => {
       workingTowardsMainGoal: "yes",
       isWillingToShare: false,
       waitlistedAt: new Date().toISOString(),
-      schemaVersion: 0,
+      schemaVersion: "0",
     };
     const res = await request(app).post("/api/waitlist").send(answers);
     expect(res.status).toBe(500);

packages/backend/src/waitlist/controller/waitlist.controller.ts

@@ -5,7 +5,7 @@ import {
   AnswerMap,
   Schema_Waitlist,
 } from "@core/types/waitlist/waitlist.types";
-import { ENV } from "@backend/common/constants/env.constants";
+import { isMissingWaitlistTagId } from "@backend/common/constants/env.util";
 import WaitlistService from "../service/waitlist.service";
 
 const logger = Logger("app:waitlist.controller");
@@ -15,7 +15,7 @@ export class WaitlistController {
     req: Request<unknown, unknown, Schema_Waitlist>,
     res: Response,
   ) {
-    if (!ENV.EMAILER_SECRET || !ENV.EMAILER_TAG_ID) {
+    if (isMissingWaitlistTagId()) {
       return res.status(500).json({ error: "Emailer values are missing" });
     }
 

packages/backend/src/waitlist/service/waitlist.service.ts

@@ -14,7 +14,7 @@ class WaitlistService {
     email: string,
     answer: Schema_Answers,
   ): Promise<Result_Waitlist> {
-    if (ENV.EMAILER_SECRET && ENV.EMAILER_TAG_ID) {
+    if (ENV.EMAILER_SECRET && ENV.EMAILER_WAITLIST_TAG_ID) {
       const subscriber: Subscriber = {
         email_address: email,
         first_name: answer.firstName,
@@ -25,7 +25,10 @@ class WaitlistService {
           Source: answer.source,
         },
       };
-      await EmailService.addTagToSubscriber(subscriber, ENV.EMAILER_TAG_ID);
+      await EmailService.addTagToSubscriber(
+        subscriber,
+        ENV.EMAILER_WAITLIST_TAG_ID,
+      );
     } else {
       logger.warn("Did not tag subscriber due to missing EMAILER env values");
     }