GitLab 查询语言
编译器以 Rust [^1] 构建,并作为两个软件包分发:
- 无 (单位:千美元)
@gitlab/query-language-rust:由GitLab的前端用于客户端-侧查询编译. - 鲁比宝石 (单位:千美元)
gitlab_query_language:由GitLab的后端用于服务器侧式查询处理.
该图书馆的目标包括:
- 将 GLQL 查询, 包括 YAML 前题块传送到 GraphQL 响应 .
- 使用变压器函数转换 GraphQL 调用的结果 .
无
@gitlab/query-language-rust 是 npm 模块,为转换提供简单的接口 glql
以其他格式查询.
它覆盖了Web Assembly的构建 glql 编译器,用Rust书写.
使用量
安装模块 :
npm install --save @gitlab/query-language-rust
导入和使用模块 :
<script type="module">
import { glql } from '@gitlab/query-language-rust';
let query = 'label != "backend" and author = currentUser() and weight = 1 and updated > today()';
let graphql = await glql.compile(query, {
group: 'gitlab-org',
username: 'johnhope',
});
console.log(graphql);
</script>
计划不在此导出 。 它由鲁比宝石代替Glql.schema下页
鲁比宝石 这是今天唯一的消费者.
运行浏览器播放地
克隆回波,然后安装dev依赖,建立WASM目标,并服务于 npm/ 目录 :
npm install
cargo install wasm-pack
rustup target add wasm32-unknown-unknown
wasm-pack build --target web
npx wds -r npm/
鲁比宝石
同样的Rust编译器也作为Ruby gem提供,提供本地Ruby装订供服务器侧面使用.
安装
添加到您的 Gem 文件 :
gem 'gitlab_query_language'
或直接安装 :
gem install gitlab_query_language
使用量
require 'gitlab_query_language'
query = 'label != "backend" and author = currentUser() and weight = 1'
result = Glql.compile(query, { group: 'gitlab-org', username: 'johnhope', fields: 'title' })
puts result
Glql.schema 返回 GLQL 所接受的一切 - 数据源、 其字段、 运算符
字段,以及可用的函数:
Glql.schema["sources"].map { |source| source["name"] }
# => ["WorkItems", "MergeRequests", "Pipelines", "Projects", "Jobs", ...]
schema["version"] 是宝石的版本.
交互式控制台( CLI / RePL)
Ruby gem为测试来自命令行的GLQL查询提供了快速的方法,而不需要浏览器:
cd glql_rb
bundle exec rake compile
bundle exec rake console
irb(main):001> Glql.compile('type = Issue', {group: 'gitlab-org', username: 'johnhope', fields: 'id'})
=>
{"fields" => [{"key" => "id", "label" => "ID", "name" => "id"}],
"output" => "query GLQL(...) { ... }",
"success" => true,
"variables" => { ... }}
关于鲁比宝石的全部细节,见 glql rb/README.md (英语)。 。 。 .
发展
mise install # installs Rust, Node.js, and Ruby at the versions pinned in .tool-versions
brew install lefthook # for managing git hooks (see below)
如果使用VSCode,则考虑安装 rust-analyzer 扩展名.
设置左旋
Lefthook用于在将代码推入寄存器前将某些检查自动化,例如运行测试,确保代码格式化,以及检查lint警告等.
在 MacOS 上在全球安装 Lefthook, 运行 :
brew install lefthook
关于安装的其他平台或方法,见 安装文件 为了左撇子.
一次 lefthook ,通过运行您寄存器根中的以下命令在您的工程中启用 :
lefthook install
此命令将设置为 Lfthook 来管理 git 钩子, 用于在 lefthook.yml 文档.
预推钩
下列检查会在您按下代码前自动运行 :
- 测试:确保所有测试通过
cargo test。 。 。 . - 饼干: 运行
cargo clippy检查提示,并确保没有警告. - 格式: 确保正确使用代码格式
cargo fmt --check。 。 。 . - 检查: 运行
cargo check以验证代码的编译没有出错.
运行测试
粗口测试
要手动运行 Rust 测试, 请使用以下命令 :
cargo test
这将构建和运行您 Rust 项目中定义的所有测试 .
WASM 软件包测试
要进行WASM包测试,请使用:
npm test
连续集成测试:
npm run test:ci
代码覆盖
覆盖报告在CI/CD中自动生成,并发布在GitLab Pages上:
- 粗线覆盖 :
https://gitlab-org.gitlab.io/glql/coverage/
重生计划
src/schema/schema.json 由分析器生成,而不是用手书写。 之后再生出来
更改分析器宣布的任何东西 - 字段、操作符、范围、来源:
cargo run --bin generate-schema && npm run lint:prettier:fix
两者都定义了文件,所以CI运行的正是这两个命令,并在任意diff上失败. 运行他们 检查一下没有改变 看看CI会说什么.
格式代码
为了确保您的代码使用适当的格式化 rustfmt,运行 :
cargo fmt -- --check
此命令检查您的代码是否遵守格式化规则, 但不会修改任何文件 。 要自动格式化您的代码, 运行 :
cargo fmt
以 Clippy 键入
要插入你的代码 并抓住常见的错误 或效率低下,运行:
cargo clippy -- -D warnings
这将把所有警告视为错误,如果发现任何警告,则防止代码构建.
端到端测试
在对 GLQL Rust 代码库进行修改时, 您可以遵循这些步骤测试您的修改端到端 GitLab GDK 软件。前端(npm/WASM)和后端(Ruby gem)都需要重建,并指向您的本地取出.
在 glql repo 中:
- 检查您要测试的分支 :
git checkout my-feature-branch - 构建 WASM 软件包 :
wasm-pack build --target web --out-dir pkg - 构建 npm 包 :
npm install && npm run build - 构建 Ruby 宝石 :
cd glql_rb && bundle install && bundle exec rake compile cd .. - 打印下一步所需的路径 :
echo "WASM path: $(pwd)/npm/dist/main.js" echo "Ruby gem path: $(pwd)/glql_rb"
在 GitLab GDK 目录中:
-
更新导入到
app/assets/javascripts/glql/core/parser.js财务报告和审定财务报表app/assets/javascripts/glql/core/transformer.js数字 :// change from import { glql } from '@gitlab/query-language-rust'; // to import { glql } from 'file:///[WASM_PATH]'; -
更新
gitlab_query_language根中线条Gemfile指向您的本地宝石:gem 'gitlab_query_language', path: '[GEM_PATH]' -
因此铁路后端和Vite前端都接上本地建筑:
bundle install gdk stop rails-web vite && rm -rf tmp/cache/vite && gdk start rails-web vite
现在您可以通过嵌入 GLQL 查询来测试您在任何平分字段的更改, 例如:
```glql
display: table
fields: title, labels, author
query: group = "gitlab-org" and label = "group::knowledge" and user = currentUser()
```
说明: 每次你改变GLQL Rust代码,你必须重建WASM,npm,和Ruby geem的文物,以使修改生效.
捐款
- 如果你还没有权限,请从 请求访问社区叉。 。 。 .
- 切开 社区分叉存储器。 。 。 .
- 创建新功能分支( N)
git checkout -b feature/my-feature) (中文(简体) ). - 提交更改( E)
git commit -am 'Add new feature') (中文(简体) ). - 推向分行(
git push origin feature/my-feature) (中文(简体) ). - 打开一个MR.
工具链版本同步
运行时版本被固定在必须同步的三个位置:
| 文件 | 它控制着什么 |
|---|---|
.tool-versions | 当地自然环境(海洋/灰尘) |
.gitlab-ci.yml | CI 管道图像和变量(RUST_VERSION,图像标记) |
.gitlab/duo/agent-config.yml | Duo 开发者代理环境 |
当撞出一个rust,Node.js,或Ruby版本时,更新所有三个文件.
释放过程
[重要] 先决条件 您需要项目中的开发者权限 .
打开 main 分支,运行以下任何管道工作以创建
释放 :
release-patch: 弹出补丁版本并发布给国家预防机制.release-minor: 弹出小版本并发布给国家预防机制.release-major: 弹出主要版本并发布给国家预防机制.
发布-*的工作将另外创建一个发布MR,同样会撞倒Ruby gem版本和依赖性. 这目前需要人工批准才能被启动宝石发行.
见宝石 glql rb/README.md (英语) 详细了解释放过程.
其他阅读
学习玫瑰
更多地了解 GLQL
[^1]: 原文为: 哈斯凯尔。 。 。 .