@tech4good/angular-schematics 20.3.1 → 21.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/.agents/skills/publish-npm/SKILL.md +1 -1
  2. package/.agents/skills/publish-npm/eval.yaml +15 -0
  3. package/.agents/skills/publish-npm/fixtures/package-v21.json.template +8 -0
  4. package/.t4g/agent-memory.db +0 -0
  5. package/CHANGELOG.md +62 -0
  6. package/contributing-docs/commit-message.md +3 -6
  7. package/package.json +5 -5
  8. package/src/collection.json +8 -0
  9. package/src/component/files/__name@dasherize__/__name@dasherize__.component.ts.template +1 -3
  10. package/src/component/index_spec.js +57 -4
  11. package/src/component/index_spec.js.map +1 -1
  12. package/src/entity/index.js +7 -1
  13. package/src/entity/index.js.map +1 -1
  14. package/src/entity/index_spec.js +108 -4
  15. package/src/entity/index_spec.js.map +1 -1
  16. package/src/guard/files/__name@dasherize__.guard.spec.ts.template +45 -0
  17. package/src/guard/files/__name@dasherize__.guard.ts.template +32 -0
  18. package/src/guard/index.d.ts +2 -0
  19. package/src/guard/index.js +38 -0
  20. package/src/guard/index.js.map +1 -0
  21. package/src/guard/index_spec.d.ts +1 -0
  22. package/src/guard/index_spec.js +64 -0
  23. package/src/guard/index_spec.js.map +1 -0
  24. package/src/guard/schema.json +46 -0
  25. package/src/ng-add/files/.firebaserc.template +3 -2
  26. package/src/ng-add/files/.github/workflows/angular-github-ci.yml.template +105 -39
  27. package/src/ng-add/files/.gitignore.template +1 -2
  28. package/src/ng-add/files/angular.json.template +1 -5
  29. package/src/ng-add/files/docs-infra/infrastructure-guide.md.template +390 -0
  30. package/src/ng-add/files/docs-infra/load-system-architecture.md.template +166 -0
  31. package/src/ng-add/files/docs-infra/querying-strategy.md.template +157 -0
  32. package/src/ng-add/files/docs-infra/stream-system-architecture.md.template +283 -0
  33. package/src/ng-add/files/eslint.config.js.template +4 -1
  34. package/src/ng-add/files/firebase.json.template +37 -0
  35. package/src/ng-add/files/firestore.rules.spec.ts.template +221 -0
  36. package/src/ng-add/files/firestore.rules.template +67 -0
  37. package/src/ng-add/files/jest.config.ts.template +6 -1
  38. package/src/ng-add/files/package.json.template +41 -31
  39. package/src/ng-add/files/setup-jest.ts.template +13 -5
  40. package/src/ng-add/files/src/app/admin/admin-panel/admin-panel.component.spec.ts.template +76 -12
  41. package/src/ng-add/files/src/app/admin/admin-panel/admin-panel.component.ts.template +1 -3
  42. package/src/ng-add/files/src/app/admin/admin-panel/admin-settings/admin-settings.component.spec.ts.template +90 -0
  43. package/src/ng-add/files/src/app/admin/admin-panel/admin-settings/admin-settings.component.ts.template +1 -1
  44. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-count-pill/admin-count-pill.component.spec.ts.template +12 -17
  45. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-count-pill/admin-count-pill.component.ts.template +2 -4
  46. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-user-counts.component.spec.ts.template +40 -19
  47. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-user-counts.component.ts.template +3 -5
  48. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-list.component.html.template +2 -2
  49. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-list.component.spec.ts.template +108 -0
  50. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-list.component.ts.template +11 -11
  51. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-table/admin-user-table.component.html.template +6 -2
  52. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-table/admin-user-table.component.spec.ts.template +136 -19
  53. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-table/admin-user-table.component.ts.template +8 -5
  54. package/src/ng-add/files/src/app/app.component.html.template +1 -1
  55. package/src/ng-add/files/src/app/app.component.scss.template +10 -0
  56. package/src/ng-add/files/src/app/app.component.ts.template +1 -1
  57. package/src/ng-add/files/src/app/app.config.ts.template +11 -11
  58. package/src/ng-add/files/src/app/auth-routing.spec.ts.template +101 -0
  59. package/src/ng-add/files/src/app/core/analytics/log.service.ts.template +5 -8
  60. package/src/ng-add/files/src/app/core/analytics/time-analytics.service.spec.ts.template +140 -0
  61. package/src/ng-add/files/src/app/core/analytics/time-analytics.service.ts.template +25 -7
  62. package/src/ng-add/files/src/app/core/auth/guards/redirect-if-authenticated.guard.ts.template +1 -1
  63. package/src/ng-add/files/src/app/core/auth/guards/require-admin.guard.ts.template +1 -1
  64. package/src/ng-add/files/src/app/core/auth/guards/require-auth-and-consent.guard.ts.template +1 -1
  65. package/src/ng-add/files/src/app/core/auth/guards/require-auth.guard.ts.template +1 -1
  66. package/src/ng-add/files/src/app/core/firebase/cached-listeners.service.ts.template +229 -14
  67. package/src/ng-add/files/src/app/core/firebase/database.service.ts.template +1 -1
  68. package/src/ng-add/files/src/app/core/firebase/firebase.mock.service.ts.template +34 -9
  69. package/src/ng-add/files/src/app/core/firebase/firebase.service.ts.template +4 -4
  70. package/src/ng-add/files/src/app/core/firebase/query-logger.ts.template +11 -0
  71. package/src/ng-add/files/src/app/core/firebase/simulate-load.spec.ts.template +104 -0
  72. package/src/ng-add/files/src/app/core/firebase/simulate-stream.spec.ts.template +127 -0
  73. package/src/ng-add/files/src/app/core/firebase/simulation.mock.ts.template +38 -0
  74. package/src/ng-add/files/src/app/core/firebase/stream-multiplexer.ts.template +443 -0
  75. package/src/ng-add/files/src/app/core/store/app.store.spec.ts.template +920 -0
  76. package/src/ng-add/files/src/app/core/store/app.store.ts.template +303 -137
  77. package/src/ng-add/files/src/app/core/store/auth/auth.mock.ts.template +65 -23
  78. package/src/ng-add/files/src/app/core/store/auth/auth.store.ts.template +68 -67
  79. package/src/ng-add/files/src/app/core/store/user/user.mock.ts.template +46 -0
  80. package/src/ng-add/files/src/app/core/store/user-context/user-context.mock.ts.template +17 -0
  81. package/src/ng-add/files/src/app/core/testing/test-utils.ts.template +26 -0
  82. package/src/ng-add/files/src/app/first-time/consent/consent.component.html.template +3 -3
  83. package/src/ng-add/files/src/app/first-time/consent/consent.component.spec.ts.template +89 -13
  84. package/src/ng-add/files/src/app/first-time/consent/consent.component.ts.template +46 -17
  85. package/src/ng-add/files/src/app/first-time/consent/consent.guard.ts.template +1 -1
  86. package/src/ng-add/files/src/app/first-time/early-access/early-access.component.html.template +5 -63
  87. package/src/ng-add/files/src/app/first-time/early-access/early-access.component.scss.template +1 -94
  88. package/src/ng-add/files/src/app/first-time/early-access/early-access.component.spec.ts.template +150 -14
  89. package/src/ng-add/files/src/app/first-time/early-access/early-access.component.ts.template +15 -42
  90. package/src/ng-add/files/src/app/first-time/early-access/early-access.guard.ts.template +2 -2
  91. package/src/ng-add/files/src/app/first-time/early-access/early-access.model.ts.template +5 -0
  92. package/src/ng-add/files/src/app/first-time/early-access/survey-form/survey-form.component.html.template +42 -0
  93. package/src/ng-add/files/src/app/first-time/early-access/survey-form/survey-form.component.scss.template +96 -0
  94. package/src/ng-add/files/src/app/first-time/early-access/survey-form/survey-form.component.spec.ts.template +37 -0
  95. package/src/ng-add/files/src/app/first-time/early-access/survey-form/survey-form.component.ts.template +63 -0
  96. package/src/ng-add/files/src/app/first-time/early-access/waitlist-view/waitlist-view.component.html.template +16 -0
  97. package/src/ng-add/files/src/app/first-time/early-access/waitlist-view/waitlist-view.component.scss.template +7 -0
  98. package/src/ng-add/files/src/app/first-time/early-access/waitlist-view/waitlist-view.component.spec.ts.template +41 -0
  99. package/src/ng-add/files/src/app/first-time/early-access/waitlist-view/waitlist-view.component.ts.template +26 -0
  100. package/src/ng-add/files/src/app/first-time/first-time-routing.spec.ts.template +123 -0
  101. package/src/ng-add/files/src/app/first-time/landing/hero/hero.component.html.template +11 -4
  102. package/src/ng-add/files/src/app/first-time/landing/hero/hero.component.scss.template +17 -4
  103. package/src/ng-add/files/src/app/first-time/landing/hero/hero.component.ts.template +5 -5
  104. package/src/ng-add/files/src/app/first-time/landing/landing.component.html.template +1 -1
  105. package/src/ng-add/files/src/app/first-time/landing/landing.component.scss.template +0 -1
  106. package/src/ng-add/files/src/app/first-time/landing/landing.component.spec.ts.template +25 -17
  107. package/src/ng-add/files/src/app/first-time/landing/landing.component.ts.template +4 -12
  108. package/src/ng-add/files/src/app/first-time/landing/rotating-quotes/rotating-quotes.component.ts.template +1 -1
  109. package/src/ng-add/files/src/app/first-time/login/login.component.spec.ts.template +36 -16
  110. package/src/ng-add/files/src/app/first-time/login/login.component.ts.template +1 -1
  111. package/src/ng-add/files/src/app/first-time/onboarding/onboarding.component.spec.ts.template +11 -15
  112. package/src/ng-add/files/src/app/first-time/onboarding/onboarding.component.ts.template +1 -3
  113. package/src/ng-add/files/src/app/main/home/home.component.ts.template +1 -3
  114. package/src/ng-add/files/src/app/shared/dev-status-bar/dev-status-bar.component.spec.ts.template +98 -0
  115. package/src/ng-add/files/src/app/shared/dev-status-bar/dev-status-bar.component.ts.template +9 -3
  116. package/src/ng-add/files/src/app/shared/hint-visibility/hint-visibility.directive.spec.ts.template +164 -0
  117. package/src/ng-add/files/src/app/shared/hint-visibility/hint-visibility.directive.ts.template +20 -18
  118. package/src/ng-add/files/src/app/shared/navbar/navbar.component.spec.ts.template +38 -17
  119. package/src/ng-add/files/src/app/shared/navbar/navbar.component.ts.template +1 -1
  120. package/src/ng-add/files/src/app/shared/redeployment-warning/redeployment-warning.component.html.template +1 -1
  121. package/src/ng-add/files/src/app/shared/redeployment-warning/redeployment-warning.component.spec.ts.template +49 -10
  122. package/src/ng-add/files/src/app/shared/redeployment-warning/redeployment-warning.component.ts.template +5 -5
  123. package/src/ng-add/files/src/app/shared/redeployment-warning/redeployment-warning.service.spec.ts.template +86 -0
  124. package/src/ng-add/files/src/app/shared/redeployment-warning/redeployment-warning.service.ts.template +11 -9
  125. package/src/ng-add/files/src/environments/environment.prod.ts.template +1 -0
  126. package/src/ng-add/files/src/environments/environment.test.ts.template +1 -0
  127. package/src/ng-add/files/src/environments/environment.ts.template +2 -8
  128. package/src/ng-add/files/src/styles.scss.template +29 -1
  129. package/src/ng-add/files/tsconfig.app.json.template +6 -6
  130. package/src/ng-add/files/tsconfig.json.template +13 -8
  131. package/src/ng-add/files/tsconfig.spec.json.template +6 -5
  132. package/src/ng-add/index.js +19 -1
  133. package/src/ng-add/index.js.map +1 -1
  134. package/src/component/files/__name@dasherize__/__name@dasherize__.animations.ts.template +0 -4
  135. package/src/ng-add/files/src/app/admin/admin-panel/admin-panel.animations.ts.template +0 -4
  136. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-count-pill/admin-count-pill.animations.ts.template +0 -4
  137. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-counts/admin-user-counts.animations.ts.template +0 -4
  138. package/src/ng-add/files/src/app/admin/admin-panel/admin-user-list/admin-user-table/admin-user-table.animations.ts.template +0 -4
  139. package/src/ng-add/files/src/app/first-time/consent/consent.animations.ts.template +0 -4
  140. package/src/ng-add/files/src/app/first-time/early-access/early-access.animations.ts.template +0 -10
  141. package/src/ng-add/files/src/app/first-time/landing/hero/hero.animations.ts.template +0 -15
  142. package/src/ng-add/files/src/app/first-time/landing/landing.animations.ts.template +0 -4
  143. package/src/ng-add/files/src/app/first-time/onboarding/onboarding.animations.ts.template +0 -4
  144. package/src/ng-add/files/src/app/main/home/home.animations.ts.template +0 -4
@@ -10,7 +10,7 @@ import { DevStatusBarComponent } from './shared/dev-status-bar/dev-status-bar.co
10
10
  @Component({
11
11
  selector: 'app-root',
12
12
  templateUrl: './app.component.html',
13
- styleUrls: ['./app.component.scss'],
13
+ styleUrl: './app.component.scss',
14
14
  imports: [
15
15
  RedeploymentWarningComponent,
16
16
  DevStatusBarComponent,
@@ -1,10 +1,9 @@
1
- import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
1
+ import { ApplicationConfig, provideBrowserGlobalErrorListeners, provideZonelessChangeDetection } from '@angular/core';
2
2
  import { provideRouter, withComponentInputBinding, withPreloading, PreloadAllModules } from '@angular/router';
3
3
  import { routes } from './app.routes';
4
- import { provideAnimationsAsync } from '@angular/platform-browser/animations/async';
5
4
  import { importProvidersFrom } from '@angular/core';
6
5
  import { provideFirebaseApp, getApp, initializeApp } from '@angular/fire/app';
7
- import { provideFirestore, getFirestore, enableIndexedDbPersistence } from '@angular/fire/firestore';
6
+ import { provideFirestore, initializeFirestore, persistentLocalCache, persistentMultipleTabManager } from '@angular/fire/firestore';
8
7
  import { provideAuth, getAuth } from '@angular/fire/auth';
9
8
  import { environment } from '../environments/environment';
10
9
  import { FirebaseService } from './core/firebase/firebase.service';
@@ -20,33 +19,34 @@ import { getPerformance, providePerformance } from '@angular/fire/performance';
20
19
  const firebaseProviders = !environment.production && environment['mockDB'] ? [] : [
21
20
  provideFirebaseApp(() => initializeApp(environment.firebase)),
22
21
  provideFirestore(() => {
23
- const firestore = getFirestore();
24
- enableIndexedDbPersistence(firestore);
25
- return firestore;
22
+ return initializeFirestore(getApp(), {
23
+ localCache: persistentLocalCache({ tabManager: persistentMultipleTabManager() }),
24
+ });
26
25
  }),
27
26
  ...(environment.production ? [
28
27
  provideFirebaseApp(() => initializeApp(environment['firebaseLogs'], 'logs')),
29
28
  provideFirestore(() => {
30
- const firestore = getFirestore(getApp('logs'));
29
+ const firestore = initializeFirestore(getApp('logs'), {
30
+ localCache: persistentLocalCache({ tabManager: persistentMultipleTabManager() }),
31
+ });
31
32
  // connectFirestoreEmulator(firestore, 'localhost', 8080);
32
- enableIndexedDbPersistence(firestore);
33
33
  return firestore;
34
34
  }),
35
35
  ] : []),
36
36
  provideAuth(() => getAuth()),
37
37
  provideFunctions(() => getFunctions()),
38
- providePerformance(() => getPerformance())
38
+ providePerformance(() => getPerformance()),
39
39
  ];
40
40
 
41
41
  export const appConfig: ApplicationConfig = {
42
42
  providers: [
43
- provideZoneChangeDetection({ eventCoalescing: true }),
43
+ provideBrowserGlobalErrorListeners(),
44
+ provideZonelessChangeDetection(),
44
45
  provideRouter(
45
46
  routes,
46
47
  withComponentInputBinding(),
47
48
  withPreloading(PreloadAllModules),
48
49
  ),
49
- provideAnimationsAsync(),
50
50
  ...firebaseProviders,
51
51
  {
52
52
  provide: LOG_SERVICE,
@@ -0,0 +1,101 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { provideRouter, Router } from '@angular/router';
3
+ import { RouterTestingHarness } from '@angular/router/testing';
4
+ import { AuthService } from './core/auth/auth.service';
5
+ import { routes } from './app.routes';
6
+ import { of } from 'rxjs';
7
+ import { AccessState, User } from './core/store/user/user.model';
8
+ import { DATABASE_SERVICE } from './core/firebase/database.service';
9
+ import { FirebaseMockService } from './core/firebase/firebase.mock.service';
10
+ import { BatchWriteMockService } from './core/store/batch-write.mock.service';
11
+ import { BATCH_WRITE_SERVICE } from './core/store/batch-write.service';
12
+ import { LOG_SERVICE, LogInDevService } from './core/analytics/log.service';
13
+ import { AuthStore } from './core/store/auth/auth.store';
14
+ import { signal } from '@angular/core';
15
+
16
+ import { createMockUser } from './core/store/user/user.mock';
17
+
18
+ describe('Core Auth Routing', () => {
19
+ let harness: RouterTestingHarness;
20
+ let router: Router;
21
+ let mockAuthService: { resolveUser: jest.Mock };
22
+ let mockUserSignal: any;
23
+
24
+ beforeEach(async () => {
25
+ mockAuthService = {
26
+ resolveUser: jest.fn().mockReturnValue(of(null)),
27
+ };
28
+ mockUserSignal = signal(null);
29
+
30
+ await TestBed.configureTestingModule({
31
+ providers: [
32
+ provideRouter(routes),
33
+ { provide: AuthService, useValue: mockAuthService },
34
+ { provide: AuthStore, useValue: { user: mockUserSignal } },
35
+ { provide: DATABASE_SERVICE, useClass: FirebaseMockService },
36
+ { provide: BATCH_WRITE_SERVICE, useClass: BatchWriteMockService },
37
+ { provide: LOG_SERVICE, useClass: LogInDevService },
38
+ ],
39
+ }).compileComponents();
40
+
41
+ harness = await RouterTestingHarness.create();
42
+ router = TestBed.inject(Router);
43
+ });
44
+
45
+ describe('Guest User (Unauthenticated)', () => {
46
+ beforeEach(() => {
47
+ mockAuthService.resolveUser.mockReturnValue(of(null));
48
+ mockUserSignal.set(null);
49
+ });
50
+
51
+ it('should allow navigation to /landing', async () => {
52
+ await harness.navigateByUrl('/landing');
53
+ expect(router.url).toEqual('/landing');
54
+ });
55
+
56
+ it('should intercept navigation to /admin and redirect to /landing', async () => {
57
+ await harness.navigateByUrl('/admin');
58
+ // Wait for async routing to settle
59
+ await harness.fixture.whenStable();
60
+ expect(router.url).toEqual('/landing'); // Note: Angular might add '?' for empty query params, or '/landing'
61
+ });
62
+ });
63
+
64
+ describe('Authenticated User (Standard)', () => {
65
+ beforeEach(() => {
66
+ mockAuthService.resolveUser.mockReturnValue(of(createMockUser()));
67
+ mockUserSignal.set(createMockUser());
68
+ });
69
+
70
+ it('should intercept navigation to /landing and redirect to /home', async () => {
71
+ await harness.navigateByUrl('/landing');
72
+ await harness.fixture.whenStable();
73
+ expect(router.url).toEqual('/home');
74
+ });
75
+
76
+ it('should intercept navigation to /admin and redirect to /home', async () => {
77
+ await harness.navigateByUrl('/admin');
78
+ await harness.fixture.whenStable();
79
+ expect(router.url).toEqual('/home');
80
+ });
81
+ });
82
+
83
+ describe('Admin User', () => {
84
+ beforeEach(() => {
85
+ mockAuthService.resolveUser.mockReturnValue(of(createMockUser({ isAdmin: true, __id: 'admin1' })));
86
+ mockUserSignal.set(createMockUser({ isAdmin: true, __id: 'admin1' }));
87
+ });
88
+
89
+ it('should allow navigation to /admin', async () => {
90
+ await harness.navigateByUrl('/admin');
91
+ await harness.fixture.whenStable();
92
+ expect(router.url).toEqual('/admin');
93
+ });
94
+
95
+ it('should intercept navigation to /landing and redirect to /home', async () => {
96
+ await harness.navigateByUrl('/landing');
97
+ await harness.fixture.whenStable();
98
+ expect(router.url).toEqual('/home');
99
+ });
100
+ });
101
+ });
@@ -1,6 +1,6 @@
1
1
  import { Injectable, InjectionToken } from '@angular/core';
2
2
  import { isDevMode } from '@angular/core';
3
- import { environment } from '../../../environments/environment.prod';
3
+ import { environment } from '../../../environments/environment';
4
4
  import { Firestore, FirestoreInstances, setDoc, doc } from '@angular/fire/firestore';
5
5
  import { TimeAtRoute } from './time-analytics.service';
6
6
 
@@ -29,7 +29,6 @@ export const LOG_SERVICE = new InjectionToken<LogService>('LogService');
29
29
  providedIn: 'root',
30
30
  })
31
31
  export class LogInDevService {
32
-
33
32
  /** Whether should log to the console in dev. */
34
33
  LOG_IN_DEV = true;
35
34
 
@@ -82,12 +81,12 @@ function reformatLogForBeacon(data: LogData, logType, logId) {
82
81
  }
83
82
  };
84
83
 
85
- if (data !== null && environment.firebaseLogs['projectId']) {
84
+ if (data !== null && environment['firebaseLogs'] && environment['firebaseLogs']['projectId']) {
86
85
  const wrappedData = {
87
86
  writes: [
88
87
  {
89
88
  update: {
90
- name: `projects/${environment.firebaseLogs['projectId']}/databases/(default)/documents/${logType}/${logId}`,
89
+ name: `projects/${environment['firebaseLogs']['projectId']}/databases/(default)/documents/${logType}/${logId}`,
91
90
  fields: {
92
91
  ...jsonToDocument(data).mapValue.fields,
93
92
  },
@@ -109,12 +108,10 @@ function reformatLogForBeacon(data: LogData, logType, logId) {
109
108
  }
110
109
 
111
110
 
112
-
113
111
  @Injectable({
114
112
  providedIn: 'root',
115
113
  })
116
114
  export class LogDBService {
117
-
118
115
  private log: Firestore;
119
116
 
120
117
  constructor(
@@ -142,9 +139,9 @@ export class LogDBService {
142
139
  const logType = 'logs';
143
140
 
144
141
  if (data !== null) {
145
- if (!isDevMode() && environment.firebaseLogs['projectId']) {
142
+ if (!isDevMode() && environment['firebaseLogs'] && environment['firebaseLogs']['projectId']) {
146
143
  navigator.sendBeacon(
147
- `https://firestore.googleapis.com/v1/projects/${environment.firebaseLogs['projectId']}/databases/(default)/documents:commit`,
144
+ `https://firestore.googleapis.com/v1/projects/${environment['firebaseLogs']['projectId']}/databases/(default)/documents:commit`,
148
145
  reformatLogForBeacon(data, logType, logId),
149
146
  );
150
147
  }
@@ -0,0 +1,140 @@
1
+ import { TestBed } from '@angular/core/testing';
2
+ import { Router, NavigationEnd, Event as RouterEvent } from '@angular/router';
3
+ import { Subject, of } from 'rxjs';
4
+ import { TimeAnalyticsService } from './time-analytics.service';
5
+ import { DATABASE_SERVICE } from '../firebase/database.service';
6
+ import { LOG_SERVICE } from './log.service';
7
+ import { SessionLocalStorageService } from '../local-storage/session-local-storage.service';
8
+ import { SessionService } from '../local-storage/session.service';
9
+
10
+ describe('TimeAnalyticsService', () => {
11
+ let service: TimeAnalyticsService;
12
+ let routerEvents$: Subject<RouterEvent>;
13
+
14
+ beforeEach(() => {
15
+ routerEvents$ = new Subject<RouterEvent>();
16
+
17
+ const routerMock = {
18
+ events: routerEvents$.asObservable(),
19
+ };
20
+
21
+ const dbMock = {
22
+ afUser: jest.fn().mockReturnValue(of(null)),
23
+ };
24
+
25
+ const logMock = {
26
+ rawLog: jest.fn(),
27
+ rawLogOnBeaconEvent: jest.fn(),
28
+ };
29
+
30
+ const localMock = {
31
+ getItemForSession: jest.fn().mockReturnValue(null),
32
+ getItemForAllSessions: jest.fn().mockReturnValue([]),
33
+ setItemForSession: jest.fn(),
34
+ removeItemForAllSessions: jest.fn(),
35
+ removeItemForSession: jest.fn(),
36
+ };
37
+
38
+ const sessionMock = {
39
+ getSessionId: jest.fn().mockReturnValue('test-session-id'),
40
+ getDeviceId: jest.fn().mockReturnValue('test-device-id'),
41
+ };
42
+
43
+ TestBed.configureTestingModule({
44
+ providers: [
45
+ TimeAnalyticsService,
46
+ { provide: Router, useValue: routerMock },
47
+ { provide: DATABASE_SERVICE, useValue: dbMock },
48
+ { provide: LOG_SERVICE, useValue: logMock },
49
+ { provide: SessionLocalStorageService, useValue: localMock },
50
+ { provide: SessionService, useValue: sessionMock },
51
+ ],
52
+ });
53
+
54
+ // Create the service, which internally triggers the `subscribe()` on `currentRoute$`
55
+ service = TestBed.inject(TimeAnalyticsService);
56
+ });
57
+
58
+ it('should eagerly cache the latest route via shareReplay(1) and deliver to delayed subscribers', () => {
59
+ // 1. Emit a navigation event BEFORE any explicit subscriber connects to currentRoute$
60
+ // Because the service internally subscribes to currentRoute$, the source is connected
61
+ const navEvent = new NavigationEnd(1, '/test-route', '/test-route');
62
+ routerEvents$.next(navEvent);
63
+
64
+ // 2. Now a delayed subscriber comes in.
65
+ let capturedRoute: string | undefined;
66
+
67
+ // Note: currentRoute$ is a private property. We can access it via bracket notation for testing,
68
+ // or test the public behavior. Since we specifically want to verify the RxJS shareReplay caching
69
+ // on `currentRoute$`, we will inspect it directly.
70
+ (service as any).currentRoute$.subscribe((route: string) => {
71
+ capturedRoute = route;
72
+ });
73
+
74
+ // 3. Assert that the delayed subscriber immediately receives the previously emitted route
75
+ // without any new events needing to be emitted by the Router.
76
+ expect(capturedRoute).toEqual('/test-route');
77
+ });
78
+
79
+ it('should track page interactions and save them to the database on routing', () => {
80
+ let currentTime = 1000;
81
+ const dateSpy = jest.spyOn(Date, 'now').mockImplementation(() => currentTime);
82
+
83
+ const logService = TestBed.inject(LOG_SERVICE) as any;
84
+
85
+ // Start logging
86
+ service.startTimeLogging();
87
+
88
+ // 1. User routes to /home
89
+ currentTime = 1000;
90
+ routerEvents$.next(new NavigationEnd(1, '/home', '/home'));
91
+
92
+ // Trigger first document interaction to initialize the active time tracking
93
+ document.dispatchEvent(new Event('click'));
94
+
95
+ // 2. User interacts again on /home at T=2000
96
+ currentTime = 2000;
97
+ document.dispatchEvent(new Event('click'));
98
+
99
+ // 3. User performs a registered interaction (e.g. click search button) at T=2500
100
+ currentTime = 2500;
101
+ service.trackInteraction('button', 'search-submit', 'query-string');
102
+
103
+ // 4. User interacts again on /home at T=3000
104
+ currentTime = 3000;
105
+ document.dispatchEvent(new Event('click'));
106
+
107
+ // 5. User routes to /profile at T=4000
108
+ currentTime = 4000;
109
+ routerEvents$.next(new NavigationEnd(2, '/profile', '/profile'));
110
+ document.dispatchEvent(new Event('click'));
111
+
112
+ // Assert that the rawLog was called with the log for /home
113
+ expect(logService.rawLog).toHaveBeenCalledTimes(1);
114
+ const savedLog = logService.rawLog.mock.calls[0][0];
115
+
116
+ expect(savedLog.route).toEqual('/home');
117
+ expect(savedLog.__sessionId).toEqual('test-session-id');
118
+ expect(savedLog.__deviceId).toEqual('test-device-id');
119
+ expect(savedLog.startTime).toEqual(1000);
120
+
121
+ // Total active time should be 2000 ms (from T=1000 to T=3000)
122
+ const activeTime = savedLog.time.find((t: any) => t.type === 'active');
123
+ expect(activeTime).toBeDefined();
124
+ expect(activeTime.total).toEqual(2000);
125
+
126
+ // Verify interactions were logged correctly
127
+ expect(savedLog.interactions).toBeDefined();
128
+ expect(savedLog.interactions.length).toEqual(1);
129
+ expect(savedLog.interactions[0]).toEqual({
130
+ 0: 2500,
131
+ 1: 'button',
132
+ 2: 'search-submit',
133
+ 3: 'query-string',
134
+ });
135
+
136
+ // Cleanup
137
+ dateSpy.mockRestore();
138
+ });
139
+ });
140
+
@@ -1,7 +1,7 @@
1
1
  import { Injectable, Inject } from '@angular/core';
2
2
  import { Router, NavigationEnd } from '@angular/router';
3
- import { Subject, Observable, ConnectableObservable, fromEvent, merge, combineLatest } from 'rxjs';
4
- import { startWith, withLatestFrom, tap, takeUntil, switchMap, debounceTime, mergeMap, publishReplay, filter, map, pairwise, scan } from 'rxjs/operators';
3
+ import { Subject, Observable, fromEvent, merge, combineLatest } from 'rxjs';
4
+ import { startWith, withLatestFrom, tap, takeUntil, switchMap, debounceTime, mergeMap, shareReplay, filter, map, pairwise, scan } from 'rxjs/operators';
5
5
  import { LOG_SERVICE, LogService } from './log.service';
6
6
  import { DATABASE_SERVICE, DatabaseService } from '../firebase/database.service';
7
7
  import { SessionLocalStorageService } from '../local-storage/session-local-storage.service';
@@ -64,7 +64,7 @@ export class TimeAnalyticsService {
64
64
  private eventTimestamps$: Observable<number>;
65
65
 
66
66
  /** The current route a user is visiting. */
67
- private currentRoute$: ConnectableObservable<string>;
67
+ private currentRoute$: Observable<string>;
68
68
 
69
69
  /** The running update of time analytics for each route. */
70
70
  private runningTimeAtRoute$: Observable<TimeAtRoute>;
@@ -185,6 +185,24 @@ export class TimeAnalyticsService {
185
185
  }
186
186
  }
187
187
 
188
+ /** Function that can be called by any component to log an interaction event imperatively. */
189
+ public trackInteraction(category: string, action: string, data: any = null) {
190
+ let ixLog: Interaction = { 0: null, 1: null, 2: null, 3: null };
191
+ if (typeof data === 'string' || typeof data === 'number' || typeof data === 'boolean') {
192
+ ixLog = { 0: Date.now(), 1: String(category), 2: String(action), 3: String(data) };
193
+ } else {
194
+ ixLog = { 0: Date.now(), 1: String(category), 2: String(action), 3: null };
195
+ }
196
+ if (!this.interactionsAtRoute) {
197
+ const newInteractions: Interaction[] = [ixLog];
198
+ this.interactionsAtRoute = newInteractions;
199
+ this.local.setItemForSession(this.IX_KEY, this.interactionsAtRoute);
200
+ } else {
201
+ this.interactionsAtRoute.push(ixLog);
202
+ this.local.setItemForSession(this.IX_KEY, this.interactionsAtRoute);
203
+ }
204
+ }
205
+
188
206
  constructor(
189
207
  private router: Router,
190
208
  @Inject(DATABASE_SERVICE) private db: DatabaseService,
@@ -237,11 +255,11 @@ export class TimeAnalyticsService {
237
255
  this.currentRoute$ = this.router.events.pipe(
238
256
  filter((event) => event instanceof NavigationEnd),
239
257
  map(({ urlAfterRedirects }: NavigationEnd) => urlAfterRedirects),
240
- publishReplay(1),
241
- ) as ConnectableObservable<string>;
258
+ shareReplay(1),
259
+ );
242
260
 
243
- // Need to manually connect to make sure it gets the first one
244
- this.currentRoute$.connect();
261
+ // Subscribe to make sure it gets the first one
262
+ this.currentRoute$.subscribe();
245
263
 
246
264
  /** Tracks the active time at the current route. */
247
265
  this.runningTimeAtRoute$ = combineLatest([this.eventTimestamps$, this.currentRoute$, this.db.afUser()]).pipe(
@@ -14,7 +14,7 @@ export function handleAccess(
14
14
  user: User | null | undefined,
15
15
  router: Router,
16
16
  route: ActivatedRouteSnapshot,
17
- state: RouterStateSnapshot
17
+ state: RouterStateSnapshot,
18
18
  ): boolean {
19
19
  if (user) {
20
20
  // Admin override short-circuit
@@ -15,7 +15,7 @@ export function handleAccess(
15
15
  user: User | null | undefined,
16
16
  router: Router,
17
17
  route: ActivatedRouteSnapshot,
18
- state: RouterStateSnapshot
18
+ state: RouterStateSnapshot,
19
19
  ): boolean {
20
20
  if (!user?.isAdmin) {
21
21
  router.navigate(['/home'], { queryParams: route.queryParams });
@@ -24,7 +24,7 @@ export function handleAccess(
24
24
  user: User | null | undefined,
25
25
  router: Router,
26
26
  route: ActivatedRouteSnapshot,
27
- state: RouterStateSnapshot
27
+ state: RouterStateSnapshot,
28
28
  ): boolean {
29
29
  // Step 1: Not logged in → landing
30
30
  if (!user) {
@@ -11,7 +11,7 @@ export function handleAccess(
11
11
  user: User | null | undefined,
12
12
  router: Router,
13
13
  route: ActivatedRouteSnapshot,
14
- state: RouterStateSnapshot
14
+ state: RouterStateSnapshot,
15
15
  ): boolean {
16
16
  if (!user) {
17
17
  router.navigate(['/landing'], { queryParams: route.queryParams });