From b0f9ed2cf6e62f5981c657f9f1f1874453fac89d Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 5 Oct 2024 11:00:33 -0700 Subject: [PATCH] Separate token refresh --- .../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, 84 insertions(+), 63 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 feb834035..b07c1faa5 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,6 +24,20 @@
+ @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 83262464b..408667f62 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 } from 'src/app/data/mail-account' +import { IMAPSecurity, MailAccountType } 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,6 +82,7 @@ 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 9a068ac88..3826e109c 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,9 +21,14 @@ const IMAP_SECURITY_OPTIONS = [ export class MailAccountEditDialogComponent extends EditDialogComponent { testActive: boolean = false testResult: string - alertTimeout + testAlertTimeout + refreshTokenActive: boolean = false + refreshTokenResult: string + refreshTokenAlertTimeout @ViewChild('testResultAlert', { static: false }) testResultAlert: NgbAlert + @ViewChild('refreshTokenResultAlert', { static: false }) + refreshTokenResultAlert: NgbAlert constructor( service: MailAccountService, @@ -62,7 +67,7 @@ export class MailAccountEditDialogComponent extends EditDialogComponent { this.testActive = false this.testResult = result.success ? 'success' : 'danger' - this.alertTimeout = setTimeout(() => this.testResultAlert.close(), 5000) + this.testAlertTimeout = setTimeout( + () => this.testResultAlert.close(), + 5000 + ) }, error: (e) => { this.testActive = false this.testResult = 'danger' - this.alertTimeout = setTimeout(() => this.testResultAlert.close(), 5000) + this.testAlertTimeout = setTimeout( + () => this.testResultAlert.close(), + 5000 + ) }, }) } @@ -87,4 +98,35 @@ 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 64974d834..9f431b29f 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,6 +20,7 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, + account_type: 1, }, { name: 'Mail Account 2', @@ -30,6 +31,7 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, + account_type: 1, }, { name: 'Mail Account 3', @@ -40,6 +42,7 @@ const mail_accounts = [ username: 'user', password: 'pass', is_token: false, + account_type: 1, }, ] @@ -55,20 +58,6 @@ 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 fb0b0ed23..67b836141 100644 --- a/src-ui/src/app/services/rest/mail-account.service.ts +++ b/src-ui/src/app/services/rest/mail-account.service.ts @@ -1,6 +1,5 @@ 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' @@ -34,15 +33,11 @@ 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())) } @@ -52,4 +47,8 @@ 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 87e21172c..b0e1d7de3 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,21 +76,6 @@ 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 caa73ed2c..b5a0c0ec1 100644 --- a/src-ui/src/app/services/rest/mail-rule.service.ts +++ b/src-ui/src/app/services/rest/mail-rule.service.ts @@ -37,12 +37,6 @@ 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 2c3d9dd77..87b9ddda2 100644 --- a/src/paperless_mail/views.py +++ b/src/paperless_mail/views.py @@ -7,6 +7,7 @@ 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 @@ -35,6 +36,14 @@ 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 @@ -56,16 +65,14 @@ 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 *** and refresh_token / expiration + # account exists, use the password from there instead of *** if ( len(serializer.validated_data.get("password").replace("*", "")) == 0 and request.data["id"] is not None ): - 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 + serializer.validated_data["password"] = MailAccount.objects.get( + pk=request.data["id"], + ).password account = MailAccount(**serializer.validated_data) @@ -75,16 +82,6 @@ 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: