A inter-process and inter-machine lockfile utility that works on a local or network file system. 

A inter-process and inter-machine lockfile utility that works on a local or network file system

hugomrdias

satazor

proper-lockfile

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

# [4.1.0](https://github.com/moxystudio/node-proper-lockfile/compare/v4.0.0...v4.1.0) (2019-03-18)

* allow second precision in mtime comparison ([#78](https://github.com/moxystudio/node-proper-lockfile/issues/78)) ([b2816a6](https://github.com/moxystudio/node-proper-lockfile/commit/b2816a6))

# [4.0.0](https://github.com/moxystudio/node-proper-lockfile/compare/v3.2.0...v4.0.0) (2019-03-12)

* fix typo in error message ([#68](https://github.com/moxystudio/node-proper-lockfile/issues/68)) ([b91cb55](https://github.com/moxystudio/node-proper-lockfile/commit/b91cb55))

* make staleness check more robust ([#74](https://github.com/moxystudio/node-proper-lockfile/issues/74)) ([9cc0973](https://github.com/moxystudio/node-proper-lockfile/commit/9cc0973)), closes [#71](https://github.com/moxystudio/node-proper-lockfile/issues/71) [/github.com/ipfs/js-ipfs-repo/issues/188#issuecomment-468682971](https://github.com//github.com/ipfs/js-ipfs-repo/issues/188/issues/issuecomment-468682971)

* We were marking the lock as compromised when system went into sleep or if the event loop was busy taking too long to run the internals timers, Now we keep track of the mtime updated by the current process, and if we lose some cycles in the update process but recover and the mtime is still ours we do not mark the lock as compromised.

# [3.2.0](https://github.com/moxystudio/node-proper-lockfile/compare/v3.1.0...v3.2.0) (2018-11-19)

* add lock path option ([#66](https://github.com/moxystudio/node-proper-lockfile/issues/66)) ([32f1b8d](https://github.com/moxystudio/node-proper-lockfile/commit/32f1b8d))

# [3.1.0](https://github.com/moxystudio/node-proper-lockfile/compare/v3.0.2...v3.1.0) (2018-11-15)

* **package:** update retry to version 0.12.0 ([#50](https://github.com/moxystudio/node-proper-lockfile/issues/50)) ([d400b98](https://github.com/moxystudio/node-proper-lockfile/commit/d400b98))

* add signal exit ([#65](https://github.com/moxystudio/node-proper-lockfile/issues/65)) ([f20bc45](https://github.com/moxystudio/node-proper-lockfile/commit/f20bc45))

## [3.0.2](https://github.com/moxystudio/node-proper-lockfile/compare/v3.0.1...v3.0.2) (2018-01-30)

## [3.0.1](https://github.com/moxystudio/node-proper-lockfile/compare/v3.0.0...v3.0.1) (2018-01-20)

* restore ability to use lockfile() directly ([0ef8fbc](https://github.com/moxystudio/node-proper-lockfile/commit/0ef8fbc))

# [3.0.0](https://github.com/moxystudio/node-proper-lockfile/compare/v2.0.1...v3.0.0) (2018-01-20)

* update project to latest node lts ([b1d43e5](https://github.com/moxystudio/node-proper-lockfile/commit/b1d43e5))

* use of node lts language features such as object spread

* compromised function in lock() has been moved to an option

    return options.lockfilePath || `${file}.lock`;

function resolveCanonicalPath(file, options, callback) {

        return callback(null, path.resolve(file));

function acquireLock(file, options, callback) {

    // Use mkdir to create the lockfile (atomic operation)

    options.fs.mkdir(getLockFile(file, options), (err) => {

            return options.fs.stat(getLockFile(file, options), callback);

        // If error is not EEXIST then some other error occurred while locking

        // Otherwise, check if lock is stale by analyzing the file mtime

            return callback(Object.assign(new Error('Lock file is already being held'), { code: 'ELOCKED', file }));

        options.fs.stat(getLockFile(file, options), (err, stat) => {

                // Retry if the lockfile has been removed (meanwhile)

                // Skip stale check to avoid recursiveness

                if (err.code === 'ENOENT') {

                    return acquireLock(file, { ...options, stale: 0 }, callback);

            if (!isLockStale(stat, options)) {

                return callback(Object.assign(new Error('Lock file is already being hold'), { code: 'ELOCKED', file }));

            // If it's stale, remove it and try again!

            // Skip stale check to avoid recursiveness

            removeLock(file, options, (err) => {

                    return callback(err);

                acquireLock(file, { ...options, stale: 0 }, callback);

    return stat.mtime.getTime() < Date.now() - options.stale;

function removeLock(file, options, callback) {

    // Remove lockfile, ignoring ENOENT errors

    options.fs.rmdir(getLockFile(file, options), (err) => {

        if (err && err.code !== 'ENOENT') {

    // Just for safety, should never happen

    lock.updateDelay = lock.updateDelay || options.update;

    lock.updateTimeout = setTimeout(() => {

        // Check if mtime is still ours if it is we can still recover from a system sleep or a busy event loop

            const isOverThreshold = lock.lastUpdate + options.stale < Date.now();

            const isMtimeOurs = lock.mtime.getTime() === stat.mtime.getTime();

            const isMtimeOurs = lock.mtimeChecker(lock.mtime, stat.mtime);

                return setLockAsCompromised(

                        new Error('Unable to update lock within the stale threshold'),

                        { code: 'ECOMPROMISED' }

            options.fs.utimes(getLockFile(file, options), mtime, mtime, (err) => {

                const isOverThreshold = lock.lastUpdate + options.stale < Date.now();

                // Ignore if the lock was released

                // If it failed to update the lockfile, keep trying unless

                // the lockfile was deleted or we are over the threshold

                    if (err.code === 'ENOENT' || isOverThreshold) {

                        return setLockAsCompromised(file, lock, Object.assign(err, { code: 'ECOMPROMISED' }));

                    lock.updateDelay = 1000;

                    return updateLock(file, options);

                // All ok, keep updating..

                lock.lastUpdate = Date.now();

                updateLock(file, options);

    // Unref the timer so that the nodejs process can exit freely

    // This is safe because all acquired locks will be automatically released

    // We first check that `lock.updateTimeout.unref` exists because some users

    // may be using this module outside of NodeJS (e.g., in an electron app),

    // and in those cases `setTimeout` return an integer.

function setLockAsCompromised(file, lock, err) {

    // Just for safety, at this point updateTimeout should be null

        clearTimeout(lock.updateTimeout);

// ----------------------------------------------------------

        onCompromised: (err) => { throw err; },

    options.retries = options.retries || 0;

    options.retries = typeof options.retries === 'number' ? { retries: options.retries } : options.retries;

    options.stale = Math.max(options.stale || 0, 2000);

    options.update = options.update == null ? options.stale / 2 : options.update || 0;

    options.update = Math.max(Math.min(options.update, options.stale / 2), 1000);

    resolveCanonicalPath(file, options, (err, file) => {

        const operation = retry.operation(options.retries);

                    lastUpdate: Date.now(),

                    mtimeChecker: createMtimeChecker(),

                // We must keep the lock fresh to avoid staleness

                callback(null, (releasedCallback) => {

                        return releasedCallback &&

                            releasedCallback(Object.assign(new Error('Lock is already released'), { code: 'ERELEASED' }));

                    // Not necessary to use realpath twice when unlocking

                    unlock(file, { ...options, realpath: false }, releasedCallback);

		@@ -5,2 +5,12 @@ # Change Log

		<a name="4.1.0"></a>
		# [4.1.0](https://github.com/moxystudio/node-proper-lockfile/compare/v4.0.0...v4.1.0) (2019-03-18)


		### Features

		* allow second precision in mtime comparison ([#78](https://github.com/moxystudio/node-proper-lockfile/issues/78)) ([b2816a6](https://github.com/moxystudio/node-proper-lockfile/commit/b2816a6))



		<a name="4.0.0"></a>
		@@ -7,0 +17,0 @@ # [4.0.0](https://github.com/moxystudio/node-proper-lockfile/compare/v3.2.0...v4.0.0) (2019-03-12)

		@@ -114,3 +114,3 @@ 'use strict';

		const isMtimeOurs = lock.mtime.getTime() === stat.mtime.getTime();
		const isMtimeOurs = lock.mtimeChecker(lock.mtime, stat.mtime);

		@@ -233,2 +233,3 @@ if (!isMtimeOurs) {
		lastUpdate: Date.now(),
		mtimeChecker: createMtimeChecker(),
		};
		@@ -314,2 +315,25 @@

		function createMtimeChecker() {
		let precision;

		return (lockMtime, statMtime) => {
		// If lock time was not on the second we can determine precision
		if (!precision && lockMtime % 1000 !== 0) {
		precision = statMtime % 1000 === 0 ? 's' : 'ms';
		}

		if (precision === 's') {
		const lockTs = lockMtime.getTime();
		const statTs = statMtime.getTime();

		// Maybe the file system truncates or rounds...
		return Math.trunc(lockTs / 1000) === Math.trunc(statTs / 1000) \|\|
		Math.round(lockTs / 1000) === Math.round(statTs / 1000);
		}

		// Must be ms or lockMtime was on the second
		return lockMtime.getTime() === statMtime.getTime();
		};
		}

		// Remove acquired locks on exit
		@@ -316,0 +340,0 @@ /* istanbul ignore next */

		{
		"name": "proper-lockfile",
		"version": "4.0.0",
		"version": "4.1.0",
		"description": "A inter-process and inter-machine lockfile utility that works on a local or network file system",
		@@ -5,0 +5,0 @@ "keywords": [

Improved metrics