Skip to content

Revert "Simplify building middleware chain" #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions spec/core/HTTPClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@

import { assert } from "chai";

import { Client } from "../../src/Client";
import { HTTPClient } from "../../src/HTTPClient";
import { Context } from "../../src/IContext";
import { FetchOptions } from "../../src/IFetchOptions";
import { RedirectHandlerOptions } from "../../src/middleware/options/RedirectHandlerOptions";
import { RedirectHandler } from "../../src/middleware/RedirectHandler";
import { TelemetryHandler } from "../../src/middleware/TelemetryHandler";
import { DummyHTTPMessageHandler } from "../DummyHTTPMessageHandler";

describe("HTTPClient.ts", () => {
Expand Down Expand Up @@ -72,39 +68,4 @@ describe("HTTPClient.ts", () => {
}
});
});

describe("getMiddlewareArray", () => {
it("Should work fine for a single middleware in the chain, which does have a getNext method", () => {
const telemetryHandler = new TelemetryHandler();
const tempHttpClient: HTTPClient = new HTTPClient(telemetryHandler);
assert.equal(tempHttpClient.getMiddlewareArray().length, 1);
});

it("Should work fine for a single middleware in the chain, which doesn't have a getNext method", () => {
const tempHttpClient: HTTPClient = new HTTPClient(httpMessageHandler);
assert.equal(tempHttpClient.getMiddlewareArray().length, 1);
});

it("Should work fine for a chain containing many middlewares", () => {
const telemetryHandler = new TelemetryHandler();
const redirectHandler = new RedirectHandler(new RedirectHandlerOptions());
redirectHandler.setNext(telemetryHandler);
telemetryHandler.setNext(httpMessageHandler);
const tempHttpClient: HTTPClient = new HTTPClient(redirectHandler);
assert.equal(tempHttpClient.getMiddlewareArray().length, 3);
});
});

describe("setMiddlewareArray", () => {
it("Should make a chain out of the provided array of middlewares", () => {
const telemetryHandler = new TelemetryHandler();
const redirectHandler = new RedirectHandler(new RedirectHandlerOptions());
redirectHandler.setNext(httpMessageHandler);
const tempHttpClient: HTTPClient = new HTTPClient(redirectHandler);
const middlewareArray = tempHttpClient.getMiddlewareArray();
middlewareArray.splice(1, 0, telemetryHandler);
tempHttpClient.setMiddlewareArray(middlewareArray);
assert.equal(tempHttpClient.getMiddlewareArray().length, 3);
});
});
});
19 changes: 0 additions & 19 deletions src/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import { HTTPClient } from "./HTTPClient";
import { HTTPClientFactory } from "./HTTPClientFactory";
import { ClientOptions } from "./IClientOptions";
import { Options } from "./IOptions";
import { Middleware } from "./middleware/IMiddleware";
import { validatePolyFilling } from "./ValidatePolyFilling";

export class Client {
Expand Down Expand Up @@ -104,24 +103,6 @@ export class Client {
this.httpClient = httpClient;
}

/**
* @public
* function to get the array of middlewares in use right now
* @returns An array of middlewares
*/
public getMiddlewareChain() {
return this.httpClient.getMiddlewareArray();
}

/**
* @public
* function to set the middleware chain
* @param {Middleware[]} middlewareArray - An array of middlewares
*/
public setMiddlewareChain(middlewareArray: Middleware[]) {
return this.httpClient.setMiddlewareArray(middlewareArray);
}

/**
* @public
* Entry point to make requests
Expand Down
31 changes: 0 additions & 31 deletions src/HTTPClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,37 +33,6 @@ export class HTTPClient {
this.middleware = middleware;
}

/**
* @public
* To get an array of Middleware, used in middleware chain
* @returns An array of middlewares
*/
public getMiddlewareArray(): Middleware[] {
const middlewareArray: Middleware[] = [];
let currentMiddleware = this.middleware;
while (currentMiddleware) {
middlewareArray.push(currentMiddleware);
if (typeof currentMiddleware.getNext !== "undefined") {
currentMiddleware = currentMiddleware.getNext();
} else {
break;
}
}
return middlewareArray;
}

/**
* @public
* To set the middleware chain
* @param {Middleware[]} middlewareArray - The array containing the middlewares
*/
public setMiddlewareArray(middlewareArray: Middleware[]) {
for (let num = 0; num < middlewareArray.length - 1; num += 1) {
middlewareArray[num].setNext(middlewareArray[num + 1]);
}
this.middleware = middlewareArray[0];
}

/**
* @public
* @async
Expand Down
9 changes: 0 additions & 9 deletions src/middleware/AuthenticationHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,4 @@ export class AuthenticationHandler implements Middleware {
public setNext(next: Middleware): void {
this.nextMiddleware = next;
}

/**
* @public
* To get the next middleware in the chain
* @returns next Middleware instance
*/
public getNext(): Middleware {
return this.nextMiddleware;
}
}
1 change: 0 additions & 1 deletion src/middleware/IMiddleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,4 @@ import { Context } from "../IContext";
export interface Middleware {
execute: (context: Context) => Promise<void>;
setNext?: (middleware: Middleware) => void;
getNext?: () => Middleware;
}
9 changes: 0 additions & 9 deletions src/middleware/RedirectHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,13 +243,4 @@ export class RedirectHandler implements Middleware {
public setNext(next: Middleware): void {
this.nextMiddleware = next;
}

/**
* @public
* To get the next middleware in the chain
* @returns next Middleware instance
*/
public getNext(): Middleware {
return this.nextMiddleware;
}
}
9 changes: 0 additions & 9 deletions src/middleware/RetryHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -216,13 +216,4 @@ export class RetryHandler implements Middleware {
public setNext(next: Middleware): void {
this.nextMiddleware = next;
}

/**
* @public
* To get the next middleware in the chain
* @returns next Middleware instance
*/
public getNext(): Middleware {
return this.nextMiddleware;
}
}
9 changes: 0 additions & 9 deletions src/middleware/TelemetryHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,4 @@ export class TelemetryHandler implements Middleware {
public setNext(next: Middleware): void {
this.nextMiddleware = next;
}

/**
* @public
* To get the next middleware in the chain
* @returns next Middleware instance
*/
public getNext(): Middleware {
return this.nextMiddleware;
}
}