-[](https://github.com/wangrunlin/github-achievements-api/blob/main/LICENSE)
-[](https://github.com/wangrunlin/github-achievements-api/blob/main/package.json)
-[](https://github.com/wangrunlin/github-achievements-api/commits)
-[](https://github.com/wangrunlin/github-achievements-api/actions)
-[](https://nodejs.org)
-[](https://www.typescriptlang.org/)
-[](https://github.com/prettier/prettier)
-[](https://makeapullrequest.com)
-[](https://github.com/wangrunlin/github-achievements-api/stargazers)
-[](https://github.com/wangrunlin/github-achievements-api/network)
-[](https://github.com/wangrunlin/github-achievements-api/issues)
-[](https://github.com/wangrunlin/github-achievements-api)
-[](https://ko-fi.com/wangrunlin)
-
-[English](README.md) | 简体中文
+[][1]
+[][2]
+[][3]
+[][4]
+[][5]
+[][6]
+[][7]
+[][8]
+[][9]
+[][10]
+[][11]
+[][12]
+[][13]
+
+[English][14] | 简体中文
一个简单的 API 服务，用于获取 GitHub 用户的成就信息。基于 Cloudflare Workers 构建。
## 在线使用
-- [https://github-achievements-api.wangrunlin.workers.dev](https://github-achievements-api.wangrunlin.workers.dev)
+- [https://github-achievements-api.wangrunlin.workers.dev][15]
## 部署到 Cloudflare Workers
-[](https://deploy.workers.cloudflare.com/?url=https://github.com/wangrunlin/github-achievements-api)
+[][16]
## 功能特点
@@ -56,25 +56,28 @@ GET https://[\s\S]*?<\/div>/);
-
- if (!achievementsSection) {
- return createJsonResponse({ total: 0, achievements: [] });
- }
-
- const achievements: { type: string; tier?: number; image?: string }[] = [];
- const pattern = new RegExp(
- `]*href="/${username}\\?achievement=([^&]+)[^>]*>\\s*]*>.*?(?:class="Label[^>]*achievement-tier-label[^>]*>x(\\d+))?(?:)?`,
- 'gs'
- );
-
- let match;
- while ((match = pattern.exec(achievementsSection[0])) !== null) {
- const [, type, image, tier] = match;
- achievements.push({
- type: type.trim(),
- tier: tier ? parseInt(tier) : 1,
- image
- });
- }
-
- const rawTotal = achievements.length;
- const weightedTotal = achievements.reduce((sum, { tier = 1 }) => sum + tier, 0);
-
- const result: AchievementsResponse = {
- total: {
- raw: rawTotal,
- weighted: weightedTotal,
- },
- achievements: achievements.sort((a, b) => (b.tier || 1) - (a.tier || 1)),
- };
-
- response = createJsonResponse(result, 200, {
- 'Cache-Control': skipCache ? 'no-store' : 'public, max-age=3600',
- });
-
- if (!skipCache) {
- ctx.waitUntil(cache.put(new Request(cacheKey), response.clone()));
- }
- }
-
- return response;
- } catch (error: unknown) {
- return createErrorResponse(`Error: ${error}`);
- }
- },
-} satisfies ExportedHandler;
+const loadAchievements = async (username: string) => {
+ const githubResponse = await globalThis.fetch(`https://github.com/${username}?tab=achievements`);
+
+ if (!githubResponse.ok) throw new HTTPError(githubResponse.statusText, githubResponse);
+
+ const { document } = parseHTML(await githubResponse.text());
+
+ const achievements = [
+ ...document.querySelectorAll('.js-achievement-card-details'),
+ ].map((card) => {
+ const type = card.dataset.achievementSlug,
+ tier = card.querySelector('.achievement-tier-label')?.textContent?.trim().slice(1) || '1',
+ image = card.querySelector('.achievement-badge-card')!.src;
+
+ return { type, tier: +tier, image } as Achievement;
+ });
+
+ return {
+ total: {
+ raw: achievements.length,
+ weighted: achievements.reduce((sum, { tier }) => sum + tier, 0),
+ },
+ achievements: achievements.sort((a, b) => b.tier - a.tier),
+ } as AchievementsResponse;
+};
+
+const fetch: ExportedHandler['fetch'] = async (request, env, ctx) => {
+ const { origin, pathname, searchParams } = new URL(request.url);
+ const [, username] = pathname.split('/');
+
+ if (!username) return createJsonResponse(usageOf(origin));
+
+ try {
+ const cacheKey = `${origin}/cache/${username}`;
+ const cache = (caches as unknown as CacheStorage).default;
+ const skipCache = searchParams.has('nocache');
+ const cacheResponse = !skipCache && (await cache.match(cacheKey));
+
+ if (cacheResponse) return cacheResponse as unknown as Response;
+
+ const result = await loadAchievements(username);
+
+ const response = createJsonResponse(result, 200, {
+ 'Cache-Control': skipCache ? 'no-store' : 'public, max-age=3600',
+ });
+ if (!skipCache)
+ ctx.waitUntil(
+ cache.put(
+ new Request(cacheKey) as unknown as CF_Req,
+ response.clone() as unknown as CF_Res,
+ ),
+ );
+ return response;
+ } catch (error: unknown) {
+ return error instanceof HTTPError
+ ? createErrorResponse(
+ `Failed to fetch GitHub achievements: ${error.response.statusText}`,
+ error.response.status,
+ )
+ : createErrorResponse(`Error: ${error}`);
+ }
+};
+
+export default { fetch } satisfies ExportedHandler;
diff --git a/src/types.ts b/src/types.ts
index 6ebf718..0343109 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -1,33 +1,21 @@
export interface UsageResponse {
description: string;
- author: {
- name: string;
- github: string;
- };
+ author: Record<'name' | 'github', string>;
repository: string;
- usage: {
- endpoint: string;
- example: string;
- };
+ usage: Record<'endpoint' | 'example', string>;
response: {
- total: {
- raw: string;
- weighted: string;
- };
- achievements: {
- type: string;
- tier: string;
- }[];
+ total: Record;
+ achievements: Record[];
};
}
+export interface Achievement {
+ type: string;
+ image: string;
+ tier: number;
+}
+
export interface AchievementsResponse {
- total: {
- raw: number;
- weighted: number;
- };
- achievements: Array<{
- type: string;
- tier?: number;
- }>;
-}
\ No newline at end of file
+ total: Record<'raw' | 'weighted', number>;
+ achievements: Achievement[];
+}
diff --git a/test/index.spec.ts b/test/index.spec.ts
index c1a9c79..21514fe 100644
--- a/test/index.spec.ts
+++ b/test/index.spec.ts
@@ -4,100 +4,98 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import worker from '../src/index';
import { UsageResponse, AchievementsResponse } from '../src/types';
+import { mockGitHubResponse } from './mock';
// For now, you'll need to do something like this to get a correctly-typed
// `Request` to pass to `worker.fetch()`.
const IncomingRequest = Request;
-// Mock GitHub 响应
-const mockGitHubResponse = `
-
-`;
-
// Mock fetch 函数
const originalFetch = globalThis.fetch;
+
beforeEach(() => {
- globalThis.fetch = vi.fn().mockImplementation((url: string) => {
- if (url.includes('non-existent-user')) {
- return Promise.resolve(new Response('Not Found', { status: 404 }));
- }
- return Promise.resolve(new Response(mockGitHubResponse, { status: 200 }));
- });
+ globalThis.fetch = vi
+ .fn()
+ .mockImplementation(async (url: string) =>
+ url.includes('non-existent-user')
+ ? new Response('Not Found', { status: 404 })
+ : new Response(mockGitHubResponse, { status: 200 }),
+ );
});
afterEach(() => {
- globalThis.fetch = originalFetch;
+ globalThis.fetch = originalFetch;
});
describe('GitHub Achievements API', () => {
- // 测试 API 使用说明
- it('responds with usage information when no username provided', async () => {
- const request = new IncomingRequest('http://example.com/');
- const ctx = createExecutionContext();
- const response = await worker.fetch(request, env, ctx);
- await waitOnExecutionContext(ctx);
-
- const data = (await response.json()) as UsageResponse;
- expect(response.headers.get('Content-Type')).toBe('application/json;charset=UTF-8');
- expect(data).toHaveProperty('description');
- expect(data).toHaveProperty('usage');
- expect(data).toHaveProperty('response');
- });
-
- // 测试获取用户成就
- it('fetches achievements for a valid username', async () => {
- const username = 'wangrunlin';
- const request = new IncomingRequest(`http://example.com/${username}`);
- const ctx = createExecutionContext();
- const response = await worker.fetch(request, env, ctx);
- await waitOnExecutionContext(ctx);
-
- const data = (await response.json()) as AchievementsResponse;
- expect(response.headers.get('Content-Type')).toBe('application/json;charset=UTF-8');
- expect(data).toHaveProperty('total');
- expect(data.total.raw).toBe(5); // 5个成就
- expect(data.total.weighted).toBe(8); // 1 + 3 + 1 + 1 + 2 = 8
- expect(data.achievements).toHaveLength(5);
-
- // 验证每个成就的存在性和等级
- const achievementsMap = new Map(data.achievements.map((a) => [a.type, a.tier]));
-
- expect(achievementsMap.get('starstruck')).toBe(1);
- expect(achievementsMap.get('pair-extraordinaire')).toBe(3);
- expect(achievementsMap.get('yolo')).toBe(1);
- expect(achievementsMap.get('quickdraw')).toBe(1);
- expect(achievementsMap.get('pull-shark')).toBe(2);
- });
-
- // 测试无效用户名
- it('handles non-existent username gracefully', async () => {
- const request = new IncomingRequest('http://example.com/non-existent-user-123456');
- const ctx = createExecutionContext();
- const response = await worker.fetch(request, env, ctx);
- await waitOnExecutionContext(ctx);
-
- expect(response.status).toBe(404);
- });
-
- // 测试缓存功能
- it('uses cache for repeated requests', async () => {
- const username = 'wangrunlin';
- const request = new IncomingRequest(`http://example.com/${username}`);
- const ctx = createExecutionContext();
-
- // 第一次请求
- const response1 = await worker.fetch(request, env, ctx);
- await waitOnExecutionContext(ctx);
- const data1 = (await response1.json()) as AchievementsResponse;
-
- // 第二次请求
- const response2 = await worker.fetch(request, env, ctx);
- await waitOnExecutionContext(ctx);
- const data2 = (await response2.json()) as AchievementsResponse;
-
- // 验证两次请求返回相同的数据
- expect(JSON.stringify(data1)).toBe(JSON.stringify(data2));
- // 验证 fetch 只被调用一次（第二次使用了缓存）
- expect(fetch).toHaveBeenCalledTimes(1);
- });
+ // 测试 API 使用说明
+ it('responds with usage information when no username provided', async () => {
+ const request = new IncomingRequest('http://example.com/');
+ const ctx = createExecutionContext();
+ const response = await worker.fetch(request, env, ctx);
+ await waitOnExecutionContext(ctx);
+
+ const data = (await response.json()) as UsageResponse;
+ expect(response.headers.get('Content-Type')).toBe('application/json;charset=UTF-8');
+ expect(data).toHaveProperty('description');
+ expect(data).toHaveProperty('usage');
+ expect(data).toHaveProperty('response');
+ });
+
+ // 测试获取用户成就
+ it('fetches achievements for a valid username', async () => {
+ const username = 'wangrunlin';
+ const request = new IncomingRequest(`http://example.com/${username}`);
+ const ctx = createExecutionContext();
+ const response = await worker.fetch(request, env, ctx);
+ await waitOnExecutionContext(ctx);
+
+ const data = (await response.json()) as AchievementsResponse;
+ expect(response.headers.get('Content-Type')).toBe('application/json;charset=UTF-8');
+ expect(data).toHaveProperty('total');
+ expect(data.total.raw).toBe(5); // 5个成就
+ expect(data.total.weighted).toBe(8); // 1 + 3 + 1 + 1 + 2 = 8
+ expect(data.achievements).toHaveLength(5);
+
+ // 验证每个成就的存在性和等级
+ const achievementsMap = new Map(data.achievements.map((a) => [a.type, a.tier]));
+
+ expect(achievementsMap.get('starstruck')).toBe(1);
+ expect(achievementsMap.get('pair-extraordinaire')).toBe(3);
+ expect(achievementsMap.get('yolo')).toBe(1);
+ expect(achievementsMap.get('quickdraw')).toBe(1);
+ expect(achievementsMap.get('pull-shark')).toBe(2);
+ });
+
+ // 测试无效用户名
+ it('handles non-existent username gracefully', async () => {
+ const request = new IncomingRequest('http://example.com/non-existent-user-123456');
+ const ctx = createExecutionContext();
+ const response = await worker.fetch(request, env, ctx);
+ await waitOnExecutionContext(ctx);
+
+ expect(response.status).toBe(404);
+ });
+
+ // 测试缓存功能
+ it('uses cache for repeated requests', async () => {
+ const username = 'wangrunlin';
+ const request = new IncomingRequest(`http://example.com/${username}`);
+ const ctx = createExecutionContext();
+
+ // 第一次请求
+ const response1 = await worker.fetch(request, env, ctx);
+ await waitOnExecutionContext(ctx);
+ const data1 = (await response1.json()) as AchievementsResponse;
+
+ // 第二次请求
+ const response2 = await worker.fetch(request, env, ctx);
+ await waitOnExecutionContext(ctx);
+ const data2 = (await response2.json()) as AchievementsResponse;
+
+ // 验证两次请求返回相同的数据
+ expect(JSON.stringify(data1)).toBe(JSON.stringify(data2));
+ // 验证 fetch 只被调用一次（第二次使用了缓存）
+ expect(fetch).toHaveBeenCalledTimes(1);
+ });
});
diff --git a/test/mock.ts b/test/mock.ts
new file mode 100644
index 0000000..618bf00
--- /dev/null
+++ b/test/mock.ts
@@ -0,0 +1,405 @@
+// Mock GitHub 响应
+export const mockGitHubResponse = `
+
+`;
diff --git a/tsconfig.json b/tsconfig.json
index 33bdb79..ec6e874 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -5,7 +5,7 @@
/* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"target": "es2021",
/* Specify a set of bundled library declaration files that describe the target runtime environment. */
- "lib": ["es2021"],
+ "lib": ["es2021", "DOM", "DOM.Iterable"],
/* Specify what JSX code is generated. */
"jsx": "react-jsx",
@@ -14,9 +14,7 @@
/* Specify how TypeScript looks up a file from a given module specifier. */
"moduleResolution": "Bundler",
/* Specify type package names to be included without being referenced in a source file. */
- "types": [
- "@cloudflare/workers-types/2023-07-01"
- ],
+ "types": ["@cloudflare/workers-types/2023-07-01"],
/* Enable importing .json files */
"resolveJsonModule": true,
Earned achievements
+ +
+
+
+
+
+
+
+
+
+
+ 
+
+
+ Starstruck
+
+
+ Starstruck
+
+
+
+
+
+
+ Loading
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ Pair Extraordinaire
+ x3
+
+
+ Pair Extraordinaire
+ x3 +
+
+
+
+
+
+ Loading
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ YOLO
+
+
+ YOLO
+
+
+
+
+
+
+ Loading
+
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ Quickdraw
+
+
+ Quickdraw
+
+
+
+
+
+
+ Loading
+
+
+
+
+
+
+
+
+
+
+
+ 
+
+
+ Pull Shark
+ x2
+
+
+ Pull Shark
+ x2 +
+
+
+
+
+
+ Loading
+
+
+