Properly escape field paths (#4148)

firebase · Dec 2, 2020 · 1849b0d · 1849b0d
1 parent 772c4d1
commit 1849b0d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/.changeset/afraid-socks-shop.md b/.changeset/afraid-socks-shop.md
@@ -0,0 +1,5 @@
+---
+"@firebase/firestore": patch
+---
+
+Fixed a bug that prevented usage of FieldPaths with multiple special characters.
diff --git a/packages/firestore/src/model/path.ts b/packages/firestore/src/model/path.ts
@@ -265,7 +265,7 @@ export class FieldPath extends BasePath<FieldPath> {
   canonicalString(): string {
     return this.toArray()
       .map(str => {
-        str = str.replace('\\', '\\\\').replace('`', '\\`');
+        str = str.replace(/\\/g, '\\\\').replace(/`/g, '\\`');
         if (!FieldPath.isValidIdentifier(str)) {
           str = '`' + str + '`';
         }

diff --git a/packages/firestore/src/remote/rpc_error.ts b/packages/firestore/src/remote/rpc_error.ts
@@ -314,7 +314,7 @@ export function mapCodeFromHttpStatus(status?: number): Code {
  *     Code.UNKNOWN.
  */
 export function mapCodeFromHttpResponseErrorStatus(status: string): Code {
-  const serverError = status.toLowerCase().replace('_', '-');
+  const serverError = status.toLowerCase().replace(/_/g, '-');
   return Object.values(Code).indexOf(serverError as Code) >= 0
     ? (serverError as Code)
     : Code.UNKNOWN;

diff --git a/packages/firestore/test/unit/model/path.test.ts b/packages/firestore/test/unit/model/path.test.ts
@@ -160,6 +160,11 @@ describe('Path', () => {
     expect(abc.isPrefixOf(ba)).to.equal(false);
   });
 
+  it('escapes FieldPath with segments', () => {
+    const path = new FieldPath(['\\foo\\.`bar`']);
+    expect(path.canonicalString()).to.equal('`\\\\foo\\\\.\\`bar\\``');
+  });
+
   it('can be constructed from field path.', () => {
     const path = FieldPath.fromServerFormat('foo\\..bar\\\\.baz');
     expect(path.toArray()).to.deep.equal(['foo.', 'bar\\', 'baz']);