improve description. require at least one item in supply if resources is specified, add validation on deploy

Author: shamsartem

packages/cli/package/src/commands/provider/deploy.ts

@@ -15,15 +15,17 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import assert from "node:assert";
 import { readFile } from "node:fs/promises";
 import { isAbsolute, resolve } from "node:path";
 
 import type k8s from "@kubernetes/client-node";
+import { color } from "@oclif/color";
 
 import { BaseCommand } from "../../baseCommand.js";
 import { commandObj } from "../../lib/commandObj.js";
+import { ensureReadonlyProviderConfig } from "../../lib/configs/project/provider/provider.js";
 import { CHAIN_FLAGS, PEER_AND_OFFER_NAMES_FLAGS } from "../../lib/const.js";
+import { splitErrorsAndResults } from "../../lib/helpers/utils.js";
 import { initCli } from "../../lib/lifeCycle.js";
 import { projectRootDir } from "../../lib/paths.js";
 import { resolveComputePeersByNames } from "../../lib/resolveComputePeersByNames.js";
@@ -39,7 +41,35 @@ export default class Deploy extends BaseCommand<typeof Deploy> {
     const { flags } = await initCli(this, await this.parse(Deploy));
     const computePeers = await resolveComputePeersByNames(flags);
 
-    for (const { kubeconfigPath, name, manifestPath } of computePeers) {
+    const [invalidPeers, peers] = splitErrorsAndResults(
+      computePeers,
+      ({ kubeconfigPath, ipSupplies, name, ...restPeer }) => {
+        return kubeconfigPath === undefined || ipSupplies.length === 0
+          ? {
+              error: [
+                kubeconfigPath === undefined &&
+                  `computePeer ${color.yellow(name)} must have a ${color.yellow("kubeconfigPath")} property`,
+                ipSupplies.length === 0 &&
+                  `computePeer ${color.yellow(name)} must have a ${color.yellow("resources.ip.supply")} property, which must be a non-empty array`,
+              ]
+                .filter((err) => {
+                  return typeof err === "string";
+                })
+                .join("\n"),
+            }
+          : { result: { name, ipSupplies, kubeconfigPath, ...restPeer } };
+      },
+    );
+
+    if (invalidPeers.length > 0) {
+      const providerConfig = await ensureReadonlyProviderConfig();
+
+      commandObj.error(
+        `Invalid config at ${providerConfig.$getPath()}:\n${invalidPeers.join("\n")}`,
+      );
+    }
+
+    for (const { kubeconfigPath, name, manifestPath } of peers) {
       await kubectlApply(kubeconfigPath, manifestPath, name);
     }
   }
@@ -54,15 +84,10 @@ export default class Deploy extends BaseCommand<typeof Deploy> {
  * @return Array of resources created
  */
 export async function kubectlApply(
-  kubeconfigPath: string | undefined,
+  kubeconfigPath: string,
   specPath: string,
   peerName: string,
 ): Promise<k8s.KubernetesObject[]> {
-  assert(
-    typeof kubeconfigPath === "string",
-    `Kubeconfig path is required for  computePeer ${peerName}`,
-  );
-
   const kubeconfigAbsolutePath = isAbsolute(kubeconfigPath)
     ? kubeconfigPath
     : resolve(projectRootDir, kubeconfigPath);

packages/cli/package/src/lib/configs/project/provider/provider.ts

@@ -472,9 +472,11 @@ export async function ensureComputerPeerConfigs(computePeerNames?: string[]) {
 
         const peerId = await getPeerIdFromSecretKey(secretKey);
 
+        const ipSupplies = computePeer.resources?.ip.supply ?? [];
+
         const manifest = genManifest({
           chainPrivateKey: hexStringToUTF8ToBase64String(signingWallet),
-          IPSupplies: computePeer.resources?.ip.supply ?? [],
+          ipSupplies,
           httpEndpoint,
           wsEndpoint,
           ipfsGatewayEndpoint,
@@ -516,6 +518,7 @@ export async function ensureComputerPeerConfigs(computePeerNames?: string[]) {
           peerId,
           computeUnits: computePeer.computeUnits,
           kubeconfigPath: computePeer.kubeconfigPath,
+          ipSupplies,
           manifestPath,
           walletKey: signingWallet,
           walletAddress: await new Wallet(signingWallet).getAddress(),

packages/cli/package/src/lib/configs/project/provider/provider1.ts

@@ -653,6 +653,8 @@ type IPSupply =
 
 const supplySchema = {
   type: "object",
+  description:
+    "Either specify only a `start` property (if you want a single IP) or `start` and `end` properties (if you want a range) or `cidr` property (if you want a CIDR notation)",
   oneOf: [
     {
       additionalProperties: false,
@@ -701,6 +703,7 @@ const ipSchema = {
       type: "array",
       items: supplySchema,
       description: "IP supply",
+      minItems: 1,
     },
   },
   required: ["supply"],

packages/cli/package/src/lib/genManifest.ts

@@ -23,7 +23,7 @@ const PRIVATE_KEY_SECRET_REF = "private-key-secret";
 
 type GenManifestsArgs = {
   chainPrivateKey: string;
-  IPSupplies: IPSupplies;
+  ipSupplies: IPSupplies;
   httpEndpoint: string;
   wsEndpoint: string;
   ipfsGatewayEndpoint: string;
@@ -34,7 +34,7 @@ type GenManifestsArgs = {
 
 export function genManifest({
   chainPrivateKey,
-  IPSupplies,
+  ipSupplies,
   httpEndpoint,
   wsEndpoint,
   ipfsGatewayEndpoint,
@@ -81,7 +81,7 @@ ${stringify({
           {
             op: "add",
             path: "/spec/blocks",
-            value: IPSupplies,
+            value: ipSupplies,
           },
         ]),
         target: {