Deprecate BaseURL in favor of explicit registry lists
メンテナーはふだん 2 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- go, javascript, rust, wasm
- 領域
- api, cli, developer-experience
調査の方向性
Read the binding and CLI changes in PRs #547, #548, and #551, along with the discussion linked from this issue. Trace each listed BaseURL option and its registry-list replacement, then review the existing CLI override test named TestInstallCmdDBCBaseURLOverridesGlobalConfig. Done means the binding API decision and CLI environment-variable behavior are resolved and the affected options and tests reflect that choice.
索引モデルが issue の本文から書いたものです。
説明
Follow-up from https://github.com/columnar-tech/dbc/pull/545#discussion_r4461229855.
BaseURL predates registry configuration and has outlived its purpose. It overlaps with explicit registry lists and adds a precedence rule to every entry point. #551 adds an explicit, ordered registries list to every binding, which covers the same need:
| Surface | BaseURL form | Replacement (from #551) |
|---|---|---|
| Go library | dbc.WithBaseURL(url) |
dbc.WithRegistries([]dbc.Registry{{BaseURL: u}}) |
internal/api |
ClientConfig.BaseURL |
ClientConfig.Registries |
| C API | DBC_OPTION_BASE_URL |
registry.<n>.url / DBC_OPTION_REGISTRY_COUNT |
| Rust | ClientConfig::base_url |
ClientConfig::registries(...) |
| npm-wasm | baseURL |
registries |
| CLI | DBC_BASE_URL env var |
see below |
Proposal
- Bindings (unreleased): remove
baseURLfrominternal/api, the C API, Rust and npm-wasm before their first release, so they launch with a single way to choose registries. Removing it now costs nothing; after release it would need a deprecation cycle. - Go library: mark
dbc.WithBaseURL// Deprecated:in favor ofWithRegistries, and remove it in a later release. It has been public API since v0.2.0. - CLI:
DBC_BASE_URLis the documented way to recover from a broken registry config: it overrides the global config.toml (TestInstallCmdDBCBaseURLOverridesGlobalConfig). Keep that ability, either by implementingDBC_BASE_URLon top ofWithRegistries, or by replacing it with an env var that accepts a registry list, deprecatingDBC_BASE_URLfirst.
Open questions
- Should step 1 land in the binding PR stack (#547/#548/#551) before their first release, or separately?
- Does the CLI env var stay
DBC_BASE_URL, or should there be a list-valued replacement?
- 主要言語
- Go
- スター
- 154
- フォーク
- 15
- 平均マージ
- 2日 19時間
- マージ済み PR（30日）
- 38
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
columnar-tech/dbc のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
columnar-tech/dbc#513 ·
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
columnar-tech/dbc#363 ·
メンテナーはふだん 2 日以内に返信
-
Review READMEs and docstrings after stack of dbc bindings PRs are merged対応中かも @amoeba が 3 日前に担当しました。 オープン
columnar-tech/dbc#564 · 担当者 1 名 ·
メンテナーはふだん 2 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
columnar-tech/dbc#560 ·
メンテナーはふだん 2 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 18/100
columnar-tech/dbc#555 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
columnar-tech/dbc の issue をすべて見る
似ている issue
-
component/mesheryctl kind/bug language/go
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
meshery/meshery#22993 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
-
frontend size:S
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
shukiv/jabali-panel#2423 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100