Code cleanup: string[] replaced with ResourcePath.

Author: MarkDuckworth

packages/firestore/src/model/path.ts

@@ -215,6 +215,15 @@ export class ResourcePath extends BasePath<ResourcePath> {
     return this.canonicalString();
   }
 
+  /**
+   * Returns a string representation of this path
+   * where each path segment has been encoded with
+   * `encodeURIComponent`.
+   */
+  toUriEncodedString(): string {
+    return this.toArray().map(encodeURIComponent).join('/');
+  }
+
   /**
    * Creates a resource path from the given slash-delimited string. If multiple
    * arguments are provided, all components are combined. Leading and trailing

packages/firestore/src/platform/node/grpc_connection.ts

@@ -22,6 +22,7 @@ import * as grpc from '@grpc/grpc-js';
 import { Token } from '../../api/credentials';
 import { DatabaseInfo } from '../../core/database_info';
 import { SDK_VERSION } from '../../core/version';
+import { ResourcePath } from '../../model/path';
 import { Connection, Stream } from '../../remote/connection';
 import { mapCodeFromRpcCode } from '../../remote/rpc_error';
 import { StreamBridge } from '../../remote/stream_bridge';
@@ -114,7 +115,7 @@ export class GrpcConnection implements Connection {
 
   invokeRPC<Req, Resp>(
     rpcName: string,
-    path: string[],
+    path: ResourcePath,
     request: Req,
     authToken: Token | null,
     appCheckToken: Token | null
@@ -166,7 +167,7 @@ export class GrpcConnection implements Connection {
 
   invokeStreamingRPC<Req, Resp>(
     rpcName: string,
-    path: string[],
+    path: ResourcePath,
     request: Req,
     authToken: Token | null,
     appCheckToken: Token | null,

packages/firestore/src/remote/connection.ts

@@ -16,6 +16,7 @@
  */
 
 import { Token } from '../api/credentials';
+import { ResourcePath } from '../model/path';
 import { FirestoreError } from '../util/error';
 
 /**
@@ -46,7 +47,7 @@ export interface Connection {
    */
   invokeRPC<Req, Resp>(
     rpcName: string,
-    path: string[],
+    path: ResourcePath,
     request: Req,
     authToken: Token | null,
     appCheckToken: Token | null
@@ -67,7 +68,7 @@ export interface Connection {
    */
   invokeStreamingRPC<Req, Resp>(
     rpcName: string,
-    path: string[],
+    path: ResourcePath,
     request: Req,
     authToken: Token | null,
     appCheckToken: Token | null,

packages/firestore/src/remote/rest_connection.ts

@@ -22,6 +22,7 @@ import {
   DatabaseInfo,
   DEFAULT_DATABASE_NAME
 } from '../core/database_info';
+import { ResourcePath } from '../model/path';
 import { debugAssert } from '../util/assert';
 import { generateUniqueDebugId } from '../util/debug_uid';
 import { FirestoreError } from '../util/error';
@@ -82,7 +83,7 @@ export abstract class RestConnection implements Connection {
 
   invokeRPC<Req, Resp>(
     rpcName: string,
-    path: string[],
+    path: ResourcePath,
     req: Req,
     authToken: Token | null,
     appCheckToken: Token | null

packages/firestore/test/unit/remote/datastore.test.ts

@@ -24,6 +24,7 @@ import {
   Token
 } from '../../../src/api/credentials';
 import { DatabaseId } from '../../../src/core/database_info';
+import { ResourcePath } from '../../../src/model/path';
 import { Connection, Stream } from '../../../src/remote/connection';
 import {
   Datastore,
@@ -49,7 +50,7 @@ describe('Datastore', () => {
 
     invokeRPC<Req, Resp>(
       rpcName: string,
-      path: string[],
+      path: ResourcePath,
       request: Req,
       token: Token | null
     ): Promise<Resp> {
@@ -58,7 +59,7 @@ describe('Datastore', () => {
 
     invokeStreamingRPC<Req, Resp>(
       rpcName: string,
-      path: string[],
+      path: ResourcePath,
       request: Req,
       token: Token | null
     ): Promise<Resp[]> {