fix: removing only networks started by hedera instead of global prune

docker-compose-state-migration.yml

@@ -356,7 +356,7 @@ services:
 
 networks:
   network-node-bridge:
-    name: network-node-bridge
+    name: hedera-network-node-bridge
     driver: bridge
     ipam:
       driver: default
@@ -365,10 +365,10 @@ networks:
           ip_range: 172.27.0.0/24
           gateway: 172.27.0.254
   mirror-node:
-    name: mirror-node
+    name: hedera-mirror-node
     driver: bridge
   cloud-storage:
-    name: cloud-storage
+    name: hedera-cloud-storage
     driver: bridge
 
 volumes:

docker-compose.yml

@@ -501,7 +501,7 @@ services:
 
 networks:
   network-node-bridge:
-    name: network-node-bridge
+    name: hedera-network-node-bridge
     driver: bridge
     ipam:
       driver: default
@@ -510,10 +510,10 @@ networks:
           ip_range: 172.27.0.0/24
           gateway: 172.27.0.254
   mirror-node:
-    name: mirror-node
+    name: hedera-mirror-node
     driver: bridge
   cloud-storage:
-    name: cloud-storage
+    name: hedera-cloud-storage
     driver: bridge
 
 volumes:

src/constants.ts

@@ -36,6 +36,16 @@ export const CONTAINERS = [
     },
 ];
 
+/**
+ * Names of all the networks created by Docker Compose in this repository.
+ * Make sure to keep them up to date to always be able to remove them all using this service.
+ */
+export const NETWORK_NAMES = [
+    'hedera-cloud-storage',
+    'hedera-mirror-node',
+    'hedera-network-node-bridge',
+];
+
 export const CONSENSUS_NODE_LABEL = "network-node";
 export const MIRROR_NODE_LABEL = "mirror-node-rest";
 export const RELAY_LABEL = "json-rpc-relay";

src/services/DockerService.ts

@@ -35,6 +35,7 @@ import detectPort from 'detect-port';
 import * as dotenv from 'dotenv';
 import { CLIOptions } from '../types/CLIOptions';
 import path from 'path';
+import { SafeDockerNetworkRemover } from '../utils/SafeDockerNetworkRemover';
 
 dotenv.config();
 
@@ -90,7 +91,7 @@ export class DockerService implements IService{
 
     /**
      * Returns the null output path depending on the operating system.
-     * 
+     *
      * @public
      * @returns {string} - The null output path.
      */
@@ -391,7 +392,7 @@ export class DockerService implements IService{
         shell.exec(`docker compose down -v --remove-orphans 2>${nullOutput}`);
         this.logger.trace('Cleaning the volumes and temp files...', stateName);
         shell.exec(`rm -rf network-logs/* >${nullOutput} 2>&1`);
-        shell.exec(`docker network prune -f 2>${nullOutput}`);
+        SafeDockerNetworkRemover.removeAll();
         this.logger.info(`${LOADING} Trying to startup again...`, stateName);
     }
 }

src/state/StopState.ts

@@ -36,6 +36,7 @@ import {
 } from '../constants';
 import { CLIOptions } from '../types/CLIOptions';
 import { CLIService } from '../services/CLIService';
+import { SafeDockerNetworkRemover } from '../utils/SafeDockerNetworkRemover';
 
 export class StopState implements IState {
     /**
@@ -101,7 +102,7 @@ export class StopState implements IState {
         shell.exec(`rm -rf network-logs/* >${nullOutput} 2>&1`);
         this.logger.trace(`Working dir is ${this.cliOptions.workDir}`, this.stateName);
         shell.exec(`rm -rf "${join(this.cliOptions.workDir, 'network-logs')}" >${nullOutput} 2>&1`);
-        shell.exec(`docker network prune -f 2>${nullOutput}`);
+        SafeDockerNetworkRemover.removeAll();
         shell.cd(rootPath);
         this.logger.info(STOP_STATE_STOPPED_MESSAGE, this.stateName);
         this.observer?.update(EventType.Finish);

src/utils/SafeDockerNetworkRemover.ts

@@ -0,0 +1,66 @@
+/*-
+ *
+ * Hedera Local Node
+ *
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import shell from 'shelljs';
+import { IS_WINDOWS, NETWORK_NAMES } from "../constants";
+
+/**
+ * Checks if the given string is a valid Docker network ID.
+ * A valid Docker network ID is a 12-character hexadecimal string.
+ *
+ * @param {string} id - The string to be validated as a Docker network ID.
+ * @returns {boolean} - Returns true if the string is a valid Docker network ID, false otherwise.
+ *
+ * @example
+ * const id = "89ded1eca1d5";
+ * console.log(isCorrectDockerId(id)); // Output: true
+ *
+ * @example
+ * const invalidId = "invalidID123";
+ * console.log(isCorrectDockerId(invalidId)); // Output: false
+ */
+const isCorrectDockerId = (id: string) => id.trim() !== '' && /^[a-f0-9]{12}$/.test(id);
+
+/**
+ * Provides utility methods for safe networks removal
+ */
+export class SafeDockerNetworkRemover {
+  /**
+   * Removes all the networks started by docker compose.
+   */
+  public static removeAll() {
+    for (const network of NETWORK_NAMES) {
+      this.removeByName(network)
+    }
+  }
+
+  /**
+   * Removes one single network by its name.
+   */
+  public static removeByName(name: string) {
+    const result = shell.exec(`docker network ls --filter name=${name} --format "{{.ID}}"`);
+    if (!result || result.stderr !== '') {
+      return;
+    }
+    for (const id of result.stdout.split('\n').filter(isCorrectDockerId)) {
+      shell.exec(`docker network rm ${id} -f 2>${IS_WINDOWS ? 'null' : '/dev/null'}`);
+    }
+  }
+}

test/unit/states/InitState.spec.ts

@@ -21,6 +21,7 @@
 import { expect } from 'chai';
 import fs from 'fs';
 import yaml from 'js-yaml';
+import { after } from "mocha";
 import { join } from 'path';
 import { SinonSandbox, SinonSpy, SinonStub, SinonStubbedInstance } from 'sinon';
 import {
@@ -249,6 +250,11 @@ describe('InitState tests', () => {
             onStartStub.restore()
         })
 
+        after(() => {
+            fsReadFileSync.restore()
+            ymlLoad.restore()
+        })
+
         it('should execute "prepareWorkDirectory" as expected', async () => {
             prepareWorkDirectoryStub.restore()
 

test/unit/states/StopState.spec.ts

@@ -79,6 +79,11 @@ describe('StopState tests', () => {
 
     it('should execute onStart properly', async () => {
         const { shellCDStub, shellExecStub }= shellTest;
+        const network = { name: 'hedera-cloud-storage', id: '89ded1eca1d5' };
+        shellExecStub
+          .withArgs(`docker network ls --filter name=${network.name} --format "{{.ID}}"`)
+          .returns({ stderr: '', stdout: network.id });
+
         await stopState.onStart();
 
         // loggin messages
@@ -100,7 +105,7 @@ describe('StopState tests', () => {
         testSandbox.assert.calledWith(shellExecStub, 'docker compose down -v --remove-orphans 2>/dev/null');
         testSandbox.assert.calledWith(shellExecStub, 'rm -rf network-logs/* >/dev/null 2>&1');
         testSandbox.assert.calledWith(shellExecStub, 'rm -rf "testDir/network-logs" >/dev/null 2>&1');
-        testSandbox.assert.calledWith(shellExecStub, 'docker network prune -f 2>/dev/null');
+        testSandbox.assert.calledWith(shellExecStub, `docker network ls --filter name=${network.name} --format "{{.ID}}"`);
 
         expect(processTest.processCWDStub.calledOnce).to.be.true;
     })

test/unit/utils/SafeDockerNetworkRemover.spec.ts

@@ -0,0 +1,104 @@
+/*-
+ *
+ * Hedera Local Node
+ *
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { SafeDockerNetworkRemover } from '../../../src/utils/SafeDockerNetworkRemover';
+import { IS_WINDOWS, NETWORK_NAMES } from '../../../src/constants';
+import { getTestBed } from '../testBed';
+import yaml, {load, loadAll} from 'js-yaml';
+import fs, {createReadStream, readdirSync, readFile, readFileSync} from 'fs';
+import { join } from "path";
+
+describe('SafeDockerNetworkRemover', () => {
+  let shellExecStub: sinon.SinonStub;
+
+  before(() => {
+    let {
+      shellStubs
+    } = getTestBed({
+      workDir: 'testDir',
+    });
+
+    shellExecStub = shellStubs.shellExecStub;
+  });
+
+  describe('removeByName', () => {
+    it('should remove the network when a valid ID is returned', () => {
+      shellExecStub
+        .withArgs('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')
+        .returns({ stderr: '', stdout: '89ded1eca1d5\n' });
+
+      shellExecStub
+        .withArgs('docker network rm 89ded1eca1d5 -f 2>null')
+        .returns({ stderr: '', stdout: '' });
+
+      SafeDockerNetworkRemover.removeByName('hedera-cloud-storage');
+
+      expect(shellExecStub.calledWith('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')).to.be.true;
+      expect(shellExecStub.calledWith(`docker network rm 89ded1eca1d5 -f 2>${IS_WINDOWS ? 'null' : '/dev/null'}`)).to.be.true;
+    });
+
+    it('should not attempt to remove network if no valid ID is returned', () => {
+      shellExecStub
+        .withArgs('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')
+        .returns({ stderr: '', stdout: 'invalidID123\n' });
+
+      SafeDockerNetworkRemover.removeByName('hedera-cloud-storage');
+
+      expect(shellExecStub.calledWith('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')).to.be.true;
+      expect(shellExecStub.calledWith('docker network rm invalidID123 -f 2>null')).to.be.false;
+    });
+
+    it('should handle shell errors gracefully', () => {
+      shellExecStub
+        .withArgs('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')
+        .returns({ stderr: 'some error', stdout: '' });
+
+      SafeDockerNetworkRemover.removeByName('hedera-cloud-storage');
+
+      expect(shellExecStub.calledWith('docker network ls --filter name=hedera-cloud-storage --format "{{.ID}}"')).to.be.true;
+      expect(shellExecStub.calledWith('docker network rm 89ded1eca1d5 -f 2>null')).to.be.false;
+    });
+  });
+
+  describe('removeAll', () => {
+    it('should call removeByName for each network', () => {
+      const removeByNameStub = sinon.stub(SafeDockerNetworkRemover, 'removeByName');
+      SafeDockerNetworkRemover.removeAll();
+      expect(removeByNameStub.calledWith('hedera-cloud-storage')).to.be.true;
+      removeByNameStub.restore();
+    });
+    it('check if all of the networks from composer yaml files are listed in the NETWORK_NAMES const', () => {
+      const relativePath = '../../..';
+      const files = readdirSync(join(__dirname, relativePath)).filter(name => /^docker-compose.*\.yml$/.test(name));
+      let actual = [];
+      for (const file of files) {
+        const data = readFileSync(join(__dirname, `${relativePath}/${file}`));
+        const config = load(data.toString());
+        actual = [...actual, ...Object.values(config.networks || {}).map((network: any) => network.name.trim())];
+      }
+      expect([...new Set(actual)].sort().join(',')).to.equal(
+        NETWORK_NAMES.sort().join(','),
+        `Make sure that no network is missing in NETWORK_NAMES const. It won't be removed by 'npm run stop' otherwise`,
+      );
+    });
+  });
+});