e0028e5741
With this change we move `XhrFactory` to the root entrypoint of `@angular/commmon`, this is needed so that we can configure `XhrFactory` DI token at a platform level, and not add a dependency between `@angular/platform-browser` and `@angular/common/http`.
Currently, when using `HttpClientModule` in a child module on the server, `ReferenceError: XMLHttpRequest is not defined` is being thrown because the child module has its own Injector and causes `XhrFactory` provider to be configured to use `BrowserXhr`.
Therefore, we should configure the `XhrFactory` at a platform level similar to other Browser specific providers.
BREAKING CHANGE:
`XhrFactory` has been moved from `@angular/common/http` to `@angular/common`.
**Before**
```ts
import {XhrFactory} from '@angular/common/http';
```
**After**
```ts
import {XhrFactory} from '@angular/common';
```
Closes #41311
PR Close #41313
67 lines
2.5 KiB
TypeScript
67 lines
2.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC 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
|
|
*/
|
|
|
|
import {XhrFactory} from '@angular/common';
|
|
import {HttpBackend} from '@angular/common/http';
|
|
import {ModuleWithProviders, NgModule, Type} from '@angular/core';
|
|
|
|
import {HttpClientBackendService} from './http-client-backend-service';
|
|
import {InMemoryBackendConfig, InMemoryBackendConfigArgs, InMemoryDbService} from './interfaces';
|
|
|
|
// Internal - Creates the in-mem backend for the HttpClient module
|
|
// AoT requires factory to be exported
|
|
export function httpClientInMemBackendServiceFactory(
|
|
dbService: InMemoryDbService, options: InMemoryBackendConfig,
|
|
xhrFactory: XhrFactory): HttpBackend {
|
|
return new HttpClientBackendService(dbService, options, xhrFactory) as HttpBackend;
|
|
}
|
|
|
|
@NgModule()
|
|
export class HttpClientInMemoryWebApiModule {
|
|
/**
|
|
* Redirect the Angular `HttpClient` XHR calls
|
|
* to in-memory data store that implements `InMemoryDbService`.
|
|
* with class that implements InMemoryDbService and creates an in-memory database.
|
|
*
|
|
* Usually imported in the root application module.
|
|
* Can import in a lazy feature module too, which will shadow modules loaded earlier
|
|
*
|
|
* @param dbCreator - Class that creates seed data for in-memory database. Must implement
|
|
* InMemoryDbService.
|
|
* @param [options]
|
|
*
|
|
* @example
|
|
* HttpInMemoryWebApiModule.forRoot(dbCreator);
|
|
* HttpInMemoryWebApiModule.forRoot(dbCreator, {useValue: {delay:600}});
|
|
*/
|
|
static forRoot(dbCreator: Type<InMemoryDbService>, options?: InMemoryBackendConfigArgs):
|
|
ModuleWithProviders<HttpClientInMemoryWebApiModule> {
|
|
return {
|
|
ngModule: HttpClientInMemoryWebApiModule,
|
|
providers: [
|
|
{provide: InMemoryDbService, useClass: dbCreator},
|
|
{provide: InMemoryBackendConfig, useValue: options}, {
|
|
provide: HttpBackend,
|
|
useFactory: httpClientInMemBackendServiceFactory,
|
|
deps: [InMemoryDbService, InMemoryBackendConfig, XhrFactory]
|
|
}
|
|
]
|
|
};
|
|
}
|
|
/**
|
|
*
|
|
* Enable and configure the in-memory web api in a lazy-loaded feature module.
|
|
* Same as `forRoot`.
|
|
* This is a feel-good method so you can follow the Angular style guide for lazy-loaded modules.
|
|
*/
|
|
static forFeature(dbCreator: Type<InMemoryDbService>, options?: InMemoryBackendConfigArgs):
|
|
ModuleWithProviders<HttpClientInMemoryWebApiModule> {
|
|
return HttpClientInMemoryWebApiModule.forRoot(dbCreator, options);
|
|
}
|
|
}
|