From 6bef0c5b2f83c5e6710b0efb5ad685d6015ffa1f Mon Sep 17 00:00:00 2001
From: prathamesh0 <42446521+prathamesh0@users.noreply.github.com>
Date: Wed, 6 Dec 2023 10:41:10 +0530
Subject: [PATCH] Separate out GQL proxy server from uniswap-urbit stack (#681)

* Separate out uniswap gql proxy in a stack

* Use proxy server from watcher-ts

* Add a flag to enable/disable the proxy server

* Update env configuratoin for uniswap urbit app stack

* Update stack file for uniswap urbit app stack

* Fix env variables in instructions
---
 .../compose/docker-compose-proxy-server.yml   | 22 ++++++
 .../docker-compose-uniswap-interface.yml      | 13 ---
 .../data/config/proxy-server/run.sh           |  9 +++
 .../data/stacks/proxy-server/README.md        | 79 +++++++++++++++++++
 .../data/stacks/proxy-server/stack.yml        |  8 ++
 .../data/stacks/uniswap-urbit-app/README.md   | 28 +++++--
 .../data/stacks/uniswap-urbit-app/stack.yml   |  3 +
 7 files changed, 144 insertions(+), 18 deletions(-)
 create mode 100644 stack_orchestrator/data/compose/docker-compose-proxy-server.yml
 create mode 100755 stack_orchestrator/data/config/proxy-server/run.sh
 create mode 100644 stack_orchestrator/data/stacks/proxy-server/README.md
 create mode 100644 stack_orchestrator/data/stacks/proxy-server/stack.yml

diff --git a/stack_orchestrator/data/compose/docker-compose-proxy-server.yml b/stack_orchestrator/data/compose/docker-compose-proxy-server.yml
new file mode 100644
index 00000000..607e8d23
--- /dev/null
+++ b/stack_orchestrator/data/compose/docker-compose-proxy-server.yml
@@ -0,0 +1,22 @@
+version: "3.2"
+
+services:
+  proxy-server:
+    image: cerc/watcher-ts:local
+    restart: on-failure
+    working_dir: /app/packages/cli
+    environment:
+      ENABLE_PROXY: ${ENABLE_PROXY:-true}
+      PROXY_UPSTREAM: ${CERC_PROXY_UPSTREAM}
+      PROXY_ORIGIN_HEADER: ${CERC_PROXY_ORIGIN_HEADER}
+    command: ["sh", "-c", "./run.sh"]
+    volumes:
+      - ../config/proxy-server/run.sh:/app/packages/cli/run.sh
+    ports:
+      - "4000"
+    healthcheck:
+      test: ["CMD", "nc", "-v", "localhost", "4000"]
+      interval: 20s
+      timeout: 5s
+      retries: 15
+      start_period: 10s
diff --git a/stack_orchestrator/data/compose/docker-compose-uniswap-interface.yml b/stack_orchestrator/data/compose/docker-compose-uniswap-interface.yml
index 6d021961..85b71af2 100644
--- a/stack_orchestrator/data/compose/docker-compose-uniswap-interface.yml
+++ b/stack_orchestrator/data/compose/docker-compose-uniswap-interface.yml
@@ -12,19 +12,6 @@ services:
       - app_builds:/app-builds
       - ../config/uniswap-interface/build-app.sh:/app/build-app.sh
 
-  uniswap-gql-proxy:
-    image: cerc/uniswap-interface:local
-    restart: on-failure
-    command: ["bash", "-c", "yarn proxy-gql"]
-    ports:
-      - "4000"
-    healthcheck:
-      test: ["CMD", "nc", "-v", "localhost", "4000"]
-      interval: 20s
-      timeout: 5s
-      retries: 15
-      start_period: 10s
-
 volumes:
   app_builds:
   app_globs:
diff --git a/stack_orchestrator/data/config/proxy-server/run.sh b/stack_orchestrator/data/config/proxy-server/run.sh
new file mode 100755
index 00000000..9e8dc7f5
--- /dev/null
+++ b/stack_orchestrator/data/config/proxy-server/run.sh
@@ -0,0 +1,9 @@
+#!/bin/sh
+
+if [ "$ENABLE_PROXY" = "true" ]; then
+  echo "Proxy server enabled"
+  yarn proxy
+else
+  echo "Proxy server disabled, exiting"
+  exit 0
+fi
diff --git a/stack_orchestrator/data/stacks/proxy-server/README.md b/stack_orchestrator/data/stacks/proxy-server/README.md
new file mode 100644
index 00000000..f0ccdb0f
--- /dev/null
+++ b/stack_orchestrator/data/stacks/proxy-server/README.md
@@ -0,0 +1,79 @@
+# Proxy Server
+
+Instructions to setup and deploy a HTTP proxy server
+
+## Setup
+
+Clone required repository:
+
+```bash
+laconic-so --stack proxy-server setup-repositories --pull
+
+# If this throws an error as a result of being already checked out to a branch/tag in a repo, remove the repositories mentioned below and re-run the command
+```
+
+Build the container image:
+
+```bash
+laconic-so --stack proxy-server build-containers
+```
+
+## Create a deployment
+
+* First, create a spec file for the deployment, which will allow mapping the stack's ports and volumes to the host:
+
+  ```bash
+  laconic-so --stack proxy-server deploy init --output proxy-server-spec.yml
+  ```
+
+* Edit `network` in spec file to map container ports to same ports in host:
+
+  ```yml
+  ...
+  network:
+    ports:
+      proxy-server:
+        - '4000:4000'
+  ...
+  ```
+
+* Once you've made any needed changes to the spec file, create a deployment from it:
+
+  ```bash
+  laconic-so --stack proxy-server deploy create --spec-file proxy-server-spec.yml --deployment-dir proxy-server-deployment
+  ```
+
+* Inside the deployment directory, open the file `config.env` and set the following env variables:
+
+  ```bash
+  # Whether to run the proxy server (Optional) (Default: true)
+  ENABLE_PROXY=
+
+  # Upstream endpoint
+  # (Eg. https://api.example.org)
+  CERC_PROXY_UPSTREAM=
+
+  # Origin header to be used (Optional)
+  # (Eg. https://app.example.org)
+  CERC_PROXY_ORIGIN_HEADER=
+  ```
+
+## Start the stack
+
+Start the deployment:
+
+```bash
+laconic-so deployment --dir proxy-server-deployment start
+```
+
+* List and check the health status of the container using `docker ps`
+
+* The proxy server will now be listening at http://localhost:4000
+
+## Clean up
+
+To stop the service running in background:
+
+```bash
+laconic-so deployment --dir proxy-server-deployment stop
+```
diff --git a/stack_orchestrator/data/stacks/proxy-server/stack.yml b/stack_orchestrator/data/stacks/proxy-server/stack.yml
new file mode 100644
index 00000000..313a7f91
--- /dev/null
+++ b/stack_orchestrator/data/stacks/proxy-server/stack.yml
@@ -0,0 +1,8 @@
+version: "0.1"
+name: proxy-server
+repos:
+  - github.com/cerc-io/watcher-ts@v0.2.78
+containers:
+  - cerc/watcher-ts
+pods:
+  - proxy-server
diff --git a/stack_orchestrator/data/stacks/uniswap-urbit-app/README.md b/stack_orchestrator/data/stacks/uniswap-urbit-app/README.md
index 55a37338..7499f5fc 100644
--- a/stack_orchestrator/data/stacks/uniswap-urbit-app/README.md
+++ b/stack_orchestrator/data/stacks/uniswap-urbit-app/README.md
@@ -41,7 +41,7 @@ network:
   ports:
     urbit-fake-ship:
       - '8080:80'
-    uniswap-gql-proxy:
+    proxy-server:
       - '4000:4000'
     ipfs-glob-host:
       - '8081:8080'
@@ -64,7 +64,7 @@ laconic-so --stack uniswap-urbit-app deploy create --spec-file uniswap-urbit-app
 
 ## Set env variables
 
-Inside the deployment directory, open the file `config.env` and add variable for infura key :
+Inside the deployment directory, open the file `config.env` and set the following env variables:
 
   ```bash
   # External RPC endpoints
@@ -73,10 +73,28 @@ Inside the deployment directory, open the file `config.env` and add variable for
 
   # Uniswap API GQL Endpoint
   # Set this to GQL proxy server endpoint for uniswap app
-  # (Eg. http://localhost:4000/graphql)
+  # (Eg. http://localhost:4000/v1/graphql)
+  # (Eg. https://abc.xyz.com/v1/graphql)
   CERC_UNISWAP_GQL=
 
-  # Optional IPFS endpoints:
+  # Optional
+
+  # Whether to run the proxy GQL server
+  # (Disable only if proxy not required to be run) (Default: true)
+  ENABLE_PROXY=
+
+  # Proxy server configuration
+  # Used only if proxy is enabled
+
+  # Upstream API URL
+  # (Eg. https://api.example.org)
+  CERC_PROXY_UPSTREAM=https://api.uniswap.org
+
+  # Origin header to be used in the proxy
+  # (Eg. https://app.example.org)
+  CERC_PROXY_ORIGIN_HEADER=https://app.uniswap.org
+
+  # IPFS configuration
 
   # IFPS endpoint to host the glob file on
   # (Default: http://ipfs-glob-host:5001 pointing to in-stack IPFS node)
@@ -120,7 +138,7 @@ laconic-so deployment --dir uniswap-urbit-app-deployment start
 
 ## Clean up
 
-To stop all uniswap-urbit-app services running in the background, while preserving chain data:
+To stop all uniswap-urbit-app services running in the background, while preserving data:
 
 ```bash
 laconic-so deployment --dir uniswap-urbit-app-deployment stop
diff --git a/stack_orchestrator/data/stacks/uniswap-urbit-app/stack.yml b/stack_orchestrator/data/stacks/uniswap-urbit-app/stack.yml
index 1077b557..3f77098f 100644
--- a/stack_orchestrator/data/stacks/uniswap-urbit-app/stack.yml
+++ b/stack_orchestrator/data/stacks/uniswap-urbit-app/stack.yml
@@ -2,9 +2,12 @@ version: "0.1"
 name: uniswap-urbit-app
 repos:
   - github.com/cerc-io/uniswap-interface@laconic # TODO: Use release
+  - github.com/cerc-io/watcher-ts@v0.2.78
 containers:
   - cerc/uniswap-interface
+  - cerc/watcher-ts
   - cerc/urbit-globs-host
 pods:
   - uniswap-interface
+  - proxy-server
   - uniswap-urbit