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 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 10x 201x 10x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 201x 49x 151x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import React, { useState } from "react";
import { useParams, useNavigate } from "react-router";
import { Row, Col, Card, Form, Button } from "react-bootstrap";
import BasicLayout from "main/layouts/BasicLayout/BasicLayout";
import { useBackend, useBackendMutation } from "main/utils/useBackend";
import { hasRole, useCurrentUser } from "main/utils/currentUser";
import CountHistogram from "main/components/Utils/CountHistogram";
import BinSizeSelector from "main/components/Utils/BinSizeSelector";
import TimeSeries from "main/components/Utils/TimeSeries";
import DashboardSectionCard from "main/components/Dashboard/DashboardSectionCard";
import LeaderboardTable from "main/components/Leaderboard/LeaderboardTable";
import {
fieldOrBlank,
getGameId,
getGameName,
getIsHidden,
getStartingDate,
getDaysActive,
numericFieldOrBlank,
getPercentageOfCarryingCapacity,
} from "main/utils/dashboardUtils";
export default function DashboardPage() {
const params = useParams();
// Stryker disable next-line all : either param name may be used depending on the route
const id = params.id ?? params.gameId;
const navigate = useNavigate();
const { data: currentUser } = useCurrentUser();
const isAdmin = hasRole(currentUser, "ROLE_ADMIN");
const [binSize, setBinSize] = useState(10);
const [viewAsStudent, setViewAsStudent] = useState(false);
// Stryker disable all
const { data: gamePlus } = useBackend(
[`/api/game/plus?id=${id}`],
{
url: "/api/game/plus",
params: { id },
},
null,
{ enabled: !!id },
);
// Stryker restore all
const game = gamePlus?.game;
// isAdminView is true only when an admin is looking at the dashboard in
// its normal (non-"View as Student") mode.
const isAdminView = isAdmin && !viewAsStudent;
// Activity is never tracked for games that aren't linked to a course (see
// issue #291), so the leaderboard's Activity column doesn't make sense
// there either.
const isCourseLinkedGame = game?.courseId != null;
const showDashboardToStudents = game?.showLeaderboard === true;
const showOverviewSection = game?.showOverviewSection !== false;
const showCowsPerFarmerSection = game?.showCowsPerFarmerSection !== false;
const showCapacitySection = game?.showCapacitySection !== false;
const showHistogramSection = game?.showHistogramSection !== false;
const showTrendsSection = game?.showTrendsSection !== false;
const showHealthSection = game?.showHealthSection !== false;
const showTotalCowsSection = game?.showTotalCowsSection !== false;
const showCapacityOverTimeSection =
game?.showCapacityOverTimeSection !== false;
const showFarmerLeaderboardSection =
game?.showFarmerLeaderboardSection !== false;
const canSeeDashboard = isAdminView || showDashboardToStudents;
// Stryker disable all
const { data: numCowsData } = useBackend(
[`/api/game/numcows?gameId=${id}`],
{
url: "/api/game/numcows",
params: { gameId: id },
},
[],
{
enabled: !!id && canSeeDashboard && (isAdminView || showHistogramSection),
},
);
// Stryker restore all
// Stryker disable all
const { data: timeSeriesData } = useBackend(
[`/api/game/timeseries?commonId=${id}`],
{
url: "/api/game/timeseries",
params: { commonId: id },
},
[],
{
enabled:
!!id &&
canSeeDashboard &&
(isAdminView ||
showTrendsSection ||
showHealthSection ||
showTotalCowsSection ||
showCapacityOverTimeSection),
},
);
// Stryker restore all
// Stryker disable all
const { data: farmer } = useBackend(
[`/api/farmer/game/all?gameId=${id}`],
{
url: "/api/farmer/game/all",
params: { gameId: id },
},
[],
{
enabled:
!!id &&
canSeeDashboard &&
(isAdminView || showFarmerLeaderboardSection),
},
);
// Stryker restore all
// Stryker disable all : it is acceptable to exclude useBackendMutation calls from mutation testing
const dashboardSettingsMutation = useBackendMutation(
(settings) => ({
url: "/api/game/dashboardSettings",
method: "PUT",
params: { id },
data: settings,
}),
{},
[`/api/game/plus?id=${id}`],
);
// Stryker restore all
const updateDashboardSetting = (field, value) => {
dashboardSettingsMutation.mutate({
showLeaderboard: showDashboardToStudents,
showOverviewSection: showOverviewSection,
showCowsPerFarmerSection: showCowsPerFarmerSection,
showCapacitySection: showCapacitySection,
showHistogramSection: showHistogramSection,
showTrendsSection: showTrendsSection,
showHealthSection: showHealthSection,
showTotalCowsSection: showTotalCowsSection,
showCapacityOverTimeSection: showCapacityOverTimeSection,
showFarmerLeaderboardSection: showFarmerLeaderboardSection,
[field]: value,
});
};
const totalFarmers = fieldOrBlank(gamePlus, "totalUsers");
const totalCows = fieldOrBlank(gamePlus, "totalCows");
const gameId = getGameId(gamePlus, id);
const gameStartDate = getStartingDate(gamePlus);
const daysActive = getDaysActive(gamePlus);
const gameName = getGameName(gamePlus);
const isHidden = getIsHidden(gamePlus);
const averageCowsPerFarmer = numericFieldOrBlank(
gamePlus,
"averageCowsPerFarmer",
);
const medianCowsPerFarmer = numericFieldOrBlank(
gamePlus,
"medianCowsPerFarmer",
);
const minimumCowsPerFarmer = numericFieldOrBlank(
gamePlus,
"minimumCowsPerFarmer",
);
const maximumCowsPerFarmer = numericFieldOrBlank(
gamePlus,
"maximumCowsPerFarmer",
);
const standardDeviationCowsPerFarmer = numericFieldOrBlank(
gamePlus,
"standardDeviationCowsPerFarmer",
);
const effectiveCapacity = fieldOrBlank(gamePlus, "effectiveCapacity");
const averageCowHealth = numericFieldOrBlank(gamePlus, "averageCowHealth");
const percentageOfCarryingCapacity = getPercentageOfCarryingCapacity(
gamePlus?.totalCows,
gamePlus?.effectiveCapacity,
);
if (!gamePlus) {
return (
<BasicLayout>
<h1>Loading...</h1>
</BasicLayout>
);
}
return (
<BasicLayout>
<div className="d-flex justify-content-between align-items-start">
<h1 className="mb-1">
{isHidden && <i className="fa-solid fa-eye-slash pe-5"></i>}
{gameName}
</h1>
{isAdmin && (
<Button
data-testid="DashboardPage-back-button"
onClick={() => navigate(-1)}
>
Back
</Button>
)}
</div>
<h3 className="mb-4">Dashboard</h3>
{isAdmin && (
<Card className="mb-4 w-100" data-testid="DashboardPage-admin-controls">
<Card.Body>
<Row>
<Col>
<Form.Check
type="switch"
id="DashboardPage-showDashboard"
data-testid="DashboardPage-showDashboard"
label="Show Dashboard to Students"
checked={showDashboardToStudents}
onChange={(e) =>
updateDashboardSetting("showLeaderboard", e.target.checked)
}
/>
</Col>
<Col>
<Form.Check
type="switch"
id="DashboardPage-viewAsStudent"
data-testid="DashboardPage-viewAsStudent"
label="View as Student"
checked={viewAsStudent}
onChange={(e) => setViewAsStudent(e.target.checked)}
/>
</Col>
</Row>
</Card.Body>
</Card>
)}
{!canSeeDashboard && <p>You're not authorized to see the dashboard.</p>}
{canSeeDashboard && (
<>
<DashboardSectionCard
title="Overview"
visible={showOverviewSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showOverviewSection", v)
}
testid="DashboardPage-OverviewSection"
>
<Row>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Total Farmers</Card.Title>
<Card.Text>{totalFarmers}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Total Cows</Card.Title>
<Card.Text>{totalCows}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Days Active</Card.Title>
<Card.Text>{daysActive}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>ID</Card.Title>
<Card.Text>{gameId}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Start Date</Card.Title>
<Card.Text>{gameStartDate}</Card.Text>
</Card.Body>
</Card>
</Col>
</Row>
</DashboardSectionCard>
<DashboardSectionCard
title="Cows Per Farmer"
visible={showCowsPerFarmerSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showCowsPerFarmerSection", v)
}
testid="DashboardPage-CowsPerFarmerSection"
>
<Row>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Average</Card.Title>
<Card.Text>{averageCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Median</Card.Title>
<Card.Text>{medianCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Min</Card.Title>
<Card.Text>{minimumCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Max</Card.Title>
<Card.Text>{maximumCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>StdDev</Card.Title>
<Card.Text>{standardDeviationCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
</Row>
</DashboardSectionCard>
<DashboardSectionCard
title="Capacity"
visible={showCapacitySection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showCapacitySection", v)
}
testid="DashboardPage-CapacitySection"
>
<Row>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Total Cows</Card.Title>
<Card.Text>{totalCows}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Effective Capacity</Card.Title>
<Card.Text>{effectiveCapacity}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>% Effective Capacity</Card.Title>
<Card.Text>{percentageOfCarryingCapacity}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Avg Cow Health</Card.Title>
<Card.Text>{averageCowHealth}</Card.Text>
</Card.Body>
</Card>
</Col>
<Col>
<Card className="mb-3">
<Card.Body>
<Card.Title>Avg Cows/Farmer</Card.Title>
<Card.Text>{averageCowsPerFarmer}</Card.Text>
</Card.Body>
</Card>
</Col>
</Row>
</DashboardSectionCard>
<DashboardSectionCard
title="Cows Per Farmer Histogram"
visible={showHistogramSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showHistogramSection", v)
}
testid="DashboardPage-HistogramSection"
>
<CountHistogram
data={numCowsData}
s={binSize}
xLabel="Cows"
yLabel="Farmers"
/>
<BinSizeSelector value={binSize} onChange={setBinSize} />
</DashboardSectionCard>
<DashboardSectionCard
title="Trends Over Time"
visible={showTrendsSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showTrendsSection", v)
}
testid="DashboardPage-TrendsSection"
>
<TimeSeries
data={timeSeriesData}
selectors={["Health", "Total Cows"]}
testid="DashboardPage-TrendsSection-time-series"
/>
</DashboardSectionCard>
<DashboardSectionCard
title="Health Over Time"
visible={showHealthSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showHealthSection", v)
}
testid="DashboardPage-HealthSection"
>
<TimeSeries
data={timeSeriesData}
selectors="Health"
testid="DashboardPage-HealthSection-time-series"
/>
</DashboardSectionCard>
<DashboardSectionCard
title="Total Cows Over Time"
visible={showTotalCowsSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showTotalCowsSection", v)
}
testid="DashboardPage-TotalCowsSection"
>
<TimeSeries
data={timeSeriesData}
selectors="Total Cows"
testid="DashboardPage-TotalCowsSection-time-series"
/>
</DashboardSectionCard>
<DashboardSectionCard
title="Trends Over Time plus Capacity"
visible={showCapacityOverTimeSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showCapacityOverTimeSection", v)
}
testid="DashboardPage-CapacityOverTimeSection"
>
<TimeSeries
data={timeSeriesData}
selectors={["Health", "Total Cows", "Effective Capacity"]}
testid="DashboardPage-CapacityOverTimeSection-time-series"
/>
</DashboardSectionCard>
<DashboardSectionCard
title="Leaderboard"
visible={showFarmerLeaderboardSection}
isAdminView={isAdminView}
onToggleVisible={(v) =>
updateDashboardSetting("showFarmerLeaderboardSection", v)
}
testid="DashboardPage-LeaderboardSection"
>
<LeaderboardTable
leaderboardUsers={farmer}
currentUser={currentUser}
isAdminView={isAdminView}
isCourseLinkedGame={isCourseLinkedGame}
/>
</DashboardSectionCard>
</>
)}
</BasicLayout>
);
}
|