Merge pull request #2 from emarteca/remove-usability-improvements

Remove usability improvements

Author: reallyTG

README.md

@@ -106,6 +106,23 @@ cd ../..
 ./transform.sh Playground/serve-static "static"
 ```
 
+#### Remove Functions in `serve-static`
+
+Stubbifier also supports a `--removeFuns <>` option, allowing users to specify a set of functions that should be totally removed from an application.
+The format of the file should match the format of the static callgraph; thus, we illustrate this functionality with `serve-static` using the static CG:
+
+```
+./resetProject.sh Playground/serve-static
+
+# If you haven't already: ./genStaticCG.sh Playground/serve-static serve-static 
+
+# 
+./remove.sh Playground/serve-static "static"
+```
+
+This should (1) remove all functions detected with the static call graph, and stub the rest. 
+If you look at, e.g., index.js (`vim Playground/serve-static/index.js`), you should see a mix of removed functions and stubbed functions.
+
 ### Integration with bundlers
 We also support integration with `rollup`, a popular JavaScript bundler.
 `bundler_mode` is another mode of `stubbifier` execution, with options:

functionLevelStubs.ts

@@ -94,7 +94,6 @@ function processAST(ast: babel.Program,
 						)]);
 					}
 				} else if ((bundlerMode && shouldTransformBundlerMode(path.node)) || (shouldTransformFunction(functionUIDName, reachableFuns, uncoveredMode, path.node))) {
-					// console.log("Triggered stubbification.");
 					if (path.node.kind == "constructor" || path.node.generator || path.node.async) { // TODO broken for generators -- is this true?
 						path.skip(); // don't transform a constructor or anything in a constructor (stubs dont work with "super" and "this")
 					} else {

remove.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# finds the absolute path from relative path
+# called realpath bc thats the utility on linux
+# https://stackoverflow.com/questions/3572030/bash-script-absolute-path-with-os-x
+realpathMACHACK() {
+    [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
+transformType=$2
+projDir=$1
+guardedMode="true"
+bundlerMode="no"
+
+if [ "$#" -ge 3 ]; then
+	guardedMode=$3
+fi
+
+if [ "$#" -ge 4 ]; then    
+        bundlerMode=$4    
+fi 
+
+if [[ "$transformType" == "dynamic" ]]; then
+	node stubbifyRunner.js --transform $projDir --removeFuns `realpathMACHACK $projDir/coverage/coverage-final.json` --dependencies $projDir/dep_list.txt --guarded_exec_mode $guardedMode --bundler_mode $bundlerMode
+elif [[ "$transformType" == "static" ]]; then 
+	node stubbifyRunner.js --transform $projDir --callgraph `realpathMACHACK $projDir/static_callgraph.csv` --removeFuns `realpathMACHACK $projDir/static_callgraph.csv` --dependencies $projDir/dep_list.txt --guarded_exec_mode $guardedMode --bundler_mode $bundlerMode
+else
+	echo "Error: transform_type must be either \"dynamic\" or \"static\""
+	echo "Usage: ./transform.sh proj_dir ( \"dynamic\" | \"static\" )"
+fi

stubbifyRunner.ts

@@ -6,6 +6,7 @@ import { fileStubFile} from './fileLevelStubs.js'
 import {getTargetsFromACG, getTargetsFromCoverageReport, buildHappyName, buildEvalCheck, getFileName, generateBundlerConfig} from './ACGParseUtils.js';
 import {argv} from 'yargs';
 import { execSync } from "child_process";
+import { debugPort } from "process";
 
 const getAllFiles = function( dirname, recurse = false, listOfFiles = []) {
 	let baseListOfFiles = fs.readdirSync( dirname);
@@ -79,6 +80,7 @@ let removeFuns : string[] = [];
 let noCG : boolean = true;
 let uncoveredMode: boolean = !(argv.uncovered == undefined);
 let depList: string[];
+
 if ( callgraphpath) {
 	let targets: string[] = getTargetsFromACG(callgraphpath);
 	functions = targets.map(buildHappyName);
@@ -88,7 +90,10 @@ if ( callgraphpath) {
 let zipFiles = false; // Currently don't ever do this.
 
 if (removeFunsPath) {
-	removeFuns = getTargetsFromACG(removeFunsPath).map(buildHappyName);
+	const targetsForRemoval = getTargetsFromACG(removeFunsPath);
+	listedFiles = listedFiles.concat(targetsForRemoval.map(getFileName));
+	removeFuns = targetsForRemoval.map(buildHappyName);
+	noCG = false;
 }
 
 if ( uncoveredMode) {
@@ -101,9 +106,6 @@ if ( uncoveredMode) {
 			listedFiles.push(element);
 	});
 	noCG = false;
-
-	console.log(listedFiles);
-	console.log(functions);
 } 
 
 if ( argv.dependencies) {
@@ -175,8 +177,8 @@ if (bundlerMode != "no") {
 		files.forEach(function(file, index) {
 			// console.log(file);
 			// only stubify JS files
-			let curPath: string = filename + file;
-			curPath = file;
+			// let curPath: string = filename + file;
+			const curPath = file;
 			// console.log("decision: " + shouldStubbify(curPath, file, depList));
 			// let curAbsPath: string = process.cwd() + curPath;
 			if( shouldStubbify( curPath, file, depList)) { // don't even try to stub externs