aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-tracing-utils/src/trace_collector.ts
diff options
context:
space:
mode:
authorHsuan Lee <boczeratul@gmail.com>2019-03-06 17:46:50 +0800
committerHsuan Lee <boczeratul@gmail.com>2019-03-06 17:46:50 +0800
commit35703539d0f2b4ddb3b11d0de8c9634af59ab71f (patch)
treeae3731221dbbb3a6fa40060a8d916cfd3f738289 /packages/sol-tracing-utils/src/trace_collector.ts
parent92a1fde5b1ecd81b07cdb5bf0c9c1cd3544799db (diff)
downloaddexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.gz
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.bz2
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.lz
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.xz
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.tar.zst
dexon-0x-contracts-35703539d0f2b4ddb3b11d0de8c9634af59ab71f.zip
Deploy @dexon-foundation/0x.jsstable
Diffstat (limited to 'packages/sol-tracing-utils/src/trace_collector.ts')
-rw-r--r--packages/sol-tracing-utils/src/trace_collector.ts106
1 files changed, 0 insertions, 106 deletions
diff --git a/packages/sol-tracing-utils/src/trace_collector.ts b/packages/sol-tracing-utils/src/trace_collector.ts
deleted file mode 100644
index 2a1f15b83..000000000
--- a/packages/sol-tracing-utils/src/trace_collector.ts
+++ /dev/null
@@ -1,106 +0,0 @@
-import { promisify } from '@0x/utils';
-import chalk from 'chalk';
-import { stripHexPrefix } from 'ethereumjs-util';
-import * as fs from 'fs';
-import { Collector } from 'istanbul';
-import * as _ from 'lodash';
-import { getLogger, levels, Logger } from 'loglevel';
-import * as mkdirp from 'mkdirp';
-
-import { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter';
-import { constants } from './constants';
-import { parseSourceMap } from './source_maps';
-import {
- ContractData,
- Coverage,
- SourceRange,
- Subtrace,
- TraceInfo,
- TraceInfoExistingContract,
- TraceInfoNewContract,
-} from './types';
-import { utils } from './utils';
-
-const mkdirpAsync = promisify<undefined>(mkdirp);
-
-export type SingleFileSubtraceHandler = (
- contractData: ContractData,
- subtrace: Subtrace,
- pcToSourceRange: { [programCounter: number]: SourceRange },
- fileIndex: number,
-) => Coverage;
-
-/**
- * TraceCollector is used by CoverageSubprovider to compute code coverage based on collected trace data.
- */
-export class TraceCollector {
- private readonly _artifactAdapter: AbstractArtifactAdapter;
- private readonly _logger: Logger;
- private _contractsData!: ContractData[];
- private readonly _collector = new Collector();
- private readonly _singleFileSubtraceHandler: SingleFileSubtraceHandler;
-
- /**
- * Instantiates a TraceCollector instance
- * @param artifactAdapter Adapter for used artifacts format (0x, truffle, giveth, etc.)
- * @param isVerbose If true, we will log any unknown transactions. Otherwise we will ignore them
- * @param singleFileSubtraceHandler A handler function for computing partial coverage for a single file & subtrace
- */
- constructor(
- artifactAdapter: AbstractArtifactAdapter,
- isVerbose: boolean,
- singleFileSubtraceHandler: SingleFileSubtraceHandler,
- ) {
- this._artifactAdapter = artifactAdapter;
- this._logger = getLogger('sol-tracing-utils');
- this._logger.setLevel(isVerbose ? levels.TRACE : levels.ERROR);
- this._singleFileSubtraceHandler = singleFileSubtraceHandler;
- }
- public async writeOutputAsync(): Promise<void> {
- const finalCoverage: Coverage = this._collector.getFinalCoverage();
- const stringifiedCoverage = JSON.stringify(finalCoverage, null, '\t');
- await mkdirpAsync('coverage');
- fs.writeFileSync('coverage/coverage.json', stringifiedCoverage);
- }
- public async computeSingleTraceCoverageAsync(traceInfo: TraceInfo): Promise<void> {
- if (_.isUndefined(this._contractsData)) {
- this._contractsData = await this._artifactAdapter.collectContractsDataAsync();
- }
- const isContractCreation = traceInfo.address === constants.NEW_CONTRACT;
- const bytecode = isContractCreation
- ? (traceInfo as TraceInfoNewContract).bytecode
- : (traceInfo as TraceInfoExistingContract).runtimeBytecode;
- const contractData = utils.getContractDataIfExists(this._contractsData, bytecode);
- if (_.isUndefined(contractData)) {
- const shortenHex = (hex: string) => {
- /**
- * Length chooses so that both error messages are of the same length
- * and it's enough data to figure out which artifact has a problem.
- */
- const length = 18;
- return `${hex.substr(0, length + 2)}...${hex.substr(hex.length - length, length)}`;
- };
- const errMsg = isContractCreation
- ? `Unable to find matching bytecode for contract creation ${chalk.bold(
- shortenHex(bytecode),
- )}, please check your artifacts. Ignoring...`
- : `Unable to find matching bytecode for contract address ${chalk.bold(
- traceInfo.address,
- )}, please check your artifacts. Ignoring...`;
- this._logger.warn(errMsg);
- return;
- }
- const bytecodeHex = stripHexPrefix(bytecode);
- const sourceMap = isContractCreation ? contractData.sourceMap : contractData.sourceMapRuntime;
- const pcToSourceRange = parseSourceMap(contractData.sourceCodes, sourceMap, bytecodeHex, contractData.sources);
- _.map(contractData.sources, (_sourcePath: string, fileIndex: string) => {
- const singleFileCoverageForTrace = this._singleFileSubtraceHandler(
- contractData,
- traceInfo.subtrace,
- pcToSourceRange,
- _.parseInt(fileIndex),
- );
- this._collector.add(singleFileCoverageForTrace);
- });
- }
-}