feat: Allow multi-cluster Marketplace deployments (linode#12648)

* augment cluster tags for stackscripts

* hook fix

* remove reduce for readability

* final clean up

* update object type

* adjust summary to include cluster name or instance type when cluster_size is only defined

* fix undef variable in forEach prop

* add .env.example back

* Update packages/manager/src/features/Linodes/LinodeCreate/Summary/Summary.tsx

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>

* use existing react query hooks for mapping

* Update packages/manager/src/features/Linodes/LinodeCreate/Summary/utilities.ts

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>

* Update packages/manager/src/features/Linodes/LinodeCreate/Summary/Summary.tsx

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>

* simplify code, cleanup unused vars

* add test coverage for complex marketplace app clusters

* Remove ClusterDataTypes and use ClusterData

* small clean up and unit testing

* more small clean up

* simplify summary logic

* fix unit test

* hopefully final clean up

---------

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>
Co-authored-by: Banks Nussman <bnussman@akamai.com>

Author: n0vabyte

packages/manager/src/features/Linodes/LinodeCreate/Summary/Summary.test.tsx

@@ -264,6 +264,53 @@ describe('Linode Create Summary', () => {
     await findByText(`5 Nodes - $10/month $2.50/hr`);
   });
 
+  it('should render correct pricing for Marketplace app cluster deployments with multiple plans involved', async () => {
+    const types = [
+      typeFactory.build({
+        label: 'Dedicated 2GB',
+        price: { hourly: 0.1, monthly: 1 },
+      }),
+      typeFactory.build({
+        label: 'Dedicated 4GB',
+        price: { hourly: 0.2, monthly: 2 },
+      }),
+      typeFactory.build({
+        label: 'Dedicated 8GB',
+        price: { hourly: 0.3, monthly: 3 },
+      }),
+    ];
+
+    server.use(
+      http.get('*/v4*/linode/types/:id', ({ params }) => {
+        const type = types.find((type) => type.id === params.id);
+        return HttpResponse.json(type);
+      }),
+      http.get('*/v4*/linode/types', () => {
+        return HttpResponse.json(makeResourcePage(types));
+      })
+    );
+
+    const { findByText } =
+      renderWithThemeAndHookFormContext<CreateLinodeRequest>({
+        component: <Summary />,
+        useFormOptions: {
+          defaultValues: {
+            region: 'fake-region',
+            stackscript_data: {
+              cluster_size: 1,
+              elastic_cluster_size: 2,
+              elastic_cluster_type: types[1].label,
+              logstash_cluster_size: 2,
+              logstash_cluster_type: types[2].label,
+            },
+            type: types[0].id,
+          },
+        },
+      });
+
+    await findByText(`5 Nodes - $11/month $1.10/hr`);
+  });
+
   it('should render "Encrypted" if a distributed region is selected', async () => {
     const region = regionFactory.build({ site_type: 'distributed' });
 

packages/manager/src/features/Linodes/LinodeCreate/Summary/Summary.tsx

@@ -1,4 +1,9 @@
-import { useImageQuery, useRegionsQuery, useTypeQuery } from '@linode/queries';
+import {
+  useAllTypes,
+  useImageQuery,
+  useRegionsQuery,
+  useTypeQuery,
+} from '@linode/queries';
 import { Divider, Paper, Stack, Typography } from '@linode/ui';
 import { formatStorageUnits } from '@linode/utilities';
 import { useTheme } from '@mui/material';
@@ -28,6 +33,8 @@ export const Summary = ({ isAlertsBetaMode }: SummaryProps) => {
 
   const { control } = useFormContext<LinodeCreateFormValues>();
 
+  const { data: types } = useAllTypes();
+
   const [
     label,
     regionId,
@@ -40,7 +47,8 @@ export const Summary = ({ isAlertsBetaMode }: SummaryProps) => {
     vlanLabel,
     vpcId,
     diskEncryption,
-    clusterSize,
+    stackscriptData,
+    clusterName,
     linodeInterfaces,
     interfaceGeneration,
     alerts,
@@ -58,7 +66,8 @@ export const Summary = ({ isAlertsBetaMode }: SummaryProps) => {
       'interfaces.1.label',
       'interfaces.0.vpc_id',
       'disk_encryption',
-      'stackscript_data.cluster_size',
+      'stackscript_data',
+      'stackscript_data.cluster_name',
       'linodeInterfaces',
       'interface_generation',
       'alerts',
@@ -83,7 +92,12 @@ export const Summary = ({ isAlertsBetaMode }: SummaryProps) => {
     getMonthlyBackupsPrice({ region: regionId, type })
   );
 
-  const price = getLinodePrice({ clusterSize, regionId, type });
+  const price = getLinodePrice({
+    regionId,
+    types,
+    stackscriptData,
+    type,
+  });
 
   const hasVPC = isLinodeInterfacesEnabled
     ? linodeInterfaces?.some((i) => i.purpose === 'vpc' && i.vpc?.subnet_id)
@@ -137,8 +151,8 @@ export const Summary = ({ isAlertsBetaMode }: SummaryProps) => {
     },
     {
       item: {
+        title: clusterName || (type ? formatStorageUnits(type.label) : typeId),
         details: price,
-        title: type ? formatStorageUnits(type.label) : typeId,
       },
       show: price,
     },

packages/manager/src/features/Linodes/LinodeCreate/Summary/utilities.test.ts

@@ -1,6 +1,6 @@
 import { linodeTypeFactory } from '@linode/utilities';
 
-import { getLinodePrice } from './utilities';
+import { getLinodePrice, getParsedMarketplaceClusterData } from './utilities';
 
 describe('getLinodePrice', () => {
   it('gets a price for a normal Linode', () => {
@@ -9,9 +9,10 @@ describe('getLinodePrice', () => {
     });
 
     const result = getLinodePrice({
-      clusterSize: undefined,
+      stackscriptData: undefined,
       regionId: 'fake-region-id',
       type,
+      types: [],
     });
 
     expect(result).toBe('$5/month');
@@ -23,11 +24,46 @@ describe('getLinodePrice', () => {
     });
 
     const result = getLinodePrice({
-      clusterSize: '3',
+      stackscriptData: {
+        cluster_size: '3',
+      },
       regionId: 'fake-region-id',
+      types: [],
       type,
     });
 
     expect(result).toBe('3 Nodes - $15/month $0.60/hr');
   });
 });
+
+describe('getParsedMarketplaceClusterData', () => {
+  it('parses stackscript user defined fields', () => {
+    const types = [
+      linodeTypeFactory.build({ label: 'Linode 2GB' }),
+      linodeTypeFactory.build({ label: 'Linode 4GB' }),
+    ];
+
+    const stackscriptData = {
+      cluster_size: '1',
+      mysql_cluster_size: '5',
+      mysql_cluster_type: 'Linode 2GB',
+      redis_cluster_size: '5',
+      redis_cluster_type: 'Linode 4GB',
+    };
+
+    expect(
+      getParsedMarketplaceClusterData(stackscriptData, types)
+    ).toStrictEqual([
+      {
+        prefix: 'mysql',
+        size: '5',
+        type: types[0],
+      },
+      {
+        prefix: 'redis',
+        size: '5',
+        type: types[1],
+      },
+    ]);
+  });
+});

packages/manager/src/features/Linodes/LinodeCreate/Summary/utilities.ts

@@ -4,15 +4,33 @@ import { getLinodeRegionPrice } from 'src/utilities/pricing/linodes';
 import type { LinodeType } from '@linode/api-v4';
 
 interface LinodePriceOptions {
-  clusterSize: string | undefined;
+  /**
+   * The selected region for the Linode
+   */
   regionId: string | undefined;
+  /**
+   * The stackscript_data (user defined fields)
+   *
+   * This is needed to calculate the Linode price because we could be dealing with
+   * a Marketplace app that deploys a cluster (or clusters)
+   */
+  stackscriptData: Record<string, string> | undefined;
+  /**
+   * The selected Linode type
+   */
   type: LinodeType | undefined;
+  /**
+   * An array of all Linode types
+   */
+  types: LinodeType[] | undefined;
 }
 
 export const getLinodePrice = (options: LinodePriceOptions) => {
-  const { clusterSize, regionId, type } = options;
+  const { stackscriptData, regionId, type, types } = options;
+
   const price = getLinodeRegionPrice(type, regionId);
 
+  const clusterSize = stackscriptData?.['cluster_size'];
   const isCluster = clusterSize !== undefined;
 
   if (
@@ -25,18 +43,72 @@ export const getLinodePrice = (options: LinodePriceOptions) => {
   }
 
   if (isCluster) {
-    const numberOfNodes = Number(clusterSize);
+    let totalClusterSize = Number(clusterSize);
+    let clusterTotalMonthlyPrice = price.monthly * Number(clusterSize);
+    let clusterTotalHourlyPrice = price.hourly * Number(clusterSize);
 
-    const totalMonthlyPrice = renderMonthlyPriceToCorrectDecimalPlace(
-      price.monthly * numberOfNodes
+    const complexClusterData = getParsedMarketplaceClusterData(
+      stackscriptData,
+      types
     );
 
-    const totalHourlyPrice = renderMonthlyPriceToCorrectDecimalPlace(
-      price.hourly * numberOfNodes
-    );
+    for (const clusterPool of complexClusterData) {
+      const price = getLinodeRegionPrice(clusterPool.type, regionId);
+      const numberOfNodesInPool = parseInt(clusterPool.size ?? '0', 10);
+      clusterTotalMonthlyPrice += (price?.monthly ?? 0) * numberOfNodesInPool;
+      clusterTotalHourlyPrice += (price?.hourly ?? 0) * numberOfNodesInPool;
+      totalClusterSize += numberOfNodesInPool;
+    }
 
-    return `${numberOfNodes} Nodes - $${totalMonthlyPrice}/month $${totalHourlyPrice}/hr`;
+    return `${totalClusterSize} Nodes - $${renderMonthlyPriceToCorrectDecimalPlace(clusterTotalMonthlyPrice)}/month $${renderMonthlyPriceToCorrectDecimalPlace(clusterTotalHourlyPrice)}/hr`;
   }
 
   return `$${renderMonthlyPriceToCorrectDecimalPlace(price.monthly)}/month`;
 };
+
+interface MarketplaceClusterData {
+  /**
+   * The name of the service within the complex Marketplace app cluster.
+   *
+   * @example mysql
+   */
+  prefix: string;
+  /**
+   * The number of nodes just for this paticular service within the Marketplace cluster deployment.
+   */
+  size?: string;
+  /**
+   * The Linode type that should be used for nodes in this service
+   *
+   * @example Linode 2GB
+   */
+  type?: LinodeType;
+}
+
+export function getParsedMarketplaceClusterData(
+  stackscriptData: Record<string, string> = {},
+  types: LinodeType[] | undefined
+): MarketplaceClusterData[] {
+  const result: MarketplaceClusterData[] = [];
+
+  for (const [key, value] of Object.entries(stackscriptData)) {
+    const match = key.match(/^(.+)_cluster_(size|type)$/);
+    if (!match) continue;
+
+    const prefix = match[1];
+    const kind = match[2];
+
+    let cluster = result.find((c) => c.prefix === prefix);
+    if (!cluster) {
+      cluster = { prefix };
+      result.push(cluster);
+    }
+
+    if (kind === 'size') {
+      cluster.size = value as string;
+    } else if (kind === 'type') {
+      cluster.type = types?.find((t) => t.label === value);
+    }
+  }
+  return result;
+}

packages/manager/src/features/Linodes/LinodeCreate/Tabs/StackScripts/UserDefinedFields/UserDefinedFields.tsx

@@ -17,7 +17,7 @@ import { oneClickApps } from 'src/features/OneClickApps/oneClickApps';
 
 import { getMarketplaceAppLabel } from '../../Marketplace/utilities';
 import { UserDefinedFieldInput } from './UserDefinedFieldInput';
-import { separateUDFsByRequiredStatus } from './utilities';
+import { getTotalClusterSize, separateUDFsByRequiredStatus } from './utilities';
 
 import type { CreateLinodeRequest } from '@linode/api-v4';
 
@@ -59,6 +59,8 @@ export const UserDefinedFields = ({ onOpenDetailsDrawer }: Props) => {
 
   const isCluster = clusterSize !== null && clusterSize !== undefined;
 
+  const totalClusterSize = getTotalClusterSize(stackscriptData);
+
   const marketplaceAppInfo =
     stackscriptId !== null && stackscriptId !== undefined
       ? oneClickApps[stackscriptId]
@@ -102,7 +104,7 @@ export const UserDefinedFields = ({ onOpenDetailsDrawer }: Props) => {
         )}
         {isCluster && (
           <Notice
-            text={`You are creating a cluster with ${clusterSize} nodes.`}
+            text={`You are creating a cluster with ${totalClusterSize} nodes.`}
             variant="success"
           />
         )}

packages/manager/src/features/Linodes/LinodeCreate/Tabs/StackScripts/UserDefinedFields/utilities.test.ts

@@ -4,6 +4,7 @@ import {
   getIsUDFMultiSelect,
   getIsUDFPasswordField,
   getIsUDFSingleSelect,
+  getTotalClusterSize,
   separateUDFsByRequiredStatus,
 } from './utilities';
 
@@ -155,3 +156,29 @@ describe('getIsUDFPasswordField', () => {
     expect(getIsUDFPasswordField(udf)).toBe(false);
   });
 });
+
+describe('getTotalClusterSize', () => {
+  it('should return 0 when there is no cluster data', () => {
+    const stackscriptData = {};
+
+    expect(getTotalClusterSize(stackscriptData)).toBe(0);
+  });
+
+  it('should support normal marketplace clusters', () => {
+    const stackscriptData = {
+      cluster_size: '5',
+    };
+
+    expect(getTotalClusterSize(stackscriptData)).toBe(5);
+  });
+
+  it('should support complex marketplace clusters', () => {
+    const stackscriptData = {
+      cluster_size: '3',
+      mysql_cluster_size: '3',
+      redis_cluster_size: '5',
+    };
+
+    expect(getTotalClusterSize(stackscriptData)).toBe(11);
+  });
+});

packages/manager/src/features/Linodes/LinodeCreate/Tabs/StackScripts/UserDefinedFields/utilities.ts

@@ -68,3 +68,20 @@ export const getIsUDFMultiSelect = (udf: UserDefinedField) => {
 export const getIsUDFHeader = (udf: UserDefinedField) => {
   return udf.header?.toLowerCase() === 'yes';
 };
+
+/**
+ * Gets the total number of nodes that will be created as part of a
+ * marketplace app cluster.
+ *
+ * - Marketplace app clusters use the user-defined-field `cluster_size` to
+ *   define the number of nodes.
+ * - Complex Marketplace App clusters will use `cluster_size` and other
+ *   fields like `{service}_cluster_size`
+ */
+export const getTotalClusterSize = (
+  userDefinedFields: Record<string, string>
+) => {
+  return Object.entries(userDefinedFields || {})
+    .filter(([key]) => key.endsWith('_cluster_size') || key === 'cluster_size')
+    .reduce((sum, [_, value]) => sum + Number(value), 0);
+};