From a4fd5fa7f5909dd42cee22eaa6f032f3dc55fa69 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 5 Oct 2024 11:47:50 -0700 Subject: [PATCH] Revert "Separate token refresh" This reverts commit 9fa69175024bfe29c0c633afa51730aeb205f81c. --- .../mail-account-edit-dialog.component.html | 14 ------ ...mail-account-edit-dialog.component.spec.ts | 3 +- .../mail-account-edit-dialog.component.ts | 50 ++----------------- .../rest/mail-account.service.spec.ts | 17 +++++-- .../app/services/rest/mail-account.service.ts | 13 ++--- .../services/rest/mail-rule.service.spec.ts | 15 ++++++ .../app/services/rest/mail-rule.service.ts | 6 +++ src/paperless_mail/views.py | 29 ++++++----- 8 files changed, 63 insertions(+), 84 deletions(-) diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html index b07c1faa5..feb834035 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html @@ -24,20 +24,6 @@
- @if (object?.expiration) { - - } -
- @if (refreshTokenResult) { - {{refreshTokenResultMessage}} - } -
@if (testResult) { {{testResultMessage}} diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts index 408667f62..83262464b 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.spec.ts @@ -11,7 +11,7 @@ import { import { FormsModule, ReactiveFormsModule } from '@angular/forms' import { NgbActiveModal, NgbModule } from '@ng-bootstrap/ng-bootstrap' import { NgSelectModule } from '@ng-select/ng-select' -import { IMAPSecurity, MailAccountType } from 'src/app/data/mail-account' +import { IMAPSecurity } from 'src/app/data/mail-account' import { IfOwnerDirective } from 'src/app/directives/if-owner.directive' import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive' import { SettingsService } from 'src/app/services/settings.service' @@ -82,7 +82,6 @@ describe('MailAccountEditDialogComponent', () => { imap_port: 443, imap_security: IMAPSecurity.SSL, is_token: false, - account_type: MailAccountType.IMAP, } // success diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts index 3826e109c..9a068ac88 100644 --- a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts @@ -21,14 +21,9 @@ const IMAP_SECURITY_OPTIONS = [ export class MailAccountEditDialogComponent extends EditDialogComponent { testActive: boolean = false testResult: string - testAlertTimeout - refreshTokenActive: boolean = false - refreshTokenResult: string - refreshTokenAlertTimeout + alertTimeout @ViewChild('testResultAlert', { static: false }) testResultAlert: NgbAlert - @ViewChild('refreshTokenResultAlert', { static: false }) - refreshTokenResultAlert: NgbAlert constructor( service: MailAccountService, @@ -67,7 +62,7 @@ export class MailAccountEditDialogComponent extends EditDialogComponent { this.testActive = false this.testResult = result.success ? 'success' : 'danger' - this.testAlertTimeout = setTimeout( - () => this.testResultAlert.close(), - 5000 - ) + this.alertTimeout = setTimeout(() => this.testResultAlert.close(), 5000) }, error: (e) => { this.testActive = false this.testResult = 'danger' - this.testAlertTimeout = setTimeout( - () => this.testResultAlert.close(), - 5000 - ) + this.alertTimeout = setTimeout(() => this.testResultAlert.close(), 5000) }, }) } @@ -98,35 +87,4 @@ export class MailAccountEditDialogComponent extends EditDialogComponent { - this.refreshTokenActive = false - this.refreshTokenResult = result.success ? 'success' : 'danger' - this.refreshTokenAlertTimeout = setTimeout( - () => this.refreshTokenResultAlert.close(), - 5000 - ) - }, - error: (e) => { - this.refreshTokenActive = false - this.refreshTokenResult = 'danger' - this.refreshTokenAlertTimeout = setTimeout( - () => this.refreshTokenResultAlert.close(), - 5000 - ) - }, - }) - } - - get refreshTokenResultMessage() { - return this.refreshTokenResult === 'success' - ? $localize`Successfully refreshed the token` - : $localize`Unable to refresh the token` - } } diff --git a/src-ui/src/app/services/rest/mail-account.service.spec.ts b/src-ui/src/app/services/rest/mail-account.service.spec.ts index 9f431b29f..64974d834 100644 --- a/src-ui/src/app/services/rest/mail-account.service.spec.ts +++ b/src-ui/src/app/services/rest/mail-account.service.spec.ts @@ -20,7 +20,6 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, - account_type: 1, }, { name: 'Mail Account 2', @@ -31,7 +30,6 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, - account_type: 1, }, { name: 'Mail Account 3', @@ -42,7 +40,6 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, - account_type: 1, }, ] @@ -58,6 +55,20 @@ describe(`Additional service tests for MailAccountService`, () => { expect(req.request.method).toEqual('POST') }) + it('should support patchMany', () => { + subscription = service.patchMany(mail_accounts).subscribe() + mail_accounts.forEach((mail_account) => { + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}${endpoint}/${mail_account.id}/` + ) + expect(req.request.method).toEqual('PATCH') + req.flush(mail_account) + }) + httpTestingController.expectOne( + `${environment.apiBaseUrl}${endpoint}/?page=1&page_size=100000` + ) + }) + it('should support reload', () => { service['reload']() const req = httpTestingController.expectOne( diff --git a/src-ui/src/app/services/rest/mail-account.service.ts b/src-ui/src/app/services/rest/mail-account.service.ts index 67b836141..fb0b0ed23 100644 --- a/src-ui/src/app/services/rest/mail-account.service.ts +++ b/src-ui/src/app/services/rest/mail-account.service.ts @@ -1,5 +1,6 @@ import { HttpClient } from '@angular/common/http' import { Injectable } from '@angular/core' +import { combineLatest, Observable } from 'rxjs' import { tap } from 'rxjs/operators' import { MailAccount } from 'src/app/data/mail-account' import { AbstractPaperlessService } from './abstract-paperless-service' @@ -33,11 +34,15 @@ export class MailAccountService extends AbstractPaperlessService { } update(o: MailAccount) { - delete o.expiration - delete o.refresh_token return super.update(o).pipe(tap(() => this.reload())) } + patchMany(objects: MailAccount[]): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + delete(o: MailAccount) { return super.delete(o).pipe(tap(() => this.reload())) } @@ -47,8 +52,4 @@ export class MailAccountService extends AbstractPaperlessService { delete account['set_permissions'] return this.http.post(this.getResourceUrl() + 'test/', account) } - - refreshOauthToken(o: MailAccount) { - return this.http.post(this.getResourceUrl(o.id) + 'refresh_oauth_token/', o) - } } diff --git a/src-ui/src/app/services/rest/mail-rule.service.spec.ts b/src-ui/src/app/services/rest/mail-rule.service.spec.ts index b0e1d7de3..87e21172c 100644 --- a/src-ui/src/app/services/rest/mail-rule.service.spec.ts +++ b/src-ui/src/app/services/rest/mail-rule.service.spec.ts @@ -76,6 +76,21 @@ const mail_rules = [ commonAbstractPaperlessServiceTests(endpoint, MailRuleService) describe(`Additional service tests for MailRuleService`, () => { + it('should support patchMany', () => { + subscription = service.patchMany(mail_rules).subscribe() + mail_rules.forEach((mail_rule) => { + const req = httpTestingController.expectOne( + `${environment.apiBaseUrl}${endpoint}/${mail_rule.id}/` + ) + expect(req.request.method).toEqual('PATCH') + req.flush(mail_rule) + }) + const reloadReq = httpTestingController.expectOne( + `${environment.apiBaseUrl}${endpoint}/?page=1&page_size=100000` + ) + reloadReq.flush({ results: mail_rules }) + }) + it('should support reload', () => { service['reload']() const req = httpTestingController.expectOne( diff --git a/src-ui/src/app/services/rest/mail-rule.service.ts b/src-ui/src/app/services/rest/mail-rule.service.ts index b5a0c0ec1..caa73ed2c 100644 --- a/src-ui/src/app/services/rest/mail-rule.service.ts +++ b/src-ui/src/app/services/rest/mail-rule.service.ts @@ -37,6 +37,12 @@ export class MailRuleService extends AbstractPaperlessService { return super.update(o).pipe(tap(() => this.reload())) } + patchMany(objects: MailRule[]): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + delete(o: MailRule) { return super.delete(o).pipe(tap(() => this.reload())) } diff --git a/src/paperless_mail/views.py b/src/paperless_mail/views.py index 87b9ddda2..2c3d9dd77 100644 --- a/src/paperless_mail/views.py +++ b/src/paperless_mail/views.py @@ -7,7 +7,6 @@ from django.conf import settings from django.http import HttpResponseBadRequest from django.http import HttpResponseRedirect from django.utils import timezone -from rest_framework.decorators import action from rest_framework.generics import GenericAPIView from rest_framework.permissions import IsAuthenticated from rest_framework.response import Response @@ -36,14 +35,6 @@ class MailAccountViewSet(ModelViewSet, PassUserMixin): permission_classes = (IsAuthenticated, PaperlessObjectPermissions) filter_backends = (ObjectOwnedOrGrantedPermissionsFilter,) - @action(methods=["post"], detail=True) - def refresh_oauth_token(self, request, pk=None): - return ( - Response({"success": True}) - if refresh_oauth_token(MailAccount.objects.get(id=pk)) - else HttpResponseBadRequest("Unable to refresh token") - ) - class MailRuleViewSet(ModelViewSet, PassUserMixin): model = MailRule @@ -65,14 +56,16 @@ class MailAccountTestView(GenericAPIView): serializer = self.get_serializer(data=request.data) serializer.is_valid(raise_exception=True) - # account exists, use the password from there instead of *** + # account exists, use the password from there instead of *** and refresh_token / expiration if ( len(serializer.validated_data.get("password").replace("*", "")) == 0 and request.data["id"] is not None ): - serializer.validated_data["password"] = MailAccount.objects.get( - pk=request.data["id"], - ).password + existing_account = MailAccount.objects.get(pk=request.data["id"]) + serializer.validated_data["password"] = existing_account.password + serializer.validated_data["account_type"] = existing_account.account_type + serializer.validated_data["refresh_token"] = existing_account.refresh_token + serializer.validated_data["expiration"] = existing_account.expiration account = MailAccount(**serializer.validated_data) @@ -82,6 +75,16 @@ class MailAccountTestView(GenericAPIView): account.imap_security, ) as M: try: + if ( + account.is_token + and account.expiration is not None + and account.expiration < timezone.now() + ): + if refresh_oauth_token(account): + account.refresh_from_db() + else: + raise MailError("Unable to refresh oauth token") + mailbox_login(M, account) return Response({"success": True}) except MailError: