Return file sizes from fs/getMetadata (#62653)

## What changed

Add `sizeBytes` to the app server's metadata response so clients can
read a file's size in bytes from its metadata. The field reports the
target file's size for symlinks to regular files and is `null` for
paths that resolve to directories or other non-regular files. The
protocol schemas and generated Python SDK model accept responses from
older servers that omit the field.

## Testing

Cover byte counts for regular files and symlinks to files, explicit
`null` for directories, and decoding responses that omit `sizeBytes`.

GitOrigin-RevId: fcc7bda9e55bd0584c1eff4af059422af282da9f
This commit is contained in:
Felipe Coury
2026-11-20 02:42:43 +00:00
committed by copyberry
parent 2c1b4c7c35
commit e787cf7024
12 changed files with 90 additions and 25 deletions
@@ -13093,6 +13093,15 @@
"description": "File modification time in Unix milliseconds when available, otherwise `0`.",
"format": "int64",
"type": "integer"
},
"sizeBytes": {
"description": "Size in bytes if the path resolves to a regular file, otherwise null. Older servers omit this field.",
"format": "uint64",
"minimum": 0.0,
"type": [
"integer",
"null"
]
}
},
"required": [
@@ -8847,6 +8847,15 @@
"description": "File modification time in Unix milliseconds when available, otherwise `0`.",
"format": "int64",
"type": "integer"
},
"sizeBytes": {
"description": "Size in bytes if the path resolves to a regular file, otherwise null. Older servers omit this field.",
"format": "uint64",
"minimum": 0.0,
"type": [
"integer",
"null"
]
}
},
"required": [
@@ -23,6 +23,15 @@
"description": "File modification time in Unix milliseconds when available, otherwise `0`.",
"format": "int64",
"type": "integer"
},
"sizeBytes": {
"description": "Size in bytes if the path resolves to a regular file, otherwise null. Older servers omit this field.",
"format": "uint64",
"minimum": 0.0,
"type": [
"integer",
"null"
]
}
},
"required": [
@@ -25,4 +25,8 @@ createdAtMs: number,
/**
* File modification time in Unix milliseconds when available, otherwise `0`.
*/
modifiedAtMs: number, };
modifiedAtMs: number,
/**
* Size in bytes if the path resolves to a regular file, otherwise null. Older servers omit this field.
*/
sizeBytes?: number | null, };
+4 -2
View File
@@ -2414,8 +2414,10 @@ mod tests {
// These are only allowed in *Params types, except additive stable fields
// that older servers omit and newer servers may return as null.
let legacy_optional_nullable_field = (path
== Path::new("v2/GetAccountTokenUsageResponse.ts")
&& field_prefix.trim() == "threadUsage?")
== Path::new("v2/FsGetMetadataResponse.ts")
&& field_prefix.trim() == "sizeBytes?")
|| (path == Path::new("v2/GetAccountTokenUsageResponse.ts")
&& field_prefix.trim() == "threadUsage?")
|| (path == Path::new("v2/ThreadUsage.ts")
&& field_prefix.trim() == "nativeUsageUsdMicros?")
|| (path == Path::new("v2/ThreadItem.ts")
@@ -107,6 +107,9 @@ pub struct FsGetMetadataResponse {
/// File modification time in Unix milliseconds when available, otherwise `0`.
#[ts(type = "number")]
pub modified_at_ms: i64,
/// Size in bytes if the path resolves to a regular file, otherwise null. Older servers omit this field.
#[ts(type = "number | null", optional)]
pub size_bytes: Option<u64>,
}
/// List direct child names for a directory.
@@ -1271,6 +1271,7 @@ fn fs_get_metadata_response_round_trips_minimal_fields() {
is_symlink: false,
created_at_ms: 123,
modified_at_ms: 456,
size_bytes: Some(5),
};
let value = serde_json::to_value(&response).expect("serialize fs/getMetadata response");
@@ -1282,12 +1283,28 @@ fn fs_get_metadata_response_round_trips_minimal_fields() {
"isSymlink": false,
"createdAtMs": 123,
"modifiedAtMs": 456,
"sizeBytes": 5,
})
);
let decoded = serde_json::from_value::<FsGetMetadataResponse>(value)
let decoded = serde_json::from_value::<FsGetMetadataResponse>(value.clone())
.expect("deserialize fs/getMetadata response");
assert_eq!(decoded, response);
let mut legacy_value = value;
legacy_value
.as_object_mut()
.expect("metadata object")
.remove("sizeBytes");
let legacy = serde_json::from_value::<FsGetMetadataResponse>(legacy_value)
.expect("deserialize fs/getMetadata response from an older server");
assert_eq!(
legacy,
FsGetMetadataResponse {
size_bytes: None,
..response
}
);
}
#[test]
@@ -126,6 +126,7 @@ impl FsRequestProcessor {
is_symlink: metadata.is_symlink,
created_at_ms: metadata.created_at_ms,
modified_at_ms: metadata.modified_at_ms,
size_bytes: metadata.is_file.then_some(metadata.size),
})
}
+24 -21
View File
@@ -70,7 +70,7 @@ fn absolute_path(path: PathBuf) -> AbsolutePathBuf {
}
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
async fn fs_get_metadata_returns_only_used_fields() -> Result<()> {
async fn fs_get_metadata_returns_file_size() -> Result<()> {
let codex_home = TempDir::new()?;
let file_path = codex_home.path().join("note.txt");
std::fs::write(&file_path, "hello")?;
@@ -87,23 +87,6 @@ async fn fs_get_metadata_returns_only_used_fields() -> Result<()> {
)
.await??;
let result = response
.result
.as_object()
.context("fs/getMetadata result should be an object")?;
let mut keys = result.keys().cloned().collect::<Vec<_>>();
keys.sort();
assert_eq!(
keys,
vec![
"createdAtMs".to_string(),
"isDirectory".to_string(),
"isFile".to_string(),
"isSymlink".to_string(),
"modifiedAtMs".to_string(),
]
);
let stat: FsGetMetadataResponse = to_response(response)?;
assert_eq!(
stat,
@@ -113,6 +96,7 @@ async fn fs_get_metadata_returns_only_used_fields() -> Result<()> {
is_symlink: false,
created_at_ms: stat.created_at_ms,
modified_at_ms: stat.modified_at_ms,
size_bytes: Some(5),
}
);
assert!(
@@ -120,6 +104,18 @@ async fn fs_get_metadata_returns_only_used_fields() -> Result<()> {
"modifiedAtMs should be populated for existing files"
);
let request_id = mcp
.send_fs_get_metadata_request(codex_app_server_protocol::FsGetMetadataParams {
path: absolute_path(codex_home.path().to_path_buf()),
})
.await?;
let response = timeout(
DEFAULT_READ_TIMEOUT,
mcp.read_stream_until_response_message(RequestId::Integer(request_id)),
)
.await??;
assert_eq!(response.result.get("sizeBytes"), Some(&json!(null)));
Ok(())
}
@@ -168,9 +164,16 @@ async fn fs_get_metadata_reports_symlink() -> Result<()> {
.await??;
let stat: FsGetMetadataResponse = to_response(response)?;
assert_eq!(stat.is_directory, false);
assert_eq!(stat.is_file, true);
assert_eq!(stat.is_symlink, true);
assert_eq!(
stat,
FsGetMetadataResponse {
is_directory: false,
is_file: true,
is_symlink: true,
size_bytes: Some(5),
..stat
}
);
Ok(())
}