@retroachievements/api/src/console/getConsoleIds.test.ts

A well-tested library that lets you get achievement, user, and game data from RetroAchievements.

/* eslint-disable sonarjs/no-duplicate-string */

import { http, HttpResponse } from "msw";
import { setupServer } from "msw/node";

import { apiBaseUrl } from "../utils/internal";
import { buildAuthorization } from "../utils/public";
import { getConsoleIds } from "./getConsoleIds";
import type { FetchedSystem, GetConsoleIdsResponse } from "./models";

const server = setupServer();

describe("Function: getConsoleIds", () => {
  // MSW Setup
  beforeAll(() => server.listen());
  afterEach(() => server.resetHandlers());
  afterAll(() => server.close());

  it("is defined #sanity", () => {
    // ASSERT
    expect(getConsoleIds).toBeDefined();
  });

  it("retrieves a list of console IDs and their names and cleans properties", async () => {
    // ARRANGE
    const authorization = buildAuthorization({
      username: "mockUserName",
      webApiKey: "mockWebApiKey",
    });

    const mockResponse: GetConsoleIdsResponse = [
      {
        ID: "1",
        Name: "Mega Drive",
        IconURL:
          "https://static.retroachievements.org/assets/images/system/md.png",
        Active: true,
        IsGameSystem: true,
      },
      {
        ID: "2",
        Name: "Nintendo 64",
        IconURL:
          "https://static.retroachievements.org/assets/images/system/n64.png",
        Active: true,
        IsGameSystem: true,
      },
      {
        ID: "3",
        Name: "SNES",
        IconURL:
          "https://static.retroachievements.org/assets/images/system/snes.png",
        Active: false,
        IsGameSystem: false,
      },
    ];

    server.use(
      http.get(`${apiBaseUrl}/API_GetConsoleIDs.php`, () =>
        HttpResponse.json(mockResponse)
      )
    );

    // ACT
    const response = await getConsoleIds(authorization, {
      shouldOnlyRetrieveActiveSystems: true,
      shouldOnlyRetrieveGameSystems: true,
    });

    // ASSERT
    const expectedResponse: FetchedSystem[] = [
      {
        id: 1,
        name: "Mega Drive",
        iconUrl:
          "https://static.retroachievements.org/assets/images/system/md.png",
        active: true,
        isGameSystem: true,
      },
      {
        id: 2,
        name: "Nintendo 64",
        iconUrl:
          "https://static.retroachievements.org/assets/images/system/n64.png",
        active: true,
        isGameSystem: true,
      },
      {
        id: 3,
        name: "SNES",
        iconUrl:
          "https://static.retroachievements.org/assets/images/system/snes.png",
        active: false,
        isGameSystem: false,
      },
    ];

    expect(response).toEqual(expectedResponse);
  });
});