feature/edit-findings-audit

[iTzGooDLife]

Descripción

Se realizaron los siguientes cambios:

• Se agrega la funcionalidad de editar findings dentro de las auditorias
• Se realiza una pequeña modificación de CVSSCalculator para compatibilizar con la feature mencionada antes, ahora no realizará el parseo si el vector está vacio (Se entiende por vacio si no tiene más de un elemento luego del '/', tipo: 'CVSS:3.1/').
• Se agrega un Check Icon al sidebar en su modalidad desplegado, para marcar si el finding está finalizado, este estado se maneja dentro del finding, en el switch con el label "Completed".
• Se agregan un Contexto para los Outlets dentro del componente padre "AuditRoot", esto para poder pasar estados/variables necesarias a componentes hijos. Además, se movió un poco de lógica desde el Sidebar hacia el AuditRoot.

OBSERVACIONES:

• No se agregaron los Custom Fields, se propone que quede como trabajo futuro.
• Hay un "TODO" pendiente, el cual es que si ocurren ciertos cambios dentro del componente de "general" de audits, entonces se debe reflejar en los findings, como el language, title, etc. No se abordó dentro de este PR debido a que afecta a muchos componentes extras.

Motivación y Contexto

Se finaliza la historia de usuario 11.

¿Cómo ha sido probado?

Pasos para comprobar:

• Editar findings con campos vacios o llenos y observar como los componentes cambian a sus respectivos valores
• Realizar recomendaciones de CVSS y CWE
• Comprobar el funcionamiento de la calculadora CVSS
• Actualizar el switch de un finding para observar como cambia el sidebar.

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 ha agregado un nuevo componente AuditContext para gestionar datos relacionados con auditorías.
  • Se introdujeron componentes para editar hallazgos, incluyendo DefinitionTab, DetailsTab, ProofsTab y Edit.
  • Se ha implementado un sistema de manejo de errores mejorado para operaciones de eliminación y edición de hallazgos.

• Mejoras en la Interfaz de Usuario

  • Se ha añadido un ícono de verificación en el componente AuditSidebar para representar el estado de los hallazgos.
  • Se ha mejorado la lógica de visualización de hallazgos y se han agregado nuevos mensajes de error para la eliminación fallida de hallazgos.

• Correcciones de Errores

  • Se han realizado ajustes en la gestión del estado para optimizar la carga de datos y la representación de opciones de idioma.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Se han realizado varias modificaciones en los componentes del frontend relacionados con la gestión de auditorías y hallazgos. Se ha añadido un nuevo tipo status al tipo Finding, se han introducido nuevos componentes para la edición de hallazgos y se ha implementado un contexto para gestionar los datos de auditoría. También se han actualizado los mensajes de error en la localización y se han mejorado las funciones de manejo de errores en varios componentes.

Changes

File Path	Change Summary
frontend/src/components/navbar/AuditSidebar.tsx	Se añadió un nuevo import para CheckIcon, se actualizó el tipo Finding para incluir status, y se modificó la lógica de renderizado para mostrar el icono según el estado.
frontend/src/i18n/en-US/index.ts	Se añadió un nuevo mensaje de error para la eliminación fallida de hallazgos: failedDeleteFinding.
frontend/src/routes/audits/edit/AuditContext.tsx	Se creó un nuevo contexto para gestionar datos de auditoría y se definieron varios tipos relacionados.
frontend/src/routes/audits/edit/AuditRoot.tsx	Se añadieron nuevas variables de estado y se integró el AuditProvider para compartir el contexto.
frontend/src/routes/audits/edit/findings/add/add.tsx	Se refactorizó la función handleAddVuln para usar async/await y se añadió el uso de handlerFindings.
frontend/src/routes/audits/edit/findings/edit/DefinitionTab.tsx	Se introdujo un nuevo componente para editar hallazgos, con lógica para manejar recomendaciones de CWE.
frontend/src/routes/audits/edit/findings/edit/DetailsTab.tsx	Se introdujo un nuevo componente para gestionar y mostrar detalles de un hallazgo.
frontend/src/routes/audits/edit/findings/edit/ProofsTab.tsx	Se introdujo un nuevo componente para manejar la información de prueba de un hallazgo.
frontend/src/routes/audits/edit/findings/edit/edit.tsx	Se realizaron cambios significativos en la lógica y estructura del componente Edit, incluyendo nuevos tipos.
frontend/src/routes/audits/edit/general/general.tsx	Se eliminó la variable de estado setLanguages para simplificar la gestión de idiomas.
frontend/src/routes/audits/edit/useAuditContext.tsx	Se añadió un nuevo hook useAuditContext para facilitar el acceso al contexto de auditoría.
frontend/src/routes/vulnerabilities/components/CVSSCalculator.tsx	Se añadió una verificación condicional en parseCVSSVector para manejar cadenas vacías.
frontend/src/services/audits.ts	Se introdujo el tipo EditFinding y se añadieron funciones para obtener, actualizar y eliminar hallazgos.

Possibly related PRs

• ✨ feat: Add functionality to add new findings in audits #128: Este PR involucra actualizaciones al tipo Finding para incluir una nueva propiedad status, que está directamente relacionada con las modificaciones en los componentes AuditSidebar y AuditRoot.
• feat: Add remediationComplexity and priority props to audits services #138: Este PR añade propiedades remediationComplexity y priority al tipo Finding, alineándose con la actualización del tipo Finding en el PR principal.
• feat: added customSections on audits #146: Las modificaciones en este PR al componente AuditSidebar incluyen actualizaciones al tipo AuditSidebarProps, mejorando la funcionalidad general del sidebar.

Suggested labels

enhancement

Suggested reviewers

• Icksir
• jllanosg
• massi-ponce
• caverav
• Sealra

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.