Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[v2] Redesign process and transport configuration APIs

オープン
#2,523 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@SteveSandersonMS がすでに取り組んでいます。

2026年9月4日 から。

  • #2536 @SteveSandersonMS による — オープン

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust

調査の方向性

まず dotnet/src/Client.cs と dotnet/src/FfiRuntimeHost.cs を確認し、次に #1930 と #1976 の下準備を踏まえて現在の動作を確認します。影響を受けるクライアントオプションとトランスポート抽象化を SDK 間で追跡し、ランタイム依存関係をすべて文書化します。完了条件は、SDK 間の動作をテストし、移行ドキュメントを作成し、必要に応じて統合されたランタイムのフォローアップにリンクすることです。

索引モデルが issue の本文から書いたものです。

説明

sdk-v2

Summary

Implement a coherent redesign of the boundary between client-wide options, out-of-process transports, and the in-process runtime.

These items are planned v2 work carried forward from #1934. Investigation should determine the correct implementation against the current code, not independently decide whether the work is desirable. If current architecture or completed work contradicts an item, document that evidence and ask maintainers to confirm the change in direction.

Why this work exists

Several CopilotClientOptions were originally implemented by lowering them to environment variables on a spawned CLI process. That is coherent for stdio/TCP clients that own an OS process, but not for an in-process FFI runtime loaded into a shared host process. A process has one ambient environment, so independently mutating it for multiple clients does not provide per-client configuration.

The original in-process implementation rejected some unsupported options while silently ignoring others. #1976 added substantial compatible forwarding and validation; preserve that groundwork and verify the current behavior while implementing the intended v2 API boundary.

Original option and behavior inventory

The complete environment-lowered inventory recorded in #1934 was:

Option Environment variable(s) Original in-process behavior
Environment Replaces the process environment block Rejected
Telemetry COPILOT_OTEL_ENABLED, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_PROTOCOL, COPILOT_OTEL_FILE_EXPORTER_PATH, COPILOT_OTEL_EXPORTER_TYPE, COPILOT_OTEL_SOURCE_NAME, OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT Rejected
GitHubToken COPILOT_SDK_AUTH_TOKEN, plus --auth-token-env Silently ignored
BaseDirectory COPILOT_HOME Silently ignored
Mode == Empty COPILOT_DISABLE_KEYTAR=1 Silently ignored
ConnectionToken COPILOT_CONNECTION_TOKEN TCP-only; not applicable in-process

The following options were lowered to CLI arguments, but the original FFI host_start arguments were hardcoded to [entrypoint, "--embedded-host"] and did not forward them:

  • UseLoggedInUser → --no-auto-login
  • SessionIdleTimeoutSeconds → --session-idle-timeout
  • EnableRemoteSessions → --remote
  • LogLevel → --log-level

The original workaround was to configure the host process before constructing a client:

  • set COPILOT_SDK_AUTH_TOKEN for authentication
  • set COPILOT_HOME for the base directory
  • set COPILOT_DISABLE_KEYTAR=1 for empty mode
  • set the corresponding COPILOT_OTEL_* and OTEL_* variables for telemetry

This workaround is historical context, not the desired v2 API.

Required changes

  • Remove client-level working-directory and environment options across SDKs, leaving process-scoped configuration on the applicable transport.
  • In Rust, move working_directory, env, env_remove, program, prefix/raw arguments, and extra_args from ClientOptions to the out-of-process transport. These remained on ClientOptions because moving them was breaking and the existing Rust transport units/structs were not declared with the #[non_exhaustive]/Default extensibility needed to add fields compatibly.
  • Make Rust's supplied process environment semantics consistent with the other SDKs. The intended behavior from #1934 is that a nonempty supplied environment replaces the inherited environment instead of adding to it.
  • Rename shared "child process" connection abstractions to "out of process" where they also cover unrelated TCP processes. Unrelated-process TCP should reject path and argument settings at runtime where they do not apply.
  • Replace settings lowered into environment variables or command-line arguments with coherent first-class runtime/server configuration where needed for stdio, TCP, and in-process operation. Environment variables may remain as compatibility overrides.
  • Ensure the runtime consumes the host_start env_json contract for host-side reads so configuration remains per client rather than ambient to the host process.
  • Validate settings that cannot apply to in-process or unrelated-process TCP connections, avoiding silent no-ops.

The first-class configuration and env_json work may not be possible without runtime changes. If runtime changes are required, file a single follow-up issue describing the complete runtime work and treat implementation of those runtime changes as out of scope for this SDK issue.

Implementation preparation

  • Account for relevant groundwork already merged in #1930 and #1976.
  • Confirm the present behavior of all environment- and argument-lowered options listed above.
  • Define the consistent public API shape and migration path in every affected SDK.
  • Link the single runtime follow-up if required.
  • Separate compatible groundwork that can safely land in v1 from the breaking v2 API changes.

Historical context

  • #1934
  • #1901
  • #1920
  • #1929
  • #1930
  • #1976
  • #1993
  • Original .NET references in #1934: dotnet/src/Client.cs (ValidateEnvironmentOptions, in-process startup, child-process environment construction, ApplyTelemetryEnvironment, and auth argument handling) and dotnet/src/FfiRuntimeHost.cs

Completion

Implement and test the required cross-SDK behavior, link the consolidated runtime follow-up where required, and document migration from every removed, moved, renamed, or behaviorally changed API. Any item not implemented requires documented contradictory evidence and explicit maintainer agreement.

主要言語
TypeScript
スター
10.5k
フォーク
1.5k
平均マージ
1日 7時間
マージ済み PR(30日)
64

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/copilot-sdk のほかの issue

github/copilot-sdk の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。