feat(*) Adds @deprecated deco to mark method as deprecated

Author: nullcc

README.md

@@ -5,7 +5,7 @@
 
 | Statements                               | Branches                                 | Functions                                | Lines                               |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ----------------------------------- |
-| ![Statements](https://img.shields.io/badge/Coverage-96.51%25-brightgreen.svg "Make me better!") | ![Branches](https://img.shields.io/badge/Coverage-86.78%25-yellow.svg "Make me better!") | ![Functions](https://img.shields.io/badge/Coverage-88.99%25-yellow.svg "Make me better!") | ![Lines](https://img.shields.io/badge/Coverage-96.51%25-brightgreen.svg "Make me better!") |
+| ![Statements](https://img.shields.io/badge/Coverage-96.59%25-brightgreen.svg "Make me better!") | ![Branches](https://img.shields.io/badge/Coverage-86.4%25-yellow.svg "Make me better!") | ![Functions](https://img.shields.io/badge/Coverage-89.19%25-yellow.svg "Make me better!") | ![Lines](https://img.shields.io/badge/Coverage-96.59%25-brightgreen.svg "Make me better!") |
 
 > A declarative and [axios](https://github.com/axios/axios) based retrofit implementation for JavaScript and TypeScript.
 

src/baseService.ts

@@ -180,6 +180,14 @@ export class BaseService {
     }
     // timeout
     config.timeout = this.__meta__[methodName].timeout || this._timeout;
+    // deprecated
+    if (this.__meta__[methodName].deprecated) {
+      let hint = `[warning] Deprecated method: "${methodName}". `;
+      if (this.__meta__[methodName].deprecatedHint) {
+        hint += this.__meta__[methodName].deprecatedHint;
+      }
+      console.warn(hint);
+    }
     // mix in config set by @Config
     config = {
       ...config,
@@ -373,20 +381,17 @@ export class ServiceBuilder {
     return this;
   }
 
-  // 单例模式
   public setStandalone(standalone: boolean | AxiosInstance): ServiceBuilder {
     this._standalone = standalone;
     return this;
   }
 
-  // 插入请求拦截器
   public setRequestInterceptors(...interceptors: Array<RequestInterceptorFunction | RequestInterceptor>)
     : ServiceBuilder {
     this._requestInterceptors.push(...interceptors);
     return this;
   }
 
-  // 插入应答拦截器
   public setResponseInterceptors(...interceptors: Array<ResponseInterceptorFunction | ResponseInterceptor>)
     : ServiceBuilder {
     this._responseInterceptors.push(...interceptors);
@@ -429,8 +434,8 @@ export class ServiceBuilder {
 }
 
 class HttpClient {
-  private axios: AxiosInstance = axios;
-  private standalone: boolean = false;
+  private readonly axios: AxiosInstance = axios;
+  private readonly standalone: boolean = false;
 
   constructor(builder: ServiceBuilder) {
     if (builder.standalone === true) {

src/decorators.ts

@@ -448,3 +448,17 @@ export const GraphQLVariables = (target: any, methodName: string, paramIndex: nu
   ensureMeta(target, methodName);
   target.__meta__[methodName].gqlVariablesIndex = paramIndex;
 };
+
+/**
+ * Mark method as deprecated
+ * @param hint
+ * @sample @Deprecated("This method is deprecated on version 2.0, please use xxx.")
+ * @constructor
+ */
+export const Deprecated = (hint?: string) => {
+  return (target: any, methodName: string, descriptor: PropertyDescriptor) => {
+    ensureMeta(target, methodName);
+    target.__meta__[methodName].deprecated = true;
+    target.__meta__[methodName].deprecatedHint = hint;
+  };
+};

test/dataResolver.test.ts

@@ -1,7 +1,12 @@
+import * as fs from "fs";
 import {
-  BaseDataResolver, FormUrlencodedResolver, MultiPartResolver, JsonResolver, TextXmlResolver, DataResolverFactory,
+  BaseDataResolver,
+  FormUrlencodedResolver,
+  MultiPartResolver,
+  JsonResolver,
+  TextXmlResolver,
+  DataResolverFactory,
 } from "../src/dataResolver";
-import * as fs from "fs";
 
 describe("Test data resolver.", () => {
   test("Test BaseDataResolver.", async () => {

test/fixture/fixtures.ts

@@ -1,7 +1,7 @@
 import {
   GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, BasePath, Header, Queries, Headers, Path, Query, QueryMap, Body,
   FormUrlEncoded, Field, FieldMap, Multipart, ResponseType, Part, PartDescriptor, BaseService, Response, HeaderMap,
-  RequestTransformer, ResponseTransformer, Timeout, ResponseStatus, Config, GraphQL, GraphQLVariables
+  RequestTransformer, ResponseTransformer, Timeout, ResponseStatus, Config, GraphQL, GraphQLVariables, Deprecated,
 } from "../../src";
 
 export const TEST_SERVER_HOST = "http://localhost";
@@ -75,6 +75,10 @@ export class UserService extends BaseService {
 
   @OPTIONS("/users/{userId}")
   async optionsUser(@Header("X-Token") token: string, @Path("userId") userId: number): Promise<Response> { return <Response>{} };
+
+  @GET("/users/{userId}/pets")
+  @Deprecated("This method is deprecated on version v2.")
+  async getUserPets(@Header("X-Token") token: string, @Path("userId") userId: number): Promise<Response> { return <Response>{} };
 }
 
 @BasePath(API_PREFIX)

test/fixture/server.ts

@@ -141,3 +141,7 @@ app.post("/graphql", async function (req, res) {
     }
   });
 });
+
+app.get("/api/v1/users/:userId/pets", function (req, res) {
+  res.status(200).json({});
+});

test/ts-retrofit.test.ts

@@ -635,4 +635,13 @@ describe("Test ts-retrofit.", () => {
       expect(err.response.status).toEqual(404);
     }
   });
+
+  test("Test `@Deprecated` decorator.", async () => {
+    const userId = 1;
+    const userService = new ServiceBuilder()
+      .setEndpoint(TEST_SERVER_ENDPOINT)
+      .build(UserService);
+    const response = await userService.getUserPets(TOKEN, userId);
+    expect(response.config.url).toEqual(`${TEST_SERVER_ENDPOINT}${API_PREFIX}/users/1/pets`);
+  });
 });