yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-31 20:51:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor: handle deeply nested object parsing in formatJsonString (#14974)

Browse Source
This commit is contained in:
Sachin Chaurasiya 2024-01-31 17:59:00 +05:30 committed by GitHub
parent a532fb1b5d
commit 38295daa99
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 44 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
openmetadata-ui/src/main/resources/ui/src/utils/StringsUtils.test.ts
View File

@ -10,7 +10,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { getDecodedFqn, getEncodedFqn } from './StringsUtils';
import { formatJsonString, getDecodedFqn, getEncodedFqn } from './StringsUtils';
describe('StringsUtils', () => {
it('getEncodedFqn should return encoded Fqn', () => {
@ -40,4 +40,36 @@ describe('StringsUtils', () => {
expect(getDecodedFqn(fqn, true)).toEqual(decodedFqn);
});
describe('formatJsonString', () => {
it('should format a simple JSON string', () => {
const jsonString = JSON.stringify({ key1: 'value1', key2: 'value2' });
const expectedOutput = '[key1]: value1\n[key2]: value2\n';
expect(formatJsonString(jsonString)).toStrictEqual(expectedOutput);
});
it('should format a deeply nested JSON string', () => {
const jsonString = JSON.stringify({
key1: 'value1',
key2: {
subKey1: 'subValue1',
subKey2: {
subSubKey1: 'subSubValue1',
subSubKey2: 'subSubValue2',
},
},
});
const expectedOutput =
'[key1]: value1\n[key2]:\n [subKey1]: subValue1\n [subKey2]:\n [subSubKey1]: subSubValue1\n [subSubKey2]: subSubValue2\n';
expect(formatJsonString(jsonString)).toStrictEqual(expectedOutput);
});
it('should return the original string if it is not valid JSON', () => {
const jsonString = 'not valid JSON';
expect(formatJsonString(jsonString)).toStrictEqual(jsonString);
});
});
});

15
openmetadata-ui/src/main/resources/ui/src/utils/StringsUtils.ts
View File

@ -226,19 +226,26 @@ export const escapeESReservedCharacters = (text?: string) => {
};
/**
* @description Format JSON string to pretty print format with 2 spaces indentation.
* @description Format JSON string to a readable format
* if the JSON string is invalid, return the original JSON string
* @param jsonString - JSON string to format
* @param indent - Indentation string
* @returns Formatted JSON string
* @example formatJsonString('{"key1": "value1", "key2": "value2"}') => '[key1]: value1\n[key2]: value2\n'
*/
export const formatJsonString = (jsonString: string) => {
export const formatJsonString = (jsonString: string, indent = '') => {
try {
let formattedJson = '';
const jsonObj = JSON.parse(jsonString);
// loop through the keys and values and format append the formatted string to formattedJson like [key]: [value]
for (const [key, value] of Object.entries(jsonObj)) {
formattedJson += `[${key}]: ${value}\n`;
if (typeof value === 'object' && value !== null) {
formattedJson += `${indent}[${key}]:\n`;
// Recursively format nested objects
formattedJson += formatJsonString(JSON.stringify(value), indent + ' ');
} else {
formattedJson += `${indent}[${key}]: ${value}\n`;
}
}
return formattedJson;