chore(datacite-tracker): rewritten existing tests to respect recent refactor

Author: opaduchak

src/app/features/preprints/components/preprint-details/preprint-file-section/preprint-file-section.component.spec.ts

@@ -1,33 +1,43 @@
 import { Store } from '@ngxs/store';
 
+import { TranslateModule } from '@ngx-translate/core';
 import { MockProvider } from 'ng-mocks';
 
-import { BehaviorSubject } from 'rxjs';
+import { BehaviorSubject, of } from 'rxjs';
 
+import { signal } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 
 import { PreprintSelectors } from '@osf/features/preprints/store/preprint';
 import { IS_LARGE, IS_MEDIUM } from '@osf/shared/helpers';
 import { MOCK_STORE } from '@shared/mocks';
+import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { PreprintFileSectionComponent } from './preprint-file-section.component';
 
-describe.skip('PreprintFileSectionComponent', () => {
+describe('PreprintFileSectionComponent', () => {
   let component: PreprintFileSectionComponent;
   let fixture: ComponentFixture<PreprintFileSectionComponent>;
-
+  let dataciteService: jest.Mocked<DataciteService>;
   const mockStore = MOCK_STORE;
   let isMediumSubject: BehaviorSubject<boolean>;
   let isLargeSubject: BehaviorSubject<boolean>;
+  // const
 
   beforeEach(async () => {
     (MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
       if (
         selector === PreprintSelectors.isPreprintFileLoading ||
-        selector === PreprintSelectors.getPreprintFileVersions ||
+        // selector === PreprintSelectors.getPreprintFileVersions ||
         selector === PreprintSelectors.arePreprintFileVersionsLoading
       ) {
         return () => [];
+      } else if (selector == PreprintSelectors.getPreprint) {
+        return () => ({
+          id: 1,
+        });
+      } else if (selector == PreprintSelectors.getPreprintFileVersions) {
+        return signal([{ date: '12312312', downloadUrl: '21312', id: '1' }]);
       }
       return () => null;
     });
@@ -36,9 +46,12 @@ describe.skip('PreprintFileSectionComponent', () => {
     isLargeSubject = new BehaviorSubject<boolean>(true);
 
     await TestBed.configureTestingModule({
-      imports: [PreprintFileSectionComponent],
+      imports: [PreprintFileSectionComponent, TranslateModule.forRoot()],
       providers: [
         MockProvider(Store, mockStore),
+        MockProvider(DataciteService, {
+          logIdentifiableDownload: jest.fn().mockReturnValue(of(void 0)),
+        }),
         MockProvider(IS_MEDIUM, isMediumSubject),
         MockProvider(IS_LARGE, isLargeSubject),
       ],
@@ -47,9 +60,27 @@ describe.skip('PreprintFileSectionComponent', () => {
     fixture = TestBed.createComponent(PreprintFileSectionComponent);
     component = fixture.componentInstance;
     fixture.detectChanges();
+    dataciteService = TestBed.inject(DataciteService) as jest.MockedObject<DataciteService>;
+  });
+
+  it('should call dataciteService.logIdentifiableDownload when logDownload is called', () => {
+    component.logDownload();
+    expect(dataciteService.logIdentifiableDownload).toHaveBeenCalledWith(component.preprint$);
   });
 
-  it('should create', () => {
-    expect(component).toBeTruthy();
+  it('should call logDownload when version menu item is clicked', () => {
+    // Get the command from versionMenuItems
+    fixture.detectChanges();
+    const menuItems = component.versionMenuItems();
+    expect(menuItems.length).toBeGreaterThan(0);
+
+    const versionCommand = menuItems[0].command!;
+    jest.spyOn(component, 'logDownload');
+
+    // simulate clicking the menu item
+    versionCommand();
+
+    expect(component.logDownload).toHaveBeenCalled();
+    expect(dataciteService.logIdentifiableDownload).toHaveBeenCalledWith(expect.anything());
   });
 });

src/app/features/preprints/pages/preprint-details/preprint-details.component.spec.ts

@@ -17,7 +17,6 @@ import { ShareAndDownloadComponent } from '@osf/features/preprints/components/pr
 import { PreprintSelectors } from '@osf/features/preprints/store/preprint';
 import { PreprintProvidersSelectors } from '@osf/features/preprints/store/preprint-providers';
 import { MOCK_PROVIDER, MOCK_STORE, TranslateServiceMock } from '@shared/mocks';
-import { Identifier } from '@shared/models';
 import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { PreprintDetailsComponent } from './preprint-details.component';
@@ -51,7 +50,7 @@ describe('PreprintDetailsComponent', () => {
     });
     (MOCK_STORE.dispatch as jest.Mock).mockImplementation(() => of());
     dataciteService = {
-      logView: jest.fn().mockReturnValue(of(void 0)),
+      logIdentifiableView: jest.fn().mockReturnValue(of(void 0)),
     } as unknown as jest.Mocked<DataciteService>;
 
     await TestBed.configureTestingModule({
@@ -86,30 +85,6 @@ describe('PreprintDetailsComponent', () => {
 
   it('reacts to sequence of state changes', () => {
     fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    preprintSignal.set(getPreprint([]));
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    preprintSignal.set(getPreprint([{ category: 'dio', value: '123', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    preprintSignal.set(getPreprint([{ category: 'doi', value: '123', id: '', type: 'identifier' }]));
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalled();
-
-    preprintSignal.set(getPreprint([{ category: 'doi', value: '456', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenLastCalledWith('123');
+    expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.preprint$);
   });
 });
-
-function getPreprint(identifiers: Identifier[]) {
-  return {
-    identifiers: identifiers,
-  };
-}

src/app/features/project/overview/project-overview.component.spec.ts

@@ -65,6 +65,7 @@ const sampleReviewAction: CollectionSubmissionReviewAction = {
 describe('ProjectOverviewComponent', () => {
   let fixture: ComponentFixture<ProjectOverviewComponent>;
   let dataciteService: jest.Mocked<DataciteService>;
+  let component: ProjectOverviewComponent;
   const projectSignal = signal<any>(getProject());
 
   const activatedRouteMock = {
@@ -118,7 +119,7 @@ describe('ProjectOverviewComponent', () => {
     });
 
     dataciteService = {
-      logView: jest.fn().mockReturnValue(of(void 0)),
+      logIdentifiableView: jest.fn().mockReturnValue(of(void 0)),
     } as unknown as jest.Mocked<DataciteService>;
 
     await TestBed.configureTestingModule({
@@ -142,6 +143,7 @@ describe('ProjectOverviewComponent', () => {
         ViewOnlyLinkMessageComponent,
       ],
       providers: [
+        TranslatePipe,
         { provide: ActivatedRoute, useValue: activatedRouteMock },
         { provide: Store, useValue: MOCK_STORE },
         { provide: DataciteService, useValue: dataciteService },
@@ -152,32 +154,14 @@ describe('ProjectOverviewComponent', () => {
         TranslateService,
       ],
     }).compileComponents();
-
     fixture = TestBed.createComponent(ProjectOverviewComponent);
+    component = fixture.componentInstance;
     fixture.detectChanges();
   });
 
   it('reacts to sequence of state changes', () => {
     fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    projectSignal.set(getProject());
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    projectSignal.set(getProject([{ category: 'dio', value: '123', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    projectSignal.set(getProject([{ category: 'doi', value: '123', id: '', type: 'identifier' }]));
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalled();
-
-    projectSignal.set(getProject([{ category: 'doi', value: '456', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenLastCalledWith('123');
+    expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.currentProject$);
   });
 
   function getProject(identifiers?: Identifier[]) {

src/app/features/project/overview/project-overview.component.ts

@@ -154,7 +154,7 @@ export class ProjectOverviewComponent implements OnInit {
 
   currentProject = select(ProjectOverviewSelectors.getProject);
   isAnonymous = select(ProjectOverviewSelectors.isProjectAnonymous);
-  private currentProject$ = toObservable(this.currentProject);
+  currentProject$ = toObservable(this.currentProject);
 
   userPermissions = computed(() => {
     return this.currentProject()?.currentUserPermissions || [];

src/app/features/registry/registry.component.spec.ts

@@ -8,20 +8,20 @@ import { TestBed } from '@angular/core/testing';
 
 import { RegistryOverviewSelectors } from '@osf/features/registry/store/registry-overview';
 import { MetaTagsService } from '@osf/shared/services';
-import { Identifier } from '@shared/models';
 import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { RegistryComponent } from './registry.component';
 
 describe('RegistryComponent', () => {
   let fixture: any;
+  let component: RegistryComponent;
   let dataciteService: jest.Mocked<DataciteService>;
 
   const registrySignal = signal<any | null>(null);
 
   beforeEach(async () => {
     dataciteService = {
-      logView: jest.fn().mockReturnValue(of(void 0)),
+      logIdentifiableView: jest.fn().mockReturnValue(of(void 0)),
     } as unknown as jest.Mocked<DataciteService>;
 
     const mockStore = {
@@ -47,48 +47,12 @@ describe('RegistryComponent', () => {
     }).compileComponents();
 
     fixture = TestBed.createComponent(RegistryComponent);
+    component = fixture.componentInstance;
     TestBed.inject(MetaTagsService);
   });
 
   it('reacts to sequence of state changes', () => {
-    registrySignal.set(null);
     fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    registrySignal.set(getRegistry([]));
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    registrySignal.set(getRegistry([{ category: 'dio', value: '123', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalledTimes(0);
-
-    registrySignal.set(getRegistry([{ category: 'doi', value: '123', id: '', type: 'identifier' }]));
-
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenCalled();
-
-    registrySignal.set(getRegistry([{ category: 'doi', value: '456', id: '', type: 'identifier' }]));
-    fixture.detectChanges();
-    expect(dataciteService.logView).toHaveBeenLastCalledWith('123');
+    expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.registry$);
   });
 });
-
-function getRegistry(identifiers: Identifier[]) {
-  return {
-    id: 'r1',
-    title: 'Mock Registry',
-    description: 'Test description',
-    dateRegistered: new Date('2023-01-01'),
-    dateModified: new Date('2023-02-01'),
-    doi: '10.1000/mockdoi',
-    tags: ['angular', 'jest'],
-    license: { name: 'MIT' },
-    contributors: [
-      { givenName: 'Alice', familyName: 'Smith' },
-      { givenName: 'Bob', familyName: 'Brown' },
-    ],
-    identifiers: identifiers,
-  };
-}