fix(core): remove duplicated load of config BREAKING CHANGE

- The behavior is change call the forRoot to call the provideConfig and provideTranslation. - provideConfigLoader and provideConfigOptions is remove call provideConfig directly
infra-geo-ouverte · Apr 11, 2024 · ae2dd97 · ae2dd97
1 parent 04fd431
commit ae2dd97
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 39 deletions.
diff --git a/packages/core/config/src/config.module.ts b/packages/core/config/src/config.module.ts
@@ -1,7 +1,10 @@
 import { ModuleWithProviders, NgModule } from '@angular/core';
 
-import { provideConfigLoader, provideConfigOptions } from './config.provider';
+import { provideConfig } from './config.provider';
 
+/**
+ * @deprecated import the provideConfig directly
+ */
 @NgModule({
   imports: [],
   declarations: [],
@@ -11,7 +14,7 @@ export class IgoConfigModule {
   static forRoot(): ModuleWithProviders<IgoConfigModule> {
     return {
       ngModule: IgoConfigModule,
-      providers: [provideConfigOptions({}), provideConfigLoader()]
+      providers: [provideConfig({})]
     };
   }
 }
diff --git a/packages/core/config/src/config.provider.ts b/packages/core/config/src/config.provider.ts
@@ -1,29 +1,30 @@
-import { APP_INITIALIZER, InjectionToken } from '@angular/core';
+import {
+  APP_INITIALIZER,
+  EnvironmentProviders,
+  InjectionToken,
+  makeEnvironmentProviders
+} from '@angular/core';
 
 import { ConfigOptions } from './config.interface';
 import { ConfigService } from './config.service';
 
 export let CONFIG_OPTIONS = new InjectionToken<ConfigOptions>('configOptions');
 
-export function provideConfigOptions(options: ConfigOptions) {
-  return {
-    provide: CONFIG_OPTIONS,
-    useValue: options
-  };
+export function provideConfig(options: ConfigOptions): EnvironmentProviders {
+  return makeEnvironmentProviders([
+    {
+      provide: CONFIG_OPTIONS,
+      useValue: options
+    },
+    {
+      provide: APP_INITIALIZER,
+      useFactory: configFactory,
+      multi: true,
+      deps: [ConfigService, CONFIG_OPTIONS]
+    }
+  ]);
 }
 
-export function configFactory(
-  configService: ConfigService,
-  options: ConfigOptions
-) {
+function configFactory(configService: ConfigService, options: ConfigOptions) {
   return () => configService.load(options);
 }
-
-export function provideConfigLoader() {
-  return {
-    provide: APP_INITIALIZER,
-    useFactory: configFactory,
-    multi: true,
-    deps: [ConfigService, CONFIG_OPTIONS]
-  };
-}
diff --git a/packages/core/config/src/config.service.ts b/packages/core/config/src/config.service.ts
@@ -97,6 +97,7 @@ export class ConfigService<T extends object = { [key: string]: any }> {
         .pipe(
           catchError((error: any): any => {
             console.log(`Configuration file ${options.path} could not be read`);
+            this._isLoaded$.next(false);
             resolve(true);
             return throwError(error.error || 'Server error');
           })

diff --git a/packages/core/language/src/shared/language.provider.ts b/packages/core/language/src/shared/language.provider.ts
@@ -16,26 +16,35 @@ import {
   TranslateModuleConfig
 } from '@ngx-translate/core';
 import { first } from 'rxjs';
+import { catchError, timeout } from 'rxjs/operators';
 
 import { LanguageLoaderBase } from './language.interface';
 import { LanguageLoader } from './language.loader';
 import { LanguageService } from './language.service';
 import { IgoMissingTranslationHandler } from './missing-translation.guard';
 
+// 5 seconds
+const TIMEOUT_DURATION = 5000;
+
 /**
  * Make sure you only call this method in the root module of your application, most of the time called AppModule.
  */
-export function provideRootTranslation(
-  loader?: Provider
-): EnvironmentProviders {
+export function provideTranslation(loader?: Provider): EnvironmentProviders {
   return makeEnvironmentProviders([
     importProvidersFrom(TranslateModule.forRoot(setTranslationConfig(loader))),
     {
       provide: APP_INITIALIZER,
       useFactory: (languageService: LanguageService) => () => {
         return (
           languageService.translate.currentLoader as LanguageLoaderBase
-        ).isLoaded$?.pipe(first((isLoaded) => isLoaded === true));
+        ).isLoaded$?.pipe(
+          timeout(TIMEOUT_DURATION),
+          first((isLoaded) => isLoaded === true),
+          catchError((error) => {
+            error.message += ` - Request timed out for language loader after: ${TIMEOUT_DURATION}`;
+            throw error;
+          })
+        );
       },
       deps: [LanguageService],
       multi: true

diff --git a/packages/core/src/lib/core.module.ts b/packages/core/src/lib/core.module.ts
@@ -3,8 +3,8 @@ import { HttpClientModule } from '@angular/common/http';
 import { ModuleWithProviders, NgModule } from '@angular/core';
 
 import { IgoActivityModule } from '@igo2/core/activity';
-import { IgoConfigModule } from '@igo2/core/config';
-import { IgoLanguageModule, provideRootTranslation } from '@igo2/core/language';
+import { ConfigOptions, provideConfig } from '@igo2/core/config';
+import { IgoLanguageModule, provideTranslation } from '@igo2/core/language';
 import { IgoMessageModule } from '@igo2/core/message';
 import { IgoErrorModule } from '@igo2/core/request';
 
@@ -44,29 +44,26 @@ const dbConfig: DBConfig = {
     CommonModule,
     HttpClientModule,
     IgoActivityModule.forRoot(),
-    IgoConfigModule.forRoot(),
     IgoErrorModule.forRoot(),
     IgoMessageModule,
     NgxIndexedDBModule.forRoot(dbConfig)
   ],
-  providers: [provideRootTranslation()],
+  providers: [],
   declarations: [],
   exports: [
     IgoActivityModule,
-    IgoConfigModule,
     IgoErrorModule,
     IgoLanguageModule,
     IgoMessageModule
   ]
 })
 export class IgoCoreModule {
-  /**
-   * @deprecated it has no effect
-   */
-  static forRoot(): ModuleWithProviders<IgoCoreModule> {
+  static forRoot(
+    options: ConfigOptions = {}
+  ): ModuleWithProviders<IgoCoreModule> {
     return {
       ngModule: IgoCoreModule,
-      providers: []
+      providers: [provideConfig(options), provideTranslation()]
     };
   }
 

diff --git a/projects/demo/src/main.ts b/projects/demo/src/main.ts
@@ -25,8 +25,8 @@ import {
 import { provideAuthentification } from '@igo2/auth';
 import { provideIcon } from '@igo2/common';
 import { IgoCoreModule } from '@igo2/core';
-import { provideConfigOptions } from '@igo2/core/config';
-import { provideRootTranslation } from '@igo2/core/language';
+import { provideConfig } from '@igo2/core/config';
+import { provideTranslation } from '@igo2/core/language';
 import {
   IgoDirectionsModule,
   IgoGeoWorkspaceModule,
@@ -67,10 +67,10 @@ bootstrapApplication(AppComponent, {
     provideHttpClient(withJsonpSupport()),
     provideRouter(routes, withPreloading(PreloadAllModules)),
     provideAnimations(),
-    provideConfigOptions({
+    provideConfig({
       default: environment.igo
     }),
-    provideRootTranslation(),
+    provideTranslation(),
     provideAuthentification(),
     provideOsrmDirectionsSource(),
     provideIChercheSearchSource(),