@ grafserv/ 持久
模糊的操作( aka "persisted chests", "query limitlist", "persisted" ) 文档 ) 前进应用 无论是标准 GET 和 POST 请求,还是网络锁定连接。 为所有人服务 操作类型(取水口,突变和订阅).
我们建议所有 GraphQL 服务器(Post Graphile 或其他) 打算首先使用GraphQL计划的当事方客户应持续使用 减少对GraphQL API的攻击并帮助跟踪 字段。 这个包裹是Grafserv的解决方案 其他的 您需要不同的软件.
人群资助开源软件
为了帮助我们可持续地开发这一软件,我们请所有人和 * 利用它来支持其持续维护与发展的企业 通过赞助.
点击这里了解更多关于赞助商和赞助商的情况.
请给我们的赞助商一点爱
钢头 * 联合国 |
* 赞助整个图形套间
安装
yarn add @grafserv/persisted
# or: npm install --save @grafserv/persisted
使用量
导入 PersistedPlugin 从 @grafserv/persisted 然后加进
plugins 列表中 graphile.config.ts (或等同)文件:
import "graphile-config";
import PersistedPlugin from "@grafserv/persisted";
const preset: GraphileConfig.Preset = {
plugins: [PersistedPlugin],
grafserv: {
/* add configuration options here, e.g. */
persistedOperationsDirectory: `${process.cwd()}/.persisted_operations`,
},
};
export default preset;
选项
此插件在 Grafserv 选项中添加了以下选项:
/**
* This function will be passed a GraphQL request object (normally
* `{query: string, variables?: any, operationName?: string, extensions?: any}`,
* but in the case of persisted operations it likely won't have a `query`
* property), and must extract the hash to use to identify the persisted
* operation. For Apollo Client, this might be something like:
* `request?.extensions?.persistedQuery?.sha256Hash`; for Relay something
* like: `request?.documentId`.
*/
hashFromPayload?(request: ParsedGraphQLBody): string | undefined;
/**
* We can read persisted operations from a folder (they must be named
* `<hash>.graphql`). When used in this way, the first request for a hash
* will read the file, and then the result will be cached such that the
* **filesystem read** will only impact the first use of that hash. We
* periodically scan the folder for new files, requests for hashes that
* were not present in our last scan of the folder will be rejected to
* mitigate denial of service attacks asking for non-existent hashes.
*/
persistedOperationsDirectory?: string;
/**
* An optional string-string key-value object defining the persisted
* operations, where the keys are the hashes, and the values are the
* operation document strings to use.
*/
persistedOperations?: { [hash: string]: string };
/**
* If your known persisted operations may change over time, or you'd rather
* load them on demand, you may supply this function. Note this function is
* **performance critical** so you should use caching to improve
* performance of any follow-up requests for the same hash.
*/
persistedOperationsGetter?: PersistedOperationGetter;
/**
* There are situations where you may want to allow arbitrary operations
* (for example using GraphiQL in development, or allowing an admin to
* make arbitrary requests in production) whilst enforcing Persisted
* Operations for the application and non-admin users. This function
* allows you to determine under which circumstances persisted operations
* may be bypassed.
*
* IMPORTANT: this function must not throw!
*
* @example
*
* ```
* app.use(postgraphile(DATABASE_URL, SCHEMAS, {
* allowUnpersistedOperation(event) {
* return process.env.NODE_ENV === "development" && event.request?.getHeader('referer')?.endsWith("/graphiql");
* }
* });
* ```
*/
allowUnpersistedOperation?:
| boolean
| ((event: ProcessGraphQLRequestBodyEvent) => boolean);
所有这些选项都是可选的;但您应当精确指定其中之一
persistedOperationsDirectory, (中文(简体) ), persistedOperations 或者说
persistedOperationsGetter 用于此插件.
生成嵌入操作
中继
中继系统为持续开展的行动提供了内在支持:
https://relay.dev/docs/guides/persisted-queries/ 页面存档备份,存于互联网档案馆
过 --persist-output ./path/to/server.json 改为 relay-compiler 和
您的正常选项是生成持续操作文件。 你们可以
然后使用 addToPersistedOperations.js 下面的脚本可以分割此操作
JSON 文件写入每个查询可以传递到的文件
--persisted-operations-directory。 。 。 .
然后在您的网络配置中( E)fetchQuery 函数)
query: operation.text 改为 documentId: operation.id
如中继文件所示。 。 。 .
图QL 代码编辑器
除了"中继"之外,我们建议你做持续操作 当你用酷炫的建筑你的客户 图克l-代码生成器 项目和 图克l-编码-持久性-克赖里-标识 (通过v0.1.2插件测试). 一个配置可能看起来像:
schema: "schema.graphql"
documents: "src/**/*.graphql"
hooks:
afterAllFileWrite:
- node addToPersistedOperations.js
generates:
client.json:
plugins:
- graphql-codegen-persisted-query-ids:
output: client
algorithm: sha256
server.json:
plugins:
- graphql-codegen-persisted-query-ids:
output: server
algorithm: sha256
我们还建议使用文件 addToPersistedOperations.js 撰写
server.json 每次代码出现时, 文件内容会分开 GraphQL 文件
为方便版本控制而建 :
// addToPersistedOperations.js
const map = require("./server.json");
const { promises: fsp } = require("fs");
async function main() {
await Promise.all(
Object.entries(map).map(([hash, query]) =>
fsp.writeFile(
`${__dirname}/.persisted_operations/${hash}.graphql`,
query,
),
),
);
}
main().catch((e) => {
console.error(e);
process.exit(1);
});
然后你通过 .persisted_operations 文件夹通过
persistedOperationsDirectory 选项,如使用示例所示.
阿波罗客户端
您可以配置阿波罗客户端, 以发送由
graphql-codegen 与 apollo-link-persisted-queries数字 :
import { createPersistedQueryLink } from "apollo-link-persisted-queries";
import { usePregeneratedHashes as withPregeneratedHashes } from "graphql-codegen-persisted-query-ids/lib/apollo";
import { hashes } from "./path/to/client.json";
const persistedLink = createPersistedQueryLink({
useGETForHashedQueries: false,
generateHash: withPregeneratedHashes(hashes),
disable: () => false,
});
// ...
const client = new ApolloClient({
link: ApolloLink.from([persistedLink, httpLink]),
// ...
});