Fixes #1149 (#1162)

Adds tests to make sure that merge works properly when getting failures.

Co-authored-by: Chris McConnell <chrimc>

Author: Chris McConnell

common/config/rush/pnpm-lock.yaml

@@ -73,6 +73,7 @@
     "@types/seedrandom": "~2.4.28",
     "chai": "^4.2.0",
     "mocha": "^6.2.2",
+    "nock": "^13.0.11",
     "nyc": "^14.1.1",
     "rimraf": "^2.6.3",
     "ts-node": "^9.0.0",

packages/dialog/package.json

@@ -556,6 +556,7 @@ export class SchemaMerger {
             return
         }
         this.log('Parsing component .schema files')
+        let triedMetaSchema = false
         for (const componentPath of componentPaths) {
             try {
                 const path = componentPath.path
@@ -576,14 +577,17 @@ export class SchemaMerger {
                     if (!component.$schema) {
                         this.missingSchemaError()
                     } else if (!this.metaSchema) {
-                        // Pick up meta-schema from first .dialog file
-                        this.metaSchemaId = component.$schema
-                        this.currentFile = this.metaSchemaId
-                        this.metaSchema = await getJSON(component.$schema)
-                        this.validator.addSchema(this.metaSchema, 'componentSchema')
-                        this.vlog(`  Using ${this.metaSchemaId} to define components`)
-                        this.currentFile = path
-                        this.validateSchema(component)
+                        if (!triedMetaSchema) {
+                            // Pick up meta-schema from first .dialog file and if failed don't try again
+                            triedMetaSchema = true
+                            this.metaSchemaId = component.$schema
+                            this.currentFile = this.metaSchemaId
+                            this.metaSchema = await getJSON(component.$schema)
+                            this.validator.addSchema(this.metaSchema, 'componentSchema')
+                            this.vlog(`  Using ${this.metaSchemaId} to define components`)
+                            this.currentFile = path
+                            this.validateSchema(component)
+                        }
                     } else if (component.$schema !== this.metaSchemaId) {
                         this.parsingWarning(`Component schema ${component.$schema} does not match ${this.metaSchemaId}`)
                     } else {
@@ -902,13 +906,13 @@ export class SchemaMerger {
         }
         return exts
     }
-    
+
     // Ensure kinds in policies exist and we expand to any extensions
     private validateAndExpandPolicies(): void {
         walkJSON(this.definitions, (val, _obj, path) => {
             if (val.$policies?.requiresKind) {
                 let expanded: string[] = []
-                for(const kind of val.$policies.requiresKind) {
+                for (const kind of val.$policies.requiresKind) {
                     if (!this.definitions[kind]) {
                         this.genericError(`Error ${path} has non-existent $kind ${kind}`)
                     }
@@ -1499,7 +1503,7 @@ export class SchemaMerger {
      * @param canOverride True if definition can override extension.
      */
     private mergeInto(extensionName: string, definition: any, canOverride?: boolean) {
-        const extension = this.definitions[extensionName] || this.metaSchema.definitions[extensionName]
+        const extension = this.definitions[extensionName] || this.metaSchema?.definitions[extensionName]
         if (!extension) {
             this.mergingError(`Cannot extend ${extensionName} because it is not included`)
         } else {

packages/dialog/src/library/schemaMerger.ts

@@ -11,6 +11,8 @@ import 'mocha'
 import * as os from 'os'
 import * as ppath from 'path'
 import * as merger from '../../../src/library/schemaMerger'
+const nock = require('nock')
+
 let srcDir = ppath.resolve('test/commands/dialog/')
 let tempDir = ppath.join(os.tmpdir(), 'test.out')
 
@@ -142,6 +144,21 @@ describe('dialog:merge', async () => {
         await compareToOracle('app.schema')
     })
 
+    it('missing component schema', async () => {
+        console.log('Start missing component schema')
+        let [merged, lines] = await merge(['schemas/badSchemas/missingComponent.schema'], 'app.schema')
+        assert(!merged, 'Merge should have failed')
+        assert(countMatches(/file does not exist/i, lines) === 1, 'No missing component schema')
+    })
+
+    it('mismatched component schema', async () => {
+        console.log('Start missing component schema')
+        let [merged, lines] = await merge(['schemas/*.schema', 'schemas/badSchemas/missingComponent.schema'], 'app.schema')
+        assert(merged, 'Could not merge')
+        assert(countMatches(/error|warning/i, lines) === 1, 'Too many errors or warnings')
+        assert(countMatches(/does not match/i, lines) === 1, 'No mismatched component schema')
+    })
+
     it('bad json', async () => {
         console.log('\nStart bad json')
         let [merged, lines] = await merge(['schemas/*.schema', 'schemas/badSchemas/badJson.schema'])
@@ -441,15 +458,18 @@ describe('dialog:merge', async () => {
         }
     })
 
-    /* Example of invoking library through test because of issues with launch.json
-    it('botbuilder-schema', async () => {
-        console.log('\nStart botbuilder-schema')
-        let [merged, lines] = await merge(['../../../../../../botbuilder-dotnet/libraries/**\*.schema',
-    '../../../../../../botbuilder-dotnet/tests/**\*.schema'], 'sdk.schema', true)
-        console.log(merged)
-        console.log(lines)
+    it('500 error', async () => {
+        console.log('Start 500 error')
+        const scope = nock('https://schemas.botframework.com')
+            .get(/schemas/)
+            .reply(500, 'Internal Server Error')
+            .persist()
+        let [merged, lines] = await merge(['schemas/*.schema'], 'app.schema')
+        assert(!merged, 'Merging should fail')
+        assert(countMatches(/internal server error/i, lines) === 1, 'Did not detect server error')
+        scope.done()
+        nock.cleanAll()
     })
-    */
 })
 
 /* TODO: These tests are related to verify and need to be updated and moved there.

packages/dialog/test/commands/dialog/merge.test.ts

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema1",
+    "properties": {
+        "name": {
+            "type": "string"
+        }
+    }
+}

packages/dialog/test/commands/dialog/schemas/badSchemas/missingComponent.schema

@@ -29,7 +29,7 @@ describe('dialog:verify', () => {
             expect(ctx.stderr.match(/DLG002/)!.length == 3, 'Wrong number of multiple definitions')
             expect(ctx.stderr.match(/DLG003/)!.length == 1, 'Wrong number of mising definitions')
             expect(ctx.stderr.match(/DLG004/)!.length == 1, 'Wrong number of type mismatches')
-            expect(ctx.stderr.match(/DLG005/)!.length == 6, 'Wrong number of unsued ids')
+            expect(ctx.stderr.match(/DLG005/)!.length == 6, 'Wrong number of unused ids')
             expect(ctx.stdout).to.contain('4 files')
             expect(ctx.stderr)
                 .to.contain('Warnings: 2', 'Wrong number of warnings')