fix: Fix TestReadRows_Generic_CloseClient conformance test by passing grpc status codes for closed client errors (#1524)

danieljbruce · web-flow · commit 8524174d9214 · 2024-12-02T18:38:20.000Z
**Summary** The TestReadRows_Generic_CloseClient conformance test [is failing](https://togithub.com/googleapis/cloud-bigtable-clients-test/blob/3b0215b4a3ae88fa1f1d2ad2229b4d8069bc1a5a/tests/readrows_test.go#L754). The [assert that was failing](https://togithub.com/googleapis/cloud-bigtable-clients-test/blob/3b0215b4a3ae88fa1f1d2ad2229b4d8069bc1a5a/tests/readrows_test.go#L754) was failing because the client was sending back an error saying the client had been closed without providing a status code for the error, but the assertion requires a non-zero status code to be present. With the new code change, the error saying that the client has been closed will now have a `CANCELLED` status code as was recommended by Gemini and the assertion check will pass and the test will pass too.
diff --git a/src/tabular-api-surface.ts b/src/tabular-api-surface.ts
@@ -34,7 +34,7 @@ import {
 } from './chunktransformer';
 import {BackoffSettings} from 'google-gax/build/src/gax';
 import {google} from '../protos/protos';
-import {CallOptions, ServiceError} from 'google-gax';
+import {CallOptions, grpc, ServiceError} from 'google-gax';
 import {Duplex, PassThrough, Transform} from 'stream';
 import * as is from 'is';
 import {GoogleInnerError} from './table';
@@ -518,6 +518,19 @@ Please use the format 'prezzy' or '${instance.name}/tables/prezzy'.`);
             );
             retryTimer = setTimeout(makeNewRequest, nextRetryDelay);
           } else {
+            if (
+              !error.code &&
+              error.message === 'The client has already been closed.'
+            ) {
+              //
+              // The TestReadRows_Generic_CloseClient conformance test requires
+              // a grpc code to be present when the client is closed. According
+              // to Gemini, the appropriate code for a closed client is
+              // CANCELLED since the user actually cancelled the call by closing
+              // the client.
+              //
+              error.code = grpc.status.CANCELLED;
+            }
             userStream.emit('error', error);
           }
         })
diff --git a/testproxy/known_failures.txt b/testproxy/known_failures.txt
@@ -14,7 +14,6 @@ TestReadRows_NoRetry_OutOfOrderError_Reverse\|
 TestReadRows_Retry_PausedScan\|
 TestReadRows_Retry_LastScannedRow_Reverse\|
 TestReadRows_Retry_StreamReset\|
-TestReadRows_Generic_CloseClient\|
 TestReadRows_Generic_DeadlineExceeded\|
 TestReadRows_Retry_WithRoutingCookie\|
 TestReadRows_Retry_WithRoutingCookie_MultipleErrorResponses\|
