refactor(tracker): replace init() method with initialized() for namin…

…g consistency Cherry-picked from 8e23baf DEPRECATION: Method `MatomoInitializerService.init()` has been deprecated. Use `MatomoInitializerService.initialize()` instead.
EmmanuelRoux · Jul 22, 2022 · 30c415d · 30c415d
1 parent 77a377f
commit 30c415d
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 19 deletions.
diff --git a/projects/tracker/src/lib/matomo-initializer.service.spec.ts b/projects/tracker/src/lib/matomo-initializer.service.spec.ts
@@ -84,7 +84,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'trackPageView');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.trackPageView).toHaveBeenCalledOnceWith();
@@ -102,7 +102,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'enableLinkTracking');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.enableLinkTracking).toHaveBeenCalledOnceWith();
@@ -122,7 +122,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'setDoNotTrack');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.trackPageView).toHaveBeenCalledOnceWith();
@@ -144,7 +144,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'requireConsent');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.trackPageView).toHaveBeenCalledOnceWith();
@@ -166,7 +166,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'requireCookieConsent');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.trackPageView).toHaveBeenCalledOnceWith();
@@ -187,7 +187,7 @@ describe('MatomoInitializerService', () => {
     spyOn(tracker, 'enableJSErrorTracking');
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(tracker.trackPageView).toHaveBeenCalledTimes(1);
@@ -234,7 +234,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://fakeTrackerUrl/matomo.js');
@@ -256,7 +256,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://fakeTrackerUrl/matomo.js');
@@ -276,7 +276,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://myCustomScriptUrl');
@@ -296,7 +296,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://myCustomScript.js');
@@ -322,7 +322,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://fakeTrackerUrl1/matomo.js');
@@ -355,7 +355,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expectInjectedScript(injectedScript, 'http://fakeTrackerUrl1/matomo.js');
@@ -381,7 +381,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
     service.initializeTracker({ trackerUrl: '', siteId: '' });
 
     // Then
@@ -406,7 +406,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(injectedScript).toBeUndefined();
@@ -445,7 +445,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
 
     // Then
     expect(injectedScript?.src).toMatch('^(.+://[^/]+)?/fake/script/url$');
@@ -467,7 +467,7 @@ describe('MatomoInitializerService', () => {
     setUpScriptInjection(script => (injectedScript = script));
 
     // When
-    service.init();
+    service.initialize();
     // Then
     expect(injectedScript).toBeFalsy();
     expect(tracker.setTrackerUrl).not.toHaveBeenCalled();
@@ -501,4 +501,20 @@ describe('MatomoInitializerService', () => {
       ALREADY_INJECTED_ERROR
     );
   });
+
+  it('should map deprecated init() method to initialize()', () => {
+    // Given
+    const service = instantiate({
+      trackerUrl: '',
+      siteId: '',
+    });
+
+    spyOn(service, 'initialize');
+
+    // When
+    service.init();
+
+    // Then
+    expect(service.initialize).toHaveBeenCalledOnceWith();
+  });
 });
diff --git a/projects/tracker/src/lib/matomo-initializer.service.ts b/projects/tracker/src/lib/matomo-initializer.service.ts
@@ -49,9 +49,9 @@ export function createMatomoInitializer(
 }
 
 export class NoopMatomoInitializer
-  implements Pick<MatomoInitializerService, 'init' | 'initializeTracker'>
+  implements Pick<MatomoInitializerService, 'initialize' | 'initializeTracker'>
 {
-  init(): void {
+  initialize(): void {
     // No-op
   }
 
@@ -87,7 +87,12 @@ export class MatomoInitializerService {
     initializeMatomoHolder();
   }
 
+  /** @deprecated use {@link initialize initialize()} instead */
   init(): void {
+    this.initialize();
+  }
+
+  initialize(): void {
     this.runPreInitTasks();
 
     if (isAutoConfigurationMode(this.config)) {

diff --git a/projects/tracker/src/lib/ngx-matomo-tracker.module.ts b/projects/tracker/src/lib/ngx-matomo-tracker.module.ts
@@ -17,7 +17,7 @@ export class NgxMatomoTrackerModule {
   ) {
     if (!parent) {
       // Do not initialize if it is already (by a parent module)
-      this.initializer.init();
+      this.initializer.initialize();
     }
   }