Improvements around running the API locally.

Author: elliotcourant

.helmignore

@@ -25,3 +25,4 @@ node_modules
 generated
 tools
 pkg
+*.sock

Makefile.local

@@ -13,7 +13,6 @@ JQ=jq
 KUBECTL=kubectl
 SPLIT_YAML=kubernetes-split-yaml
 SSHFS=sshfs
-TELEPRESENCE=telepresence
 YQ=yq
 
 # This is the domain that is used for local development. You can change it to anything you want here and run init-mini
@@ -158,6 +157,7 @@ init-mini-values: $(LOGIN_JWT_SECRET) $(REGISTER_JWT_SECRET)
 	yq e '.ingress.annotations."kubernetes.io/ingress.class" = "nginx"' -i $(VALUES)
 	yq e '.ingress.hosts[0].host = "api.$(LOCAL_DOMAIN)"' -i $(VALUES)
 	yq e '.ingress.hosts[0].paths[0] = {"path": "/"}' -i $(VALUES)
+	yq e '.service.port = 4000' -i $(VALUES)
 	yq e '.api.includeSecrets = true' -i $(VALUES)
 	yq e '.api.uiDomainName = "app.$(LOCAL_DOMAIN)"' -i $(VALUES)
 	yq e '.api.apiDomainName = "api.$(LOCAL_DOMAIN)"' -i $(VALUES)
@@ -198,16 +198,14 @@ deploy-postgres:
 	$(KUBECTL) apply -f $(PWD)/minikube/postgres.yaml --namespace $(MINIKUBE_NAMESPACE)
 	$(KUBECTL) rollout status deploy/postgres --namespace $(MINIKUBE_NAMESPACE) --timeout=30s
 
-deploy-web-ui:
-	$(KUBECTL) apply -f $(PWD)/minikube/web-ui.yaml --namespace $(MINIKUBE_NAMESPACE)
-	$(KUBECTL) rollout status deploy/web-ui --namespace $(MINIKUBE_NAMESPACE) --timeout=30s
 
 deploy-mini-application: $(VALUES) $(LOCAL_REST_API_DEPLOY) build-rest-api-mini
 	$(eval CONFIG_HASH = $(shell md5 -q $(VALUES)))
 	CONFIG_HASH=$(CONFIG_HASH) $(YQ) e '.podAnnotations.configHash = strenv(CONFIG_HASH)' -i $(VALUES)
 	$(HELM) template $(REST_API_IMAGE_NAME) $(PWD) \
  		--dry-run \
  		--values=$(VALUES) | $(SPLIT_YAML) --outdir $(LOCAL_REST_API_DEPLOY) -
+	$(KUBECTL) delete svc/$(REST_API_IMAGE_NAME) --namespace $(MINIKUBE_NAMESPACE)
 	$(KUBECTL) apply -f $(LOCAL_REST_API_DEPLOY) --namespace $(MINIKUBE_NAMESPACE)
 	$(KUBECTL) rollout status deploy/rest-api --namespace $(MINIKUBE_NAMESPACE) --timeout=30s
 
@@ -218,7 +216,6 @@ local-dependencies-maybe:
 	which $(HELM) || make dependencies-helm
 	which $(SPLIT_YAML) || make dependencies-split-yaml
 	which $(YQ) || make dependencies-yq
-	make dependencies-telepresence # We always want to use our version to make sure it'll work properly.
 
 MINIKUBE_VERSION=latest
 dependencies-minikube:
@@ -252,25 +249,14 @@ dependencies-yq:
 	mv $(YQ_DIR)/$(YQ)_$(OS)_$(ARCH) $(LOCAL_BIN)/$(YQ)
 	rm -rf $(YQ_DIR) || true
 
-TELEPRESENCE_VERSION=0.109
-TELEPRESENCE_URL=https://github.com/telepresenceio/telepresence/archive/refs/tags/$(TELEPRESENCE_VERSION).tar.gz
-TELEPRESENCE_DIR=$(LOCAL_TMP)/$(TELEPRESENCE)
-dependencies-telepresence:
-	rm -rf $(TELEPRESENCE_DIR).tar.gz || true
-	rm -rf $(TELEPRESENCE_DIR) || true
-	mkdir -p $(TELEPRESENCE_DIR)
-	curl -L -s $(TELEPRESENCE_URL) -o $(TELEPRESENCE_DIR).tar.gz
-	tar -xzf $(TELEPRESENCE_DIR).tar.gz -C $(TELEPRESENCE_DIR)
-	PREFIX=$(PWD) $(TELEPRESENCE_DIR)/$(TELEPRESENCE)-$(TELEPRESENCE_VERSION)/install.sh
-	rm -rf $(TELEPRESENCE_DIR).tar.gz || true
-	rm -rf $(TELEPRESENCE_DIR) || true
-
-
 ###################### DEBUGGING THE REST API ##################################
-debug-api-mini:
-	tmux \
-		new-session  '$(TELEPRESENCE) --method=inject-tcp --swap-deployment rest-api --expose 4000 --local-cluster' \; \
-		split-window 'minikube tunnel' \;
+LOCAL_IP=$(shell ifconfig | grep -E "([0-9]{1,3}\.){3}[0-9]{1,3}" | grep -v 127.0.0.1 | awk '{ print $$2 }' | cut -f2 -d: | head -n1)
+local-api:
+	LOCAL_IP=$(LOCAL_IP) $(YQ) e '.subsets[0].addresses[0].ip = strenv(LOCAL_IP)' $(PWD)/minikube/api-endpoint.yaml | $(KUBECTL) apply -f -
+	$(KUBECTL) get svc/$(REST_API_IMAGE_NAME) -n $(MINIKUBE_NAMESPACE) -o yaml | $(YQ) e 'del(.spec.selector)' - | $(KUBECTL) apply -f -
+	tmux new-session 'minikube tunnel' || true
+	$(KUBECTL) delete svc/$(REST_API_IMAGE_NAME) --namespace $(MINIKUBE_NAMESPACE)
+	$(KUBECTL) apply -f $(LOCAL_REST_API_DEPLOY) --namespace $(MINIKUBE_NAMESPACE)
 
 ###################### WORKING ON WEBHOOKS LOCALLY ##################################
 webhooks-mini:

README.md

@@ -58,76 +58,19 @@ make deploy-mini-application
 This will build a new docker image from your current code as well as evaluate any changes made to the `values.local.yaml`
 file in your project directory and push those changes to minikube.
 
-If you want to do step debugging you can use a tool called telepresence. The shorthand make target below will spawn a new
-tmux session with both `minikube tunnel` and `telepresence` running side by side. This is because on their own I've found
-that telepresence does not always tunnel traffic properly. And minikube has no way to send traffic from its cluster to
-a local target. This will do both.
+If you want to do step debugging there is a shortcut in the makefile to do so. You will need to create a `config.yaml`
+file in your project directory with all the same settings you have specified in your `values.local.yaml` for everything
+to work properly. Once you have done that you can run the command below:
 
 ```bash
-make debug-api-mini
+make local-api
 ```
 
-Which will let you run the REST API on your actual computer and serve requests from minikube there. This means you can
-run the REST API in GoLand or VSCode and use a step debugger to debug requests. There is a caveat with doing this though;
-configuration is primarily provided to the REST API service in Kubernetes via environment variables. So you may need to
-make a `config.yaml` file in your project directory and add any configuration options there in order to run the service
-properly. More documentation on that file will be added at a later date.
-
-You'll need to install macFUSE and SSHFS from the installer packages here: https://osxfuse.github.io/
-
-
-You may see an error like the following in the tmux session that is started:
-```
-T: Warning: kubectl 1.21.0 may not work correctly with cluster version 1.18.15 due to the version discrepancy. See https://kubernetes.io/docs/setup/version-skew-policy/ for more information.
-
-T: Using a Pod instead of a Deployment for the Telepresence proxy. If you experience problems, please file an issue!
-T: Set the environment variable TELEPRESENCE_USE_DEPLOYMENT to any non-empty value to force the old behavior, e.g.,
-T:     env TELEPRESENCE_USE_DEPLOYMENT=1 telepresence --run curl hello
-
-T: Starting proxy with method 'inject-tcp', which has the following limitations: Go programs, static binaries, suid programs, and custom DNS implementations are not supported. For a full list of method limitations see
-T: https://telepresence.io/reference/methods.html
-T: Volumes are rooted at $TELEPRESENCE_ROOT. See https://telepresence.io/howto/volumes.html for details.
-T: Starting network proxy to cluster by swapping out Deployment rest-api with a proxy Pod
-T: Forwarding remote port 9000 to local port 9000.
-T: Forwarding remote port 4000 to local port 4000.
-
-
-Looks like there's a bug in our code. Sorry about that!
-
-Traceback (most recent call last):
-  File "/Users/elliotcourant/monetr/rest-api/bin/telepresence/telepresence/cli.py", line 135, in crash_reporting
-    yield
-  File "/Users/elliotcourant/monetr/rest-api/bin/telepresence/telepresence/main.py", line 81, in main
-    user_process = launch(
-  File "/Users/elliotcourant/monetr/rest-api/bin/telepresence/telepresence/outbound/setup.py", line 64, in launch
-    return launch_inject(runner_, command, socks_port, env)
-  File "/Users/elliotcourant/monetr/rest-api/bin/telepresence/telepresence/outbound/local.py", line 120, in launch_inject
-    torsocks_env = set_up_torsocks(runner, socks_port)
-  File "/Users/elliotcourant/monetr/rest-api/bin/telepresence/telepresence/outbound/local.py", line 71, in set_up_torsocks
-    raise RuntimeError("SOCKS network proxying failed to start...")
-RuntimeError: SOCKS network proxying failed to start...
-
-
-Here are the last few lines of the logfile (see /Users/elliotcourant/monetr/rest-api/telepresence.log for the complete logs):
-
-  17.8 TEL | [114] exit -11 in 0.05 secs.
-  17.9 TEL | [115] Running: torsocks python3 -c 'import socket; socket.socket().connect(('"'"'kubernetes.default'"'"', 443))'
-  17.9 TEL | [115] exit -11 in 0.05 secs.
-  18.0 TEL | [116] Running: torsocks python3 -c 'import socket; socket.socket().connect(('"'"'kubernetes.default'"'"', 443))'
-  18.0 TEL | [116] exit -11 in 0.05 secs.
-  18.2 TEL | [117] Running: torsocks python3 -c 'import socket; socket.socket().connect(('"'"'kubernetes.default'"'"', 443))'
-  18.2 TEL | [117] exit -11 in 0.05 secs.
-  18.3 TEL | [118] Running: torsocks python3 -c 'import socket; socket.socket().connect(('"'"'kubernetes.default'"'"', 443))'
-  18.3 TEL | [118] exit -11 in 0.05 secs.
-  18.5 TEL | [119] Running: torsocks python3 -c 'import socket; socket.socket().connect(('"'"'kubernetes.default'"'"', 443))'
-  18.5 TEL | [119] exit -11 in 0.04 secs.
-  18.5 TEL | END SPAN local.py:42(set_up_torsocks)   15.0s
-
-Would you like to file an issue in our issue tracker? You'll be able to review and edit before anything is posted to the public. We'd really appreciate the help improving our product. [Y/n]:
-```
-
-If you do, **do not enter `n` or exit telepresence**. Chances are it actually did work and is tunneling TCP traffic like
-we want it to.
+This will spawn a new tmux window with a minikube tunnel in it. This is needed for the API to talk to the services it
+needs within the minikube cluster.
+This will also swap out the target for the API service in kubernetes with an endpoint pointed at your computer and at port
+4000. This way you can run a REST API instance locally through something like GoLand or VSCode and step debug API
+requests directly.
 
 ### Testing Webhooks
 

minikube/api-endpoint.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Endpoints
+metadata:
+  name: rest-api
+subsets:
+  - addresses:
+      - ip: 0.0.0.0
+    ports:
+      - port: 4000
+        name: http
+        protocol: TCP

minikube/web-ui.yaml

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"github.com/getsentry/sentry-go"
 	"github.com/go-pg/pg/v10"
+	"github.com/kataras/iris/v12"
 	"github.com/monetrapp/rest-api/pkg/application"
 	"github.com/monetrapp/rest-api/pkg/cache"
 	"github.com/monetrapp/rest-api/pkg/config"
@@ -15,6 +16,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/stripe/stripe-go/v72"
 	stripe_client "github.com/stripe/stripe-go/v72/client"
+	"net"
 	"net/http"
 	"os"
 	"time"
@@ -143,6 +145,24 @@ func RunServer() error {
 		stripeClient,
 	)...)
 
-	// TODO Allow listen port to be changed via config.
-	return app.Listen(":4000")
+	unixSocket := false
+
+	if unixSocket {
+		workingDirectory, err := os.Getwd()
+		if err != nil {
+			panic(err)
+		}
+		listener, err := net.ListenUnix("unix", &net.UnixAddr{
+			Name: workingDirectory + "/api.sock",
+			Net: "unix",
+		})
+		if err != nil {
+			panic(err)
+		}
+
+		return app.Run(iris.Listener(listener))
+	} else {
+		// TODO Allow listen port to be changed via config.
+		return app.Listen(":4000")
+	}
 }