Merge pull request #105 from jinzcdev/feature/leetcode-cn-submission-detail

New Feature: add new APIs to leetcode.cn and leecode.com & fix some errors

Author: JacobLinCool

.changeset/warm-lobsters-act.md

@@ -0,0 +1,14 @@
+---
+"leetcode-query": major
+---
+
+## Breaking Changes
+- **`submission` method**: Now uses GraphQL query to fetch submission details, resulting in significant changes to return structure:
+  - Removed `problem_id` field, replaced by `question.questionId`
+  - Removed manually calculated percentiles (`runtime_percentile` and `memory_percentile`), replaced by API-provided `runtimePercentile` and `memoryPercentile` values
+  - Removed `details` field with submission data
+  - Return structure now directly matches GraphQL response format instead of the previous custom format
+
+## New Features
+- Added `submission_detail` GraphQL API query support, fixing API errors for leetcode.com
+- Added `user_progress_questions` method to retrieve user progress with filters for leetcode.com

README.md

@@ -9,6 +9,7 @@ The API to get user profiles, submissions, and problems on LeetCode, with highly
 - [x] Get Public User Profile.
 - [x] Get User's Recent Submissions. (Public, Max: 20)
 - [x] Get User Contest Records. (thanks to [@laporchen](https://github.com/laporchen))
+- [x] Get All of User's Submissions. (Only for `leetcode.cn` endpoint)
 - [x] Get All Problem List, or with filter of difficulty and tags.
 - [x] Get Problem Detail.
 - [x] Get Daily Challenge.
@@ -35,6 +36,14 @@ import { LeetCode } from "leetcode-query";
 
 const leetcode = new LeetCode();
 const user = await leetcode.user("username");
+
+/*
+// An Example for leetcode.cn endpoint
+import { LeetCodeCN } from "leetcode-query";
+
+const leetcodeCN = new LeetCodeCN();
+const user = await leetcodeCN.user("leetcode");
+*/
 ```
 
 ### Get All Of Your Submissions
@@ -46,7 +55,7 @@ const credential = new Credential();
 await credential.init("YOUR-LEETCODE-SESSION-COOKIE");
 
 const leetcode = new LeetCode(credential);
-console.log(await leetcode.submissions(100, 0));
+console.log(await leetcode.submissions({ limit: 10, offset: 0 }));
 ```
 
 ### Use Custom Fetcher

src/_tests/cache.test.ts

@@ -66,7 +66,8 @@ describe("Cache", () => {
 
         it("should expire after 300ms", async () => {
             caches.default.set("test", "test", 300);
-            await sleep(300);
+            // wait for 305ms to ensure the cache is expired
+            await sleep(305);
             expect(caches.default.get("test")).toBeNull();
             caches.default.clear();
         });

src/_tests/leetcode-cn.test.ts

@@ -2,7 +2,7 @@ import dotenv from "dotenv";
 import { beforeAll, describe, expect, it } from "vitest";
 import { Cache } from "../cache";
 import Credential from "../credential-cn";
-import { LeetCodeCN } from "../leetcode-cn";
+import { LeetCodeCN, QuestionStatusEnum } from "../leetcode-cn";
 
 describe("LeetCodeCN", { timeout: 15_000 }, () => {
     describe("General", () => {
@@ -35,8 +35,13 @@ describe("LeetCodeCN", { timeout: 15_000 }, () => {
                     limit: 30,
                     offset: 0,
                     slug: "two-sum",
+                    lang: "cpp",
+                    status: "AC",
                 });
                 expect(Array.isArray(submissions)).toBe(true);
+                if (submissions.length > 0) {
+                    expect(submissions[0].status).toBe("AC");
+                }
             },
         );
 
@@ -45,9 +50,22 @@ describe("LeetCodeCN", { timeout: 15_000 }, () => {
             async () => {
                 const progress = await lc.user_progress_questions({
                     skip: 0,
-                    limit: 20,
+                    limit: 10,
                 });
                 expect(progress).toBeDefined();
+                expect(progress.questions.length).toBeLessThanOrEqual(10);
+
+                const progressWithQuestionStatus = await lc.user_progress_questions({
+                    skip: 0,
+                    limit: 10,
+                    questionStatus: QuestionStatusEnum.ATTEMPTED,
+                });
+                expect(progressWithQuestionStatus).toBeDefined();
+                if (progressWithQuestionStatus.questions.length > 0) {
+                    expect(progressWithQuestionStatus.questions[0].questionStatus).toBe(
+                        QuestionStatusEnum.ATTEMPTED,
+                    );
+                }
             },
         );
 
@@ -58,6 +76,18 @@ describe("LeetCodeCN", { timeout: 15_000 }, () => {
                 expect(user.isSignedIn).toBe(true);
             },
         );
+
+        it.skipIf(
+            !process.env["TEST_CN_LEETCODE_SESSION"] || !process.env["TEST_CN_SUBMISSION_ID"],
+        )("should be able to get submission detail", async () => {
+            const submissionId = process.env["TEST_CN_SUBMISSION_ID"];
+            if (submissionId) {
+                const submissionDetail = await lc.submissionDetail(submissionId);
+                expect(submissionDetail).toBeDefined();
+                expect(submissionDetail.id).toBe(submissionId);
+                expect(submissionDetail.code).toBeDefined();
+            }
+        });
     });
 
     describe("Unauthenticated", () => {

src/_tests/leetcode.test.ts

@@ -3,6 +3,7 @@ import { beforeAll, describe, expect, it } from "vitest";
 import { Cache } from "../cache";
 import { Credential } from "../credential";
 import { LeetCode } from "../leetcode";
+import { QuestionStatusEnum } from "../leetcode-cn";
 
 describe("LeetCode", { timeout: 15_000 }, () => {
     describe("General", () => {
@@ -125,5 +126,29 @@ describe("LeetCode", { timeout: 15_000 }, () => {
                 expect(submission.runtime).toBe(200);
             },
         );
+
+        it.skipIf(!process.env["TEST_LEETCODE_SESSION"])(
+            "should be able to get user progress questions",
+            async () => {
+                const progress = await lc.user_progress_questions({
+                    skip: 0,
+                    limit: 10,
+                });
+                expect(progress).toBeDefined();
+                expect(progress.questions.length).toBeLessThanOrEqual(10);
+
+                const progressWithQuestionStatus = await lc.user_progress_questions({
+                    skip: 0,
+                    limit: 10,
+                    questionStatus: QuestionStatusEnum.SOLVED,
+                });
+                expect(progressWithQuestionStatus).toBeDefined();
+                if (progressWithQuestionStatus.questions.length > 0) {
+                    expect(progressWithQuestionStatus.questions[0].questionStatus).toBe(
+                        QuestionStatusEnum.SOLVED,
+                    );
+                }
+            },
+        );
     });
 });

src/graphql/leetcode-cn/submission-detail.graphql

@@ -0,0 +1,56 @@
+query submissionDetails($submissionId: ID!) {
+    submissionDetail(submissionId: $submissionId) {
+        id
+        code
+        timestamp
+        statusDisplay
+        isMine
+        runtimeDisplay: runtime
+        memoryDisplay: memory
+        memory: rawMemory
+        lang
+        langVerboseName
+        question {
+            questionId
+            titleSlug
+            hasFrontendPreview
+        }
+        user {
+            realName
+            userAvatar
+            userSlug
+        }
+        runtimePercentile
+        memoryPercentile
+        submissionComment {
+            flagType
+        }
+        passedTestCaseCnt
+        totalTestCaseCnt
+        fullCodeOutput
+        testDescriptions
+        testInfo
+        testBodies
+        stdOutput
+        ... on GeneralSubmissionNode {
+            outputDetail {
+                codeOutput
+                expectedOutput
+                input
+                compileError
+                runtimeError
+                lastTestcase
+            }
+        }
+        ... on ContestSubmissionNode {
+            outputDetail {
+                codeOutput
+                expectedOutput
+                input
+                compileError
+                runtimeError
+                lastTestcase
+            }
+        }
+    }
+}

src/graphql/leetcode-cn/user-problem-submissions.graphql

@@ -2,7 +2,7 @@ query submissionList(
     $offset: Int!
     $limit: Int!
     $lastKey: String
-    $questionSlug: String!
+    $questionSlug: String
     $lang: String
     $status: SubmissionStatusEnum
 ) {

src/graphql/leetcode-cn/user-progress-questions.graphql

@@ -22,6 +22,14 @@ query userProgressQuestionList($filters: UserProgressQuestionListInput) {
 
 # UserProgressQuestionListInput:
 # {
-#   "skip": 50,
-#   "limit": 50
+#     "filters": {
+#         "skip": 10,
+#         "limit": 10,
+#         "questionStatus": "SOLVED", // Enums: SOLVED, ATTEMPTED
+#         "difficulty": [
+#             "EASY",
+#             "MEDIUM",
+#             "HARD"
+#         ]
+#     }
 # }

src/graphql/submission-detail.graphql

@@ -0,0 +1,51 @@
+query submissionDetails($id: Int!) {
+    submissionDetails(submissionId: $id) {
+        id
+        runtime
+        runtimeDisplay
+        runtimePercentile
+        runtimeDistribution
+        memory
+        memoryDisplay
+        memoryPercentile
+        memoryDistribution
+        code
+        timestamp
+        statusCode
+        user {
+            username
+            profile {
+                realName
+                userAvatar
+            }
+        }
+        lang {
+            name
+            verboseName
+        }
+        question {
+            questionId
+            titleSlug
+            hasFrontendPreview
+        }
+        notes
+        flagType
+        topicTags {
+            tagId
+            slug
+            name
+        }
+        runtimeError
+        compileError
+        lastTestcase
+        codeOutput
+        expectedOutput
+        totalCorrect
+        totalTestcases
+        fullCodeOutput
+        testDescriptions
+        testBodies
+        testInfo
+        stdOutput
+    }
+}