Skip to content

A community-supported supercharged document management system: scan, index and archive all your documents

11.5 KB
Raw Blame
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
import { provideHttpClientTesting } from '@angular/common/http/testing'
import { ComponentFixture, TestBed } from '@angular/core/testing'
import { By } from '@angular/platform-browser'
import { PermissionsService } from 'src/app/services/permissions.service'
import { SettingsService } from 'src/app/services/settings.service'
import { ToastService } from 'src/app/services/toast.service'
import { UploadDocumentsService } from 'src/app/services/upload-documents.service'
import { ToastsComponent } from '../common/toasts/toasts.component'
import { FileDropComponent } from './file-drop.component'

describe('FileDropComponent', () => {
  let component: FileDropComponent
  let fixture: ComponentFixture<FileDropComponent>
  let permissionsService: PermissionsService
  let toastService: ToastService
  let settingsService: SettingsService
  let uploadDocumentsService: UploadDocumentsService

  const advanceTimers = (ms: number) => {
    jest.advanceTimersByTime(ms)
    fixture.detectChanges()
  }

  const flushPromises = async () => {
    await Promise.resolve()
    await Promise.resolve()
  }

  beforeEach(async () => {
    await TestBed.configureTestingModule({
      imports: [FileDropComponent, ToastsComponent],
      providers: [
        provideHttpClient(withInterceptorsFromDi()),
        provideHttpClientTesting(),
      ],
    }).compileComponents()

    permissionsService = TestBed.inject(PermissionsService)
    settingsService = TestBed.inject(SettingsService)
    toastService = TestBed.inject(ToastService)
    uploadDocumentsService = TestBed.inject(UploadDocumentsService)

    fixture = TestBed.createComponent(FileDropComponent)
    component = fixture.componentInstance
    fixture.detectChanges()
  })

  afterEach(() => {
    jest.useRealTimers()
  })

  it('should enable drag-drop if user has permissions', () => {
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    expect(component.dragDropEnabled).toBeTruthy()
  })

  it('should disable drag-drop if user does not have permissions', () => {
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(false)
    expect(component.dragDropEnabled).toBeFalsy()
  })

  it('should disable drag-drop if disabled in settings', () => {
    jest.useFakeTimers()
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    settingsService.globalDropzoneEnabled.set(false)
    expect(component.dragDropEnabled).toBeFalsy()

    component.onDragOver(new Event('dragover') as DragEvent)
    advanceTimers(1)
    expect(component.fileIsOver()).toBeFalsy()
    const dropzone = fixture.debugElement.query(
      By.css('.global-dropzone-overlay')
    )
    expect(dropzone.classes['active']).toBeFalsy()
    component.onDragLeave(new Event('dragleave') as DragEvent)
    advanceTimers(700)
    // drop
    const uploadSpy = jest.spyOn(uploadDocumentsService, 'uploadFile')
    const dragEvent = new Event('drop')
    dragEvent['dataTransfer'] = {
      files: {
        item: () => {},
        length: 0,
      },
    }
    component.onDrop(dragEvent as DragEvent)
    advanceTimers(3000)
    expect(uploadSpy).not.toHaveBeenCalled()
  })

  it('should support drag drop, initiate upload', () => {
    jest.useFakeTimers()
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    expect(component.fileIsOver()).toBeFalsy()
    const overEvent = new Event('dragover') as DragEvent
    ;(overEvent as any).dataTransfer = { types: ['Files'] }
    component.onDragOver(overEvent)
    advanceTimers(1)
    expect(component.fileIsOver()).toBeTruthy()
    component.onDragLeave(new Event('dragleave') as DragEvent)
    advanceTimers(700)
    // drop
    const toastSpy = jest.spyOn(toastService, 'show')
    const uploadSpy = jest.spyOn(uploadDocumentsService, 'uploadFile')
    const file = new File(
      [new Blob(['testing'], { type: 'application/pdf' })],
      'file.pdf'
    )
    const dragEvent = new Event('drop')
    dragEvent['dataTransfer'] = {
      items: [
        {
          kind: 'file',
          type: 'application/pdf',
          getAsFile: () => file,
        },
      ],
    }
    component.onDrop(dragEvent as DragEvent)
    advanceTimers(3000)
    expect(toastSpy).not.toHaveBeenCalled()
    expect(uploadSpy).toHaveBeenCalled()
  })

  it('should support drag drop, initiate upload with webkitGetAsEntry', async () => {
    jest.useFakeTimers()
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    expect(component.fileIsOver()).toBeFalsy()
    const overEvent = new Event('dragover') as DragEvent
    ;(overEvent as any).dataTransfer = { types: ['Files'] }
    component.onDragOver(overEvent)
    advanceTimers(1)
    expect(component.fileIsOver()).toBeTruthy()
    component.onDragLeave(new Event('dragleave') as DragEvent)
    advanceTimers(700)
    // drop
    const toastSpy = jest.spyOn(toastService, 'show')
    const uploadSpy = jest.spyOn(uploadDocumentsService, 'uploadFile')
    const file = new File(
      [new Blob(['testing'], { type: 'application/pdf' })],
      'file.pdf'
    )
    const dragEvent = new Event('drop')
    dragEvent['dataTransfer'] = {
      items: [
        {
          kind: 'file',
          type: 'application/pdf',
          webkitGetAsEntry: () => ({
            isFile: true,
            isDirectory: false,
            file: (cb: (file: File) => void) => cb(file),
          }),
        },
      ],
      files: [],
    }
    component.onDrop(dragEvent as DragEvent)
    await flushPromises()
    advanceTimers(3000)
    expect(toastSpy).not.toHaveBeenCalled()
    expect(uploadSpy).toHaveBeenCalled()
  })

  it('should show an error on traverseFileTree error', async () => {
    jest.useFakeTimers()
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    const toastSpy = jest.spyOn(toastService, 'showError')
    const traverseSpy = jest
      .spyOn(component as any, 'traverseFileTree')
      .mockReturnValue(Promise.reject(new Error('Error traversing file tree')))
    fixture.detectChanges()

    // Simulate a drop with a directory entry
    const mockEntry = {
      isDirectory: true,
      isFile: false,
      createReader: () => ({ readEntries: jest.fn() }),
    } as unknown as FileSystemDirectoryEntry

    const event = {
      preventDefault: () => {},
      stopImmediatePropagation: () => {},
      dataTransfer: {
        items: [
          {
            kind: 'file',
            webkitGetAsEntry: () => mockEntry,
          },
        ],
      },
    } as unknown as DragEvent

    component.onDrop(event)

    await flushPromises()

    expect(traverseSpy).toHaveBeenCalled()
    expect(toastSpy).toHaveBeenCalledWith(
      $localize`Failed to read dropped items: Error traversing file tree`
    )
  })

  it('should support drag drop, initiate upload without DataTransfer API support', () => {
    jest.useFakeTimers()
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    expect(component.fileIsOver()).toBeFalsy()
    const overEvent = new Event('dragover') as DragEvent
    ;(overEvent as any).dataTransfer = { types: ['Files'] }
    component.onDragOver(overEvent)
    advanceTimers(1)
    expect(component.fileIsOver()).toBeTruthy()
    component.onDragLeave(new Event('dragleave') as DragEvent)
    advanceTimers(700)
    // drop
    const toastSpy = jest.spyOn(toastService, 'show')
    const uploadSpy = jest.spyOn(uploadDocumentsService, 'uploadFile')
    const file = new File(
      [new Blob(['testing'], { type: 'application/pdf' })],
      'file.pdf'
    )
    const dragEvent = new Event('drop')
    dragEvent['dataTransfer'] = {
      items: [],
      files: [file],
    }
    component.onDrop(dragEvent as DragEvent)
    advanceTimers(3000)
    expect(toastSpy).not.toHaveBeenCalled()
    expect(uploadSpy).toHaveBeenCalled()
  })

  it('should resolve a single file when entry isFile', () => {
    const mockFile = new File(['data'], 'test.txt', { type: 'text/plain' })
    const mockEntry = {
      isFile: true,
      isDirectory: false,
      file: (cb: (f: File) => void) => cb(mockFile),
    } as unknown as FileSystemFileEntry

    return (component as any)
      .traverseFileTree(mockEntry)
      .then((result: File[]) => {
        expect(result).toEqual([mockFile])
      })
  })

  it('should resolve all files in a flat directory', async () => {
    const file1 = new File(['data'], 'file1.txt')
    const file2 = new File(['data'], 'file2.txt')

    const mockFileEntry1 = {
      isFile: true,
      isDirectory: false,
      file: (cb: (f: File) => void) => cb(file1),
    } as unknown as FileSystemFileEntry

    const mockFileEntry2 = {
      isFile: true,
      isDirectory: false,
      file: (cb: (f: File) => void) => cb(file2),
    } as unknown as FileSystemFileEntry

    let callCount = 0

    const mockDirEntry = {
      isFile: false,
      isDirectory: true,
      createReader: () => ({
        readEntries: (cb: (batch: FileSystemEntry[]) => void) => {
          if (callCount++ === 0) {
            cb([mockFileEntry1, mockFileEntry2])
          } else {
            cb([]) // second call: signal EOF
          }
        },
      }),
    } as unknown as FileSystemDirectoryEntry

    const result = await (component as any).traverseFileTree(mockDirEntry)
    expect(result).toEqual([file1, file2])
  })

  it('should resolve a non-file non-directory entry as an empty array', () => {
    const mockEntry = {
      isFile: false,
      isDirectory: false,
      file: (cb: (f: File) => void) => cb(new File([], '')),
    } as unknown as FileSystemEntry
    return (component as any)
      .traverseFileTree(mockEntry)
      .then((result: File[]) => {
        expect(result).toEqual([])
      })
  })

  it('should ignore events if disabled', () => {
    settingsService.globalDropzoneEnabled.set(false)
    expect(settingsService.globalDropzoneActive()).toBeFalsy()
    component.onDragOver(new Event('dragover') as DragEvent)
    expect(settingsService.globalDropzoneActive()).toBeFalsy()
    settingsService.globalDropzoneActive.set(true)
    component.onDragLeave(new Event('dragleave') as DragEvent)
    expect(settingsService.globalDropzoneActive()).toBeTruthy()
    component.onDrop(new Event('drop') as DragEvent)
    expect(settingsService.globalDropzoneActive()).toBeTruthy()
  })

  it('should hide if app loses focus', () => {
    jest.useFakeTimers()
    const leaveSpy = jest.spyOn(component, 'onDragLeave')
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    settingsService.globalDropzoneEnabled.set(true)
    const overEvent = new Event('dragover') as DragEvent
    ;(overEvent as any).dataTransfer = { types: ['Files'] }
    component.onDragOver(overEvent)
    advanceTimers(1)
    expect(component.hidden()).toBeFalsy()
    expect(component.fileIsOver()).toBeTruthy()
    jest.spyOn(document, 'hidden', 'get').mockReturnValue(true)
    component.onVisibilityChange()
    expect(leaveSpy).toHaveBeenCalled()
  })

  it('should hide on window blur', () => {
    jest.useFakeTimers()
    const leaveSpy = jest.spyOn(component, 'onDragLeave')
    jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
    settingsService.globalDropzoneEnabled.set(true)
    const overEvent = new Event('dragover') as DragEvent
    ;(overEvent as any).dataTransfer = { types: ['Files'] }
    component.onDragOver(overEvent)
    advanceTimers(1)
    expect(component.hidden()).toBeFalsy()
    expect(component.fileIsOver()).toBeTruthy()
    jest.spyOn(document, 'hidden', 'get').mockReturnValue(true)
    component.onWindowBlur()
    expect(leaveSpy).toHaveBeenCalled()
  })
})