|
| 1 | +import re |
| 2 | +import logging |
| 3 | +from functools import cache |
| 4 | +from typing import Callable |
| 5 | +import requests |
| 6 | + |
| 7 | +from localstack.utils.docker_utils import DOCKER_CLIENT |
| 8 | +from localstack.extensions.api import Extension, http |
| 9 | +from localstack.http import Request |
| 10 | +from localstack.utils.container_utils.container_client import ( |
| 11 | + PortMappings, |
| 12 | + SimpleVolumeBind, |
| 13 | +) |
| 14 | +from localstack.utils.net import get_addressable_container_host |
| 15 | +from localstack.utils.sync import retry |
| 16 | +from rolo import route |
| 17 | +from rolo.proxy import Proxy |
| 18 | +from rolo.routing import RuleAdapter, WithHost |
| 19 | + |
| 20 | +LOG = logging.getLogger(__name__) |
| 21 | +logging.basicConfig() |
| 22 | + |
| 23 | +# TODO: merge utils with code in TypeDB extension over time ... |
| 24 | + |
| 25 | + |
| 26 | +class ProxiedDockerContainerExtension(Extension): |
| 27 | + name: str |
| 28 | + """Name of this extension""" |
| 29 | + image_name: str |
| 30 | + """Docker image name""" |
| 31 | + container_name: str | None |
| 32 | + """Name of the Docker container spun up by the extension""" |
| 33 | + container_ports: list[int] |
| 34 | + """List of network ports of the Docker container spun up by the extension""" |
| 35 | + host: str | None |
| 36 | + """ |
| 37 | + Optional host on which to expose the container endpoints. |
| 38 | + Can be either a static hostname, or a pattern like `<regex("(.+\.)?"):subdomain>myext.<domain>` |
| 39 | + """ |
| 40 | + path: str | None |
| 41 | + """Optional path on which to expose the container endpoints.""" |
| 42 | + command: list[str] | None |
| 43 | + """Optional command (and flags) to execute in the container.""" |
| 44 | + |
| 45 | + request_to_port_router: Callable[[Request], int] | None |
| 46 | + """Callable that returns the target port for a given request, for routing purposes""" |
| 47 | + http2_ports: list[int] | None |
| 48 | + """List of ports for which HTTP2 proxy forwarding into the container should be enabled.""" |
| 49 | + |
| 50 | + volumes: list[SimpleVolumeBind] | None = (None,) |
| 51 | + """Optional volumes to mount into the container host.""" |
| 52 | + |
| 53 | + def __init__( |
| 54 | + self, |
| 55 | + image_name: str, |
| 56 | + container_ports: list[int], |
| 57 | + host: str | None = None, |
| 58 | + path: str | None = None, |
| 59 | + container_name: str | None = None, |
| 60 | + command: list[str] | None = None, |
| 61 | + request_to_port_router: Callable[[Request], int] | None = None, |
| 62 | + http2_ports: list[int] | None = None, |
| 63 | + volumes: list[SimpleVolumeBind] | None = None, |
| 64 | + ): |
| 65 | + self.image_name = image_name |
| 66 | + self.container_ports = container_ports |
| 67 | + self.host = host |
| 68 | + self.path = path |
| 69 | + self.container_name = container_name |
| 70 | + self.command = command |
| 71 | + self.request_to_port_router = request_to_port_router |
| 72 | + self.http2_ports = http2_ports |
| 73 | + self.volumes = volumes |
| 74 | + |
| 75 | + def update_gateway_routes(self, router: http.Router[http.RouteHandler]): |
| 76 | + if self.path: |
| 77 | + raise NotImplementedError( |
| 78 | + "Path-based routing not yet implemented for this extension" |
| 79 | + ) |
| 80 | + self.start_container() |
| 81 | + # add resource for HTTP/1.1 requests |
| 82 | + resource = RuleAdapter(ProxyResource(self)) |
| 83 | + if self.host: |
| 84 | + resource = WithHost(self.host, [resource]) |
| 85 | + router.add(resource) |
| 86 | + |
| 87 | + def on_platform_shutdown(self): |
| 88 | + self._remove_container() |
| 89 | + |
| 90 | + def _get_container_name(self) -> str: |
| 91 | + if self.container_name: |
| 92 | + return self.container_name |
| 93 | + name = f"ls-ext-{self.name}" |
| 94 | + name = re.sub(r"\W", "-", name) |
| 95 | + return name |
| 96 | + |
| 97 | + @cache |
| 98 | + def start_container(self) -> None: |
| 99 | + container_name = self._get_container_name() |
| 100 | + LOG.debug("Starting extension container %s", container_name) |
| 101 | + |
| 102 | + ports = PortMappings() |
| 103 | + for port in self.container_ports: |
| 104 | + ports.add(port) |
| 105 | + |
| 106 | + kwargs = {} |
| 107 | + if self.command: |
| 108 | + kwargs["command"] = self.command |
| 109 | + |
| 110 | + try: |
| 111 | + DOCKER_CLIENT.run_container( |
| 112 | + self.image_name, |
| 113 | + detach=True, |
| 114 | + remove=True, |
| 115 | + name=container_name, |
| 116 | + ports=ports, |
| 117 | + volumes=self.volumes, |
| 118 | + **kwargs, |
| 119 | + ) |
| 120 | + except Exception as e: |
| 121 | + LOG.debug("Failed to start container %s: %s", container_name, e) |
| 122 | + raise |
| 123 | + |
| 124 | + main_port = self.container_ports[0] |
| 125 | + container_host = get_addressable_container_host() |
| 126 | + |
| 127 | + def _ping_endpoint(): |
| 128 | + # TODO: allow defining a custom healthcheck endpoint ... |
| 129 | + response = requests.get( |
| 130 | + f"http://{container_host}:{main_port}/__admin/health" |
| 131 | + ) |
| 132 | + assert response.ok |
| 133 | + |
| 134 | + try: |
| 135 | + retry(_ping_endpoint, retries=40, sleep=1) |
| 136 | + except Exception as e: |
| 137 | + LOG.info("Failed to connect to container %s: %s", container_name, e) |
| 138 | + self._remove_container() |
| 139 | + raise |
| 140 | + |
| 141 | + LOG.debug("Successfully started extension container %s", container_name) |
| 142 | + |
| 143 | + def _remove_container(self): |
| 144 | + container_name = self._get_container_name() |
| 145 | + LOG.debug("Stopping extension container %s", container_name) |
| 146 | + DOCKER_CLIENT.remove_container( |
| 147 | + container_name, force=True, check_existence=False |
| 148 | + ) |
| 149 | + |
| 150 | + |
| 151 | +class ProxyResource: |
| 152 | + """ |
| 153 | + Simple proxy resource that forwards incoming requests from the |
| 154 | + LocalStack Gateway to the target Docker container. |
| 155 | + """ |
| 156 | + |
| 157 | + extension: ProxiedDockerContainerExtension |
| 158 | + |
| 159 | + def __init__(self, extension: ProxiedDockerContainerExtension): |
| 160 | + self.extension = extension |
| 161 | + |
| 162 | + @route("/<path:path>") |
| 163 | + def index(self, request: Request, path: str, *args, **kwargs): |
| 164 | + return self._proxy_request(request, forward_path=f"/{path}") |
| 165 | + |
| 166 | + def _proxy_request(self, request: Request, forward_path: str, *args, **kwargs): |
| 167 | + self.extension.start_container() |
| 168 | + |
| 169 | + port = self.extension.container_ports[0] |
| 170 | + container_host = get_addressable_container_host() |
| 171 | + base_url = f"http://{container_host}:{port}" |
| 172 | + proxy = Proxy(forward_base_url=base_url) |
| 173 | + |
| 174 | + # update content length (may have changed due to content compression) |
| 175 | + if request.method not in ("GET", "OPTIONS"): |
| 176 | + request.headers["Content-Length"] = str(len(request.data)) |
| 177 | + |
| 178 | + # make sure we're forwarding the correct Host header |
| 179 | + request.headers["Host"] = f"localhost:{port}" |
| 180 | + |
| 181 | + # forward the request to the target |
| 182 | + result = proxy.forward(request, forward_path=forward_path) |
| 183 | + |
| 184 | + return result |
0 commit comments