Fix reports (#483)

* Version -> 1.6.0

* Remove check_fix_default_person

* Remove duplicate test

* Check if removing test fixes unit tests

* Add test again

* Try setting date format explicitly

* Revert "Try setting date format explicitly"

This reverts commit 8dfabbf.

* Try removing test

* Try renaming tree in test

* Try removing check

* Restore test

* Fix date format

Author: DavidMStraub

gramps_webapi/_version.py

@@ -18,4 +18,4 @@
 #
 
 # make sure to match this version with the one in apispec.yaml
-__version__ = "1.5.2"
+__version__ = "1.6.0"

gramps_webapi/api/report.py

@@ -32,6 +32,7 @@
 from gramps.gen.const import GRAMPS_LOCALE as glocale
 from gramps.gen.db.base import DbReadBase
 from gramps.gen.display.name import displayer as name_displayer
+from gramps.gen.errors import HandleError
 from gramps.gen.filters import reload_custom_filters
 from gramps.gen.plug import BasePluginManager
 from gramps.gen.plug.docgen import PaperStyle
@@ -76,26 +77,33 @@ def get_report_profile(
     """Extract and return report attributes and options."""
     module = plugin_manager.load_plugin(report_data)
     option_class = getattr(module, report_data.optionclass)
-    report = ModifiedCommandLineReport(
-        db_handle,
-        report_data.name,
-        report_data.category,
-        option_class,
-        {},
-        include_options_help=include_options_help,
-    )
+    try:
+        report = ModifiedCommandLineReport(
+            db_handle,
+            report_data.name,
+            report_data.category,
+            option_class,
+            {},
+            include_options_help=include_options_help,
+        )
+        options_dict = report.options_dict
+    except HandleError:
+        # HandleError can happen in particular on an empty database
+        # when there is no person yet
+        report = None
+        options_dict = {}
     result = {
         "authors": report_data.authors,
         "authors_email": report_data.authors_email,
         "category": report_data.category,
         "description": report_data.description,
         "id": report_data.id,
         "name": report_data.name,
-        "options_dict": report.options_dict,
+        "options_dict": options_dict,
         "report_modes": report_data.report_modes,
         "version": report_data.version,
     }
-    if include_options_help:
+    if include_options_help and report is not None:
         options_help = report.options_help
         if REPORT_FILTERS:
             for report_type in REPORT_FILTERS:

gramps_webapi/api/resources/exporters.py

@@ -46,7 +46,6 @@
 )
 from . import ProtectedResource
 from .emit import GrampsJSONEncoder
-from .util import check_fix_default_person
 
 
 class ExportersResource(ProtectedResource, GrampsJSONEncoder):
@@ -119,8 +118,6 @@ def post(self, args: Dict, extension: str) -> Response:
         exporters = get_exporters(extension)
         if not exporters:
             abort(404)
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
         tree = get_tree_from_jwt()
         # remove JWT from args
         options = {k: v for k, v in args.items() if k != "jwt"}
@@ -180,8 +177,6 @@ def get(self, args: Dict, extension: str) -> Response:
         exporters = get_exporters(extension)
         if not exporters:
             abort(404)
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
         options = prepare_options(db_handle, args)
         file_name, file_type = run_export(db_handle, extension, options)
         export_path = current_app.config.get("EXPORT_DIR")

gramps_webapi/api/resources/reports.py

@@ -37,7 +37,6 @@
 from ..util import get_buffer_for_file, get_db_handle, get_tree_from_jwt, use_args
 from . import ProtectedResource
 from .emit import GrampsJSONEncoder
-from .util import check_fix_default_person
 
 
 class ReportsResource(ProtectedResource, GrampsJSONEncoder):
@@ -46,8 +45,6 @@ class ReportsResource(ProtectedResource, GrampsJSONEncoder):
     @use_args({"include_help": fields.Boolean(load_default=False)}, location="query")
     def get(self, args: Dict) -> Response:
         """Get all available report attributes."""
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
         reports = get_reports(
             get_db_handle(), include_options_help=args["include_help"]
         )
@@ -60,8 +57,6 @@ class ReportResource(ProtectedResource, GrampsJSONEncoder):
     @use_args({"include_help": fields.Boolean(load_default=True)}, location="query")
     def get(self, args: Dict, report_id: str) -> Response:
         """Get specific report attributes."""
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
         reports = get_reports(
             get_db_handle(),
             report_id=report_id,
@@ -96,9 +91,6 @@ def get(self, args: Dict, report_id: str) -> Response:
         if "of" in report_options:
             abort(422)
 
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
-
         file_name, file_type = run_report(
             db_handle=get_db_handle(),
             report_id=report_id,
@@ -130,8 +122,6 @@ def post(self, args: Dict, report_id: str) -> Response:
                 abort(400)
         if "of" in report_options:
             abort(422)
-        if has_permissions({PERM_EDIT_OBJ}):
-            check_fix_default_person(get_db_handle(readonly=False))
         tree = get_tree_from_jwt()
         task = run_task(
             generate_report,

gramps_webapi/api/resources/timeline.py

@@ -21,11 +21,12 @@
 from typing import Dict, List, Optional, Set, Tuple, Union
 
 from flask import abort
+from gramps.gen.config import config
 from gramps.gen.const import GRAMPS_LOCALE as glocale
 from gramps.gen.db.base import DbReadBase
 from gramps.gen.display.place import PlaceDisplay
 from gramps.gen.errors import HandleError
-from gramps.gen.lib import Date, Event, EventRef, EventType, Person, Span
+from gramps.gen.lib import Date, Event, EventType, Person, Span
 from gramps.gen.relationship import get_relationship_calculator
 from gramps.gen.utils.alive import probably_alive_range
 from gramps.gen.utils.db import (
@@ -473,7 +474,8 @@ def profile(self, page=0, pagesize=20):
                         if not age:
                             age = person_age
                     person["age"] = person_age
-
+            date_format = config.get("preferences.date-format")
+            self.locale.date_displayer.set_format(date_format)
             profile = {
                 "date": self.locale.date_displayer.display(event.date),
                 "description": event.description,

gramps_webapi/api/resources/util.py

@@ -1226,24 +1226,3 @@ def dry_run_import(
         "notes": db_handle.get_number_of_notes(),
         "tags": db_handle.get_number_of_tags(),
     }
-
-
-def check_fix_default_person(db_handle: Union[DbReadBase, DbWriteBase]) -> None:
-    """If the db is writable, check if the default person still exists.
-
-    If it doesn't exist, set the default person to None.
-    """
-    if not isinstance(db_handle, DbWriteBase):
-        # not writable
-        return None
-    handle = db_handle.get_default_handle()
-    if not handle:
-        # default person is already empty
-        return None
-    if db_handle.has_person_handle(handle):
-        # default person exists
-        return None
-    # OK, we have a problem - default person is not empty but does not exist
-    # - set to empty
-    db_handle.set_default_person_handle(None)
-    return None

gramps_webapi/data/apispec.yaml

@@ -8,7 +8,7 @@ info:
 
 
     * More about Gramps and the numerous features it provides for genealogists can be found at https://gramps-project.org
-  version: "1.5.2"  # make sure to match this version with the one in _version.py
+  version: "1.6.0"  # make sure to match this version with the one in _version.py
   license:
     name: "GNU Affero General Public License v3.0"
     url: "http://www.gnu.org/licenses/agpl-3.0.html"

tests/test_endpoints/test_reports.py

@@ -19,12 +19,23 @@
 
 """Tests for the /api/reports endpoints using example_gramps."""
 
+import os
 import unittest
 from mimetypes import types_map
+from unittest.mock import patch
 
-from gramps_webapi.const import REPORT_DEFAULTS
+from gramps.cli.clidbman import CLIDbManager
+from gramps.gen.dbstate import DbState
 
-from . import BASE_URL, get_test_client
+from gramps_webapi.app import create_app
+from gramps_webapi.auth import add_user, user_db
+from gramps_webapi.const import (
+    ENV_CONFIG_FILE,
+    REPORT_DEFAULTS,
+    TEST_EMPTY_GRAMPS_AUTH_CONFIG,
+)
+
+from . import BASE_URL, TEST_USERS, get_test_client
 from .checks import (
     check_conforms_to_schema,
     check_invalid_semantics,
@@ -257,3 +268,43 @@ def test_post_reports_report_id_file_one_of_each(self):
             if rv.status_code != 200:
                 bad_reports.append(report["id"])
         self.assertEqual(bad_reports, [])
+
+
+class TestReportsEmptyDatabase(unittest.TestCase):
+    """Test cases for the /api/reports/ endpoint with an empty database."""
+
+    @classmethod
+    def setUpClass(cls):
+        """Test class setup."""
+        cls.name = "empty2"
+        cls.dbman = CLIDbManager(DbState())
+        cls.dbpath, _name = cls.dbman.create_new_db_cli(cls.name, dbid="sqlite")
+        cls.dbman.create_new_db_cli(cls.name, dbid="sqlite")
+        with patch.dict(
+            "os.environ",
+            {
+                ENV_CONFIG_FILE: TEST_EMPTY_GRAMPS_AUTH_CONFIG,
+                "TREE": cls.name,
+            },
+        ):
+            cls.test_app = create_app()
+        cls.test_app.config["TESTING"] = True
+        cls.client = cls.test_app.test_client()
+        cls.tree = os.path.basename(cls.dbpath)
+        with cls.test_app.app_context():
+            user_db.create_all()
+            for role in TEST_USERS:
+                add_user(
+                    name=TEST_USERS[role]["name"],
+                    password=TEST_USERS[role]["password"],
+                    role=role,
+                )
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.dbman.remove_database(cls.name)
+
+    def test_reports_empty_db(self):
+        """Test that importers are loaded also for a fresh db."""
+        rv = check_success(self, TEST_URL)
+        assert len(rv) > 0