feat: 15.2.2 release - Githubissues

aaronm-2112 commented 2 weeks ago

Summary by Sourcery

Release version 15.2.2 with multiple bug fixes related to the Pennsieve Agent, including detection of legacy versions, installation checks, and connectivity issues. Enhance error handling and user interface messages for the Pennsieve Agent. Update CI workflows to remove outdated branch references and document changes in the changelog.

New Features:

Introduce a mutation observer to monitor the Pennsieve Agent check status and update UI elements accordingly.

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 user interface to provide more informative messages during the Pennsieve Agent check process.

CI:

Remove the 'v-2019-pennsieve-agent-patch' branch from the build and deploy workflows for Linux, Mac, and Windows.

Documentation:

Update the changelog with details of the bug fixes included in version 15.2.2.

fairdataihub-bot[bot] commented 2 weeks 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 2 weeks ago

Reviewer's Guide by Sourcery

This pull request implements version 15.2.2, focusing on bug fixes related to the Pennsieve Agent and improvements to the Advanced Features section. The changes primarily address issues with agent detection, installation checks, and connectivity problems for legacy users. Additionally, there are enhancements to error handling, UI improvements, and minor adjustments to various components.

Sequence diagram for Pennsieve Agent Check Process

sequenceDiagram
    participant User
    participant UI
    participant PennsieveAgent
    User->>UI: Click 'Confirm Dataset Manifest'
    UI->>PennsieveAgent: Check if installed
    alt Agent not installed
        UI->>User: Display download link
    else Agent installed
        UI->>PennsieveAgent: Start check
        PennsieveAgent-->>UI: Check successful
        UI->>User: Display success message
    end

User journey diagram for Advanced Features Update

journey
    title User Journey for Advanced Features Update
    section Start Over
      User: 5: Click 'Start Over'
      System: 5: Hide sections and reset placeholders
    section Confirm Dataset Manifest
      User: 4: Click 'Confirm Dataset Manifest'
      System: 4: Check Pennsieve Agent installation
      System: 3: Display appropriate message
    section Pull Manifest Information
      User: 3: Click 'Pull Manifest Information'
      System: 3: Generate manifest folder locally
    section Banner Image Upload
      User: 2: Navigate to Banner Image Upload
      System: 2: Check Pennsieve Agent and transition mode

Class diagram for Pennsieve Agent Error Handling

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

File-Level Changes

Change	Details	Files
Improved Pennsieve Agent detection and handling	Fixed issue with detecting legacy versions of the Pennsieve Agent Updated the Agent installation check in the Advanced Features section Added a new Agent check display component for banner image upload/edit Implemented a mutation observer for Agent check completion	`src/renderer/src/scripts/advanced-features/advanced_features.js` `src/renderer/src/components/backgroundServices/PennsieveAgentCheckDisplay/index.jsx` `src/renderer/src/sections/advanced-features/advanced_features.html`
Enhanced error handling and logging	Added client-side error handling for manifest generation Improved error logging in various Python scripts Updated error messages to be more informative	`src/renderer/src/scripts/advanced-features/advanced_features.js` `src/pyflask/datasets/compare_local_remote_files.py` `src/pyflask/datasets/datasets.py`
UI and UX improvements	Added new buttons and sections for manifest generation workflow Updated scrolling behavior for certain UI elements Improved visibility control for various UI components	`src/renderer/src/scripts/advanced-features/advanced_features.js` `src/renderer/src/scripts/others/tab-effects.js` `src/renderer/src/sections/advanced-features/advanced_features.html`
Configuration and authentication updates	Modified the order of checking for default accounts Updated the process of lowercase account name conversion Fixed an issue with reading the config.ini file	`src/pyflask/manageDatasets/manage_datasets.py` `src/pyflask/configUtils/config.py`
Version updates and changelog	Updated version number to 15.2.2 Added new entries to the changelog Updated the minimum API version	`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 2 weeks 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!