Fix a bug where the results of the JSON function in sqlite would be interpreted as a string instead of a json object.

fixes #738

Thank you to @SebastiendOrnano who reported the issue

Author: lovasoa

CHANGELOG.md

@@ -29,6 +29,7 @@
 - Update ApexCharts to [v4.1.0](https://github.com/apexcharts/apexcharts.js/releases/tag/v4.1.0).
 - Temporarily disable automatic tick amount calculation in the chart component. This was causing issues with mislabeled x-axis data, because of a bug in ApexCharts.
 - Add a new `max_recursion_depth` configuration option to limit the depth of recursion allowed in the `run_sql` function.
+- Fix a bug where the results of the `JSON` function in sqlite would be interpreted as a string instead of a json object.
 
 ## 0.31.0 (2024-11-24)
 

src/webserver/database/execute_queries.rs

@@ -442,3 +442,80 @@ impl<'q> sqlx::Execute<'q, Any> for StatementWithParams<'q> {
         true
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use serde_json::{json, Value};
+
+    fn create_row_item(value: Value) -> DbItem {
+        DbItem::Row(value)
+    }
+
+    fn assert_json_value(item: &DbItem, key: &str, expected: Value) {
+        let DbItem::Row(Value::Object(row)) = item else {
+            panic!("Expected DbItem::Row");
+        };
+        assert_eq!(row[key], expected);
+    }
+
+    #[test]
+    fn test_basic_json_string_conversion() {
+        let mut item = create_row_item(json!({
+            "json_col": "{\"key\": \"value\"}",
+            "normal_col": "text"
+        }));
+        apply_json_columns(&mut item, &["json_col".to_string()]);
+        assert_json_value(&item, "json_col", json!({"key": "value"}));
+        assert_json_value(&item, "normal_col", json!("text"));
+    }
+
+    #[test]
+    fn test_json_array_conversion() {
+        let mut item = create_row_item(json!({
+            "array_col": ["{\"a\": 1}", "{\"b\": 2}"],
+            "normal_array": ["text"]
+        }));
+        apply_json_columns(&mut item, &["array_col".to_string()]);
+        assert_json_value(&item, "array_col", json!([{"a": 1}, {"b": 2}]));
+        assert_json_value(&item, "normal_array", json!(["text"]));
+    }
+
+    #[test]
+    fn test_invalid_json_handling() {
+        let mut item = create_row_item(json!({
+            "invalid_json": "{not valid json}",
+            "normal_col": "text"
+        }));
+        apply_json_columns(&mut item, &["invalid_json".to_string()]);
+        assert_json_value(&item, "invalid_json", json!("{not valid json}"));
+        assert_json_value(&item, "normal_col", json!("text"));
+    }
+
+    #[test]
+    fn test_missing_column_handling() {
+        let mut item = create_row_item(json!({
+            "existing_col": "text"
+        }));
+        apply_json_columns(&mut item, &["missing_col".to_string()]);
+        assert_json_value(&item, "existing_col", json!("text"));
+    }
+
+    #[test]
+    fn test_non_row_dbitem_handling() {
+        let mut item = DbItem::FinishedQuery;
+        apply_json_columns(&mut item, &["json_col".to_string()]);
+        assert!(matches!(item, DbItem::FinishedQuery));
+    }
+
+    #[test]
+    fn test_duplicate_json_column_names() {
+        let mut item = create_row_item(json!({
+            "json_col": "{\"key\": \"value\"}",
+            "normal_col": "text"
+        }));
+        apply_json_columns(&mut item, &["json_col".to_string(), "json_col".to_string()]);
+        assert_json_value(&item, "json_col", json!({"key": "value"}));
+        assert_json_value(&item, "normal_col", json!("text"));
+    }
+}

src/webserver/database/sql.rs

@@ -854,6 +854,8 @@ fn is_json_function(expr: &Expr) -> bool {
                     "json_objectagg",
                     "json_group_array",
                     "json_group_object",
+                    "json",
+                    "jsonb",
                 ]
                 .iter()
                 .any(|&func| value.eq_ignore_ascii_case(func))
@@ -1350,4 +1352,20 @@ mod test {
             assert_eq!(json_columns, Vec::<String>::new());
         }
     }
+
+    #[test]
+    fn test_extract_json_columns_from_literal() {
+        let sql = r#"
+            SELECT 
+                'Pro Plan' as title,
+                JSON('{"icon":"database","color":"blue","description":"1GB Database"}') as item,
+                JSON('{"icon":"headset","color":"green","description":"Priority Support"}') as item
+        "#;
+
+        let stmt = parse_stmt(sql, &SQLiteDialect {});
+        let json_columns = extract_json_columns(&stmt, AnyKind::Sqlite);
+
+        assert!(json_columns.contains(&"item".to_string()));
+        assert!(!json_columns.contains(&"title".to_string()));
+    }
 }

tests/index.rs

@@ -525,6 +525,31 @@ async fn privileged_paths_are_not_accessible() {
     );
 }
 
+#[actix_web::test]
+/// https://github.com/sqlpage/SQLPage/issues/738
+async fn test_json_columns() {
+    let resp_result = req_path("/tests/json_columns.sql").await;
+    let resp = resp_result.expect("Failed to request /tests/json_columns.sql");
+    assert_eq!(resp.status(), http::StatusCode::OK);
+    let body = test::read_body(resp).await;
+    let body_str = String::from_utf8(body.to_vec()).unwrap();
+    let body_html_escaped = body_str.replace(""", "\"");
+    assert!(
+        !body_html_escaped.contains("error"),
+        "the request should not have failed, in: {body_html_escaped}"
+    );
+    assert!(body_html_escaped.contains("1GB Database"));
+    assert!(body_html_escaped.contains("Priority Support"));
+    assert!(
+        !body_html_escaped.contains("\"description\""),
+        "the json should have been parsed, not returned as a string, in: {body_html_escaped}"
+    );
+    assert!(
+        !body_html_escaped.contains("{"),
+        "the json should have been parsed, not returned as a string, in: {body_html_escaped}"
+    );
+}
+
 #[actix_web::test]
 async fn test_static_files() {
     let resp = req_path("/tests/it_works.txt").await.unwrap();

tests/json_columns.sql

@@ -0,0 +1,14 @@
+select
+    'columns' as component;
+
+select
+    'Pro Plan' as title,
+    '€40' as value,
+    'rocket' as icon,
+    'For growing projects needing enhanced features' as description,
+    JSON (
+        '{"icon":"database","color":"blue","description":"1GB Database"}'
+    ) as item,
+    JSON (
+        '{"icon":"headset","color":"green","description":"Priority Support"}'
+    ) as item;