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.

fix: Support new project links in the cli (#4049)

Ivan Starkovf46abe2f04ee
diff --git a/.github/actions/vercel/action.yaml b/.github/actions/vercel/action.yaml
index 3c8972711c..3a9cf705be 100644
--- a/.github/actions/vercel/action.yaml
+++ b/.github/actions/vercel/action.yaml
@@ -61,7 +61,7 @@ runs:
"framework": "remix",
"devCommand": "pnpm dev",
"installCommand": "pnpm install",
- "buildCommand": "pnpm --filter=@webstudio-is/prisma-client build:prod && pnpm --filter=@webstudio-is/builder build",
+ "buildCommand": "pnpm --filter=@webstudio-is/prisma-client build:prod && pnpm --filter=@webstudio-is/http-client build && pnpm --filter=@webstudio-is/builder build",
"outputDirectory": null,
"rootDirectory": "apps/builder",
"directoryListing": false,
diff --git a/.github/workflows/fixtures-test.yml b/.github/workflows/fixtures-test.yml
index 5448599c29..b9920971a6 100644
--- a/.github/workflows/fixtures-test.yml
+++ b/.github/workflows/fixtures-test.yml
@@ -6,6 +6,9 @@ on:
builder-url:
required: true
type: string
+ builder-host:
+ required: true
+ type: string
permissions:
contents: read # to fetch code (actions/checkout)
@@ -23,7 +26,8 @@ jobs:
env:
DATABASE_URL: postgres://
AUTH_SECRET: test
- BUILDER_URL: ${{ inputs.builder-url }}
+ BUILDER_URL_DEPRECATED: ${{ inputs.builder-url }}
+ BUILDER_HOST: ${{ inputs.builder-host }}
steps:
- uses: actions/checkout@v4
diff --git a/.github/workflows/vercel-deploy-staging.yml b/.github/workflows/vercel-deploy-staging.yml
index 363a7af694..ba79625ac6 100644
--- a/.github/workflows/vercel-deploy-staging.yml
+++ b/.github/workflows/vercel-deploy-staging.yml
@@ -77,12 +77,14 @@ jobs:
outputs:
builder-url: "https://${{ steps.vercel.outputs.alias }}.${{ matrix.environment }}.webstudio.is"
+ builder-host: "${{ steps.vercel.outputs.alias }}.${{ matrix.environment }}.webstudio.is"
fixtures-test:
needs: deployment
uses: ./.github/workflows/fixtures-test.yml
with:
builder-url: ${{ needs.deployment.outputs.builder-url }}
+ builder-host: ${{ needs.deployment.outputs.builder-host }}
delete-github-deployments:
needs: fixtures-test
diff --git a/apps/builder/app/routes/_ui.(builder).tsx b/apps/builder/app/routes/_ui.(builder).tsx
index 96995e5d2d..378cc7b89a 100644
--- a/apps/builder/app/routes/_ui.(builder).tsx
+++ b/apps/builder/app/routes/_ui.(builder).tsx
@@ -24,7 +24,7 @@ import env from "~/env/env.server";
import builderStyles from "~/builder/builder.css?url";
import prismStyles from "prismjs/themes/prism-solarizedlight.min.css?url";
import { ClientOnly } from "~/shared/client-only";
-import { parseBuilderUrl } from "~/shared/router-utils/origins";
+import { parseBuilderUrl } from "@webstudio-is/http-client";
import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
import { redirect } from "~/services/no-store-redirect";
import { builderSessionStorage } from "~/services/builder-session.server";
diff --git a/apps/builder/app/services/builder-auth.server.ts b/apps/builder/app/services/builder-auth.server.ts
index 0efc7d7d5f..db8e65bc4e 100644
--- a/apps/builder/app/services/builder-auth.server.ts
+++ b/apps/builder/app/services/builder-auth.server.ts
@@ -9,8 +9,8 @@ import {
import {
getAuthorizationServerOrigin,
getRequestOrigin,
- parseBuilderUrl,
} from "~/shared/router-utils/origins";
+import { parseBuilderUrl } from "@webstudio-is/http-client";
import { createDebug } from "~/shared/debug";
import { readAccessToken } from "./token.server";
import { isUserAuthorizedForProject } from "./builder-access.server";
diff --git a/apps/builder/app/shared/$resources/sitemap.xml.server.ts b/apps/builder/app/shared/$resources/sitemap.xml.server.ts
index 81a383623e..963d7db702 100644
--- a/apps/builder/app/shared/$resources/sitemap.xml.server.ts
+++ b/apps/builder/app/shared/$resources/sitemap.xml.server.ts
@@ -2,7 +2,7 @@ import { json } from "@remix-run/server-runtime";
import { prisma } from "@webstudio-is/prisma-client";
import { parsePages } from "@webstudio-is/project-build/index.server";
import { getStaticSiteMapXml } from "@webstudio-is/sdk";
-import { parseBuilderUrl } from "../router-utils/origins";
+import { parseBuilderUrl } from "@webstudio-is/http-client";
import { isBuilder } from "../router-utils";
/**
diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.ts
index ad5499ba83..91152126f5 100644
--- a/apps/builder/app/shared/context.server.ts
+++ b/apps/builder/app/shared/context.server.ts
@@ -12,7 +12,7 @@ import { builderAuthenticator } from "~/services/builder-auth.server";
import { readLoginSessionBloomFilter } from "~/services/session.server";
import type { BloomFilter } from "~/services/bloom-filter.server";
import { isBuilder, isCanvas, isDashboard } from "./router-utils";
-import { parseBuilderUrl } from "./router-utils/origins";
+import { parseBuilderUrl } from "@webstudio-is/http-client";
const createAuthorizationContext = async (
request: Request
diff --git a/apps/builder/app/shared/router-utils/origins.ts b/apps/builder/app/shared/router-utils/origins.ts
index a87ac74148..2ddf420d5b 100644
--- a/apps/builder/app/shared/router-utils/origins.ts
+++ b/apps/builder/app/shared/router-utils/origins.ts
@@ -1,3 +1,5 @@
+import { parseBuilderUrl } from "@webstudio-is/http-client";
+
export const getRequestOrigin = (urlStr: string) => {
const url = new URL(urlStr);
@@ -11,49 +13,6 @@ export const isCanvas = (urlStr: string): boolean => {
return projectId !== null;
};
-// For easier detecting the builder URL
-const buildProjectDomainPrefix = "p-";
-
-export const parseBuilderUrl = (urlStr: string) => {
- const url = new URL(urlStr);
-
- const fragments = url.host.split(".");
- // Regular expression to match the prefix, UUID, and any optional string after '-dot-'
- const re =
- /^(?<prefix>[a-z-]+)(?<uuid>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})(-dot-(?<branch>.*))?/;
- const match = fragments[0].match(re);
-
- // Extract prefix, projectId (UUID), and branch (if exists)
- const prefix = match?.groups?.prefix;
- const projectId = match?.groups?.uuid;
- const branch = match?.groups?.branch;
-
- if (prefix !== buildProjectDomainPrefix) {
- return {
- projectId: undefined,
- sourceOrigin: url.origin,
- };
- }
-
- if (projectId === undefined) {
- return {
- projectId: undefined,
- sourceOrigin: url.origin,
- };
- }
-
- fragments[0] = fragments[0].replace(re, branch ?? "");
-
- const sourceUrl = new URL(url.origin);
- sourceUrl.protocol = "https";
- sourceUrl.host = fragments.filter(Boolean).join(".");
-
- return {
- projectId,
- sourceOrigin: sourceUrl.origin,
- };
-};
-
export const isBuilderUrl = (urlStr: string): boolean => {
const { projectId } = parseBuilderUrl(urlStr);
return projectId !== undefined;
diff --git a/fixtures/ssg/package.json b/fixtures/ssg/package.json
index e6b53b51a5..0d092ae382 100644
--- a/fixtures/ssg/package.json
+++ b/fixtures/ssg/package.json
@@ -8,7 +8,7 @@
"dev": "vite dev",
"typecheck": "tsc",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
+ "fixtures:link": "pnpm cli link --link ${BUILDER_URL_DEPRECATED:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
"fixtures:sync": "pnpm cli sync --buildId a2e8de30-03d5-4514-a3a6-406b3266a3af && pnpm prettier --write ./.webstudio/",
"fixtures:build": "rm -rf pages && pnpm cli build --template ssg --template internal --preview && prettier --write ."
},
diff --git a/fixtures/webstudio-cloudflare-template/package.json b/fixtures/webstudio-cloudflare-template/package.json
index b5601ff5f6..3fee378575 100644
--- a/fixtures/webstudio-cloudflare-template/package.json
+++ b/fixtures/webstudio-cloudflare-template/package.json
@@ -2,7 +2,7 @@
"type": "module",
"scripts": {
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
+ "fixtures:link": "pnpm cli link --link https://p-d845c167-ea07-4875-b08d-83e97c09dcce-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
"fixtures:sync": "pnpm cli sync --buildId a2e8de30-03d5-4514-a3a6-406b3266a3af && pnpm prettier --write ./.webstudio/",
"fixtures:build": "pnpm cli build --template cloudflare --template saas-helpers --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json",
"build": "remix vite:build",
diff --git a/fixtures/webstudio-custom-template/package.json b/fixtures/webstudio-custom-template/package.json
index 85e22fa15d..e702bbb21b 100644
--- a/fixtures/webstudio-custom-template/package.json
+++ b/fixtures/webstudio-custom-template/package.json
@@ -5,7 +5,7 @@
"dev": "remix vite:dev",
"typecheck": "tsc",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/0d856812-61d8-4014-a20a-82e01c0eb8ee?authToken=d225fafb-4f20-4340-9359-c21df7c49a3f'",
+ "fixtures:link": "pnpm cli link --link https://p-0d856812-61d8-4014-a20a-82e01c0eb8ee-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=d225fafb-4f20-4340-9359-c21df7c49a3f'",
"fixtures:sync": "pnpm cli sync --buildId d48c7c5e-fdd3-4ef6-9173-ff2eaaf851d9 && pnpm prettier --write ./.webstudio/",
"fixtures:build": "pnpm cli build --template defaults --template ./custom-template --template ./custom-template-stage --template internal --preview --assets false && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"
},
diff --git a/fixtures/webstudio-remix-netlify-edge-functions/package.json b/fixtures/webstudio-remix-netlify-edge-functions/package.json
index e1d7e30a1f..8a81f72dda 100644
--- a/fixtures/webstudio-remix-netlify-edge-functions/package.json
+++ b/fixtures/webstudio-remix-netlify-edge-functions/package.json
@@ -6,7 +6,7 @@
"dev": "remix vite:dev",
"typecheck": "tsc",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
+ "fixtures:link": "pnpm cli link --link https://p-d845c167-ea07-4875-b08d-83e97c09dcce-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
"fixtures:sync": "pnpm cli sync --buildId a2e8de30-03d5-4514-a3a6-406b3266a3af && pnpm prettier --write ./.webstudio/",
"fixtures:build": "pnpm cli build --template netlify-edge-functions --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"
},
diff --git a/fixtures/webstudio-remix-netlify-functions/package.json b/fixtures/webstudio-remix-netlify-functions/package.json
index 63f3cc8b0a..50a549841c 100644
--- a/fixtures/webstudio-remix-netlify-functions/package.json
+++ b/fixtures/webstudio-remix-netlify-functions/package.json
@@ -5,7 +5,7 @@
"start": "netlify serve",
"typecheck": "tsc",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
+ "fixtures:link": "pnpm cli link --link https://p-d845c167-ea07-4875-b08d-83e97c09dcce-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
"fixtures:sync": "pnpm cli sync --buildId a2e8de30-03d5-4514-a3a6-406b3266a3af && pnpm prettier --write ./.webstudio/",
"fixtures:build": "pnpm cli build --template netlify-functions --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"
},
diff --git a/fixtures/webstudio-remix-vercel/package.json b/fixtures/webstudio-remix-vercel/package.json
index c15bf7a68e..a30463d4b3 100644
--- a/fixtures/webstudio-remix-vercel/package.json
+++ b/fixtures/webstudio-remix-vercel/package.json
@@ -5,7 +5,7 @@
"dev": "remix vite:dev",
"typecheck": "tsc",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL:-https://main.development.webstudio.is}'/builder/cddc1d44-af37-4cb6-a430-d300cf6f932d?authToken=1cdc6026-dd5b-4624-b89b-9bd45e9bcc3d'",
+ "fixtures:link": "pnpm cli link --link https://p-cddc1d44-af37-4cb6-a430-d300cf6f932d-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=1cdc6026-dd5b-4624-b89b-9bd45e9bcc3d'",
"fixtures:sync": "pnpm cli sync --buildId 0f80ffe8-7059-4577-8ef3-232f3aded028 && pnpm prettier --write ./.webstudio/",
"fixtures:build": "pnpm cli build --template vercel --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"
},
diff --git a/packages/cli/src/commands/link.ts b/packages/cli/src/commands/link.ts
index fea4c573df..5d2dd4a56b 100644
--- a/packages/cli/src/commands/link.ts
+++ b/packages/cli/src/commands/link.ts
@@ -2,6 +2,7 @@ import { cwd, exit } from "node:process";
import { join } from "node:path";
import { readFile, writeFile } from "node:fs/promises";
import { cancel, isCancel, log, text } from "@clack/prompts";
+import { parseBuilderUrl } from "@webstudio-is/http-client";
import {
GLOBAL_CONFIG_FILE,
LOCAL_CONFIG_FILE,
@@ -17,19 +18,27 @@ import type {
const parseShareLink = (value: string) => {
const url = new URL(value);
- const origin = url.origin;
+
const token = url.searchParams.get("authToken");
- // @todo parse with URLPattern once landed in node
- const segments = url.pathname.split("/").slice(1);
- if (segments.length !== 2 || segments[0] !== "builder") {
- throw Error("Segments not matching");
+
+ // eslint-disable-next-line prefer-const
+ let { projectId, sourceOrigin } = parseBuilderUrl(url.href);
+
+ if (projectId === undefined) {
+ // Support deprecated links until the end of 2024
+ const segments = url.pathname.split("/").slice(1);
+ if (segments.length !== 2 || segments[0] !== "builder") {
+ throw Error("Segments not matching");
+ }
+ projectId = segments[1];
}
- const [_builder, projectId] = segments;
+
if (token == null) {
throw Error("Token is missing");
}
+
return {
- origin,
+ origin: sourceOrigin,
projectId,
token,
};
diff --git a/packages/http-client/jest.config.js b/packages/http-client/jest.config.js
new file mode 100644
index 0000000000..e7fc137533
--- /dev/null
+++ b/packages/http-client/jest.config.js
@@ -0,0 +1 @@
+export { default } from "@webstudio-is/jest-config";
diff --git a/packages/http-client/package.json b/packages/http-client/package.json
index 4147e64f38..e737c97ef0 100644
--- a/packages/http-client/package.json
+++ b/packages/http-client/package.json
@@ -8,12 +8,15 @@
"scripts": {
"build": "rm -rf lib && esbuild src/index.ts --outdir=lib --bundle --format=esm --packages=external",
"dts": "tsc --project tsconfig.dts.json",
- "typecheck": "tsc"
+ "typecheck": "tsc",
+ "test": "NODE_OPTIONS=--experimental-vm-modules jest"
},
"dependencies": {
"@webstudio-is/sdk": "workspace:*"
},
"devDependencies": {
+ "@jest/globals": "^29.7.0",
+ "@webstudio-is/jest-config": "workspace:*",
"@webstudio-is/tsconfig": "workspace:*",
"typescript": "5.5.2"
},
@@ -23,7 +26,8 @@
"import": "./lib/index.js"
},
"files": [
- "lib/*"
+ "lib/*",
+ "!*.{test,stories}.*"
],
"license": "AGPL-3.0-or-later",
"private": false,
diff --git a/apps/builder/app/shared/router-utils/origins.test.ts b/packages/http-client/src/index.test.ts
similarity index 98%
rename from apps/builder/app/shared/router-utils/origins.test.ts
rename to packages/http-client/src/index.test.ts
index 81b650d192..6f7fd4f5de 100644
--- a/apps/builder/app/shared/router-utils/origins.test.ts
+++ b/packages/http-client/src/index.test.ts
@@ -1,5 +1,5 @@
import { expect, test } from "@jest/globals";
-import { parseBuilderUrl } from "./origins";
+import { parseBuilderUrl } from "./index";
test("parseBuilderUrl wstd.dev", async () => {
expect(
diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts
index 1660a42918..6507e626ec 100644
--- a/packages/http-client/src/index.ts
+++ b/packages/http-client/src/index.ts
@@ -119,3 +119,46 @@ export const getLatestBuildUsingProjectId = async (params: {
const message = await response.text();
throw new Error(message.slice(0, 1000));
};
+
+// For easier detecting the builder URL
+const buildProjectDomainPrefix = "p-";
+
+export const parseBuilderUrl = (urlStr: string) => {
+ const url = new URL(urlStr);
+
+ const fragments = url.host.split(".");
+ // Regular expression to match the prefix, UUID, and any optional string after '-dot-'
+ const re =
+ /^(?<prefix>[a-z-]+)(?<uuid>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})(-dot-(?<branch>.*))?/;
+ const match = fragments[0].match(re);
+
+ // Extract prefix, projectId (UUID), and branch (if exists)
+ const prefix = match?.groups?.prefix;
+ const projectId = match?.groups?.uuid;
+ const branch = match?.groups?.branch;
+
+ if (prefix !== buildProjectDomainPrefix) {
+ return {
+ projectId: undefined,
+ sourceOrigin: url.origin,
+ };
+ }
+
+ if (projectId === undefined) {
+ return {
+ projectId: undefined,
+ sourceOrigin: url.origin,
+ };
+ }
+
+ fragments[0] = fragments[0].replace(re, branch ?? "");
+
+ const sourceUrl = new URL(url.origin);
+ sourceUrl.protocol = "https";
+ sourceUrl.host = fragments.filter(Boolean).join(".");
+
+ return {
+ projectId,
+ sourceOrigin: sourceUrl.origin,
+ };
+};
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 86cf1049a8..b52d569a4b 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1498,6 +1498,12 @@ importers:
specifier: workspace:*
version: link:../sdk
devDependencies:
+ '@jest/globals':
+ specifier: ^29.7.0
+ version: 29.7.0
+ '@webstudio-is/jest-config':
+ specifier: workspace:*
+ version: link:../jest-config
'@webstudio-is/tsconfig':
specifier: workspace:*
version: link:../tsconfig