Change client to always include /documents for root document paths (b…

…ut not when we just need the database name). The v1 protocol now enforces that /documents be included for root document paths.
googleapis · Jan 11, 2019 · 52c7381 · 52c7381
1 parent e5d521b
commit 52c7381
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 19 deletions.
diff --git a/dev/src/index.ts b/dev/src/index.ts
@@ -396,7 +396,11 @@ export class Firestore {
    * @private
    */
   get formattedName(): string {
-    return this._referencePath!.formattedName;
+    const components = [
+      'projects', this._referencePath!.projectId, 'databases',
+      this._referencePath!.databaseId
+    ];
+    return components.join('/');
   }
 
   /**

diff --git a/dev/src/path.ts b/dev/src/path.ts
@@ -343,15 +343,10 @@ export class ResourcePath extends Path<ResourcePath> {
    * @returns {string} The representation as expected by the API.
    */
   canonicalString(): string {
-    let components = [
-      'projects',
-      this.projectId,
-      'databases',
-      this.databaseId,
+    const components = [
+      'projects', this.projectId, 'databases', this.databaseId, 'documents',
+      ...this.segments
     ];
-    if (this.segments.length > 0) {
-      components = components.concat('documents', this.segments);
-    }
     return components.join('/');
   }
 

diff --git a/dev/test/index.ts b/dev/test/index.ts
@@ -679,7 +679,7 @@ describe('listCollections() method', () => {
     const overrides = {
       listCollectionIds: (request, options, callback) => {
         expect(request).to.deep.eq({
-          parent: `projects/${PROJECT_ID}/databases/(default)`,
+          parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
         });
 
         callback(null, ['first', 'second']);

diff --git a/dev/test/path.ts b/dev/test/path.ts
@@ -30,7 +30,7 @@ describe('ResourcePath', () => {
 
   it('has append() method', () => {
     let path = new ResourcePath(PROJECT_ID, '(default)');
-    expect(path.formattedName).to.equal(DATABASE_ROOT);
+    expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents`);
     path = path.append('foo');
     expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents/foo`);
   });
@@ -39,13 +39,13 @@ describe('ResourcePath', () => {
     let path = new ResourcePath(PROJECT_ID, '(default)', 'foo');
     expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents/foo`);
     path = path.parent()!;
-    expect(path.formattedName).to.equal(DATABASE_ROOT);
+    expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents`);
     expect(path.parent()).to.be.null;
   });
 
   it('parses strings', () => {
     let path = ResourcePath.fromSlashSeparatedString(DATABASE_ROOT);
-    expect(path.formattedName).to.equal(DATABASE_ROOT);
+    expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents`);
     path =
         ResourcePath.fromSlashSeparatedString(`${DATABASE_ROOT}/documents/foo`);
     expect(path.formattedName).to.equal(`${DATABASE_ROOT}/documents/foo`);

diff --git a/dev/test/query.ts b/dev/test/query.ts
@@ -229,7 +229,7 @@ function endAt(before: boolean, ...values: Array<string|api.IValue>):
 function queryEquals(
     actual: api.IRunQueryRequest, ...protoComponents: api.IStructuredQuery[]) {
   const query: api.IRunQueryRequest = {
-    parent: DATABASE_ROOT,
+    parent: DATABASE_ROOT + '/documents',
     structuredQuery: {
       from: [
         {

diff --git a/dev/test/transaction.ts b/dev/test/transaction.ts
@@ -177,7 +177,7 @@ function getAll(docs: string[], fieldMask?: string[]) {
 
 function query(transaction?) {
   const request = {
-    parent: DATABASE_ROOT,
+    parent: `${DATABASE_ROOT}/documents`,
     structuredQuery: {
       from: [
         {

diff --git a/dev/test/watch.ts b/dev/test/watch.ts
@@ -526,7 +526,7 @@ describe('Query watch', () => {
       database: `projects/${PROJECT_ID}/databases/(default)`,
       addTarget: {
         query: {
-          parent: `projects/${PROJECT_ID}/databases/(default)`,
+          parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
           structuredQuery: {
             from: [{collectionId: 'col'}],
           },
@@ -546,7 +546,7 @@ describe('Query watch', () => {
       database: `projects/${PROJECT_ID}/databases/(default)`,
       addTarget: {
         query: {
-          parent: `projects/${PROJECT_ID}/databases/(default)`,
+          parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
           structuredQuery: {
             from: [{collectionId: 'col'}],
             where: {
@@ -573,7 +573,7 @@ describe('Query watch', () => {
       database: `projects/${PROJECT_ID}/databases/(default)`,
       addTarget: {
         query: {
-          parent: `projects/${PROJECT_ID}/databases/(default)`,
+          parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
           structuredQuery: {
             from: [{collectionId: 'col'}],
           },
@@ -594,7 +594,7 @@ describe('Query watch', () => {
       database: `projects/${PROJECT_ID}/databases/(default)`,
       addTarget: {
         query: {
-          parent: `projects/${PROJECT_ID}/databases/(default)`,
+          parent: `projects/${PROJECT_ID}/databases/(default)/documents`,
           structuredQuery: {
             from: [{collectionId: 'col'}],
             orderBy: [{direction: 'DESCENDING', field: {fieldPath: 'foo'}}],