Merge pull request #728 from acelaya-forks/feature/state-machine-poc

Feature/state machine poc

src/container/types.ts

@@ -21,7 +21,7 @@ export interface ShlinkState {
   servers: ServersMap;
   selectedServer: SelectedServer;
   shortUrlsList: ShortUrlsList;
-  shortUrlCreationResult: ShortUrlCreation;
+  shortUrlCreation: ShortUrlCreation;
   shortUrlDeletion: ShortUrlDeletion;
   shortUrlEdition: ShortUrlEdition;
   shortUrlVisits: ShortUrlVisits;

src/reducers/index.ts

@@ -21,7 +21,7 @@ export default (container: IContainer) => combineReducers<ShlinkState>({
   servers: serversReducer,
   selectedServer: selectedServerReducer,
   shortUrlsList: shortUrlsListReducer,
-  shortUrlCreationResult: container.shortUrlCreationReducer,
+  shortUrlCreation: container.shortUrlCreationReducer,
   shortUrlDeletion: container.shortUrlDeletionReducer,
   shortUrlEdition: container.shortUrlEditionReducer,
   shortUrlDetail: container.shortUrlDetailReducer,

src/short-urls/CreateShortUrl.tsx

@@ -12,7 +12,7 @@ export interface CreateShortUrlProps {
 
 interface CreateShortUrlConnectProps extends CreateShortUrlProps {
   settings: Settings;
-  shortUrlCreationResult: ShortUrlCreation;
+  shortUrlCreation: ShortUrlCreation;
   selectedServer: SelectedServer;
   createShortUrl: (data: ShortUrlData) => Promise<void>;
   resetCreateShortUrl: () => void;
@@ -38,7 +38,7 @@ export const CreateShortUrl = (
   CreateShortUrlResult: FC<CreateShortUrlResultProps>,
 ) => ({
   createShortUrl,
-  shortUrlCreationResult,
+  shortUrlCreation,
   resetCreateShortUrl,
   selectedServer,
   basicMode = false,
@@ -50,7 +50,7 @@ export const CreateShortUrl = (
     <>
       <ShortUrlForm
         initialState={initialState}
-        saving={shortUrlCreationResult.saving}
+        saving={shortUrlCreation.saving}
         selectedServer={selectedServer}
         mode={basicMode ? 'create-basic' : 'create'}
         onSave={async (data: ShortUrlData) => {
@@ -59,7 +59,7 @@ export const CreateShortUrl = (
         }}
       />
       <CreateShortUrlResult
-        {...shortUrlCreationResult}
+        creation={shortUrlCreation}
         resetCreateShortUrl={resetCreateShortUrl}
         canBeClosed={basicMode}
       />

src/short-urls/helpers/CreateShortUrlResult.tsx

@@ -1,7 +1,6 @@
 import { faCopy as copyIcon } from '@fortawesome/free-regular-svg-icons';
 import { faTimes as closeIcon } from '@fortawesome/free-solid-svg-icons';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
-import { isNil } from 'ramda';
 import { useEffect } from 'react';
 import CopyToClipboard from 'react-copy-to-clipboard';
 import { Tooltip } from 'reactstrap';
@@ -11,15 +10,17 @@ import { Result } from '../../utils/Result';
 import './CreateShortUrlResult.scss';
 import { ShlinkApiError } from '../../api/ShlinkApiError';
 
-export interface CreateShortUrlResultProps extends ShortUrlCreation {
+export interface CreateShortUrlResultProps {
+  creation: ShortUrlCreation;
   resetCreateShortUrl: () => void;
   canBeClosed?: boolean;
 }
 
 export const CreateShortUrlResult = (useTimeoutToggle: TimeoutToggle) => (
-  { error, errorData, result, resetCreateShortUrl, canBeClosed = false }: CreateShortUrlResultProps,
+  { creation, resetCreateShortUrl, canBeClosed = false }: CreateShortUrlResultProps,
 ) => {
   const [showCopyTooltip, setShowCopyTooltip] = useTimeoutToggle();
+  const { error, saved } = creation;
 
   useEffect(() => {
     resetCreateShortUrl();
@@ -29,16 +30,16 @@ export const CreateShortUrlResult = (useTimeoutToggle: TimeoutToggle) => (
     return (
       <Result type="error" className="mt-3">
         {canBeClosed && <FontAwesomeIcon icon={closeIcon} className="float-end pointer" onClick={resetCreateShortUrl} />}
-        <ShlinkApiError errorData={errorData} fallbackMessage="An error occurred while creating the URL :(" />
+        <ShlinkApiError errorData={creation.errorData} fallbackMessage="An error occurred while creating the URL :(" />
       </Result>
     );
   }
 
-  if (isNil(result)) {
+  if (!saved) {
     return null;
   }
 
-  const { shortUrl } = result;
+  const { shortUrl } = creation.result;
 
   return (
     <Result type="success" className="mt-3">

src/short-urls/reducers/shortUrlCreation.ts

@@ -7,18 +7,31 @@ import { ProblemDetailsError } from '../../api/types/errors';
 
 export const CREATE_SHORT_URL = 'shlink/createShortUrl/CREATE_SHORT_URL';
 
-export interface ShortUrlCreation {
-  result: ShortUrl | null;
-  saving: boolean;
-  error: boolean;
+export type ShortUrlCreation = {
+  saving: false;
+  saved: false;
+  error: false;
+} | {
+  saving: true;
+  saved: false;
+  error: false;
+} | {
+  saving: false;
+  saved: false;
+  error: true;
   errorData?: ProblemDetailsError;
-}
+} | {
+  result: ShortUrl;
+  saving: false;
+  saved: true;
+  error: false;
+};
 
 export type CreateShortUrlAction = PayloadAction<ShortUrl>;
 
 const initialState: ShortUrlCreation = {
-  result: null,
   saving: false,
+  saved: false,
   error: false,
 };
 
@@ -30,17 +43,20 @@ export const shortUrlCreationReducerCreator = (buildShlinkApiClient: ShlinkApiCl
 
   const { reducer, actions } = createSlice({
     name: 'shortUrlCreationReducer',
-    initialState,
+    initialState: initialState as ShortUrlCreation, // Without this casting it infers type ShortUrlCreationWaiting
     reducers: {
       resetCreateShortUrl: () => initialState,
     },
     extraReducers: (builder) => {
-      builder.addCase(createShortUrl.pending, (state) => ({ ...state, saving: true, error: false }));
+      builder.addCase(createShortUrl.pending, () => ({ saving: true, saved: false, error: false }));
       builder.addCase(
         createShortUrl.rejected,
-        (state, { error }) => ({ ...state, saving: false, error: true, errorData: parseApiError(error) }),
+        (_, { error }) => ({ saving: false, saved: false, error: true, errorData: parseApiError(error) }),
+      );
+      builder.addCase(
+        createShortUrl.fulfilled,
+        (_, { payload: result }) => ({ result, saving: false, saved: true, error: false }),
       );
-      builder.addCase(createShortUrl.fulfilled, (_, { payload: result }) => ({ result, saving: false, error: false }));
     },
   });
 

src/short-urls/reducers/shortUrlEdition.ts

@@ -10,8 +10,8 @@ export const SHORT_URL_EDITED = 'shlink/shortUrlEdition/SHORT_URL_EDITED';
 export interface ShortUrlEdition {
   shortUrl?: ShortUrl;
   saving: boolean;
-  error: boolean;
   saved: boolean;
+  error: boolean;
   errorData?: ProblemDetailsError;
 }
 

src/short-urls/services/provideServices.ts

@@ -36,7 +36,7 @@ const provideServices = (bottle: Bottle, connect: ConnectDecorator) => {
   bottle.serviceFactory('CreateShortUrl', CreateShortUrl, 'ShortUrlForm', 'CreateShortUrlResult');
   bottle.decorator(
     'CreateShortUrl',
-    connect(['shortUrlCreationResult', 'selectedServer', 'settings'], ['createShortUrl', 'resetCreateShortUrl']),
+    connect(['shortUrlCreation', 'selectedServer', 'settings'], ['createShortUrl', 'resetCreateShortUrl']),
   );
 
   bottle.serviceFactory('EditShortUrl', EditShortUrl, 'ShortUrlForm');

test/short-urls/CreateShortUrl.test.tsx

@@ -13,7 +13,7 @@ describe('<CreateShortUrl />', () => {
   const CreateShortUrl = createShortUrlsCreator(ShortUrlForm, CreateShortUrlResult);
   const setUp = () => render(
     <CreateShortUrl
-      shortUrlCreationResult={shortUrlCreationResult}
+      shortUrlCreation={shortUrlCreationResult}
       createShortUrl={createShortUrl}
       selectedServer={null}
       resetCreateShortUrl={() => {}}

test/short-urls/helpers/CreateShortUrlResult.test.tsx

@@ -4,34 +4,39 @@ import { CreateShortUrlResult as createResult } from '../../../src/short-urls/he
 import { ShortUrl } from '../../../src/short-urls/data';
 import { TimeoutToggle } from '../../../src/utils/helpers/hooks';
 import { renderWithEvents } from '../../__helpers__/setUpTest';
+import { ShortUrlCreation } from '../../../src/short-urls/reducers/shortUrlCreation';
 
 describe('<CreateShortUrlResult />', () => {
   const copyToClipboard = jest.fn();
   const useTimeoutToggle = jest.fn(() => [false, copyToClipboard]) as TimeoutToggle;
   const CreateShortUrlResult = createResult(useTimeoutToggle);
-  const setUp = (result: ShortUrl | null = null, error = false) => renderWithEvents(
-    <CreateShortUrlResult resetCreateShortUrl={() => {}} result={result} error={error} saving={false} />,
+  const setUp = (creation: ShortUrlCreation) => renderWithEvents(
+    <CreateShortUrlResult resetCreateShortUrl={() => {}} creation={creation} />,
   );
 
   afterEach(jest.clearAllMocks);
 
   it('renders an error when error is true', () => {
-    setUp(Mock.all<ShortUrl>(), true);
+    setUp({ error: true, saved: false, saving: false });
     expect(screen.getByText('An error occurred while creating the URL :(')).toBeInTheDocument();
   });
 
-  it('renders nothing when no result is provided', () => {
-    const { container } = setUp();
+  it.each([[true], [false]])('renders nothing when not saved yet', (saving) => {
+    const { container } = setUp({ error: false, saved: false, saving });
     expect(container.firstChild).toBeNull();
   });
 
   it('renders a result message when result is provided', () => {
-    setUp(Mock.of<ShortUrl>({ shortUrl: 'https://doma.in/abc123' }));
+    setUp(
+      { result: Mock.of<ShortUrl>({ shortUrl: 'https://doma.in/abc123' }), saving: false, saved: true, error: false },
+    );
     expect(screen.getByText(/The short URL is/)).toHaveTextContent('Great! The short URL is https://doma.in/abc123');
   });
 
   it('Invokes tooltip timeout when copy to clipboard button is clicked', async () => {
-    const { user } = setUp(Mock.of<ShortUrl>({ shortUrl: 'https://doma.in/abc123' }));
+    const { user } = setUp(
+      { result: Mock.of<ShortUrl>({ shortUrl: 'https://doma.in/abc123' }), saving: false, saved: true, error: false },
+    );
 
     expect(copyToClipboard).not.toHaveBeenCalled();
     await user.click(screen.getByRole('button'));

test/short-urls/reducers/shortUrlCreation.test.ts

@@ -22,16 +22,16 @@ describe('shortUrlCreationReducer', () => {
 
     it('returns loading on CREATE_SHORT_URL_START', () => {
       expect(reducer(undefined, action(createShortUrl.pending.toString()))).toEqual({
-        result: null,
         saving: true,
+        saved: false,
         error: false,
       });
     });
 
     it('returns error on CREATE_SHORT_URL_ERROR', () => {
       expect(reducer(undefined, action(createShortUrl.rejected.toString()))).toEqual({
-        result: null,
         saving: false,
+        saved: false,
         error: true,
       });
     });
@@ -40,14 +40,15 @@ describe('shortUrlCreationReducer', () => {
       expect(reducer(undefined, action(createShortUrl.fulfilled.toString(), { payload: shortUrl }))).toEqual({
         result: shortUrl,
         saving: false,
+        saved: true,
         error: false,
       });
     });
 
     it('returns default state on RESET_CREATE_SHORT_URL', () => {
       expect(reducer(undefined, action(resetCreateShortUrl.toString()))).toEqual({
-        result: null,
         saving: false,
+        saved: false,
         error: false,
       });
     });