Skip to content

fix: removing entry from plugin timetable updates in real-time#706

Open
eduardosmaniotto wants to merge 3 commits intoMUnique:masterfrom
eduardosmaniotto:bugfix/timetable-remove
Open

fix: removing entry from plugin timetable updates in real-time#706
eduardosmaniotto wants to merge 3 commits intoMUnique:masterfrom
eduardosmaniotto:bugfix/timetable-remove

Conversation

@eduardosmaniotto
Copy link
Contributor

Update ValueListWrapper to properly implement RemoveAt:

Create a public new void RemoveAt(int index) method.
Make it remove from both _innerList and the base wrapper list (base.RemoveAt(index)).
Ensure index pointers on all subsequent wrappers are updated.
Modify existing public bool Remove(TValue item) method to use base.RemoveAt to prevent double-removals from _innerList.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the item removal mechanism within the ValueListWrapper<TValue> component. By introducing a dedicated RemoveAt(int index) method and modifying the existing Remove(TValue item) to utilize it, the changes ensure that list items are consistently removed from both the internal data structure and the base collection. This update resolves issues where removing entries might not have reflected in real-time, improving data integrity and UI responsiveness for components like plugin timetables.

Highlights

  • Refactored Remove logic: The ValueListWrapper<TValue> class now centralizes its item removal logic, improving consistency.
  • Introduced RemoveAt method: A new public new void RemoveAt(int index) method was added to handle item removal by index.
  • Synchronized list removal: The new RemoveAt method ensures items are correctly removed from both the internal _innerList and the base collection.
  • Corrected index updates: After removal, the indices of subsequent wrapper items are properly re-assigned to maintain consistency within the list.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • src/Web/Shared/Components/Form/ValueListWrapper.cs
    • Implemented a new public new void RemoveAt(int index) method to handle item removal by index.
    • Updated the Remove(TValue item) method to delegate its removal logic to the newly introduced RemoveAt(int index) method.
    • Ensured that the RemoveAt method correctly removes items from both the internal _innerList and the base collection, and re-indexes subsequent items.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request addresses a bug in the Remove method of ValueListWrapper<TValue> by introducing a new RemoveAt method. This new method correctly handles the removal of items from both the wrapper list and the underlying data list, ensuring their consistency. The refactoring of the Remove method to use this new RemoveAt method is a good improvement. I have one suggestion regarding the implementation of the new RemoveAt method to enhance its clarity and maintainability by reordering the operations.

Comment on lines +80 to +86
this._innerList.RemoveAt(index);
this[index].PropertyChanged -= this.OnValueChanged;
base.RemoveAt(index);
for (int i = index; i < this._innerList.Count; i++)
{
this[i].Index = i;
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The order of operations in this method could be improved for clarity and robustness. It's generally better to modify the primary collection (this) before the backing collection (_innerList) to maintain a more consistent state throughout the operation. Also, unsubscribing from the event should ideally happen before the item is removed from the collection.

A more logical sequence of operations would be:

  1. Unsubscribe the event handler from the wrapper to be removed.
  2. Remove the wrapper from the main list (base.RemoveAt).
  3. Remove the corresponding value from the inner list (_innerList.RemoveAt).
  4. Update the indices of the remaining items.
        this[index].PropertyChanged -= this.OnValueChanged;
        base.RemoveAt(index);
        this._innerList.RemoveAt(index);
        for (int i = index; i < this.Count; i++)
        {
            this[i].Index = i;
        }

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.

1 participant