Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

build: Move build time env vars in env.static (#3183)

Ivan Starkov393cc90612f3
diff --git a/.github/actions/vercel/action.yaml b/.github/actions/vercel/action.yaml
index a07451a37f..c9f1ba7473 100644
--- a/.github/actions/vercel/action.yaml
+++ b/.github/actions/vercel/action.yaml
@@ -73,6 +73,9 @@ runs:
- name: Build
run: |
+ export GITHUB_SHA=${{ inputs.sha }}
+ export GITHUB_REF_NAME=${{ inputs.ref-name }}
+
vercel build
shell: bash
@@ -82,10 +85,6 @@ runs:
vercel deploy \
--prebuilt \
--token ${{ inputs.vercel-token }} \
- --env SHORT_SHA=${{ steps.short_sha.outputs.value }} \
- --env BRANCH_NAME=${{ inputs.ref-name }} \
- --meta GITHUB_SHA=${{ inputs.sha }} \
- --meta GITHUB_REF_NAME=${{ steps.branch.outputs.value }} \
2> >(tee info.txt >&2) | tee domain.txt
echo "domain=$(cat ./domain.txt)" >> $GITHUB_OUTPUT
diff --git a/apps/builder/app/env/env.server.ts b/apps/builder/app/env/env.server.ts
index 71550d2f30..f28150e34c 100644
--- a/apps/builder/app/env/env.server.ts
+++ b/apps/builder/app/env/env.server.ts
@@ -20,9 +20,6 @@ const env = {
PORT: process.env.PORT,
- // Preview support
- BRANCH_NAME: process.env.BRANCH_NAME,
-
// Assets
MAX_UPLOAD_SIZE: process.env.MAX_UPLOAD_SIZE,
MAX_ASSETS_PER_PROJECT: process.env.MAX_ASSETS_PER_PROJECT,
@@ -109,9 +106,6 @@ if (process.env.VERCEL !== undefined) {
if (env.DEPLOYMENT_URL === undefined) {
env.DEPLOYMENT_URL = process.env.VERCEL_URL;
}
- if (env.BRANCH_NAME === undefined) {
- env.BRANCH_NAME = process.env.VERCEL_GIT_COMMIT_REF;
- }
}
export default env;
diff --git a/apps/builder/app/env/env.static.server.ts b/apps/builder/app/env/env.static.server.ts
new file mode 100644
index 0000000000..85963604df
--- /dev/null
+++ b/apps/builder/app/env/env.static.server.ts
@@ -0,0 +1,12 @@
+/**
+ * Build-time Environment Variables
+ *
+ * These variables are injected into your bundle at build time based on the environment settings.
+ * - Configuration: See envPrefix in [vite.config.ts](../../vite.config.ts) (GITHUB_)
+ * - Documentation: Refer to the [Vite documentation](https://vitejs.dev/guide/env-and-mode)
+ * - Type Definitions: See [vite-env.d.ts](./vite-env.d.ts) in this directory
+ */
+export const staticEnv = {
+ GITHUB_REF_NAME: import.meta.env.GITHUB_REF_NAME,
+ GITHUB_SHA: import.meta.env.GITHUB_SHA,
+};
diff --git a/apps/builder/app/env/vite-env.d.ts b/apps/builder/app/env/vite-env.d.ts
new file mode 100644
index 0000000000..db9bd03fe2
--- /dev/null
+++ b/apps/builder/app/env/vite-env.d.ts
@@ -0,0 +1,4 @@
+interface ImportMetaEnv {
+ readonly GITHUB_REF_NAME: string | undefined;
+ readonly GITHUB_SHA: string | undefined;
+}
diff --git a/apps/builder/app/routes/builder.$projectId.tsx b/apps/builder/app/routes/builder.$projectId.tsx
index 171324f6fb..9f520238df 100644
--- a/apps/builder/app/routes/builder.$projectId.tsx
+++ b/apps/builder/app/routes/builder.$projectId.tsx
@@ -23,6 +23,7 @@ import { ErrorMessage } from "~/shared/error";
import { loginPath } from "~/shared/router-utils";
import { type BuilderProps, Builder, links } from "~/builder";
import env from "~/env/env.server";
+import { staticEnv } from "~/env/env.static.server";
export { links };
@@ -30,6 +31,9 @@ export const loader = async ({
params,
request,
}: LoaderFunctionArgs): Promise<BuilderProps> => {
+ // TODO: remove after release 17 apr 2024
+ console.info({ staticEnv });
+
const context = await createContext(request);
try {
diff --git a/apps/builder/app/services/trpc.server.ts b/apps/builder/app/services/trpc.server.ts
index 6a9f221a8b..8052efb032 100644
--- a/apps/builder/app/services/trpc.server.ts
+++ b/apps/builder/app/services/trpc.server.ts
@@ -1,16 +1,17 @@
import { createTrpcProxyServiceClient } from "@webstudio-is/trpc-interface/index.server";
import env from "~/env/env.server";
+import { staticEnv } from "~/env/env.static.server";
const TRPC_SERVER_URL = env.TRPC_SERVER_URL ?? "";
const TRPC_SERVER_API_TOKEN = env.TRPC_SERVER_API_TOKEN ?? "";
-const BRANCH_NAME = env.BRANCH_NAME;
+const GITHUB_REF_NAME = staticEnv.GITHUB_REF_NAME;
export const trpcSharedClient = createTrpcProxyServiceClient(
TRPC_SERVER_URL !== "" && TRPC_SERVER_API_TOKEN !== ""
? {
url: TRPC_SERVER_URL,
token: TRPC_SERVER_API_TOKEN,
- branchName: BRANCH_NAME,
+ branchName: GITHUB_REF_NAME,
}
: undefined
);
diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.ts
index 88ebbb89aa..bb7de93227 100644
--- a/apps/builder/app/shared/context.server.ts
+++ b/apps/builder/app/shared/context.server.ts
@@ -8,6 +8,7 @@ import {
getUserPlanFeatures,
} from "./db/user-plan-features.server";
import { getAllApprovedProjectIds } from "./marketplace/db.server";
+import { staticEnv } from "~/env/env.static.server";
const createAuthorizationContext = async (
request: Request
@@ -62,7 +63,8 @@ const createDeploymentContext = (request: Request) => {
deploymentTrpc: trpcSharedClient.deployment,
env: {
BUILDER_ORIGIN: `${getRequestOrigin(request)}`,
- BRANCH_NAME: env.BRANCH_NAME ?? "main",
+ GITHUB_REF_NAME: staticEnv.GITHUB_REF_NAME ?? "undefined",
+ GITHUB_SHA: staticEnv.GITHUB_SHA ?? undefined,
},
};
diff --git a/apps/builder/vite.config.ts b/apps/builder/vite.config.ts
index 2946a48708..acbc9bba6f 100644
--- a/apps/builder/vite.config.ts
+++ b/apps/builder/vite.config.ts
@@ -21,4 +21,5 @@ export default defineConfig(({ mode }) => ({
ssr: {
external: ["@webstudio-is/prisma-client"],
},
+ envPrefix: "GITHUB_",
}));
diff --git a/packages/domain/src/trpc/domain.ts b/packages/domain/src/trpc/domain.ts
index 3bc647a002..4e54d102a8 100644
--- a/packages/domain/src/trpc/domain.ts
+++ b/packages/domain/src/trpc/domain.ts
@@ -61,10 +61,11 @@ export const domainRouter = router({
const result = deploymentTrpc.publish.mutate({
// used to load build data from the builder see routes/rest.build.$buildId.ts
- builderApiOrigin: env.BUILDER_ORIGIN,
+ builderOrigin: env.BUILDER_ORIGIN,
+ githubSha: env.GITHUB_SHA,
buildId: build.id,
// preview support
- branchName: env.BRANCH_NAME,
+ branchName: env.GITHUB_REF_NAME,
// action log helper (not used for deployment, but for action logs readablity)
projectDomainName: project.domain,
});
diff --git a/packages/trpc-interface/src/context/context.server.ts b/packages/trpc-interface/src/context/context.server.ts
index 09655f2ac9..418a0c2c5f 100644
--- a/packages/trpc-interface/src/context/context.server.ts
+++ b/packages/trpc-interface/src/context/context.server.ts
@@ -46,7 +46,8 @@ type DeploymentContext = {
deploymentTrpc: TrpcInterfaceClient["deployment"];
env: {
BUILDER_ORIGIN: string;
- BRANCH_NAME: string;
+ GITHUB_REF_NAME: string;
+ GITHUB_SHA: string | undefined;
};
};
diff --git a/packages/trpc-interface/src/shared/deployment.ts b/packages/trpc-interface/src/shared/deployment.ts
index 383acecfcc..213feec76b 100644
--- a/packages/trpc-interface/src/shared/deployment.ts
+++ b/packages/trpc-interface/src/shared/deployment.ts
@@ -4,7 +4,9 @@ import { router, procedure } from "./trpc";
const PublishInput = z.object({
// used to load build data from the builder see routes/rest.build.$buildId.ts
buildId: z.string(),
- builderApiOrigin: z.string(),
+ builderOrigin: z.string(),
+ githubSha: z.string().optional(),
+
// preview support
branchName: z.string(),
// action log helper (not used for deployment, but for action logs readablity)