🧑‍💻 Improve env variables type safety and management (#718)

Closes #679

apps/viewer/src/features/blocks/inputs/fileUpload/api/getUploadUrl.ts

@@ -11,6 +11,7 @@ import {
 import { byId, isDefined } from '@typebot.io/lib'
 import { z } from 'zod'
 import { generatePresignedUrl } from '@typebot.io/lib/api/storage'
+import { env } from '@typebot.io/env'
 
 export const getUploadUrl = publicProcedure
   .meta({
@@ -39,11 +40,7 @@ export const getUploadUrl = publicProcedure
     })
   )
   .query(async ({ input: { typebotId, blockId, filePath, fileType } }) => {
-    if (
-      !process.env.S3_ENDPOINT ||
-      !process.env.S3_ACCESS_KEY ||
-      !process.env.S3_SECRET_KEY
-    )
+    if (!env.S3_ENDPOINT || !env.S3_ACCESS_KEY || !env.S3_SECRET_KEY)
       throw new TRPCError({
         code: 'INTERNAL_SERVER_ERROR',
         message:

apps/viewer/src/features/blocks/inputs/fileUpload/fileUpload.spec.ts

@@ -10,6 +10,7 @@ import {
 } from '@typebot.io/lib/playwright/databaseActions'
 import { getTestAsset } from '@/test/utils/playwright'
 import { Plan } from '@typebot.io/prisma'
+import { env } from '@typebot.io/env'
 
 const THREE_GIGABYTES = 3 * 1024 * 1024 * 1024
 
@@ -30,7 +31,7 @@ test('should work as expected', async ({ page, browser }) => {
   await expect(page.locator(`text="3"`)).toBeVisible()
   await page.locator('text="Upload 3 files"').click()
   await expect(page.locator(`text="3 files uploaded"`)).toBeVisible()
-  await page.goto(`${process.env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
+  await page.goto(`${env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
   await expect(page.getByRole('link', { name: 'api.json' })).toHaveAttribute(
     'href',
     /.+\/api\.json/
@@ -52,7 +53,7 @@ test('should work as expected', async ({ page, browser }) => {
   const file = readFileSync(downloadPath as string).toString()
   const { data } = parse(file)
   expect(data).toHaveLength(2)
-  expect((data[1] as unknown[])[1]).toContain(process.env.S3_ENDPOINT)
+  expect((data[1] as unknown[])[1]).toContain(env.S3_ENDPOINT)
 
   const urls = (
     await Promise.all(
@@ -110,7 +111,7 @@ test.describe('Storage limit is reached', () => {
     await page.evaluate(() =>
       window.localStorage.setItem('workspaceId', 'starterWorkspace')
     )
-    await page.goto(`${process.env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
+    await page.goto(`${env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
     await expect(page.locator('text="150%"')).toBeVisible()
   })
 })

apps/viewer/src/features/blocks/integrations/chatwoot/executeChatwootBlock.ts

@@ -2,6 +2,7 @@ import { ExecuteIntegrationResponse } from '@/features/chat/types'
 import { extractVariablesFromText } from '@/features/variables/extractVariablesFromText'
 import { parseGuessedValueType } from '@/features/variables/parseGuessedValueType'
 import { parseVariables } from '@/features/variables/parseVariables'
+import { env } from '@typebot.io/env'
 import { isDefined } from '@typebot.io/lib'
 import {
   ChatwootBlock,
@@ -30,7 +31,7 @@ const parseChatwootOpenCode = ({
   const openChatwoot = `${parseSetUserCode(user, resultId)}
   window.$chatwoot.setCustomAttributes({
     typebot_result_url: "${
-      process.env.NEXTAUTH_URL
+      env.NEXTAUTH_URL
     }/typebots/${typebotId}/results?id=${resultId}",
   });
   window.$chatwoot.toggle("open");

apps/viewer/src/features/blocks/integrations/sendEmail/constants.ts

@@ -1,14 +1,16 @@
+import { env } from '@typebot.io/env'
+
 export const defaultTransportOptions = {
-  host: process.env.SMTP_HOST,
-  port: Number(process.env.SMTP_PORT),
-  secure: process.env.SMTP_SECURE ? process.env.SMTP_SECURE === 'true' : false,
+  host: env.SMTP_HOST,
+  port: env.SMTP_PORT,
+  secure: env.SMTP_SECURE,
   auth: {
-    user: process.env.SMTP_USERNAME,
-    pass: process.env.SMTP_PASSWORD,
+    user: env.SMTP_USERNAME,
+    pass: env.SMTP_PASSWORD,
   },
 }
 
 export const defaultFrom = {
-  name: process.env.SMTP_FROM?.split(' <')[0].replace(/"/g, ''),
-  email: process.env.SMTP_FROM?.match(/<(.*)>/)?.pop(),
+  name: env.NEXT_PUBLIC_SMTP_FROM?.split(' <')[0].replace(/"/g, ''),
+  email: env.NEXT_PUBLIC_SMTP_FROM?.match(/<(.*)>/)?.pop(),
 }

apps/viewer/src/features/blocks/integrations/sendEmail/executeSendEmailBlock.tsx

@@ -20,6 +20,7 @@ import { decrypt } from '@typebot.io/lib/api'
 import { defaultFrom, defaultTransportOptions } from './constants'
 import { ExecuteIntegrationResponse } from '@/features/chat/types'
 import { findUniqueVariableValue } from '../../../variables/findUniqueVariableValue'
+import { env } from '@typebot.io/env'
 
 export const executeSendEmailBlock = async (
   state: SessionState,
@@ -186,7 +187,7 @@ const getEmailInfo = async (
   if (credentialsId === 'default')
     return {
       host: defaultTransportOptions.host,
-      port: defaultTransportOptions.port,
+      port: defaultTransportOptions.port ?? 22,
       username: defaultTransportOptions.auth.user,
       password: defaultTransportOptions.auth.pass,
       isTlsEnabled: undefined,
@@ -226,7 +227,7 @@ const getEmailBody = async ({
   return {
     html: render(
       <DefaultBotNotificationEmail
-        resultsUrl={`${process.env.NEXTAUTH_URL}/typebots/${typebot.id}/results`}
+        resultsUrl={`${env.NEXTAUTH_URL}/typebots/${typebot.id}/results`}
         answers={omit(answers, 'submittedAt')}
       />
     ).html,

apps/viewer/src/features/blocks/integrations/sendEmail/sendEmail.spec.ts

@@ -4,6 +4,7 @@ import { createId } from '@paralleldrive/cuid2'
 import { importTypebotInDatabase } from '@typebot.io/lib/playwright/databaseActions'
 import { getTestAsset } from '@/test/utils/playwright'
 import { SmtpCredentials } from '@typebot.io/schemas'
+import { env } from '@typebot.io/env'
 
 export const mockSmtpCredentials: SmtpCredentials['data'] = {
   from: {
@@ -34,7 +35,7 @@ test('should send an email', async ({ page }) => {
   await page.goto(`/${typebotId}-public`)
   await page.locator('text=Send email').click()
   await expect(page.getByText('Email sent!')).toBeVisible()
-  await page.goto(`${process.env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
+  await page.goto(`${env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
   await page.click('text="See logs"')
   await expect(page.locator('text="Email successfully sent"')).toBeVisible()
 })

apps/viewer/src/features/blocks/logic/typebotLink/typebotLink.spec.ts

@@ -1,5 +1,6 @@
 import { getTestAsset } from '@/test/utils/playwright'
 import test, { expect } from '@playwright/test'
+import { env } from '@typebot.io/env'
 import { importTypebotInDatabase } from '@typebot.io/lib/playwright/databaseActions'
 
 const typebotId = 'cl0ibhi7s0018n21aarlmg0cm'
@@ -33,7 +34,7 @@ test('should work as expected', async ({ page }) => {
   await page.locator('input').fill('Hello there!')
   await page.locator('input').press('Enter')
   await expect(page.getByText('Cheers!')).toBeVisible()
-  await page.goto(`${process.env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
+  await page.goto(`${env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
   await expect(page.locator('text=Hello there!')).toBeVisible()
 })
 

apps/viewer/src/features/chat/api/sendMessage.ts

@@ -16,7 +16,7 @@ import {
   Variable,
   VariableWithValue,
 } from '@typebot.io/schemas'
-import { env, isDefined, isNotEmpty, omit } from '@typebot.io/lib'
+import { isDefined, isNotEmpty, omit } from '@typebot.io/lib'
 import { prefillVariables } from '@/features/variables/prefillVariables'
 import { injectVariablesFromExistingResult } from '@/features/variables/injectVariablesFromExistingResult'
 import { deepParseVariables } from '@/features/variables/deepParseVariable'
@@ -30,6 +30,7 @@ import { findTypebot } from '../queries/findTypebot'
 import { findPublicTypebot } from '../queries/findPublicTypebot'
 import { findResult } from '../queries/findResult'
 import { createId } from '@paralleldrive/cuid2'
+import { env } from '@typebot.io/env'
 
 export const sendMessage = publicProcedure
   .meta({
@@ -257,7 +258,7 @@ const getTypebot = async (
   userId?: string
 ): Promise<StartTypebot> => {
   if (typeof typebot !== 'string') return typebot
-  if (isPreview && !userId && env('E2E_TEST') !== 'true')
+  if (isPreview && !userId && !env.NEXT_PUBLIC_E2E_TEST)
     throw new TRPCError({
       code: 'UNAUTHORIZED',
       message:

apps/viewer/src/features/results/results.spec.ts

@@ -2,6 +2,7 @@ import { getTestAsset } from '@/test/utils/playwright'
 import test, { expect } from '@playwright/test'
 import { createId } from '@paralleldrive/cuid2'
 import { importTypebotInDatabase } from '@typebot.io/lib/playwright/databaseActions'
+import { env } from '@typebot.io/env'
 
 test('Big groups should work as expected', async ({ page }) => {
   const typebotId = createId()
@@ -15,7 +16,7 @@ test('Big groups should work as expected', async ({ page }) => {
   await page.locator('input').fill('26')
   await page.locator('input').press('Enter')
   await page.getByRole('button', { name: 'Yes' }).click()
-  await page.goto(`${process.env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
+  await page.goto(`${env.NEXTAUTH_URL}/typebots/${typebotId}/results`)
   await expect(page.locator('text="Baptiste"')).toBeVisible()
   await expect(page.locator('text="26"')).toBeVisible()
   await expect(page.locator('text="Yes"')).toBeVisible()