dgraph/dgraph-lambda

Dgraph Lambda

镜像概述和主要用途

Dgraph Lambda是一个无服务器平台，旨在在Slash GraphQL或Dgraph上运行JavaScript脚本。它允许用户添加自定义GraphQL解析器，以实现计算字段、复杂数据查询、多父级数据处理等功能，扩展GraphQL API的能力。

核心功能和特性

解析器添加方式

• addGraphQLResolver：接收{ parent, args }参数，返回单个值，适用于处理单个父级数据的解析场景。
• addMultiParentGraphQLResolver：接收{ parents, args }参数，返回结果数组（每个结果对应一个父级），适用于批量处理多个父级数据的场景，性能更优。

运行环境特性

• 支持fetch API
• 内置graphql和dql查询能力
• 支持base64编码/解码
• 支持URL对象操作
• （待测试）crypto模块支持

使用场景和适用范围

• 自定义GraphQL字段计算（如拼接用户姓名）
• 实现复杂数据查询逻辑（如聚合多个数据源结果）
• 多父级数据批量处理，提升查询性能
• 扩展Slash GraphQL或Dgraph的默认GraphQL API能力

使用方法和配置说明

编写脚本

脚本需通过addGraphQLResolvers或addMultiParentGraphQLResolvers注册解析器。示例如下：

javascript
// 计算用户全名
const fullName = ({ parent: { firstName, lastName } }) => `${firstName} ${lastName}`

// 查询所有待办事项标题
async function todoTitles({ graphql }) {
  const results = await graphql('{ queryTodo { title } }')
  return results.data.queryTodo.map(t => t.title)
}

// 注册单父级解析器
self.addGraphQLResolvers({
  "User.fullName": fullName,
  "Query.todoTitles": todoTitles,
})

// 复杂DQL查询（多父级处理）
async function reallyComplexDql({ parents, dql }) {
  const ids = parents.map(p => p.id);
  const someComplexResults = await dql(`really-complex-query-here with ${ids}`);
  return parents.map(parent => someComplexResults[parent.id])
}

// 注册多父级解析器
self.addMultiParentGraphQLResolvers({
  "User.reallyComplexProperty": reallyComplexDql
})

本地运行

1. 准备Dgraph环境

首先启动Dgraph并加载以下模式（可添加测试数据）：

graphql
type User {
   id: ID!
   firstName: String!
   lastName: String!
   fullName: String @lambda  # 使用lambda解析器
}

type Todo {
   id: ID!
   title: String
}

type Query {
  todoTitles: [String] @lambda  # 使用lambda解析器
}

2. 启动Dgraph Lambda容器

bash
# 注意：host.docker.internal在旧版本Docker中可能不生效
docker run -it --rm -p 8686:8686 \
  -v /本地脚本路径/script.js:/app/script/script.js \
  -e DGRAPH_URL=http://host.docker.internal:8080 \
  dgraph/dgraph-lambda

Linux系统注意：旧版本Docker的Linux系统不支持host.docker.internal，可使用DGRAPH_URL=http://172.17.0.1:8080替代。

3. 测试解析器

使用curl测试：

bash
# 测试User.fullName解析器
curl localhost:8686/graphql-worker \
  -H "Content-Type: application/json" \
  -d '{"resolver":"User.fullName","parents":[{"firstName":"Dgraph","lastName":"Labs"}]}'

添加外部库

如需添加外部库，需使用webpack --target=webworker编译脚本。详细步骤将在后续补充。

TypeScript支持

可导入@slash-graph/lambda-types获取addGraphQLResolver和addGraphQLMultiParentResolver的类型定义。

安全性

当前使用Node.js上下文隔离用户脚本，以防止***操作。但上下文隔离并非绝对安全，未来计划迁移至isolates。同时，系统会监控CPU使用，若持续5秒高负载将终止进程。

发布流程

目前发布未自动化，流程如下：

1. 如需更新类型定义，通过npm version minor; npm publish发布slash-graphql-lambda-types包。
2. Docker镜像自动发布，推送标签将创建更稳定的版本。