search

ComposioHQ / composio

Composio equip's your AI agents & LLMs with 100+ high-quality integrations via function calling
https://docs.composio.dev
Other
7.47k stars 2.33k forks source link

removed env variable loading unless needed #348

Closed sohamganatra closed 1 month ago

sohamganatra commented 1 month ago

PR Type

Enhancement, Documentation

Description

Changes walkthrough 📝

Relevant files
Enhancement
28 files
sql_query.py
Update SqlQueryResponse schema with execution details       
python/composio/tools/local/sqltool/actions/sql_query.py
  • Added execution_details dictionary to SqlQueryResponse
  • Renamed result to response_data in SqlQueryResponse
    		•  +2/-4     
    main.py
    Simplify OpenAI API key handling in calendar agent             
    python/examples/calendar_agent/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-5     
    main.py
    Simplify OpenAI API key handling in commit agent                 
    python/examples/commit_agent/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-5     
    main.py
    Simplify OpenAI API key handling in image search crewai   
    python/examples/image_search/image_search_crewai/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-4     
    main.py
    Simplify OpenAI API key handling in image search langchain
    python/examples/image_search/image_search_langchain/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-6     
    main.py
    Simplify OpenAI API key handling in image search langgraph
    python/examples/image_search/image_search_langgraph/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-6     
    main.py
    Simplify OpenAI API key handling in image search llamaindex
    python/examples/image_search/image_search_llamaindex/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-7     
    main.py
    Simplify OpenAI API key handling in investment analysis   
    python/examples/investment_analysis/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-5     
    gmail_send_attachment_crew.py
    Simplify OpenAI API key handling and add Crew initialization
    python/examples/miscellaneous/gmail_send_attachment_crew.py
  • Removed manual OpenAI API key input handling
  • Added Crew initialization and task execution
    		•  +5/-3     
    main.py
    Simplify OpenAI API key handling in PR agent crewai           
    python/examples/pr_agent/pr_agent_crewai/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-4     
    main.py
    Simplify OpenAI API key handling in PR agent langchain     
    python/examples/pr_agent/pr_agent_langchain/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-5     
    main.py
    Simplify OpenAI API key handling in PR agent llama index 
    python/examples/pr_agent/pr_agent_llama_index/main.py
  • Removed manual OpenAI API key input handling
  • Simplified OpenAI initialization
    		•  +1/-4     
    main.py
    Simplify OpenAI API key handling in PR agent openai           
    python/examples/pr_agent/pr_agent_openai/main.py
  • Removed manual OpenAI API key input handling
  • Simplified OpenAI initialization
    		•  +0/-5     
    main.py
    Simplify OpenAI API key handling in RAG agent                       
    python/examples/rag_agent/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ComposioToolSet and ChatOpenAI initialization
    		•  +0/-5     
    main.py
    Simplify OpenAI API key handling and add Crew initialization
    python/examples/research_assistant/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
  • Added Crew initialization and task execution
    		•  +5/-10   
    main.py
    Simplify OpenAI API key handling in scheduler agent crewai
    python/examples/scheduler_agent/schedule_agent_crewai/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI and ComposioToolSet initialization
    		•  +2/-11   
    main.py
    Simplify OpenAI API key handling in scheduler agent langchain
    python/examples/scheduler_agent/scheduler_agent_langchain/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI and ComposioToolSet initialization
    		•  +1/-13   
    main.py
    Simplify OpenAI API key handling in scheduler agent llamaindex
    python/examples/scheduler_agent/scheduler_agent_llamaindex/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ComposioToolSet initialization
    		•  +0/-8     
    slack_agent_crewai.py
    Simplify OpenAI API key handling in slack agent crewai     
    python/examples/slack_bot_agent/slack_agent_crewai/slack_agent_crewai.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-5     
    slack_agent_langchain.py
    Simplify OpenAI API key handling in slack agent langchain
    python/examples/slack_bot_agent/slack_agent_langchain/slack_agent_langchain.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-4     
    slack_agent_llamaindex.py
    Simplify OpenAI API key handling in slack agent llamaindex
    python/examples/slack_bot_agent/slack_agent_llamaindex/slack_agent_llamaindex.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +0/-5     
    slack_agent_openai.py
    Simplify OpenAI API key handling in slack agent openai     
    python/examples/slack_bot_agent/slack_agent_openai/slack_agent_openai.py
  • Removed manual OpenAI API key input handling
  • Simplified OpenAI initialization
    		•  +1/-6     
    main.py
    Simplify OpenAI API key handling in SQL agent                       
    python/examples/sql_agent/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-6     
    main.py
    Simplify OpenAI API key handling in SQL agent plotter crewai
    python/examples/sql_agent/sql_agent_plotter_crewai/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-6     
    main.py
    Simplify OpenAI API key handling in SQL agent plotter langchain
    python/examples/sql_agent/sql_agent_plotter_langchain/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-6     
    main.py
    Simplify OpenAI API key handling in SQL agent plotter llama index
    python/examples/sql_agent/sql_agent_plotter_llama_index/main.py
  • Removed manual OpenAI API key input handling
  • Simplified ComposioToolSet initialization
    		•  +0/-5     
    crewai_demo.py
    Simplify OpenAI API key handling in crewai demo                   
    python/plugins/crew_ai/crewai_demo.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-1     
    langchain_demo.py
    Simplify OpenAI API key handling in langchain demo             
    python/plugins/langchain/langchain_demo.py
  • Removed manual OpenAI API key input handling
  • Simplified ChatOpenAI initialization
    		•  +1/-1     
    Documentation
    8 files
    calendar-agent.mdx
    Update calendar agent guide to simplify API key handling 
    docs/guides/python/calendar-agent.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +2/-11   
    commit-agent.mdx
    Update commit agent guide to simplify API key handling     
    docs/guides/python/commit-agent.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +3/-6     
    competitor-researcher.mdx
    Update competitor researcher guide to simplify API key handling
    docs/guides/python/competitor-researcher.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +4/-4     
    investment-analyst.mdx
    Update investment analyst guide to simplify API key handling
    docs/guides/python/investment-analyst.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +2/-2     
    rag_agent.mdx
    Update RAG agent guide to simplify API key handling           
    docs/guides/python/rag_agent.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI and ComposioToolSet initialization in
    documentation
    		•  +6/-6     
    research-assistant.mdx
    Update research assistant guide to simplify API key handling
    docs/guides/python/research-assistant.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +3/-7     
    sql-agent.mdx
    Update SQL agent guide to simplify API key handling           
    docs/guides/python/sql-agent.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI and ComposioToolSet initialization in
    documentation
    		•  +5/-12   
    action-guide.mdx
    Update action guide to simplify API key handling                 
    docs/introduction/foundations/components/actions/action-guide.mdx
  • Updated code examples to remove manual OpenAI API key handling
  • Simplified ChatOpenAI initialization in documentation
    		•  +1/-4     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Schema Change
    The schema of `SqlQueryResponse` has been modified, replacing `result` with `response_data` and adding `execution_details`. Ensure that all dependent code correctly handles these changes, particularly the new dictionary structure in `execution_details`. API Key Handling
    The handling of the OpenAI API key has been removed, and the model initialization now does not include the API key. Ensure that the API key is being set globally or in another secure manner that complies with best practices.
    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Replace hardcoded model name with a configurable environment variable ___ **Replace the hardcoded model name with a variable or environment variable to allow
    easier configuration changes without modifying the codebase.** [python/examples/research_assistant/main.py [12-13]](https://github.com/ComposioHQ/composio/pull/348/files#diff-d0b9aa1a0515c318c3d50bded15ff2370d0dca1e6223f46b86ef73d4e723375fR12-R13) ```diff +model_name = os.getenv("MODEL_NAME", "gpt-4o") llm = ChatOpenAI( - model="gpt-4o" + model=model_name ) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: This suggestion improves maintainability by allowing configuration changes without modifying the codebase. It is a significant improvement and aligns with best practices for configuration management.
    		9
    Possible bug
    Add a secure method to fetch and pass the OpenAI API key to the ChatOpenAI constructor ___ **It seems the ChatOpenAI constructor in the new code is missing the api_key parameter
    which is essential for authentication. Consider adding a mechanism to securely fetch
    and pass the OpenAI API key.** [docs/guides/python/research-assistant.mdx [51-53]](https://github.com/ComposioHQ/composio/pull/348/files#diff-4249165e0ba2a25e3a865bd478565d16346b34290c85e9c3b812b4d920fa3a52R51-R53) ```diff llm = ChatOpenAI( + api_key=get_secure_api_key(), # Ensure this function securely fetches the API key model="gpt-4o" ) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies a potential bug where the API key is missing, which is crucial for authentication. Adding a secure method to fetch and pass the API key is essential for the functionality of the `ChatOpenAI` instance.
    		9
    Ensure the API key is securely provided to the ChatOpenAI initialization ___ **The new code lacks the API key parameter for the ChatOpenAI initialization, which
    might prevent the model from functioning. Include a secure way to provide the API
    key.** [docs/guides/python/investment-analyst.mdx [52]](https://github.com/ComposioHQ/composio/pull/348/files#diff-0bbe1a5006339e1aee7b7486405f43274941a4af13ed393fb76c141aa47cdde8R52-R52) ```diff -llm = ChatOpenAI(model="gpt-4o") +llm = ChatOpenAI( + api_key=get_secure_api_key(), # Securely fetch the API key + model="gpt-4o" +) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: This suggestion accurately points out the missing API key parameter, which is necessary for the `ChatOpenAI` to function correctly. Including a secure method to provide the API key is a critical improvement.
    		9
    Reintroduce the API key parameter securely in the ChatOpenAI instantiation to avoid authentication issues ___ **The removal of the API key parameter in the ChatOpenAI instantiation could lead to
    authentication issues. It's advisable to reintroduce the API key parameter in a
    secure manner.** [docs/introduction/foundations/components/actions/action-guide.mdx [216]](https://github.com/ComposioHQ/composio/pull/348/files#diff-159aafa50f58a79e48710f96de861efeaa6aaf0a8ea56bd64bf7cf764072e645R216-R216) ```diff -llm = ChatOpenAI(model="gpt-4o") +llm = ChatOpenAI( + api_key=get_secure_api_key(), # Function to securely retrieve the API key + model="gpt-4o" +) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies the risk of authentication issues due to the missing API key parameter. Reintroducing the API key securely is essential for the proper functioning of the `ChatOpenAI` instance.
    		9
    Securely fetch and use the API key for ChatOpenAI initialization to ensure access to OpenAI services ___ **The new code snippet lacks the API key parameter for the ChatOpenAI initialization.
    This is crucial for accessing the OpenAI services. Consider securely fetching and
    using the API key.** [docs/guides/python/research-assistant.mdx [118-119]](https://github.com/ComposioHQ/composio/pull/348/files#diff-4249165e0ba2a25e3a865bd478565d16346b34290c85e9c3b812b4d920fa3a52R118-R119) ```diff llm = ChatOpenAI( + api_key=get_secure_api_key(), # Function to securely fetch the API key model="gpt-4o" ) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: This suggestion correctly highlights the missing API key parameter, which is crucial for accessing OpenAI services. Securely fetching and using the API key is necessary for the `ChatOpenAI` initialization to work properly.
    		9
    Possible issue
    Add error handling for uninitialized variables in Crew object creation ___ **Ensure that the Crew object initialization includes error handling or validation to
    check if researcher and task are properly defined before use.** [python/examples/research_assistant/main.py [46]](https://github.com/ComposioHQ/composio/pull/348/files#diff-d0b9aa1a0515c318c3d50bded15ff2370d0dca1e6223f46b86ef73d4e723375fR46-R46) ```diff +if researcher is None or task is None: + raise ValueError("Researcher or Task is not properly initialized") crew = Crew(agents=[researcher], tasks=[task]) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: Adding error handling for uninitialized variables is crucial for preventing runtime errors and improving code robustness. This suggestion addresses a potential issue effectively.
    		8
    Enhancement
    Add validation check before printing the result to handle empty or None values gracefully ___ **Add a check to ensure that the result variable is not None or empty before printing,
    to avoid displaying uninformative messages or errors.** [python/examples/research_assistant/main.py [51]](https://github.com/ComposioHQ/composio/pull/348/files#diff-d0b9aa1a0515c318c3d50bded15ff2370d0dca1e6223f46b86ef73d4e723375fR51-R51) ```diff -print(result) +if result: + print(result) +else: + print("No result available.") ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: This suggestion enhances the user experience by ensuring that uninformative messages or errors are not displayed. It is a useful enhancement but not critical.
    		7
    Best practice
    Improve variable naming for better readability and maintainability ___ **Use a more descriptive variable name than llm for the ChatOpenAI instance to improve
    code readability and maintainability.** [python/examples/research_assistant/main.py [12-13]](https://github.com/ComposioHQ/composio/pull/348/files#diff-d0b9aa1a0515c318c3d50bded15ff2370d0dca1e6223f46b86ef73d4e723375fR12-R13) ```diff -llm = ChatOpenAI( +chat_openai_client = ChatOpenAI( model="gpt-4o" ) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 6 Why: While improving variable naming is beneficial for readability and maintainability, it is a minor improvement compared to functional or security-related changes.
    		6