Merge pull request #128 from codecov/ElioDiNino/debug-toolbar

feat: Support debug toolbar endpoint for development

Author: ElioDiNino

Dockerfile

@@ -18,6 +18,7 @@ ENV CODECOV_API_SCHEME=http
 ENV CODECOV_API_HOST_HEADER="%[req.hdr(Host)]"
 ENV CODECOV_API_ADMIN_ENABLED=false
 ENV CODECOV_API_ADMIN_PATH=admin
+ENV CODECOV_API_ADMIN_DEBUG_ENABLED=false
 ENV CODECOV_IA_HOST=api
 ENV CODECOV_IA_PORT=8000
 ENV CODECOV_IA_SCHEME=http
@@ -34,8 +35,8 @@ ENV CODECOV_GATEWAY_HTTP_PORT=8080
 ENV CODECOV_GATEWAY_HTTPS_PORT=8443
 ARG COMMIT_SHA
 ARG VERSION
-ENV BUILD_ID $COMMIT_SHA
-ENV BUILD_VERSION $VERSION
+ENV BUILD_ID=$COMMIT_SHA
+ENV BUILD_VERSION=$VERSION
 EXPOSE 8080
 EXPOSE 8443
 

README.md

@@ -18,6 +18,7 @@ CODECOV_API_SCHEME=http # The scheme on which to access the codecov api. http or
 CODECOV_API_HOST_HEADER="%[req.hdr(Host)]" # The host to send as the host header. Default passes through host. Useful to set for local envs.
 CODECOV_API_ADMIN_ENABLED=false # Enable/disable the admin endpoint proxy
 CODECOV_API_ADMIN_PATH=admin # The path for api's admin interface
+CODECOV_API_ADMIN_DEBUG_ENABLED=false # Enable/disable the admin path for Django's debug toolbar in local development
 CODECOV_IA_HOST=api
 CODECOV_IA_PORT=8000
 CODECOV_IA_SCHEME=http

config/codecov.map

@@ -3,6 +3,7 @@
 ^/static(\/.*)?$  be_api
 ^/internal(\/.*)?$  be_api
 ${API_ADMIN_PATH_PREFIX}^/${CODECOV_API_ADMIN_PATH}(\/.*)?$  be_api
+${API_ADMIN_DEBUG_PREFIX}^/__debug__(\/.*)?$  be_api
 ^/graphql(\/.*)?$  be_api
 ^/webhooks(\/.*)?$  be_api
 ^/frontend_health$  be_default

entrypoint.sh

@@ -97,6 +97,13 @@ _start_haproxy() {
       echo 'Codecov api admin endpoint proxy disabled'
       export API_ADMIN_PATH_PREFIX="# (disabled) "
   fi
+  if [ "$CODECOV_API_ADMIN_DEBUG_ENABLED" = "true" ]; then
+      echo 'Codecov api admin debug endpoint proxy enabled'
+      export API_ADMIN_DEBUG_PATH_PREFIX=""
+  else
+      echo 'Codecov api admin debug endpoint proxy disabled'
+      export API_ADMIN_DEBUG_PATH_PREFIX="# (disabled) "
+  fi
   envsubst < /etc/haproxy/codecov.map.template > /etc/haproxy/codecov.map
   MINIO_FILE=""
   if [ "$CODECOV_GATEWAY_MINIO_ENABLED" ] && [ "$routing_map" != "proxy" ]; then