Skip to content

fix: resolve Gradio 502 startup error on WSL2 environments#50

Open
vijaykushwaha-03 wants to merge 1 commit intomicrosoft:mainfrom
vijaykushwaha-03:fix/wsl2-gradio-502-error
Open

fix: resolve Gradio 502 startup error on WSL2 environments#50
vijaykushwaha-03 wants to merge 1 commit intomicrosoft:mainfrom
vijaykushwaha-03:fix/wsl2-gradio-502-error

Conversation

@vijaykushwaha-03
Copy link

Hey! 👋

I ran into the issue described in #49 where the Gradio app crashes with a 502 error when running on WSL2. After some digging, I found the root cause and put together a fix.

What was happening

On WSL2, when you run python app.py, it fails with:

The problem is that WSL2 handles localhost networking differently than native Linux. Gradio tries to verify the server is running by pinging 127.0.0.1, but that doesn't work reliably in WSL2.

What I changed

  • Added auto-detection for WSL2 environments (checks /proc/version and env variables)
  • When WSL2 is detected, the app automatically binds to 0.0.0.0 instead of localhost
  • Added some command-line flags (--server-name, --server-port, --share) so users can manually configure things if needed
  • Applied the same fix to app_texturing.py for consistency

How to use it

For most people, it should just work now:

python app.py

- Add auto-detection of WSL2 environment using /proc/version and env vars
- Automatically use server_name='0.0.0.0' when WSL2 is detected
- Add command-line arguments for server configuration:
  --server-name: Manually specify server IP (use '0.0.0.0' for WSL2/Docker)
  --server-port: Specify port (default: 7860)
  --share: Create a public Gradio share link
- Apply same fix to both app.py and app_texturing.py

Fixes microsoft#49
Copilot AI review requested due to automatic review settings December 25, 2025 05:51
@microsoft-github-policy-service

@vijaykushwaha-03 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses a Gradio 502 startup error that occurs when running the application on WSL2 environments by implementing WSL2 auto-detection and configurable server parameters.

Key Changes:

  • Added WSL2 environment auto-detection that automatically binds to 0.0.0.0 for better compatibility
  • Introduced command-line arguments (--server-name, --server-port, --share) for manual server configuration
  • Applied the same fix consistently to both app.py and app_texturing.py

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
app.py Added argparse for server configuration, WSL2 auto-detection logic, and updated demo.launch() to use configurable server parameters
app_texturing.py Applied identical WSL2 detection and server configuration changes as app.py for consistency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

is_wsl = False
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file is being read twice in this line. The first f.read().lower() reads the entire file content, and then the second f.read().lower() is called on an empty file buffer since the file pointer is already at the end. This means the 'wsl' check will never match. Store the result of f.read().lower() in a variable first and then check both conditions against that variable.

Suggested change
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
version_info = f.read().lower()
is_wsl = 'microsoft' in version_info or 'wsl' in version_info

Copilot uses AI. Check for mistakes.
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
except:
Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a bare except clause without specifying an exception type is considered bad practice. It catches all exceptions including system-exiting exceptions like KeyboardInterrupt and SystemExit, which should typically not be caught. Specify the expected exception types (e.g., FileNotFoundError, IOError, OSError) to make the error handling more explicit and avoid masking unexpected errors.

Suggested change
except:
except OSError:
# If /proc/version cannot be read, leave is_wsl as False and continue

Copilot uses AI. Check for mistakes.
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
except:
Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using a bare except clause without specifying an exception type is considered bad practice. It catches all exceptions including system-exiting exceptions like KeyboardInterrupt and SystemExit, which should typically not be caught. Specify the expected exception types (e.g., FileNotFoundError, IOError, OSError) to make the error handling more explicit and avoid masking unexpected errors.

Suggested change
except:
except OSError:

Copilot uses AI. Check for mistakes.
Comment on lines +630 to +649
# Auto-detect WSL2 environment and set appropriate server_name
server_name = args.server_name
if server_name is None:
# Check if running in WSL2
is_wsl = False
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
except:
pass

# Also check WSL_DISTRO_NAME environment variable
if os.environ.get('WSL_DISTRO_NAME') or os.environ.get('WSL_INTEROP'):
is_wsl = True

if is_wsl:
server_name = "0.0.0.0"
print("WSL2 environment detected. Using server_name='0.0.0.0' for better compatibility.")
print("Access the app at http://localhost:{} from your Windows browser.".format(args.server_port))

Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The WSL2 detection logic (lines 630-648) is duplicated between app.py and app_texturing.py. Consider extracting this into a shared utility function to improve maintainability and ensure consistency. This would make it easier to fix bugs (like the double file read issue) or add improvements in one place rather than maintaining the same code in multiple locations.

Suggested change
# Auto-detect WSL2 environment and set appropriate server_name
server_name = args.server_name
if server_name is None:
# Check if running in WSL2
is_wsl = False
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
except:
pass
# Also check WSL_DISTRO_NAME environment variable
if os.environ.get('WSL_DISTRO_NAME') or os.environ.get('WSL_INTEROP'):
is_wsl = True
if is_wsl:
server_name = "0.0.0.0"
print("WSL2 environment detected. Using server_name='0.0.0.0' for better compatibility.")
print("Access the app at http://localhost:{} from your Windows browser.".format(args.server_port))
def _is_wsl2() -> bool:
"""
Detect whether the current environment is WSL2.
Checks both /proc/version content and common WSL environment variables.
"""
# Check if running in WSL2 via /proc/version
try:
with open('/proc/version', 'r') as f:
version_info = f.read().lower()
if 'microsoft' in version_info or 'wsl' in version_info:
return True
except Exception:
# If /proc/version cannot be read, fall back to environment variables
pass
# Also check WSL-related environment variables
if os.environ.get('WSL_DISTRO_NAME') or os.environ.get('WSL_INTEROP'):
return True
return False
# Auto-detect WSL2 environment and set appropriate server_name
server_name = args.server_name
if server_name is None and _is_wsl2():
server_name = "0.0.0.0"
print("WSL2 environment detected. Using server_name='0.0.0.0' for better compatibility.")
print("Access the app at http://localhost:{} from your Windows browser.".format(args.server_port))

Copilot uses AI. Check for mistakes.
Comment on lines +157 to +175
# Auto-detect WSL2 environment and set appropriate server_name
server_name = args.server_name
if server_name is None:
# Check if running in WSL2
is_wsl = False
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
except:
pass

# Also check WSL_DISTRO_NAME environment variable
if os.environ.get('WSL_DISTRO_NAME') or os.environ.get('WSL_INTEROP'):
is_wsl = True

if is_wsl:
server_name = "0.0.0.0"
print("WSL2 environment detected. Using server_name='0.0.0.0' for better compatibility.")
print("Access the app at http://localhost:{} from your Windows browser.".format(args.server_port))
Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The WSL2 detection logic (lines 157-175) is duplicated between app.py and app_texturing.py. Consider extracting this into a shared utility function to improve maintainability and ensure consistency. This would make it easier to fix bugs (like the double file read issue) or add improvements in one place rather than maintaining the same code in multiple locations.

Copilot uses AI. Check for mistakes.
is_wsl = False
try:
with open('/proc/version', 'r') as f:
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
Copy link

Copilot AI Dec 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file is being read twice in this line. The first f.read().lower() reads the entire file content, and then the second f.read().lower() is called on an empty file buffer since the file pointer is already at the end. This means the 'wsl' check will never match. Store the result of f.read().lower() in a variable first and then check both conditions against that variable.

Suggested change
is_wsl = 'microsoft' in f.read().lower() or 'wsl' in f.read().lower()
version_info = f.read().lower()
is_wsl = 'microsoft' in version_info or 'wsl' in version_info

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant