goodmap 1.4.0__py3-none-any.whl → 1.6.0__py3-none-any.whl

goodmap/api_models.py

@@ -14,7 +14,9 @@ class LocationReportRequest(BaseModel):
     """Request model for reporting a location issue."""
 
     id: str = Field(..., description="Location UUID to report")
-    description: str = Field(..., min_length=1, description="Description of the problem")
+    description: str = Field(
+        ..., min_length=1, max_length=500, description="Description of the problem"
+    )
 
 
 class LocationReportResponse(BaseModel):

goodmap/core_api.py

@@ -7,6 +7,7 @@ import numpy
 import pysupercluster
 from flask import Blueprint, jsonify, make_response, request
 from flask_babel import gettext
+from platzky import FeatureFlagSet
 from platzky.attachment import AttachmentProtocol
 from platzky.config import AttachmentConfig, LanguagesMapping
 from spectree import Response, SpecTree
@@ -24,6 +25,7 @@ from goodmap.clustering import (
     match_clusters_uuids,
 )
 from goodmap.exceptions import LocationValidationError
+from goodmap.feature_flags import CategoriesHelp
 from goodmap.formatter import prepare_pin
 from goodmap.json_security import (
     MAX_JSON_DEPTH_LOCATION,
@@ -38,14 +40,29 @@ MAX_ZOOM = 16
 CLUSTER_RADIUS = 200
 CLUSTER_EXTENT = 512
 
+# Report description validation constants
+MAX_DESCRIPTION_LENGTH = 500
+
 # Error message constants
 ERROR_INVALID_REQUEST_DATA = "Invalid request data"
 ERROR_INVALID_LOCATION_DATA = "Invalid location data"
 ERROR_LOCATION_NOT_FOUND = "Location not found"
+ERROR_INVALID_DESCRIPTION = "Invalid report description"
 
 logger = logging.getLogger(__name__)
 
 
+@deprecation.deprecated(
+    deprecated_in="1.5.0",
+    removed_in="2.0.0",
+    details="Configure 'reported_issue_types' in the database instead. "
+    "The hardcoded fallback will be removed in a future release.",
+)
+def get_default_issue_options():
+    """Return hardcoded fallback issue options for backward compatibility."""
+    return ["notHere", "overload", "broken", "other"]
+
+
 def make_tuple_translation(keys_to_translate):
     return [(x, gettext(x)) for x in keys_to_translate]
 
@@ -83,7 +100,7 @@ def core_pages(
     location_model,
     photo_attachment_class: type[AttachmentProtocol],
     photo_attachment_config: AttachmentConfig,
-    feature_flags={},
+    feature_flags: FeatureFlagSet,
 ) -> Blueprint:
     core_api_blueprint = Blueprint("api", __name__, url_prefix="/api")
 
@@ -247,10 +264,23 @@ def core_pages(
         """
         try:
             location_report = request.get_json()
+            description = location_report["description"]
+
+            # Validate description against configured issue options
+            issue_options = database.get_issue_options()
+            if not issue_options:
+                issue_options = get_default_issue_options()
+
+            if description not in issue_options:
+                if "other" not in issue_options:
+                    return make_response(jsonify({"message": ERROR_INVALID_DESCRIPTION}), 400)
+                if len(description) > MAX_DESCRIPTION_LENGTH:
+                    return make_response(jsonify({"message": ERROR_INVALID_DESCRIPTION}), 400)
+
             report = {
                 "uuid": str(uuid.uuid4()),
                 "location_id": location_report["id"],
-                "description": location_report["description"],
+                "description": description,
                 "status": "pending",
                 "priority": "medium",
             }
@@ -383,15 +413,15 @@ def core_pages(
         raw_categories = database.get_categories()
         categories = make_tuple_translation(raw_categories)
 
-        if not feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp not in feature_flags:
             return jsonify(categories)
-        else:
-            category_data = database.get_category_data()
-            categories_help = category_data.get("categories_help")
-            proper_categories_help = []
-            if categories_help is not None:
-                for option in categories_help:
-                    proper_categories_help.append({option: gettext(f"categories_help_{option}")})
+
+        category_data = database.get_category_data()
+        categories_help = category_data.get("categories_help")
+        proper_categories_help = []
+        if categories_help is not None:
+            for option in categories_help:
+                proper_categories_help.append({option: gettext(f"categories_help_{option}")})
 
         return jsonify({"categories": categories, "categories_help": proper_categories_help})
 
@@ -415,7 +445,7 @@ def core_pages(
                 "options": make_tuple_translation(options),
             }
 
-            if feature_flags.get("CATEGORIES_HELP", False):
+            if CategoriesHelp in feature_flags:
                 option_help_list = categories_options_help.get(key, [])
                 proper_options_help = []
                 for option in option_help_list:
@@ -428,7 +458,7 @@ def core_pages(
 
         response = {"categories": result}
 
-        if feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp in feature_flags:
             categories_help = categories_data.get("categories_help", [])
             proper_categories_help = []
             for option in categories_help:
@@ -466,15 +496,15 @@ def core_pages(
                 proper_categories_options_help.append(
                     {option: gettext(f"categories_options_help_{option}")}
                 )
-        if not feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp not in feature_flags:
             return jsonify(local_data)
-        else:
-            return jsonify(
-                {
-                    "categories_options": local_data,
-                    "categories_options_help": proper_categories_options_help,
-                }
-            )
+
+        return jsonify(
+            {
+                "categories_options": local_data,
+                "categories_options_help": proper_categories_options_help,
+            }
+        )
 
     # Register Spectree with blueprint after all routes are defined
     spec.register(core_api_blueprint)

goodmap/db.py

@@ -335,6 +335,34 @@ def get_location_obligatory_fields(db):
     return globals()[f"{db.module_name}_get_location_obligatory_fields"](db)
 
 
+# ------------------------------------------------
+# get_issue_options
+
+
+def json_db_get_issue_options(self):
+    return self.data.get("reported_issue_types", [])
+
+
+def json_file_db_get_issue_options(self):
+    with open(self.data_file_path, "r") as file:
+        return json.load(file)["map"].get("reported_issue_types", [])
+
+
+def google_json_db_get_issue_options(self):
+    return self.data.get("map", {}).get("reported_issue_types", [])
+
+
+def mongodb_db_get_issue_options(self):
+    config_doc = self.db.config.find_one({"_id": "map_config"})
+    if config_doc and "reported_issue_types" in config_doc:
+        return config_doc["reported_issue_types"]
+    return []
+
+
+def get_issue_options(db):
+    return globals()[f"{db.module_name}_get_issue_options"]
+
+
 # ------------------------------------------------
 # get_data
 
@@ -1440,6 +1468,7 @@ def delete_report(db, report_id):
 
 
 def extend_db_with_goodmap_queries(db, location_model):
+    db.extend("get_issue_options", get_issue_options(db))
     db.extend("get_data", get_data(db))
     db.extend("get_visible_data", get_visible_data(db))
     db.extend("get_meta_data", get_meta_data(db))

goodmap/feature_flags.py

@@ -0,0 +1,7 @@
+from platzky import FeatureFlag
+
+CategoriesHelp = FeatureFlag(alias="CATEGORIES_HELP", description="Show category help text")
+UseLazyLoading = FeatureFlag(
+    alias="USE_LAZY_LOADING", description="Enable lazy loading of location fields"
+)
+EnableAdminPanel = FeatureFlag(alias="ENABLE_ADMIN_PANEL", description="Enable admin panel")

goodmap/goodmap.py

@@ -4,6 +4,7 @@ import logging
 import os
 
 from flask import Blueprint, redirect, render_template, session
+from flask_babel import gettext
 from flask_wtf.csrf import CSRFProtect, generate_csrf
 from platzky import platzky
 from platzky.attachment import create_attachment_class
@@ -18,6 +19,7 @@ from goodmap.db import (
     extend_db_with_goodmap_queries,
     get_location_obligatory_fields,
 )
+from goodmap.feature_flags import EnableAdminPanel, UseLazyLoading
 
 logger = logging.getLogger(__name__)
 
@@ -35,20 +37,6 @@ def create_app(config_path: str) -> platzky.Engine:
     return create_app_from_config(config)
 
 
-# TODO Checking if there is a feature flag secition should be part of configs logic not client app
-def is_feature_enabled(config: GoodmapConfig, feature: str) -> bool:
-    """Check if a feature flag is enabled in the configuration.
-
-    Args:
-        config: Goodmap configuration object
-        feature: Name of the feature flag to check
-
-    Returns:
-        bool: True if feature is enabled, False otherwise
-    """
-    return config.feature_flags.get(feature, False) if config.feature_flags else False
-
-
 def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
     """Create and configure Goodmap application from config object.
 
@@ -73,7 +61,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
     if "MAX_CONTENT_LENGTH" not in app.config:
         app.config["MAX_CONTENT_LENGTH"] = 100 * 1024  # 100KB
 
-    if is_feature_enabled(config, "USE_LAZY_LOADING"):
+    if app.is_enabled(UseLazyLoading):
         location_obligatory_fields = get_location_obligatory_fields(app.db)
         # Extend db with goodmap queries first so we can use the bound method
         location_model = create_location_model(location_obligatory_fields, {})
@@ -149,12 +137,16 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
             name: spec for name, spec in properties.items() if name not in ("uuid", "position")
         }
 
+        issue_options_raw = app.db.get_issue_options()  # type: ignore[attr-defined]
+        reported_issue_types = [{"value": t, "label": gettext(t)} for t in issue_options_raw]
+
         location_schema = {  # TODO remove backward compatibility - deprecation
             "obligatory_fields": app.extensions["goodmap"][
                 "location_obligatory_fields"
             ],  # Backward compatibility
             "categories": categories,  # Backward compatibility
             "fields": form_fields,
+            "reported_issue_types": reported_issue_types,
         }
 
         return render_template(
@@ -175,7 +167,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
         Returns:
             Rendered goodmap-admin.html template or redirect to login
         """
-        if not is_feature_enabled(config, "ENABLE_ADMIN_PANEL"):
+        if not app.is_enabled(EnableAdminPanel):
             return redirect("/")
 
         user = session.get("user", None)
@@ -194,7 +186,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
 
     app.register_blueprint(goodmap)
 
-    if is_feature_enabled(config, "ENABLE_ADMIN_PANEL"):
+    if app.is_enabled(EnableAdminPanel):
         admin_bp = admin_pages(app.db, location_model)
         app.register_blueprint(admin_bp)
 

{goodmap-1.4.0.dist-info → goodmap-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: goodmap
-Version: 1.4.0
+Version: 1.6.0
 Summary: Map engine to serve all the people :)
 Author: Krzysztof Kolodzinski
 Author-email: krzysztof.kolodzinski@problematy.pl
@@ -20,11 +20,11 @@ Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
 Requires-Dist: deprecation (>=2.1.0,<3.0.0)
 Requires-Dist: google-cloud-storage (>=2.7.0,<3.0.0)
 Requires-Dist: gql (>=3.4.0,<4.0.0)
-Requires-Dist: gunicorn (>=20.1,<24.0)
+Requires-Dist: gunicorn (>=20.1,<25.0)
 Requires-Dist: humanize (>=4.6.0,<5.0.0)
 Requires-Dist: myst-parser (>=4.0.0,<5.0.0) ; extra == "docs"
 Requires-Dist: numpy (>=2.2.0,<3.0.0)
-Requires-Dist: platzky (>=1.3.0,<2.0.0)
+Requires-Dist: platzky (>=1.4.1,<2.0.0)
 Requires-Dist: pydantic (>=2.7.1,<3.0.0)
 Requires-Dist: pysupercluster-problematy (>=0.7.8,<0.8.0)
 Requires-Dist: scipy (>=1.15.1,<2.0.0)

{goodmap-1.4.0.dist-info → goodmap-1.6.0.dist-info}/RECORD

@@ -1,20 +1,20 @@
 goodmap/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 goodmap/admin_api.py,sha256=5tvHeqknG8WmhBYmIHlQHTOUA-zaT8FKaAyyLdvX2EE,10290
-goodmap/api_models.py,sha256=Bv4OTGuckNneCrxaQ1Y_PMeu7YFLvGUqU2EorvDlUjY,3438
+goodmap/api_models.py,sha256=drE0i6AWHat7siwTpnvpSrWVSC5uW0pTKQzo68xwb34,3468
 goodmap/clustering.py,sha256=ULB-fPNOUDblgpBK4vzuo0o2yqIcvG84F3R6Za2X_l4,2905
 goodmap/config.py,sha256=CsmC1zuvVab90VW50dtARHbFJpy2vfsIfbque8Zgc-U,1313
 goodmap/core.py,sha256=AgdGLfeJvL7TlTX893NR2YdCS8EuXx93Gx6ndvWws7s,2673
-goodmap/core_api.py,sha256=CgAVRJP4Ggd5b33yAVNxAIJtEVy34NqOGKq1JRtNSLo,20006
+goodmap/core_api.py,sha256=ao80Tynclv6IV51hXMPA0W3RQUwJPwxZFXcs-H287KE,21105
 goodmap/data_models/location.py,sha256=_I27R06ovEL9ctv_SZ3yoLL-RwmyE3VDsVOG4a89q50,6798
-goodmap/data_validator.py,sha256=lBmVAPxvSmEOdUGeVYSjUvVVmKfPyq4CWoHfczTtEMM,4090
-goodmap/db.py,sha256=TcqYGbK5yk6S735Si1AzjNqcbB1nsd9pFGOy5qN9Vec,46589
+goodmap/db.py,sha256=ZXkonYpiWwtCGsOk9XAXlaNk_db4ZGrJjgPspBdm9gc,47408
 goodmap/exceptions.py,sha256=jkFAUoc5LHk8iPjxHxbcRp8W6qFCSEA25A8XaSwxwyo,2906
+goodmap/feature_flags.py,sha256=-hiqTX4OlhfY_4M1Kvy-_z1Fx6YTaFi3SVGYa0Pamcw,334
 goodmap/formatter.py,sha256=4rqcg9A9Y9opAi7eb8kMDdUC03M3uzZgCxx29cvvIag,1403
-goodmap/goodmap.py,sha256=OZWxVXtvjftbNPFoJ3myCshv4BOHe0J3x0yLg2Cxm9A,8030
+goodmap/goodmap.py,sha256=Hi8np9oKkPzeRFYVNPiYvhW1chsfJgIoGwUuhZ_3Q-g,7811
 goodmap/json_security.py,sha256=EHAxNlb16AVwphgf4F7yObtMZpbR9M538dwn_STRcMo,3275
 goodmap/templates/goodmap-admin.html,sha256=LSiOZ9-n29CnlfVNwdgmXwT7Xe7t5gvGh1xSrFGqOIY,35669
 goodmap/templates/map.html,sha256=Uk7FFrZwvHZvG0DDaQrGW5ZrIMD21XrJzMub76uIlAg,4348
-goodmap-1.4.0.dist-info/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
-goodmap-1.4.0.dist-info/METADATA,sha256=M8Y6Fq8-gh2--o1VnhPd35NznVOC0R9DNGZo7LAEMbU,5798
-goodmap-1.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-goodmap-1.4.0.dist-info/RECORD,,
+goodmap-1.6.0.dist-info/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
+goodmap-1.6.0.dist-info/METADATA,sha256=ljeI70gs0U8RV8dm-VDX8Vt4MHy5_KxfB7tlik3l-0E,5798
+goodmap-1.6.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+goodmap-1.6.0.dist-info/RECORD,,

goodmap/data_validator.py

@@ -1,119 +0,0 @@
-import json
-from enum import Enum
-from sys import argv, stderr
-
-
-class ViolationType(Enum):
-    INVALID_JSON_FORMAT = 0
-    MISSING_OBLIGATORY_FIELD = 1
-    INVALID_VALUE_IN_CATEGORY = 2
-    NULL_VALUE = 3
-
-    def get_error_message(self):
-        error_message_dict = {
-            0: "invalid json format",
-            1: "missing obligatory field",
-            2: "invalid value in category",
-            3: "attribute has null value",
-        }
-        return error_message_dict[self.value]
-
-
-class DataViolation:
-    def __init__(self, violation_type: ViolationType):
-        self.violation_type = violation_type
-
-
-class FormatViolation(DataViolation):
-    def __init__(self, decoding_error):
-        super().__init__(ViolationType.INVALID_JSON_FORMAT)
-        self.decoding_error = decoding_error
-
-
-class FieldViolation(DataViolation):
-    def __init__(self, violation_type: ViolationType, datapoint, violating_field):
-        super().__init__(violation_type)
-        self.datapoint = datapoint
-        self.violating_field = violating_field
-
-
-def get_missing_obligatory_fields_violations(p, obligatory_fields):
-    violations = []
-    for field in obligatory_fields:
-        if field not in p.keys():
-            violations.append(FieldViolation(ViolationType.MISSING_OBLIGATORY_FIELD, p, field))
-    return violations
-
-
-def get_invalid_value_in_category_violations(p, categories):
-    violations = []
-    for category in categories & p.keys():
-        category_value_in_point = p[category]
-        valid_values_set = categories[category]
-        if isinstance(category_value_in_point, list):
-            for attribute_value in category_value_in_point:
-                if attribute_value not in valid_values_set:
-                    violations.append(
-                        FieldViolation(ViolationType.INVALID_VALUE_IN_CATEGORY, p, category)
-                    )
-        else:
-            if category_value_in_point not in valid_values_set:
-                violations.append(
-                    FieldViolation(ViolationType.INVALID_VALUE_IN_CATEGORY, p, category)
-                )
-    return violations
-
-
-def get_null_values_violations(p):
-    violations = []
-    for attribute, value in p.items():
-        if value is None:
-            violations.append(FieldViolation(ViolationType.NULL_VALUE, p, attribute))
-    return violations
-
-
-def report_data_violations_from_json(json_database):
-    map_data = json_database["map"]
-    datapoints = map_data["data"]
-    categories = map_data["categories"]
-    obligatory_fields = map_data["location_obligatory_fields"]
-
-    data_violations = []
-
-    for p in datapoints:
-        data_violations += get_missing_obligatory_fields_violations(p, obligatory_fields)
-        data_violations += get_invalid_value_in_category_violations(p, categories)
-        data_violations += get_null_values_violations(p)
-
-    return data_violations
-
-
-def report_data_violations_from_json_file(path_to_json_file):
-    with open(path_to_json_file) as json_file:
-        try:
-            return report_data_violations_from_json(json.load(json_file))
-        except json.JSONDecodeError as e:
-            return [FormatViolation(e)]
-
-
-def print_reported_violations(data_violations):  # pragma: no cover
-    for violation in data_violations:
-        violation_type = violation.violation_type
-        if violation_type == ViolationType.INVALID_JSON_FORMAT:
-            print("DATA ERROR: invalid json format", file=stderr)
-            print(violation.decoding_error, file=stderr)
-        else:
-            violating_field = violation.violating_field
-            violation_type_error = violation_type.get_error_message()
-            print(
-                f"DATA ERROR: {violation_type_error} {violating_field} in datapoint:", file=stderr
-            )
-            print(violation.datapoint, file=stderr)
-
-
-if __name__ == "__main__":  # pragma: no cover
-    data_violations = report_data_violations_from_json_file(argv[1])
-    if data_violations == []:
-        print("All data is valid", file=stderr)
-    else:
-        print_reported_violations(data_violations)