Add CodSpeed performance benchmarks

.github/workflows/codspeed.yml

@@ -0,0 +1,35 @@
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  codspeed:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v4
+        with:
+          mode: simulation
+          run: npx vitest bench --run

README.md

@@ -18,6 +18,9 @@
 ![GitHub Created At](https://img.shields.io/github/created-at/LCSOGthb/Games)
 ![GitHub last commit](https://img.shields.io/github/last-commit/LCSOGthb/Games)
 
+CodSpeed
+[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/LCSOGthb/Games?utm_source=badge)
+
 CodeRabbit
 ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/LCSOGthb/Games?utm_source=oss&utm_medium=github&utm_campaign=LCSOGthb%2FGames&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
 

app/page.tsx

@@ -1,49 +1,5 @@
 import GameCard from "@/components/GameCard";
-
-const games = [
-  {
-    id: 1,
-    title: "Chess Master",
-    description: "Play chess against AI or friends online in real time.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Strategy",
-  },
-  {
-    id: 2,
-    title: "Quick Quiz",
-    description: "Test your knowledge with fun trivia questions.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Trivia",
-  },
-  {
-    id: 3,
-    title: "Memory Match",
-    description: "Challenge your memory with this classic card-matching game.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Puzzle",
-  },
-  {
-    id: 4,
-    title: "Snake Game",
-    description: "Eat food, grow longer, and avoid running into yourself.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Arcade",
-  },
-  {
-    id: 5,
-    title: "Word Builder",
-    description: "Create as many words as you can from scrambled letters.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Word",
-  },
-  {
-    id: 6,
-    title: "Puzzle Solver",
-    description: "Solve challenging jigsaw puzzles of increasing difficulty.",
-    image: "/placeholder.svg?height=200&width=300",
-    category: "Puzzle",
-  },
-];
+import { games } from "@/lib/games";
 
 export default function Home() {
   return (

bench/games.bench.ts

@@ -0,0 +1,95 @@
+import { bench, describe } from "vitest";
+import {
+  games,
+  filterByCategory,
+  searchGames,
+  sortByTitle,
+  getCategories,
+  getGameById,
+} from "@/lib/games";
+import type { Game } from "@/lib/games";
+
+// Build a larger dataset from the base games for more realistic benchmarks
+function generateLargeGameList(size: number): Game[] {
+  const categories = [
+    "Strategy",
+    "Trivia",
+    "Puzzle",
+    "Arcade",
+    "Word",
+    "RPG",
+    "Action",
+    "Simulation",
+  ];
+  const result: Game[] = [];
+  for (let i = 0; i < size; i++) {
+    result.push({
+      id: i + 1,
+      title: `Game ${i + 1}`,
+      description: `Description for game number ${i + 1} with various keywords and details.`,
+      image: `/placeholder.svg?height=200&width=300`,
+      category: categories[i % categories.length],
+    });
+  }
+  return result;
+}
+
+const largeGameList = generateLargeGameList(1000);
+
+describe("filterByCategory", () => {
+  bench("filter base games by category", () => {
+    filterByCategory(games, "Puzzle");
+  });
+
+  bench("filter 1000 games by category", () => {
+    filterByCategory(largeGameList, "Puzzle");
+  });
+});
+
+describe("searchGames", () => {
+  bench("search base games by title", () => {
+    searchGames(games, "chess");
+  });
+
+  bench("search 1000 games by keyword", () => {
+    searchGames(largeGameList, "keywords");
+  });
+
+  bench("search with no results", () => {
+    searchGames(largeGameList, "nonexistent-query-string");
+  });
+});
+
+describe("sortByTitle", () => {
+  bench("sort base games ascending", () => {
+    sortByTitle(games);
+  });
+
+  bench("sort 1000 games ascending", () => {
+    sortByTitle(largeGameList);
+  });
+
+  bench("sort 1000 games descending", () => {
+    sortByTitle(largeGameList, false);
+  });
+});
+
+describe("getCategories", () => {
+  bench("get categories from base games", () => {
+    getCategories(games);
+  });
+
+  bench("get categories from 1000 games", () => {
+    getCategories(largeGameList);
+  });
+});
+
+describe("getGameById", () => {
+  bench("find first game by id", () => {
+    getGameById(games, 1);
+  });
+
+  bench("find last game by id in 1000 games", () => {
+    getGameById(largeGameList, 1000);
+  });
+});

lib/games.ts

@@ -0,0 +1,82 @@
+export interface Game {
+  id: number;
+  title: string;
+  description: string;
+  image: string;
+  category: string;
+}
+
+export const games: Game[] = [
+  {
+    id: 1,
+    title: "Chess Master",
+    description: "Play chess against AI or friends online in real time.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Strategy",
+  },
+  {
+    id: 2,
+    title: "Quick Quiz",
+    description: "Test your knowledge with fun trivia questions.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Trivia",
+  },
+  {
+    id: 3,
+    title: "Memory Match",
+    description: "Challenge your memory with this classic card-matching game.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Puzzle",
+  },
+  {
+    id: 4,
+    title: "Snake Game",
+    description: "Eat food, grow longer, and avoid running into yourself.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Arcade",
+  },
+  {
+    id: 5,
+    title: "Word Builder",
+    description: "Create as many words as you can from scrambled letters.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Word",
+  },
+  {
+    id: 6,
+    title: "Puzzle Solver",
+    description: "Solve challenging jigsaw puzzles of increasing difficulty.",
+    image: "/placeholder.svg?height=200&width=300",
+    category: "Puzzle",
+  },
+];
+
+export function filterByCategory(gameList: Game[], category: string): Game[] {
+  return gameList.filter(
+    (game) => game.category.toLowerCase() === category.toLowerCase(),
+  );
+}
+
+export function searchGames(gameList: Game[], query: string): Game[] {
+  const lowerQuery = query.toLowerCase();
+  return gameList.filter(
+    (game) =>
+      game.title.toLowerCase().includes(lowerQuery) ||
+      game.description.toLowerCase().includes(lowerQuery),
+  );
+}
+
+export function sortByTitle(gameList: Game[], ascending = true): Game[] {
+  return [...gameList].sort((a, b) => {
+    const cmp = a.title.localeCompare(b.title);
+    return ascending ? cmp : -cmp;
+  });
+}
+
+export function getCategories(gameList: Game[]): string[] {
+  return [...new Set(gameList.map((game) => game.category))].sort();
+}
+
+export function getGameById(gameList: Game[], id: number): Game | undefined {
+  return gameList.find((game) => game.id === id);
+}