mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-10-21 23:38:13 +00:00
Enhancement: notifications improvements (#14500)
This commit is contained in:
1 parent
c657fceea5
commit
98fb7c3b63
77 files changed
+1535
-627
No files matched your search
+1
-1
@@ -110,7 +110,7 @@ describe('CustomFieldsDropdownComponent', () => {
|
||||
let modal: NgbModalRef
|
||||
modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1]))
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
const getFieldsSpy = jest.spyOn(
|
||||
CustomFieldsDropdownComponent.prototype as any,
|
||||
'getFields'
|
||||
|
||||
+3
-1
@@ -129,7 +129,9 @@ export class CustomFieldsDropdownComponent extends LoadingComponentWithPermissio
|
||||
modal.componentInstance.succeeded
|
||||
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||
.subscribe((newField) => {
|
||||
this.toastService.showInfo($localize`Saved field "${newField.name}".`)
|
||||
this.toastService.showSuccess(
|
||||
$localize`Saved field "${newField.name}".`
|
||||
)
|
||||
this.customFieldsService.clearCache()
|
||||
this.getFields()
|
||||
this.created.emit(newField)
|
||||
|
||||
+1
-1
@@ -151,7 +151,7 @@ describe('UserEditDialogComponent', () => {
|
||||
'deactivateTotp'
|
||||
)
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
deactivateSpy.mockReturnValueOnce(throwError(() => new Error('error')))
|
||||
component.deactivateTotp()
|
||||
expect(deactivateSpy).toHaveBeenCalled()
|
||||
|
||||
+1
-1
@@ -132,7 +132,7 @@ export class UserEditDialogComponent
|
||||
next: (result) => {
|
||||
this.totpLoading.set(false)
|
||||
if (result) {
|
||||
this.toastService.showInfo($localize`Totp deactivated`)
|
||||
this.toastService.showSuccess($localize`Totp deactivated`)
|
||||
this.object.is_mfa_enabled = false
|
||||
} else {
|
||||
this.toastService.showError($localize`Totp deactivation failed`)
|
||||
|
||||
+2
-2
@@ -52,7 +52,7 @@ describe('EmailDocumentDialogComponent', () => {
|
||||
|
||||
it('should support sending single document via email, showing error if needed', () => {
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastSuccessSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
component.documentIds.set([1])
|
||||
component.emailAddress = 'hello@paperless-ngx.com'
|
||||
component.emailSubject = 'Hello'
|
||||
@@ -73,7 +73,7 @@ describe('EmailDocumentDialogComponent', () => {
|
||||
|
||||
it('should support sending multiple documents via email, showing appropriate messages', () => {
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastSuccessSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastSuccessSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
component.documentIds.set([1, 2, 3])
|
||||
component.emailAddress = 'hello@paperless-ngx.com'
|
||||
component.emailSubject = 'Hello'
|
||||
|
||||
+1
-1
@@ -50,7 +50,7 @@ export class EmailDocumentDialogComponent extends LoadingComponentWithPermission
|
||||
this.emailSubject = ''
|
||||
this.emailMessage = ''
|
||||
this.close()
|
||||
this.toastService.showInfo($localize`Email sent`)
|
||||
this.toastService.showSuccess($localize`Email sent`)
|
||||
},
|
||||
error: (e) => {
|
||||
this.loading.set(false)
|
||||
|
||||
+3
-3
@@ -100,7 +100,7 @@ describe('ProfileEditDialogComponent', () => {
|
||||
expect(errorSpy).toHaveBeenCalled()
|
||||
|
||||
updateSpy.mockClear()
|
||||
const infoSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const infoSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
component.form.patchValue(newProfile)
|
||||
updateSpy.mockReturnValueOnce(of(newProfile))
|
||||
component.save()
|
||||
@@ -373,7 +373,7 @@ describe('ProfileEditDialogComponent', () => {
|
||||
it('should activate totp', () => {
|
||||
const activateSpy = jest.spyOn(profileService, 'activateTotp')
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
const error = new Error('failed to activate totp')
|
||||
activateSpy.mockReturnValueOnce(throwError(() => error))
|
||||
component.totpSettings.set({
|
||||
@@ -405,7 +405,7 @@ describe('ProfileEditDialogComponent', () => {
|
||||
it('should deactivate totp', () => {
|
||||
const deactivateSpy = jest.spyOn(profileService, 'deactivateTotp')
|
||||
const toastErrorSpy = jest.spyOn(toastService, 'showError')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showInfo')
|
||||
const toastInfoSpy = jest.spyOn(toastService, 'showSuccess')
|
||||
const error = new Error('failed to deactivate totp')
|
||||
deactivateSpy.mockReturnValueOnce(throwError(() => error))
|
||||
component.deactivateTotp()
|
||||
|
||||
+7
-3
@@ -204,7 +204,7 @@ export class ProfileEditDialogComponent
|
||||
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||
.subscribe({
|
||||
next: () => {
|
||||
this.toastService.showInfo($localize`Profile updated successfully`)
|
||||
this.toastService.showSuccess($localize`Profile updated successfully`)
|
||||
if (passwordChanged) {
|
||||
this.toastService.showInfo(
|
||||
$localize`Password has been changed, you will be logged out momentarily.`
|
||||
@@ -307,7 +307,9 @@ export class ProfileEditDialogComponent
|
||||
this.recoveryCodes.set(activationResponse.recovery_codes)
|
||||
this.form.get('totp_code').enable()
|
||||
if (activationResponse.success) {
|
||||
this.toastService.showInfo($localize`TOTP activated successfully`)
|
||||
this.toastService.showSuccess(
|
||||
$localize`TOTP activated successfully`
|
||||
)
|
||||
} else {
|
||||
this.toastService.showError($localize`Error activating TOTP`)
|
||||
}
|
||||
@@ -331,7 +333,9 @@ export class ProfileEditDialogComponent
|
||||
this.isTotpEnabled.set(!success)
|
||||
this.recoveryCodes.set(null)
|
||||
if (success) {
|
||||
this.toastService.showInfo($localize`TOTP deactivated successfully`)
|
||||
this.toastService.showSuccess(
|
||||
$localize`TOTP deactivated successfully`
|
||||
)
|
||||
} else {
|
||||
this.toastService.showError($localize`Error deactivating TOTP`)
|
||||
}
|
||||
|
||||
@@ -1,22 +1,33 @@
|
||||
<ngb-toast
|
||||
[autohide]="autohide"
|
||||
[delay]="toast.delay"
|
||||
[class]="toast.classname"
|
||||
[class.mb-2]="true"
|
||||
[autohide]="false"
|
||||
[class.mb-2]="autohide"
|
||||
[class.toast-list-item]="!autohide"
|
||||
[class.toast-new]="isNew"
|
||||
[class.toast-success]="toast.level === ToastLevel.Success"
|
||||
[class.toast-error]="toast.level === ToastLevel.Error"
|
||||
(mouseenter)="setHovered(true)"
|
||||
(mouseleave)="setHovered(false)"
|
||||
(focusin)="setFocused(true)"
|
||||
(focusout)="setFocused(false)"
|
||||
(shown)="onShown(toast)"
|
||||
(hidden)="hidden.emit(toast)">
|
||||
@if (autohide) {
|
||||
<ngb-progressbar class="position-absolute h-100 w-100 top-90 start-0 bottom-0 end-0 pe-none" type="dark" [max]="toast.delay" [value]="toast.delayRemaining"></ngb-progressbar>
|
||||
<span class="visually-hidden">{{ toast.delayRemaining / 1000 | number: '1.0-0' }} seconds</span>
|
||||
<ngb-progressbar class="position-absolute w-100 start-0 bottom-0 pe-none" [max]="toast.delay" [value]="delayRemaining()"></ngb-progressbar>
|
||||
<span class="visually-hidden">{{ delayRemaining() / 1000 | number: '1.0-0' }} seconds</span>
|
||||
}
|
||||
<div class="d-flex align-items-top">
|
||||
@if (!toast.error) {
|
||||
<i-bs width="0.9em" height="0.9em" name="info-circle"></i-bs>
|
||||
@switch (toast.level) {
|
||||
@case (ToastLevel.Success) {
|
||||
<i-bs width="0.9em" height="0.9em" name="check-circle" class="toast-icon"></i-bs>
|
||||
}
|
||||
@case (ToastLevel.Error) {
|
||||
<i-bs width="0.9em" height="0.9em" name="exclamation-triangle" class="toast-icon"></i-bs>
|
||||
}
|
||||
@default {
|
||||
<i-bs width="0.9em" height="0.9em" name="info-circle" class="toast-icon"></i-bs>
|
||||
}
|
||||
}
|
||||
@if (toast.error) {
|
||||
<i-bs width="0.9em" height="0.9em" name="exclamation-triangle"></i-bs>
|
||||
}
|
||||
<div>
|
||||
<div class="toast-content">
|
||||
<p class="ms-2 mb-0 text-break">{{toast.content}}</p>
|
||||
@if (toast.error) {
|
||||
<details class="ms-2">
|
||||
@@ -48,9 +59,12 @@
|
||||
</details>
|
||||
}
|
||||
@if (toast.action) {
|
||||
<p class="mb-0 mt-2"><button class="btn btn-sm btn-outline-secondary" (click)="closed.emit(toast); toast.action()">{{toast.actionName}}</button></p>
|
||||
<button class="btn btn-sm toast-action ms-2 mt-2" (click)="actioned.emit(toast); toast.action()">{{toast.actionName}}</button>
|
||||
}
|
||||
</div>
|
||||
@if (!autohide && toast.timestamp) {
|
||||
<span class="toast-time small text-body-secondary text-nowrap ms-auto ps-2">{{relativeTimestamp}}</span>
|
||||
}
|
||||
<button type="button" class="btn-close ms-auto flex-shrink-0" data-bs-dismiss="toast" aria-label="Close" (click)="closed.emit(toast);"></button>
|
||||
</div>
|
||||
</ngb-toast>
|
||||
@@ -2,19 +2,105 @@
|
||||
position: relative;
|
||||
}
|
||||
|
||||
::ng-deep .toast.error {
|
||||
border-color: hsla(350, 79%, 40%, 0.4); // bg-danger
|
||||
.toast {
|
||||
--pngx-toast-accent: var(--pngx-toast-info);
|
||||
background-color: var(--pngx-toast-bg);
|
||||
color: var(--bs-body-color);
|
||||
overflow: hidden;
|
||||
|
||||
&.toast-success {
|
||||
--pngx-toast-accent: var(--pngx-toast-success);
|
||||
background-color: var(--pngx-toast-success-bg);
|
||||
border-color: color-mix(in srgb, var(--pngx-toast-success) 30%, transparent);
|
||||
}
|
||||
|
||||
&.toast-error {
|
||||
--pngx-toast-accent: var(--pngx-toast-error);
|
||||
background-color: var(--pngx-toast-error-bg);
|
||||
border-color: color-mix(in srgb, var(--pngx-toast-error) 35%, transparent);
|
||||
}
|
||||
}
|
||||
|
||||
::ng-deep .toast.error .toast-body {
|
||||
background-color: hsla(350, 79%, 40%, 0.8); // bg-danger
|
||||
border-top-left-radius: inherit;
|
||||
border-top-right-radius: inherit;
|
||||
border-bottom-left-radius: inherit;
|
||||
border-bottom-right-radius: inherit;
|
||||
.toast-icon {
|
||||
color: var(--pngx-toast-accent);
|
||||
}
|
||||
|
||||
.toast-content {
|
||||
flex: 1 1 auto;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.toast .btn-close {
|
||||
font-size: .6rem;
|
||||
margin-top: .3rem;
|
||||
margin-left: .75rem !important;
|
||||
opacity: .45;
|
||||
}
|
||||
|
||||
.toast:hover .btn-close {
|
||||
opacity: .85;
|
||||
}
|
||||
|
||||
// compact rows in the notifications dropdown
|
||||
.toast.toast-list-item {
|
||||
width: 100%;
|
||||
max-width: none;
|
||||
background-color: var(--pngx-toast-row-bg);
|
||||
border: 0;
|
||||
box-shadow: none;
|
||||
|
||||
&:hover {
|
||||
background-color: var(--pngx-toast-row-hover-bg);
|
||||
}
|
||||
|
||||
&.toast-error {
|
||||
background-color: var(--pngx-toast-error-bg);
|
||||
}
|
||||
|
||||
::ng-deep .toast-body {
|
||||
padding: .625rem .75rem;
|
||||
}
|
||||
|
||||
.toast-time {
|
||||
margin-top: .1rem;
|
||||
}
|
||||
|
||||
// marks notifications that arrived since the dropdown was last opened
|
||||
&.toast-new .toast-time::before {
|
||||
content: '';
|
||||
display: inline-block;
|
||||
width: .45rem;
|
||||
height: .45rem;
|
||||
margin-right: .4rem;
|
||||
vertical-align: .05rem;
|
||||
border-radius: 50%;
|
||||
background-color: var(--pngx-toast-info);
|
||||
}
|
||||
}
|
||||
|
||||
.toast-action {
|
||||
--bs-btn-padding-y: .1rem;
|
||||
--bs-btn-padding-x: .6rem;
|
||||
--bs-btn-font-size: .8rem;
|
||||
--bs-btn-font-weight: 600;
|
||||
--bs-btn-color: var(--pngx-toast-accent);
|
||||
--bs-btn-bg: color-mix(in srgb, var(--pngx-toast-accent) 14%, transparent);
|
||||
--bs-btn-border-color: transparent;
|
||||
--bs-btn-hover-color: var(--pngx-toast-accent);
|
||||
--bs-btn-hover-bg: color-mix(in srgb, var(--pngx-toast-accent) 24%, transparent);
|
||||
--bs-btn-hover-border-color: transparent;
|
||||
--bs-btn-active-color: var(--pngx-toast-accent);
|
||||
--bs-btn-active-bg: color-mix(in srgb, var(--pngx-toast-accent) 30%, transparent);
|
||||
--bs-btn-active-border-color: transparent;
|
||||
}
|
||||
|
||||
// countdown thin line
|
||||
.progress {
|
||||
background-color: var(--pngx-primary);
|
||||
opacity: .07;
|
||||
height: 2px;
|
||||
background-color: transparent;
|
||||
|
||||
::ng-deep .progress-bar {
|
||||
background-color: var(--bs-secondary-color);
|
||||
opacity: .5;
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,11 @@
|
||||
import { DatePipe } from '@angular/common'
|
||||
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||
|
||||
import { Clipboard } from '@angular/cdk/clipboard'
|
||||
import { allIcons, NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||
import { ToastLevel } from 'src/app/services/toast.service'
|
||||
import { ToastComponent } from './toast.component'
|
||||
|
||||
const toast1 = {
|
||||
@@ -30,6 +34,11 @@ describe('ToastComponent', () => {
|
||||
beforeEach(async () => {
|
||||
await TestBed.configureTestingModule({
|
||||
imports: [ToastComponent, NgxBootstrapIconsModule.pick(allIcons)],
|
||||
providers: [
|
||||
DatePipe,
|
||||
provideHttpClient(withInterceptorsFromDi()),
|
||||
provideHttpClientTesting(),
|
||||
],
|
||||
}).compileComponents()
|
||||
|
||||
fixture = TestBed.createComponent(ToastComponent)
|
||||
@@ -46,11 +55,117 @@ describe('ToastComponent', () => {
|
||||
component.toast = toast2
|
||||
fixture.detectChanges()
|
||||
component.onShown(toast2)
|
||||
jest.advanceTimersByTime(5000)
|
||||
expect(component.toast.delayRemaining).toEqual(0)
|
||||
jest.advanceTimersByTime(5000 + 150) // ticks every 150ms
|
||||
expect(component.delayRemaining()).toEqual(0)
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should start the progress bar full before the countdown begins', () => {
|
||||
component.toast = { content: 'Info', delay: 3000 }
|
||||
fixture.detectChanges()
|
||||
expect(component.delayRemaining()).toEqual(3000)
|
||||
})
|
||||
|
||||
it('should hide the toast when the countdown ends', () => {
|
||||
jest.useFakeTimers()
|
||||
const toast = { content: 'Info', delay: 3000 }
|
||||
component.toast = toast
|
||||
fixture.detectChanges()
|
||||
const hideSpy = jest.spyOn(component.ngbToast, 'hide')
|
||||
component.onShown(toast)
|
||||
jest.advanceTimersByTime(2850)
|
||||
expect(hideSpy).not.toHaveBeenCalled()
|
||||
jest.advanceTimersByTime(300)
|
||||
expect(hideSpy).toHaveBeenCalled()
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should pause the countdown while hovered', () => {
|
||||
jest.useFakeTimers()
|
||||
const toast = { content: 'Info', delay: 3000 }
|
||||
component.toast = toast
|
||||
fixture.detectChanges()
|
||||
const hideSpy = jest.spyOn(component.ngbToast, 'hide')
|
||||
const el: HTMLElement = fixture.nativeElement.querySelector('ngb-toast')
|
||||
component.onShown(toast)
|
||||
jest.advanceTimersByTime(1500)
|
||||
el.dispatchEvent(new MouseEvent('mouseenter'))
|
||||
const remaining = component.delayRemaining()
|
||||
jest.advanceTimersByTime(10000)
|
||||
expect(component.delayRemaining()).toEqual(remaining)
|
||||
expect(hideSpy).not.toHaveBeenCalled()
|
||||
|
||||
el.dispatchEvent(new MouseEvent('mouseleave'))
|
||||
jest.advanceTimersByTime(remaining + 150)
|
||||
expect(hideSpy).toHaveBeenCalled()
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should pause the countdown while focus is inside', () => {
|
||||
jest.useFakeTimers()
|
||||
const toast = { content: 'Info', delay: 3000 }
|
||||
component.toast = toast
|
||||
fixture.detectChanges()
|
||||
const el: HTMLElement = fixture.nativeElement.querySelector('ngb-toast')
|
||||
component.onShown(toast)
|
||||
el.dispatchEvent(new FocusEvent('focusin'))
|
||||
// mouse leaving doesn't resume while focus is still inside
|
||||
el.dispatchEvent(new MouseEvent('mouseenter'))
|
||||
el.dispatchEvent(new MouseEvent('mouseleave'))
|
||||
jest.advanceTimersByTime(5000)
|
||||
expect(component.delayRemaining()).toEqual(3000)
|
||||
el.dispatchEvent(new FocusEvent('focusout'))
|
||||
jest.advanceTimersByTime(3000)
|
||||
expect(component.delayRemaining()).toEqual(0)
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should not count down without autohide', () => {
|
||||
jest.useFakeTimers()
|
||||
const toast = { content: 'Info', delay: 3000 }
|
||||
component.toast = toast
|
||||
component.autohide = false
|
||||
fixture.detectChanges()
|
||||
component.onShown(toast)
|
||||
jest.advanceTimersByTime(5000)
|
||||
expect(component.delayRemaining()).toBeNull()
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should show an icon and colors for each level', () => {
|
||||
component.toast = {
|
||||
content: 'Saved',
|
||||
delay: 5000,
|
||||
level: ToastLevel.Success,
|
||||
}
|
||||
fixture.detectChanges()
|
||||
const el: HTMLElement = fixture.nativeElement
|
||||
expect(el.querySelector('i-bs[name="check-circle"]')).not.toBeNull()
|
||||
expect(el.querySelector('ngb-toast').classList).not.toContain('toast-error')
|
||||
|
||||
fixture = TestBed.createComponent(ToastComponent)
|
||||
fixture.componentInstance.toast = {
|
||||
content: 'Failed',
|
||||
delay: 5000,
|
||||
level: ToastLevel.Error,
|
||||
}
|
||||
fixture.detectChanges()
|
||||
const errorEl: HTMLElement = fixture.nativeElement
|
||||
expect(
|
||||
errorEl.querySelector('i-bs[name="exclamation-triangle"]')
|
||||
).not.toBeNull()
|
||||
expect(errorEl.querySelector('ngb-toast').classList).toContain(
|
||||
'toast-error'
|
||||
)
|
||||
|
||||
fixture = TestBed.createComponent(ToastComponent)
|
||||
fixture.componentInstance.toast = { content: 'Started', delay: 5000 }
|
||||
fixture.detectChanges()
|
||||
expect(
|
||||
fixture.nativeElement.querySelector('i-bs[name="info-circle"]')
|
||||
).not.toBeNull()
|
||||
})
|
||||
|
||||
it('should show an error if given with toast', () => {
|
||||
component.toast = toast1
|
||||
fixture.detectChanges()
|
||||
@@ -88,4 +203,70 @@ describe('ToastComponent', () => {
|
||||
component.getErrorText({ error: new Array(205).join('a') })
|
||||
).toContain('...')
|
||||
})
|
||||
|
||||
it('should emit actioned, not closed, when the action is clicked', () => {
|
||||
const action = jest.fn()
|
||||
component.toast = {
|
||||
content: 'Moved',
|
||||
delay: 5000,
|
||||
action,
|
||||
actionName: 'Undo',
|
||||
}
|
||||
fixture.detectChanges()
|
||||
const closedSpy = jest.spyOn(component.closed, 'emit')
|
||||
const actionedSpy = jest.spyOn(component.actioned, 'emit')
|
||||
const button: HTMLButtonElement = [
|
||||
...fixture.nativeElement.querySelectorAll('button'),
|
||||
].find((b) => b.textContent.includes('Undo'))
|
||||
button.click()
|
||||
expect(actionedSpy).toHaveBeenCalled()
|
||||
expect(closedSpy).not.toHaveBeenCalled()
|
||||
expect(action).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should show a relative timestamp in the notifications list', () => {
|
||||
component.toast = { content: 'Saved', delay: 5000, timestamp: new Date() }
|
||||
component.autohide = false
|
||||
fixture.detectChanges()
|
||||
expect(fixture.nativeElement.textContent).toContain('Just now')
|
||||
})
|
||||
|
||||
it('should update the relative timestamp as time passes', () => {
|
||||
jest.useFakeTimers()
|
||||
jest.setSystemTime(new Date('2026-10-19T12:00:00Z'))
|
||||
component.toast = { content: 'Saved', delay: 5000, timestamp: new Date() }
|
||||
component.autohide = false
|
||||
fixture.componentRef.setInput('now', new Date())
|
||||
fixture.detectChanges()
|
||||
expect(fixture.nativeElement.textContent).toContain('Just now')
|
||||
|
||||
jest.setSystemTime(new Date('2026-10-19T12:03:00Z'))
|
||||
fixture.componentRef.setInput('now', new Date())
|
||||
fixture.detectChanges()
|
||||
expect(fixture.nativeElement.textContent).toContain('3 minutes ago')
|
||||
jest.useRealTimers()
|
||||
})
|
||||
|
||||
it('should show a compact action link in the notifications list', () => {
|
||||
const action = jest.fn()
|
||||
component.toast = {
|
||||
content: 'Moved',
|
||||
delay: 5000,
|
||||
action,
|
||||
actionName: 'Undo',
|
||||
timestamp: new Date(),
|
||||
}
|
||||
component.autohide = false
|
||||
fixture.detectChanges()
|
||||
const link: HTMLButtonElement =
|
||||
fixture.nativeElement.querySelector('.toast-action')
|
||||
expect(link.textContent).toContain('Undo')
|
||||
expect(
|
||||
fixture.nativeElement.querySelector('.btn-outline-secondary')
|
||||
).toBeNull()
|
||||
const actionedSpy = jest.spyOn(component.actioned, 'emit')
|
||||
link.click()
|
||||
expect(actionedSpy).toHaveBeenCalled()
|
||||
expect(action).toHaveBeenCalled()
|
||||
})
|
||||
})
|
||||
@@ -1,20 +1,26 @@
|
||||
import { Clipboard } from '@angular/cdk/clipboard'
|
||||
import { DecimalPipe } from '@angular/common'
|
||||
import { DatePipe, DecimalPipe } from '@angular/common'
|
||||
import {
|
||||
Component,
|
||||
DestroyRef,
|
||||
EventEmitter,
|
||||
Input,
|
||||
OnInit,
|
||||
Output,
|
||||
ViewChild,
|
||||
inject,
|
||||
signal,
|
||||
} from '@angular/core'
|
||||
import { takeUntilDestroyed } from '@angular/core/rxjs-interop'
|
||||
import {
|
||||
NgbProgressbarModule,
|
||||
NgbToast,
|
||||
NgbToastModule,
|
||||
} from '@ng-bootstrap/ng-bootstrap'
|
||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||
import { interval, take } from 'rxjs'
|
||||
import { Toast } from 'src/app/services/toast.service'
|
||||
import { Subscription, interval, takeWhile } from 'rxjs'
|
||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||
import { Toast, ToastLevel } from 'src/app/services/toast.service'
|
||||
|
||||
@Component({
|
||||
selector: 'pngx-toast',
|
||||
@@ -26,32 +32,79 @@ import { Toast } from 'src/app/services/toast.service'
|
||||
],
|
||||
templateUrl: './toast.component.html',
|
||||
styleUrl: './toast.component.scss',
|
||||
providers: [DatePipe, CustomDatePipe],
|
||||
})
|
||||
export class ToastComponent {
|
||||
export class ToastComponent implements OnInit {
|
||||
private clipboard = inject(Clipboard)
|
||||
private customDatePipe = inject(CustomDatePipe)
|
||||
private destroyRef = inject(DestroyRef)
|
||||
readonly copied = signal(false)
|
||||
readonly ToastLevel = ToastLevel
|
||||
readonly delayRemaining = signal<number>(null)
|
||||
|
||||
@ViewChild(NgbToast) ngbToast: NgbToast
|
||||
|
||||
private hovered = false
|
||||
private focused = false
|
||||
private countdown: Subscription
|
||||
|
||||
@Input() toast: Toast
|
||||
|
||||
@Input() autohide: boolean = true
|
||||
|
||||
/** Each new value re-renders the relative timestamp */
|
||||
@Input() now: Date
|
||||
|
||||
/** Marks a notification that arrived since the dropdown was last opened */
|
||||
@Input() isNew: boolean = false
|
||||
|
||||
@Output() hidden: EventEmitter<Toast> = new EventEmitter<Toast>()
|
||||
|
||||
@Output() closed: EventEmitter<Toast> = new EventEmitter<Toast>()
|
||||
|
||||
/** The toast's action button was clicked */
|
||||
@Output() actioned: EventEmitter<Toast> = new EventEmitter<Toast>()
|
||||
|
||||
ngOnInit(): void {
|
||||
if (this.autohide) this.delayRemaining.set(this.toast.delay)
|
||||
}
|
||||
|
||||
get relativeTimestamp(): string {
|
||||
return this.customDatePipe.transform(this.toast.timestamp, 'relative')
|
||||
}
|
||||
|
||||
get paused(): boolean {
|
||||
return this.hovered || this.focused
|
||||
}
|
||||
|
||||
setHovered(hovered: boolean) {
|
||||
this.hovered = hovered
|
||||
}
|
||||
|
||||
setFocused(focused: boolean) {
|
||||
this.focused = focused
|
||||
}
|
||||
|
||||
onShown(toast: Toast) {
|
||||
if (!this.autohide) return
|
||||
|
||||
const refreshInterval = 150
|
||||
const delay = toast.delay - 500 // for fade animation
|
||||
this.delayRemaining.set(toast.delay)
|
||||
|
||||
interval(refreshInterval)
|
||||
.pipe(take(Math.round(delay / refreshInterval)))
|
||||
.subscribe((count) => {
|
||||
toast.delayRemaining = Math.max(
|
||||
0,
|
||||
delay - refreshInterval * (count + 1)
|
||||
this.countdown?.unsubscribe()
|
||||
this.countdown = interval(refreshInterval)
|
||||
.pipe(
|
||||
takeWhile(() => this.delayRemaining() > 0),
|
||||
takeUntilDestroyed(this.destroyRef)
|
||||
)
|
||||
.subscribe(() => {
|
||||
if (this.paused) return
|
||||
this.delayRemaining.update((remaining) =>
|
||||
Math.max(0, remaining - refreshInterval)
|
||||
)
|
||||
if (this.delayRemaining() === 0) {
|
||||
this.ngbToast?.hide()
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
@for (toast of toasts(); track toast.id) {
|
||||
<pngx-toast [toast]="toast" [autohide]="true" (closed)="closeToast()"></pngx-toast>
|
||||
<pngx-toast [toast]="toast" [autohide]="true" (closed)="removePopup(toast)" (actioned)="closeToast(toast)" (hidden)="removePopup(toast)"></pngx-toast>
|
||||
}
|
||||
@@ -1,10 +1,11 @@
|
||||
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 { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
|
||||
import { Subject } from 'rxjs'
|
||||
import { Toast, ToastService } from 'src/app/services/toast.service'
|
||||
import { ToastsComponent } from './toasts.component'
|
||||
import { MAX_VISIBLE_TOASTS, ToastsComponent } from './toasts.component'
|
||||
|
||||
const toast = {
|
||||
content: 'Error 2 content',
|
||||
@@ -50,7 +51,7 @@ describe('ToastsComponent', () => {
|
||||
it('should close toast', () => {
|
||||
toastSubject.next(toast)
|
||||
const closeToastSpy = jest.spyOn(toastService, 'closeToast')
|
||||
component.closeToast()
|
||||
component.closeToast(toast)
|
||||
expect(component.toasts()).toEqual([])
|
||||
expect(closeToastSpy).toHaveBeenCalledWith(toast)
|
||||
})
|
||||
@@ -59,4 +60,59 @@ describe('ToastsComponent', () => {
|
||||
toastSubject.next(toast)
|
||||
expect(component.toasts()).toEqual([toast])
|
||||
})
|
||||
|
||||
it('should stack popups newest first, up to the maximum', () => {
|
||||
const toasts: Toast[] = Array.from(
|
||||
{ length: MAX_VISIBLE_TOASTS + 1 },
|
||||
(_, i) => ({ id: `${i}`, content: `Toast ${i}`, delay: 5000 })
|
||||
)
|
||||
toasts.forEach((t) => toastSubject.next(t))
|
||||
expect(component.toasts().map((t) => t.id)).toEqual(['3', '2', '1'])
|
||||
|
||||
// showing a visible toast again moves it to the top without duplicating
|
||||
toastSubject.next(toasts[1])
|
||||
expect(component.toasts().map((t) => t.id)).toEqual(['1', '3', '2'])
|
||||
})
|
||||
|
||||
it('should remove a popup when it hides without closing it', () => {
|
||||
const closeToastSpy = jest.spyOn(toastService, 'closeToast')
|
||||
const first = { id: 'a', content: 'A', delay: 5000 }
|
||||
const second = { id: 'b', content: 'B', delay: 5000 }
|
||||
toastSubject.next(first)
|
||||
toastSubject.next(second)
|
||||
component.removePopup(first)
|
||||
expect(component.toasts()).toEqual([second])
|
||||
expect(closeToastSpy).not.toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should clear popups when toastService emits null', () => {
|
||||
toastSubject.next(toast)
|
||||
toastSubject.next(null)
|
||||
expect(component.toasts()).toEqual([])
|
||||
})
|
||||
|
||||
it('should render one toast component per popup', () => {
|
||||
toastSubject.next({ id: 'a', content: 'A', delay: 5000 })
|
||||
toastSubject.next({ id: 'b', content: 'B', delay: 5000 })
|
||||
fixture.detectChanges()
|
||||
expect(fixture.nativeElement.querySelectorAll('pngx-toast')).toHaveLength(2)
|
||||
})
|
||||
|
||||
it('should only hide the popup on close, but clear it on action', () => {
|
||||
const closeToastSpy = jest.spyOn(toastService, 'closeToast')
|
||||
const first = { id: 'a', content: 'A', delay: 5000 }
|
||||
const second = { id: 'b', content: 'B', delay: 5000 }
|
||||
toastSubject.next(first)
|
||||
toastSubject.next(second)
|
||||
fixture.detectChanges()
|
||||
const popups = fixture.debugElement.queryAll(By.css('pngx-toast'))
|
||||
|
||||
popups[1].triggerEventHandler('closed', first)
|
||||
expect(closeToastSpy).not.toHaveBeenCalled()
|
||||
expect(component.toasts()).toEqual([second])
|
||||
|
||||
popups[0].triggerEventHandler('actioned', second)
|
||||
expect(closeToastSpy).toHaveBeenCalledWith(second)
|
||||
expect(component.toasts()).toEqual([])
|
||||
})
|
||||
})
|
||||
@@ -1,14 +1,18 @@
|
||||
import { Component, inject } from '@angular/core'
|
||||
import { toSignal } from '@angular/core/rxjs-interop'
|
||||
import { Component, inject, signal } from '@angular/core'
|
||||
import { takeUntilDestroyed } from '@angular/core/rxjs-interop'
|
||||
import {
|
||||
NgbAccordionModule,
|
||||
NgbProgressbarModule,
|
||||
} from '@ng-bootstrap/ng-bootstrap'
|
||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||
import { map, merge, Subject } from 'rxjs'
|
||||
import { Toast, ToastService } from 'src/app/services/toast.service'
|
||||
import { ToastComponent } from '../toast/toast.component'
|
||||
|
||||
/**
|
||||
* Maximum number of popup toasts shown at once
|
||||
*/
|
||||
export const MAX_VISIBLE_TOASTS = 3
|
||||
|
||||
@Component({
|
||||
selector: 'pngx-toasts',
|
||||
templateUrl: './toasts.component.html',
|
||||
@@ -23,18 +27,31 @@ import { ToastComponent } from '../toast/toast.component'
|
||||
export class ToastsComponent {
|
||||
toastService = inject(ToastService)
|
||||
|
||||
private readonly closedToast = new Subject<void>()
|
||||
readonly toasts = signal<Toast[]>([])
|
||||
|
||||
readonly toasts = toSignal(
|
||||
merge(
|
||||
this.toastService.showToast.pipe(map((toast) => (toast ? [toast] : []))),
|
||||
this.closedToast.pipe(map(() => [] as Toast[]))
|
||||
),
|
||||
{ initialValue: [] as Toast[] }
|
||||
)
|
||||
constructor() {
|
||||
this.toastService.showToast
|
||||
.pipe(takeUntilDestroyed())
|
||||
.subscribe((toast) => {
|
||||
if (!toast) {
|
||||
this.toasts.set([])
|
||||
return
|
||||
}
|
||||
this.toasts.update((toasts) =>
|
||||
[toast, ...toasts.filter((t) => t.id !== toast.id)].slice(
|
||||
0,
|
||||
MAX_VISIBLE_TOASTS
|
||||
)
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
closeToast() {
|
||||
this.toastService.closeToast(this.toasts()[0])
|
||||
this.closedToast.next()
|
||||
closeToast(toast: Toast) {
|
||||
this.toastService.closeToast(toast)
|
||||
this.removePopup(toast)
|
||||
}
|
||||
|
||||
removePopup(toast: Toast) {
|
||||
this.toasts.update((toasts) => toasts.filter((t) => t.id !== toast.id))
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
@if (canAddDocuments && getStatus().length > 0) {
|
||||
<div class="fixed-bottom p-2 p-md-4 d-flex justify-content-end pe-none consumer-status-list" [ngClass]="slimSidebarEnabled ? 'col-slim' : 'offset-sidebar-expanded'">
|
||||
<div class="col col-lg-4 col-xl-3 ps-0 pe-0 ps-lg-3 pe-lg-0 pe-auto overflow-y-auto">
|
||||
<div class="card shadow-sm consumer-status-card">
|
||||
<div class="card-body">
|
||||
<div class="d-flex flex-wrap align-items-center column-gap-2">
|
||||
<p class="m-0 small text-muted">{{getStatusSummary()}}</p>
|
||||
<div class="d-flex align-items-center gap-2 ms-auto">
|
||||
@if (getStatusCompleted().length > 0) {
|
||||
<a class="btn-link small text-nowrap" (click)="dismissCompleted()" [routerLink]="[]">
|
||||
<span class="me-1" i18n="This button dismisses all status messages about processed documents in the tray (failed and successful)">Dismiss completed</span>
|
||||
<i-bs name="check2-all"></i-bs>
|
||||
</a>
|
||||
}
|
||||
<button type="button" class="btn btn-sm btn-link p-0 text-muted" (click)="toggleCollapsed()"
|
||||
[attr.aria-expanded]="!collapsed()" aria-label="Toggle document processing status" i18n-aria-label>
|
||||
<i-bs [name]="collapsed() ? 'chevron-up' : 'chevron-down'"></i-bs>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
@if (!collapsed()) {
|
||||
@for (status of getStatus(); track status) {
|
||||
<ng-container [ngTemplateOutlet]="consumerAlert" [ngTemplateOutletContext]="{ $implicit: status }"></ng-container>
|
||||
}
|
||||
}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
}
|
||||
|
||||
<ng-template #consumerAlert let-status>
|
||||
<ngb-alert type="secondary" class="mt-2 mb-0" [dismissible]="isFinished(status)" (closed)="dismiss(status)">
|
||||
<h6 class="alert-heading">{{status.filename}}</h6>
|
||||
@if (!isFinished(status) || (isFinished(status) && !status.documentId)) {
|
||||
<p class="mb-0 pb-1">{{status.message}}</p>
|
||||
}
|
||||
<ngb-progressbar [value]="status.getProgress()" [max]="1" [type]="getStatusColor(status)"></ngb-progressbar>
|
||||
<div *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Document }">
|
||||
@if (isFinished(status)) {
|
||||
<div>
|
||||
@if (status.documentId) {
|
||||
<a class="btn btn-sm btn-outline-primary btn-open" [routerLink]="['/documents', status.documentId]" (click)="dismiss(status)">
|
||||
<small i18n>Open document</small>
|
||||
<i-bs name="arrow-right-short"></i-bs>
|
||||
</a>
|
||||
}
|
||||
</div>
|
||||
}
|
||||
</div>
|
||||
</ngb-alert>
|
||||
</ng-template>
|
||||
@@ -0,0 +1,36 @@
|
||||
:host ::ng-deep i-bs svg {
|
||||
margin-top: -3px;
|
||||
}
|
||||
|
||||
.alert-heading {
|
||||
font-size: 80%;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.btn-open {
|
||||
line-height: 1;
|
||||
|
||||
i-bs {
|
||||
margin-top: -1px;
|
||||
}
|
||||
}
|
||||
|
||||
.consumer-status-card {
|
||||
background-color: rgba(var(--bs-body-bg-rgb), .95) !important;
|
||||
}
|
||||
|
||||
.consumer-status-list {
|
||||
max-height: 60vh;
|
||||
z-index: 1030;
|
||||
}
|
||||
|
||||
.progress {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
height: auto;
|
||||
mix-blend-mode: soft-light;
|
||||
pointer-events: none;
|
||||
}
|
||||
+186
@@ -0,0 +1,186 @@
|
||||
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 { RouterTestingModule } from '@angular/router/testing'
|
||||
import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
|
||||
import { routes } from 'src/app/app-routing.module'
|
||||
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
|
||||
import { PermissionsService } from 'src/app/services/permissions.service'
|
||||
import {
|
||||
FileStatus,
|
||||
FileStatusPhase,
|
||||
WebsocketStatusService,
|
||||
} from 'src/app/services/websocket-status.service'
|
||||
import { UploadStatusTrayComponent } from './upload-status-tray.component'
|
||||
|
||||
const FAILED_STATUSES = [new FileStatus()]
|
||||
const WORKING_STATUSES = [new FileStatus(), new FileStatus()]
|
||||
const STARTED_STATUSES = [new FileStatus(), new FileStatus(), new FileStatus()]
|
||||
const SUCCESS_STATUSES = [
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
]
|
||||
const DEFAULT_STATUSES = [
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
new FileStatus(),
|
||||
]
|
||||
|
||||
describe('UploadStatusTrayComponent', () => {
|
||||
let component: UploadStatusTrayComponent
|
||||
let fixture: ComponentFixture<UploadStatusTrayComponent>
|
||||
let websocketStatusService: WebsocketStatusService
|
||||
|
||||
beforeEach(async () => {
|
||||
TestBed.configureTestingModule({
|
||||
imports: [
|
||||
RouterTestingModule.withRoutes(routes),
|
||||
NgxBootstrapIconsModule.pick(allIcons),
|
||||
UploadStatusTrayComponent,
|
||||
],
|
||||
providers: [
|
||||
PermissionsGuard,
|
||||
{
|
||||
provide: PermissionsService,
|
||||
useValue: {
|
||||
currentUserCan: () => true,
|
||||
},
|
||||
},
|
||||
provideHttpClient(withInterceptorsFromDi()),
|
||||
provideHttpClientTesting(),
|
||||
],
|
||||
}).compileComponents()
|
||||
|
||||
websocketStatusService = TestBed.inject(WebsocketStatusService)
|
||||
fixture = TestBed.createComponent(UploadStatusTrayComponent)
|
||||
component = fixture.componentInstance
|
||||
|
||||
fixture.detectChanges()
|
||||
})
|
||||
|
||||
it('should not render without statuses', () => {
|
||||
expect(
|
||||
fixture.nativeElement.querySelector('.consumer-status-card')
|
||||
).toBeNull()
|
||||
})
|
||||
|
||||
it('should render statuses and support collapsing', () => {
|
||||
const status = new FileStatus()
|
||||
status.filename = 'invoice.pdf'
|
||||
status.phase = FileStatusPhase.WORKING
|
||||
jest
|
||||
.spyOn(websocketStatusService, 'getConsumerStatus')
|
||||
.mockReturnValue([status])
|
||||
// a mocked return value doesn't mark the zoneless view dirty, so re-create it
|
||||
fixture = TestBed.createComponent(UploadStatusTrayComponent)
|
||||
component = fixture.componentInstance
|
||||
fixture.detectChanges()
|
||||
const el: HTMLElement = fixture.nativeElement
|
||||
expect(el.querySelector('.consumer-status-card')).not.toBeNull()
|
||||
expect(el.textContent).toContain('invoice.pdf')
|
||||
|
||||
component.toggleCollapsed()
|
||||
fixture.detectChanges()
|
||||
expect(el.querySelector('.consumer-status-card')).not.toBeNull()
|
||||
expect(el.textContent).not.toContain('invoice.pdf')
|
||||
|
||||
component.toggleCollapsed()
|
||||
fixture.detectChanges()
|
||||
expect(el.textContent).toContain('invoice.pdf')
|
||||
})
|
||||
|
||||
it('should expand again once all statuses are dismissed', () => {
|
||||
const status = websocketStatusService.newFileUpload('invoice.pdf')
|
||||
fixture.detectChanges()
|
||||
component.toggleCollapsed()
|
||||
expect(component.collapsed()).toBe(true)
|
||||
websocketStatusService.dismiss(status)
|
||||
fixture.detectChanges()
|
||||
expect(component.collapsed()).toBe(false)
|
||||
})
|
||||
|
||||
it('should generate stats summary', () => {
|
||||
mockConsumerStatuses(websocketStatusService)
|
||||
expect(component.getStatusSummary()).toEqual(
|
||||
'Processing: 6, Failed: 1, Added: 4'
|
||||
)
|
||||
})
|
||||
|
||||
it('should report an upload progress summary', () => {
|
||||
mockConsumerStatuses(websocketStatusService)
|
||||
expect(component.getTotalUploadProgress()).toEqual(0.75)
|
||||
})
|
||||
|
||||
it('should change color by status phase', () => {
|
||||
const processingStatus = new FileStatus()
|
||||
processingStatus.phase = FileStatusPhase.WORKING
|
||||
expect(component.getStatusColor(processingStatus)).toEqual('primary')
|
||||
processingStatus.phase = FileStatusPhase.UPLOADING
|
||||
expect(component.getStatusColor(processingStatus)).toEqual('primary')
|
||||
const failedStatus = new FileStatus()
|
||||
failedStatus.phase = FileStatusPhase.FAILED
|
||||
expect(component.getStatusColor(failedStatus)).toEqual('danger')
|
||||
const successStatus = new FileStatus()
|
||||
successStatus.phase = FileStatusPhase.SUCCESS
|
||||
expect(component.getStatusColor(successStatus)).toEqual('success')
|
||||
})
|
||||
|
||||
it('should allow dismissing an alert', () => {
|
||||
const dismissSpy = jest.spyOn(websocketStatusService, 'dismiss')
|
||||
component.dismiss(new FileStatus())
|
||||
expect(dismissSpy).toHaveBeenCalled()
|
||||
})
|
||||
|
||||
it('should allow dismissing completed alerts', () => {
|
||||
jest.useFakeTimers()
|
||||
mockConsumerStatuses(websocketStatusService)
|
||||
fixture.detectChanges()
|
||||
jest
|
||||
.spyOn(component, 'getStatusCompleted')
|
||||
.mockImplementation(() => SUCCESS_STATUSES)
|
||||
const dismissSpy = jest.spyOn(websocketStatusService, 'dismiss')
|
||||
component.dismissCompleted()
|
||||
jest.advanceTimersByTime(1000)
|
||||
fixture.detectChanges()
|
||||
expect(dismissSpy).toHaveBeenCalledTimes(4)
|
||||
jest.useRealTimers()
|
||||
})
|
||||
})
|
||||
|
||||
function mockConsumerStatuses(consumerStatusService) {
|
||||
const partialUpload1 = new FileStatus()
|
||||
partialUpload1.currentPhaseProgress = 50
|
||||
partialUpload1.currentPhaseMaxProgress = 50
|
||||
const partialUpload2 = new FileStatus()
|
||||
partialUpload2.currentPhaseProgress = 25
|
||||
partialUpload2.currentPhaseMaxProgress = 50
|
||||
jest
|
||||
.spyOn(consumerStatusService, 'getConsumerStatus')
|
||||
.mockImplementation((phase) => {
|
||||
switch (phase) {
|
||||
case FileStatusPhase.FAILED:
|
||||
return FAILED_STATUSES
|
||||
case FileStatusPhase.WORKING:
|
||||
return WORKING_STATUSES
|
||||
case FileStatusPhase.STARTED:
|
||||
return STARTED_STATUSES
|
||||
case FileStatusPhase.SUCCESS:
|
||||
return SUCCESS_STATUSES
|
||||
case FileStatusPhase.UPLOADING:
|
||||
return [partialUpload1, partialUpload2]
|
||||
default:
|
||||
return DEFAULT_STATUSES
|
||||
}
|
||||
})
|
||||
jest
|
||||
.spyOn(consumerStatusService, 'getConsumerStatusNotCompleted')
|
||||
.mockImplementation(() => {
|
||||
return DEFAULT_STATUSES
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
import { NgClass, NgTemplateOutlet } from '@angular/common'
|
||||
import { Component, effect, inject, signal } from '@angular/core'
|
||||
import { RouterModule } from '@angular/router'
|
||||
import {
|
||||
NgbAlertModule,
|
||||
NgbProgressbarModule,
|
||||
} from '@ng-bootstrap/ng-bootstrap'
|
||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||
import { ComponentWithPermissions } from 'src/app/components/with-permissions/with-permissions.component'
|
||||
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||
import {
|
||||
PermissionAction,
|
||||
PermissionsService,
|
||||
PermissionType,
|
||||
} from 'src/app/services/permissions.service'
|
||||
import { SettingsService } from 'src/app/services/settings.service'
|
||||
import {
|
||||
FileStatus,
|
||||
FileStatusPhase,
|
||||
WebsocketStatusService,
|
||||
} from 'src/app/services/websocket-status.service'
|
||||
|
||||
/** Floating list of document consumption statuses, shown on every page */
|
||||
@Component({
|
||||
selector: 'pngx-upload-status-tray',
|
||||
templateUrl: './upload-status-tray.component.html',
|
||||
styleUrls: ['./upload-status-tray.component.scss'],
|
||||
imports: [
|
||||
IfPermissionsDirective,
|
||||
NgClass,
|
||||
NgTemplateOutlet,
|
||||
RouterModule,
|
||||
NgbAlertModule,
|
||||
NgbProgressbarModule,
|
||||
NgxBootstrapIconsModule,
|
||||
],
|
||||
})
|
||||
export class UploadStatusTrayComponent extends ComponentWithPermissions {
|
||||
private websocketStatusService = inject(WebsocketStatusService)
|
||||
private settingsService = inject(SettingsService)
|
||||
private permissionsService = inject(PermissionsService)
|
||||
|
||||
readonly collapsed = signal(false)
|
||||
|
||||
constructor() {
|
||||
super()
|
||||
// start expanded again for the next uploads once everything is dismissed
|
||||
effect(() => {
|
||||
if (this.getStatus().length === 0) this.collapsed.set(false)
|
||||
})
|
||||
}
|
||||
|
||||
get canAddDocuments(): boolean {
|
||||
return this.permissionsService.currentUserCan(
|
||||
PermissionAction.Add,
|
||||
PermissionType.Document
|
||||
)
|
||||
}
|
||||
|
||||
getStatus() {
|
||||
return this.websocketStatusService.getConsumerStatus()
|
||||
}
|
||||
|
||||
getStatusSummary() {
|
||||
let strings = []
|
||||
let countUploadingAndProcessing =
|
||||
this.websocketStatusService.getConsumerStatusNotCompleted().length
|
||||
let countFailed = this.getStatusFailed().length
|
||||
let countSuccess = this.getStatusSuccess().length
|
||||
if (countUploadingAndProcessing > 0) {
|
||||
strings.push($localize`Processing: ${countUploadingAndProcessing}`)
|
||||
}
|
||||
if (countFailed > 0) {
|
||||
strings.push($localize`Failed: ${countFailed}`)
|
||||
}
|
||||
if (countSuccess > 0) {
|
||||
strings.push($localize`Added: ${countSuccess}`)
|
||||
}
|
||||
return strings.join(
|
||||
$localize`:this string is used to separate processing, failed and added on the file upload widget:, `
|
||||
)
|
||||
}
|
||||
|
||||
getStatusUploading() {
|
||||
return this.websocketStatusService.getConsumerStatus(
|
||||
FileStatusPhase.UPLOADING
|
||||
)
|
||||
}
|
||||
|
||||
getStatusFailed() {
|
||||
return this.websocketStatusService.getConsumerStatus(FileStatusPhase.FAILED)
|
||||
}
|
||||
|
||||
getStatusSuccess() {
|
||||
return this.websocketStatusService.getConsumerStatus(
|
||||
FileStatusPhase.SUCCESS
|
||||
)
|
||||
}
|
||||
|
||||
getStatusCompleted() {
|
||||
return this.websocketStatusService.getConsumerStatusCompleted()
|
||||
}
|
||||
|
||||
getTotalUploadProgress() {
|
||||
let current = 0
|
||||
let max = 0
|
||||
|
||||
this.getStatusUploading().forEach((status) => {
|
||||
current += status.currentPhaseProgress
|
||||
max += status.currentPhaseMaxProgress
|
||||
})
|
||||
|
||||
return current / Math.max(max, 1)
|
||||
}
|
||||
|
||||
isFinished(status: FileStatus) {
|
||||
return (
|
||||
status.phase == FileStatusPhase.FAILED ||
|
||||
status.phase == FileStatusPhase.SUCCESS
|
||||
)
|
||||
}
|
||||
|
||||
getStatusColor(status: FileStatus) {
|
||||
switch (status.phase) {
|
||||
case FileStatusPhase.UPLOADING:
|
||||
case FileStatusPhase.STARTED:
|
||||
case FileStatusPhase.WORKING:
|
||||
return 'primary'
|
||||
case FileStatusPhase.FAILED:
|
||||
return 'danger'
|
||||
case FileStatusPhase.SUCCESS:
|
||||
return 'success'
|
||||
}
|
||||
}
|
||||
|
||||
toggleCollapsed() {
|
||||
this.collapsed.update((collapsed) => !collapsed)
|
||||
}
|
||||
|
||||
dismiss(status: FileStatus) {
|
||||
this.websocketStatusService.dismiss(status)
|
||||
}
|
||||
|
||||
dismissCompleted() {
|
||||
this.getStatusCompleted().forEach((status) =>
|
||||
this.websocketStatusService.dismiss(status)
|
||||
)
|
||||
}
|
||||
|
||||
get slimSidebarEnabled(): boolean {
|
||||
return this.settingsService.get(SETTINGS_KEYS.SLIM_SIDEBAR)
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user