fix: Sorting OneOfField options / better default type (#4673)

* Sorting OneOfField options based on type weights * Fix test * fix test Co-authored-by: Geoff Cox (Microsoft) <gcox@microsoft.com>
microsoft · Nov 5, 2020 · 0b5edb7 · 0b5edb7
1 parent 25f709d
commit 0b5edb7
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/Composer/packages/adaptive-form/src/components/fields/OneOfField/__tests__/utils.test.ts b/Composer/packages/adaptive-form/src/components/fields/OneOfField/__tests__/utils.test.ts
@@ -22,9 +22,9 @@ describe('getOptions', () => {
     it('returns all of the types, sorted', () => {
       const { options } = getOptions(schema, {});
       expect(options).toEqual([
-        makeOption(schema, 'boolean'),
-        makeOption(schema, 'number'),
         makeOption(schema, 'string'),
+        makeOption(schema, 'number'),
+        makeOption(schema, 'boolean'),
       ]);
     });
   });
@@ -71,13 +71,13 @@ describe('getOptions', () => {
       const { options } = getOptions(schema, definitions);
       const optionKeys = options.map((o) => o.key);
       expect(optionKeys).toEqual([
-        'my awesome string',
-        'boolean',
+        'string',
         'number',
+        'boolean',
+        'my awesome string',
         'an enum',
         'dropdown',
         'another type',
-        'string',
         'unknown',
       ]);
     });

diff --git a/Composer/packages/adaptive-form/src/components/fields/OneOfField/utils.ts b/Composer/packages/adaptive-form/src/components/fields/OneOfField/utils.ts
@@ -25,6 +25,18 @@ function getOptionLabel(schema: JSONSchema7): string {
   return type || 'unknown';
 }
 
+const typePriorityWeights = {
+  string: 5,
+  number: 4,
+  boolean: 3,
+  array: 2,
+  object: 1,
+};
+
+const sortOptionsByTypeWeights = ({ key: type1 }, { key: type2 }): number => {
+  return (typePriorityWeights[type1] || 0) > (typePriorityWeights[type2] || 0) ? -1 : 1;
+};
+
 export function getOptions(
   schema: JSONSchema7,
   definitions?: SchemaDefinitions
@@ -40,7 +52,7 @@ export function getOptions(
       data: { schema: { ...schema, type: t }, icon: getFieldIconText(t) },
     }));
 
-    options.sort(({ text: t1 }, { text: t2 }) => (t1 > t2 ? 1 : -1));
+    options.sort(sortOptionsByTypeWeights);
 
     return { options, isNested };
   }
@@ -64,6 +76,8 @@ export function getOptions(
       })
       .filter(Boolean) as IDropdownOption[];
 
+    options.sort(sortOptionsByTypeWeights);
+
     const expression = (resolvedOneOf as JSONSchema7[]).find(({ $role }) => $role === 'expression');
     const merged = merge({}, omit(schema, 'oneOf'), expression);