fix(plugin-http): typings

closes #541

Signed-off-by: Olivier Albertini <[email protected]>

Author: OlivierAlbertini

packages/opentelemetry-plugin-http/package.json

@@ -43,24 +43,24 @@
     "@opentelemetry/node": "^0.2.0",
     "@opentelemetry/scope-base": "^0.2.0",
     "@opentelemetry/tracing": "^0.2.0",
-    "@types/got": "^9.6.7",
+    "@types/got": "^9.6.9",
     "@types/mocha": "^5.2.7",
     "@types/nock": "^11.1.0",
-    "@types/node": "^12.7.9",
+    "@types/node": "^12.12.8",
     "@types/request-promise-native": "^1.0.17",
-    "@types/semver": "^6.0.2",
+    "@types/semver": "^6.2.0",
     "@types/shimmer": "^1.0.1",
-    "@types/sinon": "^7.0.13",
-    "@types/superagent": "^4.1.3",
+    "@types/sinon": "^7.5.0",
+    "@types/superagent": "^4.1.4",
     "axios": "^0.19.0",
     "codecov": "^3.6.1",
     "got": "^9.6.0",
     "gts": "^1.1.0",
-    "mocha": "^6.2.1",
-    "nock": "^11.3.5",
+    "mocha": "^6.2.2",
+    "nock": "^11.7.0",
     "nyc": "^14.1.1",
     "request": "^2.88.0",
-    "request-promise-native": "^1.0.7",
+    "request-promise-native": "^1.0.8",
     "rimraf": "^3.0.0",
     "sinon": "^7.5.0",
     "superagent": "5.1.0",

packages/opentelemetry-plugin-http/src/http.ts

@@ -184,8 +184,10 @@ export class HttpPlugin extends BasePlugin<Http> {
       this._logger.debug('makeRequestTrace by injecting context into header');
 
       const host = options.hostname || options.host || 'localhost';
-      const method = options.method ? options.method.toUpperCase() : 'GET';
-      const headers = options.headers || {};
+      const method = (options as RequestOptions).method
+        ? (options as RequestOptions).method!.toUpperCase()
+        : 'GET';
+      const headers = (options as RequestOptions).headers || {};
       const userAgent = headers['user-agent'];
 
       span.setAttributes({
@@ -409,7 +411,7 @@ export class HttpPlugin extends BasePlugin<Http> {
           : undefined
       );
 
-      options = optionsParsed;
+      options = optionsParsed as RequestOptions;
 
       if (
         utils.isOpenTelemetryRequest(options) ||

packages/opentelemetry-plugin-http/src/types.ts

@@ -24,6 +24,7 @@ import {
   get,
 } from 'http';
 import * as http from 'http';
+import { ParsedUrlQuery } from 'querystring';
 
 export type IgnoreMatcher = string | RegExp | ((url: string) => boolean);
 export type HttpCallback = (res: IncomingMessage) => void;
@@ -38,9 +39,12 @@ export type RequestSignature = [http.RequestOptions, HttpCallbackOptional] &
 
 export type HttpRequestArgs = Array<HttpCallbackOptional | RequestSignature>;
 
-export type ParsedRequestOptions =
-  | (http.RequestOptions & Partial<url.UrlWithParsedQuery>)
-  | http.RequestOptions;
+export type ParsedRequestOptions = (
+  | http.RequestOptions
+  | Omit<url.UrlWithParsedQuery, 'query'>) & {
+  protocol?: string | null | undefined;
+  query?: string | ParsedUrlQuery | null;
+};
 export type Http = typeof http;
 /* tslint:disable-next-line:no-any */
 export type Func<T> = (...args: any[]) => T;

packages/opentelemetry-plugin-http/src/utils.ts

@@ -93,7 +93,7 @@ export const parseResponseStatus = (
  * Returns whether the Expect header is on the given options object.
  * @param options Options for http.request.
  */
-export const hasExpectHeader = (options: RequestOptions | url.URL): boolean => {
+export const hasExpectHeader = (options: ParsedRequestOptions): boolean => {
   if (typeof (options as RequestOptions).headers !== 'object') {
     return false;
   }
@@ -200,7 +200,7 @@ export const setSpanWithError = (
  * @param [extraOptions] additional options for the request
  */
 export const getRequestInfo = (
-  options: RequestOptions | string,
+  options: string | ParsedRequestOptions,
   extraOptions?: RequestOptions
 ) => {
   let pathname = '/';

packages/opentelemetry-plugin-http/test/functionals/utils.test.ts

@@ -78,7 +78,7 @@ describe('Utility', () => {
       const urlParsed = url.parse(webUrl);
       const urlParsedWithoutPathname = {
         ...urlParsed,
-        pathname: undefined,
+        pathname: null,
       };
       for (const param of [webUrl, urlParsed, urlParsedWithoutPathname]) {
         const result = utils.getRequestInfo(param);

packages/opentelemetry-plugin-http/test/integrations/http-enable.test.ts

@@ -30,6 +30,7 @@ import {
   SimpleSpanProcessor,
 } from '@opentelemetry/tracing';
 import { HttpPluginConfig } from '../../src/types';
+import { RequestOptions } from 'https';
 
 const serverPort = 32345;
 const hostname = 'localhost';
@@ -139,7 +140,7 @@ describe('HttpPlugin Integration tests', () => {
       const options = Object.assign(
         { headers: { Expect: '100-continue' } },
         url.parse('http://google.fr/')
-      );
+      ) as RequestOptions;
 
       const result = await httpRequest.get(options);
       spans = memoryExporter.getFinishedSpans();

packages/opentelemetry-plugin-http/test/utils/assertSpan.ts

@@ -33,7 +33,7 @@ export const assertSpan = (
     hostname: string;
     pathname: string;
     reqHeaders?: http.OutgoingHttpHeaders;
-    path?: string;
+    path?: string | null;
     forceStatus?: Status;
     component: string;
   }

packages/opentelemetry-plugin-http/test/utils/httpRequest.ts

@@ -20,7 +20,7 @@ import { RequestOptions } from 'https';
 
 export const httpRequest = {
   get: (
-    options: string | RequestOptions
+    options: string | RequestOptions | url.URL
   ): Promise<{
     data: string;
     statusCode: number | undefined;
@@ -34,7 +34,7 @@ export const httpRequest = {
             headers: {
               'user-agent': 'http-plugin-test',
             },
-          })
+          }) as RequestOptions
         : options;
     return new Promise((resolve, reject) => {
       const req = http.get(_options, (resp: http.IncomingMessage) => {