Puntos calientes de cambio
| Sigla | sin sigla asentada (en inglés, hotspots) |
| Aspecto | «Evolución del código» |
| Se mide en | fichero (o clase, o componente), combinando el historial de versiones con una métrica del código |
| Tipo de valor | ordenación o puntuación relativa; no hay una escala común |
| Dirección | más alto es peor |
| Origen | popularizado por Adam Tornhill (Your Code as a Crime Scene, 2015); la idea de cruzar rotación y complejidad aparece también en Michael Feathers |
| Stau Metro | no la calcula |
En pocas palabras
Un punto caliente es un fichero complicado que además se toca a menudo. Un fichero muy complejo que nadie modifica desde hace años no molesta a nadie; uno sencillo que cambia cada día tampoco. El que es complejo y cambia mucho es donde el equipo pierde tiempo y donde más errores se cuelan. La métrica sirve para decidir por dónde empezar a mejorar el código, cuando no se puede mejorar todo.
Qué mide
Mide prioridad, no calidad. Combina dos ejes:
- Frecuencia de cambio: cuántas veces se ha modificado el fichero en un periodo reciente (número de commits que lo tocan) o cuánto ha cambiado (la «rotación del código»).
- Complejidad: una métrica del código en el estado actual, como las «líneas de código», la «complejidad ponderada de los métodos» o la «complejidad ciclomática» sumada.
La razón es económica. La complejidad es un coste que se paga cada vez que alguien tiene que leer o modificar el código. Si nadie lo modifica, el coste no se paga. La frecuencia de cambio dice cuántas veces se paga.
Hay además apoyo empírico para el eje del cambio por sí solo: Graves et al. (2000) encontraron que el número de veces que se ha cambiado el código predecía cuántos fallos tendría mejor que su longitud, y Moser, Pedrycz y Succi (2008) encontraron que, en Eclipse, las métricas de cambio clasificaban los ficheros defectuosos mejor que las del código.
Para quien empieza. Piensa en un mapa de la ciudad con los accidentes de tráfico. Un cruce peligroso por el que no pasa nadie no causa accidentes; uno peligroso y muy transitado, sí. El punto caliente es el segundo.
Cómo se calcula
No hay una fórmula canónica. Las tres formas habituales:
-
Intersección de listas. Se ordenan los ficheros por frecuencia de cambio y, por separado, por complejidad; son puntos calientes los que están arriba en las dos. Es la idea de Tornhill: el código complicado importa en la medida en que hay que trabajar con él a menudo.
-
Producto normalizado. Se escala cada eje al intervalo de 0 a 1 (por ejemplo, dividiendo entre el máximo) y se multiplican:
-
Cuadrantes. Se dibuja cada fichero en un plano con la frecuencia de cambio en un eje y la complejidad en el otro (Feathers propuso dibujar la complejidad frente a la rotación); los que quedan altos en los dos son los candidatos.
El diagrama dice lo mismo que esta frase: arriba a la derecha, complejo y muy cambiado, el punto caliente; arriba a la izquierda, complejo pero estable; abajo a la derecha, simple aunque cambie mucho; abajo a la izquierda, ni lo uno ni lo otro.
En los tres casos hay que fijar:
- El periodo. Lo reciente importa más que lo antiguo: un fichero muy cambiado hace cinco años y estable desde entonces ya no es un problema. Lo habitual son los últimos meses, por ejemplo 6 o 12.
- La métrica de complejidad. Las líneas de código son la más tosca y la más fácil de obtener en cualquier lenguaje; las de complejidad discriminan mejor dentro de un lenguaje.
Ejemplo
Cinco clases de un proyecto, con los commits que las tocaron en los últimos 12 meses y su
«complejidad ponderada de los métodos» (WMC) actual. Se normaliza
cada eje dividiendo entre el máximo (48 cambios, WMC 150):
| Clase | Cambios | WMC |
Cambios / 48 | WMC / 150 |
Puntuación |
|---|---|---|---|---|---|
OrderService |
48 | 95 | 1,000 | 0,633 | 0,633 |
PriceCalculator |
30 | 60 | 0,625 | 0,400 | 0,250 |
ReportGenerator |
3 | 120 | 0,063 | 0,800 | 0,050 |
Config |
40 | 6 | 0,833 | 0,040 | 0,033 |
LegacyParser |
1 | 150 | 0,021 | 1,000 | 0,021 |
Lectura:
OrderServicees el punto caliente: la clase que más cambia y la tercera más compleja.LegacyParseres la clase más compleja, pero solo se tocó una vez en un año. Refactorizarla primero sería gastar el esfuerzo donde menos rinde.Configcambia mucho, pero es trivial: cada cambio es barato.
Una lista ordenada solo por complejidad habría puesto LegacyParser en cabeza; una ordenada solo por cambios, a
Config en segundo lugar. El cruce de los dos ejes cambia el orden.
Cómo interpretarla
No hay umbrales: la puntuación solo ordena los ficheros de un mismo proyecto y periodo. Lo que se mira es la cabeza de la lista.
Qué hacer con un punto caliente:
- Refactoriza ahí primero. Es donde una mejora se amortiza antes, porque es donde más se trabaja.
- Asegura sus tests. La guía de cobertura de Google pide en concreto cubrir bien el código que cambia con frecuencia; ver «cobertura de código».
- Busca por qué cambia tanto. Un fichero que cambia por muchas razones distintas suele tener demasiadas responsabilidades; partirlo reparte los cambios. Los mensajes de los commits y el «acoplamiento de cambio» ayudan a ver qué otras cosas cambian con él.
- Mira quién lo toca. Un punto caliente con muchos autores ocasionales es más arriesgado que uno con un responsable claro; ver «propiedad del código».
Cuándo un punto caliente es aceptable. En código que está en pleno desarrollo, un fichero nuevo y grande cambia mucho por definición. Los ficheros de configuración centrales, los registros de versiones o las listas de dependencias cambian a menudo sin ser un problema; conviene excluirlos del análisis.
Ojo. Un punto caliente no es un defecto, es un sitio donde mirar. Y la lista depende del periodo elegido: con seis meses y con tres años salen ficheros distintos.
Para profundizar
La concentración. El argumento de fondo es que la actividad de desarrollo está muy concentrada: una parte pequeña del código recibe la mayor parte de los cambios. CodeScene lo ilustra con un ejemplo de su panel en el que los puntos calientes priorizados son el 5,5 % del código, reciben el 17,6 % del esfuerzo de desarrollo y contienen el 23 % de los errores corregidos. Es un ejemplo de un proyecto, no un resultado general.
Limitaciones.
- La frecuencia de cambio cuenta los commits, no su importancia: corregir una errata y rehacer un algoritmo valen lo mismo. La rotación en líneas lo matiza, pero premia los cambios mecánicos grandes.
- Renombrar o mover un fichero puede partir su historia en dos si la herramienta no la sigue.
- Los ficheros nuevos no tienen historia: no pueden ser puntos calientes hasta pasado un tiempo, aunque sean complejos desde el primer día.
- La normalización por el máximo hace que un único fichero extremo aplaste a todos los demás; usar rangos o percentiles en vez del máximo lo evita.
Granularidad. El análisis puede bajar del fichero al método: dentro de un fichero muy grande, la mayor parte del código puede estar estable y el cambio concentrarse en unos pocos métodos. Hace falta entonces una herramienta que siga cada método a lo largo del historial, lo que es bastante más difícil que seguir ficheros.
Relación con otras métricas
- «Rotación del código»: el eje del cambio, medido en líneas en vez de en commits.
- «Complejidad ponderada de los métodos» (
WMC), «complejidad ciclomática» (v(G)) y «complejidad cognitiva» (CogC): candidatas para el eje de la complejidad. - «Líneas de código» (
LOC): el sustituto más simple de la complejidad, y el que usa CodeScene en su mapa. - «Acoplamiento de cambio»: extiende un punto caliente a los ficheros que cambian con él.
- «Propiedad del código»: quién trabaja en el punto caliente.
- «Ratio de deuda técnica»: estima cuánta deuda hay; los puntos calientes dicen cuál cuesta más.
- «Densidad de defectos»: donde se espera que los puntos calientes concentren los defectos.
En las herramientas
Stau Metro. No la calcula: no lee el control de versiones. Su pestaña Resumen también habla de «puntos
calientes», pero en otro sentido: los elementos cuyas métricas superan los umbrales de aviso o de error, ordenados
de peor a mejor y, si se compara con una instantánea anterior, marcados como nuevos o peores. Es una lectura del
estado actual del código, sin el eje de la frecuencia de cambio. Para obtener el punto caliente de cambio hay que
cruzar esa información, por ejemplo la «complejidad ponderada de los métodos» (WMC) de cada clase, con
la frecuencia de cambio que da el control de versiones.
CodeScene. Una herramienta comercial de Tornhill. Por defecto usa como criterio la frecuencia de commits de cada fichero, y ofrece como alternativa la rotación relativa. En su visualización, las líneas de código de cada fichero hacen de sustituto de la complejidad. Su documentación de ayuda describe además cómo elige los puntos calientes para su indicador de salud del código: construye la distribución de frecuencias de cambio en una ventana reciente y toma los ficheros que quedan antes del punto en que la actividad cae.
Code Maat. No calcula la complejidad; da el eje del cambio. Su análisis revisions cuenta las revisiones de
cada fichero, y entity-churn, las líneas añadidas y borradas. El cruce con una métrica de complejidad se hace
aparte.
Referencias
- Tornhill, A. (2015). Your Code as a Crime Scene: Use Forensic Techniques to Arrest Defects, Bottlenecks, and Bad Design in Your Programs. The Pragmatic Bookshelf. (2.ª ed., 2024.) https://pragprog.com/titles/atcrime/your-code-as-a-crime-scene/
- Feathers, M. «Getting Empirical about Refactoring». Artículo en StickyMinds.
- Graves, T. L., Karr, A. F., Marron, J. S. y Siy, H. (2000). «Predicting Fault Incidence Using Software Change History». IEEE Transactions on Software Engineering, 26(7), 653-661.
- Moser, R., Pedrycz, W. y Succi, G. (2008). «A Comparative Analysis of the Efficiency of Change Metrics and Static Code Attributes for Defect Prediction». Proceedings of the 30th International Conference on Software Engineering (ICSE), 181-190. https://doi.org/10.1145/1368088.1368114
- CodeScene, guía de puntos calientes: https://docs.enterprise.codescene.io/versions/4.1.4/guides/technical/hotspots.html
- CodeScene, selección de puntos calientes para el análisis de salud del código: https://helpcenter.codescene.com/en/articles/3440704-how-are-hotspots-selected-for-hotspot-code-health-analysis
- Code Maat: https://github.com/adamtornhill/code-maat