Merge pull request #834 from Speech-Rule-Engine/fix/link_output

zorkow · web-flow · commit f447e15508e6 · 2025-12-10T20:02:39.000+01:00
ensure consistent output of link postfix for label, ssml, root node
diff --git a/testsuite/README.md b/testsuite/README.md
@@ -359,7 +359,7 @@ REPL. There are two ways to ensure that all the necessary files in SRE can be fo
 
     ``` javascript
     process.env['SRE_JSON_PATH'] = '../lib/mathmaps';
-    (await import('./js/module_loader.js')).load('gt');
+    const gt = await (await import('./js/module_loader.js')).loadPromise('gt');
     ...
     ```
 
diff --git a/testsuite/expected/semantic/deep_speech/href.json b/testsuite/expected/semantic/deep_speech/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "deepSpeech",
+  "tests": "ALL",
+  "information": "Deep speech href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/expected/semantic/enrich_mathml/href.json b/testsuite/expected/semantic/enrich_mathml/href.json
@@ -0,0 +1,29 @@
+{
+  "factory": "enrichMathml",
+  "active": "EnrichExamples",
+  "information": "Enrich mathml href tests.",
+  "base": "input/semantic/href.json",
+  "tests": {
+    "href_0": {
+      "expected": "<math><mi href=\"a\" type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" attributes=\"href:a\" postfix=\"link\">a</mi></math>"
+    },
+    "href_1": {
+      "expected": "<math><mrow href=\"c\" type=\"infixop\" role=\"addition\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\"><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\">a</mi><mo type=\"operator\" role=\"addition\" id=\"1\" parent=\"3\" operator=\"infixop,+\">+</mo><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\">b</mi></mrow></math>"
+    },
+    "href_2": {
+      "expected": "<math type=\"infixop\" role=\"addition\" id=\"3\" children=\"0,2\" content=\"1\"><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\">a</mi><mo href=\"c\" type=\"operator\" role=\"addition\" id=\"1\" parent=\"3\" attributes=\"href:c\" postfix=\"link\" operator=\"infixop,+\">+</mo><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\">b</mi></math>"
+    },
+    "href_3": {
+      "expected": "<math type=\"infixop\" role=\"addition\" id=\"3\" children=\"0,2\" content=\"1\"><mi href=\"a\" type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" attributes=\"href:a\" postfix=\"link\">a</mi><mo type=\"operator\" role=\"addition\" id=\"1\" parent=\"3\" operator=\"infixop,+\">+</mo><mi href=\"b\" type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" attributes=\"href:b\" postfix=\"link\">b</mi></math>"
+    },
+    "href_4": {
+      "expected": "<math><mrow href=\"c\" type=\"infixop\" role=\"addition\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\"><mi href=\"a\" type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" attributes=\"href:a\" postfix=\"link\">a</mi><mo type=\"operator\" role=\"addition\" id=\"1\" parent=\"3\" operator=\"infixop,+\">+</mo><mi href=\"b\" type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" attributes=\"href:b\" postfix=\"link\">b</mi></mrow></math>"
+    },
+    "href_5": {
+      "expected": "<math href=\"a\"><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" attributes=\"href:a\" postfix=\"link\">a</mi></math>"
+    },
+    "href_6": {
+      "expected": "<math href=\"c\"><mrow type=\"infixop\" role=\"addition\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\"><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\">a</mi><mo type=\"operator\" role=\"addition\" id=\"1\" parent=\"3\" operator=\"infixop,+\">+</mo><mi type=\"identifier\" role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\">b</mi></mrow></math>"
+    }
+  }
+}
diff --git a/testsuite/expected/semantic/enrich_speech/href.json b/testsuite/expected/semantic/enrich_speech/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "enrichSpeech",
+  "tests": "ALL",
+  "information": "Enrich speech href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/expected/semantic/enrich_structure/href.json b/testsuite/expected/semantic/enrich_structure/href.json
@@ -0,0 +1,28 @@
+{
+  "factory": "enrichStructure",
+  "information": "Enrich structure href tests.",
+  "base": "input/semantic/href.json",
+  "tests": {
+    "href_0": {
+      "expected": "<math structure=\"0\"><mi href=\"a\" type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" attributes=\"href:a\" postfix=\"link\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\">a</mi></math>"
+    },
+    "href_1": {
+      "expected": "<math structure=\"(3 0 1 2)\"><mrow href=\"c\" type=\"infixop\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\" owns=\"0 1 2\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\" aria-owns=\"0 1 2\"><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" aria-level=\"1\" aria-posinset=\"1\" aria-setsize=\"3\" role=\"treeitem\">a</mi><mo type=\"operator\" id=\"1\" parent=\"3\" operator=\"infixop,+\" aria-level=\"1\" aria-posinset=\"2\" aria-setsize=\"3\" role=\"treeitem\">+</mo><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" aria-level=\"1\" aria-posinset=\"3\" aria-setsize=\"3\" role=\"treeitem\">b</mi></mrow></math>"
+    },
+    "href_2": {
+      "expected": "<math type=\"infixop\" id=\"3\" children=\"0,2\" content=\"1\" owns=\"0 1 2\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\" aria-owns=\"0 1 2\" structure=\"(3 0 1 2)\"><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" aria-level=\"1\" aria-posinset=\"1\" aria-setsize=\"3\" role=\"treeitem\">a</mi><mo href=\"c\" type=\"operator\" id=\"1\" parent=\"3\" attributes=\"href:c\" postfix=\"link\" operator=\"infixop,+\" aria-level=\"1\" aria-posinset=\"2\" aria-setsize=\"3\" role=\"treeitem\">+</mo><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" aria-level=\"1\" aria-posinset=\"3\" aria-setsize=\"3\" role=\"treeitem\">b</mi></math>"
+    },
+    "href_3": {
+      "expected": "<math type=\"infixop\" id=\"3\" children=\"0,2\" content=\"1\" owns=\"0 1 2\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\" aria-owns=\"0 1 2\" structure=\"(3 0 1 2)\"><mi href=\"a\" type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" attributes=\"href:a\" postfix=\"link\" aria-level=\"1\" aria-posinset=\"1\" aria-setsize=\"3\" role=\"treeitem\">a</mi><mo type=\"operator\" id=\"1\" parent=\"3\" operator=\"infixop,+\" aria-level=\"1\" aria-posinset=\"2\" aria-setsize=\"3\" role=\"treeitem\">+</mo><mi href=\"b\" type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" attributes=\"href:b\" postfix=\"link\" aria-level=\"1\" aria-posinset=\"3\" aria-setsize=\"3\" role=\"treeitem\">b</mi></math>"
+    },
+    "href_4": {
+      "expected": "<math structure=\"(3 0 1 2)\"><mrow href=\"c\" type=\"infixop\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\" owns=\"0 1 2\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\" aria-owns=\"0 1 2\"><mi href=\"a\" type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" attributes=\"href:a\" postfix=\"link\" aria-level=\"1\" aria-posinset=\"1\" aria-setsize=\"3\" role=\"treeitem\">a</mi><mo type=\"operator\" id=\"1\" parent=\"3\" operator=\"infixop,+\" aria-level=\"1\" aria-posinset=\"2\" aria-setsize=\"3\" role=\"treeitem\">+</mo><mi href=\"b\" type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" attributes=\"href:b\" postfix=\"link\" aria-level=\"1\" aria-posinset=\"3\" aria-setsize=\"3\" role=\"treeitem\">b</mi></mrow></math>"
+    },
+    "href_5": {
+      "expected": "<math href=\"a\" structure=\"0\"><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" attributes=\"href:a\" postfix=\"link\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\">a</mi></math>"
+    },
+    "href_6": {
+      "expected": "<math href=\"c\" structure=\"(3 0 1 2)\"><mrow type=\"infixop\" id=\"3\" children=\"0,2\" content=\"1\" attributes=\"href:c\" postfix=\"link\" owns=\"0 1 2\" aria-level=\"0\" aria-posinset=\"1\" aria-setsize=\"1\" role=\"treeitem\" aria-owns=\"0 1 2\"><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" parent=\"3\" aria-level=\"1\" aria-posinset=\"1\" aria-setsize=\"3\" role=\"treeitem\">a</mi><mo type=\"operator\" id=\"1\" parent=\"3\" operator=\"infixop,+\" aria-level=\"1\" aria-posinset=\"2\" aria-setsize=\"3\" role=\"treeitem\">+</mo><mi type=\"identifier\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" parent=\"3\" aria-level=\"1\" aria-posinset=\"3\" aria-setsize=\"3\" role=\"treeitem\">b</mi></mrow></math>"
+    }
+  }
+}
diff --git a/testsuite/expected/semantic/rebuild_enriched/href.json b/testsuite/expected/semantic/rebuild_enriched/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "rebuildEnriched",
+  "tests": "ALL",
+  "information": "Rebuild enriched href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/expected/semantic/rebuild_stree/href.json b/testsuite/expected/semantic/rebuild_stree/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "rebuild",
+  "tests": "ALL",
+  "information": "Rebuild stree href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/expected/semantic/semantic_api/href.json b/testsuite/expected/semantic/semantic_api/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "semanticApi",
+  "tests": "ALL",
+  "information": "Semantic api href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/expected/semantic/semantic_exploration/href.json b/testsuite/expected/semantic/semantic_exploration/href.json
@@ -0,0 +1,53 @@
+{
+  "factory": "semanticExploration",
+  "information": "Semantic exploration href tests.",
+  "base": "input/semantic/href.json",
+  "tests": {
+    "href_0": {
+      "expected": 0
+    },
+    "href_1": {
+      "expected": [
+        3,
+        0,
+        1,
+        2
+      ]
+    },
+    "href_2": {
+      "expected": [
+        3,
+        0,
+        1,
+        2
+      ]
+    },
+    "href_3": {
+      "expected": [
+        3,
+        0,
+        1,
+        2
+      ]
+    },
+    "href_4": {
+      "expected": [
+        3,
+        0,
+        1,
+        2
+      ]
+    },
+    "href_5": {
+      "expected": 0
+    },
+    "href_6": {
+      "expected": [
+        3,
+        0,
+        1,
+        2
+      ]
+    }
+  }
+}
diff --git a/testsuite/expected/semantic/semantic_tree/href.json b/testsuite/expected/semantic/semantic_tree/href.json
@@ -0,0 +1,28 @@
+{
+  "factory": "stree",
+  "information": "Semantic tree href tests.",
+  "base": "input/semantic/href.json",
+  "tests": {
+    "href_0": {
+      "expected": "<stree><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" href=\"a\">a</identifier></stree>"
+    },
+    "href_1": {
+      "expected": "<stree><infixop role=\"addition\" id=\"3\" href=\"c\">+<content><operator role=\"addition\" id=\"1\">+</operator></content><children><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\">a</identifier><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\">b</identifier></children></infixop></stree>"
+    },
+    "href_2": {
+      "expected": "<stree><infixop role=\"addition\" id=\"3\">+<content><operator role=\"addition\" id=\"1\" href=\"c\">+</operator></content><children><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\">a</identifier><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\">b</identifier></children></infixop></stree>"
+    },
+    "href_3": {
+      "expected": "<stree><infixop role=\"addition\" id=\"3\">+<content><operator role=\"addition\" id=\"1\">+</operator></content><children><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" href=\"a\">a</identifier><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" href=\"b\">b</identifier></children></infixop></stree>"
+    },
+    "href_4": {
+      "expected": "<stree><infixop role=\"addition\" id=\"3\" href=\"c\">+<content><operator role=\"addition\" id=\"1\">+</operator></content><children><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" href=\"a\">a</identifier><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\" href=\"b\">b</identifier></children></infixop></stree>"
+    },
+    "href_5": {
+      "expected": "<stree><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\" href=\"a\">a</identifier></stree>"
+    },
+    "href_6": {
+      "expected": "<stree><infixop role=\"addition\" id=\"3\" href=\"c\">+<content><operator role=\"addition\" id=\"1\">+</operator></content><children><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"0\">a</identifier><identifier role=\"latinletter\" font=\"italic\" annotation=\"clearspeak:simple\" id=\"2\">b</identifier></children></infixop></stree>"
+    }
+  }
+}
diff --git a/testsuite/expected/semantic/semantic_xml/href.json b/testsuite/expected/semantic/semantic_xml/href.json
@@ -0,0 +1,6 @@
+{
+  "factory": "semanticXml",
+  "tests": "ALL",
+  "information": "Semantic xml href tests.",
+  "base": "input/semantic/href.json"
+}
diff --git a/testsuite/input/semantic/href.json b/testsuite/input/semantic/href.json
@@ -0,0 +1,32 @@
+{
+  "tests": {
+    "href_0": {
+      "tex": "\\href{a}{a}",
+      "input": "<mi href=\"a\">a</mi>"
+    },
+    "href_1": {
+      "tex": "\\href{c}{a + b}",
+      "input": "<mrow href=\"c\"><mi>a</mi><mo>+</mo><mi>b</mi></mrow>"
+    },
+    "href_2": {
+      "tex": "a \\href{c}{+} b",
+      "input": "<mi>a</mi><mo href=\"c\">+</mo><mi>b</mi>"
+    },
+    "href_3": {
+      "tex": "\\href{a}{a} + \\href{b}{b}",
+      "input": "<mi href=\"a\">a</mi><mo>+</mo><mi href=\"b\">b</mi>"
+    },
+    "href_4": {
+      "tex": "\\href{c}{\\href{a}{a} + \\href{b}{b}}",
+      "input": "<mrow href=\"c\"><mi href=\"a\">a</mi><mo>+</mo><mi href=\"b\">b</mi></mrow>"
+    },
+    "href_5": {
+      "tex": "\\href{a}{a}",
+      "input": "<math href=\"a\"><mi>a</mi></math>"
+    },
+    "href_6": {
+      "tex": "\\href{c}{a + b}",
+      "input": "<math href=\"c\"><mrow><mi>a</mi><mo>+</mo><mi>b</mi></mrow></math>"
+    }
+  }
+}
diff --git a/testsuite/ts/generate/generate_tests.ts b/testsuite/ts/generate/generate_tests.ts
@@ -243,8 +243,13 @@ function generateFromIssues(
 }
 
 
-function generateFromLines(lines: string[],
-                           properties: string[], tests: tu.JsonTests) {
+function generateFromLines(
+  lines: string[],
+  properties: string[],
+  tests: tu.JsonTests,
+  basename: string
+) {
+  let nameCount = 0;
   let commentCount = 0;
   while (lines.length) {
     let name = lines.shift();
@@ -253,6 +258,10 @@ function generateFromLines(lines: string[],
       tests[`_comment${commentCount++}_`] = lines.shift() as any;
       continue;
     }
+    if (basename) {
+      lines.unshift(name);
+      name = `${basename}_${nameCount++}`;
+    }
     if (tests[name]) {
       console.warn('Duplicate entry for ' + name);
     }
@@ -312,17 +321,19 @@ export function fromIssues(dir: string, file: string, output: string) {
  * @param input The input file.
  * @param output The output filename for the target tests.
  * @param properties An ordered list of properties to be parsed.
+ * @param name If true, test names default to the basename of input file.
  */
 export function fromLines(
-  input: string, output: string, properties: string[]) {
+  input: string, output: string, properties: string[], name = false) {
   let data: string[];
   try {
     data = fs.readFileSync(input, { encoding: 'utf-8' }).split(/\r?\n/);
   } catch (_err) {
     console.error(`File ${input} does not exist.`);
   }
   appendTests(output,
-             tests => generateFromLines(data, properties, tests));
+              tests => generateFromLines(
+                data, properties, tests, name ? path.parse(input).name : ''));
 }
 
 
diff --git a/ts/common/processor_factory.ts b/ts/common/processor_factory.ts
@@ -529,13 +529,21 @@ export function assembleSpeechStructure(
   json.mactions = SpeechGeneratorUtil.connectMactionSelections(mml, sxml);
   json.speech = SpeechGeneratorUtil.computeSpeechStructure(sxml);
   const root = (sxml.childNodes[0] as Element)?.getAttribute('id');
-  json.label = json.speech[root]['speech-none'] + '';
-  json.ssml = json.speech[root]['speech-ssml'];
-  json.translations = Object.assign({}, LOCALE.MESSAGES.navigate);
+  // Here we have to add the postfix correctly and then ensure that it is also
+  // added to the label and ssml output.
   const links = DomUtil.querySelectorAllByAttr(sxml, 'href').length;
   if (links) {
-    json.label += `, ${links} ${links === 1 ? 'link' : 'links'}`;
+    const text = `${links} ${links === 1 ? 'link' : 'links'}`;
+    json.speech[root]['postfix-none'] = json.speech[root]['postfix-none'] ?
+      json.speech[root]['postfix-none'] + `, ${text}` : text;
+    json.speech[root]['postfix-ssml'] = json.speech[root]['postfix-ssml'] ?
+      json.speech[root]['postfix-ssml'] + ` <break time="250ms"/> ${text}` : text;
   }
+  json.label = json.speech[root]['speech-none'] +
+    (json.speech[root]['postfix-none'] ?
+      `, ${json.speech[root]['postfix-none']}` :  '');
+  json.ssml = json.speech[root]['speech-ssml'] +
+    (json.speech[root]['postfix-ssml'] ?
+      ` <prosody pitch="+30%" rate="+20%"> ${json.speech[root]['postfix-ssml']} </prosody>` :  '');
+  json.translations = Object.assign({}, LOCALE.MESSAGES.navigate);
 }
-// ./bin/sre -T -P -k ssml -d clearspeak < ../sre-resources/samples/quadratic-line.xml
-// echo "<math><mi>a</mi><mi>b</mi></math>" | ./bin/sre -T -P -d clearspeak
