feat: improved error handling

packages/composable-cli/package.json

@@ -34,6 +34,7 @@
     "ink-big-text": "1",
     "ink-gradient": "2",
     "ink-link": "2",
+    "ink-table": "^3.0.0",
     "inquirer": "8.2.4",
     "node-fetch": "2.7.0",
     "open": "8",

packages/composable-cli/src/commands/config/config-command.tsx

@@ -1,7 +1,6 @@
 import yargs from "yargs"
 import Conf from "conf"
 import { CommandContext, CommandHandlerFunction } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   ConfigCommandArguments,
   ConfigCommandData,
@@ -16,7 +15,7 @@ export function configClearCommand(store: Conf): void {
 export function createConfigCommand(
   ctx: CommandContext,
 ): yargs.CommandModule<{}, ConfigCommandArguments> {
-  const { store, logger } = ctx
+  const { store, logger, handleErrors } = ctx
 
   return {
     command: "config",
@@ -26,16 +25,24 @@ export function createConfigCommand(
         .command({
           command: "list",
           describe: "List all stored configuration",
-          handler: (_args) => {
+          handler: handleErrors(async (_args) => {
             logger.info(JSON.stringify(store.store, null, 2))
-          },
+            return {
+              success: true,
+              data: {},
+            }
+          }),
         })
         .command({
           command: "clear",
           describe: "Clear all stored configuration",
-          handler: (_args) => {
+          handler: handleErrors(async (_args) => {
             configClearCommand(store)
-          },
+            return {
+              success: true,
+              data: {},
+            }
+          }),
         })
         .example("$0 config list", "list all stored configuration")
         .example("$0 config clear", "clear all stored configuration")

packages/composable-cli/src/commands/feedback/feedback-command.ts

@@ -4,7 +4,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import { renderInk } from "../../lib/ink/render-ink"
 import React from "react"
 import {
@@ -17,19 +16,20 @@ import { Feedback } from "../ui/feedback/feedback"
 import { trackCommandHandler } from "../../util/track-command-handler"
 import { isTTY } from "../../util/is-tty"
 export function createFeedbackCommand(
-  ctx: CommandContext
+  ctx: CommandContext,
 ): yargs.CommandModule<RootCommandArguments, FeedbackCommandArguments> {
+  const { handleErrors } = ctx
   return {
     command: "feedback",
     describe: "Feedback to the Composable CLI",
     handler: handleErrors(
-      trackCommandHandler(ctx, createFeedbackCommandHandler)
+      trackCommandHandler(ctx, createFeedbackCommandHandler),
     ),
   }
 }
 
 export function createFeedbackCommandHandler(
-  _ctx: CommandContext
+  _ctx: CommandContext,
 ): CommandHandlerFunction<
   FeedbackCommandData,
   FeedbackCommandError,

packages/composable-cli/src/commands/generate/d2c/d2c-command.tsx

@@ -24,7 +24,6 @@ import {
   CommandHandlerFunction,
   CommandResult,
 } from "../../../types/command"
-import { handleErrors } from "../../../util/error-handler"
 import { getRegion, resolveHostFromRegion } from "../../../util/resolve-region"
 import { createApplicationKeys } from "../../../util/create-client-secret"
 import { renderInk } from "../../../lib/ink/render-ink"
@@ -113,7 +112,9 @@ export function createD2CCommand(
 
       return addSchemaOptionsToCommand(result, options)
     },
-    handler: handleErrors(trackCommandHandler(ctx, createD2CCommandHandler)),
+    handler: ctx.handleErrors(
+      trackCommandHandler(ctx, createD2CCommandHandler),
+    ),
   }
 }
 

packages/composable-cli/src/commands/generate/generate-command.tsx

@@ -4,7 +4,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   GenerateCommandArguments,
   GenerateCommandData,
@@ -67,7 +66,7 @@ export function createGenerateCommand(
         .demandCommand(1)
         .strict()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createGenerateCommandHandler),
     ),
   }
@@ -125,7 +124,7 @@ export function createActiveStoreMiddleware(
       return
     }
 
-    return handleErrors(createSetStoreCommandHandler(ctx))(args)
+    return ctx.handleErrors(createSetStoreCommandHandler(ctx))(args)
   }
 }
 

packages/composable-cli/src/commands/insights/insights-command.tsx

@@ -4,7 +4,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   InsightsCommandArguments,
   InsightsCommandData,
@@ -30,7 +29,7 @@ export function createInsightsCommand(
         })
         .help()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createInsightsCommandHandler),
     ),
   }

packages/composable-cli/src/commands/integration/algolia/algolia-integration-command.tsx

@@ -5,7 +5,6 @@ import {
   AlgoliaIntegrationCommandError,
 } from "./algolia-integration.types"
 import { CommandContext, CommandHandlerFunction } from "../../../types/command"
-import { handleErrors } from "../../../util/error-handler"
 import { trackCommandHandler } from "../../../util/track-command-handler"
 import {
   createActiveStoreMiddleware,
@@ -77,7 +76,7 @@ export function createAlgoliaIntegrationCommand(
         .fail(false)
         .help()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createAlgoliaIntegrationCommandHandler),
     ),
   }

packages/composable-cli/src/commands/integration/integration-command.tsx

@@ -4,7 +4,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   IntegrationCommandArguments,
   IntegrationCommandData,
@@ -29,7 +28,7 @@ export function createIntegrationCommand(
         .demandCommand(1)
         .strict()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createIntegrationCommandHandler),
     ),
   }

packages/composable-cli/src/commands/login/login-command.ts

@@ -9,7 +9,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   LoginCommandArguments,
   LoginCommandData,
@@ -81,7 +80,9 @@ export function createLoginCommand(
           "strip-aliased": true,
         })
     },
-    handler: handleErrors(trackCommandHandler(ctx, createLoginCommandHandler)),
+    handler: ctx.handleErrors(
+      trackCommandHandler(ctx, createLoginCommandHandler),
+    ),
   }
 }
 
@@ -97,9 +98,9 @@ export function createAuthenticationMiddleware(
       return
     }
 
-    return handleErrors(trackCommandHandler(ctx, createLoginCommandHandler))(
-      args,
-    )
+    return ctx.handleErrors(
+      trackCommandHandler(ctx, createLoginCommandHandler),
+    )(args)
   }
 }
 

packages/composable-cli/src/commands/logout/logout-command.ts

@@ -1,6 +1,5 @@
 import yargs from "yargs"
 import { CommandContext, CommandHandlerFunction } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   LogoutCommandArguments,
   LogoutCommandData,
@@ -14,17 +13,19 @@ import { handleClearCredentials } from "../../util/conf-store/store-credentials"
 import { trackCommandHandler } from "../../util/track-command-handler"
 
 export function createLogoutCommand(
-  ctx: CommandContext
+  ctx: CommandContext,
 ): yargs.CommandModule<{}, LogoutCommandArguments> {
   return {
     command: "logout",
     describe: "Logout of the Composable CLI",
-    handler: handleErrors(trackCommandHandler(ctx, createLogoutCommandHandler)),
+    handler: ctx.handleErrors(
+      trackCommandHandler(ctx, createLogoutCommandHandler),
+    ),
   }
 }
 
 export function createLogoutCommandHandler(
-  ctx: CommandContext
+  ctx: CommandContext,
 ): CommandHandlerFunction<
   LogoutCommandData,
   LogoutCommandError,

packages/composable-cli/src/commands/payments/ep-payments/ep-payments-command.tsx

@@ -6,7 +6,6 @@ import {
   EPPaymentsCommandErrorAlreadyExists,
 } from "./ep-payments-integration.types"
 import { CommandContext, CommandHandlerFunction } from "../../../types/command"
-import { handleErrors } from "../../../util/error-handler"
 import { trackCommandHandler } from "../../../util/track-command-handler"
 import {
   createActiveStoreMiddleware,
@@ -55,7 +54,7 @@ export function createEPPaymentsCommand(
         .fail(false)
         .help()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createEPPaymentsCommandHandler),
     ),
   }

packages/composable-cli/src/commands/payments/payments-command.tsx

@@ -4,7 +4,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 
 import { trackCommandHandler } from "../../util/track-command-handler"
 import { createEPPaymentsCommand } from "./ep-payments/ep-payments-command"
@@ -32,7 +31,7 @@ export function createPaymentsCommand(
         .demandCommand(1)
         .strict()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createPaymentsCommandHandler),
     ),
   }

packages/composable-cli/src/commands/store/store-command.tsx

@@ -5,7 +5,6 @@ import {
   CommandHandlerFunction,
   RootCommandArguments,
 } from "../../types/command"
-import { handleErrors } from "../../util/error-handler"
 import {
   SetStoreCommandArguments,
   SetStoreCommandData,
@@ -47,7 +46,9 @@ export function createStoreCommand(
         .demandCommand(1)
         .strict()
     },
-    handler: handleErrors(trackCommandHandler(ctx, createStoreCommandHandler)),
+    handler: ctx.handleErrors(
+      trackCommandHandler(ctx, createStoreCommandHandler),
+    ),
   }
 }
 
@@ -65,7 +66,7 @@ export function createSetStoreCommand(
         })
         .help()
     },
-    handler: handleErrors(
+    handler: ctx.handleErrors(
       trackCommandHandler(ctx, createSetStoreCommandHandler),
     ),
   }

packages/composable-cli/src/commands/ui/error/error.tsx

@@ -0,0 +1,29 @@
+import React from "react"
+import { Box, Newline, Text } from "ink"
+import Table from "ink-table"
+
+export function ErrorTable({ data }: { data: Record<string, any> }) {
+  const errors = Object.keys(data).map((key) => {
+    return { key, value: data[key] }
+  })
+
+  return (
+    <Box flexDirection="column">
+      <Box marginY={1}>
+        <Text bold color="red">
+          There was an issue!
+        </Text>
+      </Box>
+      <Text>
+        To get support on this issue, report it on our slack community.
+        <Newline />
+        Join us at
+        <Text color="green">
+          {" "}
+          https://elasticpathcommunity.slack.com/join/shared_invite/zt-1upzq3nlc-O3sy1bT0UJYcOWEQQCtnqw
+        </Text>
+      </Text>
+      <Table data={errors} />
+    </Box>
+  )
+}

packages/composable-cli/src/commands/ui/login/welcome-note.tsx

@@ -21,6 +21,16 @@ export function WelcomeNote({ name }: { name: string }) {
         </Text>
         <Newline />
         <Text>A CLI for managing your Elasticpath powered storefront</Text>
+        <Newline />
+        <Box marginY={1}>
+          <Text>
+            To get support or ask any question, join us in our slack community.
+            <Newline />
+            <Text color="green">
+              https://elasticpathcommunity.slack.com/join/shared_invite/zt-1upzq3nlc-O3sy1bT0UJYcOWEQQCtnqw
+            </Text>
+          </Text>
+        </Box>
       </Box>
     </>
   )

packages/composable-cli/src/types/command.ts

@@ -8,6 +8,7 @@ import { logging } from "@angular-devkit/core"
 import ansiColors from "ansi-colors"
 import { Moltin } from "@moltin/sdk"
 import { ComposableRc } from "../lib/composable-rc-schema"
+import { ErrorHandler } from "../util/error-handler"
 
 export type CommandResult<TData, TError> =
   | {
@@ -34,6 +35,7 @@ export type CommandContext = {
   epClient?: Moltin
   composableRc?: ComposableRc
   workspaceRoot?: string
+  handleErrors: ErrorHandler
 }
 
 export type RootCommandArguments = {