From 0dbbcc452ea3827772ef20d34d5bb07ac29731fd Mon Sep 17 00:00:00 2001
From: Eberhard Beilharz <eb1@sil.org>
Date: Fri, 19 Dec 2025 10:07:29 +0100
Subject: [PATCH] maint(web): escape single quotes in TC service messages

This fixes a problem where TC shows an error because it can't find the
end of the service message for a failed test. Single quotes (and some
other characters) have to be escaped with `|'` inside of a message.

Build-bot: skip:all build:web
Test-bot: skip
---
 common/test/resources/playwright-TC-reporter.ts | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/common/test/resources/playwright-TC-reporter.ts b/common/test/resources/playwright-TC-reporter.ts
index f550a48d2c..8cbc0967e7 100644
--- a/common/test/resources/playwright-TC-reporter.ts
+++ b/common/test/resources/playwright-TC-reporter.ts
@@ -62,6 +62,15 @@ class TestNode {
     TestNode.OpenNodes.push(this.id);
   }
 
+  private escape(message: string): string {
+    // TeamCity escaping rules for: ' | [ ] \n \r \uNNNN
+    // See: https://www.jetbrains.com/help/teamcity/service-messages.html#Escaped+Values
+    return message?.replace(/['|\[\]]/g, (matched) => `|${matched}`)
+      .replace(/\n/g, '|n')
+      .replace(/\r/g, '|r')
+      .replace(/[\u0080-\uFFFF]/g, c => `|0x${c.charCodeAt(0).toString(16).padStart(4, '0')}`) ?? '';
+  }
+
   private getTestResult(result: TestResult): { msgTitle: string, details: string } {
     if (!result) {
       return null;
@@ -72,9 +81,9 @@ class TestNode {
       case 'failed':
       case 'interrupted':
       case 'timedOut':
-        return { msgTitle: 'testFailed', details: `message='${result.error?.message}' details='${result.error?.value ?? result.error?.cause}'` };
+        return { msgTitle: 'testFailed', details: `message='${this.escape(result.error?.message)}' details='${this.escape(result.error?.value ?? result.error?.cause)}'` };
       case 'skipped':
-        return { msgTitle: 'testIgnored', details: `message='${result.annotations?.toString() ?? ''}'` };
+        return { msgTitle: 'testIgnored', details: `message='${this.escape(result.annotations?.toString()) ?? ''}'` };
     }
   }