chore: migrate from minimal-cors-server to simple-proxy-server to simplify request making

Author: matthiasharzer

.github/workflows/firebase-hosting-merge.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      VITE_PUBLIC_KIT_API_KEY: '${{ secrets.VITE_PUBLIC_KIT_API_KEY }}'
+      VITE_CORS_PROXY_SERVER_URL: '${{ vars.VITE_CORS_PROXY_SERVER_URL }}'
 
     steps:
       - uses: actions/checkout@v2

.github/workflows/firebase-hosting-pull-request.yml

@@ -7,6 +7,10 @@ jobs:
   build_and_preview:
     if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
     runs-on: ubuntu-latest
+
+    env:
+      VITE_CORS_PROXY_SERVER_URL: '${{ vars.VITE_CORS_PROXY_SERVER_URL }}'
+
     steps:
       - uses: actions/checkout@v2
       - run: npm ci && npm run build

README.md

@@ -6,6 +6,6 @@
 
 A web app to display lectures of the [KIT](https://www.kit.edu/) for a given time and day.
 
-Retrieves events from the [KIT extended search](https://campus.kit.edu/sp/campus/all/extendedSearch.asp) endpoint. Uses my [`minimal-cors-server`](https://github.com/MatthiasHarzer/minimal-cors-server) to avoid CORS problems with the KIT server.
+Retrieves events from the [KIT extended search](https://campus.kit.edu/sp/campus/all/extendedSearch.asp) endpoint. Uses my [`simple-proxy-server`](https://github.com/MatthiasHarzer/simple-proxy-server) to avoid CORS problems with the KIT server.
 
 Built using [Svelte](https://svelte.dev/).

src/lib/consts.ts

@@ -1,6 +1,6 @@
 const KIT_BASE_URL = "https://campus.kit.edu";
 
-export const CORS_PROXY_SERVER = "https://cors.taptwice.dev/";
+export const CORS_PROXY_SERVER = import.meta.env.VITE_CORS_PROXY_SERVER_URL;
 export const EXTENDED_SEARCH_BASE_URL = `${KIT_BASE_URL}/sp/campus/all/extendedSearch.asp`;
 export const TERMS_URL = `${KIT_BASE_URL}/sp/server/services/kit/terms.asp`;
 export const ROOMS_QUICK_SEARCH_URL = `${KIT_BASE_URL}/sp/server/services/kit/quicksearch.asp?type=room&find=`;

src/lib/event_handler.ts

@@ -1,6 +1,5 @@
-import { format_date } from "./util/util";
+import { format_date, json_to_encoded_form_data } from "./util/util";
 import type {
-    CorsProxyBody,
     KITEvent,
     KITExtendedSearchFormData,
     KITRoomEventsConfig,
@@ -33,7 +32,6 @@ let current_room_fetch_id = 0;
 
 const i_promise_terms = new Promise<Term[]>((resolve, reject) => {
     make_request(TERMS_URL, {
-        cache: true,
         max_age: 60 * 60 * 24, // 1 day
     })
         .then((response) => response.json())
@@ -81,28 +79,25 @@ const get_form_data_template = async (
  * @param params The parameters for the request.
  * @returns The response.
  *
- * @see https://github.com/MatthiasHarzer/minimal-cors-server
+ * @see https://github.com/MatthiasHarzer/simple-proxy-server
  */
 function make_request(
     url: string,
     params: RequestParams = {},
 ): Promise<Response> {
-    const { form_data, headers, cache, max_age } = params;
-    const body: CorsProxyBody = {
-        method: "POST",
-        url: url,
-        data: form_data,
-        headers: headers,
-        cache: cache ?? true,
-        max_age: max_age ?? 0,
-    };
-
-    return fetch(CORS_PROXY_SERVER, {
+    const { form_data, headers, max_age } = params;
+
+    const proxy_url = `${CORS_PROXY_SERVER}/cache/max-age:${
+        max_age ?? 0
+    }/${url}`;
+
+    return fetch(proxy_url, {
         method: "POST",
         headers: {
-            "Content-Type": "application/json",
+            ...headers,
+            "Content-Type": "application/x-www-form-urlencoded",
         },
-        body: JSON.stringify(body),
+        body: json_to_encoded_form_data(form_data),
     });
 }
 
@@ -120,7 +115,6 @@ export const get_events = async (
 
     const response = await make_request(EXTENDED_SEARCH_BASE_URL, {
         form_data: json_form_data,
-        cache: true,
         max_age: 60 * 60 * 24 * 3, // 3 days
     });
     const text = await response.text();
@@ -151,7 +145,6 @@ export const get_room_events = async (
 
     const response = await make_request(EXTENDED_SEARCH_BASE_URL, {
         form_data: json_form_data,
-        cache: true,
         max_age: 60 * 60 * 24 * 3, // 3 days
     });
     const text = await response.text();
@@ -174,7 +167,6 @@ export const find_rooms = async (
     let fetch_id = ++current_room_fetch_id;
     const query_url = `${ROOMS_QUICK_SEARCH_URL}${search_term}`;
     const response = await make_request(query_url, {
-        cache: true,
         max_age: 60 * 60 * 24 * 7 * 4, // 4 weeks
     });
 

src/lib/types.ts

@@ -18,20 +18,6 @@ export interface KITExtendedSearchFormData {
     room: string;
 }
 
-/**
- * The body for the cors proxy server request.
- * @see https://github.com/MatthiasHarzer/minimal-cors-server
- */
-export interface CorsProxyBody {
-    method: "POST" | "GET" | "PUT" | "DELETE";
-    url: string;
-    headers?: object;
-    body?: string;
-    data?: object;
-    cache?: boolean;
-    max_age?: number;
-}
-
 // noinspection SpellCheckingInspection
 /**
  * The KIT event type.
@@ -266,6 +252,5 @@ export interface RawRoom {
 export interface RequestParams {
     form_data?: KITExtendedSearchFormData;
     headers?: object;
-    cache?: boolean;
     max_age?: number;
 }

src/lib/util/util.ts

@@ -160,3 +160,17 @@ export const time_to_total_seconds = (time: string): number => {
     const [hours, minutes] = time.split(":");
     return parseInt(hours) * 60 * 60 + parseInt(minutes) * 60;
 };
+
+export const json_to_encoded_form_data = (
+    json: Record<string, any>,
+): string => {
+    const encodedPairs: string[] = [];
+    for (const key in json) {
+        if (json.hasOwnProperty(key)) {
+            const encodedKey = encodeURIComponent(key);
+            const encodedValue = encodeURIComponent(json[key]);
+            encodedPairs.push(`${encodedKey}=${encodedValue}`);
+        }
+    }
+    return encodedPairs.join("&");
+};

src/vite-env.d.ts

@@ -1,3 +1,11 @@
 /// <reference types="svelte" />
 /// <reference types="vite/client" />
 declare const APP_VERSION: string;
+
+interface ImportMetaEnv {
+    VITE_CORS_PROXY_SERVER_URL: string;
+}
+
+interface ImportMeta {
+    readonly env: ImportMetaEnv;
+}