Discussion: Missing Python dependency (msal) causes runtime failure when using pip

[netanelitguru]

Overview

While testing and running xss.py, I encountered an immediate runtime failure caused by a missing Python dependency: msal.

The script imports msal directly, but the dependency is neither installed automatically nor documented in the project’s setup instructions. As a result, the program crashes at startup before any runtime logic executes.

This discussion is intended to confirm whether msal is an intended mandatory dependency and to suggest improvements to dependency management and documentation.

---

Error Details

Traceback (most recent call last):
  File "/home/learnadmin/xss.py", line 65, in <module>
    import msal
ModuleNotFoundError: No module named 'msal'

The error occurs immediately on launch.

---

Environment

• Operating System: Linux
• Python Version: Python 3.x
• Package Manager: pip
• Installation Method: manual clone + pip
• Virtual Environment: yes (venv)

---

Steps to Reproduce

git clone <REPO_URL>
cd <REPO_DIR>

python3 -m venv .venv
source .venv/bin/activate

python3 -m pip install --upgrade pip
python3 xss.py

At this point, execution fails with:

ModuleNotFoundError: No module named 'msal'

---

Expected Behavior

One of the following would be expected:

1. All required dependencies (including msal) are installed automatically via pip
2. The README clearly documents all required Python dependencies
3. The script exits gracefully with a clear message explaining which dependency is missing and how to install it

---

Actual Behavior

• The script crashes immediately with an uncaught ModuleNotFoundError
• No guidance is provided on how to resolve the issue unless the user already knows the dependency

---

Likely Root Cause

• msal is imported directly in the codebase

• msal is not included in:

  • requirements.txt
  • pyproject.toml
  • documented setup instructions

---

Temporary Workaround

Manually installing the dependency resolves the issue:

python3 -m pip install msal

After installing msal, the script runs past the import stage without errors.

---

Suggestions for Improvement

1. Dependency Management

Add msal to the project’s dependency list, for example:

requirements.txt

msal

Then document installation clearly:

python3 -m pip install -r requirements.txt

---

2. Documentation

Update the README to include:

• Required Python version
• Required pip packages
• Recommended setup using venv + pip

---

3. Optional: Improved Error Handling

To improve user experience, the import could be guarded:

try:
    import msal
except ImportError:
    raise SystemExit(
        "Missing dependency: msal\n"
        "Install it using: python3 -m pip install msal"
    )

This avoids a confusing stack trace and provides immediate guidance.

---

Questions for Maintainers

• Is msal an intended mandatory dependency for this project?

• If so, would you be open to a PR that:

  • adds it to the dependency list
  • updates the documentation accordingly?

I’m happy to submit a fix if this aligns with the project’s direction.

---

Closing

Thanks for the project and for taking the time to review this.

Clarifying dependency requirements would significantly improve onboarding and usability for new users.