Consolidate JSON stringify dependencies #251890

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.

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

Merged

legrego merged 15 commits into elastic:main from legrego:dr/json-stringify

Feb 10, 2026

Expand empties

Loading branch information

nikitaindik committed Feb 10, 2026

commit 1c8d481bcec66abc383aa258734f98d3a653cf2b

...lic/detection_engine/rule_management/components/rule_details/json_diff/json_diff.test.tsx

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -253,11 +253,11 @@ describe('Rule upgrade workflow: viewing rule changes in JSON diff view', () =>
  
        renderRuleDiffComponent({ oldRule, newRule });

        expect(screen.queryAllByText('"author":', { exact: false })).toHaveLength(0);

        expect(screen.queryAllByText('Expand 35 unchanged lines')).toHaveLength(1);

        expect(screen.queryAllByText('Expand 44 unchanged lines')).toHaveLength(1);

        await userEvent.click(screen.getByText('Expand 35 unchanged lines'));

        await userEvent.click(screen.getByText('Expand 44 unchanged lines'));

        expect(screen.queryAllByText('Expand 35 unchanged lines')).toHaveLength(0);

        expect(screen.queryAllByText('Expand 44 unchanged lines')).toHaveLength(0);

        expect(screen.queryAllByText('"author":', { exact: false })).toHaveLength(2);

      });

    @@ -296,7 +296,7 @@ describe('Rule upgrade workflow: viewing rule changes in JSON diff view', () =>
  
        const arePropertiesSortedInConciseView = checkRenderedPropertyNamesAreSorted();

        expect(arePropertiesSortedInConciseView).toBe(true);

        await userEvent.click(screen.getByText('Expand 35 unchanged lines'));

        await userEvent.click(screen.getByText('Expand 44 unchanged lines'));

        const arePropertiesSortedInExpandedView = checkRenderedPropertyNamesAreSorted();

        expect(arePropertiesSortedInExpandedView).toBe(true);

      });

...e_management/components/rule_details/per_field_diff/get_field_diffs_for_grouped_fields.ts

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -5,7 +5,6 @@
  
     * 2.0.

     */

    import { stableStringify } from '@kbn/std';

    import type {

      RuleSchedule,

      SimpleRuleSchedule,

    @@ -20,6 +19,7 @@ import type {
  
      ThreeWayDiff,

    } from '../../../../../../common/api/detection_engine';

    import type { FieldDiff } from '../../../model/rule_details/rule_field_diff';

    import { stringifyWithExpandedEmpties } from '../three_way_diff/comparison_side/utils';

    export const sortAndStringifyJson = (fieldValue: unknown): string => {

      if (!fieldValue) {

    @@ -29,7 +29,7 @@ export const sortAndStringifyJson = (fieldValue: unknown): string => {
  
      if (typeof fieldValue === 'string') {

        return fieldValue;

      }

      return stableStringify(fieldValue, { space: 2 });

      return stringifyWithExpandedEmpties(fieldValue);

    };

    export const getFieldDiffsForDataSource = (

...olution/public/detection_engine/rule_management/components/rule_details/rule_diff_tab.tsx

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -7,7 +7,6 @@
  
    import React, { useMemo } from 'react';

    import { omit, pick } from 'lodash';

    import { stableStringify } from '@kbn/std';

    import {

      EuiSpacer,

      EuiPanel,

    @@ -21,6 +20,7 @@ import { normalizeMachineLearningJobIds } from '../../../../../common/detection_
  
    import { filterEmptyThreats } from '../../../rule_creation_ui/pages/rule_creation/helpers';

    import type { RuleResponse } from '../../../../../common/api/detection_engine/model/rule_schema/rule_schemas.gen';

    import { DiffView } from './json_diff/diff_view';

    import { stringifyWithExpandedEmpties } from './three_way_diff/comparison_side/utils';

    /* Inclding these properties in diff display might be confusing to users. */

    const HIDDEN_PROPERTIES: Array<keyof RuleResponse> = [

    @@ -60,9 +60,6 @@ const HIDDEN_PROPERTIES: Array<keyof RuleResponse> = [
  
      'execution_summary',

    ];

    const sortAndStringifyJson = (jsObject: Record<string, unknown>): string =>

      stableStringify(jsObject, { space: 2 });

    /**

     * Normalizes the rule object, making it suitable for comparison with another normalized rule.

     *

    @@ -144,8 +141,8 @@ export const RuleDiffTab = ({
  
        );

        return [

          sortAndStringifyJson(visibleOldRuleProperties),

          sortAndStringifyJson(visibleNewRuleProperties),

          stringifyWithExpandedEmpties(visibleOldRuleProperties),

          stringifyWithExpandedEmpties(visibleNewRuleProperties),

        ];

      }, [oldRule, newRule]);

...on_engine/rule_management/components/rule_details/three_way_diff/comparison_side/utils.ts

-Original file line number
+Diff line change
@@ Expand Up @@
         return fieldValue;
       }
-      return stableStringify(fieldValue, { space: 2 });
+      return stringifyWithExpandedEmpties(fieldValue);
+    };
+    /**
+     * Stringifies a value to pretty-printed JSON with sorted keys,
+     * then expands inline empty arrays (`[]`) and objects (`{}`) to multi-line format.
+     *
+     * This expansion is needed because the diff view uses a line-based diff algorithm.
+     * Without it, a change from `[]` to a non-empty array (or object) shows as a full replacement
+     * (delete + insert) instead of a clean insertion, since the algorithm can't match
+     * the single-line `[]` against the opening `[` of a multi-line array.
+     *
+     * @param value - The value to stringify.
+     * @returns A pretty-printed JSON string with empty collections expanded to multi-line.
+     *
+     * @example
+     * // Input:  { "author": [], "name": "Test" }
+     * // Output:
+     * // {
+     * //   "author": [
+     * //   ],
+     * //   "name": "Test"
+     * // }
+     */
+    export const stringifyWithExpandedEmpties = (value: unknown): string => {
+      const jsonString = stableStringify(value, { space: 2 });
+      if (jsonString === '[]') {
+        return '[\n]';
+      }
+      if (jsonString === '{}') {
+        return '{\n}';
+      }
+      const expanded = jsonString
+        // Expand nested empty arrays from "[]" to "[\n]"
+        .replace(/^(\s*)(.*): \[\]/gm, '$1$2: [\n$1]')
+        // Expand nested empty objects from "{}" to "{\n}"
+        .replace(/^(\s*)(.*): \{\}/gm, '$1$2: {\n$1}');
+      return expanded;
     };
     interface OptionDetails {
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consolidate JSON stringify dependencies #251890

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!