From ef4b39a754ba8180961916b06ce997c33c126568 Mon Sep 17 00:00:00 2001
From: Dominik Henneke <dominik.henneke@sda-se.com>
Date: Thu, 4 Feb 2021 11:54:10 +0100
Subject: [PATCH] Split the step label and content to be able to refactor the
 stepper from vertical to horizontal in the future

---
 .../ImportStepper/ImportStepper.tsx           |  44 ++-
 .../src/components/ImportStepper/defaults.tsx | 296 +++++++++---------
 2 files changed, 171 insertions(+), 169 deletions(-)

diff --git a/plugins/catalog-import/src/components/ImportStepper/ImportStepper.tsx b/plugins/catalog-import/src/components/ImportStepper/ImportStepper.tsx
index 791cf17965..851bab9ef7 100644
--- a/plugins/catalog-import/src/components/ImportStepper/ImportStepper.tsx
+++ b/plugins/catalog-import/src/components/ImportStepper/ImportStepper.tsx
@@ -15,13 +15,14 @@
  */
 
 import { configApiRef, InfoCard, useApi } from '@backstage/core';
-import { Stepper } from '@material-ui/core';
+import { Step, StepContent, Stepper } from '@material-ui/core';
 import { makeStyles } from '@material-ui/core/styles';
 import React, { useMemo } from 'react';
 import { ImportFlows, ImportState, useImportState } from '../useImportState';
 import {
   defaultGenerateStepper,
   defaultStepper,
+  StepConfiguration,
   StepperProvider,
   StepperProviderOpts,
 } from './defaults';
@@ -55,6 +56,15 @@ export const ImportStepper = ({
     [generateStepper, state.activeFlow],
   );
 
+  const render = (step: StepConfiguration) => {
+    return (
+      <Step>
+        {step.stepLabel}
+        <StepContent>{step.content}</StepContent>
+      </Step>
+    );
+  };
+
   return (
     <InfoCard variant={variant}>
       <Stepper
@@ -62,21 +72,29 @@ export const ImportStepper = ({
         activeStep={state.activeStepNumber}
         orientation="vertical"
       >
-        {states.analyze(
-          state as Extract<ImportState, { activeState: 'analyze' }>,
-          { apis: { configApi }, opts },
+        {render(
+          states.analyze(
+            state as Extract<ImportState, { activeState: 'analyze' }>,
+            { apis: { configApi }, opts },
+          ),
         )}
-        {states.prepare(
-          state as Extract<ImportState, { activeState: 'prepare' }>,
-          { apis: { configApi }, opts },
+        {render(
+          states.prepare(
+            state as Extract<ImportState, { activeState: 'prepare' }>,
+            { apis: { configApi }, opts },
+          ),
         )}
-        {states.review(
-          state as Extract<ImportState, { activeState: 'review' }>,
-          { apis: { configApi }, opts },
+        {render(
+          states.review(
+            state as Extract<ImportState, { activeState: 'review' }>,
+            { apis: { configApi }, opts },
+          ),
         )}
-        {states.finish(
-          state as Extract<ImportState, { activeState: 'finish' }>,
-          { apis: { configApi }, opts },
+        {render(
+          states.finish(
+            state as Extract<ImportState, { activeState: 'finish' }>,
+            { apis: { configApi }, opts },
+          ),
         )}
       </Stepper>
     </InfoCard>
diff --git a/plugins/catalog-import/src/components/ImportStepper/defaults.tsx b/plugins/catalog-import/src/components/ImportStepper/defaults.tsx
index 954aeb20dd..110cda9aa7 100644
--- a/plugins/catalog-import/src/components/ImportStepper/defaults.tsx
+++ b/plugins/catalog-import/src/components/ImportStepper/defaults.tsx
@@ -15,14 +15,7 @@
  */
 
 import { ConfigApi } from '@backstage/core';
-import {
-  Box,
-  Step,
-  StepContent,
-  StepLabel,
-  TextField,
-  Typography,
-} from '@material-ui/core';
+import { Box, StepLabel, TextField, Typography } from '@material-ui/core';
 import React from 'react';
 import { BackButton } from '../Buttons';
 import { StepFinishImportLocation } from '../StepFinishImportLocation';
@@ -46,23 +39,28 @@ type StepperApis = {
   configApi: ConfigApi;
 };
 
+export type StepConfiguration = {
+  stepLabel: React.ReactElement;
+  content: React.ReactElement;
+};
+
 export type StepperProvider = {
   analyze: (
     s: Extract<ImportState, { activeState: 'analyze' }>,
     opts: { apis: StepperApis; opts?: StepperProviderOpts },
-  ) => React.ReactElement;
+  ) => StepConfiguration;
   prepare: (
     s: Extract<ImportState, { activeState: 'prepare' }>,
     opts: { apis: StepperApis; opts?: StepperProviderOpts },
-  ) => React.ReactElement;
+  ) => StepConfiguration;
   review: (
     s: Extract<ImportState, { activeState: 'review' }>,
     opts: { apis: StepperApis; opts?: StepperProviderOpts },
-  ) => React.ReactElement;
+  ) => StepConfiguration;
   finish: (
     s: Extract<ImportState, { activeState: 'finish' }>,
     opts: { apis: StepperApis; opts?: StepperProviderOpts },
-  ) => React.ReactElement;
+  ) => StepConfiguration;
 };
 
 function defaultPreparePullRequest(apis: StepperApis) {
@@ -97,8 +95,8 @@ export function defaultGenerateStepper(
     case 'single-location':
       return {
         ...defaults,
-        prepare: () => (
-          <Step>
+        prepare: () => ({
+          stepLabel: (
             <StepLabel
               optional={
                 <Typography variant="caption">
@@ -108,8 +106,9 @@ export function defaultGenerateStepper(
             >
               Select Locations
             </StepLabel>
-          </Step>
-        ),
+          ),
+          content: <></>,
+        }),
       };
 
     // let the user select one or more of the discovered locations in the prepare step
@@ -121,8 +120,8 @@ export function defaultGenerateStepper(
             return defaults.prepare(state, opts);
           }
 
-          return (
-            <Step>
+          return {
+            stepLabel: (
               <StepLabel
                 optional={
                   <Typography variant="caption">
@@ -132,16 +131,16 @@ export function defaultGenerateStepper(
               >
                 Select Locations
               </StepLabel>
-              <StepContent>
-                <StepPrepareSelectLocations
-                  analyzeResult={state.analyzeResult}
-                  prepareResult={state.prepareResult}
-                  onPrepare={state.onPrepare}
-                  onGoBack={state.onGoBack}
-                />
-              </StepContent>
-            </Step>
-          );
+            ),
+            content: (
+              <StepPrepareSelectLocations
+                analyzeResult={state.analyzeResult}
+                prepareResult={state.prepareResult}
+                onPrepare={state.onPrepare}
+                onGoBack={state.onGoBack}
+              />
+            ),
+          };
         },
       };
 
@@ -158,96 +157,89 @@ export function defaultGenerateStepper(
             defaultPreparePullRequest
           )(opts.apis);
 
-          return (
-            <Step>
-              <StepLabel>Create Pull Request</StepLabel>
+          return {
+            stepLabel: <StepLabel>Create Pull Request</StepLabel>,
+            content: (
+              <StepPrepareCreatePullRequest
+                analyzeResult={state.analyzeResult}
+                onPrepare={state.onPrepare}
+                onGoBack={state.onGoBack}
+                defaultTitle={title}
+                defaultBody={body}
+                renderFormFields={({
+                  control,
+                  errors,
+                  groupsLoading,
+                  groups,
+                  register,
+                }) => (
+                  <>
+                    <Box marginTop={2}>
+                      <Typography variant="h6">Pull Request Details</Typography>
+                    </Box>
 
-              <StepContent>
-                <StepPrepareCreatePullRequest
-                  analyzeResult={state.analyzeResult}
-                  onPrepare={state.onPrepare}
-                  onGoBack={state.onGoBack}
-                  defaultTitle={title}
-                  defaultBody={body}
-                  renderFormFields={({
-                    control,
-                    errors,
-                    groupsLoading,
-                    groups,
-                    register,
-                  }) => (
-                    <>
-                      <Box marginTop={2}>
-                        <Typography variant="h6">
-                          Pull Request Details
-                        </Typography>
-                      </Box>
+                    <TextField
+                      name="title"
+                      label="Pull Request Title"
+                      placeholder="Add catalog files for the Backstage"
+                      margin="normal"
+                      variant="outlined"
+                      fullWidth
+                      inputRef={register({ required: true })}
+                      error={Boolean(errors.title)}
+                      required
+                    />
 
-                      <TextField
-                        name="title"
-                        label="Pull Request Title"
-                        placeholder="Add catalog files for the Backstage"
-                        margin="normal"
-                        variant="outlined"
-                        fullWidth
-                        inputRef={register({ required: true })}
-                        error={Boolean(errors.title)}
-                        required
-                      />
+                    <TextField
+                      name="body"
+                      label="Pull Request Body"
+                      placeholder="A decsribing text with Markdown support"
+                      margin="normal"
+                      variant="outlined"
+                      fullWidth
+                      inputRef={register({ required: true })}
+                      error={Boolean(errors.body)}
+                      multiline
+                      required
+                    />
 
-                      <TextField
-                        name="body"
-                        label="Pull Request Body"
-                        placeholder="A decsribing text with Markdown support"
-                        margin="normal"
-                        variant="outlined"
-                        fullWidth
-                        inputRef={register({ required: true })}
-                        error={Boolean(errors.body)}
-                        multiline
-                        required
-                      />
+                    <Box marginTop={2}>
+                      <Typography variant="h6">Entity Configuration</Typography>
+                    </Box>
 
-                      <Box marginTop={2}>
-                        <Typography variant="h6">
-                          Entity Configuration
-                        </Typography>
-                      </Box>
+                    <TextField
+                      name="componentName"
+                      label="Name of the created component"
+                      placeholder="my-component"
+                      margin="normal"
+                      variant="outlined"
+                      fullWidth
+                      inputRef={register({ required: true })}
+                      error={Boolean(errors.componentName)}
+                      required
+                    />
 
-                      <TextField
-                        name="componentName"
-                        label="Name of the created component"
-                        placeholder="my-component"
-                        margin="normal"
-                        variant="outlined"
-                        fullWidth
-                        inputRef={register({ required: true })}
-                        error={Boolean(errors.componentName)}
-                        required
-                      />
-
-                      <AutocompleteTextField
-                        name="owner"
-                        control={control}
-                        errors={errors}
-                        options={groups || []}
-                        loading={groupsLoading}
-                        loadingText="Loading groups…"
-                        helperText="Select an owner from the list or enter a reference to a Group or a User"
-                        errorHelperText="required value"
-                        textFieldProps={{
-                          label: 'Entity Owner',
-                          placeholder: 'Group:default/my-group',
-                        }}
-                        rules={{ required: true }}
-                        required
-                      />
-                    </>
-                  )}
-                />
-              </StepContent>
-            </Step>
-          );
+                    <AutocompleteTextField
+                      name="owner"
+                      control={control}
+                      errors={errors}
+                      options={groups || []}
+                      loading={groupsLoading}
+                      loadingText="Loading groups…"
+                      helperText="Select an owner from the list or enter a reference to a Group or a User"
+                      errorHelperText="required value"
+                      textFieldProps={{
+                        label: 'Entity Owner',
+                        placeholder: 'Group:default/my-group',
+                      }}
+                      rules={{ required: true }}
+                      required
+                    />
+                  </>
+                )}
+              />
+            ),
+          };
         },
       };
 
@@ -257,53 +249,45 @@ export function defaultGenerateStepper(
 }
 
 export const defaultStepper: StepperProvider = {
-  analyze: (state, { opts }) => (
-    <Step>
-      <StepLabel>Select URL</StepLabel>
-      <StepContent>
-        <StepInitAnalyzeUrl
-          key="analyze"
-          analysisUrl={state.analysisUrl}
-          onAnalysis={state.onAnalysis}
-          disablePullRequest={opts?.pullRequest?.disable}
-        />
-      </StepContent>
-    </Step>
-  ),
+  analyze: (state, { opts }) => ({
+    stepLabel: <StepLabel>Select URL</StepLabel>,
+    content: (
+      <StepInitAnalyzeUrl
+        key="analyze"
+        analysisUrl={state.analysisUrl}
+        onAnalysis={state.onAnalysis}
+        disablePullRequest={opts?.pullRequest?.disable}
+      />
+    ),
+  }),
 
-  prepare: state => (
-    <Step>
+  prepare: state => ({
+    stepLabel: (
       <StepLabel optional={<Typography variant="caption">Optional</Typography>}>
         Import Actions
       </StepLabel>
-      <StepContent>
-        <BackButton onClick={state.onGoBack} />
-      </StepContent>
-    </Step>
-  ),
+    ),
+    content: <BackButton onClick={state.onGoBack} />,
+  }),
 
-  review: state => (
-    <Step>
-      <StepLabel>Review</StepLabel>
-      <StepContent>
-        <StepReviewLocation
-          prepareResult={state.prepareResult}
-          onReview={state.onReview}
-          onGoBack={state.onGoBack}
-        />
-      </StepContent>
-    </Step>
-  ),
+  review: state => ({
+    stepLabel: <StepLabel>Review</StepLabel>,
+    content: (
+      <StepReviewLocation
+        prepareResult={state.prepareResult}
+        onReview={state.onReview}
+        onGoBack={state.onGoBack}
+      />
+    ),
+  }),
 
-  finish: state => (
-    <Step>
-      <StepLabel>Finish</StepLabel>
-      <StepContent>
-        <StepFinishImportLocation
-          reviewResult={state.reviewResult}
-          onReset={state.onReset}
-        />
-      </StepContent>
-    </Step>
-  ),
+  finish: state => ({
+    stepLabel: <StepLabel>Finish</StepLabel>,
+    content: (
+      <StepFinishImportLocation
+        reviewResult={state.reviewResult}
+        onReset={state.onReset}
+      />
+    ),
+  }),
 };