From 9e2430da46003edcc6d8627463b854560c5f8c4c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 30 Sep 2022 12:30:23 -0700 Subject: [PATCH 1/5] Frontend update checking settings --- .../app-frame/app-frame.component.html | 21 ++++-- .../app-frame/app-frame.component.ts | 39 +++++++++-- .../filterable-dropdown.component.scss | 19 ----- .../manage/settings/settings.component.html | 15 ++++ .../manage/settings/settings.component.ts | 28 +++++++- src-ui/src/app/data/paperless-uisettings.ts | 13 ++++ .../services/rest/remote-version.service.ts | 1 - src-ui/src/app/services/settings.service.ts | 49 +++++++++++-- src-ui/src/styles.scss | 19 +++++ src/documents/views.py | 70 ++++++++++--------- 10 files changed, 200 insertions(+), 74 deletions(-) diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index 5a68a3cda..8f94f80aa 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -200,14 +200,25 @@
  • {{ versionString }}
    -
    +
    Paperless-ngx {{ appRemoteVersion.version }} is available.
    Click to view.         - Checking for updates is disabled.
    Click for more information.     +

    + Paperless-ngx can automatically check for updates +

    +
    + + +
    +

    + + How does this work? + +

    - + @@ -217,8 +228,8 @@ - + diff --git a/src-ui/src/app/components/app-frame/app-frame.component.ts b/src-ui/src/app/components/app-frame/app-frame.component.ts index 6e758d262..fd70de51a 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.ts @@ -24,6 +24,8 @@ import { import { SettingsService } from 'src/app/services/settings.service' import { TasksService } from 'src/app/services/tasks.service' import { ComponentCanDeactivate } from 'src/app/guards/dirty-doc.guard' +import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' +import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-app-frame', @@ -40,13 +42,12 @@ export class AppFrameComponent implements ComponentCanDeactivate { private remoteVersionService: RemoteVersionService, private list: DocumentListViewService, public settingsService: SettingsService, - public tasksService: TasksService + public tasksService: TasksService, + private readonly toastService: ToastService ) { - this.remoteVersionService - .checkForUpdates() - .subscribe((appRemoteVersion: AppRemoteVersion) => { - this.appRemoteVersion = appRemoteVersion - }) + if (settingsService.updateCheckingEnabled) { + this.checkForUpdates() + } tasksService.reload() } @@ -150,4 +151,30 @@ export class AppFrameComponent implements ComponentCanDeactivate { } }) } + + private checkForUpdates() { + this.remoteVersionService + .checkForUpdates() + .subscribe((appRemoteVersion: AppRemoteVersion) => { + this.appRemoteVersion = appRemoteVersion + }) + } + + setUpdateChecking(enable: boolean) { + this.settingsService.set(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, enable) + this.settingsService + .storeSettings() + .pipe(first()) + .subscribe({ + error: (error) => { + this.toastService.showError( + $localize`An error occurred while saving update checking settings.` + ) + console.log(error) + }, + }) + if (enable) { + this.checkForUpdates() + } + } } diff --git a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.scss b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.scss index dfb989fea..b8d114683 100644 --- a/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.scss +++ b/src-ui/src/app/components/common/filterable-dropdown/filterable-dropdown.component.scss @@ -17,25 +17,6 @@ } } -.btn-group-xs { - > .btn { - padding: 0.2rem 0.25rem; - font-size: 0.675rem; - line-height: 1.2; - border-radius: 0.15rem; - } - - > .btn:not(:first-child) { - border-top-left-radius: 0; - border-bottom-left-radius: 0; - } - - > .btn:not(:last-child) { - border-top-right-radius: 0; - border-bottom-right-radius: 0; - } -} - .btn-group > label.disabled { filter: brightness(0.5); diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index f72587139..4990945d4 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -116,6 +116,21 @@
    +

    Update checking

    + +
    +
    +

    + Update checking works by pinging the the public Github API for the latest release to determine whether a new version is available.
    + Actual updating of the app must still be performed manually. +

    +

    + No tracking data is collected by the app in any way. +

    + +
    +
    +

    Bulk editing

    diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index bb7244663..2672efcae 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -4,7 +4,7 @@ import { LOCALE_ID, OnInit, OnDestroy, - Renderer2, + AfterViewInit, } from '@angular/core' import { FormControl, FormGroup } from '@angular/forms' import { PaperlessSavedView } from 'src/app/data/paperless-saved-view' @@ -18,13 +18,17 @@ import { Toast, ToastService } from 'src/app/services/toast.service' import { dirtyCheck, DirtyComponent } from '@ngneat/dirty-check-forms' import { Observable, Subscription, BehaviorSubject, first } from 'rxjs' import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' +import { ActivatedRoute } from '@angular/router' +import { ViewportScroller } from '@angular/common' @Component({ selector: 'app-settings', templateUrl: './settings.component.html', styleUrls: ['./settings.component.scss'], }) -export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { +export class SettingsComponent + implements OnInit, AfterViewInit, OnDestroy, DirtyComponent +{ savedViewGroup = new FormGroup({}) settingsForm = new FormGroup({ @@ -45,6 +49,7 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { notificationsConsumerFailed: new FormControl(null), notificationsConsumerSuppressOnDashboard: new FormControl(null), commentsEnabled: new FormControl(null), + updateCheckingEnabled: new FormControl(null), }) savedViews: PaperlessSavedView[] @@ -74,9 +79,19 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { private documentListViewService: DocumentListViewService, private toastService: ToastService, private settings: SettingsService, - @Inject(LOCALE_ID) public currentLocale: string + @Inject(LOCALE_ID) public currentLocale: string, + private viewportScroller: ViewportScroller, + private activatedRoute: ActivatedRoute ) {} + ngAfterViewInit(): void { + if (this.activatedRoute.snapshot.fragment) { + this.viewportScroller.scrollToAnchor( + this.activatedRoute.snapshot.fragment + ) + } + } + ngOnInit() { this.savedViewService.listAll().subscribe((r) => { this.savedViews = r.results @@ -118,6 +133,9 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD ), commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), + updateCheckingEnabled: this.settings.get( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED + ), } for (let view of this.savedViews) { @@ -240,6 +258,10 @@ export class SettingsComponent implements OnInit, OnDestroy, DirtyComponent { SETTINGS_KEYS.COMMENTS_ENABLED, this.settingsForm.value.commentsEnabled ) + this.settings.set( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, + this.settingsForm.value.updateCheckingEnabled + ) this.settings.setLanguage(this.settingsForm.value.displayLanguage) this.settings .storeSettings() diff --git a/src-ui/src/app/data/paperless-uisettings.ts b/src-ui/src/app/data/paperless-uisettings.ts index e3d977687..b32315e62 100644 --- a/src-ui/src/app/data/paperless-uisettings.ts +++ b/src-ui/src/app/data/paperless-uisettings.ts @@ -37,6 +37,9 @@ export const SETTINGS_KEYS = { NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD: 'general-settings:notifications:consumer-suppress-on-dashboard', COMMENTS_ENABLED: 'general-settings:comments-enabled', + UPDATE_CHECKING_ENABLED: 'general-settings:update-checking:enabled', + UPDATE_CHECKING_BACKEND_SETTING: + 'general-settings:update-checking:backend-setting', } export const SETTINGS: PaperlessUiSetting[] = [ @@ -120,4 +123,14 @@ export const SETTINGS: PaperlessUiSetting[] = [ type: 'boolean', default: true, }, + { + key: SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, + type: 'boolean', + default: false, + }, + { + key: SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING, + type: 'string', + default: '', + }, ] diff --git a/src-ui/src/app/services/rest/remote-version.service.ts b/src-ui/src/app/services/rest/remote-version.service.ts index ab1b5a66b..9b1def363 100644 --- a/src-ui/src/app/services/rest/remote-version.service.ts +++ b/src-ui/src/app/services/rest/remote-version.service.ts @@ -6,7 +6,6 @@ import { environment } from 'src/environments/environment' export interface AppRemoteVersion { version: string update_available: boolean - feature_is_set: boolean } @Injectable({ diff --git a/src-ui/src/app/services/settings.service.ts b/src-ui/src/app/services/settings.service.ts index 14d261789..eee134bef 100644 --- a/src-ui/src/app/services/settings.service.ts +++ b/src-ui/src/app/services/settings.service.ts @@ -313,13 +313,7 @@ export class SettingsService { ) } - get(key: string): any { - let setting = SETTINGS.find((s) => s.key == key) - - if (!setting) { - return null - } - + private getSettingRawValue(key: string): any { let value = null // parse key:key:key into nested object const keys = key.replace('general-settings:', '').split(':') @@ -330,6 +324,17 @@ export class SettingsService { if (index == keys.length - 1) value = settingObj[keyPart] else settingObj = settingObj[keyPart] }) + return value + } + + get(key: string): any { + let setting = SETTINGS.find((s) => s.key == key) + + if (!setting) { + return null + } + + let value = this.getSettingRawValue(key) if (value != null) { switch (setting.type) { @@ -359,6 +364,11 @@ export class SettingsService { }) } + private settingIsSet(key: string): boolean { + let value = this.getSettingRawValue(key) + return value != null + } + storeSettings(): Observable { return this.http.post(this.baseUrl, { settings: this.settings }) } @@ -401,4 +411,29 @@ export class SettingsService { }) } } + + get updateCheckingEnabled(): boolean { + const backendSetting = this.get( + SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING + ) + + if ( + !this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) && + backendSetting != 'default' + ) { + this.set(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, backendSetting === 'true') + } + return ( + this.get(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) || + (!this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) && + backendSetting == 'true') + ) + } + + get updateCheckingIsSet(): boolean { + return ( + this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) || + this.get(SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING) != 'default' + ) + } } diff --git a/src-ui/src/styles.scss b/src-ui/src/styles.scss index 18413276a..d85fb7dc7 100644 --- a/src-ui/src/styles.scss +++ b/src-ui/src/styles.scss @@ -526,6 +526,25 @@ a.badge { border-color: var(--bs-primary); } +.btn-group-xs { + > .btn { + padding: 0.2rem 0.25rem; + font-size: 0.675rem; + line-height: 1.2; + border-radius: 0.15rem; + } + + > .btn:not(:first-child) { + border-top-left-radius: 0; + border-bottom-left-radius: 0; + } + + > .btn:not(:last-child) { + border-top-right-radius: 0; + border-bottom-right-radius: 0; + } +} + code { color: var(--pngx-body-color-accent) } diff --git a/src/documents/views.py b/src/documents/views.py index e301ab5f6..3533b0ef1 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -780,42 +780,38 @@ class RemoteVersionView(GenericAPIView): remote_version = "0.0.0" is_greater_than_current = False current_version = packaging_version.parse(version.__full_version_str__) - # TODO: this can likely be removed when frontend settings are saved to DB - feature_is_set = settings.ENABLE_UPDATE_CHECK != "default" - if feature_is_set and settings.ENABLE_UPDATE_CHECK: - try: - req = urllib.request.Request( - "https://api.github.com/repos/paperless-ngx/" - "paperless-ngx/releases/latest", - ) - # Ensure a JSON response - req.add_header("Accept", "application/json") - - with urllib.request.urlopen(req) as response: - remote = response.read().decode("utf-8") - try: - remote_json = json.loads(remote) - remote_version = remote_json["tag_name"] - # Basically PEP 616 but that only went in 3.9 - if remote_version.startswith("ngx-"): - remote_version = remote_version[len("ngx-") :] - except ValueError: - logger.debug("An error occurred parsing remote version json") - except urllib.error.URLError: - logger.debug("An error occurred checking for available updates") - - is_greater_than_current = ( - packaging_version.parse( - remote_version, - ) - > current_version + try: + req = urllib.request.Request( + "https://api.github.com/repos/paperless-ngx/" + "paperless-ngx/releases/latest", ) + # Ensure a JSON response + req.add_header("Accept", "application/json") + + with urllib.request.urlopen(req) as response: + remote = response.read().decode("utf-8") + try: + remote_json = json.loads(remote) + remote_version = remote_json["tag_name"] + # Basically PEP 616 but that only went in 3.9 + if remote_version.startswith("ngx-"): + remote_version = remote_version[len("ngx-") :] + except ValueError: + logger.debug("An error occurred parsing remote version json") + except urllib.error.URLError: + logger.debug("An error occurred checking for available updates") + + is_greater_than_current = ( + packaging_version.parse( + remote_version, + ) + > current_version + ) return Response( { "version": remote_version, "update_available": is_greater_than_current, - "feature_is_set": feature_is_set, }, ) @@ -848,15 +844,23 @@ class UiSettingsView(GenericAPIView): displayname = user.username if user.first_name or user.last_name: displayname = " ".join([user.first_name, user.last_name]) - settings = {} + ui_settings = {} if hasattr(user, "ui_settings"): - settings = user.ui_settings.settings + ui_settings = user.ui_settings.settings + if ui_settings["update_checking"]: + ui_settings["update_checking"][ + "backend_setting" + ] = settings.ENABLE_UPDATE_CHECK + else: + ui_settings["update_checking"] = { + "backend_setting": settings.ENABLE_UPDATE_CHECK, + } return Response( { "user_id": user.id, "username": user.username, "display_name": displayname, - "settings": settings, + "settings": ui_settings, }, ) From c87f60c605afa21edf77b7a917e916e646072033 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 30 Sep 2022 14:03:59 -0700 Subject: [PATCH 2/5] Better migration of update checking settings, offer reload, strip backend_setting from db --- .../app-frame/app-frame.component.ts | 12 ++++--- .../manage/settings/settings.component.html | 2 +- .../manage/settings/settings.component.ts | 15 ++++---- src-ui/src/app/services/settings.service.ts | 35 ++++++++++--------- src/documents/serialisers.py | 9 +++++ src/documents/views.py | 2 +- 6 files changed, 43 insertions(+), 32 deletions(-) diff --git a/src-ui/src/app/components/app-frame/app-frame.component.ts b/src-ui/src/app/components/app-frame/app-frame.component.ts index fd70de51a..ee8deb5f8 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.ts @@ -1,4 +1,4 @@ -import { Component, HostListener } from '@angular/core' +import { Component, HostListener, OnInit } from '@angular/core' import { FormControl } from '@angular/forms' import { ActivatedRoute, Router } from '@angular/router' import { from, Observable } from 'rxjs' @@ -32,7 +32,7 @@ import { ToastService } from 'src/app/services/toast.service' templateUrl: './app-frame.component.html', styleUrls: ['./app-frame.component.scss'], }) -export class AppFrameComponent implements ComponentCanDeactivate { +export class AppFrameComponent implements OnInit, ComponentCanDeactivate { constructor( public router: Router, private activatedRoute: ActivatedRoute, @@ -44,11 +44,13 @@ export class AppFrameComponent implements ComponentCanDeactivate { public settingsService: SettingsService, public tasksService: TasksService, private readonly toastService: ToastService - ) { - if (settingsService.updateCheckingEnabled) { + ) {} + + ngOnInit(): void { + if (this.settingsService.get(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED)) { this.checkForUpdates() } - tasksService.reload() + this.tasksService.reload() } versionString = `${environment.appTitle} ${environment.version}` diff --git a/src-ui/src/app/components/manage/settings/settings.component.html b/src-ui/src/app/components/manage/settings/settings.component.html index 4990945d4..e2afd76ea 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.html +++ b/src-ui/src/app/components/manage/settings/settings.component.html @@ -209,5 +209,5 @@
    - + diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 2672efcae..8e26e8b22 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -67,13 +67,6 @@ export class SettingsComponent ) } - get displayLanguageIsDirty(): boolean { - return ( - this.settingsForm.get('displayLanguage').value != - this.store?.getValue()['displayLanguage'] - ) - } - constructor( public savedViewService: SavedViewService, private documentListViewService: DocumentListViewService, @@ -197,7 +190,13 @@ export class SettingsComponent } private saveLocalSettings() { - const reloadRequired = this.displayLanguageIsDirty // just this one, for now + const reloadRequired = + this.settingsForm.value.displayLanguage != + this.store?.getValue()['displayLanguage'] || // displayLanguage is dirty + (this.settingsForm.value.updateCheckingEnabled != + this.store?.getValue()['updateCheckingEnabled'] && + this.settingsForm.value.updateCheckingEnabled) // update checking was turned on + this.settings.set( SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE, this.settingsForm.value.bulkEditApplyOnClose diff --git a/src-ui/src/app/services/settings.service.ts b/src-ui/src/app/services/settings.service.ts index eee134bef..b58a1f845 100644 --- a/src-ui/src/app/services/settings.service.ts +++ b/src-ui/src/app/services/settings.service.ts @@ -410,30 +410,31 @@ export class SettingsService { }, }) } - } - - get updateCheckingEnabled(): boolean { - const backendSetting = this.get( - SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING - ) if ( !this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) && - backendSetting != 'default' + this.get(SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING) != 'default' ) { - this.set(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, backendSetting === 'true') + this.set( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED, + this.get(SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING).toString() === + 'true' + ) + + this.storeSettings() + .pipe(first()) + .subscribe({ + error: (e) => { + this.toastService.showError( + 'Error migrating update checking setting' + ) + console.log(e) + }, + }) } - return ( - this.get(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) || - (!this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) && - backendSetting == 'true') - ) } get updateCheckingIsSet(): boolean { - return ( - this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) || - this.get(SETTINGS_KEYS.UPDATE_CHECKING_BACKEND_SETTING) != 'default' - ) + return this.settingIsSet(SETTINGS_KEYS.UPDATE_CHECKING_ENABLED) } } diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index a1db44791..ca28240b0 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -608,6 +608,15 @@ class UiSettingsViewSerializer(serializers.ModelSerializer): "settings", ] + def validate_settings(self, settings): + # we never save update checking backend setting + if "update_checking" in settings: + try: + settings["update_checking"].pop("backend_setting") + except KeyError: + pass + return settings + def create(self, validated_data): ui_settings = UiSettings.objects.update_or_create( user=validated_data.get("user"), diff --git a/src/documents/views.py b/src/documents/views.py index 3533b0ef1..3db24614a 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -847,7 +847,7 @@ class UiSettingsView(GenericAPIView): ui_settings = {} if hasattr(user, "ui_settings"): ui_settings = user.ui_settings.settings - if ui_settings["update_checking"]: + if "update_checking" in ui_settings: ui_settings["update_checking"][ "backend_setting" ] = settings.ENABLE_UPDATE_CHECK From 98ab770437b187004798e3c00e57624aec4f3b78 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 30 Sep 2022 15:10:52 -0700 Subject: [PATCH 3/5] Update documentation re. `PAPERLESS_ENABLE_UPDATE_CHECK` --- docs/configuration.rst | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 99c037ec8..367770e18 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -908,18 +908,9 @@ Update Checking ############### PAPERLESS_ENABLE_UPDATE_CHECK= - Enable (or disable) the automatic check for available updates. This feature is disabled - by default but if it is not explicitly set Paperless-ngx will show a message about this. - If enabled, the feature works by pinging the the Github API for the latest release e.g. - https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest - to determine whether a new version is available. + .. note:: - Actual updating of the app must still be performed manually. - - Note that for users of thirdy-party containers e.g. linuxserver.io this notification - may be 'ahead' of a new release from the third-party maintainers. - - In either case, no tracking data is collected by the app in any way. - - Defaults to none, which disables the feature. + This setting was deprecated in favor of a frontend setting after v1.9.2. A one-time + migration is performed for users who have this setting set. This setting is always + ignored if the corresponding frontend setting has been set. From 06a29cd45ccbb0fa176dc55cab6afe7178502b36 Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 30 Sep 2022 15:39:02 -0700 Subject: [PATCH 4/5] Handle settings live refresh, unsubscribe subscriptions --- .../manage/settings/settings.component.ts | 170 ++++++++++-------- src-ui/src/app/services/settings.service.ts | 11 +- 2 files changed, 107 insertions(+), 74 deletions(-) diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 8e26e8b22..0cf336a01 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -16,7 +16,15 @@ import { } from 'src/app/services/settings.service' import { Toast, ToastService } from 'src/app/services/toast.service' import { dirtyCheck, DirtyComponent } from '@ngneat/dirty-check-forms' -import { Observable, Subscription, BehaviorSubject, first } from 'rxjs' +import { + Observable, + Subscription, + BehaviorSubject, + first, + tap, + takeUntil, + Subject, +} from 'rxjs' import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' import { ActivatedRoute } from '@angular/router' import { ViewportScroller } from '@angular/common' @@ -57,7 +65,9 @@ export class SettingsComponent store: BehaviorSubject storeSub: Subscription isDirty$: Observable - isDirty: Boolean = false + isDirty: boolean = false + unsubscribeNotifier: Subject = new Subject() + savePending: boolean = false get computedDateLocale(): string { return ( @@ -75,7 +85,11 @@ export class SettingsComponent @Inject(LOCALE_ID) public currentLocale: string, private viewportScroller: ViewportScroller, private activatedRoute: ActivatedRoute - ) {} + ) { + this.settings.settingsSaved.subscribe(() => { + if (!this.savePending) this.initialize() + }) + } ngAfterViewInit(): void { if (this.activatedRoute.snapshot.fragment) { @@ -88,90 +102,98 @@ export class SettingsComponent ngOnInit() { this.savedViewService.listAll().subscribe((r) => { this.savedViews = r.results - let storeData = { - bulkEditConfirmationDialogs: this.settings.get( - SETTINGS_KEYS.BULK_EDIT_CONFIRMATION_DIALOGS - ), - bulkEditApplyOnClose: this.settings.get( - SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE - ), - documentListItemPerPage: this.settings.get( - SETTINGS_KEYS.DOCUMENT_LIST_SIZE - ), - darkModeUseSystem: this.settings.get( - SETTINGS_KEYS.DARK_MODE_USE_SYSTEM - ), - darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED), - darkModeInvertThumbs: this.settings.get( - SETTINGS_KEYS.DARK_MODE_THUMB_INVERTED - ), - themeColor: this.settings.get(SETTINGS_KEYS.THEME_COLOR), - useNativePdfViewer: this.settings.get( - SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER - ), - savedViews: {}, - displayLanguage: this.settings.getLanguage(), - dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE), - dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT), - notificationsConsumerNewDocument: this.settings.get( - SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT - ), - notificationsConsumerSuccess: this.settings.get( - SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS - ), - notificationsConsumerFailed: this.settings.get( - SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED - ), - notificationsConsumerSuppressOnDashboard: this.settings.get( - SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD - ), - commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), - updateCheckingEnabled: this.settings.get( - SETTINGS_KEYS.UPDATE_CHECKING_ENABLED - ), + this.initialize() + }) + } + + initialize() { + this.unsubscribeNotifier.next(true) + + let storeData = { + bulkEditConfirmationDialogs: this.settings.get( + SETTINGS_KEYS.BULK_EDIT_CONFIRMATION_DIALOGS + ), + bulkEditApplyOnClose: this.settings.get( + SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE + ), + documentListItemPerPage: this.settings.get( + SETTINGS_KEYS.DOCUMENT_LIST_SIZE + ), + darkModeUseSystem: this.settings.get(SETTINGS_KEYS.DARK_MODE_USE_SYSTEM), + darkModeEnabled: this.settings.get(SETTINGS_KEYS.DARK_MODE_ENABLED), + darkModeInvertThumbs: this.settings.get( + SETTINGS_KEYS.DARK_MODE_THUMB_INVERTED + ), + themeColor: this.settings.get(SETTINGS_KEYS.THEME_COLOR), + useNativePdfViewer: this.settings.get( + SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER + ), + savedViews: {}, + displayLanguage: this.settings.getLanguage(), + dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE), + dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT), + notificationsConsumerNewDocument: this.settings.get( + SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT + ), + notificationsConsumerSuccess: this.settings.get( + SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS + ), + notificationsConsumerFailed: this.settings.get( + SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED + ), + notificationsConsumerSuppressOnDashboard: this.settings.get( + SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD + ), + commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), + updateCheckingEnabled: this.settings.get( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED + ), + } + + for (let view of this.savedViews) { + storeData.savedViews[view.id.toString()] = { + id: view.id, + name: view.name, + show_on_dashboard: view.show_on_dashboard, + show_in_sidebar: view.show_in_sidebar, } + this.savedViewGroup.addControl( + view.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + show_on_dashboard: new FormControl(null), + show_in_sidebar: new FormControl(null), + }) + ) + } - for (let view of this.savedViews) { - storeData.savedViews[view.id.toString()] = { - id: view.id, - name: view.name, - show_on_dashboard: view.show_on_dashboard, - show_in_sidebar: view.show_in_sidebar, - } - this.savedViewGroup.addControl( - view.id.toString(), - new FormGroup({ - id: new FormControl(null), - name: new FormControl(null), - show_on_dashboard: new FormControl(null), - show_in_sidebar: new FormControl(null), - }) - ) - } + this.store = new BehaviorSubject(storeData) - this.store = new BehaviorSubject(storeData) + this.storeSub = this.store.asObservable().subscribe((state) => { + this.settingsForm.patchValue(state, { emitEvent: false }) + }) - this.storeSub = this.store.asObservable().subscribe((state) => { - this.settingsForm.patchValue(state, { emitEvent: false }) - }) + // Initialize dirtyCheck + this.isDirty$ = dirtyCheck(this.settingsForm, this.store.asObservable()) - // Initialize dirtyCheck - this.isDirty$ = dirtyCheck(this.settingsForm, this.store.asObservable()) - - // Record dirty in case we need to 'undo' appearance settings if not saved on close - this.isDirty$.subscribe((dirty) => { + // Record dirty in case we need to 'undo' appearance settings if not saved on close + this.isDirty$ + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe((dirty) => { this.isDirty = dirty }) - // "Live" visual changes prior to save - this.settingsForm.valueChanges.subscribe(() => { + // "Live" visual changes prior to save + this.settingsForm.valueChanges + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe(() => { this.settings.updateAppearanceSettings( this.settingsForm.get('darkModeUseSystem').value, this.settingsForm.get('darkModeEnabled').value, this.settingsForm.get('themeColor').value ) }) - }) } ngOnDestroy() { @@ -190,6 +212,7 @@ export class SettingsComponent } private saveLocalSettings() { + this.savePending = true const reloadRequired = this.settingsForm.value.displayLanguage != this.store?.getValue()['displayLanguage'] || // displayLanguage is dirty @@ -265,6 +288,7 @@ export class SettingsComponent this.settings .storeSettings() .pipe(first()) + .pipe(tap(() => (this.savePending = false))) .subscribe({ next: () => { this.store.next(this.settingsForm.value) diff --git a/src-ui/src/app/services/settings.service.ts b/src-ui/src/app/services/settings.service.ts index b58a1f845..10cc93ce0 100644 --- a/src-ui/src/app/services/settings.service.ts +++ b/src-ui/src/app/services/settings.service.ts @@ -1,6 +1,7 @@ import { DOCUMENT } from '@angular/common' import { HttpClient } from '@angular/common/http' import { + EventEmitter, Inject, Injectable, LOCALE_ID, @@ -46,6 +47,8 @@ export class SettingsService { public displayName: string + public settingsSaved: EventEmitter = new EventEmitter() + constructor( rendererFactory: RendererFactory2, @Inject(DOCUMENT) private document, @@ -370,7 +373,13 @@ export class SettingsService { } storeSettings(): Observable { - return this.http.post(this.baseUrl, { settings: this.settings }) + return this.http.post(this.baseUrl, { settings: this.settings }).pipe( + tap((results) => { + if (results.success) { + this.settingsSaved.emit() + } + }) + ) } maybeMigrateSettings() { From f26fda9485ad119d2047ef1c9b3034225f92e44c Mon Sep 17 00:00:00 2001 From: Michael Shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 30 Sep 2022 17:19:54 -0700 Subject: [PATCH 5/5] Fix python + frontend tests --- src-ui/cypress/e2e/settings/settings.cy.ts | 2 +- src/documents/tests/test_api.py | 55 ++-------------------- 2 files changed, 6 insertions(+), 51 deletions(-) diff --git a/src-ui/cypress/e2e/settings/settings.cy.ts b/src-ui/cypress/e2e/settings/settings.cy.ts index 7433d16f4..157796a11 100644 --- a/src-ui/cypress/e2e/settings/settings.cy.ts +++ b/src-ui/cypress/e2e/settings/settings.cy.ts @@ -46,7 +46,7 @@ describe('settings', () => { }) }) - cy.viewport(1024, 1024) + cy.viewport(1024, 1280) cy.visit('/settings') cy.wait('@savedViews') }) diff --git a/src/documents/tests/test_api.py b/src/documents/tests/test_api.py index 4fc90b72e..9ad8dd118 100644 --- a/src/documents/tests/test_api.py +++ b/src/documents/tests/test_api.py @@ -1581,7 +1581,11 @@ class TestApiUiSettings(DirectoriesMixin, APITestCase): self.assertEqual(response.status_code, 200) self.assertDictEqual( response.data["settings"], - {}, + { + "update_checking": { + "backend_setting": "default", + }, + }, ) def test_api_set_ui_settings(self): @@ -2542,38 +2546,6 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): def setUp(self): super().setUp() - def test_remote_version_default(self): - response = self.client.get(self.ENDPOINT) - - self.assertEqual(response.status_code, 200) - self.assertDictEqual( - response.data, - { - "version": "0.0.0", - "update_available": False, - "feature_is_set": False, - }, - ) - - @override_settings( - ENABLE_UPDATE_CHECK=False, - ) - def test_remote_version_disabled(self): - response = self.client.get(self.ENDPOINT) - - self.assertEqual(response.status_code, 200) - self.assertDictEqual( - response.data, - { - "version": "0.0.0", - "update_available": False, - "feature_is_set": True, - }, - ) - - @override_settings( - ENABLE_UPDATE_CHECK=True, - ) @mock.patch("urllib.request.urlopen") def test_remote_version_enabled_no_update_prefix(self, urlopen_mock): @@ -2591,13 +2563,9 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): { "version": "1.6.0", "update_available": False, - "feature_is_set": True, }, ) - @override_settings( - ENABLE_UPDATE_CHECK=True, - ) @mock.patch("urllib.request.urlopen") def test_remote_version_enabled_no_update_no_prefix(self, urlopen_mock): @@ -2617,13 +2585,9 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): { "version": version.__full_version_str__, "update_available": False, - "feature_is_set": True, }, ) - @override_settings( - ENABLE_UPDATE_CHECK=True, - ) @mock.patch("urllib.request.urlopen") def test_remote_version_enabled_update(self, urlopen_mock): @@ -2650,13 +2614,9 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): { "version": new_version_str, "update_available": True, - "feature_is_set": True, }, ) - @override_settings( - ENABLE_UPDATE_CHECK=True, - ) @mock.patch("urllib.request.urlopen") def test_remote_version_bad_json(self, urlopen_mock): @@ -2674,13 +2634,9 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): { "version": "0.0.0", "update_available": False, - "feature_is_set": True, }, ) - @override_settings( - ENABLE_UPDATE_CHECK=True, - ) @mock.patch("urllib.request.urlopen") def test_remote_version_exception(self, urlopen_mock): @@ -2698,7 +2654,6 @@ class TestApiRemoteVersion(DirectoriesMixin, APITestCase): { "version": "0.0.0", "update_available": False, - "feature_is_set": True, }, )