feat(Merger): add support for circular dependencies

Relates #27

lib/fileAnalyzer.ts

@@ -121,6 +121,7 @@ export class FileAnalyzer {
 
     return {
       file,
+      importStatement,
       globalRenameImport,
       namedImports,
     };
@@ -172,6 +173,7 @@ export interface FileAnalyzerResult {
 }
 
 export interface FileAnalyzerImportsResult {
+  importStatement: string;
   file: string;
   globalRenameImport: string | null;
   namedImports: FileAnalyzerNamedImportResult[] | null;

lib/merger.ts

@@ -11,12 +11,13 @@ import {
 } from './fileAnalyzer';
 
 const error = Debug('sol-merger:error');
-const log = Debug('sol-merge:log');
+const debug = Debug('sol-merger:debug');
 
 export class Merger {
   delimeter: string = this.options.delimeter || '\n\n';
   removeComments: boolean;
 
+  registeredImportStatements: string[] = [];
   registeredImports: RegistredImport[] = [];
   nodeModulesRoot: string = null;
 
@@ -59,15 +60,37 @@ export class Merger {
     );
   }
 
+  async init(file: string) {
+    this.registeredImports = [];
+    this.registeredImportStatements = [];
+    this.nodeModulesRoot = await this.getNodeModulesPath(file);
+  }
+
+  isImportProcessed(importStatement: string): boolean {
+    return this.registeredImportStatements.includes(importStatement);
+  }
+
+  registerImportStatement(importStatement: string) {
+    this.registeredImportStatements.push(importStatement);
+  }
+
   async processFile(
     file: string,
     isRoot: boolean,
     parentImport?: FileAnalyzerImportsResult,
-  ) {
+  ): Promise<string> {
     if (isRoot) {
-      this.registeredImports = [];
-      this.nodeModulesRoot = await this.getNodeModulesPath(file);
+      await this.init(file);
+    }
+    if (this.isImportProcessed(parentImport?.importStatement)) {
+      return '';
+    }
+    if (parentImport) {
+      this.registerImportStatement(parentImport.importStatement);
     }
+
+    debug('Processing file %s', file);
+
     const analyzedFile = await new FileAnalyzer(
       file,
       this.removeComments,
@@ -159,7 +182,7 @@ export class Merger {
         : null;
     const isImported = this.isImported(analyzedFile.filename, e.name, rename);
     if (isImported) {
-      log('%s %s %s', '⚠', e.name, analyzedFile.filename);
+      debug('%s Already imported: %s %s', '⚠', e.name, analyzedFile.filename);
       return;
     }
     if (beImported) {

package.json

@@ -61,7 +61,7 @@
     "ts-node": "^8.3.0",
     "tslib": "^1.10.0",
     "tslint": "^5.17.0",
-    "typescript": "^3.5.2",
+    "typescript": "^3.7.4",
     "zeppelin-solidity": "^1.12.0"
   }
 }

test/compiled/circular/Circular1.sol

@@ -0,0 +1,18 @@
+pragma solidity >=0.4.21 <0.6.0;
+
+
+contract Circular1 {
+  address public owner;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+}
+
+contract Circular2 {
+  address public owner;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+}

test/contracts/circular/Circular1.sol

@@ -0,0 +1,11 @@
+pragma solidity >=0.4.21 <0.6.0;
+
+import "./Circular2.sol";
+
+contract Circular1 {
+  address public owner;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+}

test/contracts/circular/Circular2.sol

@@ -0,0 +1,11 @@
+pragma solidity >=0.4.21 <0.6.0;
+
+import "./Circular1.sol";
+
+contract Circular2 {
+  address public owner;
+
+  constructor() public {
+    owner = msg.sender;
+  }
+}

test/fileAnalyzer.spec.ts

@@ -17,6 +17,7 @@ describe('FileAnalyzer', () => {
       const result = fileAnalyzer.analyzeImport('import "filename.sol";');
       assert.deepEqual(result, {
         file: 'filename.sol',
+        importStatement: 'import "filename.sol";',
         globalRenameImport: null,
         namedImports: null,
       });
@@ -30,6 +31,7 @@ describe('FileAnalyzer', () => {
         result,
         {
           file: 'filename.sol',
+          importStatement: 'import "filename.sol" as myName;',
           globalRenameImport: 'myName',
           namedImports: null,
         },
@@ -43,6 +45,7 @@ describe('FileAnalyzer', () => {
         result,
         {
           file: 'filename.sol',
+          importStatement: 'import * as myName from "filename.sol";',
           globalRenameImport: 'myName',
           namedImports: null,
         },
@@ -56,6 +59,7 @@ describe('FileAnalyzer', () => {
       );
       assert.deepEqual(result, {
         file: 'filename.sol',
+        importStatement: 'import { A, B as Bingo, C as C1, D } from "filename.sol";',
         globalRenameImport: null,
         namedImports: [
           {
@@ -95,21 +99,25 @@ describe('FileAnalyzer', () => {
       assert.deepEqual(imports, [
         {
           file: 'filename.sol',
+          importStatement: 'import "filename.sol";',
           globalRenameImport: null,
           namedImports: null,
         },
         {
           file: 'filename1.sol',
+          importStatement: 'import "filename1.sol" as myName;',
           globalRenameImport: 'myName',
           namedImports: null,
         },
         {
           file: 'filename2.sol',
+          importStatement: 'import * as myName from "filename2.sol";',
           globalRenameImport: 'myName',
           namedImports: null,
         },
         {
           file: 'filename3.sol',
+          importStatement: 'import { A, B as Bingo, C as C1, D } from "filename3.sol";',
           globalRenameImport: null,
           namedImports: [
             {
@@ -189,9 +197,9 @@ describe('FileAnalyzer', () => {
 
     it('should return empty array if there are no exports', () => {
       const exports = fileAnalyzer.analyzeExports(`
-        Some contracts without exports
+        // Some contracts without exports
 
-        Some contract text that is not required here
+        // Some contract text that is not required here
       `);
 
       assert.deepEqual(exports, []);

test/index.spec.ts

@@ -12,6 +12,7 @@ describe('Solidity Merger', () => {
       'Delimeter must be set to 2 new lines',
     );
     assert.isArray(merger.registeredImports, 'Must be initialized as array');
+    assert.isArray(merger.registeredImportStatements, 'Must be initialized as array');
   });
 
   it('should import relative files', async () => {
@@ -63,4 +64,8 @@ describe('Solidity Merger', () => {
   it('should compile file leaving the comments inside exports', async () => {
     await testFile('LocalImportsWithComments', { removeComments: false });
   });
+
+  it('should compile while having circular dependencies', async () => {
+    await testFile('circular/Circular1');
+  })
 });