fix: exit the goose and show the error message when provider environment variable is not set by lifeizhou-ap · Pull Request #103 · block/goose

lifeizhou-ap · 2024-10-01T03:34:58Z

Why

Currently it throws a runtime error and print the stack trace when

when the environment variable is not set for LLM apis,
when unknown provider or moderator is trying to be loaded

This make it hard for users to understand what is going.

What

Exchange

Raised a MissingProviderEnvVariableError with attributes of provider, env_variable. When providers fetch the environment variable for api key, it will raise this error if the environment variable is not available
Raised a LoadExchangeAttributeError for unknown provider or moderator

With the above custom erross we can construct user friendly messages in goose

goose

Raised a LoadExchangeAttributeError for unknown provider or toolkit
Catch the custom errors Show the error message without stacktrace and exit the program.

screenshots

Please give feedback including the content and presentation of these error message. Thank you!

…s not set

lifeizhou-ap · 2024-10-01T03:39:33Z

src/goose/cli/config.py

            break
        except Exception:
            pass
-    else:


we don't need this message. The error message (env var is not set) will be thrown when the provider is loaded while creating the session.

so in this case, the provider value that is returned below will be whatever is last in the list of providers, and then be used to set the default profile. It will later error like you say.

Should we do

else: provider = RECOMMENDED_DEFAULT

so that we don't set it to something niche?

lamchau · 2024-10-01T05:33:23Z

tests/cli/test_session.py

+def test_create_exchange_exit_when_env_var_does_not_exist(create_session_with_mock_configs, mock_sessions_path):
+    session = create_session_with_mock_configs()
+    expected_error = MissingProviderEnvVariableError(env_variable="OPENAI_API_KEY", provider="openai")
+    with patch("goose.cli.session.build_exchange", side_effect=expected_error), patch(


:nit: we can make this easier to read by forcing ruff format to newline with trailing command and parenthesis

with ( patch("goose.cli.session.build_exchange", side_effect=expected_error), patch("goose.cli.session.print") as mock_print, patch("sys.exit") as mock_exit, ):

Yes, I prefer the separated lines too. However, I had a look, it seems that ruff format is unable to do it as it only supports some light formatting rules.

what do you mean? i refactored one of our tests and it worked for me - how did ruff format not work/fail?

oh, sorry I missed the extra brackets. I've updated and it works now!

…ey-not-specified * main: chore: setup workspace for exchange (#105)

…ovider/moderator is unknown

baxen

This is great! Much clearer

baxen · 2024-10-03T23:14:32Z

packages/exchange/src/exchange/load_exchange_attribute_error.py

+from typing import List
+
+
+class LoadExchangeAttributeError(Exception):


nit: maybe InvalidChoice

baxen · 2024-10-03T23:20:42Z

packages/exchange/src/exchange/providers/azure.py

        return cls(client)
+
+    @classmethod
+    def _get_env_variable(cls: Type["AzureProvider"], key: str) -> str:


nit: i'd just call the helper directly instead of adding the new method?

baxen · 2024-10-03T23:21:31Z

packages/exchange/src/exchange/providers/bedrock.py

        return tool_config
+
+    @classmethod
+    def _get_env_variable(cls: Type["BedrockProvider"], key: str) -> str:


nit: same comment as above

baxen · 2024-10-03T23:29:05Z

src/goose/cli/config.py

            break
        except Exception:
            pass
-    else:


so in this case, the provider value that is returned below will be whatever is last in the list of providers, and then be used to set the default profile. It will later error like you say.

Should we do

else: provider = RECOMMENDED_DEFAULT

so that we don't set it to something niche?

* main: fix: exit the goose and show the error message when provider environment variable is not set (#103) fix: Update OpenAI pricing per https://openai.com/api/pricing/ (#110) fix: update developer tool prompts to use plan task status to match allowable statuses update_plan tool call (#107) fix: removed the panel in the output so that the user won't have unnecessary pane borders in the copied content (#109) docs: update links to exchange to the new location (#108) chore: setup workspace for exchange (#105)

…ent variable is not set (#103)

* main: (41 commits) chore: Add goose providers list command (#116) docs: working ollama for desktop (#125) docs: format and clean up warnings/errors (#120) docs: update deploy workflow (#124) feat: Implement a goose run command (#121) feat: saved api_key to keychain for user (#104) docs: add callout plugin (#119) chore: add a page to docs for Goose application examples (#117) fix: exit the goose and show the error message when provider environment variable is not set (#103) fix: Update OpenAI pricing per https://openai.com/api/pricing/ (#110) fix: update developer tool prompts to use plan task status to match allowable statuses update_plan tool call (#107) fix: removed the panel in the output so that the user won't have unnecessary pane borders in the copied content (#109) docs: update links to exchange to the new location (#108) chore: setup workspace for exchange (#105) fix: resolve uvx when using a git client or IDE (#98) ci: add include-markdown for mkdocs (#100) chore: fix broken badge on readme (#102) feat: add global optional user goosehints file (#73) docs: update docs (#99) chore(release): release 0.9.3 (#97) ...

…ent variable is not set (#103)

…ent variable is not set (block#103)

- Use environment variables instead of direct GitHub context interpolation in shell scripts to prevent potential shell injection attacks - Pin peter-evans/create-pull-request to commit SHA (v6) Resolves code scanning alerts #103, #104, #105

exit the goose and show the error message when provider environment i…

c321c8c

…s not set

lifeizhou-ap mentioned this pull request Oct 1, 2024

fix: created custom error when env var for providers does not exist or unknown provider, moderator is attempted to be loaded square/exchange#69

Closed

lifeizhou-ap commented Oct 1, 2024

View reviewed changes

fixed the message content

6cb7cfc

lifeizhou-ap changed the title ~~feat: exit the goose and show the error message when provider environment is not set~~ fix: exit the goose and show the error message when provider environment is not set Oct 1, 2024

lifeizhou-ap changed the title ~~fix: exit the goose and show the error message when provider environment is not set~~ fix: exit the goose and show the error message when provider environment variable is not set Oct 1, 2024

lamchau reviewed Oct 1, 2024

View reviewed changes

lifeizhou-ap added 6 commits October 2, 2024 11:47

show error message when configuration is incorrect

dfb4522

Merge branch 'main' into lifei/show-readable-error-message-when-api-k…

a710080

…ey-not-specified * main: chore: setup workspace for exchange (#105)

created custom errors when env var for providers does not exist or pr…

b52f3a3

…ovider/moderator is unknown

fixed format issues

40fab9b

fixed the errror message

1b725f7

add a new line in message

451cda4

lifeizhou-ap marked this pull request as ready for review October 3, 2024 01:42

michaelneale approved these changes Oct 3, 2024

View reviewed changes

format the code

7829262

baxen approved these changes Oct 3, 2024

View reviewed changes

lifeizhou-ap added 4 commits October 4, 2024 10:31

renamed to invalidChoiceError

03af0c6

inline methods

4e97f0a

set default provider

36b5d2c

rename variable

208b265

lifeizhou-ap merged commit 908af7f into main Oct 4, 2024

lifeizhou-ap deleted the lifei/show-readable-error-message-when-api-key-not-specified branch October 4, 2024 01:18

lily-de pushed a commit that referenced this pull request Oct 7, 2024

fix: exit the goose and show the error message when provider environm…

88b5c8e

…ent variable is not set (#103)

ahau-square pushed a commit that referenced this pull request May 2, 2025

fix: exit the goose and show the error message when provider environm…

2209577

…ent variable is not set (#103)

cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025

fix: exit the goose and show the error message when provider environm…

4350eab

…ent variable is not set (block#103)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: exit the goose and show the error message when provider environment variable is not set#103

fix: exit the goose and show the error message when provider environment variable is not set#103
lifeizhou-ap merged 13 commits intomainfrom
lifei/show-readable-error-message-when-api-key-not-specified

lifeizhou-ap commented Oct 1, 2024 •

edited

Loading

Uh oh!

lifeizhou-ap Oct 1, 2024 •

edited

Loading

Uh oh!

baxen Oct 3, 2024

Uh oh!

lamchau Oct 1, 2024

Uh oh!

lifeizhou-ap Oct 3, 2024

Uh oh!

lamchau Oct 3, 2024 •

edited

Loading

Uh oh!

lifeizhou-ap Oct 3, 2024

Uh oh!

baxen left a comment

Uh oh!

baxen Oct 3, 2024

Uh oh!

baxen Oct 3, 2024

Uh oh!

baxen Oct 3, 2024

Uh oh!

baxen Oct 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		from typing import List


		class LoadExchangeAttributeError(Exception):

Conversation

lifeizhou-ap commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lifeizhou-ap Oct 1, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lamchau Oct 3, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

baxen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lifeizhou-ap commented Oct 1, 2024 •

edited

Loading

lifeizhou-ap Oct 1, 2024 •

edited

Loading

lamchau Oct 3, 2024 •

edited

Loading