feat: 15.2.2 release - Githubissues

aaronm-2112 commented 1 month ago

Summary by Sourcery

Release version 15.2.2 with bug fixes related to the Pennsieve Agent detection and connectivity, enhancements to error handling and user guidance, and updates to the CI workflows. Improve the user interface in the advanced features section with a new mutation observer for the Pennsieve Agent check.

New Features:

Introduce a mutation observer to monitor the Pennsieve Agent check status and update the UI accordingly in the advanced features section.

Bug Fixes:

Fix an issue where SODA was unable to detect legacy versions of the Pennsieve Agent and suggest an update.
Correct the Pennsieve Agent installation check in the Advanced Features section to properly notify users if the agent is not installed.
Resolve a Pennsieve connectivity issue for legacy users when updating to the latest version of SODA.
Fix an issue in the manifest creation and banner image upload/edit features where users without Pennsieve Agents were not directed to the download page.
Address a potential early upload failure in 'Prepare Datasets Step-by-Step' and 'Upload Dataset' due to undefined variables.

Enhancements:

Improve error handling and logging for Pennsieve Agent database file operations.
Enhance the Pennsieve Agent error message display with a link to SODA documentation for manual issue resolution.
Refactor the order of account authentication checks in the bf_get_accounts function for better logic flow.

CI:

Remove the 'empty-folders-files-hotfix' branch from the build and deploy workflows for Linux, Mac, and Windows.

Documentation:

Update the CHANGELOG.md with details of bug fixes and changes for version 15.2.2.

fairdataihub-bot[bot] commented 1 month ago

Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again!

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements version 15.2.2, focusing on bug fixes and improvements related to the Pennsieve Agent integration, manifest generation, and banner image upload functionality. The changes primarily affect the advanced features section of the application, enhancing error handling, user experience, and overall stability.

Sequence diagram for Pennsieve Agent Check Process

sequenceDiagram
    participant User
    participant UI
    participant PennsieveAgent
    User->>UI: Click 'Confirm Dataset Manifest'
    UI->>PennsieveAgent: checkPennsieveAgent()
    alt Agent Installed
        PennsieveAgent-->>UI: Agent is running
        UI->>User: Show success message
    else Agent Not Installed
        PennsieveAgent-->>UI: Agent not found
        UI->>User: Show download link
    end

User Journey for Advanced Features with Pennsieve Agent

journey
    title User Journey for Advanced Features with Pennsieve Agent
    section Start Over
      User: Click 'Start Over' -> UI: Hide sections
    section Confirm Dataset Manifest
      User: Click 'Confirm Dataset Manifest' -> UI: Check Pennsieve Agent
    section Pull Manifest Information
      User: Click 'Pull Manifest Information' -> UI: Generate Manifest
    section Banner Image Upload
      User: Navigate to Banner Image Upload -> UI: Check Pennsieve Agent
      User: Upload/Edit Banner Image -> UI: Confirm Upload

Class diagram for Pennsieve Agent Error Handling

classDiagram
    class PennsieveAgentErrorMessageDisplay {
        +PennsieveAgentErrorMessageDisplay(errorMessage)
        +deletePennsieveAgentDBFilesAndRestart()
    }
    class PennsieveAgentCheckDisplay {
        +pennsieveAgentCheckInProgress: boolean
        +pennsieveAgentCheckError: object
        +pennsieveAgentInstalled: boolean
        +pennsieveAgentOutputErrorMessage: string
        +pennsieveAgentUpToDate: boolean
    }
    PennsieveAgentErrorMessageDisplay --> PennsieveAgentCheckDisplay : uses

File-Level Changes

Change	Details	Files
Improved Pennsieve Agent detection and integration	Added checks to detect legacy versions of the Pennsieve Agent Implemented proper notification for users without the Pennsieve Agent installed Fixed Pennsieve connectivity issues for legacy users updating to the latest SODA version	`src/renderer/src/scripts/advanced-features/advanced_features.js` `src/renderer/src/components/backgroundServices/PennsieveAgentCheckDisplay/index.jsx` `src/renderer/src/scripts/others/renderer.js`
Enhanced manifest generation and banner image upload process	Added Pennsieve Agent check before manifest generation and banner image upload Implemented a new flow for confirming dataset selection and pulling manifest information Improved error handling and user guidance during the process	`src/renderer/src/scripts/advanced-features/advanced_features.js` `src/renderer/src/sections/advanced-features/advanced_features.html` `src/renderer/src/scripts/tab-effects.js` `src/renderer/src/scripts/metadata-files/manifest.js`
Refactored authentication and account handling	Modified the order of checking for default accounts in the config file Improved handling of the 'SODA-Pennsieve' account name Fixed issues with lowercase account name conversion	`src/pyflask/manageDatasets/manage_datasets.py` `src/pyflask/configUtils/config.py`
Improved error handling and logging	Added more comprehensive error logging throughout the application Fixed potential issues with undefined variables during upload failures Improved error messages and guidance for users	`src/pyflask/curate/curate.py` `src/pyflask/datasets/compare_local_remote_files.py` `src/renderer/src/sections/curate/curate.html`
Updated version information and changelog	Bumped version to 15.2.2 Updated CHANGELOG.md with new bug fixes and improvements Modified version information in relevant files	`src/renderer/src/scripts/meta/announcements.json` `CHANGELOG.md` `src/pyflask/startup/minimumApiVersion.py`

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

fairdataihub-bot[bot] commented 1 month ago

Thanks for making updates to your pull request. Our team will take a look and provide feedback as soon as possible. Please wait for any GitHub Actions to complete before editing your pull request. If you have any additional questions or concerns, feel free to let us know. Thank you for your contributions!