feat: clean up precedence for LRO operations mixin duplicate methods

Author: shivanee-p

core/generator/gapic-generator-typescript/templates/cjs/typescript_gapic/_operations.njk

@@ -36,6 +36,7 @@
    * // doThingsWith(response)
    * ```
    */
+{%- if service.longRunningOperationsMixinFlags.getOperation %}
   getOperation(
     request: protos.google.longrunning.GetOperationRequest,
     optionsOrCallback?:
@@ -67,6 +68,8 @@
        });
     return this.operationsClient.getOperation(request, options, callback);
   }
+{%- endif %}
+{%- if service.longRunningOperationsMixinFlags.listOperations %}
   /**
    * Lists operations that match the specified filter in the request. If the
    * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
@@ -110,6 +113,8 @@
        });
     return this.operationsClient.listOperationsAsync(request, options);
   }
+{%- endif %}
+{%- if service.longRunningOperationsMixinFlags.cancelOperation %}
   /**
    * Starts asynchronous cancellation on a long-running operation.  The server
    * makes a best effort to cancel the operation, but success is not
@@ -172,7 +177,9 @@
        });
     return this.operationsClient.cancelOperation(request, options, callback);
   }
+{%- endif %}
 
+{%- if service.longRunningOperationsMixinFlags.deleteOperation %}
   /**
    * Deletes a long-running operation. This method indicates that the client is
    * no longer interested in the operation result. It does not cancel the
@@ -229,4 +236,5 @@
        });
     return this.operationsClient.deleteOperation(request, options, callback);
   }
+{%- endif %}
 {%- endmacro -%}

core/generator/gapic-generator-typescript/templates/cjs/typescript_gapic/test/gapic_$service_$version.ts.njk

@@ -1405,6 +1405,7 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
 {%- if (service.LongRunningOperationsMixin) > 0 %}
 {%- set Operationsmethods = ['getOperation', 'cancelOperation', 'deleteOperation'] %}
 {%- for method in Operationsmethods %}
+{%- if service.longRunningOperationsMixinFlags[method] %}
     describe('{{ method }}', () => {
         it('invokes {{ method }} without error', async () => {
             const client = new {{ service.name.toLowerCase() }}Module.{{ api.naming.version }}.{{ service.name }}Client(
@@ -1495,8 +1496,10 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
                 .getCall(0).calledWith(request));
         });
     });
+{%- endif %}
 {%- endfor %}
 {%- set method = 'listOperations' %}
+{%- if service.longRunningOperationsMixinFlags.listOperations %}
     describe('{{ method }}Async', () => {
         it('uses async iteration with {{method}} without error', async () => {
             const client = new {{ service.name.toLowerCase() }}Module.{{ api.naming.version }}.{{ service.name }}Client({{- util.initClientOptions(api.rest) -}});
@@ -1561,6 +1564,7 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
         });
     });
 {%- endif %}
+{%- endif %}
 {%- if (service.pathTemplates.length > 0) %}
 
     describe('Path templates', () => {

core/generator/gapic-generator-typescript/templates/esm/typescript_gapic/_operations.njk

@@ -36,6 +36,7 @@
    * // doThingsWith(response)
    * ```
    */
+{%- if service.longRunningOperationsMixinFlags.getOperation %}
   getOperation(
     request: protos.google.longrunning.GetOperationRequest,
     optionsOrCallback?:
@@ -67,6 +68,8 @@
        });
     return this.operationsClient.getOperation(request, options, callback);
   }
+{%- endif %}
+{%- if service.longRunningOperationsMixinFlags.listOperations %}
   /**
    * Lists operations that match the specified filter in the request. If the
    * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
@@ -110,6 +113,8 @@
        });
     return this.operationsClient.listOperationsAsync(request, options);
   }
+{%- endif %}
+{%- if service.longRunningOperationsMixinFlags.cancelOperation %}
   /**
    * Starts asynchronous cancellation on a long-running operation.  The server
    * makes a best effort to cancel the operation, but success is not
@@ -172,7 +177,9 @@
        });
     return this.operationsClient.cancelOperation(request, options, callback);
   }
+{%- endif %}
 
+{%- if service.longRunningOperationsMixinFlags.deleteOperation %}
   /**
    * Deletes a long-running operation. This method indicates that the client is
    * no longer interested in the operation result. It does not cancel the
@@ -229,4 +236,5 @@
        });
     return this.operationsClient.deleteOperation(request, options, callback);
   }
+{%- endif %}
 {%- endmacro -%}

core/generator/gapic-generator-typescript/templates/esm/typescript_gapic/esm/test/gapic_$service_$version.ts.njk

@@ -1411,6 +1411,7 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
 {%- if (service.LongRunningOperationsMixin) > 0 %}
 {%- set Operationsmethods = ['getOperation', 'cancelOperation', 'deleteOperation'] %}
 {%- for method in Operationsmethods %}
+{%- if service.longRunningOperationsMixinFlags[method] %}
     describe('{{ method }}', () => {
         it('invokes {{ method }} without error', async () => {
             const client = new {{ service.name.toLowerCase() }}Module.{{ api.naming.version }}.{{ service.name }}Client(
@@ -1501,8 +1502,10 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
                 .getCall(0).calledWith(request));
         });
     });
+{%- endif %}
 {%- endfor %}
 {%- set method = 'listOperations' %}
+{%- if service.longRunningOperationsMixinFlags.listOperations %}
     describe('{{ method }}Async', () => {
         it('uses async iteration with {{method}} without error', async () => {
             const client = new {{ service.name.toLowerCase() }}Module.{{ api.naming.version }}.{{ service.name }}Client({{- util.initClientOptions(api.rest) -}});
@@ -1567,6 +1570,7 @@ describe('{{ api.naming.version }}.{{ service.name }}Client', () => {
         });
     });
 {%- endif %}
+{%- endif %}
 {%- if (service.pathTemplates.length > 0) %}
 
     describe('Path templates', () => {

core/generator/gapic-generator-typescript/typescript/src/schema/proto.ts

@@ -98,6 +98,13 @@ export interface LocationMixinConfig extends MixinConfig {
   listLocations: boolean;
 }
 
+export interface OperationsMixinConfig extends MixinConfig {
+  cancelOperation: boolean;
+  deleteOperation: boolean;
+  getOperation: boolean;
+  listOperations: boolean;
+}
+
 export interface ServiceDescriptorProto
   extends protos.google.protobuf.IServiceDescriptorProto {
   internalMethods: MethodDescriptorProto[];
@@ -128,6 +135,7 @@ export interface ServiceDescriptorProto
   LongRunningOperationsMixin: number;
   iamPolicyMixinFlags?: IamPolicyMixinConfig;
   locationMixinFlags?: LocationMixinConfig;
+  longRunningOperationsMixinFlags?: OperationsMixinConfig;
   protoFile: string;
   diregapicLRO?: MethodDescriptorProto[];
   httpRules?: protos.google.api.IHttpRule[];
@@ -1103,6 +1111,14 @@ export function augmentService(parameters: AugmentServiceParameters) {
     augmentedService.LongRunningOperationsMixin = 1;
   }
 
+  augmentedService.longRunningOperationsMixinFlags = {
+    enabled: augmentedService.LongRunningOperationsMixin === 1,
+    getOperation: !nativeMethodNames.includes('GetOperation'),
+    cancelOperation: !nativeMethodNames.includes('CancelOperation'),
+    deleteOperation: !nativeMethodNames.includes('DeleteOperation'),
+    listOperations: !nativeMethodNames.includes('ListOperations'),
+  };
+
   augmentedService.hostname = '';
   augmentedService.port = 0;
   if (augmentedService.options?.['.google.api.defaultHost']) {

core/generator/gapic-generator-typescript/typescript/test/unit/proto.ts

@@ -427,11 +427,13 @@ describe('src/schema/proto.ts', () => {
       fd.service[0].method = [
         {name: 'GetIamPolicy'},
         {name: 'ListLocations'},
+        {name: 'GetOperation'},
       ] as protos.google.protobuf.MethodDescriptorProto[];
 
       // Simulating mixins being enabled (non-zero value)
       (fd.service[0] as any).IAMPolicyMixin = 1;
       (fd.service[0] as any).LocationMixin = 1;
+      (fd.service[0] as any).LongRunningOperationsMixin = 1;
 
       const options: Options = {
         grpcServiceConfig: {} as protos.grpc.service_config.ServiceConfig,
@@ -464,6 +466,11 @@ describe('src/schema/proto.ts', () => {
         augmentedService.locationMixinFlags?.listLocations,
         false
       ); // Native ListLocations exists
+
+      assert.strictEqual(augmentedService.longRunningOperationsMixinFlags?.getOperation, false); // Native GetOperation exists
+      assert.strictEqual(augmentedService.longRunningOperationsMixinFlags?.cancelOperation, true);
+      assert.strictEqual(augmentedService.longRunningOperationsMixinFlags?.deleteOperation, true);
+      assert.strictEqual(augmentedService.longRunningOperationsMixinFlags?.listOperations, true);
     });
 
     it('should return api version if it exists', () => {