fix(results): 🐛 Collect prefilled variables in db

apps/builder/components/shared/Graph/Nodes/StepNode/StepNodeContent/contents/SetVariableContent.tsx

@@ -12,7 +12,7 @@ export const SetVariableContent = ({ step }: { step: SetVariableStep }) => {
     <Text color={'gray.500'}>
       {variableName === '' && expression === ''
         ? 'Click to edit...'
-        : `${variableName} = ${expression}`}
+        : `${variableName} ${expression ? `= ${expression}` : ``}`}
     </Text>
   )
 }

apps/builder/layouts/results/ResultsContent.tsx

@@ -6,7 +6,6 @@ import { useRouter } from 'next/router'
 import React, { useMemo } from 'react'
 import { useStats } from 'services/analytics'
 import { isFreePlan } from 'services/user'
-import { isDefined } from 'utils'
 import { AnalyticsContent } from './AnalyticsContent'
 import { SubmissionsContent } from './SubmissionContent'
 

apps/builder/package.json

@@ -66,7 +66,6 @@
     "qs": "^6.10.3",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
-    "react-frame-component": "^5.2.1",
     "react-table": "^7.7.0",
     "short-uuid": "^4.2.0",
     "slate": "^0.72.8",

apps/builder/pages/api/credentials/google-sheets/callback.ts

@@ -38,6 +38,7 @@ const handler = async (req: NextApiRequest, res: NextApiResponse) => {
       return res
         .status(400)
         .send({ message: "User didn't accepted required scopes" })
+    // console.log(tokens)
     const { encryptedData, iv } = encrypt(tokens)
     const credentials = {
       name: email,

apps/builder/playwright/services/database.ts

@@ -67,9 +67,9 @@ const createCredentials = () => {
     expiry_date: 1642441058842,
     access_token:
       'ya29.A0ARrdaM--PV_87ebjywDJpXKb77NBFJl16meVUapYdfNv6W6ZzqqC47fNaPaRjbDbOIIcp6f49cMaX5ndK9TAFnKwlVqz3nrK9nLKqgyDIhYsIq47smcAIZkK56SWPx3X3DwAFqRu2UPojpd2upWwo-3uJrod',
-    // This token is linked to a mock Google account (typebot.test.user@gmail.com)
+    // This token is linked to a test Google account (typebot.test.user@gmail.com)
     refresh_token:
-      '1//03NRE9V8T-aayCgYIARAAGAMSNwF-L9Ir6zVzF-wm30psz0lbDJj5Y9OgqTO0cvBISODMW4QTR0VK40BLnOQgcHCHkb9c769TAhQ',
+      '1//039xWRt8YaYa3CgYIARAAGAMSNwF-L9Iru9FyuTrDSa7lkSceggPho83kJt2J29G69iEhT1C6XV1vmo6bQS9puL_R2t8FIwR3gek',
   })
   return prisma.credentials.createMany({
     data: [

apps/builder/services/publicTypebot.tsx

@@ -3,7 +3,7 @@ import shortId from 'short-uuid'
 import { HStack, Text } from '@chakra-ui/react'
 import { CalendarIcon, CodeIcon } from 'assets/icons'
 import { StepIcon } from 'components/editor/StepsSideBar/StepIcon'
-import { isInputStep, sendRequest } from 'utils'
+import { byId, isInputStep, sendRequest } from 'utils'
 import { isDefined } from '@udecode/plate-common'
 
 export const parseTypebotToPublicTypebot = (
@@ -48,12 +48,14 @@ export const updatePublishedTypebot = async (
     body: typebot,
   })
 
-export const parseSubmissionsColumns = (
-  typebot: PublicTypebot
-): {
+type HeaderCell = {
   Header: JSX.Element
   accessor: string
-}[] => {
+}
+export const parseSubmissionsColumns = (
+  typebot: PublicTypebot
+): HeaderCell[] => {
+  const parsedBlocks = parseBlocksHeaders(typebot)
   return [
     {
       Header: (
@@ -64,51 +66,58 @@ export const parseSubmissionsColumns = (
       ),
       accessor: 'createdAt',
     },
-    ...parseBlocksHeaders(typebot),
-    ...parseVariablesHeaders(typebot),
+    ...parsedBlocks,
+    ...parseVariablesHeaders(typebot, parsedBlocks),
   ]
 }
 
 const parseBlocksHeaders = (typebot: PublicTypebot) =>
   typebot.blocks
     .filter((block) => typebot && block.steps.some((step) => isInputStep(step)))
-    .map((block) => {
+    .reduce<HeaderCell[]>((headers, block) => {
       const inputStep = block.steps.find((step) => isInputStep(step))
-      if (!inputStep || !isInputStep(inputStep)) return
-      return {
-        Header: (
-          <HStack
-            minW={
-              'isLong' in inputStep.options && inputStep.options.isLong
-                ? '400px'
-                : '150px'
-            }
-            maxW="500px"
-          >
-            <StepIcon type={inputStep.type} />
-            <Text>{block.title}</Text>
-          </HStack>
-        ),
-        accessor: block.id,
-      }
-    })
-    .filter(isDefined)
-
-const parseVariablesHeaders = (typebot: PublicTypebot) =>
-  typebot.variables
-    .map((v) => {
-      const isVariableInInputStep = isDefined(
-        typebot.blocks.find((b) => {
-          const inputStep = b.steps.find((step) => isInputStep(step))
-          return (
-            inputStep &&
-            isInputStep(inputStep) &&
-            inputStep.options.variableId === v.id
-          )
-        })
+      if (
+        !inputStep ||
+        !isInputStep(inputStep) ||
+        headers.find((h) => h.accessor === inputStep.options.variableId)
       )
-      if (isVariableInInputStep) return
-      return {
+        return headers
+      const matchedVariableName =
+        inputStep.options.variableId &&
+        typebot.variables.find(byId(inputStep.options.variableId))?.name
+      return [
+        ...headers,
+        {
+          Header: (
+            <HStack
+              minW={
+                'isLong' in inputStep.options && inputStep.options.isLong
+                  ? '400px'
+                  : '150px'
+              }
+              maxW="500px"
+            >
+              <StepIcon type={inputStep.type} />
+              <Text>{matchedVariableName ?? block.title}</Text>
+            </HStack>
+          ),
+          accessor: inputStep.options.variableId ?? block.id,
+        },
+      ]
+    }, [])
+
+const parseVariablesHeaders = (
+  typebot: PublicTypebot,
+  parsedBlocks: {
+    Header: JSX.Element
+    accessor: string
+  }[]
+) =>
+  typebot.variables.reduce<HeaderCell[]>((headers, v) => {
+    if (parsedBlocks.find((b) => b.accessor === v.id)) return headers
+    return [
+      ...headers,
+      {
         Header: (
           <HStack minW={'150px'} maxW="500px">
             <CodeIcon />
@@ -116,6 +125,6 @@ const parseVariablesHeaders = (typebot: PublicTypebot) =>
           </HStack>
         ),
         accessor: v.id,
-      }
-    })
-    .filter(isDefined)
+      },
+    ]
+  }, [])

apps/builder/services/results.ts

@@ -1,9 +1,9 @@
-import { Result } from 'models'
+import { Result, VariableWithValue } from 'models'
 import useSWRInfinite from 'swr/infinite'
 import { fetcher } from './utils'
 import { stringify } from 'qs'
 import { Answer } from 'db'
-import { sendRequest } from 'utils'
+import { isDefined, sendRequest } from 'utils'
 
 const paginationLimit = 50
 
@@ -98,8 +98,18 @@ export const parseDateToReadable = (dateStr: string): string => {
 export const convertResultsToTableData = (results?: ResultWithAnswers[]) =>
   (results ?? []).map((result) => ({
     createdAt: parseDateToReadable(result.createdAt),
-    ...result.answers.reduce(
-      (o, answer) => ({ ...o, [answer.blockId]: answer.content }),
-      {}
-    ),
+    ...[...result.answers, ...result.prefilledVariables].reduce<{
+      [key: string]: string
+    }>((o, answerOrVariable) => {
+      if ('blockId' in answerOrVariable) {
+        const answer = answerOrVariable as Answer
+        return {
+          ...o,
+          [answer.variableId ?? answer.blockId]: answer.content,
+        }
+      }
+      const variable = answerOrVariable as VariableWithValue
+      if (isDefined(o[variable.id])) return o
+      return { ...o, [variable.id]: variable.value }
+    }, {}),
   }))

apps/viewer/layouts/TypebotPage.tsx

@@ -1,5 +1,5 @@
 import { TypebotViewer } from 'bot-engine'
-import { Answer, PublicTypebot } from 'models'
+import { Answer, PublicTypebot, VariableWithValue } from 'models'
 import React, { useEffect, useState } from 'react'
 import { upsertAnswer } from 'services/answer'
 import { SEO } from '../components/Seo'
@@ -19,21 +19,25 @@ export const TypebotPage = ({
   isIE,
   url,
 }: TypebotPageProps & { typebot: PublicTypebot }) => {
+  const [showTypebot, setShowTypebot] = useState(false)
   const [error, setError] = useState<Error | undefined>(
     isIE ? new Error('Internet explorer is not supported') : undefined
   )
   const [resultId, setResultId] = useState<string | undefined>()
 
+  // Workaround for react-frame-component bug (https://github.com/ryanseddon/react-frame-component/pull/207)
   useEffect(() => {
-    initializeResult()
-    // eslint-disable-next-line react-hooks/exhaustive-deps
+    setShowTypebot(true)
   }, [])
 
-  const initializeResult = async () => {
+  const initializeResult = async (variables: VariableWithValue[]) => {
     const resultIdFromSession = sessionStorage.getItem(sessionStorageKey)
     if (resultIdFromSession) setResultId(resultIdFromSession)
     else {
-      const { error, data: result } = await createResult(typebot.typebotId)
+      const { error, data: result } = await createResult(
+        typebot.typebotId,
+        variables
+      )
       if (error) setError(error)
       if (result) {
         setResultId(result.id)
@@ -60,11 +64,12 @@ export const TypebotPage = ({
   return (
     <div style={{ height: '100vh' }}>
       <SEO url={url} chatbotName={typebot.name} />
-      {resultId && (
+      {showTypebot && (
         <TypebotViewer
           typebot={typebot}
           onNewAnswer={handleNewAnswer}
           onCompleted={handleCompleted}
+          onVariablesPrefilled={initializeResult}
         />
       )}
     </div>

apps/viewer/pages/api/results.ts

@@ -1,13 +1,17 @@
 import { withSentry } from '@sentry/nextjs'
 import prisma from 'libs/prisma'
+import { VariableWithValue } from 'models'
 import { NextApiRequest, NextApiResponse } from 'next'
 import { methodNotAllowed } from 'utils'
 
 const handler = async (req: NextApiRequest, res: NextApiResponse) => {
   if (req.method === 'POST') {
-    const { typebotId } = JSON.parse(req.body) as { typebotId: string }
+    const resultData = JSON.parse(req.body) as {
+      typebotId: string
+      prefilledVariables: VariableWithValue[]
+    }
     const result = await prisma.result.create({
-      data: { typebotId, isCompleted: false },
+      data: { ...resultData, isCompleted: false },
     })
     return res.send(result)
   }

apps/viewer/pages/api/results/[id].ts

@@ -1,12 +1,11 @@
 import { withSentry } from '@sentry/nextjs'
 import prisma from 'libs/prisma'
-import { Result } from 'models'
 import { NextApiRequest, NextApiResponse } from 'next'
 import { methodNotAllowed } from 'utils'
 
 const handler = async (req: NextApiRequest, res: NextApiResponse) => {
   if (req.method === 'PATCH') {
-    const data = JSON.parse(req.body) as Result
+    const data = JSON.parse(req.body) as { isCompleted: true }
     const id = req.query.id.toString()
     const result = await prisma.result.update({
       where: { id },

apps/viewer/services/result.ts

@@ -1,11 +1,15 @@
 import { Result } from 'db'
+import { VariableWithValue } from 'models'
 import { sendRequest } from 'utils'
 
-export const createResult = async (typebotId: string) => {
+export const createResult = async (
+  typebotId: string,
+  prefilledVariables: VariableWithValue[]
+) => {
   return sendRequest<Result>({
     url: `/api/results`,
     method: 'POST',
-    body: { typebotId },
+    body: { typebotId, prefilledVariables },
   })
 }
 

packages/bot-engine/src/components/ChatBlock/ChatStep/ChatStep.tsx

@@ -21,8 +21,18 @@ export const ChatStep = ({
 }) => {
   const { addAnswer } = useAnswers()
 
-  const handleInputSubmit = (content: string, isRetry: boolean) => {
-    if (!isRetry) addAnswer({ stepId: step.id, blockId: step.blockId, content })
+  const handleInputSubmit = (
+    content: string,
+    isRetry: boolean,
+    variableId?: string
+  ) => {
+    if (!isRetry)
+      addAnswer({
+        stepId: step.id,
+        blockId: step.blockId,
+        content,
+        variableId: variableId ?? null,
+      })
     onTransitionEnd(content, isRetry)
   }
 
@@ -38,7 +48,7 @@ const InputChatStep = ({
   onSubmit,
 }: {
   step: InputStep
-  onSubmit: (value: string, isRetry: boolean) => void
+  onSubmit: (value: string, isRetry: boolean, variableId?: string) => void
 }) => {
   const { typebot } = useTypebot()
   const { addNewAvatarOffset } = useHostAvatars()
@@ -54,7 +64,7 @@ const InputChatStep = ({
 
   const handleSubmit = (value: string) => {
     setAnswer(value)
-    onSubmit(value, !isInputValid(value, step.type))
+    onSubmit(value, !isInputValid(value, step.type), step.options.variableId)
   }
 
   if (answer) {

packages/bot-engine/src/components/ConversationContainer.tsx

@@ -5,8 +5,8 @@ import { useFrame } from 'react-frame-component'
 import { setCssVariablesValue } from '../services/theme'
 import { useAnswers } from '../contexts/AnswersContext'
 import { deepEqual } from 'fast-equals'
-import { Answer, Edge, PublicBlock, Theme } from 'models'
-import { byId } from 'utils'
+import { Answer, Edge, PublicBlock, Theme, VariableWithValue } from 'models'
+import { byId, isNotDefined } from 'utils'
 import { animateScroll as scroll } from 'react-scroll'
 import { useTypebot } from 'contexts/TypebotContext'
 
@@ -15,12 +15,14 @@ type Props = {
   onNewBlockVisible: (edge: Edge) => void
   onNewAnswer: (answer: Answer) => void
   onCompleted: () => void
+  onVariablesPrefilled?: (prefilledVariables: VariableWithValue[]) => void
 }
 export const ConversationContainer = ({
   theme,
   onNewBlockVisible,
   onNewAnswer,
   onCompleted,
+  onVariablesPrefilled,
 }: Props) => {
   const { typebot, updateVariableValue } = useTypebot()
   const { document: frameDocument } = useFrame()
@@ -48,19 +50,24 @@ export const ConversationContainer = ({
   }
 
   useEffect(() => {
-    injectUrlParamsIntoVariables()
+    const prefilledVariables = injectUrlParamsIntoVariables()
+    if (onVariablesPrefilled) onVariablesPrefilled(prefilledVariables)
     displayNextBlock(typebot.blocks[0].steps[0].outgoingEdgeId)
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [])
 
   const injectUrlParamsIntoVariables = () => {
     const urlParams = new URLSearchParams(location.search)
+    const prefilledVariables: VariableWithValue[] = []
     urlParams.forEach((value, key) => {
       const matchingVariable = typebot.variables.find(
         (v) => v.name.toLowerCase() === key.toLowerCase()
       )
-      if (matchingVariable) updateVariableValue(matchingVariable?.id, value)
+      if (isNotDefined(matchingVariable)) return
+      updateVariableValue(matchingVariable?.id, value)
+      prefilledVariables.push({ ...matchingVariable, value })
     })
+    return prefilledVariables
   }
 
   useEffect(() => {

packages/bot-engine/src/components/TypebotViewer.tsx

@@ -10,7 +10,13 @@ import phoneNumberInputStyle from 'react-phone-number-input/style.css'
 import phoneSyle from '../assets/phone.css'
 import { ConversationContainer } from './ConversationContainer'
 import { AnswersContext } from '../contexts/AnswersContext'
-import { Answer, BackgroundType, Edge, PublicTypebot } from 'models'
+import {
+  Answer,
+  BackgroundType,
+  Edge,
+  PublicTypebot,
+  VariableWithValue,
+} from 'models'
 
 export type TypebotViewerProps = {
   typebot: PublicTypebot
@@ -19,6 +25,7 @@ export type TypebotViewerProps = {
   onNewBlockVisible?: (edge: Edge) => void
   onNewAnswer?: (answer: Answer) => void
   onCompleted?: () => void
+  onVariablesPrefilled?: (prefilledVariables: VariableWithValue[]) => void
 }
 export const TypebotViewer = ({
   typebot,
@@ -27,6 +34,7 @@ export const TypebotViewer = ({
   onNewBlockVisible,
   onNewAnswer,
   onCompleted,
+  onVariablesPrefilled,
 }: TypebotViewerProps) => {
   const containerBgColor = useMemo(
     () =>
@@ -84,6 +92,7 @@ export const TypebotViewer = ({
                 onNewBlockVisible={handleNewBlockVisible}
                 onNewAnswer={handleNewAnswer}
                 onCompleted={handleCompleted}
+                onVariablesPrefilled={onVariablesPrefilled}
               />
             </div>
             {typebot.settings.general.isBrandingEnabled && (

packages/db/prisma/schema.prisma

@@ -125,21 +125,23 @@ model PublicTypebot {
 }
 
 model Result {
-  id          String   @id @default(cuid())
-  createdAt   DateTime @default(now())
-  typebotId   String
-  typebot     Typebot  @relation(fields: [typebotId], references: [id], onDelete: Cascade)
-  answers     Answer[]
-  isCompleted Boolean
+  id                 String   @id @default(cuid())
+  createdAt          DateTime @default(now())
+  typebotId          String
+  typebot            Typebot  @relation(fields: [typebotId], references: [id], onDelete: Cascade)
+  answers            Answer[]
+  prefilledVariables Json[]
+  isCompleted        Boolean
 }
 
 model Answer {
-  createdAt DateTime @default(now())
-  resultId  String
-  result    Result   @relation(fields: [resultId], references: [id], onDelete: Cascade)
-  stepId    String
-  blockId   String
-  content   String
+  createdAt  DateTime @default(now())
+  resultId   String
+  result     Result   @relation(fields: [resultId], references: [id], onDelete: Cascade)
+  stepId     String
+  blockId    String
+  variableId String?
+  content    String
 
   @@unique([resultId, blockId, stepId])
 }

packages/models/src/result.ts

@@ -1,3 +1,7 @@
 import { Result as ResultFromPrisma } from 'db'
+import { VariableWithValue } from '.'
 
-export type Result = Omit<ResultFromPrisma, 'createdAt'> & { createdAt: string }
+export type Result = Omit<
+  ResultFromPrisma,
+  'createdAt' | 'prefilledVariables'
+> & { createdAt: string; prefilledVariables: VariableWithValue[] }

packages/models/src/typebot/variable.ts

@@ -3,3 +3,7 @@ export type Variable = {
   name: string
   value?: string
 }
+
+export type VariableWithValue = Omit<Variable, 'value'> & {
+  value: string
+}