chore: Add displayName (#26)

Author: gonzalezzfelipe

extensions/apex-fusion/values.yaml

@@ -1,5 +1,6 @@
 nameOverride: ""
 fullnameOverride: ""
+displayName: ""
 
 image:
   repository: ghcr.io/blinklabs-io/cardano-node

extensions/cardano-node/values.yaml

@@ -1,5 +1,6 @@
 nameOverride: ""
 fullnameOverride: ""
+displayName: ""
 
 image:
   repository: ghcr.io/blinklabs-io/cardano-node

extensions/dolos/values.yaml

@@ -1,5 +1,6 @@
 nameOverride: ""
 fullnameOverride: ""
+displayName: ""
 
 image:
   repository: ghcr.io/txpipe/dolos

extensions/hydra-node/values.yaml

@@ -1,5 +1,6 @@
 nameOverride: ""
 fullnameOverride: ""
+displayName: ""
 
 image:
   repository: ghcr.io/input-output-hk/hydra-node

extensions/midnight/values.yaml

@@ -1,5 +1,6 @@
 nameOverride: ""
 fullnameOverride: ""
+displayName: ""
 
 image:
   repository: midnightnetwork/midnight-node

frontends/dashboard/src/utils/helm-install/dolos.ts

@@ -1,11 +1,11 @@
 // Utils
-import { runCommand } from '~/utils/process';
+import { runCommand, shellEscape } from '~/utils/process';
 
 export async function install(namespace: string, name: string, image: string, version: string) {
   await runCommand(`
-    helm install ${name} ${image} \
-    --namespace ${namespace} \
-    --version "${version}" \
+    helm install ${shellEscape(name)} ${shellEscape(image)} \
+    --namespace ${shellEscape(namespace)} \
+    --version ${shellEscape(version)} \
     --set image.tag=v0.32.0 \
     --set extraLabels.supernode/status=ready \
     --set config.upstreamAddress=relay.cnode-m1.demeter.run:3002 \

frontends/dashboard/src/utils/helm-install/index.ts

@@ -1,10 +1,16 @@
-import { runCommand } from '~/utils/process';
+import { runCommand, shellEscape } from '~/utils/process';
 
 // Installs
 import { install as midnightInstall } from '~/utils/helm-install/midnight';
 import { install as dolosInstall } from '~/utils/helm-install/dolos';
 
-export async function runInstall(repo: string, namespace: string, name: string, image: string, version: string) {
+export async function runInstall(
+  repo: string,
+  namespace: string,
+  name: string,
+  image: string,
+  version: string,
+) {
   if (repo.includes('midnight')) {
     return midnightInstall(namespace, name, image, version);
   }
@@ -14,9 +20,9 @@ export async function runInstall(repo: string, namespace: string, name: string,
   }
 
   return runCommand(`
-    helm install ${name} ${image} \
-    --namespace ${namespace} \
-    --version "${version}" \
+    helm install ${shellEscape(name)} ${shellEscape(image)} \
+    --namespace ${shellEscape(namespace)} \
+    --version ${shellEscape(version)} \
     --set extraLabels.supernode/status=ready
   `.trim());
 }

frontends/dashboard/src/utils/helm-install/midnight.ts

@@ -2,7 +2,7 @@ import { randomBytes } from 'crypto';
 
 // Utils
 import { getClients } from '~/utils/k8s';
-import { runCommand } from '~/utils/process';
+import { runCommand, shellEscape } from '~/utils/process';
 
 export async function install(namespace: string, name: string, image: string, version: string) {
   const { core } = getClients();
@@ -24,9 +24,9 @@ export async function install(namespace: string, name: string, image: string, ve
   });
 
   await runCommand(`
-    helm install ${name} ${image} \
-    --namespace ${namespace} \
-    --version "${version}" \
+    helm install ${shellEscape(name)} ${shellEscape(image)} \
+    --namespace ${shellEscape(namespace)} \
+    --version ${shellEscape(version)} \
     --set nodeKey.existingSecret.name=${secretName} \
     --set nodeKey.existingSecret.key=node.key \
     --set persistence.size=5Gi \

frontends/dashboard/src/utils/home/calls.ts

@@ -15,14 +15,20 @@ import { nanoid } from '~/utils/generic';
 import { runInstall } from '~/utils/helm-install';
 
 function getAnnotationsFromRelease(release: DecodedHelmRelease): SupernodeAnnotations | undefined {
-  if (!release.chart.metadata.annotations) {
+  const annotations = release.chart.metadata.annotations;
+
+  const customDisplayName = typeof release.config?.displayName === 'string'
+    ? release.config.displayName.trim()
+    : '';
+
+  if (!annotations && !customDisplayName) {
     return undefined;
   }
 
   return {
-    displayName: release.chart.metadata.annotations['displayName'] || release.name,
-    icon: release.chart.metadata.annotations['icon'],
-    category: release.chart.metadata.annotations['category'],
+    displayName: customDisplayName || annotations?.['displayName'] || release.name,
+    icon: annotations?.['icon'] || '',
+    category: annotations?.['category'],
     network: getNetworkFromHelmRelease(release),
   };
 }

frontends/dashboard/src/utils/process.ts

@@ -4,6 +4,11 @@ import childProcess from 'child_process';
 const exec = promisify(childProcess.exec);
 const DEFAULT_TIMEOUT = 30000; // 30 seconds
 
+export function shellEscape(value: string): string {
+  const quote = '\'';
+  return quote + value.replace(/'/g, `${quote}\\${quote}${quote}`) + quote;
+}
+
 export async function runCommand(command: string): Promise<string> {
   const { stdout, stderr } = await exec(command, { timeout: DEFAULT_TIMEOUT });