@crvouga/mockingbird-service-posthog (英语)

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

状态模拟器 邮箱 测试套间:远程特征旗评价(/flags 页:1 遗产 /decide 形状),远程配置,事件抓取(/batch/, (中文(简体) ), /e/, (中文(简体) ), /i/v0/e/, (中文(简体) ), 分会话记录录入、hog-js后资产和调查终点以及片段 管理 API 我们的工具和餐具呼叫(feature-flag list/create/patch, HogQL). 每个旗帜 通过管理路径设定每个测试,因此无法到达我们的应用程序内覆盖路径(限制) 布尔斯人, getConfig 有效载荷、EMR服务器闸门、成员-应用程序变体)成为可控制装置,以及 堆栈运行从未达到 us.i.posthog.com。 。 。 .

• 行动范围: 支助
• 合同openapi.yaml)由后浩格-节点5.52.2的线形手写出, @posthog/core 1.54.0 (后反应-内生 4.72.1''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' 我们自己的原始取来。 所有三个SDK都被证明是与之相反的(posthog.sdk.test.ts) (中文(简体) ).

安装

npm install -D @crvouga/mockingbird-service-posthog

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-posthog serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与 任何获取服务器.

使用量

将应用的 PostHog 主机指向模拟器( 默认为8795 端口 ) :

npx mockingbird-posthog serve --port 8795 --import-flags dev

import { PostHog } from "posthog-node"
import { createRuntime } from "@crvouga/mockingbird-service-posthog"

// Test setup: the emulator and the flags this worker should see.
const emulator = createRuntime()
const admin = (path: string, body: unknown, method = "PUT") =>
  emulator.fetch(
    new Request(`http://posthog.test/__admin${path}`, { method, body: JSON.stringify(body) }),
  )
// Per-worker namespaces: map each worker's project token (the SDKs cannot add headers)…
await admin("/credentials", { credentials: { phc_worker1: "w1" } })
// …then set flags in that namespace.
await admin("/flags/shop-coupons?namespace=w1", { default: true })
await admin("/flags/rx-category-intake?namespace=w1", {
  default: true,
  payload: { categories: ["trt"] },
  overrides: [{ distinct_id: "42", value: false }, { email: "[email protected]", value: "beta" }],
})
await admin("/flags/mobile-smart-links?namespace=w1", undefined, "DELETE") // absent again

// The application's posthog-node client. Only its fetch changes: requests reach the
// emulator in this process instead of us.i.posthog.com.
const posthog = new PostHog("phc_worker1", {
  fetch: (url, options) => emulator.fetch(new Request(url, options)),
})
await posthog.getFeatureFlag("shop-coupons", "7") // true
await posthog.getFeatureFlag("rx-category-intake", "42") // false
posthog.capture({ distinctId: "7", event: "coupon_applied" })
await posthog.shutdown()

路线

每条路线都用它后面的斜线来回答。 错误使用 PostHog {type, code, detail, attr} 机构: 401 invalid_api_key 没有项目代号,400 missing_distinct_id、400个 invalid_payload 404 为不可毁谤的身体 not_found。 。 。 .

旗帜语义

• 缺席对 false。 。 。 . 一个旗子,它的 default 省略(或 null) 完全没有返回 除非一个覆盖匹配; default: false 返回时 enabled: false成员应用软件 hasFlag 仅因缺席而发生静态默认。 非活动或删除 旗帜从不返回(如PostHog).
• 目标: 按顺序排列 distinct_id 或通过 person_properties.email 默认值.
• 备选案文: 字符串值是一个变体(enabled: true, variant: "<key>"我们的后端, EMR和Python客户端都读作 true。 。 。 .
• 有效载荷 : 任意 JSON; 存储并发送为 JSON 字符串 PostHog 使用. 后门的 getConfig 只接受物体有效载荷.
• 管理层 filters • 型号: distinct_id 编号 : email 财产组合成为被取代; 100%的无财产群体为默认(其 variant,否则最大多变量 变体,其他 true);在0%或部分推出时是 false; 组和其他财产 团体被忽略(决定性,不散开). 创建/ patch 拒绝数组/ scalar filters.payloads 在改变旗帜或链接之前使用 400 实验状态。 字典要求对照 PostHog 的序列器回归 和当地合同;种子 172181039 通过自我均等,而不是现场管理平等.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets, (中文(简体) ), 每个人在 /flags 财务报告和审定财务报表 /decide数字 : flags_5xx, (中文(简体) ), flags_429 (单位:千美元)retry-after: 1, (中文(简体) ), flags_hang (1.5 s,通过后端严格和EMR 1 s s 比赛), errors_while_computing (单位:千美元)errorsWhileComputingFlags: true旗帜还在, quota_limited (单位:千美元)quotaLimited: ["feature_flags"]没有旗帜。 加号 capture_5xx 在捕捉的终点. 每个预设每个路线都增加一条规则,所以 count 每个路线适用.

命名空间

PostHog SDK 无法添加信头 。 选择命名空间 :

• 主机前缀 (小学): POSTHOG_HOST=http://127.0.0.1:8795/__admin/ns/w1。每个 SDK 构建 ${host}/path这样 /__admin/ns/w1/flags/?v=2 选择 w1。 。 。 .
• 项目令牌数字 : PUT /__admin/credentials {"credentials": {"phc_…": "w1"}}。符号是 读取自 /array/{token}/…, (中文(简体) ), ?token=,尸体(token, (中文(简体) ), api_key,或者第一个批次的 事件 properties.token,在解码gzip/base64后,或个人钥匙的 Authorization: Bearer 在管理API.
• x-mockingbird-namespace对原始客户来说.

管理API的 next 页面 URL 保存已配置的管理员前缀和名空间. 在每个页面请求中发送授权头中的个人密钥 .

故意不模拟

• 推出、组别、组(组织)目标确定和地方评价的百分比 (单位:千美元)/api/feature_flag/local_evaluation:旗帜从明确角度进行确定性评估 覆盖和默认.
• 实验统计、接触群、计量执行、特别发射/存档/船舶终点、批准政策、高级试验过滤器以及 feature_flag 配置通过实验写出. 管理旗使用现有的全名空间项目别名模型;实验记录额外通过项目id过滤.
• 会话记录内容,热映射,调查和网络实验(端点回答为空).
• HogQL执行:查询回答罐头结果.
• 人物简介 : $identify 编号 : $set 事件为断言而存储,但不反馈 目标; 发送 person_properties 打开 /flags 就像SDK一样.
• 按管理API上的工程id进行项目隔离:每个命名空间设置一面旗.
• 真正的远程配置字段 超过SDKs读取.

API 密码

部分 嘲笑鸟。 。 。 .