fix: handle imported networks with missing custom images

Author: jamaljsr

src/components/network/NewNetwork.tsx

@@ -88,7 +88,7 @@ const NewNetwork: React.SFC = () => {
               <Styled.Divider orientation="left">{l('customLabel')}</Styled.Divider>
               <Row>
                 {customNodes.map(node => (
-                  <Col span={8} key={node.id}>
+                  <Col span={6} key={node.id}>
                     <Form.Item
                       name={['customNodes', node.id]}
                       label={node.name}

src/components/nodeImages/CustomImageModal.tsx

@@ -49,7 +49,7 @@ const CustomImageModal: React.FC<Props> = ({ image, onClose }) => {
   };
 
   const implGroups: Record<string, NodeImplementation[]> = {
-    Lightning: ['LND', 'c-lightning'],
+    Lightning: ['LND', 'c-lightning', 'eclair'],
     Bitcoin: ['bitcoind'],
   };
 

src/i18n/locales/en-US.json

@@ -355,6 +355,7 @@
   "store.models.network.removeCompatErr": "There are no other compatible backends for {{lnName}} to connect to. You must remove the {{lnName}} node first",
   "store.models.network.exportTitle": "Export '{{name}}'",
   "store.models.network.exportBadStatus": "The network must be stopped to be exported",
+  "store.models.network.missingImages": "Cannot start the network because it contains custom node images that are not available on this machine",
   "utils.network.backendCompatError": "This network does not contain a Bitcoin Core v{{requiredVersion}} (or lower) node which is required for {{implementation}} v{{version}}",
   "utils.network.incompatibleImplementation": "Importing networks with {{implementation}} nodes is not supported on {{platform}}",
   "utils.network.unknownImplementation": "Cannot import unknown Lightning implementation '{{implementation}}'"

src/store/models/network.spec.ts

@@ -618,6 +618,16 @@ describe('Network model', () => {
       });
       expect(logMock.info).toBeCalledWith('Failed to connect all LN peers', err);
     });
+
+    it('should throw an error if a custom node image is missing', async () => {
+      const { networks } = store.getState().network;
+      networks[0].nodes.lightning[0].docker.image = 'custom-image:latest';
+      store.getActions().network.setNetworks(networks);
+      const { start } = store.getActions().network;
+      const errMsg =
+        'Cannot start the network because it contains custom node images that are not available on this machine: custom-image:latest';
+      await expect(start(firstNetwork().id)).rejects.toThrow(errMsg);
+    });
   });
 
   describe('Stopping', () => {

src/store/models/network.ts

@@ -12,7 +12,7 @@ import {
 } from 'shared/types';
 import { CustomImage, Network, StoreInjections } from 'types';
 import { initChartFromNetwork } from 'utils/chart';
-import { APP_VERSION } from 'utils/constants';
+import { APP_VERSION, DOCKER_REPO } from 'utils/constants';
 import { rm } from 'utils/files';
 import {
   createBitcoindNetworkNode,
@@ -21,6 +21,7 @@ import {
   createLndNetworkNode,
   createNetwork,
   filterCompatibleBackends,
+  getMissingImages,
   getOpenPorts,
   importNetworkFromZip,
   OpenPorts,
@@ -488,39 +489,53 @@ const networkModel: NetworkModel = {
       network.status = status;
     }
   }),
-  start: thunk(async (actions, networkId, { getState, injections, getStoreActions }) => {
-    let network = getState().networks.find(n => n.id === networkId);
-    if (!network) throw new Error(l('networkByIdErr', { networkId }));
-    const { id } = network;
-    actions.setStatus({ id: id, status: Status.Starting });
-    try {
-      // make sure the node ports are available
-      const ports = await getOpenPorts(network);
-      if (ports) {
-        // at least one port was updated. save the network & composeFile
-        actions.updateNodePorts({ id, ports });
-        // re-fetch the network with the updated ports
-        network = getState().networks.find(n => n.id === networkId) as Network;
-        await actions.save();
-        await injections.dockerService.saveComposeFile(network);
+  start: thunk(
+    async (
+      actions,
+      networkId,
+      { getState, injections, getStoreState, getStoreActions },
+    ) => {
+      let network = getState().networks.find(n => n.id === networkId);
+      if (!network) throw new Error(l('networkByIdErr', { networkId }));
+      const { dockerImages } = getStoreState().app;
+      // make sure all non-Polar images are available
+      const missingImages = getMissingImages(network, dockerImages).filter(
+        i => !i.startsWith(DOCKER_REPO),
+      );
+      if (missingImages.length) {
+        throw new Error(`${l('missingImages')}: ${missingImages.join(', ')}`);
       }
-      // start the docker containers
-      await injections.dockerService.start(network);
-      // update the list of docker images pulled since new images may be pulled
-      await getStoreActions().app.getDockerImages();
-      // set the status of only the network to Started
-      actions.setStatus({ id, status: Status.Started, all: false });
-      // wait for nodes to startup before updating their status
-      await actions.monitorStartup([
-        ...network.nodes.lightning,
-        ...network.nodes.bitcoin,
-      ]);
-    } catch (e) {
-      actions.setStatus({ id, status: Status.Error });
-      info(`unable to start network '${network.name}'`, e.message);
-      throw e;
-    }
-  }),
+      const { id } = network;
+      actions.setStatus({ id: id, status: Status.Starting });
+      try {
+        // make sure the node ports are available
+        const ports = await getOpenPorts(network);
+        if (ports) {
+          // at least one port was updated. save the network & composeFile
+          actions.updateNodePorts({ id, ports });
+          // re-fetch the network with the updated ports
+          network = getState().networks.find(n => n.id === networkId) as Network;
+          await actions.save();
+          await injections.dockerService.saveComposeFile(network);
+        }
+        // start the docker containers
+        await injections.dockerService.start(network);
+        // update the list of docker images pulled since new images may be pulled
+        await getStoreActions().app.getDockerImages();
+        // set the status of only the network to Started
+        actions.setStatus({ id, status: Status.Started, all: false });
+        // wait for nodes to startup before updating their status
+        await actions.monitorStartup([
+          ...network.nodes.lightning,
+          ...network.nodes.bitcoin,
+        ]);
+      } catch (e) {
+        actions.setStatus({ id, status: Status.Error });
+        info(`unable to start network '${network.name}'`, e.message);
+        throw e;
+      }
+    },
+  ),
   stop: thunk(async (actions, networkId, { getState, injections }) => {
     const network = getState().networks.find(n => n.id === networkId);
     if (!network) throw new Error(l('networkByIdErr', { networkId }));