✨ Enable to import JAG prelim and regional tasks (#1514)

prisma/ERD.md

@@ -29,6 +29,7 @@ UNIVERSITY UNIVERSITY
 OTHERS OTHERS
 AOJ_COURSES AOJ_COURSES
 AOJ_PCK AOJ_PCK
+AOJ_JAG AOJ_JAG
         }
 
 

prisma/migrations/20241120113542_add_aoj_jag_to_contest_type/migration.sql

@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "ContestType" ADD VALUE 'AOJ_JAG';

prisma/schema.prisma

@@ -224,6 +224,7 @@ enum ContestType {
   OTHERS // AtCoder (その他)
   AOJ_COURSES // AIZU ONLINE JUDGE Courses
   AOJ_PCK // All-Japan High School Programming Contest (PCK)
+  AOJ_JAG // ACM-ICPC Japan Alumni Group Contest (JAG)
 }
 
 // 11Q(最も簡単)〜6D(最難関)。

src/lib/clients/aizu_online_judge.ts

@@ -30,6 +30,14 @@ type AOJChallengeContestAPI = {
   readonly contests: ChallengeContests;
 };
 
+/**
+ * Enum representing the types of challenge contests available.
+ */
+enum ChallengeContestType {
+  PCK = 'pck',
+  JAG = 'jag',
+}
+
 /**
  * Represents a challenge contest in the AOJ
  */
@@ -80,6 +88,14 @@ enum PckRound {
   FINAL = 'final',
 }
 
+/**
+ * Enum representing JAG contest rounds
+ */
+enum JagRound {
+  PRELIM = 'prelim',
+  REGIONAL = 'regional',
+}
+
 /**
  * Constant used as a placeholder for missing timestamp data in AOJ contests
  * Value: -1
@@ -98,20 +114,22 @@ export class AojApiClient extends ContestSiteApiClient {
   /**
    * Fetches and combines contests from different sources.
    *
-   * This method concurrently fetches course contests, preliminary PCK contests,
-   * and final PCK contests, then combines them into a single array.
+   * This method concurrently fetches course contests, preliminary and final PCK contests,
+   * and prelim and regional JAG contests, then combines them into a single array.
    *
    * @returns {Promise<ContestsForImport>} A promise that resolves to an array of contests.
    */
   async getContests(): Promise<ContestsForImport> {
     try {
-      const [courses, pckPrelims, pckFinals] = await Promise.all([
+      const [courses, pckPrelims, pckFinals, jagPrelims, jagRegionals] = await Promise.all([
         this.fetchCourseContests(),
-        this.fetchPckContests(PckRound.PRELIM),
-        this.fetchPckContests(PckRound.FINAL),
+        this.fetchChallengeContests(ChallengeContestType.PCK, PckRound.PRELIM),
+        this.fetchChallengeContests(ChallengeContestType.PCK, PckRound.FINAL),
+        this.fetchChallengeContests(ChallengeContestType.JAG, JagRound.PRELIM),
+        this.fetchChallengeContests(ChallengeContestType.JAG, JagRound.REGIONAL),
       ]);
 
-      const contests = courses.concat(pckPrelims, pckFinals);
+      const contests = courses.concat(pckPrelims, pckFinals, jagPrelims, jagRegionals);
       console.log(`Found AOJ: ${contests.length} contests.`);
 
       return contests;
@@ -158,24 +176,31 @@ export class AojApiClient extends ContestSiteApiClient {
   }
 
   /**
-   * Fetches PCK contests from the AOJ API for a given round.
+   * Fetches challenge contests from the AOJ API for a given round.
    *
-   * @param {PckRound} round - The round identifier for which to fetch contests.
+   * @param {ChallengeContestType} contestType - The type of challenge contest for which to fetch contests.
+   * @param {PckRound | JagRound} round - The round identifier for which to fetch contests.
    * @returns {Promise<ContestsForImport>} A promise that resolves to an array of contests for import.
    *
    * @throws Will throw an error if the API request fails or the response validation fails.
    *
    * @example
+   * const contestType = ChallengeContestType.PCK;
    * const round = 'PRELIM';
-   * const contests = await fetchPckContests(round);
+   * const contests = await fetchChallengeContests(contestType, round);
    * console.log(contests);
    */
-  private async fetchPckContests(round: PckRound): Promise<ContestsForImport> {
+  private async fetchChallengeContests(
+    contestType: ChallengeContestType,
+    round: PckRound | JagRound,
+  ): Promise<ContestsForImport> {
+    const contestTypeLabel = contestType.toLocaleUpperCase();
+
     try {
       const results = await this.fetchApiWithConfig<AOJChallengeContestAPI>({
         baseApiUrl: AOJ_API_BASE_URL,
-        endpoint: `challenges/cl/pck/${round}`,
-        errorMessage: `Failed to fetch ${round} contests from AOJ API`,
+        endpoint: `challenges/cl/${contestType}/${round}`,
+        errorMessage: `Failed to fetch ${contestTypeLabel} ${round} contests from AOJ API`,
         validateResponse: (data) =>
           'contests' in data && Array.isArray(data.contests) && data.contests.length > 0,
       });
@@ -192,11 +217,11 @@ export class AojApiClient extends ContestSiteApiClient {
         [] as ContestsForImport,
       );
 
-      console.log(`Found AOJ PCK ${round}: ${contests.length} contests.`);
+      console.log(`Found AOJ ${contestTypeLabel} ${round}: ${contests.length} contests.`);
 
       return contests;
     } catch (error) {
-      console.error(`Failed to fetch from AOJ PCK ${round} contests:`, error);
+      console.error(`Failed to fetch from AOJ ${contestTypeLabel} ${round} contests:`, error);
       return [];
     }
   }
@@ -226,10 +251,12 @@ export class AojApiClient extends ContestSiteApiClient {
   /**
    * Fetches tasks from various sources and combines them into a single list.
    *
-   * This method concurrently fetches tasks from three different sources:
+   * This method concurrently fetches tasks from five different sources:
    * - Course tasks
    * - PCK Prelim tasks
    * - PCK Final tasks
+   * - JAG Prelim tasks
+   * - JAG Regional tasks
    *
    * The fetched tasks are then concatenated into a single array and returned.
    *
@@ -239,12 +266,14 @@ export class AojApiClient extends ContestSiteApiClient {
    */
   async getTasks(): Promise<TasksForImport> {
     try {
-      const [courses, pckPrelims, pckFinals] = await Promise.all([
+      const [courses, pckPrelims, pckFinals, jagPrelims, jagRegionals] = await Promise.all([
         this.fetchCourseTasks(),
-        this.fetchPckTasks(PckRound.PRELIM),
-        this.fetchPckTasks(PckRound.FINAL),
+        this.fetchChallengeTasks(ChallengeContestType.PCK, PckRound.PRELIM),
+        this.fetchChallengeTasks(ChallengeContestType.PCK, PckRound.FINAL),
+        this.fetchChallengeTasks(ChallengeContestType.JAG, JagRound.PRELIM),
+        this.fetchChallengeTasks(ChallengeContestType.JAG, JagRound.REGIONAL),
       ]);
-      const tasks = courses.concat(pckPrelims, pckFinals);
+      const tasks = courses.concat(pckPrelims, pckFinals, jagPrelims, jagRegionals);
       console.log(`Found AOJ: ${tasks.length} tasks.`);
 
       return tasks;
@@ -309,9 +338,10 @@ export class AojApiClient extends ContestSiteApiClient {
   };
 
   /**
-   * Fetches tasks for a specified PCK round from the AOJ API.
+   * Fetches tasks for a specified challenge contest round from the AOJ API.
    *
-   * @param {string} round - The round identifier for which to fetch tasks.
+   * @param {ChallengeContestType} contestType - The type of challenge contest for which to fetch tasks.
+   * @param {PckRound | JagRound} round - The round identifier for which to fetch tasks.
    * @returns {Promise<TasksForImport>} A promise that resolves to an object containing tasks for import.
    * @throws Will throw an error if the API request fails or the response is invalid.
    *
@@ -321,17 +351,17 @@ export class AojApiClient extends ContestSiteApiClient {
    * 3. Maps the contest data to a list of tasks, extracting relevant information such as task ID, contest ID, and title.
    * 4. Logs the number of tasks found for the specified round.
    */
-  private async fetchPckTasks(round: string): Promise<TasksForImport> {
-    if (!Object.values(PckRound).includes(round as PckRound)) {
-      console.error(`Found invalid PCK round: ${round}`);
-      return [];
-    }
+  private async fetchChallengeTasks(
+    contestType: ChallengeContestType,
+    round: PckRound | JagRound,
+  ): Promise<TasksForImport> {
+    const contestTypeLabel = contestType.toLocaleUpperCase();
 
     try {
       const allPckContests = await this.fetchApiWithConfig<AOJChallengeContestAPI>({
         baseApiUrl: AOJ_API_BASE_URL,
-        endpoint: `challenges/cl/pck/${round}`,
-        errorMessage: `Failed to fetch PCK ${round} tasks from AOJ API`,
+        endpoint: `challenges/cl/${contestType}/${round}`,
+        errorMessage: `Failed to fetch ${contestTypeLabel} ${round} tasks from AOJ API`,
         validateResponse: (data) =>
           'contests' in data && Array.isArray(data.contests) && data.contests.length > 0,
       });
@@ -350,11 +380,11 @@ export class AojApiClient extends ContestSiteApiClient {
         },
         [],
       );
-      console.log(`Found PCK ${round}: ${tasks.length} tasks.`);
+      console.log(`Found ${contestTypeLabel} ${round}: ${tasks.length} tasks.`);
 
       return tasks;
     } catch (error) {
-      console.error(`Failed to fetch from PCK ${round} tasks:`, error);
+      console.error(`Failed to fetch from ${contestTypeLabel} ${round} tasks:`, error);
       return [];
     }
   }

src/lib/clients/index.ts

@@ -16,6 +16,7 @@ import type { TaskForImport, TasksForImport } from '$lib/types/task';
 //   ・Courses
 //   ・Challenges
 //     ・PCK (All-Japan High School Programming Contest)
+//     ・JAG (ACM-ICPC Japan Alumni Group Contest)
 
 /**
  * Creates and returns an object containing instances of various API clients.

src/lib/types/contest.ts

@@ -23,6 +23,10 @@ export type ContestsForImport = ContestForImport[];
 // Import original enum as type.
 import type { ContestType as ContestTypeOrigin } from '@prisma/client';
 
+/**
+ * An object representing various types of programming contests.
+ * Each key is a contest type identifier, and the value is the same identifier as a string.
+ */
 export const ContestType: { [key in ContestTypeOrigin]: key } = {
   ABC: 'ABC', // AtCoder Beginner Contest
   APG4B: 'APG4B', // C++入門 AtCoder Programming Guide for beginners
@@ -44,6 +48,7 @@ export const ContestType: { [key in ContestTypeOrigin]: key } = {
   OTHERS: 'OTHERS', // AtCoder (その他)
   AOJ_COURSES: 'AOJ_COURSES', // AIZU ONLINE JUDGE Courses
   AOJ_PCK: 'AOJ_PCK', // All-Japan High School Programming Contest (PCK)
+  AOJ_JAG: 'AOJ_JAG', // ACM-ICPC Japan Alumni Group Contest (JAG)
 } as const;
 
 // Re-exporting the original type with the original name.
@@ -65,3 +70,14 @@ export type ContestType = ContestTypeOrigin;
 export interface ContestPrefix {
   [key: string]: string;
 }
+
+/**
+ * Represents a collection of translations for contest labels.
+ * The keys are language codes or identifiers, and the values are the translated strings.
+ *
+ * @property {string} [key] - The abbr contest type in English.
+ * @property {string} [key: string] - The contest name in Japanese.
+ */
+export type ContestLabelTranslations = {
+  [key: string]: string;
+};

src/lib/utils/contest.ts

@@ -1,4 +1,4 @@
-import { ContestType, type ContestPrefix } from '$lib/types/contest';
+import { ContestType, type ContestPrefix, type ContestLabelTranslations } from '$lib/types/contest';
 
 // See:
 // https://github.com/kenkoooo/AtCoderProblems/blob/master/atcoder-problems-frontend/src/utils/ContestClassifier.ts
@@ -81,6 +81,10 @@ export const classifyContest = (contest_id: string) => {
     return ContestType.AOJ_PCK;
   }
 
+  if (/^JAG(Prelim|Regional|Summer|Winter|Spring)\d*$/.exec(contest_id)) {
+    return ContestType.AOJ_JAG;
+  }
+
   return null;
 };
 
@@ -220,6 +224,7 @@ export const contestTypePriorities: Map<ContestType, number> = new Map([
   [ContestType.OTHERS, 17], // AtCoder (その他)
   [ContestType.AOJ_COURSES, 18],
   [ContestType.AOJ_PCK, 19],
+  [ContestType.AOJ_JAG, 20],
 ]);
 
 export function getContestPriority(contestId: string): number {
@@ -271,22 +276,31 @@ export const getContestNameLabel = (contest_id: string) => {
   }
 
   if (contest_id.startsWith('PCK')) {
-    return getAojPckLabel(contest_id);
+    return getAojChallengeLabel(PCK_TRANSLATIONS, contest_id);
+  }
+
+  if (contest_id.startsWith('JAG')) {
+    return getAojChallengeLabel(JAG_TRANSLATIONS, contest_id);
   }
 
   return contest_id.toUpperCase();
 };
 
-function getAojPckLabel(contestId: string): string {
-  const PCK_TRANSLATIONS = {
-    PCK: 'パソコン甲子園',
-    Prelim: '予選',
-    Final: '本選',
-  };
+const PCK_TRANSLATIONS = {
+  PCK: 'パソコン甲子園',
+  Prelim: '予選',
+  Final: '本選',
+};
+
+const JAG_TRANSLATIONS = {
+  Prelim: '模擬国内予選',
+  Regional: '模擬アジア地区予選',
+};
 
+function getAojChallengeLabel(translations: ContestLabelTranslations, contestId: string): string {
   const baseLabel = 'AOJ - ';
 
-  Object.entries(PCK_TRANSLATIONS).forEach(([abbrEnglish, japanese]) => {
+  Object.entries(translations).forEach(([abbrEnglish, japanese]) => {
     contestId = contestId.replace(abbrEnglish, japanese);
   });
 

src/lib/utils/task.ts

@@ -30,7 +30,11 @@ class AtCoderGenerator implements UrlGenerator {
 
 class AojGenerator implements UrlGenerator {
   canHandle(contestId: string): boolean {
-    return getPrefixForAojCourses().includes(contestId) || contestId.startsWith('PCK');
+    return (
+      getPrefixForAojCourses().includes(contestId) ||
+      contestId.startsWith('PCK') ||
+      contestId.startsWith('JAG')
+    );
   }
 
   // Note: contestId is not used because it is not included in the URL.

src/test/lib/utils/contest.test.ts

@@ -171,6 +171,14 @@ describe('Contest', () => {
           });
         });
       });
+
+      describe('when contest_id mean AOJ JAG (prelim and regional) ', () => {
+        TestCasesForContestType.aojJag.forEach(({ name, value }) => {
+          runTests(`${name}`, [value], ({ contestId, expected }: TestCaseForContestType) => {
+            expect(classifyContest(contestId)).toEqual(expected);
+          });
+        });
+      });
     });
   });
 
@@ -329,6 +337,14 @@ describe('Contest', () => {
           });
         });
       });
+
+      describe('when contest_id means AOJ JAG (prelim and regional)', () => {
+        TestCasesForContestType.aojJag.forEach(({ name, value }) => {
+          runTests(`${name}`, [value], ({ contestId, expected }: TestCaseForContestType) => {
+            expect(getContestPriority(contestId)).toEqual(contestTypePriorities.get(expected));
+          });
+        });
+      });
     });
   });
 
@@ -471,6 +487,14 @@ describe('Contest', () => {
           });
         });
       });
+
+      describe('when contest_id means AOJ JAG (prelim and regional)', () => {
+        TestCasesForContestNameLabel.aojJag.forEach(({ name, value }) => {
+          runTests(`${name}`, [value], ({ contestId, expected }: TestCaseForContestNameLabel) => {
+            expect(getContestNameLabel(contestId)).toEqual(expected);
+          });
+        });
+      });
     });
   });
 
@@ -597,6 +621,18 @@ describe('Contest', () => {
           );
         });
       });
+
+      describe('when contest_id means AOJ JAG (prelim and regional)', () => {
+        TestCasesForContestNameAndTaskIndex.aojJag.forEach(({ name, value }) => {
+          runTests(
+            `${name}`,
+            [value],
+            ({ contestId, taskTableIndex, expected }: TestCaseForContestNameAndTaskIndex) => {
+              expect(addContestNameToTaskIndex(contestId, taskTableIndex)).toEqual(expected);
+            },
+          );
+        });
+      });
     });
   });
 });