Skip to content

⚡ Bolt: [performance improvement] Avoid deep clones during OpenAPI parsing #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cloudesize67-cmd wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

⚡ Bolt: [performance improvement] Avoid deep clones during OpenAPI parsing #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .jules/bolt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 2024-07-08 - [Avoid Serde Deep Clones During Parsing]
**Learning:** Calling `.clone()` on intermediate `serde_yaml::Value` and `serde_json::Value` objects just to pass them into `from_value` allocates memory for every nested AST node, causing severe performance bottlenecks when parsing large specs.
**Action:** Replace `serde_yaml::from_value::<Type>(value.clone())` with `Type::deserialize(value)` (requires `use serde::Deserialize;`) to allow `serde` to read directly from the borrowed AST reference. Keep un-cloned `from_value` calls intact at the end of functions to consume the full tree without re-allocating.
23 changes: 10 additions & 13 deletions xdk-openapi/src/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
//! This module provides functions for parsing OpenAPI specifications from YAML or JSON formats.
//! It supports both string inputs and file paths.

use serde::Deserialize;

use crate::context::OpenApiContextGuard;
use crate::core::OpenApi;
use crate::error::OpenApiError;
Expand Down Expand Up @@ -56,9 +58,7 @@ pub fn parse_yaml(yaml: &str) -> Result<OpenApi> {
if let Some(schemas) = components.get("schemas").and_then(|s| s.as_mapping()) {
for (name, schema_val) in schemas {
if let Some(name_str) = name.as_str() {
match serde_yaml::from_value::<crate::components::Schema>(
schema_val.clone(),
) {
match crate::components::Schema::deserialize(schema_val) {
Ok(schema) => ctx.add_schema(name_str.to_string(), schema),
Err(e) => {
eprintln!("Warning: Failed to parse schema {name_str}: {e}")
Expand All @@ -70,9 +70,7 @@ pub fn parse_yaml(yaml: &str) -> Result<OpenApi> {
if let Some(parameters) = components.get("parameters").and_then(|p| p.as_mapping()) {
for (name, param_val) in parameters {
if let Some(name_str) = name.as_str() {
match serde_yaml::from_value::<crate::components::Parameter>(
param_val.clone(),
) {
match crate::components::Parameter::deserialize(param_val) {
Ok(param) => ctx.add_parameter(name_str.to_string(), param),
Err(e) => {
eprintln!("Warning: Failed to parse parameter {name_str}: {e}")
Expand All @@ -84,7 +82,7 @@ pub fn parse_yaml(yaml: &str) -> Result<OpenApi> {
if let Some(responses) = components.get("responses").and_then(|r| r.as_mapping()) {
for (name, resp_val) in responses {
if let Some(name_str) = name.as_str() {
match serde_yaml::from_value::<crate::core::Response>(resp_val.clone()) {
match crate::core::Response::deserialize(resp_val) {
Ok(resp) => ctx.add_response(name_str.to_string(), resp),
Err(e) => {
eprintln!("Warning: Failed to parse response {name_str}: {e}")
Expand All @@ -99,7 +97,7 @@ pub fn parse_yaml(yaml: &str) -> Result<OpenApi> {
{
for (name, rb_val) in request_bodies {
if let Some(name_str) = name.as_str() {
match serde_yaml::from_value::<crate::core::RequestBody>(rb_val.clone()) {
match crate::core::RequestBody::deserialize(rb_val) {
Ok(rb) => ctx.add_request_body(name_str.to_string(), rb),
Err(e) => {
eprintln!("Warning: Failed to parse requestBody {name_str}: {e}")
Expand Down Expand Up @@ -211,24 +209,23 @@ pub fn parse_json(json: &str) -> Result<OpenApi> {
OpenApiContextGuard::with_context_mut(|ctx| {
if let Some(schemas) = components.get("schemas").and_then(|s| s.as_object()) {
for (name, schema_val) in schemas {
match serde_json::from_value::<crate::components::Schema>(schema_val.clone()) {
match crate::components::Schema::deserialize(schema_val) {
Ok(schema) => ctx.add_schema(name.clone(), schema),
Err(e) => eprintln!("Warning: Failed to parse schema {name}: {e}"),
}
}
}
if let Some(parameters) = components.get("parameters").and_then(|p| p.as_object()) {
for (name, param_val) in parameters {
match serde_json::from_value::<crate::components::Parameter>(param_val.clone())
{
match crate::components::Parameter::deserialize(param_val) {
Ok(param) => ctx.add_parameter(name.clone(), param),
Err(e) => eprintln!("Warning: Failed to parse parameter {name}: {e}"),
}
}
}
if let Some(responses) = components.get("responses").and_then(|r| r.as_object()) {
for (name, resp_val) in responses {
match serde_json::from_value::<crate::core::Response>(resp_val.clone()) {
match crate::core::Response::deserialize(resp_val) {
Ok(resp) => ctx.add_response(name.clone(), resp),
Err(e) => eprintln!("Warning: Failed to parse response {name}: {e}"),
}
Expand All @@ -239,7 +236,7 @@ pub fn parse_json(json: &str) -> Result<OpenApi> {
.and_then(|rb| rb.as_object())
{
for (name, rb_val) in request_bodies {
match serde_json::from_value::<crate::core::RequestBody>(rb_val.clone()) {
match crate::core::RequestBody::deserialize(rb_val) {
Ok(rb) => ctx.add_request_body(name.clone(), rb),
Err(e) => eprintln!("Warning: Failed to parse requestBody {name}: {e}"),
}
Expand Down
Loading