paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Change: tweaks to system status (#6008)

Browse Source
This commit is contained in:
shamoon 2024-03-05 07:50:04 -08:00 committed by GitHub
parent fc74da9b82
commit 55a40708a6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 114 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src-ui/messages.xlf
View File

@ -4281,7 +4281,7 @@
</context-group>
<context-group purpose="location">
<context context-type="sourcefile">src/app/components/common/system-status-dialog/system-status-dialog.component.html</context>
<context context-type="linenumber">152</context>
<context context-type="linenumber">156</context>
</context-group>
</trans-unit>
<trans-unit id="595732867213154214" datatype="html">
@ -4652,7 +4652,7 @@
<source>Last Trained</source>
<context-group purpose="location">
<context context-type="sourcefile">src/app/components/common/system-status-dialog/system-status-dialog.component.html</context>
<context context-type="linenumber">135</context>
<context context-type="linenumber">139</context>
</context-group>
</trans-unit>
<trans-unit id="6732151329960766506" datatype="html">

6
src-ui/src/app/components/common/system-status-dialog/system-status-dialog.component.html
View File

@ -128,7 +128,11 @@
<i-bs name="check-circle-fill" class="text-primary ms-2 lh-1" [ngbPopover]="classifierStatus" triggers="mouseenter:mouseleave"></i-bs>
}
} @else {
<i-bs name="exclamation-triangle-fill" class="text-danger ms-2 lh-1" ngbPopover="{{status.tasks.classifier_error}}" triggers="mouseenter:mouseleave"></i-bs>
<i-bs name="exclamation-triangle-fill" class="ms-2 lh-1"
[class.text-danger]="status.tasks.classifier_status === SystemStatusItemStatus.ERROR"
[class.text-warning]="status.tasks.classifier_status === SystemStatusItemStatus.WARNING"
ngbPopover="{{status.tasks.classifier_error}}"
triggers="mouseenter:mouseleave"></i-bs>
}
</dd>
<ng-template #classifierStatus>

6
src-ui/src/app/components/common/system-status-dialog/system-status-dialog.component.ts
View File

@ -1,6 +1,9 @@
import { Component, Input } from '@angular/core'
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
import { SystemStatus } from 'src/app/data/system-status'
import {
SystemStatus,
SystemStatusItemStatus,
} from 'src/app/data/system-status'
import { SystemStatusService } from 'src/app/services/system-status.service'
import { Clipboard } from '@angular/cdk/clipboard'
@ -10,6 +13,7 @@ import { Clipboard } from '@angular/cdk/clipboard'
styleUrl: './system-status-dialog.component.scss',
})
export class SystemStatusDialogComponent {
public SystemStatusItemStatus = SystemStatusItemStatus
public status: SystemStatus
public copied: boolean = false

1
src-ui/src/app/data/system-status.ts
View File

@ -6,6 +6,7 @@ export enum InstallType {
export enum SystemStatusItemStatus {
OK = 'OK',
ERROR = 'ERROR',
WARNING = 'WARNING',
}
export interface SystemStatus {

64
src/documents/tests/test_api_status.py
View File

@ -1,4 +1,5 @@
import os
import tempfile
from pathlib import Path
from unittest import mock
@ -7,8 +8,11 @@ from django.test import override_settings
from rest_framework import status
from rest_framework.test import APITestCase
from documents.classifier import ClassifierModelCorruptError
from documents.classifier import DocumentClassifier
from documents.classifier import load_classifier
from documents.models import Document
from documents.models import Tag
from paperless import version
@ -158,7 +162,7 @@ class TestSystemStatus(APITestCase):
WHEN:
- The user requests the system status
THEN:
- The response contains the correct classifier status
- The response contains an OK classifier status
"""
load_classifier()
test_classifier = DocumentClassifier()
@ -169,18 +173,66 @@ class TestSystemStatus(APITestCase):
self.assertEqual(response.data["tasks"]["classifier_status"], "OK")
self.assertIsNone(response.data["tasks"]["classifier_error"])
def test_system_status_classifier_error(self):
def test_system_status_classifier_warning(self):
"""
GIVEN:
- The classifier is not found
- The classifier does not exist yet
- > 0 documents and tags with auto matching exist
WHEN:
- The user requests the system status
THEN:
- The response contains an error classifier status
- The response contains an WARNING classifier status
"""
with override_settings(MODEL_FILE="does_not_exist"):
Document.objects.create(
title="Test Document",
)
Tag.objects.create(name="Test Tag", matching_algorithm=Tag.MATCH_AUTO)
self.client.force_login(self.user)
response = self.client.get(self.ENDPOINT)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["tasks"]["classifier_status"], "WARNING")
self.assertIsNotNone(response.data["tasks"]["classifier_error"])
def test_system_status_classifier_error(self):
"""
GIVEN:
- The classifier does exist but is corrupt
- > 0 documents and tags with auto matching exist
WHEN:
- The user requests the system status
THEN:
- The response contains an ERROR classifier status
"""
does_exist = tempfile.NamedTemporaryFile(
dir="/tmp",
delete=False,
)
with override_settings(MODEL_FILE=does_exist):
with mock.patch("documents.classifier.load_classifier") as mock_load:
mock_load.side_effect = ClassifierModelCorruptError()
Document.objects.create(
title="Test Document",
)
Tag.objects.create(name="Test Tag", matching_algorithm=Tag.MATCH_AUTO)
self.client.force_login(self.user)
response = self.client.get(self.ENDPOINT)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["tasks"]["classifier_status"], "ERROR")
self.assertIsNotNone(response.data["tasks"]["classifier_error"])
def test_system_status_classifier_ok_no_objects(self):
"""
GIVEN:
- The classifier does not exist (and should not)
- No documents nor objects with auto matching exist
WHEN:
- The user requests the system status
THEN:
- The response contains an OK classifier status
"""
with override_settings(MODEL_FILE="does_not_exist"):
self.client.force_login(self.user)
response = self.client.get(self.ENDPOINT)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["tasks"]["classifier_status"], "ERROR")
self.assertIsNotNone(response.data["tasks"]["classifier_error"])
self.assertEqual(response.data["tasks"]["classifier_status"], "OK")

50
src/documents/views.py
View File

@ -1581,7 +1581,9 @@ class SystemStatusView(GenericAPIView, PassUserMixin):
except Exception as e: # pragma: no cover
applied_migrations = []
db_status = "ERROR"
logger.exception(f"System status error connecting to database: {e}")
logger.exception(
f"System status detected a possible problem while connecting to the database: {e}",
)
db_error = "Error connecting to database, check logs for more detail."
media_stats = os.statvfs(settings.MEDIA_ROOT)
@ -1594,7 +1596,9 @@ class SystemStatusView(GenericAPIView, PassUserMixin):
redis_status = "OK"
except Exception as e:
redis_status = "ERROR"
logger.exception(f"System status error connecting to redis: {e}")
logger.exception(
f"System status detected a possible problem while connecting to redis: {e}",
)
redis_error = "Error connecting to redis, check logs for more detail."
try:
@ -1615,14 +1619,40 @@ class SystemStatusView(GenericAPIView, PassUserMixin):
except Exception as e:
index_status = "ERROR"
index_error = "Error opening index, check logs for more detail."
logger.exception(f"System status error opening index: {e}")
logger.exception(
f"System status detected a possible problem while opening the index: {e}",
)
index_last_modified = None
classifier_error = None
classifier_status = None
try:
classifier = load_classifier()
if classifier is None:
raise Exception("Classifier not loaded")
# Make sure classifier should exist
docs_queryset = Document.objects.exclude(
tags__is_inbox_tag=True,
)
if (
docs_queryset.count() > 0
and (
Tag.objects.filter(matching_algorithm=Tag.MATCH_AUTO).exists()
or DocumentType.objects.filter(
matching_algorithm=Tag.MATCH_AUTO,
).exists()
or Correspondent.objects.filter(
matching_algorithm=Tag.MATCH_AUTO,
).exists()
or StoragePath.objects.filter(
matching_algorithm=Tag.MATCH_AUTO,
).exists()
)
and not os.path.isfile(settings.MODEL_FILE)
):
# if classifier file doesn't exist just classify as a warning
classifier_error = "Classifier file does not exist (yet). Re-training may be pending."
classifier_status = "WARNING"
raise FileNotFoundError(classifier_error)
classifier_status = "OK"
task_result_model = apps.get_model("django_celery_results", "taskresult")
result = (
@ -1637,10 +1667,16 @@ class SystemStatusView(GenericAPIView, PassUserMixin):
)
classifier_last_trained = result.date_done if result else None
except Exception as e:
classifier_status = "ERROR"
if classifier_status is None:
classifier_status = "ERROR"
classifier_last_trained = None
classifier_error = "Error loading classifier, check logs for more detail."
logger.exception(f"System status error loading classifier: {e}")
if classifier_error is None:
classifier_error = (
"Unable to load classifier, check logs for more detail."
)
logger.exception(
f"System status detected a possible problem while loading the classifier: {e}",
)
return Response(
{