Include animating to prevent toggle showing early

src-ui/src/app/components/admin/settings/settings.component.html

@@ -112,6 +112,22 @@
 
                 <pngx-input-check i18n-title title="Use 'slim' sidebar (icons only)" formControlName="slimSidebarEnabled"></pngx-input-check>
 
+                <p class="mb-2 mt-3" i18n>Sidebar items to show:</p>
+                @for (option of sidebarItemOptions; track option.id) {
+                  <div class="form-check">
+                    <input
+                      class="form-check-input"
+                      type="checkbox"
+                      [id]="'sidebar-item-setting-' + option.id"
+                      [checked]="isSidebarItemShown(option.id)"
+                      (change)="toggleSidebarItem(option.id, $event.target.checked)"
+                    />
+                    <label class="form-check-label" [for]="'sidebar-item-setting-' + option.id">
+                      {{ option.label }}
+                    </label>
+                  </div>
+                }
+
               </div>
             </div>
 

src-ui/src/app/components/admin/settings/settings.component.spec.ts

@@ -24,7 +24,7 @@ import {
   SystemStatus,
   SystemStatusItemStatus,
 } from 'src/app/data/system-status'
-import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import { HideableSidebarItemID, SETTINGS_KEYS } from 'src/app/data/ui-settings'
 import { IfOwnerDirective } from 'src/app/directives/if-owner.directive'
 import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { PermissionsGuard } from 'src/app/guards/permissions.guard'
@@ -209,6 +209,45 @@ describe('SettingsComponent', () => {
     fixture.detectChanges()
   }
 
+  it('supports configuring sidebar items and canceling changes', () => {
+    completeSetup()
+
+    component.toggleSidebarItem(HideableSidebarItemID.Workflows, false)
+    fixture.detectChanges()
+
+    expect(component.settingsForm.value.sidebarHiddenItems).toContain(
+      HideableSidebarItemID.Workflows
+    )
+
+    settingsService.updateSidebarItemVisibility(
+      HideableSidebarItemID.Mail,
+      false
+    )
+
+    expect(component.settingsForm.value.sidebarHiddenItems).toContain(
+      HideableSidebarItemID.Mail
+    )
+
+    component.reset()
+
+    expect(component.settingsForm.value.sidebarHiddenItems).not.toContain(
+      HideableSidebarItemID.Workflows
+    )
+    expect(component.settingsForm.value.sidebarHiddenItems).not.toContain(
+      HideableSidebarItemID.Mail
+    )
+  })
+
+  it('enables sidebar item controls on general settings until destroyed', () => {
+    completeSetup()
+
+    expect(settingsService.organizingSidebarItems()).toBe(true)
+
+    component.ngOnDestroy()
+
+    expect(settingsService.organizingSidebarItems()).toBe(false)
+  })
+
   it('should support tabbed settings & change URL, prevent navigation if dirty confirmation rejected', async () => {
     completeSetup()
     const navigateSpy = jest.spyOn(router, 'navigate')
@@ -249,6 +288,7 @@ describe('SettingsComponent', () => {
 
   it('should support save local settings updating appearance settings and calling API, show error', () => {
     completeSetup()
+    component.toggleSidebarItem(HideableSidebarItemID.Workflows, false)
     const toastErrorSpy = jest.spyOn(toastService, 'showError')
     const toastSpy = jest.spyOn(toastService, 'show')
     const storeSpy = jest.spyOn(settingsService, 'storeSettings')
@@ -267,7 +307,10 @@ describe('SettingsComponent', () => {
     expect(toastErrorSpy).toHaveBeenCalled()
     expect(storeSpy).toHaveBeenCalled()
     expect(appearanceSettingsSpy).not.toHaveBeenCalled()
-    expect(setSpy).toHaveBeenCalledTimes(33)
+    expect(setSpy).toHaveBeenCalledTimes(34)
+    expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+      HideableSidebarItemID.Workflows,
+    ])
 
     // succeed
     storeSpy.mockReturnValueOnce(of(true))

src-ui/src/app/components/admin/settings/settings.component.ts

@@ -39,7 +39,12 @@ import {
   SystemStatus,
   SystemStatusItemStatus,
 } from 'src/app/data/system-status'
-import { GlobalSearchType, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import {
+  GlobalSearchType,
+  HIDEABLE_SIDEBAR_ITEM_IDS,
+  HideableSidebarItemID,
+  SETTINGS_KEYS,
+} from 'src/app/data/ui-settings'
 import { User } from 'src/app/data/user'
 import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
@@ -102,6 +107,14 @@ const documentDetailFieldOptions = [
   { id: DocumentDetailFieldID.Tags, label: $localize`Tags` },
 ]
 
+const sidebarItemLabels: Record<HideableSidebarItemID, string> = {
+  [HideableSidebarItemID.Dashboard]: $localize`Dashboard`,
+  [HideableSidebarItemID.SavedViews]: $localize`Saved Views`,
+  [HideableSidebarItemID.Workflows]: $localize`Workflows`,
+  [HideableSidebarItemID.Mail]: $localize`Mail`,
+  [HideableSidebarItemID.Documentation]: $localize`Documentation`,
+}
+
 @Component({
   selector: 'pngx-settings',
   templateUrl: './settings.component.html',
@@ -149,6 +162,7 @@ export class SettingsComponent
     bulkEditApplyOnClose: new FormControl(null),
     documentListItemPerPage: new FormControl(null),
     slimSidebarEnabled: new FormControl(null),
+    sidebarHiddenItems: new FormControl<HideableSidebarItemID[]>([]),
     darkModeUseSystem: new FormControl(null),
     darkModeEnabled: new FormControl(null),
     darkModeInvertThumbs: new FormControl(null),
@@ -186,6 +200,7 @@ export class SettingsComponent
 
   store: BehaviorSubject<any>
   storeSub: Subscription
+  sidebarItemsSub: Subscription
   isDirty$: Observable<boolean>
   isDirty: boolean = false
   unsubscribeNotifier: Subject<any> = new Subject()
@@ -203,6 +218,10 @@ export class SettingsComponent
   public readonly PdfEditorEditMode = PdfEditorEditMode
 
   public readonly documentDetailFieldOptions = documentDetailFieldOptions
+  public readonly sidebarItemOptions = HIDEABLE_SIDEBAR_ITEM_IDS.map((id) => ({
+    id,
+    label: sidebarItemLabels[id],
+  }))
 
   get systemStatusHasErrors(): boolean {
     const status = this.systemStatus()
@@ -230,6 +249,10 @@ export class SettingsComponent
 
   constructor() {
     super()
+    this.sidebarItemsSub =
+      this.settings.sidebarHiddenItemsEditingChanged.subscribe((hiddenItems) =>
+        this.settingsForm.controls.sidebarHiddenItems.setValue(hiddenItems)
+      )
     this.settings.settingsSaved.subscribe(() => {
       if (!this.savePending) this.initialize()
       this.savedViewsService.maybeRefreshDocumentCounts()
@@ -279,14 +302,21 @@ export class SettingsComponent
 
     this.activatedRoute.paramMap.subscribe((paramMap) => {
       const section = paramMap.get('section')
+      let navID = SettingsNavIDs.General
       if (section) {
         const navIDKey: string = Object.keys(SettingsNavIDs).find(
           (navID) => navID.toLowerCase() == section
         )
         if (navIDKey) {
-          this.activeNavID.set(SettingsNavIDs[navIDKey])
+          navID = SettingsNavIDs[navIDKey]
         }
       }
+      this.activeNavID.set(navID)
+      this.settings.sidebarHiddenItemsEditing.set(
+        navID === SettingsNavIDs.General
+          ? [...this.settingsForm.controls.sidebarHiddenItems.value]
+          : null
+      )
     })
   }
 
@@ -310,6 +340,7 @@ export class SettingsComponent
         SETTINGS_KEYS.DOCUMENT_LIST_SIZE
       ),
       slimSidebarEnabled: this.settings.get(SETTINGS_KEYS.SLIM_SIDEBAR),
+      sidebarHiddenItems: this.settings.get(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS),
       darkModeUseSystem: this.settings.get(SETTINGS_KEYS.DARK_MODE_USE_SYSTEM),
       darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED),
       darkModeInvertThumbs: this.settings.get(
@@ -436,6 +467,12 @@ export class SettingsComponent
       this.settingsForm.patchValue(currentFormValue)
     }
 
+    if (this.settings.organizingSidebarItems()) {
+      this.settings.sidebarHiddenItemsEditing.set([
+        ...this.settingsForm.controls.sidebarHiddenItems.value,
+      ])
+    }
+
     if (this.canViewSystemStatus) {
       this.systemStatusService.get().subscribe((status) => {
         this.systemStatus.set(status)
@@ -444,8 +481,18 @@ export class SettingsComponent
   }
 
   ngOnDestroy() {
+    this.settings.sidebarHiddenItemsEditing.set(null)
     if (this.isDirty) this.settings.updateAppearanceSettings() // in case user changed appearance but didn't save
     this.storeSub && this.storeSub.unsubscribe()
+    this.sidebarItemsSub.unsubscribe()
+  }
+
+  isSidebarItemShown(item: HideableSidebarItemID): boolean {
+    return !(this.settingsForm.value.sidebarHiddenItems || []).includes(item)
+  }
+
+  toggleSidebarItem(item: HideableSidebarItemID, checked: boolean): void {
+    this.settings.updateSidebarItemVisibility(item, checked)
   }
 
   public saveSettings() {
@@ -473,6 +520,10 @@ export class SettingsComponent
       SETTINGS_KEYS.SLIM_SIDEBAR,
       this.settingsForm.value.slimSidebarEnabled
     )
+    this.settings.set(
+      SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS,
+      this.settingsForm.value.sidebarHiddenItems
+    )
     this.settings.set(
       SETTINGS_KEYS.DARK_MODE_USE_SYSTEM,
       this.settingsForm.value.darkModeUseSystem
@@ -632,6 +683,11 @@ export class SettingsComponent
 
   reset() {
     this.settingsForm.patchValue(this.store.getValue())
+    if (this.settings.organizingSidebarItems()) {
+      this.settings.sidebarHiddenItemsEditing.set([
+        ...this.settingsForm.controls.sidebarHiddenItems.value,
+      ])
+    }
   }
 
   clearThemeColor() {

src-ui/src/app/components/app-frame/app-frame.component.html

@@ -86,12 +86,15 @@
       }
       <div class="sidebar-sticky pt-3 pb-1 d-flex flex-column justify-space-around">
         <ul class="nav flex-column">
-          <li class="nav-item app-link">
-            <a class="nav-link" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()"
+          <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard) && !settingsService.organizingSidebarItems()">
+            <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="dashboard" routerLinkActive="active" (click)="closeMenu()"
               ngbPopover="Dashboard" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
               container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
               <i-bs class="me-2" name="house"></i-bs><span class="nav-link-label"><ng-container i18n>Dashboard</ng-container></span>
             </a>
+            @if (settingsService.organizingSidebarItems()) {
+              <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Dashboard" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Dashboard)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Dashboard, $event)"></pngx-input-switch>
+            }
           </li>
           <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Document }">
             <a class="nav-link" routerLink="documents" routerLinkActive="active"
@@ -237,29 +240,38 @@
                 </div>
               </li>
             }
-            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.SavedView }">
-              <a class="nav-link" routerLink="savedviews" routerLinkActive="active" (click)="closeMenu()"
+            <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.SavedView }">
+              <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="savedviews" routerLinkActive="active" (click)="closeMenu()"
                 ngbPopover="Saved Views" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
                 container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
                 <i-bs class="me-2" name="window-stack"></i-bs><span class="nav-link-label"><ng-container i18n>Saved Views</ng-container></span>
               </a>
+              @if (settingsService.organizingSidebarItems()) {
+                <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Saved Views" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.SavedViews)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.SavedViews, $event)"></pngx-input-switch>
+              }
             </li>
-            <li class="nav-item app-link"
+            <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows) && !settingsService.organizingSidebarItems()"
               *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Workflow }"
               tourAnchor="tour.workflows">
-              <a class="nav-link" routerLink="workflows" routerLinkActive="active" (click)="closeMenu()"
+              <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="workflows" routerLinkActive="active" (click)="closeMenu()"
                 ngbPopover="Workflows" i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end"
                 container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
                 <i-bs class="me-2" name="boxes"></i-bs><span class="nav-link-label"><ng-container i18n>Workflows</ng-container></span>
               </a>
+              @if (settingsService.organizingSidebarItems()) {
+                <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Workflows" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Workflows, $event)"></pngx-input-switch>
+              }
             </li>
-            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
+            <li class="nav-item app-link position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail) && !settingsService.organizingSidebarItems()" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.MailAccount }"
               tourAnchor="tour.mail">
-              <a class="nav-link" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
+              <a class="nav-link" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()" routerLink="mail" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Mail"
                 i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end" container="body"
                 triggers="mouseenter:mouseleave" popoverClass="popover-slim">
                 <i-bs class="me-2" name="envelope"></i-bs><span class="nav-link-label"><ng-container i18n>Mail</ng-container></span>
               </a>
+              @if (settingsService.organizingSidebarItems()) {
+                <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Mail" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Mail)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Mail, $event)"></pngx-input-switch>
+              }
             </li>
             <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Delete, type: PermissionType.Document }">
               <a class="nav-link" routerLink="trash" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Trash"
@@ -322,13 +334,16 @@
                 </a>
               </li>
             }
-            <li class="nav-item mt-2" tourAnchor="tour.outro">
-              <a class="text-muted small d-flex align-items-center flex-wrap text-decoration-none nav-anchor"
+            <li class="nav-item mt-2 position-relative" [class.d-none]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation) && !settingsService.organizingSidebarItems()" tourAnchor="tour.outro">
+              <a class="text-muted small d-flex align-items-center flex-wrap text-decoration-none nav-anchor" [class.opacity-50]="settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation)" [class.pe-5]="settingsService.organizingSidebarItems() && !slimSidebarEnabled && !slimSidebarAnimating()"
                 target="_blank" rel="noopener noreferrer" href="https://docs.paperless-ngx.com" ngbPopover="Documentation"
                 i18n-ngbPopover [disablePopover]="!slimSidebarPopoversEnabled" placement="end" container="body"
                 triggers="mouseenter:mouseleave" popoverClass="popover-slim">
                 <i-bs class="d-flex me-2" name="question-circle"></i-bs><span><ng-container i18n>Documentation</ng-container></span>
               </a>
+              @if (settingsService.organizingSidebarItems()) {
+                <pngx-input-switch class="position-absolute top-50 end-0 translate-middle-y me-1" [class.d-none]="slimSidebarEnabled || slimSidebarAnimating()" [compact]="true" title="Documentation" i18n-title [ngModel]="!settingsService.sidebarItemIsHidden(HideableSidebarItemID.Documentation)" (ngModelChange)="toggleSidebarItem(HideableSidebarItemID.Documentation, $event)"></pngx-input-switch>
+              }
             </li>
             <li class="nav-item" [class.visually-hidden]="slimSidebarEnabled">
               <div class="text-muted small d-flex align-items-center flex-wrap nav-label">

src-ui/src/app/components/app-frame/app-frame.component.spec.ts

@@ -15,7 +15,7 @@ import { provideUiTour } from 'ngx-ui-tour-ng-bootstrap'
 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 { HideableSidebarItemID, 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 {
@@ -287,6 +287,82 @@ describe('AppFrameComponent', () => {
     jest.useRealTimers()
   })
 
+  it('should hide configured sidebar items', () => {
+    settingsService.set(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+      HideableSidebarItemID.Dashboard,
+      HideableSidebarItemID.Workflows,
+    ])
+    fixture.detectChanges()
+
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="dashboard"]')
+        .parentElement.classList
+    ).toContain('d-none')
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="workflows"]')
+        .parentElement.classList
+    ).toContain('d-none')
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="mail"]').parentElement
+        .classList
+    ).not.toContain('d-none')
+  })
+
+  it('should show hidden items and visibility switches while customizing', () => {
+    settingsService.set(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
+      HideableSidebarItemID.Dashboard,
+    ])
+    settingsService.sidebarHiddenItemsEditing.set([
+      HideableSidebarItemID.Dashboard,
+    ])
+    fixture.detectChanges()
+
+    expect(
+      fixture.nativeElement.querySelectorAll('pngx-input-switch').length
+    ).toBe(5)
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="dashboard"]')
+        .parentElement.classList
+    ).not.toContain('d-none')
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+    ).toContain('opacity-50')
+
+    settingsService.set(SETTINGS_KEYS.SLIM_SIDEBAR, true)
+    fixture.detectChanges()
+
+    expect(
+      Array.from(
+        fixture.nativeElement.querySelectorAll('pngx-input-switch')
+      ).every((toggle: HTMLElement) => toggle.classList.contains('d-none'))
+    ).toBe(true)
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+    ).not.toContain('pe-5')
+
+    settingsService.set(SETTINGS_KEYS.SLIM_SIDEBAR, false)
+    component.slimSidebarAnimating.set(true)
+    fixture.detectChanges()
+
+    expect(
+      Array.from(
+        fixture.nativeElement.querySelectorAll('pngx-input-switch')
+      ).every((toggle: HTMLElement) => toggle.classList.contains('d-none'))
+    ).toBe(true)
+
+    component.slimSidebarAnimating.set(false)
+    fixture.detectChanges()
+
+    expect(
+      Array.from(
+        fixture.nativeElement.querySelectorAll('pngx-input-switch')
+      ).every((toggle: HTMLElement) => !toggle.classList.contains('d-none'))
+    ).toBe(true)
+    expect(
+      fixture.nativeElement.querySelector('[routerLink="dashboard"]').classList
+    ).toContain('pe-5')
+  })
+
   it('should show error on toggle slim sidebar if store settings fails', () => {
     jest.spyOn(console, 'warn').mockImplementation(() => {})
     const toastSpy = jest.spyOn(toastService, 'showError')

src-ui/src/app/components/app-frame/app-frame.component.ts

@@ -7,6 +7,7 @@ import {
 } from '@angular/cdk/drag-drop'
 import { NgClass } from '@angular/common'
 import { Component, HostListener, inject, OnInit, signal } from '@angular/core'
+import { FormsModule } from '@angular/forms'
 import { ActivatedRoute, Router, RouterModule } from '@angular/router'
 import {
   NgbCollapseModule,
@@ -21,7 +22,11 @@ import { Observable } from 'rxjs'
 import { first } from 'rxjs/operators'
 import { Document } from 'src/app/data/document'
 import { SavedView } from 'src/app/data/saved-view'
-import { CollapsibleSection, SETTINGS_KEYS } from 'src/app/data/ui-settings'
+import {
+  CollapsibleSection,
+  HideableSidebarItemID,
+  SETTINGS_KEYS,
+} from 'src/app/data/ui-settings'
 import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
 import { ComponentCanDeactivate } from 'src/app/guards/dirty-doc.guard'
 import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
@@ -48,6 +53,7 @@ import { ChatComponent } from '../chat/chat/chat.component'
 import { BrandMarkComponent } from '../common/logo/brand-mark/brand-mark.component'
 import { LogoComponent } from '../common/logo/logo.component'
 import { ProfileEditDialogComponent } from '../common/profile-edit-dialog/profile-edit-dialog.component'
+import { SwitchComponent } from '../common/input/switch/switch.component'
 import { DocumentDetailComponent } from '../document-detail/document-detail.component'
 import { ComponentWithPermissions } from '../with-permissions/with-permissions.component'
 import { GlobalSearchComponent } from './global-search/global-search.component'
@@ -76,6 +82,8 @@ const SCROLL_THRESHOLD = 16
     NgxBootstrapIconsModule,
     DragDropModule,
     TourNgBootstrap,
+    FormsModule,
+    SwitchComponent,
   ],
 })
 export class AppFrameComponent
@@ -98,6 +106,7 @@ export class AppFrameComponent
   readonly isMenuCollapsed = signal(true)
   readonly slimSidebarAnimating = signal(false)
   readonly mobileSearchHidden = signal(false)
+  readonly HideableSidebarItemID = HideableSidebarItemID
   private readonly versionSetting = this.settingsService.getSignal<string>(
     SETTINGS_KEYS.VERSION
   )
@@ -195,6 +204,10 @@ export class AppFrameComponent
     }, 200) // slightly longer than css animation for slim sidebar
   }
 
+  toggleSidebarItem(item: HideableSidebarItemID, visible: boolean): void {
+    this.settingsService.updateSidebarItemVisibility(item, visible)
+  }
+
   toggleAttributesSections(event?: Event): void {
     event?.preventDefault()
     event?.stopPropagation()

src-ui/src/app/components/common/input/switch/switch.component.html

@@ -1,6 +1,6 @@
-<div class="mb-3">
-  <div class="row">
-    @if (!horizontal) {
+<div [class.mb-3]="!compact">
+  <div [class.row]="!compact">
+    @if (!horizontal && !compact) {
       <div class="d-flex align-items-center position-relative hidden-button-container col-md-3">
         <label class="form-label" [for]="inputId" [ngbTooltip]="showUnsetNote && isUnset ? tipContent: null" placement="end">
           {{title}}
@@ -17,8 +17,8 @@
     }
     <div [ngClass]="{'align-items-center': horizontal, 'd-flex': horizontal}">
       <div class="form-check form-switch">
-        <input #inputField type="checkbox" class="form-check-input" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" (blur)="onTouched()" [disabled]="disabled">
-        @if (horizontal) {
+        <input #inputField type="checkbox" class="form-check-input" [id]="inputId" [(ngModel)]="value" [ngModelOptions]="{standalone: true}" (change)="onChange(value)" (blur)="onTouched()" [disabled]="disabled" [attr.aria-label]="compact ? title : null">
+        @if (horizontal && !compact) {
           <label class="form-check-label" [class.text-muted]="showUnsetNote && isUnset" [for]="inputId" [ngbTooltip]="showUnsetNote && isUnset ? tipContent: null" placement="end">
             {{title}}
             @if (showUnsetNote && isUnset) {

src-ui/src/app/components/common/input/switch/switch.component.spec.ts

@@ -48,4 +48,14 @@ describe('SwitchComponent', () => {
     component.value = undefined
     expect(component.isUnset).toBeTruthy()
   })
+
+  it('should support a compact layout', () => {
+    component.compact = true
+    component.title = 'Test switch'
+    fixture.detectChanges()
+
+    expect(fixture.nativeElement.querySelector('.mb-3')).toBeNull()
+    expect(fixture.nativeElement.querySelector('.row')).toBeNull()
+    expect(input.getAttribute('aria-label')).toEqual('Test switch')
+  })
 })

src-ui/src/app/components/common/input/switch/switch.component.ts

@@ -25,6 +25,9 @@ export class SwitchComponent extends AbstractInputComponent<boolean> {
   @Input()
   showUnsetNote: boolean = false
 
+  @Input()
+  compact: boolean = false
+
   constructor() {
     super()
   }

src-ui/src/app/data/ui-settings.ts

@@ -24,6 +24,16 @@ export enum CollapsibleSection {
   ATTRIBUTES = 'attributes',
 }
 
+export enum HideableSidebarItemID {
+  Dashboard = 'dashboard',
+  SavedViews = 'saved_views',
+  Workflows = 'workflows',
+  Mail = 'mail',
+  Documentation = 'documentation',
+}
+
+export const HIDEABLE_SIDEBAR_ITEM_IDS = Object.values(HideableSidebarItemID)
+
 export const PAPERLESS_GREEN_HEX = '#17541f'
 
 export const SETTINGS_KEYS = {
@@ -56,6 +66,7 @@ export const SETTINGS_KEYS = {
   NOTES_ENABLED: 'general-settings:notes-enabled',
   AUDITLOG_ENABLED: 'general-settings:auditlog-enabled',
   SLIM_SIDEBAR: 'general-settings:slim-sidebar',
+  SIDEBAR_HIDDEN_ITEMS: 'general-settings:sidebar:hidden-items',
   ATTRIBUTES_SECTIONS_COLLAPSED:
     'general-settings:attributes-sections-collapsed',
   UPDATE_CHECKING_ENABLED: 'general-settings:update-checking:enabled',
@@ -127,6 +138,11 @@ export const SETTINGS: UiSetting[] = [
     type: 'boolean',
     default: false,
   },
+  {
+    key: SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS,
+    type: 'array',
+    default: [],
+  },
   {
     key: SETTINGS_KEYS.ATTRIBUTES_SECTIONS_COLLAPSED,
     type: 'array',

src-ui/src/app/services/settings.service.spec.ts

@@ -14,7 +14,11 @@ import { CustomFieldDataType } from '../data/custom-field'
 import { DEFAULT_DISPLAY_FIELDS, DisplayField } from '../data/document'
 import { SavedView } from '../data/saved-view'
 import { RemoteOCRModeConfig } from '../data/paperless-config'
-import { SETTINGS_KEYS, UiSettings } from '../data/ui-settings'
+import {
+  HideableSidebarItemID,
+  SETTINGS_KEYS,
+  UiSettings,
+} from '../data/ui-settings'
 import { PermissionsService } from './permissions.service'
 import { CustomFieldsService } from './rest/custom-fields.service'
 import { SettingsService } from './settings.service'
@@ -230,6 +234,35 @@ describe('SettingsService', () => {
     expect(notesEnabled()).toBeFalsy()
   })
 
+  it('updates sidebar item visibility', () => {
+    httpTestingController
+      .expectOne(`${environment.apiBaseUrl}ui_settings/`)
+      .flush(ui_settings)
+
+    expect(
+      settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+    ).toBe(false)
+
+    settingsService.updateSidebarItemVisibility(
+      HideableSidebarItemID.Workflows,
+      false
+    )
+
+    expect(
+      settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+    ).toBe(true)
+    expect(settingsService.get(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS)).toEqual([])
+
+    settingsService.updateSidebarItemVisibility(
+      HideableSidebarItemID.Workflows,
+      true
+    )
+
+    expect(
+      settingsService.sidebarItemIsHidden(HideableSidebarItemID.Workflows)
+    ).toBe(false)
+  })
+
   it('updates setting signals when settings are reinitialized', () => {
     let req = httpTestingController.expectOne(
       `${environment.apiBaseUrl}ui_settings/`

src-ui/src/app/services/settings.service.ts

@@ -24,6 +24,7 @@ import { DEFAULT_DISPLAY_FIELDS, DisplayField } from '../data/document'
 import { RemoteOCRModeConfig } from '../data/paperless-config'
 import { SavedView } from '../data/saved-view'
 import {
+  HideableSidebarItemID,
   PAPERLESS_GREEN_HEX,
   SETTINGS,
   SETTINGS_KEYS,
@@ -313,6 +314,18 @@ export class SettingsService {
   readonly globalDropzoneEnabled = signal(true)
   readonly globalDropzoneActive = signal(false)
   readonly organizingSidebarSavedViews = signal(false)
+  readonly sidebarHiddenItemsEditing = signal<HideableSidebarItemID[] | null>(
+    null
+  )
+  readonly organizingSidebarItems = computed(
+    () => this.sidebarHiddenItemsEditing() !== null
+  )
+  readonly sidebarHiddenItemsEditingChanged = new EventEmitter<
+    HideableSidebarItemID[]
+  >()
+  readonly hiddenSidebarItems = this.getSignal<HideableSidebarItemID[]>(
+    SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS
+  )
 
   readonly allDisplayFields = signal<Array<{ id: DisplayField; name: string }>>(
     DEFAULT_DISPLAY_FIELDS
@@ -749,6 +762,29 @@ export class SettingsService {
     return this.storeSettings()
   }
 
+  sidebarItemIsHidden(item: HideableSidebarItemID): boolean {
+    return (
+      this.sidebarHiddenItemsEditing() ?? this.hiddenSidebarItems()
+    ).includes(item)
+  }
+
+  updateSidebarItemVisibility(
+    item: HideableSidebarItemID,
+    visible: boolean
+  ): void {
+    const hiddenItems = new Set(
+      this.sidebarHiddenItemsEditing() ?? this.hiddenSidebarItems()
+    )
+    if (visible) {
+      hiddenItems.delete(item)
+    } else {
+      hiddenItems.add(item)
+    }
+    const updatedHiddenItems = [...hiddenItems]
+    this.sidebarHiddenItemsEditing.set(updatedHiddenItems)
+    this.sidebarHiddenItemsEditingChanged.emit(updatedHiddenItems)
+  }
+
   updateSavedViewsVisibility(
     dashboardVisibleViewIds: number[],
     sidebarVisibleViewIds: number[]

src/documents/management/commands/document_consumer.py

@@ -72,24 +72,6 @@ class TrackedFile:
             return False
 
 
-@dataclass(frozen=True, slots=True)
-class QueuedFile:
-    """A file handed to Celery, with enough state to decide when it's safe to re-check."""
-
-    task_id: str
-    size: int
-    mtime: float
-
-    @classmethod
-    def from_path(cls, task_id: str, path: Path) -> QueuedFile | None:
-        """Snapshot the file's size and mtime, or None if it cannot be stat'd."""
-        try:
-            stat = path.stat()
-        except OSError:
-            return None
-        return cls(task_id, stat.st_size, stat.st_mtime)
-
-
 class FileStabilityTracker:
     """
     Tracks file events and determines when files are stable for consumption.
@@ -332,7 +314,7 @@ def _consume_file(
     consumption_dir: Path,
     *,
     subdirs_as_tags: bool,
-) -> str | None:
+) -> bool:
     """
     Queue a file for consumption.
 
@@ -342,18 +324,18 @@ def _consume_file(
         subdirs_as_tags: Whether to create tags from subdirectory names.
 
     Returns:
-        The Celery task id if the file was successfully handed to Celery,
-        None otherwise. Callers must not record the file as queued on
-        failure, or the rescan will never retry it.
+        True if the file was successfully handed to Celery, False otherwise.
+        Callers must not record the file as queued on failure, or the rescan
+        will never retry it.
     """
     # Verify file still exists and is accessible
     try:
         if not filepath.is_file():
             logger.debug(f"Not consuming {filepath}: not a file or doesn't exist")
-            return None
+            return False
     except OSError as e:
         logger.warning(f"Not consuming {filepath}: {e}")
-        return None
+        return False
 
     # Get tags from path if configured
     tag_ids: list[int] | None = None
@@ -366,7 +348,7 @@ def _consume_file(
     # Queue for consumption
     try:
         logger.info(f"Adding {filepath} to the task queue")
-        result = consume_file.apply_async(
+        consume_file.apply_async(
             kwargs={
                 "input_doc": ConsumableDocument(
                     source=DocumentSource.ConsumeFolder,
@@ -378,9 +360,9 @@ def _consume_file(
         )
     except Exception:
         logger.exception(f"Error while queuing document {filepath}")
-        return None
+        return False
 
-    return result.id
+    return True
 
 
 class Command(BaseCommand):
@@ -497,19 +479,18 @@ class Command(BaseCommand):
         recursive: bool,
         subdirs_as_tags: bool,
         consumer_filter: ConsumerFilter,
-    ) -> dict[Path, QueuedFile]:
+    ) -> set[Path]:
         """
         Process any existing files in the consumption directory.
 
-        Returns a dict mapping each resolved path that was queued to its
-        QueuedFile state, so the watch loop can seed its in-flight dict and
-        avoid re-queuing them on the first rescan before the consume tasks
-        have removed them from disk.
+        Returns the set of resolved paths that were queued, so the watch loop
+        can seed its in-flight set and avoid re-queuing them on the first
+        rescan before the consume tasks have removed them from disk.
         """
         logger.info(f"Processing existing files in {directory}")
 
         glob_pattern = "**/*" if recursive else "*"
-        queued: dict[Path, QueuedFile] = {}
+        queued: set[Path] = set()
 
         for filepath in directory.glob(glob_pattern):
             # Use filter to check if file should be processed
@@ -519,17 +500,12 @@ class Command(BaseCommand):
             if not consumer_filter(Change.added, str(filepath)):
                 continue
 
-            task_id = _consume_file(
+            if _consume_file(
                 filepath=filepath,
                 consumption_dir=directory,
                 subdirs_as_tags=subdirs_as_tags,
-            )
-            if task_id is None:
-                continue
-
-            entry = QueuedFile.from_path(task_id, filepath)
-            if entry is not None:
-                queued[filepath.resolve()] = entry
+            ):
+                queued.add(filepath.resolve())
 
         return queued
 
@@ -540,43 +516,21 @@ class Command(BaseCommand):
         recursive: bool,
         consumer_filter: ConsumerFilter,
         tracker: FileStabilityTracker,
-        queued: dict[Path, QueuedFile],
+        queued: set[Path],
     ) -> None:
         """
         Re-inject on-disk files the watcher never reported into the tracker.
 
         Acts as a safety net for files stranded by the watcher-recreation gap
-        (see ``rescan_interval_s``). Files already being tracked, or already
-        queued and still in flight (or completed but with unchanged content),
-        are skipped, so a file is never queued twice and a permanently broken
-        file does not retry forever. Queued paths that have since left the
-        directory are pruned so a later file reusing the same name is not
-        skipped forever.
+        (see ``rescan_interval_s``). Files already being tracked or already
+        queued and awaiting consumption are skipped, so a file is never queued
+        twice. Queued paths that have since left the directory are pruned so a
+        later file reusing the same name is not skipped forever.
         """
-        # Long-running process: drop stale DB connections before querying (#4265)
-        db.close_old_connections()
-
-        # Vanished from disk: consumed (or otherwise removed), prune regardless of status
-        for path in [path for path in queued if not path.exists()]:
-            del queued[path]
-
-        if queued:
-            tasks = PaperlessTask.objects.only("task_id", "status").in_bulk(
-                [entry.task_id for entry in queued.values()],
-                field_name="task_id",
-            )
-            for path, entry in list(queued.items()):
-                task = tasks.get(entry.task_id)
-                # No row yet means the task has not started: treat as in flight
-                if task is None or task.status not in PaperlessTask.COMPLETE_STATUSES:
-                    continue
-                try:
-                    current = path.stat()
-                except OSError:
-                    continue
-                # Completed and the content changed: a new file, allow a retry
-                if current.st_size != entry.size or current.st_mtime != entry.mtime:
-                    del queued[path]
+        # Prune in-flight paths that have left the directory
+        for path in list(queued):
+            if not path.exists():
+                queued.discard(path)
 
         glob_pattern = "**/*" if recursive else "*"
 
@@ -604,7 +558,7 @@ class Command(BaseCommand):
         polling_interval: float,
         stability_delay: float,
         is_testing: bool,
-        queued: dict[Path, QueuedFile] | None = None,
+        queued: set[Path] | None = None,
     ) -> None:
         """Watch directory for changes and process stable files."""
         use_polling = polling_interval > 0
@@ -613,7 +567,7 @@ class Command(BaseCommand):
         # Resolved paths that have been queued and are awaiting consumption.
         # Seeded from the startup scan so the first rescan does not re-queue
         # files whose consume tasks have not yet removed them from disk.
-        queued = {} if queued is None else queued
+        queued = set() if queued is None else queued
 
         # Full-glob safety net cadence (0 disables)
         rescan_interval_s = self.rescan_interval_s
@@ -690,7 +644,7 @@ class Command(BaseCommand):
                             # Consumed (or otherwise removed); a later file
                             # reusing this name must not be skipped as
                             # already-queued.
-                            queued.pop(path, None)
+                            queued.discard(path)
                         if not path.is_file():
                             continue
                         if path in queued:
@@ -709,17 +663,12 @@ class Command(BaseCommand):
                         # rescan does not re-queue them while the consume task
                         # has yet to remove them from disk, but does retry a
                         # failed publish instead of stranding it
-                        task_id = _consume_file(
+                        if _consume_file(
                             filepath=stable_path,
                             consumption_dir=directory,
                             subdirs_as_tags=subdirs_as_tags,
-                        )
-                        if task_id is None:
-                            continue
-
-                        entry = QueuedFile.from_path(task_id, stable_path)
-                        if entry is not None:
-                            queued[stable_path] = entry
+                        ):
+                            queued.add(stable_path)
 
                     # Exit watch loop to reconfigure timeout
                     break
@@ -728,16 +677,13 @@ class Command(BaseCommand):
                 if rescan_timeout_ms > 0 and (
                     monotonic() - last_rescan >= rescan_interval_s
                 ):
-                    try:
-                        self._rescan_existing_files(
-                            directory=directory,
-                            recursive=recursive,
-                            consumer_filter=consumer_filter,
-                            tracker=tracker,
-                            queued=queued,
-                        )
-                    except Exception:
-                        logger.exception("Error during consume folder rescan")
+                    self._rescan_existing_files(
+                        directory=directory,
+                        recursive=recursive,
+                        consumer_filter=consumer_filter,
+                        tracker=tracker,
+                        queued=queued,
+                    )
                     last_rescan = monotonic()
 
                 # Determine next timeout

src/documents/tests/test_document_consumer_stuck_queue.py

@@ -1,165 +0,0 @@
-"""
-Regression test for GH discussion #13969.
-
-A consume-folder file that fails (e.g. a scanner's 0-byte placeholder
-hitting "Unsupported mime type inode/x-empty") must be re-detected once
-its content changes, not permanently stranded in the watcher's queued
-set. See docs/superpowers/specs/2026-09-08-consume-folder-stuck-queue-spec.md.
-"""
-
-from __future__ import annotations
-
-import shutil
-from time import monotonic
-from time import sleep
-from typing import TYPE_CHECKING
-
-import pytest
-
-from documents.management.commands.document_consumer import Command
-from documents.models import PaperlessTask
-from documents.tests.test_management_consumer import consumption_dir  # noqa: F401
-from documents.tests.test_management_consumer import (
-    mock_consume_file_delay,  # noqa: F401
-)
-from documents.tests.test_management_consumer import (
-    mock_supported_extensions,  # noqa: F401
-)
-from documents.tests.test_management_consumer import sample_pdf  # noqa: F401
-from documents.tests.test_management_consumer import scratch_dir  # noqa: F401
-from documents.tests.test_management_consumer import start_consumer  # noqa: F401
-from documents.tests.test_management_consumer import wait_for_mock_call
-
-if TYPE_CHECKING:
-    from collections.abc import Callable
-    from pathlib import Path
-    from unittest.mock import MagicMock
-
-    from pytest_mock import MockerFixture
-
-    from documents.tests.test_management_consumer import ConsumerThread
-
-
-@pytest.mark.management
-# transaction=True: the background consumer thread needs to see rows
-# committed by this test.
-@pytest.mark.django_db(transaction=True)
-class TestStuckQueueAfterConsumptionFailure:
-    def test_scanner_placeholder_recovers_after_failure(
-        self,
-        consumption_dir: Path,  # noqa: F811
-        sample_pdf: Path,  # noqa: F811
-        mock_consume_file_delay: MagicMock,  # noqa: F811
-        start_consumer: Callable[..., ConsumerThread],  # noqa: F811
-    ) -> None:
-        """
-        Reproduces discussion #13969: a scanner creates a 0-byte file,
-        consumption fails on it, then the scanner writes real content —
-        the watcher must pick it up on the next rescan instead of
-        ignoring it forever.
-        """
-        apply_async = mock_consume_file_delay.apply_async
-        apply_async.return_value.id = "scan-task-1"
-
-        thread = start_consumer(
-            stability_delay=0.1,
-            rescan_interval=0.3,
-        )
-
-        target = consumption_dir / "scan.pdf"
-        target.write_bytes(b"")  # scanner's 0-byte placeholder
-
-        assert wait_for_mock_call(apply_async, timeout_s=5.0)
-        if thread.exception:
-            raise thread.exception
-        assert apply_async.call_count == 1
-
-        # The Celery task fails on inode/x-empty, exactly as consumer.py's
-        # mime-type check would in production. Create a real PaperlessTask row
-        # with FAILURE status to simulate the task's result when the real
-        # consumer.py rescan queries for it. This exercises the actual
-        # batched query path: PaperlessTask.objects.filter(task_id__in=[...]).
-        # values_list("task_id", "status")
-        PaperlessTask.objects.create(
-            task_id="scan-task-1",
-            task_type=PaperlessTask.TaskType.CONSUME_FILE,
-            status=PaperlessTask.Status.FAILURE,
-        )
-
-        # Scanner finishes writing the real scan.
-        shutil.copy(sample_pdf, target)
-
-        # Needs to clear: rescan_interval (0.3s, until the entry is
-        # released) + a fresh stability_delay (0.1s, before _consume_file
-        # is called again) + polling slop + test margin.
-        deadline = monotonic() + 8.0
-        while apply_async.call_count < 2 and monotonic() < deadline:
-            sleep(0.1)
-
-        if thread.exception:
-            raise thread.exception
-
-        assert apply_async.call_count == 2, (
-            "Expected the file to be re-consumed after the scanner wrote "
-            f"real content, but apply_async was called "
-            f"{apply_async.call_count} time(s)"
-        )
-
-
-@pytest.mark.management
-@pytest.mark.django_db(transaction=True)
-class TestRescanErrorHandling:
-    def test_rescan_exception_does_not_break_the_watch_loop(
-        self,
-        consumption_dir: Path,  # noqa: F811
-        mock_consume_file_delay: MagicMock,  # noqa: F811
-        start_consumer: Callable[..., ConsumerThread],  # noqa: F811
-        mocker: MockerFixture,
-    ) -> None:
-        """
-        A rescan that raises must not kill the watcher, and must not
-        cause the loop to busy-retry the database on every wake. The
-        watch loop updates ``last_rescan`` even when the rescan raises,
-        so a broken rescan still waits a full ``rescan_interval_s``
-        between attempts instead of spinning.
-
-        A file kept perpetually "pending" (rewritten faster than
-        ``stability_delay``) forces the watch loop to wake more often
-        than ``rescan_interval_s``, which is what surfaces the busy-retry
-        regression: with the broken shape, every one of those frequent
-        wakes re-attempts the rescan instead of only every
-        ``rescan_interval_s``.
-        """
-        rescan = mocker.patch.object(
-            Command,
-            "_rescan_existing_files",
-            side_effect=Exception("db down"),
-        )
-
-        thread = start_consumer(
-            stability_delay=0.02,
-            rescan_interval=0.5,
-        )
-
-        # Keep a file perpetually unstable so the watch loop's timeout is
-        # floored at stability_delay (0.02s) rather than rescan_interval_s
-        # (0.5s). Otherwise the loop only wakes every 0.5s regardless of
-        # the rescan bug, and the two shapes would be indistinguishable.
-        target = consumption_dir / "busy.pdf"
-        deadline = monotonic() + 2.0
-        counter = 0
-        while monotonic() < deadline:
-            counter += 1
-            target.write_bytes(f"%PDF-1.4\n{counter}\n".encode())
-            sleep(0.01)
-
-        assert thread.is_alive()
-        if thread.exception:
-            raise thread.exception
-
-        assert rescan.called
-        assert rescan.call_count < 15, (
-            "Expected the rescan to be retried roughly once per "
-            "rescan_interval_s, but it was called "
-            f"{rescan.call_count} time(s), suggesting a busy-loop"
-        )

src/documents/tests/test_management_consumer.py

@@ -33,11 +33,9 @@ from documents.data_models import DocumentSource
 from documents.management.commands.document_consumer import Command
 from documents.management.commands.document_consumer import ConsumerFilter
 from documents.management.commands.document_consumer import FileStabilityTracker
-from documents.management.commands.document_consumer import QueuedFile
 from documents.management.commands.document_consumer import TrackedFile
 from documents.management.commands.document_consumer import _consume_file
 from documents.management.commands.document_consumer import _tags_from_path
-from documents.models import PaperlessTask
 from documents.models import Tag
 
 if TYPE_CHECKING:
@@ -447,14 +445,13 @@ class TestConsumeFile:
         target = consumption_dir / "document.pdf"
         shutil.copy(sample_pdf, target)
 
-        mock_consume_file_delay.apply_async.return_value.id = "abc123"
         result = _consume_file(
             filepath=target,
             consumption_dir=consumption_dir,
             subdirs_as_tags=False,
         )
 
-        assert result == mock_consume_file_delay.apply_async.return_value.id
+        assert result is True
         mock_consume_file_delay.apply_async.assert_called_once()
         call_args = mock_consume_file_delay.apply_async.call_args
         consumable_doc = call_args.kwargs["kwargs"]["input_doc"]
@@ -473,7 +470,7 @@ class TestConsumeFile:
             consumption_dir=consumption_dir,
             subdirs_as_tags=False,
         )
-        assert result is None
+        assert result is False
         mock_consume_file_delay.apply_async.assert_not_called()
 
     def test_consume_directory(
@@ -490,7 +487,7 @@ class TestConsumeFile:
             consumption_dir=consumption_dir,
             subdirs_as_tags=False,
         )
-        assert result is None
+        assert result is False
         mock_consume_file_delay.apply_async.assert_not_called()
 
     def test_consume_with_permission_error(
@@ -510,7 +507,7 @@ class TestConsumeFile:
             consumption_dir=consumption_dir,
             subdirs_as_tags=False,
         )
-        assert result is None
+        assert result is False
         mock_consume_file_delay.apply_async.assert_not_called()
 
     def test_consume_with_apply_async_failure(
@@ -530,7 +527,7 @@ class TestConsumeFile:
             consumption_dir=consumption_dir,
             subdirs_as_tags=False,
         )
-        assert result is None
+        assert result is False
 
     def test_consume_with_tags_error(
         self,
@@ -548,13 +545,12 @@ class TestConsumeFile:
             side_effect=DatabaseError("Something happened"),
         )
 
-        mock_consume_file_delay.apply_async.return_value.id = "abc123"
         result = _consume_file(
             filepath=target,
             consumption_dir=consumption_dir,
             subdirs_as_tags=True,
         )
-        assert result == "abc123"
+        assert result is True
         mock_consume_file_delay.apply_async.assert_called_once()
         call_args = mock_consume_file_delay.apply_async.call_args
         overrides = call_args.kwargs["kwargs"]["overrides"]
@@ -1120,7 +1116,6 @@ class TestCommandWatchEdgeCases:
             Tag.objects.all().delete()
 
 
-@pytest.mark.django_db
 class TestRescanExistingFiles:
     """
     Unit tests for the rescan safety net.
@@ -1139,23 +1134,12 @@ class TestRescanExistingFiles:
             ignore_patterns=[],
         )
 
-    def _queued_as_is(self, target: Path, task_id: str) -> dict[Path, QueuedFile]:
-        """A queued entry whose snapshot matches the file's current content."""
-        stat = target.stat()
-        return {
-            target.resolve(): QueuedFile(
-                task_id=task_id,
-                size=stat.st_size,
-                mtime=stat.st_mtime,
-            ),
-        }
-
     def _rescan(
         self,
         directory: Path,
         consumer_filter: ConsumerFilter,
         tracker: FileStabilityTracker,
-        queued: dict[Path, QueuedFile],
+        queued: set[Path],
         *,
         recursive: bool = False,
     ) -> None:
@@ -1178,7 +1162,7 @@ class TestRescanExistingFiles:
         shutil.copy(sample_pdf, target)
         tracker = FileStabilityTracker(stability_delay=0.1)
 
-        self._rescan(consumption_dir, pdf_only_filter, tracker, {})
+        self._rescan(consumption_dir, pdf_only_filter, tracker, set())
 
         assert tracker.is_tracking(target) is True
         assert tracker.pending_count == 1
@@ -1195,7 +1179,7 @@ class TestRescanExistingFiles:
         tracker = FileStabilityTracker(stability_delay=0.1)
         tracker.track(target, Change.added)
 
-        self._rescan(consumption_dir, pdf_only_filter, tracker, {})
+        self._rescan(consumption_dir, pdf_only_filter, tracker, set())
 
         assert tracker.pending_count == 1
 
@@ -1209,17 +1193,11 @@ class TestRescanExistingFiles:
         target = consumption_dir / "inflight.pdf"
         shutil.copy(sample_pdf, target)
         tracker = FileStabilityTracker(stability_delay=0.1)
-        PaperlessTask.objects.create(
-            task_id="task-inflight",
-            task_type=PaperlessTask.TaskType.CONSUME_FILE,
-            status=PaperlessTask.Status.STARTED,
-        )
-        queued = self._queued_as_is(target, "task-inflight")
+        queued = {target.resolve()}
 
         self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
 
         assert tracker.pending_count == 0
-        assert target.resolve() in queued
 
     def test_prunes_vanished_queued_paths(
         self,
@@ -1229,7 +1207,7 @@ class TestRescanExistingFiles:
         """Queued paths no longer on disk are dropped so the name can recur."""
         gone = (consumption_dir / "gone.pdf").resolve()
         tracker = FileStabilityTracker(stability_delay=0.1)
-        queued = {gone: QueuedFile(task_id="task-gone", size=0, mtime=0.0)}
+        queued = {gone}
 
         self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
 
@@ -1244,7 +1222,7 @@ class TestRescanExistingFiles:
         (consumption_dir / "notes.xyz").write_bytes(b"content")
         tracker = FileStabilityTracker(stability_delay=0.1)
 
-        self._rescan(consumption_dir, pdf_only_filter, tracker, {})
+        self._rescan(consumption_dir, pdf_only_filter, tracker, set())
 
         assert tracker.pending_count == 0
 
@@ -1261,151 +1239,13 @@ class TestRescanExistingFiles:
         shutil.copy(sample_pdf, target)
 
         shallow = FileStabilityTracker(stability_delay=0.1)
-        self._rescan(consumption_dir, pdf_only_filter, shallow, {})
+        self._rescan(consumption_dir, pdf_only_filter, shallow, set())
         assert shallow.pending_count == 0
 
         deep = FileStabilityTracker(stability_delay=0.1)
-        self._rescan(consumption_dir, pdf_only_filter, deep, {}, recursive=True)
+        self._rescan(consumption_dir, pdf_only_filter, deep, set(), recursive=True)
         assert deep.is_tracking(target) is True
 
-    def test_completed_but_content_unchanged_stays_queued(
-        self,
-        consumption_dir: Path,
-        sample_pdf: Path,
-        pdf_only_filter: ConsumerFilter,
-    ) -> None:
-        """
-        A task that failed (or succeeded) but whose file content never
-        changed since being queued stays put — this is what makes a
-        permanently-broken file (e.g. a corrupt PDF) fail once instead of
-        retrying forever (C2).
-        """
-        target = consumption_dir / "broken.pdf"
-        shutil.copy(sample_pdf, target)
-        tracker = FileStabilityTracker(stability_delay=0.1)
-        PaperlessTask.objects.create(
-            task_id="task-failed-unchanged",
-            task_type=PaperlessTask.TaskType.CONSUME_FILE,
-            status=PaperlessTask.Status.FAILURE,
-        )
-        queued = self._queued_as_is(target, "task-failed-unchanged")
-
-        self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
-
-        assert target.resolve() in queued
-        assert tracker.pending_count == 0
-
-    def test_completed_and_content_changed_is_released(
-        self,
-        consumption_dir: Path,
-        sample_pdf: Path,
-        pdf_only_filter: ConsumerFilter,
-    ) -> None:
-        """
-        A task that completed AND whose file content has since changed is
-        released and re-tracked — this is the discussion #13969 fix: the
-        scanner's 0-byte file failed, then real content arrived.
-        """
-        target = consumption_dir / "scanned.pdf"
-        target.write_bytes(b"")  # simulate the 0-byte placeholder that was queued
-        tracker = FileStabilityTracker(stability_delay=0.1)
-        PaperlessTask.objects.create(
-            task_id="task-failed-changed",
-            task_type=PaperlessTask.TaskType.CONSUME_FILE,
-            status=PaperlessTask.Status.FAILURE,
-        )
-        queued = {
-            target.resolve(): QueuedFile(
-                task_id="task-failed-changed",
-                size=0,
-                mtime=0.0,
-            ),
-        }
-        shutil.copy(sample_pdf, target)  # scanner writes real content
-
-        self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
-
-        assert target.resolve() not in queued
-        assert tracker.is_tracking(target.resolve()) is True
-
-    def test_no_paperlesstask_row_stays_queued(
-        self,
-        consumption_dir: Path,
-        sample_pdf: Path,
-        pdf_only_filter: ConsumerFilter,
-    ) -> None:
-        """No matching PaperlessTask row is treated as still in flight, not released."""
-        target = consumption_dir / "no_row.pdf"
-        shutil.copy(sample_pdf, target)
-        tracker = FileStabilityTracker(stability_delay=0.1)
-        queued = self._queued_as_is(target, "task-does-not-exist")
-
-        self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
-
-        assert target.resolve() in queued
-
-    def test_revoked_status_is_treated_as_complete(
-        self,
-        consumption_dir: Path,
-        sample_pdf: Path,
-        pdf_only_filter: ConsumerFilter,
-    ) -> None:
-        """
-        The release guard checks membership in COMPLETE_STATUSES (SUCCESS,
-        FAILURE, REVOKED), not just FAILURE. A cancelled/revoked task (e.g.
-        after a worker restart discards a stale queue entry) whose content
-        has since changed must also be released, not stuck treating REVOKED
-        as still in-flight.
-        """
-        target = consumption_dir / "revoked.pdf"
-        target.write_bytes(b"")
-        tracker = FileStabilityTracker(stability_delay=0.1)
-        PaperlessTask.objects.create(
-            task_id="task-revoked",
-            task_type=PaperlessTask.TaskType.CONSUME_FILE,
-            status=PaperlessTask.Status.REVOKED,
-        )
-        queued = {
-            target.resolve(): QueuedFile(task_id="task-revoked", size=0, mtime=0.0),
-        }
-        shutil.copy(sample_pdf, target)
-
-        self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
-
-        assert target.resolve() not in queued
-        assert tracker.is_tracking(target.resolve()) is True
-
-    def test_rescan_issues_one_batched_query_for_multiple_queued_files(
-        self,
-        consumption_dir: Path,
-        sample_pdf: Path,
-        pdf_only_filter: ConsumerFilter,
-        django_assert_num_queries,
-    ) -> None:
-        """
-        The status lookup for every queued file must be a single batched
-        `task_id__in=[...]` query, not one query per file — otherwise a
-        consume folder with many in-flight files turns every rescan into
-        an N+1.
-        """
-        tracker = FileStabilityTracker(stability_delay=0.1)
-        queued: dict[Path, QueuedFile] = {}
-        for i in range(3):
-            target = consumption_dir / f"doc{i}.pdf"
-            shutil.copy(sample_pdf, target)
-            task_id = f"task-batched-{i}"
-            PaperlessTask.objects.create(
-                task_id=task_id,
-                task_type=PaperlessTask.TaskType.CONSUME_FILE,
-                status=PaperlessTask.Status.STARTED,
-            )
-            queued.update(self._queued_as_is(target, task_id))
-
-        with django_assert_num_queries(1):
-            self._rescan(consumption_dir, pdf_only_filter, tracker, queued)
-
-        assert len(queued) == 3
-
 
 class TestProcessExistingFilesQueued:
     """Tests that startup processing reports which paths it queued."""
@@ -1418,8 +1258,7 @@ class TestProcessExistingFilesQueued:
         mock_consume_file_delay: MagicMock,
         settings: Settings,
     ) -> None:
-        """The dict returned seeds the rescan's queued dict, avoiding re-queue."""
-        mock_consume_file_delay.apply_async.return_value.id = "startup-task-id"
+        """The set returned seeds the rescan's queued set, avoiding re-queue."""
         target = consumption_dir / "document.pdf"
         shutil.copy(sample_pdf, target)
         settings.CONSUMER_IGNORE_PATTERNS = []
@@ -1432,9 +1271,6 @@ class TestProcessExistingFilesQueued:
         )
 
         assert target.resolve() in queued
-        entry = queued[target.resolve()]
-        assert entry.task_id == "startup-task-id"
-        assert entry.size == target.stat().st_size
 
 
 @pytest.mark.management
@@ -1459,13 +1295,11 @@ class TestCommandRetryAfterQueueFailure:
         """A publish failure from the watch loop is retried by the rescan."""
         apply_async = mock_consume_file_delay.apply_async
 
-        def fail_first_call(*args: object, **kwargs: object) -> MagicMock | None:
+        def fail_first_call(*args: object, **kwargs: object) -> None:
             if apply_async.call_count == 1:
                 raise Exception("broker down")
-            return apply_async.return_value
 
         apply_async.side_effect = fail_first_call
-        apply_async.return_value.id = "task_id_test"
 
         thread = start_consumer(stability_delay=0.1, rescan_interval=0.3)