Updated FDC to include promise instead of promiselike (#8667)

Author: maneesht

.changeset/tame-tigers-approve.md

@@ -0,0 +1,6 @@
+---
+"@firebase/data-connect": minor
+"firebase": minor
+---
+
+Updated to include promise instead of promiselike

common/api-review/data-connect.api.md

@@ -11,14 +11,6 @@ import { FirebaseError } from '@firebase/util';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
-// @public (undocumented)
-export interface CancellableOperation<T> extends PromiseLike<{
-    data: T;
-}> {
-    // (undocumented)
-    cancel: () => void;
-}
-
 // @public
 export function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
 
@@ -88,7 +80,7 @@ export function getDataConnect(app: FirebaseApp, options: ConnectorConfig): Data
 export const MUTATION_STR = "mutation";
 
 // @public
-export interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
+export interface MutationPromise<Data, Variables> extends Promise<MutationResult<Data, Variables>> {
 }
 
 // @public (undocumented)
@@ -144,7 +136,7 @@ export interface OpResult<Data> {
 export const QUERY_STR = "query";
 
 // @public
-export interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
+export interface QueryPromise<Data, Variables> extends Promise<QueryResult<Data, Variables>> {
 }
 
 // @public

packages/data-connect/src/api/Mutation.ts

@@ -76,7 +76,7 @@ export function mutationRef<Data, Variables>(
  * @internal
  */
 export class MutationManager {
-  private _inflight: Array<PromiseLike<unknown>> = [];
+  private _inflight: Array<Promise<unknown>> = [];
   constructor(private _transport: DataConnectTransport) {}
   executeMutation<Data, Variables>(
     mutationRef: MutationRef<Data, Variables>
@@ -95,7 +95,7 @@ export class MutationManager {
       return obj;
     });
     this._inflight.push(result);
-    const removePromise = (): Array<PromiseLike<unknown>> =>
+    const removePromise = (): Array<Promise<unknown>> =>
       (this._inflight = this._inflight.filter(promise => promise !== result));
     result.then(removePromise, removePromise);
     return withRefPromise;
@@ -113,7 +113,7 @@ export interface MutationResult<Data, Variables>
  * Mutation return value from `executeMutation`
  */
 export interface MutationPromise<Data, Variables>
-  extends PromiseLike<MutationResult<Data, Variables>> {
+  extends Promise<MutationResult<Data, Variables>> {
   // reserved for special actions like cancellation
 }
 

packages/data-connect/src/api/query.ts

@@ -67,7 +67,7 @@ export interface QueryResult<Data, Variables>
  * Promise returned from `executeQuery`
  */
 export interface QueryPromise<Data, Variables>
-  extends PromiseLike<QueryResult<Data, Variables>> {
+  extends Promise<QueryResult<Data, Variables>> {
   // reserved for special actions like cancellation
 }
 
@@ -124,7 +124,7 @@ export function queryRef<Data, Variables>(
     dataConnect: dcInstance,
     refType: QUERY_STR,
     name: queryName,
-    variables: variables as Variables
+    variables: variables
   };
 }
 /**

packages/data-connect/src/network/fetch.ts

@@ -30,9 +30,14 @@ function getGoogApiClientValue(_isUsingGen: boolean): string {
   }
   return str;
 }
+export interface DataConnectFetchBody<T> {
+  name: string;
+  operationName: string;
+  variables: T;
+}
 export function dcFetch<T, U>(
   url: string,
-  body: U,
+  body: DataConnectFetchBody<U>,
   { signal }: AbortController,
   appId: string | null,
   accessToken: string | null,
@@ -95,7 +100,7 @@ export function dcFetch<T, U>(
         logError('DataConnect error while performing request: ' + stringified);
         throw new DataConnectError(Code.OTHER, stringified);
       }
-      return res as { data: T; errors: Error[] };
+      return res;
     });
 }
 interface MessageObject {

packages/data-connect/src/network/transport/index.ts

@@ -26,19 +26,15 @@ export interface DataConnectTransport {
   invokeQuery<T, U>(
     queryName: string,
     body?: U
-  ): PromiseLike<{ data: T; errors: Error[] }>;
+  ): Promise<{ data: T; errors: Error[] }>;
   invokeMutation<T, U>(
     queryName: string,
     body?: U
-  ): PromiseLike<{ data: T; errors: Error[] }>;
+  ): Promise<{ data: T; errors: Error[] }>;
   useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
   onTokenChanged: (token: string | null) => void;
 }
 
-export interface CancellableOperation<T> extends PromiseLike<{ data: T }> {
-  cancel: () => void;
-}
-
 /**
  * @internal
  */

packages/data-connect/src/network/transport/rest.ts

@@ -161,7 +161,7 @@ export class RESTTransport implements DataConnectTransport {
   invokeQuery: <T, U>(
     queryName: string,
     body?: U
-  ) => PromiseLike<{ data: T; errors: Error[] }> = <T, U = unknown>(
+  ) => Promise<{ data: T; errors: Error[] }> = <T, U = unknown>(
     queryName: string,
     body: U
   ) => {
@@ -174,24 +174,20 @@ export class RESTTransport implements DataConnectTransport {
           name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
           operationName: queryName,
           variables: body
-        } as unknown as U, // TODO(mtewani): This is a patch, fix this.
+        },
         abortController,
         this.appId,
         this._accessToken,
         this._appCheckToken,
         this._isUsingGen
       )
     );
-
-    return {
-      then: withAuth.then.bind(withAuth),
-      catch: withAuth.catch.bind(withAuth)
-    };
+    return withAuth;
   };
   invokeMutation: <T, U>(
     queryName: string,
     body?: U
-  ) => PromiseLike<{ data: T; errors: Error[] }> = <T, U = unknown>(
+  ) => Promise<{ data: T; errors: Error[] }> = <T, U = unknown>(
     mutationName: string,
     body: U
   ) => {
@@ -203,20 +199,14 @@ export class RESTTransport implements DataConnectTransport {
           name: `projects/${this._project}/locations/${this._location}/services/${this._serviceName}/connectors/${this._connectorName}`,
           operationName: mutationName,
           variables: body
-        } as unknown as U,
+        },
         abortController,
         this.appId,
         this._accessToken,
         this._appCheckToken,
         this._isUsingGen
       );
     });
-
-    return {
-      then: taskResult.then.bind(taskResult),
-      // catch: taskResult.catch.bind(taskResult),
-      // finally: taskResult.finally.bind(taskResult),
-      cancel: () => abortController.abort()
-    };
+    return taskResult;
   };
 }

packages/data-connect/test/unit/fetch.test.ts

@@ -42,7 +42,11 @@ describe('fetch', () => {
     await expect(
       dcFetch(
         'http://localhost',
-        {},
+        {
+          name: 'n',
+          operationName: 'n',
+          variables: {}
+        },
         {} as AbortController,
         null,
         null,
@@ -61,7 +65,11 @@ describe('fetch', () => {
     await expect(
       dcFetch(
         'http://localhost',
-        {},
+        {
+          name: 'n',
+          operationName: 'n',
+          variables: {}
+        },
         {} as AbortController,
         null,
         null,