chore(types): make handlerOptions optional (#1696)

trivikr · web-flow · commit b344ed8edb81 · 2020-11-30T16:19:11.000-08:00
diff --git a/packages/fetch-http-handler/src/fetch-http-handler.ts b/packages/fetch-http-handler/src/fetch-http-handler.ts
@@ -25,12 +25,10 @@ export class FetchHttpHandler implements HttpHandler {
   }
 
   destroy(): void {
-    // Do nothing. TLS and HTTP/2 connection pooling is handled by the
-    // browser.
+    // Do nothing. TLS and HTTP/2 connection pooling is handled by the browser.
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
-    const abortSignal = options?.abortSignal;
+  handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {
     const requestTimeoutInMs = this.requestTimeout;
 
     // if the request was already aborted, prevent doing extra work
diff --git a/packages/node-http-handler/src/node-http-handler.ts b/packages/node-http-handler/src/node-http-handler.ts
@@ -51,7 +51,7 @@ export class NodeHttpHandler implements HttpHandler {
     this.httpsAgent.destroy();
   }
 
-  handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {
     return new Promise((resolve, reject) => {
       // if the request was already aborted, prevent doing extra work
       if (abortSignal?.aborted) {
diff --git a/packages/node-http-handler/src/node-http2-handler.ts b/packages/node-http-handler/src/node-http2-handler.ts
@@ -44,7 +44,7 @@ export class NodeHttp2Handler implements HttpHandler {
     this.connectionPool.clear();
   }
 
-  handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {
     return new Promise((resolve, reject) => {
       // if the request was already aborted, prevent doing extra work
       if (abortSignal?.aborted) {
diff --git a/packages/types/src/transfer.ts b/packages/types/src/transfer.ts
@@ -8,7 +8,7 @@ export interface RequestHandler<RequestType, ResponseType, HandlerOptions = {}>
    */
   metadata?: RequestHandlerMetadata;
   destroy?: () => void;
-  handle: (request: RequestType, handlerOptions: HandlerOptions) => Promise<RequestHandlerOutput<ResponseType>>;
+  handle: (request: RequestType, handlerOptions?: HandlerOptions) => Promise<RequestHandlerOutput<ResponseType>>;
 }
 
 export interface RequestHandlerMetadata {
diff --git a/protocol_tests/aws-ec2/tests/functional/ec2query.spec.ts b/protocol_tests/aws-ec2/tests/functional/ec2query.spec.ts
@@ -32,7 +32,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {
  * request. The thrown exception contains the serialized request.
  */
 class RequestSerializationTestHandler implements HttpHandler {
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));
   }
 }
@@ -60,7 +60,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {
     this.body = body;
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.resolve({
       response: {
         statusCode: this.code,
diff --git a/protocol_tests/aws-json/tests/functional/awsjson1_1.spec.ts b/protocol_tests/aws-json/tests/functional/awsjson1_1.spec.ts
@@ -18,7 +18,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {
  * request. The thrown exception contains the serialized request.
  */
 class RequestSerializationTestHandler implements HttpHandler {
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));
   }
 }
@@ -46,7 +46,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {
     this.body = body;
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.resolve({
       response: {
         statusCode: this.code,
diff --git a/protocol_tests/aws-query/tests/functional/awsquery.spec.ts b/protocol_tests/aws-query/tests/functional/awsquery.spec.ts
@@ -38,7 +38,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {
  * request. The thrown exception contains the serialized request.
  */
 class RequestSerializationTestHandler implements HttpHandler {
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));
   }
 }
@@ -66,7 +66,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {
     this.body = body;
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.resolve({
       response: {
         statusCode: this.code,
diff --git a/protocol_tests/aws-restjson/tests/functional/restjson1.spec.ts b/protocol_tests/aws-restjson/tests/functional/restjson1.spec.ts
@@ -44,7 +44,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {
  * request. The thrown exception contains the serialized request.
  */
 class RequestSerializationTestHandler implements HttpHandler {
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));
   }
 }
@@ -72,7 +72,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {
     this.body = body;
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.resolve({
       response: {
         statusCode: this.code,
diff --git a/protocol_tests/aws-restxml/tests/functional/restxml.spec.ts b/protocol_tests/aws-restxml/tests/functional/restxml.spec.ts
@@ -54,7 +54,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {
  * request. The thrown exception contains the serialized request.
  */
 class RequestSerializationTestHandler implements HttpHandler {
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));
   }
 }
@@ -82,7 +82,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {
     this.body = body;
   }
 
-  handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
+  handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {
     return Promise.resolve({
       response: {
         statusCode: this.code,

Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,10 @@ export class FetchHttpHandler implements HttpHandler {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`destroy(): void {`
`28`		`- // Do nothing. TLS and HTTP/2 connection pooling is handled by the`
`29`		`- // browser.`
	`28`	`+ // Do nothing. TLS and HTTP/2 connection pooling is handled by the browser.`
`30`	`29`	`}`
`31`	`30`
`32`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`33`		`- const abortSignal = options?.abortSignal;`
	`31`	`+ handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {`
`34`	`32`	`const requestTimeoutInMs = this.requestTimeout;`
`35`	`33`
`36`	`34`	`// if the request was already aborted, prevent doing extra work`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ export class NodeHttpHandler implements HttpHandler {`
`51`	`51`	`this.httpsAgent.destroy();`
`52`	`52`	`}`
`53`	`53`
`54`		`- handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`54`	`+ handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {`
`55`	`55`	`return new Promise((resolve, reject) => {`
`56`	`56`	`// if the request was already aborted, prevent doing extra work`
`57`	`57`	`if (abortSignal?.aborted) {`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ export class NodeHttp2Handler implements HttpHandler {`
`44`	`44`	`this.connectionPool.clear();`
`45`	`45`	`}`
`46`	`46`
`47`		`- handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`47`	`+ handle(request: HttpRequest, { abortSignal }: HttpHandlerOptions = {}): Promise<{ response: HttpResponse }> {`
`48`	`48`	`return new Promise((resolve, reject) => {`
`49`	`49`	`// if the request was already aborted, prevent doing extra work`
`50`	`50`	`if (abortSignal?.aborted) {`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ export interface RequestHandler<RequestType, ResponseType, HandlerOptions = {}>`
`8`	`8`	`*/`
`9`	`9`	`metadata?: RequestHandlerMetadata;`
`10`	`10`	`destroy?: () => void;`
`11`		`- handle: (request: RequestType, handlerOptions: HandlerOptions) => Promise<RequestHandlerOutput<ResponseType>>;`
	`11`	`+ handle: (request: RequestType, handlerOptions?: HandlerOptions) => Promise<RequestHandlerOutput<ResponseType>>;`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`export interface RequestHandlerMetadata {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {`
`32`	`32`	`* request. The thrown exception contains the serialized request.`
`33`	`33`	`*/`
`34`	`34`	`class RequestSerializationTestHandler implements HttpHandler {`
`35`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`35`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`36`	`36`	`return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));`
`37`	`37`	`}`
`38`	`38`	`}`
`@@ -60,7 +60,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {`
`60`	`60`	`this.body = body;`
`61`	`61`	`}`
`62`	`62`
`63`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`63`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`64`	`64`	`return Promise.resolve({`
`65`	`65`	`response: {`
`66`	`66`	`statusCode: this.code,`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {`
`18`	`18`	`* request. The thrown exception contains the serialized request.`
`19`	`19`	`*/`
`20`	`20`	`class RequestSerializationTestHandler implements HttpHandler {`
`21`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`21`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`22`	`22`	`return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));`
`23`	`23`	`}`
`24`	`24`	`}`
`@@ -46,7 +46,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {`
`46`	`46`	`this.body = body;`
`47`	`47`	`}`
`48`	`48`
`49`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`49`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`50`	`50`	`return Promise.resolve({`
`51`	`51`	`response: {`
`52`	`52`	`statusCode: this.code,`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {`
`38`	`38`	`* request. The thrown exception contains the serialized request.`
`39`	`39`	`*/`
`40`	`40`	`class RequestSerializationTestHandler implements HttpHandler {`
`41`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`41`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`42`	`42`	`return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));`
`43`	`43`	`}`
`44`	`44`	`}`
`@@ -66,7 +66,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {`
`66`	`66`	`this.body = body;`
`67`	`67`	`}`
`68`	`68`
`69`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`69`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`70`	`70`	`return Promise.resolve({`
`71`	`71`	`response: {`
`72`	`72`	`statusCode: this.code,`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {`
`44`	`44`	`* request. The thrown exception contains the serialized request.`
`45`	`45`	`*/`
`46`	`46`	`class RequestSerializationTestHandler implements HttpHandler {`
`47`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`47`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`48`	`48`	`return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));`
`49`	`49`	`}`
`50`	`50`	`}`
`@@ -72,7 +72,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {`
`72`	`72`	`this.body = body;`
`73`	`73`	`}`
`74`	`74`
`75`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`75`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`76`	`76`	`return Promise.resolve({`
`77`	`77`	`response: {`
`78`	`78`	`statusCode: this.code,`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ class EXPECTED_REQUEST_SERIALIZATION_ERROR {`
`54`	`54`	`* request. The thrown exception contains the serialized request.`
`55`	`55`	`*/`
`56`	`56`	`class RequestSerializationTestHandler implements HttpHandler {`
`57`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`57`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`58`	`58`	`return Promise.reject(new EXPECTED_REQUEST_SERIALIZATION_ERROR(request));`
`59`	`59`	`}`
`60`	`60`	`}`
`@@ -82,7 +82,7 @@ class ResponseDeserializationTestHandler implements HttpHandler {`
`82`	`82`	`this.body = body;`
`83`	`83`	`}`
`84`	`84`
`85`		`- handle(request: HttpRequest, options: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
	`85`	`+ handle(request: HttpRequest, options?: HttpHandlerOptions): Promise<{ response: HttpResponse }> {`
`86`	`86`	`return Promise.resolve({`
`87`	`87`	`response: {`
`88`	`88`	`statusCode: this.code,`