fix: add localnet proxy to add Access-Control-Allow-Private-Network h…

…eader (#523) * fix: add localnet proxy to add Access-Control-Allow-Private-Network header * chore: fix audit
algorandfoundation · Jun 19, 2024 · 2267e9e · 2267e9e · github-actions · Jun 19, 2024
1 parent 872f6b1
commit 2267e9e
Show file tree

Hide file tree

Showing 15 changed files with 326 additions and 32 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/src/algokit/core/sandbox.py b/src/algokit/core/sandbox.py
@@ -56,6 +56,7 @@ def __init__(self, name: str = SANDBOX_BASE_NAME) -> None:
         self._latest_yaml = get_docker_compose_yml(name=f"algokit_{self.name}")
         self._latest_config_json = get_config_json()
         self._latest_algod_network_template = get_algod_network_template()
+        self._latest_proxy_config = get_proxy_config()
 
     @property
     def compose_file_path(self) -> Path:
@@ -73,6 +74,10 @@ def algod_config_file_path(self) -> Path:
     def algod_network_template_file_path(self) -> Path:
         return self.directory / "algod_network_template.json"
 
+    @property
+    def proxy_config_file_path(self) -> Path:
+        return self.directory / "nginx.conf"
+
     @classmethod
     def from_environment(cls) -> ComposeSandbox | None:
         try:
@@ -128,6 +133,8 @@ def compose_file_status(self) -> ComposeFileStatus:
             compose_content = self.compose_file_path.read_text()
             config_content = self.algod_config_file_path.read_text()
             algod_network_template_content = self.algod_network_template_file_path.read_text()
+            proxy_config_content = self.proxy_config_file_path.read_text()
+
         except FileNotFoundError:
             # treat as out of date if compose file exists but algod config doesn't
             # so that existing setups aren't suddenly reset
@@ -139,6 +146,7 @@ def compose_file_status(self) -> ComposeFileStatus:
                 compose_content == self._latest_yaml
                 and config_content == self._latest_config_json
                 and algod_network_template_content == self._latest_algod_network_template
+                and proxy_config_content == self._latest_proxy_config
             ):
                 return ComposeFileStatus.UP_TO_DATE
             else:
@@ -149,6 +157,7 @@ def write_compose_file(self) -> None:
         self.compose_file_path.write_text(self._latest_yaml)
         self.algod_config_file_path.write_text(self._latest_config_json)
         self.algod_network_template_file_path.write_text(self._latest_algod_network_template)
+        self.proxy_config_file_path.write_text(self._latest_proxy_config)
 
     def _run_compose_command(
         self,
@@ -424,6 +433,74 @@ def get_conduit_yaml() -> str:
 """
 
 
+def get_proxy_config(algod_port: int = DEFAULT_ALGOD_PORT, kmd_port: int = 4002) -> str:
+    return f"""worker_processes 1;
+
+events {{
+  worker_connections 1024;
+}}
+
+http {{
+  access_log off;
+
+  map $request_method$http_access_control_request_private_network $cors_allow_private_network {{
+    "OPTIONStrue" "true";
+    default "";
+  }}
+
+  add_header Access-Control-Allow-Private-Network $cors_allow_private_network;
+
+  upstream algod_api {{
+    zone upstreams 64K;
+    server algod:8080 max_fails=1 fail_timeout=2s;
+    keepalive 2;
+  }}
+
+  upstream kmd_api {{
+    zone upstreams 64K;
+    server algod:7833 max_fails=1 fail_timeout=2s;
+    keepalive 2;
+  }}
+
+  upstream indexer_api {{
+    zone upstreams 64K;
+    server indexer:8980 max_fails=1 fail_timeout=2s;
+    keepalive 2;
+  }}
+
+  server {{
+    listen {algod_port};
+
+    location / {{
+      proxy_set_header Host $host;
+      proxy_pass http://algod_api;
+      proxy_pass_header Server;
+    }}
+  }}
+
+  server {{
+    listen {kmd_port};
+
+    location / {{
+      proxy_set_header Host $host;
+      proxy_pass http://kmd_api;
+      proxy_pass_header Server;
+    }}
+  }}
+
+  server {{
+    listen 8980;
+
+    location / {{
+      proxy_set_header Host $host;
+      proxy_pass http://indexer_api;
+      proxy_pass_header Server;
+    }}
+  }}
+}}
+    """
+
+
 def get_docker_compose_yml(
     name: str = "algokit_sandbox",
     algod_port: int = DEFAULT_ALGOD_PORT,
@@ -437,8 +514,8 @@ def get_docker_compose_yml(
     container_name: "{name}_algod"
     image: {ALGORAND_IMAGE}
     ports:
-      - {algod_port}:8080
-      - {kmd_port}:7833
+      - 8080
+      - 7833
       - {tealdbg_port}:9392
     environment:
       START_KMD: 1
@@ -483,13 +560,29 @@ def get_docker_compose_yml(
     container_name: "{name}_indexer"
     image: {INDEXER_IMAGE}
     ports:
-      - "8980:8980"
+      - 8980
     restart: unless-stopped
     command: daemon --enable-all-parameters
     environment:
       INDEXER_POSTGRES_CONNECTION_STRING: "host=indexer-db port=5432 user=algorand password=algorand dbname=indexerdb sslmode=disable"
     depends_on:
       - conduit
+
+  proxy:
+    container_name: "{name}_proxy"
+    image: nginx:1.27.0-alpine
+    restart: unless-stopped
+    ports:
+      - {algod_port}:{algod_port}
+      - {kmd_port}:{kmd_port}
+      - 8980:8980
+    volumes:
+      - type: bind
+        source: ./nginx.conf
+        target: /etc/nginx/nginx.conf
+    depends_on:
+      - algod
+      - indexer
 """  # noqa: E501
 
 

diff --git a/tests/goal/test_goal.py b/tests/goal/test_goal.py
@@ -3,7 +3,13 @@
 from subprocess import CompletedProcess
 
 import pytest
-from algokit.core.sandbox import ALGOD_HEALTH_URL, get_algod_network_template, get_config_json, get_docker_compose_yml
+from algokit.core.sandbox import (
+    ALGOD_HEALTH_URL,
+    get_algod_network_template,
+    get_config_json,
+    get_docker_compose_yml,
+    get_proxy_config,
+)
 from pytest_httpx import HTTPXMock
 from pytest_mock import MockerFixture
 
@@ -43,6 +49,7 @@ def _setup_latest_dummy_compose(app_dir_mock: AppDirs) -> None:
     (app_dir_mock.app_config_dir / "sandbox" / "docker-compose.yml").write_text(get_docker_compose_yml())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_config.json").write_text(get_config_json())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_network_template.json").write_text(get_algod_network_template())
+    (app_dir_mock.app_config_dir / "sandbox" / "nginx.conf").write_text(get_proxy_config())
 
 
 @pytest.fixture()

diff --git a/tests/localnet/test_localnet_console.py b/tests/localnet/test_localnet_console.py
@@ -2,7 +2,7 @@
 from subprocess import CompletedProcess
 
 import pytest
-from algokit.core.sandbox import get_algod_network_template, get_config_json, get_docker_compose_yml
+from algokit.core.sandbox import get_algod_network_template, get_config_json, get_docker_compose_yml, get_proxy_config
 from pytest_mock import MockerFixture
 
 from tests.goal.test_goal import _normalize_output
@@ -25,6 +25,7 @@ def test_goal_console(
     (app_dir_mock.app_config_dir / "sandbox" / "docker-compose.yml").write_text(get_docker_compose_yml())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_config.json").write_text(get_config_json())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_network_template.json").write_text(get_algod_network_template())
+    (app_dir_mock.app_config_dir / "sandbox" / "nginx.conf").write_text(get_proxy_config())
 
     mocker.patch("algokit.core.proc.subprocess_run").return_value = CompletedProcess(
         ["docker", "exec"], 0, "STDOUT+STDERR"

diff --git a/tests/localnet/test_localnet_reset.py b/tests/localnet/test_localnet_reset.py
@@ -1,7 +1,7 @@
 import json
 
 import pytest
-from algokit.core.sandbox import get_algod_network_template, get_config_json, get_docker_compose_yml
+from algokit.core.sandbox import get_algod_network_template, get_config_json, get_docker_compose_yml, get_proxy_config
 
 from tests import get_combined_verify_output
 from tests.utils.app_dir_mock import AppDirs
@@ -52,6 +52,7 @@ def test_localnet_reset_with_existing_sandbox_with_up_to_date_config(app_dir_moc
     (app_dir_mock.app_config_dir / "sandbox" / "docker-compose.yml").write_text(get_docker_compose_yml())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_config.json").write_text(get_config_json())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_network_template.json").write_text(get_algod_network_template())
+    (app_dir_mock.app_config_dir / "sandbox" / "nginx.conf").write_text(get_proxy_config())
 
     result = invoke("localnet reset")
 
@@ -83,6 +84,7 @@ def test_localnet_reset_with_named_sandbox_config(app_dir_mock: AppDirs, proc_mo
     (app_dir_mock.app_config_dir / "sandbox_test" / "algod_network_template.json").write_text(
         get_algod_network_template()
     )
+    (app_dir_mock.app_config_dir / "sandbox_test" / "nginx.conf").write_text(get_proxy_config())
 
     result = invoke("localnet reset")
 
@@ -98,6 +100,7 @@ def test_localnet_reset_with_existing_sandbox_with_up_to_date_config_with_pull(a
     (app_dir_mock.app_config_dir / "sandbox" / "docker-compose.yml").write_text(get_docker_compose_yml())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_config.json").write_text(get_config_json())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_network_template.json").write_text(get_algod_network_template())
+    (app_dir_mock.app_config_dir / "sandbox" / "nginx.conf").write_text(get_proxy_config())
 
     result = invoke("localnet reset --update")
 

diff --git a/...lnet_reset.test_localnet_reset_with_existing_sandbox_with_out_of_date_config.approved.txt b/...lnet_reset.test_localnet_reset_with_existing_sandbox_with_out_of_date_config.approved.txt
@@ -33,8 +33,8 @@ services:
     container_name: "algokit_sandbox_algod"
     image: algorand/algod:latest
     ports:
-      - 4001:8080
-      - 4002:7833
+      - 8080
+      - 7833
       - 9392:9392
     environment:
       START_KMD: 1
@@ -79,13 +79,29 @@ services:
     container_name: "algokit_sandbox_indexer"
     image: algorand/indexer:latest
     ports:
-      - "8980:8980"
+      - 8980
     restart: unless-stopped
     command: daemon --enable-all-parameters
     environment:
       INDEXER_POSTGRES_CONNECTION_STRING: "host=indexer-db port=5432 user=algorand password=algorand dbname=indexerdb sslmode=disable"
     depends_on:
       - conduit
 
+  proxy:
+    container_name: "algokit_sandbox_proxy"
+    image: nginx:1.27.0-alpine
+    restart: unless-stopped
+    ports:
+      - 4001:4001
+      - 4002:4002
+      - 8980:8980
+    volumes:
+      - type: bind
+        source: ./nginx.conf
+        target: /etc/nginx/nginx.conf
+    depends_on:
+      - algod
+      - indexer
+
 {app_config}/sandbox/algod_config.json
 { "Version": 12, "GossipFanout": 1, "EndpointAddress": "0.0.0.0:8080", "DNSBootstrapID": "", "IncomingConnectionsLimit": 0, "Archival":true, "isIndexerActive":false, "EnableDeveloperAPI":true}
diff --git a/tests/localnet/test_localnet_reset.test_localnet_reset_without_existing_sandbox.approved.txt b/tests/localnet/test_localnet_reset.test_localnet_reset_without_existing_sandbox.approved.txt
@@ -25,8 +25,8 @@ services:
     container_name: "algokit_sandbox_algod"
     image: algorand/algod:latest
     ports:
-      - 4001:8080
-      - 4002:7833
+      - 8080
+      - 7833
       - 9392:9392
     environment:
       START_KMD: 1
@@ -71,10 +71,26 @@ services:
     container_name: "algokit_sandbox_indexer"
     image: algorand/indexer:latest
     ports:
-      - "8980:8980"
+      - 8980
     restart: unless-stopped
     command: daemon --enable-all-parameters
     environment:
       INDEXER_POSTGRES_CONNECTION_STRING: "host=indexer-db port=5432 user=algorand password=algorand dbname=indexerdb sslmode=disable"
     depends_on:
       - conduit
+
+  proxy:
+    container_name: "algokit_sandbox_proxy"
+    image: nginx:1.27.0-alpine
+    restart: unless-stopped
+    ports:
+      - 4001:4001
+      - 4002:4002
+      - 8980:8980
+    volumes:
+      - type: bind
+        source: ./nginx.conf
+        target: /etc/nginx/nginx.conf
+    depends_on:
+      - algod
+      - indexer
diff --git a/tests/localnet/test_localnet_start.py b/tests/localnet/test_localnet_start.py
@@ -9,6 +9,7 @@
     get_algod_network_template,
     get_config_json,
     get_docker_compose_yml,
+    get_proxy_config,
 )
 from pytest_httpx import HTTPXMock
 
@@ -142,6 +143,7 @@ def test_localnet_start_up_to_date_definition(app_dir_mock: AppDirs) -> None:
     (app_dir_mock.app_config_dir / "sandbox" / "docker-compose.yml").write_text(get_docker_compose_yml())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_config.json").write_text(get_config_json())
     (app_dir_mock.app_config_dir / "sandbox" / "algod_network_template.json").write_text(get_algod_network_template())
+    (app_dir_mock.app_config_dir / "sandbox" / "nginx.conf").write_text(get_proxy_config())
 
     result = invoke("localnet start")
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	4	4	0%	1–7
src/algokit/cli
__init__.py	47	3	94%	31–34
codespace.py	50	9	82%	28, 114, 137, 150–155
completions.py	108	9	92%	63–64, 83, 93–99
dispenser.py	121	1	99%	77
doctor.py	53	3	94%	146–148
explore.py	50	12	76%	34–39, 41–46
generate.py	70	3	96%	76–77, 155
goal.py	47	1	98%	79
init.py	309	24	92%	493–494, 499–500, 503, 524, 527–529, 540, 544, 602, 628, 657, 690, 699–701, 704–709, 722, 741, 753–754
localnet.py	152	32	79%	65, 86–113, 133–137, 170, 182, 197–207, 220, 271, 292–293
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	26	2	92%	120, 123
src/algokit/cli/project
bootstrap.py	32	1	97%	33
deploy.py	99	20	80%	47, 49, 101, 124, 146–148, 227, 234, 248–256, 259–268
link.py	89	16	82%	60, 65–66, 101–105, 115–120, 148–149, 218–219, 223
list.py	33	5	85%	21–23, 51–56
run.py	46	3	93%	38, 71, 160
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	66	4	94%	48, 70, 91, 250
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	99	45	55%	26–34, 40–43, 75–76, 100–101, 125–133, 152–162, 209, 258–259, 279–290, 297–299
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
codespace.py	175	68	61%	34–37, 41–44, 48–71, 111–112, 125–133, 191, 200–202, 210, 216–217, 229–236, 251–298, 311–313, 338–344, 348, 395
conf.py	57	9	84%	12, 24, 28, 36, 38, 73–75, 80
dispenser.py	202	26	87%	91, 123–124, 141–149, 191–192, 198–200, 218–219, 259–260, 318, 332–334, 345–346, 356, 369, 384
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	48	3	94%	44, 81, 99
goal.py	65	4	94%	21, 36–37, 47
init.py	67	10	85%	53, 57–62, 70, 81, 88, 108–109
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	99
sandbox.py	261	23	91%	32, 89–92, 97, 101–103, 153, 201–208, 219, 595, 611, 636, 644
typed_client_generation.py	170	20	88%	62–64, 103–108, 132, 135–138, 156, 159–162, 229, 232–235
utils.py	148	40	73%	50–51, 57–69, 125–131, 155, 158, 164–177, 198–200, 229–232, 254
src/algokit/core/compilers
python.py	28	5	82%	19–20, 25, 49–50
src/algokit/core/config_commands
container_engine.py	41	21	49%	24, 29–31, 47–76
version_prompt.py	92	14	85%	37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/project
__init__.py	53	3	94%	50, 86, 145
bootstrap.py	120	8	93%	47, 126–127, 149, 176, 207–209
deploy.py	54	9	83%	61–64, 73–75, 79, 84
run.py	125	15	88%	83, 88, 97–98, 133–134, 138–139, 143, 147, 261–269, 284
src/algokit/core/tasks
analyze.py	93	3	97%	105–112, 187
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	78	10	87%	123–133, 187
models.py	90	11	88%	50, 52, 57, 71–74, 85–88
TOTAL	4632	640	86%