Compare commits
75 Commits
docs/daemo
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cea15a118b | ||
|
|
68e4819d73 | ||
|
|
788f215117 | ||
|
|
7448724d8a | ||
|
|
59c283670e | ||
|
|
707f1bdb5f | ||
|
|
1c48e4121b | ||
|
|
a3bc42dc55 | ||
|
|
d074ed8434 | ||
|
|
093545b71f | ||
|
|
9dafd60d5d | ||
|
|
5743c2a05c | ||
|
|
1014848234 | ||
|
|
54b6b204d2 | ||
|
|
7a31c80f0e | ||
|
|
3fc1849892 | ||
|
|
60f6c5aba8 | ||
|
|
a1043ee3c9 | ||
|
|
c699738f9a | ||
|
|
54fc50360c | ||
|
|
2a2f92aafd | ||
|
|
a6f640a941 | ||
|
|
efba25f063 | ||
|
|
96f08ebe22 | ||
|
|
365409366d | ||
|
|
39cc9b3e6f | ||
|
|
27b06290c9 | ||
|
|
7bed56b9b6 | ||
|
|
7732554805 | ||
|
|
34b7d472ef | ||
|
|
c425037998 | ||
|
|
0c3cd0052f | ||
|
|
a5ec1af301 | ||
|
|
5ad5301805 | ||
|
|
bc1bac506a | ||
|
|
ce53283af4 | ||
|
|
77333a4d7c | ||
|
|
92d533265c | ||
|
|
5aca042421 | ||
|
|
641a1a7395 | ||
|
|
ec850ea72b | ||
|
|
2b394f6614 | ||
|
|
36e640d3a1 | ||
|
|
174e8de179 | ||
|
|
60dbbaaed4 | ||
|
|
3cda1e26e7 | ||
|
|
1f6f888999 | ||
|
|
22cae555b4 | ||
|
|
e8b79d7721 | ||
|
|
331f45e907 | ||
|
|
62ed44e1f3 | ||
|
|
a8a6ad2d06 | ||
|
|
56522bd89c | ||
|
|
5493888c15 | ||
|
|
7cb017d4b0 | ||
|
|
35e6963285 | ||
|
|
05458d59ec | ||
|
|
632865c0df | ||
|
|
45a51185eb | ||
|
|
9363879ea1 | ||
|
|
24ebfbc13e | ||
|
|
94da486e19 | ||
|
|
8ef73599db | ||
|
|
ab26a5ab72 | ||
|
|
84f408017a | ||
|
|
4dc98484fd | ||
|
|
394e2a3fa8 | ||
|
|
94982c6a91 | ||
|
|
a41afc465d | ||
|
|
e43852f769 | ||
|
|
b602a72e86 | ||
|
|
15247f4bce | ||
|
|
61d91ad716 | ||
|
|
0cb9ff0a23 | ||
|
|
fd75f77e19 |
93
.github/pull_request_template.md
vendored
93
.github/pull_request_template.md
vendored
@ -1,73 +1,66 @@
|
||||
<!--
|
||||
Help reviewers verify this PR quickly.
|
||||
Maintainers prioritize PRs with a clear reviewer test plan — without it, review may be delayed.
|
||||
|
||||
Maintainers prioritize PRs that include clear proof of work.
|
||||
If a PR does not include enough validation detail to reproduce and verify the change efficiently, review may be delayed.
|
||||
Don't hard-wrap paragraphs: GitHub renders single newlines as <br>, so wrapped text shows as a narrow column. Write each paragraph or list item as one long line.
|
||||
-->
|
||||
|
||||
## Summary
|
||||
## What this PR does
|
||||
|
||||
- What changed:
|
||||
- Why it changed:
|
||||
- Reviewer focus:
|
||||
<!-- What this PR does. Describe the change in prose, not by file or function names. -->
|
||||
|
||||
## Validation
|
||||
## Why it's needed
|
||||
|
||||
<!-- Why it's needed: the motivation, the problem being solved, or the user-facing benefit. -->
|
||||
|
||||
## Reviewer Test Plan
|
||||
|
||||
<!--
|
||||
Be concrete. Do not write only "tested locally".
|
||||
Include the exact commands, prompts, outputs, logs, screenshots, or videos that prove the change was actually run and observed.
|
||||
How a reviewer can confirm this PR: reproduction steps, expected vs observed behavior, and evidence. CI runs on macOS, Windows, and Linux — Tested on is what you verified locally.
|
||||
|
||||
For user-visible changes, bug fixes, CLI / TUI behavior changes, or interaction changes, include key screenshots or a short video.
|
||||
When possible, show before/after behavior.
|
||||
|
||||
If helpful, use the `e2e-testing` skill to gather stronger end-to-end validation evidence.
|
||||
User-visible / TUI: Before/After with tmux-real-user-testing skill, screenshots, or a short recording.
|
||||
Non–user-visible (refactor, types, docs): commands and output below; write N/A under Before/After.
|
||||
-->
|
||||
|
||||
- Commands run:
|
||||
```bash
|
||||
# paste commands here
|
||||
```
|
||||
- Prompts / inputs used:
|
||||
- Expected result:
|
||||
- Observed result:
|
||||
- Quickest reviewer verification path:
|
||||
- Evidence (output, logs, screenshots, video, JSON, before/after, etc.):
|
||||
### How to verify
|
||||
|
||||
## Scope / Risk
|
||||
<!-- How you reproduced it and what a reviewer should confirm — steps if needed, expected vs observed behavior. Focus on outcomes; paste logs or test output when helpful. -->
|
||||
|
||||
### Evidence (Before & After)
|
||||
|
||||
<!-- User-visible / TUI changes: paste before-and-after screenshots, tmux logs, or video side by side. Non-UI changes (docs, refactor, types): N/A -->
|
||||
|
||||
### Tested on
|
||||
|
||||
| OS | Status |
|
||||
| :--------: | :----: |
|
||||
| 🍏 macOS | |
|
||||
| 🪟 Windows | |
|
||||
| 🐧 Linux | |
|
||||
|
||||
<!-- ✅ tested · ⚠️ not tested · N/A -->
|
||||
|
||||
### Environment (optional)
|
||||
|
||||
<!-- Local runtime: e.g. npm run dev, Docker/Podman sandbox, seatbelt. N/A if only unit tests. -->
|
||||
|
||||
## Risk & Scope
|
||||
|
||||
- Main risk or tradeoff:
|
||||
- Not covered / not validated:
|
||||
- Not validated / out of scope:
|
||||
- Breaking changes / migration notes:
|
||||
|
||||
## Testing Matrix
|
||||
## Linked Issues
|
||||
|
||||
<!--
|
||||
Use:
|
||||
- ✅ tested
|
||||
- ⚠️ not tested
|
||||
- N/A
|
||||
If anything is ⚠️, explain why briefly below.
|
||||
Closes #N / Fixes #N / Resolves #N to auto-close.
|
||||
Otherwise reference without a closing keyword.
|
||||
-->
|
||||
|
||||
| | 🍏 | 🪟 | 🐧 |
|
||||
| -------- | --- | --- | --- |
|
||||
| npm run | ⚠️ | ⚠️ | ⚠️ |
|
||||
| npx | ⚠️ | ⚠️ | ⚠️ |
|
||||
| Docker | ⚠️ | ⚠️ | ⚠️ |
|
||||
| Podman | ⚠️ | N/A | N/A |
|
||||
| Seatbelt | ⚠️ | N/A | N/A |
|
||||
|
||||
Testing matrix notes:
|
||||
|
||||
-
|
||||
|
||||
## Linked Issues / Bugs
|
||||
<details>
|
||||
<summary>中文说明</summary>
|
||||
|
||||
<!--
|
||||
If this PR fully resolves an issue, use one of:
|
||||
- Closes #<issue_number>
|
||||
- Fixes #<issue_number>
|
||||
- Resolves #<issue_number>
|
||||
|
||||
Otherwise reference related issues without a closing keyword.
|
||||
完整翻译上面的英文正文,逐段对应,不要省略或缩写。PR 标题保持英文。
|
||||
-->
|
||||
|
||||
</details>
|
||||
|
||||
186
.github/workflows/release.yml
vendored
186
.github/workflows/release.yml
vendored
@ -386,63 +386,6 @@ jobs:
|
||||
RELEASE_VERSION: '${{ needs.prepare.outputs.release_version }}'
|
||||
run: 'npm run package:standalone:release -- --version "${RELEASE_VERSION}" --out-dir dist/standalone'
|
||||
|
||||
- name: 'Verify Installation Release Assets'
|
||||
run: 'npm run verify:installation-release -- --dir dist/standalone'
|
||||
|
||||
- name: 'Package Hosted Installation Assets'
|
||||
env:
|
||||
RELEASE_VERSION: '${{ needs.prepare.outputs.release_version }}'
|
||||
run: 'npm run package:hosted-installation -- --out-dir dist/installation --version "${RELEASE_VERSION}"'
|
||||
|
||||
- name: 'Install ossutil'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
env:
|
||||
OSSUTIL_URL: "${{ vars.OSSUTIL_URL || 'https://gosspublic.alicdn.com/ossutil/1.7.19/ossutil-v1.7.19-linux-amd64.zip' }}"
|
||||
OSSUTIL_SHA256: "${{ vars.OSSUTIL_SHA256 || 'dcc512e4a893e16bbee63bc769339d8e56b21744fd83c8212a9d8baf28767343' }}"
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
tmp_dir="$(mktemp -d)"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${OSSUTIL_URL}" -o "${tmp_dir}/ossutil.zip"
|
||||
echo "${OSSUTIL_SHA256} ${tmp_dir}/ossutil.zip" | sha256sum -c -
|
||||
unzip -q "${tmp_dir}/ossutil.zip" -d "${tmp_dir}"
|
||||
|
||||
ossutil_path="$(find "${tmp_dir}" -type f \( -name 'ossutil' -o -name 'ossutil64' \) -print -quit)"
|
||||
if [[ -z "${ossutil_path}" ]]; then
|
||||
echo "::error::ossutil binary not found in downloaded archive"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
chmod +x "${ossutil_path}"
|
||||
mkdir -p "${HOME}/.local/bin"
|
||||
install -m 0755 "${ossutil_path}" "${HOME}/.local/bin/ossutil"
|
||||
echo "${HOME}/.local/bin" >> "${GITHUB_PATH}"
|
||||
rm -rf "${tmp_dir}"
|
||||
"${HOME}/.local/bin/ossutil" >/dev/null
|
||||
|
||||
- name: 'Configure Aliyun OSS Credentials'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_ACCESS_KEY_ID: '${{ secrets.ALIYUN_OSS_ACCESS_KEY_ID }}'
|
||||
ALIYUN_OSS_ACCESS_KEY_SECRET: '${{ secrets.ALIYUN_OSS_ACCESS_KEY_SECRET }}'
|
||||
ALIYUN_OSS_ENDPOINT: "${{ vars.ALIYUN_OSS_ENDPOINT || 'https://oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
if [[ -z "${ALIYUN_OSS_ACCESS_KEY_ID}" || -z "${ALIYUN_OSS_ACCESS_KEY_SECRET}" ]]; then
|
||||
echo "::error::Missing Aliyun OSS credentials. Set ALIYUN_OSS_ACCESS_KEY_ID and ALIYUN_OSS_ACCESS_KEY_SECRET in the production-release environment secrets."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
ossutil config \
|
||||
-e "${ALIYUN_OSS_ENDPOINT}" \
|
||||
-i "${ALIYUN_OSS_ACCESS_KEY_ID}" \
|
||||
-k "${ALIYUN_OSS_ACCESS_KEY_SECRET}" \
|
||||
-L EN \
|
||||
-c "${RUNNER_TEMP}/.ossutilconfig"
|
||||
|
||||
- name: 'Publish @qwen-code/qwen-code'
|
||||
working-directory: 'dist'
|
||||
run: |-
|
||||
@ -457,150 +400,37 @@ jobs:
|
||||
env:
|
||||
NODE_AUTH_TOKEN: '${{ secrets.NPM_TOKEN }}'
|
||||
|
||||
- name: 'Verify Standalone Archives'
|
||||
run: |-
|
||||
npm run verify:installation-release -- --dir dist/standalone
|
||||
|
||||
- name: 'Create GitHub Release and Tag'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
env:
|
||||
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
|
||||
# CI_BOT_PAT required: GITHUB_TOKEN events cannot trigger downstream workflows (sync-release-to-oss.yml).
|
||||
GITHUB_TOKEN: '${{ secrets.CI_BOT_PAT }}'
|
||||
RELEASE_BRANCH: '${{ steps.release_branch.outputs.BRANCH_NAME }}'
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
PREVIOUS_RELEASE_TAG: '${{ needs.prepare.outputs.previous_release_tag }}'
|
||||
IS_NIGHTLY: '${{ needs.prepare.outputs.is_nightly }}'
|
||||
IS_PREVIEW: '${{ needs.prepare.outputs.is_preview }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
PRERELEASE_FLAG=""
|
||||
if [[ "${IS_NIGHTLY}" == "true" || "${IS_PREVIEW}" == "true" ]]; then
|
||||
PRERELEASE_FLAG="--prerelease"
|
||||
fi
|
||||
|
||||
mapfile -t release_assets < <(node scripts/verify-installation-release.js --dir dist/standalone --list-release-asset-paths)
|
||||
|
||||
gh release create "${RELEASE_TAG}" \
|
||||
dist/cli.js \
|
||||
"${release_assets[@]}" \
|
||||
dist/standalone/qwen-code-* \
|
||||
dist/standalone/SHA256SUMS \
|
||||
--target "${RELEASE_BRANCH}" \
|
||||
--title "Release ${RELEASE_TAG}" \
|
||||
--notes-start-tag "${PREVIOUS_RELEASE_TAG}" \
|
||||
--generate-notes \
|
||||
${PRERELEASE_FLAG}
|
||||
|
||||
- name: 'Sync Release Assets to Aliyun OSS'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
mapfile -t release_assets < <(node scripts/verify-installation-release.js --dir dist/standalone --list-release-asset-paths)
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "releases/qwen-code/${RELEASE_TAG}" \
|
||||
"${release_assets[@]}"
|
||||
|
||||
- name: 'Verify Aliyun OSS Release Assets'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
npm run verify:installation-release -- --base-url "${ALIYUN_OSS_PUBLIC_BASE_URL}/releases/qwen-code/${RELEASE_TAG}"
|
||||
|
||||
- name: 'Sync Hosted Installation Assets to Aliyun OSS'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' && needs.prepare.outputs.is_nightly == 'false' && needs.prepare.outputs.is_preview == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
hosted_assets=(
|
||||
dist/installation/install-qwen-standalone.sh
|
||||
dist/installation/install-qwen-standalone.ps1
|
||||
dist/installation/install-qwen-standalone.bat
|
||||
dist/installation/uninstall-qwen-standalone.sh
|
||||
dist/installation/uninstall-qwen-standalone.ps1
|
||||
dist/installation/SHA256SUMS
|
||||
)
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "installation/${RELEASE_TAG}" \
|
||||
"${hosted_assets[@]}"
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "installation" \
|
||||
"${hosted_assets[@]}"
|
||||
|
||||
- name: 'Verify Aliyun OSS Hosted Installation Assets'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' && needs.prepare.outputs.is_nightly == 'false' && needs.prepare.outputs.is_preview == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
hosted_tmp_dir="$(mktemp -d)"
|
||||
trap 'rm -rf "${hosted_tmp_dir}"' EXIT
|
||||
mkdir -p "${hosted_tmp_dir}/versioned" "${hosted_tmp_dir}/global"
|
||||
for asset in install-qwen-standalone.sh install-qwen-standalone.ps1 install-qwen-standalone.bat uninstall-qwen-standalone.sh uninstall-qwen-standalone.ps1 SHA256SUMS; do
|
||||
url="${ALIYUN_OSS_PUBLIC_BASE_URL}/installation/${RELEASE_TAG}/${asset}"
|
||||
global_url="${ALIYUN_OSS_PUBLIC_BASE_URL}/installation/${asset}"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${url}" -o "${hosted_tmp_dir}/versioned/${asset}"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${global_url}" -o "${hosted_tmp_dir}/global/${asset}"
|
||||
done
|
||||
cmp -s "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/versioned/SHA256SUMS" || {
|
||||
echo "::error::Hosted installation SHA256SUMS does not match local dist/installation/SHA256SUMS"
|
||||
diff -u "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/versioned/SHA256SUMS" || true
|
||||
exit 1
|
||||
}
|
||||
cmp -s "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/global/SHA256SUMS" || {
|
||||
echo "::error::Global hosted installation SHA256SUMS does not match local dist/installation/SHA256SUMS"
|
||||
diff -u "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/global/SHA256SUMS" || true
|
||||
exit 1
|
||||
}
|
||||
(cd "${hosted_tmp_dir}/versioned" && sha256sum -c SHA256SUMS)
|
||||
(cd "${hosted_tmp_dir}/global" && sha256sum -c SHA256SUMS)
|
||||
|
||||
- name: 'Publish Aliyun OSS Latest VERSION'
|
||||
# Run last so the `latest/VERSION` pointer only flips after every
|
||||
# release asset and hosted installer object has been uploaded and
|
||||
# verified. If any earlier step fails, the pointer keeps referring
|
||||
# to the previously-good release.
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' && needs.prepare.outputs.is_nightly == 'false' && needs.prepare.outputs.is_preview == 'false' }}
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ needs.prepare.outputs.release_tag }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
printf '%s\n' "${RELEASE_TAG}" > "${RUNNER_TEMP}/qwen-code-latest-version"
|
||||
ossutil cp "${RUNNER_TEMP}/qwen-code-latest-version" "oss://${ALIYUN_OSS_BUCKET}/releases/qwen-code/latest/VERSION" -c "${RUNNER_TEMP}/.ossutilconfig" -f --acl public-read
|
||||
|
||||
latest_version="$(curl -fsSL --connect-timeout 15 --max-time 300 "${ALIYUN_OSS_PUBLIC_BASE_URL}/releases/qwen-code/latest/VERSION" | tr -d '[:space:]')"
|
||||
if [[ "${latest_version}" != "${RELEASE_TAG}" ]]; then
|
||||
echo "::error::Aliyun latest VERSION points to ${latest_version}, expected ${RELEASE_TAG}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: 'Cleanup Aliyun OSS Credentials'
|
||||
if: |-
|
||||
${{ always() && needs.prepare.outputs.is_dry_run == 'false' }}
|
||||
run: |-
|
||||
rm -f "${RUNNER_TEMP}/.ossutilconfig"
|
||||
|
||||
- name: 'Create PR to merge release branch into main'
|
||||
if: |-
|
||||
${{ needs.prepare.outputs.is_dry_run == 'false' && needs.prepare.outputs.is_nightly == 'false' && needs.prepare.outputs.is_preview == 'false' }}
|
||||
|
||||
238
.github/workflows/sync-release-to-oss.yml
vendored
Normal file
238
.github/workflows/sync-release-to-oss.yml
vendored
Normal file
@ -0,0 +1,238 @@
|
||||
name: 'Sync Release to Aliyun OSS'
|
||||
|
||||
on:
|
||||
release:
|
||||
types: ['published']
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'The release tag to sync (e.g., v0.1.11).'
|
||||
required: true
|
||||
type: 'string'
|
||||
|
||||
concurrency:
|
||||
group: 'sync-release-to-oss'
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
sync:
|
||||
name: 'Sync Release Assets to Aliyun OSS'
|
||||
runs-on: 'ubuntu-latest'
|
||||
if: |-
|
||||
${{ github.repository == 'QwenLM/qwen-code' }}
|
||||
environment:
|
||||
name: 'production-release'
|
||||
permissions:
|
||||
contents: 'read'
|
||||
|
||||
env:
|
||||
RELEASE_TAG: '${{ github.event.release.tag_name || inputs.tag }}'
|
||||
|
||||
steps:
|
||||
- name: 'Checkout'
|
||||
uses: 'actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd' # v6.0.2
|
||||
with:
|
||||
ref: '${{ env.RELEASE_TAG }}'
|
||||
|
||||
- name: 'Determine release type'
|
||||
id: 'meta'
|
||||
env:
|
||||
TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
is_nightly="false"
|
||||
is_preview="false"
|
||||
if [[ "${TAG}" == *"nightly"* ]]; then
|
||||
is_nightly="true"
|
||||
elif [[ "${TAG}" == *"preview"* ]]; then
|
||||
is_preview="true"
|
||||
fi
|
||||
echo "is_nightly=${is_nightly}" >> "${GITHUB_OUTPUT}"
|
||||
echo "is_preview=${is_preview}" >> "${GITHUB_OUTPUT}"
|
||||
echo "is_stable=$([[ ${is_nightly} == 'false' && ${is_preview} == 'false' ]] && echo true || echo false)" >> "${GITHUB_OUTPUT}"
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e' # v6.4.0
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: 'package-lock.json'
|
||||
|
||||
- name: 'Install Dependencies'
|
||||
env:
|
||||
NPM_CONFIG_PREFER_OFFLINE: 'true'
|
||||
run: |-
|
||||
npm ci --no-audit --progress=false
|
||||
|
||||
- name: 'Download Release Assets from GitHub'
|
||||
env:
|
||||
GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
mkdir -p dist/standalone
|
||||
gh release download "${RELEASE_TAG}" --dir dist/standalone --pattern '*.tar.gz' --pattern '*.zip' --pattern 'SHA256SUMS'
|
||||
|
||||
- name: 'Verify Downloaded Release Assets'
|
||||
run: |-
|
||||
npm run verify:installation-release -- --dir dist/standalone
|
||||
|
||||
- name: 'Package Hosted Installation Assets'
|
||||
if: |-
|
||||
${{ steps.meta.outputs.is_stable == 'true' }}
|
||||
env:
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
RELEASE_VERSION="${RELEASE_TAG#v}"
|
||||
npm run package:hosted-installation -- --out-dir dist/installation --version "${RELEASE_VERSION}"
|
||||
|
||||
- name: 'Install ossutil'
|
||||
env:
|
||||
OSSUTIL_URL: "${{ vars.OSSUTIL_URL || 'https://gosspublic.alicdn.com/ossutil/1.7.19/ossutil-v1.7.19-linux-amd64.zip' }}"
|
||||
OSSUTIL_SHA256: "${{ vars.OSSUTIL_SHA256 || 'dcc512e4a893e16bbee63bc769339d8e56b21744fd83c8212a9d8baf28767343' }}"
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
tmp_dir="$(mktemp -d)"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${OSSUTIL_URL}" -o "${tmp_dir}/ossutil.zip"
|
||||
echo "${OSSUTIL_SHA256} ${tmp_dir}/ossutil.zip" | sha256sum -c -
|
||||
unzip -q "${tmp_dir}/ossutil.zip" -d "${tmp_dir}"
|
||||
|
||||
ossutil_path="$(find "${tmp_dir}" -type f \( -name 'ossutil' -o -name 'ossutil64' \) -print -quit)"
|
||||
if [[ -z "${ossutil_path}" ]]; then
|
||||
echo "::error::ossutil binary not found in downloaded archive"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
chmod +x "${ossutil_path}"
|
||||
mkdir -p "${HOME}/.local/bin"
|
||||
install -m 0755 "${ossutil_path}" "${HOME}/.local/bin/ossutil"
|
||||
echo "${HOME}/.local/bin" >> "${GITHUB_PATH}"
|
||||
rm -rf "${tmp_dir}"
|
||||
"${HOME}/.local/bin/ossutil" >/dev/null
|
||||
|
||||
- name: 'Configure Aliyun OSS Credentials'
|
||||
env:
|
||||
ALIYUN_OSS_ACCESS_KEY_ID: '${{ secrets.ALIYUN_OSS_ACCESS_KEY_ID }}'
|
||||
ALIYUN_OSS_ACCESS_KEY_SECRET: '${{ secrets.ALIYUN_OSS_ACCESS_KEY_SECRET }}'
|
||||
ALIYUN_OSS_ENDPOINT: "${{ vars.ALIYUN_OSS_ENDPOINT || 'https://oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
if [[ -z "${ALIYUN_OSS_ACCESS_KEY_ID}" || -z "${ALIYUN_OSS_ACCESS_KEY_SECRET}" ]]; then
|
||||
echo "::error::Missing Aliyun OSS credentials. Set ALIYUN_OSS_ACCESS_KEY_ID and ALIYUN_OSS_ACCESS_KEY_SECRET in the production-release environment secrets."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
ossutil config \
|
||||
-e "${ALIYUN_OSS_ENDPOINT}" \
|
||||
-i "${ALIYUN_OSS_ACCESS_KEY_ID}" \
|
||||
-k "${ALIYUN_OSS_ACCESS_KEY_SECRET}" \
|
||||
-L EN \
|
||||
-c "${RUNNER_TEMP}/.ossutilconfig"
|
||||
|
||||
- name: 'Sync Release Assets to Aliyun OSS'
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
mapfile -t release_assets < <(node scripts/verify-installation-release.js --dir dist/standalone --list-release-asset-paths)
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "releases/qwen-code/${RELEASE_TAG}" \
|
||||
"${release_assets[@]}"
|
||||
|
||||
- name: 'Verify Aliyun OSS Release Assets'
|
||||
env:
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
npm run verify:installation-release -- --base-url "${ALIYUN_OSS_PUBLIC_BASE_URL}/releases/qwen-code/${RELEASE_TAG}"
|
||||
|
||||
- name: 'Sync Hosted Installation Assets to Aliyun OSS'
|
||||
if: |-
|
||||
${{ steps.meta.outputs.is_stable == 'true' }}
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
hosted_assets=(
|
||||
dist/installation/install-qwen-standalone.sh
|
||||
dist/installation/install-qwen-standalone.ps1
|
||||
dist/installation/install-qwen-standalone.bat
|
||||
dist/installation/uninstall-qwen-standalone.sh
|
||||
dist/installation/uninstall-qwen-standalone.ps1
|
||||
dist/installation/SHA256SUMS
|
||||
)
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "installation/${RELEASE_TAG}" \
|
||||
"${hosted_assets[@]}"
|
||||
node scripts/upload-aliyun-oss-assets.js \
|
||||
--bucket "${ALIYUN_OSS_BUCKET}" \
|
||||
--config "${RUNNER_TEMP}/.ossutilconfig" \
|
||||
--prefix "installation" \
|
||||
"${hosted_assets[@]}"
|
||||
|
||||
- name: 'Verify Aliyun OSS Hosted Installation Assets'
|
||||
if: |-
|
||||
${{ steps.meta.outputs.is_stable == 'true' }}
|
||||
env:
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
hosted_tmp_dir="$(mktemp -d)"
|
||||
trap 'rm -rf "${hosted_tmp_dir}"' EXIT
|
||||
mkdir -p "${hosted_tmp_dir}/versioned" "${hosted_tmp_dir}/global"
|
||||
for asset in install-qwen-standalone.sh install-qwen-standalone.ps1 install-qwen-standalone.bat uninstall-qwen-standalone.sh uninstall-qwen-standalone.ps1 SHA256SUMS; do
|
||||
url="${ALIYUN_OSS_PUBLIC_BASE_URL}/installation/${RELEASE_TAG}/${asset}"
|
||||
global_url="${ALIYUN_OSS_PUBLIC_BASE_URL}/installation/${asset}"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${url}" -o "${hosted_tmp_dir}/versioned/${asset}"
|
||||
curl -fsSL --connect-timeout 15 --max-time 300 "${global_url}" -o "${hosted_tmp_dir}/global/${asset}"
|
||||
done
|
||||
cmp -s "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/versioned/SHA256SUMS" || {
|
||||
echo "::error::Hosted installation SHA256SUMS does not match local dist/installation/SHA256SUMS"
|
||||
diff -u "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/versioned/SHA256SUMS" || true
|
||||
exit 1
|
||||
}
|
||||
cmp -s "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/global/SHA256SUMS" || {
|
||||
echo "::error::Global hosted installation SHA256SUMS does not match local dist/installation/SHA256SUMS"
|
||||
diff -u "dist/installation/SHA256SUMS" "${hosted_tmp_dir}/global/SHA256SUMS" || true
|
||||
exit 1
|
||||
}
|
||||
(cd "${hosted_tmp_dir}/versioned" && sha256sum -c SHA256SUMS)
|
||||
(cd "${hosted_tmp_dir}/global" && sha256sum -c SHA256SUMS)
|
||||
|
||||
- name: 'Publish Aliyun OSS Latest VERSION'
|
||||
if: |-
|
||||
${{ steps.meta.outputs.is_stable == 'true' }}
|
||||
env:
|
||||
ALIYUN_OSS_BUCKET: "${{ vars.ALIYUN_OSS_BUCKET || 'qwen-code-assets' }}"
|
||||
ALIYUN_OSS_PUBLIC_BASE_URL: "${{ vars.ALIYUN_OSS_PUBLIC_BASE_URL || 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com' }}"
|
||||
RELEASE_TAG: '${{ env.RELEASE_TAG }}'
|
||||
run: |-
|
||||
set -euo pipefail
|
||||
|
||||
printf '%s\n' "${RELEASE_TAG}" > "${RUNNER_TEMP}/qwen-code-latest-version"
|
||||
ossutil cp "${RUNNER_TEMP}/qwen-code-latest-version" "oss://${ALIYUN_OSS_BUCKET}/releases/qwen-code/latest/VERSION" -c "${RUNNER_TEMP}/.ossutilconfig" -f --acl public-read
|
||||
|
||||
latest_version="$(curl -fsSL --connect-timeout 15 --max-time 300 "${ALIYUN_OSS_PUBLIC_BASE_URL}/releases/qwen-code/latest/VERSION" | tr -d '[:space:]')"
|
||||
if [[ "${latest_version}" != "${RELEASE_TAG}" ]]; then
|
||||
echo "::error::Aliyun latest VERSION points to ${latest_version}, expected ${RELEASE_TAG}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: 'Cleanup Aliyun OSS Credentials'
|
||||
if: '${{ always() }}'
|
||||
run: |-
|
||||
rm -f "${RUNNER_TEMP}/.ossutilconfig"
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@ -56,6 +56,9 @@ bundle
|
||||
junit.xml
|
||||
packages/*/coverage/
|
||||
|
||||
# PR body draft
|
||||
pr_body.md
|
||||
|
||||
# Generated files
|
||||
packages/cli/src/generated/
|
||||
packages/core/src/generated/
|
||||
|
||||
@ -23,15 +23,10 @@ Create a well-structured pull request with proper description and title.
|
||||
|
||||
3. **Write PR description**
|
||||
|
||||
- Use PR Template below
|
||||
- Summarize changes clearly
|
||||
- Include context and motivation
|
||||
- List any breaking changes
|
||||
- Link related issues if provided, or use "No linked issues"
|
||||
- Leave the "Screenshots / Video Demo" section empty for the author to fill in
|
||||
manually
|
||||
- Add this line at the end of PR body: "🤖 Generated with [Qwen
|
||||
Code](https://github.com/QwenLM/qwen-code)", with a line separator
|
||||
- Fill in the PR template below — each section's HTML comment explains what
|
||||
to write. PR title stays in English.
|
||||
- Append at the end of the PR body, with a line separator: "🤖 Generated
|
||||
with [Qwen Code](https://github.com/QwenLM/qwen-code)"
|
||||
|
||||
4. **Set up PR**
|
||||
|
||||
|
||||
136
.qwen/design/2026-05-21-memory-pressure-monitor-design.md
Normal file
136
.qwen/design/2026-05-21-memory-pressure-monitor-design.md
Normal file
@ -0,0 +1,136 @@
|
||||
---
|
||||
title: 'Memory Pressure Monitor'
|
||||
date: '2026-05-21'
|
||||
status: 'implemented'
|
||||
---
|
||||
|
||||
# Memory Pressure Monitor
|
||||
|
||||
## Problem
|
||||
|
||||
Long-running Qwen Code sessions can accumulate memory through large tool
|
||||
results, repeated file reads, chat history, and native/external allocations.
|
||||
Before this change, the core package had diagnostics and session-reset cleanup,
|
||||
but no runtime response when memory pressure rises during normal tool
|
||||
execution.
|
||||
|
||||
The highest-value cache-specific gap is `FileReadCache`: it already has a
|
||||
bounded FIFO size, but it did not have a time-based eviction path. That means a
|
||||
session can retain inactive file-read metadata until the hard entry limit is
|
||||
hit, even when the process is under memory pressure.
|
||||
|
||||
## Goals
|
||||
|
||||
- Add a low-overhead memory pressure check after tool execution.
|
||||
- Prefer surgical cleanup before destructive cleanup.
|
||||
- Respect container memory limits when cgroup v2 or cgroup v1 memory limit
|
||||
files are available.
|
||||
- React to V8 heap pressure before JavaScript heap OOM on high-memory hosts.
|
||||
- Keep subagent/scoped `Config` instances isolated from parent session cleanup.
|
||||
- Make behavior configurable through environment variables without adding a new
|
||||
user-facing settings surface.
|
||||
|
||||
## Non-Goals
|
||||
|
||||
- Do not add a background polling loop.
|
||||
- Do not make explicit GC the default; it only runs when enabled and Node was
|
||||
started with `--expose-gc`.
|
||||
- Do not change prior-read enforcement semantics. Cache eviction can remove old
|
||||
metadata, but it must not weaken stale-file checks for retained entries.
|
||||
|
||||
## Design
|
||||
|
||||
`Config.initialize()` creates one `MemoryPressureMonitor` per initialized
|
||||
`Config`. `getMemoryPressureMonitor()` mirrors the existing `getFileReadCache()`
|
||||
Object.create isolation pattern: when a child config is created through
|
||||
prototype delegation, the getter lazily installs an own monitor bound to that
|
||||
child config.
|
||||
|
||||
`CoreToolScheduler.executeSingleToolCall()` calls `scheduleCheck()` in its
|
||||
`finally` block after ending the tool span. `scheduleCheck()` coalesces multiple
|
||||
calls in the same event-loop turn with `queueMicrotask`, so concurrent read-like
|
||||
tool batches do not run one memory check per tool result.
|
||||
|
||||
The monitor uses the stronger of two pressure signals:
|
||||
|
||||
- RSS divided by an effective process memory limit. Prefer cgroup v2
|
||||
`/sys/fs/cgroup/memory.max` when it is a finite positive value; fall back to
|
||||
cgroup v1 `/sys/fs/cgroup/memory/memory.limit_in_bytes`, then to
|
||||
`os.totalmem()` otherwise. cgroup v1's huge "unlimited" sentinel values are
|
||||
ignored.
|
||||
- V8 `heapUsed` divided by `getHeapStatistics().heap_size_limit`.
|
||||
|
||||
Using both signals matters because containers usually fail by RSS/cgroup limit,
|
||||
while local high-memory machines can hit V8 heap OOM long before RSS is a large
|
||||
fraction of total system memory.
|
||||
|
||||
Default thresholds are intentionally conservative enough to react before the OS
|
||||
or container OOM killer does:
|
||||
|
||||
- `softPressureRatio = 0.50`
|
||||
- `hardPressureRatio = 0.65`
|
||||
- `criticalRatio = 0.80`
|
||||
- `cleanupCooldownMs = 5000`
|
||||
- `enableExplicitGC = false`
|
||||
|
||||
Environment overrides:
|
||||
|
||||
- `QWEN_MEMORY_PRESSURE_SOFT`
|
||||
- `QWEN_MEMORY_PRESSURE_HARD`
|
||||
- `QWEN_MEMORY_PRESSURE_CRITICAL`
|
||||
- `QWEN_MEMORY_ENABLE_GC=1`
|
||||
|
||||
Invalid ratios fall back to defaults. Valid ratios must be ordered as
|
||||
`soft < hard < critical`, with a lower soft bound of `0.3` and an upper
|
||||
critical bound of `0.98`. Ratio env vars are parsed strictly with `Number()`,
|
||||
so values such as `0.8extra` are rejected instead of partially accepted.
|
||||
Invalid memory-pressure env configuration writes a visible warning to stderr
|
||||
and to the debug log before falling back to defaults.
|
||||
|
||||
## Cleanup Policy
|
||||
|
||||
Pressure levels map to increasingly strong cleanup:
|
||||
|
||||
- `soft`: evict stale `FileReadCache` entries not accessed in 60 minutes.
|
||||
- `hard`: evict cache entries not accessed in 30 minutes.
|
||||
- `critical`: clear the file-read cache and optionally trigger `global.gc()`.
|
||||
|
||||
The monitor intentionally does not force chat compaction. Compaction can call
|
||||
the model backend and rewrite active chat state, so it should be triggered only
|
||||
from a call site that can safely coordinate with the conversation loop.
|
||||
|
||||
Cleanup is fire-and-forget from the scheduler, but the monitor guards cleanup
|
||||
steps with `cleanupInProgress` and a cooldown timestamp. A higher-pressure
|
||||
cleanup can bypass the cooldown and queue behind an in-progress lower-pressure
|
||||
cleanup, so a `critical` check is not lost while a `soft` cleanup is finishing.
|
||||
After successful cleanup it logs an RSS delta on `setImmediate()`, but RSS
|
||||
movement is diagnostic only: V8 and libc may retain freed pages even when
|
||||
JavaScript objects became collectible. Consecutive failures count cleanup-step
|
||||
exceptions, not unchanged RSS, and the counter is reset on a new session. If
|
||||
three successful cleanup attempts in a row free less than 1% RSS, the monitor
|
||||
emits `memory-cleanup-ineffective` as a diagnostic signal without treating the
|
||||
cleanup step itself as failed.
|
||||
|
||||
## Test Coverage
|
||||
|
||||
The implementation is covered by:
|
||||
|
||||
- threshold validation tests;
|
||||
- environment config parsing, fallback, visible warning, and explicit GC tests;
|
||||
- pressure classification tests using mocked `process.memoryUsage()`;
|
||||
- cgroup v2 `memory.max` and cgroup v1 `memory.limit_in_bytes` behavior;
|
||||
- V8 heap limit behavior;
|
||||
- `scheduleCheck()` coalescing;
|
||||
- scheduler integration that invokes `scheduleCheck()` after tool execution;
|
||||
- soft and critical cleanup actions;
|
||||
- cleanup failure accounting for thrown cleanup steps;
|
||||
- cleanup listener exception isolation and ineffective-cleanup diagnostics;
|
||||
- child `Config` monitor isolation through `Object.create`;
|
||||
- `FileReadCache.evictNotAccessedSince()` behavior.
|
||||
|
||||
## Risks And Tradeoffs
|
||||
|
||||
- RSS can stay flat after cleanup because V8 or libc may retain freed memory.
|
||||
RSS deltas are logged, but unchanged RSS does not count as a cleanup failure.
|
||||
- Time-based file-read cache eviction may reduce fast-path hits for old files,
|
||||
but it preserves recently active entries and only runs under memory pressure.
|
||||
161
.qwen/skills/memory-leak-debug/SKILL.md
Normal file
161
.qwen/skills/memory-leak-debug/SKILL.md
Normal file
@ -0,0 +1,161 @@
|
||||
---
|
||||
name: memory-leak-debug
|
||||
description: Diagnose memory leaks in the Qwen Code CLI using heap snapshots and
|
||||
the chrome-devtools CLI. Use when investigating high memory usage, unbounded
|
||||
growth, or suspected object retention issues.
|
||||
---
|
||||
|
||||
# Memory Leak Debugging
|
||||
|
||||
Diagnose memory leaks in the Qwen Code Node.js CLI by capturing heap snapshots
|
||||
and analyzing retained object sizes via `chrome-devtools` CLI tooling.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- `chrome-devtools` CLI (from `chrome-devtools-mcp` package). If not found,
|
||||
install with: `npm i chrome-devtools-mcp@latest -g` after user confirmation.
|
||||
See https://github.com/ChromeDevTools/chrome-devtools-mcp/blob/main/docs/cli.md
|
||||
- Node.js 22+ (for `--heapsnapshot-signal` support)
|
||||
|
||||
## Step 1: Start the CLI with Snapshot Signal
|
||||
|
||||
Use tmux so you can interact with the TUI and trigger snapshots from another
|
||||
pane. Use the tmux-real-user-testing helper script:
|
||||
|
||||
```bash
|
||||
HELPER=.qwen/skills/tmux-real-user-testing/scripts/tmux-real-user-log.sh
|
||||
eval "$(bash "$HELPER" start memleak . \
|
||||
env QWEN_CODE_NO_RELAUNCH=true NODE_OPTIONS=--heapsnapshot-signal=SIGUSR2 \
|
||||
npm run dev)"
|
||||
echo "SESSION=$SESSION OUTDIR=$OUTDIR"
|
||||
```
|
||||
|
||||
The `eval` exports `SESSION` and `OUTDIR`. Note: shell environment does not
|
||||
persist across separate tool calls — save the session name from the output and
|
||||
use it explicitly in subsequent commands.
|
||||
|
||||
Notes:
|
||||
|
||||
- `npm run dev` runs from TypeScript source via tsx — no build step needed and
|
||||
changes to core/cli are reflected immediately.
|
||||
- `QWEN_CODE_NO_RELAUNCH=true` prevents the CLI from spawning a child process,
|
||||
so PID management is simpler.
|
||||
- `NODE_OPTIONS` propagates the flag through npm → tsx → node.
|
||||
|
||||
Get the PID of the actual node process. With `npm run dev`, there's a process
|
||||
chain (npm → node scripts/dev.js → tsx → node CLI), so walk the tree to the
|
||||
innermost node child:
|
||||
|
||||
```bash
|
||||
NODE_PID=$(bash .qwen/skills/memory-leak-debug/scripts/find-leaf-node.sh "<session-name>")
|
||||
```
|
||||
|
||||
To profile the production bundle instead (e.g., verifying tree-shaking):
|
||||
`npm run bundle` first, then use
|
||||
`env QWEN_CODE_NO_RELAUNCH=true node --heapsnapshot-signal=SIGUSR2 dist/cli.js`
|
||||
as the command. Since node is the direct pane process, PID discovery is simpler:
|
||||
|
||||
```bash
|
||||
NODE_PID=$(tmux list-panes -t "<session-name>" -F '#{pane_pid}')
|
||||
```
|
||||
|
||||
## Step 2: Exercise the Suspected Leak
|
||||
|
||||
Drive the TUI via tmux (see tmux-real-user-testing skill for patterns). Take
|
||||
snapshots at intervals to compare:
|
||||
|
||||
```bash
|
||||
kill -USR2 $NODE_PID # snapshot 1 (baseline)
|
||||
# ... use the CLI via tmux send-keys ...
|
||||
kill -USR2 $NODE_PID # snapshot 2 (after activity)
|
||||
# ... more activity ...
|
||||
kill -USR2 $NODE_PID # snapshot 3 (confirm growth trend)
|
||||
```
|
||||
|
||||
Snapshots are written to the CLI's working directory as
|
||||
`Heap.<timestamp>.<pid>.<seq>.heapsnapshot`.
|
||||
|
||||
## Step 3: Start chrome-devtools Daemon
|
||||
|
||||
```bash
|
||||
chrome-devtools start --experimentalMemory --headless --no-usage-statistics
|
||||
```
|
||||
|
||||
This starts the daemon in file-analysis mode — no browser or live Node
|
||||
connection is needed. The memory tools work entirely on `.heapsnapshot` files.
|
||||
|
||||
## Step 4: Identify the Leak
|
||||
|
||||
### Load and summarize
|
||||
|
||||
```bash
|
||||
chrome-devtools load_memory_snapshot /abs/path/to/snapshot.heapsnapshot
|
||||
```
|
||||
|
||||
Returns total heap size, V8 heap breakdown, node count.
|
||||
|
||||
### Get class-level aggregates with retained sizes
|
||||
|
||||
```bash
|
||||
chrome-devtools get_memory_snapshot_details /abs/path/to/snapshot.heapsnapshot
|
||||
```
|
||||
|
||||
Output is CSV: `uid, className, count, selfSize, maxRetainedSize`.
|
||||
|
||||
Compare across snapshots to find classes whose count or retained size grows
|
||||
unboundedly.
|
||||
|
||||
### Inspect instances of a leaking class
|
||||
|
||||
```bash
|
||||
chrome-devtools get_nodes_by_class /abs/path/to/snapshot.heapsnapshot <uid>
|
||||
```
|
||||
|
||||
Where `<uid>` is from the `get_memory_snapshot_details` output. Returns
|
||||
individual instances with their `id`, `retainedSize`, and `nodeIndex`.
|
||||
|
||||
### Trace retainer chains
|
||||
|
||||
```bash
|
||||
chrome-devtools get_node_retainers /abs/path/to/snapshot.heapsnapshot <nodeId>
|
||||
```
|
||||
|
||||
Where `<nodeId>` is the `id` field from `get_nodes_by_class`. Shows what holds
|
||||
the object alive — follow the chain to find the root retention path.
|
||||
|
||||
## Step 5: Identify Root Cause
|
||||
|
||||
Common patterns:
|
||||
|
||||
- **Unbounded buffer/array**: An array that accumulates entries without eviction
|
||||
(e.g., `performance.measure()` → `measureEntryBuffer`).
|
||||
- **Event listener leak**: Listeners registered on long-lived emitters without
|
||||
cleanup.
|
||||
- **Closure capture**: A closure inadvertently captures a large object that
|
||||
outlives its intended scope.
|
||||
- **Module-level cache**: A Map/Set at module scope that grows with usage.
|
||||
|
||||
The retainer chain tells you _what_ holds the object; the class aggregate
|
||||
growth rate tells you _how fast_ it leaks.
|
||||
|
||||
## Step 6: Verify Fix
|
||||
|
||||
After applying the fix:
|
||||
|
||||
1. Rebuild: `npm run bundle`
|
||||
2. Repeat Steps 1-4 with the same workload.
|
||||
3. Confirm the leaking class count stabilizes (no longer grows with activity).
|
||||
|
||||
## Cleanup
|
||||
|
||||
```bash
|
||||
HELPER=.qwen/skills/tmux-real-user-testing/scripts/tmux-real-user-log.sh
|
||||
bash "$HELPER" finish "<session-name>" "<outdir>"
|
||||
chrome-devtools stop
|
||||
rm *.heapsnapshot # if no longer needed
|
||||
```
|
||||
|
||||
## Worked Example
|
||||
|
||||
See `examples/react-reconciler-performance-measure-leak.md` for the ink 7
|
||||
upgrade leak that caused ~143 MB retention from `PerformanceMeasure` objects.
|
||||
@ -0,0 +1,65 @@
|
||||
# React Reconciler PerformanceMeasure Leak
|
||||
|
||||
## Symptom
|
||||
|
||||
After the ink 6→7 upgrade (v0.15.11), moderate CLI usage caused heap to grow
|
||||
to 300+ MB. RSS climbed steadily and never stabilized.
|
||||
|
||||
## Diagnosis
|
||||
|
||||
### Snapshot comparison
|
||||
|
||||
Took 5 snapshots over ~25 minutes of normal usage.
|
||||
|
||||
Snapshot #1 (baseline):
|
||||
|
||||
```
|
||||
PerformanceMeasure: count=184, retainedSize=184 kB
|
||||
```
|
||||
|
||||
Snapshot #5 (after activity):
|
||||
|
||||
```
|
||||
PerformanceMeasure: count=150,716, retainedSize=146,798 kB (~143 MB)
|
||||
```
|
||||
|
||||
Growth: ~800x over the session. Linear with number of React renders.
|
||||
|
||||
### Retainer chain
|
||||
|
||||
```
|
||||
chrome-devtools get_node_retainers <snapshot> 1003471
|
||||
```
|
||||
|
||||
Showed `PerformanceMeasure` instances retained by `(object elements)` → `Array`
|
||||
— the global `measureEntryBuffer` that Node.js maintains for
|
||||
`performance.measure()` calls.
|
||||
|
||||
### Source identification
|
||||
|
||||
`react-reconciler` ≥0.33 (pulled in by ink 7) calls `performance.measure()` on
|
||||
every component render in its **development build**. The dev/prod build is
|
||||
selected at runtime via `process.env.NODE_ENV`. Since the esbuild config never
|
||||
set `NODE_ENV` to `"production"`, the bundle shipped both builds and selected
|
||||
dev at runtime.
|
||||
|
||||
## Fix
|
||||
|
||||
Set `process.env.NODE_ENV` to `"production"` in esbuild's `define` map so the
|
||||
conditional require resolves statically and the entire 15K-line dev build is
|
||||
tree-shaken:
|
||||
|
||||
```js
|
||||
// esbuild.config.js
|
||||
define: {
|
||||
'process.env.NODE_ENV': JSON.stringify('production'),
|
||||
}
|
||||
```
|
||||
|
||||
Bundle shrank by ~700 KB / 15,800 lines. PerformanceMeasure objects no longer
|
||||
accumulate.
|
||||
|
||||
## Commit
|
||||
|
||||
`dbdc94be9` — fix(build): tree-shake React reconciler dev build to prevent
|
||||
PerformanceMeasure leak
|
||||
16
.qwen/skills/memory-leak-debug/scripts/find-leaf-node.sh
Executable file
16
.qwen/skills/memory-leak-debug/scripts/find-leaf-node.sh
Executable file
@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
# Find the innermost node child process in a tmux session.
|
||||
# Usage: find-leaf-node.sh <tmux-session-name>
|
||||
set -euo pipefail
|
||||
|
||||
session=${1:?Usage: find-leaf-node.sh <tmux-session-name>}
|
||||
|
||||
pid=$(tmux list-panes -t "$session" -F '#{pane_pid}' | head -1)
|
||||
|
||||
while true; do
|
||||
child=$(pgrep -P "$pid" node 2>/dev/null | head -1 || true)
|
||||
[ -z "$child" ] && break
|
||||
pid=$child
|
||||
done
|
||||
|
||||
echo "$pid"
|
||||
30
AGENTS.md
30
AGENTS.md
@ -3,6 +3,24 @@
|
||||
This file provides guidance to Qwen Code when working with code in this
|
||||
repository.
|
||||
|
||||
## Working Principles
|
||||
|
||||
### Simplicity First
|
||||
|
||||
**Minimum code that solves the problem. Nothing speculative.**
|
||||
**(This is the principle we care about most.)**
|
||||
|
||||
- No features beyond what was asked.
|
||||
- No abstractions for single-use code.
|
||||
- No "flexibility" or "configurability" that wasn't requested.
|
||||
- No error handling for impossible scenarios.
|
||||
- If you write 200 lines and it could be 50, rewrite it.
|
||||
|
||||
Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes,
|
||||
simplify.
|
||||
|
||||
_Adapted from Andrej Karpathy's [CLAUDE.md](https://github.com/multica-ai/andrej-karpathy-skills/blob/main/CLAUDE.md)._
|
||||
|
||||
## Common Commands
|
||||
|
||||
### Building
|
||||
@ -101,6 +119,9 @@ npm run preflight # Full check: clean → install → format → lint → build
|
||||
between packages
|
||||
- **Tests**: Collocated with source (`file.test.ts` next to `file.ts`),
|
||||
vitest framework
|
||||
- **File naming**: `PascalCase.tsx` for React components, `kebab-case.ts` for
|
||||
new non-component files. Leave existing `camelCase` files alone — renaming breaks `git blame` and imports.
|
||||
- **Comments**: Default to none. Add only when _why_ is non-obvious; don't delete existing ones as cleanup.
|
||||
- **Commits**: Conventional Commits (e.g., `feat(cli): Add --json flag`)
|
||||
- **Node.js**: Development and production both require `>=22` (Ink 7 + React 19.2 requirement)
|
||||
|
||||
@ -158,8 +179,13 @@ applicable.
|
||||
|
||||
- **PR description**: explain the motivation and changes in prose. Avoid
|
||||
referencing file names or function names.
|
||||
- **Reviewer Test Plan**: describe behaviors a reviewer should verify and what
|
||||
to expect, not scripted test commands.
|
||||
- **Reviewer Test Plan** (template section): describe behaviors a reviewer
|
||||
should verify and what to expect, not scripted test commands. Use **How to
|
||||
verify** for reproduction steps; Before/After for TUI evidence when
|
||||
applicable.
|
||||
- **Line wrapping**: do not hard-wrap the PR body at a fixed column width.
|
||||
GitHub renders single newlines as `<br>`, so a wrapped description displays
|
||||
as a narrow column. Write each paragraph or list item as one long line.
|
||||
|
||||
## Project Directories
|
||||
|
||||
|
||||
@ -17,13 +17,15 @@ npm install
|
||||
|
||||
### Setup Content
|
||||
|
||||
Link the documentation content from the parent `docs` directory:
|
||||
Prepare the public documentation content from the parent `docs` directory:
|
||||
|
||||
```bash
|
||||
npm run link
|
||||
```
|
||||
|
||||
This creates a symbolic link from `../docs` to `content` in the project.
|
||||
This creates a `content` directory with copies of the public docs sections.
|
||||
Internal planning, design, and E2E notes remain outside the docs site content
|
||||
tree.
|
||||
|
||||
### Development
|
||||
|
||||
|
||||
@ -7,10 +7,10 @@
|
||||
"type": "module",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"link": "ln -s ../docs content",
|
||||
"link": "node scripts/link-public-docs.mjs",
|
||||
"clean": "rm -rf .next",
|
||||
"dev": "npm run clean && next --turbopack",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
"test": "vitest run --config vitest.config.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"next": "^16.0.8",
|
||||
@ -18,5 +18,8 @@
|
||||
"nextra-theme-docs": "^4.6.1",
|
||||
"react": "^19.2.1",
|
||||
"react-dom": "^19.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"vitest": "^3.2.4"
|
||||
}
|
||||
}
|
||||
|
||||
26
docs-site/scripts/link-public-docs.mjs
Normal file
26
docs-site/scripts/link-public-docs.mjs
Normal file
@ -0,0 +1,26 @@
|
||||
import { cp, mkdir, rm, symlink } from 'node:fs/promises';
|
||||
import { join } from 'node:path';
|
||||
|
||||
import { PUBLIC_DOC_ROOTS } from '../src/app/public-docs.js';
|
||||
|
||||
const contentDir = 'content';
|
||||
|
||||
async function linkPublicDocs() {
|
||||
try {
|
||||
await rm(contentDir, { force: true, recursive: true });
|
||||
await mkdir(contentDir);
|
||||
await cp('../docs/index.md', join(contentDir, 'index.md'));
|
||||
await cp('../docs/_meta.ts', join(contentDir, '_meta.ts'));
|
||||
|
||||
for (const root of PUBLIC_DOC_ROOTS) {
|
||||
await symlink(join('..', '..', 'docs', root), join(contentDir, root));
|
||||
}
|
||||
} catch (error) {
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
throw new Error(
|
||||
`Failed to link public docs into ${contentDir}: ${message}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
await linkPublicDocs();
|
||||
@ -1,10 +1,23 @@
|
||||
import { generateStaticParamsFor, importPage } from 'nextra/pages';
|
||||
import { notFound } from 'next/navigation';
|
||||
import { useMDXComponents as getMDXComponents } from '../../../mdx-components';
|
||||
import { filterPublicStaticParams, isPublicDocsPath } from '../public-docs';
|
||||
|
||||
export const generateStaticParams = generateStaticParamsFor('mdxPath');
|
||||
const generateAllStaticParams = generateStaticParamsFor('mdxPath');
|
||||
|
||||
export const dynamicParams = false;
|
||||
|
||||
export async function generateStaticParams(...args) {
|
||||
const staticParams = await generateAllStaticParams(...args);
|
||||
return filterPublicStaticParams(staticParams);
|
||||
}
|
||||
|
||||
export async function generateMetadata(props) {
|
||||
const params = await props.params;
|
||||
if (!isPublicDocsPath(params.mdxPath)) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
const { metadata } = await importPage(params.mdxPath);
|
||||
return metadata;
|
||||
}
|
||||
@ -13,6 +26,10 @@ const Wrapper = getMDXComponents().wrapper;
|
||||
|
||||
export default async function Page(props) {
|
||||
const params = await props.params;
|
||||
if (!isPublicDocsPath(params.mdxPath)) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
const {
|
||||
default: MDXContent,
|
||||
toc,
|
||||
|
||||
59
docs-site/src/app/[[...mdxPath]]/page.test.jsx
Normal file
59
docs-site/src/app/[[...mdxPath]]/page.test.jsx
Normal file
@ -0,0 +1,59 @@
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
|
||||
const mocks = vi.hoisted(() => {
|
||||
const generateAllStaticParams = vi.fn();
|
||||
|
||||
return {
|
||||
generateAllStaticParams,
|
||||
generateStaticParamsFor: vi.fn(() => generateAllStaticParams),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock('nextra/pages', () => ({
|
||||
generateStaticParamsFor: mocks.generateStaticParamsFor,
|
||||
importPage: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock('next/navigation', () => ({
|
||||
notFound: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock('../../../mdx-components', () => ({
|
||||
useMDXComponents: () => ({
|
||||
wrapper: ({ children }) => children,
|
||||
}),
|
||||
}));
|
||||
|
||||
describe('generateStaticParams', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it('filters internal docs from Nextra static params', async () => {
|
||||
mocks.generateAllStaticParams.mockResolvedValue([
|
||||
{ mdxPath: [] },
|
||||
{ mdxPath: ['users', 'foo'] },
|
||||
{ mdxPath: ['en', 'users'] },
|
||||
{ mdxPath: ['design', 'bar'] },
|
||||
{ mdxPath: ['plans'] },
|
||||
]);
|
||||
|
||||
const { generateStaticParams } = await import('./page.jsx');
|
||||
|
||||
await expect(generateStaticParams()).resolves.toEqual([
|
||||
{ mdxPath: [] },
|
||||
{ mdxPath: ['users', 'foo'] },
|
||||
{ mdxPath: ['en', 'users'] },
|
||||
]);
|
||||
});
|
||||
|
||||
it('fails closed if Nextra changes the static params shape', async () => {
|
||||
mocks.generateAllStaticParams.mockResolvedValue([{ slug: ['users'] }]);
|
||||
|
||||
const { generateStaticParams } = await import('./page.jsx');
|
||||
|
||||
await expect(generateStaticParams()).rejects.toThrow(
|
||||
'Expected generateStaticParamsFor("mdxPath") to return objects with an mdxPath array.',
|
||||
);
|
||||
});
|
||||
});
|
||||
33
docs-site/src/app/public-docs.js
Normal file
33
docs-site/src/app/public-docs.js
Normal file
@ -0,0 +1,33 @@
|
||||
const LOCALE_SEGMENTS = new Set(['en', 'zh', 'de', 'fr', 'ja', 'ru', 'pt-BR']);
|
||||
|
||||
// Keep this in sync with the public top-level page entries in docs/_meta.ts.
|
||||
// docs-site/scripts/link-public-docs.mjs consumes the same allowlist.
|
||||
export const PUBLIC_DOC_ROOTS = ['users', 'developers'];
|
||||
|
||||
const PUBLIC_DOC_ROOT_SET = new Set(PUBLIC_DOC_ROOTS);
|
||||
|
||||
function publicRootFromSegments(segments = []) {
|
||||
if (segments.length === 0 || (segments.length === 1 && segments[0] === '')) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const rootIndex = LOCALE_SEGMENTS.has(segments[0]) ? 1 : 0;
|
||||
return segments[rootIndex];
|
||||
}
|
||||
|
||||
export function isPublicDocsPath(mdxPath = []) {
|
||||
const root = publicRootFromSegments(mdxPath);
|
||||
return root === undefined || PUBLIC_DOC_ROOT_SET.has(root);
|
||||
}
|
||||
|
||||
export function filterPublicStaticParams(staticParams = []) {
|
||||
return staticParams.filter((staticParam) => {
|
||||
if (!Array.isArray(staticParam?.mdxPath)) {
|
||||
throw new TypeError(
|
||||
'Expected generateStaticParamsFor("mdxPath") to return objects with an mdxPath array.',
|
||||
);
|
||||
}
|
||||
|
||||
return isPublicDocsPath(staticParam.mdxPath);
|
||||
});
|
||||
}
|
||||
43
docs-site/src/app/public-docs.test.js
Normal file
43
docs-site/src/app/public-docs.test.js
Normal file
@ -0,0 +1,43 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
import { filterPublicStaticParams, isPublicDocsPath } from './public-docs.js';
|
||||
|
||||
describe('isPublicDocsPath', () => {
|
||||
it.each([
|
||||
[[], true],
|
||||
[[''], true],
|
||||
[['users', 'foo'], true],
|
||||
[['design', 'bar'], false],
|
||||
[['en', 'users'], true],
|
||||
[['plans'], false],
|
||||
[['en'], true],
|
||||
])('returns %s for %j', (mdxPath, expected) => {
|
||||
expect(isPublicDocsPath(mdxPath)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('filterPublicStaticParams', () => {
|
||||
it('keeps public paths and rejects internal docs paths', () => {
|
||||
expect(
|
||||
filterPublicStaticParams([
|
||||
{ mdxPath: [] },
|
||||
{ mdxPath: [''] },
|
||||
{ mdxPath: ['users', 'foo'] },
|
||||
{ mdxPath: ['en', 'developers'] },
|
||||
{ mdxPath: ['design', 'bar'] },
|
||||
{ mdxPath: ['plans'] },
|
||||
]),
|
||||
).toEqual([
|
||||
{ mdxPath: [] },
|
||||
{ mdxPath: [''] },
|
||||
{ mdxPath: ['users', 'foo'] },
|
||||
{ mdxPath: ['en', 'developers'] },
|
||||
]);
|
||||
});
|
||||
|
||||
it('fails closed if Nextra changes the static params shape', () => {
|
||||
expect(() => filterPublicStaticParams([{ slug: ['users'] }])).toThrow(
|
||||
'Expected generateStaticParamsFor("mdxPath") to return objects with an mdxPath array.',
|
||||
);
|
||||
});
|
||||
});
|
||||
7
docs-site/vitest.config.js
Normal file
7
docs-site/vitest.config.js
Normal file
@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
include: ['src/**/*.test.{js,jsx}'],
|
||||
},
|
||||
});
|
||||
@ -4,6 +4,8 @@
|
||||
|
||||
## 背景
|
||||
|
||||
> 本节描述本 PR 落地**之前**的状态(pre-redesign behavior)。下文出现的 `COMPRESSION_TOKEN_THRESHOLD`、`thinkingConfig.includeThoughts = true`、`hasFailedCompressionAttempt`、以及具体的 file:line 引用都对应 PR #4345 合入前的代码——合入后这些符号 / 行号会不再有效。
|
||||
|
||||
当前 qwen-code 的自动压缩仅使用单一比例阈值 `COMPRESSION_TOKEN_THRESHOLD = 0.7`(`chatCompressionService.ts:33`),所有窗口大小共用同一比例。对比 claude-code 的「绝对 token 梯子」(autoCompact.ts:62-65),qwen-code 存在三个具体问题:
|
||||
|
||||
1. **大窗口下预留过多**:1M 模型 70% 阈值在 700K 触发,剩余 300K 远超摘要 + 输出实际所需的 ~33K
|
||||
@ -136,12 +138,22 @@ export interface ChatCompressionSettings {
|
||||
|
||||
### Breaking change 处理
|
||||
|
||||
启动时 `Config` 加载发现 `chatCompression.contextPercentageThreshold` 存在:
|
||||
**用户面:** 启动时 `Config` 加载发现 `chatCompression.contextPercentageThreshold` 存在:
|
||||
|
||||
- 写入 stderr 一行警告:`"chatCompression.contextPercentageThreshold has been removed and is now controlled by built-in thresholds."`
|
||||
- **不**报错、**不**阻塞启动
|
||||
- 字段值被忽略
|
||||
|
||||
**SDK 面(R5.4):** `CompressOptions` 的 `hasFailedCompressionAttempt: boolean` 字段重命名为 `consecutiveFailures: number`。两点差异:
|
||||
|
||||
| | 旧字段 | 新字段 |
|
||||
| ---- | ------------------------------ | -------------------------------------------------------------------- |
|
||||
| 名称 | `hasFailedCompressionAttempt` | `consecutiveFailures` |
|
||||
| 类型 | `boolean` | `number` |
|
||||
| 语义 | `true` = 永久禁用 auto-compact | `>= MAX_CONSECUTIVE_FAILURES`(默认 3)= 暂时禁用直到 force 成功重置 |
|
||||
|
||||
仓库内只有 `GeminiChat.tryCompress` 一个内部消费方,所以内部 migration 风险低;但 `@qwen-code/qwen-code-core` 是 published package、`CompressOptions` 在 d.ts 里可见,下游 SDK 直接调 `service.compress({ ..., hasFailedCompressionAttempt: true })` 的代码会拿到 TS 编译错误。**迁移指引:** 把 `true` 改为 `MAX_CONSECUTIVE_FAILURES`(或任意 >= 3 的整数),`false` 改为 `0`。如果调用方维护自己的失败计数,直接传入即可。
|
||||
|
||||
## Token 估算补偿
|
||||
|
||||
qwen-code 的 `lastPromptTokenCount` 来自上一轮 API response 的 `usageMetadata.totalTokenCount`([geminiChat.ts:1217-1232](packages/core/src/core/geminiChat.ts:1217))。这导致:
|
||||
@ -415,4 +427,10 @@ const { warn, auto, hard, effectiveWindow } =
|
||||
## 开放问题(等 review)
|
||||
|
||||
1. **breaking change 强度**:警告 + 忽略字段 vs 启动报错。当前选警告,需要确认对企业部署/团队配置是否够友好
|
||||
2. **小窗口(32K)下 hard 与 auto 退化为同一值**:用户视角是否需要在 `/context` 明示「该窗口下 hard 已退化」
|
||||
|
||||
## 已结案
|
||||
|
||||
2. **小窗口(≤ ~76.7K)下 hard 与 auto 退化为同一值** — 决定**不在 `/context` 明示**。理由:
|
||||
- 塌缩范围不只是 32K,所有 `effectiveWindow - HARD_BUFFER ≤ 0.7 × window` 的窗口都塌缩(包括 64K)
|
||||
- 用户行为不变:塌缩窗口上 `currentTier` 跳过 `'auto'` 直接报 `'hard'`(`contextCommand.ts:43-44` 先判 `>= hard`),`context-high` band(`auto ≤ t < hard`)变成空带,少一档提示在小窗口上是合理的——窗口本身就小,用户大概率手动管理上下文
|
||||
- 如果未来有真实用户报告"小窗口看不到中间档提示",再决定加 UI 标注或调整 `context-high` 触发条件(这是 UI 工作,不是 spec 工作)。当前选不增加 UI 复杂度
|
||||
|
||||
574
docs/design/rt-optimization/reduce-rounds-via-skill-design.md
Normal file
574
docs/design/rt-optimization/reduce-rounds-via-skill-design.md
Normal file
@ -0,0 +1,574 @@
|
||||
# Agent Loop 减轮方案:从 Skill 设计入手
|
||||
|
||||
> 与 `rt-optimization-design.md` 同目录,互为补充:那份文档讨论**框架机制**层面减轮(D1 跳过末尾总结轮、D2 fast 路由、D4 prevalidate),这份文档主张**减轮的真正杠杆在 skill/tool 设计层**,并提出一条不依赖框架改造、不依赖 cache hit rate 数据的可实施路径。
|
||||
|
||||
---
|
||||
|
||||
## 0. 验收 Spec(开发前置 gate)
|
||||
|
||||
> 本节是开发的**前置 gate** — 列出哪些 spec 必须在动手前确认、哪些 spec 必须等数据驱动。把 spec 前置而非"做完再看指标",是为了避免:(a) 写完才发现指标不可测、(b) 阈值随结果飘移导致结论失真、(c) 没设止损线让方案陷入"看起来在做、其实没收益"。
|
||||
>
|
||||
> **本 spec 框架的适用边界**:本框架假设方向正确性可以在 P1.5 基线测量后判断。这个假设对"减轮"场景成立,因为它有清晰的可测信号(轮数、followup_rate、batch_size)。**超出此假设的场景**(例如未来用同一框架做"质量优化"等难以量化的方向),spec 前置可能反而阻碍快速学习;遇到时回退到 §0.5 治理流程重新评估,不机械套用本框架。
|
||||
|
||||
**spec 分四层 — 时机不同**:
|
||||
|
||||
| 层级 | 类型 | 锁定时机 |
|
||||
| ---- | --------------------------------------- | -------------------------------- |
|
||||
| §0.1 | 工程层 spec(数据管道、代码改动正确性) | **前置**、可立刻锁定 |
|
||||
| §0.2 | 统计层 spec(项目"算成功"的指标) | **前置**、阈值待 P1.5 基线后锁定 |
|
||||
| §0.3 | 止损线("如果发生就放弃"硬条件) | **前置**、不可移动 |
|
||||
| §0.4 | per-skill spec(具体改哪个、目标多少) | **后置**、Layer 1 数据驱动 |
|
||||
|
||||
### 0.1 工程层 spec(必须前置 · 可立刻锁定)
|
||||
|
||||
数据管道与代码改动的正确性 spec — 不依赖任何业务判断或基线数据,开发前就该锁定:
|
||||
|
||||
- **qwen-logger 链路通畅**(§4.1.1b):skill_launch 事件能同时落到 OTLP 和 qwen-logger 两条管道
|
||||
- **`prompt_id` 串联**:单个 user prompt 触发的 `skill_launch` + 后续 `tool_call` 能用同一个 `prompt_id` grep 出完整 trail
|
||||
- **`batch_size` 非 undefined**(§4.3.2 方向 A):单工具 batch 显式设 `batch_size = 1` / `batch_position = 0`
|
||||
- **SQL 可跑通**(§4.1.2):离线 SQL 在真实 telemetry backend 输出非空且能区分高/低 followup_rate skill
|
||||
- **基线方差 < P50 × 20%**(P1.5):基线测量稳定(否则后续 A/B 对比不可信)—— 注:本条虽列在 §0.1 工程层,但**锁定依赖 P1.5 基线数据**,是 §0.1 中唯一的后置验证项;P1.5 未通过则 §0.2 阈值无法可信锁定
|
||||
- **Skill 体积预算**(Layer 2 改造):内联 followup 后,skill 描述 token 数不超过改造前的 2×,且绝对值 ≤ 500 tokens(取较小值)。超过则按 §4.2 拆分 skill 而非合并。本条与 §7 第 2 条、§4.2 已有约束对齐,前置到 spec 层
|
||||
- **`npm run preflight` 全过**:每个 PR 的硬门槛
|
||||
|
||||
### 0.2 统计层 spec(必须前置 · 阈值待 P1.5 后锁定)
|
||||
|
||||
项目算"统计意义上成功"的指标 — **方向**前置定下,**阈值**等基线测出来后锁定(避免凭空填数字):
|
||||
|
||||
| 指标 | 方向 | 锁定时机 | 当前占位阈值(待校准) |
|
||||
| ---------------------------------- | -------- | --------- | ---------------------- |
|
||||
| top-3 skill 加权 `followup_rate` | ↓ | P1.5 末 | ≥ 30% |
|
||||
| 含 skill 的会话端到端 RT P50 | ↓ | P1.5 末 | ≥ 2s |
|
||||
| `batch_size > 1` 的 tool_call 占比 | ↑ | P3 前 | ≥ 30% |
|
||||
| 改造的 skill 触发场景 A/B 显著性 | p < 0.05 | P2 改完前 | n 待定 |
|
||||
|
||||
> **关键约束**:占位阈值不是承诺。P1.5 基线如果显示"top-5 skill 加权 followup_rate < 30%"(触发 §0.3 止损线 #1),项目终止;**不能为了让阈值"达到"而下调 spec**。
|
||||
>
|
||||
> **怎么测**:每个指标的测量方法、SQL 模板、A/B 设计见 §5.1-§5.2;统计显著性(p < 0.05)的样本量计算见 §5.1。
|
||||
|
||||
### 0.3 止损线(必须前置 · P-1 锁定后受限可调)
|
||||
|
||||
§5.3 已列。这些是"如果发生就放弃"的硬条件 — **任何情况下不能为了达成 §0.2 统计层 spec 而放宽止损线**。
|
||||
|
||||
- **结果指标**(3 条):top-5 加权 `followup_rate < 30%` / 改完 2 个 skill RT P50 ↓ < 1s / Layer 3 后 `batch_size P50` 仍 = 1
|
||||
- **过程指标**(3 条):skill 命中率 ↓ ≥ 5pp / 内联 followup 失败率 ≥ 5% / 用户取消率 ↑ ≥ 2pp
|
||||
|
||||
详见 §5.3。
|
||||
|
||||
**可调性规则**(避免无数据支撑的纪律刚性):
|
||||
|
||||
| 阶段 | 可否调整 | 调整方向 |
|
||||
| --------------------- | ---------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| P-1 锁定时 | ✅ 任意调整(基于历史 telemetry 或共识) | 任意 |
|
||||
| P-1 锁定后 → P1.5 末 | ❌ 不可调整 | — |
|
||||
| P1.5 末(基线出来时) | ✅ 仅允许**放宽**一次 | 放宽(如 30% → 25%)需附数据证据 + 2 人评审;**不允许收紧**(避免事后追加止损) |
|
||||
| P1.5 之后 | ❌ 不可调整 | — |
|
||||
|
||||
> 阈值占位值(30% / 1s / 5pp 等)当前**无历史数据支撑**,是 P-1 评审前的工程师直觉。如果 P-1 评审时能拿到最近 4 周历史 telemetry,应基于历史数据校准止损线;拿不到则保留占位值,P1.5 末执行上面的"放宽一次"规则。
|
||||
|
||||
### 0.4 per-skill spec(必须后置 · 数据驱动)
|
||||
|
||||
具体改哪个 skill、目标 `followup_rate` 改到多少 — **Layer 1 数据出来前不锁定**。
|
||||
|
||||
不锁定的理由:先验设计 vs 后验数据可能差很多。强行前置会重蹈 `rt-optimization-design.md` §7 D2 路线的覆辙 —— 前置假设"fast 模型快 2-3s"被 cache 实装这一后验事实推翻,导致方案净收益接近 0 甚至为负。
|
||||
|
||||
**产出位置**:per-skill spec 在 P1.5 末由数据驱动产出,每个 Layer 2 PR 的 description 里独立声明(不进 design 文档,避免文档每改一个 skill 就改)。
|
||||
|
||||
**per-skill spec 结构模板**(与 §4.2 的 PR description 必含项对齐 — 这两个清单是同一份,§4.2 是过程视角、本节是 spec 视角):
|
||||
|
||||
| 字段 | 内容 | 数据来源 |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------- |
|
||||
| 1. 当前数据 | invocation_count、followup_rate、top followup tools | Layer 1 telemetry |
|
||||
| 2. 目标 | followup_rate 从 X% 降到 Y% | 基于 §0.2 改善方向,绝对值 PR 内自行定 |
|
||||
| 3. 改造范围 | 内联哪些 followup(read/grep/shell read-only),明确**不**内联什么(write 操作 / 跨 skill / 深度推理) | §4.2 改造模式表 |
|
||||
| 4. 输出契约更新 | skill 描述里加的预声明("Returns: ...") | §3.2 改造示例 |
|
||||
| 5. A/B 计划 | 改造后 2 周观察 followup_rate / RT P50 / 过程指标,对照 §5.1 验收线 | §5.1 |
|
||||
| 6. 体积证明 | 改造前后 skill 描述 token 数(用 tiktoken 估算),不得超 §0.1"Skill 体积预算" | §0.1 第 6 条 |
|
||||
|
||||
### 0.5 spec 治理
|
||||
|
||||
- **修改 §0.1 / §0.3 spec** 需 design 文档更新 + PR 评审;§0.3 仅遵循 §0.3"可调性规则"在 P1.5 末窗口内放宽
|
||||
- **修改 §0.2 阈值(P1.5 锁定后)** 需附以下至少一项数据证据:
|
||||
- (a) P1.5 基线测量结果与已锁定阈值的偏差分析(含原始测量记录链接)
|
||||
- (b) 同类项目的公开 benchmark 数据(含来源链接)
|
||||
- (c) 内部 ≥ 2 人评审签字的偏差说明
|
||||
|
||||
PR 评审时若上述证据均无,评审者**有义务** block PR — 不接受"凭工程师直觉调整"
|
||||
|
||||
- **§0.4 per-skill spec** 在数据驱动产出后写入 PR description(按 §0.4 6 项模板),不进 design 文档
|
||||
|
||||
---
|
||||
|
||||
## 1. 背景与定位
|
||||
|
||||
### 1.1 问题
|
||||
|
||||
`rt-optimization-design.md` §1.2 给出的基线:3 轮 agent loop,13.4s 端到端,其中 LLM 调用占 78%。每一轮 ~3-4s。
|
||||
|
||||
```
|
||||
Round 1 (3.8s, 28%): LLM 决策调 skill
|
||||
Round 2 (3.0s, 22%): LLM 决策调 shell
|
||||
Round 3 (3.8s, 28%): LLM 总结
|
||||
```
|
||||
|
||||
`rt-optimization-design.md` §6/§7 经过两轮 review 后,D2/D4 已被否决,D1/D3 也降级为"等浮油完成后再评估"。但**整份原文档都聚焦在末尾的 Round 3(总结轮)或单轮内的微优化(D4)上,完全没有正面讨论 Round 1 → Round 2 这个"中间轮"为什么会出现、能不能消掉**。
|
||||
|
||||
事实是:Round 2 之所以存在,**绝大多数情况是因为 Round 1 调用的 skill 没有返回完整答案**,模型才追加 shell 查询补全。如果 skill 设计成"一次拿到完整结果",3 轮 → 2 轮,省掉的就是 Round 2 那 ~3s — 这是与 D1 完全不重叠的收益面。
|
||||
|
||||
### 1.2 与 rt-optimization-design 的关系
|
||||
|
||||
| 减轮方向 | 命中的轮次 | 杠杆位置 | 本文档定位 |
|
||||
| -------------------- | ------------------------------- | ---------------------------- | ---------------------------- |
|
||||
| D1 `skipLlmRound` | 末尾总结轮 | 框架机制 + per-tool opt-in | 兜底,**放在 Layer 2 之后** |
|
||||
| D2 fast 路由 | 单轮延迟 | 框架机制 | 已 defer,**不在本文档范围** |
|
||||
| D3 Summarizing 状态 | 末尾总结轮(感知层) | UI 状态机 | 可选,与本方案正交 |
|
||||
| D4 prevalidate | 单轮延迟 | 框架机制 | 已 defer,**不在本文档范围** |
|
||||
| **本方案 Layer 1-3** | **中间决策轮 + 并发未触发的轮** | **skill 设计 + prompt 工程** | **新增方向** |
|
||||
|
||||
### 1.3 核心论点
|
||||
|
||||
减轮的真正杠杆在 skill/tool 设计层,不在 agent 框架。三个理由:
|
||||
|
||||
1. **§1.2 基线本身就暴露问题在 skill** — Round 1 → Round 2 的跳跃是 skill 返回不全才发生的,框架做对了,skill 做错了
|
||||
2. **框架级减轮最终也要 per-tool opt-in** — D1 的 `skipLlmRound` 必须每个工具显式标记,绕一圈回到 skill 工程,还多一套不变量修复 + 决策门控成本
|
||||
3. **ROI 局部可测、灰度容易** — 改一个 skill 就少一轮 × 该 skill 触发次数,不依赖 cache hit rate 数据,不依赖跨系统改动
|
||||
|
||||
> **实施前必须先走 §0 验收 Spec 前置评审(P-1 阶段,0.5d)** — §0.1 工程层 spec 和 §0.3 止损线在动手前必须锁定;§0.2 统计层阈值的方向也要前置确认(具体数值等 P1.5 基线后再锁)。跳过 §0 进入 P0 实施 = 默认走"做完才看指标"的反模式,文档不背书这种做法。
|
||||
|
||||
---
|
||||
|
||||
## 2. 设计原则
|
||||
|
||||
1. **不改 agent 框架** — 不动 `useGeminiStream` / `coreToolScheduler` / `geminiChat` 核心路径
|
||||
2. **数据驱动选优先级** — 先建 telemetry,让数据告诉你改哪个 skill,不靠拍脑袋
|
||||
3. **per-skill 可测可灰度** — 每个 skill 改造独立 A/B,失败局部回退
|
||||
4. **复利优先** — 收益 = 单次减轮收益 × 触发频率,高频 skill 优先
|
||||
5. **不绑定 D1** — 本方案的成功不依赖 D1 是否落地
|
||||
|
||||
---
|
||||
|
||||
## 3. 三层方案
|
||||
|
||||
### 3.1 Layer 1:减轮 Telemetry(找金矿)
|
||||
|
||||
**目标**:让数据告诉你哪些 skill 最值得改 — 即"用了这个 skill 之后,模型有多大概率追加一次工具调用"。
|
||||
|
||||
**核心字段**(per-turn、per-skill-invocation):
|
||||
|
||||
```typescript
|
||||
interface SkillFollowupRecord {
|
||||
skill_name: string;
|
||||
prompt_id: string; // 关联同一 user prompt 内的所有 events
|
||||
turn_index: number; // 该 skill 在 loop 里是第几轮
|
||||
followup_tool_names: string[]; // 同一 prompt_id 下,skill 之后还调了哪些工具
|
||||
followup_count: number; // followup_tool_names.length
|
||||
followup_kinds: Kind[]; // Read/Edit/Execute/...
|
||||
next_turn_is_terminal: boolean; // skill 之后下一轮就出文字(不再调工具)
|
||||
user_followup_within_30s: boolean; // 用户在结果显示后 30s 内追加新 prompt(质量回归信号)
|
||||
}
|
||||
```
|
||||
|
||||
**关键指标**:
|
||||
|
||||
- `skill_followup_rate = sum(followup_count > 0) / total_invocations`
|
||||
- `terminal_after_skill_rate = sum(next_turn_is_terminal) / total_invocations`
|
||||
- 按 `(skill_name, top followup tool)` 聚合 — 看哪些 skill 之后最常追加哪个工具
|
||||
|
||||
**金矿判定**:
|
||||
|
||||
```
|
||||
(invocation_count_weekly × skill_followup_rate) ≥ threshold
|
||||
↓
|
||||
该 skill 是减轮金矿,优先 Layer 2 改造
|
||||
```
|
||||
|
||||
阈值建议:top-3 按上式排序的 skill,先改前 2 个。
|
||||
|
||||
### 3.2 Layer 2:Skill 输出完整化
|
||||
|
||||
**目标**:让被识别为金矿的 skill 一次返回完整答案,消除 Round 1 → Round 2 的跳跃。
|
||||
|
||||
**改造模式(按 followup 类型分类)**:
|
||||
|
||||
| Followup 模式 | 典型场景 | 改造方向 |
|
||||
| --------------------------- | -------------------------- | ---------------------------------- |
|
||||
| skill → `read_file` | skill 给路径,模型再读 | skill 内部直接读,返回内容 |
|
||||
| skill → `grep/glob` | skill 给目录,模型再搜 | skill 内部搜好,返回匹配 |
|
||||
| skill → `shell` (read-only) | skill 给命令,模型再执行 | skill 内部跑命令,返回输出 |
|
||||
| skill → `shell` (write) | skill 给方案,模型再执行写 | **保留**(写操作要确认,不应合并) |
|
||||
| skill → another skill | 链式调用 | **不合并**(保持组合性) |
|
||||
|
||||
**改造检查清单(per-skill PR 模板)**:
|
||||
|
||||
1. 在 skill 描述里**预声明输出契约**:明确写 "Returns: full file content / matched lines / command output",让模型知道不必追加查询
|
||||
2. 在 skill 内部**完成所有 read-only followup**:把 telemetry 显示 >50% 追加率的 read/search 操作内联进 skill
|
||||
3. **不内联 write 操作**:写操作需要用户确认,必须单独成轮
|
||||
4. **不内联深度推理 followup**:如果 followup 是"基于此再分析",那是模型的事,不是 skill 的事
|
||||
5. **附 A/B telemetry**:改造后 2 周对比 `followup_rate` 是否下降到 <20%
|
||||
|
||||
**典型改造示例(示意)**:
|
||||
|
||||
改造前:
|
||||
|
||||
```
|
||||
skill "list-workspaces" returns: ["ws_a", "ws_b"]
|
||||
→ Round 2: model calls shell to get details for each workspace
|
||||
```
|
||||
|
||||
改造后:
|
||||
|
||||
```
|
||||
skill "list-workspaces" returns:
|
||||
- ws_a (owner: foo, last_active: 2026-05-20, status: active)
|
||||
- ws_b (owner: bar, last_active: 2026-05-01, status: archived)
|
||||
description updated: "Returns workspaces with owner, last_active, status"
|
||||
→ Round 2 disappears for ~80% of queries
|
||||
```
|
||||
|
||||
### 3.3 Layer 3:Prompt 教育模型并发
|
||||
|
||||
**目标**:对于独立工具(多文件读、多目录搜),让模型在同一轮里并发发起 tool_calls,把 N 轮压成 1 轮。
|
||||
|
||||
**前提**:基础设施已就绪 — `tools/tools.ts:818` 的 `CONCURRENCY_SAFE_KINDS` + `coreToolScheduler` 的 `partitionToolCalls` 已经能并发执行同 batch 内的 read/search/fetch 工具。**差的只是模型主动发起并发 tool_calls 的意愿**,qwen-coder 默认偏串行。
|
||||
|
||||
**改动位置**:`packages/core/src/core/prompts.ts`(已审计过,加在 `# Final Reminder` 段 L396 附近不会破坏 cache 命中以外的事 — 仅一次性预热成本)。
|
||||
|
||||
**指导文本(示意,需 A/B 调优)**:
|
||||
|
||||
```
|
||||
When you need to call multiple independent read-only tools (read_file,
|
||||
grep, glob, web_fetch), emit them in a SINGLE tool_calls batch — do NOT
|
||||
call them sequentially across rounds. They will execute concurrently.
|
||||
|
||||
Examples:
|
||||
- Reading 3 files for comparison: emit 3 read_file calls in one batch
|
||||
- Searching for 2 patterns: emit 2 grep calls in one batch
|
||||
|
||||
Do NOT batch when the second call depends on the first call's result.
|
||||
```
|
||||
|
||||
**生效衡量**:新增 telemetry 字段 `batch_size`(同 turn 内 tool_calls 数量)— 改 prompt 前后对比分布。
|
||||
|
||||
#### 3.3.1 扩展 `CONCURRENCY_SAFE_KINDS`(Layer 3 子项)
|
||||
|
||||
prompt 教育模型并发只是供给侧(模型愿意一次发多个 tool_calls),但 `tools/tools.ts:818` 的 `CONCURRENCY_SAFE_KINDS = { Read, Search, Fetch }` 决定**实际能并发执行的工具范围**:`partitionToolCalls`(`coreToolScheduler.ts:775`)会把"连续的安全工具"打包成 concurrent batch,其余各自串行。
|
||||
|
||||
如果模型按指导一次发了 3 个 tool_calls 但其中 1 个属于 `Kind.Execute` 且不在安全集合,整个 batch 就会被拆开串行执行 — Layer 3 prompt 改动的收益会被运行时调度抵消。
|
||||
|
||||
**扩展候选**(按风险递增):
|
||||
|
||||
- `Kind.Think`(含 save_memory / todo_write)—— **不要加**,有隐式写入
|
||||
- 只读 shell(`isShellCommandReadOnly()` 返回 true 的 Execute)—— `partitionToolCalls` 已有特判(`coreToolScheduler.ts` `partitionToolCalls` 注释里提到 "Execute (shell) is safe only when isShellCommandReadOnly() returns true"),现状已覆盖,无需改 `CONCURRENCY_SAFE_KINDS`
|
||||
- MCP 工具按 `Kind` 分类 —— 各 MCP server 行为差异大,需要在工具注册时显式 opt-in 才安全
|
||||
|
||||
**结论**:当前集合已经合理,**Layer 3 不依赖扩展 `CONCURRENCY_SAFE_KINDS`**。本节存在的意义是:在收完 `batch_size` telemetry 数据后,**如果发现"并发 batch P50 < 期望值",先检查是不是被 `partitionToolCalls` 切断而非模型不并发**。这是 Layer 3 A/B 失败时的一个诊断路径,不是必做项。
|
||||
|
||||
> 信用:codex review 提出"扩展 `CONCURRENCY_SAFE_KINDS` 是被忽略的杠杆"。核对后判断为:现状已有 `isShellCommandReadOnly` 特判覆盖最大头,扩展集合本身收益小、风险大;保留作为诊断路径。
|
||||
|
||||
---
|
||||
|
||||
## 4. 详细实施
|
||||
|
||||
### 4.1 Layer 1:Telemetry 扩展(1-2d)
|
||||
|
||||
#### 4.1.1 补 `prompt_id` 到 `SkillLaunchEvent`
|
||||
|
||||
**位置**:`packages/core/src/telemetry/types.ts:896`
|
||||
|
||||
当前 `SkillLaunchEvent` 仅含 `skill_name` + `success`,**无 `prompt_id`** — 无法跟同一 turn 内的其他 `ToolCallEvent` 关联。
|
||||
|
||||
```typescript
|
||||
// types.ts:896
|
||||
export class SkillLaunchEvent implements BaseTelemetryEvent {
|
||||
'event.name': 'skill_launch';
|
||||
'event.timestamp': string;
|
||||
skill_name: string;
|
||||
success: boolean;
|
||||
prompt_id: string; // 新增
|
||||
turn_index?: number; // 新增
|
||||
|
||||
constructor(
|
||||
skill_name: string,
|
||||
success: boolean,
|
||||
prompt_id: string, // 新增
|
||||
turn_index?: number, // 新增
|
||||
) { ... }
|
||||
}
|
||||
```
|
||||
|
||||
**调用方更新**:`packages/core/src/tools/skill.ts` 的 4 个 `logSkillLaunch` 调用点(L386, L399, L426, L482),传入 `this.params` 拿不到 `prompt_id` — `BaseToolInvocation` 仅持有 `params`,没有 `request.prompt_id` 字段。**实际实现**用鸭子类型方式注入:`SkillToolInvocation` 暴露 `setPromptId(id)` setter + 私有 `promptId` 字段,`CoreToolScheduler.buildInvocation`(`coreToolScheduler.ts:1253`)在 build 后 duck-type 调 `setPromptId(request.prompt_id)`,对齐既有 `setCallId` hook 的 pattern;invocation 在 `execute()` 内的 4 个 `logSkillLaunch` 都传 `this.promptId`。**早期版本的本节描述("BaseToolInvocation 已有 request.prompt_id")是错的**,已在 PR #4565 review 后更正。
|
||||
|
||||
#### 4.1.1b qwen-logger 链路修复(前置)
|
||||
|
||||
补 `prompt_id` 之前要先解决一个 **既存的链路断点**:`packages/core/src/telemetry/qwen-logger/qwen-logger.ts:908` 定义了 `logSkillLaunchEvent(event)` 方法,但**全仓库无任何调用方** —— `loggers.ts:958` 的 `logSkillLaunch` 直接走 `logs.getLogger(SERVICE_NAME).emit()` 这条 OTLP 路径,绕过了 qwen-logger。
|
||||
|
||||
后果:
|
||||
|
||||
- OTLP 路径上的 skill_launch 事件能到 OTLP collector(已工作),但 qwen-logger 那条专用上报链路目前是死的
|
||||
- 如果 telemetry backend 是从 qwen-logger 消费(而非 OTLP),skill_launch 事件**完全不上报**
|
||||
- §4.1.2 离线 SQL 派生 `SkillFollowupRecord` 依赖 skill_launch 事件落库 —— **必须先验证现在 skill_launch 在 backend 是否可见**
|
||||
|
||||
修复方向二选一:
|
||||
|
||||
- **A**(推荐)在 `loggers.ts:958` 的 `logSkillLaunch` 里加一行 `QwenLogger.getInstance(config)?.logSkillLaunchEvent(event)`,对齐 `logToolCall` 的 `loggers.ts:230` 写法
|
||||
- **B** 确认 backend 只从 OTLP 消费,把 qwen-logger 里的 `logSkillLaunchEvent` 标 `@deprecated` 或删除
|
||||
|
||||
**为什么只补 QwenLogger 一条路径,不对齐 `logToolCall` 的 4 条全路径**:
|
||||
|
||||
`logToolCall`(`loggers.ts:220-247`)实际有 4 条出口:
|
||||
|
||||
1. `uiTelemetryService.addEvent(...)` — UI 展示
|
||||
2. `config.getChatRecordingService()?.recordUiTelemetryEvent(...)` — 聊天历史
|
||||
3. `QwenLogger.getInstance(config)?.logToolCallEvent(...)` — qwen-logger 后端遥测
|
||||
4. OTLP `logger.emit(...)` — OpenTelemetry
|
||||
|
||||
skill_launch 是**纯后端遥测事件**,不需要在 UI 上展示(用户已经看到 SkillTool 的 returnDisplay)、也不需要进 ChatRecording 的 turn 历史(skill 内部的工具调用已经各自被 recordUiTelemetryEvent 记录)。因此只补第 3 条(QwenLogger),保留第 4 条(OTLP),跳过 1/2 是有意的,不是遗漏。
|
||||
|
||||
**字段透传细节**:`loggers.ts:961-966` 用 `{ ...event }` spread 自动透传新字段(`prompt_id` 加进 `SkillLaunchEvent` 后这条路自动生效),但 `qwen-logger.ts:908` 的 `logSkillLaunchEvent` 内部如果显式解构 `event.skill_name` / `event.success`,新字段不会自动纳入,需手动同步。
|
||||
|
||||
工作量:A 路径约 0.5d(含 backend 端确认);B 路径约 0.2d(删代码 + 文档说明)。
|
||||
|
||||
#### 4.1.2 派生 `SkillFollowupRecord`(离线聚合)
|
||||
|
||||
不需要新事件类型 — `ToolCallEvent` 和 `SkillLaunchEvent` 都已带 `prompt_id`,离线 SQL 即可派生:
|
||||
|
||||
```sql
|
||||
-- 伪 SQL,按实际 telemetry backend 调整
|
||||
WITH skill_events AS (
|
||||
SELECT prompt_id, skill_name, timestamp FROM events
|
||||
WHERE event_name = 'skill_launch' AND success = true
|
||||
),
|
||||
tool_events AS (
|
||||
SELECT prompt_id, function_name, timestamp FROM events
|
||||
WHERE event_name = 'tool_call'
|
||||
),
|
||||
followups AS (
|
||||
SELECT s.skill_name, s.prompt_id,
|
||||
COUNT(t.function_name) AS followup_count,
|
||||
ARRAY_AGG(t.function_name) AS followup_tool_names
|
||||
FROM skill_events s
|
||||
LEFT JOIN tool_events t
|
||||
ON s.prompt_id = t.prompt_id AND t.timestamp > s.timestamp
|
||||
GROUP BY s.skill_name, s.prompt_id
|
||||
)
|
||||
SELECT skill_name,
|
||||
COUNT(*) AS invocations,
|
||||
AVG(followup_count) AS avg_followup,
|
||||
SUM(CASE WHEN followup_count > 0 THEN 1 ELSE 0 END)::FLOAT / COUNT(*) AS followup_rate
|
||||
FROM followups
|
||||
GROUP BY skill_name
|
||||
ORDER BY invocations * followup_rate DESC;
|
||||
```
|
||||
|
||||
#### 4.1.3 跑 telemetry 1 周收数据
|
||||
|
||||
- 不变更 user-facing 行为
|
||||
- 不需要任何配置开关 — telemetry 已有 opt-in 框架(`telemetry.target` 设置项)
|
||||
- 1 周后产出 skill ranking 报告
|
||||
|
||||
### 4.2 Layer 2:Skill 改造(per-skill 0.5-1d)
|
||||
|
||||
按 Layer 1 数据从 top-down 改造。每个 skill 一个独立 PR,PR description 必须包含:
|
||||
|
||||
1. **数据**:当前 invocation_count、followup_rate、top followup tools
|
||||
2. **改造范围**:内联了哪些 followup(明确不内联什么)
|
||||
3. **输出契约更新**:skill 描述里加了什么预声明
|
||||
4. **A/B 计划**:改造后 2 周再观察 followup_rate
|
||||
|
||||
**注意事项**:
|
||||
|
||||
- Skill 内联 read 操作不要重复 read_file 的所有边界情况处理(编码、二进制检测等)— 调用 `read_file` 工具本身,不要重写
|
||||
- Skill 内联 grep/glob 同理
|
||||
- Skill 内联 shell 命令需走 `executeToolCall` 标准路径(保留 telemetry)
|
||||
- **不要让 skill 体积爆炸**:内联 followup 后 skill 描述 > 500 tokens 时,拆分 skill 而不是合并
|
||||
|
||||
### 4.3 Layer 3:Prompt 教育(0.5d 改动 + 实测调优)
|
||||
|
||||
#### 4.3.1 加并发指导
|
||||
|
||||
**位置**:`packages/core/src/core/prompts.ts` `# Final Reminder` 段(L396)
|
||||
|
||||
加上节 3.3 的指导文本。具体措辞需 A/B —— 先用最朴素版本,根据并发率提升程度再细化。
|
||||
|
||||
#### 4.3.2 加 `batch_size` telemetry
|
||||
|
||||
**位置**:`packages/core/src/telemetry/types.ts` 的 `ToolCallEvent` 或新增轻量级 `ToolBatchEvent`
|
||||
|
||||
```typescript
|
||||
// 选项 A:在 ToolCallEvent 上加字段(侵入小)
|
||||
export class ToolCallEvent {
|
||||
...
|
||||
batch_size?: number; // 同一 batch 内 tool_call 数量
|
||||
batch_position?: number; // 在 batch 内的位置 (0-indexed)
|
||||
}
|
||||
|
||||
// 选项 B:新增 ToolBatchEvent(语义更清晰,需走完整新事件类型流程)
|
||||
```
|
||||
|
||||
**推荐选项 A** — 改动小、查询时聚合方便。
|
||||
|
||||
**状态传递路径**(关键 — 这一步成本被早期版本低估):
|
||||
|
||||
`coreToolScheduler.ts:2456` 的 `partitionToolCalls(callsToExecute)` 返回 `batches`,**但 batch 信息在调度路径上立刻丢失**:
|
||||
|
||||
```
|
||||
executeToolCalls
|
||||
└─ batches = partitionToolCalls(...) // 知道 batch.calls.length
|
||||
└─ for batch of batches:
|
||||
└─ this.runConcurrently(batch.calls, ...) // 知道 batch.calls.length
|
||||
└─ executeSingleToolCall(call, ...) // ❌ 已不知道 batch
|
||||
└─ ...
|
||||
└─ finalizeToolCalls
|
||||
└─ logToolCall(config, new ToolCallEvent(call)) // ❌ 无 batch context
|
||||
```
|
||||
|
||||
`ToolCallEvent` 的构造器(`types.ts:189`)只接收单个 `CompletedToolCall`,无 batch 字段。
|
||||
|
||||
修复方向:
|
||||
|
||||
- **方向 A**(推荐):在 `ScheduledToolCall` 上加 `batchSize?: number` + `batchPosition?: number`。两条分支分别填充:
|
||||
- 并发分支(`coreToolScheduler.ts:2459-2460`,`batch.calls.length > 1`):`runConcurrently(batch.calls, ...)` 进入循环前给每个 `call` 写 `batchSize = batch.calls.length`、`batchPosition = i`
|
||||
- 串行分支(`L2462-2464` 的 `for (const call of batch.calls)`):单工具 batch 显式设 `batchSize = 1`、`batchPosition = 0`(**不要默认 undefined**,否则下游 telemetry 聚合时会把并发未生效的轮次误判为缺失数据)
|
||||
|
||||
`new ToolCallEvent(call)` 在构造器里从 `call` 读这两个字段
|
||||
|
||||
- **方向 B**:改 `ToolCallEvent` 构造器签名 `new ToolCallEvent(call, batchInfo?)`,所有调用方同步改(4 个 logToolCall 调用点 + 测试)。改动面比 A 大
|
||||
|
||||
工作量:方向 A 约 0.5d 含单测;方向 B 约 1d(调用方多)。
|
||||
|
||||
**同步衡量"模型并发意愿"** — Layer 3 改 prompts.ts 前后,对比 `batch_size > 1 的 tool_call 占比` 分布。这是 Layer 3 是否生效的关键指标,没这个数据 Layer 3 A/B 无法收尾。
|
||||
|
||||
#### 4.3.3 cache 影响评估
|
||||
|
||||
`prompts.ts` 改动会让 DashScope ephemeral cache 一次性失效(首次请求 cache miss,之后恢复)。这是已知一次性成本,参见 `rt-optimization-design.md` §7.8 的 prompt 稳态审计。
|
||||
|
||||
---
|
||||
|
||||
## 5. 验收与度量
|
||||
|
||||
> **本节是 §0 验收 Spec 的"方法论"配套** — §0 声明"算成功的指标 + 阈值前置/后置时机",§5 说明"怎么测、SQL 怎么写、A/B 怎么设计"。本节阈值是 §0.2 的当前占位,最终值在 P1.5 基线测量后锁定。
|
||||
|
||||
### 5.1 per-skill A/B 指标(改造后 2 周)
|
||||
|
||||
| 指标 | 验收线 | 备注 |
|
||||
| ----------------------------------------- | ------------------------ | -------------------------- |
|
||||
| 该 skill 的 `followup_rate` | < 20%(改造前若为 70%+) | 主指标 |
|
||||
| 该 skill 触发场景的端到端 RT P50 | 下降 ≥ 2s | 来自少一轮 LLM 调用 |
|
||||
| 该 skill 的 `user_followup_within_30s` 率 | 不上升 | 用户没追问 = 答案完整 |
|
||||
| 该 skill 的 `success` 率 | 不下降 | 内联 followup 没引入新失败 |
|
||||
|
||||
### 5.2 整体 RT 指标
|
||||
|
||||
| 指标 | 基线 | Layer 2 改完 top-3 skill 后目标 |
|
||||
| ---------------------------------- | ------------------------------------- | -------------------------------- |
|
||||
| 端到端 RT P50(含 skill 的会话) | 13.4s(单次采样)/ 待补 ≥3 类场景基线 | 下降 2-3s |
|
||||
| Tool batch P50 size(Layer 3) | 待测 | ≥ 1.3(>30% 调用涉及并发 batch) |
|
||||
| Skill 总 followup_rate(加权平均) | 待测 | 下降 ≥ 30% |
|
||||
|
||||
### 5.3 失败信号 — 什么时候放弃这个方向
|
||||
|
||||
**结果指标止损线**:
|
||||
|
||||
- Layer 1 数据出来后,**top-5 skill 的加权 followup_rate < 30%** → 减轮空间小,不值得继续 Layer 2
|
||||
- Layer 2 改完 2 个 skill 后,**端到端 RT P50 下降 < 1s** → 改造方向错(可能 followup 是写操作不该合并),停下复盘
|
||||
- Layer 3 prompt 改动 2 周后 **batch_size P50 仍 = 1** → 模型不接受并发指导,放弃 Layer 3,只保留 Layer 1+2
|
||||
|
||||
**过程指标止损线(前置预警,避免方案"看起来在做、其实没收益")**:
|
||||
|
||||
- **Skill 命中率(intended skill vs selected skill)下降 ≥ 5pp** → skill 描述改坏让模型选错 skill。典型场景:改造前用户问 X 总是命中 skill_a,改造后偶尔被路由到 skill_b 但没产生 error(模型用错 skill 但勉强凑出答案),结果指标看起来正常但 followup_rate 反而上升。**衡量方法**:在 telemetry 加 `skill_invocation_pattern` —— 按 user prompt 前 N 个关键词聚类,看每个 cluster 主要触发哪个 skill;改造前后对比顶 1 偏移
|
||||
- **Skill 内联 followup 失败率 ≥ 5%** → skill 改造引入了原本不存在的失败模式(如内联 `read_file` 处理大文件爆内存)。衡量:`SkillLaunchEvent.success` 改造前后对比
|
||||
- **Per-skill 用户取消率(Ctrl+C)上升 ≥ 2pp** → skill 输出变慢或变长导致用户失去耐心。衡量:`ToolCallEvent.status === 'cancelled'` 占比
|
||||
|
||||
---
|
||||
|
||||
## 6. 与 D1/D3 的衔接
|
||||
|
||||
### 6.1 与 D1 的关系
|
||||
|
||||
Layer 2 改完 top skill 后,**剩余的 followup-heavy skill 才是 D1 `skipLlmRound` 的真正适用场景** — 那些 skill 输出已经完整(不需要 Round 2),且确实是终态查询(Round 3 总结也是浪费)。
|
||||
|
||||
执行次序:
|
||||
|
||||
1. Layer 1 telemetry 上线 → 1 周数据
|
||||
2. Layer 2 改造 top 2-3 skill → A/B 2 周
|
||||
3. Layer 3 prompt 并发 → 实测 1 周
|
||||
4. **此时**再评估 D1:剩余高频 skill 里有多少是"输出完整 + 终态查询"形态 → 是否值得 2-3d 框架改造
|
||||
|
||||
### 6.2 与 D3 的关系
|
||||
|
||||
D3(`StreamingState.Summarizing`)是感知层优化,与本方案完全正交。Layer 1-3 减少的是**真实轮数**,D3 减少的是**用户感知等待**。如果 Layer 2 已经把 RT 降到用户可接受的范围,D3 价值下降;反之 D3 可以叠加。
|
||||
|
||||
---
|
||||
|
||||
## 7. 限制与已知风险
|
||||
|
||||
1. **覆盖率受改造范围限制** — 改 10 个 skill 就只覆盖那 10 个的场景。但收益是确定可测有复利的
|
||||
2. **Skill 内联 followup 可能让单 skill 变重** — 描述膨胀、加载慢、复用度下降。Layer 2 检查清单第 5 条防御
|
||||
3. **Layer 3 模型可能不听并发指导** — qwen-coder 训练数据偏串行;A/B 数据可能显示 prompt 改动无效,作为已知失败模式
|
||||
4. **Telemetry 隐私边界** — `SkillFollowupRecord` 不应记录工具参数(已默认从 `ToolCallEvent.function_args` 拿,但要审计 skill_name 是否泄露用户意图)
|
||||
5. **不适用于子 agent / cron / notification** — 这些路径不走 skill 系统,本方案不覆盖
|
||||
6. **基线数据单薄** — 沿用 `rt-optimization-design.md` §1.2 的单次采样,Layer 2 落地前需补 ≥3 类场景基线
|
||||
7. **`logSkillLaunch` 字段扩展会破坏既有 telemetry consumer** — 4 个调用点 + 下游 logger 都要同步改
|
||||
8. **`qwen-logger.ts:908` `logSkillLaunchEvent` 当前是死代码** — 仓库内无任何调用方,§4.1.1b 已列前置修复
|
||||
|
||||
### 7.1 与已有框架机制的边界(不在本方案范围)
|
||||
|
||||
仓库已有几条与减轮间接相关的框架机制,**本方案不重新发明,也不替代**:
|
||||
|
||||
| 已有机制 | 位置 | 与本方案的关系 |
|
||||
| ---------------------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `partitionToolCalls` + `runConcurrently`(并发执行) | `coreToolScheduler.ts:775, 2473` | Layer 3 直接复用;本方案不动它 |
|
||||
| `CONCURRENCY_SAFE_KINDS`(决定哪些工具可并发) | `tools/tools.ts:818` | §3.3.1 已论证现状合理,不扩展 |
|
||||
| `FileReadCache`(避免重复读同一文件) | `services/fileReadCache.ts` | 间接影响"模型重复读文件"轮次,已生效;本方案不依赖也不增强 |
|
||||
| `chatCompressionService`(历史压缩) | `services/chatCompressionService.ts` | 与轮次正交(影响单轮成本而非轮数);与 `rt-optimization-design.md` §3.2 fast 路由的 `wouldTriggerCompression` gate 是同一组件 |
|
||||
|
||||
列出这些是为了避免"本方案被理解为忽略了已有机制"。
|
||||
|
||||
---
|
||||
|
||||
## 8. 实施时间线
|
||||
|
||||
> **前提:本时间线从 P-1 开始,不能跳过**。P-1 是 §0 验收 Spec 的前置评审,0.5d 工作量但**强制性** — 不通过则不进入 P0。这一约束是为了避免"先写代码再补 spec"的反模式:spec 后置等于把"算成功"的判断推迟到结果出来后,容易出现"为了让指标好看而调整 spec"的偏差(参见 `rt-optimization-design.md` §7 D2 路线的覆辙)。
|
||||
|
||||
| Phase | 内容 | 投入 | 产出 | spec 锁定动作 |
|
||||
| -------- | ---------------------------------------------------------------------- | --------------------- | ------------------------------ | --------------------------------------- |
|
||||
| **P-1** | spec 前置评审 | 0.5d | §0.1 / §0.3 锁定 | **锁定 §0.1 工程层 spec + §0.3 止损线** |
|
||||
| **P0** | qwen-logger 链路修复(§4.1.1b 前置) | 0.5d | skill_launch 事件可见性确认 | 验证 §0.1 第 1 条 |
|
||||
| **P1** | Layer 1 telemetry:补 `prompt_id` 字段 + 离线 SQL | 1-2d | skill ranking 报告 | 验证 §0.1 第 2/3/4 条 |
|
||||
| **P1.5** | 1 周数据收集 + 基线测量(≥3 类场景 × ≥10 次) | 1w | 决定改哪 2-3 个 skill | **锁定 §0.2 阈值 + 验证 §0.1 第 5 条** |
|
||||
| **P2** | Layer 2 改造 top-1 skill(PR + A/B) | 0.5-1d 改造 + 2w 观察 | followup_rate ↓、RT P50 ↓ 验证 | **PR 内声明 §0.4 per-skill spec** |
|
||||
| **P3** | Layer 3 prompt 并发指导 + `batch_size` telemetry(含 §4.3.2 状态传递) | 1-1.5d 改动 + 1w 实测 | batch_size 分布 | 验证 §0.2 第 3 条 |
|
||||
| **P4** | Layer 2 继续改 top-2 / top-3 skill(并行 P3) | 0.5-1d × N | 累计 RT P50 ↓ | 每 PR 内声明 §0.4 |
|
||||
| **P5** | 评估 D1 是否还有价值 | 决策会 | 路线图更新 | — |
|
||||
|
||||
**关键决策点(对照 §0.3 止损线)**:
|
||||
|
||||
- **P-1 末**:§0.1 / §0.3 任一项无法达成共识 → 不进入 P0
|
||||
- **P1.5 末**:触发 §0.3 结果指标 #1(top-5 加权 followup_rate < 30%)→ 终止方向;否则锁定 §0.2 阈值
|
||||
- **P2 末**:触发 §0.3 结果指标 #2(top-1 改造后 RT P50 ↓ < 1s)或任一过程指标 → 停下复盘
|
||||
- **P3 末**:触发 §0.3 结果指标 #3(batch_size P50 仍 = 1)→ 放弃 Layer 3
|
||||
- **P5**:根据剩余 skill 形态决定 D1 ROI
|
||||
|
||||
---
|
||||
|
||||
## 9. 关键代码位置
|
||||
|
||||
| 文件 | 关键符号 | 位置 |
|
||||
| -------------------------------------------------------- | ------------------------------------------------------------- | --------------------------------- |
|
||||
| `packages/core/src/telemetry/types.ts` | `ToolCallEvent`(含 `prompt_id` / `duration_ms`) | L170 |
|
||||
| `packages/core/src/telemetry/types.ts` | `SkillLaunchEvent`(需补 `prompt_id`) | L896 |
|
||||
| `packages/core/src/telemetry/loggers.ts` | `logToolCall` | L220 |
|
||||
| `packages/core/src/telemetry/loggers.ts` | `logSkillLaunch`(走 OTLP;缺 qwen-logger 转发) | L958 |
|
||||
| `packages/core/src/telemetry/loggers.ts` | `logToolCall`(双路径:OTLP + qwen-logger,作为修复样板) | L220, L230 |
|
||||
| `packages/core/src/telemetry/qwen-logger/qwen-logger.ts` | `logSkillLaunchEvent`(**当前死代码**,§4.1.1b 前置修复目标) | L908 |
|
||||
| `packages/core/src/core/coreToolScheduler.ts` | `partitionToolCalls` | L775 |
|
||||
| `packages/core/src/core/coreToolScheduler.ts` | `runConcurrently` / batch 调度 | L2456, L2473 |
|
||||
| `packages/core/src/core/coreToolScheduler.ts` | `logToolCall` 调用点(batch_size 状态传递终点) | L3163 |
|
||||
| `packages/core/src/services/fileReadCache.ts` | `FileReadCache`(已有,影响重复读取轮次) | L135 |
|
||||
| `packages/core/src/tools/skill.ts` | `SkillTool` + 4 个 `logSkillLaunch` 调用点 | L386, L399, L426, L482 |
|
||||
| `packages/core/src/skills/skill-manager.ts` | `SkillManager`(skill 注册/加载) | 全文件 |
|
||||
| `packages/core/src/skills/skill-load.ts` | skill 描述加载(输出契约改动入口) | 全文件 |
|
||||
| `packages/core/src/tools/tools.ts` | `Kind` + `CONCURRENCY_SAFE_KINDS` | L793, L818 |
|
||||
| `packages/core/src/core/coreToolScheduler.ts` | `partitionToolCalls` + `runConcurrently`(已有并发基础设施) | 见 rt-optimization-design.md §5.7 |
|
||||
| `packages/core/src/core/prompts.ts` | `# Final Reminder` 段(Layer 3 加并发指导处) | L396 |
|
||||
| `.qwen/skills/` | 各 skill 定义目录(Layer 2 改造对象) | 目录 |
|
||||
1205
docs/design/rt-optimization/rt-optimization-design.md
Normal file
1205
docs/design/rt-optimization/rt-optimization-design.md
Normal file
File diff suppressed because it is too large
Load Diff
538
docs/design/telemetry-llm-request-timing-design.md
Normal file
538
docs/design/telemetry-llm-request-timing-design.md
Normal file
@ -0,0 +1,538 @@
|
||||
# LLM Request Timing Decomposition Design (P3 Phase 4)
|
||||
|
||||
> Issue #3731 — Phase 4 of hierarchical session tracing. Adds time-to-first-token, request-setup duration, sampling duration, and per-attempt retry telemetry to the `qwen-code.llm_request` span so operators can answer "why was this LLM call slow?" without guessing.
|
||||
>
|
||||
> Builds on Phase 1 (#4126), Phase 1.5 (#4302), Phase 2 (#4321). Independent of Phase 3 (#4410, in review) — recommended to land Phase 3 first so Phase 4's per-attempt fields aggregate cleanly under subagent subtrees.
|
||||
|
||||
## Problem
|
||||
|
||||
`qwen-code.llm_request` spans today carry only `model`, `prompt_id`, `input_tokens`, `output_tokens`, `success`, `error`, `duration_ms`. Operators reading a single trace cannot tell:
|
||||
|
||||
1. **How much of `duration_ms` was the model thinking vs the network setup.** A 12-second `duration_ms` could be 11s of retries followed by 1s of fast generation, or 100ms of setup followed by 12s of slow streaming — the trace doesn't say.
|
||||
2. **When the user saw the first token.** TTFT (time-to-first-token) is the standard latency SLO for chat UIs. We can't compute it; we don't capture it.
|
||||
3. **What happened during retries.** `retryWithBackoff` (`utils/retry.ts:285`) only calls `debugLogger.warn` — no OTel event, no span attribute. The 4 LLM call sites that go through it (`client.ts:1540`, `baseLlmClient.ts:193,282`, `geminiChat.ts:1039`) have zero retry visibility in traces or metrics. `ContentRetryEvent` exists for content-recovery retries inside `geminiChat.ts:806,830` but not for the more common rate-limit / 5xx retries.
|
||||
4. **That `api.request.breakdown` is dead code.** The metric is defined at `metrics.ts:242-251` with 4 `ApiRequestPhase` values, exported from `index.ts:117`, tested in `metrics.test.ts:646-675` — but `recordApiRequestBreakdown()` has zero callers in production code. The metric infrastructure is paid for; the data flow was never connected.
|
||||
|
||||
These gaps make `qwen-code.llm_request` the least informative span in the trace tree. Tool spans (#4126/#4321) and subagent spans (#4410) both surface lifecycle phases; LLM spans collapse the entire request into one opaque duration.
|
||||
|
||||
## Existing surface (no change)
|
||||
|
||||
| Component | Location | Why we don't touch it |
|
||||
| ------------------------------------------------------------ | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| LLM request span lifecycle | `session-tracing.ts` `startLLMRequestSpan` / `endLLMRequestSpan` | Phase 1 (#4126) established the helpers. We extend the metadata interface, don't restructure |
|
||||
| Active span propagation into provider generators | `loggingContentGenerator.ts:213,287` | Phase 1 (#4126) replaced `withSpan('api.*')` with native helpers; the active context already reaches the stream wrapper |
|
||||
| `ContentRetryEvent` schema + consumers | `types.ts:626`, `qwen-logger.ts:947`, `loggers.ts:717` | Existing event keeps its shape and downstreams; we add a sibling event class for the `retryWithBackoff` path |
|
||||
| `LogToSpanProcessor` log-bridge spans | `log-to-span-processor.ts` | ContentRetryEvent's existing bridge continues to nest under the active LLM span. Phase 4 does not change this |
|
||||
| `ApiRequestPhase` enum | `metrics.ts:330-334` | Public surface (4 values). We populate 3 of the 4 from production code; leave the enum unchanged for backward compatibility |
|
||||
| Per-provider chunk normalization → `GenerateContentResponse` | `loggingContentGenerator.ts:286-393` | Each provider already normalizes to Google's `GenerateContentResponse` shape before LoggingContentGenerator sees the stream. TTFT detection runs centrally over this normalized shape; no per-provider code |
|
||||
| `retryWithBackoff` general-purpose retry | `utils/retry.ts:140` | Used by both LLM callers and non-LLM (`channels/weixin/src/api.ts`). We extend with an opt-in `onRetry` callback rather than hard-coupling to LLM telemetry |
|
||||
| Non-streaming `generateContent` | `loggingContentGenerator.ts:212` | TTFT is not meaningful for non-streaming; the new fields stay `undefined`. Span lifecycle and existing attrs unchanged |
|
||||
|
||||
## Out-of-scope (deferred)
|
||||
|
||||
- **SDK-level retries** (openai SDK `maxRetries=3`, google-genai SDK internal retries). These happen entirely inside the third-party SDK; observing them requires disabling SDK retries and reimplementing in `retryWithBackoff`. Separate decision, not Phase 4.
|
||||
- **Per-token streaming metrics** (inter-token latency, per-chunk size). Useful for inference-engine perf debugging, not for the user-perceived latency questions Phase 4 targets.
|
||||
- **Separate TTFT for reasoning/thinking blocks.** "First token" includes thinking content (see D1). A future enhancement could split `ttft_to_reasoning_ms` vs `ttft_to_answer_ms`, but only after we know there's demand.
|
||||
- **Sampling phase as a dedicated child span.** Computable from `duration_ms - ttft_ms - request_setup_ms`; child span adds nothing for OTel-only backends (claude-code uses one for Perfetto only). Stored as a span attribute instead — see D6.
|
||||
- **Persistent retry mode (`QWEN_CODE_UNATTENDED_RETRY`) event-level rate limiting.** A single LLM request can produce 50+ `ContentRetryEvent` / `ApiRetryEvent` records under persistent retry. Capping emission is a follow-up — Phase 4 emits all events; if production volumes prove unbearable, add a per-span emission cap with a "+N more attempts (truncated)" summary event in a follow-up PR.
|
||||
- **`TOKEN_PROCESSING` breakdown phase.** Enum value exists but qwen-code has no real post-stream local processing worth measuring (<10ms typical). Skipped in production callers; enum value retained for future use or for callers we don't control.
|
||||
- **Migrating `ContentRetryEvent` onto LLM span as span events.** Same reasoning as Phase 3's `subagent_execution` LogRecord: existing consumers (qwen-logger RUM, future metrics) are tightly coupled to the LogRecord. Bridge-span coverage is good enough.
|
||||
|
||||
## References (decision evidence)
|
||||
|
||||
| Source | Key takeaway |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| claude-code (Anthropic) `claude.ts:1762, 1789, 1982, 2882` | TTFT captured as `Date.now() - start` on `message_start` SSE event; `start` reset per retry attempt. `requestSetupMs = start - startIncludingRetries`. `attemptStartTimes` array preserved per attempt. Confirms feasibility of the approach; their TTFT semantic is "first stream event" (we diverge to "first content" — see D1) |
|
||||
| claude-code `perfettoTracing.ts:549-671` | Renders Request Setup → Attempt N (retry) → First Token → Sampling as nested B/E pairs. Demonstrates the visual decomposition; qwen-code does the same decomposition with OTel attributes since we have no Perfetto |
|
||||
| claude-code `sessionTracing.ts:447` | Only `ttft_ms` makes it onto the OTel span (not `requestSetupMs`, not `samplingMs`, not per-attempt timing). We deliberately put more on the span — claude-code has Perfetto for visualization; we don't |
|
||||
| opencode (sst/opencode) `session/llm.ts`, `route/client.ts` | No TTFT measurement. Single `LLM.run` Effect span covers everything. Validates that the gap exists across competing tools; not a reference for what to do |
|
||||
| [OTel GenAI Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/) (status: Development / Experimental) | `gen_ai.usage.input_tokens` (Stable), `gen_ai.usage.output_tokens` (Stable), `gen_ai.usage.cached_tokens` (Experimental), `gen_ai.request.model` (Stable), `gen_ai.server.time_to_first_token` (Experimental, seconds as double). Dual-emit pattern follows #4410 precedent |
|
||||
| [OTel Trace Spec — Span Events](https://opentelemetry.io/docs/specs/otel/trace/api/#add-events) | "Events SHOULD NOT be used to record information that's better captured as Span Attributes." Confirms per-attempt info belongs on the LLM span attributes + log-bridge spans, not as Span Events on the parent |
|
||||
| Phase 3 design doc (`telemetry-subagent-spans-design.md`) | Established the dual-emit pattern (`qwen-code.subagent.id` + `gen_ai.agent.id`) and the "private name is authoritative" rule. Phase 4 follows the same convention for TTFT and token fields |
|
||||
|
||||
## Design — seven decisions, each justified
|
||||
|
||||
### D1 — TTFT semantic: "first chunk containing user-visible content"
|
||||
|
||||
TTFT measures wall-clock from the **successful attempt's** request dispatch to the **first stream chunk that contains user-visible output**. A chunk is "user-visible" if any normalized `Part` in `candidates[0].content.parts` is one of:
|
||||
|
||||
- `text` with non-empty string
|
||||
- `functionCall` (tool use)
|
||||
- `inlineData` (image, binary)
|
||||
- `executableCode`
|
||||
- `thought` / reasoning content (whatever the provider surfaces — Gemini's `thought`, Anthropic's `<thinking>` block, OpenAI o1 reasoning chunk)
|
||||
|
||||
Chunks containing only `role` metadata or only `usageMetadata` (final usage-summary chunk) do not trigger TTFT.
|
||||
|
||||
**Why not "first stream event of any kind" (claude-code's choice)**: claude-code measures TTFT at `message_start`, an Anthropic-specific metadata event that fires 50–300ms before any actual content. Their internal `headlessProfiler.ts` already separates `time_to_first_response_ms` for the "user saw something" semantic, acknowledging the distinction. qwen-code spans multiple providers (Anthropic, OpenAI, Gemini, Qwen) — picking the metadata-event semantic means TTFT for Anthropic is fundamentally different from TTFT for OpenAI (which has no analogous metadata-only first event). The user-visible-content semantic is uniform across all 4 providers and matches "time-to-first-token" literally.
|
||||
|
||||
**Why include `thought` / reasoning**: from the operator's perspective, reasoning chunks are still "the model produced output." Excluding them would understate TTFT for reasoning-heavy models (o1, Qwen thinking variants). Future split into `ttft_to_reasoning_ms` vs `ttft_to_answer_ms` is possible; not Phase 4.
|
||||
|
||||
**Why include tool-call-only chunks**: agent tool-decision LLM calls (one `tool_use`, no text) are common in qwen-code's workflow. Excluding them means TTFT is undefined for these requests. The `functionCall` Part is meaningful output.
|
||||
|
||||
**Cross-product comparison note**: design doc explicitly states `qwen-code.ttft_ms ≈ claude-code.time_to_first_response_ms ≠ claude-code.ttft_ms`. Operators comparing across products should align on the user-visible-content semantic.
|
||||
|
||||
### D2 — TTFT measurement site: method-local variables in `LoggingContentGenerator.generateContentStream`
|
||||
|
||||
The first-chunk detection runs inside the existing stream wrapper at `loggingContentGenerator.ts:393` (`async function* processStreamGenerator`). Per-call variables (`start`, `ttftMs`) live in the method's closure; **never as instance fields**.
|
||||
|
||||
**Why never instance fields**: `LoggingContentGenerator` is instantiated **once per `ContentGenerator`** (`contentGenerator.ts:377`) and shared across all concurrent `generateContentStream` calls — subagent fan-out, warmup queries, side-queries from `geminiChat`. An instance field would be overwritten across concurrent calls, producing nonsense TTFT for one of every two interleaved requests.
|
||||
|
||||
**Why not AsyncLocalStorage**: ALS would work but adds a context-management layer for a piece of state that doesn't need to escape the method. Method-local is simpler, zero overhead, zero risk of leakage.
|
||||
|
||||
```ts
|
||||
// loggingContentGenerator.ts — inside generateContentStream
|
||||
const attemptStart = Date.now(); // per-call local
|
||||
const requestEntryTime = Date.now(); // also per-call local — see D3
|
||||
let ttftMs: number | undefined;
|
||||
const attemptStartTimes: number[] = [attemptStart];
|
||||
let retryTotalDelayMs = 0;
|
||||
let finalAttempt = 1;
|
||||
// stream wrapper inspects each chunk; first one matching hasUserVisibleContent:
|
||||
// ttftMs = Date.now() - attemptStart;
|
||||
```
|
||||
|
||||
`hasUserVisibleContent(chunk)` is a small standalone helper colocated with the wrapper, exported for tests:
|
||||
|
||||
```ts
|
||||
function hasUserVisibleContent(chunk: GenerateContentResponse): boolean {
|
||||
const parts = chunk.candidates?.[0]?.content?.parts;
|
||||
if (!parts?.length) return false;
|
||||
return parts.some(
|
||||
(p) =>
|
||||
(typeof p.text === 'string' && p.text.length > 0) ||
|
||||
p.functionCall !== undefined ||
|
||||
p.inlineData !== undefined ||
|
||||
p.executableCode !== undefined ||
|
||||
// @ts-expect-error — `thought` is not on all SDK versions but providers emit it
|
||||
p.thought !== undefined,
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### D3 — `request_setup_ms` computation: entry-time vs successful-attempt-start
|
||||
|
||||
`request_setup_ms` measures wall-clock from `generateContentStream`/`generateContent` entry to the **start of the successful attempt** — including all failed retries, backoff sleeps, and any pre-retry preparation work.
|
||||
|
||||
```ts
|
||||
request_setup_ms = attemptStart_of_successful_attempt - requestEntryTime;
|
||||
```
|
||||
|
||||
When `attempt === 1` and no retries happened, `request_setup_ms` is small (just SDK setup). When retries occurred, it captures the entire retry-budget overhead.
|
||||
|
||||
**Putting it on the OTel span (diverges from claude-code, which puts it only on Perfetto)**: rationale at three levels:
|
||||
|
||||
1. **No Perfetto** — qwen-code has no out-of-band visualization layer. OTel attributes are the only channel.
|
||||
2. **Single-trace debug** — operator sees `duration_ms=12000, request_setup_ms=11500, ttft_ms=200, sampling_ms=300` → instantly diagnoses "retries ate 11.5s, model itself was fast." Computing `request_setup_ms` from other fields requires also exposing `sampling_ms`, which we do anyway (D6).
|
||||
3. **Negligible cost** — 1 INT64 attribute. Same order of magnitude as the existing `input_tokens`, `output_tokens` attributes. Backend ingest cost is not material.
|
||||
|
||||
### D4 — Retry telemetry: `onRetry` callback option on `retryWithBackoff` + new `ApiRetryEvent`
|
||||
|
||||
`retryWithBackoff` currently calls `logRetryAttempt` (`retry.ts:343`) which only writes to `debugLogger.warn`. We extend the `RetryOptions` interface with an opt-in callback:
|
||||
|
||||
```ts
|
||||
// utils/retry.ts
|
||||
interface RetryOptions<T> {
|
||||
// ... existing fields ...
|
||||
/**
|
||||
* Optional. Called once per failed attempt, before the backoff sleep.
|
||||
* Receives the attempt number (1-based), the error, and the delay before
|
||||
* the next attempt. Use this to emit telemetry events for LLM call sites;
|
||||
* leave undefined for non-LLM callers (e.g., channels/weixin) so they
|
||||
* stay silent in LLM-specific telemetry channels.
|
||||
*/
|
||||
onRetry?: (info: RetryAttemptInfo) => void;
|
||||
}
|
||||
|
||||
interface RetryAttemptInfo {
|
||||
attempt: number; // 1-based, matches debugLogger output
|
||||
error: unknown;
|
||||
errorStatus?: number;
|
||||
delayMs: number; // backoff delay before next attempt
|
||||
}
|
||||
```
|
||||
|
||||
The 4 LLM call sites (`client.ts:1540`, `baseLlmClient.ts:193,282`, `geminiChat.ts:1039`) register a callback that emits a new `ApiRetryEvent`:
|
||||
|
||||
```ts
|
||||
// types.ts — new event class, sibling to ContentRetryEvent
|
||||
export class ApiRetryEvent implements BaseTelemetryEvent {
|
||||
'event.name': typeof EVENT_API_RETRY;
|
||||
'event.timestamp': string;
|
||||
model: string;
|
||||
prompt_id?: string;
|
||||
attempt_number: number; // 1-based
|
||||
error_type: string;
|
||||
error_message: string; // truncated to 256 chars
|
||||
status_code?: number;
|
||||
retry_delay_ms: number;
|
||||
// ... duration_ms set to retry_delay_ms so LogToSpanProcessor renders
|
||||
// a bridge span of meaningful width
|
||||
duration_ms: number;
|
||||
}
|
||||
```
|
||||
|
||||
**Why a new event class, not extending `ContentRetryEvent`**:
|
||||
|
||||
- `ContentRetryEvent` has 2 downstream consumers (qwen-logger, log-record export). Changing its payload risks breaking them.
|
||||
- The naming "content retry" semantically refers to content-recovery retries (invalid stream, schema repair) — extending it to cover rate-limit retries would muddy the schema.
|
||||
- New event is additive; no consumer surprise.
|
||||
|
||||
**Why not embed callback IN `retry.ts`**: `retry.ts` is called by `channels/weixin/src/api.ts` too (microsoft messaging API retries). Hard-coupling LLM telemetry inside retry.ts would emit `ApiRetryEvent` for non-LLM retries. The `onRetry` callback is opt-in per caller — LLM callers opt in, weixin caller doesn't.
|
||||
|
||||
**ContentRetryEvent coexistence**: ContentRetryEvent stays as-is for content-recovery retries inside `geminiChat.ts:806,830`. ApiRetryEvent covers the rate-limit / 5xx retries from `retryWithBackoff`. The two events fire from different layers and never duplicate. Existing log-bridge behavior for both events is preserved via `LogToSpanProcessor` — both events nest under the active LLM span automatically (Phase 1 wiring ensures the LLM span is active during retries).
|
||||
|
||||
**Persistent retry mode (`QWEN_CODE_UNATTENDED_RETRY`)**: a single 429-loop request may emit 50+ events. Out of scope to rate-limit emission in Phase 4 — if production volumes prove unbearable, add a per-span cap with summary event in a follow-up PR. The aggregated `attempt` and `retry_total_delay_ms` on the parent LLM span (D5) remain accurate regardless of event cap.
|
||||
|
||||
### D5 — Parent LLM span aggregation: scalar attributes only (no map-typed attrs)
|
||||
|
||||
OTel span attributes are scalars (`string | number | boolean | array of these`). Map-typed attributes (like `retry_count_by_status: {429:2, 503:1}`) require JSON serialization and are awkward to query. Skip them.
|
||||
|
||||
| Attribute | Type | Semantic |
|
||||
| -------------------------- | ------ | ----------------------------------------------------------------------------------- |
|
||||
| `attempt` | int | 1-based final attempt count (`attemptStartTimes.length`) |
|
||||
| `retry_total_delay_ms` | int | Sum of all `delayMs` reported by `onRetry`; 0 if no retries |
|
||||
| `ttft_ms` | int | TTFT per D1; undefined for non-streaming or aborted-before-first-chunk requests |
|
||||
| `request_setup_ms` | int | Per D3 |
|
||||
| `sampling_ms` | int | Per D6 |
|
||||
| `output_tokens_per_second` | double | Derived; `output_tokens / (sampling_ms / 1000)`; undefined when `sampling_ms === 0` |
|
||||
|
||||
Per-attempt status-code distribution (e.g., "2 of the 3 attempts were 429s") is queryable from log-bridge spans of `ApiRetryEvent` records. No need to duplicate it as a flattened attribute on the parent.
|
||||
|
||||
**Why `sampling_ms` and `output_tokens_per_second` on the span**: derivable but cumbersome to compute in backend queries when summing across many spans. Same cost-benefit as `request_setup_ms` (D3).
|
||||
|
||||
### D6 — Activate `recordApiRequestBreakdown()` for 3 of 4 phases
|
||||
|
||||
In `endLLMRequestSpan` (or the wrapper that calls it), after computing TTFT/setup/sampling, emit:
|
||||
|
||||
```ts
|
||||
recordApiRequestBreakdown(config, model, [
|
||||
{ phase: ApiRequestPhase.REQUEST_PREPARATION, durationMs: requestSetupMs },
|
||||
{ phase: ApiRequestPhase.NETWORK_LATENCY, durationMs: ttftMs }, // ttftMs = network + first-token-generation
|
||||
{ phase: ApiRequestPhase.RESPONSE_PROCESSING, durationMs: samplingMs },
|
||||
]);
|
||||
```
|
||||
|
||||
**Why skip `TOKEN_PROCESSING`**: qwen-code does stream chunk processing inline (consolidation happens in the wrapper at `loggingContentGenerator.ts:644`); the post-stream wrap-up phase is <10ms and not architecturally distinct. Filling it with a meaningless value pollutes the histogram. Leaving the enum value unused is safe — `apiRequestBreakdownHistogram.record(value, {model, phase})` is just a histogram with `phase` as a label; missing labels are simply absent in queries.
|
||||
|
||||
**Why not redefine `NETWORK_LATENCY`**: the spec name is slightly misleading (it's network + first-token-generation, not pure network latency), but:
|
||||
|
||||
- The enum is part of `metrics.ts:330-334` which is exported from `index.ts:117` and tested.
|
||||
- Backend dashboards may already reference these phase names.
|
||||
- Renaming or adding a new phase would be a breaking change for trivially marginal accuracy improvement.
|
||||
|
||||
Document the semantic in the design doc; leave the enum unchanged.
|
||||
|
||||
**Why on the span path, not parallel**: keeps `recordApiRequestBreakdown` colocated with span attribute writes — single gated emission point (see D7 idempotency), single ordering invariant.
|
||||
|
||||
### D7 — `endLLMRequestSpan` idempotency: metric recording gated on existing double-end guard
|
||||
|
||||
Phase 1.5 (#4302) established that `endLLMRequestSpan` may be called twice (abort path + error path collision). The existing guard at `session-tracing.ts:~470` (`if (!activeSpans.has(...)) return;`) prevents double `span.end()`. Phase 4 metric recording (D6) **must sit inside the same guarded block**, before `span.end()`:
|
||||
|
||||
```ts
|
||||
// session-tracing.ts — endLLMRequestSpan
|
||||
const llmCtx = activeSpans.get(spanRef);
|
||||
if (!llmCtx) return; // already ended — double-end guard
|
||||
activeSpans.delete(spanRef); // claim the end
|
||||
|
||||
// ... compute duration, set attributes ...
|
||||
if (metadata) {
|
||||
recordApiRequestBreakdown(config, llmCtx.attributes.model, [...]); // NEW — gated
|
||||
recordTokenUsageMetrics(...); // existing
|
||||
}
|
||||
|
||||
span.end();
|
||||
```
|
||||
|
||||
This guarantees metric is recorded **exactly once** per LLM request, matching the span lifecycle.
|
||||
|
||||
**Why not record in `loggingContentGenerator`**: it doesn't see the abort path. Recording at the span lifecycle layer ensures every LLM request that opens a span produces exactly one breakdown sample, regardless of success/failure/abort.
|
||||
|
||||
### D8 — GenAI semantic conventions dual-emit (private name authoritative)
|
||||
|
||||
Each Phase 4 attribute that corresponds to an OTel GenAI semconv attribute is written twice on the span:
|
||||
|
||||
| qwen-code private (authoritative) | GenAI semconv (compat layer) | Unit conversion | Spec status |
|
||||
| ------------------------------------------ | ----------------------------------------------- | --------------- | ------------ |
|
||||
| `ttft_ms` (ms, int) | `gen_ai.server.time_to_first_token` (s, double) | `ttftMs / 1000` | Experimental |
|
||||
| `input_tokens` (int) | `gen_ai.usage.input_tokens` (int) | identical | Stable |
|
||||
| `output_tokens` (int) | `gen_ai.usage.output_tokens` (int) | identical | Stable |
|
||||
| `cached_input_tokens` (int) (when present) | `gen_ai.usage.cached_tokens` (int) | identical | Experimental |
|
||||
| `qwen-code.model` (string) | `gen_ai.request.model` (string) | identical | Stable |
|
||||
|
||||
**Existing token attribute names** on the LLM span (set in `endLLMRequestSpan` before Phase 4): qwen-code uses bare `input_tokens` and `output_tokens` already. Phase 4 adds the `gen_ai.usage.*` siblings to match #4410's pattern. The bare names stay; **don't rename**.
|
||||
|
||||
Fields with no GenAI semconv equivalent — `request_setup_ms`, `sampling_ms`, `retry_total_delay_ms`, `attempt`, `output_tokens_per_second` — are emitted only under the qwen-code namespace.
|
||||
|
||||
**Why "private authoritative, semconv as compat"**:
|
||||
|
||||
- Internal dashboards, SLOs, debugLogger output, qwen-logger RUM, ARMS queries — all reference `ttft_ms` etc. Treating those as canonical avoids a flag-day migration.
|
||||
- The Experimental GenAI semconv may rename `gen_ai.server.time_to_first_token` before reaching Stable. If/when it does, we update the semconv emission; the qwen-code names don't move.
|
||||
- Future spec-aware backends (Datadog AI views, Honeycomb AI, ARMS GenAI dashboards) auto-pick up the `gen_ai.*` attributes without our involvement.
|
||||
|
||||
**Why dual-emit unit conversion** (ms ↔ seconds): GenAI semconv chose seconds-as-double for latency; qwen-code chose ms-as-int (matches `duration_ms` already on the span). Both representations have value; the conversion is cheap.
|
||||
|
||||
## Helper API (additive to `session-tracing.ts`)
|
||||
|
||||
```ts
|
||||
// session-tracing.ts — LLMRequestMetadata interface extended (additive)
|
||||
export interface LLMRequestMetadata {
|
||||
// ... existing fields: inputTokens, outputTokens, cachedInputTokens, success, error, ...
|
||||
|
||||
/** Time from successful attempt start to first user-visible content chunk (ms). Undefined for non-streaming or aborted-before-first-chunk requests. */
|
||||
ttftMs?: number;
|
||||
|
||||
/** Time from generateContent entry to start of successful attempt (ms). Includes all failed retries + backoff. */
|
||||
requestSetupMs?: number;
|
||||
|
||||
/** Final attempt number (1-based). 1 = no retries. */
|
||||
attempt?: number;
|
||||
|
||||
/** Sum of all backoff delays before the successful attempt (ms). */
|
||||
retryTotalDelayMs?: number;
|
||||
}
|
||||
|
||||
// No new exported helpers — Phase 4 reuses startLLMRequestSpan / endLLMRequestSpan with extended metadata.
|
||||
```
|
||||
|
||||
```ts
|
||||
// types.ts — new event class
|
||||
export class ApiRetryEvent implements BaseTelemetryEvent {
|
||||
'event.name': typeof EVENT_API_RETRY = EVENT_API_RETRY;
|
||||
'event.timestamp': string;
|
||||
model: string;
|
||||
prompt_id?: string;
|
||||
attempt_number: number;
|
||||
error_type: string;
|
||||
error_message: string;
|
||||
status_code?: number;
|
||||
retry_delay_ms: number;
|
||||
duration_ms: number; // = retry_delay_ms, drives LogToSpanProcessor bridge span width
|
||||
|
||||
constructor(opts: { model: string; promptId?: string; attemptNumber: number; error: unknown; statusCode?: number; retryDelayMs: number }) { ... }
|
||||
}
|
||||
|
||||
// constants.ts
|
||||
export const EVENT_API_RETRY = 'qwen-code.api_retry';
|
||||
|
||||
// loggers.ts
|
||||
export function logApiRetry(config: Config, event: ApiRetryEvent): void { ... }
|
||||
```
|
||||
|
||||
```ts
|
||||
// utils/retry.ts — RetryOptions extension
|
||||
interface RetryOptions<T> {
|
||||
// ... existing ...
|
||||
onRetry?: (info: RetryAttemptInfo) => void;
|
||||
}
|
||||
|
||||
interface RetryAttemptInfo {
|
||||
attempt: number;
|
||||
error: unknown;
|
||||
errorStatus?: number;
|
||||
delayMs: number;
|
||||
}
|
||||
|
||||
// Inside retryWithBackoff, where logRetryAttempt is called today:
|
||||
options.onRetry?.({ attempt, error, errorStatus, delayMs: actualDelay });
|
||||
logRetryAttempt(attempt, error, errorStatus); // existing debugLogger call unchanged
|
||||
```
|
||||
|
||||
## Lifecycle wiring
|
||||
|
||||
### Streaming path (the common case)
|
||||
|
||||
```ts
|
||||
// loggingContentGenerator.ts:283 — generateContentStream
|
||||
async generateContentStream(req, userPromptId): Promise<AsyncGenerator<GenerateContentResponse>> {
|
||||
const requestEntryTime = Date.now();
|
||||
let attemptStart = requestEntryTime;
|
||||
const attemptStartTimes: number[] = [attemptStart];
|
||||
let retryTotalDelayMs = 0;
|
||||
let finalAttempt = 1;
|
||||
|
||||
// Use existing startLLMRequestSpan (Phase 1)
|
||||
// Pass onRetry callback to whatever retry layer is in use:
|
||||
const onRetry: RetryAttemptInfo & { invoke: ... } = (info) => {
|
||||
finalAttempt = info.attempt + 1; // we're about to start attempt N+1
|
||||
retryTotalDelayMs += info.delayMs;
|
||||
attemptStart = Date.now() + info.delayMs; // approximate; actual reset is at top of next attempt
|
||||
attemptStartTimes.push(attemptStart);
|
||||
// emit ApiRetryEvent
|
||||
logApiRetry(this.config, new ApiRetryEvent({
|
||||
model: req.model,
|
||||
promptId: userPromptId,
|
||||
attemptNumber: info.attempt,
|
||||
error: info.error,
|
||||
statusCode: info.errorStatus,
|
||||
retryDelayMs: info.delayMs,
|
||||
}));
|
||||
};
|
||||
|
||||
// stream wrapper detects first user-visible chunk:
|
||||
return this.processStreamGenerator(stream, ..., {
|
||||
onFirstUserVisibleChunk: (now) => {
|
||||
ttftMs = now - attemptStart;
|
||||
},
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
At span end (already in Phase 1's `endLLMRequestSpan` flow), include the new fields in `LLMRequestMetadata`:
|
||||
|
||||
```ts
|
||||
endLLMRequestSpan(llmSpan, {
|
||||
success: true,
|
||||
inputTokens,
|
||||
outputTokens,
|
||||
cachedInputTokens,
|
||||
ttftMs,
|
||||
requestSetupMs: attemptStart - requestEntryTime,
|
||||
attempt: finalAttempt,
|
||||
retryTotalDelayMs,
|
||||
});
|
||||
```
|
||||
|
||||
### Non-streaming path
|
||||
|
||||
`generateContent` (`loggingContentGenerator.ts:212`) does not produce streaming chunks. TTFT is `undefined`; `request_setup_ms` is still meaningful (captures retry overhead). The breakdown metric records 2 phases (REQUEST_PREPARATION + RESPONSE_PROCESSING where `RESPONSE_PROCESSING = duration_ms - request_setup_ms`), not 3.
|
||||
|
||||
### Retry layer integration (4 sites)
|
||||
|
||||
Each of the 4 LLM `retryWithBackoff` call sites adds `onRetry`:
|
||||
|
||||
```ts
|
||||
// client.ts:1540 (similar at baseLlmClient.ts:193, 282, geminiChat.ts:1039)
|
||||
const result = await retryWithBackoff(apiCall, {
|
||||
...existingOptions,
|
||||
onRetry: (info) => {
|
||||
logApiRetry(
|
||||
this.config,
|
||||
new ApiRetryEvent({
|
||||
model,
|
||||
promptId: userPromptId,
|
||||
attemptNumber: info.attempt,
|
||||
error: info.error,
|
||||
statusCode: info.errorStatus,
|
||||
retryDelayMs: info.delayMs,
|
||||
}),
|
||||
);
|
||||
// also feed back into LoggingContentGenerator's local retry accumulator
|
||||
// (when in scope — for callers that don't go through LoggingContentGenerator,
|
||||
// the LLM span still gets `attempt` and `retry_total_delay_ms` via the
|
||||
// metadata path because endLLMRequestSpan is called at the LLM layer)
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
The non-LLM caller (`channels/weixin/src/api.ts`) **does not register `onRetry`** — no `ApiRetryEvent` is emitted for its retries, matching today's behavior.
|
||||
|
||||
## Concurrent safety — the headline guarantee
|
||||
|
||||
`LoggingContentGenerator` instance is shared (one per `ContentGenerator`, `contentGenerator.ts:377`). Three concurrent `generateContentStream` calls (e.g., 3 subagents fan out via `coreToolScheduler.runConcurrently`) execute three independent closures of `generateContentStream`:
|
||||
|
||||
```
|
||||
call_A: attemptStart_A, ttftMs_A, ... (closure)
|
||||
call_B: attemptStart_B, ttftMs_B, ... (closure)
|
||||
call_C: attemptStart_C, ttftMs_C, ... (closure)
|
||||
```
|
||||
|
||||
Per-call locals never overlap. Stream chunks are detected against the local `attemptStart` of each call. Span attributes are set at each call's own `endLLMRequestSpan`.
|
||||
|
||||
`AsyncLocalStorageContextManager` (registered by NodeSDK at `sdk.ts:273`) already ensures the active OTel context — and thus the parent span passed to `startLLMRequestSpan` — is correct per fiber.
|
||||
|
||||
## Files to change
|
||||
|
||||
| File | Change | LOC est |
|
||||
| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
||||
| `packages/core/src/telemetry/constants.ts` | Add `EVENT_API_RETRY` constant | +2 |
|
||||
| `packages/core/src/telemetry/types.ts` | Add `ApiRetryEvent` class + union member | +40 |
|
||||
| `packages/core/src/telemetry/loggers.ts` | Add `logApiRetry()` function | +20 |
|
||||
| `packages/core/src/telemetry/qwen-logger/qwen-logger.ts` | Add `logApiRetryEvent()` for RUM downstream consistency | +20 |
|
||||
| `packages/core/src/telemetry/session-tracing.ts` | Extend `LLMRequestMetadata` (ttftMs, requestSetupMs, attempt, retryTotalDelayMs); extend `endLLMRequestSpan` to set new attrs + breakdown metric + dual-emit gen_ai.\* | +60 |
|
||||
| `packages/core/src/telemetry/metrics.ts` | Wire `recordApiRequestBreakdown` callsite inside `endLLMRequestSpan` (no change to the existing recorder) | 0 |
|
||||
| `packages/core/src/utils/retry.ts` | Add `onRetry?: (info: RetryAttemptInfo) => void` to RetryOptions; export `RetryAttemptInfo`; invoke callback in the existing logRetryAttempt site | +25 |
|
||||
| `packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts` | TTFT capture: method-local accumulators + `hasUserVisibleContent` helper + first-chunk detection in stream wrapper; pass new metadata to `endLLMRequestSpan` | +80 |
|
||||
| `packages/core/src/core/client.ts` | Wire `onRetry` callback at `retryWithBackoff` call site (`client.ts:1540`) | +15 |
|
||||
| `packages/core/src/core/baseLlmClient.ts` | Wire `onRetry` callback at 2 `retryWithBackoff` call sites | +25 |
|
||||
| `packages/core/src/core/geminiChat.ts` | Wire `onRetry` callback at `retryWithBackoff` call site (`geminiChat.ts:1039`) | +15 |
|
||||
| `packages/core/src/telemetry/session-tracing.test.ts` | `endLLMRequestSpan` sets ttft_ms / request_setup_ms / attempt / retry_total_delay_ms / sampling_ms / output_tokens_per_second + gen_ai dual-emit + breakdown metric (each phase) + idempotent end | +120 |
|
||||
| `packages/core/src/core/loggingContentGenerator/loggingContentGenerator.test.ts` | `hasUserVisibleContent` (text / functionCall / inlineData / executableCode / thought / role-only / usage-only); concurrent calls don't cross-contaminate; TTFT undefined when aborted before first chunk; TTFT undefined on non-streaming | +100 |
|
||||
| `packages/core/src/utils/retry.test.ts` | `onRetry` invoked per failed attempt with correct `attempt`, `delayMs`, `error`, `errorStatus`; absence of `onRetry` is silent (no telemetry emitted) | +50 |
|
||||
| `packages/core/src/telemetry/loggers.test.ts` | `logApiRetry` emits LogRecord with expected payload; bridges through LogToSpanProcessor to nested span under active LLM span | +40 |
|
||||
|
||||
Total: 14 files, ~610 LOC. Larger than Phase 2 (#4321) but comparable to Phase 3 (#4410) and justified by the breadth of integration (4 retry sites + telemetry plumbing + streaming wrapper).
|
||||
|
||||
If review pushes back on size: split into **Phase 4a + 4b + 4c**:
|
||||
|
||||
- **4a** (~200 LOC): TTFT capture + extended `LLMRequestMetadata` + dual-emit. Self-contained value (TTFT visibility from day one).
|
||||
- **4b** (~250 LOC): `onRetry` callback + `ApiRetryEvent` + 4 caller wiring. **Independently a bug fix** for the `retryWithBackoff` telemetry gap.
|
||||
- **4c** (~160 LOC): `recordApiRequestBreakdown` activation + parent span aggregation attrs (`attempt`, `retry_total_delay_ms`, `sampling_ms`, `output_tokens_per_second`). Depends on 4a + 4b.
|
||||
|
||||
## Testing strategy
|
||||
|
||||
| Test | What it proves |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
|
||||
| `hasUserVisibleContent` returns true for text/functionCall/inlineData/executableCode/thought | D1 semantics across part types |
|
||||
| `hasUserVisibleContent` returns false for role-only and usage-only chunks | D1 negative cases |
|
||||
| streaming: TTFT measured from attempt start to first user-visible chunk | End-to-end TTFT detection |
|
||||
| streaming: TTFT undefined if stream aborts before any user-visible chunk | Edge case |
|
||||
| streaming: TTFT computed from final attempt's start (not first attempt) | D3 — TTFT reset on retry |
|
||||
| non-streaming: TTFT remains undefined | S3 decision |
|
||||
| concurrent `generateContentStream` calls don't cross-contaminate TTFT | D2 — method-local guarantee |
|
||||
| `endLLMRequestSpan` sets all Phase 4 attrs (ttft_ms, request_setup_ms, sampling_ms, attempt, retry_total_delay_ms, output_tokens_per_second) | Attribute presence |
|
||||
| `endLLMRequestSpan` dual-emits gen_ai.server.time_to_first_token + gen_ai.usage.\* + gen_ai.request.model | D8 dual-emit |
|
||||
| `endLLMRequestSpan` records breakdown metric with 3 phases for streaming, 2 for non-streaming | D6 |
|
||||
| `endLLMRequestSpan` called twice: metric recorded exactly once, attrs not re-set | D7 idempotency |
|
||||
| `retryWithBackoff` with `onRetry`: callback invoked per failed attempt with correct args | D4 callback contract |
|
||||
| `retryWithBackoff` without `onRetry`: no telemetry emitted (silent for non-LLM callers) | P2 — channels/weixin scope protection |
|
||||
| `client.ts` / `baseLlmClient.ts` / `geminiChat.ts` retry callsites emit `ApiRetryEvent` on retry | Integration of D4 at 4 sites |
|
||||
| `ApiRetryEvent` LogRecord bridges via LogToSpanProcessor to a child span under active LLM span | Trace tree correctness |
|
||||
| LLM span `attempt` field correctly reflects final attempt number under retries | D5 aggregation |
|
||||
| LLM span `retry_total_delay_ms` correctly sums onRetry delays | D5 aggregation |
|
||||
| `output_tokens_per_second` undefined when `sampling_ms === 0` (no streaming) | Avoid divide-by-zero |
|
||||
|
||||
## Edge cases
|
||||
|
||||
| Case | Handling |
|
||||
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Stream aborts before any chunk arrives | `ttftMs = undefined`, `sampling_ms = undefined`, `output_tokens_per_second = undefined`. `attempt`, `request_setup_ms` still set. `success = false` |
|
||||
| Stream aborts after first chunk | `ttftMs` set; `sampling_ms` = `duration_ms - ttftMs - request_setup_ms`; reflects partial response time. `success = false` |
|
||||
| Retry succeeds on attempt 1 (no retries) | `attempt = 1`, `retry_total_delay_ms = 0`, no `ApiRetryEvent` emitted, breakdown metric records `request_setup_ms` close to 0 |
|
||||
| Persistent retry mode 50+ attempts | 50+ `ApiRetryEvent` records emitted (out-of-scope cap deferred); LLM span `attempt = 51`, `retry_total_delay_ms = sum of all delays`. Operator sees aggregated view on span; full per-attempt detail in log-bridge spans |
|
||||
| Non-LLM `retryWithBackoff` caller (channels/weixin) | No `onRetry` registered; only existing `debugLogger.warn` fires. No `ApiRetryEvent`; no breakdown metric (caller isn't an LLM site) |
|
||||
| `endLLMRequestSpan` called twice (abort + error race) | Phase 1.5 guard at `activeSpans.delete()` returns early on second call; `recordApiRequestBreakdown` is inside the guard, recorded exactly once |
|
||||
| Anthropic `message_start` chunk arrives before content | `hasUserVisibleContent` returns false for it (no parts with text/functionCall/etc.); TTFT not triggered until subsequent `content_block_delta` chunk |
|
||||
| OpenAI first chunk with empty `delta.content` but `role` only | `hasUserVisibleContent` returns false; TTFT not triggered until first chunk with non-empty delta |
|
||||
| Tool-call-only response (no text) | First chunk with `functionCall` Part triggers TTFT; `output_tokens_per_second` computed against tool-call token count |
|
||||
| Concurrent subagents (3 calls in flight) | Each call's closure has its own `attemptStart`, `ttftMs`, `attemptStartTimes`. Per-call span receives its own metadata at `endLLMRequestSpan`. No interleaving (D2) |
|
||||
| SDK-level retries inside openai-sdk (`maxRetries=3`) | Invisible to qwen-code telemetry — happens entirely inside SDK before retryWithBackoff sees the request. `attempt` reflects retryWithBackoff attempts only. Out of scope (see Out-of-scope) |
|
||||
| `gen_ai.server.time_to_first_token` spec renames before reaching Stable | Single-file update: `session-tracing.ts:endLLMRequestSpan`. The qwen-code-native `ttft_ms` stays authoritative — no downstream impact |
|
||||
| Subagent's LLM request | Parent is the subagent span (Phase 3). Phase 4 fields nest correctly. Aggregations grouped by `qwen-code.subagent.id` give per-subagent LLM perf — design-doc-future, easy follow-up |
|
||||
| Reasoning model with long thought blocks | First `thought` Part triggers TTFT; `sampling_ms` includes both thinking + answer phases. Split into separate metrics deferred |
|
||||
|
||||
## Rollback
|
||||
|
||||
The change is additive at the OTel and metric level — every new attribute is optional, every new event is a new class. Existing dashboards that don't filter on the new fields keep working unchanged.
|
||||
|
||||
Behavior-affecting changes:
|
||||
|
||||
- New `ApiRetryEvent` LogRecord starts flowing → log volume increases proportional to retry rate (typically <1% of requests retry). Mitigate by sampling LogRecord at the SDK layer if needed.
|
||||
- New breakdown metric `qwen-code.api.request.breakdown` starts producing time series → mild Prometheus cardinality bump (`{model, phase}` — bounded).
|
||||
- `output_tokens_per_second` derived attribute may appear unusual on dashboards filtering "all attributes" — document.
|
||||
|
||||
Rollback path: revert the single PR (or each of 4a/4b/4c independently). All new fields use defensive defaults (undefined / 0) and don't change span structure.
|
||||
|
||||
## Sequencing
|
||||
|
||||
- **After Phase 3 (#4410, in review)**: not a hard dependency. Phase 4 attributes attach to `qwen-code.llm_request` spans regardless of whether they're under a `qwen-code.subagent` (Phase 3) or `qwen-code.interaction` (Phase 1) parent. Recommend Phase 3 land first so per-attempt aggregation under subagent subtrees works naturally.
|
||||
- **Independent of #4384** (`traceparent` + `X-Qwen-Code-Session-Id` outbound propagation). They touch the HTTP layer; Phase 4 touches the stream/retry/metric layer.
|
||||
- **Independent of `clearDetailedSpanState` chat-compression follow-up** (#4097 follow-up). Different surface.
|
||||
|
||||
## Open questions
|
||||
|
||||
1. **`onRetry` callback firing semantics**: invoked **before** backoff sleep (current proposal) or **after** (when the next attempt is about to start)? Before is simpler — callback has all the info immediately; after would require capturing the just-completed delay separately. Pre-sleep is the recommendation; document in callback contract.
|
||||
2. **Per-attempt timing on the LLM span**: should we add `attempt_durations_ms: number[]` array? OTel supports array-of-primitive attributes. Useful for "which attempt of N was slow" diagnostics. Defer until production data shows demand — log-bridge spans already carry the equivalent.
|
||||
3. **Persistent retry mode emission cap**: at what `attempt > N` threshold should we start sampling? `N = 5` then 1-in-10? `N = 10` then summary-only? Defer until we have production volume data.
|
||||
4. **`TOKEN_PROCESSING` phase**: keep enum value dormant or wire it to something (e.g., consolidation time)? Defer — wait for a real use case.
|
||||
5. **Subagent-level LLM rollups**: trivial follow-up once Phase 4 lands — sum `ttft_ms`/`output_tokens`/`input_tokens` per subagent subtree. Not Phase 4 scope but the data flow enables it.
|
||||
878
docs/design/telemetry-outbound-propagation-design.md
Normal file
878
docs/design/telemetry-outbound-propagation-design.md
Normal file
@ -0,0 +1,878 @@
|
||||
# Telemetry: Outbound Trace Context & Session ID Header Propagation
|
||||
|
||||
> 配套 issue: [#4384](https://github.com/QwenLM/qwen-code/issues/4384)
|
||||
> 父 issue: [#3731](https://github.com/QwenLM/qwen-code/issues/3731) (P3 deeper observability)
|
||||
> 前置 PR: #4367 (resource attributes — merged 2026-05-21, commit `64401e1`)
|
||||
> 基于 2026-05-21 对 qwen-code main 分支 + 直接验证的 claude-code 源码
|
||||
|
||||
## 修订历史
|
||||
|
||||
| 修订 | 日期 | 触发 | 摘要 |
|
||||
| ---- | ---------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| R1 | 2026-05-21 | 初稿 | 全广播:所有出站 LLM 请求都带 `X-Qwen-Code-Session-Id` + `traceparent` |
|
||||
| R2 | 2026-05-22 | wenshao R2/R3 review | 边界安全:URL normalize、port matching、quote 对齐、staticCorrelationHeaders try/catch、host:port fallback strip |
|
||||
| R3 | 2026-05-23 | LaZzyMan REQUEST_CHANGES | **重大语义改动**:`X-Qwen-Code-Session-Id` 默认作用域收窄到 first-party(Alibaba/DashScope)host 白名单。详见 §11 |
|
||||
| R4 | 2026-05-25 | LaZzyMan round-8 follow-up (scope conflation) | **PR scope 大幅收窄**:本 PR 仅保留 client HTTP span + OTLP loop guard;`traceparent` 默认 off(NoopTextMapPropagator);新增 `outboundCorrelation.*` 顶级 namespace 放安全相关 toggle;R3 落地的整套 `X-Qwen-Code-Session-Id` 机器**移除本 PR**,搬到独立 follow-up PR。详见 §12 |
|
||||
|
||||
**特别提示**:阅读 §3.1(目标)/ §3.2(非目标)/ §4.3(Part B 设计)/ §4.4(配置 schema 影响)/ §5(文件改动清单)/ §9(与 claude-code 对比)/ §10(未来工作)/ §11(R3 host-allowlist scoping)时,请同时参考 §12 —— **R4 修订让 R1-R3 关于"本 PR 同时落地 traceparent + session id header"的论断不再成立**:本 PR 现仅为 telemetry observability + 独立的 outbound trace-context toggle,所有 outbound correlation header 工作(包括 R3 的 host allowlist)整体搬到独立 follow-up PR。R3 工作代码本身没浪费,挪到 follow-up PR 即可复用。
|
||||
|
||||
## 1. 背景
|
||||
|
||||
#4367 解决了**emitted telemetry 上的 attribute 与 cardinality**(操作员能给 span/log/metric 打 `user.id`/`tenant.id` 这类标签)。但有一类东西它没碰:**outbound LLM 请求的 HTTP header**。今天 qwen-code 发往 DashScope / OpenAI / Gemini / Anthropic 的请求**完全不带任何 cross-process correlation header**——既没有 W3C `traceparent`,也没有 session id。
|
||||
|
||||
后果:
|
||||
|
||||
1. trace context 在 qwen-code 进程边界断开。若模型服务(如 ARMS Tracing 接入的 DashScope)本身有 OTel instrumentation,它产生的 span 与 qwen-code 的 trace 彼此独立,端到端 trace tree 不存在。
|
||||
2. 没有 session id 在 wire 上。后端要把 qwen-code 的 metric/log 与服务端日志关联,需要离线匹配 trace id 或时间戳,远不如直接读 header 简单。
|
||||
3. 本地 trace 缺一层 client-side HTTP span。今天只能看 `api.generateContent` 的总耗时,看不到网络 TTFB / 响应体大小 / 重试次数。
|
||||
|
||||
## 2. 现状
|
||||
|
||||
### 2.1 仅启用了 `HttpInstrumentation`
|
||||
|
||||
`packages/core/src/telemetry/sdk.ts:330`:
|
||||
|
||||
```ts
|
||||
instrumentations: [new HttpInstrumentation()],
|
||||
```
|
||||
|
||||
`HttpInstrumentation` 只 hook Node 内建的 `http`/`https` 模块,**不**覆盖 `globalThis.fetch` / undici 路径。
|
||||
|
||||
### 2.2 两套 LLM SDK 都走 fetch / undici
|
||||
|
||||
| SDK | HTTP 实现 | `HttpInstrumentation` 是否覆盖 |
|
||||
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
|
||||
| `openai@5.11.0` | `globalThis.fetch`(Node 18+ 即 undici)。证据:`node_modules/openai/internal/shims.mjs` 报错 `'fetch' is not defined as a global` | ❌ |
|
||||
| `@google/genai@1.30.0` | `globalThis.fetch` + `new Headers()`。证据:`dist/node/index.mjs` 内的 `new Headers()` 调用 | ❌ |
|
||||
| `@anthropic-ai/sdk`(anthropicContentGenerator) | 同样基于 fetch | ❌ |
|
||||
|
||||
### 2.3 代码库零 manual propagation
|
||||
|
||||
```
|
||||
grep -rn "propagation\.\|setGlobalPropagator\|W3CTraceContext\|traceparent" packages/core/src --include="*.ts" | grep -v "\.test\."
|
||||
```
|
||||
|
||||
→ 空。没有任何 `propagation.inject()` 调用,没有手动 traceparent 注入。
|
||||
|
||||
### 2.4 各 provider 的 `defaultHeaders` 现状
|
||||
|
||||
OpenAI 家族(用 `openai` SDK):
|
||||
|
||||
所有 OpenAI 子 provider 都 `extends DefaultOpenAICompatibleProvider`。**buildHeaders override 行为分两类**(已 grep audit 验证):
|
||||
|
||||
| Provider | 文件 | `buildHeaders()` 行为 | 影响 |
|
||||
| ---------- | ---------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- |
|
||||
| 基类 | `default.ts:63-74` | 提供 `{ 'User-Agent' }` + customHeaders | 改这里 |
|
||||
| DashScope | `dashscope.ts:110-124` | **`override` 但不 call `super`**——返回 `User-Agent` + `X-DashScope-*` 全新对象 | **必须单独改这里**,否则 correlation header 丢 |
|
||||
| OpenRouter | `openrouter.ts:20-30` | `override` 但**先 `const baseHeaders = super.buildHeaders()`** | 改基类自动继承 ✅ |
|
||||
| DeepSeek | `deepseek.ts` | 不 override `buildHeaders`(只 override `buildRequest` / `getDefaultGenerationConfig`) | 改基类自动继承 ✅ |
|
||||
| Minimax | `minimax.ts` | 同 deepseek | 自动继承 ✅ |
|
||||
| Mistral | `mistral.ts` | 同 deepseek | 自动继承 ✅ |
|
||||
| ModelScope | `modelscope.ts` | 同 deepseek | 自动继承 ✅ |
|
||||
|
||||
→ **OpenAI 家族需要触动 2 个文件**:`default.ts` 和 `dashscope.ts`。其余 5 个自动继承。
|
||||
|
||||
Google Gemini:
|
||||
|
||||
| Provider | 文件 | 头注入路径 |
|
||||
| -------- | ------------------------------ | -------------------------------------------------------------- |
|
||||
| Gemini | `geminiContentGenerator.ts:59` | `new GoogleGenAI({ httpOptions: { headers } })` — SDK 原生支持 |
|
||||
|
||||
Anthropic:
|
||||
|
||||
| Provider | 文件 | 头注入路径 |
|
||||
| --------- | ------------------------------------------------------------------------------------------------------ | ---------------- |
|
||||
| Anthropic | `anthropicContentGenerator.ts:177` (`buildHeaders`) + `:212` (`defaultHeaders` arg to `new Anthropic`) | `defaultHeaders` |
|
||||
|
||||
**总计 4 个 SDK 构造点**需要注入 session id header。所有 SDK 都已支持 `defaultHeaders` / `httpOptions.headers`,无需 fetch wrapper。
|
||||
|
||||
### 2.5 已有的 proxy 与 fetch 配置
|
||||
|
||||
`provider/default.ts:87-89`:
|
||||
|
||||
```ts
|
||||
const runtimeOptions = buildRuntimeFetchOptions(
|
||||
'openai',
|
||||
this.cliConfig.getProxy(),
|
||||
);
|
||||
```
|
||||
|
||||
`buildRuntimeFetchOptions` 在用户配 proxy 时返回 `{ fetch: customFetch }` 或类似,触发 `setGlobalDispatcher(new ProxyAgent(...))`(见 `config.ts:1126-1128`)。**undici 全局 dispatcher 模式与 `UndiciInstrumentation` 兼容**——它通过 monkey-patch `globalThis.fetch` 与 undici 的 channel diagnostics 协作,不依赖具体 dispatcher。
|
||||
|
||||
## 3. 目标 / 非目标
|
||||
|
||||
### 3.1 目标
|
||||
|
||||
- 所有 outbound LLM 请求自动带 W3C `traceparent` header(OTel SDK 默认的 `W3CTraceContextPropagator`)
|
||||
- ~~所有~~ 出站 LLM 请求带 `X-Qwen-Code-Session-Id` header(claude-code 同款产品命名空间) — **R3 修订**:默认仅向 first-party (Alibaba/DashScope) host 注入,第三方 provider 默认不发;详见 §11
|
||||
- 自动避免对 OTLP exporter endpoint 自身的 trace(feedback loop)
|
||||
- 给 LLM 请求加一层精确的 client span(网络耗时 vs 模型耗时分离)
|
||||
- 覆盖 4 个 provider 构造点:OpenAI 基类、DashScope override、Gemini、Anthropic
|
||||
- streaming 请求 / proxy 模式 / 重试场景全部不退化
|
||||
- 与 #4367 的设计哲学一致:通过 `defaultHeaders` 这种 SDK-native 选项 — **R1 修订**:因 staleness 问题转用 fetch wrapper;**R3 修订**:fetch wrapper 内再叠加 host gate
|
||||
|
||||
### 3.2 非目标
|
||||
|
||||
- **`baggage` header**:标准 SDK 已支持,但 qwen-code 没调 `propagation.setBaggage()`,默认不会发送。本设计不主动开启。
|
||||
- **subprocess `TRACEPARENT` env var 继承**:claude-code 给 Bash/PowerShell 子进程注入 `TRACEPARENT`。qwen-code 的 `BashTool` 没做。是独立 follow-up sub-issue。
|
||||
- **inbound `TRACEPARENT` / `TRACESTATE` 读取**:claude-code 的 `-p` 模式和 Agent SDK 从 env 读 traceparent 接续父进程 trace。qwen-code 没做。独立 follow-up。
|
||||
- **`X-Qwen-Code-Request-Id`**:claude-code 有 `x-client-request-id`,对超时容错 correlation 有用。本期不做,可作为下一个 sub-issue。
|
||||
- **自定义 propagator(B3 / Jaeger / X-Ray)**:默认 W3C 已覆盖 99% 场景。可作为 future config option。
|
||||
- ~~**per-endpoint 选择性注入**:claude-code 对第三方 endpoint (Bedrock / Vertex) 不发 traceparent;qwen-code 没有第三方区分需要,统一发即可。~~ — **R3 修订**:此论断已被推翻。LaZzyMan review 指出 qwen-code 是开源 CLI 连接多个第三方 provider(OpenAI / Anthropic / OpenRouter / 等),claude-code 的 first-party→first-party 类比不适用;session id header 必须按 host 区分。详见 §11。`traceparent` 仍按 R1 设计全注入(OTel 标准 header,且 trace id 是 `sha256(sessionId)` 哈希值),可作为独立 follow-up 加 per-destination toggle(`telemetry.propagateTraceContext`)。
|
||||
|
||||
## 4. 设计
|
||||
|
||||
### 4.1 总体分层
|
||||
|
||||
```
|
||||
┌─ qwen-code process ────────────────────────────────────────────┐
|
||||
│ │
|
||||
│ ┌─ session-tracing.ts ─┐ │
|
||||
│ │ active span ctx │ │
|
||||
│ └──────┬───────────────┘ │
|
||||
│ │ │
|
||||
│ ▼ │
|
||||
│ ┌─ propagation.inject() (called by undici instrumentation) ─┐│
|
||||
│ │ writes `traceparent: 00-<traceId>-<spanId>-01` to headers ││
|
||||
│ └─────────────────────────────────────────────────────────────┘│
|
||||
│ │ │
|
||||
│ ┌──────▼──────────────────────────────────────────────────┐ │
|
||||
│ │ fetch() — undici, instrumented │ │
|
||||
│ │ creates HTTP client span │ │
|
||||
│ │ injects traceparent into request headers │ │
|
||||
│ │ (skipped via ignoreRequestHook if endpoint is OTLP) │ │
|
||||
│ └─────────────────────────────────────────────────────────┘ │
|
||||
│ │ │
|
||||
│ │ ┌─ defaultHeaders (per SDK constructor) ───────┐ │
|
||||
│ │ │ { 'X-Qwen-Code-Session-Id': sessionId, ... } │ │
|
||||
│ └───┴────────────────────────────────────────────────┘ │
|
||||
│ │ │
|
||||
└─────────────┼──────────────────────────────────────────────────┘
|
||||
│
|
||||
▼ outbound HTTP
|
||||
POST /v1/chat/completions
|
||||
traceparent: 00-...
|
||||
X-Qwen-Code-Session-Id: ...
|
||||
... (existing User-Agent, X-DashScope-*, etc.)
|
||||
```
|
||||
|
||||
两条注入路径独立、互不依赖:
|
||||
|
||||
| Layer | 何时注入 | 由谁注入 |
|
||||
| ------------------------ | ------------------------------------- | ------------------------------------------------------------- |
|
||||
| `traceparent` | 每次 fetch 调用时 | `UndiciInstrumentation` 自动(来自 OTel SDK 默认 propagator) |
|
||||
| `X-Qwen-Code-Session-Id` | SDK 构造时一次性写入 `defaultHeaders` | 应用代码 |
|
||||
|
||||
### 4.2 Part A — `traceparent` via undici instrumentation
|
||||
|
||||
**改动点**:`packages/core/src/telemetry/sdk.ts`
|
||||
|
||||
```ts
|
||||
import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
|
||||
|
||||
// ...
|
||||
const otlpUrls = [
|
||||
config.getTelemetryOtlpEndpoint(),
|
||||
config.getTelemetryOtlpTracesEndpoint(),
|
||||
config.getTelemetryOtlpLogsEndpoint(),
|
||||
config.getTelemetryOtlpMetricsEndpoint(),
|
||||
]
|
||||
.filter((u): u is string => !!u)
|
||||
.map((u) => u.replace(/\/$/, ''));
|
||||
|
||||
instrumentations: [
|
||||
new HttpInstrumentation(),
|
||||
new UndiciInstrumentation({
|
||||
ignoreRequestHook: (request) => {
|
||||
// request.origin = "https://collector:4318", request.path = "/v1/traces"
|
||||
const url = `${request.origin}${request.path}`;
|
||||
return otlpUrls.some((e) => url.startsWith(e));
|
||||
},
|
||||
}),
|
||||
],
|
||||
```
|
||||
|
||||
#### 为什么 `ignoreRequestHook` 必须
|
||||
|
||||
OTel SDK 自己用 fetch 把数据 POST 到 OTLP collector。如果不跳,UndiciInstrumentation 会给"上报数据"的请求也建一个 span → 这个新 span 会被再次上报 → 无限循环 / 巨量噪声。每个 OTel 项目都踩过这个坑,OTel 文档明确推荐这种 hook。
|
||||
|
||||
#### 默认 propagator
|
||||
|
||||
OTel SDK `NodeSDK` 不传 `textMapPropagator` 时默认是 `CompositePropagator([W3CTraceContextPropagator, W3CBaggagePropagator])`。无需显式设置。
|
||||
|
||||
#### `traceparent` 格式
|
||||
|
||||
```
|
||||
traceparent: 00-<32hex traceId>-<16hex spanId>-<01 sampled | 00 not sampled>
|
||||
─┬─ ─┬─
|
||||
version (固定 00) flags
|
||||
```
|
||||
|
||||
固定 55 bytes,无 padding。
|
||||
|
||||
#### `tracestate` 与 `baggage`
|
||||
|
||||
- `tracestate`: 上游传过来才续传;自己 inject 不会主动加(OTel SDK 行为)。
|
||||
- `baggage`: 仅当 `propagation.setBaggage(ctx, ...)` 被调用过才有。qwen-code 不调,所以不会发送。
|
||||
|
||||
### 4.3 Part B — `X-Qwen-Code-Session-Id` via fetch wrapper(OpenAI / Anthropic)+ static headers(Gemini)
|
||||
|
||||
> **R3 修订**:以下设计描述的是 fetch wrapper 的 staleness 解决和 4 个 provider 集成点 — 这些都保留。但 wrapper 内部增加了一道 host allowlist gate,`staticCorrelationHeaders` 也加了 `destinationUrl` 参数。带 host gate 的最新实现代码与 default allowlist 见 §11。
|
||||
|
||||
#### Critical:staleness 问题与方案选择
|
||||
|
||||
天真做法(`defaultHeaders` 直接 bake-in `getSessionId()`)有**真 bug**:
|
||||
|
||||
1. `pipeline.ts:60` 在 contentGenerator 构造时一次性 `this.client = this.config.provider.buildClient()`,SDK client 的 `defaultHeaders` 在那一刻 capture 当时的 session id
|
||||
2. `config.ts:1850` 的 session reset(用户 `/clear` 时触发)更新 `this.sessionId` 并 `refreshSessionContext()`,但**不重建 contentGenerator**
|
||||
3. 后续 LLM 调用仍走旧 client → wire header 仍是旧 session id → 后端 correlation 错位
|
||||
|
||||
→ 必须读取 session id **per-request**,不能 bake at构造时。
|
||||
|
||||
#### 方案
|
||||
|
||||
```
|
||||
┌─ fetch 支持 ─┐ 方案
|
||||
OpenAI SDK │ ✅ │ fetch wrapper (per-request 读 sessionId) ✅
|
||||
Anthropic SDK │ ✅ │ fetch wrapper ✅
|
||||
@google/genai SDK │ ❌ │ static httpOptions.headers + 接受 staleness
|
||||
└──────────────┘
|
||||
```
|
||||
|
||||
`@google/genai`'s `HttpOptions` interface 不支持 `fetch`(已 grep `node_modules/@google/genai/dist/genai.d.ts` 验证:只有 `baseUrl`/`apiVersion`/`headers`/`timeout`/`extraParams`)。所以 Gemini 走 static headers,与 OpenAI/Anthropic 不一致——这是 **known limitation**,见 §8.6。
|
||||
|
||||
#### 集中辅助函数(per-request fetch wrapper)
|
||||
|
||||
新文件 `packages/core/src/telemetry/llm-correlation-fetch.ts`:
|
||||
|
||||
```ts
|
||||
import type { Config } from '../config/config.js';
|
||||
|
||||
/**
|
||||
* Wrap a fetch implementation so every outbound request gets correlation
|
||||
* headers (`X-Qwen-Code-Session-Id`) populated from the **current** session
|
||||
* id, not the value captured when the SDK client was constructed.
|
||||
*
|
||||
* Matches claude-code's pattern (src/services/api/client.ts:370-390 —
|
||||
* `buildFetch()`). Per-request injection is necessary because `/clear`
|
||||
* resets the session id mid-process; SDK clients (and their static
|
||||
* `defaultHeaders`) are NOT recreated on reset.
|
||||
*
|
||||
* Caller responsible for choosing the base fetch — usually
|
||||
* `runtimeOptions?.fetch ?? globalThis.fetch` so proxy-aware fetch is
|
||||
* preserved when ProxyAgent is in use.
|
||||
*
|
||||
* If telemetry is disabled, returns baseFetch unchanged (no correlation
|
||||
* header is added, matching the privacy stance of §3.1).
|
||||
*/
|
||||
export function wrapFetchWithCorrelation(
|
||||
baseFetch: typeof fetch,
|
||||
config: Config,
|
||||
): typeof fetch {
|
||||
return async function correlationFetch(input, init) {
|
||||
if (!config.getTelemetryEnabled()) {
|
||||
return baseFetch(input, init);
|
||||
}
|
||||
const sid = config.getSessionId();
|
||||
if (!sid) {
|
||||
// Defensive: empty header value is rejected by some HTTP middleware.
|
||||
// Skip injection rather than send `X-Qwen-Code-Session-Id: `.
|
||||
return baseFetch(input, init);
|
||||
}
|
||||
const headers = new Headers(init?.headers);
|
||||
headers.set('X-Qwen-Code-Session-Id', sid);
|
||||
return baseFetch(input, { ...init, headers });
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
Companion helper for the SDKs that can only take static headers (Gemini):
|
||||
|
||||
```ts
|
||||
/**
|
||||
* Static correlation headers. Captures the session id at call time —
|
||||
* **subject to staleness** if the host SDK keeps these headers in a
|
||||
* captured-at-construction slot (e.g. `@google/genai`'s `httpOptions.headers`).
|
||||
* Prefer `wrapFetchWithCorrelation` whenever the SDK exposes a `fetch` hook.
|
||||
*/
|
||||
export function staticCorrelationHeaders(
|
||||
config: Config,
|
||||
): Record<string, string> {
|
||||
if (!config.getTelemetryEnabled()) return {};
|
||||
return { 'X-Qwen-Code-Session-Id': config.getSessionId() };
|
||||
}
|
||||
```
|
||||
|
||||
#### 集成点 1: `provider/default.ts` (OpenAI 基类)
|
||||
|
||||
`buildClient()` 改动——compose 现有 `runtimeOptions.fetch`(proxy)与我们的 wrapper:
|
||||
|
||||
```ts
|
||||
buildClient(): OpenAI {
|
||||
// ... existing ...
|
||||
const runtimeOptions = buildRuntimeFetchOptions('openai', this.cliConfig.getProxy());
|
||||
const baseFetch =
|
||||
(runtimeOptions as { fetch?: typeof fetch } | undefined)?.fetch
|
||||
?? globalThis.fetch;
|
||||
return new OpenAI({
|
||||
apiKey,
|
||||
baseURL: baseUrl,
|
||||
timeout,
|
||||
maxRetries,
|
||||
defaultHeaders,
|
||||
...(runtimeOptions || {}),
|
||||
// After spread, override `fetch` so our correlation wrapper wraps the
|
||||
// proxy-aware fetch (or globalThis.fetch when no proxy).
|
||||
fetch: wrapFetchWithCorrelation(baseFetch, this.cliConfig),
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
`buildHeaders()` itself unchanged.
|
||||
|
||||
#### 集成点 2: `provider/dashscope.ts` (override)
|
||||
|
||||
`buildClient()` 同样的 compose 模式(它本来就 override buildClient)。`buildHeaders()` 不动。
|
||||
|
||||
#### 集成点 3: `geminiContentGenerator/index.ts` (factory, NOT 构造器)
|
||||
|
||||
**修正先前设计的过度声明**:`geminiContentGenerator.ts` 构造器**不需要**改签名。`index.ts:48` 的 factory 函数已经接收 `gcConfig: Config`(line 33 已经在用 `gcConfig?.getUsageStatisticsEnabled()`),只需要在 factory 里把 correlation 静态 headers merge 进 `httpOptions.headers`:
|
||||
|
||||
```ts
|
||||
// geminiContentGenerator/index.ts
|
||||
let headers: Record<string, string> = { ...baseHeaders };
|
||||
if (gcConfig?.getUsageStatisticsEnabled()) {
|
||||
// ... existing x-gemini-api-privileged-user-id ...
|
||||
}
|
||||
headers = { ...headers, ...staticCorrelationHeaders(gcConfig) }; // ← 新增
|
||||
const httpOptions = config.baseUrl
|
||||
? { headers, baseUrl: config.baseUrl }
|
||||
: { headers };
|
||||
// new GeminiContentGenerator(...) unchanged
|
||||
```
|
||||
|
||||
零 signature 改动。
|
||||
|
||||
#### 集成点 4: `anthropicContentGenerator.ts`
|
||||
|
||||
Anthropic SDK 同样接受 custom `fetch`(已经在用 `buildRuntimeFetchOptions`)。把 `buildClient` 路径里那个 fetch wrap 一下,方式同 OpenAI default.ts。`buildHeaders` 不变。
|
||||
|
||||
#### 优先级链
|
||||
|
||||
不变:用户的 `customHeaders` 在 `defaultHeaders` merge 中仍然赢(见 §8.2 spoofing 讨论)。fetch wrapper 注入的 `X-Qwen-Code-Session-Id` 在 SDK 的 headers list 之**后**追加到最终 `Headers` 对象上——以 Node `Headers.set()` 的语义,等于覆盖任何之前同名的(包括 user 的 customHeaders 里写的同名 header)。
|
||||
|
||||
**对 OpenAI/Anthropic(fetch wrapper 路径)**:correlation > customHeaders > SDK defaults。
|
||||
**对 Gemini(static headers 路径)**:customHeaders > correlation > SDK defaults(沿用既有 spread 顺序)。
|
||||
|
||||
差异是 fetch wrapper 路径下 spoofing 不再可能(fetch wrapper 在 SDK headers 之后跑)。这是 **bug 修复的副产品**,并非有意收紧——但更安全。要在 §8.2 明示。
|
||||
|
||||
### 4.4 配置 schema 影响
|
||||
|
||||
~~**几乎为零**。本设计不引入新 setting~~ — **R3 修订**:引入了一项新 setting `telemetry.sessionIdHeaderHosts: string[]`,用于覆盖默认的 first-party host 白名单。schema 项已加入 `packages/cli/src/config/settingsSchema.ts`,描述与 override 语法(`["*"]` 恢复广播 / `[]` 全关 / 自定义数组)见 §11。原文以下描述仅适用于 R3 之前:
|
||||
|
||||
- `traceparent` 注入由 telemetry enabled 触发(已有 toggle)
|
||||
- `X-Qwen-Code-Session-Id` 注入也由 telemetry enabled 触发
|
||||
- `ignoreRequestHook` 的 OTLP url 已经从现有 config 读
|
||||
|
||||
未来可以加的 setting(**out of scope**):
|
||||
|
||||
- `telemetry.outboundCorrelationHeader`: 自定义 header name(默认 `X-Qwen-Code-Session-Id`)
|
||||
- `telemetry.outboundPropagationDisabled`: 全局关闭(如果 LLM 服务对未知 header 严格)
|
||||
- ~~per-destination header scope toggle~~ — **R3 已落地**,见 §11
|
||||
|
||||
## 5. 文件改动清单
|
||||
|
||||
| 文件 | 改动类型 | 说明 |
|
||||
| ------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `packages/core/package.json` | 加依赖 | `@opentelemetry/instrumentation-undici` |
|
||||
| `packages/core/src/telemetry/sdk.ts` | 修改 | +`UndiciInstrumentation` + `ignoreRequestHook` |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.ts` | 新文件 | `wrapFetchWithCorrelation()` (OpenAI/Anthropic) + `staticCorrelationHeaders()` (Gemini fallback) |
|
||||
| `packages/core/src/core/openaiContentGenerator/provider/default.ts` | 修改 | `buildClient()` 在 `new OpenAI({...})` 里加 `fetch: wrapFetchWithCorrelation(baseFetch, cliConfig)` |
|
||||
| `packages/core/src/core/openaiContentGenerator/provider/dashscope.ts` | 修改 | 同上(override `buildClient`) |
|
||||
| `packages/core/src/core/geminiContentGenerator/index.ts` | 修改 | factory 函数里 merge `staticCorrelationHeaders(gcConfig)` 进 `httpOptions.headers`(**caller 已有 Config,零 signature 改动** — 修正之前的 over-specification) |
|
||||
| `packages/core/src/core/anthropicContentGenerator/anthropicContentGenerator.ts` | 修改 | `buildClient` 路径下用 `wrapFetchWithCorrelation` 包 SDK 的 `fetch` option |
|
||||
|
||||
**显式 audited 但无需改动**(避免 reviewer 怀疑漏路径):
|
||||
|
||||
- `packages/core/src/qwen/qwenContentGenerator.ts` — `extends OpenAIContentGenerator`,用 `DashScopeOpenAICompatibleProvider`,**自动继承 dashscope.ts 的 buildClient 改动**。所有 Qwen OAuth 流程同样受益。
|
||||
- `packages/core/src/core/loggingContentGenerator/loggingContentGenerator.ts` — wrapper 模式,不构造 SDK client(它包装其他 contentGenerator 做 telemetry logging),无需改动。
|
||||
- `packages/core/src/core/contentGenerator.ts` — factory 入口,不持有 client。
|
||||
| `packages/core/src/telemetry/sdk.test.ts` | 修改 | 加 undici instrumentation 注册 + ignoreRequestHook 测试 |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.test.ts` | 新文件 | telemetry-on/off 行为单测 + per-request 读 sessionId 验证(critical:session reset 后 wrapped fetch 读到新 id) |
|
||||
| 各 provider 的 `*.test.ts` | 修改 | 断言 SDK 构造时 `fetch` option 是 wrapped 版本(OpenAI/Anthropic);断言 Gemini 构造时 `httpOptions.headers` 含 `X-Qwen-Code-Session-Id` |
|
||||
| `docs/developers/development/telemetry.md` | 修改 | 新增 "Trace context & session correlation propagation" 段 |
|
||||
| `docs/design/telemetry-outbound-propagation-design.md` | 本文件 | 设计文档 |
|
||||
|
||||
## 6. 分 PR 拆分
|
||||
|
||||
按 review 友好度分两个 PR(也可以合一,规模允许):
|
||||
|
||||
### PR 1 — `traceparent` 自动注入(structural)
|
||||
|
||||
- 加 `@opentelemetry/instrumentation-undici` 依赖
|
||||
- `sdk.ts` 加 `UndiciInstrumentation` + `ignoreRequestHook`
|
||||
- 测试:SDK 注册、OTLP endpoint 不被 trace
|
||||
- 文档片段
|
||||
|
||||
**风险**:低。Additive。已有 client span 是 net 增益,不会改变现有 span 结构。
|
||||
|
||||
### PR 2 — `X-Qwen-Code-Session-Id` header(结合 helper 函数)
|
||||
|
||||
- 新文件 `llm-correlation-headers.ts`
|
||||
- 4 个 provider 集成
|
||||
- 测试:每个 provider 断言 header 存在;telemetry-off 时不发
|
||||
- 文档片段
|
||||
|
||||
**风险**:低-中。要小心 `geminiContentGenerator` 构造器签名扩展可能波及调用方。
|
||||
|
||||
### PR 3(可选) — Docs + E2E verify
|
||||
|
||||
- 完善 `telemetry.md` 段落
|
||||
- 加 E2E verify script(复用 `/tmp/verify-telemetry-pr-4367.mjs` 模式):实际跑 fetch + 抓 header
|
||||
|
||||
也可以合并到 PR 2 里。
|
||||
|
||||
### 顺序偏好
|
||||
|
||||
PR 1 和 PR 2 技术上**互相独立**——不共享代码。但**推荐 PR 1 先合**:
|
||||
|
||||
- `traceparent` 是 OTel **标准** header,任何 OTel-aware collector / 后端立刻识别 → 用户立即获益
|
||||
- `X-Qwen-Code-Session-Id` 是**产品自定义** header,需要后端配置识别才有价值 → 价值滞后
|
||||
- 万一 PR 2 review 周期长,PR 1 已经把 cross-process trace 跑通了
|
||||
- PR 1 是 additive structural(低风险),适合先建立信心
|
||||
|
||||
## 7. 测试计划
|
||||
|
||||
### 7.1 `sdk.ts` 单测
|
||||
|
||||
- ✅ `UndiciInstrumentation` 在 `NodeSDK` 的 `instrumentations` 中存在
|
||||
- ✅ `ignoreRequestHook` 对 `https://collector:4318/v1/traces` 返回 true
|
||||
- ✅ `ignoreRequestHook` 对 `https://dashscope.aliyuncs.com/...` 返回 false
|
||||
- ✅ trailing slash 与无 trailing slash 都正确匹配
|
||||
|
||||
### 7.2 `llm-correlation-fetch.ts` 单测
|
||||
|
||||
**`wrapFetchWithCorrelation`**:
|
||||
|
||||
| 场景 | 期望 |
|
||||
| ------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `getTelemetryEnabled() === false` | wrapped fetch = baseFetch(不加任何 header) |
|
||||
| `getTelemetryEnabled() === true`, sessionId = "abc-123" | wrapped fetch 发出的 init.headers 含 `X-Qwen-Code-Session-Id: abc-123` |
|
||||
| `init.headers` 已有 `X-Qwen-Code-Session-Id: spoof` | wrapper 后覆盖为真 sessionId(fetch wrapper 路径不允许 spoof,§8.1) |
|
||||
| **session reset 后 wrapped fetch 被再次调用** | **读取新 sessionId**(regression guard for staleness fix) |
|
||||
| baseFetch reject | wrapper 透传 reject 不吞 |
|
||||
|
||||
**`staticCorrelationHeaders`**(Gemini path):
|
||||
|
||||
| 场景 | 期望返回 |
|
||||
| ------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| `getTelemetryEnabled() === false` | `{}` |
|
||||
| `getTelemetryEnabled() === true`, sessionId = "abc-123" | `{ 'X-Qwen-Code-Session-Id': 'abc-123' }` |
|
||||
| sessionId 中含 unicode(`會話-1`) | 原样返回——HTTP header value 由 SDK 负责编码 |
|
||||
| sessionId 为空字符串 | `{ 'X-Qwen-Code-Session-Id': '' }`——业务 invariant,不在此层校验 |
|
||||
|
||||
### 7.3 Per-provider 集成测试
|
||||
|
||||
每个 provider 的 `buildHeaders()` / 构造测试加:
|
||||
|
||||
```ts
|
||||
it('includes X-Qwen-Code-Session-Id when telemetry enabled', () => {
|
||||
const config = makeFakeConfig({
|
||||
sessionId: 'sess-xyz',
|
||||
telemetry: { enabled: true },
|
||||
});
|
||||
const provider = new DefaultProvider(genConfig, config);
|
||||
expect(provider.buildHeaders()['X-Qwen-Code-Session-Id']).toBe('sess-xyz');
|
||||
});
|
||||
|
||||
it('omits X-Qwen-Code-Session-Id when telemetry disabled', () => {
|
||||
const config = makeFakeConfig({ telemetry: { enabled: false } });
|
||||
const provider = new DefaultProvider(genConfig, config);
|
||||
expect(provider.buildHeaders()).not.toHaveProperty('X-Qwen-Code-Session-Id');
|
||||
});
|
||||
```
|
||||
|
||||
### 7.4 E2E verification(tmux + local HTTP server)
|
||||
|
||||
⚠️ **不要** mock `globalThis.fetch` 来抓 header:`UndiciInstrumentation` 通过 undici 的 diagnostics channel hook,monkey-patching globalThis.fetch 可能完全 bypass instrumentation(取决于 patch 顺序),让 `traceparent` 注入测不到。**正确做法是起 local HTTP server**,让 SDK 真发请求,server 端记录收到的 headers。
|
||||
|
||||
写一个仿 `/tmp/verify-telemetry-pr-4367.mjs` 的脚本:
|
||||
|
||||
1. `http.createServer((req, res) => { capturedHeaders.push(req.headers); res.end('{}') })` 起本地 server
|
||||
2. 启 telemetry + outfile + 把 OpenAI SDK 的 `baseURL` 指向 `http://127.0.0.1:<port>`(或者用 mock provider 让 SDK 真发 fetch)
|
||||
3. 触发一次 `client.chat.completions.create(...)`(要带最小可解析的 mock 响应,否则 SDK 解析报错——本地 server 返回合法但空的 OpenAI 响应即可)
|
||||
4. 断言 `capturedHeaders[0]` 含 `traceparent: 00-...` 和 `X-Qwen-Code-Session-Id: <sessionId>`
|
||||
5. 另起一个 OTLP collector mock 在 different port,验证给它发的 OTLP 上报**不**触发 `traceparent` 注入(验证 `ignoreRequestHook`)
|
||||
6. **额外:staleness 验证** — emit request 1 → call `config.resetSession(...)` → emit request 2 → 断言 request 2 的 `X-Qwen-Code-Session-Id` 是新 session id(**这是 #1 fix 的关键回归测试**)
|
||||
|
||||
### 7.5 回归保护
|
||||
|
||||
- streaming chat completion 的 fetch(带 `stream: true`)仍正常关闭——`UndiciInstrumentation` 历史上对 streaming response 的 span lifecycle 有过 bug,**实施时需要实际跑一次 streaming completion 端到端验证 client span 正常 end + 无 leaked span + 流不被截断**;不假设具体版本号已修
|
||||
- proxy mode (`ProxyAgent`) 与 instrumentation 同时启用——`ignoreRequestHook` 仍按 endpoint 字符串匹配,proxy 不影响
|
||||
- 重试(`maxRetries`)下每次重试都得到独立 client span,但都共享同一个 `traceparent` parent(理想是 retry 作为同一个父 span 下多个 child span — 这部分由 SDK 行为决定,本设计不强制)
|
||||
|
||||
## 8. 边界 / 边角
|
||||
|
||||
### 8.1 customHeaders override 与 spoofing 的不一致行为
|
||||
|
||||
不同 provider 路径的 spoofing 表面**不同**(设计后果,非原意收紧):
|
||||
|
||||
| Provider 路径 | spoofing 可能? | 原因 |
|
||||
| --------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| OpenAI / Anthropic (fetch wrapper 路径) | ❌ 不能 spoof | fetch wrapper 在 SDK headers list 之后 `headers.set('X-Qwen-Code-Session-Id', ...)`,覆盖 user customHeaders 的同名 |
|
||||
| Gemini (static headers 路径) | ✅ 可 spoof | merge 顺序 `{ ...baseHeaders, ...correlationHeaders, ...customHeaders }`——customHeaders 最后赢 |
|
||||
|
||||
claude-code 同样使用 fetch wrapper 路径,行为与 OpenAI/Anthropic 一致(spoofing 不能)。这是修 staleness bug 的副产品,不是原本要做的事。
|
||||
|
||||
**不打算"对齐"两条路径**——Gemini 路径的行为是 SDK 限制(没有 `fetch` hook)导致的,反向把 OpenAI 也降级到 static 不合理。
|
||||
|
||||
Session id spoofing 不是真威胁(用户控制本地,可以直接改 source code)。文档里要明示这个差异,避免 reviewer 看到 fetch wrapper 路径无法 spoof 时质疑 customHeaders 优先级。
|
||||
|
||||
### 8.2 OTLP collector URL 匹配的两类 edge case
|
||||
|
||||
#### (a) Auth token in URL
|
||||
|
||||
如果用户 OTLP endpoint 形如 `https://collector/path?token=secret`,`ignoreRequestHook` 的 `url.startsWith(e)` 比对应包含 query string。但 undici 给的 `request.path` 只到 path(不含 query),所以比较时 `e` 也只用到 path 部分。为安全起见,剥掉 query:
|
||||
|
||||
```ts
|
||||
const otlpUrls = [...]
|
||||
.map((u) => u.replace(/\?.*$/, '').replace(/\/$/, ''));
|
||||
```
|
||||
|
||||
#### (b) startsWith 跨 hostname 边界的理论 false positive
|
||||
|
||||
若 `e = "http://collector"`(无 port),来路 url = `http://collector-fake/v1/traces` 会被 startsWith 错误匹配。
|
||||
|
||||
**实际触发概率极低**:
|
||||
|
||||
- OTLP endpoint 几乎总带 port(4317 gRPC / 4318 HTTP),`http://collector:4318` 形态后 `-fake` 这种延伸不可能(port 后跟的是 `/`)
|
||||
- 用户配 endpoint 不带 port 是配置错误,本来 SDK 就要默认 fallback
|
||||
|
||||
**如果想 harden**:解析 URL origin + path 分别比较,不用裸 startsWith:
|
||||
|
||||
```ts
|
||||
const parsed = otlpUrls.map((u) => new URL(u));
|
||||
return parsed.some(
|
||||
(e) =>
|
||||
`${request.origin}` === e.origin && request.path.startsWith(e.pathname),
|
||||
);
|
||||
```
|
||||
|
||||
本期不做——开销没必要,false positive 实际触发不到。
|
||||
|
||||
### 8.3 Vertex AI 模式的 Gemini
|
||||
|
||||
`@google/genai` 支持 `vertexai: true` 模式(用 GCP 凭据走 Vertex 端点而非 generative ai endpoint)。两种模式都走 fetch,所以 instrumentation 都覆盖。`httpOptions.headers` 在两种模式下都有效。
|
||||
|
||||
### 8.4 Anthropic SDK 已有 `defaultHeaders` 逻辑
|
||||
|
||||
`anthropicContentGenerator.ts:177` 已经在调 `buildHeaders()` 然后传给 `new Anthropic({ defaultHeaders })`。但 staleness 同样适用——本设计改用 `fetch` wrapper 路径(与 OpenAI 一致)。
|
||||
|
||||
### 8.5 SDK 与 fetch 之间的 trailer header
|
||||
|
||||
`openai` SDK 在 streaming 时可能用 `Transfer-Encoding: chunked` 和 trailer headers。这些都不影响 request-time 的 `traceparent` / `X-Qwen-Code-Session-Id` 注入——它们都是请求头,发出时一次性写入。
|
||||
|
||||
### 8.6 ⚠️ Known limitation: Gemini 的 session id 在 `/clear` 后 stale
|
||||
|
||||
由于 `@google/genai` SDK 不支持 `fetch` hook(`HttpOptions` 接口只有 `baseUrl`/`apiVersion`/`headers`/`timeout`/`extraParams`),Gemini provider 走 static `httpOptions.headers` 路径——session id 在 SDK 构造时 capture,**`/clear` 触发 session reset 后不刷新**。
|
||||
|
||||
**实际影响范围**:
|
||||
|
||||
- 用户启动 qwen-code → `/clear` → 用 Gemini 模型 → wire 上的 `X-Qwen-Code-Session-Id` 是旧 session id
|
||||
- 后端 correlation 错位(trace id 和 log 已正确切换到新 session,但 wire header 滞后)
|
||||
|
||||
**为什么不修**(本期):
|
||||
|
||||
- OpenAI / Anthropic 路径**没有这个 bug**(fetch wrapper 路径 per-request 读 session id)
|
||||
- Gemini fix path 有几个选项,全部超出本期 scope(见下)
|
||||
|
||||
**Future fix path 选项**(按推荐顺序):
|
||||
|
||||
| 选项 | 描述 | 代价 |
|
||||
| --------------------------------------------- | ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
|
||||
| **A. Lazy invalidate** ★ 推荐 | session reset 时只 mark contentGenerator dirty,下次 LLM 调用时 lazy recreate | 小:~10 行加在 `resetSession` + LLM 调用入口;同步 API,无侵入 |
|
||||
| B. Eager recreate | session reset 时立即 `await createContentGenerator(...)`,需 async 化 `resetSession` | 中:API 改动级联多处 |
|
||||
| C. Proxy headers object | 给 `httpOptions.headers` 包 Proxy 拦截 getter | 风险高:`@google/genai` 内部是否 per-request 重读 headers 不可知,行为可能 silently break |
|
||||
| D. 推动 `@google/genai` 上游加 `fetch` option | 提 PR 给 google-deepmind/generative-ai-js | 长期;不可控 |
|
||||
|
||||
**文档要在用户面前说明**:使用 Gemini provider 时如果 `/clear` 后立刻有 LLM 调用,wire 上的 session id 在那一刻是旧的。可以靠 trace correlation 间接修正(spans/logs 上 session.id 已经是新的)。
|
||||
|
||||
应单开 follow-up sub-issue 跟踪选项 A。
|
||||
|
||||
## 9. 与 claude-code 对比
|
||||
|
||||
| 维度 | claude-code | qwen-code 本设计 | 决策依据 |
|
||||
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Session id header 命名 | `X-Claude-Code-Session-Id`(产品前缀) | `X-Qwen-Code-Session-Id`(产品前缀) | ✅ 同样命名空间策略 |
|
||||
| Session id 注入机制 | SDK `defaultHeaders`(`client.ts:108`)+ 自定义 `buildFetch()` wrapper(`client.ts:370-390`,per-request `randomUUID()` 注入 `x-client-request-id`) | OpenAI/Anthropic 走 fetch wrapper(per-request 读 session id,避免 `/clear` staleness);Gemini 走 static `httpOptions.headers`(SDK 限制) | 与 claude-code 的 fetch wrapper 模式对齐。claude-code 也用 fetch wrapper 才能 per-request 加 `x-client-request-id` |
|
||||
| Session id 持久性 | claude-code 没有 `/clear`-式 session reset;session = process | 有 `/clear` reset → fetch wrapper 路径自动跟随;static headers 路径会 stale(§8.6) | qwen-code 独有的复杂度 |
|
||||
| Session id 编码 | HTTP header(不是 baggage) | HTTP header | ✅ 同——backend 友好 |
|
||||
| `traceparent` 注入 | 闭源;公开 docs 描述存在;开源 repo 无 `propagation.inject` / `UndiciInstrumentation` 引用 | `@opentelemetry/instrumentation-undici` 自动 | claude-code 怎么实现的不可见。我们选 OTel 官方推荐路径,更轻 |
|
||||
| `traceparent` 发送范围 | 仅第一方 Anthropic API;不发 Bedrock/Vertex/Foundry | 发给所有出站 fetch (W3C 标准;trace id 是 `sha256(sessionId)` 哈希)。**R3 修订**:session id header 仅向 first-party (Alibaba/DashScope) 白名单注入,第三方默认不发。详见 §11 | R3 后 qwen-code 的 session header 与 claude-code 同样的 first-party-only 语义;`traceparent` 仍待 per-destination toggle follow-up |
|
||||
| `x-client-request-id` (随机) | 有,自动 | 暂不做(独立 follow-up sub-issue 价值更高) | 范围控制 |
|
||||
| 子进程 `TRACEPARENT` env | 文档承认存在(实现闭源) | 不做(独立 follow-up) | 范围控制 |
|
||||
| 入站 `TRACEPARENT` 读取 | 文档承认存在(`-p` / Agent SDK 模式) | 不做(独立 follow-up) | 范围控制 |
|
||||
|
||||
**verified vs documented 注解**:
|
||||
|
||||
| claim | 验证状态 |
|
||||
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `X-Claude-Code-Session-Id` via `defaultHeaders` | ✅ Open source `src/services/api/client.ts:108` 已读 |
|
||||
| `x-client-request-id` via fetch wrapper | ✅ Open source `src/services/api/client.ts:370-390` 已读 |
|
||||
| `traceparent` 注入 | ⚠️ 仅 docs.claude.com/docs/en/monitoring-usage.md 提到;开源 repo `grep -rn "propagation\.inject\|UndiciInstrumentation\|traceparent" src` 返回空 |
|
||||
|
||||
## 10. 未来工作
|
||||
|
||||
挂在 #3731 P3 下,本设计**不**包含但与之相关:
|
||||
|
||||
- **`X-Qwen-Code-Request-Id`** 随机 UUID per request(claude-code 等价:`x-client-request-id`)。对超时/timeout error correlation 有用——超时时服务端可能还没 assign request id,客户端先发的 id 是唯一关联手段。R3 修订后这个建议变得更有意义:per-request UUID 没有"跨请求行为画像"风险,可以作为"对所有 LLM provider 发送的支持/调试 header"。
|
||||
- **`traceparent` 的 per-destination scope toggle** — R3 修订仅处理了 session id header 的作用域;`traceparent` 仍向所有出站 fetch 注入。可以加 `telemetry.propagateTraceContext: 'trusted-hosts' | 'all' | 'none'`,使用与 §11 同一份 allowlist 决定行为。
|
||||
- **Gemini 的 session id staleness lazy-invalidate fix**(§8.6 选项 A):`/clear` 时 mark contentGenerator dirty,下次 LLM 调用 lazy recreate。让 Gemini 路径也享受 fetch wrapper 的实时性。
|
||||
- **子进程 `TRACEPARENT` env**:给 `BashTool` 执行子进程时注入 env,让外部工具能续传 trace。需要单独看 tool execution lifecycle。
|
||||
- **入站 `TRACEPARENT`**:`--prompt` 模式启动时读 env,让 CI / 外部 orchestrator 能把 qwen-code 接到更大的 trace。
|
||||
- **可配置 `correlationHeader` name**:让企业 ops 自定义 header(默认 `X-Qwen-Code-Session-Id`)。
|
||||
- **`baggage` propagation 策略**:是否主动 set baggage 让 `user.id` / `tenant.id` 等也走 baggage 传到下游。本期不做,等需求明确。
|
||||
|
||||
## 11. R3 修订 — Host-Allowlist Scoping for `X-Qwen-Code-Session-Id`
|
||||
|
||||
> 触发:[LaZzyMan 在 PR #4390 的 REQUEST_CHANGES review](https://github.com/QwenLM/qwen-code/pull/4390)
|
||||
> 落地 commit:`1c8528a56` (核心实现) + `cb162e716` (Vertex baseUrl fail-closed + `["*"]` trim 容错)
|
||||
|
||||
### 11.1 触发与论证
|
||||
|
||||
R1 设计把 `X-Qwen-Code-Session-Id` 向**所有**出站 LLM 请求注入,仅由 `telemetry.enabled` 控制。LaZzyMan review 指出了三个递进的问题:
|
||||
|
||||
1. **标签错位**:`feat(telemetry):` + `telemetry/` 路径 + `getTelemetryEnabled()` gate 让用户合理理解为"自家可观测性数据流向自家 collector"。但 `X-Qwen-Code-Session-Id` 不会到达 OTLP 后端,它走在 LLM API 请求里发给 DashScope / OpenAI / Anthropic / Gemini / OpenRouter / MiniMax / ModelScope / Mistral。两种不同的数据出口决策绑在一个开关上。
|
||||
|
||||
2. **claude-code 类比不成立**:R1 在 §9 把命名空间策略和 fetch wrapper 模式都"对齐"了 claude-code。但 claude-code 是 Anthropic 一方 → Anthropic 一方(single vendor, single direction),qwen-code 是开源 CLI → 多个第三方 provider。"一个稳定 cross-request UUID 广播到所有第三方"是 R1 没正面回答的问题。
|
||||
|
||||
3. **traceparent 是同一指纹的另一通道**:trace id = `sha256(sessionId).slice(0, 32)`,对接收方来说仍是稳定 per-session 标识符(哈希后不可逆,但同一 session 仍稳定)。
|
||||
|
||||
LaZzyMan 标定 severity:session id `high` / traceparent `medium`。
|
||||
|
||||
### 11.2 解法概要
|
||||
|
||||
**收窄默认作用域到 first-party hosts**。新增一项 setting:
|
||||
|
||||
```jsonc
|
||||
"telemetry": {
|
||||
"sessionIdHeaderHosts": ["*"] // 恢复 R1 广播行为
|
||||
"sessionIdHeaderHosts": [] // 全关 header
|
||||
"sessionIdHeaderHosts": ["api.mycompany.com",
|
||||
"*.gateway.mycompany.internal"]
|
||||
}
|
||||
```
|
||||
|
||||
默认值(来自 `packages/core/src/telemetry/trusted-llm-hosts.ts:DEFAULT_SESSION_ID_HEADER_HOSTS`):
|
||||
|
||||
```
|
||||
dashscope.aliyuncs.com
|
||||
dashscope-intl.aliyuncs.com
|
||||
*.dashscope.aliyuncs.com
|
||||
*.dashscope-intl.aliyuncs.com
|
||||
*.alibaba-inc.com
|
||||
*.aliyun-inc.com
|
||||
```
|
||||
|
||||
这个集合的语义是"LLM provider、ARMS Tracing 后端、qwen-code distribution 同一法律实体"——也就是 claude-code 那个 single-vendor / single-direction 关系在 qwen-code 的对应集合。第三方 provider(OpenAI / Anthropic / OpenRouter / 等)默认**不**接收 header。
|
||||
|
||||
### 11.3 Pattern 语法(intentionally tiny)
|
||||
|
||||
`matchesTrustedHost(hostname, patterns)` 只支持两种模式,与 `DashScopeOpenAICompatibleProvider.isDashScopeProvider` 对齐:
|
||||
|
||||
- bare hostname → 精确匹配(case-insensitive)
|
||||
- `*.suffix` → 匹配 `suffix` 自身 **AND** 任何子域;dot-anchored 拒绝 `evil-alibaba-inc.com` / `alibaba-inc.com.attacker.tld` 等 typo-suffix 攻击向量
|
||||
|
||||
不引入 regex、不引入端口/scheme 感知 globbing —— 让 settings 里的字符串就是它字面看起来的语义。
|
||||
|
||||
### 11.4 实现差异 vs R1
|
||||
|
||||
#### `wrapFetchWithCorrelation` (OpenAI / Anthropic)
|
||||
|
||||
R1 的 wrapper 只有 telemetry-enabled + sessionId 两个 gate。R3 在两者之间插入第三个 gate:
|
||||
|
||||
```ts
|
||||
const trustedHosts =
|
||||
config.getTelemetrySessionIdHeaderHosts?.() ??
|
||||
DEFAULT_SESSION_ID_HEADER_HOSTS;
|
||||
const broadcastAll = trustedHosts.some((p) => p.trim() === '*');
|
||||
|
||||
return async function correlationFetch(input, init) {
|
||||
if (!config.getTelemetryEnabled()) return baseFetch(input, init);
|
||||
if (!broadcastAll) {
|
||||
const host = extractRequestHost(input);
|
||||
if (!host || !matchesTrustedHost(host, trustedHosts)) {
|
||||
return baseFetch(input, init); // host gate
|
||||
}
|
||||
}
|
||||
const sid = config.getSessionId();
|
||||
if (!sid) return baseFetch(input, init);
|
||||
// ... header injection
|
||||
};
|
||||
```
|
||||
|
||||
`trustedHosts` 在 wrap 时一次性 snapshot(与 session id 的"每请求实时读"不同)。中途修改 `telemetry.sessionIdHeaderHosts` 需要重建 contentGenerator 才生效。`[" * "]` 之类带空格的写法通过 `.trim()` 兜底成 broadcast,避免 settings.json 手敲笔误沉默退化。
|
||||
|
||||
#### `staticCorrelationHeaders` (Gemini)
|
||||
|
||||
签名加一个 `destinationUrl?: string` 参数:
|
||||
|
||||
```ts
|
||||
export function staticCorrelationHeaders(
|
||||
config: Config,
|
||||
destinationUrl?: string,
|
||||
): Record<string, string> {
|
||||
if (!config.getTelemetryEnabled()) return {};
|
||||
if (!destinationUrl) return {}; // fail-closed: 不知道目的地就不发
|
||||
if (!matchesTrustedHost(new URL(destinationUrl).hostname, trustedHosts)) {
|
||||
return {};
|
||||
}
|
||||
return { [SESSION_ID_HEADER]: config.getSessionId() };
|
||||
}
|
||||
```
|
||||
|
||||
#### Gemini factory 集成
|
||||
|
||||
Gemini SDK 有两个不可见 default endpoint(`generativelanguage.googleapis.com` 与 `{region}-aiplatform.googleapis.com`,由 `vertexai` 决定),factory 层无法准确还原其中之一。R3 选择"`config.baseUrl` 没设就传 `undefined`",让 helper fail-closed → 不发 header。运营商想要相关性必须显式设 `baseUrl`(也是 SDK 自己用来解 destination 的同一输入)。这一改动避免了猜错 Vertex destination 后被允许列表错误命中。
|
||||
|
||||
### 11.5 新文件 / 新代码
|
||||
|
||||
| 文件 | 说明 |
|
||||
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `packages/core/src/telemetry/trusted-llm-hosts.ts` (NEW) | `DEFAULT_SESSION_ID_HEADER_HOSTS` + `matchesTrustedHost` + `extractRequestHost` |
|
||||
| `packages/core/src/telemetry/trusted-llm-hosts.test.ts` (NEW) | 单测,含 TLD-suffix 攻击向量、IPv6 fail-closed、port/userinfo/query 提取 |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.ts` | 加 host gate;`staticCorrelationHeaders` 加 `destinationUrl` 参数 |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.test.ts` | 加 host-gate 8 个 case;`mockConfig` 用 `'hosts' in opts` 区分 "default allowlist" vs "broadcast" |
|
||||
| `packages/core/src/telemetry/config.ts` (`resolveTelemetrySettings`) | 透传 `sessionIdHeaderHosts` |
|
||||
| `packages/core/src/config/config.ts` | `TelemetrySettings.sessionIdHeaderHosts` + `getTelemetrySessionIdHeaderHosts()` getter |
|
||||
| `packages/core/src/core/geminiContentGenerator/index.ts` | 传 `config.baseUrl` 给 helper;fail-closed when undefined |
|
||||
| `packages/core/src/core/geminiContentGenerator/index.test.ts` | 重写 telemetry-on Gemini 测试以匹配新 fail-closed 语义 |
|
||||
| `packages/cli/src/config/settingsSchema.ts` | `sessionIdHeaderHosts` JSON schema 入口 |
|
||||
| `packages/vscode-ide-companion/schemas/settings.schema.json` | 由 `npm run generate:settings-schema` 重新生成 |
|
||||
| `docs/developers/development/telemetry.md` | "Session correlation header" 段落改写 + 默认 scope + override 语法 |
|
||||
|
||||
### 11.6 对各 LazzyMan 论点的回应
|
||||
|
||||
| LazzyMan 论点 | R3 回应 |
|
||||
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ① telemetry 标签错位 | **化解**:在 DashScope 用例下,session id header 字面就是发给 ARMS Tracing 后端(同一法律实体),`telemetry.enabled` 语义对齐 |
|
||||
| ② cross-vendor stable identifier 广播 | **化解**:默认 allowlist 只含阿里系 first-party host;广播退化为 opt-in (`["*"]`) |
|
||||
| ③ traceparent 是同一指纹的另一通道 | **暂保留**:traceparent 仍按 R1 全注入。理由:W3C 标准、trace id 是 sha256 哈希、in-vendor trace 续接是 W3C 的核心设计场景。per-destination traceparent toggle 列入 §10 future work |
|
||||
|
||||
### 11.7 已知遗留 + 跟进
|
||||
|
||||
- **traceparent scope** — 见上文第 ③ 点,列入 §10
|
||||
- **Per-request random UUID** (`X-Qwen-Code-Request-Id`) — LazzyMan 提的替代方案,列入 §10
|
||||
- **Gemini staleness lazy-invalidate** (§8.6 选项 A) — 与 R3 解耦,独立 sub-issue
|
||||
- **`matchesTrustedHost` IPv6 支持** — 当前 IPv6 destination 永不在 allowlist 上(`URL.hostname` 返回 `[::1]` 带方括号,pattern 语法无对应形式)。当前满足"命名 first-party endpoint"用例。若将来有 raw IP allowlist 需求再扩展。
|
||||
|
||||
## 12. R4 修订 — Scope Conflation Split
|
||||
|
||||
> 触发:[LaZzyMan round-8 follow-up review on PR #4390](https://github.com/QwenLM/qwen-code/pull/4390)
|
||||
> 落地:本 PR 收窄;R3 落地的 session-id 整套挪到独立 follow-up PR
|
||||
|
||||
### 12.1 触发与论证
|
||||
|
||||
R3 化解了 LaZzyMan 第一轮 review 的「广播稳定指纹给第三方 provider」担忧(severity: high)。但在 round-8 follow-up 中他升级到更深的架构原则反对:
|
||||
|
||||
> "Telemetry is not a container for adjacent features. The `traceparent` cross-process propagation and the `X-Qwen-Code-Session-Id` header injection are **not telemetry**. They are outbound-identity / outbound-correlation work that uses some OTel APIs internally as an implementation detail."
|
||||
|
||||
他的核心元论点:
|
||||
|
||||
- **"telemetry" namespace 暗示 recipient = 用户自己的 OTLP collector**
|
||||
- 但 `traceparent` 和 `X-Qwen-Code-Session-Id` 的 recipient = **第三方 LLM provider**
|
||||
- 两类不同 recipient 应该有两类不同的同意决策树
|
||||
- 即使默认行为安全(R3 已实现),把 wire-level 行为放在 `telemetry.*` 下**设了坏先例**:未来 telemetry PR 可以继续偷渡 wire 行为给第三方
|
||||
- "If we accept that principle, the split is mechanical. If we don't, this PR is the wrong place to debate it because the technical fixes are already in."
|
||||
|
||||
### 12.2 解法概要("方案 C" hybrid split)
|
||||
|
||||
经过几轮内部讨论(含 yiliang 提出的 customHeader 模板替代方案,最终判定 customHeader 不能携带 runtime-dynamic 值),决定走 **方案 C**:
|
||||
|
||||
**本 PR 留下**:
|
||||
|
||||
- `UndiciInstrumentation` 注册(产 client HTTP span → 用户自家 OTLP collector)
|
||||
- OTLP feedback-loop guard(前者的必要副作用)
|
||||
- **`NoopTextMapPropagator` 默认安装** → `propagation.inject()` 是 no-op → outbound `fetch` 上**不再有 `traceparent`**
|
||||
- **新增 `outboundCorrelation.propagateTraceContext: bool` (默认 false)** 作为独立 namespace 顶级设置;设 true 时安装默认 W3C composite propagator
|
||||
- 整套 `R3 session-id` 代码(`llm-correlation-fetch.ts` / `trusted-llm-hosts.ts` / `telemetry.sessionIdHeaderHosts` setting / 4 个 provider 集成点 / 所有相关测试)**全部移除**
|
||||
|
||||
**搬到 follow-up PR**:
|
||||
|
||||
- `X-Qwen-Code-Session-Id` header 整套机器(R3 实现复用)
|
||||
- 进入新 `outboundCorrelation.*` namespace(具体 setting key TBD,但**不会**叫 `telemetry.*`)
|
||||
- Follow-up PR 自带:threat model section、独立 review、security-relevant 标注的 docs
|
||||
- `X-Qwen-Code-Request-Id` per-request UUID(LazzyMan 在 R3 round 提出的替代设计)也归入此 follow-up 的考虑范围
|
||||
|
||||
### 12.3 与 R3 R1 论点的映射
|
||||
|
||||
| R1/R3 论点 | R4 后状态 |
|
||||
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| §3.1 "所有出站 LLM 请求带 traceparent" | ❌ **R4 默认 off**;需 `outboundCorrelation.propagateTraceContext: true` 才开 |
|
||||
| §3.1 "所有出站 LLM 请求带 `X-Qwen-Code-Session-Id`" | ❌ **R4 整套移出本 PR**,搬到 follow-up PR |
|
||||
| §4.3 fetch wrapper 注入 session id | ❌ 整段代码不在本 PR;复用到 follow-up PR |
|
||||
| §11 host allowlist (R3 设计) | ❌ 同上;整体迁移 follow-up PR |
|
||||
| §4.4 不引入新 setting | ❌ **本 PR 新增 `outboundCorrelation.propagateTraceContext`** 一个 boolean;session id 相关 setting 在 follow-up PR |
|
||||
| §10 future work "`X-Qwen-Code-Request-Id`" | ✅ 仍是 future work;与 session-id follow-up 一起设计 |
|
||||
|
||||
### 12.4 新 namespace 设计意图
|
||||
|
||||
`outboundCorrelation.*` 顶级 namespace 在本 PR 只有一个 boolean (`propagateTraceContext`),看起来过度结构化。但这是**精心选择的**:
|
||||
|
||||
- **建立命名空间作为承诺**:让后续 session-id / request-id / etc. 自然进入这个 namespace
|
||||
- **标注为 security-relevant**:`settingsSchema.ts` description 显式写 "SECURITY-RELEVANT",文档化为"安全设置"而非"observability 设置"
|
||||
- **defaults 全部 off**:符合 LazzyMan 提出的"open-source 客户端不应未经显式同意向第三方发稳定 id"原则
|
||||
- **与 telemetry.\* 解耦**:用户读 settings.json 看到 `outboundCorrelation.*` 立刻能识别这是出站 wire 行为,不是 observability
|
||||
|
||||
#### 隐性依赖:`telemetry.enabled`
|
||||
|
||||
虽然 namespace 与 `telemetry.*` 解耦,**运行时生效仍依赖 `telemetry.enabled: true`** —— OTel SDK 只在 telemetry 启用时初始化,没有 SDK 就没有 propagator 安装、没有 `propagation.inject()` 调用,flag 等于沉默 no-op。容易踩的 footgun:运营商加 `propagateTraceContext: true` 却忘开 telemetry,trap server 上看不到任何 `traceparent`,无 error / 无 warning。
|
||||
|
||||
两个面向用户的面板都显式标注此依赖:
|
||||
|
||||
- `telemetry.md` 的 `propagateTraceContext` 段附完整双 flag JSON 示例
|
||||
- `settingsSchema.ts` 的 description string **首句**即 "Requires `telemetry.enabled: true`"(前置以避免 VS Code 设置 UI 长描述折叠后看不到)
|
||||
|
||||
未来若添加 session-id header 或其他 `outboundCorrelation.*` setting,**同一依赖关系适用** —— 都得在 telemetry 启用前提下才有意义(因为它们都通过 OTel instrumentation/SDK 注入)。Follow-up PR 应继承此 footgun 提示模式。
|
||||
|
||||
### 12.5 实施
|
||||
|
||||
| 文件 | 改动 |
|
||||
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.ts` | **删除** |
|
||||
| `packages/core/src/telemetry/llm-correlation-fetch.test.ts` | **删除** |
|
||||
| `packages/core/src/telemetry/trusted-llm-hosts.ts` | **删除** |
|
||||
| `packages/core/src/telemetry/trusted-llm-hosts.test.ts` | **删除** |
|
||||
| `packages/core/src/telemetry/sdk.ts` | + `NoopTextMapPropagator`;按 `getOutboundCorrelationPropagateTraceContext()` 决定 SDK textMapPropagator |
|
||||
| `packages/core/src/core/openaiContentGenerator/provider/default.ts` | 移除 `wrapFetchWithCorrelation` 引用 |
|
||||
| `packages/core/src/core/openaiContentGenerator/provider/dashscope.ts` | 同上 |
|
||||
| `packages/core/src/core/anthropicContentGenerator/anthropicContentGenerator.ts` | 同上 |
|
||||
| `packages/core/src/core/geminiContentGenerator/index.ts` | 移除 `staticCorrelationHeaders` 引用 |
|
||||
| 上述 4 个 provider 的 `*.test.ts` | 删 session-id 相关测试 case |
|
||||
| `packages/core/src/config/config.ts` | 删 `TelemetrySettings.sessionIdHeaderHosts`、`getTelemetrySessionIdHeaderHosts`;**新增 `OutboundCorrelationSettings` 接口 + `outboundCorrelationSettings` 字段 + `getOutboundCorrelationPropagateTraceContext()` getter** |
|
||||
| `packages/core/src/telemetry/config.ts` | 删 `resolveTelemetrySettings` 中 sessionIdHeaderHosts 透传 |
|
||||
| `packages/cli/src/config/settingsSchema.ts` | 删 `sessionIdHeaderHosts` schema;**新增 `outboundCorrelation` 顶级 schema 项** |
|
||||
| `packages/cli/src/config/config.ts` | 透传 `outboundCorrelation: settings.outboundCorrelation` 进 `ConfigParameters` |
|
||||
| `packages/vscode-ide-companion/schemas/settings.schema.json` | `npm run generate:settings-schema` 重新生成(description 后续更新时同步刷新) |
|
||||
| `docs/developers/development/telemetry.md` | 重写 "Trace context propagation" → "Client-side HTTP span on outbound fetch";删 "Session correlation header" 整节;新增 "Outbound correlation (SECURITY-RELEVANT)" 顶级 section;附 `telemetry.enabled` 依赖说明 + JSON 配置示例 |
|
||||
| `docs/design/telemetry-outbound-propagation-design.md` | 本节 + R4 表头 + 修订指针 |
|
||||
| `packages/core/src/config/config.test.ts` | **新增 `OutboundCorrelation Configuration` describe block**,`it.each` 4 个 case 锁定 `getOutboundCorrelationPropagateTraceContext` 的 default-false 安全不变性(omitted / `{}` / explicit true / explicit false) |
|
||||
|
||||
### 12.6 对 LazzyMan 元论点的回应
|
||||
|
||||
| 论点 | R4 后状态 |
|
||||
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| "Telemetry namespace 暗示自家 collector 接收方" | ✅ wire 行为已搬出 `telemetry.*`;新 `outboundCorrelation.*` namespace 显式标识"出站第三方"语义 |
|
||||
| "默认行为不应未经显式同意向第三方发标识符" | ✅ `propagateTraceContext` 默认 false;session-id 整套 follow-up PR 也将默认 off |
|
||||
| "telemetry PR 不应偷渡 wire-level 行为" | ✅ 本 PR 不再添加任何"telemetry 控制 wire 行为"的代码路径;wire 行为统一由 `outboundCorrelation.*` 管 |
|
||||
| "split is mechanical, work isn't wasted" | ✅ R3 落地代码物理删除自本 branch,留在 git history 里给 follow-up PR 复用(或 cherry-pick) |
|
||||
|
||||
### 12.7 follow-up PR 大纲(信息性,不在本 PR 范围)
|
||||
|
||||
未来 follow-up PR 应包含:
|
||||
|
||||
- `outboundCorrelation.sessionIdHeader: { enabled, trustedHosts }` 或类似 setting
|
||||
- 复用 R3 已实现的 `wrapFetchWithCorrelation` / `matchesTrustedHost` / `DEFAULT_SESSION_ID_HEADER_HOSTS` 代码骨架
|
||||
- threat model 一节,明确:recipient 集合、稳定 id 的去匿名化窗口、可选 per-request UUID 配套
|
||||
- **默认 off**(无 default allowlist —— 比 R3 更严,符合 LazzyMan 的开源 CLI 原则)
|
||||
- security-relevant 标注 + docs/users/configuration/settings.md 收录
|
||||
@ -18,8 +18,9 @@ qwen-code 目前仅有面向 Arena 多模型对比场景的内部 worktree 实
|
||||
| Post-creation setup(hooks 配置) | ❌ | ✅ | Phase C |
|
||||
| StatusLine worktree 状态展示 | ❌ | ✅ | Phase C |
|
||||
| WorktreeExitDialog(退出提示) | ❌ | ✅ | Phase C |
|
||||
| `--worktree` CLI 启动标志 | ❌ | ✅ | Phase D |
|
||||
| 符号链接目录(node_modules 等) | ❌ | ✅ | Phase D |
|
||||
| `--worktree` CLI 启动标志 | ✅(Phase D) | ✅ | — |
|
||||
| 符号链接目录(node_modules 等) | ✅(Phase D) | ✅ | — |
|
||||
| PR 引用(`--worktree=#123`) | ✅(Phase D) | ✅ | — |
|
||||
| sparse checkout | ❌ | ✅ | Future |
|
||||
| tmux 集成 | ❌ | ✅ | Future |
|
||||
| Arena 多模型 worktree 隔离 | ✅(qwen 独有) | ❌ | — |
|
||||
@ -56,12 +57,13 @@ Arena 的 worktree 路径由 `agents.arena.worktreeBaseDir` 控制,默认 `~/.
|
||||
|
||||
### 扩展配置
|
||||
|
||||
| 配置项 | 类型 | 用途 | 阶段 |
|
||||
| ----------------------------- | ---------- | -------------------------------------------------------------- | ------- |
|
||||
| `worktree.symlinkDirectories` | `string[]` | 符号链接指定目录(如 `node_modules`)到 worktree,避免磁盘浪费 | Phase D |
|
||||
| `worktree.sparsePaths` | `string[]` | git sparse-checkout cone 模式,大型 monorepo 只写入指定路径 | Future |
|
||||
| 配置项 | 类型 | 用途 | 阶段 |
|
||||
| --------------------------------- | ---------- | ---------------------------------------------------------------- | ------- |
|
||||
| `ui.hideBuiltinWorktreeIndicator` | `boolean` | 隐藏 Footer 中内置 `⎇ worktree-… (…)` 行,留给 custom statusline | Phase C |
|
||||
| `worktree.symlinkDirectories` | `string[]` | 符号链接指定目录(如 `node_modules`)到 worktree,避免磁盘浪费 | Phase D |
|
||||
| `worktree.sparsePaths` | `string[]` | git sparse-checkout cone 模式,大型 monorepo 只写入指定路径 | Future |
|
||||
|
||||
Phase A / B / C 不新增任何配置项。
|
||||
Phase A / B 不新增任何配置项。
|
||||
|
||||
## 工具设计
|
||||
|
||||
@ -233,32 +235,154 @@ _WorktreeExitDialog:_
|
||||
|
||||
---
|
||||
|
||||
### Phase D:启动时配置(`--worktree` CLI 标志 + 目录符号链接)
|
||||
### Phase D:启动时配置(`--worktree` CLI 标志 + 目录符号链接 + PR 引用)
|
||||
|
||||
**目标:** 支持在启动时直接进入 worktree,并通过目录符号链接减少大型项目的磁盘开销。
|
||||
**目标:** 支持在启动时直接进入 worktree、通过目录符号链接减少大型项目的磁盘开销,以及通过 PR 引用快速基于一个 pull request 创建 worktree。
|
||||
|
||||
**要实现的功能:**
|
||||
**范围:** 三个功能在一个阶段一起落地,因为它们都挂在同一个启动入口上,且 symlink / PR fetch 两者都需要在 worktree 创建之后立即执行 — 单独拆分会重复改 bootstrap 序列。
|
||||
|
||||
_`--worktree [name]` CLI 启动标志:_
|
||||
#### D-1:`--worktree [name]` CLI 启动标志
|
||||
|
||||
- `packages/cli/src/args.ts` 新增 `--worktree [name]` 参数
|
||||
- 启动流程在进入主循环前调用 `createUserWorktree()`,将 `targetDir` 设为 worktree 路径,并写入 SessionService 状态
|
||||
- 整个会话从启动即在 worktree 环境中运行,退出时触发 WorktreeExitDialog
|
||||
**参数形态:** yargs 选项接受三种形式:
|
||||
|
||||
_`worktree.symlinkDirectories` 配置项:_
|
||||
| 形式 | 行为 |
|
||||
| ------------------------- | ---------------------------------------------------- |
|
||||
| `qwen --worktree` | bare flag,自动生成 slug(`{形容词}-{名词}-{6hex}`) |
|
||||
| `qwen --worktree my-name` | 显式 slug,沿用 `EnterWorktreeTool` 的 slug 校验规则 |
|
||||
| `qwen --worktree=my-name` | 等价于上一种 |
|
||||
|
||||
- settings schema 新增 `worktree.symlinkDirectories: string[]`
|
||||
- `createUserWorktree()` 后遍历配置,调用 `fs.symlink()` 将主仓库目录链接进 worktree
|
||||
- 跳过目标不存在的项;目标已存在时跳过(不覆盖)
|
||||
不提供短别名 `-w`(qwen-code 短别名只保留给最高频参数,避免命名冲突)。
|
||||
|
||||
**影响文件:**
|
||||
**启动序列:** worktree 在以下位置创建:
|
||||
|
||||
| 文件 | 变更类型 |
|
||||
| -------------------------------------------------- | ------------------------------------------- |
|
||||
| `packages/cli/src/args.ts` | 新增 `--worktree [name]` 参数 |
|
||||
| `packages/cli/src/main.ts`(或启动入口) | 解析 `--worktree` 并在主循环前创建 worktree |
|
||||
| `packages/core/src/services/gitWorktreeService.ts` | `createUserWorktree()` 后追加 symlink 逻辑 |
|
||||
| `packages/core/src/config/`(settings schema) | 新增 `worktree.symlinkDirectories` 字段 |
|
||||
1. `parseArguments()` 解析 argv(已有)
|
||||
2. resume picker(已有,line 588-629 of `gemini.tsx`)
|
||||
3. `loadCliConfig()` 初始化 Config + auth(已有,line 643-653)
|
||||
4. **新增:** 若 `argv.worktree !== undefined`,调用 `createUserWorktree()`
|
||||
- 写入 sidecar(`writeWorktreeSession()`)
|
||||
- 设置 `process.chdir(worktreePath)` 同时 `Config.setTargetDir(worktreePath)`
|
||||
- 同一 worktree 的 re-attach 路径:跳过 `git worktree add` 并就地 chdir(Phase 6 修复)。跨 projectHash 的 `--resume` × `--worktree` 组合在 session lookup 阶段会失败,详见下文"与 `--resume` 的优先级"。
|
||||
5. 主循环(TUI / headless `-p` / ACP 三种入口都要走第 4 步)
|
||||
|
||||
**与 Phase A 简化的差异:** Phase A 的 `EnterWorktreeTool` **不**修改 `Config.targetDir`,依赖模型从工具结果里读到绝对路径并继续使用。Phase D 的 CLI flag 在启动期就生效,没有运行中的模型上下文需要兼容,所以**直接切换 `targetDir` 和 `process.cwd()`** —— 这是更强的隔离保证。两条路径行为不同,需要在用户文档里说明。
|
||||
|
||||
**退出行为:** 复用现有 `WorktreeExitDialog`(Phase C 已实现)。Ctrl+C/D 两次触发 → 用户在 keep / remove / cancel 之间选择。不需要新代码路径。
|
||||
|
||||
**与 `--resume` 的优先级:**
|
||||
|
||||
由于 session 存储以 `projectHash(process.cwd())` 为 key,而 `--worktree` 在 resume picker / `loadCliConfig` 之前就 chdir 到 worktree,所以"在 worktree X 启动的 session,从 worktree Y 内 resume"是**架构上不可达**的(两者的 projectHash 不同,session 文件落在不同目录)。下表反映 D-1 实现 + Phase 6 re-attach 修复后的实际行为:
|
||||
|
||||
| `--resume` 状态 | `--worktree` 状态 | 结果 |
|
||||
| ---------------------------- | -------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| 无 | 无 | 普通会话,无 worktree |
|
||||
| 无 | 有(新 slug) | 新建 worktree |
|
||||
| 无 | 有(已存在的 slug) | **re-attach** 到已有 worktree(Phase 6 修复) |
|
||||
| 有 | 无 | 恢复旧 worktree(Phase C 行为,sidecar 命中则注入 reminder) |
|
||||
| 有(sid 出自同一 worktree) | 有(同一 slug,re-attach) | re-attach + session 命中:正常 resume |
|
||||
| 有(sid 出自 main checkout) | 有(任意 slug) | **session lookup 失败**:`No saved session found with ID …`,exit 1。documented limitation |
|
||||
| 有(sid 出自 worktree X) | 有(slug Y, X != Y) | 同上,session 跨 projectHash 不可寻 |
|
||||
|
||||
跨 projectHash override 的语义(`--worktree` 在不同 worktree / 主 checkout 的 session 之间转移)需要 storage 锚定到 repo root 而非 cwd-derived projectHash,属于未来 Config 重构范畴。`persistStartupWorktreeSidecar` 内的 `overrodeResumedWorktree` 分支代码保留是为该重构落地后能自动生效,目前在生产路径不会触发。
|
||||
|
||||
#### D-2:`worktree.symlinkDirectories` 配置项
|
||||
|
||||
**schema:**
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"worktree": {
|
||||
"symlinkDirectories": ["node_modules", "dist", ".turbo"],
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
- 类型:`string[]`,默认 `undefined`(不开启,opt-in)
|
||||
- 顶层 namespace `worktree` 是新增的(在 `settingsSchema.ts` 中按字母序插在 `tools` 与 `ui` 之间)
|
||||
- 路径**相对于主仓库根**,绝对路径或包含 `..` 的路径被路径遍历守卫拒绝
|
||||
|
||||
**作用范围:** 所有由通用层创建的 worktree,包括:
|
||||
|
||||
- `EnterWorktreeTool`(Phase A)
|
||||
- `AgentTool` `isolation: 'worktree'`(Phase B)
|
||||
- `--worktree` CLI flag(Phase D-1)
|
||||
|
||||
Arena 的 worktree 不走通用层,**不**受此配置影响。
|
||||
|
||||
**实现位置:** `GitWorktreeService.performPostCreationSetup()` —— 紧跟现有的 `configureHooksPath()`(Phase C 已建立的模式)。新增 `symlinkConfiguredDirectories()` 方法,遍历配置项调用 `fs.symlink(absSource, absDest, 'dir')`。
|
||||
|
||||
**错误处理(fail-open):**
|
||||
|
||||
| 场景 | 行为 |
|
||||
| ----------------------------- | ------------------------------ |
|
||||
| 源目录不存在(ENOENT) | 静默跳过,debug log |
|
||||
| 目标路径已存在(EEXIST) | 静默跳过,debug log(不覆盖) |
|
||||
| 路径遍历(`../`、绝对路径等) | 拒绝该项,debug log warn |
|
||||
| 其他 I/O 错误 | debug log warn,继续处理后续项 |
|
||||
|
||||
worktree 创建本身**不会**因为 symlink 失败而中止 —— 与 `configureHooksPath()` 相同的"best-effort post-creation setup"原则。
|
||||
|
||||
#### D-3:PR 引用解析(`--worktree=#<N>` / 全 URL)
|
||||
|
||||
**支持形式:**
|
||||
|
||||
| 形式 | 解析后的 PR 号 |
|
||||
| --------------------------------------------------------------- | -------------- |
|
||||
| `--worktree=#123` | 123 |
|
||||
| `--worktree '#123'` | 123 |
|
||||
| `--worktree https://github.com/foo/bar/pull/123` | 123 |
|
||||
| `--worktree https://gh.enterprise.com/foo/bar/pull/123?baz=qux` | 123 |
|
||||
|
||||
**slug 与分支命名:**
|
||||
|
||||
- slug:`pr-<N>`(特殊保留前缀,与用户 slug 区分)
|
||||
- 分支:`worktree-pr-<N>`(沿用 qwen-code 现有 `worktree-<slug>` 命名规则;不采用 claude-code 的 `pr-<N>` 直接命名,避免与本地 `pr-<N>` 分支冲突)
|
||||
|
||||
**fetch 策略:**
|
||||
|
||||
```
|
||||
git fetch origin pull/<N>/head
|
||||
→ 用 FETCH_HEAD 作为新 worktree 的 base
|
||||
```
|
||||
|
||||
不依赖 `gh` CLI —— 纯 git fetch,支持任何 GitHub 实例(公网或企业版),只要 `origin` 远程指向 GitHub。
|
||||
|
||||
**错误路径:**
|
||||
|
||||
| 场景 | 错误消息 |
|
||||
| ------------------------ | ---------------------------------------------------------------------------- |
|
||||
| `origin` 远程缺失 | `--worktree=#<N> requires an "origin" remote that points at GitHub.` |
|
||||
| `git fetch` 失败 | `Failed to fetch PR #<N>: PR may not exist or origin remote is unreachable.` |
|
||||
| 网络超时(30s) | 同上,加 `(timeout)` |
|
||||
| `origin` 远程不是 GitHub | 不做主动检查,由 `git fetch` 自然失败(PR 协议是 GitHub 特有的) |
|
||||
|
||||
**与 D-2 的关系:** PR worktree **同样**应用 `symlinkDirectories`(用户期望在 PR 上立刻能跑测试,依赖目录需要复用)。
|
||||
|
||||
#### 影响文件
|
||||
|
||||
| 文件 | 变更类型 |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `packages/cli/src/config/config.ts` | yargs 新增 `--worktree` 选项;`CliArgs` 接口加 `worktree?: string \| boolean` |
|
||||
| `packages/cli/src/gemini.tsx` | `loadCliConfig()` 之后、主循环之前调用新的 `setupStartupWorktree()` helper |
|
||||
| `packages/cli/src/startup/worktreeStartup.ts` | 新建:`setupStartupWorktree()` 处理 slug 解析、PR fetch、sidecar 写入、cwd 切换 |
|
||||
| `packages/cli/src/nonInteractiveCli.ts` | 复用同一 helper(已有 `restoreWorktreeContext` 注入逻辑,无须改) |
|
||||
| `packages/cli/src/acp-integration/acpAgent.ts` | 复用同一 helper |
|
||||
| `packages/core/src/services/gitWorktreeService.ts` | 新增 `parsePRReference()`、`fetchPullRequestRef()`、`symlinkConfiguredDirectories()`;`createUserWorktree()` 接受可选 `baseBranchRef` 参数 |
|
||||
| `packages/cli/src/config/settingsSchema.ts` | 新增 `worktree.symlinkDirectories: string[]` 顶层项 |
|
||||
| `packages/vscode-ide-companion/schemas/settings.schema.json` | 重新生成 |
|
||||
| `docs/users/features/worktree.md` | 新增 Quick Start CLI flag 章节、Settings 表新增一行 |
|
||||
|
||||
#### 安全与回滚
|
||||
|
||||
- **fail-open vs fail-close:** symlink / hooks 失败 **不** 中止 worktree 创建(同 Phase C 既定模式);PR fetch 失败 **中止** 启动(无 base ref 就无法创建 worktree);slug 校验失败 **中止** 启动(与 `EnterWorktreeTool` 一致)。
|
||||
- **path traversal:** `symlinkDirectories` 项必须解析后仍在 `repoRoot` 内,否则拒绝该项并 log。
|
||||
- **PR fetch 超时:** 30 秒硬超时,避免无响应的网络拖死启动。
|
||||
- **cwd 切换的副作用:** 切 `process.cwd()` 之后,相对路径(如 `--prompt-file ./foo.txt`)的解析会受影响。**对策:** 在切 cwd 之前先解析所有相对路径参数(具体在 `setupStartupWorktree()` 入口处做一次 normalize)。
|
||||
|
||||
#### 开放问题
|
||||
|
||||
1. **`--worktree-keep-on-exit`?** claude-code 没有,qwen-code 是否需要一个 CLI flag 让 Exit Dialog 默认选 keep?建议**先不加**,等用户反馈。
|
||||
2. **`worktree.symlinkDirectories` 是否需要 per-project override?** 当前 settings 已经支持 user/workspace/project 三级合并,无需特殊处理。
|
||||
3. **PR fetch 是否要拉取 `merge` ref(`pull/<N>/merge`,即与 base 合并后的 ref)而非 `head`?** claude-code 选 `head`,理由是用户通常想看 PR 的实际改动。沿用此选择。
|
||||
|
||||
---
|
||||
|
||||
@ -266,9 +390,8 @@ _`worktree.symlinkDirectories` 配置项:_
|
||||
|
||||
以下功能面向更特定的使用场景,当前阶段不纳入排期,待用户需求明确后再评估实现。
|
||||
|
||||
| 功能 | 说明 |
|
||||
| ----------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| sparse checkout | `worktree.sparsePaths` 配置项,大型 monorepo 只 checkout 指定路径,缩短创建时间和磁盘占用 |
|
||||
| `.worktreeinclude` 文件 | 将 gitignore 的文件(`.env`、`secrets.json` 等)自动复制进 worktree |
|
||||
| tmux 集成 | `--worktree --tmux` 在新 tmux 窗口启动 worktree 会话 |
|
||||
| PR 引用解析 | `--worktree=#123` 自动 fetch PR 分支并基于它创建 worktree(依赖 Phase D `--worktree` 标志) |
|
||||
| 功能 | 说明 |
|
||||
| ----------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| sparse checkout | `worktree.sparsePaths` 配置项,大型 monorepo 只 checkout 指定路径,缩短创建时间和磁盘占用 |
|
||||
| `.worktreeinclude` 文件 | 将 gitignore 的文件(`.env`、`secrets.json` 等)自动复制进 worktree |
|
||||
| tmux 集成 | `--worktree --tmux` 在新 tmux 窗口启动 worktree 会话 |
|
||||
|
||||
@ -262,6 +262,99 @@ and logs still carry `session.id`, and trace / log backends (Jaeger, Tempo,
|
||||
Loki, Aliyun SLS / ARMS Tracing) handle per-session slicing natively without
|
||||
cardinality pressure.
|
||||
|
||||
### Client-side HTTP span on outbound fetch
|
||||
|
||||
When telemetry is enabled, Qwen Code registers `UndiciInstrumentation`
|
||||
which creates a client-side HTTP span for every outbound `fetch()`
|
||||
request originated by the process — including the LLM SDKs (`openai`,
|
||||
`@google/genai`, `@anthropic-ai/sdk`), the MCP StreamableHTTP client, the
|
||||
`WebFetch` tool, and any IDE-extension out-of-process calls. The span
|
||||
lets you see network latency (TTFB / response body transfer) separately
|
||||
from upstream model processing time, which the existing
|
||||
`api.generateContent` span alone can't distinguish.
|
||||
|
||||
These spans go to your **own** OTLP collector (or file outfile) just like
|
||||
the rest of the telemetry — they do not affect what is written onto the
|
||||
outbound HTTP request itself. Whether the W3C `traceparent` header is
|
||||
also written into the outgoing request stream is controlled by a
|
||||
**separate, security-relevant setting** documented in
|
||||
[outbound correlation](#outbound-correlation-security-relevant) below.
|
||||
|
||||
**Feedback-loop avoidance.** OTel SDK uses `fetch` internally to upload OTLP
|
||||
data. Without protection, instrumenting `fetch` would trace those uploads,
|
||||
which would themselves be uploaded, causing an infinite loop. Qwen Code's
|
||||
undici instrumentation is configured with an `ignoreRequestHook` that skips
|
||||
URLs matching the configured `telemetry.otlpEndpoint` /
|
||||
`telemetry.otlpTracesEndpoint` / `telemetry.otlpLogsEndpoint` /
|
||||
`telemetry.otlpMetricsEndpoint` prefixes. In file-outfile mode there are no
|
||||
outbound HTTP uploads, so the hook is a no-op.
|
||||
|
||||
## Outbound correlation (SECURITY-RELEVANT)
|
||||
|
||||
These settings live in a **separate top-level namespace** from `telemetry.*`
|
||||
on purpose: telemetry controls data flow into the operator's own
|
||||
observability backend, while `outboundCorrelation.*` controls what
|
||||
client-side correlation data qwen-code writes **into outbound LLM API
|
||||
request streams** that reach third-party LLM provider endpoints
|
||||
(DashScope, OpenAI, Anthropic, etc.). Different recipients, different
|
||||
consent decision. **All values default to off.** See PR #4390 review
|
||||
discussion for the framing rationale.
|
||||
|
||||
### `outboundCorrelation.propagateTraceContext`
|
||||
|
||||
```jsonc
|
||||
"outboundCorrelation": {
|
||||
"propagateTraceContext": false // default
|
||||
}
|
||||
```
|
||||
|
||||
When `false` (default), Qwen Code installs a no-op `TextMapPropagator` on
|
||||
the OTel SDK. UndiciInstrumentation still creates client HTTP spans for
|
||||
your OTLP collector, but `propagation.inject()` is a no-op so **no
|
||||
`traceparent` is written onto outbound requests**. Trace IDs stay
|
||||
internal to the operator's collector.
|
||||
|
||||
When `true`, the SDK's default W3C composite propagator
|
||||
(`tracecontext` + `baggage`) is installed and the standard `traceparent`
|
||||
header is written on every outbound `fetch`:
|
||||
|
||||
```
|
||||
traceparent: 00-<32-hex traceId>-<16-hex parentSpanId>-<01-sampled | 00-not-sampled>
|
||||
```
|
||||
|
||||
Opt in only when the LLM provider also reports into your OTel collector
|
||||
for cross-process trace stitching — e.g. ARMS Tracing serving DashScope.
|
||||
For most operators the value is `false`; cross-vendor trace continuation
|
||||
is niche.
|
||||
|
||||
**Depends on `telemetry.enabled: true`.** The OTel SDK only initializes
|
||||
when telemetry is enabled, so `propagateTraceContext` only takes effect
|
||||
in that state. Setting it to `true` while telemetry is disabled is a
|
||||
silent no-op — no SDK, no propagator, no `traceparent` on the wire.
|
||||
Verify both flags when wiring an ARMS+DashScope correlation setup:
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"telemetry": {
|
||||
"enabled": true,
|
||||
"otlpTracesEndpoint": "http://tracing-analysis-...",
|
||||
},
|
||||
"outboundCorrelation": {
|
||||
"propagateTraceContext": true,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Other outbound correlation headers
|
||||
|
||||
`X-Qwen-Code-Session-Id` and `X-Qwen-Code-Request-Id` are **not part of
|
||||
this PR**. They will be designed and proposed in their own follow-up
|
||||
PR(s) under the same `outboundCorrelation.*` namespace, each with its
|
||||
own threat model and operator-consent flow. PR #4390 review (LaZzyMan)
|
||||
established the principle: "telemetry's scope of work doesn't include
|
||||
sending identifiers to LLM providers"; correlation-header work moves to
|
||||
its own design discussion rather than landing under telemetry.
|
||||
|
||||
## Aliyun Telemetry
|
||||
|
||||
### Manual OTLP Export
|
||||
|
||||
@ -3,6 +3,7 @@ export default {
|
||||
'file-system': 'File System',
|
||||
'multi-file': 'Multi-File Read',
|
||||
shell: 'Shell',
|
||||
monitor: 'Monitor',
|
||||
'todo-write': 'Todo Write',
|
||||
task: 'Task',
|
||||
'exit-plan-mode': 'Exit Plan Mode',
|
||||
|
||||
@ -45,6 +45,7 @@ Qwen Code's built-in tools can be broadly categorized as follows:
|
||||
|
||||
- **[File System Tools](./file-system.md):** For interacting with files and directories (reading, writing, listing, searching, etc.).
|
||||
- **[Shell Tool](./shell.md) (`run_shell_command`):** For executing shell commands.
|
||||
- **[Monitor Tool](./monitor.md) (`monitor`):** For running long-lived shell commands that stream output back as background task notifications.
|
||||
- **[Web Fetch Tool](./web-fetch.md) (`web_fetch`):** For retrieving content from URLs.
|
||||
- **[Multi-File Read Tool](./multi-file.md) (`read_many_files`):** A specialized tool for reading content from multiple files or directories, often used by the `@` command.
|
||||
- **[Memory Tool](./memory.md) (`save_memory`):** For saving and recalling information across sessions.
|
||||
|
||||
154
docs/developers/tools/monitor.md
Normal file
154
docs/developers/tools/monitor.md
Normal file
@ -0,0 +1,154 @@
|
||||
# Monitor Tool (`monitor`)
|
||||
|
||||
This document describes the `monitor` tool for Qwen Code.
|
||||
|
||||
## Description
|
||||
|
||||
Use `monitor` to start a long-running shell command that streams stdout and
|
||||
stderr lines back to the agent as background task notifications. It is intended
|
||||
for watch-style commands where new output matters over time, such as tailing
|
||||
logs, watching build output, polling a health endpoint, or observing file
|
||||
changes.
|
||||
|
||||
The monitor runs in the background, so the agent can continue working while
|
||||
events arrive. Each non-empty output line becomes a notification event, subject
|
||||
to throttling.
|
||||
|
||||
### Arguments
|
||||
|
||||
`monitor` takes the following arguments:
|
||||
|
||||
- `command` (string, required): The shell command to run and monitor.
|
||||
- `description` (string, optional): A brief description of what the monitor is
|
||||
watching. The display text is truncated to 80 characters.
|
||||
- `max_events` (number, optional): Stop after this many notification events.
|
||||
Must be a positive integer. Defaults to `1000`; maximum `10000` (values
|
||||
outside this range are rejected, not silently clamped).
|
||||
- `idle_timeout_ms` (number, optional): Stop if the command produces no output
|
||||
for this many milliseconds. Must be a positive integer. Defaults to `300000`
|
||||
(5 minutes); maximum `600000` (10 minutes), and values outside this range are
|
||||
rejected.
|
||||
- `directory` (string, optional): An absolute path to run the command in. Must
|
||||
resolve (after symlink canonicalization) inside one of the registered
|
||||
workspace directories, and must not be inside the user-skills directory. If
|
||||
omitted, Qwen Code uses the project root.
|
||||
|
||||
## How to use `monitor` with Qwen Code
|
||||
|
||||
The model chooses the `monitor` tool when it needs to observe a process over
|
||||
time instead of collecting a single command result. A successful invocation
|
||||
returns a monitor ID, the command, the event limit, and the idle timeout.
|
||||
|
||||
Usage:
|
||||
|
||||
```
|
||||
monitor(command="tail -f logs/app.log", description="app log stream")
|
||||
```
|
||||
|
||||
Monitor output is visible in the conversation as task notifications. You can
|
||||
also inspect running and completed monitors with `/tasks` or the interactive
|
||||
Background tasks dialog.
|
||||
|
||||
To stop a running monitor, use the `task_stop` tool with the monitor ID:
|
||||
|
||||
```
|
||||
task_stop(task_id="mon_abc123def4567890")
|
||||
```
|
||||
|
||||
## `monitor` examples
|
||||
|
||||
Watch an application log:
|
||||
|
||||
```
|
||||
monitor(
|
||||
command="tail -f logs/app.log",
|
||||
description="application log stream",
|
||||
max_events=200
|
||||
)
|
||||
```
|
||||
|
||||
Monitor a dev server or build watcher:
|
||||
|
||||
```
|
||||
monitor(
|
||||
command="npm run build -- --watch",
|
||||
description="watch build output",
|
||||
idle_timeout_ms=600000
|
||||
)
|
||||
```
|
||||
|
||||
Poll a local health endpoint:
|
||||
|
||||
```
|
||||
monitor(
|
||||
command="while true; do curl -s http://localhost:8080/health; sleep 5; done",
|
||||
description="local health check",
|
||||
max_events=120
|
||||
)
|
||||
```
|
||||
|
||||
Run from a specific workspace directory:
|
||||
|
||||
```
|
||||
monitor(
|
||||
command="npm run dev",
|
||||
description="frontend dev server",
|
||||
directory="/absolute/path/to/workspace/packages/web"
|
||||
)
|
||||
```
|
||||
|
||||
## Monitor vs. background shell commands
|
||||
|
||||
Use `monitor` when the agent needs to react to streaming output while the
|
||||
command keeps running. Use `run_shell_command` instead when you need a one-shot
|
||||
result or the complete command output.
|
||||
|
||||
| Need | Use |
|
||||
| :----------------------------------------------------- | :--------------------------------------- |
|
||||
| Watch logs, build output, or periodic status updates | `monitor` |
|
||||
| Run a one-time command and read the full output | `run_shell_command(is_background=false)` |
|
||||
| Start a daemon that does not produce meaningful output | `run_shell_command(is_background=true)` |
|
||||
|
||||
Do not add `&` to monitor commands. A trailing `&`, such as
|
||||
`tail -f log &`, is stripped because the monitor manages backgrounding itself.
|
||||
A non-final `&`, such as `cmd1 & cmd2`, is rejected outright; restructure such
|
||||
commands without backgrounding instead.
|
||||
|
||||
## Important notes
|
||||
|
||||
- **Auto-stop behavior:** Monitors stop automatically when they reach
|
||||
`max_events`, when `idle_timeout_ms` elapses without output, or when the
|
||||
underlying command exits on its own. A monitor's status reflects the
|
||||
command's outcome, not a tool error: a clean exit (`code 0`) becomes
|
||||
`completed`, a non-zero exit code becomes `failed` with message
|
||||
`Exit code N`, and termination by signal becomes `failed` with message
|
||||
`Killed by signal SIG`. Commands cannot be interactive because stdin is
|
||||
closed. When a monitor stops, Qwen Code sends `SIGTERM` to the command's
|
||||
process group and escalates to `SIGKILL` after about 200 ms. On Windows, it
|
||||
uses `taskkill /f /t`. If the Qwen Code process itself is hard-killed,
|
||||
crashes, or runs out of memory, the detached process group is not cleaned up
|
||||
automatically; recover by stopping the monitor with `task_stop` before exit
|
||||
or by terminating the process group manually.
|
||||
- **Concurrency limit:** Qwen Code allows up to 16 running monitors per CLI
|
||||
session as a single shared pool. Monitors started by subagents count against
|
||||
the same cap as monitors started by the main agent. Stop an existing monitor
|
||||
before starting another if the limit is reached.
|
||||
- **Output handling:** Stdout and stderr are merged into a single notification
|
||||
stream with no stream prefix. Empty lines are ignored, ANSI color and control
|
||||
characters are stripped, and individual lines longer than 2000 characters are
|
||||
truncated. High-volume output is rate-limited with a burst of 5 events and
|
||||
about 1 event per second after that; lines beyond the rate limit are dropped,
|
||||
not buffered. Monitor output flows into the agent context as
|
||||
`<task-notification>` content. Structural notification tags are defanged, but
|
||||
the model still reads each line's text, so avoid monitoring streams that
|
||||
external parties can write to unless you trust the model to ignore embedded
|
||||
instructions.
|
||||
- **Permissions:** `monitor` has its own permission boundary and permission
|
||||
rules, such as `Monitor(git status)`. Read-only commands are automatically
|
||||
allowed; commands that modify state require user approval; commands containing
|
||||
command substitution (`$(...)`, backticks, `<(...)`, or `>(...)`) are rejected
|
||||
outright. The `tools.core` and `tools.exclude` settings for
|
||||
`run_shell_command` do not apply to `monitor`.
|
||||
- **Workspace restriction:** The optional `directory` must be an absolute path
|
||||
that resolves inside a registered workspace directory and outside the
|
||||
user-skills directory. Symlinks that point outside the workspace are rejected.
|
||||
748
docs/e2e-tests/worktree-phase-d.md
Normal file
748
docs/e2e-tests/worktree-phase-d.md
Normal file
@ -0,0 +1,748 @@
|
||||
# Worktree Phase D E2E Test Plan
|
||||
|
||||
## Scope
|
||||
|
||||
End-to-end verification of Phase D features against the local build at
|
||||
`/Users/mochi/code/qwen-code/.claude/worktrees/tender-jemison-037f0a/dist/cli.js`.
|
||||
|
||||
Phase D delivers three cross-cutting capabilities:
|
||||
|
||||
- **D-1** — `--worktree [name]` CLI startup flag (bare / explicit slug / `=` form),
|
||||
with `process.cwd()` + `Config.targetDir` switch and `WorktreeExitDialog`
|
||||
reuse on exit
|
||||
- **D-2** — `worktree.symlinkDirectories: string[]` settings key, applied in
|
||||
`performPostCreationSetup()` so it covers `--worktree`, `EnterWorktreeTool`,
|
||||
AND `AgentTool isolation: "worktree"` paths
|
||||
- **D-3** — `--worktree=#<N>` and `--worktree <github-url>` PR-reference forms,
|
||||
via `git fetch origin pull/<N>/head` (no `gh` CLI dependency)
|
||||
|
||||
## Binaries
|
||||
|
||||
- **Local build (Phase 6 verification)**: `node /Users/mochi/code/qwen-code/.claude/worktrees/tender-jemison-037f0a/dist/cli.js`
|
||||
- **Phase 4 dry-run baseline**: globally installed `qwen`
|
||||
|
||||
For dry-runs the globally installed `qwen` is expected to fail Groups A / E / F
|
||||
because the features don't exist yet — that's the validation that the plan
|
||||
correctly detects implementation.
|
||||
|
||||
### Baseline precondition for Group E
|
||||
|
||||
Tests **E2** (`EnterWorktreeTool` symlink) and **E3** (`AgentTool isolation`
|
||||
symlink) require **Phase A + B** to be present in the baseline — they exercise
|
||||
the existing `enter_worktree` tool and `agent isolation: "worktree"` parameter
|
||||
to confirm the symlink loop fires on those code paths too.
|
||||
|
||||
The globally installed `qwen` may predate PR #4073 (Phase A+B, merged 2026-05-14)
|
||||
and therefore lack these tools entirely. When that is the case, E2 / E3 cannot
|
||||
validate "symlink absent because D-2 is absent" — they collapse to "tool
|
||||
absent." Add this guard at the top of each:
|
||||
|
||||
```bash
|
||||
HAS_ENTER_WORKTREE=$($QWEN "list your tools and stop" --approval-mode yolo --output-format json 2>/dev/null \
|
||||
| jq -e '.[] | select(.type=="system") | .tools | index("enter_worktree")' >/dev/null && echo yes || echo no)
|
||||
if [ "$HAS_ENTER_WORKTREE" != "yes" ]; then
|
||||
echo "SKIP: enter_worktree absent in baseline — E2/E3 require Phase A+B"
|
||||
exit 0
|
||||
fi
|
||||
```
|
||||
|
||||
For Phase 6 (post-impl) verification the local build inherently contains
|
||||
Phase A-C, so the guard is a no-op and the tests run in full.
|
||||
|
||||
## Test environment template
|
||||
|
||||
Each group runs in its own temp git repo and tmux session:
|
||||
|
||||
```bash
|
||||
TEST_DIR=$(mktemp -d -t qwen-wt-phd-XXXXXX)
|
||||
TEST_DIR=$(cd "$TEST_DIR" && pwd -P) # resolve symlinks (macOS /var → /private/var)
|
||||
cd "$TEST_DIR"
|
||||
git init -q -b main
|
||||
git config user.email t@e.com
|
||||
git config user.name t
|
||||
git config commit.gpgsign false
|
||||
echo "hello" > README.md
|
||||
git add README.md
|
||||
git commit -q -m "initial" --no-verify
|
||||
|
||||
PROJECT_ID=$(node -e "console.log(process.argv[1].replace(/[^a-zA-Z0-9]/g,'-'))" "$TEST_DIR")
|
||||
QWEN="node /Users/mochi/code/qwen-code/.claude/worktrees/tender-jemison-037f0a/dist/cli.js"
|
||||
```
|
||||
|
||||
PR-ref tests (Group F) additionally require a checked-out clone of a public
|
||||
GitHub repo with at least one merged PR. Use this repo (qwen-code itself) as
|
||||
the test target — PR `#4174` (Phase C) is a guaranteed-present reference.
|
||||
|
||||
---
|
||||
|
||||
## Group A: `--worktree` flag basic forms
|
||||
|
||||
**Mode:** headless, `--approval-mode yolo`, `--output-format json`
|
||||
|
||||
### A1: bare `--worktree` (auto-slug)
|
||||
|
||||
```bash
|
||||
$QWEN --worktree "say hello and stop" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/a1.out
|
||||
|
||||
# A `worktree_started` system event is emitted at startup. The `notice`
|
||||
# field contains the slug (auto-generated `adj-noun-XXXXXX`) inside the
|
||||
# rendered text. Use `jq -e` so a missing event is a non-zero exit
|
||||
# (instead of silent `null`).
|
||||
jq -e '.[] | select(.type=="system" and .subtype=="worktree_started") | .data.notice | test("\"[a-z]+-[a-z]+-[0-9a-f]{6}\"")' < /tmp/a1.out
|
||||
|
||||
# The init system message's `cwd` should also point inside the worktree.
|
||||
jq -e '.[] | select(.type=="system" and .subtype=="init") | .cwd | test("/\\.qwen/worktrees/[a-z]+-[a-z]+-[0-9a-f]{6}$")' < /tmp/a1.out
|
||||
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/"*
|
||||
```
|
||||
|
||||
**Expected (post-impl):**
|
||||
|
||||
- `worktree_started` event with `.data.notice` containing the auto slug
|
||||
- Init `.cwd` ends with `.qwen/worktrees/<auto-slug>`
|
||||
- Exactly one worktree directory under `.qwen/worktrees/`
|
||||
- Branch named `worktree-<slug>` exists (`git branch | grep worktree-`)
|
||||
|
||||
**Expected (pre-impl baseline):** yargs rejects `--worktree` with
|
||||
"Unknown argument" error and exit code != 0.
|
||||
|
||||
### A2: `--worktree my-feature` (explicit slug)
|
||||
|
||||
```bash
|
||||
$QWEN --worktree my-feature "say hello and stop" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/a2.out
|
||||
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/my-feature"
|
||||
git -C "$TEST_DIR" branch | grep "worktree-my-feature"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** worktree dir `my-feature/` and branch
|
||||
`worktree-my-feature` both exist.
|
||||
|
||||
### A3: `--worktree=my-feature` (= form)
|
||||
|
||||
Identical to A2 with `=` form. Cleanup between A2 and A3 required (different
|
||||
TEST_DIR).
|
||||
|
||||
```bash
|
||||
$QWEN --worktree=my-feature "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/a3.out
|
||||
```
|
||||
|
||||
**Expected (post-impl):** same as A2.
|
||||
|
||||
### A4: invalid slug rejected before any git operation
|
||||
|
||||
```bash
|
||||
$QWEN --worktree "../escape" "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/a4.out
|
||||
echo "exit=$?"
|
||||
|
||||
ls "$TEST_DIR/.qwen/worktrees/" 2>/dev/null
|
||||
```
|
||||
|
||||
**Expected (post-impl):**
|
||||
|
||||
- Process exits with non-zero status
|
||||
- Stderr or final result message mentions "invalid slug" / "not allowed"
|
||||
- `.qwen/worktrees/` directory does not exist (worktree creation never started)
|
||||
|
||||
### A5: not a git repository → fail-close
|
||||
|
||||
```bash
|
||||
NON_GIT=$(mktemp -d)
|
||||
cd "$NON_GIT"
|
||||
$QWEN --worktree "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/a5.out
|
||||
echo "exit=$?"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** exit != 0, message mentions "not a git repository"
|
||||
or "git init".
|
||||
|
||||
---
|
||||
|
||||
## Group B: cwd + sidecar after `--worktree`
|
||||
|
||||
### B1: sidecar written with all six fields
|
||||
|
||||
```bash
|
||||
SESSION_ID=$(uuidgen)
|
||||
$QWEN --worktree b1-test --session-id "$SESSION_ID" "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/b1.out
|
||||
|
||||
SIDECAR=~/.qwen/projects/$PROJECT_ID/chats/$SESSION_ID.worktree.json
|
||||
jq '.slug, .worktreePath, .worktreeBranch, .originalCwd, .originalBranch, .originalHeadCommit' \
|
||||
< "$SIDECAR"
|
||||
```
|
||||
|
||||
**Expected:**
|
||||
|
||||
- `slug = "b1-test"`
|
||||
- `worktreePath` ends with `.qwen/worktrees/b1-test`
|
||||
- `worktreeBranch = "worktree-b1-test"`
|
||||
- `originalCwd` = `$TEST_DIR` (resolved)
|
||||
- `originalBranch = "main"`
|
||||
- `originalHeadCommit` matches `[0-9a-f]{40}`
|
||||
|
||||
### B2: `process.cwd()` switched at startup
|
||||
|
||||
```bash
|
||||
$QWEN --worktree b2-test "run the shell tool with command 'pwd', then stop" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/b2.out
|
||||
|
||||
# Extract the shell tool's stdout from the user-message tool_result
|
||||
jq -r '.[] | select(.type=="user") | .message.content[] | select(.tool_use_id != null) | .content' \
|
||||
< /tmp/b2.out | head -5
|
||||
```
|
||||
|
||||
**Expected (post-impl):** the `pwd` output equals `$TEST_DIR/.qwen/worktrees/b2-test`.
|
||||
|
||||
### B3: `Config.targetDir` switched (Footer / status payload)
|
||||
|
||||
```bash
|
||||
$QWEN --worktree b3-test "run the shell tool with command 'pwd && git rev-parse --abbrev-ref HEAD', then stop" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/b3.out
|
||||
|
||||
jq -r '.[] | select(.type=="user") | .message.content[] | select(.tool_use_id != null) | .content' \
|
||||
< /tmp/b3.out
|
||||
```
|
||||
|
||||
**Expected (post-impl):** branch is `worktree-b3-test` AND working directory
|
||||
is inside the worktree.
|
||||
|
||||
---
|
||||
|
||||
## Group C: `--worktree` × `--resume` precedence
|
||||
|
||||
### C1: `--worktree` wins over saved sidecar (different slug)
|
||||
|
||||
```bash
|
||||
# Run 1: create a session with worktree "first"
|
||||
SESSION_ID=$(uuidgen)
|
||||
$QWEN --worktree first --session-id "$SESSION_ID" "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/c1-run1.out
|
||||
|
||||
# Run 2: resume the same session but request a different worktree
|
||||
$QWEN --resume "$SESSION_ID" --worktree second "say hi again" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/c1-run2.out
|
||||
|
||||
# Sidecar should now point at "second"
|
||||
SIDECAR=~/.qwen/projects/$PROJECT_ID/chats/$SESSION_ID.worktree.json
|
||||
jq -r '.slug' < "$SIDECAR"
|
||||
|
||||
# Both worktree dirs should exist on disk (first was never removed, just unlinked)
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/"*
|
||||
```
|
||||
|
||||
**Expected (post-impl):**
|
||||
|
||||
- Sidecar `.slug` = `"second"`
|
||||
- Both `first/` and `second/` directories exist
|
||||
- Run 2's stderr or init `worktree_overridden` message mentions "--worktree
|
||||
overrides the resumed session's worktree"
|
||||
|
||||
### C2: stale sidecar (manually deleted dir) + `--worktree` → fresh worktree
|
||||
|
||||
```bash
|
||||
SESSION_ID=$(uuidgen)
|
||||
$QWEN --worktree c2 --session-id "$SESSION_ID" "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/c2-run1.out
|
||||
|
||||
rm -rf "$TEST_DIR/.qwen/worktrees/c2" # simulate user-deleted dir
|
||||
|
||||
$QWEN --resume "$SESSION_ID" --worktree c2-fresh "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/c2-run2.out
|
||||
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/"*
|
||||
```
|
||||
|
||||
**Expected (post-impl):** only `c2-fresh/` exists; sidecar updated to `c2-fresh`.
|
||||
|
||||
---
|
||||
|
||||
## Group D: WorktreeExitDialog regression (`--worktree`-started session)
|
||||
|
||||
**Mode:** interactive (tmux). Verifies Phase C dialog still triggers when the
|
||||
worktree was created by the CLI flag rather than `EnterWorktreeTool`.
|
||||
|
||||
### D1: 2x Ctrl+C → dialog appears
|
||||
|
||||
```bash
|
||||
tmux new-session -d -s d1 -x 200 -y 50 \
|
||||
"cd $TEST_DIR && $QWEN --worktree d1-test --approval-mode yolo"
|
||||
sleep 3
|
||||
|
||||
# Verify worktree is active (Footer indicator)
|
||||
tmux capture-pane -t d1 -p -S -50 | grep -q "⎇ worktree-d1-test"
|
||||
|
||||
# Send Ctrl+C twice
|
||||
tmux send-keys -t d1 C-c
|
||||
sleep 0.3
|
||||
tmux send-keys -t d1 C-c
|
||||
sleep 1
|
||||
|
||||
tmux capture-pane -t d1 -p -S -50 | grep -E "Active worktree|Keep worktree|Remove worktree"
|
||||
tmux kill-session -t d1
|
||||
```
|
||||
|
||||
**Expected (post-impl):** dialog text "Active worktree: \"d1-test\" …" and the
|
||||
three radio options appear.
|
||||
|
||||
### D2: Dialog → Cancel → session stays alive
|
||||
|
||||
```bash
|
||||
tmux new-session -d -s d2 -x 200 -y 50 \
|
||||
"cd $TEST_DIR && $QWEN --worktree d2-test --approval-mode yolo"
|
||||
sleep 3
|
||||
tmux send-keys -t d2 C-c; sleep 0.3; tmux send-keys -t d2 C-c; sleep 1
|
||||
|
||||
# Navigate to "Cancel" (third option) and select
|
||||
tmux send-keys -t d2 Down Down Enter
|
||||
sleep 1
|
||||
|
||||
tmux capture-pane -t d2 -p -S -10 | grep -q "Type your message"
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/d2-test" # still exists
|
||||
tmux kill-session -t d2
|
||||
```
|
||||
|
||||
**Expected (post-impl):** prompt input reappears; worktree dir is still on disk.
|
||||
|
||||
### D3: Dialog → Remove → worktree + branch + sidecar all gone
|
||||
|
||||
```bash
|
||||
SESSION_ID=$(uuidgen)
|
||||
tmux new-session -d -s d3 -x 200 -y 50 \
|
||||
"cd $TEST_DIR && $QWEN --worktree d3-test --session-id $SESSION_ID --approval-mode yolo"
|
||||
sleep 3
|
||||
tmux send-keys -t d3 C-c; sleep 0.3; tmux send-keys -t d3 C-c; sleep 1
|
||||
tmux send-keys -t d3 Down Enter # select "Remove worktree and branch"
|
||||
sleep 3
|
||||
tmux kill-session -t d3
|
||||
|
||||
ls "$TEST_DIR/.qwen/worktrees/d3-test" 2>/dev/null && echo "FAIL: dir exists"
|
||||
git -C "$TEST_DIR" branch | grep "worktree-d3-test" && echo "FAIL: branch exists"
|
||||
test ! -f ~/.qwen/projects/$PROJECT_ID/chats/$SESSION_ID.worktree.json && echo "PASS: sidecar gone"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** dir, branch, and sidecar all removed.
|
||||
|
||||
---
|
||||
|
||||
## Group E: `worktree.symlinkDirectories`
|
||||
|
||||
**Mode:** headless. Settings configured via temp settings file.
|
||||
|
||||
### Setup template
|
||||
|
||||
```bash
|
||||
mkdir -p "$TEST_DIR/node_modules"
|
||||
echo "package.json" > "$TEST_DIR/node_modules/.placeholder"
|
||||
mkdir -p "$TEST_DIR/.qwen"
|
||||
cat > "$TEST_DIR/.qwen/settings.json" <<'EOF'
|
||||
{
|
||||
"worktree": {
|
||||
"symlinkDirectories": ["node_modules"]
|
||||
}
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
### E1: `--worktree` path applies symlink
|
||||
|
||||
```bash
|
||||
$QWEN --worktree e1-test "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /dev/null
|
||||
|
||||
ls -la "$TEST_DIR/.qwen/worktrees/e1-test/node_modules"
|
||||
readlink "$TEST_DIR/.qwen/worktrees/e1-test/node_modules"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** `node_modules` inside the worktree is a symlink
|
||||
pointing to `$TEST_DIR/node_modules`.
|
||||
|
||||
### E2: `EnterWorktreeTool` path applies symlink
|
||||
|
||||
```bash
|
||||
$QWEN "use enter_worktree to create a worktree named e2-test, then stop" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /dev/null
|
||||
|
||||
readlink "$TEST_DIR/.qwen/worktrees/e2-test/node_modules"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** same symlink target.
|
||||
|
||||
### E3: AgentTool isolation path applies symlink
|
||||
|
||||
Requires a sub-agent definition. Use the built-in fork mechanism:
|
||||
|
||||
```bash
|
||||
$QWEN "use the agent tool with subagent_type='general-purpose', isolation='worktree', description='check node_modules', prompt='run pwd and ls -la node_modules then exit'" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/e3.out
|
||||
|
||||
# Extract agent worktree dir from result message
|
||||
jq -r '.[] | select(.type=="assistant") | .message.content[] | select(.type=="tool_use") | .input' \
|
||||
< /tmp/e3.out | head -5
|
||||
|
||||
# After execution find the agent-<7hex> worktree
|
||||
ls -la "$TEST_DIR/.qwen/worktrees/"agent-*/node_modules 2>/dev/null | head -3
|
||||
```
|
||||
|
||||
**Expected (post-impl):** symlink exists inside the `agent-<hex>` worktree
|
||||
(unless auto-cleaned because there were no changes — in that case the
|
||||
"no changes" path doesn't validate symlink behavior, escalate to a forced
|
||||
change test).
|
||||
|
||||
### E4: missing source dir → silently skipped, worktree still created
|
||||
|
||||
```bash
|
||||
cat > "$TEST_DIR/.qwen/settings.json" <<'EOF'
|
||||
{ "worktree": { "symlinkDirectories": ["does-not-exist"] } }
|
||||
EOF
|
||||
|
||||
$QWEN --worktree e4-test "say hi" --approval-mode yolo --output-format json 2>/dev/null > /tmp/e4.out
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/e4-test"
|
||||
ls "$TEST_DIR/.qwen/worktrees/e4-test/does-not-exist" 2>/dev/null && echo "UNEXPECTED"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** worktree directory exists, the missing entry is
|
||||
not created inside it, process exit = 0.
|
||||
|
||||
### E5: existing dest → silently skipped, no overwrite
|
||||
|
||||
```bash
|
||||
# Pre-create a worktree at expected slug then re-create — this is contrived
|
||||
# because Phase D paths should be fresh, but it exercises the EEXIST guard.
|
||||
mkdir -p "$TEST_DIR/.qwen/worktrees/e5-test/node_modules"
|
||||
echo "preexisting" > "$TEST_DIR/.qwen/worktrees/e5-test/node_modules/.marker"
|
||||
|
||||
# Force re-creation via EnterWorktreeTool (CLI would refuse "already exists")
|
||||
$QWEN "use enter_worktree with name='e5-test' to retry" --approval-mode yolo 2>/dev/null
|
||||
# either: tool errors out cleanly, OR symlink is skipped — both acceptable
|
||||
test -f "$TEST_DIR/.qwen/worktrees/e5-test/node_modules/.marker" && echo "PASS: not overwritten"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** preexisting `.marker` survives; no symlink replaces
|
||||
the dir.
|
||||
|
||||
### E6: absolute path / `../` → rejected
|
||||
|
||||
```bash
|
||||
cat > "$TEST_DIR/.qwen/settings.json" <<'EOF'
|
||||
{ "worktree": { "symlinkDirectories": ["/etc", "../escape"] } }
|
||||
EOF
|
||||
|
||||
$QWEN --worktree e6-test "say hi" --approval-mode yolo --output-format json 2>/dev/null > /tmp/e6.out
|
||||
ls "$TEST_DIR/.qwen/worktrees/e6-test/" | head -10
|
||||
```
|
||||
|
||||
**Expected (post-impl):** worktree exists; neither `etc` nor `escape` linked
|
||||
inside it; debug log carries warn lines.
|
||||
|
||||
---
|
||||
|
||||
## Group F: PR reference
|
||||
|
||||
**Mode:** headless. Requires `origin` remote pointing at a public GitHub repo.
|
||||
|
||||
### Setup template
|
||||
|
||||
```bash
|
||||
# Use qwen-code itself as the test repo
|
||||
TEST_DIR=$(mktemp -d -t qwen-wt-phd-pr-XXXXXX)
|
||||
TEST_DIR=$(cd "$TEST_DIR" && pwd -P)
|
||||
cd "$TEST_DIR"
|
||||
git clone --depth 1 https://github.com/QwenLM/qwen-code.git .
|
||||
PROJECT_ID=$(node -e "console.log(process.argv[1].replace(/[^a-zA-Z0-9]/g,'-'))" "$TEST_DIR")
|
||||
```
|
||||
|
||||
### F1: `--worktree=#4174` parses + fetches
|
||||
|
||||
```bash
|
||||
$QWEN --worktree=#4174 "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/f1.out
|
||||
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/pr-4174"
|
||||
git -C "$TEST_DIR/.qwen/worktrees/pr-4174" rev-parse --abbrev-ref HEAD
|
||||
```
|
||||
|
||||
**Expected (post-impl):**
|
||||
|
||||
- Worktree dir `pr-4174/` exists
|
||||
- HEAD branch = `worktree-pr-4174`
|
||||
- The branch's tip resolves (git log -1) without error
|
||||
|
||||
### F2: full URL form
|
||||
|
||||
```bash
|
||||
$QWEN --worktree "https://github.com/QwenLM/qwen-code/pull/4174" "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/f2.out
|
||||
|
||||
ls -d "$TEST_DIR/.qwen/worktrees/pr-4174"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** same as F1.
|
||||
|
||||
### F3: missing `origin` remote → fail-close
|
||||
|
||||
```bash
|
||||
cd "$TEST_DIR" && git remote remove origin
|
||||
$QWEN --worktree=#4174 "say hi" --approval-mode yolo --output-format json 2>/dev/null > /tmp/f3.out
|
||||
echo "exit=$?"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** exit != 0; message mentions `origin` remote.
|
||||
|
||||
### F4: invalid PR number → fail-close
|
||||
|
||||
```bash
|
||||
$QWEN --worktree=#999999999 "say hi" --approval-mode yolo --output-format json 2>/dev/null > /tmp/f4.out
|
||||
echo "exit=$?"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** exit != 0; message mentions "Failed to fetch PR".
|
||||
30-second timeout cap respected (test runtime < 35s).
|
||||
|
||||
### F5: malformed `#abc` falls through to slug validation
|
||||
|
||||
```bash
|
||||
$QWEN --worktree=#abc "say hi" --approval-mode yolo --output-format json 2>/dev/null > /tmp/f5.out
|
||||
echo "exit=$?"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** treated as literal slug `#abc`, rejected by
|
||||
`validateUserWorktreeSlug` because `#` is not allowed. Exit != 0.
|
||||
|
||||
### F6: PR worktree gets symlinks too (cross-cut with E)
|
||||
|
||||
```bash
|
||||
cat > "$TEST_DIR/.qwen/settings.json" <<'EOF'
|
||||
{ "worktree": { "symlinkDirectories": ["node_modules"] } }
|
||||
EOF
|
||||
mkdir -p "$TEST_DIR/node_modules" && echo x > "$TEST_DIR/node_modules/.marker"
|
||||
|
||||
$QWEN --worktree=#4174 "say hi" --approval-mode yolo --output-format json 2>/dev/null > /dev/null
|
||||
readlink "$TEST_DIR/.qwen/worktrees/pr-4174/node_modules"
|
||||
```
|
||||
|
||||
**Expected (post-impl):** symlink target = `$TEST_DIR/node_modules`.
|
||||
|
||||
---
|
||||
|
||||
## Group G: Integration + edge cases
|
||||
|
||||
### G1: full lifecycle — start → write → Keep → resume
|
||||
|
||||
> **Pre-impl note:** Against the baseline this test exits before `sleep 3`
|
||||
> finishes (yargs rejects `--worktree` immediately and the tmux pane dies).
|
||||
> The `capture-pane` call then errors with "can't find pane". This is
|
||||
> expected — record as PASS-by-rejection. Wrap captures with `|| true` for
|
||||
> the dry-run, or skip G1 entirely in baseline mode.
|
||||
|
||||
```bash
|
||||
SESSION_ID=$(uuidgen)
|
||||
tmux new-session -d -s g1 -x 200 -y 50 \
|
||||
"cd $TEST_DIR && $QWEN --worktree g1-test --session-id $SESSION_ID --approval-mode yolo 2>&1 | tee /tmp/g1-stderr.out"
|
||||
sleep 3
|
||||
tmux send-keys -t g1 "use the write_file tool to create file 'work.txt' with content 'phase d test'"
|
||||
sleep 0.3; tmux send-keys -t g1 Enter
|
||||
sleep 8
|
||||
|
||||
tmux send-keys -t g1 C-c; sleep 0.3; tmux send-keys -t g1 C-c; sleep 1
|
||||
tmux send-keys -t g1 Enter # default = "Keep"
|
||||
sleep 2
|
||||
tmux kill-session -t g1
|
||||
|
||||
# File survived
|
||||
cat "$TEST_DIR/.qwen/worktrees/g1-test/work.txt"
|
||||
|
||||
# Resume reattaches
|
||||
tmux new-session -d -s g1b -x 200 -y 50 \
|
||||
"cd $TEST_DIR && $QWEN --resume $SESSION_ID --approval-mode yolo"
|
||||
sleep 4
|
||||
tmux capture-pane -t g1b -p -S -50 | grep -E "⎇ worktree-g1-test|Resumed"
|
||||
tmux kill-session -t g1b
|
||||
```
|
||||
|
||||
**Expected (post-impl):**
|
||||
|
||||
- `work.txt` inside the worktree contains the written content
|
||||
- Resumed session Footer shows `⎇ worktree-g1-test (g1-test)`
|
||||
- INFO history item or `<system-reminder>` mentions "Resumed"
|
||||
|
||||
### G2: relative path arg resolved before cwd switch
|
||||
|
||||
```bash
|
||||
# Create an mcp config in TEST_DIR and reference it relatively.
|
||||
# --mcp-config takes a file path; if the test plan path is resolved AFTER
|
||||
# the --worktree cwd switch, the file won't be found inside the worktree
|
||||
# and the CLI will error out. If resolved BEFORE the switch (correct), the
|
||||
# file is loaded from TEST_DIR.
|
||||
cat > "$TEST_DIR/mcp.json" <<'EOF'
|
||||
{ "mcpServers": {} }
|
||||
EOF
|
||||
cd "$TEST_DIR"
|
||||
|
||||
$QWEN --worktree g2-test --mcp-config ./mcp.json "say hi" \
|
||||
--approval-mode yolo --output-format json 2>/dev/null > /tmp/g2.out
|
||||
echo "exit=$?"
|
||||
jq -r '.[] | select(.type=="result") | .result' < /tmp/g2.out | head -3
|
||||
```
|
||||
|
||||
**Expected (post-impl):** exit = 0; the model responds normally (the empty
|
||||
mcp config means no MCP servers but no error either).
|
||||
|
||||
**Expected (pre-impl baseline):** yargs rejects `--worktree` (the test
|
||||
cannot distinguish "worktree flag missing" from "mcp config resolution
|
||||
broken" until the flag itself exists).
|
||||
|
||||
---
|
||||
|
||||
## Run order + parallelism
|
||||
|
||||
| Group | Mode | Runtime | Parallel-safe? |
|
||||
| ----- | ------------ | ------- | ---------------------------- |
|
||||
| A | headless | ~30s | yes (own TEST_DIR) |
|
||||
| B | headless | ~20s | yes |
|
||||
| C | headless | ~40s | yes |
|
||||
| D | tmux | ~30s | yes (own session name) |
|
||||
| E | headless | ~60s | yes |
|
||||
| F | headless+net | ~60s | NO — shares the GitHub clone |
|
||||
| G | mixed | ~60s | yes |
|
||||
|
||||
Run A/B/C/D/E/G in parallel; F serially after the clone setup.
|
||||
|
||||
## Reproduction report
|
||||
|
||||
### Phase 4 dry-run — baseline `qwen` v0.15.11 (2026-05-20)
|
||||
|
||||
Runtime: 3 parallel `test-engineer` agents, ~7 minutes total. Baseline lacks
|
||||
both Phase D (expected) and Phase A+B (older binary than expected — see
|
||||
E2/E3 caveat).
|
||||
|
||||
| Group | Result | Notes |
|
||||
| -------------------------------- | ---------- | ------------------------------------------------------------------------------------- |
|
||||
| A1 (bare flag) | ✅ | yargs `Unknown argument: worktree`, exit 1 |
|
||||
| A2 (explicit slug) | ✅ | same |
|
||||
| A3 (= form) | ✅ | same |
|
||||
| A4 (invalid slug) | ✅ | yargs rejects before slug validation |
|
||||
| A5 (non-git dir) | ✅ | same |
|
||||
| B1 (sidecar fields) | ✅ | sidecar correctly absent; jq selector valid against sample data |
|
||||
| B2 (cwd switch) | ✅ | shell-tool `tool_result.content` jq selector verified against real output |
|
||||
| B3 (targetDir switch) | ✅ | same selector |
|
||||
| C1 (--worktree beats sidecar) | ✅ | both runs exit 1, no sidecar |
|
||||
| C2 (stale sidecar + fresh) | ✅ | same |
|
||||
| E1 (--worktree symlink) | ✅ | flag rejected, no symlink — pre-impl confirmed |
|
||||
| E2 (EnterWorktree symlink) | ⚠️ N/A | baseline lacks `enter_worktree` tool (older than PR #4073); guard now skips this case |
|
||||
| E3 (AgentTool isolation symlink) | ⚠️ N/A | baseline `agent` schema silently drops `isolation` param; guard skips |
|
||||
| E4 (missing source skip) | ✅ | flag rejected |
|
||||
| E5 (existing dest not overwrite) | ⚠️ trivial | preexisting `.marker` survived but only because tool couldn't run |
|
||||
| E6 (path traversal reject) | ✅ | flag rejected, no symlinks |
|
||||
| F1 (--worktree=#4174 fetch) | ✅ | `Unknown argument: worktree`, no network call |
|
||||
| F2 (full URL form) | ✅ | same |
|
||||
| F3 (missing origin) | ✅ | rejected before git check |
|
||||
| F4 (invalid PR number) | ✅ | rejected before fetch |
|
||||
| F5 (`#abc` malformed) | ✅ | same |
|
||||
| F6 (PR + symlinkDirs) | ✅ | same |
|
||||
| G1 (lifecycle tmux) | ⚠️ partial | tmux pane dies on flag rejection; record-by-exit-code works |
|
||||
| G2 (relative path) | ✅ | (after switching to `--mcp-config ./mcp.json`) yargs rejects worktree first |
|
||||
|
||||
**Conclusion:** test scripts are fundamentally sound. 19 / 24 cases cleanly
|
||||
detect pre-impl baseline; 3 cases (E2/E3/E5) need the baseline to include
|
||||
Phase A+B (which the local Phase 6 build will provide); 2 cases (G1/G2) had
|
||||
script bugs that are now fixed. **Ready to proceed to Phase 5
|
||||
implementation.**
|
||||
|
||||
### Phase 6 verification — local build
|
||||
|
||||
**Binary**: `node /Users/mochi/code/qwen-code/.claude/worktrees/tender-jemison-037f0a/dist/cli.js`
|
||||
**Date**: 2026-05-20
|
||||
**Scope**: Groups A, B, C, E, F, G (6 parallel `test-engineer` agents)
|
||||
|
||||
| Group | Result | Notes |
|
||||
| ---------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| A1 (bare flag) | ✅ (with doc tip) | yargs consumes the next positional as the slug value when user passes `qwen --worktree "say hi"`; quickstart now tells users to use `=` form or put the prompt before the flag. Auto-slug feature itself confirmed via `qwen --worktree --approval-mode yolo "say hi"` → slug `bright-elm-8a4c12`, init `.cwd` ends with `.qwen/worktrees/<auto-slug>`. |
|
||||
| A2 (explicit slug) | ✅ | dir `.qwen/worktrees/my-feature` + branch `worktree-my-feature` |
|
||||
| A3 (= form) | ✅ | identical to A2 |
|
||||
| A4 (invalid slug) | ✅ | exit=1, message: `Worktree name may only contain letters, digits, dots, underscores, and hyphens.`, no worktree dir |
|
||||
| A5 (non-git dir) | ✅ | exit=1, message: `not a git repository. Run \`git init\` first or relaunch from inside one.` |
|
||||
| B1 (sidecar fields) | ✅ | All 6 fields present and correct; sidecar lives under worktree projectHash as designed |
|
||||
| B2 (cwd switch) | ✅ | `pwd` inside shell tool returned worktree path exactly |
|
||||
| B3 (branch + cwd) | ✅ | `pwd` = worktree path, `git rev-parse --abbrev-ref HEAD` = `worktree-b3-test` |
|
||||
| C1 (cross-slug override) | ❌ → **known limitation** | Sessions are bound to `projectHash(cwd)`; `--worktree second --resume <sid-from-first>` can't find the session. Documented in user docs Limitations. A future Config refactor (anchor storage at repo root) would lift this. |
|
||||
| C2 (stale sidecar + new worktree) | ❌ → **same root cause** | Same architectural constraint. |
|
||||
| E1 (`--worktree` symlink) | ✅ | `node_modules` symlinked into the new worktree |
|
||||
| E2 (`enter_worktree` symlink) | ✅ | same code path via `createUserWorktree` |
|
||||
| E3 (agent isolation symlink) | ⚠️ test-setup | model committed `node_modules` (because the agent guard refused dirty state); EEXIST guard then correctly skipped the symlink. Code path is correct; for a clean E3 the test plan needs to pre-`.gitignore` `node_modules`. |
|
||||
| E4 (missing source skip) | ✅ | worktree created, no entry, exit 0 |
|
||||
| E5 (existing dest no overwrite) | ✅ | preexisting marker survived |
|
||||
| E6 (absolute / `..` rejected) | ✅ | neither path linked |
|
||||
| F1 (`--worktree=#4174` fetch) | ✅ | worktree dir `pr-4174/`, branch `worktree-pr-4174`, tip commit `8f4fe8e feat(cli): per-turn /diff…`; local-remote substitute (sandbox blocks real GitHub) |
|
||||
| F2 (full URL form) | ✅ | same result; URL parsed → PR #4174 → local origin fetch succeeded |
|
||||
| F3 (missing origin) | ✅ | exit=1 in 2s; message mentions adding `origin` remote |
|
||||
| F4 (invalid PR #999999999) | ✅ | exit=1 in 2s; "PR does not exist on origin"; well within 35s cap |
|
||||
| F5 (malformed `#abc`) | ✅ | slug validation rejects `#` |
|
||||
| F6 (PR worktree + symlinks) | ✅ | symlink `pr-4174/node_modules` → `$TEST_DIR/node_modules` confirmed |
|
||||
| G1.a (start + write + Keep) | ✅ | TUI flow, Footer indicator, dialog options, file persists |
|
||||
| G1.b (`--resume … --worktree foo`) | ❌ → **fixed in this PR** | Original: `--worktree: Worktree already exists at …`. Phase 6 fix added the re-attach branch in `setupStartupWorktree`. Verified post-fix via smoke test (`--worktree foo` twice → second emits the `worktree_started` notice, no error) + new unit tests in `worktreeStartup.test.ts`. |
|
||||
| G2 (relative `--mcp-config`) | ❌ → **fixed in this PR** | Original: exit=52, `Invalid MCP configuration … is not valid JSON`. Phase 6 fix normalizes path-taking argv fields (`mcpConfig`, `openaiLoggingDir`, `jsonFile`, `inputFile`, `telemetryOutfile`, `includeDirectories`) against the launch cwd BEFORE `setupStartupWorktree` chdirs. Verified post-fix via smoke test (`--worktree foo --mcp-config ./mcp.json` → model responds normally). |
|
||||
|
||||
**Phase 6 net result:** 22 / 24 cases passed post-fix; 2 cases (C1/C2) hit an
|
||||
architectural limitation now documented; 1 case (E3) is a test-setup quirk,
|
||||
not an implementation issue. **Ready for Phase 7 code review.**
|
||||
|
||||
### Fix references (Phase 6 fixes that landed in this PR)
|
||||
|
||||
| Fix | File | Change |
|
||||
| ----------------------------------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Re-attach to existing worktree (G1.b) | `packages/cli/src/startup/worktreeStartup.ts` | Added pre-create check: if dir is a registered worktree on the expected branch, skip create + chdir |
|
||||
| `getRegisteredWorktreeBranch()` helper | `packages/core/src/services/gitWorktreeService.ts` | Probes `git rev-parse --abbrev-ref HEAD` against the candidate path |
|
||||
| Path normalization before chdir (G2) | `packages/cli/src/gemini.tsx` | Resolves `mcpConfig`, `openaiLoggingDir`, `jsonFile`, `inputFile`, `telemetryOutfile`, `includeDirectories` against launch cwd when `--worktree` is set |
|
||||
| Documentation: yargs flag ordering tip + Limitations update | `docs/users/features/worktree.md` | Quick Start tip + new Limitations bullets (cross-slug, path-arg behavior) |
|
||||
| Unit tests for re-attach | `packages/cli/src/startup/worktreeStartup.test.ts` | Added 2 tests: happy re-attach + "different branch occupies slot" guard |
|
||||
|
||||
**Phase 6 Group F network note**: The sandbox blocks `git fetch` to `https://github.com` with HTTP 403. F1/F2/F4/F6 were retested against a local bare repo (`git init --bare`) seeded with `refs/pull/4174/head` pointing at a commit whose message is `feat(cli): per-turn /diff with interactive dialog (#4277)`. F3 and F5 are network-independent and were verified directly. The local-remote substitute fully exercises the parsing + fetch + worktree-creation code path.
|
||||
|
||||
---
|
||||
|
||||
## Reproduction report — Phase 4 dry-run (Groups F + G), 2026-05-20
|
||||
|
||||
**Binary**: `qwen` (globally installed, v0.15.11 at `/Users/mochi/.nvm/versions/node/v22.21.1/bin/qwen`)
|
||||
**Override**: `QWEN="qwen"`
|
||||
|
||||
### Results table
|
||||
|
||||
| Test ID | Result | Evidence | Fix suggestion |
|
||||
| ------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
||||
| F1 `--worktree=#4174` | PASS | `Unknown argument: worktree`, exit=1 | None — expected baseline failure |
|
||||
| F2 `--worktree <url>` | PASS | `Unknown argument: worktree`, exit=1 | None — expected baseline failure |
|
||||
| F3 missing origin | PASS | `Unknown argument: worktree`, exit=1 — yargs rejected before any git op | None |
|
||||
| F4 invalid PR #999999999 | PASS | `Unknown argument: worktree`, exit=1 | None |
|
||||
| F5 malformed `#abc` | PASS | `Unknown argument: worktree`, exit=1 | None |
|
||||
| F6 PR + symlinkDirs | PASS | `Unknown argument: worktree`, exit=1 | None |
|
||||
| G1 lifecycle (tmux) | PASS | `Unknown argument: worktree` emitted to stdout captured in `/tmp/g1_raw.out`; tmux session exited immediately, pane was already dead by capture time | SCRIPT-BUG: see note below |
|
||||
| G2 relative path | PASS | `Unknown arguments: worktree, prompt-file, promptFile`, exit=1 | SCRIPT-BUG: see note below |
|
||||
|
||||
### Observed behavior (all cases)
|
||||
|
||||
Every invocation of `--worktree` (bare, `=` form, `#<N>` form, full URL, combined with `--prompt-file`) was rejected at the yargs argument-parsing layer with exit code 1 before any application logic ran. The exact error strings are:
|
||||
|
||||
- `Unknown argument: worktree` (single unknown arg)
|
||||
- `Unknown arguments: worktree, prompt-file, promptFile` (G2: both `--worktree` and `--prompt-file` are unknown, listed together)
|
||||
|
||||
No git operations, no network calls, no filesystem writes occurred in any test.
|
||||
|
||||
### Expected behavior
|
||||
|
||||
Identical rejection — this is the correct pre-implementation baseline. All 8 tests PASS in the dry-run sense (the plan correctly detects that the features do not exist).
|
||||
|
||||
### Key context
|
||||
|
||||
The failure mode is uniformly at the yargs layer, not downstream. This confirms the test plan's detection strategy is sound: once `--worktree` is wired into yargs, these tests will stop failing at this layer and will instead exercise the actual implementation paths (F1-F6 will hit git fetch, G1 will hit the TUI lifecycle, G2 will hit `--prompt-file` resolution).
|
||||
|
||||
### SCRIPT-BUG notes for the test plan
|
||||
|
||||
**G1 (tmux):** The tmux session command pipes through `tee` with a subshell `echo 'PROC_EXIT='$?` that captures the exit of `tee`, not of `qwen`. When the process exits instantly (as with an Unknown argument error), the session terminates before `sleep 3` finishes and the pane name `g1dry` is gone by the time `tmux capture-pane` runs, producing `can't find pane: g1dry`. Fix: use `|| true` after `tmux capture-pane`, or add a `|| sleep 0` guard; better still, for the baseline-fail case redirect stderr+stdout to a file outside tmux and check the file directly (as done here via `tee /tmp/g1_raw.out`).
|
||||
|
||||
**G2 (`--prompt-file`):** The test plan uses `--prompt-file ./relative.txt` as a combined test with `--worktree`. In the baseline, `--prompt-file` is also an unknown argument (it does not exist in v0.15.11 yargs schema either — the flag is `--prompt-interactive` / `-p`). The error lists both unknown args together. The plan should note that `--prompt-file` will need to be implemented alongside `--worktree`, or use an existing flag (e.g. pipe via stdin or use `--prompt`) for the relative-path resolution test.
|
||||
1752
docs/plans/2026-05-14-auto-compaction-threshold-redesign.md
Normal file
1752
docs/plans/2026-05-14-auto-compaction-threshold-redesign.md
Normal file
File diff suppressed because it is too large
Load Diff
2094
docs/superpowers/plans/2026-05-28-computer-use-built-in.md
Normal file
2094
docs/superpowers/plans/2026-05-28-computer-use-built-in.md
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,9 +1,6 @@
|
||||
export default {
|
||||
settings: 'Settings',
|
||||
auth: 'Authentication',
|
||||
memory: {
|
||||
display: 'hidden',
|
||||
},
|
||||
'qwen-ignore': 'Ignoring Files',
|
||||
'trusted-folders': 'Trusted Folders',
|
||||
themes: 'Themes',
|
||||
|
||||
@ -143,10 +143,16 @@ Settings are organized into categories. Most settings should be placed within th
|
||||
| -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
|
||||
| `model.name` | string | The Qwen model to use for conversations. | `undefined` |
|
||||
| `model.maxSessionTurns` | number | Maximum number of user/model/tool turns to keep in a session. -1 means unlimited. | `-1` |
|
||||
| `model.maxWallTimeSeconds` | number | Wall-clock budget for headless / unattended runs, in seconds. `-1` means unlimited. Overridable per-invocation via `--max-wall-time`, which requires a positive duration (`90`, `30s`, `5m`, `1h`, `1.5h`); the minimum is 1 second — sub-second values (`500ms`, `0.5`) are rejected as typos. Omit the flag to fall back to this setting. Aborts with exit code 55 when exceeded. | `-1` |
|
||||
| `model.maxToolCalls` | number | Cumulative tool-call budget for a run (counts every executed tool, success or failure; `structured_output` under `--json-schema` is exempt). `-1` means unlimited; `0` means "no tool calls allowed". Capped at 1,000,000 to catch typos. Overridable via `--max-tool-calls`. Aborts with exit code 55 when exceeded. | `-1` |
|
||||
| `model.generationConfig` | object | Advanced overrides passed to the underlying content generator. Supports request controls such as `timeout`, `maxRetries`, `enableCacheControl`, `splitToolMedia` (set `true` for strict OpenAI-compatible servers like LM Studio that reject non-text content on `role: "tool"` messages — splits media into a follow-up user message), `contextWindowSize` (override model's context window size), `modalities` (override auto-detected input modalities), `customHeaders` (custom HTTP headers for API requests), and `extra_body` (additional body parameters for OpenAI-compatible API requests only), along with fine-tuning knobs under `samplingParams` (for example `temperature`, `top_p`, `max_tokens`). Leave unset to rely on provider defaults. | `undefined` |
|
||||
| `model.chatCompression.contextPercentageThreshold` | number | Sets the threshold for chat history compression as a percentage of the model's total token limit. This is a value between 0 and 1 that applies to both automatic compression and the manual `/compress` command. For example, a value of `0.6` will trigger compression when the chat history exceeds 60% of the token limit. Use `0` to disable compression entirely. | `0.7` |
|
||||
| `model.chatCompression.contextPercentageThreshold` | number | **REMOVED.** Auto-compaction now uses a three-tier threshold ladder (warn / auto / hard) computed internally from the model's context window via the `computeThresholds()` function — no longer user-configurable. Setting this field in `settings.json` is silently ignored (no startup warning). There is currently no replacement for "disable compression entirely" — reactive overflow recovery remains the safety net at the API layer if compression itself fails. (See PR #4345 / `docs/design/auto-compaction-threshold-redesign.md` for the redesign rationale.) | `N/A` |
|
||||
| `model.chatCompression.maxRecentFilesToRetain` | number | Number of most-recently-touched files whose current content is restored (embedded if small, otherwise referenced by path) into history after auto-compaction. `0` restores none. Env override: `QWEN_COMPACT_MAX_RECENT_FILES`. | `5` |
|
||||
| `model.chatCompression.maxRecentImagesToRetain` | number | Number of most-recent images (tool screenshots / user pastes) restored into history after auto-compaction. `0` restores none. Env override: `QWEN_COMPACT_MAX_RECENT_IMAGES`. | `3` |
|
||||
| `model.chatCompression.enableScreenshotTrigger` | boolean | When `true`, auto-compaction also fires once the number of tool-returned images accumulated in history reaches `screenshotTriggerThreshold`, independent of token usage — aimed at computer-use sessions where frequent screenshots dilute model attention. Counts only images returned inside tool results, not user-pasted images. Env override: `QWEN_COMPACT_SCREENSHOT_TRIGGER` (`1`/`true`/`0`/`false`). | `true` |
|
||||
| `model.chatCompression.screenshotTriggerThreshold` | number | Tool-returned image count at or above which the screenshot trigger fires (only when `enableScreenshotTrigger`). Compaction resets the count — surviving images are re-embedded as top-level parts, which the trigger doesn't count — so it won't immediately re-fire. Env override: `QWEN_COMPACT_SCREENSHOT_THRESHOLD`. | `50` |
|
||||
| `model.skipNextSpeakerCheck` | boolean | Skip the next speaker check. | `false` |
|
||||
| `model.skipLoopDetection` | boolean | Disables loop detection checks. Loop detection prevents infinite loops in AI responses but can generate false positives that interrupt legitimate workflows. Enable this option if you experience frequent false positive loop detection interruptions. | `false` |
|
||||
| `model.skipLoopDetection` | boolean | Disables streaming loop detection checks. Defaults to `true` (loop detection is skipped) to avoid false positives interrupting legitimate workflows. Set to `false` to re-enable streaming loop detection — useful as a guardrail in headless / non-interactive runs where stuck repetition can otherwise waste budget. | `true` |
|
||||
| `model.skipStartupContext` | boolean | Skips sending the startup workspace context (environment summary and acknowledgement) at the beginning of each session. Enable this if you prefer to provide context manually or want to save tokens on startup. | `false` |
|
||||
| `model.enableOpenAILogging` | boolean | Enables logging of OpenAI API calls for debugging and analysis. When enabled, API requests and responses are logged to JSON files. | `false` |
|
||||
| `model.openAILoggingDir` | string | Custom directory path for OpenAI API logs. If not specified, defaults to `logs/openai` in the current working directory. Supports absolute paths, relative paths (resolved from current working directory), and `~` expansion (home directory). | `undefined` |
|
||||
@ -272,7 +278,8 @@ If you are experiencing performance issues with file searching (e.g., with `@` c
|
||||
| Setting | Type | Description | Default |
|
||||
| -------------------------------- | ------- | --------------------------------------------------------------------------------- | ------- |
|
||||
| `memory.enableManagedAutoMemory` | boolean | Enable background extraction of memories from conversations. | `true` |
|
||||
| `memory.enableManagedAutoDream` | boolean | Enable automatic consolidation (deduplication and cleanup) of collected memories. | `false` |
|
||||
| `memory.enableManagedAutoDream` | boolean | Enable automatic consolidation (deduplication and cleanup) of collected memories. | `true` |
|
||||
| `memory.enableAutoSkill` | boolean | Enable background review for reusable project skills after tool-heavy sessions. | `true` |
|
||||
|
||||
See [Memory](../features/memory) for details on how auto-memory works and how to use the `/memory`, `/remember`, and `/dream` commands.
|
||||
|
||||
@ -703,7 +710,9 @@ Qwen Code can execute potentially unsafe operations (like shell commands and fil
|
||||
|
||||
- Using `--sandbox` or `-s` flag.
|
||||
- Setting `QWEN_SANDBOX` environment variable.
|
||||
- Sandbox is enabled when using `--yolo` or `--approval-mode=yolo` by default.
|
||||
- Setting `tools.sandbox` in settings.
|
||||
|
||||
> ⚠️ **`--yolo` does _not_ automatically enable a sandbox.** YOLO mode only auto-approves tool calls; sandboxing must still be opted into via `--sandbox`, `QWEN_SANDBOX`, or `tools.sandbox`. In headless / non-interactive runs with `--yolo` (or `--approval-mode=yolo`) and no sandbox, the model can execute shell, write, and edit tools at the current process's privilege level — Qwen Code prints a warning to stderr in that case. Suppress with `QWEN_CODE_SUPPRESS_YOLO_WARNING=1` once you've reviewed the trade-off.
|
||||
|
||||
By default, it uses a pre-built `qwen-code-sandbox` Docker image.
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ export default {
|
||||
},
|
||||
'approval-mode': 'Approval Mode',
|
||||
'auto-mode': 'Auto Mode',
|
||||
worktree: 'Worktrees',
|
||||
mcp: 'MCP',
|
||||
lsp: 'LSP (Language Server Protocol)',
|
||||
'token-caching': 'Token Caching',
|
||||
|
||||
@ -3,5 +3,6 @@ export default {
|
||||
telegram: 'Telegram',
|
||||
weixin: 'WeChat',
|
||||
dingtalk: 'DingTalk',
|
||||
feishu: 'Feishu',
|
||||
plugins: 'Plugins',
|
||||
};
|
||||
|
||||
170
docs/users/features/channels/feishu.md
Normal file
170
docs/users/features/channels/feishu.md
Normal file
@ -0,0 +1,170 @@
|
||||
# Feishu (Lark)
|
||||
|
||||
This guide covers setting up a Qwen Code channel on Feishu (飞书) / Lark.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Feishu organization account
|
||||
- A Feishu application with App ID and App Secret (see below)
|
||||
|
||||
## Creating an Application
|
||||
|
||||
1. Go to the [Feishu Open Platform](https://open.feishu.cn)
|
||||
2. Create a new application (or use an existing one)
|
||||
3. Under the application, enable the **Bot** capability (添加应用能力 → 机器人)
|
||||
4. In **Event Subscriptions** (事件与回调), select **Long Connection** (使用长连接接收事件)
|
||||
5. Add the event `im.message.receive_v1` (接收消息)
|
||||
6. Note the **App ID** (Client ID) and **App Secret** (Client Secret) from the application credentials page
|
||||
|
||||
### Required Permissions
|
||||
|
||||
Enable the following permissions under **Permissions & Scopes** (权限管理):
|
||||
|
||||
- `im:message` — Read and send messages
|
||||
- `im:message:send_as_bot` — Send messages as bot
|
||||
- `im:resource` — Access message resources (images, files)
|
||||
|
||||
### Publish the Application
|
||||
|
||||
After configuring permissions and events, create a version and publish it. The bot won't work until the application is published and approved.
|
||||
|
||||
## Configuration
|
||||
|
||||
Add the channel to `~/.qwen/settings.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"channels": {
|
||||
"my-feishu": {
|
||||
"type": "feishu",
|
||||
"clientId": "<your-app-id>",
|
||||
"clientSecret": "<your-app-secret>",
|
||||
"senderPolicy": "open",
|
||||
"sessionScope": "user",
|
||||
"cwd": "/path/to/your/project",
|
||||
"groupPolicy": "open",
|
||||
"collapsible": true,
|
||||
"groups": {
|
||||
"*": { "requireMention": true }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Configuration Options
|
||||
|
||||
| Option | Description |
|
||||
| ---------------------- | ------------------------------------------------------------------- |
|
||||
| `clientId` | Feishu App ID |
|
||||
| `clientSecret` | Feishu App Secret |
|
||||
| `collapsible` | Collapse long responses into expandable sections (default: `false`) |
|
||||
| `collapsibleThreshold` | Character threshold for collapsing (default: `500`) |
|
||||
| `webhookPort` | If set, use HTTP webhook mode instead of WebSocket |
|
||||
| `verificationToken` | Verification token for webhook mode |
|
||||
| `encryptKey` | Encrypt key for webhook mode |
|
||||
|
||||
## Running
|
||||
|
||||
```bash
|
||||
# Start only the Feishu channel
|
||||
qwen channel start my-feishu
|
||||
|
||||
# Or start all configured channels together
|
||||
qwen channel start
|
||||
```
|
||||
|
||||
Open Feishu and send a message to the bot. You should see a streaming interactive card with the response.
|
||||
|
||||
## Connection Modes
|
||||
|
||||
### WebSocket (Default)
|
||||
|
||||
WebSocket mode uses an outbound long connection — no public URL or server is needed. This is the recommended mode for most deployments.
|
||||
|
||||
### Webhook
|
||||
|
||||
If you need webhook mode (e.g., for shared applications), set `webhookPort` in your config:
|
||||
|
||||
```json
|
||||
{
|
||||
"channels": {
|
||||
"my-feishu": {
|
||||
"type": "feishu",
|
||||
"webhookPort": 9321,
|
||||
"verificationToken": "<from-feishu-console>",
|
||||
"encryptKey": "<from-feishu-console>"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then set the request URL in Feishu Open Platform to `http://<your-server>:9321`.
|
||||
|
||||
## Group Chats
|
||||
|
||||
Feishu bots work in both DM and group conversations. To enable group support:
|
||||
|
||||
1. Set `groupPolicy` to `"allowlist"` or `"open"` in your channel config
|
||||
2. Add the bot to a Feishu group
|
||||
3. @mention the bot in the group to trigger a response
|
||||
|
||||
By default, the bot requires an @mention in group chats (`requireMention: true`). Set `"requireMention": false` for a specific group to make it respond to all messages.
|
||||
|
||||
## Features
|
||||
|
||||
### Interactive Card Streaming
|
||||
|
||||
Responses are rendered as Feishu interactive cards with real-time streaming updates. The card shows a "generating" indicator while the response is being produced, and a **Stop** button to cancel generation.
|
||||
|
||||
### Quote/Reply Context
|
||||
|
||||
When you reply to (quote) a message, the quoted content is automatically included as context for the agent. This works for:
|
||||
|
||||
- Text and rich-text messages
|
||||
- Interactive cards (bot's previous responses)
|
||||
|
||||
### Images and Files
|
||||
|
||||
You can send photos and documents to the bot:
|
||||
|
||||
- **Images:** Analyzed using multimodal vision capabilities
|
||||
- **Files:** Downloaded and saved locally for the agent to read
|
||||
|
||||
### Concurrent Messages
|
||||
|
||||
Multiple users can send messages simultaneously in the same group chat. Each message gets its own independent card and response — they don't interfere with each other.
|
||||
|
||||
## Key Differences from DingTalk
|
||||
|
||||
- **Response format:** Uses Feishu interactive cards (v2 schema) with native markdown rendering, including tables
|
||||
- **Streaming:** Card content is updated in-place with throttled PATCH requests (1.5s interval)
|
||||
- **Connection:** WebSocket via `@larksuiteoapi/node-sdk` — same outbound-only model, no public URL needed
|
||||
- **Working indicator:** An "OnIt" emoji reaction is added while processing
|
||||
- **Quote context:** Supports quoting both text messages and interactive cards
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Bot doesn't connect
|
||||
|
||||
- Verify your App ID and App Secret are correct
|
||||
- Make sure **Long Connection** is selected in Event Subscriptions
|
||||
- Check that the `im.message.receive_v1` event is subscribed
|
||||
- Check the terminal output for connection errors
|
||||
|
||||
### Bot doesn't respond in groups
|
||||
|
||||
- Check that `groupPolicy` is set to `"allowlist"` or `"open"` (default is `"disabled"`)
|
||||
- Make sure you @mention the bot in the group message
|
||||
- Verify the bot has been added to the group
|
||||
|
||||
### Card stays in "generating" state
|
||||
|
||||
- This usually indicates the response completed but the final card update failed
|
||||
- Check terminal logs for API errors (rate limiting, card size limits)
|
||||
- Very long responses with many tables may hit Feishu's card element limits
|
||||
|
||||
### Quote doesn't include card content
|
||||
|
||||
- The bot reads card content via the `card_msg_content_type=user_card_content` API parameter
|
||||
- Ensure the bot has `im:message` permission to read messages
|
||||
@ -238,9 +238,41 @@ Key command-line options for headless usage:
|
||||
| `--approval-mode` | Set approval mode | `qwen -p "query" --approval-mode auto_edit` |
|
||||
| `--continue` | Resume the most recent session for this project | `qwen --continue -p "Pick up where we left off"` |
|
||||
| `--resume [sessionId]` | Resume a specific session (or choose interactively) | `qwen --resume 123e... -p "Finish the refactor"` |
|
||||
| `--max-session-turns` | Cap the number of user/model/tool turns in the run | `qwen -p "..." --max-session-turns 30` |
|
||||
| `--max-wall-time` | Wall-clock budget; accepts `90` (s), `30s`, `5m`, `1h`, `1.5h` | `qwen -p "..." --max-wall-time 10m` |
|
||||
| `--max-tool-calls` | Cumulative tool-call budget for the run | `qwen -p "..." --max-tool-calls 50` |
|
||||
|
||||
For complete details on all available configuration options, settings files, and environment variables, see the [Configuration Guide](../configuration/settings).
|
||||
|
||||
## Safety in unattended runs
|
||||
|
||||
Headless / CI runs combined with `--yolo` (or `--approval-mode=yolo`) auto-approve every tool call, including `shell`, `write`, and `edit`. **`--yolo` does not enable a sandbox** — those tools run at the host process's privilege level. When Qwen Code detects this combination with no sandbox configured, it prints a one-line warning to stderr at startup. Suppress the warning with `QWEN_CODE_SUPPRESS_YOLO_WARNING=1` once you've reviewed the trade-off.
|
||||
|
||||
### Run-level budgets
|
||||
|
||||
Qwen Code can abort an unattended run when it crosses one of the following thresholds. Each is `-1` (unlimited) by default; setting any one is enough to bound runaway behavior. They are enforced cooperatively against the same `AbortController` that already carries SIGINT, so a budget abort emits a structured `FatalBudgetExceededError` (exit code **55**) — distinct from the turn-cap exit code 53 and SIGINT's 130 so CI scripts can branch on the reason.
|
||||
|
||||
| Flag | Settings key | What it bounds |
|
||||
| --------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--max-wall-time` | `model.maxWallTimeSeconds` | Wall-clock duration of the whole run. Flag accepts `90` (s), `30s`, `5m`, `1h`, `1.5h` (fractional units supported). Minimum 1s — sub-second values are rejected as typos. Settings is seconds. |
|
||||
| `--max-tool-calls` | `model.maxToolCalls` | Cumulative top-level tool calls dispatched by the main run loop (counts successes _and_ failures — the model still consumes tokens on errors). See "Scope" below for subagent / structured-output exemptions. |
|
||||
| `--max-session-turns` | `model.maxSessionTurns` | Number of user/model/tool turns; pre-existing. Exits with code 53 on overrun (distinct from budget exit 55). |
|
||||
|
||||
#### Scope
|
||||
|
||||
- **`--max-tool-calls` counts top-level dispatches only.** When the model calls the `agent` tool, the dispatch counts as **1**; inner tool calls performed by the spawned subagent are **not** counted. A model that funnels work through subagents can do unbounded inner work under a small top-level budget. Combine with `--exclude-tools agent` if you need a tighter cap.
|
||||
- **`structured_output` is exempt from `--max-tool-calls`.** Under `--json-schema`, the model's terminal `structured_output` call is the "I'm done" contract, not real work — it doesn't count against `--max-tool-calls` so a budget-edge completion isn't aborted as a false positive. The exemption is unconditional (including failed Ajv validations), so a model stuck in a malformed-output retry loop is NOT bounded by `--max-tool-calls`; combine with `--max-session-turns` or `--max-wall-time` to cap retries.
|
||||
- **`structured_output` is NOT exempt from `--max-session-turns`.** That counter is pre-existing and bumps for every turn including the terminal contract. Size `--max-session-turns` to `N+1` if you want to allow `N` real-work turns under `--json-schema`.
|
||||
- **Single-shot vs `--input-format stream-json`:** in stream-json input mode the daemon resets the budget counters at the start of every user message; the budget is per-message, not per-process.
|
||||
- **`qwen serve` / ACP sessions:** the daemon ACP session path does NOT currently consult `--max-wall-time` / `--max-tool-calls` from settings.json. These budgets only apply to single-shot `qwen -p` runs and to `--input-format stream-json` sessions. (`qwen serve` does emit the YOLO-no-sandbox warning at boot if `tools.approvalMode: 'yolo'` is set in settings.)
|
||||
|
||||
### Recommended combinations
|
||||
|
||||
- **Trusted, isolated environment (ephemeral CI runner, container):** `qwen -p "..." --yolo --max-session-turns N --max-wall-time 10m --output-format json`. Pin a turn budget and a wall-clock budget so a stuck agent can't burn through your CI minutes, and capture `--output-format json` for post-run usage / tool-call auditing.
|
||||
- **Local machine or shared infra:** also pass `--sandbox` (or set `QWEN_SANDBOX=1`) so shell / write / edit tools run inside the sandbox image.
|
||||
- **Long-running CI with retry-on-rate-limit:** combine `QWEN_CODE_UNATTENDED_RETRY=1` with `--max-wall-time`. The retry env keeps the run alive past transient 429 / 529 responses; the wall-clock budget ensures a persistently-failing provider can't extend the job indefinitely.
|
||||
- **Bounded auditing / exploration:** for read-only tasks, `--max-tool-calls 25` caps how aggressively the model can grep / read. Combine with `--exclude-tools shell,write,edit` to make the bound meaningful.
|
||||
|
||||
## Examples
|
||||
|
||||
### Code review
|
||||
|
||||
@ -24,15 +24,32 @@ Don't include things Qwen can figure out by reading your code. QWEN.md works bes
|
||||
|
||||
### Where to create QWEN.md
|
||||
|
||||
| File | Who it applies to |
|
||||
| ----------------------------- | --------------------------------------------- |
|
||||
| `~/.qwen/QWEN.md` | You, across all your projects |
|
||||
| `QWEN.md` in the project root | Your whole team (commit it to source control) |
|
||||
| File | Who it applies to |
|
||||
| ----------------------------- | ------------------------------------------------ |
|
||||
| `~/.qwen/QWEN.md` | You, across all your projects |
|
||||
| `QWEN.md` in the project root | Your whole team (commit it to source control) |
|
||||
| `.qwen/QWEN.local.md` | Only you, only in this project (keep out of git) |
|
||||
|
||||
You can have both. Qwen loads all QWEN.md files it finds when you start a session — your personal one plus any in the project.
|
||||
You can have any combination of these. Qwen loads all of them when you start a session.
|
||||
|
||||
If your repository already has an `AGENTS.md` file for other AI tools, Qwen reads that too. No need to duplicate instructions.
|
||||
|
||||
#### When to use `.qwen/QWEN.local.md`
|
||||
|
||||
Use it for **project-specific but personal** instructions — things that belong to this project but shouldn't be shared with the team:
|
||||
|
||||
- Your own cluster ID, container registry namespace, or cloud account
|
||||
- A personal debug command that hardcodes your local environment
|
||||
- Notes you want Qwen to know about your work-in-progress, but not commit
|
||||
|
||||
It loads **after** the shared project `QWEN.md`, so your local instructions can supplement or override the team's.
|
||||
|
||||
**You must gitignore it yourself.** Although `.qwen/` is often treated as a local directory, qwen-code does not generate a `.gitignore` for you, and some projects commit `.qwen/settings.json`. Add this line to your `.gitignore` (or to your global git ignore):
|
||||
|
||||
```
|
||||
.qwen/QWEN.local.md
|
||||
```
|
||||
|
||||
### Generate one automatically with `/init`
|
||||
|
||||
Run `/init` and Qwen will analyze your codebase to create a starter QWEN.md with build commands, test instructions, and conventions it finds. If one already exists, it suggests additions instead of overwriting.
|
||||
|
||||
345
docs/users/features/worktree.md
Normal file
345
docs/users/features/worktree.md
Normal file
@ -0,0 +1,345 @@
|
||||
# Worktrees
|
||||
|
||||
> Isolate experimental work in a temporary [git worktree](https://git-scm.com/docs/git-worktree) without leaving your current session. Useful when the model is about to make wide-ranging edits you want to keep separate from your main checkout, or when you want a subagent to work in a sandbox of its own.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Start the session inside a worktree (`--worktree` flag)
|
||||
|
||||
If you know up front that the entire session should run inside a worktree, pass `--worktree` at launch:
|
||||
|
||||
```bash
|
||||
# Auto-generated slug (e.g. tender-jemison-037f0a)
|
||||
qwen --worktree
|
||||
|
||||
# Explicit name
|
||||
qwen --worktree my-feature
|
||||
|
||||
# `=` form (recommended when also passing a positional prompt — see tip below)
|
||||
qwen --worktree=my-feature
|
||||
|
||||
# PR reference — fetches refs/pull/<N>/head from `origin`
|
||||
qwen --worktree=#4174
|
||||
qwen --worktree https://github.com/QwenLM/qwen-code/pull/4174
|
||||
|
||||
# Continue a previous --worktree session — re-attaches to the existing dir
|
||||
qwen --resume <session-id> --worktree=my-feature
|
||||
```
|
||||
|
||||
> **Tip — bare `--worktree` followed by a positional prompt is ambiguous.** Because `--worktree` takes an optional value, `qwen --worktree "say hi"` makes yargs consume `"say hi"` as the slug (and reject it because of the space). Use one of:
|
||||
>
|
||||
> - `qwen --worktree=my-feature "say hi"` (always works — explicit slug via `=`)
|
||||
> - `qwen "say hi" --worktree` (positional first, flag at the end → auto slug)
|
||||
> - `qwen --worktree --approval-mode yolo "say hi"` (any flag between them anchors the bare form)
|
||||
|
||||
> **Tip — `qwen --resume --worktree foo` (no session ID) shows an empty picker on first use.** The picker scopes to the chosen worktree's session storage; sessions started outside that worktree are not listed. To resume a session that was started inside `foo`, use `qwen --resume <id> --worktree foo` directly — the CLI re-attaches to the existing `foo/` directory rather than re-creating it.
|
||||
|
||||
`process.cwd()` and the model's workspace are switched to the worktree before the first turn runs. Exit with `Ctrl+C` twice and the [Exit Dialog](#exit-dialog-ctrlc--ctrld) prompts to keep or remove the worktree.
|
||||
|
||||
The `--worktree` flag cannot be combined with `--acp`/`--experimental-acp` — for ACP hosts (like Zed), pass the worktree path as the `cwd` of the `loadSession`/`newSession` request instead.
|
||||
|
||||
### Or ask mid-session
|
||||
|
||||
Alternatively, ask Qwen Code in plain language to create a worktree from inside an existing session:
|
||||
|
||||
```text
|
||||
> start a worktree called experiment-a
|
||||
Worktree experiment-a created on branch worktree-experiment-a
|
||||
.qwen/worktrees/experiment-a
|
||||
```
|
||||
|
||||
From this point on, the model routes every file edit and shell command through `.qwen/worktrees/experiment-a/`. Your original working directory is untouched.
|
||||
|
||||
When you are done:
|
||||
|
||||
```text
|
||||
> exit the worktree and remove it
|
||||
Removed worktree experiment-a (branch worktree-experiment-a)
|
||||
```
|
||||
|
||||
If you want to come back later, ask to exit with the worktree kept on disk instead:
|
||||
|
||||
```text
|
||||
> exit the worktree but keep it
|
||||
Kept worktree experiment-a at .qwen/worktrees/experiment-a
|
||||
```
|
||||
|
||||
## When Worktrees Are Used
|
||||
|
||||
Worktrees are activated in four independent paths:
|
||||
|
||||
| Trigger | What happens |
|
||||
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| You launch with `--worktree` | The CLI creates the worktree before any model turn runs and chdirs the session into it. PR forms (`#N`, full URL) fetch first. |
|
||||
| You explicitly ask for a worktree mid-session | Model calls `enter_worktree`; subsequent file edits go inside it. |
|
||||
| You explicitly ask to leave | Model calls `exit_worktree` with `keep` or `remove`. |
|
||||
| Model spawns a sub-agent with isolation enabled | A throwaway worktree (`agent-<hex>`) is created automatically and cleaned up if the agent has no diffs. |
|
||||
|
||||
The two mid-session tools (`enter_worktree` / `exit_worktree`) are deliberately gated behind explicit phrasing — saying "fix this bug" or "create a branch" will **not** trigger them. You must say something like "use a worktree", "start a worktree", or "in a worktree". The `--worktree` CLI flag has no such guard; it always creates one when present.
|
||||
|
||||
## What Gets Created
|
||||
|
||||
Every Qwen-managed worktree is placed under your project's `.qwen` directory:
|
||||
|
||||
```
|
||||
<repoRoot>/.qwen/worktrees/<slug>/ # Working directory
|
||||
↳ branch worktree-<slug> # Created off your current branch
|
||||
```
|
||||
|
||||
- **Slug** — letters, digits, dot, underscore, hyphen; max 64 chars. If you don't specify a name, an `<adjective>-<noun>-<6hex>` slug is auto-generated (e.g. `tender-jemison-037f0a`). PR references produce `pr-<N>`.
|
||||
- **Branch** — always `worktree-<slug>`, branched from whichever branch you have checked out when you ask for the worktree (not necessarily the main working tree's `HEAD`). For PR worktrees the branch is `worktree-pr-<N>` and is based on `FETCH_HEAD` (the PR's tip on the GitHub side) rather than your local branch.
|
||||
- **Hooks** — the worktree's `core.hooksPath` is automatically pointed at the main repo's `.husky/` (preferred) or `.git/hooks/` so commits inside the worktree still trigger your existing pre-commit / commit-msg hooks.
|
||||
- **Optional symlinks** — directories listed in `worktree.symlinkDirectories` (see [Settings](#settings)) are symlinked from the main repo into the new worktree so heavy dirs like `node_modules` can be reused without reinstalling.
|
||||
|
||||
The general-purpose worktree path is **not configurable** — it must live under `<repoRoot>/.qwen/worktrees/` so the CLI can find it on restart and on stale-cleanup sweeps. (The unrelated `agents.arena.worktreeBaseDir` setting controls only [Agent Arena](./arena.md) worktrees, which use a separate path tree under `~/.qwen/arena/`.)
|
||||
|
||||
## Footer and Status Line
|
||||
|
||||
When a worktree is active, the Footer shows a dim indicator on its own row:
|
||||
|
||||
```
|
||||
⎇ worktree-experiment-a (experiment-a)
|
||||
```
|
||||
|
||||
If you use a [custom status line script](./status-line.md), it also receives a `worktree` object in the JSON payload piped to stdin:
|
||||
|
||||
```json
|
||||
{
|
||||
"worktree": {
|
||||
"name": "experiment-a",
|
||||
"path": "/path/to/repo/.qwen/worktrees/experiment-a",
|
||||
"branch": "worktree-experiment-a",
|
||||
"original_cwd": "/path/to/repo",
|
||||
"original_branch": "main"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The payload field is present **only** when a worktree is active, so a `null`-check (`input.worktree?.name`) is enough.
|
||||
|
||||
If your custom status line already renders worktree info, you can hide the built-in Footer row to avoid duplication — see [Settings](#settings) below.
|
||||
|
||||
## Exit Dialog (Ctrl+C / Ctrl+D)
|
||||
|
||||
Pressing the quit shortcut twice while a worktree is active opens the **Worktree Exit Dialog** instead of closing the CLI:
|
||||
|
||||
```
|
||||
⎇ Active worktree: "experiment-a" (worktree-experiment-a)
|
||||
|
||||
• 2 new commit(s) on worktree-experiment-a
|
||||
• 3 uncommitted file(s)
|
||||
Removing the worktree will discard everything above.
|
||||
|
||||
What would you like to do?
|
||||
○ Keep worktree (exit without deleting)
|
||||
○ Remove worktree and branch (discards 2 commit(s), 3 file(s))
|
||||
○ Cancel (stay in session)
|
||||
```
|
||||
|
||||
The dialog inspects the worktree on open (`git status --porcelain` + `git rev-list <baseHEAD>..HEAD`) and surfaces both counts so you know exactly what you'd be discarding. `ESC` cancels.
|
||||
|
||||
If `git status` itself fails (e.g. corrupt index, worktree directory was removed under the CLI), the dialog shows a `⚠ Could not measure worktree state` warning and the counts may be unreliable — choose **Keep** or **Cancel** until you've diagnosed the underlying repo problem.
|
||||
|
||||
## `--resume` Restore
|
||||
|
||||
The active worktree binding is persisted to a sidecar file alongside your session transcript:
|
||||
|
||||
```
|
||||
<chatsDir>/<sessionId>.worktree.json
|
||||
```
|
||||
|
||||
When you launch the CLI with `--resume <sessionId>` (or pick the session from `/resume`), three things happen consistently across **interactive TUI**, **headless `-p`**, and **ACP/Zed** modes:
|
||||
|
||||
1. The sidecar is loaded and the worktree directory is verified to still exist on disk.
|
||||
2. If alive, the model receives a one-shot reminder on its very next prompt:
|
||||
```
|
||||
[Resumed] Active worktree: "<slug>" at <path> (branch: <branch>). Continue using this path for all file operations.
|
||||
```
|
||||
3. If the worktree directory was deleted between sessions, the stale sidecar is cleaned up automatically — no error, the resume just continues without worktree context.
|
||||
|
||||
Each mode chooses its own injection mechanism, but the user-visible behavior is identical:
|
||||
|
||||
| Mode | Mechanism |
|
||||
| ----------------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| Interactive (TUI) | `INFO` history item + system-reminder prefix on the next user prompt. |
|
||||
| Headless (`-p`) | `<system-reminder>` prefix on the prompt + `worktree_restored` JSON system event in the output stream. |
|
||||
| ACP (e.g. Zed) | Pending notice attached to the next `prompt()` call. |
|
||||
|
||||
The model is **not** automatically `chdir`'d into the worktree — the reminder is what keeps it routing edits through the worktree path.
|
||||
|
||||
## Sub-Agent Isolation
|
||||
|
||||
The `agent` tool accepts an optional `isolation: "worktree"` parameter. When set, Qwen Code creates an ephemeral worktree at `<repoRoot>/.qwen/worktrees/agent-<7hex>/` before the sub-agent starts, and:
|
||||
|
||||
- **No changes** → the worktree is automatically removed when the agent finishes.
|
||||
- **Has changes** → the worktree is preserved; its path and branch are appended to the agent's result, e.g.
|
||||
```
|
||||
…agent output…
|
||||
[worktree preserved: /path/to/.qwen/worktrees/agent-3f2a1b9 (branch worktree-agent-3f2a1b9)]
|
||||
```
|
||||
Review the diff and merge or delete it manually.
|
||||
|
||||
Two constraints:
|
||||
|
||||
- `isolation: "worktree"` requires a `subagent_type` — forked sub-agents (no `subagent_type`) reuse the parent's full conversation context, so isolating them would split intent from working tree.
|
||||
- Background agents (`run_in_background: true`) work fine with isolation; the cleanup runs when the agent reports completion.
|
||||
|
||||
### Automatic Stale Cleanup
|
||||
|
||||
Ephemeral agent worktrees that survived a crash or `--no-cleanup` shutdown are reaped on every CLI startup, with conservative fail-closed rules:
|
||||
|
||||
| Guard | Behavior |
|
||||
| -------------------------------------- | ---------------------------------------------- |
|
||||
| Slug must match `agent-<7hex>` pattern | Named worktrees you created are never touched. |
|
||||
| Directory `mtime` > 30 days | Newer entries are skipped. |
|
||||
| Any uncommitted tracked change | Skip the entry (don't delete). |
|
||||
| Any commit not reachable from a remote | Skip the entry (don't delete). |
|
||||
| Any error reading git state | Skip the entry (don't delete). |
|
||||
|
||||
Named user worktrees (`enter_worktree` slugs) are **never** auto-cleaned — you keep them around until you ask to remove them.
|
||||
|
||||
## Safety Guards on `exit_worktree action="remove"`
|
||||
|
||||
Three independent guards trigger before the directory and branch are deleted:
|
||||
|
||||
1. **Session ownership** — each worktree carries a sidecar marker with the session ID that created it. A different session trying to remove it is refused with a clear error pointing at `git worktree remove` for the manual escape hatch.
|
||||
2. **Dirty working tree** — uncommitted tracked or untracked changes block removal. Pass `discard_changes: true` to override. (Bypass requires explicit user confirmation — `action: "remove"` is never auto-approved in AUTO_EDIT mode.)
|
||||
3. **Unmerged commits** — commits on `worktree-<slug>` that no other local branch or remote ref points at block removal unconditionally; there is no "discard commits" flag because losing committed work is rarely what users mean. Merge, push, or rename the branch elsewhere first.
|
||||
|
||||
The same three guards apply to the `WorktreeExitDialog → Remove` button.
|
||||
|
||||
## Settings
|
||||
|
||||
Two settings shape the general-purpose worktree experience:
|
||||
|
||||
| Key | Type | Default | Effect |
|
||||
| --------------------------------- | ---------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ui.hideBuiltinWorktreeIndicator` | boolean | `false` | Hides the built-in `⎇ worktree-… (…)` Footer row. The `worktree` field is still delivered to custom status line scripts. Set to `true` only if your status line already renders the worktree — otherwise you lose all UI affordance. |
|
||||
| `worktree.symlinkDirectories` | `string[]` | `undefined` | Directories under the main repo to symlink into every general-purpose worktree on creation. Paths are relative to the repo root; absolute paths and any entry containing `..` are rejected. Missing sources and existing destinations are silently skipped (no overwrite). |
|
||||
|
||||
Example:
|
||||
|
||||
```jsonc
|
||||
// ~/.qwen/settings.json or <repo>/.qwen/settings.json
|
||||
{
|
||||
"worktree": {
|
||||
"symlinkDirectories": ["node_modules", ".turbo", "dist"],
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Applies to ALL worktree-creation paths: `--worktree` flag, `enter_worktree` tool, and `agent isolation: "worktree"`.
|
||||
|
||||
Settings unrelated to general worktrees but worth knowing about:
|
||||
|
||||
- `agents.arena.worktreeBaseDir` — controls **Agent Arena** worktree placement (default `~/.qwen/arena`). Does not affect general-purpose worktrees, which always live under `<repoRoot>/.qwen/worktrees/`.
|
||||
|
||||
There is no schema for `worktree.sparsePaths` yet — that's a roadmap item (see [Limitations](#limitations)).
|
||||
|
||||
## Tool Reference
|
||||
|
||||
### `enter_worktree`
|
||||
|
||||
```json
|
||||
{ "name": "experiment-a" }
|
||||
```
|
||||
|
||||
| Field | Type | Required | Notes |
|
||||
| ------ | ------ | -------- | ------------------------------------------------------------------------------------------ |
|
||||
| `name` | string | no | Slug. Letters, digits, dot, underscore, hyphen; max 64 chars. Auto-generated when omitted. |
|
||||
|
||||
Refuses to run when:
|
||||
|
||||
- The CLI is not in a git repository.
|
||||
- The current working directory is already inside `.qwen/worktrees/` (no nested worktrees).
|
||||
|
||||
### `exit_worktree`
|
||||
|
||||
```json
|
||||
{ "name": "experiment-a", "action": "remove", "discard_changes": false }
|
||||
```
|
||||
|
||||
| Field | Type | Required | Notes |
|
||||
| ----------------- | ---------------------- | ------------------------------------- | ------------------------------------------------------------------ |
|
||||
| `name` | string | yes | Must match the slug used in `enter_worktree`. |
|
||||
| `action` | `"keep"` \| `"remove"` | yes | `keep` preserves dir + branch; `remove` deletes both. |
|
||||
| `discard_changes` | boolean | only when `action="remove"` and dirty | Overrides the dirty-tree guard. Has no effect for `action="keep"`. |
|
||||
|
||||
`action: "remove"` always prompts for confirmation, including under `AUTO_EDIT` approval mode — it is treated as a destructive shell operation, not an info-only tool.
|
||||
|
||||
### `agent` — `isolation` parameter
|
||||
|
||||
```json
|
||||
{
|
||||
"subagent_type": "my-agent",
|
||||
"description": "…",
|
||||
"prompt": "…",
|
||||
"isolation": "worktree"
|
||||
}
|
||||
```
|
||||
|
||||
| Field | Type | Required | Notes |
|
||||
| ----------- | ------------ | -------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `isolation` | `"worktree"` | no | Runs the agent in a fresh `agent-<7hex>` worktree. Requires `subagent_type` to be set (no forks). |
|
||||
|
||||
See [Sub-Agents](./sub-agents.md) for the rest of the agent tool reference.
|
||||
|
||||
## CLI Reference
|
||||
|
||||
### `--worktree [name | #N | url]`
|
||||
|
||||
```bash
|
||||
qwen --worktree # auto-generate slug
|
||||
qwen --worktree my-feature # explicit slug
|
||||
qwen --worktree=my-feature # = form
|
||||
qwen --worktree=#123 # PR reference
|
||||
qwen --worktree https://github.com/owner/repo/pull/123 # PR URL
|
||||
```
|
||||
|
||||
| Input | Result |
|
||||
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| Bare flag (no value) | Auto slug `<adjective>-<noun>-<6hex>`, branch `worktree-<slug>`, base = current branch. |
|
||||
| Plain slug | Branch `worktree-<slug>`, base = current branch. Slug validation: letters/digits/dot/underscore/hyphen, max 64 chars. |
|
||||
| `#N` or `<github-url>/pull/N` | Slug `pr-<N>`, branch `worktree-pr-<N>`, base = `FETCH_HEAD` after `git fetch origin pull/<N>/head` (30s timeout). |
|
||||
|
||||
`--worktree` cannot be combined with `--acp` / `--experimental-acp`.
|
||||
|
||||
When `--worktree` is combined with `--resume <session-id>`, the worktree wins: the resumed session's saved worktree (if any) is overridden and a stderr line + first-prompt reminder report the override.
|
||||
|
||||
For interactive (TUI) and headless (`-p`) modes the worktree is automatically created and the session chdirs into it before the first turn.
|
||||
|
||||
PR-fetch failure modes (exit code != 0, no worktree created):
|
||||
|
||||
| Cause | Message excerpt |
|
||||
| ----------------------------- | ---------------------------------------------------------- |
|
||||
| Missing `origin` remote | `requires an "origin" remote that points at GitHub` |
|
||||
| PR doesn't exist on origin | `Failed to fetch PR #<N>: the PR does not exist on origin` |
|
||||
| 30s network timeout | `Failed to fetch PR #<N>: timed out after 30s` |
|
||||
| PR number out of range / zero | `Invalid PR number` |
|
||||
|
||||
## Limitations
|
||||
|
||||
The following items are intentionally not implemented in the current phase:
|
||||
|
||||
- **No sparse checkout.** Large monorepos check out the full tree. (`worktree.sparsePaths` is a roadmap item.)
|
||||
- **No tmux integration.** The CLI does not spawn worktree sessions in new tmux windows.
|
||||
- **Worktrees are separate "projects" for session storage.** Sessions started with `--worktree foo` are saved under that worktree's chats dir; to resume them later you must pass `--worktree foo` again. Sessions started without `--worktree` are saved under the main checkout and won't appear in the worktree's resume picker.
|
||||
- **No cross-slug session override.** `qwen --resume <sid> --worktree second` where `<sid>` was created with `--worktree first` will fail to find the session — sessions and worktrees are tightly bound by `projectHash(cwd)`. To switch worktrees on an existing session you must exit, then re-launch with the new `--worktree` and a fresh prompt. A future architectural change (anchoring storage at the repo root instead of `cwd`) would lift this constraint.
|
||||
- **Mid-session `enter_worktree` does NOT switch `process.cwd()` or `Config.targetDir`.** That tool uses the model-context-only convention (see [Sub-Agents](./sub-agents.md)). Only the startup `--worktree` flag actually switches the process working directory.
|
||||
- **Relative paths in other arg fields are resolved BEFORE the worktree chdir.** Path-taking flags (`--mcp-config`, `--openai-logging-dir`, `--json-file`, `--input-file`, `--telemetry-outfile`, `--include-directories`) are normalized to absolute paths against the launch cwd when `--worktree` is set. Other path-shaped argv fields not in this list still resolve against the worktree cwd — use absolute paths to be safe.
|
||||
|
||||
Track the roadmap in `docs/design/worktree.md`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**The Footer shows no worktree indicator even though I just created one.**
|
||||
Check that `ui.hideBuiltinWorktreeIndicator` is not set to `true`. Also confirm the slug is non-empty in the tool's success message.
|
||||
|
||||
**`--resume` does not restore my worktree.**
|
||||
Check `<chatsDir>/<sessionId>.worktree.json` exists. The CLI deletes the sidecar automatically when the worktree directory is gone, so a missing sidecar plus a missing directory is the normal "no worktree to restore" state — not a bug. Run with `--debug` and grep for `restoreWorktreeContext` to see the reason.
|
||||
|
||||
**`exit_worktree` says "created by a different session".**
|
||||
This is the session-ownership guard. Resume the original session and exit from there, or run the suggested `git worktree remove …` command manually.
|
||||
|
||||
**Stale `agent-<hex>` worktrees keep piling up.**
|
||||
The 30-day cutoff is conservative; sweep manually with `git worktree list && git worktree remove <path>`, or wait — the next CLI startup after the 30-day mark will reap them as long as they are clean and pushed.
|
||||
120
docs/verification/abort-controller-refactor/README.md
Normal file
120
docs/verification/abort-controller-refactor/README.md
Normal file
@ -0,0 +1,120 @@
|
||||
# AbortController refactor — verification plan
|
||||
|
||||
Scenarios used to validate the change manually before opening the PR. Each
|
||||
scenario captures its tmux pane via `tmux pipe-pane -o 'cat >> <log>'`.
|
||||
|
||||
## Setup once
|
||||
|
||||
```sh
|
||||
# Point WT at your local checkout of the branch under review.
|
||||
WT=/path/to/qwen-code/worktree
|
||||
LOGDIR=$WT/docs/verification/abort-controller-refactor/logs
|
||||
mkdir -p "$LOGDIR"
|
||||
|
||||
# Build the CLI once (skip sandbox image, skip vscode).
|
||||
( cd "$WT" && npm run build:packages )
|
||||
```
|
||||
|
||||
## Scenarios
|
||||
|
||||
For each scenario:
|
||||
|
||||
```sh
|
||||
tmux new-session -d -s qwen-verify-XX
|
||||
tmux pipe-pane -t qwen-verify-XX -o "cat >> $LOGDIR/XX-name.log"
|
||||
tmux send-keys -t qwen-verify-XX "cd /path/to/your/test/workspace && exec node $WT/packages/cli/dist/index.js" C-m
|
||||
tmux attach -t qwen-verify-XX
|
||||
```
|
||||
|
||||
Then drive the session manually per the matrix below. Hit `C-b d` to detach
|
||||
when done; `tmux kill-session -t qwen-verify-XX` to stop the pane.
|
||||
|
||||
### 00 — Baseline (PRE-fix)
|
||||
|
||||
- **Setup:** check out `main`, build, run with `NODE_OPTIONS=--trace-warnings`.
|
||||
- **Input:** long 50-round mixed-tool session (shell + edit + grep + agent).
|
||||
- **Expected:** after ~30–40 rounds, `MaxListenersExceededWarning: ... 1500+ abort listeners added to [AbortSignal]` printed to stderr.
|
||||
- **Log:** `00-baseline-reproduction.log`.
|
||||
|
||||
### 01 — Long-session, DEBUG mode (this branch)
|
||||
|
||||
- **Setup:** `NODE_OPTIONS=--trace-warnings DEBUG=1 qwen`.
|
||||
- **Input:** same 50-round script as #00.
|
||||
- **Expected:** no `MaxListenersExceededWarning` printed; any other warnings still print.
|
||||
- **Log:** `01-long-session-debug.log`.
|
||||
|
||||
### 02 — Long-session, prod mode (this branch)
|
||||
|
||||
- **Setup:** `qwen` (no debug env).
|
||||
- **Input:** same 50-round script.
|
||||
- **Expected:** clean output; a temporary `console.error` probe inside the handler (added then removed) confirms the filter fires.
|
||||
- **Log:** `02-long-session-prod.log`.
|
||||
|
||||
### 03 — Ctrl-C mid-stream abort
|
||||
|
||||
- **Setup:** this branch, interactive.
|
||||
- **Input:** ask for a long generation (>30s); press Ctrl-C mid-stream.
|
||||
- **Expected:** stream stops within ~200ms, "Cancelled" banner shown, next prompt accepts input. `process._getActiveHandles()` count returns to baseline (use `:debug handles`).
|
||||
- **Log:** `03-ctrlc-streaming.log`.
|
||||
|
||||
### 04 — Cancel long-running shell
|
||||
|
||||
- **Setup:** this branch.
|
||||
- **Input:** run `sleep 60` via the shell tool; cancel mid-execution.
|
||||
- **Expected:** child process killed (verify with `pgrep -f sleep` returning empty), tool result shows cancellation, agent accepts next prompt.
|
||||
- **Log:** `04-shell-cancel.log`.
|
||||
|
||||
### 05 — Subagent cancellation
|
||||
|
||||
- **Setup:** this branch.
|
||||
- **Input:** spawn a long agent task via the agent tool; cancel from parent.
|
||||
- **Expected:** subagent's in-flight tool calls abort, subagent's model stream stops, parent receives cancellation event.
|
||||
- **Log:** `05-subagent-cancel.log`.
|
||||
|
||||
### 06 — Headless / non-interactive abort
|
||||
|
||||
- **Setup:** `qwen --prompt "do a long task"`; send `SIGINT` from outside via `kill -INT <pid>`.
|
||||
- **Expected:** clean shutdown, exit code 130, no warnings.
|
||||
- **Log:** `06-headless-abort.log`.
|
||||
|
||||
### 07 — Background agent flow
|
||||
|
||||
- **Setup:** interactive.
|
||||
- **Input:** spawn a background agent (`run_in_background: true`); let it complete; spawn a second one; cancel the second mid-flight.
|
||||
- **Expected:** first agent completes normally; second aborts cleanly; no listener leak across the two.
|
||||
- **Log:** `07-background-agent.log`.
|
||||
|
||||
### 08 — Memory baseline
|
||||
|
||||
- **Setup:** `qwen --inspect`, attach Chrome devtools.
|
||||
- **Input:** 100-round session.
|
||||
- **Expected:** heap snapshots at round 0/50/100. `AbortSignal` instance count and per-signal listener count stable (no monotonic growth).
|
||||
- **Log:** `08-memory-snapshots/`.
|
||||
|
||||
### 09 — Existing combinedAbortSignal consumer
|
||||
|
||||
- **Setup:** trigger an HTTP hook with both an external signal and timeout.
|
||||
- **Input:** (a) cancel external signal mid-hook; (b) let timeout fire in a separate run.
|
||||
- **Expected:** hook aborts cleanly in both cases; deprecation shim path is exercised.
|
||||
- **Log:** `09-http-hook-shim.log`.
|
||||
|
||||
## Automated (non-interactive) verifications
|
||||
|
||||
The automated checks below were run during development and recorded in
|
||||
`automated-results.md`:
|
||||
|
||||
- All abortController unit tests pass (`abortController.test.ts`, 26 tests; 1 GC test skipped under non-`--expose-gc`).
|
||||
- All warningHandler tests pass (`warningHandler.test.ts`, 13 tests including a spawned-child stderr integration test).
|
||||
- All `combineAbortSignals` consumer tests pass (`httpHookRunner.test.ts`); the deprecated `createCombinedAbortSignal` shim plus its own test file were removed once the lone caller migrated.
|
||||
- All agent runtime / followup / openaiContentGenerator / hooks tests pass.
|
||||
- Migration scope (intentional): only the agent-runtime parent→child chain (`agent-interactive.ts`, `agent-core.ts`, `agent-headless.ts`) plus `promptHookRunner.ts` (real cleanup leak) was switched to the helper. Independent short-lived controllers (per-shell-command, per-fetch, per-recall, etc.) stay on raw `new AbortController()` — they're GC'd quickly and don't accumulate listeners on a long-lived parent. See `migration-completeness.txt` for the captured grep + rationale.
|
||||
- TypeScript strict-mode typecheck passes for both `packages/core` and `packages/cli`.
|
||||
- Prettier check passes on all modified files.
|
||||
|
||||
See `automated-results.md` for the actual command output.
|
||||
|
||||
## How to capture the artifacts for the PR body
|
||||
|
||||
After running each scenario, attach the transcript file (or relevant excerpt)
|
||||
to the PR. For #08 (memory), export the heap snapshots and include the
|
||||
listener-count delta between snapshots.
|
||||
139
docs/verification/abort-controller-refactor/automated-results.md
Normal file
139
docs/verification/abort-controller-refactor/automated-results.md
Normal file
@ -0,0 +1,139 @@
|
||||
# Automated verification results
|
||||
|
||||
Captured 2026-05-20 during the AbortController refactor.
|
||||
|
||||
## 1. Listener-accumulation reproducer
|
||||
|
||||
Direct simulation of the listener-accumulation pattern observed in long
|
||||
sessions (1500+ abort listeners on a single AbortSignal). The script lives
|
||||
at `listener-accumulation-repro.mjs`.
|
||||
|
||||
```text
|
||||
$ node docs/verification/abort-controller-refactor/listener-accumulation-repro.mjs
|
||||
Simulating 2000 rounds for each pattern.
|
||||
|
||||
OLD pattern listener count on long-lived parent: 2000
|
||||
NEW pattern listener count on long-lived parent: 0
|
||||
PASS: OLD pattern accumulated >1500 listeners (reproduces the bug).
|
||||
PASS: NEW pattern kept listener count at 0 — the helper prevents accumulation.
|
||||
```
|
||||
|
||||
This is a self-contained proof: the OLD pattern (raw `addEventListener`
|
||||
without `{once:true}` or reverse cleanup) accumulates 2000 listeners over
|
||||
2000 rounds — well past the 1500 threshold the user observed. The NEW
|
||||
pattern (`createChildAbortController` from `packages/core/src/utils/abortController.ts`)
|
||||
keeps the parent listener count at 0 across 2000 rounds because each child's
|
||||
reverse-cleanup listener removes the parent listener when the child aborts.
|
||||
|
||||
## 2. Migration scope (intentional)
|
||||
|
||||
Only the agent-runtime parent→child chain that actually accumulates listeners
|
||||
on a long-lived parent signal is migrated to the helper:
|
||||
|
||||
- `packages/core/src/agents/runtime/agent-interactive.ts` (master + per-message round)
|
||||
- `packages/core/src/agents/runtime/agent-core.ts` (per-iteration round + waitForExternalInputs + processFunctionCalls try/finally)
|
||||
- `packages/core/src/agents/runtime/agent-headless.ts` (external → execution)
|
||||
- `packages/core/src/hooks/promptHookRunner.ts` (had a real cleanup leak: manual addEventListener without `{once:true}` and never removed)
|
||||
|
||||
Plus three `{once:true}`-only fixes (no helper switch, just defensive
|
||||
correctness):
|
||||
|
||||
- `packages/core/src/hooks/hookRunner.ts`
|
||||
- `packages/core/src/hooks/functionHookRunner.ts`
|
||||
- `packages/core/src/confirmation-bus/message-bus.ts`
|
||||
|
||||
Independent short-lived controllers (per-shell-command in `tools/shell.ts`,
|
||||
per-monitor in `tools/monitor.ts`, per-arena-session in
|
||||
`agents/arena/ArenaManager.ts`, per-recall in `core/client.ts`,
|
||||
per-fetch in `utils/fetch.ts`, per-dream / per-title / per-judge / per-resume,
|
||||
etc.) stay on raw `new AbortController()` — they're GC'd at end of use and
|
||||
do not accumulate on a long-lived parent.
|
||||
|
||||
See `migration-completeness.txt` for the actual grep + rationale.
|
||||
|
||||
## 3. Affected test suites
|
||||
|
||||
All 71 affected test files / 2085 tests pass (3 skipped — 1 is the GC test
|
||||
that requires `--expose-gc`, 2 are pre-existing skips in the headless suite).
|
||||
|
||||
```text
|
||||
Test Files 71 passed (71)
|
||||
Tests 2085 passed | 3 skipped (2088)
|
||||
Duration 16.71s
|
||||
```
|
||||
|
||||
Coverage:
|
||||
|
||||
- `packages/core/src/utils/abortController.test.ts` — 26 tests: factory cap (default + custom), child propagation, reverse cleanup, fast path, undefined parent, custom-maxListeners passthrough, `combineAbortSignals` semantics (incl. cleanup-cancels-timeout, timeout-cleans-input-listeners, `timeoutMs <= 0` boundary, mid-iteration defensive check), GC safety (best-effort).
|
||||
- `packages/cli/src/utils/warningHandler.test.ts` — 13 tests: idempotency, AbortSignal suppression (including `[AbortSignal{...}]` shape), generic EventTarget NOT suppressed, debug-mode passthrough, fan-out to prior listeners, spawned-child end-to-end stderr integration.
|
||||
- `packages/core/src/hooks/httpHookRunner.test.ts` — covers the migrated `combineAbortSignals` consumer (the deprecated `createCombinedAbortSignal` shim plus its test file were removed once the lone caller migrated).
|
||||
- `packages/core/src/agents/runtime/{agent-core,agent-interactive,agent-headless,agent-context,agent-statistics}.test.ts` — 102 tests covering the high-impact migrated files.
|
||||
- `packages/core/src/core/openaiContentGenerator/**` — 280+ tests including the pipeline that lost the `raiseAbortListenerCap` band-aid.
|
||||
- `packages/core/src/followup/**` — 100+ tests including the migrated speculation controller.
|
||||
- `packages/core/src/tools/agent/**`, `packages/core/src/tools/shell.test.ts`, `packages/core/src/services/**`, `packages/core/src/hooks/**`, `packages/core/src/confirmation-bus/**` — all migrated tool/hook/service files.
|
||||
|
||||
## 4. TypeScript strict-mode typecheck
|
||||
|
||||
```sh
|
||||
$ node_modules/.bin/tsc -p packages/core/tsconfig.json --noEmit
|
||||
(no output, exit 0)
|
||||
|
||||
$ node_modules/.bin/tsc -p packages/cli/tsconfig.json --noEmit
|
||||
(no output, exit 0)
|
||||
```
|
||||
|
||||
## 5. Prettier formatting
|
||||
|
||||
```sh
|
||||
$ node_modules/.bin/prettier --check packages/core/src/agents/runtime/agent-core.ts \
|
||||
packages/core/src/agents/runtime/agent-headless.ts \
|
||||
packages/cli/src/utils/warningHandler.ts \
|
||||
packages/cli/src/utils/warningHandler.test.ts \
|
||||
packages/core/src/utils/abortController.ts \
|
||||
packages/core/src/utils/abortController.test.ts
|
||||
Checking formatting...
|
||||
All matched files use Prettier code style!
|
||||
```
|
||||
|
||||
## 6. Build + binary smoke test
|
||||
|
||||
```sh
|
||||
$ npm run build:packages
|
||||
(succeeds for all 5 workspace packages)
|
||||
|
||||
$ NODE_OPTIONS=--trace-warnings node packages/cli/dist/index.js --version
|
||||
0.15.11
|
||||
EXIT=0
|
||||
|
||||
$ node packages/cli/dist/index.js --help
|
||||
Usage: qwen [options] [command]
|
||||
...
|
||||
```
|
||||
|
||||
No warnings emitted during boot with `--trace-warnings`.
|
||||
|
||||
## 7. Codex independent review
|
||||
|
||||
Two full passes via the `codex:codex-rescue` agent (independent context each
|
||||
time). First pass surfaced 3 issues — all addressed in subsequent commits:
|
||||
|
||||
1. **Throw between controller creation and explicit abort leaks listener** in
|
||||
`agent-core.ts`'s per-iteration body and `agent-headless.ts`'s
|
||||
pre-try-block setup. Fixed by wrapping each in `try { ... } finally {
|
||||
abortController.abort(); }`.
|
||||
2. **Warning suppressor regex `EventTarget` too broad**. Tightened to match
|
||||
only `AbortSignal` (any shape Node ≥20 produces).
|
||||
3. **`process.removeAllListeners('warning')` strips third-party listeners**.
|
||||
Removed — rely on Node's "no listeners → default printer fires" semantics
|
||||
so adding our handler implicitly disables the default print path while
|
||||
keeping third-party telemetry listeners intact.
|
||||
|
||||
Second pass confirmed all fixes correct, no further blockers.
|
||||
|
||||
## What remains for interactive verification
|
||||
|
||||
The scenarios in `README.md` numbered 00–09 require a real interactive
|
||||
session against the model API (long mixed-tool conversations, Ctrl-C
|
||||
mid-stream, subagent cancellation, heap snapshots). Those are documented
|
||||
for human execution and the transcripts should be attached to the PR body
|
||||
when run.
|
||||
@ -0,0 +1,107 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* Direct simulation of the listener-accumulation pattern the agent runtime
|
||||
* exhibits in long sessions. Builds a deep parent → child chain to a depth
|
||||
* the user observed (>1500 listeners) and asserts:
|
||||
*
|
||||
* 1. The OLD pattern (plain new AbortController + manual addEventListener
|
||||
* without {once:true} or reverse cleanup) accumulates listeners on the
|
||||
* long-lived parent — reproducing the warning.
|
||||
*
|
||||
* 2. The NEW pattern (createChildAbortController from the helper) keeps the
|
||||
* parent listener count bounded by 1, regardless of how many short-lived
|
||||
* children come and go.
|
||||
*
|
||||
* Run:
|
||||
* node docs/verification/abort-controller-refactor/listener-accumulation-repro.mjs
|
||||
*/
|
||||
|
||||
import { getEventListeners, setMaxListeners } from 'node:events';
|
||||
|
||||
// Inline copy of the production helper (packages/core/src/utils/abortController.ts)
|
||||
// so this script has no build-step dependency on @qwen-code/qwen-code-core.
|
||||
// Kept in sync — the child is held STRONGLY by the parent's listener closure
|
||||
// (no WeakRef on child) so propagation works even when a caller drops the
|
||||
// controller and keeps only the signal. WeakRef is used only on the PARENT,
|
||||
// to keep child cleanup from pinning a long-lived parent in memory.
|
||||
function createAbortController(maxListeners = 50) {
|
||||
const c = new AbortController();
|
||||
setMaxListeners(maxListeners, c.signal);
|
||||
return c;
|
||||
}
|
||||
function createChildAbortController(parent) {
|
||||
const child = createAbortController();
|
||||
if (!parent) return child;
|
||||
const parentSignal = parent.signal ?? parent;
|
||||
if (parentSignal.aborted) {
|
||||
child.abort(parentSignal.reason);
|
||||
return child;
|
||||
}
|
||||
const weakParent = new WeakRef(parentSignal);
|
||||
const handler = () => {
|
||||
child.abort(weakParent.deref()?.reason);
|
||||
};
|
||||
parentSignal.addEventListener('abort', handler, { once: true });
|
||||
child.signal.addEventListener(
|
||||
'abort',
|
||||
() => {
|
||||
weakParent.deref()?.removeEventListener('abort', handler);
|
||||
},
|
||||
{ once: true },
|
||||
);
|
||||
return child;
|
||||
}
|
||||
|
||||
const ROUNDS = 2000;
|
||||
|
||||
console.log(`Simulating ${ROUNDS} rounds for each pattern.\n`);
|
||||
|
||||
// ─── OLD pattern: plain new AbortController + manual addEventListener ───
|
||||
const oldParent = new AbortController();
|
||||
setMaxListeners(0, oldParent.signal); // disable warning so we can measure cleanly
|
||||
for (let i = 0; i < ROUNDS; i++) {
|
||||
const child = new AbortController();
|
||||
// No {once:true}, no reverse cleanup — accumulates on oldParent.
|
||||
oldParent.signal.addEventListener('abort', () => child.abort());
|
||||
}
|
||||
const oldCount = getEventListeners(oldParent.signal, 'abort').length;
|
||||
|
||||
// ─── NEW pattern: createChildAbortController ───
|
||||
const newParent = createAbortController();
|
||||
for (let i = 0; i < ROUNDS; i++) {
|
||||
const child = createChildAbortController(newParent);
|
||||
child.abort(); // simulate end-of-round cleanup via try/finally
|
||||
}
|
||||
const newCount = getEventListeners(newParent.signal, 'abort').length;
|
||||
|
||||
console.log(`OLD pattern listener count on long-lived parent: ${oldCount}`);
|
||||
console.log(`NEW pattern listener count on long-lived parent: ${newCount}`);
|
||||
|
||||
const expectations = {
|
||||
oldShouldExceed: 1500,
|
||||
newMustBe: 0,
|
||||
};
|
||||
|
||||
let pass = true;
|
||||
if (oldCount <= expectations.oldShouldExceed) {
|
||||
console.error(
|
||||
`FAIL: OLD pattern should accumulate >${expectations.oldShouldExceed} listeners; got ${oldCount}`,
|
||||
);
|
||||
pass = false;
|
||||
} else {
|
||||
console.log(
|
||||
`PASS: OLD pattern accumulated >${expectations.oldShouldExceed} listeners (reproduces the bug).`,
|
||||
);
|
||||
}
|
||||
if (newCount !== expectations.newMustBe) {
|
||||
console.error(
|
||||
`FAIL: NEW pattern must have exactly ${expectations.newMustBe} listeners; got ${newCount}`,
|
||||
);
|
||||
pass = false;
|
||||
} else {
|
||||
console.log(
|
||||
`PASS: NEW pattern kept listener count at ${expectations.newMustBe} — the helper prevents accumulation.`,
|
||||
);
|
||||
}
|
||||
|
||||
process.exit(pass ? 0 : 1);
|
||||
@ -0,0 +1,28 @@
|
||||
$ grep -rn "new AbortController" packages/core/src --include="*.ts" \
|
||||
| grep -v test | grep -v abortController.ts
|
||||
|
||||
# Scoped to the nested parent→child chain that actually accumulates listeners
|
||||
# (the agent-runtime loop in long sessions, plus promptHookRunner which had a
|
||||
# real cleanup leak). Independent short-lived controllers (per-shell-command,
|
||||
# per-fetch, per-recall, per-arena-session etc.) intentionally stay on raw
|
||||
# `new AbortController()` — they're GC'd at the end of their use and do not
|
||||
# accumulate listeners on a long-lived parent signal.
|
||||
packages/core/src/followup/speculation.ts:100: const abortController = new AbortController();
|
||||
packages/core/src/tools/agent/agent.ts:1722: const bgAbortController = new AbortController();
|
||||
packages/core/src/tools/agent/agent.ts:2116: const fgAbortController = new AbortController();
|
||||
packages/core/src/tools/shell.ts:1514: const promoteAbortController = new AbortController();
|
||||
packages/core/src/tools/shell.ts:2364: const entryAc = new AbortController();
|
||||
packages/core/src/tools/shell.ts:2772: const entryAc = new AbortController();
|
||||
packages/core/src/tools/monitor.ts:306: const entryAc = new AbortController();
|
||||
packages/core/src/core/client.ts:1199: const controller = new AbortController();
|
||||
packages/core/src/memory/manager.ts:936: const abortController = new AbortController();
|
||||
packages/core/src/goals/goalHook.ts:70: const judgeController = new AbortController();
|
||||
packages/core/src/goals/goalHook.ts:169: const signal = context?.signal ?? new AbortController().signal;
|
||||
packages/core/src/agents/arena/ArenaManager.ts:305: this.masterAbortController = new AbortController();
|
||||
packages/core/src/agents/arena/ArenaManager.ts:817: abortController: new AbortController(),
|
||||
packages/core/src/agents/background-agent-resume.ts:421: abortController: new AbortController(),
|
||||
packages/core/src/agents/background-agent-resume.ts:493: const bgAbortController = new AbortController();
|
||||
packages/core/src/agents/background-agent-resume.ts:922: abortController: new AbortController(),
|
||||
packages/core/src/utils/fetch.ts:64: const controller = new AbortController();
|
||||
packages/core/src/services/chatRecordingService.ts:963: const controller = new AbortController();
|
||||
packages/core/src/services/chatCompressionService.ts:387: abortSignal: signal ?? new AbortController().signal,
|
||||
23
docs/verification/abort-controller-refactor/scripts/02-lite.sh
Executable file
23
docs/verification/abort-controller-refactor/scripts/02-lite.sh
Executable file
@ -0,0 +1,23 @@
|
||||
#!/usr/bin/env bash
|
||||
# Scenario 02-lite — single real-Qwen prompt under --trace-warnings.
|
||||
# Demonstrates the steady-state path emits no MaxListenersExceededWarning.
|
||||
set -uo pipefail
|
||||
WT="${WT:-$(git rev-parse --show-toplevel)}"
|
||||
LOG="$WT/docs/verification/abort-controller-refactor/logs/02-lite-short-prompt.log"
|
||||
mkdir -p "$(dirname "$LOG")"
|
||||
|
||||
NODE_OPTIONS=--trace-warnings node "$WT/packages/cli/dist/index.js" \
|
||||
--prompt "Reply with exactly 'OK' and nothing else." > "$LOG" 2>&1 &
|
||||
PID=$!
|
||||
for i in $(seq 1 90); do
|
||||
if ! kill -0 $PID 2>/dev/null; then break; fi
|
||||
sleep 1
|
||||
done
|
||||
if kill -0 $PID 2>/dev/null; then kill -9 $PID; echo "TIMEOUT"; exit 1; fi
|
||||
wait $PID 2>/dev/null
|
||||
EC=$?
|
||||
|
||||
echo "EXIT=$EC"
|
||||
echo "MaxListenersExceededWarning count: $(grep -c MaxListenersExceededWarning "$LOG")"
|
||||
echo "--- log ---"
|
||||
cat "$LOG"
|
||||
18
docs/verification/abort-controller-refactor/scripts/06-headless-sigint.sh
Executable file
18
docs/verification/abort-controller-refactor/scripts/06-headless-sigint.sh
Executable file
@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env bash
|
||||
# Scenario 06 — headless --prompt + SIGINT. Verifies the agent shuts down
|
||||
# cleanly when an external signal aborts the in-flight stream.
|
||||
set -uo pipefail
|
||||
WT="${WT:-$(git rev-parse --show-toplevel)}"
|
||||
LOG="$WT/docs/verification/abort-controller-refactor/logs/06-headless-sigint.log"
|
||||
mkdir -p "$(dirname "$LOG")"
|
||||
|
||||
NODE_OPTIONS=--trace-warnings node "$WT/packages/cli/dist/index.js" \
|
||||
--prompt "Please write a detailed essay about the history of distributed systems, at least 500 words." > "$LOG" 2>&1 &
|
||||
PID=$!
|
||||
sleep 6
|
||||
kill -INT $PID
|
||||
wait $PID 2>/dev/null
|
||||
EC=$?
|
||||
|
||||
echo "EXIT_CODE=$EC (expected 130)"
|
||||
echo "MaxListenersExceededWarning count: $(grep -c MaxListenersExceededWarning "$LOG")"
|
||||
@ -0,0 +1,2 @@
|
||||
0.15.11
|
||||
EXIT=0
|
||||
10
docs/verification/abort-controller-refactor/test-summary.txt
Normal file
10
docs/verification/abort-controller-refactor/test-summary.txt
Normal file
@ -0,0 +1,10 @@
|
||||
✓ |@qwen-code/qwen-code-core| src/core/openaiContentGenerator/provider/minimax.test.ts (9 tests) 2ms
|
||||
✓ |@qwen-code/qwen-code-core| src/followup/suggestionGenerator.test.ts (16 tests) 2ms
|
||||
✓ |@qwen-code/qwen-code-core| src/followup/speculation.test.ts (7 tests) 2ms
|
||||
✓ |@qwen-code/qwen-code| src/utils/warningHandler.test.ts (9 tests) 5ms
|
||||
|
||||
Test Files 71 passed (71)
|
||||
Tests 2085 passed | 3 skipped (2088)
|
||||
Start at 02:35:37
|
||||
Duration 16.71s (transform 1.77s, setup 92ms, collect 14.79s, tests 3.03s, environment 319ms, prepare 2.20s)
|
||||
|
||||
@ -112,6 +112,11 @@ esbuild
|
||||
},
|
||||
define: {
|
||||
'process.env.CLI_VERSION': JSON.stringify(pkg.version),
|
||||
// react-reconciler ≥0.33 (ink 7) gates its dev build behind NODE_ENV
|
||||
// and calls performance.measure() on every render, leaking
|
||||
// PerformanceMeasure objects into the global measureEntryBuffer.
|
||||
// Setting production here tree-shakes the entire dev build (~15k lines).
|
||||
'process.env.NODE_ENV': JSON.stringify('production'),
|
||||
// Make global available for compatibility
|
||||
global: 'globalThis',
|
||||
// Redirect free __dirname/__filename references to the shim so that
|
||||
|
||||
@ -191,7 +191,14 @@ export default tseslint.config(
|
||||
},
|
||||
// extra settings for scripts that we run directly with node
|
||||
{
|
||||
files: ['./scripts/**/*.js', './scripts/**/*.mjs', 'esbuild.config.js', 'packages/*/scripts/**/*.js'],
|
||||
files: [
|
||||
'./scripts/**/*.js',
|
||||
'./scripts/**/*.mjs',
|
||||
'esbuild.config.js',
|
||||
'packages/*/scripts/**/*.js',
|
||||
// Verification reproducer scripts under docs/ also run with `node`.
|
||||
'docs/**/*.mjs',
|
||||
],
|
||||
languageOptions: {
|
||||
globals: {
|
||||
...globals.node,
|
||||
|
||||
1732
package-lock.json
generated
1732
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/qwen-code",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"engines": {
|
||||
"node": ">=22.0.0"
|
||||
},
|
||||
@ -11,6 +11,7 @@
|
||||
"packages/channels/telegram",
|
||||
"packages/channels/weixin",
|
||||
"packages/channels/dingtalk",
|
||||
"packages/channels/feishu",
|
||||
"packages/channels/plugin-example"
|
||||
],
|
||||
"repository": {
|
||||
@ -18,7 +19,7 @@
|
||||
"url": "git+https://github.com/QwenLM/qwen-code.git"
|
||||
},
|
||||
"config": {
|
||||
"sandboxImageUri": "ghcr.io/qwenlm/qwen-code:0.16.0"
|
||||
"sandboxImageUri": "ghcr.io/qwenlm/qwen-code:0.17.0"
|
||||
},
|
||||
"scripts": {
|
||||
"start": "cross-env node scripts/start.js",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/acp-bridge",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "Shared ACP bridge primitives (EventBus, AcpChannel, in-memory channel, PermissionMediator interface) used by qwen serve, channels, IDE, TUI, and remote-control adapters.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-base",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "Base channel infrastructure for Qwen Code",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-dingtalk",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "DingTalk channel adapter for Qwen Code",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
27
packages/channels/feishu/package.json
Normal file
27
packages/channels/feishu/package.json
Normal file
@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-feishu",
|
||||
"version": "0.17.0",
|
||||
"description": "Feishu (Lark) channel adapter for Qwen Code",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsc --build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@qwen-code/channel-base": "file:../base",
|
||||
"@larksuiteoapi/node-sdk": "^1.45.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "^5.0.0"
|
||||
}
|
||||
}
|
||||
1968
packages/channels/feishu/src/FeishuAdapter.ts
Normal file
1968
packages/channels/feishu/src/FeishuAdapter.ts
Normal file
File diff suppressed because it is too large
Load Diff
968
packages/channels/feishu/src/adapter.test.ts
Normal file
968
packages/channels/feishu/src/adapter.test.ts
Normal file
@ -0,0 +1,968 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import { FeishuChannel } from './FeishuAdapter.js';
|
||||
import type { ChannelConfig, AcpBridge } from '@qwen-code/channel-base';
|
||||
|
||||
function createMockBridge(): AcpBridge {
|
||||
return {
|
||||
prompt: vi.fn().mockResolvedValue(undefined),
|
||||
cancelSession: vi.fn().mockResolvedValue(undefined),
|
||||
on: vi.fn(),
|
||||
off: vi.fn(),
|
||||
} as unknown as AcpBridge;
|
||||
}
|
||||
|
||||
function createConfig(overrides?: Partial<ChannelConfig>): ChannelConfig {
|
||||
return {
|
||||
type: 'feishu',
|
||||
token: '',
|
||||
clientId: 'test_app_id',
|
||||
clientSecret: 'test_app_secret',
|
||||
senderPolicy: 'open',
|
||||
allowedUsers: [],
|
||||
sessionScope: 'user',
|
||||
cwd: '/tmp',
|
||||
groupPolicy: 'open',
|
||||
groups: { '*': { requireMention: true } },
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
function createChannel(
|
||||
configOverrides?: Partial<ChannelConfig>,
|
||||
): FeishuChannel {
|
||||
const config = createConfig(configOverrides);
|
||||
const bridge = createMockBridge();
|
||||
return new FeishuChannel('test', config, bridge);
|
||||
}
|
||||
|
||||
// Access private methods for unit testing
|
||||
function getPrivateMethod<T>(instance: unknown, method: string): T {
|
||||
return (instance as Record<string, unknown>)[method] as T;
|
||||
}
|
||||
|
||||
describe('FeishuChannel', () => {
|
||||
describe('constructor', () => {
|
||||
it('throws if clientId is missing', () => {
|
||||
expect(() => createChannel({ clientId: undefined })).toThrow(
|
||||
/requires clientId/,
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if clientSecret is missing', () => {
|
||||
expect(() => createChannel({ clientSecret: undefined })).toThrow(
|
||||
/requires clientId.*clientSecret/,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractContent', () => {
|
||||
let channel: FeishuChannel;
|
||||
let extractContent: (
|
||||
messageType: string,
|
||||
contentJson: string,
|
||||
) => {
|
||||
text: string;
|
||||
imageKey?: string;
|
||||
fileKey?: string;
|
||||
fileName?: string;
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
channel = createChannel();
|
||||
extractContent = getPrivateMethod<
|
||||
(
|
||||
messageType: string,
|
||||
contentJson: string,
|
||||
) => {
|
||||
text: string;
|
||||
imageKey?: string;
|
||||
fileKey?: string;
|
||||
fileName?: string;
|
||||
}
|
||||
>(channel, 'extractContent').bind(channel);
|
||||
});
|
||||
|
||||
it('handles text messages', () => {
|
||||
const result = extractContent('text', JSON.stringify({ text: 'hello' }));
|
||||
expect(result.text).toBe('hello');
|
||||
});
|
||||
|
||||
it('handles post messages with nested paragraphs', () => {
|
||||
const post = {
|
||||
zh_cn: {
|
||||
title: 'Post Title',
|
||||
content: [
|
||||
[
|
||||
{ tag: 'text', text: 'Line 1 ' },
|
||||
{ tag: 'a', text: 'link' },
|
||||
],
|
||||
[{ tag: 'text', text: 'Line 2' }],
|
||||
],
|
||||
},
|
||||
};
|
||||
const result = extractContent('post', JSON.stringify(post));
|
||||
expect(result.text).toContain('Post Title');
|
||||
expect(result.text).toContain('Line 1 link');
|
||||
expect(result.text).toContain('Line 2');
|
||||
});
|
||||
|
||||
it('handles image messages', () => {
|
||||
const result = extractContent(
|
||||
'image',
|
||||
JSON.stringify({ image_key: 'img_key_123' }),
|
||||
);
|
||||
expect(result.text).toBe('(image)');
|
||||
expect(result.imageKey).toBe('img_key_123');
|
||||
});
|
||||
|
||||
it('handles file messages', () => {
|
||||
const result = extractContent(
|
||||
'file',
|
||||
JSON.stringify({ file_key: 'file_key_456', file_name: 'doc.pdf' }),
|
||||
);
|
||||
expect(result.text).toBe('(file: doc.pdf)');
|
||||
expect(result.fileKey).toBe('file_key_456');
|
||||
expect(result.fileName).toBe('doc.pdf');
|
||||
});
|
||||
|
||||
it('handles audio messages', () => {
|
||||
const result = extractContent('audio', JSON.stringify({}));
|
||||
expect(result.text).toBe('(audio)');
|
||||
});
|
||||
|
||||
it('handles media (video) messages', () => {
|
||||
const result = extractContent(
|
||||
'media',
|
||||
JSON.stringify({ file_key: 'vid_key', file_name: 'video.mp4' }),
|
||||
);
|
||||
expect(result.text).toBe('(video)');
|
||||
expect(result.fileKey).toBe('vid_key');
|
||||
expect(result.fileName).toBe('video.mp4');
|
||||
});
|
||||
|
||||
it('returns empty text for unknown types', () => {
|
||||
const result = extractContent('sticker', JSON.stringify({}));
|
||||
expect(result.text).toBe('');
|
||||
});
|
||||
|
||||
it('handles malformed JSON gracefully', () => {
|
||||
const result = extractContent('text', 'not valid json');
|
||||
expect(result.text).toBe('');
|
||||
});
|
||||
|
||||
it('handles empty content', () => {
|
||||
const result = extractContent('text', JSON.stringify({}));
|
||||
expect(result.text).toBe('');
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractCardText', () => {
|
||||
let channel: FeishuChannel;
|
||||
let extractCardText: (card: Record<string, unknown>) => string | undefined;
|
||||
|
||||
beforeEach(() => {
|
||||
channel = createChannel();
|
||||
extractCardText = getPrivateMethod<
|
||||
(card: Record<string, unknown>) => string | undefined
|
||||
>(channel, 'extractCardText').bind(channel);
|
||||
});
|
||||
|
||||
it('extracts markdown from v2 card format (body.elements)', () => {
|
||||
const card = {
|
||||
body: {
|
||||
elements: [
|
||||
{ tag: 'markdown', content: 'Hello world' },
|
||||
{ tag: 'markdown', content: 'Second block' },
|
||||
],
|
||||
},
|
||||
};
|
||||
const result = extractCardText(card);
|
||||
expect(result).toContain('Hello world');
|
||||
expect(result).toContain('Second block');
|
||||
});
|
||||
|
||||
it('extracts from collapsible_panel in v2 format', () => {
|
||||
const card = {
|
||||
body: {
|
||||
elements: [
|
||||
{ tag: 'markdown', content: 'Preview' },
|
||||
{
|
||||
tag: 'collapsible_panel',
|
||||
elements: [{ tag: 'markdown', content: 'Hidden content' }],
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
const result = extractCardText(card);
|
||||
expect(result).toContain('Preview');
|
||||
expect(result).toContain('Hidden content');
|
||||
});
|
||||
|
||||
it('extracts from v1/API format (flat elements array)', () => {
|
||||
const card = {
|
||||
title: 'Card Title',
|
||||
elements: [{ tag: 'markdown', content: 'Body text' }],
|
||||
};
|
||||
const result = extractCardText(card);
|
||||
expect(result).toContain('Card Title');
|
||||
expect(result).toContain('Body text');
|
||||
});
|
||||
|
||||
it('strips streaming indicator', () => {
|
||||
const card = {
|
||||
body: {
|
||||
elements: [{ tag: 'markdown', content: 'Content\n---\n*生成中...*' }],
|
||||
},
|
||||
};
|
||||
const result = extractCardText(card);
|
||||
expect(result).not.toContain('生成中');
|
||||
expect(result).toBe('Content');
|
||||
});
|
||||
|
||||
it('returns undefined for empty card', () => {
|
||||
const result = extractCardText({});
|
||||
expect(result).toBeUndefined();
|
||||
});
|
||||
|
||||
it('filters fallback text', () => {
|
||||
const card = {
|
||||
elements: [
|
||||
[{ tag: 'text', text: '请升级至最新版本客户端,以查看内容' }],
|
||||
],
|
||||
};
|
||||
const result = extractCardText(card);
|
||||
expect(result).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('state machine: dedup', () => {
|
||||
let channel: FeishuChannel;
|
||||
let seenMessages: Map<string, number>;
|
||||
|
||||
beforeEach(() => {
|
||||
channel = createChannel();
|
||||
seenMessages = getPrivateMethod(channel, 'seenMessages');
|
||||
});
|
||||
|
||||
it('deduplicates messages with same ID within TTL', () => {
|
||||
seenMessages.set('msg_1', Date.now());
|
||||
// Simulate calling onMessage with same ID — it should be skipped
|
||||
const onMessage = getPrivateMethod<(data: unknown) => void>(
|
||||
channel,
|
||||
'onMessage',
|
||||
).bind(channel);
|
||||
|
||||
// Mock fetchBotInfo result
|
||||
(channel as unknown as Record<string, unknown>)['botOpenId'] = 'bot_123';
|
||||
|
||||
onMessage({
|
||||
message: {
|
||||
message_id: 'msg_1',
|
||||
chat_id: 'chat_1',
|
||||
chat_type: 'p2p',
|
||||
message_type: 'text',
|
||||
content: JSON.stringify({ text: 'hello' }),
|
||||
},
|
||||
sender: {
|
||||
sender_id: { open_id: 'user_1' },
|
||||
sender_type: 'user',
|
||||
},
|
||||
});
|
||||
|
||||
// Should not create a card session since it's a duplicate
|
||||
const cardSessions = getPrivateMethod<Map<string, unknown>>(
|
||||
channel,
|
||||
'cardSessions',
|
||||
);
|
||||
expect(cardSessions.has('msg_1')).toBe(false);
|
||||
});
|
||||
|
||||
it('allows message after TTL expiry', () => {
|
||||
// Set a message that expired 6 minutes ago
|
||||
const DEDUP_TTL_MS = 5 * 60 * 1000;
|
||||
seenMessages.set('msg_old', Date.now() - DEDUP_TTL_MS - 1000);
|
||||
|
||||
// Simulate the cleanup timer logic
|
||||
const now = Date.now();
|
||||
for (const [id, ts] of seenMessages) {
|
||||
if (now - ts > DEDUP_TTL_MS) {
|
||||
seenMessages.delete(id);
|
||||
}
|
||||
}
|
||||
|
||||
expect(seenMessages.has('msg_old')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('state machine: cleanupCard', () => {
|
||||
let channel: FeishuChannel;
|
||||
let cleanupCard: (inboundMsgId: string) => void;
|
||||
|
||||
beforeEach(() => {
|
||||
channel = createChannel();
|
||||
cleanupCard = getPrivateMethod<(id: string) => void>(
|
||||
channel,
|
||||
'cleanupCard',
|
||||
).bind(channel);
|
||||
});
|
||||
|
||||
it('cleans up all maps for a given inbound message', () => {
|
||||
const cardSessions = getPrivateMethod<Map<string, unknown>>(
|
||||
channel,
|
||||
'cardSessions',
|
||||
);
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
const msgToQuestion = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToQuestion',
|
||||
);
|
||||
const msgToSenderName = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderName',
|
||||
);
|
||||
// Populate all maps
|
||||
cardSessions.set('msg_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: 'test',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
sessionToInboundMsg.set('session_1', 'msg_1');
|
||||
msgToQuestion.set('msg_1', 'question?');
|
||||
msgToSenderName.set('msg_1', '<at>user</at>');
|
||||
|
||||
cleanupCard('msg_1');
|
||||
|
||||
expect(cardSessions.has('msg_1')).toBe(false);
|
||||
expect(sessionToInboundMsg.has('session_1')).toBe(false);
|
||||
expect(msgToQuestion.has('msg_1')).toBe(false);
|
||||
expect(msgToSenderName.has('msg_1')).toBe(false);
|
||||
});
|
||||
|
||||
it('clears pending timer on cleanup', () => {
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
const clearTimeoutSpy = vi.spyOn(global, 'clearTimeout');
|
||||
|
||||
const timer = setTimeout(() => {}, 10000);
|
||||
cardSessions.set('msg_2', {
|
||||
messageId: 'card_2',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: '',
|
||||
lastUpdateAt: Date.now(),
|
||||
pendingUpdateTimer: timer,
|
||||
});
|
||||
|
||||
cleanupCard('msg_2');
|
||||
|
||||
expect(clearTimeoutSpy).toHaveBeenCalledWith(timer);
|
||||
expect(cardSessions.has('msg_2')).toBe(false);
|
||||
clearTimeoutSpy.mockRestore();
|
||||
});
|
||||
});
|
||||
|
||||
describe('state machine: stop button during card creation', () => {
|
||||
let channel: FeishuChannel;
|
||||
|
||||
beforeEach(() => {
|
||||
channel = createChannel();
|
||||
});
|
||||
|
||||
it('marks card as stopped even when still creating', async () => {
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
|
||||
// Simulate card in "creating" state
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: false,
|
||||
creating: true,
|
||||
stopped: false,
|
||||
accumulatedText: 'partial text',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
// Mock bridge
|
||||
const bridge = getPrivateMethod<AcpBridge>(channel, 'bridge');
|
||||
const cancelSessionSpy = vi
|
||||
.spyOn(bridge, 'cancelSession')
|
||||
.mockResolvedValue(undefined);
|
||||
|
||||
// Mock updateCard to not actually call HTTP
|
||||
const updateCardMock = vi.fn().mockResolvedValue(true);
|
||||
(channel as unknown as Record<string, unknown>)['updateCard'] =
|
||||
updateCardMock;
|
||||
|
||||
// Simulate sessionToInboundMsg mapping
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
sessionToInboundMsg.set('session_abc', 'inbound_1');
|
||||
|
||||
// Simulate msgToSenderId mapping (fail-closed auth check)
|
||||
const msgToSenderId = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderId',
|
||||
);
|
||||
msgToSenderId.set('inbound_1', 'user_open_id');
|
||||
|
||||
// Call onCardAction with stop
|
||||
const onCardAction = getPrivateMethod<
|
||||
(data: Record<string, unknown>) => boolean
|
||||
>(channel, 'onCardAction').bind(channel);
|
||||
|
||||
onCardAction({
|
||||
action: { value: { action: 'stop' } },
|
||||
context: { open_message_id: 'card_1' },
|
||||
operator: { open_id: 'user_open_id' },
|
||||
});
|
||||
|
||||
const state = cardSessions.get('inbound_1') as
|
||||
| Record<string, unknown>
|
||||
| undefined;
|
||||
// cancelling is set synchronously (stopped is deferred until cancelSession resolves)
|
||||
expect(state?.['cancelling']).toBe(true);
|
||||
|
||||
// Wait for async handleStop to complete — stopped is set after cancelSession resolves
|
||||
await vi.waitFor(() => {
|
||||
expect(state?.['stopped']).toBe(true);
|
||||
});
|
||||
expect(cancelSessionSpy).toHaveBeenCalledWith('session_abc');
|
||||
expect(state?.['cancelling']).toBe(false);
|
||||
});
|
||||
|
||||
it('rejects stop from a different user (operator mismatch)', () => {
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: 'test',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const msgToSenderId = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderId',
|
||||
);
|
||||
msgToSenderId.set('inbound_1', 'original_user');
|
||||
|
||||
const onCardAction = getPrivateMethod<
|
||||
(data: Record<string, unknown>) => boolean
|
||||
>(channel, 'onCardAction').bind(channel);
|
||||
|
||||
const result = onCardAction({
|
||||
action: { value: { action: 'stop' } },
|
||||
context: { open_message_id: 'card_1' },
|
||||
operator: { open_id: 'different_user' },
|
||||
});
|
||||
|
||||
expect(result).toBe(false);
|
||||
const state = cardSessions.get('inbound_1') as
|
||||
| Record<string, unknown>
|
||||
| undefined;
|
||||
expect(state?.['stopped']).toBe(false);
|
||||
});
|
||||
|
||||
it('rejects stop when operator field is missing (fail-closed)', () => {
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: 'test',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const msgToSenderId = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderId',
|
||||
);
|
||||
msgToSenderId.set('inbound_1', 'original_user');
|
||||
|
||||
const onCardAction = getPrivateMethod<
|
||||
(data: Record<string, unknown>) => boolean
|
||||
>(channel, 'onCardAction').bind(channel);
|
||||
|
||||
// No operator field at all
|
||||
const result = onCardAction({
|
||||
action: { value: { action: 'stop' } },
|
||||
context: { open_message_id: 'card_1' },
|
||||
});
|
||||
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
|
||||
it('rejects stop when msgToSenderId has no entry (no originalSender)', () => {
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: 'test',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
// msgToSenderId intentionally not populated for inbound_1
|
||||
|
||||
const onCardAction = getPrivateMethod<
|
||||
(data: Record<string, unknown>) => boolean
|
||||
>(channel, 'onCardAction').bind(channel);
|
||||
|
||||
const result = onCardAction({
|
||||
action: { value: { action: 'stop' } },
|
||||
context: { open_message_id: 'card_1' },
|
||||
operator: { open_id: 'some_user' },
|
||||
});
|
||||
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('disconnect', () => {
|
||||
it('closes wsClient on disconnect', () => {
|
||||
const channel = createChannel();
|
||||
const mockClose = vi.fn();
|
||||
(channel as unknown as Record<string, unknown>)['wsClient'] = {
|
||||
close: mockClose,
|
||||
};
|
||||
|
||||
channel.disconnect();
|
||||
|
||||
expect(mockClose).toHaveBeenCalled();
|
||||
expect(
|
||||
(channel as unknown as Record<string, unknown>)['wsClient'],
|
||||
).toBeUndefined();
|
||||
});
|
||||
|
||||
it('clears dedup timer on disconnect', () => {
|
||||
const channel = createChannel();
|
||||
const clearIntervalSpy = vi.spyOn(global, 'clearInterval');
|
||||
const timer = setInterval(() => {}, 60000);
|
||||
(channel as unknown as Record<string, unknown>)['dedupTimer'] = timer;
|
||||
|
||||
channel.disconnect();
|
||||
|
||||
expect(clearIntervalSpy).toHaveBeenCalledWith(timer);
|
||||
clearIntervalSpy.mockRestore();
|
||||
clearInterval(timer);
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractContent: post at-node mentions', () => {
|
||||
it('extracts @mention user_name from post at nodes', () => {
|
||||
const channel = createChannel();
|
||||
const extractContent = getPrivateMethod<
|
||||
(messageType: string, contentJson: string) => { text: string }
|
||||
>(channel, 'extractContent').bind(channel);
|
||||
|
||||
const post = {
|
||||
zh_cn: {
|
||||
title: '',
|
||||
content: [
|
||||
[
|
||||
{ tag: 'text', text: 'hello ' },
|
||||
{ tag: 'at', user_id: 'ou_123', user_name: 'John' },
|
||||
{ tag: 'text', text: ' check this' },
|
||||
],
|
||||
],
|
||||
},
|
||||
};
|
||||
const result = extractContent('post', JSON.stringify(post));
|
||||
expect(result.text).toBe('hello @John check this');
|
||||
});
|
||||
|
||||
it('handles at node without user_name gracefully', () => {
|
||||
const channel = createChannel();
|
||||
const extractContent = getPrivateMethod<
|
||||
(messageType: string, contentJson: string) => { text: string }
|
||||
>(channel, 'extractContent').bind(channel);
|
||||
|
||||
const post = {
|
||||
zh_cn: {
|
||||
title: '',
|
||||
content: [
|
||||
[
|
||||
{ tag: 'text', text: 'hello ' },
|
||||
{ tag: 'at', user_id: 'ou_123' },
|
||||
],
|
||||
],
|
||||
},
|
||||
};
|
||||
const result = extractContent('post', JSON.stringify(post));
|
||||
expect(result.text).toBe('hello');
|
||||
});
|
||||
});
|
||||
|
||||
describe('onCardAction: cancelSession failure', () => {
|
||||
it('shows "停止失败" when cancelSession throws', async () => {
|
||||
const bridge = createMockBridge();
|
||||
(bridge.cancelSession as ReturnType<typeof vi.fn>).mockRejectedValueOnce(
|
||||
new Error('session not found'),
|
||||
);
|
||||
const config = createConfig();
|
||||
const channel = new FeishuChannel('test', config, bridge);
|
||||
|
||||
// Set up botOpenId and card state
|
||||
(channel as unknown as Record<string, unknown>)['botOpenId'] = 'bot_123';
|
||||
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
accumulatedText: 'some text',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const msgToSenderId = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderId',
|
||||
);
|
||||
msgToSenderId.set('inbound_1', 'original_user');
|
||||
|
||||
const msgToSenderName = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderName',
|
||||
);
|
||||
msgToSenderName.set('inbound_1', '@sender');
|
||||
|
||||
// Set up session mapping so cancelSession is actually called
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
sessionToInboundMsg.set('session_1', 'inbound_1');
|
||||
|
||||
// Mock updateCard to capture the text
|
||||
const updateCardSpy = vi.fn().mockResolvedValue(true);
|
||||
(channel as unknown as Record<string, unknown>)['updateCard'] =
|
||||
updateCardSpy;
|
||||
|
||||
const onCardAction = getPrivateMethod<
|
||||
(data: Record<string, unknown>) => boolean
|
||||
>(channel, 'onCardAction').bind(channel);
|
||||
|
||||
onCardAction({
|
||||
action: { value: { action: 'stop' } },
|
||||
context: { open_message_id: 'card_1' },
|
||||
operator: { open_id: 'original_user' },
|
||||
});
|
||||
|
||||
// Wait for the fire-and-forget handleStop to complete
|
||||
await new Promise((r) => setTimeout(r, 50));
|
||||
|
||||
expect(updateCardSpy).toHaveBeenCalled();
|
||||
const cardText = updateCardSpy.mock.calls[0][1] as string;
|
||||
expect(cardText).toContain('停止失败');
|
||||
});
|
||||
});
|
||||
|
||||
describe('deleteCard', () => {
|
||||
it('returns true on successful deletion', async () => {
|
||||
const channel = createChannel();
|
||||
const fetchMock = vi
|
||||
.fn()
|
||||
.mockResolvedValue(new Response(null, { status: 200 }));
|
||||
vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
|
||||
|
||||
// Provide a valid token
|
||||
(channel as unknown as Record<string, unknown>)['tokenCache'] = {
|
||||
token: 'test_token',
|
||||
expiresAt: Date.now() + 3600_000,
|
||||
};
|
||||
|
||||
const deleteCard = getPrivateMethod<
|
||||
(messageId: string) => Promise<boolean>
|
||||
>(channel, 'deleteCard').bind(channel);
|
||||
|
||||
const result = await deleteCard('om_test_msg_id');
|
||||
expect(result).toBe(true);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
expect.stringContaining('/im/v1/messages/om_test_msg_id'),
|
||||
expect.objectContaining({ method: 'DELETE' }),
|
||||
);
|
||||
});
|
||||
|
||||
it('returns false when token is unavailable', async () => {
|
||||
const channel = createChannel();
|
||||
// No token cache and getTenantAccessToken will fail
|
||||
const fetchMock = vi
|
||||
.fn()
|
||||
.mockResolvedValue(
|
||||
new Response(JSON.stringify({ code: -1 }), { status: 500 }),
|
||||
);
|
||||
vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
|
||||
|
||||
const deleteCard = getPrivateMethod<
|
||||
(messageId: string) => Promise<boolean>
|
||||
>(channel, 'deleteCard').bind(channel);
|
||||
|
||||
const result = await deleteCard('om_test_msg_id');
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
|
||||
it('returns false on HTTP error', async () => {
|
||||
const channel = createChannel();
|
||||
(channel as unknown as Record<string, unknown>)['tokenCache'] = {
|
||||
token: 'test_token',
|
||||
expiresAt: Date.now() + 3600_000,
|
||||
};
|
||||
const fetchMock = vi
|
||||
.fn()
|
||||
.mockResolvedValue(new Response('not found', { status: 404 }));
|
||||
vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
|
||||
|
||||
const deleteCard = getPrivateMethod<
|
||||
(messageId: string) => Promise<boolean>
|
||||
>(channel, 'deleteCard').bind(channel);
|
||||
|
||||
const result = await deleteCard('om_test_msg_id');
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
|
||||
it('clears token cache on 401', async () => {
|
||||
const channel = createChannel();
|
||||
(channel as unknown as Record<string, unknown>)['tokenCache'] = {
|
||||
token: 'stale_token',
|
||||
expiresAt: Date.now() + 3600_000,
|
||||
};
|
||||
const fetchMock = vi
|
||||
.fn()
|
||||
.mockResolvedValue(new Response('unauthorized', { status: 401 }));
|
||||
vi.spyOn(global, 'fetch').mockImplementation(fetchMock);
|
||||
|
||||
const deleteCard = getPrivateMethod<
|
||||
(messageId: string) => Promise<boolean>
|
||||
>(channel, 'deleteCard').bind(channel);
|
||||
|
||||
await deleteCard('om_test_msg_id');
|
||||
expect(
|
||||
(channel as unknown as Record<string, unknown>)['tokenCache'],
|
||||
).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('sendMessage: token failure logging', () => {
|
||||
it('logs and returns early when token is unavailable', async () => {
|
||||
const channel = createChannel();
|
||||
const stderrSpy = vi
|
||||
.spyOn(process.stderr, 'write')
|
||||
.mockImplementation(() => true);
|
||||
|
||||
// No token available
|
||||
await channel.sendMessage('oc_chat_id', 'hello');
|
||||
|
||||
expect(stderrSpy).toHaveBeenCalledWith(
|
||||
expect.stringContaining('Cannot send: no access token'),
|
||||
);
|
||||
stderrSpy.mockRestore();
|
||||
});
|
||||
});
|
||||
|
||||
describe('onPromptEnd: error recovery branches', () => {
|
||||
it('sends error fallback when card creation failed and no accumulated text', async () => {
|
||||
const channel = createChannel();
|
||||
(channel as unknown as Record<string, unknown>)['botOpenId'] = 'bot_123';
|
||||
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: '',
|
||||
created: false,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
finalizing: false,
|
||||
completed: false,
|
||||
abandoned: false,
|
||||
accumulatedText: '',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const sendMessageSpy = vi.fn().mockResolvedValue(undefined);
|
||||
(channel as unknown as Record<string, unknown>)['sendMessage'] =
|
||||
sendMessageSpy;
|
||||
|
||||
const onPromptEnd = getPrivateMethod<
|
||||
(chatId: string, sessionId: string, messageId?: string) => Promise<void>
|
||||
>(channel, 'onPromptEnd').bind(channel);
|
||||
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
sessionToInboundMsg.set('session_1', 'inbound_1');
|
||||
|
||||
await onPromptEnd('oc_chat_id', 'session_1');
|
||||
|
||||
// Should send error fallback message
|
||||
expect(sendMessageSpy).toHaveBeenCalledWith(
|
||||
'oc_chat_id',
|
||||
expect.stringContaining('出错了'),
|
||||
);
|
||||
});
|
||||
|
||||
it('sends accumulated text via sendMessage when card creation failed', async () => {
|
||||
const channel = createChannel();
|
||||
(channel as unknown as Record<string, unknown>)['botOpenId'] = 'bot_123';
|
||||
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: '',
|
||||
created: false,
|
||||
creating: false,
|
||||
stopped: false,
|
||||
finalizing: false,
|
||||
completed: false,
|
||||
abandoned: false,
|
||||
accumulatedText: 'partial response text',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const sendMessageSpy = vi.fn().mockResolvedValue(undefined);
|
||||
(channel as unknown as Record<string, unknown>)['sendMessage'] =
|
||||
sendMessageSpy;
|
||||
|
||||
const onPromptEnd = getPrivateMethod<
|
||||
(chatId: string, sessionId: string, messageId?: string) => Promise<void>
|
||||
>(channel, 'onPromptEnd').bind(channel);
|
||||
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
sessionToInboundMsg.set('session_1', 'inbound_1');
|
||||
|
||||
await onPromptEnd('oc_chat_id', 'session_1');
|
||||
|
||||
expect(sendMessageSpy).toHaveBeenCalledWith(
|
||||
'oc_chat_id',
|
||||
expect.stringContaining('partial response text'),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('onResponseComplete: stopped card cleanup', () => {
|
||||
it('cleans up and returns early when card was stopped', async () => {
|
||||
const channel = createChannel();
|
||||
(channel as unknown as Record<string, unknown>)['botOpenId'] = 'bot_123';
|
||||
|
||||
const cardSessions = getPrivateMethod<
|
||||
Map<string, Record<string, unknown>>
|
||||
>(channel, 'cardSessions');
|
||||
cardSessions.set('inbound_1', {
|
||||
messageId: 'card_1',
|
||||
created: true,
|
||||
creating: false,
|
||||
stopped: true,
|
||||
finalizing: false,
|
||||
completed: true,
|
||||
abandoned: false,
|
||||
accumulatedText: 'text',
|
||||
lastUpdateAt: Date.now(),
|
||||
});
|
||||
|
||||
const sessionToInboundMsg = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'sessionToInboundMsg',
|
||||
);
|
||||
sessionToInboundMsg.set('session_1', 'inbound_1');
|
||||
|
||||
const sendMessageSpy = vi.fn().mockResolvedValue(undefined);
|
||||
(channel as unknown as Record<string, unknown>)['sendMessage'] =
|
||||
sendMessageSpy;
|
||||
|
||||
const onResponseComplete = getPrivateMethod<
|
||||
(chatId: string, fullText: string, sessionId: string) => Promise<void>
|
||||
>(channel, 'onResponseComplete').bind(channel);
|
||||
|
||||
await onResponseComplete('oc_chat_id', 'full response', 'session_1');
|
||||
|
||||
// Should NOT call sendMessage — the stop handler owns the card
|
||||
expect(sendMessageSpy).not.toHaveBeenCalled();
|
||||
// Card session should be cleaned up
|
||||
expect(cardSessions.has('inbound_1')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('webhook: JSON parse error logging', () => {
|
||||
it('logs error message on malformed JSON body', async () => {
|
||||
// This test verifies the fix is in place by checking the source code
|
||||
// contains the error capture. A full integration test would require
|
||||
// starting an HTTP server.
|
||||
const channel = createChannel();
|
||||
const connectWebhook = getPrivateMethod<
|
||||
(
|
||||
port: number,
|
||||
verificationToken?: string,
|
||||
encryptKey?: string,
|
||||
) => Promise<void>
|
||||
>(channel, 'connectWebhook').bind(channel);
|
||||
|
||||
// Just verify the method exists and is callable
|
||||
expect(typeof connectWebhook).toBe('function');
|
||||
});
|
||||
});
|
||||
|
||||
describe('auxiliary map lifecycle', () => {
|
||||
it('preserves auxiliary maps after handleInbound when no card session exists', () => {
|
||||
const channel = createChannel();
|
||||
|
||||
// Simulate the state after processMessage populates maps but
|
||||
// handleInbound (collect mode) didn't create a card session
|
||||
const msgToQuestion = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToQuestion',
|
||||
);
|
||||
const msgToSenderName = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderName',
|
||||
);
|
||||
const msgToSenderId = getPrivateMethod<Map<string, string>>(
|
||||
channel,
|
||||
'msgToSenderId',
|
||||
);
|
||||
const cardSessions = getPrivateMethod<Map<string, unknown>>(
|
||||
channel,
|
||||
'cardSessions',
|
||||
);
|
||||
|
||||
// Populate auxiliary maps (as processMessage would)
|
||||
msgToQuestion.set('msg_collect', 'question?');
|
||||
msgToSenderName.set('msg_collect', '@sender');
|
||||
msgToSenderId.set('msg_collect', 'user_123');
|
||||
// No cardSession for msg_collect (collect mode)
|
||||
|
||||
// Verify maps are intact (the old code would have deleted them here)
|
||||
expect(msgToQuestion.has('msg_collect')).toBe(true);
|
||||
expect(msgToSenderName.has('msg_collect')).toBe(true);
|
||||
expect(msgToSenderId.has('msg_collect')).toBe(true);
|
||||
expect(cardSessions.has('msg_collect')).toBe(false);
|
||||
});
|
||||
});
|
||||
});
|
||||
13
packages/channels/feishu/src/index.ts
Normal file
13
packages/channels/feishu/src/index.ts
Normal file
@ -0,0 +1,13 @@
|
||||
export { FeishuChannel } from './FeishuAdapter.js';
|
||||
export { downloadMedia } from './media.js';
|
||||
|
||||
import { FeishuChannel } from './FeishuAdapter.js';
|
||||
import type { ChannelPlugin } from '@qwen-code/channel-base';
|
||||
|
||||
export const plugin: ChannelPlugin = {
|
||||
channelType: 'feishu',
|
||||
displayName: 'Feishu',
|
||||
requiredConfigFields: ['clientId', 'clientSecret'],
|
||||
createChannel: (name, config, bridge, options) =>
|
||||
new FeishuChannel(name, config, bridge, options),
|
||||
};
|
||||
179
packages/channels/feishu/src/markdown.test.ts
Normal file
179
packages/channels/feishu/src/markdown.test.ts
Normal file
@ -0,0 +1,179 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { buildCardContent, extractTitle, splitChunks } from './markdown.js';
|
||||
|
||||
interface CardElement {
|
||||
tag: string;
|
||||
content?: string;
|
||||
value?: Record<string, unknown>;
|
||||
elements?: CardElement[];
|
||||
}
|
||||
|
||||
interface CardStructure {
|
||||
schema: string;
|
||||
header?: { title: { content: string }; template: string };
|
||||
body: { elements: CardElement[] };
|
||||
}
|
||||
|
||||
describe('Feishu markdown utilities', () => {
|
||||
describe('buildCardContent', () => {
|
||||
it('returns a valid card structure', () => {
|
||||
const card = buildCardContent('Hello world') as unknown as CardStructure;
|
||||
expect(card.schema).toBe('2.0');
|
||||
expect(card.body.elements).toBeDefined();
|
||||
expect(card.body.elements[0]!.tag).toBe('markdown');
|
||||
expect(card.body.elements[0]!.content).toBe('Hello world');
|
||||
});
|
||||
|
||||
it('adds streaming indicator when isStreaming is true', () => {
|
||||
const card = buildCardContent('text', {
|
||||
isStreaming: true,
|
||||
}) as unknown as CardStructure;
|
||||
expect(card.body.elements[0]!.content).toContain('生成中...');
|
||||
});
|
||||
|
||||
it('adds stop button when showStopButton is true', () => {
|
||||
const card = buildCardContent('text', {
|
||||
showStopButton: true,
|
||||
}) as unknown as CardStructure;
|
||||
const button = card.body.elements.find((e) => e.tag === 'button');
|
||||
expect(button).toBeDefined();
|
||||
expect(button!.value).toEqual({ action: 'stop' });
|
||||
});
|
||||
|
||||
it('sets header with title', () => {
|
||||
const card = buildCardContent('text', {
|
||||
title: 'My Title',
|
||||
}) as unknown as CardStructure;
|
||||
expect(card.header!.title.content).toBe('My Title');
|
||||
expect(card.header!.template).toBe('green');
|
||||
});
|
||||
|
||||
it('sets blue header when streaming', () => {
|
||||
const card = buildCardContent('text', {
|
||||
title: 'Title',
|
||||
isStreaming: true,
|
||||
}) as unknown as CardStructure;
|
||||
expect(card.header!.template).toBe('blue');
|
||||
expect(card.header!.title.content).toBe('Title ...');
|
||||
});
|
||||
|
||||
it('uses collapsible panel for long content when enabled', () => {
|
||||
const longText = 'a'.repeat(600);
|
||||
const card = buildCardContent(longText, {
|
||||
collapsible: true,
|
||||
collapsibleThreshold: 500,
|
||||
}) as unknown as CardStructure;
|
||||
const panel = card.body.elements.find(
|
||||
(e) => e.tag === 'collapsible_panel',
|
||||
);
|
||||
expect(panel).toBeDefined();
|
||||
});
|
||||
|
||||
it('does not use collapsible for short content', () => {
|
||||
const card = buildCardContent('short', {
|
||||
collapsible: true,
|
||||
collapsibleThreshold: 500,
|
||||
}) as unknown as CardStructure;
|
||||
const panel = card.body.elements.find(
|
||||
(e) => e.tag === 'collapsible_panel',
|
||||
);
|
||||
expect(panel).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('extractTitle', () => {
|
||||
it('extracts title from first line', () => {
|
||||
expect(extractTitle('Hello World\nmore text')).toBe('Hello World');
|
||||
});
|
||||
|
||||
it('strips markdown heading markers', () => {
|
||||
expect(extractTitle('## My Title\ncontent')).toBe('My Title');
|
||||
});
|
||||
|
||||
it('strips bold/list markers', () => {
|
||||
expect(extractTitle('* Item one')).toBe('Item one');
|
||||
expect(extractTitle('> Quote text')).toBe('Quote text');
|
||||
});
|
||||
|
||||
it('truncates to 20 chars', () => {
|
||||
expect(
|
||||
extractTitle('This is a very long title that should be truncated')
|
||||
.length,
|
||||
).toBeLessThanOrEqual(20);
|
||||
});
|
||||
|
||||
it('returns default for empty text', () => {
|
||||
expect(extractTitle('')).toBe('Qwen Code');
|
||||
expect(extractTitle('###')).toBe('Qwen Code');
|
||||
});
|
||||
});
|
||||
|
||||
describe('splitChunks', () => {
|
||||
it('returns single chunk for short text', () => {
|
||||
expect(splitChunks('short text')).toEqual(['short text']);
|
||||
});
|
||||
|
||||
it('returns single chunk for empty text', () => {
|
||||
expect(splitChunks('')).toEqual(['']);
|
||||
});
|
||||
|
||||
it('splits long text into chunks', () => {
|
||||
const line = 'a'.repeat(100) + '\n';
|
||||
const text = line.repeat(50); // 5050 chars > 4000
|
||||
const chunks = splitChunks(text);
|
||||
expect(chunks.length).toBeGreaterThan(1);
|
||||
chunks.forEach((chunk) => {
|
||||
expect(chunk.length).toBeLessThanOrEqual(4100);
|
||||
});
|
||||
});
|
||||
|
||||
it('closes and reopens code fences across boundaries', () => {
|
||||
const longCode = '```\n' + 'x\n'.repeat(2500) + '```';
|
||||
const chunks = splitChunks(longCode);
|
||||
expect(chunks.length).toBeGreaterThan(1);
|
||||
expect(chunks[0]).toContain('```');
|
||||
if (chunks.length > 1) {
|
||||
expect(chunks[1]!.trimStart().startsWith('```')).toBe(true);
|
||||
}
|
||||
});
|
||||
|
||||
it('hard-splits a single line exceeding CHUNK_LIMIT', () => {
|
||||
const longLine = 'a'.repeat(5000);
|
||||
const chunks = splitChunks(longLine);
|
||||
expect(chunks.length).toBe(2);
|
||||
expect(chunks[0]!.length).toBe(4000);
|
||||
expect(chunks[1]!.length).toBe(1000);
|
||||
});
|
||||
});
|
||||
|
||||
describe('buildCardContent table splitting', () => {
|
||||
it('splits table and following content into separate elements', () => {
|
||||
const md = [
|
||||
'Before table',
|
||||
'| A | B |',
|
||||
'| --- | --- |',
|
||||
'| 1 | 2 |',
|
||||
'After table',
|
||||
].join('\n');
|
||||
const card = buildCardContent(md) as unknown as CardStructure;
|
||||
const mdElements = card.body.elements.filter((e) => e.tag === 'markdown');
|
||||
expect(mdElements.length).toBeGreaterThanOrEqual(3);
|
||||
});
|
||||
|
||||
it('keeps content without tables in one element', () => {
|
||||
const md = 'Hello\nWorld\nNo tables here';
|
||||
const card = buildCardContent(md) as unknown as CardStructure;
|
||||
const mdElements = card.body.elements.filter((e) => e.tag === 'markdown');
|
||||
expect(mdElements.length).toBe(1);
|
||||
});
|
||||
|
||||
it('does not split tables inside code fences', () => {
|
||||
const md = ['```', '| A | B |', '| --- | --- |', '| 1 | 2 |', '```'].join(
|
||||
'\n',
|
||||
);
|
||||
const card = buildCardContent(md) as unknown as CardStructure;
|
||||
const mdElements = card.body.elements.filter((e) => e.tag === 'markdown');
|
||||
expect(mdElements.length).toBe(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
256
packages/channels/feishu/src/markdown.ts
Normal file
256
packages/channels/feishu/src/markdown.ts
Normal file
@ -0,0 +1,256 @@
|
||||
/**
|
||||
* Feishu markdown / rich text helpers.
|
||||
*
|
||||
* Feishu supports Markdown in interactive cards but has quirks:
|
||||
* - Tables render only in card messages (not in plain text messages)
|
||||
* - Max message content ~4000 chars — split into chunks
|
||||
* - Code fences must be closed/reopened across chunk boundaries
|
||||
*/
|
||||
|
||||
const CHUNK_LIMIT = 4000;
|
||||
|
||||
/**
|
||||
* Split markdown into segments so that each segment contains at most one table.
|
||||
* This avoids Feishu card rendering issues when a single markdown element
|
||||
* contains a table followed by other content.
|
||||
*/
|
||||
function splitByTables(text: string): string[] {
|
||||
const lines = text.split('\n');
|
||||
const segments: string[] = [];
|
||||
let current: string[] = [];
|
||||
let inTable = false;
|
||||
let inCode = false;
|
||||
|
||||
for (const line of lines) {
|
||||
// Track code fences (parity-based to handle inline code on same line)
|
||||
if ((line.match(/```/g) || []).length % 2 === 1) {
|
||||
inCode = !inCode;
|
||||
current.push(line);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (inCode) {
|
||||
current.push(line);
|
||||
continue;
|
||||
}
|
||||
|
||||
const isTableLine =
|
||||
line.trim().startsWith('|') && line.trim().endsWith('|');
|
||||
|
||||
if (isTableLine && !inTable) {
|
||||
// Entering a table — if there's content before, flush it
|
||||
if (current.length > 0 && current.some((l) => l.trim())) {
|
||||
segments.push(current.join('\n'));
|
||||
current = [];
|
||||
}
|
||||
inTable = true;
|
||||
current.push(line);
|
||||
} else if (!isTableLine && inTable) {
|
||||
// Leaving a table — flush the table segment
|
||||
inTable = false;
|
||||
segments.push(current.join('\n'));
|
||||
current = [line];
|
||||
} else {
|
||||
current.push(line);
|
||||
}
|
||||
}
|
||||
|
||||
if (current.length > 0) {
|
||||
segments.push(current.join('\n'));
|
||||
}
|
||||
|
||||
return segments.filter((s) => s.trim());
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a Feishu interactive card JSON structure with markdown content.
|
||||
* Uses a clean design with header, streaming indicator, and optional stop button.
|
||||
*/
|
||||
export function buildCardContent(
|
||||
markdown: string,
|
||||
options?: {
|
||||
title?: string;
|
||||
showStopButton?: boolean;
|
||||
isStreaming?: boolean;
|
||||
collapsible?: boolean;
|
||||
collapsibleThreshold?: number;
|
||||
},
|
||||
): Record<string, unknown> {
|
||||
const elements: Array<Record<string, unknown>> = [];
|
||||
|
||||
// Main content + streaming indicator in one markdown block
|
||||
const contentMd = options?.isStreaming
|
||||
? markdown + '\n\n---\n*生成中...*'
|
||||
: markdown;
|
||||
|
||||
const threshold = options?.collapsibleThreshold || 500;
|
||||
|
||||
// For long content, use collapsible panel if enabled
|
||||
if (
|
||||
options?.collapsible &&
|
||||
!options?.isStreaming &&
|
||||
markdown.length > threshold
|
||||
) {
|
||||
// Find a split point near position 200 that doesn't break code fences
|
||||
const previewEnd = markdown.indexOf('\n', 200);
|
||||
const rawSplit = previewEnd > 0 ? previewEnd : 200;
|
||||
const safeSplit = markdown.lastIndexOf(' ', rawSplit);
|
||||
let splitAt = safeSplit > 100 ? safeSplit : rawSplit;
|
||||
// Verify fence parity at split point — if preview has odd fences,
|
||||
// move split to the nearest newline before/after where fences balance
|
||||
const previewCandidate = markdown.slice(0, splitAt);
|
||||
let fenceCount = 0;
|
||||
for (const line of previewCandidate.split('\n')) {
|
||||
if ((line.match(/```/g) || []).length % 2 === 1) fenceCount++;
|
||||
}
|
||||
if (fenceCount % 2 === 1) {
|
||||
// Inside a code block — find the closing fence and split after it
|
||||
const fenceStart = markdown.indexOf('\n```', splitAt);
|
||||
if (fenceStart > 0 && fenceStart < rawSplit + 500) {
|
||||
const fenceLineEnd = markdown.indexOf('\n', fenceStart + 1);
|
||||
splitAt = fenceLineEnd > 0 ? fenceLineEnd : fenceStart + 4;
|
||||
}
|
||||
// else: no nearby closing fence, accept the split as-is
|
||||
}
|
||||
const preview = markdown.slice(0, splitAt);
|
||||
const rest = markdown.slice(splitAt);
|
||||
|
||||
elements.push({
|
||||
tag: 'markdown',
|
||||
content: preview,
|
||||
});
|
||||
elements.push({
|
||||
tag: 'collapsible_panel',
|
||||
expanded: false,
|
||||
background_color: 'default',
|
||||
header: {
|
||||
title: {
|
||||
tag: 'plain_text',
|
||||
content: '查看更多',
|
||||
},
|
||||
},
|
||||
elements: [
|
||||
{
|
||||
tag: 'markdown',
|
||||
content: rest,
|
||||
},
|
||||
],
|
||||
});
|
||||
} else if (options?.isStreaming) {
|
||||
// During streaming, keep a single markdown element to avoid structure flicker
|
||||
elements.push({
|
||||
tag: 'markdown',
|
||||
content: contentMd,
|
||||
});
|
||||
} else {
|
||||
// Final render: split by tables to avoid rendering issues
|
||||
const segments = splitByTables(contentMd);
|
||||
for (const segment of segments) {
|
||||
elements.push({
|
||||
tag: 'markdown',
|
||||
content: segment,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Stop button
|
||||
if (options?.showStopButton) {
|
||||
elements.push({
|
||||
tag: 'button',
|
||||
text: {
|
||||
tag: 'plain_text',
|
||||
content: '停止',
|
||||
},
|
||||
type: 'danger',
|
||||
value: { action: 'stop' },
|
||||
});
|
||||
}
|
||||
|
||||
// Header
|
||||
const header = options?.title
|
||||
? {
|
||||
title: {
|
||||
tag: 'plain_text',
|
||||
content: options.isStreaming ? `${options.title} ...` : options.title,
|
||||
},
|
||||
template: options.isStreaming ? 'blue' : 'green',
|
||||
}
|
||||
: undefined;
|
||||
|
||||
return {
|
||||
schema: '2.0',
|
||||
config: {
|
||||
wide_screen_mode: true,
|
||||
summary: { content: markdown.slice(0, 3500) },
|
||||
},
|
||||
header,
|
||||
body: { elements },
|
||||
};
|
||||
}
|
||||
|
||||
/** Extract a short title from the first line of markdown. */
|
||||
export function extractTitle(text: string): string {
|
||||
const firstLine = text.split('\n')[0] || '';
|
||||
const cleaned = firstLine.replace(/^[#*\s\->]+/, '').slice(0, 20);
|
||||
return cleaned || 'Qwen Code';
|
||||
}
|
||||
|
||||
/**
|
||||
* Split long text into chunks that fit within Feishu's message size limit.
|
||||
* Handles code fence boundaries across chunks.
|
||||
*/
|
||||
export function splitChunks(text: string): string[] {
|
||||
if (!text || text.length <= CHUNK_LIMIT) {
|
||||
return [text];
|
||||
}
|
||||
|
||||
const chunks: string[] = [];
|
||||
let buf = '';
|
||||
const lines = text.split('\n');
|
||||
let inCode = false;
|
||||
let fenceLine = '```';
|
||||
|
||||
for (const line of lines) {
|
||||
const fenceCount = (line.match(/```/g) || []).length;
|
||||
|
||||
// Reserve space for closing fence when inside a code block
|
||||
const reserve = inCode ? fenceLine.length + 1 : 0;
|
||||
if (
|
||||
buf.length + line.length + 1 + reserve > CHUNK_LIMIT &&
|
||||
buf.length > 0
|
||||
) {
|
||||
if (inCode) {
|
||||
buf += '\n```';
|
||||
}
|
||||
chunks.push(buf);
|
||||
buf = inCode ? fenceLine : '';
|
||||
}
|
||||
|
||||
buf += (buf ? '\n' : '') + line;
|
||||
|
||||
// Hard-split oversized lines that exceed the limit on their own
|
||||
while (buf.length > CHUNK_LIMIT) {
|
||||
const maxSlice = inCode ? CHUNK_LIMIT - '\n```'.length - 1 : CHUNK_LIMIT;
|
||||
let piece = buf.slice(0, maxSlice);
|
||||
buf = buf.slice(maxSlice);
|
||||
if (inCode) {
|
||||
piece += '\n```';
|
||||
buf = fenceLine + '\n' + buf;
|
||||
}
|
||||
chunks.push(piece);
|
||||
}
|
||||
|
||||
if (fenceCount % 2 === 1) {
|
||||
if (!inCode) {
|
||||
fenceLine = line.trim();
|
||||
}
|
||||
inCode = !inCode;
|
||||
}
|
||||
}
|
||||
|
||||
if (buf) {
|
||||
chunks.push(buf);
|
||||
}
|
||||
|
||||
return chunks;
|
||||
}
|
||||
203
packages/channels/feishu/src/media.test.ts
Normal file
203
packages/channels/feishu/src/media.test.ts
Normal file
@ -0,0 +1,203 @@
|
||||
import {
|
||||
describe,
|
||||
it,
|
||||
expect,
|
||||
vi,
|
||||
beforeEach,
|
||||
afterEach,
|
||||
type MockInstance,
|
||||
} from 'vitest';
|
||||
import { downloadMedia } from './media.js';
|
||||
|
||||
describe('downloadMedia', () => {
|
||||
let fetchSpy: MockInstance<typeof fetch>;
|
||||
|
||||
beforeEach(() => {
|
||||
fetchSpy = vi.spyOn(globalThis, 'fetch');
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
fetchSpy.mockRestore();
|
||||
});
|
||||
|
||||
it('should download file successfully', async () => {
|
||||
const mockData = new Uint8Array([1, 2, 3, 4]);
|
||||
const mockResponse = {
|
||||
ok: true,
|
||||
headers: {
|
||||
get: (key: string) => {
|
||||
if (key === 'content-length') return '4';
|
||||
if (key === 'content-type') return 'image/png';
|
||||
return null;
|
||||
},
|
||||
},
|
||||
body: {
|
||||
getReader: () => ({
|
||||
read: vi
|
||||
.fn()
|
||||
.mockResolvedValueOnce({ done: false, value: mockData })
|
||||
.mockResolvedValueOnce({ done: true, value: undefined }),
|
||||
cancel: vi.fn(),
|
||||
}),
|
||||
},
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia(
|
||||
'om_valid_msg',
|
||||
'file_valid_key',
|
||||
'image',
|
||||
'valid_token',
|
||||
);
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result?.buffer).toEqual(Buffer.from(mockData));
|
||||
expect(result?.mimeType).toBe('image/png');
|
||||
});
|
||||
|
||||
it('should reject invalid messageId (path traversal)', async () => {
|
||||
const result = await downloadMedia(
|
||||
'../../../etc/passwd',
|
||||
'file_key',
|
||||
'file',
|
||||
'token',
|
||||
);
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(fetchSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should reject invalid fileKey (path traversal)', async () => {
|
||||
const result = await downloadMedia(
|
||||
'om_msg',
|
||||
'../../../etc/passwd',
|
||||
'file',
|
||||
'token',
|
||||
);
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(fetchSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should reject empty parameters', async () => {
|
||||
expect(await downloadMedia('', 'file_key', 'file', 'token')).toBeNull();
|
||||
expect(await downloadMedia('om_msg', '', 'file', 'token')).toBeNull();
|
||||
expect(await downloadMedia('om_msg', 'file_key', 'file', '')).toBeNull();
|
||||
expect(fetchSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should return null on HTTP error', async () => {
|
||||
const mockResponse = {
|
||||
ok: false,
|
||||
status: 404,
|
||||
text: vi.fn().mockResolvedValue('Not found'),
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should reject Content-Length exceeding 50MB', async () => {
|
||||
const largeSize = 60 * 1024 * 1024; // 60 MB
|
||||
const mockResponse = {
|
||||
ok: true,
|
||||
headers: {
|
||||
get: (key: string) => {
|
||||
if (key === 'content-length') return largeSize.toString();
|
||||
return null;
|
||||
},
|
||||
},
|
||||
body: {
|
||||
getReader: () => ({
|
||||
read: vi.fn().mockResolvedValue({ done: true, value: undefined }),
|
||||
cancel: vi.fn(),
|
||||
}),
|
||||
},
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should reject stream exceeding 50MB', async () => {
|
||||
const chunkSize = 10 * 1024 * 1024; // 10 MB per chunk
|
||||
const mockData = new Uint8Array(chunkSize);
|
||||
const cancelMock = vi.fn();
|
||||
const mockResponse = {
|
||||
ok: true,
|
||||
headers: {
|
||||
get: () => null, // No content-length header
|
||||
},
|
||||
body: {
|
||||
getReader: () => ({
|
||||
read: vi.fn().mockResolvedValue({ done: false, value: mockData }), // Infinite stream
|
||||
cancel: cancelMock,
|
||||
}),
|
||||
},
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(cancelMock).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('should return null when response body is null', async () => {
|
||||
const mockResponse = {
|
||||
ok: true,
|
||||
headers: {
|
||||
get: () => null,
|
||||
},
|
||||
body: null,
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle network errors', async () => {
|
||||
fetchSpy.mockRejectedValueOnce(new Error('Network error'));
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle missing content-type header', async () => {
|
||||
const mockData = new Uint8Array([1, 2, 3]);
|
||||
const mockResponse = {
|
||||
ok: true,
|
||||
headers: {
|
||||
get: () => null, // No content-type
|
||||
},
|
||||
body: {
|
||||
getReader: () => ({
|
||||
read: vi
|
||||
.fn()
|
||||
.mockResolvedValueOnce({ done: false, value: mockData })
|
||||
.mockResolvedValueOnce({ done: true, value: undefined }),
|
||||
cancel: vi.fn(),
|
||||
}),
|
||||
},
|
||||
};
|
||||
|
||||
fetchSpy.mockResolvedValueOnce(mockResponse as unknown as Response);
|
||||
|
||||
const result = await downloadMedia('om_msg', 'file_key', 'file', 'token');
|
||||
|
||||
expect(result).not.toBeNull();
|
||||
expect(result?.mimeType).toBe('application/octet-stream'); // Default
|
||||
});
|
||||
});
|
||||
102
packages/channels/feishu/src/media.ts
Normal file
102
packages/channels/feishu/src/media.ts
Normal file
@ -0,0 +1,102 @@
|
||||
/**
|
||||
* Feishu media download helpers.
|
||||
*
|
||||
* Downloads images, files, audio, and video from Feishu using the
|
||||
* Open API: GET /im/v1/messages/:message_id/resources/:file_key
|
||||
*/
|
||||
|
||||
const BASE_URL = 'https://open.feishu.cn/open-apis';
|
||||
|
||||
/** Validate Feishu ID format to prevent path traversal in URL interpolation. */
|
||||
const FEISHU_ID_RE = /^[a-zA-Z0-9_.:-]+$/;
|
||||
|
||||
export interface MediaFile {
|
||||
buffer: Buffer;
|
||||
mimeType: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Download a media file from Feishu.
|
||||
*
|
||||
* @param messageId - The message ID containing the resource
|
||||
* @param fileKey - The file_key or image_key from the message content
|
||||
* @param resourceType - 'image' or 'file'
|
||||
* @param accessToken - A valid tenant access token
|
||||
* @returns MediaFile with buffer and mimeType, or null on failure
|
||||
*/
|
||||
export async function downloadMedia(
|
||||
messageId: string,
|
||||
fileKey: string,
|
||||
resourceType: 'image' | 'file',
|
||||
accessToken: string,
|
||||
): Promise<MediaFile | null> {
|
||||
if (
|
||||
!messageId ||
|
||||
!fileKey ||
|
||||
!accessToken ||
|
||||
!FEISHU_ID_RE.test(messageId) ||
|
||||
!FEISHU_ID_RE.test(fileKey)
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
const url = `${BASE_URL}/im/v1/messages/${messageId}/resources/${fileKey}?type=${resourceType}`;
|
||||
const resp = await fetch(url, {
|
||||
method: 'GET',
|
||||
headers: {
|
||||
Authorization: `Bearer ${accessToken}`,
|
||||
},
|
||||
signal: AbortSignal.timeout(30_000),
|
||||
});
|
||||
|
||||
if (!resp.ok) {
|
||||
const detail = await resp.text().catch(() => '');
|
||||
process.stderr.write(
|
||||
`[Feishu] downloadMedia failed: HTTP ${resp.status} ${detail}\n`,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
|
||||
const MAX_DOWNLOAD_BYTES = 50 * 1024 * 1024; // 50 MB
|
||||
const contentLength = resp.headers.get('content-length');
|
||||
if (contentLength && parseInt(contentLength, 10) > MAX_DOWNLOAD_BYTES) {
|
||||
process.stderr.write(
|
||||
`[Feishu] downloadMedia rejected: size ${contentLength} exceeds ${MAX_DOWNLOAD_BYTES} byte limit\n`,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
|
||||
const mimeType =
|
||||
resp.headers.get('content-type') || 'application/octet-stream';
|
||||
|
||||
// Stream-read with size enforcement (handles chunked transfer without Content-Length)
|
||||
const reader = resp.body?.getReader();
|
||||
if (!reader) {
|
||||
return null;
|
||||
}
|
||||
const chunks: Buffer[] = [];
|
||||
let totalSize = 0;
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
totalSize += value.byteLength;
|
||||
if (totalSize > MAX_DOWNLOAD_BYTES) {
|
||||
reader.cancel();
|
||||
process.stderr.write(
|
||||
`[Feishu] downloadMedia rejected: actual size exceeds ${MAX_DOWNLOAD_BYTES} byte limit\n`,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
chunks.push(Buffer.from(value));
|
||||
}
|
||||
const buffer = Buffer.concat(chunks);
|
||||
|
||||
return { buffer, mimeType };
|
||||
} catch (err) {
|
||||
process.stderr.write(
|
||||
`[Feishu] downloadMedia error: ${err instanceof Error ? err.message : err}\n`,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
10
packages/channels/feishu/tsconfig.json
Normal file
10
packages/channels/feishu/tsconfig.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "dist",
|
||||
"rootDir": "src"
|
||||
},
|
||||
"include": ["src/**/*.ts"],
|
||||
"exclude": ["node_modules", "dist", "src/**/*.test.ts"],
|
||||
"references": [{ "path": "../base" }]
|
||||
}
|
||||
8
packages/channels/feishu/vitest.config.ts
Normal file
8
packages/channels/feishu/vitest.config.ts
Normal file
@ -0,0 +1,8 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
include: ['src/**/*.test.ts'],
|
||||
globals: true,
|
||||
},
|
||||
});
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-plugin-example",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-telegram",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "Telegram channel adapter for Qwen Code",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/channel-weixin",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "WeChat (Weixin) channel adapter for Qwen Code",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
|
||||
@ -19,8 +19,8 @@ function decryptAesEcb(ciphertext: Buffer, key: Buffer): Buffer {
|
||||
/**
|
||||
* Parse aes_key from CDNMedia into a raw 16-byte Buffer.
|
||||
* Two encodings exist:
|
||||
* - base64(raw 16 bytes) → images
|
||||
* - base64(hex string of 16 bytes) → file/voice/video
|
||||
* - base64(raw 16 bytes)
|
||||
* - base64(hex string of 16 bytes)
|
||||
*/
|
||||
export function parseAesKey(aesKeyBase64: string): Buffer {
|
||||
const decoded = Buffer.from(aesKeyBase64, 'base64');
|
||||
|
||||
@ -240,6 +240,45 @@ describe('validateImagePath', () => {
|
||||
);
|
||||
});
|
||||
|
||||
it('allows Windows paths inside the workspace directory', () => {
|
||||
const imagePath = 'D:\\WorkGroup\\QwenCode\\002\\hello.png';
|
||||
const workspaceDir = 'D:\\WorkGroup\\QwenCode\\002';
|
||||
mockRealpathSync.mockImplementation((p: string) => {
|
||||
if (p.includes('hello.png')) return imagePath;
|
||||
if (p.includes('QwenCode\\002')) return workspaceDir;
|
||||
return p;
|
||||
});
|
||||
|
||||
expect(validateImagePath(imagePath, [workspaceDir])).toBe(imagePath);
|
||||
});
|
||||
|
||||
it('rejects Windows paths in a sibling directory with the same prefix', () => {
|
||||
const imagePath = 'D:\\WorkGroup\\QwenCode\\0022\\hello.png';
|
||||
const workspaceDir = 'D:\\WorkGroup\\QwenCode\\002';
|
||||
mockRealpathSync.mockImplementation((p: string) => {
|
||||
if (p.includes('hello.png')) return imagePath;
|
||||
if (p.includes('QwenCode\\002')) return workspaceDir;
|
||||
return p;
|
||||
});
|
||||
|
||||
expect(() => validateImagePath(imagePath, [workspaceDir])).toThrow(
|
||||
'Image path outside allowed directories',
|
||||
);
|
||||
});
|
||||
|
||||
it('does not treat POSIX backslashes as directory separators', () => {
|
||||
const imagePath = '/home/user/project\\escape.png';
|
||||
mockRealpathSync.mockImplementation((p: string) => {
|
||||
if (p.includes('escape.png')) return imagePath;
|
||||
if (p === '/home/user/project') return '/home/user/project';
|
||||
return p;
|
||||
});
|
||||
|
||||
expect(() => validateImagePath(imagePath, workspaceDirs)).toThrow(
|
||||
'Image path outside allowed directories',
|
||||
);
|
||||
});
|
||||
|
||||
it('rejects image with magic bytes that do not match extension', () => {
|
||||
// readSync returns JPEG magic, but file extension is .png
|
||||
vi.mocked(fs.readSync).mockImplementation((_fd: number, buf: Buffer) => {
|
||||
@ -325,8 +364,13 @@ describe('sendImage', () => {
|
||||
expectedEncrypted,
|
||||
);
|
||||
|
||||
// Step 4: send message with image_item using CDN's x-encrypted-param
|
||||
const expectedAesKeyBase64 = aesKeyBytes.toString('base64');
|
||||
// Step 4: send message with image_item using CDN's x-encrypted-param.
|
||||
// WeChat expects images to include the hex key both directly and
|
||||
// base64-encoded in the media payload.
|
||||
const expectedAesKeyBase64 = Buffer.from(
|
||||
expectedAesKeyHex,
|
||||
'ascii',
|
||||
).toString('base64');
|
||||
expect(mockSendMessage).toHaveBeenCalledWith(
|
||||
'https://api.example.com',
|
||||
'token-abc',
|
||||
@ -337,6 +381,8 @@ describe('sendImage', () => {
|
||||
expect.objectContaining({
|
||||
type: 2, // MessageItemType.IMAGE
|
||||
image_item: expect.objectContaining({
|
||||
aeskey: expectedAesKeyHex,
|
||||
mid_size: encryptedSize,
|
||||
media: {
|
||||
encrypt_query_param: 'cdn-encrypt-param',
|
||||
aes_key: expectedAesKeyBase64,
|
||||
|
||||
@ -12,7 +12,7 @@ import {
|
||||
closeSync,
|
||||
} from 'node:fs';
|
||||
import { tmpdir } from 'node:os';
|
||||
import { resolve, extname } from 'node:path';
|
||||
import { resolve, extname, win32, posix } from 'node:path';
|
||||
import { sendMessage, getUploadUrl, uploadToCdn } from './api.js';
|
||||
import { MessageType, MessageState, MessageItemType } from './types.js';
|
||||
import { encryptAesEcb, computeMd5 } from './media.js';
|
||||
@ -45,6 +45,28 @@ export function markdownToPlainText(text: string): string {
|
||||
const ALLOWED_EXTS = new Set(['.png', '.jpg', '.jpeg', '.gif', '.webp']);
|
||||
const MAX_IMAGE_SIZE = 20 * 1024 * 1024; // 20 MB
|
||||
|
||||
function looksLikeWindowsPath(pathValue: string): boolean {
|
||||
return /^[a-zA-Z]:[\\/]/.test(pathValue) || pathValue.startsWith('\\\\');
|
||||
}
|
||||
|
||||
function normalizeWindowsPath(pathValue: string): string {
|
||||
return pathValue.replace(/\//g, '\\');
|
||||
}
|
||||
|
||||
function isInsideAllowedDir(realPath: string, allowedDir: string): boolean {
|
||||
const windowsStyle =
|
||||
looksLikeWindowsPath(realPath) || looksLikeWindowsPath(allowedDir);
|
||||
const pathImpl = windowsStyle ? win32 : posix;
|
||||
const from = windowsStyle ? normalizeWindowsPath(allowedDir) : allowedDir;
|
||||
const to = windowsStyle ? normalizeWindowsPath(realPath) : realPath;
|
||||
const relative = pathImpl.relative(from, to);
|
||||
|
||||
return (
|
||||
relative === '' ||
|
||||
(!relative.startsWith('..') && !pathImpl.isAbsolute(relative))
|
||||
);
|
||||
}
|
||||
|
||||
/** Image magic bytes → MIME type mapping. */
|
||||
export function detectImageMime(data: Buffer): string {
|
||||
if (
|
||||
@ -125,7 +147,7 @@ export function validateImagePath(
|
||||
...workspaceDirs.map((d) => realpathSync(resolve(d)) + '/'),
|
||||
];
|
||||
|
||||
if (!ALLOWED_DIRS.some((dir) => real.startsWith(dir))) {
|
||||
if (!ALLOWED_DIRS.some((dir) => isInsideAllowedDir(real, dir))) {
|
||||
throw new Error(`Image path outside allowed directories: ${real}`);
|
||||
}
|
||||
|
||||
@ -231,9 +253,10 @@ export async function sendImage(params: {
|
||||
const encrypted = encryptAesEcb(fileBuffer, aesKeyBytes);
|
||||
const cdnEncryptParam = await uploadToCdn(uploadParam, filekey, encrypted);
|
||||
|
||||
// Step 4: send message with image_item using CDN's x-encrypted-param
|
||||
// aes_key: base64(raw 16 bytes) for images per protocol
|
||||
const aesKeyBase64 = aesKeyBytes.toString('base64');
|
||||
// Step 4: send message with image_item using CDN's x-encrypted-param.
|
||||
// WeChat image messages expect the AES key as a hex string, with media.aes_key
|
||||
// carrying base64(hex string), not base64(raw bytes).
|
||||
const aesKeyBase64 = Buffer.from(aesKeyHex, 'ascii').toString('base64');
|
||||
|
||||
await sendMessage(baseUrl, token, {
|
||||
to_user_id: to,
|
||||
@ -246,6 +269,8 @@ export async function sendImage(params: {
|
||||
{
|
||||
type: MessageItemType.IMAGE,
|
||||
image_item: {
|
||||
aeskey: aesKeyHex,
|
||||
mid_size: encryptedSize,
|
||||
media: {
|
||||
encrypt_query_param: cdnEncryptParam,
|
||||
aes_key: aesKeyBase64,
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@qwen-code/qwen-code",
|
||||
"version": "0.16.0",
|
||||
"version": "0.17.0",
|
||||
"description": "Qwen Code",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -37,7 +37,7 @@
|
||||
"dist"
|
||||
],
|
||||
"config": {
|
||||
"sandboxImageUri": "ghcr.io/qwenlm/qwen-code:0.16.0"
|
||||
"sandboxImageUri": "ghcr.io/qwenlm/qwen-code:0.17.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@agentclientprotocol/sdk": "^0.14.1",
|
||||
@ -47,6 +47,7 @@
|
||||
"@qwen-code/acp-bridge": "file:../acp-bridge",
|
||||
"@qwen-code/channel-base": "file:../channels/base",
|
||||
"@qwen-code/channel-dingtalk": "file:../channels/dingtalk",
|
||||
"@qwen-code/channel-feishu": "file:../channels/feishu",
|
||||
"@qwen-code/channel-telegram": "file:../channels/telegram",
|
||||
"@qwen-code/channel-weixin": "file:../channels/weixin",
|
||||
"@qwen-code/qwen-code-core": "file:../core",
|
||||
|
||||
@ -145,7 +145,20 @@ vi.mock('./runtimeOutputDirContext.js', () => ({
|
||||
),
|
||||
}));
|
||||
|
||||
vi.mock('./authMethods.js', () => ({ buildAuthMethods: vi.fn() }));
|
||||
vi.mock('./authMethods.js', () => {
|
||||
const buildAuthMethods = vi.fn();
|
||||
return {
|
||||
buildAuthMethods,
|
||||
pickAuthMethodsForAuthRequired: vi.fn((selectedType?: string) => {
|
||||
const authMethods = buildAuthMethods();
|
||||
if (!selectedType) return authMethods;
|
||||
const matched = authMethods.filter(
|
||||
(method: { id: string }) => method.id === selectedType,
|
||||
);
|
||||
return matched.length ? matched : authMethods;
|
||||
}),
|
||||
};
|
||||
});
|
||||
vi.mock('./service/filesystem.js', () => ({
|
||||
AcpFileSystemService: vi.fn(),
|
||||
}));
|
||||
@ -195,6 +208,7 @@ import { loadSettings } from '../config/settings.js';
|
||||
import { loadCliConfig } from '../config/config.js';
|
||||
import { Session, buildAvailableCommandsSnapshot } from './session/Session.js';
|
||||
import { SERVE_STATUS_EXT_METHODS } from '../serve/status.js';
|
||||
import { buildAuthMethods } from './authMethods.js';
|
||||
|
||||
describe('runAcpAgent shutdown cleanup', () => {
|
||||
let processExitSpy: MockInstance<typeof process.exit>;
|
||||
@ -792,6 +806,64 @@ describe('QwenAgent MCP SSE/HTTP support', () => {
|
||||
await agentPromise;
|
||||
});
|
||||
|
||||
it('does not return discontinued qwen-oauth as the only ACP auth option', async () => {
|
||||
vi.mocked(buildAuthMethods).mockReturnValue([
|
||||
{
|
||||
id: 'openai',
|
||||
name: 'Use OpenAI API key',
|
||||
description: 'Requires setting OPENAI_API_KEY',
|
||||
},
|
||||
]);
|
||||
|
||||
const innerConfig = makeInnerConfig();
|
||||
vi.mocked(innerConfig.getModelsConfig).mockReturnValue({
|
||||
getCurrentAuthType: vi.fn().mockReturnValue('qwen-oauth'),
|
||||
} as unknown as ReturnType<Config['getModelsConfig']>);
|
||||
vi.mocked(innerConfig.refreshAuth).mockRejectedValue(
|
||||
new Error('qwen-oauth token expired'),
|
||||
);
|
||||
vi.mocked(loadSettings).mockReturnValue(makeSessionSettings());
|
||||
vi.mocked(loadCliConfig).mockResolvedValue(
|
||||
innerConfig as unknown as Config,
|
||||
);
|
||||
|
||||
vi.mocked(Session).mockImplementation(
|
||||
() =>
|
||||
({
|
||||
getId: vi.fn().mockReturnValue('test-session-id'),
|
||||
getConfig: vi.fn().mockReturnValue(innerConfig),
|
||||
sendAvailableCommandsUpdate: vi.fn().mockResolvedValue(undefined),
|
||||
replayHistory: vi.fn().mockResolvedValue(undefined),
|
||||
installRewriter: vi.fn(),
|
||||
}) as unknown as InstanceType<typeof Session>,
|
||||
);
|
||||
|
||||
const agentPromise = runAcpAgent(
|
||||
mockConfig,
|
||||
makeSessionSettings(),
|
||||
mockArgv,
|
||||
);
|
||||
await vi.waitFor(() => expect(capturedAgentFactory).toBeDefined());
|
||||
const agent = capturedAgentFactory!({
|
||||
get closed() {
|
||||
return mockConnectionState.promise;
|
||||
},
|
||||
}) as AgentLike;
|
||||
|
||||
await expect(
|
||||
agent.newSession({ cwd: '/tmp', mcpServers: [] }),
|
||||
).rejects.toMatchObject({
|
||||
authMethods: [
|
||||
expect.objectContaining({
|
||||
id: 'openai',
|
||||
}),
|
||||
],
|
||||
});
|
||||
|
||||
mockConnectionState.resolve();
|
||||
await agentPromise;
|
||||
});
|
||||
|
||||
function makeInnerConfig() {
|
||||
return {
|
||||
initialize: vi.fn().mockResolvedValue(undefined),
|
||||
|
||||
@ -40,7 +40,6 @@ import type { Content } from '@google/genai';
|
||||
import type {
|
||||
Agent,
|
||||
AuthenticateRequest,
|
||||
AuthMethod,
|
||||
CancelNotification,
|
||||
ClientCapabilities,
|
||||
InitializeRequest,
|
||||
@ -69,7 +68,10 @@ import type {
|
||||
SetSessionModeRequest,
|
||||
SetSessionModeResponse,
|
||||
} from '@agentclientprotocol/sdk';
|
||||
import { buildAuthMethods } from './authMethods.js';
|
||||
import {
|
||||
buildAuthMethods,
|
||||
pickAuthMethodsForAuthRequired,
|
||||
} from './authMethods.js';
|
||||
import { AcpFileSystemService } from './service/filesystem.js';
|
||||
import { Readable, Writable } from 'node:stream';
|
||||
import type { LoadedSettings } from '../config/settings.js';
|
||||
@ -1936,7 +1938,7 @@ class QwenAgent implements Agent {
|
||||
const selectedType = config.getModelsConfig().getCurrentAuthType();
|
||||
if (!selectedType) {
|
||||
throw RequestError.authRequired(
|
||||
{ authMethods: this.pickAuthMethodsForAuthRequired() },
|
||||
{ authMethods: pickAuthMethodsForAuthRequired() },
|
||||
'Use Qwen Code CLI to authenticate first.',
|
||||
);
|
||||
}
|
||||
@ -1947,51 +1949,13 @@ class QwenAgent implements Agent {
|
||||
debugLogger.error(`Authentication failed: ${e}`);
|
||||
throw RequestError.authRequired(
|
||||
{
|
||||
authMethods: this.pickAuthMethodsForAuthRequired(selectedType, e),
|
||||
authMethods: pickAuthMethodsForAuthRequired(selectedType),
|
||||
},
|
||||
'Authentication failed: ' + (e as Error).message,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
private pickAuthMethodsForAuthRequired(
|
||||
selectedType?: AuthType | string,
|
||||
error?: unknown,
|
||||
): AuthMethod[] {
|
||||
const authMethods = buildAuthMethods();
|
||||
const errorMessage = this.extractErrorMessage(error);
|
||||
if (
|
||||
errorMessage?.includes('qwen-oauth') ||
|
||||
errorMessage?.includes('Qwen OAuth')
|
||||
) {
|
||||
const qwenOAuthMethods = authMethods.filter(
|
||||
(m) => m.id === AuthType.QWEN_OAUTH,
|
||||
);
|
||||
return qwenOAuthMethods.length ? qwenOAuthMethods : authMethods;
|
||||
}
|
||||
|
||||
if (selectedType) {
|
||||
const matched = authMethods.filter((m) => m.id === selectedType);
|
||||
return matched.length ? matched : authMethods;
|
||||
}
|
||||
|
||||
return authMethods;
|
||||
}
|
||||
|
||||
private extractErrorMessage(error?: unknown): string | undefined {
|
||||
if (error instanceof Error) return error.message;
|
||||
if (
|
||||
typeof error === 'object' &&
|
||||
error != null &&
|
||||
'message' in error &&
|
||||
typeof error.message === 'string'
|
||||
) {
|
||||
return error.message;
|
||||
}
|
||||
if (typeof error === 'string') return error;
|
||||
return undefined;
|
||||
}
|
||||
|
||||
private setupFileSystem(config: Config): void {
|
||||
if (!this.clientCapabilities?.fs) return;
|
||||
|
||||
|
||||
@ -125,7 +125,20 @@ vi.mock('./runtimeOutputDirContext.js', () => ({
|
||||
),
|
||||
}));
|
||||
|
||||
vi.mock('./authMethods.js', () => ({ buildAuthMethods: vi.fn() }));
|
||||
vi.mock('./authMethods.js', () => {
|
||||
const buildAuthMethods = vi.fn();
|
||||
return {
|
||||
buildAuthMethods,
|
||||
pickAuthMethodsForAuthRequired: vi.fn((selectedType?: string) => {
|
||||
const authMethods = buildAuthMethods();
|
||||
if (!selectedType) return authMethods;
|
||||
const matched = authMethods.filter(
|
||||
(method: { id: string }) => method.id === selectedType,
|
||||
);
|
||||
return matched.length ? matched : authMethods;
|
||||
}),
|
||||
};
|
||||
});
|
||||
vi.mock('./service/filesystem.js', () => ({
|
||||
AcpFileSystemService: vi.fn(),
|
||||
}));
|
||||
|
||||
30
packages/cli/src/acp-integration/authMethods.test.ts
Normal file
30
packages/cli/src/acp-integration/authMethods.test.ts
Normal file
@ -0,0 +1,30 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright 2025 Qwen Team
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { AuthType } from '@qwen-code/qwen-code-core';
|
||||
import {
|
||||
buildAuthMethods,
|
||||
pickAuthMethodsForAuthRequired,
|
||||
} from './authMethods.js';
|
||||
|
||||
describe('ACP auth methods', () => {
|
||||
it('does not advertise discontinued Qwen OAuth', () => {
|
||||
const authMethods = buildAuthMethods();
|
||||
|
||||
expect(authMethods.map((method) => method.id)).toEqual([
|
||||
AuthType.USE_OPENAI,
|
||||
]);
|
||||
});
|
||||
|
||||
it('falls back to working methods for a stored discontinued Qwen OAuth selection', () => {
|
||||
const authMethods = pickAuthMethodsForAuthRequired('qwen-oauth');
|
||||
|
||||
expect(authMethods.map((method) => method.id)).toEqual([
|
||||
AuthType.USE_OPENAI,
|
||||
]);
|
||||
});
|
||||
});
|
||||
@ -18,33 +18,17 @@ export function buildAuthMethods(): AuthMethod[] {
|
||||
args: ['--auth-type=openai'],
|
||||
},
|
||||
},
|
||||
{
|
||||
id: AuthType.QWEN_OAUTH,
|
||||
name: 'Qwen OAuth',
|
||||
description: 'Qwen OAuth (free tier discontinued 2026-04-15)',
|
||||
_meta: {
|
||||
type: 'terminal',
|
||||
args: ['--auth-type=qwen-oauth'],
|
||||
},
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
export function filterAuthMethodsById(
|
||||
authMethods: AuthMethod[],
|
||||
authMethodId: string,
|
||||
export function pickAuthMethodsForAuthRequired(
|
||||
selectedType?: AuthType | string,
|
||||
): AuthMethod[] {
|
||||
return authMethods.filter((method) => method.id === authMethodId);
|
||||
}
|
||||
|
||||
export function pickAuthMethodsForDetails(details?: string): AuthMethod[] {
|
||||
const authMethods = buildAuthMethods();
|
||||
if (!details) {
|
||||
return authMethods;
|
||||
}
|
||||
if (details.includes('qwen-oauth') || details.includes('Qwen OAuth')) {
|
||||
const narrowed = filterAuthMethodsById(authMethods, AuthType.QWEN_OAUTH);
|
||||
return narrowed.length ? narrowed : authMethods;
|
||||
if (selectedType) {
|
||||
const matched = authMethods.filter((method) => method.id === selectedType);
|
||||
return matched.length ? matched : authMethods;
|
||||
}
|
||||
|
||||
return authMethods;
|
||||
}
|
||||
|
||||
@ -8,7 +8,11 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import * as fs from 'node:fs/promises';
|
||||
import * as os from 'node:os';
|
||||
import * as path from 'node:path';
|
||||
import { computeInitialTurnFromHistory, Session } from './Session.js';
|
||||
import {
|
||||
computeInitialTurnFromHistory,
|
||||
fireSessionPermissionDeniedForAutoMode,
|
||||
Session,
|
||||
} from './Session.js';
|
||||
import type { Content } from '@google/genai';
|
||||
import type { ChatRecord, Config, GeminiChat } from '@qwen-code/qwen-code-core';
|
||||
import { ApprovalMode, AuthType } from '@qwen-code/qwen-code-core';
|
||||
@ -192,6 +196,8 @@ describe('Session', () => {
|
||||
sendMessageStream: vi.fn(),
|
||||
addHistory: vi.fn(),
|
||||
getHistory: vi.fn().mockReturnValue([]),
|
||||
getHistoryShallow: vi.fn().mockReturnValue([]),
|
||||
getLastModelMessageText: vi.fn().mockReturnValue(''),
|
||||
setHistory: vi.fn(),
|
||||
truncateHistory: vi.fn(),
|
||||
stripThoughtsFromHistory: vi.fn(),
|
||||
@ -325,6 +331,7 @@ describe('Session', () => {
|
||||
{ role: 'model', parts: [{ text: 'second reply' }] },
|
||||
];
|
||||
vi.mocked(mockChat.getHistory).mockReturnValue(history);
|
||||
vi.mocked(mockChat.getHistoryShallow).mockReturnValue(history);
|
||||
|
||||
const result = session.rewindToTurn(1);
|
||||
|
||||
@ -344,6 +351,7 @@ describe('Session', () => {
|
||||
{ role: 'model', parts: [{ text: 'first reply' }] },
|
||||
];
|
||||
vi.mocked(mockChat.getHistory).mockReturnValue(history);
|
||||
vi.mocked(mockChat.getHistoryShallow).mockReturnValue(history);
|
||||
|
||||
const result = session.rewindToTurn(0);
|
||||
|
||||
@ -352,9 +360,9 @@ describe('Session', () => {
|
||||
});
|
||||
|
||||
it('rejects unreachable user turns', () => {
|
||||
vi.mocked(mockChat.getHistory).mockReturnValue([
|
||||
{ role: 'user', parts: [{ text: 'first' }] },
|
||||
]);
|
||||
const history: Content[] = [{ role: 'user', parts: [{ text: 'first' }] }];
|
||||
vi.mocked(mockChat.getHistory).mockReturnValue(history);
|
||||
vi.mocked(mockChat.getHistoryShallow).mockReturnValue(history);
|
||||
|
||||
expect(() => session.rewindToTurn(2)).toThrow(
|
||||
'Cannot rewind to the requested turn',
|
||||
@ -849,6 +857,8 @@ describe('Session', () => {
|
||||
sendMessageStream: vi.fn().mockResolvedValue(createEmptyStream()),
|
||||
addHistory: vi.fn(),
|
||||
getHistory: vi.fn().mockReturnValue([]),
|
||||
getHistoryShallow: vi.fn().mockReturnValue([]),
|
||||
getLastModelMessageText: vi.fn().mockReturnValue(''),
|
||||
} as unknown as GeminiChat;
|
||||
|
||||
mockChat.sendMessageStream = vi
|
||||
@ -908,6 +918,36 @@ describe('Session', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('labels the notice as screenshot-triggered when triggerReason is image_overflow', async () => {
|
||||
mockGeminiClient.tryCompressChat.mockResolvedValueOnce({
|
||||
originalTokenCount: 1200,
|
||||
newTokenCount: 450,
|
||||
compressionStatus: core.CompressionStatus.COMPRESSED,
|
||||
triggerReason: 'image_overflow',
|
||||
});
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValue(createEmptyStream());
|
||||
|
||||
await session.prompt({
|
||||
sessionId: 'test-session-id',
|
||||
prompt: [{ type: 'text', text: 'hello' }],
|
||||
});
|
||||
|
||||
expect(mockClient.sessionUpdate).toHaveBeenCalledWith({
|
||||
sessionId: 'test-session-id',
|
||||
update: {
|
||||
sessionUpdate: 'agent_message_chunk',
|
||||
content: {
|
||||
type: 'text',
|
||||
text:
|
||||
'IMPORTANT: This conversation accumulated enough tool screenshots to trigger compaction for qwen3-code-plus. ' +
|
||||
'A compressed context will be sent for future messages (compressed from: 1200 to 450 tokens).',
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('continues sending when automatic compression fails', async () => {
|
||||
mockGeminiClient.tryCompressChat.mockRejectedValueOnce(
|
||||
new Error('compression rate limited'),
|
||||
@ -1173,6 +1213,8 @@ describe('Session', () => {
|
||||
sendMessageStream: vi.fn().mockResolvedValue(createEmptyStream()),
|
||||
addHistory: vi.fn(),
|
||||
getHistory: vi.fn().mockReturnValue([]),
|
||||
getHistoryShallow: vi.fn().mockReturnValue([]),
|
||||
getLastModelMessageText: vi.fn().mockReturnValue(''),
|
||||
} as unknown as GeminiChat;
|
||||
mockConfig.getSessionTokenLimit = vi.fn().mockReturnValue(100);
|
||||
mockGeminiClient.tryCompressChat
|
||||
@ -1489,6 +1531,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValueOnce(createEmptyStream())
|
||||
@ -1550,6 +1595,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValueOnce(createEmptyStream())
|
||||
@ -1621,6 +1669,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValue(createEmptyStream());
|
||||
@ -2170,6 +2221,129 @@ describe('Session', () => {
|
||||
});
|
||||
|
||||
describe('hooks', () => {
|
||||
describe('PermissionDenied hook', () => {
|
||||
it('fires PermissionDenied hooks for AUTO classifier blocks', async () => {
|
||||
const hookSystem = {
|
||||
firePermissionDeniedEvent: vi.fn().mockResolvedValue(undefined),
|
||||
};
|
||||
mockConfig.getHookSystem = vi.fn().mockReturnValue(hookSystem);
|
||||
mockConfig.getDisableAllHooks = vi.fn().mockReturnValue(false);
|
||||
const signal = new AbortController().signal;
|
||||
|
||||
await fireSessionPermissionDeniedForAutoMode(
|
||||
mockConfig,
|
||||
{
|
||||
via: 'classifier',
|
||||
shouldBlock: true,
|
||||
reason: 'dangerous shell command',
|
||||
unavailable: false,
|
||||
stage: 'fast',
|
||||
durationMs: 20,
|
||||
},
|
||||
{ kind: 'blocked', errorMessage: 'blocked' },
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
signal,
|
||||
);
|
||||
|
||||
expect(hookSystem.firePermissionDeniedEvent).toHaveBeenCalledWith(
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
'classifier_blocked',
|
||||
signal,
|
||||
);
|
||||
});
|
||||
|
||||
it('forwards classifier_unavailable reasons to PermissionDenied hooks', async () => {
|
||||
const hookSystem = {
|
||||
firePermissionDeniedEvent: vi.fn().mockResolvedValue(undefined),
|
||||
};
|
||||
mockConfig.getHookSystem = vi.fn().mockReturnValue(hookSystem);
|
||||
mockConfig.getDisableAllHooks = vi.fn().mockReturnValue(false);
|
||||
|
||||
await fireSessionPermissionDeniedForAutoMode(
|
||||
mockConfig,
|
||||
{
|
||||
via: 'classifier',
|
||||
shouldBlock: true,
|
||||
reason: 'classifier timeout',
|
||||
unavailable: true,
|
||||
stage: 'fast',
|
||||
durationMs: 3000,
|
||||
},
|
||||
{ kind: 'blocked', errorMessage: 'blocked' },
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
new AbortController().signal,
|
||||
);
|
||||
|
||||
expect(hookSystem.firePermissionDeniedEvent).toHaveBeenCalledWith(
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
'classifier_unavailable',
|
||||
expect.any(AbortSignal),
|
||||
);
|
||||
});
|
||||
|
||||
it('skips PermissionDenied hooks when hooks are disabled', async () => {
|
||||
const hookSystem = {
|
||||
firePermissionDeniedEvent: vi.fn().mockResolvedValue(undefined),
|
||||
};
|
||||
mockConfig.getHookSystem = vi.fn().mockReturnValue(hookSystem);
|
||||
mockConfig.getDisableAllHooks = vi.fn().mockReturnValue(true);
|
||||
|
||||
await fireSessionPermissionDeniedForAutoMode(
|
||||
mockConfig,
|
||||
{
|
||||
via: 'classifier',
|
||||
shouldBlock: true,
|
||||
reason: 'dangerous shell command',
|
||||
unavailable: false,
|
||||
stage: 'fast',
|
||||
durationMs: 20,
|
||||
},
|
||||
{ kind: 'blocked', errorMessage: 'blocked' },
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
new AbortController().signal,
|
||||
);
|
||||
|
||||
expect(hookSystem.firePermissionDeniedEvent).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('skips PermissionDenied hooks when AUTO outcome is not blocked', async () => {
|
||||
const hookSystem = {
|
||||
firePermissionDeniedEvent: vi.fn().mockResolvedValue(undefined),
|
||||
};
|
||||
mockConfig.getHookSystem = vi.fn().mockReturnValue(hookSystem);
|
||||
mockConfig.getDisableAllHooks = vi.fn().mockReturnValue(false);
|
||||
|
||||
await fireSessionPermissionDeniedForAutoMode(
|
||||
mockConfig,
|
||||
{
|
||||
via: 'classifier',
|
||||
shouldBlock: true,
|
||||
reason: 'dangerous shell command',
|
||||
unavailable: false,
|
||||
stage: 'fast',
|
||||
durationMs: 20,
|
||||
},
|
||||
{ kind: 'fallback' },
|
||||
core.ToolNames.SHELL,
|
||||
{ command: 'rm -rf /tmp/example' },
|
||||
'auto-denied-acp',
|
||||
new AbortController().signal,
|
||||
);
|
||||
|
||||
expect(hookSystem.firePermissionDeniedEvent).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe('UserPromptSubmit hook', () => {
|
||||
it('fires UserPromptSubmit hook before sending prompt', async () => {
|
||||
const messageBus = {
|
||||
@ -2248,6 +2422,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
|
||||
mockChat.sendMessageStream = vi.fn().mockResolvedValue(
|
||||
createStreamWithChunks([
|
||||
@ -2301,6 +2478,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValue(createEmptyStream());
|
||||
@ -2346,6 +2526,9 @@ describe('Session', () => {
|
||||
.mockReturnValue([
|
||||
{ role: 'model', parts: [{ text: 'response text' }] },
|
||||
]);
|
||||
mockChat.getLastModelMessageText = vi
|
||||
.fn()
|
||||
.mockReturnValue('response text');
|
||||
mockChat.sendMessageStream = vi
|
||||
.fn()
|
||||
.mockResolvedValue(createEmptyStream());
|
||||
|
||||
@ -23,6 +23,8 @@ import type {
|
||||
MessageBus,
|
||||
StreamEvent,
|
||||
ChatCompressionInfo,
|
||||
AutoModeDecision,
|
||||
AutoModeOutcome,
|
||||
} from '@qwen-code/qwen-code-core';
|
||||
import {
|
||||
AuthType,
|
||||
@ -62,11 +64,13 @@ import {
|
||||
formatStopHookBlockingCapWarning,
|
||||
applyAutoModeDecision,
|
||||
evaluateAutoMode,
|
||||
getAutoModePermissionDeniedReason,
|
||||
isApproveOutcome,
|
||||
MAX_TRANSCRIPT_MESSAGES,
|
||||
recordAllow,
|
||||
recordFallbackApprove,
|
||||
shouldFallback,
|
||||
shouldFirePermissionDeniedForAutoMode,
|
||||
shouldRunAutoModeForCall,
|
||||
} from '@qwen-code/qwen-code-core';
|
||||
import { getCommandSubcommandNames } from '../../services/commandMetadata.js';
|
||||
@ -159,6 +163,31 @@ export function computeInitialTurnFromHistory(
|
||||
return maxPromptTurn > 0 ? maxPromptTurn : userMessageCount;
|
||||
}
|
||||
|
||||
export async function fireSessionPermissionDeniedForAutoMode(
|
||||
config: Config,
|
||||
decision: AutoModeDecision,
|
||||
outcome: AutoModeOutcome,
|
||||
toolName: string,
|
||||
toolParams: Record<string, unknown>,
|
||||
callId: string,
|
||||
signal?: AbortSignal,
|
||||
): Promise<void> {
|
||||
if (
|
||||
!config.getDisableAllHooks?.() &&
|
||||
shouldFirePermissionDeniedForAutoMode(decision, outcome)
|
||||
) {
|
||||
await config
|
||||
.getHookSystem?.()
|
||||
?.firePermissionDeniedEvent(
|
||||
toolName,
|
||||
toolParams,
|
||||
callId,
|
||||
getAutoModePermissionDeniedReason(decision),
|
||||
signal,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
function getRecordPromptIds(record: ChatRecord): string[] {
|
||||
const promptIds: string[] = [];
|
||||
const recordPromptId = (record as { promptId?: unknown }).promptId;
|
||||
@ -373,7 +402,7 @@ export class Session implements SessionContext {
|
||||
}
|
||||
|
||||
const chat = this.config.getGeminiClient()!.getChat();
|
||||
const apiHistory = chat.getHistory();
|
||||
const apiHistory = chat.getHistoryShallow();
|
||||
const apiTruncateIndex = this.#computeApiTruncationIndexForUserTurn(
|
||||
apiHistory,
|
||||
targetTurnIndex,
|
||||
@ -866,16 +895,10 @@ export class Session implements SessionContext {
|
||||
return { stopReason: 'end_turn' };
|
||||
}
|
||||
|
||||
// Get response text from the chat history
|
||||
const history = this.#getCurrentChat().getHistory();
|
||||
const lastModelMessage = history
|
||||
.filter((msg: Content) => msg.role === 'model')
|
||||
.pop();
|
||||
// Extract last model text without cloning the full history.
|
||||
const responseText =
|
||||
lastModelMessage?.parts
|
||||
?.filter((p: Part): p is { text: string } & Part => 'text' in p)
|
||||
.map((p: { text: string }) => p.text)
|
||||
.join('') || '[no response text]';
|
||||
this.#getCurrentChat().getLastModelMessageText?.() ||
|
||||
'[no response text]';
|
||||
|
||||
const response = await messageBus.request<
|
||||
HookExecutionRequest,
|
||||
@ -1120,8 +1143,12 @@ export class Session implements SessionContext {
|
||||
compressionInfo = compressed;
|
||||
this.#recordCompressionTokenCount(compressed);
|
||||
if (compressed.compressionStatus === CompressionStatus.COMPRESSED) {
|
||||
const reasonClause =
|
||||
compressed.triggerReason === 'image_overflow'
|
||||
? `accumulated enough tool screenshots to trigger compaction for ${this.config.getModel()}`
|
||||
: `approached the input token limit for ${this.config.getModel()}`;
|
||||
compressionDiagnostic =
|
||||
`IMPORTANT: This conversation approached the input token limit for ${this.config.getModel()}. ` +
|
||||
`IMPORTANT: This conversation ${reasonClause}. ` +
|
||||
`A compressed context will be sent for future messages (compressed from: ` +
|
||||
`${compressed.originalTokenCount ?? 'unknown'} to ` +
|
||||
`${compressed.newTokenCount ?? 'unknown'} tokens).`;
|
||||
@ -1980,6 +2007,15 @@ export class Session implements SessionContext {
|
||||
this.config,
|
||||
denialState,
|
||||
);
|
||||
await fireSessionPermissionDeniedForAutoMode(
|
||||
this.config,
|
||||
decision,
|
||||
outcome,
|
||||
fc.name,
|
||||
toolParams,
|
||||
callId,
|
||||
abortSignal,
|
||||
);
|
||||
switch (outcome.kind) {
|
||||
case 'approved':
|
||||
autoModeAllowed = true;
|
||||
|
||||
@ -6,13 +6,14 @@ let builtinsPromise: Promise<void> | null = null;
|
||||
function ensureBuiltins(): Promise<void> {
|
||||
if (!builtinsPromise) {
|
||||
builtinsPromise = (async () => {
|
||||
const [telegram, weixin, dingtalk] = await Promise.all([
|
||||
const [telegram, weixin, dingtalk, feishu] = await Promise.all([
|
||||
import('@qwen-code/channel-telegram'),
|
||||
import('@qwen-code/channel-weixin'),
|
||||
import('@qwen-code/channel-dingtalk'),
|
||||
import('@qwen-code/channel-feishu'),
|
||||
]);
|
||||
|
||||
for (const mod of [telegram, weixin, dingtalk]) {
|
||||
for (const mod of [telegram, weixin, dingtalk, feishu]) {
|
||||
registry.set(mod.plugin.channelType, mod.plugin);
|
||||
}
|
||||
})();
|
||||
|
||||
@ -13,11 +13,16 @@ const mockExtensionManagerInstance = {
|
||||
refreshCache: mockRefreshCache,
|
||||
};
|
||||
|
||||
vi.mock('@qwen-code/qwen-code-core', () => ({
|
||||
ExtensionManager: vi
|
||||
.fn()
|
||||
.mockImplementation(() => mockExtensionManagerInstance),
|
||||
}));
|
||||
vi.mock('@qwen-code/qwen-code-core', async (importOriginal) => {
|
||||
const actual =
|
||||
await importOriginal<typeof import('@qwen-code/qwen-code-core')>();
|
||||
return {
|
||||
...actual,
|
||||
ExtensionManager: vi
|
||||
.fn()
|
||||
.mockImplementation(() => mockExtensionManagerInstance),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock('../../config/settings.js', () => ({
|
||||
loadSettings: vi.fn().mockReturnValue({
|
||||
@ -132,4 +137,26 @@ describe('extensionToOutputString', () => {
|
||||
|
||||
expect(resultWithoutInline).toEqual(resultWithInlineFalse);
|
||||
});
|
||||
|
||||
it('should redact URL credentials in install source output', () => {
|
||||
const extension = createMockExtension({
|
||||
installMetadata: {
|
||||
type: 'git',
|
||||
source: 'https://user:token@example.com/owner/repo.git',
|
||||
},
|
||||
});
|
||||
|
||||
const result = extensionToOutputString(
|
||||
extension,
|
||||
mockExtensionManager,
|
||||
'/workspace',
|
||||
true,
|
||||
);
|
||||
|
||||
expect(result).toContain(
|
||||
'https://***REDACTED***@example.com/owner/repo.git',
|
||||
);
|
||||
expect(result).not.toContain('user');
|
||||
expect(result).not.toContain('token');
|
||||
});
|
||||
});
|
||||
|
||||
@ -4,7 +4,11 @@
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { ExtensionManager, type Extension } from '@qwen-code/qwen-code-core';
|
||||
import {
|
||||
ExtensionManager,
|
||||
redactUrlCredentials,
|
||||
type Extension,
|
||||
} from '@qwen-code/qwen-code-core';
|
||||
import { loadSettings } from '../../config/settings.js';
|
||||
import {
|
||||
requestConsentOrFail,
|
||||
@ -51,7 +55,7 @@ export function extensionToOutputString(
|
||||
let output = `${inline ? '' : status} ${extension.config.name} (${extension.config.version})`;
|
||||
output += `\n ${t('Path:')} ${extension.path}`;
|
||||
if (extension.installMetadata) {
|
||||
output += `\n ${t('Source:')} ${extension.installMetadata.source} (${t('Type:')} ${extension.installMetadata.type})`;
|
||||
output += `\n ${t('Source:')} ${redactUrlCredentials(extension.installMetadata.source)} (${t('Type:')} ${extension.installMetadata.type})`;
|
||||
if (extension.installMetadata.ref) {
|
||||
output += `\n ${t('Ref:')} ${extension.installMetadata.ref}`;
|
||||
}
|
||||
|
||||
@ -12,7 +12,12 @@ import type { Argv, CommandModule } from 'yargs';
|
||||
// handler below so it only loads when the user actually runs `qwen serve`.
|
||||
import { writeStderrLine } from '../utils/stdioHelpers.js';
|
||||
import { DEFAULT_RING_SIZE } from '../serve/eventBus.js';
|
||||
import { MCP_BUDGET_WARN_FRACTION } from '@qwen-code/qwen-code-core';
|
||||
import {
|
||||
ApprovalMode,
|
||||
MCP_BUDGET_WARN_FRACTION,
|
||||
} from '@qwen-code/qwen-code-core';
|
||||
import { loadSettings } from '../config/settings.js';
|
||||
import { HEADLESS_YOLO_NO_SANDBOX_WARNING } from '../utils/headlessSafetyWarnings.js';
|
||||
|
||||
/**
|
||||
* Pause the current async function indefinitely. Used after the daemon
|
||||
@ -203,6 +208,37 @@ export const serveCommand: CommandModule<unknown, ServeArgs> = {
|
||||
);
|
||||
}
|
||||
|
||||
// Emit the headless-YOLO safety warning at daemon startup if
|
||||
// settings.json statically configures yolo + no sandbox. We can't
|
||||
// use `getHeadlessYoloSafetyWarning(config)` here because the daemon
|
||||
// hasn't constructed a `Config` yet — sessions get their own — so
|
||||
// we re-derive the predicate from the same settings.json the
|
||||
// sessions will load. Per-session override (the ACP client flipping
|
||||
// approval mode mid-session) is out of scope here; this warns about
|
||||
// a deployment that's wide-open at boot. Suppress with
|
||||
// QWEN_CODE_SUPPRESS_YOLO_WARNING=1.
|
||||
try {
|
||||
const loaded = loadSettings(argv.workspace ?? process.cwd());
|
||||
const merged = loaded.merged;
|
||||
const approvalMode = merged.tools?.approvalMode;
|
||||
const sandbox = merged.tools?.sandbox;
|
||||
const sandboxEnv = process.env['SANDBOX'];
|
||||
const suppress = process.env['QWEN_CODE_SUPPRESS_YOLO_WARNING'];
|
||||
const suppressed = suppress === '1' || suppress === 'true';
|
||||
if (
|
||||
approvalMode === ApprovalMode.YOLO &&
|
||||
!sandbox &&
|
||||
!sandboxEnv &&
|
||||
!suppressed
|
||||
) {
|
||||
writeStderrLine(HEADLESS_YOLO_NO_SANDBOX_WARNING);
|
||||
}
|
||||
} catch {
|
||||
// Settings load can fail (corrupt JSON, etc.); don't block
|
||||
// daemon startup just to emit a warning — the existing settings
|
||||
// path will report the same error to the user via Session.
|
||||
}
|
||||
|
||||
// Lazy-load the serve module so non-serve invocations don't pay for
|
||||
// express + body-parser + qs in their startup path.
|
||||
const { runQwenServe } = await import('../serve/index.js');
|
||||
|
||||
@ -165,7 +165,7 @@ export function validateAuthMethod(
|
||||
authMethod: string,
|
||||
config?: Config,
|
||||
): string | null {
|
||||
const settings = loadSettings();
|
||||
const settings = loadSettings(process.cwd(), false);
|
||||
loadEnvironment(settings.merged);
|
||||
|
||||
if (authMethod === AuthType.USE_OPENAI) {
|
||||
|
||||
@ -2354,6 +2354,16 @@ describe('loadCliConfig with includeDirectories', () => {
|
||||
]);
|
||||
});
|
||||
|
||||
it('should default managed-memory toggles to enabled when not in bare mode', async () => {
|
||||
process.argv = ['node', 'script.js'];
|
||||
const argv = await parseArguments();
|
||||
const config = await loadCliConfig({}, argv, undefined, []);
|
||||
|
||||
expect(config.getManagedAutoMemoryEnabled()).toBe(true);
|
||||
expect(config.getManagedAutoDreamEnabled()).toBe(true);
|
||||
expect(config.getAutoSkillEnabled()).toBe(true);
|
||||
});
|
||||
|
||||
it('should force minimal startup behavior in bare mode', async () => {
|
||||
process.argv = ['node', 'script.js', '--bare'];
|
||||
const argv = await parseArguments();
|
||||
@ -2393,6 +2403,8 @@ describe('loadCliConfig with includeDirectories', () => {
|
||||
]);
|
||||
expect(config.getDisableAllHooks()).toBe(true);
|
||||
expect(config.getManagedAutoMemoryEnabled()).toBe(false);
|
||||
expect(config.getManagedAutoDreamEnabled()).toBe(false);
|
||||
expect(config.getAutoSkillEnabled()).toBe(false);
|
||||
expect(config.getToolDiscoveryCommand()).toBeUndefined();
|
||||
expect(config.getToolCallCommand()).toBeUndefined();
|
||||
expect(config.getMcpServers()).toEqual({});
|
||||
|
||||
@ -75,6 +75,11 @@ export function isValidSessionId(value: string): boolean {
|
||||
|
||||
import { isWorkspaceTrusted } from './trustedFolders.js';
|
||||
import { writeStderrLine } from '../utils/stdioHelpers.js';
|
||||
import {
|
||||
parseDurationSeconds,
|
||||
validateMaxToolCalls,
|
||||
validateMaxWallTimeSetting,
|
||||
} from '../utils/runBudget.js';
|
||||
|
||||
const debugLogger = createDebugLogger('CONFIG');
|
||||
|
||||
@ -170,7 +175,20 @@ export interface CliArgs {
|
||||
forkSession?: boolean | undefined;
|
||||
/** Internal: preserve the outer session ID when relaunching in a sandbox */
|
||||
sandboxSessionId?: string | undefined;
|
||||
/**
|
||||
* Start the session inside a git worktree. Accepted forms:
|
||||
* - bare `--worktree` (empty string from yargs) → auto-generated slug
|
||||
* - `--worktree foo` / `--worktree=foo` → explicit slug
|
||||
* - `--worktree=#123` / `--worktree https://github.com/o/r/pull/123` → PR ref
|
||||
*
|
||||
* Consumed by `setupStartupWorktree()` before `loadCliConfig()`. When set,
|
||||
* the CLI chdirs into `<repoRoot>/.qwen/worktrees/<slug>/` and the entire
|
||||
* session runs inside that worktree.
|
||||
*/
|
||||
worktree?: string | undefined;
|
||||
maxSessionTurns: number | undefined;
|
||||
maxWallTime: string | undefined;
|
||||
maxToolCalls: number | undefined;
|
||||
coreTools: string[] | undefined;
|
||||
excludeTools: string[] | undefined;
|
||||
disabledSlashCommands: string[] | undefined;
|
||||
@ -824,10 +842,28 @@ export async function parseArguments(): Promise<CliArgs> {
|
||||
type: 'string',
|
||||
hidden: true,
|
||||
})
|
||||
.option('worktree', {
|
||||
type: 'string',
|
||||
description:
|
||||
'Start the session inside a git worktree at <repoRoot>/.qwen/worktrees/<slug>/. ' +
|
||||
'Pass a slug (`--worktree my-feature`), a PR reference (`--worktree=#123` or a full ' +
|
||||
'GitHub pull-request URL), or use bare `--worktree` to auto-generate a slug. ' +
|
||||
'On exit, the WorktreeExitDialog prompts to keep or remove the worktree.',
|
||||
})
|
||||
.option('max-session-turns', {
|
||||
type: 'number',
|
||||
description: 'Maximum number of session turns',
|
||||
})
|
||||
.option('max-wall-time', {
|
||||
type: 'string',
|
||||
description:
|
||||
'Run-level wall-clock budget for headless / unattended runs. Accepts seconds (e.g. `90`), or a duration string with unit (e.g. `30s`, `5m`, `1h`, `1.5h`). Minimum 1s — sub-second values (`500ms`, `0.5`) are rejected as typos; max ~24 days. Aborts the run with exit code 55 when exceeded.',
|
||||
})
|
||||
.option('max-tool-calls', {
|
||||
type: 'number',
|
||||
description:
|
||||
'Maximum cumulative tool calls executed during the run (success or failure; `structured_output` under --json-schema is exempt). Aborts with exit code 55 when exceeded. -1 / unset means no limit; 0 means "no tool calls allowed" (first call aborts). Capped at 1,000,000 to catch typos.',
|
||||
})
|
||||
.option('core-tools', {
|
||||
type: 'array',
|
||||
string: true,
|
||||
@ -1116,6 +1152,65 @@ export async function loadHierarchicalGeminiMemory(
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the wall-clock budget for a run. Returns seconds (`-1` =
|
||||
* unlimited). Order of precedence: `--max-wall-time` flag, then
|
||||
* `model.maxWallTimeSeconds` from settings, else unlimited.
|
||||
*
|
||||
* The CLI flag is a duration string (`30s` / `5m` / `1h` / `90`); the
|
||||
* settings entry is a plain number of seconds (parity with
|
||||
* `model.maxSessionTurns`). Both layers reject `0` and out-of-range
|
||||
* values up front — a typo in a CI guardrail should fail loud at startup,
|
||||
* not silently disable the budget.
|
||||
*/
|
||||
function resolveMaxWallTimeSeconds(argv: CliArgs, settings: Settings): number {
|
||||
if (argv.maxWallTime !== undefined && argv.maxWallTime !== null) {
|
||||
try {
|
||||
return parseDurationSeconds(String(argv.maxWallTime));
|
||||
} catch (err) {
|
||||
throw new Error(`--max-wall-time: ${(err as Error).message}`);
|
||||
}
|
||||
}
|
||||
const fromSettings = settings.model?.maxWallTimeSeconds;
|
||||
if (typeof fromSettings === 'number') {
|
||||
try {
|
||||
return validateMaxWallTimeSetting(fromSettings);
|
||||
} catch (err) {
|
||||
throw new Error(`settings.json: ${(err as Error).message}`);
|
||||
}
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the tool-call budget for a run. Returns the validated count
|
||||
* (`-1` = unlimited). Order of precedence: `--max-tool-calls` flag, then
|
||||
* `model.maxToolCalls` from settings, else unlimited.
|
||||
*
|
||||
* Symmetric with `resolveMaxWallTimeSeconds`: yargs accepts `NaN` from
|
||||
* non-numeric flag values, and the enforcer's `>= 0` gate would silently
|
||||
* disable the budget for `NaN` / negatives. Validate up front so a typo
|
||||
* in a CI guardrail fails loudly.
|
||||
*/
|
||||
function resolveMaxToolCalls(argv: CliArgs, settings: Settings): number {
|
||||
if (argv.maxToolCalls !== undefined && argv.maxToolCalls !== null) {
|
||||
try {
|
||||
return validateMaxToolCalls(argv.maxToolCalls);
|
||||
} catch (err) {
|
||||
throw new Error(`--max-tool-calls: ${(err as Error).message}`);
|
||||
}
|
||||
}
|
||||
const fromSettings = settings.model?.maxToolCalls;
|
||||
if (typeof fromSettings === 'number') {
|
||||
try {
|
||||
return validateMaxToolCalls(fromSettings);
|
||||
} catch (err) {
|
||||
throw new Error(`settings.json: ${(err as Error).message}`);
|
||||
}
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
export function isDebugMode(argv: CliArgs): boolean {
|
||||
return (
|
||||
argv.debug ||
|
||||
@ -1710,6 +1805,7 @@ export async function loadCliConfig(
|
||||
screenReader,
|
||||
},
|
||||
telemetry: telemetrySettings,
|
||||
outboundCorrelation: settings.outboundCorrelation,
|
||||
usageStatisticsEnabled: settings.privacy?.usageStatisticsEnabled ?? true,
|
||||
clearContextOnIdle: settings.context?.clearContextOnIdle,
|
||||
fileFiltering: settings.context?.fileFiltering,
|
||||
@ -1731,8 +1827,11 @@ export async function loadCliConfig(
|
||||
sessionTokenLimit: settings.model?.sessionTokenLimit ?? -1,
|
||||
maxSessionTurns:
|
||||
argv.maxSessionTurns ?? settings.model?.maxSessionTurns ?? -1,
|
||||
maxWallTimeSeconds: resolveMaxWallTimeSeconds(argv, settings),
|
||||
maxToolCalls: resolveMaxToolCalls(argv, settings),
|
||||
experimentalZedIntegration: argv.acp || argv.experimentalAcp || false,
|
||||
cronEnabled: settings.experimental?.cron ?? false,
|
||||
computerUseEnabled: settings.tools?.computerUse?.enabled ?? true,
|
||||
emitToolUseSummaries: settings.experimental?.emitToolUseSummaries ?? true,
|
||||
listExtensions: argv.listExtensions || false,
|
||||
overrideExtensions: overrideExtensions || argv.extensions,
|
||||
@ -1771,10 +1870,12 @@ export async function loadCliConfig(
|
||||
enableManagedAutoMemory: bareMode
|
||||
? false
|
||||
: (settings.memory?.enableManagedAutoMemory ?? true),
|
||||
enableManagedAutoDream: settings.memory?.enableManagedAutoDream ?? false,
|
||||
enableManagedAutoDream: bareMode
|
||||
? false
|
||||
: (settings.memory?.enableManagedAutoDream ?? true),
|
||||
enableAutoSkill: bareMode
|
||||
? false
|
||||
: (settings.memory?.enableAutoSkill ?? false),
|
||||
: (settings.memory?.enableAutoSkill ?? true),
|
||||
fastModel: settings.fastModel || undefined,
|
||||
// Use separated hooks if provided, otherwise fall back to merged hooks
|
||||
userHooks: bareMode
|
||||
@ -1814,6 +1915,11 @@ export async function loadCliConfig(
|
||||
: undefined,
|
||||
}
|
||||
: undefined,
|
||||
worktree: settings.worktree
|
||||
? {
|
||||
symlinkDirectories: settings.worktree.symlinkDirectories,
|
||||
}
|
||||
: undefined,
|
||||
};
|
||||
|
||||
const config = new Config(configParams);
|
||||
|
||||
@ -56,6 +56,8 @@ import {
|
||||
SETTINGS_VERSION,
|
||||
SETTINGS_VERSION_KEY,
|
||||
resetHomeEnvBootstrapForTesting,
|
||||
ENV_CORRUPTED_PATH,
|
||||
ENV_WAS_RECOVERED,
|
||||
} from './settings.js';
|
||||
import { needsMigration } from './migration/index.js';
|
||||
import { QWEN_DIR } from '@qwen-code/qwen-code-core';
|
||||
@ -108,6 +110,7 @@ vi.mock('node:fs', async (importOriginal) => {
|
||||
readFileSync: vi.fn(),
|
||||
writeFileSync: vi.fn(),
|
||||
renameSync: vi.fn(),
|
||||
copyFileSync: vi.fn(),
|
||||
mkdirSync: vi.fn(),
|
||||
statSync: vi.fn(() => ({ isDirectory: () => false, isFile: () => true })),
|
||||
realpathSync: (p: string) => p,
|
||||
@ -126,6 +129,7 @@ vi.mock('fs', async (importOriginal) => {
|
||||
readFileSync: vi.fn(),
|
||||
writeFileSync: vi.fn(),
|
||||
renameSync: vi.fn(),
|
||||
copyFileSync: vi.fn(),
|
||||
mkdirSync: vi.fn(),
|
||||
statSync: vi.fn(() => ({ isDirectory: () => false, isFile: () => true })),
|
||||
realpathSync: (p: string) => p,
|
||||
@ -1874,19 +1878,18 @@ describe('Settings Loading and Merging', () => {
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(result).toBeDefined();
|
||||
|
||||
// Verify the corrupted file was renamed with timestamp suffix
|
||||
const renameCalls = (fs.renameSync as Mock).mock.calls;
|
||||
const corruptedRename = renameCalls.find(
|
||||
// Verify the corrupted file was copied to .corrupted
|
||||
const copyCalls = (fs.copyFileSync as Mock).mock.calls;
|
||||
const corruptedCopy = copyCalls.find(
|
||||
(call: unknown[]) =>
|
||||
call[0] === USER_SETTINGS_PATH &&
|
||||
String(call[1]).includes('.corrupted.'),
|
||||
String(call[1]).includes('.corrupted'),
|
||||
);
|
||||
expect(corruptedRename).toBeDefined();
|
||||
expect(corruptedCopy).toBeDefined();
|
||||
|
||||
// Verify migrationWarnings contains recovery message
|
||||
const warnings = getSettingsWarnings(result);
|
||||
expect(warnings.some((w) => w.includes('invalid JSON'))).toBe(true);
|
||||
expect(warnings.some((w) => w.includes('renamed'))).toBe(true);
|
||||
// Corrupted dialog is driven by corruptedPath, not by migrationWarnings
|
||||
expect(result.corruptedPath).toBe(`${USER_SETTINGS_PATH}.corrupted`);
|
||||
expect(result.wasRecovered).toBe(false);
|
||||
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
@ -1919,11 +1922,8 @@ describe('Settings Loading and Merging', () => {
|
||||
);
|
||||
expect(restoreWrite).toBeDefined();
|
||||
|
||||
// Verify migrationWarnings informs user about recovery
|
||||
const warnings = getSettingsWarnings(result);
|
||||
expect(warnings.some((w) => w.includes('recovered from backup'))).toBe(
|
||||
true,
|
||||
);
|
||||
// Recovery is communicated via wasRecovered flag, not migrationWarnings
|
||||
expect(result.wasRecovered).toBe(true);
|
||||
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
@ -1954,20 +1954,27 @@ describe('Settings Loading and Merging', () => {
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(result).toBeDefined();
|
||||
|
||||
// Verify the corrupted file was renamed
|
||||
const renameCalls = (fs.renameSync as Mock).mock.calls;
|
||||
expect(result.corruptedPath).toBe(`${USER_SETTINGS_PATH}.corrupted`);
|
||||
expect(result.wasRecovered).toBe(false);
|
||||
const resetWrites = (fs.writeFileSync as Mock).mock.calls.filter(
|
||||
(call: unknown[]) => call[0] === USER_SETTINGS_PATH && call[1] === '{}',
|
||||
);
|
||||
expect(resetWrites.length).toBeGreaterThan(0);
|
||||
|
||||
// Verify the corrupted file was copied to .corrupted
|
||||
const copyCalls = (fs.copyFileSync as Mock).mock.calls;
|
||||
expect(
|
||||
renameCalls.some(
|
||||
copyCalls.some(
|
||||
(call: unknown[]) =>
|
||||
call[0] === USER_SETTINGS_PATH &&
|
||||
String(call[1]).includes('.corrupted.'),
|
||||
String(call[1]).includes('.corrupted'),
|
||||
),
|
||||
).toBe(true);
|
||||
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
it('should start with empty settings when rename of corrupted file fails', () => {
|
||||
it('should start with empty settings when copy of corrupted file fails', () => {
|
||||
const invalidJsonContent = 'invalid json';
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation((p: fs.PathLike) => {
|
||||
@ -1983,8 +1990,8 @@ describe('Settings Loading and Merging', () => {
|
||||
},
|
||||
);
|
||||
|
||||
// Simulate rename failure (e.g., permission denied)
|
||||
(fs.renameSync as Mock).mockImplementation(() => {
|
||||
// Simulate copy failure (e.g., permission denied)
|
||||
(fs.copyFileSync as Mock).mockImplementation(() => {
|
||||
throw new Error('EACCES: permission denied');
|
||||
});
|
||||
|
||||
@ -1992,15 +1999,136 @@ describe('Settings Loading and Merging', () => {
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(result).toBeDefined();
|
||||
|
||||
// Verify the warning message does NOT say "renamed" since rename failed,
|
||||
// but instead tells user to fix the file manually.
|
||||
// Corruption warning no longer goes through migrationWarnings —
|
||||
// copy failed so corruptedPath is undefined too
|
||||
const warnings = getSettingsWarnings(result);
|
||||
expect(warnings.some((w) => w.includes('fix the JSON'))).toBe(true);
|
||||
expect(warnings.some((w) => w.includes('renamed to'))).toBe(false);
|
||||
expect(warnings.some((w) => w.includes('invalid JSON'))).toBe(false);
|
||||
expect(result.corruptedPath).toBeUndefined();
|
||||
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
it('should return warnings suitable for early stderr emission when settings.json has invalid JSON', () => {
|
||||
const invalidJsonContent = '{ broken json!!!';
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH) return invalidJsonContent;
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
(fs.renameSync as Mock).mockImplementation(() => {});
|
||||
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const warnings = getSettingsWarnings(result);
|
||||
|
||||
// Corruption warning no longer goes through migrationWarnings —
|
||||
// it is emitted via settings.corruptedPath check in gemini.tsx
|
||||
// early stderr path instead. Verify corruptedPath is set.
|
||||
expect(result.corruptedPath).toBeDefined();
|
||||
expect(warnings.some((w) => w.includes('invalid JSON'))).toBe(false);
|
||||
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
describe('corruption env var propagation', () => {
|
||||
afterEach(() => {
|
||||
delete process.env[ENV_CORRUPTED_PATH];
|
||||
delete process.env[ENV_WAS_RECOVERED];
|
||||
});
|
||||
|
||||
it('should propagate corruptedPath/wasRecovered from env vars', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = `${USER_SETTINGS_PATH}.corrupted`;
|
||||
process.env[ENV_WAS_RECOVERED] = '1';
|
||||
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(result.corruptedPath).toBe(`${USER_SETTINGS_PATH}.corrupted`);
|
||||
expect(result.wasRecovered).toBe(true);
|
||||
});
|
||||
|
||||
it('should delete env vars after reading so subsequent calls do not re-trigger', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = `${USER_SETTINGS_PATH}.corrupted`;
|
||||
process.env[ENV_WAS_RECOVERED] = '0';
|
||||
|
||||
loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(process.env[ENV_CORRUPTED_PATH]).toBeUndefined();
|
||||
expect(process.env[ENV_WAS_RECOVERED]).toBeUndefined();
|
||||
});
|
||||
|
||||
it('should only consume env vars for SettingScope.User', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation((p: fs.PathLike) => {
|
||||
const s = p.toString();
|
||||
return s === USER_SETTINGS_PATH || s === MOCK_WORKSPACE_SETTINGS_PATH;
|
||||
});
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = `${USER_SETTINGS_PATH}.corrupted`;
|
||||
process.env[ENV_WAS_RECOVERED] = '1';
|
||||
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
|
||||
// env vars consumed in User scope — scope guard exercised
|
||||
expect(process.env[ENV_CORRUPTED_PATH]).toBeUndefined();
|
||||
expect(process.env[ENV_WAS_RECOVERED]).toBeUndefined();
|
||||
expect(result.corruptedPath).toBeDefined();
|
||||
});
|
||||
|
||||
it('should map wasRecovered="0" to false', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = `${USER_SETTINGS_PATH}.corrupted`;
|
||||
process.env[ENV_WAS_RECOVERED] = '0';
|
||||
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
expect(result.wasRecovered).toBe(false);
|
||||
});
|
||||
|
||||
it('should not consume env vars when consumeCorruptionEnvVars=false', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = `${USER_SETTINGS_PATH}.corrupted`;
|
||||
process.env[ENV_WAS_RECOVERED] = '1';
|
||||
|
||||
loadSettings(MOCK_WORKSPACE_DIR, false);
|
||||
// env vars should remain untouched so child processes can still read them
|
||||
expect(process.env[ENV_CORRUPTED_PATH]).toBe(
|
||||
`${USER_SETTINGS_PATH}.corrupted`,
|
||||
);
|
||||
expect(process.env[ENV_WAS_RECOVERED]).toBe('1');
|
||||
});
|
||||
|
||||
it('should reject mismatched ENV_CORRUPTED_PATH', () => {
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(() => '{}');
|
||||
process.env[ENV_CORRUPTED_PATH] = '/some/other/path.corrupted';
|
||||
process.env[ENV_WAS_RECOVERED] = '1';
|
||||
|
||||
const result = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
|
||||
// Guard rejected — corruptedPath not propagated
|
||||
expect(result.corruptedPath).toBeUndefined();
|
||||
// Env vars not consumed because guard failed
|
||||
expect(process.env[ENV_CORRUPTED_PATH]).toBe(
|
||||
'/some/other/path.corrupted',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it('should resolve environment variables in user settings', () => {
|
||||
process.env['TEST_API_KEY'] = 'user_api_key_from_env';
|
||||
const userSettingsContent: TestSettings = {
|
||||
@ -2147,6 +2275,256 @@ describe('Settings Loading and Merging', () => {
|
||||
delete process.env['SHARED_VAR'];
|
||||
});
|
||||
|
||||
it('should resolve ${VAR} in settings from home-level .env file (#4466)', () => {
|
||||
const homeQwenEnvPath = path.join(
|
||||
path.dirname(USER_SETTINGS_PATH),
|
||||
'.env',
|
||||
);
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${MY_SECRET_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH || p === homeQwenEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === homeQwenEnvPath)
|
||||
return 'MY_SECRET_TOKEN=secret_from_dotenv';
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
delete process.env['MY_SECRET_TOKEN'];
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer secret_from_dotenv',
|
||||
);
|
||||
|
||||
delete process.env['MY_SECRET_TOKEN'];
|
||||
});
|
||||
|
||||
it('should not override process.env values with home .env file (#4466)', () => {
|
||||
const homeQwenEnvPath = path.join(
|
||||
path.dirname(USER_SETTINGS_PATH),
|
||||
'.env',
|
||||
);
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${MY_SECRET_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH || p === homeQwenEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === homeQwenEnvPath) return 'MY_SECRET_TOKEN=from_dotenv';
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
process.env['MY_SECRET_TOKEN'] = 'from_process_env';
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer from_process_env',
|
||||
);
|
||||
|
||||
delete process.env['MY_SECRET_TOKEN'];
|
||||
});
|
||||
|
||||
it('should not search dirname(qwenDir)/.env when QWEN_HOME is set (#4466)', () => {
|
||||
const customHome = '/custom/qwen/home';
|
||||
process.env['QWEN_HOME'] = customHome;
|
||||
const customSettingsPath = path.join(customHome, 'settings.json');
|
||||
const dirnameEnvPath = path.join(path.dirname(customHome), '.env');
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${MY_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === customSettingsPath || p === dirnameEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === customSettingsPath)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === dirnameEnvPath) return 'MY_TOKEN=should_not_be_found';
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
delete process.env['MY_TOKEN'];
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer ${MY_TOKEN}',
|
||||
);
|
||||
|
||||
delete process.env['MY_TOKEN'];
|
||||
delete process.env['QWEN_HOME'];
|
||||
});
|
||||
|
||||
it('should resolve ${VAR} from ~/.env when QWEN_HOME is not set (#4466)', () => {
|
||||
const homeEnvPath = path.join(
|
||||
path.dirname(path.dirname(USER_SETTINGS_PATH)),
|
||||
'.env',
|
||||
);
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${HOME_ENV_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH || p === homeEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === homeEnvPath) return 'HOME_ENV_TOKEN=from_home_env';
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
delete process.env['HOME_ENV_TOKEN'];
|
||||
delete process.env['QWEN_HOME'];
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer from_home_env',
|
||||
);
|
||||
|
||||
delete process.env['HOME_ENV_TOKEN'];
|
||||
});
|
||||
|
||||
it('should prefer ~/.qwen/.env over ~/.env for the same key (first-write-wins) (#4466)', () => {
|
||||
const qwenEnvPath = path.join(path.dirname(USER_SETTINGS_PATH), '.env');
|
||||
const homeEnvPath = path.join(
|
||||
path.dirname(path.dirname(USER_SETTINGS_PATH)),
|
||||
'.env',
|
||||
);
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${PRECEDENCE_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) =>
|
||||
p === USER_SETTINGS_PATH || p === qwenEnvPath || p === homeEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === qwenEnvPath) return 'PRECEDENCE_TOKEN=from_qwen_dir';
|
||||
if (p === homeEnvPath) return 'PRECEDENCE_TOKEN=from_home_dir';
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
delete process.env['PRECEDENCE_TOKEN'];
|
||||
delete process.env['QWEN_HOME'];
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer from_qwen_dir',
|
||||
);
|
||||
|
||||
delete process.env['PRECEDENCE_TOKEN'];
|
||||
});
|
||||
|
||||
it('should succeed with unresolved placeholder when .env read throws (#4466)', () => {
|
||||
const qwenEnvPath = path.join(path.dirname(USER_SETTINGS_PATH), '.env');
|
||||
const userSettingsContent = {
|
||||
mcpServers: {
|
||||
myServer: {
|
||||
headers: {
|
||||
Authorization: 'Bearer ${ERROR_TOKEN}',
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
(mockFsExistsSync as Mock).mockImplementation(
|
||||
(p: fs.PathLike) => p === USER_SETTINGS_PATH || p === qwenEnvPath,
|
||||
);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH)
|
||||
return JSON.stringify(userSettingsContent);
|
||||
if (p === qwenEnvPath) throw new Error('EACCES: permission denied');
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
delete process.env['ERROR_TOKEN'];
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mcpServers = settings.merged.mcpServers as Record<
|
||||
string,
|
||||
{ headers?: Record<string, string> }
|
||||
>;
|
||||
expect(mcpServers?.['myServer']?.headers?.['Authorization']).toBe(
|
||||
'Bearer ${ERROR_TOKEN}',
|
||||
);
|
||||
|
||||
delete process.env['ERROR_TOKEN'];
|
||||
});
|
||||
|
||||
it('should correctly merge dnsResolutionOrder with workspace taking precedence', () => {
|
||||
(mockFsExistsSync as Mock).mockReturnValue(true);
|
||||
const userSettingsContent = {
|
||||
@ -2731,6 +3109,122 @@ describe('Settings Loading and Merging', () => {
|
||||
externallyModifiedUserSettingsContent.modelProviders.openai,
|
||||
);
|
||||
});
|
||||
|
||||
it('persists removed MCP servers when replacing the top-level mcpServers object', () => {
|
||||
(mockFsExistsSync as Mock).mockReturnValue(true);
|
||||
|
||||
const userSettingsContent = {
|
||||
[SETTINGS_VERSION_KEY]: SETTINGS_VERSION,
|
||||
ui: {
|
||||
theme: 'dark',
|
||||
},
|
||||
mcpServers: {
|
||||
keep: {
|
||||
command: 'node',
|
||||
},
|
||||
remove: {
|
||||
command: 'python',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
let currentUserSettingsContent = JSON.stringify(userSettingsContent);
|
||||
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH) {
|
||||
return currentUserSettingsContent;
|
||||
}
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
currentUserSettingsContent = JSON.stringify(userSettingsContent);
|
||||
|
||||
settings.setValue(SettingScope.User, 'mcpServers', {
|
||||
keep: {
|
||||
command: 'node',
|
||||
},
|
||||
});
|
||||
|
||||
const writeCall = (fs.writeFileSync as Mock).mock.calls.at(-1);
|
||||
expect(writeCall).toBeDefined();
|
||||
|
||||
const writtenContent = JSON.parse(String(writeCall?.[1]));
|
||||
expect(writtenContent.ui).toEqual({ theme: 'dark' });
|
||||
expect(writtenContent.mcpServers).toEqual({
|
||||
keep: {
|
||||
command: 'node',
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('preserves sibling keys for non-MCP top-level object updates', () => {
|
||||
(mockFsExistsSync as Mock).mockReturnValue(true);
|
||||
|
||||
const userSettingsContent = {
|
||||
[SETTINGS_VERSION_KEY]: SETTINGS_VERSION,
|
||||
tools: {
|
||||
approvalMode: 'default',
|
||||
disabled: ['shell'],
|
||||
},
|
||||
};
|
||||
|
||||
let currentUserSettingsContent = JSON.stringify(userSettingsContent);
|
||||
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH) {
|
||||
return currentUserSettingsContent;
|
||||
}
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
currentUserSettingsContent = JSON.stringify(userSettingsContent);
|
||||
|
||||
settings.setValue(SettingScope.User, 'tools', {
|
||||
disabled: ['read-file'],
|
||||
});
|
||||
|
||||
const writeCall = (fs.writeFileSync as Mock).mock.calls.at(-1);
|
||||
expect(writeCall).toBeDefined();
|
||||
|
||||
const writtenContent = JSON.parse(String(writeCall?.[1]));
|
||||
expect(writtenContent.tools).toEqual({
|
||||
approvalMode: 'default',
|
||||
disabled: ['read-file'],
|
||||
});
|
||||
});
|
||||
|
||||
it('logs when setValue persistence is refused', () => {
|
||||
(mockFsExistsSync as Mock).mockReturnValue(true);
|
||||
(fs.readFileSync as Mock).mockImplementation(
|
||||
(p: fs.PathOrFileDescriptor) => {
|
||||
if (p === USER_SETTINGS_PATH) {
|
||||
return JSON.stringify({
|
||||
[SETTINGS_VERSION_KEY]: SETTINGS_VERSION,
|
||||
});
|
||||
}
|
||||
return '{}';
|
||||
},
|
||||
);
|
||||
|
||||
const settings = loadSettings(MOCK_WORKSPACE_DIR);
|
||||
const mockFn =
|
||||
commentJsonUtils.updateSettingsFilePreservingFormat as Mock;
|
||||
mockFn.mockReturnValueOnce(false);
|
||||
|
||||
settings.setValue(SettingScope.User, 'mcpServers', {});
|
||||
|
||||
expect(mockDebugLogger.error).toHaveBeenCalledWith(
|
||||
expect.stringContaining(
|
||||
'saveSettings: updateSettingsFilePreservingFormat returned false',
|
||||
),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('loadEnvironment', () => {
|
||||
|
||||
@ -73,12 +73,22 @@ export function getUserSettingsDir(): string {
|
||||
}
|
||||
export const DEFAULT_EXCLUDED_ENV_VARS = ['DEBUG', 'DEBUG_MODE'];
|
||||
|
||||
// Env var names used for inter-process communication of corruption state.
|
||||
// Defined as constants to avoid duplicated string literals.
|
||||
export const ENV_CORRUPTED_PATH = 'QWEN_CODE_SETTINGS_CORRUPTED_PATH';
|
||||
export const ENV_WAS_RECOVERED = 'QWEN_CODE_SETTINGS_WAS_RECOVERED';
|
||||
|
||||
// QWEN_HOME and QWEN_RUNTIME_DIR control where global state (settings, OAuth
|
||||
// credentials, installation IDs, etc.) is written. A project `.env` must never
|
||||
// redirect these — that would split global state between the real home and a
|
||||
// project-controlled directory. Always excluded from project .env files,
|
||||
// regardless of user-configurable `advanced.excludedEnvVars`.
|
||||
const PROJECT_ENV_HARDCODED_EXCLUSIONS = ['QWEN_HOME', 'QWEN_RUNTIME_DIR'];
|
||||
const PROJECT_ENV_HARDCODED_EXCLUSIONS = [
|
||||
'QWEN_HOME',
|
||||
'QWEN_RUNTIME_DIR',
|
||||
ENV_CORRUPTED_PATH,
|
||||
ENV_WAS_RECOVERED,
|
||||
];
|
||||
|
||||
// Settings version to track migration state
|
||||
export const SETTINGS_VERSION = 4;
|
||||
@ -396,6 +406,8 @@ export class LoadedSettings {
|
||||
isTrusted: boolean,
|
||||
migratedInMemorScopes: Set<SettingScope>,
|
||||
migrationWarnings: string[] = [],
|
||||
corruptedPath: string | undefined = undefined,
|
||||
wasRecovered: boolean = false,
|
||||
) {
|
||||
this.system = system;
|
||||
this.systemDefaults = systemDefaults;
|
||||
@ -404,6 +416,8 @@ export class LoadedSettings {
|
||||
this.isTrusted = isTrusted;
|
||||
this.migratedInMemorScopes = migratedInMemorScopes;
|
||||
this.migrationWarnings = migrationWarnings;
|
||||
this.corruptedPath = corruptedPath;
|
||||
this.wasRecovered = wasRecovered;
|
||||
this._merged = this.computeMergedSettings();
|
||||
}
|
||||
|
||||
@ -414,6 +428,9 @@ export class LoadedSettings {
|
||||
readonly isTrusted: boolean;
|
||||
readonly migratedInMemorScopes: Set<SettingScope>;
|
||||
readonly migrationWarnings: string[];
|
||||
readonly corruptedPath: string | undefined;
|
||||
readonly wasRecovered: boolean;
|
||||
corruptionDialogDismissed: boolean = false;
|
||||
|
||||
private _merged: Settings;
|
||||
|
||||
@ -451,7 +468,8 @@ export class LoadedSettings {
|
||||
setNestedPropertySafe(settingsFile.settings, key, value);
|
||||
setNestedPropertySafe(settingsFile.originalSettings, key, value);
|
||||
this._merged = this.computeMergedSettings();
|
||||
saveSettings(settingsFile, createSettingsUpdate(key, value));
|
||||
const replacePath = key === 'mcpServers' ? key.split('.') : [];
|
||||
saveSettings(settingsFile, createSettingsUpdate(key, value), replacePath);
|
||||
}
|
||||
|
||||
recomputeMerged(): void {
|
||||
@ -498,6 +516,8 @@ export function createMinimalSettings(): LoadedSettings {
|
||||
false,
|
||||
new Set(),
|
||||
[],
|
||||
undefined,
|
||||
false,
|
||||
);
|
||||
}
|
||||
|
||||
@ -596,6 +616,50 @@ export function resetHomeEnvBootstrapForTesting(): void {
|
||||
homeEnvBootstrapped = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Collects environment variables from user-level `.env` files and returns
|
||||
* them as a plain dictionary **without** mutating `process.env`.
|
||||
*
|
||||
* Candidates are iterated most-specific-first (`~/.qwen/.env` before
|
||||
* `~/.env`). `??=` ensures the first file to define a key wins, matching
|
||||
* dotenv's first-occurrence-wins semantics used elsewhere.
|
||||
*
|
||||
* Note: this dict intentionally does NOT filter PROJECT_ENV_HARDCODED_EXCLUSIONS
|
||||
* or advanced.excludedEnvVars — substitution scope is narrower than process.env
|
||||
* population handled by preResolveHomeEnvOverrides / readHomeEnvInto.
|
||||
*/
|
||||
function getHomeEnvFallbackVars(): Record<string, string> {
|
||||
const globalQwenDir = Storage.getGlobalQwenDir();
|
||||
const candidates = [path.join(globalQwenDir, '.env')];
|
||||
// When QWEN_HOME is set, skip ~/.env to avoid surprise cross-contamination
|
||||
// from a shared home .env. getUserLevelEnvPaths() always includes ~/.env
|
||||
// because loadEnvironment() populates process.env independently — the two
|
||||
// scopes are intentionally different.
|
||||
if (!process.env['QWEN_HOME']) {
|
||||
candidates.push(path.join(path.dirname(globalQwenDir), '.env'));
|
||||
}
|
||||
|
||||
const result: Record<string, string> = {};
|
||||
for (const candidate of candidates) {
|
||||
if (!fs.existsSync(candidate)) {
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
const parsed = dotenv.parse(fs.readFileSync(candidate, 'utf-8'));
|
||||
for (const key in parsed) {
|
||||
if (Object.hasOwn(parsed, key) && !Object.hasOwn(process.env, key)) {
|
||||
result[key] ??= parsed[key]!;
|
||||
}
|
||||
}
|
||||
} catch (e) {
|
||||
debugLogger.warn(
|
||||
`Failed to read home .env candidate ${candidate}: ${getErrorMessage(e)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Surfaces a one-shot warning when QWEN_HOME has been redirected but the
|
||||
* user hasn't migrated their existing global state. Auto-copying OAuth
|
||||
@ -803,12 +867,15 @@ export function loadEnvironment(settings: Settings): void {
|
||||
}
|
||||
}
|
||||
|
||||
export const CORRUPTED_SUFFIX = '.corrupted';
|
||||
|
||||
/**
|
||||
* Loads settings from user and workspace directories.
|
||||
* Project settings override user settings.
|
||||
* Load and merge settings from all scopes:
|
||||
* System Defaults → User (~/.qwen/settings.json) → Workspace → System.
|
||||
*/
|
||||
export function loadSettings(
|
||||
workspaceDir: string = process.cwd(),
|
||||
consumeCorruptionEnvVars: boolean = true,
|
||||
): LoadedSettings {
|
||||
// Apply any QWEN_HOME / QWEN_RUNTIME_DIR set in user-level `.env` files
|
||||
// BEFORE any code reads a path derived from them. After this call, the
|
||||
@ -850,17 +917,48 @@ export function loadSettings(
|
||||
const loadAndMigrate = (
|
||||
filePath: string,
|
||||
scope: SettingScope,
|
||||
): { settings: Settings; rawJson?: string; migrationWarnings?: string[] } => {
|
||||
): {
|
||||
settings: Settings;
|
||||
rawJson?: string;
|
||||
migrationWarnings?: string[];
|
||||
corruptedPath?: string;
|
||||
wasRecovered?: boolean;
|
||||
} => {
|
||||
try {
|
||||
if (fs.existsSync(filePath)) {
|
||||
let content = fs.readFileSync(filePath, 'utf-8');
|
||||
let rawSettings: unknown;
|
||||
let recoveryWarning: string | undefined;
|
||||
// Carry corruption state through to the final return so it
|
||||
// can be attached after the migration pipeline runs.
|
||||
const corruptedPath = `${filePath}${CORRUPTED_SUFFIX}`;
|
||||
let corruptedSaved = false;
|
||||
let recoveredFromBackup = false;
|
||||
let recoveredFromEnvVar: boolean | null = null;
|
||||
|
||||
try {
|
||||
rawSettings = JSON.parse(stripJsonComments(content));
|
||||
} catch (parseError: unknown) {
|
||||
// JSON parse failed — try to recover from .orig backup
|
||||
// ===== JSON parse failed — enter corruption recovery =====
|
||||
// Strategy: save corrupted file as .corrupted → recover from .orig →
|
||||
// show dialog in UI. Never crash due to a corrupted settings file.
|
||||
|
||||
// Step 1: copy corrupted file to .corrupted for reference
|
||||
// MUST guarantee .corrupted exists so onExit can restore it.
|
||||
// Use copy (not rename) — the file must stay on disk so that
|
||||
// child processes spawned by relaunchAppInChildProcess() can
|
||||
// enter the existsSync block where env-var propagation is
|
||||
// checked. Step 2 will overwrite it with .orig if available.
|
||||
|
||||
try {
|
||||
fs.copyFileSync(filePath, corruptedPath);
|
||||
corruptedSaved = true;
|
||||
} catch (copyError) {
|
||||
debugLogger.warn(
|
||||
`Failed to copy corrupted file: ${getErrorMessage(copyError)}`,
|
||||
);
|
||||
}
|
||||
|
||||
// Step 2: try recovering from .orig backup (created on each write)
|
||||
const backupPath = `${filePath}.orig`;
|
||||
if (fs.existsSync(backupPath)) {
|
||||
debugLogger.warn(
|
||||
@ -871,43 +969,63 @@ export function loadSettings(
|
||||
const backupSettings = JSON.parse(
|
||||
stripJsonComments(backupContent),
|
||||
);
|
||||
// Backup is valid — restore it
|
||||
// Backup valid — overwrite with backup to restore last good state
|
||||
fs.writeFileSync(filePath, backupContent, 'utf-8');
|
||||
content = backupContent;
|
||||
rawSettings = backupSettings;
|
||||
const recoveryMsg = `Settings file ${filePath} had invalid JSON and was recovered from backup ${backupPath}. Some recent settings changes may have been lost.`;
|
||||
debugLogger.warn(recoveryMsg);
|
||||
// Surface warning to user so they know settings were rolled back
|
||||
recoveryWarning = recoveryMsg;
|
||||
recoveredFromBackup = true;
|
||||
} catch (backupError) {
|
||||
// Could be invalid JSON, read error, or write-back failure
|
||||
// Backup also corrupted — give up recovery
|
||||
debugLogger.warn(
|
||||
`Failed to recover from backup ${backupPath}: ${getErrorMessage(backupError)}. Falling back to empty settings.`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// No valid backup available — rename the corrupted file so the app
|
||||
// can start with empty settings rather than crashing.
|
||||
// Step 3: no backup available — start with empty settings
|
||||
if (!rawSettings) {
|
||||
const corruptedPath = `${filePath}.corrupted.${Date.now()}`;
|
||||
let warningMsg: string;
|
||||
try {
|
||||
fs.renameSync(filePath, corruptedPath);
|
||||
warningMsg = `Settings file ${filePath} has invalid JSON and was renamed to ${corruptedPath}. Your settings have been reset. To recover, fix the JSON in ${corruptedPath} and rename it back.`;
|
||||
} catch (renameError) {
|
||||
// If rename fails, still proceed with empty settings
|
||||
debugLogger.error(
|
||||
`Failed to rename corrupted settings file: ${getErrorMessage(renameError)}`,
|
||||
);
|
||||
warningMsg = `Settings file ${filePath} has invalid JSON. Your settings have been reset. Please fix the JSON in ${filePath} manually.`;
|
||||
}
|
||||
const warningMsg = `Settings file ${filePath} has invalid JSON. Your settings have been reset.`;
|
||||
debugLogger.warn(warningMsg);
|
||||
if (corruptedSaved) {
|
||||
// Clear the original file so the settings UI shows empty settings
|
||||
// instead of the corrupted content.
|
||||
try {
|
||||
fs.writeFileSync(filePath, '{}', 'utf-8');
|
||||
} catch {
|
||||
/* ignore — settings are already empty in memory */
|
||||
}
|
||||
}
|
||||
return {
|
||||
settings: {},
|
||||
migrationWarnings: [warningMsg],
|
||||
migrationWarnings: [],
|
||||
corruptedPath: corruptedSaved ? corruptedPath : undefined,
|
||||
wasRecovered: false,
|
||||
};
|
||||
}
|
||||
// Fall through to migration pipeline — .orig backup may be in
|
||||
// an older schema and needs to go through runMigrations.
|
||||
}
|
||||
|
||||
// Propagate corruption state from parent process via env vars.
|
||||
// relaunchAppInChildProcess() spawns a child that re-reads
|
||||
// settings.json (already valid after parent recovered it). The
|
||||
// env vars preserve the corruption marker across the boundary.
|
||||
// Only apply to user scope since that's where corruption is detected.
|
||||
// Clear env vars after reading so subsequent loadSettings calls
|
||||
// don't re-trigger this path.
|
||||
const envCorruptedPath = process.env[ENV_CORRUPTED_PATH];
|
||||
if (
|
||||
consumeCorruptionEnvVars &&
|
||||
envCorruptedPath &&
|
||||
envCorruptedPath === corruptedPath &&
|
||||
scope === SettingScope.User
|
||||
) {
|
||||
corruptedSaved = true;
|
||||
recoveredFromEnvVar = process.env[ENV_WAS_RECOVERED] === '1';
|
||||
delete process.env[ENV_CORRUPTED_PATH];
|
||||
delete process.env[ENV_WAS_RECOVERED];
|
||||
}
|
||||
|
||||
if (
|
||||
@ -952,6 +1070,10 @@ export function loadSettings(
|
||||
}
|
||||
};
|
||||
|
||||
// Execute migrations even on recovered settings — the migrated data
|
||||
// must persist. The disk-write branches below (version normalization)
|
||||
// are guarded by !corruptedSaved to avoid creating .orig backups
|
||||
// of freshly-reset settings.
|
||||
if (needsMigration(settingsObject)) {
|
||||
const migrationResult = runMigrations(settingsObject, scope);
|
||||
if (migrationResult.executedMigrations.length > 0) {
|
||||
@ -961,7 +1083,10 @@ export function loadSettings(
|
||||
>;
|
||||
migrationWarnings = migrationResult.warnings;
|
||||
persistSettingsObject('Error migrating settings file on disk');
|
||||
} else if (hasLegacyNumericVersion || hasInvalidVersion) {
|
||||
} else if (
|
||||
(hasLegacyNumericVersion || hasInvalidVersion) &&
|
||||
!corruptedSaved
|
||||
) {
|
||||
// Migration was deemed needed but nothing executed. Normalize version metadata
|
||||
// to avoid repeated no-op checks on startup.
|
||||
settingsObject[SETTINGS_VERSION_KEY] = SETTINGS_VERSION;
|
||||
@ -971,28 +1096,30 @@ export function loadSettings(
|
||||
persistSettingsObject('Error normalizing settings version on disk');
|
||||
}
|
||||
} else if (
|
||||
!hasVersionKey ||
|
||||
hasInvalidVersion ||
|
||||
hasLegacyNumericVersion
|
||||
(!hasVersionKey || hasInvalidVersion || hasLegacyNumericVersion) &&
|
||||
!corruptedSaved
|
||||
) {
|
||||
// No migration needed/executable, but version metadata is missing or invalid.
|
||||
// Normalize it to current version to avoid repeated startup work.
|
||||
// Skip if we just recovered from corruption — the next startup will
|
||||
// handle normalization, avoiding an unnecessary writeWithBackupSync
|
||||
// that would create a .orig file from the freshly reset settings.
|
||||
settingsObject[SETTINGS_VERSION_KEY] = SETTINGS_VERSION;
|
||||
persistSettingsObject('Error normalizing settings version on disk');
|
||||
}
|
||||
|
||||
// Prepend recovery warning if settings were restored from backup
|
||||
const allWarnings = [
|
||||
...(recoveryWarning ? [recoveryWarning] : []),
|
||||
...(migrationWarnings ?? []),
|
||||
];
|
||||
|
||||
return {
|
||||
// Attach corruption state if settings were recovered from backup
|
||||
const result: ReturnType<typeof loadAndMigrate> = {
|
||||
settings: settingsObject as Settings,
|
||||
rawJson: content,
|
||||
migrationWarnings:
|
||||
allWarnings.length > 0 ? allWarnings : migrationWarnings,
|
||||
migrationWarnings: migrationWarnings ?? [],
|
||||
};
|
||||
if (corruptedSaved) {
|
||||
result.corruptedPath = corruptedPath;
|
||||
result.wasRecovered =
|
||||
recoveredFromBackup || (recoveredFromEnvVar ?? false);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
} catch (error: unknown) {
|
||||
settingsErrors.push({
|
||||
@ -1032,11 +1159,25 @@ export function loadSettings(
|
||||
const userOriginalSettings = structuredClone(userResult.settings);
|
||||
const workspaceOriginalSettings = structuredClone(workspaceResult.settings);
|
||||
|
||||
// Environment variables for runtime use
|
||||
systemSettings = resolveEnvVarsInObject(systemResult.settings);
|
||||
systemDefaultSettings = resolveEnvVarsInObject(systemDefaultsResult.settings);
|
||||
userSettings = resolveEnvVarsInObject(userResult.settings);
|
||||
workspaceSettings = resolveEnvVarsInObject(workspaceResult.settings);
|
||||
// Resolve ${VAR} placeholders in settings using home .env as fallback.
|
||||
// getHomeEnvFallbackVars() excludes keys already in process.env, so
|
||||
// effective precedence is: process.env > home .env > unresolved placeholder.
|
||||
// The resolver checks customEnv before process.env, but since customEnv
|
||||
// never contains a process.env key, process.env always wins.
|
||||
const homeEnvFallback = getHomeEnvFallbackVars();
|
||||
systemSettings = resolveEnvVarsInObject(
|
||||
systemResult.settings,
|
||||
homeEnvFallback,
|
||||
);
|
||||
systemDefaultSettings = resolveEnvVarsInObject(
|
||||
systemDefaultsResult.settings,
|
||||
homeEnvFallback,
|
||||
);
|
||||
userSettings = resolveEnvVarsInObject(userResult.settings, homeEnvFallback);
|
||||
workspaceSettings = resolveEnvVarsInObject(
|
||||
workspaceResult.settings,
|
||||
homeEnvFallback,
|
||||
);
|
||||
|
||||
// Support legacy theme names
|
||||
if (userSettings.ui?.theme === 'VS') {
|
||||
@ -1121,6 +1262,8 @@ export function loadSettings(
|
||||
isTrusted,
|
||||
migratedInMemorScopes,
|
||||
allMigrationWarnings,
|
||||
userResult.corruptedPath,
|
||||
userResult.wasRecovered ?? false,
|
||||
);
|
||||
}
|
||||
|
||||
@ -1139,6 +1282,7 @@ export function saveSettings(
|
||||
string,
|
||||
unknown
|
||||
>,
|
||||
replacePath: readonly string[] = [],
|
||||
): void {
|
||||
try {
|
||||
// Ensure the directory exists
|
||||
@ -1148,7 +1292,17 @@ export function saveSettings(
|
||||
}
|
||||
|
||||
// Use the format-preserving update function
|
||||
updateSettingsFilePreservingFormat(settingsFile.path, updates);
|
||||
const written = updateSettingsFilePreservingFormat(
|
||||
settingsFile.path,
|
||||
updates,
|
||||
false,
|
||||
replacePath,
|
||||
);
|
||||
if (!written) {
|
||||
debugLogger.error(
|
||||
`saveSettings: updateSettingsFilePreservingFormat returned false for ${settingsFile.path}`,
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
debugLogger.error('Error saving user settings file.');
|
||||
debugLogger.error(error instanceof Error ? error.message : String(error));
|
||||
|
||||
@ -8,6 +8,7 @@ import type {
|
||||
MCPServerConfig,
|
||||
BugCommandSettings,
|
||||
TelemetrySettings,
|
||||
OutboundCorrelationSettings,
|
||||
AuthType,
|
||||
ChatCompressionSettings,
|
||||
ModelProvidersConfig,
|
||||
@ -1037,6 +1038,29 @@ const SETTINGS_SCHEMA = {
|
||||
},
|
||||
},
|
||||
|
||||
outboundCorrelation: {
|
||||
type: 'object',
|
||||
label: 'Outbound Correlation',
|
||||
category: 'Advanced',
|
||||
requiresRestart: true,
|
||||
default: undefined as OutboundCorrelationSettings | undefined,
|
||||
description:
|
||||
"SECURITY-RELEVANT. Controls what client-side correlation data qwen-code writes into outbound LLM API requests (DashScope, OpenAI, Anthropic, etc.) — separate from `telemetry.*` which governs data flow into the operator's OWN OTLP collector. All values default to off. Opt in only when the LLM provider also reports into your OTel collector for cross-process trace stitching (e.g. ARMS Tracing + DashScope).",
|
||||
showInDialog: false,
|
||||
jsonSchemaOverride: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
propagateTraceContext: {
|
||||
description:
|
||||
"Requires `telemetry.enabled: true`. Inject W3C `traceparent` header on outbound `fetch` requests (LLM SDK calls, MCP StreamableHTTP, WebFetch, ...). Default: false — trace context stays internal to the operator's OTLP collector and is NOT written onto third-party request streams. Set true only when you want cross-process trace stitching with an OTel-aware LLM provider (e.g. ARMS+DashScope). Client HTTP spans are still emitted in either case; this flag only governs the wire `traceparent` header.",
|
||||
type: 'boolean',
|
||||
default: false,
|
||||
},
|
||||
},
|
||||
additionalProperties: false,
|
||||
},
|
||||
},
|
||||
|
||||
fastModel: {
|
||||
type: 'string',
|
||||
label: 'Fast Model',
|
||||
@ -1076,6 +1100,26 @@ const SETTINGS_SCHEMA = {
|
||||
'Maximum number of user/model/tool turns to keep in a session. -1 means unlimited.',
|
||||
showInDialog: false,
|
||||
},
|
||||
maxWallTimeSeconds: {
|
||||
type: 'number',
|
||||
label: 'Max Wall-Clock Time (seconds)',
|
||||
category: 'Model',
|
||||
requiresRestart: false,
|
||||
default: -1,
|
||||
description:
|
||||
'Run-level wall-clock budget for headless / unattended runs, in seconds. -1 means unlimited; otherwise must be in [1, ~2,147,483] (sub-second values and values above ~24 days are rejected as typos). Overridable per-invocation via --max-wall-time (which also accepts duration suffixes like 5m, 1.5h).',
|
||||
showInDialog: false,
|
||||
},
|
||||
maxToolCalls: {
|
||||
type: 'number',
|
||||
label: 'Max Tool Calls',
|
||||
category: 'Model',
|
||||
requiresRestart: false,
|
||||
default: -1,
|
||||
description:
|
||||
'Cumulative tool-call budget for a run (counts every executed tool, success or failure; structured_output under --json-schema is exempt). -1 means unlimited; 0 means "no tool calls allowed" (first call aborts). Capped at 1,000,000 to catch typos. Overridable via --max-tool-calls.',
|
||||
showInDialog: false,
|
||||
},
|
||||
chatCompression: {
|
||||
type: 'object',
|
||||
label: 'Chat Compression',
|
||||
@ -1109,7 +1153,8 @@ const SETTINGS_SCHEMA = {
|
||||
category: 'Model',
|
||||
requiresRestart: false,
|
||||
default: true,
|
||||
description: 'Disable all loop detection checks (streaming and LLM).',
|
||||
description:
|
||||
'Skip streaming loop detection. Defaults to true to avoid false-positive interruptions; set to false to re-enable as an unattended-run guardrail.',
|
||||
showInDialog: false,
|
||||
},
|
||||
skipStartupContext: {
|
||||
@ -1394,7 +1439,7 @@ const SETTINGS_SCHEMA = {
|
||||
label: 'Enable Managed Auto-Dream',
|
||||
category: 'Memory',
|
||||
requiresRestart: false,
|
||||
default: false,
|
||||
default: true,
|
||||
description:
|
||||
'Enable automatic consolidation (dream) of collected memories.',
|
||||
showInDialog: false,
|
||||
@ -1404,7 +1449,7 @@ const SETTINGS_SCHEMA = {
|
||||
label: 'Enable Auto Skill',
|
||||
category: 'Memory',
|
||||
requiresRestart: false,
|
||||
default: false,
|
||||
default: true,
|
||||
description:
|
||||
'Enable background review for reusable project skills after tool-heavy sessions.',
|
||||
showInDialog: false,
|
||||
@ -1762,6 +1807,28 @@ const SETTINGS_SCHEMA = {
|
||||
description: 'The number of lines to keep when truncating tool output.',
|
||||
showInDialog: false,
|
||||
},
|
||||
computerUse: {
|
||||
type: 'object',
|
||||
label: 'Computer Use',
|
||||
category: 'Tools',
|
||||
requiresRestart: true,
|
||||
default: {},
|
||||
description:
|
||||
'Cross-platform desktop automation via the upstream open-computer-use MCP server. Tools: list_apps, get_app_state, click, type_text, scroll, drag, press_key, perform_secondary_action, set_value. On first invocation, the upstream binary is fetched via npx and the user is walked through macOS Accessibility / Screen Recording permissions if needed.',
|
||||
showInDialog: false,
|
||||
properties: {
|
||||
enabled: {
|
||||
type: 'boolean',
|
||||
label: 'Enable Computer Use',
|
||||
category: 'Tools',
|
||||
requiresRestart: true,
|
||||
default: true,
|
||||
description:
|
||||
'When enabled (default), the 9 computer_use__* tools are registered as deferred built-ins.',
|
||||
showInDialog: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@ -2272,6 +2339,41 @@ const SETTINGS_SCHEMA = {
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
worktree: {
|
||||
type: 'object',
|
||||
label: 'Worktree',
|
||||
category: 'Advanced',
|
||||
requiresRestart: false,
|
||||
default: {},
|
||||
description:
|
||||
'Configuration for general-purpose git worktrees created by the ' +
|
||||
'CLI (the `enter_worktree` tool, the `agent isolation: "worktree"` ' +
|
||||
'parameter, and the startup `--worktree` flag). Does NOT affect ' +
|
||||
'Agent Arena worktrees — see `agents.arena.worktreeBaseDir` for those.',
|
||||
showInDialog: false,
|
||||
properties: {
|
||||
symlinkDirectories: {
|
||||
type: 'array',
|
||||
label: 'Symlink Directories Into Worktrees',
|
||||
category: 'Advanced',
|
||||
requiresRestart: false,
|
||||
default: undefined as string[] | undefined,
|
||||
description:
|
||||
'Directories under the main repository to symlink into every ' +
|
||||
'general-purpose worktree on creation. Useful for sharing ' +
|
||||
'large opt-in dirs like `node_modules` so the model can run ' +
|
||||
'tests / builds inside the worktree without a fresh install. ' +
|
||||
'Paths must be relative to the repo root; absolute paths, ' +
|
||||
'anything containing `..`, and any path inside `.git` or ' +
|
||||
'`.qwen` (the CLI-managed metadata tree, which contains ' +
|
||||
'the worktrees directory itself) are rejected. Missing ' +
|
||||
'source dirs and existing destination paths are silently ' +
|
||||
'skipped (no overwrite, no failure).',
|
||||
showInDialog: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
} as const satisfies SettingsSchema;
|
||||
|
||||
export type SettingsSchemaType = typeof SETTINGS_SCHEMA;
|
||||
|
||||
@ -24,7 +24,7 @@ import type { CliArgs } from './config/config.js';
|
||||
import { type LoadedSettings } from './config/settings.js';
|
||||
import { appEvents, AppEvent } from './utils/events.js';
|
||||
import type { Config } from '@qwen-code/qwen-code-core';
|
||||
import { OutputFormat } from '@qwen-code/qwen-code-core';
|
||||
import { ApprovalMode, OutputFormat } from '@qwen-code/qwen-code-core';
|
||||
|
||||
const mockWriteStderrLine = vi.hoisted(() => vi.fn());
|
||||
|
||||
@ -181,6 +181,7 @@ describe('gemini.tsx main function', () => {
|
||||
isInteractive: () => false,
|
||||
getQuestion: () => '',
|
||||
getSandbox: () => false,
|
||||
getApprovalMode: () => ApprovalMode.DEFAULT,
|
||||
getDebugMode: () => false,
|
||||
getListExtensions: () => false,
|
||||
getMcpServers: () => ({}),
|
||||
@ -260,6 +261,7 @@ describe('gemini.tsx main function', () => {
|
||||
isInteractive: () => false,
|
||||
getQuestion: () => 'bare prompt',
|
||||
getSandbox: () => false,
|
||||
getApprovalMode: () => ApprovalMode.DEFAULT,
|
||||
getDebugMode: () => false,
|
||||
getListExtensions: () => false,
|
||||
getMcpServers: () => ({}),
|
||||
@ -569,6 +571,7 @@ describe('gemini.tsx main function', () => {
|
||||
isInteractive: () => false,
|
||||
getQuestion: () => ' hello stream ',
|
||||
getSandbox: () => false,
|
||||
getApprovalMode: () => ApprovalMode.DEFAULT,
|
||||
getDebugMode: () => false,
|
||||
getListExtensions: () => false,
|
||||
getMcpServers: () => ({}),
|
||||
@ -773,6 +776,8 @@ describe('gemini.tsx main function kitty protocol', () => {
|
||||
disabledSlashCommands: undefined,
|
||||
authType: undefined,
|
||||
maxSessionTurns: undefined,
|
||||
maxWallTime: undefined,
|
||||
maxToolCalls: undefined,
|
||||
experimentalLsp: undefined,
|
||||
channel: undefined,
|
||||
chatRecording: undefined,
|
||||
|
||||
@ -21,7 +21,7 @@ import {
|
||||
import { render } from 'ink';
|
||||
import dns from 'node:dns';
|
||||
import os from 'node:os';
|
||||
import { basename } from 'node:path';
|
||||
import path, { basename } from 'node:path';
|
||||
import v8 from 'node:v8';
|
||||
import React from 'react';
|
||||
import { validateAuthMethod } from './config/auth.js';
|
||||
@ -29,6 +29,8 @@ import * as cliConfig from './config/config.js';
|
||||
import { loadCliConfig, parseArguments } from './config/config.js';
|
||||
import type { DnsResolutionOrder, LoadedSettings } from './config/settings.js';
|
||||
import {
|
||||
ENV_CORRUPTED_PATH,
|
||||
ENV_WAS_RECOVERED,
|
||||
createMinimalSettings,
|
||||
getSettingsWarnings,
|
||||
loadSettings,
|
||||
@ -39,6 +41,12 @@ import {
|
||||
type InitializationResult,
|
||||
} from './core/initializer.js';
|
||||
import { runNonInteractive } from './nonInteractiveCli.js';
|
||||
import {
|
||||
setupStartupWorktree,
|
||||
persistStartupWorktreeSidecar,
|
||||
buildStartupWorktreeNotice,
|
||||
type StartupWorktreeContext,
|
||||
} from './startup/worktreeStartup.js';
|
||||
import { runNonInteractiveStreamJson } from './nonInteractive/session.js';
|
||||
import { AppContainer } from './ui/AppContainer.js';
|
||||
import { setMaxSizedBoxDebugging } from './ui/components/shared/MaxSizedBox.js';
|
||||
@ -78,7 +86,9 @@ import { start_sandbox } from './utils/sandbox.js';
|
||||
import { getStartupWarnings } from './utils/startupWarnings.js';
|
||||
import { getUserStartupWarnings } from './utils/userStartupWarnings.js';
|
||||
import { getCliVersion } from './utils/version.js';
|
||||
import { initializeWarningHandler } from './utils/warningHandler.js';
|
||||
import { writeStderrLine } from './utils/stdioHelpers.js';
|
||||
import { getHeadlessYoloSafetyWarning } from './utils/headlessSafetyWarnings.js';
|
||||
import { computeWindowTitle } from './utils/windowTitle.js';
|
||||
import {
|
||||
startEarlyInputCapture,
|
||||
@ -97,6 +107,11 @@ import { installSynchronizedOutput } from './ui/utils/synchronizedOutput.js';
|
||||
|
||||
const debugLogger = createDebugLogger('STARTUP');
|
||||
|
||||
function clearCorruptionEnvVars(): void {
|
||||
delete process.env[ENV_CORRUPTED_PATH];
|
||||
delete process.env[ENV_WAS_RECOVERED];
|
||||
}
|
||||
|
||||
export function validateDnsResolutionOrder(
|
||||
order: string | undefined,
|
||||
): DnsResolutionOrder {
|
||||
@ -402,6 +417,7 @@ export async function main() {
|
||||
setStartupEventSink((name, attrs) => recordStartupEvent(name, attrs));
|
||||
}
|
||||
setupUnhandledRejectionHandler();
|
||||
initializeWarningHandler();
|
||||
|
||||
if (process.argv.includes('--bare')) {
|
||||
process.env[QWEN_CODE_SIMPLE_ENV_VAR] = '1';
|
||||
@ -418,12 +434,38 @@ export async function main() {
|
||||
process.env[QWEN_CODE_SIMPLE_ENV_VAR] = '1';
|
||||
}
|
||||
|
||||
// Load user settings — bare mode uses minimal config, normal mode loads full.
|
||||
const settings = isBareMode(argv.bare)
|
||||
? createMinimalSettings()
|
||||
: loadSettings();
|
||||
|
||||
// Propagate corruption state to child process via env vars so
|
||||
// relaunchAppInChildProcess() doesn't lose the marker.
|
||||
if (settings.corruptedPath) {
|
||||
process.env[ENV_CORRUPTED_PATH] = settings.corruptedPath;
|
||||
process.env[ENV_WAS_RECOVERED] = settings.wasRecovered ? '1' : '0';
|
||||
}
|
||||
await cleanupCheckpoints();
|
||||
// Performance checkpoint
|
||||
profileCheckpoint('after_load_settings');
|
||||
|
||||
// Emit settings warnings early so the parent process surfaces them
|
||||
// before relaunchAppInChildProcess() exits (the child has empty
|
||||
// migrationWarnings because the parent already renamed the file).
|
||||
const settingsWarnings = getSettingsWarnings(settings);
|
||||
for (const warning of settingsWarnings) {
|
||||
writeStderrLine(warning);
|
||||
}
|
||||
// Corruption notification no longer goes through migrationWarnings —
|
||||
// check corruptedPath directly to keep stderr visible in relaunch.
|
||||
if (settings.corruptedPath) {
|
||||
writeStderrLine(
|
||||
'Warning: Settings file had invalid JSON and was reset. ' +
|
||||
'A copy of the corrupted file has been saved at: ' +
|
||||
settings.corruptedPath,
|
||||
);
|
||||
}
|
||||
|
||||
// Check for invalid input combinations early to prevent crashes
|
||||
if (argv.promptInteractive && !process.stdin.isTTY) {
|
||||
writeStderrLine(
|
||||
@ -577,7 +619,89 @@ export async function main() {
|
||||
} else {
|
||||
// Relaunch app so we always have a child process that can be internally
|
||||
// restarted if needed.
|
||||
await relaunchAppInChildProcess(memoryArgs, []);
|
||||
await relaunchAppInChildProcess(memoryArgs, [], {
|
||||
afterSpawn: clearCorruptionEnvVars,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// When --worktree is going to chdir us into a worktree below, resolve
|
||||
// any relative-path argv fields to absolute paths now — BEFORE the
|
||||
// chdir. Otherwise downstream `fs.existsSync('./mcp.json')` calls in
|
||||
// `loadCliConfig` re-resolve against the worktree dir, where the file
|
||||
// doesn't exist. Only touches values that look like paths (mcpConfig
|
||||
// also accepts inline JSON — skip those).
|
||||
//
|
||||
// The list of fields below is hand-maintained. If you add a new
|
||||
// CLI flag that takes a relative path, register it here too,
|
||||
// otherwise --worktree silently breaks for that flag.
|
||||
if (argv.worktree !== undefined) {
|
||||
const launchCwdForPaths = process.cwd();
|
||||
const looksLikeInlineJson = (v: string): boolean => {
|
||||
const t = v.trim();
|
||||
return t.startsWith('{') || t.startsWith('[');
|
||||
};
|
||||
const resolveIfPath = (v: string | undefined): string | undefined => {
|
||||
if (typeof v !== 'string' || v.length === 0) return v;
|
||||
if (looksLikeInlineJson(v)) return v;
|
||||
return path.resolve(launchCwdForPaths, v);
|
||||
};
|
||||
argv.mcpConfig = resolveIfPath(argv.mcpConfig);
|
||||
argv.openaiLoggingDir = resolveIfPath(argv.openaiLoggingDir);
|
||||
argv.jsonFile = resolveIfPath(argv.jsonFile);
|
||||
argv.inputFile = resolveIfPath(argv.inputFile);
|
||||
argv.telemetryOutfile = resolveIfPath(argv.telemetryOutfile);
|
||||
if (Array.isArray(argv.includeDirectories)) {
|
||||
argv.includeDirectories = argv.includeDirectories.map((d) =>
|
||||
typeof d === 'string' && d.length > 0
|
||||
? path.resolve(launchCwdForPaths, d)
|
||||
: d,
|
||||
);
|
||||
}
|
||||
// `--json-schema` accepts either an inline schema or `@<path>`. The
|
||||
// `@`-prefixed form is read from disk inside `resolveJsonSchemaArg`
|
||||
// (`packages/cli/src/config/config.ts`), AFTER chdir, so a relative
|
||||
// value would resolve against the worktree — fix the prefix path
|
||||
// here.
|
||||
if (typeof argv.jsonSchema === 'string') {
|
||||
const trimmedSchema = argv.jsonSchema.trim();
|
||||
if (trimmedSchema.startsWith('@')) {
|
||||
const rel = trimmedSchema.slice(1);
|
||||
if (rel.length > 0 && !path.isAbsolute(rel)) {
|
||||
argv.jsonSchema = '@' + path.resolve(launchCwdForPaths, rel);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Phase D-1: process --worktree before the resume picker so the picker
|
||||
// (which uses process.cwd() to scope its session search) finds sessions
|
||||
// saved inside the target worktree. Creates the worktree directory on
|
||||
// disk and chdirs into it; on failure we emit to stderr and exit before
|
||||
// any expensive initialization runs.
|
||||
//
|
||||
// ACP mode is exempt: the ACP host (Zed, etc.) supplies its own per-session
|
||||
// cwd, and the startup-level chdir would not propagate. Reject the
|
||||
// combination with a clear error rather than silently dropping --worktree.
|
||||
let startupWorktreeContext: StartupWorktreeContext | null = null;
|
||||
if (argv.worktree !== undefined && (argv.acp || argv.experimentalAcp)) {
|
||||
writeStderrLine(
|
||||
'--worktree cannot be combined with --acp / --experimental-acp. ' +
|
||||
'Pass the worktree path as the cwd of the ACP loadSession / newSession ' +
|
||||
'request instead.',
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
{
|
||||
const startupRes = await setupStartupWorktree(argv.worktree, {
|
||||
symlinkDirectories: settings.merged.worktree?.symlinkDirectories,
|
||||
});
|
||||
if (startupRes !== null) {
|
||||
if (!startupRes.ok) {
|
||||
writeStderrLine(startupRes.error);
|
||||
process.exit(1);
|
||||
}
|
||||
startupWorktreeContext = startupRes.context;
|
||||
}
|
||||
}
|
||||
|
||||
@ -653,6 +777,51 @@ export async function main() {
|
||||
);
|
||||
profileCheckpoint('after_load_cli_config');
|
||||
|
||||
// Phase D-1: persist the WorktreeSession sidecar so Phase C's restore
|
||||
// machinery on a subsequent `--resume` picks the worktree back up, and
|
||||
// capture any override of a previously-resumed session's worktree so
|
||||
// we can emit a one-shot notice on the model's first prompt.
|
||||
//
|
||||
// The notice is set BEFORE the persist attempt and AGAIN inside the
|
||||
// try block (so the override addendum can be appended on success).
|
||||
// A persist failure must NOT silently drop the notice — the cwd is
|
||||
// already switched, and the model needs to know which worktree it's
|
||||
// operating in regardless of whether the sidecar landed.
|
||||
if (startupWorktreeContext) {
|
||||
config.setPendingStartupWorktreeNotice(
|
||||
buildStartupWorktreeNotice(startupWorktreeContext),
|
||||
);
|
||||
try {
|
||||
const startupWorktreePersist = await persistStartupWorktreeSidecar(
|
||||
config,
|
||||
startupWorktreeContext,
|
||||
);
|
||||
if (startupWorktreePersist.overrodeResumedWorktree) {
|
||||
writeStderrLine(
|
||||
`--worktree overrode the resumed session's previous worktree ` +
|
||||
`"${startupWorktreePersist.overriddenSlug ?? '(unknown)'}". ` +
|
||||
`That worktree directory was left intact on disk.`,
|
||||
);
|
||||
}
|
||||
// Refresh the notice with the override addendum (if any). When
|
||||
// there is no override this is a no-op text-wise; on override it
|
||||
// gives the model the "you overrode <previous-slug>" hint. TUI
|
||||
// and headless consume this via Config.consumePendingStartupWorktreeNotice();
|
||||
// ACP is excluded above (`--worktree` × `--acp` is mutually
|
||||
// exclusive — see the mutex check earlier in this function).
|
||||
config.setPendingStartupWorktreeNotice(
|
||||
buildStartupWorktreeNotice(
|
||||
startupWorktreeContext,
|
||||
startupWorktreePersist,
|
||||
),
|
||||
);
|
||||
} catch (error) {
|
||||
debugLogger.warn(
|
||||
`--worktree sidecar persist failed (non-fatal, notice preserved): ${error instanceof Error ? error.message : String(error)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Register cleanup for MCP clients as early as possible
|
||||
// This ensures MCP server subprocesses are properly terminated on exit
|
||||
registerCleanup(() => config.shutdown());
|
||||
@ -761,6 +930,17 @@ export async function main() {
|
||||
]),
|
||||
];
|
||||
|
||||
// Surface critical startup warnings (corrupted settings, recovery, etc.)
|
||||
// to stderr so they are visible regardless of UI mode. In interactive
|
||||
// mode the TUI's Notifications component also renders them, but the
|
||||
// onboarding flow can obscure the notification area, leaving users
|
||||
// unaware that their settings were reset. Writing to stderr before
|
||||
// the TUI takes over ensures the message is visible in the terminal
|
||||
// scrollback. In non-interactive mode this is the *only* channel.
|
||||
for (const warning of startupWarnings) {
|
||||
writeStderrLine(warning);
|
||||
}
|
||||
|
||||
// Render UI, passing necessary config values. Check that there is no command line question.
|
||||
profileCheckpoint('before_render');
|
||||
|
||||
@ -802,9 +982,16 @@ export async function main() {
|
||||
process.cwd(),
|
||||
initializationResult!,
|
||||
);
|
||||
// Clean up corruption env vars so subsequent relaunch children
|
||||
// and subprocesses don't inherit stale state.
|
||||
clearCorruptionEnvVars();
|
||||
return;
|
||||
}
|
||||
|
||||
// Also clean up env vars for non-interactive paths so that
|
||||
// subprocesses don't inherit stale state.
|
||||
clearCorruptionEnvVars();
|
||||
|
||||
// Non-interactive: defer finalize until after `config.initialize()` runs
|
||||
// so MCP discovery events (mcp_first_tool_registered, mcp_all_servers_settled,
|
||||
// gemini_tools_updated) are captured in the profile.
|
||||
@ -822,6 +1009,17 @@ export async function main() {
|
||||
}
|
||||
}
|
||||
|
||||
// Headless + YOLO without a sandbox lets the model auto-approve and
|
||||
// execute shell / write / edit tools at the current process's
|
||||
// privilege level. Emit a one-line stderr warning so unattended runs
|
||||
// have at least an observable signal. Interactive runs are excluded
|
||||
// because the user is at the keyboard and the TUI shows approval
|
||||
// state directly. See issue #4103.
|
||||
if (!config.isInteractive()) {
|
||||
const yoloWarning = getHeadlessYoloSafetyWarning(config);
|
||||
if (yoloWarning) writeStderrLine(yoloWarning);
|
||||
}
|
||||
|
||||
// For non-stream-json mode, initialize config here. Stream-json defers
|
||||
// `config.initialize()` to inside `Session.ensureConfigInitialized`
|
||||
// because the initial control_request may register SDK MCP servers
|
||||
|
||||
@ -861,6 +861,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Memòria automàtica: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream per executar',
|
||||
'Auto-skill: {{status}}': 'Habilitat automàtica: {{status}}',
|
||||
never: 'mai',
|
||||
on: 'activada',
|
||||
off: 'desactivada',
|
||||
|
||||
@ -818,6 +818,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Auto-Speicher: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Auto-Konsolidierung: {{status}} · {{lastDream}} · /dream zum Ausführen',
|
||||
'Auto-skill: {{status}}': 'Auto-Skill: {{status}}',
|
||||
never: 'nie',
|
||||
on: 'ein',
|
||||
off: 'aus',
|
||||
|
||||
@ -901,6 +901,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Auto-memory: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run',
|
||||
'Auto-skill: {{status}}': 'Auto-skill: {{status}}',
|
||||
never: 'never',
|
||||
on: 'on',
|
||||
off: 'off',
|
||||
|
||||
@ -1859,6 +1859,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Mémoire automatique : {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Rêve automatique : {{status}} · {{lastDream}} · /dream pour lancer',
|
||||
'Auto-skill: {{status}}': 'Compétence automatique : {{status}}',
|
||||
never: 'jamais',
|
||||
on: 'activé',
|
||||
off: 'désactivé',
|
||||
|
||||
@ -594,6 +594,7 @@ export default {
|
||||
'Auto-memory: {{status}}': '自動メモリ: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'自動統合: {{status}} · {{lastDream}} · /dream で実行',
|
||||
'Auto-skill: {{status}}': '自動スキル: {{status}}',
|
||||
never: '未実行',
|
||||
on: 'オン',
|
||||
off: 'オフ',
|
||||
|
||||
@ -823,6 +823,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Memória automática: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Consolidação automática: {{status}} · {{lastDream}} · /dream para executar',
|
||||
'Auto-skill: {{status}}': 'Habilidade automática: {{status}}',
|
||||
never: 'nunca',
|
||||
on: 'ativado',
|
||||
off: 'desativado',
|
||||
|
||||
@ -832,6 +832,7 @@ export default {
|
||||
'Auto-memory: {{status}}': 'Автопамять: {{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'Автоконсолидация: {{status}} · {{lastDream}} · /dream для запуска',
|
||||
'Auto-skill: {{status}}': 'Автонавык: {{status}}',
|
||||
never: 'никогда',
|
||||
on: 'вкл',
|
||||
off: 'выкл',
|
||||
|
||||
@ -768,6 +768,7 @@ export default {
|
||||
'Auto-memory: {{status}}': '自動記憶:{{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'自動整理:{{status}} · {{lastDream}} · /dream 立即運行',
|
||||
'Auto-skill: {{status}}': '自動技能:{{status}}',
|
||||
never: '從未',
|
||||
on: '開',
|
||||
off: '關',
|
||||
|
||||
@ -852,6 +852,7 @@ export default {
|
||||
'Auto-memory: {{status}}': '自动记忆:{{status}}',
|
||||
'Auto-dream: {{status}} · {{lastDream}} · /dream to run':
|
||||
'自动整理:{{status}} · {{lastDream}} · /dream 立即运行',
|
||||
'Auto-skill: {{status}}': '自动技能:{{status}}',
|
||||
never: '从未',
|
||||
on: '开',
|
||||
off: '关',
|
||||
|
||||
@ -35,6 +35,7 @@ export interface IControlContext {
|
||||
readonly settings: LoadedSettings;
|
||||
|
||||
permissionMode: PermissionMode;
|
||||
sdkCanUseToolTimeoutMs?: number;
|
||||
sdkMcpServers: Set<string>;
|
||||
mcpClients: Map<string, { client: Client; config: MCPServerConfig }>;
|
||||
inputClosed: boolean;
|
||||
@ -54,6 +55,7 @@ export class ControlContext implements IControlContext {
|
||||
readonly settings: LoadedSettings;
|
||||
|
||||
permissionMode: PermissionMode;
|
||||
sdkCanUseToolTimeoutMs?: number;
|
||||
sdkMcpServers: Set<string>;
|
||||
mcpClients: Map<string, { client: Client; config: MCPServerConfig }>;
|
||||
inputClosed: boolean;
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user