add non-authentication impersonate unit tests

Author: stephenarosaj

src/data-connect/data-connect-api-client-internal.ts

@@ -143,32 +143,6 @@ export class DataConnectApiClient {
       });
   }
 
-  /**
-   * Makes a GraphQL request to the specified url.
-   *
-   * @param url - The URL to send the request to.
-   * @param data - The GraphQL request payload.
-   * @returns A promise that fulfills with the GraphQL response, or throws an error.
-   */
-  private async makeGqlRequest<GraphqlResponse>(url: string, data: object): 
-  Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
-    const request: HttpRequestConfig = {
-      method: 'POST',
-      url,
-      headers: DATA_CONNECT_CONFIG_HEADERS,
-      data,
-    };
-    const resp = await this.httpClient.send(request);
-    if (resp.data.errors && validator.isNonEmptyArray(resp.data.errors)) {
-      const allMessages = resp.data.errors.map((error: { message: any; }) => error.message).join(' ');
-      throw new FirebaseDataConnectError(
-        DATA_CONNECT_ERROR_CODE_MAPPING.QUERY_ERROR, allMessages);
-    }
-    return Promise.resolve({
-      data: resp.data.data as GraphqlResponse,
-    });
-  }
-
   /**
    * Executes a GraphQL query with impersonation.
    *
@@ -310,6 +284,32 @@ export class DataConnectApiClient {
       });
   }
 
+  /**
+   * Makes a GraphQL request to the specified url.
+   *
+   * @param url - The URL to send the request to.
+   * @param data - The GraphQL request payload.
+   * @returns A promise that fulfills with the GraphQL response, or throws an error.
+   */
+  private async makeGqlRequest<GraphqlResponse>(url: string, data: object): 
+  Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
+    const request: HttpRequestConfig = {
+      method: 'POST',
+      url,
+      headers: DATA_CONNECT_CONFIG_HEADERS,
+      data,
+    };
+    const resp = await this.httpClient.send(request);
+    if (resp.data.errors && validator.isNonEmptyArray(resp.data.errors)) {
+      const allMessages = resp.data.errors.map((error: { message: any; }) => error.message).join(' ');
+      throw new FirebaseDataConnectError(
+        DATA_CONNECT_ERROR_CODE_MAPPING.QUERY_ERROR, allMessages);
+    }
+    return Promise.resolve({
+      data: resp.data.data as GraphqlResponse,
+    });
+  }
+
   private toFirebaseError(err: RequestResponseError): PrefixedFirebaseError {
     if (err instanceof PrefixedFirebaseError) {
       return err;

test/unit/data-connect/data-connect-api-client-internal.spec.ts

@@ -340,6 +340,115 @@ describe('DataConnectApiClient', () => {
         });
     });
   });
+
+  describe('impersonateMutation', () => {
+    const unauthenticatedOptions: GraphqlOptions<unknown> = 
+      { operationName: 'operationName', impersonate: { unauthenticated: true } };
+
+    it('should reject when no operationName is provided', () => {
+      apiClient.impersonateMutation({ impersonate: { unauthenticated: true } })
+        .should.eventually.be.rejectedWith('`query` must be a non-empty string.');
+      apiClient.impersonateMutation({ operationName: undefined, impersonate: { unauthenticated: true } })
+        .should.eventually.be.rejectedWith('`query` must be a non-empty string.');
+    });
+    it('should reject when no impersonate object is provided', () => {
+      apiClient.impersonateMutation({ operationName: 'queryName' })
+        .should.eventually.be.rejectedWith('GraphqlOptions must be a non-null object');
+      apiClient.impersonateMutation({ operationName: 'queryName', impersonate: undefined })
+        .should.eventually.be.rejectedWith('GraphqlOptions must be a non-null object');
+    });
+    it('should reject when project id is not available', () => {
+      clientWithoutProjectId.impersonateMutation(unauthenticatedOptions)
+        .should.eventually.be.rejectedWith(noProjectId);
+    });
+
+    it('should reject when a full platform error response is received', () => {
+      sandbox
+        .stub(HttpClient.prototype, 'send')
+        .rejects(utils.errorFrom(ERROR_RESPONSE, 404));
+      const expected = new FirebaseDataConnectError('not-found', 'Requested entity not found');
+      return apiClient.impersonateMutation(unauthenticatedOptions)
+        .should.eventually.be.rejected.and.deep.include(expected);
+    });
+
+    it('should reject with unknown-error when error code is not present', () => {
+      sandbox
+        .stub(HttpClient.prototype, 'send')
+        .rejects(utils.errorFrom({}, 404));
+      const expected = new FirebaseDataConnectError('unknown-error', 'Unknown server error: {}');
+      return apiClient.impersonateMutation(unauthenticatedOptions)
+        .should.eventually.be.rejected.and.deep.include(expected);
+    });
+
+    it('should reject with unknown-error for non-json response', () => {
+      sandbox
+        .stub(HttpClient.prototype, 'send')
+        .rejects(utils.errorFrom('not json', 404));
+      const expected = new FirebaseDataConnectError(
+        'unknown-error', 'Unexpected response with status: 404 and body: not json');
+      return apiClient.impersonateMutation(unauthenticatedOptions)
+        .should.eventually.be.rejected.and.deep.include(expected);
+    });
+
+    it('should reject when rejected with a FirebaseDataConnectError', () => {
+      const expected = new FirebaseDataConnectError('internal-error', 'socket hang up');
+      sandbox
+        .stub(HttpClient.prototype, 'send')
+        .rejects(expected);
+      return apiClient.impersonateMutation(unauthenticatedOptions)
+        .should.eventually.be.rejected.and.deep.include(expected);
+    });
+
+    it('should resolve with the GraphQL response on success', () => {
+      interface UsersResponse {
+        users: [
+          user: {
+            id: string;
+            name: string;
+            address: string;
+          }
+        ];
+      }
+      const stub = sandbox
+        .stub(HttpClient.prototype, 'send')
+        .resolves(utils.responseFrom(TEST_RESPONSE, 200));
+      return apiClient.impersonateMutation<UsersResponse, unknown>(unauthenticatedOptions)
+        .then((resp) => {
+          expect(resp.data.users).to.be.not.empty;
+          expect(resp.data.users[0].name).to.be.not.undefined;
+          expect(resp.data.users[0].address).to.be.not.undefined;
+          expect(resp.data.users).to.deep.equal(TEST_RESPONSE.data.users);
+          expect(stub).to.have.been.calledOnce.and.calledWith({
+            method: 'POST',
+            url: `https://firebasedataconnect.googleapis.com/v1alpha/projects/test-project/locations/${connectorConfig.location}/services/${connectorConfig.serviceId}/connectors/${DataConnectService.getId(connectorConfig)}:impersonateMutation`,
+            headers: EXPECTED_HEADERS,
+            data: { 
+              operationName: unauthenticatedOptions.operationName, 
+              extensions: { impersonate: unauthenticatedOptions.impersonate }
+            }
+          });
+        });
+    });
+
+    it('should use DATA_CONNECT_EMULATOR_HOST if set', () => {
+      process.env.DATA_CONNECT_EMULATOR_HOST = 'localhost:9399';
+      const stub = sandbox
+        .stub(HttpClient.prototype, 'send')
+        .resolves(utils.responseFrom(TEST_RESPONSE, 200));
+      return apiClient.impersonateMutation(unauthenticatedOptions)
+        .then(() => {
+          expect(stub).to.have.been.calledOnce.and.calledWith({
+            method: 'POST',
+            url: `http://localhost:9399/v1alpha/projects/test-project/locations/${connectorConfig.location}/services/${connectorConfig.serviceId}/connectors/${DataConnectService.getId(connectorConfig)}:impersonateMutation`,
+            headers: EMULATOR_EXPECTED_HEADERS,
+            data: { 
+              operationName: unauthenticatedOptions.operationName, 
+              extensions: { impersonate: unauthenticatedOptions.impersonate }
+            }
+          });
+        });
+    });
+  });
 });
 
 describe('DataConnectApiClient CRUD helpers', () => {