From 7fe59bf42d417d690d7175af6a91a3d3d008db56 Mon Sep 17 00:00:00 2001 From: Rashad Karanouh <11599358+rashad@users.noreply.github.com> Date: Tue, 28 Jul 2026 11:46:14 +0200 Subject: [PATCH] feat(website): send the referring partner with a client brief (#23351) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Pairs with #23344** (`twenty-partners` v1.4.1), which adds the `referredByPartner` relation and the Discord notification. This PR is the sender; that one is the receiver. **Merge #23344 first.** Its schema is a non-strict `z.object`, so an unknown `partnerSlug` is stripped rather than rejected — shipping this one first degrades silently (attribution dropped) rather than breaking, but there is no reason to. Until #23344 is deployed, this field goes nowhere. No dependency in the other direction and no shared files: #23344 is entirely inside `packages/twenty-apps`, this is entirely inside `packages/twenty-website`. ## What this does A visitor can reach the client brief form from two places: the marketplace listing page, or a specific partner's profile. Until now both produced an identical payload, so the partner whose page drove the lead was lost. This sends the partner's slug along with the brief when the form was opened from a profile page. #23344 resolves it to a Partner record and links it to the created Opportunity. ## How it flows `PartnerProfileCtas` links to `/partners/brief?partner=` → `page.tsx` reads and normalizes the param → prop threaded through `ClientBriefPageContent` → `ClientBriefWizard` → `buildClientBriefRequestBody`. The slug is inert context, never a form field, so the wizard reducer and `ClientBriefState` are untouched. The three CTAs on `/partners/list` (`MarketplaceHeader`, `MarketplaceMatchCard`, `MarketplaceBriefPrompt`) stay bare — a brief from the listing page has no referring partner, and the notification labels it "Marketplace listing". ## Why `normalizePartnerSlug` exists `clientBriefRequestSchema` is a `z.strictObject`. Forwarding a malformed `?partner=` value straight into the body would fail validation for the **entire request** and lose the brief — a bad trade for an attribution field the visitor never saw. So the param is normalized at the boundary: array-valued params take the first entry, and anything not matching `[a-z0-9-]{1,100}` is dropped to `undefined` rather than passed on. The charset mirrors the app's `slugify` helper, which is what produced the slugs in the first place. ## Testing 8 new cases — 6 for the normalizer (well-formed, absent, empty, bad charset, over-long, repeated param) and 2 for the schema. Suite: 456 passing, up exactly 8 from a 448 baseline. `oxlint` and `oxfmt --check` clean; `next build` compiles with no type errors. Verified in a browser rather than asserted: opening a partner profile, clicking "Submit a brief", and completing the wizard produces ```json {"firstName":"Jane","lastName":"","email":"…","companyName":"NetZero Test Co","need":"…","partnerSlug":"netzero-systems"} ``` on `POST /api/client-brief` → 200. `LocalizedLink` preserves the query string across locale prefixing (`localize-href.test.ts:20` already covers this; confirmed live on the FR route). ## Deliberately not included - **CTA-level attribution.** Which of the three listing-page CTAs was used is not tracked. That is click analytics, a different concern from partner attribution. - **Length bounds on the other brief fields.** `country`, `seatCount`, `timeline`, `budgetRange` and `companyName` remain unbounded, as they were before this PR. Worth tightening, but pre-existing and out of scope here. Review in cubic --- .../partners/brief/ClientBriefPageContent.tsx | 8 +++-- .../(focused)/partners/brief/page.tsx | 6 +++- .../build-client-brief-request-body.test.ts | 23 +++++++++++++++ .../build-client-brief-request-body.ts | 2 ++ .../client-brief-request-schema.test.ts | 18 ++++++++++++ .../client-brief-request-schema.ts | 2 ++ .../normalize-partner-slug.test.ts | 29 +++++++++++++++++++ .../client-brief/normalize-partner-slug.ts | 9 ++++++ .../src/client-brief/partner-slug-schema.ts | 9 ++++++ .../client-brief/wizard/ClientBriefWizard.tsx | 5 ++-- .../partners-marketplace/PartnerProfile.tsx | 1 + .../PartnerProfileCtas.tsx | 4 ++- 12 files changed, 110 insertions(+), 6 deletions(-) create mode 100644 packages/twenty-website/src/client-brief/build-client-brief-request-body.test.ts create mode 100644 packages/twenty-website/src/client-brief/normalize-partner-slug.test.ts create mode 100644 packages/twenty-website/src/client-brief/normalize-partner-slug.ts create mode 100644 packages/twenty-website/src/client-brief/partner-slug-schema.ts diff --git a/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/ClientBriefPageContent.tsx b/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/ClientBriefPageContent.tsx index 738ea3e644..cf5c6a6cd1 100644 --- a/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/ClientBriefPageContent.tsx +++ b/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/ClientBriefPageContent.tsx @@ -25,11 +25,15 @@ const BriefContainer = styled.div` } `; -export function ClientBriefPageContent() { +export function ClientBriefPageContent({ + partnerSlug, +}: { + partnerSlug?: string; +}) { return ( - + ); diff --git a/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/page.tsx b/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/page.tsx index 3b3c15f78d..28c101c2f5 100644 --- a/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/page.tsx +++ b/packages/twenty-website/src/app/[locale]/(focused)/partners/brief/page.tsx @@ -1,3 +1,4 @@ +import { normalizePartnerSlug } from '@/client-brief/normalize-partner-slug'; import { getRouteI18n, type LocaleRouteParams, @@ -10,10 +11,13 @@ export const generateMetadata = buildRouteMetadata('partnersBrief'); export default async function ClientBriefPage({ params, + searchParams, }: { params: Promise; + searchParams: Promise<{ partner?: string | string[] }>; }) { await getRouteI18n(params); + const { partner } = await searchParams; - return ; + return ; } diff --git a/packages/twenty-website/src/client-brief/build-client-brief-request-body.test.ts b/packages/twenty-website/src/client-brief/build-client-brief-request-body.test.ts new file mode 100644 index 0000000000..95a60f764a --- /dev/null +++ b/packages/twenty-website/src/client-brief/build-client-brief-request-body.test.ts @@ -0,0 +1,23 @@ +import { buildClientBriefRequestBody } from './build-client-brief-request-body'; +import { INITIAL_CLIENT_BRIEF_STATE } from './client-brief-state'; + +const state = { + ...INITIAL_CLIENT_BRIEF_STATE, + firstName: 'Jane', + lastName: 'Smith', + email: 'jane@acme.com', + companyName: 'Acme Real Estate', + need: 'Migrate from HubSpot', +}; + +describe('buildClientBriefRequestBody', () => { + it('puts the referring partner slug on the wire', () => { + expect( + buildClientBriefRequestBody(state, 'acme-consulting').partnerSlug, + ).toBe('acme-consulting'); + }); + + it('omits the key entirely when no slug is given', () => { + expect('partnerSlug' in buildClientBriefRequestBody(state)).toBe(false); + }); +}); diff --git a/packages/twenty-website/src/client-brief/build-client-brief-request-body.ts b/packages/twenty-website/src/client-brief/build-client-brief-request-body.ts index e2058e6f19..c4dccfd6cd 100644 --- a/packages/twenty-website/src/client-brief/build-client-brief-request-body.ts +++ b/packages/twenty-website/src/client-brief/build-client-brief-request-body.ts @@ -10,6 +10,7 @@ function splitLanguages(value: string): string[] { export function buildClientBriefRequestBody( state: ClientBriefState, + partnerSlug?: string, ): ClientBriefRequest { const body: ClientBriefRequest = { firstName: state.firstName.trim(), @@ -27,6 +28,7 @@ export function buildClientBriefRequestBody( if (state.seatCount.trim()) body.seatCount = state.seatCount.trim(); if (state.timeline.trim()) body.timeline = state.timeline.trim(); if (state.budgetRange.trim()) body.budgetRange = state.budgetRange.trim(); + if (partnerSlug) body.partnerSlug = partnerSlug; return body; } diff --git a/packages/twenty-website/src/client-brief/client-brief-request-schema.test.ts b/packages/twenty-website/src/client-brief/client-brief-request-schema.test.ts index 2f5ca6e0e4..53dd429305 100644 --- a/packages/twenty-website/src/client-brief/client-brief-request-schema.test.ts +++ b/packages/twenty-website/src/client-brief/client-brief-request-schema.test.ts @@ -68,4 +68,22 @@ describe('clientBriefRequestSchema', () => { .success, ).toBe(false); }); + + it('accepts a payload carrying a referring partner slug', () => { + expect( + clientBriefRequestSchema.safeParse({ + ...minimalValid, + partnerSlug: 'acme-consulting', + }).success, + ).toBe(true); + }); + + it('rejects a malformed partner slug', () => { + expect( + clientBriefRequestSchema.safeParse({ + ...minimalValid, + partnerSlug: 'Acme Consulting!', + }).success, + ).toBe(false); + }); }); diff --git a/packages/twenty-website/src/client-brief/client-brief-request-schema.ts b/packages/twenty-website/src/client-brief/client-brief-request-schema.ts index 844850c199..be7ab9fca8 100644 --- a/packages/twenty-website/src/client-brief/client-brief-request-schema.ts +++ b/packages/twenty-website/src/client-brief/client-brief-request-schema.ts @@ -3,6 +3,7 @@ import { z } from 'zod'; import { emailFieldSchema } from '@/partner-application/email-field-schema'; import { CLIENT_BRIEF_HOSTING_TYPES } from './data/hosting-type-values'; +import { partnerSlugSchema } from './partner-slug-schema'; const optionalNonEmptyString = z.string().trim().min(1).optional(); @@ -19,6 +20,7 @@ export const clientBriefRequestSchema = z.strictObject({ seatCount: optionalNonEmptyString, timeline: optionalNonEmptyString, budgetRange: optionalNonEmptyString, + partnerSlug: partnerSlugSchema.optional(), }); export type ClientBriefRequest = z.infer; diff --git a/packages/twenty-website/src/client-brief/normalize-partner-slug.test.ts b/packages/twenty-website/src/client-brief/normalize-partner-slug.test.ts new file mode 100644 index 0000000000..a85bf6abc6 --- /dev/null +++ b/packages/twenty-website/src/client-brief/normalize-partner-slug.test.ts @@ -0,0 +1,29 @@ +import { normalizePartnerSlug } from './normalize-partner-slug'; + +describe('normalizePartnerSlug', () => { + it('returns a well-formed slug unchanged', () => { + expect(normalizePartnerSlug('acme-consulting')).toBe('acme-consulting'); + }); + + it('returns undefined when the param is absent', () => { + expect(normalizePartnerSlug(undefined)).toBeUndefined(); + }); + + it('returns undefined for an empty string', () => { + expect(normalizePartnerSlug('')).toBeUndefined(); + }); + + it('drops a slug with unsupported characters instead of forwarding it', () => { + expect(normalizePartnerSlug('Acme Consulting!')).toBeUndefined(); + }); + + it('drops an over-long slug', () => { + expect(normalizePartnerSlug('a'.repeat(101))).toBeUndefined(); + }); + + it('takes the first value when the param is repeated', () => { + expect(normalizePartnerSlug(['acme-consulting', 'other'])).toBe( + 'acme-consulting', + ); + }); +}); diff --git a/packages/twenty-website/src/client-brief/normalize-partner-slug.ts b/packages/twenty-website/src/client-brief/normalize-partner-slug.ts new file mode 100644 index 0000000000..0156aa7f2d --- /dev/null +++ b/packages/twenty-website/src/client-brief/normalize-partner-slug.ts @@ -0,0 +1,9 @@ +import { partnerSlugSchema } from './partner-slug-schema'; + +// The API schema is strict: a malformed value must be dropped here, not +// forwarded, or it fails the whole brief submission. +export function normalizePartnerSlug( + raw: string | string[] | undefined, +): string | undefined { + return partnerSlugSchema.safeParse(Array.isArray(raw) ? raw[0] : raw).data; +} diff --git a/packages/twenty-website/src/client-brief/partner-slug-schema.ts b/packages/twenty-website/src/client-brief/partner-slug-schema.ts new file mode 100644 index 0000000000..47f4bf2344 --- /dev/null +++ b/packages/twenty-website/src/client-brief/partner-slug-schema.ts @@ -0,0 +1,9 @@ +import { z } from 'zod'; + +// Mirrors the backend `slugify` output. Shared by the request schema and +// normalizePartnerSlug so the rule has one owner. +export const partnerSlugSchema = z + .string() + .trim() + .regex(/^[a-z0-9-]+$/) + .max(100); diff --git a/packages/twenty-website/src/client-brief/wizard/ClientBriefWizard.tsx b/packages/twenty-website/src/client-brief/wizard/ClientBriefWizard.tsx index d947b0cbfc..004955c669 100644 --- a/packages/twenty-website/src/client-brief/wizard/ClientBriefWizard.tsx +++ b/packages/twenty-website/src/client-brief/wizard/ClientBriefWizard.tsx @@ -135,7 +135,7 @@ function StepRenderer({ controller }: { controller: ClientBriefController }) { } } -export function ClientBriefWizard() { +export function ClientBriefWizard({ partnerSlug }: { partnerSlug?: string }) { const { i18n } = useLingui(); const controller = useClientBriefState(); const { @@ -176,7 +176,7 @@ export function ClientBriefWizard() { return; } - const payload = buildClientBriefRequestBody(state); + const payload = buildClientBriefRequestBody(state, partnerSlug); setSubmitting(true); try { const response = await fetch('/api/client-brief', { @@ -199,6 +199,7 @@ export function ClientBriefWizard() { goNext, i18n, isLastStep, + partnerSlug, setFieldErrors, setSubmitError, setSubmitted, diff --git a/packages/twenty-website/src/partners-marketplace/PartnerProfile.tsx b/packages/twenty-website/src/partners-marketplace/PartnerProfile.tsx index 34bca7b141..0b5b7e40a3 100644 --- a/packages/twenty-website/src/partners-marketplace/PartnerProfile.tsx +++ b/packages/twenty-website/src/partners-marketplace/PartnerProfile.tsx @@ -144,6 +144,7 @@ export function PartnerProfile({ partner }: { partner: MarketplacePartner }) { calendarLink={partner.calendarLink} links={partner.links} linkUrls={partner.linkUrls} + slug={partner.slug} />