feat: move env vars from build-time to run-time #789

ShubhamPalriwala · 2023-09-08T13:40:38Z

What does this PR do?

Shifts a set ( SignUp and SignIn ) related environment variables from Build-time configuration to Run-time configuration! This will allow users to edit these, now, in their docker/runtiem env itself instead of needing to build the image from source.

This is possible because we now parse the env var in server side pages and pass them as a prop to the child components who are client side!

Warning: We need to update our env variables of the hosted app as well!

This PR migrates:

EMAIL_VERIFICATION_DISABLED
PASSWORD_RESET_DISABLED
SIGNUP_DISABLED
INVITE_DISABLED
PRIVACY_URL
TERMS_URL
IMPRINT_URL
GITHUB_AUTH_ENABLED
GOOGLE_AUTH_ENABLED
WEBAPP_URL
IS_FORMBRICKS_CLOUD
SURVEY_BASE_URL

Have updated the documentation as well!

Migration Guide

Type of change

Enhancement (small improvements)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist

…ding

vercel · 2023-09-08T13:40:45Z

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

Name	Status	Preview	Comments	Updated (UTC)
formbricks-cloud	❌ Failed (Inspect)			Sep 30, 2023 6:31pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
formbricks-com	⬜️ Ignored (Inspect)	Visit Preview		Sep 30, 2023 6:31pm

github-actions · 2023-09-08T13:40:52Z

Thank you for following the naming conventions for pull request titles! 🙏

github-actions · 2023-09-08T13:52:28Z

📦 Next.js Bundle Analysis for @formbricks/web

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

This PR introduced no changes to the JavaScript bundle! 🙌

mattinannt

@ShubhamPalriwala looks great 😊💪 I added a few comments, let's chat about it or if they make sense please implement the changes.
Also please pull the latest changes from main and solve the merge conflicts 😊

mattinannt · 2023-09-15T15:17:11Z

packages/lib/constants.ts

-  HEROKU_URL ||
-  RENDER_URL ||
-  "http://localhost:3000";
+export const WEBAPP_URL = process.env.WEBAPP_URL || "http://localhost:3000";


I now remember that the VERCEL_URL makes sense here due to get Formbricks working in a Vercel preview deployment where URLs change with every deployment. Only with VERCEL_URL we are able to set this correctly.

export const WEBAPP_URL = process.env.WEBAPP_URL || VERCEL_URL || "http://localhost:3000";

oo nice, done!

mattinannt · 2023-09-15T15:21:43Z

apps/web/app/(auth)/auth/login/page.tsx

@@ -9,14 +10,24 @@ export const metadata: Metadata = {
 };

 export default function SignInPage() {
+  const publicSignUpEnabled = env.SIGNUP_DISABLED !== "1";


Would it maybe make sense to move the definition of the variables, e.g.
const publicSignUpEnabled = env.SIGNUP_DISABLED !== "1";
to the constants.ts file so we don't have to make these comparisons all over again?
But then we need to make sure that they are not imported variables are on the server.

what would you think about a constants-server.ts file with the import of the server-only package to prevent importing them at the client and moving all the server side environment variables/constants there?

that's a nice idea!

Also, the "use server" will not work bec it only allows exporting async functions and not const vals. Remember facing this issue when we were trying to export an interface from a service file!

Update, I took a different approach and instead of having a separate constants file, I imported all those env vars into server components and passed them as props to child client components! 😎

I meant the server-only package as described here:
https://nextjs.org/docs/app/building-your-application/rendering/composition-patterns#keeping-server-only-code-out-of-the-client-environment

oh okay, my bad, done!

…shubham/for-1254-try-moving-build-time-vars-to-runtime

…into shubham/for-1254-try-moving-build-time-vars-to-runtime

…f-hosting environments (formbricks#789) * feat: privacy, imprint, and terms URL env vars now do not need rebuilding * feat: disable_singup env var now do not need rebuilding * feat: password_reset_disabled env var now do not need rebuilding * feat: email_verification_disabled env var now do not need rebuilding * feat: github_oauth & google_oauth env var now do not need rebuilding * feat: move logic of env vars to serverside and send boolean client-side * feat: invite_disabled env var now do not need rebuilding * feat: rename vars logically * feat: migration guide * feat: update docker-compose as per v1.1 * deprecate: unused NEXT_PUBLIC_VERCEL_URL & VERCEL_URL * deprecate: unused RAILWAY_STATIC_URL * deprecate: unused RENDER_EXTERNAL_URL * deprecate: unused HEROKU_APP_NAME * fix: define WEBAPP_URL & replace NEXT_WEBAPP_URL with it * migrate: NEXT_PUBLIC_IS_FORMBRICKS_CLOUD to IS_FORMBRICKS_CLOUD * chore: move all env parsing to a constants.ts from page files * feat: migrate client side envs to server side * redo: isFormbricksCloud to navbar serverside page * fix: constants is now a server only file * fix: removal of use swr underway * fix: move 1 tag away from swr to service * feat: move away from tags swr * feat: move away from surveys swr * feat: move away from eventClass swr * feat: move away from event swr * fix: make constants server-only * remove comments from .env.example, use constants in MetaInformation * clean up services * rename tag function * fix build error * fix smaller bugs, fix Response % not working in summary --------- Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>

ShubhamPalriwala added 8 commits September 8, 2023 16:15

feat: privacy, imprint, and terms URL env vars now do not need rebuil…

afd5b0a

…ding

feat: disable_singup env var now do not need rebuilding

fd2f083

feat: password_reset_disabled env var now do not need rebuilding

795d277

feat: email_verification_disabled env var now do not need rebuilding

8868549

feat: github_oauth & google_oauth env var now do not need rebuilding

191eefb

feat: move logic of env vars to serverside and send boolean client-side

a30be23

feat: invite_disabled env var now do not need rebuilding

1fdda3f

feat: rename vars logically

443cf39

github-actions bot added the ❗️ .env changes label Sep 8, 2023

vercel bot deployed to Preview – formbricks-cloud September 8, 2023 13:41 View deployment

ShubhamPalriwala added 2 commits September 11, 2023 08:54

feat: migration guide

d8b09b9

feat: update docker-compose as per v1.1

1c09714

vercel bot deployed to Preview – formbricks-cloud September 11, 2023 03:34 View deployment

ShubhamPalriwala added 6 commits September 11, 2023 09:09

deprecate: unused NEXT_PUBLIC_VERCEL_URL & VERCEL_URL

6294c3e

deprecate: unused RAILWAY_STATIC_URL

cd953c5

deprecate: unused RENDER_EXTERNAL_URL

20cbd68

deprecate: unused HEROKU_APP_NAME

0dd5821

fix: define WEBAPP_URL & replace NEXT_WEBAPP_URL with it

9d88bff

migrate: NEXT_PUBLIC_IS_FORMBRICKS_CLOUD to IS_FORMBRICKS_CLOUD

a442832

vercel bot had a problem deploying to Preview – formbricks-cloud September 11, 2023 13:36 Failure

mattinannt added this to the v1.1.0 milestone Sep 12, 2023

mattinannt reviewed Sep 15, 2023

View reviewed changes

ShubhamPalriwala added 2 commits September 16, 2023 13:54

chore: move all env parsing to a constants.ts from page files

9dfc973

feat: migrate client side envs to server side

4784fc6

vercel bot had a problem deploying to Preview – formbricks-cloud September 16, 2023 09:22 Failure

ShubhamPalriwala added 2 commits September 16, 2023 15:01

Merge branch 'main' of https://github.com/formbricks/formbricks into …

006e38b

…shubham/for-1254-try-moving-build-time-vars-to-runtime

redo: isFormbricksCloud to navbar serverside page

6dda347

wip & Merge branch 'main' of https://github.com/formbricks/formbricks …

9f26686

…into shubham/for-1254-try-moving-build-time-vars-to-runtime

ShubhamPalriwala force-pushed the shubham/for-1254-try-moving-build-time-vars-to-runtime branch from 81c4fac to 9f26686 Compare September 26, 2023 12:36

vercel bot had a problem deploying to Preview – formbricks-cloud September 26, 2023 13:44 Failure

ShubhamPalriwala added 7 commits September 27, 2023 16:15

fix: removal of use swr underway

5e5b695

fix: move 1 tag away from swr to service

619c1bd

feat: move away from tags swr

6db3082

feat: move away from surveys swr

a12e0d8

feat: move away from eventClass swr

cf84b92

feat: move away from event swr

2153271

fix: make constants server-only

70dd62b

vercel bot had a problem deploying to Preview – formbricks-cloud September 28, 2023 09:27 Failure

solve merge conflicts

770cb06

vercel bot had a problem deploying to Preview – formbricks-cloud September 28, 2023 15:54 Failure

remove comments from .env.example, use constants in MetaInformation

04e566c

vercel bot had a problem deploying to Preview – formbricks-cloud September 28, 2023 16:14 Failure

clean up services

e002462

vercel bot had a problem deploying to Preview – formbricks-cloud September 28, 2023 16:28 Failure

mattinannt added 2 commits September 30, 2023 17:55

rename tag function

347ad8c

fix build error

1d9ba96

vercel bot had a problem deploying to Preview – formbricks-cloud September 30, 2023 16:09 Failure

merge latest changes, solve merge conflicts, solve linting warnings

36a639f

vercel bot had a problem deploying to Preview – formbricks-cloud September 30, 2023 16:27 Failure

fix smaller bugs, fix Response % not working in summary

a686b2c

vercel bot had a problem deploying to Preview – formbricks-cloud September 30, 2023 18:30 Failure

mattinannt approved these changes Sep 30, 2023

View reviewed changes

mattinannt merged commit 13afba7 into main Sep 30, 2023
10 of 12 checks passed

mattinannt deleted the shubham/for-1254-try-moving-build-time-vars-to-runtime branch September 30, 2023 19:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: move env vars from build-time to run-time #789

feat: move env vars from build-time to run-time #789

ShubhamPalriwala commented Sep 8, 2023 •

edited

Loading

vercel bot commented Sep 8, 2023 •

edited

Loading

github-actions bot commented Sep 8, 2023 •

edited

Loading

github-actions bot commented Sep 8, 2023

mattinannt left a comment

mattinannt Sep 15, 2023

ShubhamPalriwala Sep 16, 2023

mattinannt Sep 15, 2023

ShubhamPalriwala Sep 16, 2023

mattinannt Sep 16, 2023

ShubhamPalriwala Sep 16, 2023

feat: move env vars from build-time to run-time #789

feat: move env vars from build-time to run-time #789

Conversation

ShubhamPalriwala commented Sep 8, 2023 • edited Loading

What does this PR do?

Migration Guide

Type of change

Checklist

vercel bot commented Sep 8, 2023 • edited Loading

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

github-actions bot commented Sep 8, 2023

📦 Next.js Bundle Analysis for @formbricks/web

mattinannt left a comment

Choose a reason for hiding this comment

mattinannt Sep 15, 2023

Choose a reason for hiding this comment

ShubhamPalriwala Sep 16, 2023

Choose a reason for hiding this comment

mattinannt Sep 15, 2023

Choose a reason for hiding this comment

ShubhamPalriwala Sep 16, 2023

Choose a reason for hiding this comment

mattinannt Sep 16, 2023

Choose a reason for hiding this comment

ShubhamPalriwala Sep 16, 2023

Choose a reason for hiding this comment

ShubhamPalriwala commented Sep 8, 2023 •

edited

Loading

vercel bot commented Sep 8, 2023 •

edited

Loading

github-actions bot commented Sep 8, 2023 •

edited

Loading