Refactor dockerfile and tiltfile to allow debug all go container in docker compose

Co-authored-by: Copilot <copilot@github.com>

Author: masterashu

.env.example

@@ -29,6 +29,11 @@ PG_USER=postgres
 PG_PASSWORD=postgres
 PG_DATABASE=postgres
 
+# Set to 1 for enabling go debugger in dockerfile and Tilt Setup
+DOCKER_GO_DEBUG_FLOW_API=
+DOCKER_GO_DEBUG_FLOW_WORKER=
+DOCKER_GO_DEBUG_FLOW_SNAPSHOT_WORKER=
+
 PEERDB_CATALOG_HOST=host.docker.internal
 PEERDB_CATALOG_PORT=9901
 PEERDB_CATALOG_USER=postgres
@@ -44,4 +49,4 @@ AWS_EC2_METADATA_DISABLED="true"
 MINIO_ROOT_USER=_peerdb_minioadmin
 MINIO_ROOT_PASSWORD=_peerdb_minioadmin
 
-TZ='UTC'
+TZ='UTC'

.vscode/launch.json

@@ -2,7 +2,7 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "Docker Go Debug",
+      "name": "Tilt Debug: Flow Worker",
       "type": "go",
       "request": "attach",
       "mode": "remote",
@@ -16,7 +16,43 @@
           "to": "/root/flow"
         }
       ],
-      "port": 40000,
+      "port": 4001,
+      "host": "127.0.0.1"
+    },
+    {
+      "name": "Tilt Debug: Flow Snapshot Worker",
+      "type": "go",
+      "request": "attach",
+      "mode": "remote",
+      "remotePath": "/root",
+      "debugAdapter": "dlv-dap",
+      "hideSystemGoroutines": true,
+      "showGlobalVariables": true,
+      "substitutePath": [
+        {
+          "from": "${workspaceFolder}/flow",
+          "to": "/root/flow"
+        }
+      ],
+      "port": 4002,
+      "host": "127.0.0.1"
+    },
+    {
+      "name": "Tilt Debug: Flow API",
+      "type": "go",
+      "request": "attach",
+      "mode": "remote",
+      "remotePath": "/root",
+      "debugAdapter": "dlv-dap",
+      "hideSystemGoroutines": true,
+      "showGlobalVariables": true,
+      "substitutePath": [
+        {
+          "from": "${workspaceFolder}/flow",
+          "to": "/root/flow"
+        }
+      ],
+      "port": 4003,
       "host": "127.0.0.1"
     }
   ]

Tiltfile

@@ -8,24 +8,25 @@ flow_ignore = ['flow/e2e/', 'flow/**/*_test.go']
 
 docker_build('flow-api', '.',
     dockerfile='stacks/flow.Dockerfile',
-    target='flow-api',
+    target='flow-api-debug' if os.getenv('DOCKER_GO_DEBUG_FLOW_API') == '1' else 'flow-api',
     only=['flow/', 'stacks/flow.Dockerfile'],
     ignore=flow_ignore,
     build_args={'PEERDB_VERSION_SHA_SHORT': os.getenv('PEERDB_VERSION_SHA_SHORT', 'unknown')},
 )
 
 docker_build('flow-worker', '.',
     dockerfile='stacks/flow.Dockerfile',
-    target='flow-worker-debug',
+    target='flow-worker-debug' if os.getenv('DOCKER_GO_DEBUG_FLOW_WORKER') == '1' else 'flow-worker',
     only=['flow/', 'stacks/flow.Dockerfile'],
-    build_args={'DEBUG_BUILD':'1'},
+    build_args={'DEBUG_BUILD': os.getenv('DOCKER_GO_DEBUG_FLOW_WORKER','')},
     ignore=flow_ignore,
 )
 
 docker_build('flow-snapshot-worker', '.',
     dockerfile='stacks/flow.Dockerfile',
-    target='flow-snapshot-worker',
+    target='flow-snapshot-worker-debug' if os.getenv('DOCKER_GO_DEBUG_FLOW_SNAPSHOT_WORKER') == '1' else 'flow-snapshot-worker',
     only=['flow/', 'stacks/flow.Dockerfile'],
+    build_args={'DEBUG_BUILD': os.getenv('DOCKER_GO_DEBUG_FLOW_SNAPSHOT_WORKER','')},
     ignore=flow_ignore,
 )
 

docker-compose-dev.yml

@@ -129,6 +129,7 @@ services:
       - 8112:8112
       - 8113:8113
       - 5732:5732
+      - 4003:40000
     environment:
       <<: [*catalog-config, *flow-worker-env, *minio-config]
       PEERDB_ALLOWED_TARGETS:
@@ -148,6 +149,8 @@ services:
       context: .
       dockerfile: stacks/flow.Dockerfile
       target: flow-snapshot-worker
+    ports:
+      - 4002:40000
     environment:
       <<: [*catalog-config, *flow-worker-env, *minio-config]
     depends_on:
@@ -162,7 +165,12 @@ services:
       dockerfile: stacks/flow.Dockerfile
       target: flow-worker
     ports:
-      - 40000:40000
+      - 4001:40000
+    # The below options were mentioned to be required, but it works without them, so leaving them commented out for now. If you run into issues with Delve, try uncommenting these.
+    # security_opt:
+    #   - "seccomp:unconfined"  # Required for Delve
+    # cap_add:
+    #   - SYS_PTRACE         # Required for Delve
     environment:
       <<: [*catalog-config, *flow-worker-env, *minio-config]
     extra_hosts:

stacks/flow.Dockerfile

@@ -37,14 +37,30 @@ RUN apk add --no-cache ca-certificates geos && \
 USER peerdb
 WORKDIR /home/peerdb
 COPY --from=builder --chown=peerdb /root/peer-flow .
+ENTRYPOINT [ "/home/peerdb/peer-flow" ]
+
+# Debug Image with Delve installed and the binary built with debug flags
+FROM flow-base AS flow-base-debug
+USER root
+COPY --from=builder /go/bin/dlv /usr/local/bin/dlv
+EXPOSE 40000
+ENTRYPOINT ["dlv", "--headless", "--continue", "--accept-multiclient", "--listen=:40000", "--api-version=2", "exec", "/home/peerdb/peer-flow", "--"]
 
 FROM flow-base AS flow-api
 
 ARG PEERDB_VERSION_SHA_SHORT
 ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
 
 EXPOSE 8112 8113
-ENTRYPOINT ["./peer-flow", "api", "--port", "8112", "--gateway-port", "8113"]
+CMD ["api", "--port", "8112", "--gateway-port", "8113"]
+
+FROM flow-base-debug AS flow-api-debug
+
+ARG PEERDB_VERSION_SHA_SHORT
+ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
+
+EXPOSE 8112 8113
+CMD ["api", "--port", "8112", "--gateway-port", "8113"]
 
 FROM flow-base AS flow-worker
 
@@ -54,28 +70,31 @@ ENV OTEL_EXPORTER_OTLP_COMPRESSION=gzip
 ARG PEERDB_VERSION_SHA_SHORT
 ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
 
-ENTRYPOINT ["./peer-flow", "worker"]
+CMD ["worker"]
+
+FROM flow-base-debug AS flow-worker-debug
+ENV OTEL_METRIC_EXPORT_INTERVAL=10000
+ENV OTEL_EXPORTER_OTLP_COMPRESSION=gzip
+ARG PEERDB_VERSION_SHA_SHORT
+ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
+CMD ["./peer-flow", "--", "worker"]
+
 
 FROM flow-base AS flow-snapshot-worker
 
 ARG PEERDB_VERSION_SHA_SHORT
 ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
-ENTRYPOINT ["./peer-flow", "snapshot-worker"]
+CMD ["snapshot-worker"]
 
+FROM flow-base-debug AS flow-snapshot-worker-debug
 
-FROM flow-base AS flow-worker-debug
-ENV OTEL_METRIC_EXPORT_INTERVAL=10000
-ENV OTEL_EXPORTER_OTLP_COMPRESSION=gzip
 ARG PEERDB_VERSION_SHA_SHORT
 ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
-USER root
-COPY --from=builder /go/bin/dlv /usr/local/bin/dlv
-USER peerdb
-EXPOSE 40000
-ENTRYPOINT ["dlv", "--headless", "--continue", "--accept-multiclient", "--listen=:40000", "--api-version=2", "exec", "./peer-flow", "--", "worker"]
+CMD ["snapshot-worker"]
+
 
 FROM flow-base AS flow-maintenance
 
 ARG PEERDB_VERSION_SHA_SHORT
 ENV PEERDB_VERSION_SHA_SHORT=${PEERDB_VERSION_SHA_SHORT}
-ENTRYPOINT ["./peer-flow", "maintenance"]
+CMD ["maintenance"]