@baukit/api-runtime

Baukit产品 API 的共享客户端行为:明确环境选择,无记名端和请求ID头,可选的W3C痕量传播,正常出错,安全回取,以及测试取回传输. 它在浏览器和 React Introduct 中工作,从来不读 process.env。 。 。 .

生成客户端使用量

包包包装 openapi-fetch每个产品继续拥有其产生的 paths 类型.

import { createApiClient, resolveApiEnvironment } from '@baukit/api-runtime';
import type { paths } from './generated/api.js';

const environment = resolveApiEnvironment('production', {
  development: 'http://localhost:3000',
  production: 'https://api.example.com',
});

export const api = createApiClient<paths>({
  ...environment,
  tokenProvider: async () => session.accessToken ?? null,
  onUnauthorized: async ({ canRetry }) => {
    if (!canRetry) return 'handled';
    const token = await session.accessToken({ forceRefresh: true });
    return token === undefined ? 'handled' : 'retry-once';
  },
});

const { data } = await api.GET('/widgets');

如果生成的包装器已经创建客户端, 请通过一个配置的运行时间 :

import createClient from 'openapi-fetch';
import { createApiRuntime } from '@baukit/api-runtime';

const runtime = createApiRuntime({
  baseUrl: 'https://api.example.com',
  environment: 'production',
  tokenProvider: getAccessToken,
});

const api = createClient<paths>({ baseUrl: runtime.baseUrl, fetch: runtime.fetch });

tokenProvider 运行每个逻辑请求;运行时间不会缓存结果。 每个请求都收到一个新的UUID x-request-id配置 traceparentProvider 只有在产品有追踪执行时.

未经授权的追回

onUnauthorized 返回时仍为通知钩 void 或者说 'handled':正统的401被像以前一样抛出. 正在返回 'retry-once' 明确要求运行时间通过 tokenProvider 并重放飞行前的请求克隆。 钩子收到 canRetry: false 当身体无法被复制时; 返回 'retry-once' 然后安全地回到原来的401 恢复最多一次 第二次401站 原始的 AbortSignal 在刷新和重播期间依然有效.

设定 onUnauthorizedExhausted 当产品必须停止排程器或移动到 重放后退出状态也会返回401。 它得到最终 已校正错误 canRetry: false; 观察员失败永远不会替换 API失败.

错误代码为 profile_erased 意思是后端的栅栏被抹去 配置文件,所以新的证书不能帮助。 运行时间然后跳过 onUnauthorized 财务报告和审定财务报表 onUnauthorizedExhausted 和电话 onProfileErased 一次 一次吗 它等待着 处理器并忽略其返回值。 请求仍然拒绝 ApiError 密码是 profile_erased,而处理器失败永远不会取代它.

这种握手方式并不能使任意突变安全. 重放中 POST, (中文(简体) ), PATCH,或任何其结果可能已经作出的任何书面要求 Idempotency-Key 服务器荣誉;见 偶发变异 编辑 重放安全突变协议。跟随存储器 集成可靠性方法, (中文(简体) ), 离线重播合同,以及 加点重放/能力指导。 。 。 .

未验证的显示身份提示

unverifiedDisplayIdentityHintsFromJwt 解码 JWT 本地索赔只用于显示。 它更喜欢 name,然后加入 given_name 财务报告和审定财务报表 family_name, (中文(简体) ), preferred_username,以及 email它从 大部分两个首字母 无效的令牌和缺失的索赔使用产品提供的倒置文字.

import { unverifiedDisplayIdentityHintsFromJwt } from '@baukit/api-runtime';

const hints = unverifiedDisplayIdentityHintsFromJwt(session.accessToken, {
  displayName: 'Local account',
  initials: 'LA',
});

索赔没有得到核实。 不要用这些提示来授权,一个存储分区, 分析身份,缓存所有权,或同步所有权. 这些决定需要: 服务器验证对象 。 现有网络和本地帮助者可以直接替换,但产品 必须在呼叫站点保留他们的倒数副本.

处理错误

非成功回复抛出三个打出的错误中的一个. 原始获取/ CORS 错误总是被包起来 .

import { isApiError, isHttpError, isNetworkError } from '@baukit/api-runtime';

try {
  await api.POST('/widgets', { body: widget });
} catch (error) {
  if (isApiError(error, 'validation_failed')) {
    showValidation(error.details, error.requestId);
  } else if (isNetworkError(error)) {
    showOfflineMessage();
  } else if (isHttpError(error)) {
    reportUnexpectedResponse(error.status, error.requestId);
  } else {
    throw error;
  }
}

• ApiError: 一个有效的 Baukit { error: { code, message, requestId, details } } 信封上写着.
• HttpError: HTTP 失败,信封缺失或变形,包括非JSON体.
• NetworkError:没有HTTP响应,例如离线,DNS,取出,或CORS失败. 中止设置 aborted 改为 true。 。 。 .

后端 message 是公开的,安全的回放文本。 本地化客户应解决 ApiError.code 加结构化 ApiError.details 通过产品目录和使用 ApiError.message 只有在没有该决议的情况下。 不分析信件, 或将其作为稳定的本地化密钥 .

重试语义

复数使用有全焦的指数回放, 由 maxDelayMs在尝试中保留同样的请求ID.

默认为两回重置,一回100ms初始天花板,一回2000ms最高天花板. 使用 retry: false 以禁用重试。 A 类 POST 或者说 PATCH 当请求带有 Idempotency-Key 页眉 (e)IDEMPOTENCY_KEY_HEADER) (中文(简体) ). 每次尝试都会重新发送相同的信头和正文,因此服务器看到一个密钥.

延迟公式作为 fullJitterBackoffMs(retryIndex, { baseDelayMs, maxDelayMs, random }) 内 @baukit/api-runtime/backoff返回 0 到 min(maxDelayMs, baseDelayMs * 2 ** retryIndex) 并夹住随机样本 [0, 1]。该条目不导入任何信息,所以同步循环或任务执行者可以共享策略而无需加载获取运行时间. @baukit/sync-client'调度器把它当作它的重试延迟.

异能变异

@baukit/api-runtime/idempotency 保持一个 Idempotency-Key 在结果确定或密钥过期之前, 服务器的一半是 baukit-http是因为 IdempotencyKeyRule,协议是 重放安全突变。 。 。 .

import { createApiFetch, IDEMPOTENCY_KEY_HEADER } from '@baukit/api-runtime';
import { createIdempotencyKeyStore, sendIdempotentMutation } from '@baukit/api-runtime/idempotency';

const keys = createIdempotencyKeyStore({ ttlMs: 12 * 60 * 60 * 1000 });
const apiFetch = createApiFetch({
  baseUrl: 'https://api.example.com',
  environment: 'production',
  retry: { methods: ['GET', 'HEAD', 'POST'] },
});

const note = { title: 'Standup' };
await sendIdempotentMutation(
  keys,
  { account: 'user-1', operation: 'createNote', body: note },
  (key) =>
    apiFetch('/notes', {
      method: 'POST',
      headers: { [IDEMPOTENCY_KEY_HEADER]: key, 'content-type': 'application/json' },
      body: JSON.stringify(note),
    }),
);

sendIdempotentMutation 问商店的意向钥匙,打电话 send,然后用结果解决密钥。 商店通过Canonical JSON来比较意向,所以成员在体内的秩序并不重要. classifyMutationError 财务报告和审定财务报表 classifyMutationStatus 决定结果:

保存的密钥用于同样目的,直到 ttlMs 通过; 保留 ttlMs 在服务器的回放保留下。 在此之后, 商店薄荷会装上一个新的密钥, 因此一个请求永远不会装上服务器可能已经清理过的密钥 。 密钥默认为 crypto.randomUUID() 并活在记忆中,所以重新装入会忘记它们. 过 storage,一个 IdempotencyKeyStorage 与 get, (中文(简体) ), set,以及 delete (同步或同步),将密钥保存在 sessionStorage,AsyncStorage,或作"SQLite". 它的槽参数是用意的犬形JSON;当身体敏感时存储它的摘要.

有同一种意图的呼吁 keyFor 直到目的解决为止 因此,双向提交会发出两个带有一个密钥的请求,服务器会重放第一个结果或回答 409 idempotency_key_in_progress,它保留了钥匙。 当存储仍在读取时, 当存储下降时写作为全 sessionStorage 已经 商店不会将两个请求合并为一个请求;每个呼叫者都会得到自己的响应. 检查失败不会阻碍下一次检查.

body 将 JSON 所携带的值保持不变, 并检查其类型 JsonCompatible<Body>。没有索引签名的接口,可选成员也可以输入 T | undefinedA级 Date,函数,或 unknown 成员无法编译 。 成员预定 undefined 键外,因为 JSON.stringify 离开他们的请求.

宝琪知道 ApiError, (中文(简体) ), HttpError,以及 NetworkError。一个会抛出自己的 API 出错通过的产品 classifyError 到店里来 返回产品所知道的错误的结果 undefined 其余的,这属于 classifyMutationError。 。 。 . classifyMutationStatus(status, code) 应用上表,包括进行中代码:

const keys = createIdempotencyKeyStore({
  ttlMs: 12 * 60 * 60 * 1000,
  classifyError: (error) =>
    error instanceof ProductApiError ? classifyMutationStatus(error.status, error.code) : undefined,
});

sendIdempotentMutation 解析失败的发送 store.classifyError(error)密码 keyFor 财务报告和审定财务报表 settle 直接可以调用同一种方法.

@baukit/data-contracts/revisioned-writes 决定文件写作时的怨恨; 此商店决定它携带的密钥 。 订正 PATCH 与 If-Match 不需要钥匙。 从队列的回调中发送的按键创建将任何预期的修订版放入 body,因此在未知结果映射到同一密钥后重新发送.

测试

MockFetch 队列响应、错误或处理器和记录克隆请求 :

const mock = new MockFetch().enqueueJson({ widgets: [] });
const runtime = createApiRuntime({
  baseUrl: 'https://api.example.test',
  environment: 'test',
  fetch: mock.fetch,
});

await runtime.fetch('/widgets');
mock.assertRequest(0, { method: 'GET', url: 'https://api.example.test/widgets' });
mock.assertQueueEmpty();

配置和登录账户删除

导入 createProfileErasureClient 从 @baukit/api-runtime/erasure通过 账户的永恒主题, 认证的取来, 和耐用 IdempotencyKeyStorage。永久键与符号分开。 模板 适配器将存储槽上散开,所以其中不包含生主体.

const erasure = createProfileErasureClient({
  account: subject,
  fetch: runtime.fetch,
  storage: persistedKeys,
});
const receipt = await erasure.erase(signal);
if (receipt.status === 'pending' && receipt.operationId !== null) {
  const operation = await erasure.poll(receipt.operationId, { signal });
}

erase 发送 DELETE /me 与 Idempotency-Key,以及 poll 读取 GET /me/erasures/{operationId}。通过 routes: { eraseMethod, erasePath, statusPath } 其他路线,例如: { eraseMethod: 'POST', erasePath: '/v1/me/erasure', statusPath: '/v1/me/erasure/{operationId}' }· ; templateProfileErasureRoutes 持有默认值。 它验证了200个完成的 和202个待决机构。 网络下降、 发送后中止、 失败 机构, 或不确定的服务器出错 AmbiguousProfileErasureError。其代码 与 eraseProductProfile保留同样的密钥供日后重试, 即使在重新装入之后 已完成或待收,包括401 profile_erased,按承诺解决键并消除其持久性 存储。 不确定的密钥不会在计时器上过期 。 如果密钥删除失败, ProfileErasureKeyCleanupError 携带承诺的收据,以便呼叫者 仍然删除本地数据并签名,然后报告本地清理失败. 客户端在409上发布了密钥 erasure_idempotency_conflict其他项目 拒绝保留它,因为早先的企图可能在 反应丢失.

一个401 profile_erased 确认服务器配置文件已删除 。 它回来了 由于栅栏不能证明签入 账户已经不见了。 一个普通的401仍然拒绝.

poll 读取 GET /me/erasures/{operationId} 立即,然后等待500毫秒, 1秒,2秒,最多5秒之间读取。 完工后就停了, 失败, 或八个读出并返回该限制的最后一个待决状态 . maxAttempts, (中文(简体) ), initialDelayMs,以及 maxDelayMs 可以改变这些界限。 终止 取消获取和后退计时器。 操作失败需要操作员 帮助;客户端不得再发送删除来修复.

认证模板在操作前为此操作捕获一个短命访问符 清除本地认证。 状态检查在屏幕上使用此符号 保持开放,而不刷新或恢复已签名的会话 。 失败 状态检查不取消删除;服务器工作继续.