[FIX] qweb: properly handle xml comments

src/component/component.ts

@@ -101,7 +101,7 @@ export class Component<T extends Env, Props extends {}> {
   readonly __owl__: Internal<Env, Props>;
   static template?: string | null = null;
   static _template?: string | null = null;
-  static current: Component<any,any> | null = null;
+  static current: Component<any, any> | null = null;
   static components = {};
   static props?: any;
   static defaultProps?: any;

src/qweb/qweb.ts

@@ -104,8 +104,6 @@ const UTILS: Utils = {
 function parseXML(xml: string): Document {
   const parser = new DOMParser();
 
-  // we remove comments from the xml string
-  xml = xml.replace(/<!--[\s\S]*?-->/g, "");
   const doc = parser.parseFromString(xml, "text/xml");
   if (doc.getElementsByTagName("parsererror").length) {
     let msg = "Invalid XML in template.";
@@ -421,7 +419,11 @@ export class QWeb extends EventBus {
         text = text.replace(whitespaceRE, " ");
       }
       if (ctx.parentNode) {
+        if (node.nodeType === 3) {
           ctx.addLine(`c${ctx.parentNode}.push({text: \`${text}\`});`);
+        } else if (node.nodeType === 8) {
+          ctx.addLine(`c${ctx.parentNode}.push(h('!', \`${text}\`));`);
+        }
       } else if (ctx.parentTextNode) {
         ctx.addLine(`vn${ctx.parentTextNode}.text += \`${text}\`;`);
       } else {
@@ -569,7 +571,11 @@ export class QWeb extends EventBus {
     }
   }
 
-  _compileGenericNode(node: ChildNode, ctx: CompilationContext, withHandlers: boolean = true): number {
+  _compileGenericNode(
+    node: ChildNode,
+    ctx: CompilationContext,
+    withHandlers: boolean = true
+  ): number {
     // nodeType 1 is generic tag
     if (node.nodeType !== 1) {
       throw new Error("unsupported node type");

tests/qweb/__snapshots__/qweb.test.ts.snap

@@ -771,13 +771,15 @@ exports[`static templates empty div 1`] = `
 }"
 `;
 
-exports[`static templates ignore comments 1`] = `
+exports[`static templates properly handle comments 1`] = `
 "function anonymous(context,extra
 ) {
     var h = this.h;
     let c1 = [], p1 = {key:1};
     var vn1 = h('div', p1, c1);
-    c1.push({text: \`hello owl\`});
+    c1.push({text: \`hello \`});
+    c1.push(h('!', \` comment\`));
+    c1.push({text: \`owl\`});
     return vn1;
 }"
 `;

tests/qweb/qweb.test.ts

@@ -50,9 +50,9 @@ describe("static templates", () => {
     expect(renderToString(qweb, "test")).toBe("<div><span>word</span></div>");
   });
 
-  test("ignore comments", () => {
+  test("properly handle comments", () => {
     qweb.addTemplate("test", "<div>hello <!-- comment-->owl</div>");
-    expect(renderToString(qweb, "test")).toBe("<div>hello owl</div>");
+    expect(renderToString(qweb, "test")).toBe("<div>hello <!-- comment-->owl</div>");
   });
 });