foca-plugin-generic-routing-random 0.1.0__py3-none-any.whl

foca_plugin_generic_routing_random-0.1.0.dist-info/METADATA

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: foca-plugin-generic-routing-random
+Version: 0.1.0
+Summary: FOCA gateway plugin that routes requests to the backends in random order
+Author-email: ELIXIR On-Cloud <cloud-service@elixir-europe.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/elixir-cloud-aai/foca-plugins/tree/dev/plugins/generic/routing/random
+Project-URL: Documentation, https://foca-plugins.readthedocs.io/
+Project-URL: Changelog, https://github.com/elixir-cloud-aai/foca-plugins/blob/dev/plugins/generic/routing/random/CHANGELOG.md
+Project-URL: Issues, https://github.com/elixir-cloud-aai/foca-plugins/issues
+Keywords: foca,foca-plugin,gateway,ga4gh
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: foca<0.19,>=0.18.0
+Requires-Dist: pydantic<3,>=2.7
+Dynamic: license-file
+
+# generic.routing.random
+
+<!-- --8<-- [start:summary] -->
+Routes requests to the candidate backends in random order, so that they
+spread over all backends without round-robin state. The successor of
+proTES's random task distribution.
+<!-- --8<-- [end:summary] -->
+
+| | |
+| --- | --- |
+| Plugin ID | `generic.routing.random` |
+| Distribution | `foca-plugin-generic-routing-random` |
+| Import path | `foca_plugins.generic.routing.random` |
+| APIs | all (`*`) |
+| Phases | `route` |
+| Maturity | experimental |
+| Data transfers | none |
+| FOCA | 0.18 (`>=0.18.0,<0.19`) |
+
+## What it does
+
+- `route`: returns all candidate backends, shuffled with the operating
+  system's randomness (`random.SystemRandom`). It drops no candidate and
+  adds none; the gateway then tries them in that order. It records the
+  annotations `candidates` (their number) and `seeded` (whether a seed was
+  used).
+
+It never rejects a request and never raises `NotApplicable`. The order
+itself is in the provenance of each request (`route.candidates_out`), so
+the plugin doesn't record it again.
+
+FOCA's default router, `foca.routing.ordered`, keeps the order of the
+backend list and shuffles only the backends of each service registry among
+themselves. This plugin shuffles all candidates, configured or discovered.
+
+## Configuration
+
+Admin settings, in the gateway app's configuration (FOCA's `plugins`
+section):
+
+```yaml
+plugins:
+  available:
+    generic.routing.random:
+      distribution: foca-plugin-generic-routing-random
+      config:
+        allow_seed: false  # default; true only for tests
+  pipeline:
+    - id: route
+      alternatives:
+        - plugin: generic.routing.random
+```
+
+| Setting | Type | Default | Description |
+| --- | --- | --- | --- |
+| `config.allow_seed` | boolean | `false` | whether pipelines may set `seed` |
+| `params.seed` | integer or `null` | `null` | seed of the shuffling, for reproducible orders in tests; refused (when pipelines are resolved) unless `allow_seed` is set |
+
+With a seed, the order is a function of the seed and the candidate list,
+on the same Python version (Python doesn't promise the same shuffles
+across versions). Seeded orders are predictable, also for clients that
+choose the plugin in their own pipelines: keep `allow_seed` off in
+production. A test setup:
+
+```yaml
+plugins:
+  available:
+    generic.routing.random:
+      config:
+        allow_seed: true  # tests only
+  pipeline:
+    - id: route
+      alternatives:
+        - plugin: generic.routing.random
+          params:
+            seed: 42
+```
+
+### proTES's old default
+
+proTES used to try distance-based routing first and fall back to random
+routing. The same pipeline with plugins, once distance routing
+([`tes.routing.distance`](https://github.com/elixir-cloud-aai/foca-plugins/issues/8))
+is released:
+
+```yaml
+plugins:
+  pipeline:
+    - id: route
+      alternatives:
+        - plugin: tes.routing.distance
+        - plugin: generic.routing.random
+```
+
+## Installation
+
+```bash
+pip install foca-plugin-generic-routing-random
+```
+
+See "Installing" in the docs for release trains and derived images.
+
+## Development
+
+From the repository root, with the development environment set up (see
+"Contributing" in the docs):
+
+```bash
+uv run ruff check plugins/generic/routing/random
+uv run python -m scripts.packages mypy plugins/generic/routing/random
+uv run coverage run --source plugins/generic/routing/random/src \
+  -m pytest plugins/generic/routing/random
+uv run coverage report
+```
+
+## Changelog
+
+See [`CHANGELOG.md`](CHANGELOG.md).

foca_plugin_generic_routing_random-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+foca_plugin_generic_routing_random-0.1.0.dist-info/licenses/LICENSE,sha256=P7yNyja8VO8RxCeuoGyopv3TBs5r-H4H3pF-HjInpRw,11345
+foca_plugins/generic/routing/random/__init__.py,sha256=phlLrnOzr7G5ISlorUsghmEEtGcwyf1gmnJhG6BrvXo,4531
+foca_plugins/generic/routing/random/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foca_plugin_generic_routing_random-0.1.0.dist-info/METADATA,sha256=-Rfn1iVBJZLXMtjQp5aE4kntF6vtI50S4TbSLozIwwM,4890
+foca_plugin_generic_routing_random-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+foca_plugin_generic_routing_random-0.1.0.dist-info/entry_points.txt,sha256=CXn-IRNFvPenqSE51rjmZI7p7-AaxWQASK73BP7B9sI,83
+foca_plugin_generic_routing_random-0.1.0.dist-info/top_level.txt,sha256=a5sIt4LiiO_GQ8yz2_W3rZ2fNeBRwITeFqOWdgXdF5w,13
+foca_plugin_generic_routing_random-0.1.0.dist-info/RECORD,,

foca_plugin_generic_routing_random-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

foca_plugin_generic_routing_random-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[foca.plugins]
+generic.routing.random = foca_plugins.generic.routing.random:Random

foca_plugin_generic_routing_random-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ELIXIR On-Cloud
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

foca_plugin_generic_routing_random-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+foca_plugins

foca_plugins/generic/routing/random/__init__.py

@@ -0,0 +1,141 @@
+"""Plugin `generic.routing.random`: route to the candidates in random order.
+
+The successor of proTES's random task distribution
+(`TaskDistributionRandom`): the route step returns all candidate backends,
+shuffled, so that requests spread over them without round-robin state.
+Gateways then try the candidates in that order (cf. FOCA's forwarding).
+
+FOCA's default router `foca.routing.ordered` keeps the order of the
+backend list and shuffles only the backends of each service registry among
+themselves; this plugin shuffles all candidates, configured or discovered.
+
+The plugin API is documented in FOCA's `docs/plugins.md`
+(https://foca.readthedocs.io/en/latest/plugins/).
+"""
+
+from collections.abc import Sequence
+import random
+
+from foca.plugins import Backend, Context, InvalidParams, Plugin
+from pydantic import BaseModel, ConfigDict, StrictInt
+
+
+class RandomConfig(BaseModel):
+    """Admin settings (`plugins.available."generic.routing.random".config`).
+
+    Attributes:
+        allow_seed: Whether pipelines may set a `seed` (for tests only:
+            seeded orders are predictable, also for clients that choose the
+            plugin in their own pipelines).
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    allow_seed: bool = False
+
+
+class RandomParams(BaseModel):
+    """Parameters of the plugin in a pipeline step.
+
+    Attributes:
+        seed: Seed of the shuffling, for reproducible orders in tests; an
+            integer (no booleans, floats or strings), refused unless
+            `allow_seed` is set. Without a seed, the order comes from the
+            operating system's randomness (`random.SystemRandom`).
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    seed: StrictInt | None = None
+
+
+class Random(Plugin[RandomConfig, RandomParams]):
+    """Route to the candidates in random order.
+
+    Attributes:
+        allow_seed: Whether pipelines may set a `seed`
+            (`RandomConfig.allow_seed`).
+    """
+
+    Config = RandomConfig
+    Params = RandomParams
+    apis = frozenset({"*"})
+    maturity = "experimental"
+    description = (
+        "Returns all candidate backends in random order, so that requests"
+        " spread over them; with a seed (if the admin allows it, for tests),"
+        " the order depends only on the seed and the order of the candidates"
+        " (on the same Python version)."
+    )
+
+    # Set by `setup()`, from the admin settings
+    allow_seed: bool
+
+    def setup(self, config: RandomConfig) -> None:
+        """Keep the admin settings; idempotent, as it may run more than once.
+
+        Args:
+            config: Validated admin settings.
+        """
+        self.allow_seed = config.allow_seed
+
+    def check_params(self, params: RandomParams) -> None:
+        """Refuse seeds unless the admin settings allow them.
+
+        Args:
+            params: Validated parameters of a pipeline step.
+
+        Raises:
+            InvalidParams: A seed is set, but not allowed.
+        """
+        if params.seed is not None and not self.allow_seed:
+            raise InvalidParams("'seed' is not allowed (cf. 'allow_seed')")
+
+    def on_route(self, candidates: Sequence[Backend], ctx: Context) -> list[Backend]:
+        """Shuffle the candidate backends.
+
+        Args:
+            candidates: Candidate backends, in order.
+            ctx: Context of the call.
+
+        Returns:
+            All candidates, in random order (a new list).
+        """
+        seed = _params(ctx).seed
+        shuffled = list(candidates)
+        _rng(seed).shuffle(shuffled)
+        ctx.record("candidates", len(shuffled))
+        ctx.record("seeded", seed is not None)
+        return shuffled
+
+
+def _rng(seed: int | None) -> random.Random:
+    """Create the random number generator of a call.
+
+    Args:
+        seed: Seed, or `None` for the operating system's randomness.
+
+    Returns:
+        `random.SystemRandom` without a seed, else `random.Random(seed)`.
+    """
+    if seed is None:
+        return random.SystemRandom()
+    return random.Random(seed)  # noqa: S311 (seeded for tests only)
+
+
+def _params(ctx: Context) -> RandomParams:
+    """Get the parameters of the call, with their type.
+
+    Args:
+        ctx: Context of the call; the engine has validated its parameters
+            with `RandomParams`.
+
+    Returns:
+        Parameters.
+
+    Raises:
+        TypeError: The parameters are of another model.
+    """
+    if not isinstance(ctx.params, RandomParams):
+        raise TypeError(f"Unexpected parameters: {type(ctx.params).__name__}")
+    return ctx.params