Skip to content

feat: add enabled flag for compaction config#4

Closed
davidrudduck wants to merge 1 commit intomainfrom
feat/enabled-flag-compaction-decay
Closed

feat: add enabled flag for compaction config#4
davidrudduck wants to merge 1 commit intomainfrom
feat/enabled-flag-compaction-decay

Conversation

@davidrudduck
Copy link
Copy Markdown
Owner

@davidrudduck davidrudduck commented Mar 3, 2026

Summary

  • Adds an optional enabled boolean to the compaction configuration
  • When enabled: false, all compaction paths are disabled (safeguard extension, direct compaction, extension factory)
  • Default behaviour unchanged — compaction is enabled when the flag is omitted

Motivation

Plugins that manage the context budget externally (via before_context_send) need the ability to disable built-in compaction. This gives plugin authors a clean config flag rather than requiring workarounds.

Changes

  • src/config/types.agent-defaults.ts — Added enabled?: boolean to AgentCompactionConfig
  • src/config/zod-schema.agent-defaults.ts — Added enabled to compaction Zod schema
  • src/agents/pi-extensions/compaction-safeguard-runtime.ts — Added enabled to runtime value type
  • src/agents/pi-extensions/compaction-safeguard.ts — Early cancel when enabled === false
  • src/agents/pi-embedded-runner/compact.ts — Early return in direct compaction path
  • src/agents/pi-embedded-runner/extensions.ts — Gate safeguard factory on enabled !== false

Test plan

  • Verify pnpm tsgo passes
  • Verify existing compaction tests still pass
  • Manual: set compaction.enabled: false, verify compaction doesn't fire
  • Manual: omit enabled flag, verify default behaviour unchanged

Config example

agents:
  defaults:
    compaction:
      enabled: false  # external plugin manages context budget
      mode: safeguard

Summary by CodeRabbit

Release Notes

  • New Features
    • Added configuration control for compaction. A new optional configuration flag in agent defaults enables disabling all compaction operations (both direct and safeguard modes) globally. When compaction is disabled via configuration, the system skips all compaction processing and returns early, eliminating unnecessary compaction work at multiple points in the request handling pipeline.

Adds an optional `enabled` boolean to the compaction config, allowing
compaction to be completely disabled when external plugins manage the
context budget. Belt-and-suspenders: the safeguard extension, direct
compaction path, and extension factory registration all check the flag.

Default behaviour is unchanged (enabled when omitted).
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 3, 2026

📝 Walkthrough

Walkthrough

Configuration-driven compaction control is added through an optional enabled flag in agent defaults. Guards are implemented across compaction runners and safeguard extensions to skip compaction when disabled. Configuration types and validation schemas are updated to support the new flag.

Changes

Cohort / File(s) Summary
Configuration System
src/config/types.agent-defaults.ts, src/config/zod-schema.agent-defaults.ts
Added optional enabled?: boolean field to AgentCompactionConfig with comment indicating it disables all compaction when false. Zod schema updated with enabled: z.boolean().optional() validation.
Compaction Runtime Types
src/agents/pi-extensions/compaction-safeguard-runtime.ts
Added optional enabled?: boolean field to CompactionSafeguardRuntimeValue type to propagate enabled status through runtime configuration.
Compaction Execution with Guards
src/agents/pi-embedded-runner/compact.ts, src/agents/pi-embedded-runner/extensions.ts, src/agents/pi-extensions/compaction-safeguard.ts
Implemented early-return guards across three files. Direct compaction checks params.config.agents.defaults.compaction.enabled before executing. Safeguard extension enables safeguard only when mode is "safeguard" and enabled is not false, propagating enabled flag to runtime. Safeguard runtime logs and cancels compaction when enabled is explicitly false.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and specifically describes the main change: adding an enabled flag for the compaction configuration.
Description check ✅ Passed The pull request description covers most required sections including summary, motivation, changes, and test plan, though some template sections are incomplete.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/enabled-flag-compaction-decay

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
src/agents/pi-embedded-runner/compact.ts (1)

262-266: Consider logging the explicit-disable fast path.

Line 265 returns early with no diagnostic entry, which can make “why compaction didn’t run” harder to trace during debugging.

🔎 Optional observability tweak
 // Check if compaction is disabled by config
 const compactionCfg = params.config?.agents?.defaults?.compaction;
 if (compactionCfg?.enabled === false) {
+  log.info(
+    `[compaction-diag] skip runId=${runId} sessionKey=${params.sessionKey ?? params.sessionId} ` +
+      `diagId=${diagId} trigger=${trigger} provider=${provider}/${modelId} reason=disabled_by_config`,
+  );
   return { ok: true, compacted: false, reason: "compaction disabled by config" };
 }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/agents/pi-embedded-runner/compact.ts` around lines 262 - 266, The
early-return when compactionCfg?.enabled === false currently provides no
diagnostic; before returning from this fast path, emit a diagnostic log that
compaction was explicitly disabled (include compactionCfg and relevant config
path) so it’s visible in traces — e.g., call the module’s logger (processLogger
or existing logger variable) to log an info/debug message right before the
return in the block that checks params.config?.agents?.defaults?.compaction
(referencing compactionCfg and params).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/agents/pi-embedded-runner/compact.ts`:
- Around line 262-266: The early-return when compactionCfg?.enabled === false
currently provides no diagnostic; before returning from this fast path, emit a
diagnostic log that compaction was explicitly disabled (include compactionCfg
and relevant config path) so it’s visible in traces — e.g., call the module’s
logger (processLogger or existing logger variable) to log an info/debug message
right before the return in the block that checks
params.config?.agents?.defaults?.compaction (referencing compactionCfg and
params).

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4906701 and fe7160f.

📒 Files selected for processing (6)
  • src/agents/pi-embedded-runner/compact.ts
  • src/agents/pi-embedded-runner/extensions.ts
  • src/agents/pi-extensions/compaction-safeguard-runtime.ts
  • src/agents/pi-extensions/compaction-safeguard.ts
  • src/config/types.agent-defaults.ts
  • src/config/zod-schema.agent-defaults.ts

@davidrudduck
Copy link
Copy Markdown
Owner Author

Replacing with clean branch

@davidrudduck davidrudduck deleted the feat/enabled-flag-compaction-decay branch March 3, 2026 22:41
davidrudduck pushed a commit that referenced this pull request Mar 16, 2026
1. [P1] Treat remap failures as resume failures — if replaceSubagentRunAfterSteer
   returns false, do NOT clear abortedLastRun, increment failed count.

2. [P2] Count scan-level exceptions as retryable failures — set result.failed > 0
   in the outer catch block so scheduleOrphanRecovery retry logic triggers.

3. [P2] Persist resumed-session dedupe across recovery retries — accept
   resumedSessionKeys as a parameter; scheduleOrphanRecovery lifts the Set to
   its own scope and passes it through retries.

4. [Greptile] Use typed config accessors instead of raw structural cast for TLS
   check in lifecycle.ts.

5. [Greptile] Forward gateway.reload.deferralTimeoutMs to deferGatewayRestartUntilIdle
   in scheduleGatewaySigusr1Restart so user-configured value is not silently ignored.

6. [Greptile] Same as #4 — already addressed by the typed config fix.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
davidrudduck pushed a commit that referenced this pull request Mar 31, 2026
* feat: add QQ Bot channel extension

* fix(qqbot): add setupWizard to runtime plugin for onboard re-entry

* fix: fix review

* fix: fix review

* chore: sync lockfile and config-docs baseline for qqbot extension

* refactor: 移除图床服务器相关代码

* fix

* docs: 新增 QQ Bot 插件文档并修正链接路径

* refactor: remove credential backup functionality and update setup logic

- Deleted the credential backup module to streamline the codebase.
- Updated the setup surface to handle client secrets more robustly, allowing for configured secret inputs.
- Simplified slash commands by removing unused hot upgrade compatibility checks and related functions.
- Adjusted types to use SecretInput for client secrets in QQBot configuration.
- Modified bundled plugin metadata to allow additional properties in the config schema.

* feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理

* feat: 添加本地媒体路径解析功能,修正 QQBot 媒体路径处理

* feat: remove qqbot-media and qqbot-remind skills, add tests for config and setup

- Deleted the qqbot-media and qqbot-remind skills documentation files.
- Added unit tests for qqbot configuration and setup processes, ensuring proper handling of SecretRef-backed credentials and account configurations.
- Implemented tests for local media path remapping, verifying correct resolution of media file paths.
- Removed obsolete channel and remind tools, streamlining the codebase.

* feat: 更新 QQBot 配置模式,添加音频格式和账户定义

* feat: 添加 QQBot 频道管理和定时提醒技能,更新媒体路径解析功能

* fix

* feat: 添加 /bot-upgrade 指令以查看 QQBot 插件升级指引

* feat: update reminder and qq channel skills

* feat: 更新remind工具投递目标地址格式

* feat: Refactor QQBot payload handling and improve code documentation

- Simplified and clarified the structure of payload interfaces for Cron reminders and media messages.
- Enhanced the parsing function to provide clearer error messages and improved validation.
- Updated platform utility functions for better cross-platform compatibility and clearer documentation.
- Improved text parsing utilities for better readability and consistency in emoji representation.
- Optimized upload cache management with clearer comments and reduced redundancy.
- Integrated QQBot plugin into the bundled channel plugins and updated metadata for installation.

* OK apps/macos/Sources/OpenClaw/HostEnvSecurityPolicy.generated.swift

> [email protected] check:bundled-channel-config-metadata /Users/yuehuali/code/PR/openclaw
> node --import tsx scripts/generate-bundled-channel-config-metadata.ts --check

[bundled-channel-config-metadata] stale generated output at src/config/bundled-channel-config-metadata.generated.ts
 ELIFECYCLE  Command failed with exit code 1.
 ELIFECYCLE  Command failed with exit code 1.

* feat: 添加 QQBot 渠道配置及相关账户设置

* fix(qqbot): resolve 14 high-priority bugs from PR openclaw#52986 review

DM routing (7 fixes):
- #1: DM slash-command replies use sendDmMessage(guildId) instead of sendC2CMessage(senderId)
- #2: DM qualifiedTarget uses qqbot:dm:${guildId} instead of qqbot:c2c:${senderId}
- #3: sendTextChunks adds DM branch
- #4: sendMarkdownReply adds DM branch for text and Base64 images
- #5: parseAndSendMediaTags maps DM to targetType:dm + guildId
- #6: sendTextToTarget DM branch uses sendDmMessage; MessageTarget adds guildId field
- #7: handleImage/Audio/Video/FilePayload add DM branches

Other high-priority fixes:
- #8: Fix sendC2CVoiceMessage/sendGroupVoiceMessage parameter misalignment
- #9: broadcastMessage uses groupOpenid instead of member_openid for group users
- #10: Unify KnownUser storage - proactive.ts delegates to known-users.ts
- #11: Remove invalid recordKnownUser calls for guild/DM users
- #12: sendGroupMessage uses sendAndNotify to trigger onMessageSent hook
- #13: sendPhoto channel unsupported returns error field
- #14: sendTextAfterMedia adds channel and dm branches

Type fixes:
- DeliverEventContext adds guildId field
- MediaTargetContext.targetType adds dm variant
- sendPlainTextReply imgMediaTarget adds DM branch

* fix(qqbot): resolve 2 blockers + 7 medium-priority bugs from PR openclaw#52986 review

Blocker-1: Remove unused dmPolicy config knob
- dmPolicy was declared in schema/types/plugin.json but never consumed at runtime
- Removed from config-schema.ts, types.ts, and openclaw.plugin.json
- allowFrom remains active (already wired into framework command-auth)

Blocker-2: Gate sensitive slash commands with allowFrom authorization
- SlashCommand interface adds requireAuth?: boolean
- SlashCommandContext adds commandAuthorized: boolean
- /bot-logs set to requireAuth: true (reads local log files)
- matchSlashCommand rejects unauthorized senders for requireAuth commands
- trySlashCommandOrEnqueue computes commandAuthorized from allowFrom config

Medium-priority fixes:
- #15: Strip non-HTTP/non-local markdown image tags to prevent path leakage
- openclaw#16: applyQQBotAccountConfig clears clientSecret when setting clientSecretFile and vice versa
- openclaw#17: getAdminMarkerFile sanitizes accountId to prevent path traversal
- openclaw#18: URGENT_COMMANDS uses exact match instead of startsWith prefix match
- openclaw#19: isCronExpression validates each token starts with a cron-valid character
- openclaw#20: --token format validation rejects malformed input without colon separator
- openclaw#21: resolveDefaultQQBotAccountId checks QQBOT_APP_ID environment variable

* test(qqbot): add focused tests for slash command authorization path

- Unauthorized sender rejected for /bot-logs (requireAuth: true)
- Authorized sender allowed for /bot-logs
- Non-requireAuth commands (/bot-ping, /bot-help, /bot-version) work for all senders
- Unknown slash commands return null (passthrough)
- Non-slash messages return null
- Usage query (/bot-logs ?) also gated by auth check

* fix(qqbot): align global TTS fallback with framework config resolution

- Extract isGlobalTTSAvailable to utils/audio-convert.ts, mirroring core
  resolveTtsConfig logic: check auto !== 'off', fall back to legacy
  enabled boolean, default to off when neither is set.
- Add pre-check in reply-dispatcher before calling globalTextToSpeech to
  avoid unnecessary TTS calls and noisy error logs when TTS is not
  configured.
- Remove inline as any casts; use OpenClawConfig type throughout.
- Refactor handleAudioPayload into flat early-return structure with
  unified send path (plugin TTS → global fallback → send).

* fix(qqbot): break ESM circular dependency causing multi-account startup crash

The bundled gateway chunk had a circular static import on the channel
chunk (gateway -> outbound-deliver -> channel, while channel dynamically
imports gateway). When two accounts start concurrently via Promise.all,
the first dynamic import triggers module graph evaluation; the circular
reference causes api exports (including runDiagnostics) to resolve as
undefined before the module finishes evaluating.

Fix: extract chunkText and TEXT_CHUNK_LIMIT from channel.ts into a new
text-utils.ts leaf module. outbound-deliver.ts now imports from
text-utils.ts, breaking the cycle. channel.ts re-exports for backward
compatibility.

* fix(qqbot): serialize gateway module import to prevent multi-account startup race

When multiple accounts start concurrently via Promise.all, each calls
await import('./gateway.js') independently. Due to ESM circular
dependencies in the bundled output, the first import can resolve
transitive exports as undefined before module evaluation completes.

Fix: cache the dynamic import promise in a module-level variable so all
concurrent startAccount calls share the same import, ensuring the
gateway module is fully evaluated before any account uses it.

* refactor(qqbot): remove startup greeting logic

Remove getStartupGreetingPlan and related startup greeting delivery:
- Delete startup-greeting.ts (greeting plan, marker persistence)
- Delete admin-resolver.ts (admin resolution, greeting dispatch)
- Remove startup greeting calls from gateway READY/RESUMED handlers
- Remove isFirstReadyGlobal flag and adminCtx

* fix(qqbot): skip octal escape decoding for Windows local paths

Windows paths like C:\Users\1\file.txt contain backslash-digit sequences
that were incorrectly matched as octal escape sequences and decoded,
corrupting the file path. Detect Windows local paths (drive letter or UNC
prefix) and skip the octal decoding step for them.

* fix bot issue

* feat: 支持 TTS 自动开关并清理配置中的 clientSecretFile

* docs: 添加 QQBot 配置和消息处理的设计说明

* rebase

* fix(qqbot): align slash-command auth with shared command-auth model

Route requireAuth:true slash commands (e.g. /bot-logs) through the
framework's api.registerCommand() so resolveCommandAuthorization()
applies commands.allowFrom.qqbot precedence and qqbot: prefix
normalization before any handler runs.

- slash-commands.ts: registerCommand() now auto-routes by requireAuth
  into two maps (commands / frameworkCommands); getFrameworkCommands()
  exports the auth-required set for framework registration; bot-help
  lists both maps
- index.ts: registerFull() iterates getFrameworkCommands() and calls
  api.registerCommand() for each; handler derives msgType from ctx.from,
  sends file attachments via sendDocument, supports multi-account via
  ctx.accountId
- gateway.ts (inbound): replace raw allowFrom string comparison with
  qqbotPlugin.config.formatAllowFrom() to strip qqbot: prefix and
  uppercase before matching event.senderId
- gateway.ts (pre-dispatch): remove stale auth computation; commandAuthorized
  is true (requireAuth:true commands never reach matchSlashCommand)
- command-auth.test.ts: add regression tests for qqbot: prefix
  normalization in the inbound commandAuthorized computation
- slash-commands.test.ts: update /bot-logs tests to expect null
  (command routed to framework, not in local registry)

* rebase and solve conflict

* fix(qqbot): preserve mixed env setup credentials

---------

Co-authored-by: yuehuali <[email protected]>
Co-authored-by: walli <[email protected]>
Co-authored-by: WideLee <[email protected]>
Co-authored-by: Frank Yang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant