Understanding and Detecting Peer Dependency Resolving Loop in npm Ecosystem

TL;DR

This paper investigates the PeerSpin problem in npm, a peer dependency conflict causing infinite loops, and introduces PeerChecker, a detection tool that identified thousands of affected packages in the ecosystem.

Contribution

It provides the first in-depth analysis of PeerSpin, characterizes its root causes, and proposes a novel detection technique and tool for the npm ecosystem.

Findings

Detected 5,662 packages with PeerSpin

Confirmed 28 real PeerSpin issues

Open sourced detection tools and data sets

Abstract

As the default package manager for Node.js, npm has become one of the largest package management systems in the world. To facilitate dependency management for developers, npm supports a special type of dependency, Peer Dependency, whose installation and usage differ from regular dependencies. However, conflicts between peer dependencies can trap the npm client into infinite loops, leading to resource exhaustion and system crashes. We name this problem PeerSpin. Although PeerSpin poses a severe risk to ecosystems, it was overlooked by previous studies, and its impacts have not been explored. To bridge this gap, this paper conducts the first in-depth study to understand and detect PeerSpin in the npm ecosystem. First, by systematically analyzing the npm dependency resolution, we identify the root cause of PeerSpin and characterize two peer dependency patterns to guide detection. Second, we propose a novel technique called Node-Replacement-Conflict based PeerSpin Detection, which leverages the state of the directory tree during dependency resolution to achieve accurate and efficient PeerSpin detection. Based on this technique, we developed a tool called PeerChecker to detect PeerSpin. Finally, we apply PeerChecker to the entire NPM ecosystem and find that 5,662 packages, totaling 72,968 versions, suffer from PeerSpin. Up until now, we confirmed 28 real PeerSpin problems by reporting them to the package maintainer. We also open source all PeerSpin analysis implementations, tools, and data sets to the public to help the community detect PeerSpin issues and enhance the reliability of the npm ecosystem.