Compare commits

..
1 Commits
Author SHA1 Message Date
Tunglies d7ac6b5bca chore(docs): centralize issue guidance and trim PR descriptions 2026-11-16 23:43:58 +08:00
26 changed files with 238 additions and 256 deletions
+31
View File
@@ -0,0 +1,31 @@
# Issue and PR Guidelines
These rules apply to Issue and PR work, including operations through `gh` or an
API. The root [AGENTS.md](../AGENTS.md) defines the repository-wide contract.
## Issues
When creating, drafting, triaging, splitting, or implementing from a community
issue, follow [ISSUE_GUIDELINES.md](ISSUE_GUIDELINES.md). Do not create or modify
GitHub issues without explicit authorization.
## PR Descriptions
When creating or updating a PR body, follow the
[PR template](PULL_REQUEST_TEMPLATE.md). Describe the final change; replace stale
text instead of appending work history. Omit routine check-pass declarations,
including Clippy, lint, and local tests. Keep only evidence and limitations that
help reviewers assess the change; the template defines what belongs in the body
and when Scope is needed.
Before publishing or updating a PR body, remove repetition, self-evaluation, and
details already clear from the diff. Keep only sentences that help review the
change.
## AI Disclosure
When an agent creates or co-creates a PR or Issue, append a final body line with
the model and effort used (e.g. `Assisted by: GPT-5.6 High`). Effort may be omitted
when the runtime does not report it. Human contributors are not asked to disclose
AI assistance. Disclosure is transparency only and carries no positive or
negative weight.
+29 -1
View File
@@ -1,3 +1,29 @@
<!--
Describe the final problem, approach, and evidence needed to review this change.
When updating the body, replace stale text instead of appending implementation
history or review-round summaries.
State each fact once. Omit details already clear from the diff unless they
explain a non-obvious constraint or trade-off. Describe concrete behavior instead
of self-evaluation or unsupported assurances such as "more robust" or "seamless".
Mention unchanged behavior or excluded areas only when they matter to review.
Before publishing, remove any sentence whose deletion loses no information
needed to understand the problem, approach, evidence, or material limitations.
Omit file-by-file diff summaries, internal planning scores, agent handoffs, and
routine check results such as "Clippy passed", "lint passed", or "local tests
passed". Do not add a Validation/Testing section for a command checklist.
Include concrete before/after behavior or measurements when they support the
change, and retain limitations that affect review. Link reviewer-accessible
details when needed; do not paste full scripts, logs, or test matrices into the
body, including collapsed sections.
Keep Scope only when explaining necessary changes outside the core fix, PR
dependencies, or why added tests are needed. Do not repeat Approach there.
For small changes, Problem and Approach may be combined into one short paragraph;
remove unnecessary headings instead of adding text to fill them.
-->
## Problem
What breaks or what is missing. Product bug fixes and features require a
@@ -14,4 +40,6 @@ Why this change solves the problem — the reasoning behind the approach, not a
## Scope
What changed. If anything outside the core fix was touched, explain why it was necessary. New tests are not expected by default — if any were added, justify why each is needed.
Optional: explain necessary changes outside the core fix, PR dependencies, or
why added tests are needed. Otherwise remove this section. New tests are not
expected by default.
+5 -2
View File
@@ -12,6 +12,7 @@ on:
- REVIEW.md
- src/AGENTS.md
- src-tauri/AGENTS.md
- .github/AGENTS.md
- .github/ISSUE_GUIDELINES.md
- .github/agents/agentic-workflows.md
- .github/skills/agentic-workflows/SKILL.md
@@ -30,6 +31,7 @@ on:
- REVIEW.md
- src/AGENTS.md
- src-tauri/AGENTS.md
- .github/AGENTS.md
- .github/ISSUE_GUIDELINES.md
- .github/agents/agentic-workflows.md
- .github/skills/agentic-workflows/SKILL.md
@@ -57,7 +59,8 @@ jobs:
check AGENTS.md 'Issue first'
check AGENTS.md 'Author accountability'
check AGENTS.md 'pr-ai-slop-review'
check AGENTS.md 'Disclose AI automation'
check AGENTS.md '(.github/AGENTS.md)'
check .github/AGENTS.md '## AI Disclosure'
check CONTRIBUTING.md 'Assisted by:'
check .github/workflows/pr-ai-slop-review.md '(../../CONTRIBUTING.md)'
check .github/workflows/pr-ai-slop-review.md '(../../AGENTS.md)'
@@ -84,7 +87,7 @@ jobs:
sources = [
"AGENTS.md", "CONTRIBUTING.md", "REVIEW.md", "CLAUDE.md", "GEMINI.md",
"src/AGENTS.md", "src-tauri/AGENTS.md", ".github/ISSUE_GUIDELINES.md",
"src/AGENTS.md", "src-tauri/AGENTS.md", ".github/AGENTS.md", ".github/ISSUE_GUIDELINES.md",
".github/PULL_REQUEST_TEMPLATE.md", ".github/workflows/pr-ai-slop-review.md",
".github/workflows/pr-verify-fix.md",
".github/agents/agentic-workflows.md", ".github/skills/agentic-workflows/SKILL.md",
+4 -12
View File
@@ -48,16 +48,11 @@ the ownership evidence the AI-slop review evaluates (see
8. **Minimal diffs.** Match the surrounding code's style, naming, and comment
density. Do not introduce new dependencies or restructure working code unless
the linked issue or stated task demands it.
9. **Disclose AI automation.** When an agent creates or co-creates a PR or Issue,
append a final body line with the model and effort used (e.g.
`Assisted by: GPT-5.6 High`). Effort may be omitted when the runtime does not
report it. Human contributors are not asked to disclose AI assistance.
Disclosure is transparency only and carries no positive or negative weight.
10. **Compiled workflows.** Agentic workflow Markdown, including the
9. **Compiled workflows.** Agentic workflow Markdown, including the
[AI-slop policy](.github/workflows/pr-ai-slop-review.md) and shared imports,
is compiled: after editing it, run `gh aw compile` and commit the affected
`.lock.yml` files. Never edit lock files directly.
11. **Changelog.** Entries follow the rules in
10. **Changelog.** Entries follow the rules in
[`template/Changelog.md`](template/Changelog.md): one line per
user-visible change, no internals.
@@ -78,8 +73,5 @@ the ownership evidence the AI-slop review evaluates (see
## Issue and PR Workflows
When drafting, triaging, splitting, or implementing from a community issue, use
the conditional checklist in [`.github/ISSUE_GUIDELINES.md`](.github/ISSUE_GUIDELINES.md).
Do not make GitHub issue changes without explicit authorization. For PRs, follow
the directly loaded [PR template](.github/PULL_REQUEST_TEMPLATE.md); do not
duplicate its prompts here.
For Issue and PR work, read [`.github/AGENTS.md`](.github/AGENTS.md), including
when using `gh` or an API without editing files under `.github/`.
+4 -3
View File
@@ -168,9 +168,10 @@ to run every command for every change. Run commands from the repository root.
Tie results to the code reviewed: identify the base/head commits for branch
comparisons and include task-relevant staged, unstaged, and untracked files in a
local review. Report
the command or interaction, observed result, and material gaps in the existing
conversation or PR; no separate verification report is required. Static checks,
local review. Keep command-level results in the working conversation. For PR
descriptions, follow the [PR template](.github/PULL_REQUEST_TEMPLATE.md): include
behavioral evidence and material gaps relevant to review, omitting routine check
pass lists. No separate verification report is required. Static checks,
mocks, browser previews, native runs, and remote CI establish different things.
When code changes after verification, repeat affected checks. Attribute a failure
to the baseline only after comparing the same check on the base revision.
+2 -2
View File
@@ -210,10 +210,10 @@ pub async fn delete_profile(index: std::string::String) -> CmdResult {
Ok(())
}
async fn restore_previous_profile(prev_profile: &str) -> CmdResult<()> {
async fn restore_previous_profile(prev_profile: &String) -> CmdResult<()> {
logging!(info, Type::Cmd, "尝试恢复到之前的配置: {}", prev_profile);
let restore_profiles = IProfiles {
current: Some(prev_profile.into()),
current: Some(prev_profile.to_owned()),
items: None,
};
Config::profiles()
+2 -2
View File
@@ -216,7 +216,7 @@ impl Config {
.or_else(|| runtime_data.config.as_ref())
.ok_or_else(|| anyhow!("failed to generate runtime config, might need to restart application"))?;
let yaml_str = serde_yaml_ng::to_string(config)?;
Ok(yaml_str)
Ok(format!("# Generated by Clash Verge\n\n{}", yaml_str))
})
.await
.map_err(|join| anyhow!("runtime serialization task failed: {join}"))?
@@ -224,7 +224,7 @@ impl Config {
pub(crate) async fn write_runtime_file(yaml: &str) -> Result<PathBuf> {
let path = dirs::app_home_dir()?.join(files::RUNTIME_CONFIG);
help::save_yaml_str(&path, yaml, Some("# Generated by Clash Verge")).await?;
help::save_yaml_str(&path, yaml).await?;
Ok(path)
}
+3 -2
View File
@@ -1,5 +1,4 @@
use crate::core::notify::NoticeStatus;
use crate::utils::help;
use anyhow::Result;
use clash_verge_draft::DraftTransaction;
use serde::{Deserialize, Serialize};
@@ -50,7 +49,9 @@ pub(crate) fn dns_override_source(profile_uid: &str, config: &Mapping) -> Result
digest.update(profile_uid.as_bytes());
digest.update([0]);
digest.update(serde_json::to_vec(&canonical)?);
Ok(Some(help::hex_encode(&digest.finalize()).into()))
Ok(Some(
digest.finalize().iter().map(|byte| format!("{byte:02x}")).collect(),
))
}
#[derive(Debug, Clone)]
+1 -1
View File
@@ -26,7 +26,7 @@ pub(super) fn normalize_profile_home_url(raw: &str) -> Option<String> {
}
url.host_str()?;
Some(url.as_str().into())
Some(url.to_string().into())
}
#[derive(Debug, Clone, Deserialize, Serialize, Default, specta::Type)]
+8 -12
View File
@@ -605,7 +605,7 @@ async fn fetch_proxies_with_timeout() -> Result<Proxies> {
.map_err(Into::into)
}
async fn select_node_with_timeout(group_name: &str, node: &str) -> Result<()> {
async fn select_node_with_timeout(group_name: &String, node: &String) -> Result<()> {
tokio::time::timeout(MIHOMO_OPERATION_TIMEOUT, async {
handle::Handle::mihomo().select_node_for_group(group_name, node).await
})
@@ -761,7 +761,7 @@ pub(crate) async fn record_selected_node(group_name: &str, node: &str) -> Result
return Ok((profiles, false));
};
let selected = item.selected.get_or_insert_with(Vec::new);
let mut selected = item.selected.clone().unwrap_or_default();
match selected
.iter_mut()
.find(|entry| entry.name.as_ref() == Some(&group_name))
@@ -770,13 +770,14 @@ pub(crate) async fn record_selected_node(group_name: &str, node: &str) -> Result
if entry.now.as_ref() == Some(&node) {
return Ok((profiles, false));
}
entry.now = Some(node.clone());
entry.now = Some(node);
}
None => selected.push(PrfSelected {
name: Some(group_name),
now: Some(node),
}),
}
item.selected = Some(selected);
profiles.save_file().await?;
Ok((profiles, true))
})
@@ -795,17 +796,12 @@ pub(crate) async fn forget_selected_node(group_name: &str) -> Result<()> {
return Ok((profiles, false));
};
let Some(mut selected) = item.selected.take() else {
return Ok((profiles, false));
};
let mut selected = item.selected.clone().unwrap_or_default();
if !remove_selected_node(&mut selected, group_name) {
item.selected = Some(selected);
return Ok((profiles, false));
}
if !selected.is_empty() {
item.selected = Some(selected);
}
item.selected = (!selected.is_empty()).then_some(selected);
profiles.save_file().await?;
Ok((profiles, true))
})
@@ -813,7 +809,7 @@ pub(crate) async fn forget_selected_node(group_name: &str) -> Result<()> {
}
async fn persist_reconciled_selected(
profile_uid: &str,
profile_uid: &String,
original_selected: &[PrfSelected],
selected: Vec<PrfSelected>,
generation: u64,
@@ -822,7 +818,7 @@ async fn persist_reconciled_selected(
return Ok(());
}
let profile_uid = String::from(profile_uid);
let profile_uid = profile_uid.clone();
let original_selected = original_selected.to_vec();
persist_selected_update(false, move |mut profiles| async move {
if !is_activation_current(generation) || profiles.current.as_ref() != Some(&profile_uid) {
+3 -6
View File
@@ -42,12 +42,9 @@ pub async fn notify_event<'a>(event: NotificationEvent<'a>) {
}
NotificationEvent::ClashModeChanged { mode } => {
let title = clash_verge_i18n::t!("notifications.clashModeChanged.title");
let body = clash_verge_i18n::t!("notifications.clashModeChanged.body");
let body = if body.contains("{mode}") {
body.replace("{mode}", mode).into()
} else {
body
};
let body = clash_verge_i18n::t!("notifications.clashModeChanged.body")
.replace("{mode}", mode)
.into();
notify(title, body);
}
NotificationEvent::SystemProxyToggled(enabled) => {
+4 -5
View File
@@ -1,6 +1,5 @@
use super::NoticeStatus;
use crate::{APP_HANDLE, singleton};
#[cfg(target_os = "macos")]
use smartstring::alias::String;
use std::sync::{
Arc,
@@ -56,21 +55,21 @@ impl Handle {
Self::send_event(FrontendEvent::RunStateChanged { state: state.clone() });
}
pub fn notify_profile_changed(profile_id: &str) {
pub fn notify_profile_changed(profile_id: &String) {
Self::send_event(FrontendEvent::ProfileChanged {
current_profile_id: profile_id,
});
}
pub fn notify_timer_updated(profile_index: &str) {
pub fn notify_timer_updated(profile_index: &String) {
Self::send_event(FrontendEvent::TimerUpdated { profile_index });
}
pub fn notify_profile_update_started(uid: &str) {
pub fn notify_profile_update_started(uid: &String) {
Self::send_event(FrontendEvent::ProfileUpdateStarted { uid });
}
pub fn notify_profile_update_completed(uid: &str) {
pub fn notify_profile_update_completed(uid: &String) {
Self::send_event(FrontendEvent::ProfileUpdateCompleted { uid });
}
+5 -5
View File
@@ -20,16 +20,16 @@ pub enum FrontendEvent<'a> {
message: Arc<str>,
},
ProfileChanged {
current_profile_id: &'a str,
current_profile_id: &'a String,
},
TimerUpdated {
profile_index: &'a str,
profile_index: &'a String,
},
ProfileUpdateStarted {
uid: &'a str,
uid: &'a String,
},
ProfileUpdateCompleted {
uid: &'a str,
uid: &'a String,
},
RunStateChanged {
state: crate::core::runstate::RunStateView,
@@ -369,7 +369,7 @@ mod wire_tests {
/// One sample per `FrontendEvent` variant, paired with its wire name and payload.
#[cfg(test)]
fn sample_frontend_events(uid: &str) -> Vec<(FrontendEvent<'_>, &'static str, serde_json::Value)> {
fn sample_frontend_events(uid: &String) -> Vec<(FrontendEvent<'_>, &'static str, serde_json::Value)> {
let state = crate::core::runstate::RunState {
health: Default::default(),
pending: None,
+1 -1
View File
@@ -122,7 +122,7 @@ fn allocate_provider_destination(destination: &str, url: &str, reserved: &mut Ha
digest.update(destination.as_bytes());
digest.update([0]);
digest.update(url.as_bytes());
let digest: String = crate::utils::help::hex_encode(&digest.finalize());
let digest: String = digest.finalize().iter().map(|byte| format!("{byte:02x}")).collect();
let path = Path::new(destination);
let extension = path
.extension()
+1 -1
View File
@@ -458,7 +458,7 @@ impl Timer {
}
}
fn emit_update_event(uid: &str, is_start: bool) {
fn emit_update_event(uid: &String, is_start: bool) {
if is_start {
super::handle::Handle::notify_profile_update_started(uid);
} else {
+3
View File
@@ -342,6 +342,9 @@ impl Tray {
let verge = Config::verge().await.data_arc();
let app_handle = handle::Handle::app_handle();
self.update_menu_internal(app_handle, false).await?;
AsyncHandler::spawn(|| async {
logging_error!(Type::Tray, Self::global().update_menu().await);
});
self.update_icon(&verge).await?;
#[cfg(target_os = "macos")]
self.update_speed_task(verge.enable_tray_speed.unwrap_or(false));
+1 -1
View File
@@ -435,7 +435,7 @@ impl CoreConfigValidator {
}
let check_path = dirs::app_home_dir()?.join(crate::constants::files::CHECK_CONFIG);
help::save_yaml_str(&check_path, yaml, None).await?;
help::save_yaml_str(&check_path, yaml).await?;
let outcome = Self::validate_config_internal_outcome(dirs::path_to_str(&check_path)?).await?;
if outcome.is_valid() {
*LAST_VALIDATED.lock() = Some(fingerprint);
+3 -3
View File
@@ -24,12 +24,12 @@ fn lowercase_key(key: &str) -> Value {
Value::from(key.as_str())
}
pub fn use_lowercase(config: Mapping) -> Mapping {
pub fn use_lowercase(config: &Mapping) -> Mapping {
let mut lowercased = Mapping::new();
for (key, value) in config {
for (key, value) in config.iter() {
if let Some(key_str) = key.as_str() {
lowercased.insert(lowercase_key(key_str), value);
lowercased.insert(lowercase_key(key_str), value.clone());
}
}
lowercased
+3 -3
View File
@@ -16,7 +16,7 @@ fn deep_merge(a: &mut Value, b: Value) {
}
}
pub fn use_merge(merge: Mapping, mut config: Mapping) -> Mapping {
pub fn use_merge(merge: &Mapping, mut config: Mapping) -> Mapping {
for (key, value) in use_lowercase(merge) {
match (config.get_mut(&key), value) {
(Some(Value::Mapping(existing)), Value::Mapping(overlay)) if key.as_str() == Some("dns") => {
@@ -79,7 +79,7 @@ fn test_merge() -> anyhow::Result<()> {
let merge = serde_yaml_ng::from_str::<Mapping>(merge)?;
let config = serde_yaml_ng::from_str::<Mapping>(config)?;
let result = use_merge(merge.clone(), config);
let result = use_merge(&merge, config);
assert_eq!(result["dns"]["nameserver-policy"], merge["dns"]["nameserver-policy"]);
assert_eq!(result["dns"]["fallback-filter"], merge["dns"]["fallback-filter"]);
assert_eq!(result["hosts"], merge["hosts"]);
@@ -91,7 +91,7 @@ fn test_merge() -> anyhow::Result<()> {
let cleared = serde_yaml_ng::from_str::<Mapping>(
"dns: {enable: false, nameserver-policy: {}, fallback-filter: {}, nameserver: []}\nhosts: {}",
)?;
let result = use_merge(cleared.clone(), result);
let result = use_merge(&cleared, result);
assert_eq!(result["dns"], cleared["dns"]);
assert_eq!(result["hosts"], cleared["hosts"]);
+45 -79
View File
@@ -28,7 +28,6 @@ use parking_lot::Mutex;
use serde_yaml_ng::{Mapping, Value};
use smartstring::alias::String;
use std::collections::{HashMap, HashSet};
use std::hash::{Hash as _, Hasher as _};
use tokio::fs;
type ResultLog = Vec<(String, String)>;
@@ -237,13 +236,13 @@ async fn process_override_items(
mut result_map: HashMap<String, ResultLog>,
merge_item: ChainItem,
script_item: ChainItem,
profile_name: &str,
profile_name: &String,
authoritative: &AuthoritativeFields,
) -> (Mapping, Vec<String>, HashMap<String, ResultLog>) {
if let ChainType::Merge(merge) = merge_item.data {
exists_keys.extend(use_keys(&merge));
let before = authoritative.current(&config);
config = use_merge(merge, config);
config = use_merge(&merge, config);
let notes: ResultLog = authoritative
.overridden(&before, &authoritative.current(&config))
.into_iter()
@@ -256,7 +255,7 @@ async fn process_override_items(
if let ChainType::Script(script) = script_item.data {
let before = authoritative.current(&config);
let (res_config, changed_keys, mut logs) = use_script(script, config, profile_name.into()).await;
let (res_config, changed_keys, mut logs) = use_script(script, config, profile_name.clone()).await;
exists_keys.extend(changed_keys);
config = res_config;
logs.extend(
@@ -321,45 +320,15 @@ struct AuthoritativeFields {
tun: Mapping,
dns: Mapping,
hosts: Option<Value>,
fingerprints: FieldFingerprints,
}
#[derive(Default)]
struct FieldFingerprints {
control_plane: Vec<Option<u64>>,
tun: Vec<Option<u64>>,
dns: Vec<Option<u64>>,
hosts: Option<u64>,
}
fn fingerprint(value: Option<&Value>) -> Option<u64> {
let value = value?;
let mut hasher = std::collections::hash_map::DefaultHasher::new();
value.hash(&mut hasher);
Some(hasher.finish())
}
impl AuthoritativeFields {
fn capture(config: &Mapping, gui_tun_keys: &[Value], mut dns_settings: Mapping) -> Self {
let control_plane = snapshot_control_plane(config);
let tun = snapshot_tun(config, gui_tun_keys);
let dns = take_mapping(&mut dns_settings, "dns");
let hosts = dns_settings.remove("hosts");
let fingerprints = FieldFingerprints {
control_plane: CONTROL_PLANE_KEYS
.iter()
.map(|&key| fingerprint(control_plane.get(Value::from(key))))
.collect(),
tun: tun.iter().map(|(_, value)| fingerprint(Some(value))).collect(),
dns: dns.iter().map(|(_, value)| fingerprint(Some(value))).collect(),
hosts: fingerprint(hosts.as_ref()),
};
Self {
control_plane,
tun,
dns,
hosts,
fingerprints,
control_plane: snapshot_control_plane(config),
tun: snapshot_tun(config, gui_tun_keys),
dns: take_mapping(&mut dns_settings, "dns"),
hosts: dns_settings.remove("hosts"),
}
}
@@ -377,50 +346,43 @@ impl AuthoritativeFields {
config
}
/// What `config` holds now, for diffing one override.
fn current(&self, config: &Mapping) -> FieldFingerprints {
let tun = config.get("tun").and_then(Value::as_mapping);
/// The owned values as `config` holds them now, for diffing one override.
fn current(&self, config: &Mapping) -> Self {
let tun_keys: Vec<Value> = self.tun.keys().cloned().collect();
let dns = config.get("dns").and_then(Value::as_mapping);
FieldFingerprints {
control_plane: CONTROL_PLANE_KEYS
.iter()
.map(|&key| fingerprint(config.get(key)))
.collect(),
tun: self
.tun
.keys()
.map(|key| fingerprint(tun.and_then(|map| map.get(key))))
.collect(),
Self {
control_plane: snapshot_control_plane(config),
tun: snapshot_tun(config, &tun_keys),
dns: self
.dns
.keys()
.map(|key| fingerprint(dns.and_then(|map| map.get(key))))
.filter_map(|key| Some((key.clone(), dns?.get(key)?.clone())))
.collect(),
hosts: self.hosts.as_ref().and_then(|_| fingerprint(config.get("hosts"))),
hosts: self.hosts.as_ref().and_then(|_| config.get("hosts")).cloned(),
}
}
/// Owned keys an override moved off the app value; `enforce` discards those writes.
fn overridden(&self, before: &FieldFingerprints, after: &FieldFingerprints) -> Vec<String> {
fn overridden(&self, before: &Self, after: &Self) -> Vec<String> {
let mut keys = Vec::new();
for (index, &key) in CONTROL_PLANE_KEYS.iter().enumerate() {
if before.control_plane[index] != after.control_plane[index]
&& after.control_plane[index] != self.fingerprints.control_plane[index]
for &key in CONTROL_PLANE_KEYS {
if before.control_plane.get(key) != after.control_plane.get(key)
&& after.control_plane.get(key) != self.control_plane.get(key)
{
keys.push(key.into());
}
}
for (index, key) in self.tun.keys().enumerate() {
if before.tun[index] != after.tun[index] && after.tun[index] != self.fingerprints.tun[index] {
for key in self.tun.keys() {
if before.tun.get(key) != after.tun.get(key) && after.tun.get(key) != self.tun.get(key) {
keys.push(format!("tun.{}", key.as_str().unwrap_or_default()).into());
}
}
for (index, key) in self.dns.keys().enumerate() {
if before.dns[index] != after.dns[index] && after.dns[index] != self.fingerprints.dns[index] {
for key in self.dns.keys() {
if before.dns.get(key) != after.dns.get(key) && after.dns.get(key) != self.dns.get(key) {
keys.push(format!("dns.{}", key.as_str().unwrap_or_default()).into());
}
}
if self.hosts.is_some() && before.hosts != after.hosts && after.hosts != self.fingerprints.hosts {
if self.hosts.is_some() && before.hosts != after.hosts && after.hosts != self.hosts {
keys.push("hosts".into());
}
keys
@@ -591,15 +553,16 @@ fn merge_default_config(
) -> Mapping {
for (key, value) in clash_config.into_iter() {
if key.as_str() == Some("tun") {
if let Value::Mapping(patch_tun) = value {
let mut tun = take_mapping(&mut config, "tun");
for (key, value) in patch_tun {
let mut tun = config.get_mut("tun").map_or_else(Mapping::new, |val| {
val.as_mapping().cloned().unwrap_or_else(Mapping::new)
});
let patch_tun = value.as_mapping().cloned().unwrap_or_else(Mapping::new);
for (key, value) in patch_tun.into_iter() {
if !value.is_null() {
tun.insert(key, value);
}
}
config.insert(Value::from("tun"), Value::Mapping(tun));
}
config.insert("tun".into(), tun.into());
} else {
if key.as_str() == Some("socks-port") && !socks_enabled {
config.remove("socks-port");
@@ -654,7 +617,7 @@ fn merge_default_config(
fn apply_builtin_scripts(mut config: Mapping, enable_builtin: bool) -> Mapping {
if enable_builtin {
// The JS path saw a lowercased view; lowercase once, only when the builtin runs.
config = use_lowercase(config);
config = use_lowercase(&config);
logging!(debug, Type::Core, "run builtin script verge_hy_alpn");
config = builtin_hy_alpn(config);
}
@@ -686,8 +649,11 @@ fn cleanup_proxy_groups(mut config: Mapping) -> Mapping {
.map_or_default(|seq| {
seq.iter()
.filter_map(|item| match item {
Value::Mapping(map) => map.get("name").and_then(Value::as_str).map(Into::into),
Value::String(name) => Some(name.as_str().into()),
Value::Mapping(map) => map
.get("name")
.and_then(Value::as_str)
.map(|name| name.to_owned().into()),
Value::String(name) => Some(name.to_owned().into()),
_ => None,
})
.collect::<HashSet<String>>()
@@ -906,7 +872,7 @@ pub async fn enhance(
result_map,
global_merge,
global_script,
profile_name.as_str(),
&profile_name,
&authoritative,
)
.await;
@@ -917,12 +883,12 @@ pub async fn enhance(
result_map,
merge_item,
script_item,
profile_name.as_str(),
&profile_name,
&authoritative,
)
.await;
notify_discarded_keys(authoritative.overridden(&authoritative.fingerprints, &authoritative.current(&config)));
notify_discarded_keys(authoritative.overridden(&authoritative, &authoritative.current(&config)));
let config = authoritative.enforce(config);
let config = ensure_tun_default_mtu(config);
let config = ensure_lan_bind_address(config);
@@ -1441,7 +1407,7 @@ mod tests {
uid: uid.into(),
data: ChainType::Merge(merge.clone()),
};
let profile_name = "test-profile";
let profile_name = "test-profile".into();
let (config, keys, logs) = process_override_items(
config,
vec![],
@@ -1451,7 +1417,7 @@ mod tests {
uid: "global-script".into(),
data: ChainType::Script(script.into()),
},
profile_name,
&profile_name,
&authoritative,
)
.await;
@@ -1464,7 +1430,7 @@ mod tests {
uid: "profile-script".into(),
data: ChainType::Script(script.into()),
},
profile_name,
&profile_name,
&authoritative,
)
.await;
@@ -1540,7 +1506,7 @@ mod tests {
),
};
let profile_name = "test-profile";
let profile_name = "test-profile".into();
let authoritative = AuthoritativeFields::capture(&config, &[], Mapping::new());
let (config, exists_keys, result_map) = process_override_items(
config,
@@ -1548,7 +1514,7 @@ mod tests {
HashMap::new(),
global_merge,
global_script,
profile_name,
&profile_name,
&authoritative,
)
.await;
@@ -1558,7 +1524,7 @@ mod tests {
result_map,
profile_merge,
profile_script,
profile_name,
&profile_name,
&authoritative,
)
.await;
+46 -77
View File
@@ -1,7 +1,7 @@
use crate::{process::AsyncHandler, utils::tmpl};
use super::field::use_lowercase;
use anyhow::Result;
use anyhow::{Error, Result};
use boa_engine::{Context, JsString, JsValue, Source, js_string, native_function::NativeFunction, property::Attribute};
use clash_verge_logging::{Type, logging};
use parking_lot::Mutex;
@@ -22,27 +22,15 @@ type EvalOutcome = (Result<Mapping, std::string::String>, Vec<(String, String)>)
pub(super) async fn use_script(script: String, config: Mapping, name: String) -> ScriptResult {
// The template is identity-plus-lowercasing; skip the Boa round-trip.
if script == tmpl::ITEM_SCRIPT {
return (use_lowercase(config), vec![], vec![]);
return (use_lowercase(&config), vec![], vec![]);
}
let json = match serde_json::to_value(&config) {
Ok(mut json) => {
if let Some(map) = json.as_object_mut() {
let mut lowered = serde_json::Map::with_capacity(map.len());
for (key, value) in std::mem::take(map) {
let mut key = key;
key.make_ascii_lowercase();
lowered.insert(key, value);
}
*map = lowered;
}
if json_approx_size(&json) <= MAX_JSON_SIZE {
json
} else {
let json = match serde_json::to_string(&use_lowercase(&config)) {
Ok(json) if json.len() <= MAX_JSON_SIZE => json,
Ok(_) => {
let message = "Configuration size exceeds maximum allowed size";
return (config, vec![], vec![("exception".into(), message.into())]);
}
}
Err(err) => return (config, vec![], vec![("exception".into(), err.to_string().into())]),
};
@@ -78,7 +66,7 @@ pub(super) async fn use_script(script: String, config: Mapping, name: String) ->
}
/// Console logs survive every failure path.
fn eval_script(script: &str, config_json: &serde_json::Value, name: &String) -> EvalOutcome {
fn eval_script(script: &str, config_json: &str, name: &String) -> EvalOutcome {
let mut context = Context::default();
context
@@ -143,11 +131,12 @@ fn eval_script(script: &str, config_json: &serde_json::Value, name: &String) ->
});"#,
));
let config_value = match JsValue::from_json(config_json, &mut context) {
Ok(value) => value,
Err(err) => return bail(format!("failed to bind config for script: {err}")),
};
if let Err(err) = context.register_global_property(js_string!("__verge_config__"), config_value, Attribute::all()) {
// Bind the JSON instead of embedding it in program source; Boa's parser never chews it.
if let Err(err) = context.register_global_property(
js_string!("__verge_config__"),
JsValue::from(JsString::from(config_json)),
Attribute::all(),
) {
return bail(format!("failed to bind config for script: {err}"));
}
@@ -160,61 +149,31 @@ fn eval_script(script: &str, config_json: &serde_json::Value, name: &String) ->
let code = format!(
r"try{{
{script};
main(globalThis.__verge_config__,'{safe_name}')
JSON.stringify(main(JSON.parse(globalThis.__verge_config__),'{safe_name}')||'')
}} catch(err) {{
`__error_flag__ ${{err.toString()}}`
}}"
);
let result = match context.eval(Source::from_bytes(code.as_str())) {
Ok(result) if result.is_string() => result,
_ => return bail("main function should return object".to_owned()),
};
let result = match result.to_string(&mut context) {
Ok(result) => result,
Err(err) => {
logging!(
error,
Type::Config,
"Script execution error: {err}. Script name: {name}"
);
return bail("Script execution failed".to_owned());
}
Err(e) => return bail(format!("Failed to convert JS result to string: {e}")),
};
// The JS wrapper funnels exceptions into a marker string; surface its text.
if result.is_string() {
let text = result
.to_string(&mut context)
.ok()
.and_then(|text| text.to_std_string().ok())
.unwrap_or_default();
if text.trim_start().starts_with("__error_flag__") {
logging!(
error,
Type::Config,
"Script execution error: {}. Script name: {name}",
text.trim_start()["__error_flag__".len()..].trim()
);
return bail("Script execution failed".to_owned());
}
}
if !result.is_object() {
return bail("main function should return object".to_owned());
}
let result = match result.to_json(&mut context) {
Ok(Some(result)) => result,
Ok(None) => return bail("main function should return object".to_owned()),
Err(err) => {
logging!(
error,
Type::Config,
"Script execution error: {err}. Script name: {name}"
);
return bail("Script execution failed".to_owned());
}
let result = match result.to_std_string() {
Ok(result) => result,
Err(_) => return bail("Failed to convert JS string to std string".to_owned()),
};
if json_approx_size(&result) > MAX_JSON_SIZE {
if result.len() > MAX_JSON_SIZE {
return bail("Script result exceeds maximum allowed size".to_owned());
}
match serde_json::from_value::<Mapping>(result) {
Ok(config) => (Ok(use_lowercase(config)), outputs.lock().to_vec()),
match parse_json_safely(&result) {
Ok(config) => (Ok(use_lowercase(&config)), outputs.lock().to_vec()),
Err(err) => {
logging!(
error,
@@ -226,17 +185,27 @@ fn eval_script(script: &str, config_json: &serde_json::Value, name: &String) ->
}
}
/// Serialized-size estimate without building the serialized string; a DoS guard, not an exact byte count.
fn json_approx_size(value: &serde_json::Value) -> usize {
match value {
serde_json::Value::String(s) => s.len() + 2,
serde_json::Value::Object(map) => map
.iter()
.map(|(key, value)| key.len() + 4 + json_approx_size(value))
.sum(),
serde_json::Value::Array(items) => items.iter().map(json_approx_size).sum(),
serde_json::Value::Number(n) => n.to_string().len(),
serde_json::Value::Bool(_) | serde_json::Value::Null => 4,
fn parse_json_safely(json_str: &str) -> Result<Mapping, Error> {
if json_str.len() > MAX_JSON_SIZE {
anyhow::bail!("JSON string too large");
}
let json_str = strip_outer_quotes(json_str);
Ok(serde_json::from_str::<Mapping>(json_str)?)
}
// 安全地移除外层引号
fn strip_outer_quotes(s: &str) -> &str {
let s = s.trim();
if s.len() < 2 {
return s;
}
if (s.starts_with('"') && s.ends_with('"')) || (s.starts_with('\'') && s.ends_with('\'')) {
&s[1..s.len() - 1]
} else {
s
}
}
+10 -2
View File
@@ -8,10 +8,18 @@ macro_rules! revise {
}
pub fn use_tun(mut config: Mapping, enable: bool) -> Mapping {
let mut tun_val = super::take_mapping(&mut config, "tun");
let tun_key = Value::from("tun");
let tun_val = config.get(&tun_key);
let mut tun_val = tun_val.map_or_else(Mapping::new, |val| {
val.as_mapping().cloned().unwrap_or_else(Mapping::new)
});
if enable {
let mut dns_val = super::take_mapping(&mut config, "dns");
let dns_key = Value::from("dns");
let dns_val = config.get(&dns_key);
let mut dns_val = dns_val.map_or_else(Mapping::new, |val| {
val.as_mapping().cloned().unwrap_or_else(Mapping::new)
});
let ipv6_key = Value::from("ipv6");
let ipv6_val = config.get(&ipv6_key).and_then(|v| v.as_bool()).unwrap_or(false);
+2 -2
View File
@@ -123,7 +123,7 @@ pub async fn list_wevdav_backup() -> Result<Vec<ListFile>> {
}
pub async fn delete_webdav_backup(filename: String) -> Result<()> {
let name = filename.clone();
let name = filename.to_string();
backup::WebDavClient::global().delete(filename).await.map_err(|err| {
logging!(
error,
@@ -165,7 +165,7 @@ pub async fn restore_webdav_backup(filename: String) -> Result<()> {
let backup_storage_path = app_home_dir()
.map_err(|e| anyhow::anyhow!("Failed to get app home dir: {e}"))?
.join(filename.as_str());
let name = filename.clone();
let name = filename.to_string();
backup::WebDavClient::global()
.download(filename, backup_storage_path.clone())
.await
+5 -5
View File
@@ -103,7 +103,7 @@ pub async fn switch_proxy_node(group_name: &str, proxy_name: &str, unfix: bool)
Ok(())
}
async fn should_update_profile(uid: &str, ignore_auto_update: bool) -> Result<Option<(String, Option<PrfOption>)>> {
async fn should_update_profile(uid: &String, ignore_auto_update: bool) -> Result<Option<(String, Option<PrfOption>)>> {
let profiles = Config::profiles().await;
let profiles = profiles.latest_arc();
let item = profiles.get_item(uid)?;
@@ -138,8 +138,8 @@ async fn should_update_profile(uid: &str, ignore_auto_update: bool) -> Result<Op
#[tracing::instrument(skip_all, level = "info", fields(uid = %uid, strategy = tracing::field::Empty, configured_elapsed = tracing::field::Empty, clash_elapsed = tracing::field::Empty, system_elapsed = tracing::field::Empty))]
async fn perform_profile_update(
uid: &str,
url: &str,
uid: &String,
url: &String,
opt: Option<&PrfOption>,
option: Option<&PrfOption>,
is_mannual_trigger: bool,
@@ -234,7 +234,7 @@ async fn perform_profile_update(
}
#[tracing::instrument(skip_all, level = "info", fields(uid = %uid, manual = is_mannual_trigger))]
pub async fn update_profile(uid: &str, option: Option<&PrfOption>, is_mannual_trigger: bool) -> Result<()> {
pub async fn update_profile(uid: &String, option: Option<&PrfOption>, is_mannual_trigger: bool) -> Result<()> {
let url_opt = should_update_profile(uid, is_mannual_trigger).await?;
let profile_persisted = match url_opt {
@@ -245,7 +245,7 @@ pub async fn update_profile(uid: &str, option: Option<&PrfOption>, is_mannual_tr
None => false,
};
let profiles = Config::profiles().await;
let is_current = profiles.latest_arc().current.as_deref() == Some(uid);
let is_current = profiles.latest_arc().current.as_ref() == Some(uid);
let should_refresh = is_current || (!profile_persisted && is_mannual_trigger);
if should_refresh {
+9 -21
View File
@@ -137,11 +137,16 @@ fn is_short_id(key: &Value) -> bool {
pub async fn save_yaml<T: Serialize + Sync>(path: &Path, data: &T, prefix: Option<&str>) -> Result<()> {
let data_str = with_encryption(|| async { serde_yaml_ng::to_string(data) }).await?;
save_yaml_str(path, &data_str, prefix).await
let yaml_str = match prefix {
Some(prefix) => format!("{prefix}\n\n{data_str}"),
None => data_str,
};
save_yaml_str(path, &yaml_str).await
}
/// Atomic replace with pre-serialized content; the payload must not need the encryption scope.
pub async fn save_yaml_str(path: &Path, yaml_str: &str, prefix: Option<&str>) -> Result<()> {
pub async fn save_yaml_str(path: &Path, yaml_str: &str) -> Result<()> {
let (temporary, file) = loop {
let temporary = path.with_extension(format!("tmp-{}-{}", std::process::id(), nanoid!()));
match std::fs::OpenOptions::new()
@@ -167,16 +172,9 @@ pub async fn save_yaml_str(path: &Path, yaml_str: &str, prefix: Option<&str>) ->
let _ = std::fs::remove_file(path);
});
let mut file = tokio::fs::File::from_std(file);
async fn write_chunk(file: &mut tokio::fs::File, bytes: &[u8], path: &Path) -> Result<()> {
file.write_all(bytes)
file.write_all(yaml_str.as_bytes())
.await
.with_context(|| format!("failed to write temporary file for \"{}\"", path.display()))
}
if let Some(prefix) = prefix {
write_chunk(&mut file, prefix.as_bytes(), path).await?;
write_chunk(&mut file, b"\n\n", path).await?;
}
write_chunk(&mut file, yaml_str.as_bytes(), path).await?;
.with_context(|| format!("failed to write temporary file for \"{}\"", path.display()))?;
file.flush()
.await
.with_context(|| format!("failed to flush temporary file for \"{}\"", path.display()))?;
@@ -222,16 +220,6 @@ pub fn parse_str<T: FromStr>(target: &str, key: &str) -> Option<T> {
})
}
pub fn hex_encode(bytes: &[u8]) -> String {
const HEX: &[u8; 16] = b"0123456789abcdef";
let mut out = String::with_capacity(bytes.len() * 2);
for &byte in bytes {
out.push(HEX[usize::from(byte >> 4)] as char);
out.push(HEX[usize::from(byte & 0x0f)] as char);
}
out
}
/// Masks query values and token-like path segments for logging.
pub fn mask_url(url: &str) -> String {
let (path_part, query_part) = match url.find('?') {
+3 -3
View File
@@ -47,7 +47,7 @@ fn extract_subscription_info(link_parsed: &Url) -> Option<(std::string::String,
let name = link_parsed
.query_pairs()
.find(|(key, _)| key == "name")
.map(|(_, value)| value.into());
.map(|(_, value)| value.into_owned().into());
let url = extract_subscription_url(link_parsed)?;
Some((url, name))
}
@@ -123,7 +123,7 @@ async fn fetch_profile_item(url: &str, name: Option<&String>) -> Option<PrfItem>
}
}
async fn post_import_updates(uid: &str, had_current_profile: bool) {
async fn post_import_updates(uid: &String, had_current_profile: bool) {
handle::Handle::refresh_verge();
handle::Handle::notify_profile_changed(uid);
@@ -131,7 +131,7 @@ async fn post_import_updates(uid: &str, had_current_profile: bool) {
false
} else {
let profiles = Config::profiles().await;
profiles.latest_arc().current.as_deref() == Some(uid)
profiles.latest_arc().current.as_ref() == Some(uid)
};
if should_update_core {