From a9025f70ba765fc85a4af0c4d50b925d594ef898 Mon Sep 17 00:00:00 2001
From: Harry Hogg <hhogg@spotify.com>
Date: Thu, 14 Oct 2021 13:30:43 +0100
Subject: [PATCH] fix(rootLogger): Added util for escaping a regular expression

Signed-off-by: Harry Hogg <hhogg@spotify.com>
---
 .../src/util/escapeRegExp.test.ts             | 80 +++++++++++++++++++
 .../backend-common/src/util/escapeRegExp.ts   | 24 ++++++
 2 files changed, 104 insertions(+)
 create mode 100644 packages/backend-common/src/util/escapeRegExp.test.ts
 create mode 100644 packages/backend-common/src/util/escapeRegExp.ts

diff --git a/packages/backend-common/src/util/escapeRegExp.test.ts b/packages/backend-common/src/util/escapeRegExp.test.ts
new file mode 100644
index 0000000000..60b12739b3
--- /dev/null
+++ b/packages/backend-common/src/util/escapeRegExp.test.ts
@@ -0,0 +1,80 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { escapeRegExp } from './escapeRegExp';
+
+describe('escapeRegExp', () => {
+  test('all the characters', () => {
+    expect(escapeRegExp('^$\\.*+?()[]{}|')).toBe(
+      '\\^\\$\\\\\\.\\*\\+\\?\\(\\)\\[\\]\\{\\}\\|',
+    );
+  });
+
+  test('character: ^', () => {
+    expect(escapeRegExp('^')).toBe('\\^');
+  });
+
+  test('character: $', () => {
+    expect(escapeRegExp('$')).toBe('\\$');
+  });
+
+  test('character: \\', () => {
+    expect(escapeRegExp('\\')).toBe('\\\\');
+  });
+
+  test('character: .', () => {
+    expect(escapeRegExp('.')).toBe('\\.');
+  });
+
+  test('character: *', () => {
+    expect(escapeRegExp('*')).toBe('\\*');
+  });
+
+  test('character: +', () => {
+    expect(escapeRegExp('+')).toBe('\\+');
+  });
+
+  test('character: ?', () => {
+    expect(escapeRegExp('?')).toBe('\\?');
+  });
+
+  test('character: (', () => {
+    expect(escapeRegExp('(')).toBe('\\(');
+  });
+
+  test('character: )', () => {
+    expect(escapeRegExp(')')).toBe('\\)');
+  });
+
+  test('character: [', () => {
+    expect(escapeRegExp('[')).toBe('\\[');
+  });
+
+  test('character: ]', () => {
+    expect(escapeRegExp(']')).toBe('\\]');
+  });
+
+  test('character: {', () => {
+    expect(escapeRegExp('{')).toBe('\\{');
+  });
+
+  test('character: }', () => {
+    expect(escapeRegExp('}')).toBe('\\}');
+  });
+
+  test('character: |', () => {
+    expect(escapeRegExp('|')).toBe('\\|');
+  });
+});
diff --git a/packages/backend-common/src/util/escapeRegExp.ts b/packages/backend-common/src/util/escapeRegExp.ts
new file mode 100644
index 0000000000..58a8d2da15
--- /dev/null
+++ b/packages/backend-common/src/util/escapeRegExp.ts
@@ -0,0 +1,24 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Escapes a given string to be used inside a RegExp.
+ *
+ * Taken from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+ */
+export const escapeRegExp = (text: string) => {
+  return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+};