feat: integrate formbricks in help feedback box #12276

ShubhamPalriwala · 2023-11-08T05:09:07Z

What does this PR do?

The Help Feedback Box currently sends the data to our email service. This PR sends it to a pre-created Formbricks Survey for easier visibility and availability in the Formbricks App.

We use the @formbricks/api package for minimal dependencies and create a response in the app.

Requirement/Documentation

We introduce 2 new environment variables that needs to be set:

FORMBRICKS in the form of [apiHost]+[environmentId]
FORMBRICKS_FEEDBACK_SURVEY_ID in the form of surveyId

For testing, use:

FORMBRICKS=https://app.formbricks.com+cloob69in56synz0fg6l5vqmx
FORMBRICKS_FEEDBACK_SURVEY_ID=cloob6fn356u0nz0fl0mm1wa5

Before merging to main,

Create a Survey on Formbricks
Create 2 questions (1 Open Text with Question ID as: formbricks-share-comments-question and 1 Rating question with Range of 4 and ID as formbricks-rating-question )

Type of change

New feature (non-breaking change which adds functionality)

How should this be tested?

Set the env variable as suggested above
Fill the Feedback Box inside the Help Button
View in the Formbricks App and the response should be reflected

Mandatory Tasks

Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.

vercel · 2023-11-08T05:09:13Z

@ShubhamPalriwala is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

CLAassistant · 2023-11-08T05:09:14Z

All committers have signed the CLA.

github-actions · 2023-11-08T05:09:19Z

Thank you for following the naming conventions! 🙏 Feel free to join our discord and post your PR link.

github-actions · 2023-11-08T05:17:18Z

📦 Next.js Bundle Analysis for @calcom/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

socket-security · 2023-11-08T05:19:21Z

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@formbricks/api	1.4.0	network	`+0`	102 kB	matthiasnannt

PeerRich

looks very good and minimal, will try today!

PeerRich · 2023-11-08T09:23:45Z

lets also add userid and email

PeerRich · 2023-11-08T09:32:02Z

added .env to both prod and staging, added formbricks survey with the question ID

PeerRich · 2023-11-08T09:32:36Z

.env.example

@@ -119,6 +119,12 @@ NEXT_PUBLIC_SENDGRID_SENDER_NAME=
 # Used for capturing exceptions and logging messages
 NEXT_PUBLIC_SENTRY_DSN=

+# Formbricks Experience Management Integration
+# [apiHost]+[environmentId]
+FORMBRICKS=


does this have to be FORMBRICKS or NEXT_PUBLIC_FORMBRICKS ?

vercel · 2023-11-08T09:38:04Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
cal	⬜️ Ignored (Inspect)	Visit Preview		Nov 8, 2023 9:38am

alishaz-polymath

Tested, works!
NIT: We could also add userId and/or email as a hidden field (auto-populates internally).

Thank you for your contribution 🚀

ShubhamPalriwala · 2023-11-09T08:55:24Z

Hey, thanks for the quick reviews and testing! Glad it works for everyone 🚀
We're currently updating our API endpoint to support the linking of userId and email as well via the API. Will ping the reviewers here once the PR is again ready for review

PeerRich · 2023-11-09T10:43:25Z

draft until API is ready for userID and email

PeerRich

env and keys added to vercel prod

zomars · 2023-11-16T18:26:04Z

.env.example

@@ -120,6 +120,12 @@ NEXT_PUBLIC_SENDGRID_SENDER_NAME=
 # Used for capturing exceptions and logging messages
 NEXT_PUBLIC_SENTRY_DSN=

+# Formbricks Experience Management Integration
+# [apiHost]+[environmentId]
+FORMBRICKS=


Not quite since is used on the server only. But I would go with something more descriptive.

Suggested change

FORMBRICKS=

FORMBRICKS_URL=

zomars

Thank you for your contribution 🙏

Quick note. Let's prioritize legibility over clever code in this case. Left some suggestions to address.

.env.example

packages/lib/formbricks.ts

packages/trpc/server/routers/loggedInViewer/submitFeedback.handler.ts

turbo.json

PeerRich · 2023-11-22T12:01:03Z

.env.example

@@ -120,6 +120,11 @@ NEXT_PUBLIC_SENDGRID_SENDER_NAME=
 # Used for capturing exceptions and logging messages
 NEXT_PUBLIC_SENTRY_DSN=

+# Formbricks Experience Management Integration
+FORMBRICKS_HOST_URL=


Suggested change

FORMBRICKS_HOST_URL=

FORMBRICKS_HOST_URL="https://app.formbricks.com"

done

ShubhamPalriwala · 2023-11-22T12:09:52Z

update, discussed with @mattinannt and restructuring things a bit

… username to formbricks person object

ShubhamPalriwala · 2023-11-22T12:31:01Z

Hey team, pushed the latest commit. Now,

Feedback is submitted as a response to Formbricks
A person is created in Formbricks when a feedback is submitted with the ID of cal's user.id & attached to the response
Person gets their attributes to have an email field as well as a username field that has both values from cal for easier filtering and identification
Also updated the env example as suggested above

mattinannt · 2023-11-22T13:25:30Z

@PeerRich During our testing, we discovered a potential security issue with the Formbricks API updates we pushed to enable this PR. We will update you as soon as this is fixed. You can review this before then, but please don't merge yet.

mattinannt · 2023-11-27T17:20:11Z

@PeerRich We fixed the issues, re-tested the PR and it's now ready for review 😊

zomars

zomars · 2023-12-11T20:42:50Z

We need to fix types tho

zomars

Type checks are failing

ShubhamPalriwala · 2023-12-12T03:03:04Z

Thanks for the feedback @zomars, I've made the type fixes (apologies for overlooking it) and tested the flow again 💪🏼
cc: @PeerRich

review again please

github-actions bot added the ❗️ .env changes contains changes to env variables label Nov 8, 2023

PeerRich requested review from joeauyeung and alishaz-polymath November 8, 2023 09:20

PeerRich approved these changes Nov 8, 2023

View reviewed changes

PeerRich reviewed Nov 8, 2023

View reviewed changes

alishaz-polymath previously approved these changes Nov 8, 2023

View reviewed changes

alishaz-polymath self-requested a review November 9, 2023 08:59

PeerRich marked this pull request as draft November 9, 2023 10:43

PeerRich marked this pull request as ready for review November 11, 2023 11:17

PeerRich previously approved these changes Nov 11, 2023

View reviewed changes

PeerRich enabled auto-merge (squash) November 12, 2023 17:19

PeerRich dismissed stale reviews from alishaz-polymath and themself via 778a1cd November 16, 2023 13:09

zomars reviewed Nov 16, 2023

View reviewed changes

zomars previously requested changes Nov 16, 2023

View reviewed changes

.env.example Outdated Show resolved Hide resolved

packages/lib/formbricks.ts Outdated Show resolved Hide resolved

packages/trpc/server/routers/loggedInViewer/submitFeedback.handler.ts Outdated Show resolved Hide resolved

turbo.json Outdated Show resolved Hide resolved

zomars added the Low priority Created by Linear-GitHub Sync label Nov 16, 2023

auto-merge was automatically disabled November 22, 2023 10:47
Head branch was pushed to by a user without write access

ShubhamPalriwala and others added 3 commits November 22, 2023 16:49

feat: integrate formbricks in help feedback box

6c9ec50

Update yarn.lock

b8a2c89

Update yarn.lock

1e0239a

PeerRich reviewed Nov 22, 2023

View reviewed changes

feat: link cal and formbricks user.id and add attributes of email and…

c8dd0fa

… username to formbricks person object

PeerRich and others added 3 commits December 11, 2023 12:33

Update yarn.lock

82a42cf

Update yarn.lock

3efc449

Merge branch 'main' into use-formbricks-in-help-box-feedback

5d5b36b

PeerRich previously approved these changes Dec 11, 2023

View reviewed changes

zomars approved these changes Dec 11, 2023

View reviewed changes

zomars previously requested changes Dec 11, 2023

View reviewed changes

ShubhamPalriwala added 2 commits December 12, 2023 08:11

Merge branch 'main' into use-formbricks-in-help-box-feedback

0cb8dc8

fix: type safety in enums

98825bf

ShubhamPalriwala dismissed PeerRich’s stale review via 98825bf December 12, 2023 02:54

ShubhamPalriwala and others added 3 commits December 15, 2023 14:41

Merge branch 'main' into use-formbricks-in-help-box-feedback

8eea1b6

Merge branch 'main' into use-formbricks-in-help-box-feedback

f36237c

Merge branch 'main' into use-formbricks-in-help-box-feedback

f0c5325

PeerRich added 4 commits December 28, 2023 17:29

Merge branch 'main' into use-formbricks-in-help-box-feedback

f5a0482

Merge branch 'main' into use-formbricks-in-help-box-feedback

084c04d

Merge branch 'main' into use-formbricks-in-help-box-feedback

0726e38

Merge branch 'main' into use-formbricks-in-help-box-feedback

70d7168

PeerRich approved these changes Dec 31, 2023

View reviewed changes

Merge branch 'main' into use-formbricks-in-help-box-feedback

fa67e97

PeerRich enabled auto-merge (squash) January 2, 2024 13:59

PeerRich merged commit f848a44 into calcom:main Jan 2, 2024
14 of 23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: integrate formbricks in help feedback box #12276

feat: integrate formbricks in help feedback box #12276

ShubhamPalriwala commented Nov 8, 2023 •

edited by PeerRich

Loading

vercel bot commented Nov 8, 2023

CLAassistant commented Nov 8, 2023 •

edited

Loading

github-actions bot commented Nov 8, 2023 •

edited

Loading

github-actions bot commented Nov 8, 2023 •

edited

Loading

socket-security bot commented Nov 8, 2023 •

edited

Loading

PeerRich left a comment

PeerRich commented Nov 8, 2023

PeerRich commented Nov 8, 2023

PeerRich Nov 8, 2023 •

edited

Loading

vercel bot commented Nov 8, 2023 •

edited

Loading

alishaz-polymath left a comment

ShubhamPalriwala commented Nov 9, 2023

PeerRich commented Nov 9, 2023 •

edited

Loading

PeerRich left a comment

zomars Nov 16, 2023

zomars left a comment

PeerRich Nov 22, 2023 •

edited

Loading

ShubhamPalriwala commented Nov 22, 2023

ShubhamPalriwala commented Nov 22, 2023

mattinannt commented Nov 22, 2023

mattinannt commented Nov 27, 2023

zomars left a comment

zomars commented Dec 11, 2023

zomars left a comment

ShubhamPalriwala commented Dec 12, 2023

	FORMBRICKS_HOST_URL=
	FORMBRICKS_HOST_URL="https://app.formbricks.com"

feat: integrate formbricks in help feedback box #12276

feat: integrate formbricks in help feedback box #12276

Conversation

ShubhamPalriwala commented Nov 8, 2023 • edited by PeerRich Loading

What does this PR do?

Requirement/Documentation

Type of change

How should this be tested?

Mandatory Tasks

vercel bot commented Nov 8, 2023

CLAassistant commented Nov 8, 2023 • edited Loading

github-actions bot commented Nov 8, 2023 • edited Loading

github-actions bot commented Nov 8, 2023 • edited Loading

📦 Next.js Bundle Analysis for @calcom/web

socket-security bot commented Nov 8, 2023 • edited Loading

PeerRich left a comment

Choose a reason for hiding this comment

PeerRich commented Nov 8, 2023

PeerRich commented Nov 8, 2023

PeerRich Nov 8, 2023 • edited Loading

Choose a reason for hiding this comment

vercel bot commented Nov 8, 2023 • edited Loading

alishaz-polymath left a comment

Choose a reason for hiding this comment

ShubhamPalriwala commented Nov 9, 2023

PeerRich commented Nov 9, 2023 • edited Loading

PeerRich left a comment

Choose a reason for hiding this comment

zomars Nov 16, 2023

Choose a reason for hiding this comment

zomars left a comment

Choose a reason for hiding this comment

PeerRich Nov 22, 2023 • edited Loading

Choose a reason for hiding this comment

ShubhamPalriwala commented Nov 22, 2023

ShubhamPalriwala commented Nov 22, 2023

mattinannt commented Nov 22, 2023

mattinannt commented Nov 27, 2023

zomars left a comment

Choose a reason for hiding this comment

zomars commented Dec 11, 2023

zomars left a comment

Choose a reason for hiding this comment

ShubhamPalriwala commented Dec 12, 2023

ShubhamPalriwala commented Nov 8, 2023 •

edited by PeerRich

Loading

CLAassistant commented Nov 8, 2023 •

edited

Loading

github-actions bot commented Nov 8, 2023 •

edited

Loading

github-actions bot commented Nov 8, 2023 •

edited

Loading

socket-security bot commented Nov 8, 2023 •

edited

Loading

PeerRich Nov 8, 2023 •

edited

Loading

vercel bot commented Nov 8, 2023 •

edited

Loading

PeerRich commented Nov 9, 2023 •

edited

Loading

PeerRich Nov 22, 2023 •

edited

Loading