revert: feat: allow providing Matomo in lazy-loaded components/modules (#98)

This reverts commit 45a5a0e.

Author: EmmanuelRoux

angular.json

@@ -27,8 +27,7 @@
           "options": {
             "main": "projects/ngx-matomo-client/test.ts",
             "tsConfig": "projects/ngx-matomo-client/tsconfig.spec.json",
-            "karmaConfig": "projects/ngx-matomo-client/karma.conf.js",
-            "codeCoverageExclude": ["projects/ngx-matomo-client/core/testing/**"]
+            "karmaConfig": "projects/ngx-matomo-client/karma.conf.js"
           }
         },
         "lint": {

projects/demo/src/app/app.component.spec.ts

@@ -1,7 +1,7 @@
 import { NO_ERRORS_SCHEMA } from '@angular/core';
 import { TestBed } from '@angular/core/testing';
 import { RouterTestingModule } from '@angular/router/testing';
-import { MatomoModule, MatomoRouterModule } from 'ngx-matomo-client';
+import { MatomoConfiguration, MatomoRouterModule, MatomoModule } from 'ngx-matomo-client';
 import { AppComponent } from './app.component';
 
 describe('AppComponent', () => {
@@ -12,8 +12,8 @@ describe('AppComponent', () => {
         MatomoModule.forRoot({
           trackerUrl: '',
           siteId: '',
-        }),
-        MatomoRouterModule.forRoot(),
+        } as MatomoConfiguration),
+        MatomoRouterModule,
       ],
       declarations: [AppComponent],
       schemas: [NO_ERRORS_SCHEMA],

projects/ngx-matomo-client/core/directives/matomo-opt-out-form.component.spec.ts

@@ -1,13 +1,14 @@
 import { Component, LOCALE_ID } from '@angular/core';
 import { fakeAsync, flush, TestBed } from '@angular/core/testing';
 import { By, DomSanitizer, SafeResourceUrl } from '@angular/platform-browser';
-import { provideMatomo } from '../providers';
-import { provideTestingTracker } from '../testing/testing-tracker';
 import {
   ASYNC_INTERNAL_MATOMO_CONFIGURATION,
   INTERNAL_MATOMO_CONFIGURATION,
   InternalMatomoConfiguration,
+  MATOMO_CONFIGURATION,
+  MatomoConfiguration,
 } from '../tracker/configuration';
+import { MatomoInitializerService } from '../tracker/matomo-initializer.service';
 import { MatomoOptOutFormComponent } from './matomo-opt-out-form.component';
 
 @Component({
@@ -101,14 +102,18 @@ describe('MatomoOptOutFormComponent', () => {
         HostWithoutLocaleComponent,
       ],
       providers: [
-        provideMatomo({ siteId: 1, trackerUrl: 'http://localhost' }),
-        provideTestingTracker(),
+        {
+          provide: MATOMO_CONFIGURATION,
+          useValue: { siteId: 1, trackerUrl: 'http://localhost' } as MatomoConfiguration,
+        },
         {
           provide: LOCALE_ID,
           useValue: 'en',
         },
       ],
     }).compileComponents();
+
+    TestBed.inject(MatomoInitializerService).initialize();
   });
 
   it('should create', async () => {

projects/ngx-matomo-client/core/private-api.ts

@@ -12,8 +12,4 @@ export {
   isAutoConfigurationMode as ɵisAutoConfigurationMode,
 } from './tracker/configuration';
 export { InternalMatomoTracker as ɵInternalMatomoTracker } from './tracker/internal-matomo-tracker.service';
-export {
-  provideTestingTracker as ɵprovideTestingTracker,
-  MatomoTestingTracker as ɵMatomoTestingTracker,
-} from './testing/testing-tracker';
 export { createMatomoFeature as ɵcreateMatomoFeature } from './providers';

projects/ngx-matomo-client/core/providers.spec.ts

@@ -21,11 +21,11 @@ describe('providers', () => {
     const config: MatomoConfiguration = { trackerUrl: 'my-tracker', siteId: 42 };
 
     await setUp([
-      provideMatomo(config),
       {
         provide: MatomoInitializerService,
         useValue: fakeInitializer,
       },
+      provideMatomo(config),
     ]);
 
     expect(TestBed.inject(MatomoTracker)).toEqual(jasmine.any(MatomoTracker));
@@ -40,7 +40,6 @@ describe('providers', () => {
     const trackerUrlToken = new InjectionToken<string>('trackerUrl');
 
     await setUp([
-      provideMatomo(() => ({ trackerUrl: TestBed.inject(trackerUrlToken), siteId: 42 })),
       {
         provide: MatomoInitializerService,
         useValue: fakeInitializer,
@@ -49,6 +48,7 @@ describe('providers', () => {
         provide: trackerUrlToken,
         useValue: trackerUrl,
       },
+      provideMatomo(() => ({ trackerUrl: TestBed.inject(trackerUrlToken), siteId: 42 })),
     ]);
 
     expect(TestBed.inject(MatomoTracker)).toEqual(jasmine.any(MatomoTracker));

projects/ngx-matomo-client/core/providers.ts

@@ -5,26 +5,9 @@ import {
   makeEnvironmentProviders,
   Provider,
 } from '@angular/core';
-import {
-  ASYNC_INTERNAL_MATOMO_CONFIGURATION,
-  createDeferredInternalMatomoConfiguration,
-  createInternalMatomoConfiguration,
-  DEFERRED_INTERNAL_MATOMO_CONFIGURATION,
-  INTERNAL_MATOMO_CONFIGURATION,
-  MATOMO_CONFIGURATION,
-  MatomoConfiguration,
-} from './tracker/configuration';
-import {
-  createInternalMatomoTracker,
-  InternalMatomoTracker,
-} from './tracker/internal-matomo-tracker.service';
-import {
-  createMatomoInitializer,
-  MatomoInitializerService,
-} from './tracker/matomo-initializer.service';
-import { MatomoTracker } from './tracker/matomo-tracker.service';
+import { MATOMO_CONFIGURATION, MatomoConfiguration } from './tracker/configuration';
+import { MatomoInitializerService } from './tracker/matomo-initializer.service';
 import { MATOMO_SCRIPT_FACTORY, MatomoScriptFactory } from './tracker/script-factory';
-import { ScriptInjector } from './utils/script-injector';
 
 const PRIVATE_MATOMO_PROVIDERS = Symbol('MATOMO_PROVIDERS');
 const PRIVATE_MATOMO_CHECKS = Symbol('MATOMO_CHECKS');
@@ -91,28 +74,6 @@ export function provideMatomo(
   ...features: MatomoFeature[]
 ): EnvironmentProviders {
   const providers: Provider[] = [
-    MatomoTracker,
-    ScriptInjector,
-    {
-      provide: InternalMatomoTracker,
-      useFactory: createInternalMatomoTracker,
-    },
-    {
-      provide: MatomoInitializerService,
-      useFactory: createMatomoInitializer,
-    },
-    {
-      provide: INTERNAL_MATOMO_CONFIGURATION,
-      useFactory: createInternalMatomoConfiguration,
-    },
-    {
-      provide: DEFERRED_INTERNAL_MATOMO_CONFIGURATION,
-      useFactory: createDeferredInternalMatomoConfiguration,
-    },
-    {
-      provide: ASYNC_INTERNAL_MATOMO_CONFIGURATION,
-      useFactory: () => inject(DEFERRED_INTERNAL_MATOMO_CONFIGURATION).configuration,
-    },
     {
       provide: ENVIRONMENT_INITIALIZER,
       multi: true,

projects/ngx-matomo-client/core/testing/testing-tracker.ts

@@ -20,61 +20,69 @@ export const MATOMO_CONFIGURATION = new InjectionToken<MatomoConfiguration>('MAT
  */
 export const INTERNAL_MATOMO_CONFIGURATION = new InjectionToken<InternalMatomoConfiguration>(
   'INTERNAL_MATOMO_CONFIGURATION',
+  {
+    factory(): InternalMatomoConfiguration {
+      const { mode, requireConsent, ...restConfig } = requireNonNull(
+        inject(MATOMO_CONFIGURATION, { optional: true }),
+        CONFIG_NOT_FOUND,
+      );
+
+      return {
+        mode: mode ? coerceInitializationMode(mode) : undefined,
+        disabled: false,
+        enableLinkTracking: true,
+        trackAppInitialLoad: !inject(MATOMO_ROUTER_ENABLED),
+        requireConsent: requireConsent ? coerceConsentRequirement(requireConsent) : 'none',
+        enableJSErrorTracking: false,
+        runOutsideAngularZone: false,
+        disableCampaignParameters: false,
+        acceptDoNotTrack: false,
+        ...restConfig,
+      };
+    },
+  },
 );
 
-export function createInternalMatomoConfiguration(): InternalMatomoConfiguration {
-  const { mode, requireConsent, ...restConfig } = requireNonNull(
-    inject(MATOMO_CONFIGURATION, { optional: true }),
-    CONFIG_NOT_FOUND,
-  );
-
-  return {
-    mode: mode ? coerceInitializationMode(mode) : undefined,
-    disabled: false,
-    enableLinkTracking: true,
-    trackAppInitialLoad: !inject(MATOMO_ROUTER_ENABLED),
-    requireConsent: requireConsent ? coerceConsentRequirement(requireConsent) : 'none',
-    enableJSErrorTracking: false,
-    runOutsideAngularZone: false,
-    disableCampaignParameters: false,
-    acceptDoNotTrack: false,
-    ...restConfig,
-  };
-}
-
 /**
  * For internal use only. Injection token for deferred {@link InternalMatomoConfiguration}.
  *
  */
 export const DEFERRED_INTERNAL_MATOMO_CONFIGURATION =
-  new InjectionToken<DeferredInternalMatomoConfiguration>('DEFERRED_INTERNAL_MATOMO_CONFIGURATION');
-
-export function createDeferredInternalMatomoConfiguration(): DeferredInternalMatomoConfiguration {
-  const base = inject(INTERNAL_MATOMO_CONFIGURATION);
-  let resolveFn: ((configuration: InternalMatomoConfiguration) => void) | undefined;
-  const configuration = new Promise<InternalMatomoConfiguration>(resolve => (resolveFn = resolve));
-
-  return {
-    configuration,
-    markReady(configuration) {
-      requireNonNull(
-        resolveFn,
-        'resolveFn',
-      )({
-        ...base,
-        ...configuration,
-      });
+  new InjectionToken<DeferredInternalMatomoConfiguration>(
+    'DEFERRED_INTERNAL_MATOMO_CONFIGURATION',
+    {
+      factory: () => {
+        const base = inject(INTERNAL_MATOMO_CONFIGURATION);
+        let resolveFn: ((configuration: InternalMatomoConfiguration) => void) | undefined;
+        const configuration = new Promise<InternalMatomoConfiguration>(
+          resolve => (resolveFn = resolve),
+        );
+
+        return {
+          configuration,
+          markReady(configuration) {
+            requireNonNull(
+              resolveFn,
+              'resolveFn',
+            )({
+              ...base,
+              ...configuration,
+            } as InternalMatomoConfiguration);
+          },
+        };
+      },
     },
-  };
-}
+  );
 
 /**
  * For internal use only. Injection token for fully loaded async {@link InternalMatomoConfiguration}.
  *
  */
 export const ASYNC_INTERNAL_MATOMO_CONFIGURATION = new InjectionToken<
   Promise<InternalMatomoConfiguration>
->('ASYNC_INTERNAL_MATOMO_CONFIGURATION');
+>('ASYNC_INTERNAL_MATOMO_CONFIGURATION', {
+  factory: () => inject(DEFERRED_INTERNAL_MATOMO_CONFIGURATION).configuration,
+});
 
 /**
  * For internal use only. Module configuration merged with default values.
@@ -89,7 +97,7 @@ export type InternalMatomoConfiguration = Omit<MatomoConfiguration, 'mode' | 're
 export interface DeferredInternalMatomoConfiguration {
   readonly configuration: Promise<InternalMatomoConfiguration>;
 
-  markReady(configuration: InternalMatomoConfiguration): void;
+  markReady(configuration: AutoMatomoConfiguration<'auto' | 'deferred'>): void;
 }
 
 /**

projects/ngx-matomo-client/core/tracker/configuration.ts

@@ -18,7 +18,7 @@ function trimTrailingUndefinedElements<T>(array: T[]): T[] {
   return trimmed;
 }
 
-export type InternalMatomoTrackerType = Pick<
+type InternalMatomoTrackerType = Pick<
   InternalMatomoTracker<unknown, string>,
   'get' | 'push' | 'pushFn'
 >;
@@ -30,7 +30,10 @@ export function createInternalMatomoTracker(): InternalMatomoTrackerType {
   return disabled || !isBrowser ? new NoopMatomoTracker() : new InternalMatomoTracker();
 }
 
-@Injectable()
+@Injectable({
+  providedIn: 'root',
+  useFactory: createInternalMatomoTracker,
+})
 export class InternalMatomoTracker<MATOMO, PREFIX extends string = ''> {
   private readonly ngZone = inject(NgZone);
   private readonly config = inject(INTERNAL_MATOMO_CONFIGURATION);
@@ -67,7 +70,6 @@ export class InternalMatomoTracker<MATOMO, PREFIX extends string = ''> {
   }
 }
 
-@Injectable()
 export class NoopMatomoTracker<MATOMO = unknown, PREFIX extends string = ''>
   implements InternalMatomoTrackerType
 {