Add tests for github

Author: mackenly

src/index.test.ts

@@ -4,7 +4,6 @@ import {
 } from 'cloudflare:test';
 import { describe, it, expect } from 'vitest';
 import { Env } from '../worker-configuration';
-// Could import any other source file/function here
 import worker from '../src';
 
 // For now, you'll need to do something like this to get a correctly-typed

src/legacy/handler.ts

@@ -5,17 +5,16 @@ import { TauriUpdateResponse } from '../types';
 import { sanitizeVersion, semverGt, semverValid } from '../utils/versioning';
 
 import { Env } from '../../worker-configuration';
-import { Request, ExecutionContext } from '@cloudflare/workers-types';
+import { Request } from '@cloudflare/workers-types';
 
 export async function handleLegacyRequest(
     request: Request,
-    env: Env,
-    ctx: ExecutionContext
+    env: Env
 ): Promise<Response> {
     const path = new URL(request.url).pathname;
     const [platform, version] = path.slice(1).split('/');
 
-    const releases = await getReleases(request, env, ctx);
+    const releases = await getReleases(request, env);
 
     const release = (await releases.clone().json()) as {
         tag_name: string;

src/services/github.test.ts

@@ -0,0 +1,51 @@
+import { describe, it, expect } from 'vitest';
+import {
+    getReleases,
+    getLatestRelease,
+    findAssetSignature,
+    Asset
+} from './github';
+import { Env } from '../../worker-configuration';
+
+const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
+
+// Mock the Env object
+const env: Env = {
+    GITHUB_ACCOUNT: 'killeencode',
+    GITHUB_REPO: 'brancato'
+};
+
+describe('github', () => {
+    it('getReleases', async () => {
+        const request = new IncomingRequest('http://example.com');
+        const response = await getReleases(request, env);
+        expect(response).toBeInstanceOf(Response);
+        expect(response.status).toBe(200);
+    });
+
+    it('getLatestRelease', async () => {
+        const request = new IncomingRequest('http://example.com');
+        const release = await getLatestRelease(request, env);
+        expect(release).toEqual(
+            expect.objectContaining({
+                tag_name: expect.any(String),
+                assets: expect.any(Array),
+                body: expect.any(String),
+                published_at: expect.any(String)
+            })
+        );
+    });
+
+    it('findAssetSignature', async () => {
+        const assets: Asset[] = [
+            { name: 'test.sig', browser_download_url: 'http://example.com' },
+            { name: 'lol.sig', browser_download_url: 'http://example.com/lol' },
+            {
+                name: 'test.zip',
+                browser_download_url: 'http://example.com/test'
+            }
+        ];
+        const signature = await findAssetSignature('test', assets);
+        expect(signature).toContain('Example Domain');
+    });
+});

src/services/github.ts

@@ -1,47 +1,68 @@
 import { Env } from '../../worker-configuration';
 import { Request, Response } from '@cloudflare/workers-types';
 
-export type Asset = { name: string; browser_download_url: string };
+export type Asset = {
+    name: string;
+    browser_download_url: string;
+};
 
-export const getReleases = async (
+type Release = {
+    tag_name: string;
+    assets: Asset[];
+    body: string;
+    published_at: string;
+};
+
+/**
+ * Get the latest release from the GitHub API
+ * @param request The Worker Request object from the fetch event
+ * @param env The Worker environment object
+ * @returns Response object from the GitHub API
+ */
+export async function getReleases(
     request: Request,
     env: Env
-): Promise<Response> => {
-    const reqUrl = new URL(
-        `https://api.github.com/repos/${env.GITHUB_ACCOUNT}/${env.GITHUB_REPO}/releases/latest`
-    );
+): Promise<Response> {
+    // build the request headers conditionally
     const headers = new Headers({
         Accept: 'application/vnd.github.preview',
         'User-Agent': request.headers.get('User-Agent') as string
     });
 
-    if (env.GITHUB_API_TOKEN?.length)
+    if (env.GITHUB_API_TOKEN?.length) {
         headers.set('Authorization', `token ${env.GITHUB_API_TOKEN}`);
+    }
 
-    const response = await fetch(reqUrl.toString(), {
-        method: 'GET',
-        headers
-    });
-
-    return response;
-};
-
-type Release = {
-    tag_name: string;
-    assets: Asset[];
-    body: string;
-    published_at: string;
-};
+    // @ts-expect-error - Fetch does not have the webSocket property
+    return await fetch(
+        `https://api.github.com/repos/${env.GITHUB_ACCOUNT}/${env.GITHUB_REPO}/releases/latest`,
+        {
+            method: 'GET',
+            headers
+        }
+    );
+}
 
-export const getLatestRelease = async (
+/**
+ * Get the latest release from the GitHub API as a Release object
+ * @param request The Worker Request object from the fetch event
+ * @param env The Worker environment object
+ * @returns The latest release as a Release object
+ */
+export async function getLatestRelease(
     request: Request,
     env: Env
-): Promise<Release> => {
-    const releases = await getReleases(request, env);
-
+): Promise<Release> {
+    const releases: Response = await getReleases(request, env);
     return (await releases.json()) as Release;
-};
+}
 
+/**
+ * Find the signature file for a given asset
+ * @param fileName The name of the file to find the signature for
+ * @param assets The assets to search for the signature
+ * @returns The signature as a string or undefined if not found
+ */
 export async function findAssetSignature(
     fileName: string,
     assets: Asset[]
@@ -61,6 +82,6 @@ export async function findAssetSignature(
     if (response.status !== 200) {
         return undefined;
     }
-    const signature = await response.text();
-    return signature;
+
+    return await response.text();
 }