Improve error messages when functions fails to load #5782
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheIronDev
approved these changes
May 2, 2023
colerogers
approved these changes
May 2, 2023
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #5782 +/- ##
==========================================
- Coverage 55.21% 55.17% -0.04%
==========================================
Files 329 329
Lines 22500 22521 +21
Branches 4586 4588 +2
==========================================
+ Hits 12423 12427 +4
- Misses 8972 8990 +18
+ Partials 1105 1104 -1
☔ View full report in Codecov by Sentry. |
ProfHercules
pushed a commit
to ProfHercules/firebase-tools
that referenced
this pull request
May 5, 2023
We will proactively try to identify common issues based on error messages to provide better debugging experience. 1. No `venv` directory: ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⬢ functions: Failed to load function definition from source: FirebaseError: Failed to find location of Firebase Functions SDK: Missing virtual environment at venv directory. Did you forget to run 'python3.11 -m venv venv'? ``` 2. No `firebase-functions` package ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⬢ functions: Failed to load function definition from source: FirebaseError: Failed to find location of Firebase Functions SDK. Did you forget to run 'source /Users/danielylee/google/cf3-pyinit/functions/venv/bin/activate && python3.11 -m pip install -r requirements.txt'? ``` 3. Runtime errors ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⚠ functions: Failed to detect functions from source FirebaseError: Failed to parse build specification. stderr:WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://127.0.0.1:8081 Press CTRL+C to quit [2023-05-02 19:29:18,285] ERROR in app: Exception on /__/functions.yaml [GET] Traceback (most recent call last): ... File "/Users/REDACTED/google/cf3-pyinit/functions/main.py", line 8, in <module> foo += 1 ^^^ NameError: name 'foo' is not defined ```
|
If venv is created and requirements is not installed. It still says: Hm, even after doing it. |
tonyjhuang
pushed a commit
that referenced
this pull request
May 22, 2023
We will proactively try to identify common issues based on error messages to provide better debugging experience. 1. No `venv` directory: ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⬢ functions: Failed to load function definition from source: FirebaseError: Failed to find location of Firebase Functions SDK: Missing virtual environment at venv directory. Did you forget to run 'python3.11 -m venv venv'? ``` 2. No `firebase-functions` package ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⬢ functions: Failed to load function definition from source: FirebaseError: Failed to find location of Firebase Functions SDK. Did you forget to run 'source /Users/danielylee/google/cf3-pyinit/functions/venv/bin/activate && python3.11 -m pip install -r requirements.txt'? ``` 3. Runtime errors ``` ➜ functions firebase emulators:start i emulators: Starting emulators: functions i functions: Watching "/Users/REDACTED/google/cf3-pyinit/functions" for Cloud Functions... ⚠ functions: Failed to detect functions from source FirebaseError: Failed to parse build specification. stderr:WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. * Running on http://127.0.0.1:8081 Press CTRL+C to quit [2023-05-02 19:29:18,285] ERROR in app: Exception on /__/functions.yaml [GET] Traceback (most recent call last): ... File "/Users/REDACTED/google/cf3-pyinit/functions/main.py", line 8, in <module> foo += 1 ^^^ NameError: name 'foo' is not defined ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We will proactively try to identify common issues based on error messages to provide better debugging experience.
venvdirectory:firebase-functionspackage