@funnelsgrove/cli 0.1.19 → 0.1.24

package/template_scaffold/docs/funnelsgrove/recipes/add-experiment.md

@@ -19,13 +19,162 @@ Contract hash: `d761e91d5ac6ff9e72c6d49c5bcd014270912473a66f99c49d726c65998085cf
 
 ## Procedure
 
-1. Build and validate every control/variant step before activation.
-2. Give each variant a stable, contract-compliant identity and normal outgoing edge.
-3. Create the experiment through FunnelsGrove so the platform owns the database row, feature flag, and generated experiment snapshot.
-4. Keep variant keys, labels, traffic percentages, source step, and route targets aligned.
-5. Resolve assignment and any redirect before creating the destination step visit.
-6. Keep the default flow valid when the experiment is stopped or assignment is unavailable.
-7. Run experiment-focused tests, then `fgrove validate`.
+1. Start in a synced funnel checkout and run `fgrove status` and `git status --short`.
+2. Build the control and variant steps or offer sets in the same local change.
+3. Save one of the strict JSON specs below as `experiment.json`.
+4. Create the database draft, hosted snapshot, and matching local generated files:
+
+   ```bash
+   fgrove experiments create --spec experiment.json --dir .
+   ```
+
+   For machine-readable output, run `fgrove experiments create --spec experiment.json --dir . --json`. It emits only `experimentId`, `experimentKey`, `draftVersionId`, and `writtenPaths`, with generated paths in canonical order.
+5. Resolve assignment and any redirect before creating the destination step visit. Keep the default flow valid when assignment is stopped, missing, or invalid.
+6. Run experiment-focused tests and `fgrove validate`, then follow the delivery path below.
+
+## JSON contract
+
+Use only the documented fields. Unknown top-level and variant fields are rejected.
+
+All experiment types require non-empty `id`, `name`, and `stepId`; one `primaryMetric`; at least one unique `trackedMetrics` entry containing the primary metric; and two to five variants. Each variant requires a unique non-empty `variantKey`, `label`, and `routeToStepId`, an integer `trafficPercent` from 0 through 100, and `isControl`. Exactly one variant is the control and traffic must total 100.
+
+Length limits are enforced after surrounding whitespace is trimmed: `variantKey` is at most 120 characters. `id`, `name`, `stepId`, `label`, `routeToStepId`, and `offerSetKey` are each at most 200 characters after trimming. `offerSetKey` applies only to pricing variants.
+
+Metrics are exactly `step_completion`, `next_step_reached`, `checkout_opened`, `funnel_completed`, or `paying_customer`.
+
+### Step experiment
+
+Every variant routes to the step that implements that experience.
+
+```json
+{
+  "id": "claim-headline-v1",
+  "name": "Claim headline experiment",
+  "type": "step",
+  "stepId": "claim",
+  "primaryMetric": "next_step_reached",
+  "trackedMetrics": [
+    "next_step_reached",
+    "funnel_completed"
+  ],
+  "variants": [
+    {
+      "variantKey": "control",
+      "label": "Control",
+      "routeToStepId": "claim",
+      "trafficPercent": 50,
+      "isControl": true
+    },
+    {
+      "variantKey": "variant_b",
+      "label": "Variant B",
+      "routeToStepId": "claim-b",
+      "trafficPercent": 50,
+      "isControl": false
+    }
+  ]
+}
+```
+
+### Paywall experiment
+
+Like `step`, every variant has a route target. Use `type: "paywall"` when the routes select complete paywall step variants.
+
+```json
+{
+  "id": "paywall-layout-v1",
+  "name": "Paywall layout experiment",
+  "type": "paywall",
+  "stepId": "paywall-entry",
+  "primaryMetric": "checkout_opened",
+  "trackedMetrics": [
+    "checkout_opened",
+    "paying_customer"
+  ],
+  "variants": [
+    {
+      "variantKey": "control",
+      "label": "Control",
+      "routeToStepId": "paywall-control",
+      "trafficPercent": 50,
+      "isControl": true
+    },
+    {
+      "variantKey": "compact",
+      "label": "Compact",
+      "routeToStepId": "paywall-compact",
+      "trafficPercent": 50,
+      "isControl": false
+    }
+  ]
+}
+```
+
+### Pricing experiment
+
+Each pricing variant also requires a non-empty `offerSetKey`, and every `routeToStepId` must exactly equal the top-level `stepId`.
+
+```json
+{
+  "id": "paywall-price-v1",
+  "name": "Paywall pricing experiment",
+  "type": "pricing",
+  "stepId": "paywall",
+  "primaryMetric": "paying_customer",
+  "trackedMetrics": [
+    "checkout_opened",
+    "paying_customer"
+  ],
+  "variants": [
+    {
+      "variantKey": "control",
+      "label": "Control",
+      "routeToStepId": "paywall",
+      "trafficPercent": 50,
+      "isControl": true,
+      "offerSetKey": "default-paywall"
+    },
+    {
+      "variantKey": "annual_focus",
+      "label": "Annual focus",
+      "routeToStepId": "paywall",
+      "trafficPercent": 50,
+      "isControl": false,
+      "offerSetKey": "annual-focus"
+    }
+  ]
+}
+```
+
+## Creation guarantees
+
+The stable `id` becomes the experiment key. Keep it unchanged for an exact retry: an identical same-key draft is reused, while a different definition or non-draft experiment is rejected rather than overwritten.
+
+Creation always produces a draft. It does not create or activate a PostHog flag, start traffic, or make unfinished variant steps or offer sets runnable. Activation remains a separate pre-activation UI/API action.
+
+The API creates the experiment and variants atomically, commits the matching generated snapshot to the hosted draft, and only then returns. The draft is immediately visible in the FunnelsGrove UI and hosted previews use the same snapshot. The CLI installs the exact returned bytes at `src/config/experiments.generated.ts` and `src/config/experiments.ts`, then updates the sync manifest last. `.funnelsgrove-sync.json` stays local and ignored; never commit or push it.
+
+## Recovery and errors
+
+- Missing `.funnelsgrove-sync.json`: run `fgrove sync down` into a clean directory first.
+- Invalid local JSON or `[FG-EXPERIMENT-SPEC]`: fix the reported field and retry with the same stable `id`.
+- `[FG-EXPERIMENT-STALE-DRAFT]`: do not overwrite remote work. Download the latest draft into a clean temporary directory, merge deliberately, rerun validation, and retry the same exact spec.
+- `[FG-EXPERIMENT-DRAFT-CONFLICT]`: the stable key already belongs to a different definition, owner, or lifecycle state. Reuse the original exact definition for a retry, or choose a new stable `id` only for a genuinely new experiment.
+- Locally changed generated experiment files are never overwritten. Resolve those edits before retrying.
+- If the API succeeded but the process stopped, retry safely with the same `id`. A ready local journal is automatically recovered before the next create or sync command; an interruption before the journal simply repeats the exact API request.
+
+## Validate and deliver
+
+After implementing all referenced variant steps or offer sets, run:
+
+```bash
+fgrove validate
+git status --short
+```
+
+For a funnel without GitHub source sync, deliver all local source changes with `fgrove sync up`.
+
+For a GitHub-connected funnel, commit and push the generated source files with the rest of the source change, then run `fgrove github pull`. Never use `fgrove sync up` for the same GitHub-connected diff, and never add `.funnelsgrove-sync.json` to git.
 
 ## Pre-activation QA
 

package/template_scaffold/funnel-agent-docs.test.ts

@@ -226,6 +226,32 @@ describe('funnel agent documentation supply', () => {
     );
   });
 
+  it('documents the complete JSON-driven experiment creation workflow', async () => {
+    const content = await readFile(
+      join(templateRoot, 'docs/funnelsgrove/recipes/add-experiment.md'),
+      'utf8',
+    );
+    const examples = [...content.matchAll(/```json\n([\s\S]*?)\n```/g)]
+      .map((match) => JSON.parse(match[1]) as { type?: unknown });
+
+    expect(examples.map(({ type }) => type)).toEqual(['step', 'paywall', 'pricing']);
+    expect(content).toContain('fgrove experiments create --spec experiment.json --dir .');
+    expect(content).toContain('fgrove experiments create --spec experiment.json --dir . --json');
+    expect(content).toContain('`experimentId`, `experimentKey`, `draftVersionId`, and `writtenPaths`');
+    expect(content).toContain(
+      '`variantKey` is at most 120 characters. `id`, `name`, `stepId`, `label`, `routeToStepId`, and `offerSetKey` are each at most 200 characters after trimming.',
+    );
+    expect(content).toContain('does not create or activate a PostHog flag');
+    expect(content).toContain('immediately visible in the FunnelsGrove UI');
+    expect(content).toContain('src/config/experiments.generated.ts');
+    expect(content).toContain('[FG-EXPERIMENT-STALE-DRAFT]');
+    expect(content).toContain('[FG-EXPERIMENT-DRAFT-CONFLICT]');
+    expect(content).toContain('[FG-EXPERIMENT-SPEC]');
+    expect(content).toContain('fgrove sync up');
+    expect(content).toContain('fgrove github pull');
+    expect(content).toContain('`.funnelsgrove-sync.json` stays local and ignored');
+  });
+
   it('keeps intro engagement explicitly non-automatic', async () => {
     const content = await readFile(
       join(templateRoot, 'docs/funnelsgrove/steps/intro_hero.md'),
@@ -311,7 +337,7 @@ describe('funnel agent documentation supply', () => {
 
     expect(manifest).toMatchObject({
       schemaVersion: 1,
-      bundleVersion: '2.0.7',
+      bundleVersion: '2.0.12',
       stepContractVersion: contract.stepContractVersion,
       contractHash: contract.contractHash,
     });

package/template_scaffold/funnel-docs.config.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
-  "bundleVersion": "2.0.7",
+  "bundleVersion": "2.0.12",
   "contractSource": "funnelsgrove-repository://apps/funnel-runtime/contracts/step-contract-v2.json",
   "fullyGenerated": [
     ".funnelsgrove-docs.json",

package/template_scaffold/package-lock.json

@@ -9,7 +9,7 @@
       "version": "0.1.0",
       "dependencies": {
         "@funnelsgrove/analytics": "^0.1.37",
-        "@funnelsgrove/payments": "^0.1.53",
+        "@funnelsgrove/payments": "^0.1.55",
         "@funnelsgrove/runtime": "^0.1.60",
         "@stripe/react-stripe-js": "^5.6.0",
         "@stripe/stripe-js": "^8.7.0",
@@ -899,9 +899,9 @@
       }
     },
     "node_modules/@funnelsgrove/payments": {
-      "version": "0.1.53",
-      "resolved": "https://registry.npmjs.org/@funnelsgrove/payments/-/payments-0.1.53.tgz",
-      "integrity": "sha512-eaiaE8kcZnuZ1rrCIjnWzHNWFGjKYWtL4E9siOcSpDcz9QnnQndn/HFs0qEojTPgwdDEb17LW6WvQx/xmd5AxQ==",
+      "version": "0.1.55",
+      "resolved": "https://registry.npmjs.org/@funnelsgrove/payments/-/payments-0.1.55.tgz",
+      "integrity": "sha512-zrlnyPwUsqSYkaDYASBkB3bzNVSzS0+4glKC2+ai/+fIi4SZqEOAEo51WxR3jt0s5dAX2nFdX08r/YlvY7XqyA==",
       "dependencies": {
         "@funnelsgrove/analytics": "^0.1.28",
         "@funnelsgrove/runtime": "^0.1.54",

package/template_scaffold/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@funnelsgrove/analytics": "^0.1.37",
-    "@funnelsgrove/payments": "^0.1.53",
+    "@funnelsgrove/payments": "^0.1.55",
     "@funnelsgrove/runtime": "^0.1.60",
     "@stripe/react-stripe-js": "^5.6.0",
     "@stripe/stripe-js": "^8.7.0",