Use @osd/std to prettify objects for display (#8232) (#8253)

* Use @osd/std to stringify JSON when formatting objects for display * Changeset file for PR #8232 created/updated --------- (cherry picked from commit 6e3351c) Signed-off-by: Miki <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
opensearch-project · Sep 21, 2024 · 91e4fe5 · 91e4fe5
1 parent af4529d
commit 91e4fe5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/changelogs/fragments/8232.yml b/changelogs/fragments/8232.yml
@@ -0,0 +1,2 @@
+fix:
+- Use @osd/std to prettify objects for display ([#8232](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8232))
diff --git a/src/plugins/data/common/field_formats/utils/as_pretty_string.test.ts b/src/plugins/data/common/field_formats/utils/as_pretty_string.test.ts
@@ -42,7 +42,11 @@ describe('asPrettyString', () => {
   });
 
   test('Converts objects values into presentable strings', () => {
-    expect(asPrettyString({ key: 'value' })).toBe('{\n  "key": "value"\n}');
+    const longPositive = BigInt(Number.MAX_SAFE_INTEGER) * 2n;
+    const longNegative = BigInt(Number.MIN_SAFE_INTEGER) * 2n;
+    expect(asPrettyString({ key: 'value', longPositive, longNegative })).toBe(
+      `{\n  "key": "value",\n  "longPositive": ${longPositive.toString()},\n  "longNegative": ${longNegative.toString()}\n}`
+    );
   });
 
   test('Converts other non-string values into strings', () => {

diff --git a/src/plugins/data/common/field_formats/utils/as_pretty_string.ts b/src/plugins/data/common/field_formats/utils/as_pretty_string.ts
@@ -28,6 +28,8 @@
  * under the License.
  */
 
+import { stringify } from '@osd/std';
+
 /**
  * Convert a value to a presentable string
  */
@@ -37,7 +39,7 @@ export function asPrettyString(val: any): string {
     case 'string':
       return val;
     case 'object':
-      return JSON.stringify(val, null, '  ');
+      return stringify(val, null, '  ');
     default:
       return '' + val;
   }