Fix the bug with incorrect source maps parsing by changing contract data from an array to a mapping

4 files changed, 22 insertions, 14 deletions

diff --git a/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts b/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts
index 57391abbe..7d85f6c68 100644
--- a/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts
+++ b/packages/sol-tracing-utils/src/artifact_adapters/sol_compiler_artifact_adapter.ts
@@ -43,9 +43,14 @@ export class SolCompilerArtifactAdapter extends AbstractArtifactAdapter {
                 logUtils.warn(`${artifactFileName} doesn't contain bytecode. Skipping...`);
                 continue;
             }
-            let sources = _.keys(artifact.sources);
-            sources = _.map(sources, relativeFilePath => path.resolve(this._sourcesPath, relativeFilePath));
-            const sourceCodes = _.map(sources, (source: string) => fs.readFileSync(source).toString());
+            const sources: { [sourceId: number]: string } = {};
+            const sourceCodes: { [sourceId: number]: string } = {};
+            _.map(artifact.sources, (value: { id: number }, relativeFilePath: string) => {
+                const filePath = path.resolve(this._sourcesPath, relativeFilePath);
+                const fileContent = fs.readFileSync(filePath).toString();
+                sources[value.id] = filePath;
+                sourceCodes[value.id] = fileContent;
+            });
             const contractData = {
                 sourceCodes,
                 sources,
diff --git a/packages/sol-tracing-utils/src/source_maps.ts b/packages/sol-tracing-utils/src/source_maps.ts
index ceb20d843..c674d32a3 100644
--- a/packages/sol-tracing-utils/src/source_maps.ts
+++ b/packages/sol-tracing-utils/src/source_maps.ts
@@ -33,20 +33,23 @@ export function getLocationByOffset(str: string): LocationByOffset {
 /**
  * Parses a sourcemap string.
  * The solidity sourcemap format is documented here: https://github.com/ethereum/solidity/blob/develop/docs/miscellaneous.rst#source-mappings
- * @param sourceCodes sources contents
+ * @param sourceCodes sources contents by index
  * @param srcMap source map string
  * @param bytecodeHex contract bytecode
- * @param sources sources file names
+ * @param sources sources file names by index
  */
 export function parseSourceMap(
-    sourceCodes: string[],
+    sourceCodes: { [fileIndex: number]: string },
     srcMap: string,
     bytecodeHex: string,
-    sources: string[],
+    sources: { [fileIndex: number]: string },
 ): { [programCounter: number]: SourceRange } {
     const bytecode = Uint8Array.from(Buffer.from(bytecodeHex, 'hex'));
     const pcToInstructionIndex: { [programCounter: number]: number } = getPcToInstructionIndexMapping(bytecode);
-    const locationByOffsetByFileIndex = _.map(sourceCodes, s => (_.isUndefined(s) ? {} : getLocationByOffset(s)));
+    const locationByOffsetByFileIndex: { [fileIndex: number]: LocationByOffset } = {};
+    _.map(sourceCodes, (sourceCode: string, fileIndex: number) => {
+        locationByOffsetByFileIndex[fileIndex] = _.isUndefined(sourceCode) ? {} : getLocationByOffset(sourceCode);
+    });
     const entries = srcMap.split(';');
     let lastParsedEntry: SourceLocation = {} as any;
     const instructionIndexToSourceRange: { [instructionIndex: number]: SourceRange } = {};
diff --git a/packages/sol-tracing-utils/src/trace_collector.ts b/packages/sol-tracing-utils/src/trace_collector.ts
index 943e208cf..f5dde8762 100644
--- a/packages/sol-tracing-utils/src/trace_collector.ts
+++ b/packages/sol-tracing-utils/src/trace_collector.ts
@@ -56,7 +56,7 @@ export class TraceCollector {
         this._singleFileSubtraceHandler = singleFileSubtraceHandler;
     }
     public async writeOutputAsync(): Promise<void> {
-        const finalCoverage = this._collector.getFinalCoverage();
+        const finalCoverage: Coverage = this._collector.getFinalCoverage();
         const stringifiedCoverage = JSON.stringify(finalCoverage, null, '\t');
         await mkdirpAsync('coverage');
         fs.writeFileSync('coverage/coverage.json', stringifiedCoverage);
@@ -80,14 +80,14 @@ export class TraceCollector {
         const bytecodeHex = stripHexPrefix(bytecode);
         const sourceMap = isContractCreation ? contractData.sourceMap : contractData.sourceMapRuntime;
         const pcToSourceRange = parseSourceMap(contractData.sourceCodes, sourceMap, bytecodeHex, contractData.sources);
-        for (let fileIndex = 0; fileIndex < contractData.sources.length; fileIndex++) {
+        _.map(contractData.sources, (_sourcePath: string, fileIndex: string) => {
             const singleFileCoverageForTrace = this._singleFileSubtraceHandler(
                 contractData,
                 traceInfo.subtrace,
                 pcToSourceRange,
-                fileIndex,
+                _.parseInt(fileIndex),
             );
             this._collector.add(singleFileCoverageForTrace);
-        }
+        });
     }
 }
diff --git a/packages/sol-tracing-utils/src/types.ts b/packages/sol-tracing-utils/src/types.ts
index 54ade0400..fa10a93d6 100644
--- a/packages/sol-tracing-utils/src/types.ts
+++ b/packages/sol-tracing-utils/src/types.ts
@@ -81,8 +81,8 @@ export interface ContractData {
     sourceMap: string;
     runtimeBytecode: string;
     sourceMapRuntime: string;
-    sourceCodes: string[];
-    sources: string[];
+    sourceCodes: { [sourceId: number]: string };
+    sources: { [sourceId: number]: string };
 }
 
 // Part of the trace executed within the same context