Merge pull request #529 from fractal-analytics-platform/fix-custom-json-schema-key

Fixed custom key not displayed in JSON Schema form

Author: zonia3000

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 # Unreleased
 
+* Fixed custom key not displayed in JSON Schema form (\#529);
 * Added dropdown for Python version in tasks (\#526);
 * Improved formatting of errors in standard error alert component (\#526);
 * Used `postgres-psycopg` adapter in CI (\#525);

jschema/__tests__/properties/object.test.js

@@ -242,4 +242,45 @@ describe('Object properties', () => {
 		expect(screen.getByRole('textbox', { name: 'key1' })).toHaveValue('foo');
 		expect(screen.getByRole('textbox', { name: 'key2' })).toHaveValue('');
 	});
+
+	it('Display object with custom key and title - key prevails over title', async function () {
+		const { component } = renderSchema(
+			{
+				type: 'object',
+				properties: {
+					map: {
+						type: 'object',
+						additionalProperties: {
+							type: 'object',
+							title: 'PropertyTitle',
+							properties: {
+								test: {
+									type: 'string'
+								}
+							}
+						}
+					}
+				}
+			},
+			{ map: { k1: { test: 'foo' } } }
+		);
+		expect(component.getArguments()).deep.eq({ map: { k1: { test: 'foo' } } });
+		expect(screen.queryByText('PropertyTitle')).toBeNull();
+		expect(screen.queryByText('k1')).not.toBeNull();
+	});
+
+	it('Display root schema having only additionalProperties', async function () {
+		const { component } = renderSchema(
+			{
+				type: 'object',
+				additionalProperties: {
+					type: 'string'
+				}
+			},
+			{ k1: 'foo', k2: 'bar' }
+		);
+		expect(component.getArguments()).deep.eq({ k1: 'foo', k2: 'bar' });
+		expect(screen.queryByText('k1')).not.toBeNull();
+		expect(screen.queryByText('k2')).not.toBeNull();
+	});
 });

jschema/src/lib/components/form_manager.js

@@ -328,7 +328,7 @@ export class FormManager {
 			manager: this,
 			id: this.getUniqueId(),
 			type: property.type || null,
-			title: property.title || key || '',
+			title: key && removable ? key : property.title || key || '',
 			description: property.description || '',
 			property: deepCopy(property),
 			notifyChange: this.notifyChange

jschema/src/lib/components/jschema_adapter.js

@@ -21,7 +21,7 @@ export function adaptJsonSchema(originalJsonSchema, propertiesToIgnore = []) {
  */
 export function stripIgnoredProperties(originalJsonSchema, propertiesToIgnore = []) {
 	const adaptedSchema = deepCopy(originalJsonSchema);
-	for (const k of Object.keys(adaptedSchema.properties)) {
+	for (const k of Object.keys(adaptedSchema.properties || {})) {
 		if (propertiesToIgnore.includes(k)) {
 			delete adaptedSchema.properties[k];
 		}