Merge pull request 'feature/upload-car-image' (#90) from feature/upload-car-image into main

Reviewed-on: #90

locales/en.json

@@ -50,6 +50,12 @@
   "dry-wash.order-view.details.location": "Where",
   "dry-wash.order-view.details.datetime-range": "When",
   "dry-wash.order-view.details.alert": "The operator will contact you about the payment at the specified phone number",
+  "dry-wash.order-view.upload-car-image.field.label": "Upload a photo of your car, and our service will quickly calculate the pre-order price!",
+  "dry-wash.order-view.upload-car-image.field.help": "Allowed formats: .jpg, .png. Maximum size: 5MB",
+  "dry-wash.order-view.upload-car-image.file-input.placeholder": "Upload a file",
+  "dry-wash.order-view.upload-car-image.file-input.button": "Upload",
+  "dry-wash.order-view.upload-car-image-query.success.title": "The car image is successfully uploaded",
+  "dry-wash.order-view.upload-car-image-query.error.title": "Failed to upload the car image",
   "dry-wash.arm.master.add": "Add",
   "dry-wash.arm.order.title": "Orders",
   "dry-wash.arm.order.table.empty": "Table empty",

locales/ru.json

@@ -105,6 +105,12 @@
   "dry-wash.order-view.details.location": "Где",
   "dry-wash.order-view.details.datetime-range": "Когда",
   "dry-wash.order-view.details.alert": "С вами свяжется оператор насчет оплаты по указанному номеру телефона",
+  "dry-wash.order-view.upload-car-image.field.label": "Загрузите фото вашего автомобиля, и наш сервис быстро рассчитает предварительную стоимость заказа!",
+  "dry-wash.order-view.upload-car-image.field.help": "Допустимые форматы: .jpg, .png. Максимальный размер: 5МБ",
+  "dry-wash.order-view.upload-car-image.file-input.placeholder": "Загрузите файл",
+  "dry-wash.order-view.upload-car-image.file-input.button": "Загрузить",
+  "dry-wash.order-view.upload-car-image-query.success.title": "Изображение автомобиля успешно загружено",
+  "dry-wash.order-view.upload-car-image-query.error.title": "Не удалось загрузить изображение автомобиля",
   "dry-wash.notFound.title": "Страница не найдена",
   "dry-wash.notFound.description": "К сожалению, запрашиваемая вами страница не существует.",
   "dry-wash.notFound.button.back": "Вернуться на главную",

src/__data__/service/landing.api.ts

@@ -1,4 +1,4 @@
-import { GetOrder, CreateOrder } from "../../models/api";
+import { GetOrder, CreateOrder, UploadCarImage } from "../../models/api";
 
 import { api } from "./api";
 import { extractBodyFromResponse, extractErrorMessageFromResponse } from "./utils";
@@ -19,5 +19,13 @@ export const landingApi = api.injectEndpoints({
       transformResponse: extractBodyFromResponse<CreateOrder.Response>,
       transformErrorResponse: extractErrorMessageFromResponse,
     }),
+    uploadCarImage: mutation<UploadCarImage.Response, UploadCarImage.Params>({
+      query: ({ orderId, body }) => ({
+        url: `/order/${orderId}/upload-car-img`,
+        body,
+        method: 'POST'
+      }),
+      transformErrorResponse: extractErrorMessageFromResponse,
+    }),
   })
 });

src/__data__/service/utils.ts

@@ -13,9 +13,10 @@ export const extractErrorMessageFromResponse = ({
 }: FetchBaseQueryError) => {
   if (
     typeof data === 'object' &&
-    'message' in data &&
-    typeof data.message === 'string'
+    data !== null &&
+    'error' in data &&
+    typeof data.error === 'string'
   ) {
-    return data.message;
+    return data.error;
   }
 };

src/components/order-view/car-img/car-img-form.tsx

@@ -0,0 +1,102 @@
+import React, { FC, memo, useRef } from 'react';
+import { Controller, useForm } from 'react-hook-form';
+import {
+  Button,
+  FormControl,
+  FormErrorMessage,
+  FormHelperText,
+  FormLabel,
+  HStack,
+  Input,
+} from '@chakra-ui/react';
+import { useTranslation } from 'react-i18next';
+
+import { landingApi } from '../../../__data__/service/landing.api';
+import { UploadCarImage } from '../../../models/api';
+
+import { useHandleUploadCarImageResponse } from './helper';
+
+type FormValues = {
+  carImg: File & {
+    fileName: string;
+  };
+};
+
+type CarImageFormProps = {
+  orderId: UploadCarImage.Params['orderId'];
+};
+
+export const CarImageForm: FC<CarImageFormProps> = memo(function CarImageForm({
+  orderId,
+}) {
+  const {
+    handleSubmit,
+    control,
+    formState: { errors, isSubmitting },
+  } = useForm<FormValues>({ shouldFocusError: true });
+
+  const [uploadCarImage, uploadCarImageMutation] =
+    landingApi.useUploadCarImageMutation();
+  useHandleUploadCarImageResponse(uploadCarImageMutation);
+
+  const onSubmit = (formData: FormValues) => {
+    const body = new FormData();
+    body.append('file', formData.carImg);
+    uploadCarImage({ orderId, body });
+  };
+
+  const fileInputRef = useRef(null);
+
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.order-view.upload-car-image',
+  });
+
+  return (
+    <form>
+      <FormControl>
+        <FormLabel htmlFor='carImg'>{t('field.label')}</FormLabel>
+        <Controller
+          control={control}
+          name='carImg'
+          render={({ field: { value, onChange, ...field } }) => {
+            return (
+              <HStack gap={0}>
+                <Input
+                  {...field}
+                  ref={fileInputRef}
+                  accept='.jpg,.png'
+                  value={value?.fileName}
+                  onChange={(event) => {
+                    onChange(event.target.files[0]);
+                    handleSubmit(onSubmit)();
+                  }}
+                  type='file'
+                  hidden
+                />
+                <Input
+                  placeholder={t('file-input.placeholder')}
+                  value={value?.name || ''}
+                  readOnly
+                  borderRightRadius={0}
+                />
+                <Button
+                  onClick={() => {
+                    fileInputRef.current.click();
+                  }}
+                  isLoading={isSubmitting || uploadCarImageMutation.isLoading}
+                  colorScheme='primary'
+                  paddingInline={8}
+                  borderLeftRadius={0}
+                >
+                  {t('file-input.button')}
+                </Button>
+              </HStack>
+            );
+          }}
+        />
+        <FormErrorMessage>{errors.carImg?.message}</FormErrorMessage>
+        <FormHelperText>{t('field.help')}</FormHelperText>
+      </FormControl>
+    </form>
+  );
+});

src/components/order-view/car-img/helper.ts

@@ -0,0 +1,35 @@
+import { useEffect } from "react";
+import { useToast } from "@chakra-ui/react";
+import { useTranslation } from "react-i18next";
+
+import { isErrorMessage } from "../../../models/api";
+
+export const useHandleUploadCarImageResponse = (query: {
+  isSuccess: boolean;
+  isError: boolean;
+  error?: unknown;
+}) => {
+  const toast = useToast();
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.order-create.upload-car-image-query',
+  });
+
+  useEffect(() => {
+    if (query.isError) {
+      toast({
+        status: 'error',
+        title: t('error.title'),
+        description: isErrorMessage(query.error) ? query.error : undefined,
+      });
+    }
+  }, [query.isError]);
+
+  useEffect(() => {
+    if (query.isSuccess) {
+      toast({
+        status: 'success',
+        title: t('success.title'),
+      });
+    }
+  }, [query.isSuccess]);
+};

src/components/order-view/car-img/index.ts

@@ -0,0 +1 @@
+export { CarImageForm } from './car-img-form';

src/components/order-view/details/order-details.tsx

@@ -5,11 +5,13 @@ import {
   Heading,
   HStack,
   UnorderedList,
-  VStack,
   ListItem,
   Text,
 } from '@chakra-ui/react';
 import { useTranslation } from 'react-i18next';
+import dayjs from 'dayjs';
+import localizedFormat from "dayjs/plugin/localizedFormat";
+dayjs.extend(localizedFormat);
 
 import { Order } from '../../../models/landing';
 import { formatDatetime } from '../../../lib';
@@ -41,7 +43,7 @@ export const OrderDetails: FC<OrderDetailsProps> = ({
   location,
   startWashTime,
   endWashTime,
-  ...props
+  created
 }) => {
   const { t } = useTranslation('~', {
     keyPrefix: 'dry-wash.order-view.details',
@@ -51,7 +53,7 @@ export const OrderDetails: FC<OrderDetailsProps> = ({
   });
 
   return (
-    <VStack p={4} alignItems='flex-start' gap={4} {...props}>
+    <>
       <HStack
         width='full'
         flexWrap='wrap'
@@ -59,7 +61,7 @@ export const OrderDetails: FC<OrderDetailsProps> = ({
         gap={2}
       >
         <Heading as='h2' size='lg'>
-          {t('title', { number: orderNumber })}
+          {t('title', { number: orderNumber })} ({dayjs(created).format('LLLL')})
         </Heading>
         <OrderStatus value={status} />
       </HStack>
@@ -105,7 +107,7 @@ export const OrderDetails: FC<OrderDetailsProps> = ({
         <AlertIcon />
         {t('alert')}
       </Alert>
-    </VStack>
+    </>
   );
 };
 

src/models/api/common.ts

@@ -9,7 +9,7 @@ export const isErrorMessage = (error: unknown): error is ErrorMessage => typeof
 
 type ErrorResponse = {
   success: false;
-  message: ErrorMessage;
+  error: ErrorMessage;
 };
 
 export type BaseResponse<Body> = SuccessResponse<Body> | ErrorResponse;

src/models/api/order.ts

@@ -21,6 +21,17 @@ export namespace CreateOrder {
   };
 }
 
+export namespace UploadCarImage {
+  export type Response = void;
+  export type Params = {
+    orderId: Order.Id;
+    /**
+     * @example { file: File }
+     */
+    body: FormData;
+  };
+}
+
 type GetArrItemType<ArrType> =
   ArrType extends Array<infer ItemType> ? ItemType : never;
 

src/pages/__tests__/__snapshots__/order-view.test.tsx.snap

@@ -16,7 +16,6 @@ exports[`Страница просмотра заказа отображает
       </h2>
       <div
         class="chakra-stack css-1n38vgh"
-        created="2025-01-19T14:04:02.985Z"
         data-testid="order-details"
       >
         <div
@@ -26,6 +25,9 @@ exports[`Страница просмотра заказа отображает
             class="chakra-heading css-1jb3vzl"
           >
             Заказ №{{number}}
+             (
+            Sunday, January 19, 2025 5:04 PM
+            )
           </h2>
           <span
             class="css-6jfsiv"
@@ -108,6 +110,55 @@ exports[`Страница просмотра заказа отображает
           </span>
           С вами свяжется оператор насчет оплаты по указанному номеру телефона
         </div>
+        <form>
+          <div
+            class="chakra-form-control css-1kxonj9"
+            role="group"
+          >
+            <label
+              class="chakra-form__label css-g6pte"
+              for="carImg"
+              id="field-:r0:-label"
+            >
+              Загрузите фото вашего автомобиля, и наш сервис быстро рассчитает предварительную стоимость заказа!
+            </label>
+            <div
+              class="chakra-stack css-1hohgv6"
+            >
+              <input
+                accept=".jpg,.png"
+                aria-describedby="field-:r0:-helptext"
+                class="chakra-input css-1cjy4zv"
+                hidden=""
+                id="field-:r0:"
+                name="carImg"
+                type="file"
+                value=""
+              />
+              <input
+                aria-describedby="field-:r0:-helptext"
+                aria-readonly="true"
+                class="chakra-input css-1oewt32"
+                id="field-:r0:"
+                placeholder="Загрузите файл"
+                readonly=""
+                value=""
+              />
+              <button
+                class="chakra-button css-fkfo5c"
+                type="button"
+              >
+                Загрузить
+              </button>
+            </div>
+            <div
+              class="chakra-form__helper-text css-186pyma"
+              id="field-:r0:-helptext"
+            >
+              Допустимые форматы: .jpg, .png. Максимальный размер: 5МБ
+            </div>
+          </div>
+        </form>
       </div>
     </div>
   </div>

src/pages/__tests__/__snapshots__/ordersList.test.tsx.snap

@@ -75,7 +75,7 @@ exports[`Страница заказов должна корректно ото
           <p
             class="chakra-text css-52ukzg"
           >
-            20.02.2025
+            23.02.2025
           </p>
           <button
             class="chakra-button css-ez23ye"

src/pages/order-view/index.tsx

@@ -21,6 +21,7 @@ import { Order } from '../../models/landing';
 import { landingApi } from '../../__data__/service/landing.api';
 import { isErrorMessage } from '../../models/api';
 import { FEATURE } from '../../__data__/features';
+import { CarImageForm } from '../../components/order-view/car-img';
 
 const Page: FC = () => {
   const { t } = useTranslation('~', {
@@ -69,6 +70,7 @@ const Page: FC = () => {
             <>
               <>
                 {isSuccess && (
+                  <VStack p={4} alignItems='flex-start' gap={4} data-testid='order-details'>
                     <OrderDetails
                       orderNumber={order.orderNumber}
                       status={order.status}
@@ -80,13 +82,18 @@ const Page: FC = () => {
                       startWashTime={order.startWashTime}
                       endWashTime={order.endWashTime}
                       created={order.created}                      
-                    data-testid='order-details'
                     />
+                    <CarImageForm orderId={orderId} />
+                  </VStack>
                 )}
               </>
               <>
                 {isError && (
-                  <Alert status='error' alignItems='flex-start' data-testid='error'>
+                  <Alert
+                    status='error'
+                    alignItems='flex-start'
+                    data-testid='error'
+                  >
                     <AlertIcon />
                     <Box>
                       <AlertTitle>

stubs/api/admin.js

@@ -2,7 +2,7 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 const router = require('express').Router();
 
-const STUBS = { masters: 'success', orders: 'success', orderCreate: 'success', orderView: 'success-pending' };
+const STUBS = { masters: 'success', orders: 'success', orderCreate: 'success', orderView: 'success-pending', orderCarImg: 'success' };
 
 router.get('/set/:name/:value', (req, res) => {
   const { name, value } = req.params;
@@ -37,6 +37,12 @@ router.get('/', (req, res) => {
       ${generateRadioInput('orderView', 'success-working')}
       ${generateRadioInput('orderView', 'error')}
     </fieldset>
+    <fieldset>
+      <legend>Лендинг - Детали заказа, фото машины</legend>
+      ${generateRadioInput('orderCarImg', 'success')}
+      ${generateRadioInput('orderCarImg', 'error-file-type')}
+      ${generateRadioInput('orderCarImg', 'error-file-size')}
+    </fieldset>
 </div>`);
 });
 

stubs/api/index.js

@@ -98,6 +98,22 @@ router.post('/order/create', (req, res) => {
     );
 });
 
+router.post('/order/:orderId/upload-car-img', (req, res) => {
+  const { orderId } = req.params;
+  const stubName = `${orderId}-${STUBS.orderCarImg}`;
+
+  try {
+    res
+      .status(/error/.test(stubName) ? 500 : 200)
+      .send(require(`../json/landing-order-car-image-upload/${stubName}.json`));
+  } catch (e) {
+    console.error(e);
+    res
+      .status(500)
+      .send(commonError);
+  }
+});
+
 router.use('/admin', require('./admin'));
 
 module.exports = router;

stubs/json/landing-order-car-image-upload/id1-error-file-size.json

@@ -0,0 +1,4 @@
+{
+  "success": false,
+  "error": "Invalid car image file size. Limit is 5MB"
+}

stubs/json/landing-order-car-image-upload/id1-error-file-type.json

@@ -0,0 +1,4 @@
+{
+  "success": false,
+  "error": "Invalid car image file type. Allowed types: jpg, png"
+}

stubs/json/landing-order-car-image-upload/id1-success.json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

stubs/json/landing-order-create/error.json

@@ -1,4 +1,4 @@
 {
   "success": false,
-  "message": "Не удалось создать заказ"
+  "error": "Не удалось создать заказ"
 }

stubs/json/landing-order-view/id1-error.json

@@ -1,4 +1,4 @@
 {
   "success": false,
-  "message": "Не удалось загрузить детали заказа"
+  "error": "Не удалось загрузить детали заказа"
 }