All files / components/Commons CommonsForm.js

100% Statements 21/21
100% Branches 21/21
100% Functions 4/4
100% Lines 21/21

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420              66x   66x 19x                 66x             66x                 66x             66x 16x                     3x   3x                           66x 66x 66x 66x 66x 66x                     66x 66x   66x                                                                                                                                                                                                                                                                                                                                                                                                                                                                         10x                                   10x                                                                                                                                                                      
import {Button, Form, Row, Col, OverlayTrigger, Tooltip} from "react-bootstrap";
import {useForm} from "react-hook-form";
import {useBackend} from "main/utils/useBackend";
import { useEffect } from "react";
import HealthUpdateStrategiesDropdown from "main/components/Commons/HealthStrategiesUpdateDropdown";
 
function CommonsForm({initialCommons, submitAction, buttonLabel = "Create"}) {
    let modifiedCommons = initialCommons ? { ...initialCommons } : {};  // make a shallow copy of initialCommons
 
    if (modifiedCommons.startingDate) {
        modifiedCommons.startingDate = modifiedCommons.startingDate.split("T")[0];
    }
 
    // Stryker disable all
    const {
        register,
        formState: {errors},
        handleSubmit,
        reset,
    } = useForm(
        // modifiedCommons is guaranteed to be defined (initialCommons or {})
        {defaultValues: modifiedCommons}
    );
    // Stryker restore all
    
    // Stryker disable all
    const {data: healthUpdateStrategies} = useBackend(
        "/api/commons/all-health-update-strategies", {
            method: "GET",
            url: "/api/commons/all-health-update-strategies",
        },
    );
    // Stryker restore all
 
    // Stryker disable all
    const { data: defaultValuesData } = useBackend("/api/commons/defaults", {
        method: "GET",
        url: "/api/commons/defaults",
      });
    // Stryker restore all
    
    // Stryker disable all
    useEffect(() => {
        if(defaultValuesData && !initialCommons)
        {
            const{
                startingBalance,
                cowPrice,
                milkPrice,
                degradationRate,
                carryingCapacity,
                capacityPerUser,
                aboveCapacityStrategy,
                belowCapacityStrategy,
            } = defaultValuesData;
 
            reset({
                startingBalance,
                cowPrice,
                milkPrice,
                degradationRate,
                carryingCapacity,
                capacityPerUser,
                aboveCapacityStrategy,
                belowCapacityStrategy,
            });
        }
    }, [defaultValuesData, initialCommons, reset]);
    // Stryker restore all
    
    const testid = "CommonsForm";
    const curr = new Date();
    const today = curr.toLocaleDateString('en-CA'); // Canadian english gives YYYY-MM-DD
    const currMonth = curr.getMonth() % 12;
    const nextMonth = new Date(curr.getFullYear(), currMonth + 1, curr.getDate()).toISOString().substr(0, 10);
    const DefaultVals = {
        name: "",
        startingBalance: defaultValuesData?.startingBalance || "10000",
        cowPrice: defaultValuesData?.cowPrice || "100",
        milkPrice: defaultValuesData?.milkPrice || "1",
        degradationRate: defaultValuesData?.degradationRate || 0.001,
        carryingCapacity: defaultValuesData?.carryingCapacity || 100,
        startingDate: today,
        lastDate: nextMonth,
      };
 
    const belowStrategy = defaultValuesData?.belowCapacityStrategy;
    const aboveStrategy = defaultValuesData?.aboveCapacityStrategy;
 
    return (
        <Form onSubmit={handleSubmit(submitAction)}>
            {initialCommons && (
                <Form.Group className="mb-3">
                    <Form.Label htmlFor="id">Id</Form.Label>
                    <Form.Control
                        data-testid={`${testid}-id`}
                        id="id"
                        type="text"
                        {...register("id")}
                        value={initialCommons.id}
                        disabled
                    />
                </Form.Group>
            )}
 
            <div className="border-bottom mb-3"></div>
 
            <Row className="flex justify-content-start" style={{width: '80%'}} data-testid={`${testid}-r0`}>
                <Col className="" md={6}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="name">Commons Name</Form.Label>
                        <OverlayTrigger
                            placement="top"
                            overlay={<Tooltip>This is the name farmers will see when joining the game.</Tooltip>}
                            delay='5'
                        >
                            <Form.Control
                                data-testid={`${testid}-name`}
                                id="name"
                                type="text"
                                defaultValue={DefaultVals.name}
                                isInvalid={!!errors.name}
                                {...register("name", {required: "Commons name is required"})}
                            />
                        </OverlayTrigger>
                        <Form.Control.Feedback type="invalid">
                            {errors.name?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
                </Col>
                <Col md={6}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="startingBalance">Starting Balance</Form.Label>
                        <OverlayTrigger
                            placement="top"
                            overlay={<Tooltip>Each farmer starts with this amount of money in dollars.</Tooltip>}
                            delay='100'
                        >
                            <Form.Control
                                id="startingBalance"
                                data-testid={`${testid}-startingBalance`}
                                type="number"
                                step="0.01"
                                defaultValue={DefaultVals.startingBalance}
                                isInvalid={!!errors.startingBalance}
                                {...register("startingBalance", {
                                    valueAsNumber: true,
                                    required: "Starting Balance is required",
                                    min: {value: 0.0, message: "Starting Balance must be ≥ 0.00"},
                                })}
                            />
                        </OverlayTrigger>
                        <Form.Control.Feedback type="invalid">
                            {errors.startingBalance?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
                </Col>
            </Row>
 
            <Row className="flex justify-content-start" style={{width: '80%'}} data-testid={`${testid}-r1`}>
                <Col md={6}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="cowPrice">Cow Price</Form.Label>
                        <OverlayTrigger
                            placement="top"
                            overlay={<Tooltip>This is the price to purchase cows. The selling price is this amount times the health of the cows on that farm.</Tooltip>}
                            delay='100'
                        >
                            <Form.Control
                                data-testid={`${testid}-cowPrice`}
                                id="cowPrice"
                                type="number"
                                step="0.01"
                                defaultValue={DefaultVals.cowPrice}
                                isInvalid={!!errors.cowPrice}
                                {...register("cowPrice", {
                                    valueAsNumber: true,
                                    required: "Cow price is required",
                                    min: {value: 0.01, message: "Cow price must be ≥ 0.01"},
                                })}
                            />
                        </OverlayTrigger>
 
 
                        <Form.Control.Feedback type="invalid">
                            {errors.cowPrice?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
 
                </Col>
                <Col md={6}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="milkPrice">Milk Price</Form.Label>
                        <OverlayTrigger
                            placement="top"
                            overlay={<Tooltip>This is the amount of money the farmer earns in profits for each cow every time it is milked if it is at 100% health. When a cow is at health less than 100%, the amount earned is multiplied by that percentage (e.g. 75% of the milk price if the health is at 75%).</Tooltip>}
                            delay='100'
                        >
                            <Form.Control
                                data-testid={`${testid}-milkPrice`}
                                id="milkPrice"
                                type="number"
                                step="0.01"
                                defaultValue={DefaultVals.milkPrice}
                                isInvalid={!!errors.milkPrice}
                                {...register("milkPrice", {
                                    valueAsNumber: true,
                                    required: "Milk price is required",
                                    min: {value: 0.01, message: "Milk price must be ≥ 0.01"},
                                })}
                            />
                        </OverlayTrigger>
                        <Form.Control.Feedback type="invalid">
                            {errors.milkPrice?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
 
                </Col>
            </Row>
 
 
            <Row className="mt-1 flex justify-content-start" style={{width: '80%'}} data-testid={`${testid}-r2`}>
                <Col md={4}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="degradationRate">Degradation Rate</Form.Label>
                        <OverlayTrigger
                            placement="bottom"
                            overlay={<Tooltip>This number controls the rate at which cow health decreases when the number of cows in the commons is greater than the effective carrying capacity. The way in which the number is used depends on the selected Health Update Formulas below.</Tooltip>}
                            delay = '100'
                        >
                        <Form.Control
                            data-testid={`${testid}-degradationRate`}
                            id="degradationRate"
                            type="number"
                            step="0.0001"
                            defaultValue={DefaultVals.degradationRate}
 
                            isInvalid={!!errors.degradationRate}
                            {...register("degradationRate", {
                                valueAsNumber: true,
                                required: "Degradation rate is required",
                                min: {value: 0, message: "Degradation rate must be ≥ 0"},
                            })}
                        />
                        </OverlayTrigger>
                        <Form.Control.Feedback type="invalid">
                            {errors.degradationRate?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
                </Col>
                <Col md={4}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="carryingCapacity">Carrying Capacity</Form.Label>
                        <OverlayTrigger
                            placement="bottom"
                            overlay={<Tooltip>This is the minimum carrying capacity for the commons; at least this many cows may graze in the commons regardless of the number of players. If this number is zero, then only the Capacity Per User is used to determine the actual carrying capacity.</Tooltip>}
                            delay = '100'
                        >
                        <Form.Control
                            data-testid={`${testid}-carryingCapacity`}
                            id="carryingCapacity"
                            type="number"
                            step="1"
                            defaultValue={DefaultVals.carryingCapacity}
                            isInvalid={!!errors.carryingCapacity}
                            {...register("carryingCapacity", {
                                valueAsNumber: true,
                                required: "Carrying capacity is required",
                                min: {value: 1, message: "Carrying Capacity must be ≥ 1"},
                            })}
                        />
                        </OverlayTrigger>
 
                        <Form.Control.Feedback type="invalid">
                            {errors.carryingCapacity?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
                </Col>
                <Col md={4}>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="capacityPerUser">Capacity Per User</Form.Label>
                        <OverlayTrigger
                            placement="bottom"
                            overlay={<Tooltip>When this number is greater than zero, the commons will be able to support at least this many cows per farmer; that is, the effective carrying capacity of the commons is the value of Carrying Capacity, or Capacity Per User times the number of Farmers, whichever is greater. If this number is zero, then the Carrying Capacity is fixed regardless of the number of users.</Tooltip>}
                            delay = '100'
                            >
                        <Form.Control
                            data-testid={`${testid}-capacityPerUser`}
                            id="capacityPerUser"
                            type="number"
                            step="1"
                            defaultValue={defaultValuesData?.capacityPerUser}
                            isInvalid={!!errors.capacityPerUser}
                            {...register("capacityPerUser", {
                                valueAsNumber: true,
                                required: "Capacity Per User is required",
                            })}
                        />
                        </OverlayTrigger>
 
                        <Form.Control.Feedback type="invalid">
                            {errors.capacityPerUser?.message}
                        </Form.Control.Feedback>
                    </Form.Group>
                </Col>
            </Row>
 
            <Row>
                <Form.Group className="mb-5" style={{width: '300px', height: '50px'}} data-testid={`${testid}-r3`}>
                    <Form.Label htmlFor="startingDate">Starting Date</Form.Label>
                    <Form.Control
                        data-testid={`${testid}-startingDate`}
                        id="startingDate"
                        type="date"
                        defaultValue={DefaultVals.startingDate}
                        isInvalid={!!errors.startingDate}
                        {...register("startingDate", {
                            valueAsDate: true,
                            validate: {isPresent: (v) => !isNaN(v)},
                        })}
                    />
                    <Form.Control.Feedback type="invalid">
                        {errors.startingDate?.message}
                    </Form.Control.Feedback>
                </Form.Group>
                    
                <Form.Group className="mb-5" style={{width: '300px', height: '50px'}} data-testid={`${testid}-r4`}>
                    <Form.Label htmlFor="lastDate">Last Date</Form.Label>
                    <Form.Control
                        data-testid={`${testid}-lastDate`}
                        id="lastDate"
                        type="date"
                        defaultValue={DefaultVals.lastDate}
                        isInvalid={!!errors.lastDate}
                        {...register("lastDate", {
                            valueAsDate: true,
                            validate: {isPresent: (v) => !isNaN(v)},
                        })}
                    />
                    <Form.Control.Feedback type="invalid">
                        {errors.lastDate?.message}
                    </Form.Control.Feedback>
                </Form.Group>
            </Row>
 
 
            <h5>Health update formula</h5>
            <div className="border-bottom mb-4"></div>
            <Row>
                <Col md={6}>
                    <HealthUpdateStrategiesDropdown
                        formName={"aboveCapacityHealthUpdateStrategy"}
                        displayName={"When above capacity"}
                        initialValue={aboveStrategy}
                        register={register}
                        healthUpdateStrategies={healthUpdateStrategies}
                    />
 
                </Col>
                <Col md={6}>
                    <HealthUpdateStrategiesDropdown
                        formName={"belowCapacityHealthUpdateStrategy"}
                        displayName={"When below capacity"}
                        initialValue={belowStrategy}
                        register={register}
                        healthUpdateStrategies={healthUpdateStrategies}
                    />
                </Col>
            </Row>
 
            <Row>
                <Col>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="showLeaderboard">Show Leaderboard?</Form.Label>
                        <OverlayTrigger
                                    placement="bottom"
                                    overlay={<Tooltip>When checked, regular users will have access to the leaderboard for this commons. When unchecked, only admins can see the leaderboard for this commons.</Tooltip>}
                                    delay = '100'
                                >
                        <Form.Check
                            data-testid={`${testid}-showLeaderboard`}
                            type="checkbox"
                            id="showLeaderboard"
                            {...register("showLeaderboard")}
                        />
                        </OverlayTrigger>
                    </Form.Group>
                </Col>
 
                <Col>
                    <Form.Group className="mb-3">
                        <Form.Label htmlFor="showChat">Show Chat?</Form.Label>
                        <OverlayTrigger
                                    placement="bottom"
                                    overlay={<Tooltip>When checked, regular users will have access to the chat for this commons. When unchecked, only admins can see the chat for this commons.</Tooltip>}
                                    delay = '100'
                                >
                        <Form.Check
                            data-testid={`${testid}-showChat`}
                            type="checkbox"
                            id="showChat"
                            {...register("showChat")}
                        />
                        </OverlayTrigger>
                    </Form.Group>
                </Col>
 
            </Row>
 
            <Row className="mb-5">
                <Button type="submit"
                        data-testid="CommonsForm-Submit-Button"
                        className="pl-1 w-30 text-left"
                        style={{width: '30%'}}
                >{buttonLabel}</Button>
            </Row>
        </Form>
    );
}
export default CommonsForm;