Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update dockerfiles and imports to use xrx_agent_framework instead of agent_framework #28

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mprast
Copy link
Collaborator

@mprast mprast commented Oct 31, 2024

fixes #27 (for all sample apps, not just shopify-app)

@chrislott feel free to re-assign if you need

@mprast mprast requested a review from chrislott October 31, 2024 05:39
@alessandro-neri
Copy link
Contributor

alessandro-neri commented Nov 15, 2024

[Feature] Update xRx Framework Integration Across Multiple Applications

1. Overview

  • What is the feature?
    This feature involves updating the xRx framework integration across multiple applications within the repository. The updates include refactoring the import paths from agent_framework to xrx_agent_framework, updating Dockerfiles to reflect the new framework structure, and modifying the xrx-core submodule to align with the latest framework changes. These changes ensure consistent integration of the xRx framework across all applications, enhancing modularity and maintainability.

  • What changed?

    • xrx-core Submodule: Refactored import paths and updated core functionalities to align with the new xrx_agent_framework.
    • Application Dockerfiles: Modified Docker configurations to incorporate the updated xrx_agent_framework paths.
    • Reasoning Applications: Updated import statements and dependencies in patient-information-app, pizza-store, shopify-app, simple-app, and wolfram-assistant-app to ensure compatibility with the updated framework.

2. Files Modified

File Name Changes
reasoning/Dockerfile (patient-information-app) Context: Configures the Docker environment for the patient information reasoning application.
Changes [EDIT]: Updated framework import paths from agent_framework to xrx_agent_framework.
executor.py (patient-information-app/reasoning/app/agent) Context: Handles the execution logic for the reasoning agent.
Changes [EDIT]: Refactored import statements to use xrx_agent_framework instead of agent_framework.
main.py (patient-information-app/reasoning/app) Context: Entry point for the patient information reasoning application.
Changes [EDIT]: Updated import paths to reflect the new xrx_agent_framework structure.
xrx-core (Submodule) Context: Core functionalities and framework integrations for xRx.
Changes [EDIT]: Refactored multiple files to update import paths and align with xrx_agent_framework changes.
reasoning/Dockerfile (pizza-store) Context: Configures the Docker environment for the pizza store reasoning application.
Changes [EDIT]: Updated framework import paths from agent_framework to xrx_agent_framework.
config.py (pizza-store/reasoning/app/agent) Context: Configuration settings for the pizza store reasoning agent.
Changes [EDIT]: Refactored import statements to use xrx_agent_framework.
executor.py (pizza-store/reasoning/app/agent) Context: Handles the execution logic for the pizza store reasoning agent.
Changes [EDIT]: Updated import paths to xrx_agent_framework.
... ...
main.py (wolfram-assistant-app/reasoning/app) Context: Entry point for the Wolfram Assistant reasoning application.
Changes [EDIT]: Updated import paths to reflect the new xrx_agent_framework structure.
xrx-core (Submodule) Context: Core functionalities and framework integrations for xRx.
Changes [EDIT]: Refactored multiple files to update import paths and align with xrx_agent_framework changes.

Note: The table above summarizes representative changes. All affected applications underwent similar updates to ensure consistency.

3. Issues/Improvements

Security. Potential exposure of sensitive import paths. - Ensure that updated import paths do not inadvertently expose sensitive module structures. - Review access permissions and secure configuration settings post-refactoring.
Maintainability. Increased complexity due to multiple simultaneous updates. - Consider breaking down the PR into smaller, application-specific updates to enhance reviewability. - Implement comprehensive documentation for the new `xrx_agent_framework` structure to aid future maintenance.
Performance. Potential delays in Docker image builds. - Optimize Dockerfile changes to minimize build times. - Cache dependencies effectively to reduce installation overhead.
Simplification. Opportunity to streamline import statements across applications. - Refactor common import patterns into centralized modules or utilities. - Utilize environment variables or configuration files to manage framework paths dynamically.

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.

shopify-app dockerfile out of date after xrx-core restructuring
2 participants