Skip to content

fix: infinite loop in multiselect effect#115

Merged
massi-ponce merged 2 commits intomainfrom
bugfix/multiselect-effect
Sep 28, 2024
Merged

fix: infinite loop in multiselect effect#115
massi-ponce merged 2 commits intomainfrom
bugfix/multiselect-effect

Conversation

@jllanosg
Copy link
Copy Markdown
Collaborator

@jllanosg jllanosg commented Sep 28, 2024

Descripción

Quita useEffect "innecesario"; este había sido incluido para que al actualizar la lista de elementos seleccionados en el multiselect en el componente padre el multiselect se "limpiara", pero genera problemas ya que tenía como dependencias dos variables que terminaban generando un loop infinito.

Ahora la lista de seleccionados se debe vaciar manualmente cuando sea necesario. Actualmente no hay lugar en el front donde se requiera hacer eso por lo que no es un breaking change; el multi select solo se está ocupando en audits:edit:general.

Motivación y Contexto

Evitar un loop infinito en custom data.

¿Cómo ha sido probado?

En audits -> edit -> general, modificar los collaborators.

Capturas de pantalla (si es apropiado):

Tipos de cambios

  • Bugfix (cambio que no interrumpe el funcionamiento y que soluciona un problema)
  • New feature (cambio que no interrumpe el funcionamiento y que añade funcionalidad)
  • Breaking change (corrección o funcionalidad que podría causar que la funcionalidad existente cambie)

Lista de verificación:

  • Mi código sigue el estilo de código de este proyecto.
  • Mi cambio requiere una modificación en la documentación.
  • He actualizado la documentación en consecuencia.
  • Requiere nuevos tests.

Summary by CodeRabbit

  • Nuevas Funciones
    • Se eliminó el restablecimiento automático de los elementos seleccionados en el menú desplegable al cambiar los elementos o la función onChange, mejorando la experiencia del usuario al mantener las selecciones previas.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 28, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

Los cambios realizados en el archivo MultiSelectDropdown.tsx implican la eliminación del hook useEffect, que anteriormente se utilizaba para invocar la función onChange con un arreglo vacío cada vez que cambiaban las dependencias items o onChange. Esta modificación evita que los elementos seleccionados en el dropdown se restablezcan automáticamente a un estado vacío cuando cambian los elementos del componente o la referencia de la función onChange. Además, se ha eliminado la declaración de importación de useEffect, indicando que ya no se utiliza en el componente.

Changes

Archivos Resumen de cambios
frontend/src/components/dropdown/MultiSelectDropdown.tsx Se eliminó el uso del hook useEffect, lo que previene el restablecimiento automático de los elementos seleccionados en el dropdown. También se eliminó la importación de useEffect.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MultiSelectDropdown
    participant onChangeFunction

    User->>MultiSelectDropdown: Interactúa con el dropdown
    MultiSelectDropdown->>onChangeFunction: Llama a onChange con los elementos seleccionados
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 412d5e6 and e121f96.

📒 Files selected for processing (1)
  • frontend/src/components/dropdown/MultiSelectDropdown.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • frontend/src/components/dropdown/MultiSelectDropdown.tsx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between aab045b and 412d5e6.

📒 Files selected for processing (1)
  • frontend/src/components/dropdown/MultiSelectDropdown.tsx (1 hunks)
🔇 Additional comments (1)
frontend/src/components/dropdown/MultiSelectDropdown.tsx (1)

Line range hint 1-111: Apruebo la eliminación del useEffect.

La eliminación del hook useEffect resuelve efectivamente el problema del bucle infinito mencionado en los objetivos del PR. Esta modificación permite un control más preciso sobre cuándo se deben borrar los elementos seleccionados, lo que es una mejora significativa en la funcionalidad del componente.

Sin embargo, es crucial que entiendas las implicaciones de este cambio:

  1. Ya no hay un restablecimiento automático de los elementos seleccionados cuando cambian las propiedades 'items' o 'onChange'.
  2. Ahora, cualquier limpieza de los elementos seleccionados debe realizarse manualmente desde el componente padre.

Asegúrate de que todos los desarrolladores que utilicen este componente estén al tanto de estos cambios en su comportamiento.

Ejecuta el siguiente script para verificar que no haya referencias al useEffect eliminado en otros archivos:

✅ Verification successful

Confirmación de la Eliminación de useEffect

No se encontraron referencias a useEffect en frontend/src/components/dropdown/MultiSelectDropdown.tsx. La eliminación del hook useEffect ha sido verificada exitosamente, resolviendo el problema del bucle infinito mencionado en el PR.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Descripción: Buscar referencias a useEffect en relación con MultiSelectDropdown

# Prueba: Buscar referencias a useEffect y MultiSelectDropdown en el mismo archivo
rg --type typescript -e "useEffect.*MultiSelectDropdown" -e "MultiSelectDropdown.*useEffect"

Length of output: 129


Script:

#!/bin/bash
# Descripción: Buscar referencias a useEffect en MultiSelectDropdown.tsx

# Buscar 'useEffect' dentro de 'MultiSelectDropdown.tsx'
rg "useEffect" frontend/src/components/dropdown/MultiSelectDropdown.tsx -A 2

Length of output: 76

Comment thread frontend/src/components/dropdown/MultiSelectDropdown.tsx Outdated
iTzGooDLife
iTzGooDLife previously approved these changes Sep 28, 2024
Copy link
Copy Markdown
Collaborator

@iTzGooDLife iTzGooDLife left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Collaborator

@iTzGooDLife iTzGooDLife left a comment

Choose a reason for hiding this comment

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

LGTM (again)

Copy link
Copy Markdown
Collaborator

@massi-ponce massi-ponce left a comment

Choose a reason for hiding this comment

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

Todo bien.

@massi-ponce massi-ponce merged commit 250f831 into main Sep 28, 2024
@caverav caverav deleted the bugfix/multiselect-effect branch October 16, 2024 23:32
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.

3 participants