chore(datacite-tracker): added tests for file downloads tracking

Author: opaduchak

jest.config.js

@@ -68,7 +68,6 @@ module.exports = {
     '<rootDir>/src/app/features/project/addons/components/confirm-account-connection-modal/',
     '<rootDir>/src/app/features/files/components',
     '<rootDir>/src/app/features/files/pages/community-metadata',
-    '<rootDir>/src/app/features/files/pages/file-detail',
     '<rootDir>/src/app/features/my-projects/',
     '<rootDir>/src/app/features/project/analytics/',
     '<rootDir>/src/app/features/project/contributors/',

src/app/features/files/pages/file-detail/file-detail.component.spec.ts

@@ -1,29 +1,114 @@
-import { MockComponent } from 'ng-mocks';
+// Dependencies
+import { Store } from '@ngxs/store';
 
-import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { TranslatePipe, TranslateService } from '@ngx-translate/core';
+import { MockProvider } from 'ng-mocks';
+
+import { ButtonGroupModule } from 'primeng/buttongroup';
+import { DialogService } from 'primeng/dynamicdialog';
+import { Message } from 'primeng/message';
+import { TagModule } from 'primeng/tag';
 
-import { SubHeaderComponent } from '@shared/components';
+import { of } from 'rxjs';
+
+import { DestroyRef } from '@angular/core';
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+import { FormsModule } from '@angular/forms';
+import { ActivatedRoute, Router, RouterLink } from '@angular/router';
 
-import { FileDetailComponent } from './file-detail.component';
+import { FileDetailComponent } from '@osf/features/files/pages/file-detail/file-detail.component';
+import {
+  LinkedResourcesComponent,
+  OverviewComponentsComponent,
+  OverviewToolbarComponent,
+  OverviewWikiComponent,
+  RecentActivityComponent,
+} from '@osf/features/project/overview/components';
+import {
+  LoadingSpinnerComponent,
+  ResourceMetadataComponent,
+  SubHeaderComponent,
+  ViewOnlyLinkMessageComponent,
+} from '@shared/components';
+import { MOCK_STORE } from '@shared/mocks';
+import { CustomConfirmationService } from '@shared/services/custom-confirmation.service';
+import { DataciteService } from '@shared/services/datacite/datacite.service';
+import { ToastService } from '@shared/services/toast.service';
 
-import { OSFTestingStoreModule } from '@testing/osf.testing.module';
+import { OSFTestingModule } from '@testing/osf.testing.module';
 
 describe('FileDetailComponent', () => {
-  let component: FileDetailComponent;
   let fixture: ComponentFixture<FileDetailComponent>;
+  let component: FileDetailComponent;
+  let dataciteService: jest.Mocked<DataciteService>;
 
   beforeEach(async () => {
+    window.open = jest.fn();
+    dataciteService = {
+      logIdentifiableView: jest.fn().mockReturnValue(of(void 0)),
+      logIdentifiableDownload: jest.fn().mockReturnValue(of(void 0)),
+    } as unknown as jest.Mocked<DataciteService>;
+
+    const mockRoute: Partial<ActivatedRoute> = {
+      params: of({ providerId: 'osf', preprintId: 'p1' }),
+      queryParams: of({ providerId: 'osf', preprintId: 'p1' }),
+    };
+    (MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
+      switch (selector) {
+        default:
+          return () => [];
+      }
+    });
+
     await TestBed.configureTestingModule({
-      imports: [FileDetailComponent, MockComponent(SubHeaderComponent), OSFTestingStoreModule],
-      providers: [],
+      imports: [
+        FileDetailComponent,
+        OSFTestingModule,
+        ButtonGroupModule,
+        TagModule,
+        SubHeaderComponent,
+        FormsModule,
+        LoadingSpinnerComponent,
+        OverviewWikiComponent,
+        OverviewComponentsComponent,
+        LinkedResourcesComponent,
+        RecentActivityComponent,
+        OverviewToolbarComponent,
+        ResourceMetadataComponent,
+        TranslatePipe,
+        Message,
+        RouterLink,
+        ViewOnlyLinkMessageComponent,
+      ],
+      providers: [
+        TranslatePipe,
+        { provide: ActivatedRoute, useValue: mockRoute },
+        { provide: Store, useValue: MOCK_STORE },
+        { provide: DataciteService, useValue: dataciteService },
+        Router,
+        DestroyRef,
+        MockProvider(ToastService),
+        MockProvider(CustomConfirmationService),
+        DialogService,
+        TranslateService,
+      ],
     }).compileComponents();
-
     fixture = TestBed.createComponent(FileDetailComponent);
     component = fixture.componentInstance;
     fixture.detectChanges();
   });
 
-  it('should create', () => {
-    expect(component).toBeTruthy();
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should call dataciteService.logIdentifiableDownload when downloadFile is triggered', () => {
+    const link = '123';
+    component.downloadFile(link);
+    expect(dataciteService.logIdentifiableDownload).toHaveBeenCalledWith(component.fileMetadata$);
+  });
+
+  it('should call dataciteService.logIdentifiableView on start  ', () => {
+    expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.fileMetadata$);
   });
 });

src/app/features/files/pages/files/files.component.spec.ts

@@ -8,6 +8,8 @@ import { Dialog } from 'primeng/dialog';
 import { DialogService } from 'primeng/dynamicdialog';
 import { TableModule } from 'primeng/table';
 
+import { of } from 'rxjs';
+
 import { signal } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 import { FormsModule, ReactiveFormsModule } from '@angular/forms';
@@ -24,6 +26,7 @@ import {
 import { GoogleFilePickerComponent } from '@osf/shared/components/addons/folder-selector/google-file-picker/google-file-picker.component';
 import { OsfFile } from '@osf/shared/models';
 import { CustomConfirmationService, FilesService } from '@osf/shared/services';
+import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { FilesSelectors } from '../../store';
 
@@ -40,8 +43,15 @@ describe('Component: Files', () => {
   let fixture: ComponentFixture<FilesComponent>;
   const currentFolderSignal = signal(getNodeFilesMappedData(0));
 
+  let dataciteService: jest.Mocked<DataciteService>;
+
   beforeEach(async () => {
     jest.clearAllMocks();
+    window.open = jest.fn();
+    dataciteService = {
+      logFileView: jest.fn().mockReturnValue(of(void 0)),
+      logFileDownload: jest.fn().mockReturnValue(of(void 0)),
+    } as unknown as jest.Mocked<DataciteService>;
     await TestBed.configureTestingModule({
       imports: [
         OSFTestingModule,
@@ -63,7 +73,7 @@ describe('Component: Files', () => {
         FilesService,
         MockProvider(ActivatedRoute),
         MockProvider(CustomConfirmationService),
-
+        { provide: DataciteService, useValue: dataciteService },
         DialogService,
         provideMockStore({
           signals: [
@@ -183,4 +193,12 @@ describe('Component: Files', () => {
       expect(dispatchSpy).not.toHaveBeenCalled();
     });
   });
+
+  describe('Download file', () => {
+    it('', () => {
+      component.resourceId.set('123');
+      component.downloadFolder();
+      expect(dataciteService.logFileDownload).toHaveBeenCalledWith('123', 'nodes');
+    });
+  });
 });

src/app/features/files/pages/files/files.component.ts

@@ -341,9 +341,9 @@ export class FilesComponent {
     const isRootFolder = !this.currentFolder()?.relationships?.parentFolderLink;
     const provider = this.currentRootFolder()?.folder?.provider ?? 'osfstorage';
     const resourcePath = this.urlMap.get(this.resourceType()) ?? 'nodes';
-    this.dataciteService.logFileDownload(resourceId, resourcePath).subscribe();
 
     if (resourceId && folderId) {
+      this.dataciteService.logFileDownload(resourceId, resourcePath).subscribe();
       if (isRootFolder) {
         const link = this.filesService.getFolderDownloadLink(resourceId, provider, '', true);
         window.open(link, '_blank')?.focus();

src/app/features/preprints/components/preprint-details/share-and-downlaod/share-and-download.component.spec.ts

@@ -2,35 +2,85 @@ import { Store } from '@ngxs/store';
 
 import { MockProvider } from 'ng-mocks';
 
+import { of } from 'rxjs';
+
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 
+import { ProviderReviewsWorkflow } from '@osf/features/preprints/enums';
+import { PreprintProviderDetails } from '@osf/features/preprints/models';
 import { PreprintSelectors } from '@osf/features/preprints/store/preprint';
+import { ReviewPermissions } from '@osf/shared/enums';
 import { MOCK_STORE } from '@shared/mocks';
+import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { ShareAndDownloadComponent } from './share-and-download.component';
 
-describe.skip('ShareAndDownloadComponent', () => {
+import { OSFTestingModule } from '@testing/osf.testing.module';
+
+export const mockPreprintProvider: PreprintProviderDetails = {
+  id: 'osf-preprints',
+  name: 'OSF Preprints',
+  descriptionHtml: '<p>Open preprints for all disciplines</p>',
+  advisoryBoardHtml: '<p>Advisory board content here</p>',
+  examplePreprintId: '12345',
+  domain: 'osf.io',
+  footerLinksHtml: '<a href="/about">About</a>',
+  preprintWord: 'preprint',
+  allowSubmissions: true,
+  assertionsEnabled: false,
+  reviewsWorkflow: ProviderReviewsWorkflow.PreModeration,
+  permissions: [ReviewPermissions.ViewSubmissions],
+  brand: {
+    id: 'brand-1',
+    name: 'OSF Brand',
+    heroLogoImageUrl: 'https://osf.io/assets/hero-logo.png',
+    heroBackgroundImageUrl: 'https://osf.io/assets/hero-bg.png',
+    topNavLogoImageUrl: 'https://osf.io/assets/nav-logo.png',
+    primaryColor: '#0056b3',
+    secondaryColor: '#ff9900',
+    backgroundColor: '#ffffff',
+  },
+  iri: 'https://osf.io/preprints/',
+  faviconUrl: 'https://osf.io/favicon.ico',
+  squareColorNoTransparentImageUrl: 'https://osf.io/image.png',
+  facebookAppId: '1234567890',
+  reviewsCommentsPrivate: null,
+  reviewsCommentsAnonymous: null,
+  lastFetched: Date.now(),
+};
+describe('ShareAndDownloadComponent', () => {
   let component: ShareAndDownloadComponent;
   let fixture: ComponentFixture<ShareAndDownloadComponent>;
+  let dataciteService: jest.Mocked<DataciteService>;
 
   beforeEach(async () => {
+    dataciteService = {
+      logIdentifiableView: jest.fn().mockReturnValue(of(void 0)),
+      logIdentifiableDownload: jest.fn().mockReturnValue(of(void 0)),
+    } as unknown as jest.Mocked<DataciteService>;
     (MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
       if (selector === PreprintSelectors.getPreprint) return () => null;
       if (selector === PreprintSelectors.isPreprintLoading) return () => false;
       return () => null;
     });
 
     await TestBed.configureTestingModule({
-      imports: [ShareAndDownloadComponent],
-      providers: [MockProvider(Store, MOCK_STORE)],
+      imports: [ShareAndDownloadComponent, OSFTestingModule],
+      providers: [MockProvider(Store, MOCK_STORE), { provide: DataciteService, useValue: dataciteService }],
     }).compileComponents();
 
     fixture = TestBed.createComponent(ShareAndDownloadComponent);
     component = fixture.componentInstance;
+    fixture.componentRef.setInput('preprintProvider', mockPreprintProvider);
     fixture.detectChanges();
   });
 
-  it('should create', () => {
-    expect(component).toBeTruthy();
+  it('should call dataciteService.logIdentifiableDownload when logDownload is triggered', () => {
+    component.logDownload();
+    expect(dataciteService.logIdentifiableDownload).toHaveBeenCalledWith(component.preprint$);
+  });
+
+  it('should call dataciteService.logIdentifiableView on start  ', () => {
+    expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.preprint$);
   });
 });

src/app/features/preprints/components/preprint-details/share-and-downlaod/share-and-download.component.ts

@@ -49,7 +49,7 @@ export class ShareAndDownloadComponent {
     return this.socialShareService.createDownloadUrl(preprint.id);
   });
 
-  protected logDownload() {
+  logDownload() {
     this.dataciteService.logIdentifiableDownload(this.preprint$).subscribe();
   }