Fix for #122 - luis:convert fails on valid patterns (#143)

* spec

* Fix for #122

* Fix up

* updates

Author: vishwacsena

packages/luis/parser/converters/lumerger.js

@@ -161,11 +161,9 @@ const resolveReferencesInUtterances = async function(allParsedContent) {
         let newPatternsToAdd = [];
         let spliceList = [];
         (luisModel.LUISJsonStructure.utterances || []).forEach((utterance,idx) => {
-            // Deep references must have [link name](link-value) notation
-            if (utterance.text.indexOf('[') !== 0) return;
-            // does this utterance have a deep link uri? 
-            let linkExp = (utterance.text || '').trim().match(new RegExp(/\(.*?\)/g));
-            if (linkExp && linkExp.length !== 0) {
+            // Fix for BF-CLI #122. 
+            // Ensure only links are detected and passed on to be parsed.
+            if (helpers.isUtteranceLinkRef(utterance.text || '')) {
                 // we have stuff to parse and resolve
                 let parsedUtterance = helpers.parseLinkURI(utterance.text);
                 if (!path.isAbsolute(parsedUtterance.luFile)) parsedUtterance.luFile = path.resolve(path.dirname(luisModel.srcFile), parsedUtterance.luFile);

packages/luis/parser/lufile/helpers.js

@@ -116,6 +116,33 @@ const helpers = {
             returnValue.roles = parsedRoleDefinition.replace('[', '').replace(']', '').split(RolesSplitRegEx).map(item => item.trim());
         }
         return returnValue;
+    },
+    /**
+     * Helper function to detect if a given text is a link reference
+     * @param {String} utterance utterance text to examine
+     * @returns {Boolean} true if input is a link reference
+     */
+    isUtteranceLinkRef : function (utterance) {
+        utterance = utterance || '';
+        // Ensure only links are detected and passed on to be parsed.
+        // Valid link: [bar](xyz)
+        // Not a link: [bar](xyz|123), [bar[tar]](xyz), abc [foo](bar)
+        let linkDetectRegex = /^\[[^\[]+\]\([^|]+\)$/gi;
+        return linkDetectRegex.test(utterance);   
+    },
+    /**
+     * Helper function to detect if a given text is a pattern.
+     * @param {String} utterance
+     * @returns {Boolean} true if utterance is a pattern 
+     */
+    isUtterancePattern : function (utterance) {
+        utterance = utterance || '';
+        // link references cannot be a pattern
+        if (this.isUtteranceLinkRef(utterance)) return false;
+
+        // patterns must have at least one [optional] and or one (group | text)
+        let detectPatternRegex = /(\[.*?\])|(\(.*?(\|.*?)+\))/gi;
+        return detectPatternRegex.test(utterance);
     }
 }
 

packages/luis/parser/lufile/parseFileContents.js

@@ -208,13 +208,12 @@ const parseAndHandleIntent = function (parsedContent, luResource) {
             for (const utteranceAndEntities of intent.UtteranceAndEntitiesMap) {
                 // add utterance
                 let utterance = utteranceAndEntities.utterance.trim();
-                if (utterance.indexOf('[') == 0) {
-                    let linkExp = (utterance || '').trim().match(new RegExp(/\(.*?\)/g));
-                    if (linkExp && linkExp.length === 1) {
-                        let parsedLinkUriInUtterance = helpers.parseLinkURI(utterance);
-                        // examine and add these to filestoparse list.
-                        parsedContent.additionalFilesToParse.push(new fileToParse(parsedLinkUriInUtterance.luFile, false));
-                    }
+                // Fix for BF-CLI #122. 
+                // Ensure only links are detected and passed on to be parsed.
+                if (helpers.isUtteranceLinkRef(utterance || '')) {
+                    let parsedLinkUriInUtterance = helpers.parseLinkURI(utterance);
+                    // examine and add these to filestoparse list.
+                    parsedContent.additionalFilesToParse.push(new fileToParse(parsedLinkUriInUtterance.luFile, false));
                 }
 
                 if (utteranceAndEntities.entities.length > 0) {
@@ -387,8 +386,14 @@ const parseAndHandleIntent = function (parsedContent, luResource) {
                     }
 
                 } else {
-                    let utteranceObject = new helperClass.uttereances(utterance, intentName, []);
-                    parsedContent.LUISJsonStructure.utterances.push(utteranceObject);
+                    // detect if utterance is a pattern and if so add it as a pattern
+                    if (helpers.isUtterancePattern(utterance)) {
+                        let patternObject = new helperClass.pattern(utterance, intentName);
+                        parsedContent.LUISJsonStructure.patterns.push(patternObject);
+                    } else {
+                        let utteranceObject = new helperClass.uttereances(utterance, intentName, []);
+                        parsedContent.LUISJsonStructure.utterances.push(utteranceObject);    
+                    }
                 }
             }
         }

packages/luis/test/fixtures/verified/Skills/Calendar.json

@@ -14434,11 +14434,6 @@
         }
       ]
     },
-    {
-      "text": "^[(show|display)] next [page] [please]^",
-      "intent": "ShowNextCalendar",
-      "entities": []
-    },
     {
       "text": "bring the previous one",
       "intent": "ShowPreviousCalendar",
@@ -17620,6 +17615,10 @@
       "pattern": "^is (this|the|that) (meeting|conference) room (available|booked) [(at|on|for)] [{FromDate}] [(at|on|for)] [{FromTime}]^",
       "intent": "FindMeetingRoom"
     },
+    {
+      "pattern": "^[(show|display)] next [page] [please]^",
+      "intent": "ShowNextCalendar"
+    },
     {
       "pattern": "^i (want to|need to|would like to) (attend|join) {Subject}, [please] add it.^",
       "intent": "ShowNextCalendar"

packages/luis/test/fixtures/verified/Skills/Email.json

@@ -5981,11 +5981,6 @@
         }
       ]
     },
-    {
-      "text": "^(show|give|tell) [me] [the] next (email|message|mail)^",
-      "intent": "ShowNext",
-      "entities": []
-    },
     {
       "text": "back to the last one from apple",
       "intent": "ShowPrevious",
@@ -6182,11 +6177,6 @@
         }
       ]
     },
-    {
-      "text": "^(show|give|tell) [me] [the] previous (email|message|mail)^",
-      "intent": "ShowPrevious",
-      "entities": []
-    },
     {
       "text": "cancel",
       "intent": "Cancel",
@@ -8905,6 +8895,14 @@
       "pattern": "^(write|send|start) [(a|an|the)] [new] email to {ContactName} (about|on|with) [the subject] [that] {EmailSubject}^",
       "intent": "SendEmail"
     },
+    {
+      "pattern": "^(show|give|tell) [me] [the] next (email|message|mail)^",
+      "intent": "ShowNext"
+    },
+    {
+      "pattern": "^(show|give|tell) [me] [the] previous (email|message|mail)^",
+      "intent": "ShowPrevious"
+    },
     {
       "pattern": "^(yes|sure)[[,]i want (that|the ({DirectionalReference}|{ordinal}) ({number}|one))]",
       "intent": "Confirm"

packages/luis/test/fixtures/verified/Skills/ToDo.json

@@ -4510,11 +4510,6 @@
       "intent": "Cancel",
       "entities": []
     },
-    {
-      "text": "^[(would you|could you|can you)] [please] cancel (previous|current|this) (step|operation)",
-      "intent": "Cancel",
-      "entities": []
-    },
     {
       "text": "confirm all of them",
       "intent": "Confirm",
@@ -6100,11 +6095,6 @@
       "intent": "ShowPreviousPage",
       "entities": []
     },
-    {
-      "text": "^[(can|could|would)] [you] [please] [(show|display|go back to)][the](first|previous)page",
-      "intent": "ShowPreviousPage",
-      "entities": []
-    },
     {
       "text": "access my shopping list",
       "intent": "ShowToDo",
@@ -6837,6 +6827,10 @@
       "pattern": "^[please] (add|put|append) [(items|item)] {FoodOfGrocery} [and] [{FoodOfGrocery}](on|to|in)[(my|the)]{ListType}list",
       "intent": "AddToDo"
     },
+    {
+      "pattern": "^[(would you|could you|can you)] [please] cancel (previous|current|this) (step|operation)",
+      "intent": "Cancel"
+    },
     {
       "pattern": "^(yes|ok|sure), [please][(add|delete|update)] [the] [(item|task|todo item)][(of|about|that)]{TaskContent}",
       "intent": "Confirm"
@@ -6845,6 +6839,10 @@
       "pattern": "^[task][(done|finished|completed)]{TaskContent},[please][(check off|mark it)][as][(done|finished|complete)]",
       "intent": "MarkToDo"
     },
+    {
+      "pattern": "^[(can|could|would)] [you] [please] [(show|display|go back to)][the](first|previous)page",
+      "intent": "ShowPreviousPage"
+    },
     {
       "pattern": "^(what|anything)[do] i (need|should|have to) (buy|shop|purchase) for {TaskContent}",
       "intent": "ShowToDo"

packages/luis/test/fixtures/verified/calendar_all_prebuilt_parsed.json

@@ -12496,11 +12496,6 @@
       "intent": "Calendar.ShowNext",
       "entities": []
     },
-    {
-      "text": "^[(show|display)] next [page] [please]^",
-      "intent": "Calendar.ShowNext",
-      "entities": []
-    },
     {
       "text": "what is the previous",
       "intent": "Calendar.ShowPrevious",
@@ -13023,6 +13018,10 @@
       "pattern": "^(remind|inform|tell) (the|all) attendees {Calendar.Message}^",
       "intent": "Calendar.ContactMeetingAttendees"
     },
+    {
+      "pattern": "^[(show|display)] next [page] [please]^",
+      "intent": "Calendar.ShowNext"
+    },
     {
       "pattern": "^i (want to|need to|would like to) (attend|join) {Calendar.Subject}, [please] add it.^",
       "intent": "Calendar.ShowNext"

packages/luis/test/parser/lufile/parseFileContents.parseFile.test.js

@@ -970,4 +970,16 @@ describe('parseFile correctly parses utterances', function () {
                         .catch(err => done())
         })
 
+        it ('Test for BF CLI #122', function(done){
+                let testLU = `# intent1
+                - [[this]is] a new form (a | b)`;
+
+                parseFile.parseFile(testLU)
+                        .then(res => {
+                                assert.equal(res.LUISJsonStructure.patterns.length, 1);
+                                assert.equal(res.LUISJsonStructure.patterns[0].pattern, '[[this]is] a new form (a | b)');
+                                done();
+                        })
+                        .catch(err => done('Fail! Did not throw when expected'))
+        })
 })