temp 0.9.4: cleanup

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify temp.cleanup in pkg:npm/temp@0.9.4
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/temp@0.9.4
Demonstrate these symbols/APIs:
  - temp.cleanup
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:4ffcc5939279d6748f142bd7606ebb05674b18b1546bb44bf726d025e990c321","constraints":{"executionContext":"node"},"contract":["temp.cleanup rejects with an error when tracking is not enabled","temp.cleanup resolves with zero counts when tracking is enabled but no temporary files or directories exist","temp.cleanup asynchronously deletes tracked temporary files and directories returning deletion counts","temp.cleanup drains tracked item queues so subsequent cleanup calls return zero counts","temp.cleanup supports invocation with a node-style callback function"],"goal":"verify temp.cleanup in pkg:npm/temp@0.9.4","kind":"HOW","packages":["pkg:npm/temp@0.9.4"],"schemaVersion":1,"symbols":["temp.cleanup"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/temp@0.9.4"],"schemaVersion":1,"subject":"pkg:npm/temp@0.9.4","symbols":["temp.cleanup"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-temp-cleanup",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-temp-cleanup",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "temp": "0.9.4"
      }
    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "license": "MIT"
    },
    "node_modules/brace-expansion": {
      "version": "1.1.18",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.18.tgz",
      "integrity": "sha512-Edep/X9fGqVNmzKBVsDYIOtD+z1tuezV70LBjdCst9Tqu76lsnvRiZ6oTic1n+/BIwX6QDGAO94PN4N2SADvtw==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^1.0.0",
        "concat-map": "0.0.1"
      }
    },
    "node_modules/concat-map": {
      "version": "0.0.1",
      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
      "license": "MIT"
    },
    "node_modules/fs.realpath": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
      "license": "ISC"
    },
    "node_modules/glob": {
      "version": "7.2.3",
      "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
      "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
      "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me",
      "license": "ISC",
      "dependencies": {
        "fs.realpath": "^1.0.0",
        "inflight": "^1.0.4",
        "inherits": "2",
        "minimatch": "^3.1.1",
        "once": "^1.3.0",
        "path-is-absolute": "^1.0.0"
      },
      "engines": {
        "node": "*"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "node_modules/inflight": {
      "version": "1.0.6",
      "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
      "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
      "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.",
      "license": "ISC",
      "dependencies": {
        "once": "^1.3.0",
        "wrappy": "1"
      }
    },
    "node_modules/inherits": {
      "version": "2.0.4",
      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
      "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
      "license": "ISC"
    },
    "node_modules/minimatch": {
      "version": "3.1.5",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz",
      "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==",
      "license": "ISC",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
      "engines": {
        "node": "*"
      }
    },
    "node_modules/minimist": {
      "version": "1.2.8",
      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
      "license": "MIT",
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/mkdirp": {
      "version": "0.5.6",
      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz",
      "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==",
      "license": "MIT",
      "dependencies": {
        "minimist": "^1.2.6"
      },
      "bin": {
        "mkdirp": "bin/cmd.js"
      }
    },
    "node_modules/once": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
      "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
      "license": "ISC",
      "dependencies": {
        "wrappy": "1"
      }
    },
    "node_modules/path-is-absolute": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
      "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    },
    "node_modules/rimraf": {
      "version": "2.6.3",
      "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz",
      "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==",
      "deprecated": "Rimraf versions prior to v4 are no longer supported",
      "license": "ISC",
      "dependencies": {
        "glob": "^7.1.3"
      },
      "bin": {
        "rimraf": "bin.js"
      }
    },
    "node_modules/temp": {
      "version": "0.9.4",
      "resolved": "https://registry.npmjs.org/temp/-/temp-0.9.4.tgz",
      "integrity": "sha512-yYrrsWnrXMcdsnu/7YMYAofM1ktpL5By7vZhf15CrXijWWrEYZks5AXBudalfSWJLlnen/QUJUB5aoB0kqZUGA==",
      "license": "MIT",
      "dependencies": {
        "mkdirp": "^0.5.1",
        "rimraf": "~2.6.2"
      },
      "engines": {
        "node": ">=6.0.0"
      }
    },
    "node_modules/wrappy": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
      "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
      "license": "ISC"
    }
  }
}

{
  "name": "sample-temp-cleanup",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for temp.cleanup in temp@0.9.4",
  "main": "src/index.js",
  "license": "MIT-0",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "temp": "0.9.4"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify temp.cleanup in pkg:npm/temp@0.9.4",
  "kind": "HOW",
  "packages": [
    "pkg:npm/temp@0.9.4"
  ],
  "symbols": [
    "temp.cleanup"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const temp = require('temp');

/**
 * Enables temporary resource tracking.
 * @returns {typeof temp}
 */
function enableTracking() {
  return temp.track();
}

/**
 * Asynchronously cleans up all tracked temporary files and directories.
 * Returns a Promise if no callback is provided.
 *
 * @param {Function} [callback] - Optional callback (err, stats).
 * @returns {Promise<{files: number, dirs: number}>|undefined}
 */
function performCleanup(callback) {
  return temp.cleanup(callback);
}

/**
 * Creates a tracked temporary file.
 *
 * @param {string|Object} [affixes]
 * @returns {Promise<{path: string, fd: number}>}
 */
function createTrackedFile(affixes) {
  return temp.open(affixes);
}

/**
 * Creates a tracked temporary directory.
 *
 * @param {string|Object} [affixes]
 * @returns {Promise<string>}
 */
function createTrackedDirectory(affixes) {
  return temp.mkdir(affixes);
}

module.exports = {
  temp,
  enableTracking,
  performCleanup,
  createTrackedFile,
  createTrackedDirectory
};

import assert from 'node:assert/strict';
import fs from 'node:fs';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const {
  temp,
  enableTracking,
  performCleanup,
  createTrackedFile,
  createTrackedDirectory
} = require('../src/index.js');

async function testAll() {
  // 1. temp.cleanup rejects with an error when tracking is not enabled
  await assert.rejects(
    async () => {
      await temp.cleanup();
    },
    {
      name: 'Error',
      message: 'not tracking'
    },
    'temp.cleanup must reject when tracking has not been enabled'
  );

  // Enable tracking for subsequent tests
  enableTracking();

  // 2. temp.cleanup resolves with zero counts when tracking is enabled but no temporary files or directories exist
  const emptyCleanup = await performCleanup();
  assert.deepEqual(
    emptyCleanup,
    { files: 0, dirs: 0 },
    'temp.cleanup should return 0 files and 0 dirs when none exist'
  );

  // 3. temp.cleanup asynchronously deletes tracked temporary files and directories returning deletion counts
  const file1 = await createTrackedFile('cleanup-test-file-1');
  const file2 = await createTrackedFile('cleanup-test-file-2');
  const dir1 = await createTrackedDirectory('cleanup-test-dir-1');
  const dir2 = await createTrackedDirectory('cleanup-test-dir-2');

  // Close open file descriptors before cleanup
  fs.closeSync(file1.fd);
  fs.closeSync(file2.fd);

  assert.ok(fs.existsSync(file1.path), 'file1 must exist before cleanup');
  assert.ok(fs.existsSync(file2.path), 'file2 must exist before cleanup');
  assert.ok(fs.existsSync(dir1), 'dir1 must exist before cleanup');
  assert.ok(fs.existsSync(dir2), 'dir2 must exist before cleanup');

  const cleanupResult = await performCleanup();
  assert.equal(cleanupResult.files, 2, 'cleanup should report 2 files deleted');
  assert.equal(cleanupResult.dirs, 2, 'cleanup should report 2 dirs deleted');

  assert.ok(!fs.existsSync(file1.path), 'file1 must be deleted after cleanup');
  assert.ok(!fs.existsSync(file2.path), 'file2 must be deleted after cleanup');
  assert.ok(!fs.existsSync(dir1), 'dir1 must be deleted after cleanup');
  assert.ok(!fs.existsSync(dir2), 'dir2 must be deleted after cleanup');

  // 4. temp.cleanup drains tracked item queues so subsequent cleanup calls return zero counts
  const drainedResult = await performCleanup();
  assert.deepEqual(
    drainedResult,
    { files: 0, dirs: 0 },
    'subsequent cleanup call should return zero counts'
  );

  // 5. temp.cleanup supports invocation with a node-style callback function
  const fileForCallback = await createTrackedFile('cleanup-callback-file');
  fs.closeSync(fileForCallback.fd);
  assert.ok(fs.existsSync(fileForCallback.path), 'callback test file must exist before cleanup');

  const callbackStats = await new Promise((resolve, reject) => {
    temp.cleanup((err, stats) => {
      if (err) return reject(err);
      resolve(stats);
    });
  });

  assert.equal(callbackStats.files, 1, 'callback cleanup should report 1 file deleted');
  assert.ok(!fs.existsSync(fileForCallback.path), 'callback test file must be deleted');

  console.log('Contract tests passed successfully.');
}

testAll().catch((err) => {
  console.error('Contract test failure:', err);
  process.exit(1);
});