Sync public snapshot from freebuff-private

Author: github-actions[bot]

cli/src/components/__tests__/sponsored-account-prompt.test.tsx

@@ -11,6 +11,8 @@ import React from 'react'
 import { SponsoredAccountPrompt } from '../sponsored-account-prompt'
 import { initializeThemeStore } from '../../hooks/use-theme'
 
+import { trackedSponsoredCredentials } from '../../utils/sponsored-account-step'
+
 import type {
   SponsoredAccountAnswer,
   SponsoredAccountAsk,
@@ -30,6 +32,7 @@ async function mount(
   reply: (answer: SponsoredAccountAnswer) => string | null = () => null,
 ) {
   const answers: SponsoredAccountAnswer[] = []
+  const opened: string[] = []
   const interrupts: number[] = []
   const setup = await createTestRenderer({
     width: 70,
@@ -50,6 +53,7 @@ async function mount(
           return reply(answer)
         }}
         onInterrupt={() => interrupts.push(1)}
+        openUrl={(url) => opened.push(url)}
       />,
     )
   })
@@ -62,7 +66,9 @@ async function mount(
   return {
     answers,
     interrupts,
+    opened,
     input: setup.mockInput,
+    mouse: setup.mockMouse,
     frame: () => setup.captureCharFrame(),
     async act(fn: () => unknown) {
       await fn()
@@ -155,3 +161,40 @@ describe('the key form', () => {
     expect(prompt.frame()).toContain('That Acme API key looks too short.')
   })
 })
+
+describe('a key page link with a {bfcid} slot (COD-965)', () => {
+  const TOKEN = 'bfc_1.p.s'
+  const declared = [
+    {
+      env: 'ACME_API_KEY',
+      label: 'Acme API key',
+      getUrl: 'https://acme.example/k?bfcid={bfcid}',
+    },
+  ]
+  const askFor = (advertiserLink: string | null): SponsoredAccountAsk => ({
+    kind: 'credentials',
+    offerName: 'Acme',
+    credentials: trackedSponsoredCredentials(declared, { advertiserLink }),
+    error: null,
+  })
+
+  test('is shown and opened with the signed click id', async () => {
+    const prompt = await mount(askFor(`https://acme.example/?bfcid=${TOKEN}`))
+    const lines = prompt.frame().split('\n')
+    const y = lines.findIndex((line) => line.includes('acme.example/k'))
+    expect(y).toBeGreaterThanOrEqual(0)
+    expect(lines[y]).toContain(`bfcid=${TOKEN}`)
+    expect(prompt.frame()).not.toContain('{bfcid}')
+    await prompt.act(() =>
+      prompt.mouse.click(lines[y]!.indexOf('acme.example') + 2, y),
+    )
+    expect(prompt.opened).toEqual([`https://acme.example/k?bfcid=${TOKEN}`])
+  })
+
+  test('without a signed click id, no link and no literal {bfcid}', async () => {
+    const prompt = await mount(askFor(null))
+    expect(prompt.frame()).toContain('Acme API key (ACME_API_KEY)')
+    expect(prompt.frame()).not.toContain('{bfcid}')
+    expect(prompt.frame()).not.toContain('acme.example/k')
+  })
+})

cli/src/components/sponsored-account-prompt.tsx

@@ -51,7 +51,9 @@ export const SponsoredAccountPrompt: React.FC<{
   onAnswer: (answer: SponsoredAccountAnswer) => string | null
   /** Ctrl-C: stop the sponsored run, as it does everywhere else in chat. */
   onInterrupt?: () => void
-}> = ({ ask, onAnswer, onInterrupt }) => {
+  /** Opens a link the user clicks; injected by tests. */
+  openUrl?: (url: string) => void
+}> = ({ ask, onAnswer, onInterrupt, openUrl = safeOpen }) => {
   const theme = useTheme()
   const { keyHandler } = useAppContext()
   const [choice, setChoice] = useState(0)
@@ -198,7 +200,7 @@ export const SponsoredAccountPrompt: React.FC<{
           <TerminalLink
             text={ask.url}
             lineWrap
-            onActivate={() => safeOpen(ask.url)}
+            onActivate={() => openUrl(ask.url)}
           />
           {[SPONSORED_SIGNUP_YES, SPONSORED_SIGNUP_NO].map((label, index) => (
             <text
@@ -232,7 +234,7 @@ export const SponsoredAccountPrompt: React.FC<{
                 <TerminalLink
                   text={credential.getUrl}
                   lineWrap
-                  onActivate={() => safeOpen(credential.getUrl!)}
+                  onActivate={() => openUrl(credential.getUrl!)}
                 />
               ) : null}
               <text style={{ fg: theme.foreground }}>

cli/src/utils/__tests__/sponsored-account-step.test.ts

@@ -14,6 +14,7 @@ import {
 import {
   SponsoredAccountStep,
   SponsoredHeldCredentials,
+  trackedSponsoredCredentials,
 } from '../sponsored-account-step'
 
 import type {
@@ -192,6 +193,68 @@ describe('a tracked signup link', () => {
   })
 })
 
+describe('a key page link with a {bfcid} slot (COD-965)', () => {
+  const TOKEN = 'bfc_1.p.s'
+  const declared = [
+    {
+      env: 'ACME_API_KEY',
+      label: 'Acme API key',
+      getUrl: 'https://acme.example/keys?bfcid={bfcid}',
+    },
+    {
+      env: 'ACME_ORG',
+      label: 'Acme org id',
+      getUrl: 'https://acme.example/org',
+    },
+  ]
+
+  test('takes the signed click id, and the form shows that link', async () => {
+    const credentials = trackedSponsoredCredentials(declared, {
+      advertiserLink: `https://acme.example/?bfcid=${TOKEN}`,
+    })
+    expect(credentials).toEqual([
+      { ...declared[0]!, getUrl: `https://acme.example/keys?bfcid=${TOKEN}` },
+      declared[1]!,
+    ])
+    const h = harness({ credentials })
+    void h.step.request(new AbortController().signal)
+    await Promise.resolve()
+    const ask = h.step.asking
+    expect(ask?.kind).toBe('credentials')
+    if (ask?.kind !== 'credentials') return
+    expect(ask.credentials[0]!.getUrl).toBe(
+      `https://acme.example/keys?bfcid=${TOKEN}`,
+    )
+  })
+
+  test('without a signed click id the link is dropped, never shown with the slot', () => {
+    for (const advertiserLink of [null, 'https://acme.example/', undefined]) {
+      const credentials = trackedSponsoredCredentials(declared, {
+        advertiserLink: advertiserLink as string | null,
+      })
+      expect(credentials).toEqual([
+        { env: 'ACME_API_KEY', label: 'Acme API key' },
+        declared[1]!,
+      ])
+      expect(JSON.stringify(credentials)).not.toContain('bfcid}')
+    }
+  })
+
+  test('an encoded slot is filled too, and an {email} slot is removed', () => {
+    const [credential] = trackedSponsoredCredentials(
+      [
+        {
+          env: 'ACME_API_KEY',
+          label: 'Acme API key',
+          getUrl: 'https://acme.example/keys?bfcid=%7Bbfcid%7D&email={email}',
+        },
+      ],
+      { advertiserLink: `https://acme.example/?bfcid=${TOKEN}` },
+    )
+    expect(credential!.getUrl).toBe(`https://acme.example/keys?bfcid=${TOKEN}`)
+  })
+})
+
 test('no account step answers unavailable', async () => {
   const h = harness({ credentials: [] })
   expect(await h.step.request(new AbortController().signal)).toEqual({

cli/src/utils/sponsored-account-step.ts

@@ -36,6 +36,7 @@ import {
   labSignInConfirmedNote,
 } from '@codebuff/common/ads/agentic-ad-lab-run'
 import { signupUrlWithEmail } from '@codebuff/common/ads/sponsored-instant-setup'
+import { resolveSponsoredBfcidTemplate } from '@codebuff/common/ads/sponsored-procedure-inputs'
 import {
   redactSponsoredCredentialDeep,
   redactSponsoredCredentialText,
@@ -47,6 +48,7 @@ import type {
   SponsoredRedactableSecret,
   SponsoredRunCredential,
 } from '@codebuff/common/ads/sponsored-run-credentials'
+import type { SponsoredProcedureRuntimeInputs } from '@codebuff/common/ads/sponsored-procedure-inputs'
 import type { SponsoredSignupStep } from '@codebuff/common/ads/sponsored-signup-step'
 
 export const SPONSORED_SIGNUP_TOOL_NAME = 'request_sponsored_signup'
@@ -147,6 +149,29 @@ export class SponsoredHeldCredentials {
   }
 }
 
+/**
+ * MIRRORED from Desktop's `requiredCredentials` (COD-965): each declared key
+ * page with its `{bfcid}` slot filled from this run's signed click id. The
+ * key form may be the first advertiser visit, so a link that cannot be
+ * attributed (no signed id) is dropped rather than shown with a literal
+ * placeholder, and an `{email}` slot is removed: nobody agreed to share the
+ * email on this form (COD-830).
+ */
+export function trackedSponsoredCredentials(
+  credentials: readonly SponsoredRunCredential[],
+  inputs: SponsoredProcedureRuntimeInputs,
+): SponsoredRunCredential[] {
+  return credentials.map(({ getUrl, ...credential }) => {
+    const bfcidResolved = getUrl
+      ? resolveSponsoredBfcidTemplate(getUrl, inputs)
+      : null
+    const resolved = bfcidResolved
+      ? signupUrlWithEmail(bfcidResolved, null)
+      : null
+    return { ...credential, ...(resolved ? { getUrl: resolved } : {}) }
+  })
+}
+
 /** User copy for a refused key. Never names a value. */
 export function sponsoredCredentialRefusalCopy(
   credential: SponsoredRunCredential,

cli/src/utils/sponsored-run.ts

@@ -164,6 +164,7 @@ import {
   SPONSORED_ACCOUNT_STEP_MARGIN_MS,
   SponsoredAccountStep,
   SponsoredHeldCredentials,
+  trackedSponsoredCredentials,
 } from './sponsored-account-step'
 import { sponsoredSignupTool } from './sponsored-signup-tool'
 import {
@@ -1199,7 +1200,12 @@ export class SponsoredRun {
     // and the agent calls `request_sponsored_signup` once the work that needs
     // no account is done. A tracked signup link, declared keys, or a skill's
     // user step each make one.
-    const declaredCredentials = declaredRunCredentials(active.procedure)
+    // A key page's `{bfcid}` slot takes this run's signed click id, as on
+    // Desktop and Cloud; a link that cannot be attributed is not shown.
+    const declaredCredentials = trackedSponsoredCredentials(
+      declaredRunCredentials(active.procedure),
+      active.runtimeInputs,
+    )
     const signup = sponsoredSignupStep(
       active.procedure,
       active.runtimeInputs,
@@ -1254,7 +1260,9 @@ export class SponsoredRun {
     const installTool = context.installTool
       ? sponsoredInstallTool({
           ...sponsoredInstallProbe(
-            createSponsoredRootedFileSystem({ workspaceRoot: this.projectRoot }),
+            createSponsoredRootedFileSystem({
+              workspaceRoot: this.projectRoot,
+            }),
             this.projectRoot,
           ),
           resolve: (request) => this.resolvePackage(active, request),