feat(common): new HttpClient API
HttpClient is an evolution of the existing Angular HTTP API, which exists alongside of it in a separate package, @angular/common/http. This structure ensures that existing codebases can slowly migrate to the new API. The new API improves significantly on the ergonomics and features of the legacy API. A partial list of new features includes: * Typed, synchronous response body access, including support for JSON body types * JSON is an assumed default and no longer needs to be explicitly parsed * Interceptors allow middleware logic to be inserted into the pipeline * Immutable request/response objects * Progress events for both request upload and response download * Post-request verification & flush based testing framework
This commit is contained in:
Alex Rickabaugh
committed by
Jason Aden
Jason Aden
parent
2a7ebbe982
commit
37797e2b4e
214
packages/common/http/src/headers.ts
Executable file
214
packages/common/http/src/headers.ts
Executable file
@ -0,0 +1,214 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright Google Inc. All Rights Reserved.
|
||||
*
|
||||
* Use of this source code is governed by an MIT-style license that can be
|
||||
* found in the LICENSE file at https://angular.io/license
|
||||
*/
|
||||
|
||||
interface Update {
|
||||
name: string;
|
||||
value?: string|string[];
|
||||
op: 'a'|'s'|'d';
|
||||
}
|
||||
|
||||
/**
|
||||
* Immutable set of Http headers, with lazy parsing.
|
||||
* @experimental
|
||||
*/
|
||||
export class HttpHeaders {
|
||||
/**
|
||||
* Internal map of lowercase header names to values.
|
||||
*/
|
||||
private headers: Map<string, string[]>;
|
||||
|
||||
|
||||
/**
|
||||
* Internal map of lowercased header names to the normalized
|
||||
* form of the name (the form seen first).
|
||||
*/
|
||||
private normalizedNames: Map<string, string> = new Map();
|
||||
|
||||
/**
|
||||
* Complete the lazy initialization of this object (needed before reading).
|
||||
*/
|
||||
private lazyInit: HttpHeaders|Function|null;
|
||||
|
||||
/**
|
||||
* Queued updates to be materialized the next initialization.
|
||||
*/
|
||||
private lazyUpdate: Update[]|null = null;
|
||||
|
||||
constructor(headers?: string|{[name: string]: string | string[]}) {
|
||||
if (!headers) {
|
||||
this.headers = new Map<string, string[]>();
|
||||
} else if (typeof headers === 'string') {
|
||||
this.lazyInit = () => {
|
||||
this.headers = new Map<string, string[]>();
|
||||
headers.split('\n').forEach(line => {
|
||||
const index = line.indexOf(':');
|
||||
if (index > 0) {
|
||||
const name = line.slice(0, index);
|
||||
const key = name.toLowerCase();
|
||||
const value = line.slice(index + 1).trim();
|
||||
this.maybeSetNormalizedName(name, key);
|
||||
if (this.headers.has(key)) {
|
||||
this.headers.get(key) !.push(value);
|
||||
} else {
|
||||
this.headers.set(key, [value]);
|
||||
}
|
||||
}
|
||||
});
|
||||
};
|
||||
} else {
|
||||
this.lazyInit = () => {
|
||||
this.headers = new Map<string, string[]>();
|
||||
Object.keys(headers).forEach(name => {
|
||||
let values: string|string[] = headers[name];
|
||||
const key = name.toLowerCase();
|
||||
if (typeof values === 'string') {
|
||||
values = [values];
|
||||
}
|
||||
if (values.length > 0) {
|
||||
this.headers.set(key, values);
|
||||
this.maybeSetNormalizedName(name, key);
|
||||
}
|
||||
});
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks for existence of header by given name.
|
||||
*/
|
||||
has(name: string): boolean {
|
||||
this.init();
|
||||
|
||||
return this.headers.has(name.toLowerCase());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns first header that matches given name.
|
||||
*/
|
||||
get(name: string): string|null {
|
||||
this.init();
|
||||
|
||||
const values = this.headers.get(name.toLowerCase());
|
||||
return values && values.length > 0 ? values[0] : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the names of the headers
|
||||
*/
|
||||
keys(): string[] {
|
||||
this.init();
|
||||
|
||||
return Array.from(this.normalizedNames.values());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns list of header values for a given name.
|
||||
*/
|
||||
getAll(name: string): string[]|null {
|
||||
this.init();
|
||||
|
||||
return this.headers.get(name.toLowerCase()) || null;
|
||||
}
|
||||
|
||||
append(name: string, value: string|string[]): HttpHeaders {
|
||||
return this.clone({name, value, op: 'a'});
|
||||
}
|
||||
|
||||
set(name: string, value: string|string[]): HttpHeaders {
|
||||
return this.clone({name, value, op: 's'});
|
||||
}
|
||||
|
||||
delete (name: string, value?: string|string[]): HttpHeaders {
|
||||
return this.clone({name, value, op: 'd'});
|
||||
}
|
||||
|
||||
private maybeSetNormalizedName(name: string, lcName: string): void {
|
||||
if (!this.normalizedNames.has(lcName)) {
|
||||
this.normalizedNames.set(lcName, name);
|
||||
}
|
||||
}
|
||||
|
||||
private init(): void {
|
||||
if (!!this.lazyInit) {
|
||||
if (this.lazyInit instanceof HttpHeaders) {
|
||||
this.copyFrom(this.lazyInit);
|
||||
} else {
|
||||
this.lazyInit();
|
||||
}
|
||||
this.lazyInit = null;
|
||||
if (!!this.lazyUpdate) {
|
||||
this.lazyUpdate.forEach(update => this.applyUpdate(update));
|
||||
this.lazyUpdate = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private copyFrom(other: HttpHeaders) {
|
||||
other.init();
|
||||
Array.from(other.headers.keys()).forEach(key => {
|
||||
this.headers.set(key, other.headers.get(key) !);
|
||||
this.normalizedNames.set(key, other.normalizedNames.get(key) !);
|
||||
});
|
||||
}
|
||||
|
||||
private clone(update: Update): HttpHeaders {
|
||||
const clone = new HttpHeaders();
|
||||
clone.lazyInit =
|
||||
(!!this.lazyInit && this.lazyInit instanceof HttpHeaders) ? this.lazyInit : this;
|
||||
clone.lazyUpdate = (this.lazyUpdate || []).concat([update]);
|
||||
return clone;
|
||||
}
|
||||
|
||||
private applyUpdate(update: Update): void {
|
||||
const key = update.name.toLowerCase();
|
||||
switch (update.op) {
|
||||
case 'a':
|
||||
case 's':
|
||||
let value = update.value !;
|
||||
if (typeof value === 'string') {
|
||||
value = [value];
|
||||
}
|
||||
if (value.length === 0) {
|
||||
return;
|
||||
}
|
||||
this.maybeSetNormalizedName(update.name, key);
|
||||
const base = (update.op === 'a' ? this.headers.get(key) : undefined) || [];
|
||||
base.push(...value);
|
||||
this.headers.set(key, base);
|
||||
break;
|
||||
case 'd':
|
||||
const toDelete = update.value as string | undefined;
|
||||
if (!toDelete) {
|
||||
this.headers.delete(key);
|
||||
this.normalizedNames.delete(key);
|
||||
} else {
|
||||
let existing = this.headers.get(key);
|
||||
if (!existing) {
|
||||
return;
|
||||
}
|
||||
existing = existing.filter(value => toDelete.indexOf(value) === -1);
|
||||
if (existing.length === 0) {
|
||||
this.headers.delete(key);
|
||||
this.normalizedNames.delete(key);
|
||||
} else {
|
||||
this.headers.set(key, existing);
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
forEach(fn: (name: string, values: string[]) => void) {
|
||||
this.init();
|
||||
Array.from(this.normalizedNames.keys())
|
||||
.forEach(key => fn(this.normalizedNames.get(key) !, this.headers.get(key) !));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user