Fix: Feedback API Failure In Docker - Gh CLI Authentication

Understanding the Reported Issue

At the heart of the matter, the feedback API within our Docker containerized application is currently experiencing a critical failure. Specifically, the feedback button, a core component of our user interface, is displaying the disconcerting message: "Failed to create GitHub issue." This issue arises because the GitHub CLI (gh CLI) is not properly authenticated within the production Docker container, hindering its ability to create new issues on our GitHub repository. This breakdown in functionality is not merely an inconvenience; it represents a significant impediment to our feedback collection process, potentially impacting our ability to respond effectively to user concerns and improve our product. Addressing this promptly is crucial to maintaining a healthy feedback loop and ensuring the continued development and refinement of our application.

Our expected behavior is that the system should seamlessly create GitHub issues when feedback is submitted through the feedback button. This can be achieved either by ensuring the gh CLI is authenticated within the container or by leveraging the GitHub REST API with a designated token. The current failure disrupts this core functionality, preventing users from easily reporting bugs, suggesting improvements, or providing general feedback. The inability to collect this feedback directly undermines our development process, potentially leading to missed opportunities for improvement and a less responsive user experience. Therefore, resolving this authentication issue is paramount to maintaining a robust and user-centric feedback mechanism.

Given that this issue renders the feedback functionality completely inoperable, it has been classified as a HIGH severity issue. This classification underscores the urgency of the situation, as the inability to collect feedback directly impacts our ability to address user concerns, track bugs, and prioritize improvements. The feedback mechanism is a vital communication channel between our users and our development team, and its failure disrupts this essential flow of information. Consequently, we must address this authentication problem promptly to restore this crucial functionality and ensure that we can effectively gather and respond to user feedback.

Deep Dive into the Error Details

The core of the problem lies in an Authentication / Configuration error. The precise location of this error is pinpointed within our codebase, specifically in the src/app/api/feedback/route.ts file. This file is responsible for handling the logic behind our feedback API. The API attempts to use the gh issue create command to generate new issues on GitHub. However, this command relies on the gh CLI being authenticated, which, as we've discovered, is not the case within our Docker production container. This discrepancy between the expected authentication state and the actual state is the root cause of the failure.

Delving deeper, the problematic URL/Route is the POST /api/feedback endpoint. This endpoint is triggered when a user submits feedback through the feedback form. When this endpoint is accessed, the code attempts to execute the gh issue create command. However, due to the lack of authentication, this command fails, leading to the "Failed to create GitHub issue" error. Understanding the specific endpoint and the sequence of events that lead to the error is crucial for developing an effective solution.

The feedback API's reliance on the gh CLI is implemented through the following code snippet:

const command = `gh issue create --title "..." --body "..." --label "..."`
exec(command, ...)

This code demonstrates that the API constructs a command string for the gh CLI and then uses the exec function to execute it. This approach inherently depends on the gh CLI being properly configured and authenticated within the environment where the code is running. The absence of authentication within the Docker container directly violates this dependency, causing the command execution to fail. To rectify this, we need to either establish gh CLI authentication within the container or explore alternative methods for creating GitHub issues, such as using the GitHub REST API with a token.

Verification Checkpoint and Reproducing the Bug

Our comprehensive verification process confirms the persistence of this issue. The Last Verified date is 2025-12-02, indicating that this problem has been recently validated. File paths have also been thoroughly verified, ensuring that our analysis is focused on the correct areas of the codebase. Furthermore, we've checked for previous partial fixes and confirmed that no prior attempts have fully resolved this authentication problem. Most importantly, reproduction of the issue has been confirmed today, with users encountering the "Failed to create GitHub issue" error. This real-world user experience underscores the urgency and importance of addressing this bug.

To reproduce the issue, follow these straightforward steps:

1. Access the application at the specified address: http://172.16.20.50:4545.
2. Locate and click the feedback button in the upper right corner of the interface. This button is the primary entry point for users to submit feedback.
3. Fill out the bug report form with the necessary details. This includes providing a descriptive title, a detailed body explaining the issue, and any relevant labels.
4. Submit the form. Upon submission, you will encounter the error message "Failed to create GitHub issue," confirming the reproduction of the bug. This consistent reproduction across different attempts reinforces the need for a definitive solution.

In-depth Investigation Notes and Proposed Solutions

Our investigation has revealed that the gh CLI necessitates authentication, which can be achieved either through the gh auth login command or by utilizing the GITHUB_TOKEN environment variable. The Docker container, in its current state, lacks this necessary authentication, rendering the gh CLI inoperable. This absence of authentication is the direct cause of the feedback API's failure to create GitHub issues.

We've identified three potential avenues for resolving this authentication problem:

1. Add GITHUB_TOKEN to .env and container: This approach involves setting the GITHUB_TOKEN environment variable within both the .env file and the Docker container itself. This would provide the gh CLI with the necessary credentials to authenticate and create GitHub issues. This is the preferred approach due to its simplicity and security.
2. Use Octokit REST API instead of gh CLI: This alternative involves replacing the gh CLI with the Octokit REST API for interacting with GitHub. Octokit provides a programmatic way to interact with GitHub's API, allowing us to create issues using a token-based authentication mechanism. This approach offers greater flexibility and control but requires more code changes.
3. Pre-authenticate gh in Dockerfile (not recommended - secrets in image): This option involves pre-authenticating the gh CLI within the Dockerfile itself. However, this approach is strongly discouraged due to security concerns, as it would embed secrets directly within the Docker image, potentially exposing them. This practice should be avoided to maintain the security and integrity of our application.

Next Steps and Actionable Items

To effectively address this critical issue, we've outlined the following next steps:

1. Add GITHUB_TOKEN env var to .env.example and container: This is our primary focus, as it provides a straightforward and secure way to authenticate the gh CLI. We will add the GITHUB_TOKEN environment variable to both the .env.example file (for development environments) and the Docker container configuration (for production). This ensures that the gh CLI has the necessary credentials to operate correctly.
2. Update feedback API to use token-based auth or Octokit: We will modify the feedback API to leverage the GITHUB_TOKEN for authentication, either directly with the gh CLI or by transitioning to the Octokit REST API. This ensures that the API can create GitHub issues securely and reliably.
3. Thoroughly test in Docker container: After implementing the changes, we will conduct comprehensive testing within the Docker container to verify that the feedback API is functioning as expected. This testing will include submitting feedback through the feedback button and confirming that new issues are successfully created on GitHub. This rigorous testing is crucial to ensure that the issue is fully resolved and that the feedback mechanism is restored to its intended functionality.

By following these steps, we are confident that we can effectively resolve the authentication issue and restore the critical feedback functionality within our application. This will allow us to continue collecting valuable user feedback and ensure the ongoing improvement of our product.

In conclusion, addressing the gh CLI authentication issue within the Docker container is crucial for restoring the functionality of the feedback API. By implementing the proposed solutions, we can ensure that user feedback is collected efficiently, contributing to the ongoing development and improvement of our application. For more information on GitHub authentication best practices, please visit the official GitHub Documentation.