Fix bug in interface sorting (#1034)

Chris McConnell · web-flow · commit 69cf2b91988b · 2020-10-24T11:43:43.000-07:00
diff --git a/packages/dialog/src/library/schemaMerger.ts b/packages/dialog/src/library/schemaMerger.ts
@@ -1680,8 +1680,8 @@ export class SchemaMerger {
     private sortImplementations(): void {
         for (this.currentKind in this.definitions) {
             const definition = this.definitions[this.currentKind]
-            if (this.isInterface(definition) && definition.oneOf) {
-                definition.oneOf = definition.oneOf.sort((a: any, b: any) => a.title.localeCompare(b.title))
+            if (this.isInterface(this.currentKind) && definition.oneOf) {
+                definition.oneOf = definition.oneOf.sort((a: any, b: any) => (a.$ref || a.type).localeCompare(b.$ref || b.type))
             }
         }
     }
diff --git a/packages/dialog/test/commands/dialog/oracles/app.schema b/packages/dialog/test/commands/dialog/oracles/app.schema
@@ -26,13 +26,13 @@
       "title": "Recognizer",
       "description": "Recognizer interface.",
       "oneOf": [
+        {
+          "$ref": "#/definitions/Recognizer"
+        },
         {
           "type": "string",
           "title": "Reference to IRecognizer",
           "description": "Reference to IRecognizer .dialog file."
-        },
-        {
-          "$ref": "#/definitions/Recognizer"
         }
       ]
     },
diff --git a/packages/dialog/test/commands/dialog/oracles/project3.schema b/packages/dialog/test/commands/dialog/oracles/project3.schema
@@ -213,14 +213,14 @@
       "description": "Components which are ActivityTemplate, which is string template, an activity, or a implementation of ActivityTemplate",
       "$role": "interface",
       "oneOf": [
-        {
-          "type": "string"
-        },
         {
           "$ref": "#/definitions/botframework.json/definitions/Activity",
           "required": [
             "type"
           ]
+        },
+        {
+          "type": "string"
         }
       ],
       "$package": {
@@ -233,9 +233,6 @@
       "description": "Components which derive from Dialog",
       "$role": "interface",
       "oneOf": [
-        {
-          "type": "string"
-        },
         {
           "$ref": "#/definitions/Microsoft.AdaptiveDialog"
         },
@@ -244,6 +241,9 @@
         },
         {
           "$ref": "#/definitions/Microsoft.SendActivity"
+        },
+        {
+          "type": "string"
         }
       ],
       "$package": {
@@ -257,10 +257,10 @@
       "$role": "interface",
       "oneOf": [
         {
-          "type": "string"
+          "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"
         },
         {
-          "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"
+          "type": "string"
         }
       ],
       "$package": {
@@ -274,10 +274,10 @@
       "$role": "interface",
       "oneOf": [
         {
-          "type": "string"
+          "$ref": "#/definitions/Microsoft.LuisRecognizer"
         },
         {
-          "$ref": "#/definitions/Microsoft.LuisRecognizer"
+          "type": "string"
         }
       ],
       "$package": {
@@ -294,16 +294,16 @@
         "version": "1.0.0"
       },
       "oneOf": [
-        {
-          "type": "string",
-          "title": "Reference to Microsoft.ITrigger",
-          "description": "Reference to Microsoft.ITrigger .dialog file."
-        },
         {
           "$ref": "#/definitions/Microsoft.OnCondition"
         },
         {
           "$ref": "#/definitions/Microsoft.OnIntent"
+        },
+        {
+          "type": "string",
+          "title": "Reference to Microsoft.ITrigger",
+          "description": "Reference to Microsoft.ITrigger .dialog file."
         }
       ]
     },
@@ -316,13 +316,13 @@
         "version": "1.0.0"
       },
       "oneOf": [
+        {
+          "$ref": "#/definitions/Microsoft.MostSpecificSelector"
+        },
         {
           "type": "string",
           "title": "Reference to Microsoft.ITriggerSelector",
           "description": "Reference to Microsoft.ITriggerSelector .dialog file."
-        },
-        {
-          "$ref": "#/definitions/Microsoft.MostSpecificSelector"
         }
       ]
     },
diff --git a/packages/dialog/test/commands/dialog/oracles/project5.schema b/packages/dialog/test/commands/dialog/oracles/project5.schema
@@ -213,14 +213,14 @@
       "description": "Components which are ActivityTemplate, which is string template, an activity, or a implementation of ActivityTemplate",
       "$role": "interface",
       "oneOf": [
-        {
-          "type": "string"
-        },
         {
           "$ref": "#/definitions/botframework.json/definitions/Activity",
           "required": [
             "type"
           ]
+        },
+        {
+          "type": "string"
         }
       ],
       "$package": {
@@ -233,9 +233,6 @@
       "description": "Components which derive from Dialog",
       "$role": "interface",
       "oneOf": [
-        {
-          "type": "string"
-        },
         {
           "$ref": "#/definitions/Microsoft.AdaptiveDialog"
         },
@@ -244,6 +241,9 @@
         },
         {
           "$ref": "#/definitions/Microsoft.SendActivity"
+        },
+        {
+          "type": "string"
         }
       ],
       "$package": {
@@ -257,10 +257,10 @@
       "$role": "interface",
       "oneOf": [
         {
-          "type": "string"
+          "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"
         },
         {
-          "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"
+          "type": "string"
         }
       ],
       "$package": {
@@ -274,10 +274,10 @@
       "$role": "interface",
       "oneOf": [
         {
-          "type": "string"
+          "$ref": "#/definitions/Microsoft.LuisRecognizer"
         },
         {
-          "$ref": "#/definitions/Microsoft.LuisRecognizer"
+          "type": "string"
         }
       ],
       "$package": {
@@ -294,16 +294,16 @@
         "version": "1.0.0"
       },
       "oneOf": [
-        {
-          "type": "string",
-          "title": "Reference to Microsoft.ITrigger",
-          "description": "Reference to Microsoft.ITrigger .dialog file."
-        },
         {
           "$ref": "#/definitions/Microsoft.OnCondition"
         },
         {
           "$ref": "#/definitions/Microsoft.OnIntent"
+        },
+        {
+          "type": "string",
+          "title": "Reference to Microsoft.ITrigger",
+          "description": "Reference to Microsoft.ITrigger .dialog file."
         }
       ]
     },
@@ -316,13 +316,13 @@
         "version": "1.0.0"
       },
       "oneOf": [
+        {
+          "$ref": "#/definitions/Microsoft.MostSpecificSelector"
+        },
         {
           "type": "string",
           "title": "Reference to Microsoft.ITriggerSelector",
           "description": "Reference to Microsoft.ITriggerSelector .dialog file."
-        },
-        {
-          "$ref": "#/definitions/Microsoft.MostSpecificSelector"
         }
       ]
     },

Original file line number	Diff line number	Diff line change
`@@ -1680,8 +1680,8 @@ export class SchemaMerger {`
`1680`	`1680`	`private sortImplementations(): void {`
`1681`	`1681`	`for (this.currentKind in this.definitions) {`
`1682`	`1682`	`const definition = this.definitions[this.currentKind]`
`1683`		`- if (this.isInterface(definition) && definition.oneOf) {`
`1684`		`- definition.oneOf = definition.oneOf.sort((a: any, b: any) => a.title.localeCompare(b.title))`
	`1683`	`+ if (this.isInterface(this.currentKind) && definition.oneOf) {`
	`1684`	`+ definition.oneOf = definition.oneOf.sort((a: any, b: any) => (a.$ref \|\| a.type).localeCompare(b.$ref \|\| b.type))`
`1685`	`1685`	`}`
`1686`	`1686`	`}`
`1687`	`1687`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,13 +26,13 @@`
`26`	`26`	`"title": "Recognizer",`
`27`	`27`	`"description": "Recognizer interface.",`
`28`	`28`	`"oneOf": [`
	`29`	`+ {`
	`30`	`+ "$ref": "#/definitions/Recognizer"`
	`31`	`+ },`
`29`	`32`	`{`
`30`	`33`	`"type": "string",`
`31`	`34`	`"title": "Reference to IRecognizer",`
`32`	`35`	`"description": "Reference to IRecognizer .dialog file."`
`33`		`- },`
`34`		`- {`
`35`		`- "$ref": "#/definitions/Recognizer"`
`36`	`36`	`}`
`37`	`37`	`]`
`38`	`38`	`},`
Original file line number	Diff line number	Diff line change
`@@ -213,14 +213,14 @@`
`213`	`213`	`"description": "Components which are ActivityTemplate, which is string template, an activity, or a implementation of ActivityTemplate",`
`214`	`214`	`"$role": "interface",`
`215`	`215`	`"oneOf": [`
`216`		`- {`
`217`		`- "type": "string"`
`218`		`- },`
`219`	`216`	`{`
`220`	`217`	`"$ref": "#/definitions/botframework.json/definitions/Activity",`
`221`	`218`	`"required": [`
`222`	`219`	`"type"`
`223`	`220`	`]`
	`221`	`+ },`
	`222`	`+ {`
	`223`	`+ "type": "string"`
`224`	`224`	`}`
`225`	`225`	`],`
`226`	`226`	`"$package": {`
`@@ -233,9 +233,6 @@`
`233`	`233`	`"description": "Components which derive from Dialog",`
`234`	`234`	`"$role": "interface",`
`235`	`235`	`"oneOf": [`
`236`		`- {`
`237`		`- "type": "string"`
`238`		`- },`
`239`	`236`	`{`
`240`	`237`	`"$ref": "#/definitions/Microsoft.AdaptiveDialog"`
`241`	`238`	`},`
`@@ -244,6 +241,9 @@`
`244`	`241`	`},`
`245`	`242`	`{`
`246`	`243`	`"$ref": "#/definitions/Microsoft.SendActivity"`
	`244`	`+ },`
	`245`	`+ {`
	`246`	`+ "type": "string"`
`247`	`247`	`}`
`248`	`248`	`],`
`249`	`249`	`"$package": {`
`@@ -257,10 +257,10 @@`
`257`	`257`	`"$role": "interface",`
`258`	`258`	`"oneOf": [`
`259`	`259`	`{`
`260`		`- "type": "string"`
	`260`	`+ "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"`
`261`	`261`	`},`
`262`	`262`	`{`
`263`		`- "$ref": "#/definitions/Microsoft.TemplateEngineLanguageGenerator"`
	`263`	`+ "type": "string"`
`264`	`264`	`}`
`265`	`265`	`],`
`266`	`266`	`"$package": {`
`@@ -274,10 +274,10 @@`
`274`	`274`	`"$role": "interface",`
`275`	`275`	`"oneOf": [`
`276`	`276`	`{`
`277`		`- "type": "string"`
	`277`	`+ "$ref": "#/definitions/Microsoft.LuisRecognizer"`
`278`	`278`	`},`
`279`	`279`	`{`
`280`		`- "$ref": "#/definitions/Microsoft.LuisRecognizer"`
	`280`	`+ "type": "string"`
`281`	`281`	`}`
`282`	`282`	`],`
`283`	`283`	`"$package": {`
`@@ -294,16 +294,16 @@`
`294`	`294`	`"version": "1.0.0"`
`295`	`295`	`},`
`296`	`296`	`"oneOf": [`
`297`		`- {`
`298`		`- "type": "string",`
`299`		`- "title": "Reference to Microsoft.ITrigger",`
`300`		`- "description": "Reference to Microsoft.ITrigger .dialog file."`
`301`		`- },`
`302`	`297`	`{`
`303`	`298`	`"$ref": "#/definitions/Microsoft.OnCondition"`
`304`	`299`	`},`
`305`	`300`	`{`
`306`	`301`	`"$ref": "#/definitions/Microsoft.OnIntent"`
	`302`	`+ },`
	`303`	`+ {`
	`304`	`+ "type": "string",`
	`305`	`+ "title": "Reference to Microsoft.ITrigger",`
	`306`	`+ "description": "Reference to Microsoft.ITrigger .dialog file."`
`307`	`307`	`}`
`308`	`308`	`]`
`309`	`309`	`},`
`@@ -316,13 +316,13 @@`
`316`	`316`	`"version": "1.0.0"`
`317`	`317`	`},`
`318`	`318`	`"oneOf": [`
	`319`	`+ {`
	`320`	`+ "$ref": "#/definitions/Microsoft.MostSpecificSelector"`
	`321`	`+ },`
`319`	`322`	`{`
`320`	`323`	`"type": "string",`
`321`	`324`	`"title": "Reference to Microsoft.ITriggerSelector",`
`322`	`325`	`"description": "Reference to Microsoft.ITriggerSelector .dialog file."`
`323`		`- },`
`324`		`- {`
`325`		`- "$ref": "#/definitions/Microsoft.MostSpecificSelector"`
`326`	`326`	`}`
`327`	`327`	`]`
`328`	`328`	`},`