An empirical study on the impact of refactoring activities on evolving client-used APIs

Abstract

ContextRefactoring is recognized as an effective practice to maintain evolving software systems. For software libraries, we study how library developers refactor their Application Programming Interfaces (APIs), especially when it impacts client users by breaking an API of the library. ObjectiveOur work aims to understand how clients that use a library API are affected by refactoring activities. We target popular libraries that potentially impact more library client users. MethodWe distinguish between library APIs based on their client-usage (referred to as client-used APIs) in order to understand the extent to which API breakages relate to refactorings. Our tool-based approach allows for a large-scale study across eight libraries (i.e., totaling 183 consecutive versions) with around 900 clients projects. ResultsWe find that library maintainers are less likely to break client-used API classes. Quantitatively, we find that refactoring activities break less than 37% of all client-used APIs. In a more qualitative analysis, we show two documented cases of where non-refactoring API breaking changes are motivated other maintenance issues (i.e., bug fix and new features) and involve more complex refactoring operations. ConclusionUsing our automated approach, we find that library developers are less likely to break APIs and tend to break client-used APIs when performing maintenance issues.