Merge pull request #584 from pierotofy/timecost

Add --req-time-cost

.pre-commit-config.yaml

@@ -9,8 +9,6 @@ repos:
       name: " ✔️  Check TOML"
     - id: check-json
       name: " ✔️  Check JSON"
-    - id: trailing-whitespace
-      name: " ✂️  Trim trailing whitespaces"
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: v0.0.277
     hooks:

README.md

@@ -166,12 +166,13 @@ Arguments passed to the process or set via environment variables are split into
 ### Configuration Parameters
 
 | Argument                   | Description                                                                                                                                                                                                 | Default Parameter                     | Env. name                   |
-|-----------------------------|-------------------------------------------------------------------------------------------------------------| -------------------- |------------------------------|
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------- |
 | --host                     | Set host to bind the server to                                                                                                                                                                              | `127.0.0.1`                           | LT_HOST                     |
 | --port                     | Set port to bind the server to                                                                                                                                                                              | `5000`                                | LT_PORT                     |
 | --char-limit               | Set character limit                                                                                                                                                                                         | `No limit`                            | LT_CHAR_LIMIT               |
 | --req-limit                | Set maximum number of requests per minute per client (outside of limits set by api keys)                                                                                                                    | `No limit`                            | LT_REQ_LIMIT                |
 | --req-limit-storage        | Storage URI to use for request limit data storage. See [Flask Limiter](https://flask-limiter.readthedocs.io/en/stable/configuration.html)                                                                   | `memory://`                           | LT_REQ_LIMIT_STORAGE        |
+| --req-time-cost            | Considers a time cost (in seconds) for request limiting purposes. If a request takes 10 seconds and this value is set to 5, the request cost is either 2 or the actual request cost (whichever is greater). | `No time cost`                        | LT_REQ_TIME_COST            |
 | --batch-limit              | Set maximum number of texts to translate in a batch request                                                                                                                                                 | `No limit`                            | LT_BATCH_LIMIT              |
 | --ga-id                    | Enable Google Analytics on the API client page by providing an ID                                                                                                                                           | `Empty (no tracking)`                 | LT_GA_ID                    |
 | --frontend-language-source | Set frontend default language - source                                                                                                                                                                      | `auto`                                | LT_FRONTEND_LANGUAGE_SOURCE |

libretranslate/app.py

@@ -1,4 +1,5 @@
 import io
+import math
 import os
 import re
 import tempfile
@@ -219,6 +220,13 @@ def create_app(args):
 
         from flask_limiter import Limiter
 
+        def limits_cost():
+          req_cost = getattr(request, 'req_cost', 1)
+          if args.req_time_cost > 0:
+            return max(req_cost, int(math.ceil(getattr(request, 'duration', 0) / args.req_time_cost)))
+          else:
+            return req_cost
+
         limiter = Limiter(
             key_func=get_remote_address,
             default_limits=get_routes_limits(
@@ -226,7 +234,7 @@ def create_app(args):
             ),
             storage_uri=args.req_limit_storage,
             default_limits_deduct_when=lambda req: True, # Force cost to be called after the request
-            default_limits_cost=lambda: getattr(request, 'req_cost', 1)
+            default_limits_cost=limits_cost
         )
     else:
         from .no_limiter import Limiter
@@ -325,12 +333,19 @@ def create_app(args):
                 status = e.code
                 raise e
               finally:
-                duration = max(default_timer() - start_t, 0)
+                request.duration = max(default_timer() - start_t, 0)
-                measure_request.labels(request.path, status, ip, ak).observe(duration)
+                measure_request.labels(request.path, status, ip, ak).observe(request.duration)
                 g.dec()
           return measure_func
         else:
-          return func
+          @wraps(func)
+          def time_func(*a, **kw):
+            start_t = default_timer()
+            try:
+              return func(*a, **kw)
+            finally:
+              request.duration = max(default_timer() - start_t, 0)
+          return time_func
 
     @bp.errorhandler(400)
     def invalid_api(e):

libretranslate/default_values.py

@@ -81,6 +81,11 @@ _default_options_objects = [
         'default_value': -1,
         'value_type': 'int'
     },
+    {
+        'name': 'REQ_TIME_COST',
+        'default_value': -1,
+        'value_type': 'int'
+    },
     {
         'name': 'BATCH_LIMIT',
         'default_value': -1,

libretranslate/main.py

@@ -63,6 +63,13 @@ def get_args():
         metavar="<number>",
         help="Set the maximum number of request limit offences that a client can exceed before being banned. (%(default)s)",
     )
+    parser.add_argument(
+        "--req-time-cost",
+        default=DEFARGS['REQ_TIME_COST'],
+        type=int,
+        metavar="<number>",
+        help="Considers a time cost (in seconds) for request limiting purposes. If a request takes 10 seconds and this value is set to 5, the request cost is either 2 or the actual request cost (whichever is greater). (%(default)s)",
+    )
     parser.add_argument(
         "--batch-limit",
         default=DEFARGS['BATCH_LIMIT'],