👌 IMPROVE: Keep more compatible d.ts on httpclient request (#5092)

index.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
 import accepts = require('accepts');
-import KoaApplication = require('koa');
-import KoaRouter = require('koa-router');
 import { AsyncLocalStorage } from 'async_hooks';
 import { EventEmitter } from 'events'
 import { Readable } from 'stream';
 import { Socket } from 'net';
 import { IncomingMessage, ServerResponse } from 'http';
+import KoaApplication = require('koa');
+import KoaRouter = require('koa-router');
 import {
   EggLogger as Logger,
   EggLoggers,
@@ -15,7 +15,9 @@ import {
   EggLoggerOptions,
   EggContextLogger
 } from 'egg-logger';
-import { HttpClient, RequestOptions2 as RequestOptions } from 'urllib';
+import { RequestOptions2 as RequestOptions, HttpClientResponse } from 'urllib';
+import { RequestURL, RequestOptions as RequestOptionsNext } from 'urllib-next/src/Request';
+import { HttpClientResponse as HttpClientResponseNext } from 'urllib-next/src/Response';
 import {
   EggCoreBase,
   FileLoaderOption,
@@ -46,12 +48,18 @@ declare module 'egg' {
   // Remove specific property from the specific class
   type RemoveSpecProp<T, P> = Pick<T, Exclude<keyof T, P>>;
 
-  export interface EggHttpClient extends HttpClient<RequestOptions> { }
+  // Compatible with both urllib@2 and urllib@3 RequestOptions to request
+  export interface EggHttpClient extends EventEmitter {
+    reques<T = any>(url: RequestURL): Promise<HttpClientResponse<T> | HttpClientResponseNext>;
+    request<T = any>(url: RequestURL, options: RequestOptions | RequestOptionsNext): Promise<HttpClientResponse<T> | HttpClientResponseNext>;
+    curl<T = any>(url: RequestURL): Promise<HttpClientResponse<T> | HttpClientResponseNext>;
+    curl<T = any>(url: RequestURL, options: RequestOptions | RequestOptionsNext): Promise<HttpClientResponse<T> | HttpClientResponseNext>;
+  }
   interface EggHttpConstructor {
     new(app: Application): EggHttpClient;
   }
 
-  export interface EggContextHttpClient extends HttpClient<RequestOptions> { }
+  export interface EggContextHttpClient extends EggHttpClient { }
   interface EggContextHttpClientConstructor {
     new(ctx: Context): EggContextHttpClient;
   }

package.json

@@ -54,7 +54,7 @@
     "on-finished": "^2.4.1",
     "sendmessage": "^1.1.0",
     "urllib": "^2.33.0",
-    "urllib-next": "^3.1.3",
+    "urllib-next": "^3.8.0",
     "utility": "^1.17.0",
     "ylru": "^1.3.2"
   },

test/app/middleware/meta.test.js

@@ -54,6 +54,7 @@ describe('test/app/middleware/meta.test.js', () => {
         .expect('X-Readtime', /\d+/)
         .expect('hello world')
         .expect(200);
+      if (process.platform === 'win32') await utils.sleep(2000);
       const content = (await fs.readFile(app.coreLogger.options.file, 'utf8')).split('\n').slice(-2, -1)[0];
       assert(content.includes('[meta] request started, host: '));
     });

test/fixtures/apps/app-ts/app/controller/foo.ts

@@ -1,3 +1,4 @@
+import { strict as assert } from 'assert';
 import {
   Controller,
   RequestObjectBody,
@@ -6,6 +7,8 @@ import {
   EggHttpClient,
   EggContextHttpClient,
 } from 'egg';
+import { RequestOptions as RequestOptionsNext } from 'urllib-next/src/Request';
+import { RequestOptions2, RequestOptions } from 'urllib';
 
 // add user controller and service
 declare module 'egg' {
@@ -25,6 +28,8 @@ export default class FooController extends Controller {
     this.appHttpClient = ctx.app.httpclient;
     this.ctxHttpClient = ctx.httpclient;
     this.fooLogger = ctx.getLogger('foo');
+    assert(ctx.app.ctxStorage);
+    assert(!ctx.app.currentConext);
   }
 
   async getData() {
@@ -47,6 +52,33 @@ export default class FooController extends Controller {
     }
   }
 
+  async requestWithHttpclientNext(request: RequestOptionsNext) {
+    let result = await this.app.curl('url', request);
+    result = await this.ctx.curl('url', request);
+    result = await this.app.httpclient.curl('url', request);
+    result = await this.app.httpclient.request('url', request);
+    result = await this.ctx.httpclient.curl('url', request);
+    result = await this.ctx.httpclient.request('url', request);
+  }
+
+  async requestWithHttpclient(request: RequestOptions) {
+    let result = await this.app.curl('url', request);
+    result = await this.ctx.curl('url', request);
+    result = await this.app.httpclient.curl('url', request);
+    result = await this.app.httpclient.request('url', request);
+    result = await this.ctx.httpclient.curl('url', request);
+    result = await this.ctx.httpclient.request('url', request);
+  }
+
+  async requestWithHttpclient2(request: RequestOptions2) {
+    let result = await this.app.curl('url', request);
+    result = await this.ctx.curl('url', request);
+    result = await this.app.httpclient.curl('url', request);
+    result = await this.app.httpclient.request('url', request);
+    result = await this.ctx.httpclient.curl('url', request);
+    result = await this.ctx.httpclient.request('url', request);
+  }
+
   async httpclient() {
     await this.app.httpclient.request('url', {
       method: 'POST',

test/fixtures/apps/app-ts/config/config.ts

@@ -16,6 +16,9 @@ export default () => {
 
   config.httpclient = {
     useHttpClientNext: false,
+    request: {
+      timing: true,
+    },
   };
 
   return config;