Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add remediationComplexity and priority props to audits services #138

Merged

Conversation

massi-ponce
Copy link
Collaborator

@massi-ponce massi-ponce commented Oct 11, 2024

Descripción

Se añaden props faltantes (remediationComplexity y priority) a audit services.

Específicamente se añaden al POST que se genera al añadir un finding a una auditoría, y también, al type Findings.

Motivación y Contexto

Es necesario ya que se estaba dejando pasar data importante, la cuál se quiere representar en los dashboards.

¿Cómo ha sido probado?

Seguir el siguiente flujo:

  1. Ir a "audits".
  2. Editar un audit.
  3. Ir a "Findings".
  4. Abrir el "Monitor de red" (Ctrl+Shift+E).
  5. Añadir una vulnerabilidad.
  6. Fijarse que en la solicitud del POST se encuentren los campos remediationComplexity y priority en el JSON.

Capturas de pantalla (si es apropiado):

imagen

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 características
    • Se han añadido nuevas propiedades remediationComplexity y priority al tipo Finding, mejorando la estructura de los hallazgos.
    • La función para agregar vulnerabilidades ahora incluye estas nuevas propiedades al crear un hallazgo.

@massi-ponce massi-ponce requested a review from caverav October 11, 2024 23:56
Copy link
Contributor

coderabbitai bot commented Oct 11, 2024

📝 Walkthrough

Walkthrough

Se han introducido dos nuevas propiedades, remediationComplexity y priority, en el tipo Finding dentro del archivo frontend/src/services/audits.ts. Estas propiedades son de tipo número y añaden metadatos adicionales relacionados con la complejidad de la remediación y la prioridad del hallazgo. Además, la función addVuln se ha modificado para incluir estos nuevos atributos al crear un hallazgo, extrayendo los valores de data y enviándolos en la solicitud POST para agregar hallazgos.

Changes

Archivo Resumen de cambios
frontend/src/services/audits.ts Se añadieron las propiedades remediationComplexity y priority al tipo Finding. Se modificó la función addVuln para incluir estas propiedades en la solicitud POST al agregar un hallazgo.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend
    participant API

    User->>Frontend: Agregar hallazgo
    Frontend->>Frontend: Extraer remediationComplexity y priority de data
    Frontend->>API: POST /addFinding con datos del hallazgo
    API-->>Frontend: Confirmación de hallazgo agregado
    Frontend-->>User: Mostrar confirmación
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 17172fb and 4693792.

📒 Files selected for processing (1)
  • frontend/src/services/audits.ts (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
frontend/src/services/audits.ts (2)

12-13: ¡Bien hecho! Las nuevas propiedades se han añadido correctamente.

Las propiedades remediationComplexity y priority se han agregado al tipo Finding de manera adecuada. Esto cumple con los objetivos del PR y mejora la estructura de datos para los hallazgos de auditoría.


583-584: ⚠️ Potential issue

Atención: Posible error al acceder a las nuevas propiedades.

Has añadido correctamente remediationComplexity y priority al cuerpo de la solicitud POST, pero hay un problema potencial:

  1. Estás accediendo a estas propiedades directamente desde data, pero no está claro si data contiene estas propiedades.
  2. No hay manejo de errores o valores predeterminados si estas propiedades no existen en data.

Te sugiero que hagas lo siguiente:

  1. Verifica si getVulnerabilities() devuelve estas nuevas propiedades.
  2. Añade un manejo de errores o valores predeterminados. Por ejemplo:
-        remediationComplexity: data.remediationComplexity,
-        priority: data.priority,
+        remediationComplexity: data.remediationComplexity || 0,
+        priority: data.priority || 0,
  1. Considera actualizar la interfaz o tipo de data para incluir estas nuevas propiedades.

Ejecuta el siguiente script para verificar si getVulnerabilities() incluye las nuevas propiedades:


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.

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.

2 participants