CLI: get valid --format values via autodiscover

[nominatim.git] / nominatim / server / falcon / server.py

diff --git a/nominatim/server/falcon/server.py b/nominatim/server/falcon/server.py
index f1030f5c82205c85b798e418f3f740343ce04951..bdae350744e6774ff927f8bec597da8b05ee90e6 100644 (file)
--- a/nominatim/server/falcon/server.py
+++ b/nominatim/server/falcon/server.py
@@ -7,14 +7,16 @@
 """
 Server implementation using the falcon webserver framework.
 """
 """
 Server implementation using the falcon webserver framework.
 """

-from typing import Optional, Mapping, cast, Any
+from typing import Optional, Mapping, cast, Any, List

 from pathlib import Path
 import datetime as dt
 from pathlib import Path
 import datetime as dt

+import asyncio

 
 from falcon.asgi import App, Request, Response
 
 from nominatim.api import NominatimAPIAsync
 import nominatim.api.v1 as api_impl
 
 from falcon.asgi import App, Request, Response
 
 from nominatim.api import NominatimAPIAsync
 import nominatim.api.v1 as api_impl

+import nominatim.api.logging as loglib

 from nominatim.config import Configuration
 
 class HTTPNominatimError(Exception):
 from nominatim.config import Configuration
 
 class HTTPNominatimError(Exception):


@@ -44,8 +46,15 @@ async def timeout_error_handler(req: Request, resp: Response, #pylint: disable=u
         per exception info.
     """
     resp.status = 503
         per exception info.
     """
     resp.status = 503

-    resp.text = "Query took too long to process."
-    resp.content_type = 'text/plain; charset=utf-8'
+
+    loglib.log().comment('Aborted: Query took too long to process.')
+    logdata = loglib.get_and_disable()
+    if logdata:
+        resp.text = logdata
+        resp.content_type = 'text/html; charset=utf-8'
+    else:
+        resp.text = "Query took too long to process."
+        resp.content_type = 'text/plain; charset=utf-8'

 
 
 class ParamWrapper(api_impl.ASGIAdaptor):
 
 
 class ParamWrapper(api_impl.ASGIAdaptor):


@@ -119,10 +128,10 @@ class FileLoggingMiddleware:
                                resource: Optional[EndpointWrapper],
                                req_succeeded: bool) -> None:
         """ Callback after requests writes to the logfile. It only
                                resource: Optional[EndpointWrapper],
                                req_succeeded: bool) -> None:
         """ Callback after requests writes to the logfile. It only

-            writes logs for sucessful requests for search, reverse and lookup.
+            writes logs for successful requests for search, reverse and lookup.

         """
         if not req_succeeded or resource is None or resp.status != 200\
         """
         if not req_succeeded or resource is None or resp.status != 200\

-            or resource.name not in ('reverse', 'search', 'lookup'):
+            or resource.name not in ('reverse', 'search', 'lookup', 'details'):

             return
 
         finish = dt.datetime.now(tz=dt.timezone.utc)
             return
 
         finish = dt.datetime.now(tz=dt.timezone.utc)


@@ -136,21 +145,36 @@ class FileLoggingMiddleware:
                       f'{resource.name} "{params}"\n')
 
 
                       f'{resource.name} "{params}"\n')
 
 

+class APIShutdown:
+    """ Middleware that closes any open database connections.
+    """
+
+    def __init__(self, api: NominatimAPIAsync) -> None:
+        self.api = api
+
+    async def process_shutdown(self, *_: Any) -> None:
+        """Process the ASGI lifespan shutdown event.
+        """
+        await self.api.close()
+
+

 def get_application(project_dir: Path,
                     environ: Optional[Mapping[str, str]] = None) -> App:
     """ Create a Nominatim Falcon ASGI application.
     """
     api = NominatimAPIAsync(project_dir, environ)
 
 def get_application(project_dir: Path,
                     environ: Optional[Mapping[str, str]] = None) -> App:
     """ Create a Nominatim Falcon ASGI application.
     """
     api = NominatimAPIAsync(project_dir, environ)
 

-    middleware: Optional[object] = None
+    middleware: List[object] = [APIShutdown(api)]

     log_file = api.config.LOG_FILE
     if log_file:
     log_file = api.config.LOG_FILE
     if log_file:

-        middleware = FileLoggingMiddleware(log_file)
+        middleware.append(FileLoggingMiddleware(log_file))

 
     app = App(cors_enable=api.config.get_bool('CORS_NOACCESSCONTROL'),
               middleware=middleware)
     app.add_error_handler(HTTPNominatimError, nominatim_error_handler)
     app.add_error_handler(TimeoutError, timeout_error_handler)
 
     app = App(cors_enable=api.config.get_bool('CORS_NOACCESSCONTROL'),
               middleware=middleware)
     app.add_error_handler(HTTPNominatimError, nominatim_error_handler)
     app.add_error_handler(TimeoutError, timeout_error_handler)

+    # different from TimeoutError in Python <= 3.10
+    app.add_error_handler(asyncio.TimeoutError, timeout_error_handler)

 
     legacy_urls = api.config.get_bool('SERVE_LEGACY_URLS')
     for name, func in api_impl.ROUTES:
 
     legacy_urls = api.config.get_bool('SERVE_LEGACY_URLS')
     for name, func in api_impl.ROUTES: