Revisión de código, testing y documentación.
En la primera parte vimos algunas técnicas de prompting que podemos utilizar para generar código HTML, CSS y JavaScript con inteligencia artificial. Entre ellas estaban Zero-shot, Few-shot, CETO, RTF, CO-STAR, entrevista guiada y descomposición.
En este artículo os voy a mostrar otras técnicas que podemos utilizar durante el desarrollo de una aplicación web, pero esta vez enfocadas a revisar código, detectar errores, realizar pruebas y documentar un proyecto.
Para los ejemplos utilizaremos Node.js y Express en el backend, React en el frontend y Postman para realizar algunas pruebas de una API REST.
Hay que tener en cuenta que el código generado por inteligencia artificial no siempre es correcto. Aunque una respuesta parezca adecuada, puede contener errores o no contemplar determinadas situaciones.
1. Autorrevisión: revisar el código generado por IA
La autorrevisión consiste en pedirle a la inteligencia artificial que revise una respuesta que ha generado anteriormente, buscando posibles errores o aspectos que podemos mejorar.
En desarrollo web podemos utilizar esta técnica para revisar funciones JavaScript, componentes React o endpoints de una API, entre muchos otros.
Ejemplo práctico con Node.js y Express
Imaginemos que estamos desarrollando una API REST para gestionar productos.
Tenemos el siguiente endpoint:
app.post('/productos', (req, res) => {
const producto = req.body;
productos.push(producto);
res.json(producto);
});
Este código permite recibir un producto y añadirlo a un array. Sin embargo, no comprueba si los datos recibidos son correctos.
Podemos pedirle a la IA que revise el código.
Prompt de autorrevisión:
Estoy desarrollando una API REST con Node.js
y Express.
He generado este endpoint:
app.post('/productos', (req, res) => {
const producto = req.body;
productos.push(producto);
res.json(producto);
});
Revisa el código e identifica posibles errores.
Comprueba:
- Si se validan los datos recibidos.
- Si se utilizan correctamente los códigos HTTP.
- Si faltan comprobaciones importantes.
- Si puede mejorarse el tratamiento de errores.
Explica los problemas encontrados y después
proporciona una versión corregida del código.
No utilices bibliotecas externas.
En este caso, la IA debería indicar que es necesario validar los datos antes de guardarlos y que podemos utilizar el código HTTP 201 cuando se crea correctamente un recurso.
La autorrevisión permite realizar una primera comprobación, aunque después debemos probar el funcionamiento real del endpoint.
2. Revisión adversarial: buscar posibles errores en React
La revisión adversarial consiste en analizar una solución buscando situaciones en las que puede fallar.
A diferencia de una revisión normal, en este caso le pedimos a la IA que intente encontrar problemas, incluso cuando el código parece funcionar correctamente.
Ejemplo práctico con un componente React
Imaginemos que tenemos un componente que muestra una lista de usuarios:
function ListaUsuarios({ usuarios }) {
return (
<ul>
{usuarios.map((usuario) => (
<li key={usuario.id}>
{usuario.nombre}
</li>
))}
</ul>
);
}
Este componente funciona si recibe correctamente un array de usuarios.
Pero ¿qué ocurre si no recibe ningún dato o si la propiedad usuarios es undefined?
Prompt de revisión adversarial:
Actúa como revisor de código React.
Analiza el siguiente componente:
function ListaUsuarios({ usuarios }) {
return (
<ul>
{usuarios.map((usuario) => (
<li key={usuario.id}>
{usuario.nombre}
</li>
))}
</ul>
);
}
Busca posibles errores.
Comprueba:
- Qué ocurre si usuarios es undefined.
- Qué sucede si el array está vacío.
- Si las claves key son correctas.
- Si faltan comprobaciones.
Explica los problemas encontrados
y propone una versión mejorada.
La IA puede recomendar establecer un valor por defecto para la propiedad usuarios y mostrar un mensaje cuando la lista esté vacía.
Por otro lado, debemos comprobar que los identificadores utilizados como key sean únicos.
Esta técnica resulta útil para detectar situaciones que no hemos tenido en cuenta al programar un componente.
3. Revisión crítica: comprobar una API REST con Postman
La revisión crítica consiste en analizar una solución para comprobar si es correcta y qué aspectos pueden mejorarse.
En este caso vamos a utilizarla para revisar las pruebas de una API REST.
Postman es una herramienta que permite enviar peticiones HTTP a un servidor y comprobar las respuestas que devuelve.
Por ejemplo, podemos utilizarlo para comprobar si una petición GET devuelve los datos de un producto.
Ejemplo práctico con Postman
Imaginemos que tenemos el siguiente endpoint en Express:
app.get('/productos/:id', (req, res) => {
const producto = productos.find(
p => p.id === Number(req.params.id)
);
if (!producto) {
return res.status(404).json({
mensaje: 'Producto no encontrado'
});
}
res.json(producto);
});
Para comprobarlo en Postman, seleccionamos el método GET e introducimos esta dirección:
http://localhost:3000/productos/1
Suponiendo que el servidor está funcionando en el puerto 3000 y existe un producto con ese identificador, deberíamos recibir sus datos con un código HTTP 200.
Pero también debemos comprobar qué ocurre cuando el producto no existe.
Prompt de revisión crítica:
Estoy probando una API REST con Postman. Tengo un endpoint GET /productos/:id que devuelve un producto por su identificador. Si el producto no existe, devuelve un código HTTP 404. Actualmente solo he comprobado que devuelve un producto existente. Realiza una revisión crítica de las pruebas. Indica: - Qué otras peticiones debería realizar. - Qué códigos HTTP debo comprobar. - Qué resultado debería obtener. Explícalo de forma sencilla, porque estoy empezando a utilizar Postman.
En este caso, podemos realizar dos pruebas básicas:
- Producto existente: comprobar que devuelve los datos y el código
200. - Producto inexistente: comprobar que devuelve el mensaje de error y el código
404.
De esta manera, utilizamos la IA para identificar las pruebas que nos faltan y después las realizamos directamente en Postman.
4. Matriz RACI: organizar las responsabilidades de un proyecto web
La matriz RACI permite definir las responsabilidades de las personas que participan en un proyecto.
Sus siglas corresponden a:
- R (Responsible): persona que realiza la tarea.
- A (Accountable): responsable final del resultado.
- C (Consulted): persona a la que se consulta.
- I (Informed): persona que debe estar informada.
Aunque no es una técnica de programación, podemos utilizar la IA para preparar una matriz RACI y organizar las tareas de desarrollo.
Ejemplo práctico
Imaginemos que estamos desarrollando una aplicación con React, Node.js y Express.
En el proyecto participan un desarrollador frontend, un desarrollador backend y un responsable del proyecto.
Prompt para generar una matriz RACI:
Estoy organizando un proyecto de desarrollo web. Utilizamos React para el frontend y Node.js con Express para el backend. El equipo está formado por: - Desarrollador frontend. - Desarrollador backend. - Responsable del proyecto. Las tareas son: - Desarrollo de componentes React. - Creación de endpoints REST. - Integración entre frontend y backend. - Pruebas de la aplicación. - Documentación. - Despliegue. Crea una matriz RACI en formato tabla. Explica brevemente las responsabilidades y señala las asignaciones que deberían confirmarse con el equipo.
La IA generará una propuesta de responsabilidades que podemos revisar y adaptar a la organización real del proyecto.
5. Pre-mortem: anticipar problemas antes de publicar una aplicación
La técnica pre-mortem consiste en imaginar que un proyecto ha fallado e intentar identificar las posibles causas antes de que sucedan.
En desarrollo web podemos utilizarla antes de publicar una aplicación, actualizar dependencias o realizar cambios importantes.
Ejemplo práctico con Node.js y Express
Imaginemos que hemos terminado una API REST y estamos preparando su despliegue.
Antes de publicarla, podemos pedirle a la IA que identifique posibles problemas.
Prompt de pre-mortem:
Estoy preparando el despliegue de una API REST desarrollada con Node.js y Express. La aplicación utiliza una base de datos y variables de entorno. Imagina que hemos publicado la aplicación y ha dejado de funcionar. Realiza un análisis pre-mortem. Indica: - Cinco posibles causas del fallo. - Qué consecuencias tendría cada una. - Cómo podríamos detectarlas. - Qué medidas preventivas podemos aplicar. Presenta el resultado en una tabla. No afirmes que estos errores existen realmente en mi aplicación.
Por ejemplo, la IA puede identificar problemas relacionados con las variables de entorno, la conexión con la base de datos o una configuración incorrecta del servidor.
Esta técnica permite anticipar riesgos, aunque después debemos comprobar cuáles son realmente aplicables a nuestro proyecto.
6. Análisis de escenarios: comprobar diferentes situaciones en React
El análisis de escenarios consiste en estudiar cómo debería comportarse una aplicación en diferentes situaciones.
Por ejemplo, cuando una aplicación React obtiene información desde una API, debemos tener en cuenta que la respuesta puede tardar, devolver datos o producir un error.
Ejemplo práctico
Imaginemos que estamos desarrollando un componente React para mostrar productos de una tienda online.
Podemos pedirle a la IA que analice los posibles escenarios antes de generar el código.
Prompt de análisis de escenarios:
Estoy desarrollando un componente React que muestra productos obtenidos desde una API. Analiza estos escenarios: 1. Los productos se están cargando. 2. La API devuelve productos. 3. La API devuelve una lista vacía. 4. Se produce un error en la petición. Para cada escenario indica: - Qué debería mostrar la interfaz. - Qué comportamiento debe tener el componente. - Qué deberíamos comprobar. Después propone una estructura sencilla para implementar estos estados en React. No utilices bibliotecas externas.
En este caso, podemos mostrar un mensaje de carga mientras esperamos la respuesta, los productos cuando estén disponibles o un mensaje de error cuando la petición falle.
El análisis de escenarios resulta útil para planificar el comportamiento de una aplicación antes de desarrollar todas sus funcionalidades.
7. Verificación de documentación técnica
La inteligencia artificial puede generar código utilizando funciones que no existen o que no son compatibles con la versión que estamos utilizando.
Por eso, es importante comprobar la documentación oficial de las tecnologías antes de incorporar determinadas soluciones.
Por ejemplo, podemos pedirle a la IA que revise un fragmento de código de Express e identifique qué métodos necesitamos comprobar.
Prompt de verificación técnica:
Estoy desarrollando una API con Node.js y Express. Voy a proporcionarte un fragmento de código. Quiero que identifiques: - Qué métodos pertenecen a Express. - Qué funciones pertenecen a Node.js. - Qué dependencias externas utiliza. - Qué aspectos debería comprobar en la documentación oficial. Si tienes acceso a búsqueda web, proporciona enlaces oficiales. Si no puedes verificar una función, indícalo y no inventes información. Código: [PEGAR AQUÍ EL CÓDIGO]
En este caso, podemos consultar la documentación oficial de Node.js y Express para comprobar las funciones utilizadas.
8. Registro de decisiones: documentar los cambios de un proyecto
El registro de decisiones consiste en guardar información sobre las soluciones que hemos elegido durante el desarrollo y los motivos de esas decisiones.
Por ejemplo, podemos documentar por qué hemos seleccionado una determinada biblioteca o por qué hemos decidido organizar una aplicación de una forma concreta.
En proyectos de software se pueden utilizar documentos ADR (Architecture Decision Records) para registrar decisiones técnicas importantes.
Prompt para documentar una decisión:
Estoy desarrollando una aplicación React. Necesito documentar una decisión técnica relacionada con la organización de componentes. Prepara un documento con estos apartados: 1. Problema que queremos resolver. 2. Alternativas consideradas. 3. Ventajas e inconvenientes. 4. Decisión adoptada. 5. Motivos de la decisión. 6. Posibles consecuencias. No inventes la decisión adoptada. Si falta información, deja el apartado pendiente de completar.
Esta técnica resulta útil para mantener un registro de los cambios y facilitar que otras personas comprendan las decisiones tomadas.
¿Qué técnicas de prompting podemos utilizar para revisar código?
Dependiendo de lo que necesitemos realizar, podemos utilizar una técnica u otra.
| Técnica | Aplicación |
|---|---|
| Autorrevisión | Revisar código generado con Node.js y Express. |
| Revisión adversarial | Detectar posibles errores en componentes React. |
| Revisión crítica | Comprobar las pruebas básicas de una API con Postman. |
| Matriz RACI | Organizar responsabilidades de un proyecto. |
| Pre-mortem | Anticipar problemas antes del despliegue. |
| Análisis de escenarios | Revisar diferentes estados de una aplicación React. |
| Verificación técnica | Comprobar funciones en la documentación oficial. |
| Registro de decisiones | Documentar cambios y decisiones del proyecto. |
Estas técnicas también pueden combinarse.
Por ejemplo, antes de publicar una API podemos utilizar un pre-mortem para identificar posibles riesgos y una revisión crítica para comprobar si hemos realizado las pruebas necesarias.
Conclusión
Como hemos visto, las técnicas de prompting no solamente sirven para generar código con inteligencia artificial.
También podemos utilizarlas para revisar funciones, detectar posibles errores en React, comprobar endpoints con Postman o documentar decisiones de un proyecto.
En cualquier caso, debemos comprobar las respuestas de la IA y probar el código antes de incorporarlo a una aplicación.
En los siguientes artículos veremos cómo aplicar un control de calidad al código generado con IA y cómo detectar errores y respuestas incompletas durante el desarrollo web.