fix(docker compose): make ports optional #5500

jessicasingh7 · 2025-09-25T20:51:05Z

Description

[Provide a brief description of the changes in this PR]

How Has This Been Tested?

[Describe the tests you ran to verify your changes]

Additional Options

[Optional] Override Linear Check

vercel · 2025-09-25T20:51:10Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
internal-search	Ready	Preview	Comment	Sep 25, 2025 9:35pm

greptile-apps

Greptile Overview

Summary

This PR makes Docker Compose port mappings optional by using environment variables, allowing more flexible deployment configurations. The changes include:

Modified docker-compose.yml to use ${API_PORT:-} and ${POSTGRES_PORT:-} for optional port exposure
Updated CI workflows to explicitly set these ports for integration tests
Ensures services can run with or without external port access

However, the current syntax "${API_PORT:-}" may cause Docker Compose parsing issues when the variable is empty. The implementation would be more robust with default values like "${API_PORT:-8080:8080}".

Confidence Score: 3/5

This PR has deployment configuration risks due to Docker Compose syntax issues
Score reflects potential Docker Compose parsing failures with empty environment variables, though the concept is sound and CI tests should catch issues
Pay close attention to deployment/docker_compose/docker-compose.yml for proper environment variable handling

Important Files Changed

File Analysis

Filename	Score	Overview
.github/workflows/pr-integration-tests.yml	5/5	Added explicit port environment variables for API_PORT and POSTGRES_PORT in CI workflows to ensure proper port mapping
.github/workflows/pr-mit-integration-tests.yml	5/5	Added explicit port environment variables for API_PORT and POSTGRES_PORT in MIT integration tests workflow
deployment/docker_compose/docker-compose.yml	4/5	Made API and Postgres ports optional using environment variables, but empty value syntax may cause issues

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant CI as CI Pipeline
    participant DC as Docker Compose
    participant API as API Server
    participant PG as PostgreSQL

    Note over Dev,PG: Making Ports Optional Flow

    Dev->>DC: Set API_PORT and POSTGRES_PORT env vars
    Note right of Dev: API_PORT=8080:8080<br/>POSTGRES_PORT=5432:5432
    
    CI->>DC: Run docker compose with explicit port envs
    Note right of CI: Ensures CI tests work properly
    
    DC->>API: Start API server
    alt API_PORT is set
        DC->>API: Expose port ${API_PORT}
    else API_PORT is empty
        DC->>API: No port mapping (internal only)
    end
    
    DC->>PG: Start PostgreSQL
    alt POSTGRES_PORT is set
        DC->>PG: Expose port ${POSTGRES_PORT}
    else POSTGRES_PORT is empty
        DC->>PG: No port mapping (internal only)
    end
    
    Note over Dev,PG: Optional port mapping allows<br/>flexibility for different deployments

_{3 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2025-09-25T20:53:52Z

deployment/docker_compose/docker-compose.yml

-    # ports:
-    #   - "8080:8080"
+    ports:
+      - "${API_PORT:-}"


logic: Empty environment variable expansion may cause Docker Compose parsing issues. Consider using a default empty string or conditional port mapping.

Suggested change

- "${API_PORT:-}"

- "${API_PORT:-8080:8080}"

greptile-apps · 2025-09-25T20:53:53Z

deployment/docker_compose/docker-compose.yml

-    # ports:
-    #   - "5432:5432"
+    ports:
+      - "${POSTGRES_PORT:-}"


logic: Same issue with empty environment variable expansion for Postgres port.

Suggested change

- "${POSTGRES_PORT:-}"

- "${POSTGRES_PORT:-5432:5432}"

cubic-dev-ai

3 issues found across 3 files

Prompt for AI agents (all 3 issues)


Understand the root cause of the following 3 issues and fix them.


<file name=".github/workflows/pr-mit-integration-tests.yml">

<violation number="1" location=".github/workflows/pr-mit-integration-tests.yml:262">
Unnecessary host port exposure for Postgres; tests use the Docker network (relational_db) and do not require binding 5432 on the host. This can cause port conflicts and increases attack surface in CI.</violation>
</file>

<file name="deployment/docker_compose/docker-compose.yml">

<violation number="1" location="deployment/docker_compose/docker-compose.yml:57">
Interpolating an empty value for API_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.</violation>

<violation number="2" location="deployment/docker_compose/docker-compose.yml:232">
Interpolating an empty value for POSTGRES_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.</violation>
</file>

_{React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.}

cubic-dev-ai · 2025-09-25T21:02:15Z

.github/workflows/pr-mit-integration-tests.yml

          IMAGE_TAG=test \
          INTEGRATION_TESTS_MODE=true \
+          API_PORT=8080:8080 \
+          POSTGRES_PORT=5432:5432 \


Unnecessary host port exposure for Postgres; tests use the Docker network (relational_db) and do not require binding 5432 on the host. This can cause port conflicts and increases attack surface in CI.

Prompt for AI agents

Address the following comment on .github/workflows/pr-mit-integration-tests.yml at line 262: <comment>Unnecessary host port exposure for Postgres; tests use the Docker network (relational_db) and do not require binding 5432 on the host. This can cause port conflicts and increases attack surface in CI.</comment> <file context> @@ -258,6 +258,8 @@ jobs: IMAGE_TAG=test \ INTEGRATION_TESTS_MODE=true \ + API_PORT=8080:8080 \ + POSTGRES_PORT=5432:5432 \ docker compose up \ relational_db \ </file context>

✅ Addressed in 2fea661

cubic-dev-ai · 2025-09-25T21:02:15Z

deployment/docker_compose/docker-compose.yml

-    # ports:
-    #   - "5432:5432"
+    ports:
+      - "${POSTGRES_PORT:-}"


Interpolating an empty value for POSTGRES_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.

Prompt for AI agents

Address the following comment on deployment/docker_compose/docker-compose.yml at line 232: <comment>Interpolating an empty value for POSTGRES_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.</comment> <file context> @@ -228,8 +228,8 @@ services: - # ports: - # - "5432:5432" + ports: + - "${POSTGRES_PORT:-}" volumes: - db_volume:/var/lib/postgresql/data </file context>

Suggested change

- "${POSTGRES_PORT:-}"

- "${POSTGRES_PORT:-5432:5432}"

✅ Addressed in 2fea661

cubic-dev-ai · 2025-09-25T21:02:15Z

deployment/docker_compose/docker-compose.yml

-    # ports:
-    #   - "8080:8080"
+    ports:
+      - "${API_PORT:-}"


Interpolating an empty value for API_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.

Prompt for AI agents

Address the following comment on deployment/docker_compose/docker-compose.yml at line 57: <comment>Interpolating an empty value for API_PORT results in an invalid ports entry and docker-compose parsing failure. Provide a valid default mapping or remove the ports block when not mapping ports.</comment> <file context> @@ -53,8 +53,8 @@ services: - # ports: - # - "8080:8080" + ports: + - "${API_PORT:-}" environment: # Auth Settings </file context>

Suggested change

- "${API_PORT:-}"

- "${API_PORT:-8080:8080}"

✅ Addressed in 2fea661

ports option by using env var

9bd3cda

jessicasingh7 requested a review from a team as a code owner September 25, 2025 20:51

vercel bot deployed to Preview September 25, 2025 20:52 View deployment

greptile-apps bot reviewed Sep 25, 2025

View reviewed changes

justin-tahara approved these changes Sep 25, 2025

View reviewed changes

fix

5b43b28

cubic-dev-ai bot reviewed Sep 25, 2025

View reviewed changes

vercel bot deployed to Preview September 25, 2025 21:05 View deployment

add default port

2fea661

vercel bot deployed to Preview September 25, 2025 21:22 View deployment

postgres

23e0054

vercel bot deployed to Preview September 25, 2025 21:35 View deployment

jessicasingh7 closed this Sep 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(docker compose): make ports optional #5500

fix(docker compose): make ports optional #5500

Uh oh!

jessicasingh7 commented Sep 25, 2025 •

edited

Loading

Uh oh!

vercel bot commented Sep 25, 2025 •

edited

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Sep 25, 2025

Uh oh!

greptile-apps bot Sep 25, 2025

Uh oh!

cubic-dev-ai bot left a comment

Uh oh!

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading

Uh oh!

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading

Uh oh!

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

fix(docker compose): make ports optional #5500

fix(docker compose): make ports optional #5500

Uh oh!

Conversation

jessicasingh7 commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Additional Options

Uh oh!

vercel bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Overview

Summary

Confidence Score: 3/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai bot Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jessicasingh7 commented Sep 25, 2025 •

edited

Loading

vercel bot commented Sep 25, 2025 •

edited

Loading

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading

cubic-dev-ai bot Sep 25, 2025 •

edited

Loading