Files
react/scripts/facts-tracker/index.js
Christopher Chedeau dbd9c4b205 Introduce facts-tracker (#7747)
* Introduce facts-tracker

We want to be able to track various things like number of files that are flowified, number of tests passing with Fiber...

This introduces a tool that lets you do that. The API is very simple, you execute the script with a list of tuples [key value] and it's going to create a `facts` branch and put a txt file for each fact and values over time.

```
node scripts/facts-tracker/index.js \
  "flow-files" "$COUNT_WITH_FLOW/$COUNT_ALL_FILES"
```

Test Plan:
This is tricky to test because Travis only exposes the private variables (github token) when it processes a committed file and not on branches. The reason is that otherwise anyone could send a pull requests that does `echo $GITHUB_TOKEN` and steal your token.

Given this constraint, I did all the work using two of my repos:
- https://github.com/vjeux/facts-tracker
- https://github.com/vjeux/facts-tracker-test

and am sending this pull request that should work as is /fingers crossed/, but we won't be able to test it out until it is committed.

Note that once this lands, I'm going to kill those two repos.

* Update with all the suggested changes

* Branch on a flow type in travis.yml

* Use $GITHUB_TOKEN

* properly escape it
2016-09-26 12:58:51 -07:00

179 lines
5.0 KiB
JavaScript

#!/usr/bin/env node
/**
* Copyright (c) 2013-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
'use strict';
var fs = require('fs');
var path = require('path');
var execSync = require('child_process').execSync;
function escape(value) {
return '\'' + value.replace(/'/g, "'\\''") + '\'';
}
var cwd = null;
function exec(command) {
console.error('>', command.replace(process.env.GITHUB_TOKEN, '************'));
return execSync(command, cwd ? {cwd: cwd} : undefined).toString();
}
var isInsideOfTravis = !!process.env.TRAVIS_REPO_SLUG;
if (isInsideOfTravis) {
if (process.env.TRAVIS_BRANCH !== 'master') {
console.error('facts-tracker: Branch is not master, exiting...');
process.exit(0);
}
if (process.env.TRAVIS_PULL_REQUEST !== 'false') {
console.error('facts-tracker: This is a pull request, exiting...');
process.exit(0);
}
if (!process.env.GITHUB_USER || !process.env.GITHUB_TOKEN) {
console.error(
'In order to use facts-tracker, you need to configure a ' +
'few environment variables in order to be able to commit to the ' +
'repository. Follow those steps to get you setup:\n' +
'\n' +
'Go to https://github.com/settings/tokens/new\n' +
' - Fill "Token description" with "facts-tracker for ' +
process.env.TRAVIS_REPO_SLUG + '"\n' +
' - Check "public_repo"\n' +
' - Press "Generate Token"\n' +
'\n' +
'In a different tab, go to https://travis-ci.org/' +
process.env.TRAVIS_REPO_SLUG + '/settings\n' +
' - Make sure "Build only if .travis.yml is present" is ON\n' +
' - Fill "Name" with "GITHUB_TOKEN" and "Value" with the token you ' +
'just generated. Press "Add"\n' +
' - Fill "Name" with "GITHUB_USER" and "Value" with the name of the ' +
'account you generated the token with. Press "Add"\n' +
'\n' +
'Once this is done, commit anything to the repository to restart ' +
'Travis and it should work :)'
);
process.exit(1);
}
exec(
'echo "machine github.com login $GITHUB_USER password $GITHUB_TOKEN"' +
'> ~/.netrc'
);
exec(
'git config --global user.name ' +
escape(process.env.GITHUB_USER_NAME || 'facts-tracker')
);
exec(
'git config --global user.email ' +
escape(process.env.GITHUB_USER_EMAIL || 'facts-tracker@no-reply.github.com')
);
}
if (process.argv.length <= 2) {
console.error('Usage: facts-tracker <name1> <value1> <name2> <value2>...');
process.exit(1);
}
function getRepoSlug() {
if (isInsideOfTravis) {
return process.env.TRAVIS_REPO_SLUG;
}
var remotes = exec('git remote -v').split('\n');
for (var i = 0; i < remotes.length; ++i) {
var match = remotes[i].match(/^origin\t[^:]+:([^\.]+).+\(fetch\)/);
if (match) {
return match[1];
}
}
console.error('Cannot find repository slug, sorry.');
process.exit(1);
}
var repoSlug = getRepoSlug();
var currentCommitHash = exec('git rev-parse HEAD').trim();
var currentTimestamp = new Date().toISOString()
.replace('T', ' ')
.replace(/\..+/, '');
function checkoutFactsFolder() {
var factsFolder = '../' + repoSlug.split('/')[1] + '-facts';
if (!fs.existsSync(factsFolder)) {
var escapedRepoURL;
if (isInsideOfTravis) {
escapedRepoURL = 'https://$GITHUB_TOKEN@github.com/' + escape(repoSlug) + '.git';
} else {
escapedRepoURL = escape('git@github.com:' + repoSlug + '.git');
}
exec(
'git clone ' +
'--branch facts ' +
'--depth=5 ' +
escapedRepoURL + ' ' +
escape(factsFolder)
);
}
cwd = path.resolve(factsFolder);
exec('git fetch');
if (exec('git status --porcelain')) {
console.error('facts-tracker: `git status` is not clean, aborting.');
process.exit(1);
}
exec('git rebase origin/facts');
}
checkoutFactsFolder();
for (var i = 2; i < process.argv.length; i += 2) {
var name = process.argv[i].trim();
var value = process.argv[i + 1];
if (value.indexOf('\n') !== -1) {
console.error(
'facts-tracker: skipping', name,
'as the value contains new lines:', value
);
continue;
}
var filename = name + '.txt';
try {
var lastLine = exec('tail -n 1 ' + escape(filename));
} catch (e) {
// ignore error
}
var lastValue = lastLine && lastLine
.replace(/^[^\t]+\t[^\t]+\t/, '') // commit hash \t timestamp \t
.slice(0, -1); // trailing \n
if (value !== lastValue) {
fs.appendFileSync(
path.resolve(cwd, filename),
currentCommitHash + '\t' + currentTimestamp + '\t' + value + '\n'
);
}
console.log(name);
console.log(lastValue);
console.log(value);
}
if (exec('git status --porcelain')) {
exec('git add --all');
exec('git commit -m ' + escape('Adding facts for ' + currentCommitHash));
exec('git push origin facts');
} else {
console.error('facts-tracker: nothing to update');
}
cwd = null;