[Bug][Project] Invalid metric plugin options are accepted on project save and only fail at the next pipeline run
メンテナーはふだん 2 日以内に返信
評価
調査の方向性
Start in backend/server/services/project.go at refreshProjectMetrics, which CreateProject and PatchProject call without validating pluginOption. Then read the MakeMetricPluginPipelinePlanV200 implementations in the monorepo and dora plugins, which already compile the regex. Done means an invalid regex or empty sub-project list returns HTTP 400 without writing to the database, while valid Go-only syntax such as (?i) is still accepted. Pull request #9228 is already open against this issue, so check it before starting.
索引モデルが issue の本文から書いたものです。
説明
Search before asking
- I had searched in the issues and found no similar issues.
What happened
Some metric plugin settings on the Config UI Project → Settings page take a regex, e.g. the
Deploy job pattern of Monorepo Sub-Projects.
If the regex is invalid (e.g. ^deploy-(a, missing a closing parenthesis), clicking Save reports
success and the setting is stored. The error only surfaces the next time a pipeline plan is generated
(Collect Data or the scheduled run):
- The whole blueprint fails to start, not just that metric — data collection from every data source
stops as well. - The error is reported on the pipeline / blueprint, far from the Settings page where the mistake was
made, so it is hard to connect the two. - With a scheduled blueprint, it can take hours before anyone notices the data stopped updating.
The same happens when Monorepo Sub-Projects is enabled with no sub-projects at all.
Project Settings → Save Collect Data / cron (hours later)
│ │
▼ ▼
PATCH /projects/:projectName MakePlanForBlueprint
│ │
▼ ▼
refreshProjectMetrics MakeMetricPluginPipelinePlanV200
stores pluginOption as-is ──── DB ────► compiles `^deploy-(a` ✗ error
│ │
▼ ▼
2xx ✓ "saved" whole blueprint fails,
no data collected at all
Root cause:
POST /projectsandPATCH /projects/:projectNamestore each metric'spluginOptionas-is via
refreshProjectMetrics(backend/server/services/project.go), without any validation.- The actual validation lives in each metric plugin's
MakeMetricPluginPipelinePlanV200(monorepo
rejects an emptysubProjectslist and compiles everydeployJobPattern, returningBadInput), which
is only called when a pipeline plan is generated — i.e. when a blueprint is saved or triggered. - The monorepo code comment says "Validate eagerly so a bad regex is reported when the blueprint is
saved", but editing metric settings from Project Settings never goes through the blueprint save
flow, so this path is never validated.
What do you expect to happen
Invalid metric plugin options should be rejected when the project is saved:
- Saving with an invalid regex shows an error, and the previous settings remain unchanged.
- Saving with a valid regex (including Go-only syntax such as
(?i)) succeeds. - Disabled metrics carrying invalid options do not block saving (they are not used for plan generation
either). - Creating a project (
POST /projects) is validated the same way.
Proposed fix: before writing to the database, CreateProject / PatchProject dry-run
MakeMetricPluginPipelinePlanV200(projectName, pluginOption) for every enabled metric, discard the
generated plan, and reject the request with HTTP 400 (BadInput) as invalid options for metric plugin <name>,
wrapping the plugin's own error (e.g. subProjects[0] (serviceA): invalid deployJobPattern caused by
error parsing regexp: missing closing ): `^deploy-(a` ).
- Every current metric plugin (dora, linker, issue_trace, monorepo) only parses JSON and builds a plan
inMakeMetricPluginPipelinePlanV200— no database access or other side effects — so it is safe to
reuse as a validator. - Some plugins return
errors.Default(500) on a JSON unmarshal failure; wrapping withBadInput
makes it a 400 instead of a server error. - No Config UI change is needed: the Save button already shows the API error message as a toast.
- Any metric plugin that validates its options in
MakeMetricPluginPipelinePlanV200automatically
gets save-time validation, with no further server change.
Out of scope:
- Client-side regex validation: JavaScript
RegExpdiffers from Go RE2 (e.g. no(?i)) and would
reject valid patterns. - The linker
prToIssueRegexp: it is only compiled at task runtime, not in
MakeMetricPluginPipelinePlanV200, so this fix does not cover it. Could be a follow-up. - A dedicated plugin validation interface (e.g.
ValidateMetricPluginOption): cleaner semantically,
but requires acore/plugininterface change.
How to reproduce
- Create a project and enable Monorepo Sub-Projects on the Settings tab.
- Add a sub-project with Deploy job pattern
^deploy-(aand click Save — it reports success. - Go to the Blueprint tab and click Collect Data — plan generation fails and no pipeline runs, so
no data is collected at all.
Anything else
Happens every time an enabled metric has invalid options.
Version
main (4ad2f66df042386888cbcd7a0b585c4a2c13f90a)
Are you willing to submit PR?
- Yes I am willing to submit a PR!
Code of Conduct
- I agree to follow this project's Code of Conduct
- 主要言語
- Go
- スター
- 3.2k
- フォーク
- 824
- 平均マージ
- 2日 22時間
- マージ済み PR(30日)
- 43
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/devlake のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
メンテナーはふだん 2 日以内に返信
-
[Bug][Dashboard] Engineering Throughput PR time panels count PRs without a project_pr_metrics row as 0 hours対応中かも @chenwei791129 が 2 日前に担当しました。 オープン
難易度 3/5 半日 初心者へのやさしさ 22/100
メンテナーはふだん 2 日以内に返信
-
[Bug][e2e] Several plugin e2e tests fail on a fresh database because they depend on tables created by other tests対応中かも @chenwei791129 が 3 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
-
[Feature][dora] Allow filtering which pull requests count toward Lead Time for Changes by branch name対応中かも @chenwei791129 が 2 日前に担当しました。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
メンテナーはふだん 2 日以内に返信
-
難易度 3/5 半日 初心者へのやさしさ 62/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
Realtime: ASR EOU language tags leak into the LLM conversation (unintended reply-language switching)対応中かも @nexxtmobile が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
effort:high model:sonnet phase:3 type:docs
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
OffchainLabs/nitro#4771 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
BurntSushi/toml#530 ·