mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
367 lines
14 KiB
TypeScript
367 lines
14 KiB
TypeScript
import { ViewportScroller, DatePipe } from '@angular/common'
|
|
import { HttpClientTestingModule } from '@angular/common/http/testing'
|
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
|
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
|
import { By } from '@angular/platform-browser'
|
|
import { Router, ActivatedRoute, convertToParamMap } from '@angular/router'
|
|
import { RouterTestingModule } from '@angular/router/testing'
|
|
import {
|
|
NgbModule,
|
|
NgbAlertModule,
|
|
NgbNavLink,
|
|
} from '@ng-bootstrap/ng-bootstrap'
|
|
import { NgSelectModule } from '@ng-select/ng-select'
|
|
import { of, throwError } from 'rxjs'
|
|
import { routes } from 'src/app/app-routing.module'
|
|
import { SavedView } from 'src/app/data/saved-view'
|
|
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
|
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
|
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
|
import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe'
|
|
import { PermissionsService } from 'src/app/services/permissions.service'
|
|
import { GroupService } from 'src/app/services/rest/group.service'
|
|
import { SavedViewService } from 'src/app/services/rest/saved-view.service'
|
|
import { UserService } from 'src/app/services/rest/user.service'
|
|
import { SettingsService } from 'src/app/services/settings.service'
|
|
import { ToastService, Toast } from 'src/app/services/toast.service'
|
|
import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component'
|
|
import { CheckComponent } from '../../common/input/check/check.component'
|
|
import { ColorComponent } from '../../common/input/color/color.component'
|
|
import { NumberComponent } from '../../common/input/number/number.component'
|
|
import { PermissionsGroupComponent } from '../../common/input/permissions/permissions-group/permissions-group.component'
|
|
import { PermissionsUserComponent } from '../../common/input/permissions/permissions-user/permissions-user.component'
|
|
import { SelectComponent } from '../../common/input/select/select.component'
|
|
import { TagsComponent } from '../../common/input/tags/tags.component'
|
|
import { TextComponent } from '../../common/input/text/text.component'
|
|
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
|
import { SettingsComponent } from './settings.component'
|
|
import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
|
|
|
|
const savedViews = [
|
|
{ id: 1, name: 'view1', show_in_sidebar: true, show_on_dashboard: true },
|
|
{ id: 2, name: 'view2', show_in_sidebar: false, show_on_dashboard: false },
|
|
]
|
|
const users = [
|
|
{ id: 1, username: 'user1', is_superuser: false },
|
|
{ id: 2, username: 'user2', is_superuser: false },
|
|
]
|
|
const groups = [
|
|
{ id: 1, name: 'group1' },
|
|
{ id: 2, name: 'group2' },
|
|
]
|
|
|
|
describe('SettingsComponent', () => {
|
|
let component: SettingsComponent
|
|
let fixture: ComponentFixture<SettingsComponent>
|
|
let router: Router
|
|
let settingsService: SettingsService
|
|
let savedViewService: SavedViewService
|
|
let activatedRoute: ActivatedRoute
|
|
let viewportScroller: ViewportScroller
|
|
let toastService: ToastService
|
|
let userService: UserService
|
|
let permissionsService: PermissionsService
|
|
let groupService: GroupService
|
|
|
|
beforeEach(async () => {
|
|
TestBed.configureTestingModule({
|
|
declarations: [
|
|
SettingsComponent,
|
|
PageHeaderComponent,
|
|
IfPermissionsDirective,
|
|
CustomDatePipe,
|
|
ConfirmDialogComponent,
|
|
CheckComponent,
|
|
ColorComponent,
|
|
SafeHtmlPipe,
|
|
SelectComponent,
|
|
TextComponent,
|
|
NumberComponent,
|
|
TagsComponent,
|
|
PermissionsUserComponent,
|
|
PermissionsGroupComponent,
|
|
IfOwnerDirective,
|
|
],
|
|
providers: [CustomDatePipe, DatePipe, PermissionsGuard],
|
|
imports: [
|
|
NgbModule,
|
|
HttpClientTestingModule,
|
|
RouterTestingModule.withRoutes(routes),
|
|
FormsModule,
|
|
ReactiveFormsModule,
|
|
NgbAlertModule,
|
|
NgSelectModule,
|
|
],
|
|
}).compileComponents()
|
|
|
|
router = TestBed.inject(Router)
|
|
activatedRoute = TestBed.inject(ActivatedRoute)
|
|
viewportScroller = TestBed.inject(ViewportScroller)
|
|
toastService = TestBed.inject(ToastService)
|
|
settingsService = TestBed.inject(SettingsService)
|
|
settingsService.currentUser = users[0]
|
|
userService = TestBed.inject(UserService)
|
|
permissionsService = TestBed.inject(PermissionsService)
|
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
|
jest
|
|
.spyOn(permissionsService, 'currentUserHasObjectPermissions')
|
|
.mockReturnValue(true)
|
|
jest
|
|
.spyOn(permissionsService, 'currentUserOwnsObject')
|
|
.mockReturnValue(true)
|
|
groupService = TestBed.inject(GroupService)
|
|
savedViewService = TestBed.inject(SavedViewService)
|
|
})
|
|
|
|
function completeSetup(excludeService = null) {
|
|
if (excludeService !== userService) {
|
|
jest.spyOn(userService, 'listAll').mockReturnValue(
|
|
of({
|
|
all: users.map((u) => u.id),
|
|
count: users.length,
|
|
results: users.concat([]),
|
|
})
|
|
)
|
|
}
|
|
if (excludeService !== groupService) {
|
|
jest.spyOn(groupService, 'listAll').mockReturnValue(
|
|
of({
|
|
all: groups.map((g) => g.id),
|
|
count: groups.length,
|
|
results: groups.concat([]),
|
|
})
|
|
)
|
|
}
|
|
if (excludeService !== savedViewService) {
|
|
jest.spyOn(savedViewService, 'listAll').mockReturnValue(
|
|
of({
|
|
all: savedViews.map((v) => v.id),
|
|
count: savedViews.length,
|
|
results: (savedViews as SavedView[]).concat([]),
|
|
})
|
|
)
|
|
}
|
|
|
|
fixture = TestBed.createComponent(SettingsComponent)
|
|
component = fixture.componentInstance
|
|
fixture.detectChanges()
|
|
}
|
|
|
|
it('should support tabbed settings & change URL, prevent navigation if dirty confirmation rejected', () => {
|
|
completeSetup()
|
|
const navigateSpy = jest.spyOn(router, 'navigate')
|
|
const tabButtons = fixture.debugElement.queryAll(By.directive(NgbNavLink))
|
|
tabButtons[1].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
expect(navigateSpy).toHaveBeenCalledWith(['settings', 'permissions'])
|
|
tabButtons[2].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
expect(navigateSpy).toHaveBeenCalledWith(['settings', 'notifications'])
|
|
tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
expect(navigateSpy).toHaveBeenCalledWith(['settings', 'savedviews'])
|
|
|
|
const initSpy = jest.spyOn(component, 'initialize')
|
|
component.isDirty = true // mock dirty
|
|
navigateSpy.mockResolvedValueOnce(false) // nav rejected cause dirty
|
|
tabButtons[0].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
expect(navigateSpy).toHaveBeenCalledWith(['settings', 'general'])
|
|
expect(initSpy).not.toHaveBeenCalled()
|
|
|
|
navigateSpy.mockResolvedValueOnce(true) // nav accepted even though dirty
|
|
tabButtons[1].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
expect(navigateSpy).toHaveBeenCalledWith(['settings', 'notifications'])
|
|
expect(initSpy).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should support direct link to tab by URL, scroll if needed', () => {
|
|
completeSetup()
|
|
jest
|
|
.spyOn(activatedRoute, 'paramMap', 'get')
|
|
.mockReturnValue(of(convertToParamMap({ section: 'notifications' })))
|
|
activatedRoute.snapshot.fragment = '#notifications'
|
|
const scrollSpy = jest.spyOn(viewportScroller, 'scrollToAnchor')
|
|
component.ngOnInit()
|
|
expect(component.activeNavID).toEqual(3) // Notifications
|
|
component.ngAfterViewInit()
|
|
expect(scrollSpy).toHaveBeenCalledWith('#notifications')
|
|
})
|
|
|
|
it('should enable organizing of sidebar saved views even on direct navigation', () => {
|
|
completeSetup()
|
|
jest
|
|
.spyOn(activatedRoute, 'paramMap', 'get')
|
|
.mockReturnValue(of(convertToParamMap({ section: 'savedviews' })))
|
|
activatedRoute.snapshot.fragment = '#savedviews'
|
|
component.ngOnInit()
|
|
expect(component.activeNavID).toEqual(4) // Saved Views
|
|
component.ngAfterViewInit()
|
|
expect(settingsService.organizingSidebarSavedViews).toBeTruthy()
|
|
})
|
|
|
|
it('should support save saved views, show error', () => {
|
|
completeSetup()
|
|
|
|
const tabButtons = fixture.debugElement.queryAll(By.directive(NgbNavLink))
|
|
tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
fixture.detectChanges()
|
|
|
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
|
const toastSpy = jest.spyOn(toastService, 'show')
|
|
const savedViewPatchSpy = jest.spyOn(savedViewService, 'patchMany')
|
|
|
|
const toggle = fixture.debugElement.query(
|
|
By.css('.form-check.form-switch input')
|
|
)
|
|
toggle.nativeElement.checked = true
|
|
toggle.nativeElement.dispatchEvent(new Event('change'))
|
|
|
|
// saved views error first
|
|
savedViewPatchSpy.mockReturnValueOnce(
|
|
throwError(() => new Error('unable to save saved views'))
|
|
)
|
|
component.saveSettings()
|
|
expect(toastErrorSpy).toHaveBeenCalled()
|
|
expect(savedViewPatchSpy).toHaveBeenCalled()
|
|
toastSpy.mockClear()
|
|
toastErrorSpy.mockClear()
|
|
savedViewPatchSpy.mockClear()
|
|
|
|
// succeed saved views
|
|
savedViewPatchSpy.mockReturnValueOnce(of(savedViews as SavedView[]))
|
|
component.saveSettings()
|
|
expect(toastErrorSpy).not.toHaveBeenCalled()
|
|
expect(savedViewPatchSpy).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should update only patch saved views that have changed', () => {
|
|
completeSetup()
|
|
|
|
const tabButtons = fixture.debugElement.queryAll(By.directive(NgbNavLink))
|
|
tabButtons[3].nativeElement.dispatchEvent(new MouseEvent('click'))
|
|
fixture.detectChanges()
|
|
|
|
const patchSpy = jest.spyOn(savedViewService, 'patchMany')
|
|
component.saveSettings()
|
|
expect(patchSpy).not.toHaveBeenCalled()
|
|
|
|
const view = savedViews[0]
|
|
const toggle = fixture.debugElement.query(
|
|
By.css('.form-check.form-switch input')
|
|
)
|
|
toggle.nativeElement.checked = true
|
|
toggle.nativeElement.dispatchEvent(new Event('change'))
|
|
// register change
|
|
component.savedViewGroup.get(view.id.toString()).value[
|
|
'show_on_dashboard'
|
|
] = !view.show_on_dashboard
|
|
fixture.detectChanges()
|
|
|
|
component.saveSettings()
|
|
expect(patchSpy).toHaveBeenCalledWith([
|
|
{
|
|
id: view.id,
|
|
name: view.name,
|
|
show_in_sidebar: view.show_in_sidebar,
|
|
show_on_dashboard: !view.show_on_dashboard,
|
|
},
|
|
])
|
|
})
|
|
|
|
it('should support save local settings updating appearance settings and calling API, show error', () => {
|
|
completeSetup()
|
|
jest.spyOn(savedViewService, 'patchMany').mockReturnValue(of([]))
|
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
|
const toastSpy = jest.spyOn(toastService, 'show')
|
|
const storeSpy = jest.spyOn(settingsService, 'storeSettings')
|
|
const appearanceSettingsSpy = jest.spyOn(
|
|
settingsService,
|
|
'updateAppearanceSettings'
|
|
)
|
|
const setSpy = jest.spyOn(settingsService, 'set')
|
|
|
|
// error first
|
|
storeSpy.mockReturnValueOnce(
|
|
throwError(() => new Error('unable to save settings'))
|
|
)
|
|
component.saveSettings()
|
|
|
|
expect(toastErrorSpy).toHaveBeenCalled()
|
|
expect(storeSpy).toHaveBeenCalled()
|
|
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
|
|
expect(setSpy).toHaveBeenCalledTimes(24)
|
|
|
|
// succeed
|
|
storeSpy.mockReturnValueOnce(of(true))
|
|
component.saveSettings()
|
|
expect(toastSpy).toHaveBeenCalled()
|
|
expect(appearanceSettingsSpy).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should offer reload if settings changes require', () => {
|
|
completeSetup()
|
|
jest.spyOn(savedViewService, 'patchMany').mockReturnValue(of([]))
|
|
let toast: Toast
|
|
toastService.getToasts().subscribe((t) => (toast = t[0]))
|
|
component.initialize(true) // reset
|
|
component.store.getValue()['displayLanguage'] = 'en-US'
|
|
component.store.getValue()['updateCheckingEnabled'] = false
|
|
component.settingsForm.value.displayLanguage = 'en-GB'
|
|
component.settingsForm.value.updateCheckingEnabled = true
|
|
jest.spyOn(settingsService, 'storeSettings').mockReturnValueOnce(of(true))
|
|
component.saveSettings()
|
|
expect(toast.actionName).toEqual('Reload now')
|
|
})
|
|
|
|
it('should allow setting theme color, visually apply change immediately but not save', () => {
|
|
completeSetup()
|
|
const appearanceSpy = jest.spyOn(
|
|
settingsService,
|
|
'updateAppearanceSettings'
|
|
)
|
|
const colorInput = fixture.debugElement.query(By.directive(ColorComponent))
|
|
colorInput.query(By.css('input')).nativeElement.value = '#ff0000'
|
|
colorInput
|
|
.query(By.css('input'))
|
|
.nativeElement.dispatchEvent(new Event('change'))
|
|
fixture.detectChanges()
|
|
expect(appearanceSpy).toHaveBeenCalled()
|
|
expect(settingsService.get(SETTINGS_KEYS.THEME_COLOR)).toEqual('')
|
|
component.clearThemeColor()
|
|
})
|
|
|
|
it('should support delete saved view', () => {
|
|
completeSetup()
|
|
const toastSpy = jest.spyOn(toastService, 'showInfo')
|
|
const deleteSpy = jest.spyOn(savedViewService, 'delete')
|
|
deleteSpy.mockReturnValue(of(true))
|
|
component.deleteSavedView(savedViews[0] as SavedView)
|
|
expect(deleteSpy).toHaveBeenCalled()
|
|
expect(toastSpy).toHaveBeenCalledWith(
|
|
`Saved view "${savedViews[0].name}" deleted.`
|
|
)
|
|
})
|
|
|
|
it('should show errors on load if load users failure', () => {
|
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
|
jest
|
|
.spyOn(userService, 'listAll')
|
|
.mockImplementation(() =>
|
|
throwError(() => new Error('failed to load users'))
|
|
)
|
|
completeSetup(userService)
|
|
fixture.detectChanges()
|
|
expect(toastErrorSpy).toBeCalled()
|
|
})
|
|
|
|
it('should show errors on load if load groups failure', () => {
|
|
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
|
jest
|
|
.spyOn(groupService, 'listAll')
|
|
.mockImplementation(() =>
|
|
throwError(() => new Error('failed to load groups'))
|
|
)
|
|
completeSetup(groupService)
|
|
fixture.detectChanges()
|
|
expect(toastErrorSpy).toBeCalled()
|
|
})
|
|
})
|