grafana/scripts/codeowners-manifest/metadata.js

62 lines
2.0 KiB
JavaScript
Raw Normal View History

Tests: Custom script to run unit tests filtered by code ownership (#111210) * feat(script): generate a source file x teams manifest from CODEOWNERS * feat(script): unit tests + coverage report only for files owned by team * feat(script): calculate CODEOWNERS metadata * refactor(script): export a pure codeowners manifest generation function * refactor(script): export a pure test coverage by team function * refactor(script): generate raw JSONL codeowners data from Node.js script * feat(script): put codeowners manifest all together in one script * refactor(scripts): group consistently with NPM script name * refactor(scripts): deduplicate constants for file paths etc. * refactor(scripts): make console output cute 💅✨ * refactor(tests): make coverage by "owner" directory more human readable * refactor(scripts): use consistent naming "codeowner" instead of "team" * chore(codeowners): mark DataViz as owners of scripts for now * chore(todo): leave a note where coverage metrics should be emitted later * fix(gitignore): ignore root codeowners-manifest directory not scripts/* * refactor(script): rename manifest to generate for clarity * docs(readme): add a brief README describing new scrips * chore(linter): ignore temporary files in prettier, fix whitespace format * refactor(script): simplify Jest config by using team files list directly * refactor(script): simplify script, partition sourceFiles and testFiles * refactor(script): simplify and parallelize manifest write operations * fix(script): handle errors for JSONL line reader * refactor(script): use Map instead of POJOs * fix(script): handle errors when streaming raw JSONL output * fix(script): add error handling, and use promise API for metadata check * fix(reporter): suppress duplicate Jest CLI coverage report output * refactor(script): simplify with fs promises API for consistency * fix(script): error handling for cp spawn-ed process * refactor(script): use Promise API for mkdir + exists * refactor(script): use fs Promise API * refactor(script): use fs Promise API * fix(script): same allow list for sourceFilter and all Jest config rules Co-authored-by: Paul Marbach <paul.marbach@grafana.com> * fix(script): bust cache when new files are created also --------- Co-authored-by: Paul Marbach <paul.marbach@grafana.com>
2025-10-08 05:07:55 +08:00
#!/usr/bin/env node
const { execSync } = require('node:child_process');
const { writeFile, mkdir, access } = require('node:fs/promises');
const { CODEOWNERS_FILE_PATH, CODEOWNERS_MANIFEST_DIR, METADATA_JSON_PATH } = require('./constants.js');
/**
* @typedef {Object} CodeownersMetadata
* @property {string} generatedAt - ISO timestamp when metadata was generated
* @property {string} filesHash - SHA-256 hash of all repository files
* @property {string} codeownersHash - SHA-256 hash of CODEOWNERS file
*/
/**
* Generate codeowners metadata for caching
* @param {string} codeownersFilePath - Path to CODEOWNERS file
* @param {string} manifestDir - Directory for manifest files
* @param {string} metadataFilename - Filename for metadata file
* @returns {CodeownersMetadata} Metadata object with hashes
*/
function generateCodeownersMetadata(codeownersFilePath, manifestDir, metadataFilename) {
const [filesHash] = execSync('git ls-files --cached --others --exclude-standard | sort | sha256sum', {
encoding: 'utf8',
})
.trim()
.split(' ');
const [codeownersHash] = execSync(`sha256sum "${codeownersFilePath}"`, { encoding: 'utf8' }).trim().split(' ');
return {
generatedAt: new Date().toISOString(),
filesHash,
codeownersHash,
};
}
if (require.main === module) {
(async () => {
try {
console.log('⚙️ Generating codeowners-manifest metadata ...');
try {
await access(CODEOWNERS_MANIFEST_DIR);
} catch (error) {
await mkdir(CODEOWNERS_MANIFEST_DIR, { recursive: true });
}
const metadata = generateCodeownersMetadata(CODEOWNERS_FILE_PATH, CODEOWNERS_MANIFEST_DIR, METADATA_JSON_PATH);
await writeFile(METADATA_JSON_PATH, JSON.stringify(metadata, null, 2), 'utf8');
console.log('✅ Metadata generated:');
console.log(`${METADATA_JSON_PATH}`);
} catch (error) {
console.error('❌ Error generating codeowners metadata:', error.message);
process.exit(1);
}
})();
}
module.exports = { generateCodeownersMetadata };