Added mutationRef's functionality accourding to the api proposal and cleaned up unnecessary code.

Author: FOLUSO ONATEMOWO

dataconnect_test.ts

@@ -46,7 +46,7 @@ const FIREBASE_DATA_CONNECT_EMULATOR_BASE_URL_FORMAT_WITH_CONNECTOR =
 const EXECUTE_GRAPH_QL_ENDPOINT = 'executeGraphql';
 const EXECUTE_GRAPH_QL_READ_ENDPOINT = 'executeGraphqlRead';
 const EXECUTE_QUERY_ENDPOINT = 'executeQuery';
-// const EXECUTE_MUTATION_ENDPOINT = 'executeMutation';
+const EXECUTE_MUTATION_ENDPOINT = 'executeMutation';
 
 const DATA_CONNECT_CONFIG_HEADERS = {
   'X-Firebase-Client': `fire-admin-node/${utils.getSdkVersion()}`
@@ -81,7 +81,8 @@ export class DataConnectApiClient {
     query: string,
     options?: GraphqlOptions<Variables>,
   ): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
-    return this.executeGraphqlHelper(query, EXECUTE_GRAPH_QL_ENDPOINT, options);
+    // return this.executeGraphqlHelper(query, EXECUTE_GRAPH_QL_ENDPOINT, options);
+    return this.executeHelper(EXECUTE_GRAPH_QL_ENDPOINT,options, query);
   }
 
   /**
@@ -100,15 +101,28 @@ export class DataConnectApiClient {
     return this.executeHelper(EXECUTE_GRAPH_QL_READ_ENDPOINT,options, query);
   }
 
-    /**
-   * Uses the name and the variables parameters to execute a query.
+  /**
+   * Execute pre-existing <QueryResult<Data, Variables>> read-only queries
+   * @param options - GraphQL Options
+   * @returns A promise that fulfills with a `ExecuteGraphqlResponse`.
+   * @throws FirebaseDataConnectError
    */
   public async executeQuery<Data, Variables>(
     options: GraphqlOptions<Variables>,
   ): Promise<ExecuteGraphqlResponse<Data>>{
-    // const {data} = await this.executeHelper(options.operationName!, EXECUTE_QUERY_ENDPOINT, options);
     return this.executeHelper(EXECUTE_QUERY_ENDPOINT,options);
 }
+  /**
+   * Execute pre-existing <MutationResult<Data, Variables>> read and write queries
+   * @param options - GraphQL Options
+   * @returns A promise that fulfills with a `ExecuteGraphqlResponse`.
+   * @throws FirebaseDataConnectError
+   */
+  public async executeMutation<Data, Variables>(
+    options: GraphqlOptions<Variables>,
+  ): Promise<ExecuteGraphqlResponse<Data>>{
+    return this.executeHelper(EXECUTE_MUTATION_ENDPOINT,options);
+}
 
   private async executeHelper<GraphqlResponse, Variables>(
     endpoint: string,
@@ -136,8 +150,6 @@ export class DataConnectApiClient {
       query: gql,
       ...(!gql && { name: options?.operationName}),
       ...(options?.variables && { variables: options?.variables }),
-      //change to if query != operationName for executeQuery and executeMutation
-      //Also how was this needed in conjuncton with executeGraphql before? Just the name of an operation normally doesn't that mean this is how it was used before?
       ...(options?.operationName && { operationName: options?.operationName }),
       ...(options?.impersonate && { extensions: { impersonate: options?.impersonate } }),
     };
@@ -168,55 +180,6 @@ export class DataConnectApiClient {
       });
   }
 
-  private async executeGraphqlHelper<GraphqlResponse, Variables>(
-    query: string,
-    endpoint: string,
-    options?: GraphqlOptions<Variables>,
-  ): Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
-    if (!validator.isNonEmptyString(query)) {
-      throw new FirebaseDataConnectError(
-        DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-        '`query` must be a non-empty string.');
-    }
-    if (typeof options !== 'undefined') {
-      if (!validator.isNonNullObject(options)) {
-        throw new FirebaseDataConnectError(
-          DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
-          'GraphqlOptions must be a non-null object');
-      }
-    }
-    const data = {
-      query,
-      ...(options?.variables && { variables: options?.variables }),
-      ...(options?.operationName && { operationName: options?.operationName }),
-      ...(options?.impersonate && { extensions: { impersonate: options?.impersonate } }),
-    };
-    return this.getUrl(API_VERSION, this.connectorConfig.location, this.connectorConfig.serviceId, endpoint)
-      .then(async (url) => {
-        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,
-        });
-      })
-      .then((resp) => {
-        return resp;
-      })
-      .catch((err) => {
-        throw this.toFirebaseError(err);
-      });
-  }
-
   private async getUrl(version: string, locationId: string, serviceId: string, endpointId: string, connector?: string): Promise<string> {
     return this.getProjectId()
       .then((projectId) => {

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

@@ -191,25 +191,28 @@ export class DataConnect {
    * @param name Name of Mutation
    * @returns MutationRef
    */
-  // public mutationRef<Data>(name: string): MutationRef<Data, undefined>;
+  public mutationRef<Data>(name: string): MutationRef<Data, undefined>;
   /**
    * 
    * Returns Mutation Reference
    * @param name Name of Mutation
    * @param variables 
    * @returns MutationRef
    */
-  // public mutationRef<Data, Variables>(name: string, variables: Variables): MutationRef<Data, Variables>;
+  public mutationRef<Data, Variables>(name: string, variables: Variables): MutationRef<Data, Variables>;
   /**
    * 
    * Returns Query Reference
    * @param name Name of Mutation
    * @param variables 
    * @returns MutationRef
    */
-  // public mutationRef<Data, Variables>(name: string, variables?: Variables): MutationRef<Data, Variables> {
-  //   return new MutationRef(name, variables as Variables, this.client);
-  // }
+  public mutationRef<Data, Variables>(name: string, variables?: Variables): MutationRef<Data, Variables> {
+    if (!("connector" in this.connectorConfig)){
+      throw new FirebaseDataConnectError(DATA_CONNECT_ERROR_CODE_MAPPING.INVALID_ARGUMENT,'executeQuery requires a connector');
+    }
+    return new MutationRef(this, name, variables as Variables, this.client);
+  }
 }
 
 abstract class OperationRef<Data, Variables> {
@@ -229,14 +232,13 @@ interface OperationResult<Data, Variables> {
 export interface QueryResult<Data, Variables> extends OperationResult<Data, Variables> {
   ref: QueryRef<Data, Variables>;
 }
-// interface MutationResult<Data, Variables> extends OperationResult<Data, Variables> {
-//   ref: MutationRef<Data, Variables>;
-// }
+export interface MutationResult<Data, Variables> extends OperationResult<Data, Variables> {
+  ref: MutationRef<Data, Variables>;
+}
 
 class QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
   option_params:GraphqlOptions<Variables>;
   async execute(): Promise<QueryResult<Data, Variables>> {
-    // return this.client.executeQuery(this.name, this.variables);
     const option_params = {
       variables: this.variables,
       operationName: this.name
@@ -252,8 +254,20 @@ class QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
   }
 }
 
-// class MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
-//   execute(): Promise<MutationResult<Data, Variables>> {
-//     return this.client.executeMutation(this.name, this.variables);
-//   }
-// }
+class MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
+  option_params:GraphqlOptions<Variables>;
+  async execute(): Promise<MutationResult<Data, Variables>> {
+    const option_params = {
+      variables: this.variables,
+      operationName: this.name
+    };
+    const {data} = await this.client.executeMutation<Data, Variables>(option_params)
+    
+    return {
+      ref: this,
+      data: data,
+      variables: this.variables,
+      dataConnect: this.dataConnect
+    }
+  }
+}

src/data-connect/data-connect.ts

@@ -0,0 +1,27 @@
+import { getDataConnect } from '../lib/data-connect';
+import { initializeApp } from '../lib/app';
+
+initializeApp();
+
+const config = {
+    serviceId: "your-service-id",
+    location: "us-central1",
+    connector:"movie-connector"
+};
+
+const dataConnect = getDataConnect(config);
+
+async function queryref_test (){
+    // const listOfMovies_res = await dataConnect.queryRef('ListMovies', {orderByRating: "DESC",orderByReleaseYear: "DESC", limit: 3}).execute();
+    // const getActorsDetails = await dataConnect.queryRef('GetActorById', {id: "11111111222233334444555555555555"}).execute()
+    // const graphqlRead_listOfMovies_res = await dataConnect.executeGraphqlRead(" query { movies {id, title}}");
+    // const graphql_listOfMovies_res= await dataConnect.executeGraphql(`mutation {user_insert(data: {id: "66666666667777777770", username: "coder_bot"})}`);
+    // const graphql_listOfMovies_res_with_operation= await dataConnect.executeGraphql(`mutation {user_insert(data: {id: "66666666667777777773", username: "night_agent"})}`);
+    // const graphql_query_listOfMovies_res = await dataConnect.executeGraphql(" query { movies {id, title}}");
+    // const Upsert_user_res = await dataConnect.mutationRef('UpsertUser', {id: "66666666667777777771",username: "Hola"}).execute();
+    const GetUserBy_Id_res = await dataConnect.queryRef("GetUserById",{id:"66666666667777777771"}).execute()
+
+    console.log(GetUserBy_Id_res.data)
+}
+
+queryref_test()