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

README.md

@@ -90,6 +90,7 @@ npm install && npm install -g
 
 > **_NOTE:_**  If you want to use any of the CLI options listed below, you'd need to pass `--` after `npm run start` (for example) and then specify the wanted option. For example, if you want to start in detached mode, you can use `npm run start -- -d`
 
+> **_WARNING:_** While stopping the networks, we will first list all Docker networks with the `hedera-` prefix in their names. This operation may affect not only the networks initiated by the `npm run start` command from this repository but also any other networks you have created with this prefix. Network termination can be triggered both by a direct `npm run stop` call and by the `npm run start` script if the initial startup process fails and failover recovery is activated. One of the recovery steps includes attempting to close all previously started networks with the `hedera-` prefix.
 
 ## Using hedera-local
 

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.evm.yml

@@ -8,6 +8,9 @@ services:
         "echo 'Deleting old recordStream files.';find /records/ -type f -delete;echo 'This container is intentionally disabled by the EVM profile.';"
       ]
     command: []
+    networks:
+      - uploader-network
+
   account-balances-uploader:
     restart: "no"
     entrypoint:
@@ -17,6 +20,9 @@ services:
         "echo 'Deleting old accountBalances files.';find /balances/ -type f -delete;echo 'This container is intentionally disabled by the EVM profile.';"
       ]
     command: []
+    networks:
+      - uploader-network
+
   record-sidecar-uploader:
     restart: "no"
     entrypoint:
@@ -26,6 +32,9 @@ services:
         "echo 'Deleting old sidecars files.';find /sidecar-files/ -type f -delete;echo 'This container is intentionally disabled by the EVM profile.';"
       ]
     command: []
+    networks:
+      - uploader-network
+
   minio:
     restart: "no"
     entrypoint:
@@ -34,8 +43,18 @@ services:
         "This container is intentionally disabled by the EVM profile."
       ]
     command: []
+    networks:
+      - uploader-network
+
   importer:
     user: root
     volumes:
       - "${NETWORK_NODE_LOGS_ROOT_PATH}/accountBalances/balance0.0.3:/node/streams/accountBalances/balance0.0.3"
       - "${NETWORK_NODE_LOGS_ROOT_PATH}/recordStreams/record0.0.3:/node/streams/recordstreams/record0.0.3"
+    networks:
+      - uploader-network
+
+networks:
+  uploader-network:
+    name: hedera-uploader-network
+    driver: bridge

docker-compose.multinode.evm.yml

@@ -48,3 +48,10 @@ services:
     volumes:
       - "${NETWORK_NODE_LOGS_ROOT_PATH}/accountBalances/:/node/streams/accountBalances/"
       - "${NETWORK_NODE_LOGS_ROOT_PATH}/recordStreams/:/node/streams/recordstreams/"
+    networks:
+      - multinode-importer-evm-network
+
+networks:
+  multinode-importer-evm-network:
+    name: hedera-multinode-importer-evm
+    driver: bridge

docker-compose.multinode.yml

@@ -15,6 +15,8 @@ services:
       start_period: 10s
     volumes:
       - "${APPLICATION_ROOT_PATH}/config.multinode.txt:/opt/hgcapp/services-hedera/HapiApp2.0/config.txt"
+    networks:
+      - network-node-bridge
 
   network-node-1:
     &network-node-definition
@@ -222,3 +224,10 @@ services:
   importer:
     volumes:
       - ./compose-network/mirror-node/addressBook.multinode.bin:/usr/etc/hedera-mirror-importer/local-dev-1-node.addressbook.f102.json.bin
+    networks:
+      - multinode-importer-network
+
+networks:
+  multinode-importer-network:
+    name: hedera-multinode-importer
+    driver: bridge

docker-compose.yml

@@ -288,6 +288,8 @@ services:
     environment:
       DOCKER_LOCAL_MIRROR_NODE_MENU_NAME: ${DOCKER_LOCAL_MIRROR_NODE_MENU_NAME}
       DOCKER_LOCAL_MIRROR_NODE_URL: ${DOCKER_LOCAL_MIRROR_NODE_URL}
+    networks:
+      - mirror-node
 
   web3:
     image: "${MIRROR_IMAGE_PREFIX}hedera-mirror-web3:${MIRROR_WEB3_IMAGE_TAG:-${MIRROR_IMAGE_TAG}}"
@@ -501,7 +503,7 @@ services:
 
 networks:
   network-node-bridge:
-    name: network-node-bridge
+    name: hedera-network-node
     driver: bridge
     ipam:
       driver: default
@@ -510,10 +512,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,8 @@ export const CONTAINERS = [
     },
 ];
 
+export const NETWORK_PREFIX = 'hedera-';
+
 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,57 @@
+/*-
+ *
+ * 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_PREFIX } 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. Only networks with the "hedera-" prefix will be affected.
+   */
+  public static removeAll() {
+    const result = shell.exec(`docker network ls --filter name=${NETWORK_PREFIX} --format "{{.ID}}"`);
+    if (!result || result.stderr !== '') {
+      return;
+    }
+    result.stdout.split('\n').filter(isCorrectDockerId).forEach((id) => {
+      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

@@ -24,6 +24,7 @@ import { StopState } from '../../../src/state/StopState';
 import {
   DOCKER_CLEANING_VALUMES_MESSAGE,
   DOCKER_STOPPING_CONTAINERS_MESSAGE,
+  NETWORK_PREFIX,
   STOP_STATE_INIT_MESSAGE,
   STOP_STATE_ON_START_MESSAGE,
   STOP_STATE_STOPPED_MESSAGE,
@@ -79,6 +80,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_PREFIX} --format "{{.ID}}"`)
+          .returns({ stderr: '', stdout: network.id });
+
         await stopState.onStart();
 
         // loggin messages
@@ -100,7 +106,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_PREFIX} --format "{{.ID}}"`);
 
         expect(processTest.processCWDStub.calledOnce).to.be.true;
     })