From ab4f953c78d444cbc6c77836f9c4aa9440026bd2 Mon Sep 17 00:00:00 2001
From: Pete Bacon Darwin <pete@bacondarwin.com>
Date: Fri, 4 Sep 2020 15:16:12 +0100
Subject: [PATCH] fix(localize): render location in XLIFF 2 even if there is no
 metadata (#38713)

Previously, the location of a translation message, in XLIFF 2, was only
rendered if there were also notes for meaning or description. Now the
location will be rendered even if the other metadata is not provided.

Fixes #38705

PR Close #38713
---
 .../xliff2_translation_serializer.ts           |  2 +-
 .../test/extract/integration/main_spec.ts      | 18 ++++++++++++++++++
 .../xliff1_translation_serializer_spec.ts      | 14 ++++++++++++++
 .../xliff2_translation_serializer_spec.ts      | 15 +++++++++++++++
 4 files changed, 48 insertions(+), 1 deletion(-)

diff --git a/packages/localize/src/tools/src/extract/translation_files/xliff2_translation_serializer.ts b/packages/localize/src/tools/src/extract/translation_files/xliff2_translation_serializer.ts
index 4dd7e4f4a2824..6dafa6a5d5dc6 100644
--- a/packages/localize/src/tools/src/extract/translation_files/xliff2_translation_serializer.ts
+++ b/packages/localize/src/tools/src/extract/translation_files/xliff2_translation_serializer.ts
@@ -51,7 +51,7 @@ export class Xliff2TranslationSerializer implements TranslationSerializer {
       }
       ids.add(id);
       xml.startTag('unit', {id});
-      if (message.meaning || message.description) {
+      if (message.meaning || message.description || message.location) {
         xml.startTag('notes');
         if (message.location) {
           const {file, start, end} = message.location;
diff --git a/packages/localize/src/tools/test/extract/integration/main_spec.ts b/packages/localize/src/tools/test/extract/integration/main_spec.ts
index 3f69a2d22f215..07f89aa5c4540 100644
--- a/packages/localize/src/tools/test/extract/integration/main_spec.ts
+++ b/packages/localize/src/tools/test/extract/integration/main_spec.ts
@@ -220,31 +220,49 @@ runInEachFileSystem(() => {
             `<xliff version="2.0" xmlns="urn:oasis:names:tc:xliff:document:2.0" srcLang="en-AU">`,
             `  <file id="ngi18n" original="ng.template">`,
             `    <unit id="3291030485717846467">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:2</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>Hello, <ph id="0" equiv="PH" disp="name"/>!</source>`,
             `      </segment>`,
             `    </unit>`,
             `    <unit id="8669027859022295761">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:3</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>try<ph id="0" equiv="PH" disp="40 + 2"/>me</source>`,
             `      </segment>`,
             `    </unit>`,
             `    <unit id="custom-id">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:4</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>Custom id message</source>`,
             `      </segment>`,
             `    </unit>`,
             `    <unit id="${useLegacyIds ? '12345678901234567890' : '273296103957933077'}">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:6</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>Legacy id message</source>`,
             `      </segment>`,
             `    </unit>`,
             `    <unit id="custom-id-2">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:8</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>Custom and legacy message</source>`,
             `      </segment>`,
             `    </unit>`,
             `    <unit id="2932901491976224757">`,
+            `      <notes>`,
+            `        <note category="location">test_files/test.js:9,10</note>`,
+            `      </notes>`,
             `      <segment>`,
             `        <source>pre<pc id="0" equivStart="START_TAG_SPAN" equivEnd="CLOSE_TAG_SPAN" dispStart="&apos;&lt;span&gt;&apos;" dispEnd="&apos;&lt;/span&gt;&apos;">` +
                 `inner-pre<pc id="1" equivStart="START_BOLD_TEXT" equivEnd="CLOSE_BOLD_TEXT" dispStart="&apos;&lt;b&gt;&apos;" dispEnd="&apos;&lt;/b&gt;&apos;">bold</pc>` +
diff --git a/packages/localize/src/tools/test/extract/translation_files/xliff1_translation_serializer_spec.ts b/packages/localize/src/tools/test/extract/translation_files/xliff1_translation_serializer_spec.ts
index f421850a3270e..4a9e8baa89594 100644
--- a/packages/localize/src/tools/test/extract/translation_files/xliff1_translation_serializer_spec.ts
+++ b/packages/localize/src/tools/test/extract/translation_files/xliff1_translation_serializer_spec.ts
@@ -49,6 +49,13 @@ runInEachFileSystem(() => {
             mockMessage(
                 '67890', ['a', '', 'c'], ['START_TAG_SPAN', 'CLOSE_TAG_SPAN'],
                 {description: 'some description'}),
+            mockMessage('38705', ['a', '', 'c'], ['START_TAG_SPAN', 'CLOSE_TAG_SPAN'], {
+              location: {
+                file: absoluteFrom('/project/file.ts'),
+                start: {line: 2, column: 7},
+                end: {line: 3, column: 2}
+              }
+            }),
             mockMessage('13579', ['', 'b', ''], ['START_BOLD_TEXT', 'CLOSE_BOLD_TEXT'], {}),
             mockMessage('24680', ['a'], [], {meaning: 'meaning', description: 'and description'}),
             mockMessage('80808', ['multi\nlines'], [], {}),
@@ -91,6 +98,13 @@ runInEachFileSystem(() => {
             `        <source>a<x id="START_TAG_SPAN"/><x id="CLOSE_TAG_SPAN"/>c</source>`,
             `        <note priority="1" from="description">some description</note>`,
             `      </trans-unit>`,
+            `      <trans-unit id="38705" datatype="html">`,
+            `        <source>a<x id="START_TAG_SPAN"/><x id="CLOSE_TAG_SPAN"/>c</source>`,
+            `        <context-group purpose="location">`,
+            `          <context context-type="sourcefile">file.ts</context>`,
+            `          <context context-type="linenumber">3,4</context>`,
+            `        </context-group>`,
+            `      </trans-unit>`,
             `      <trans-unit id="13579" datatype="html">`,
             `        <source><x id="START_BOLD_TEXT"/>b<x id="CLOSE_BOLD_TEXT"/></source>`,
             `      </trans-unit>`,
diff --git a/packages/localize/src/tools/test/extract/translation_files/xliff2_translation_serializer_spec.ts b/packages/localize/src/tools/test/extract/translation_files/xliff2_translation_serializer_spec.ts
index d783e0ce9f914..d01b6d0ca3f40 100644
--- a/packages/localize/src/tools/test/extract/translation_files/xliff2_translation_serializer_spec.ts
+++ b/packages/localize/src/tools/test/extract/translation_files/xliff2_translation_serializer_spec.ts
@@ -54,6 +54,13 @@ runInEachFileSystem(() => {
                 end: {line: 3, column: 2}
               }
             }),
+            mockMessage('location-only', ['a', '', 'c'], ['START_TAG_SPAN', 'CLOSE_TAG_SPAN'], {
+              location: {
+                file: absoluteFrom('/project/file.ts'),
+                start: {line: 2, column: 7},
+                end: {line: 3, column: 2}
+              }
+            }),
             mockMessage('13579', ['', 'b', ''], ['START_BOLD_TEXT', 'CLOSE_BOLD_TEXT'], {}),
             mockMessage('24680', ['a'], [], {meaning: 'meaning', description: 'and description'}),
             mockMessage('80808', ['multi\nlines'], [], {}),
@@ -101,6 +108,14 @@ runInEachFileSystem(() => {
             `        <source>a<pc id="0" equivStart="START_TAG_SPAN" equivEnd="CLOSE_TAG_SPAN"></pc>c</source>`,
             `      </segment>`,
             `    </unit>`,
+            `    <unit id="location-only">`,
+            `      <notes>`,
+            `        <note category="location">file.ts:3,4</note>`,
+            `      </notes>`,
+            `      <segment>`,
+            `        <source>a<pc id="0" equivStart="START_TAG_SPAN" equivEnd="CLOSE_TAG_SPAN"></pc>c</source>`,
+            `      </segment>`,
+            `    </unit>`,
             `    <unit id="13579">`,
             `      <segment>`,
             `        <source><pc id="0" equivStart="START_BOLD_TEXT" equivEnd="CLOSE_BOLD_TEXT">b</pc></source>`,