feat: Auto update algolia index

.github/workflows/update-algolia.yaml

@@ -0,0 +1,64 @@
+name: Script - upserts course information to Algolia
+on:
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: Application environment to execute in.
+        required: true
+      term:
+        description: Academic term to execute the script with. ie 202009, 202001
+        required: true
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./functions
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Cache npm dependencies
+        uses: actions/cache@v2
+        with:
+          key: npm-${{ hashFiles('package-lock.json') }}
+          path: ~/.npm
+          restore-keys: |
+            npm-
+      - name: Install dependencies
+        run: npm ci --ignore-scripts --no-audit --no-progress
+      - name: Lint
+        run: npm run lint
+  update-algolia:
+    name: Update Algolia index
+    needs: [lint]
+    runs-on: ubuntu-latest
+    environment: ${{ github.event.inputs.environment }}
+    defaults:
+      run:
+        working-directory: ./functions
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Cache npm dependencies
+        uses: actions/cache@v2
+        with:
+          key: npm-${{ hashFiles('package-lock.json') }}
+          path: ~/.npm
+          restore-keys: |
+            npm-
+      - name: Install dependencies
+        run: npm ci --ignore-scripts --no-audit --no-progress
+      - name: Set up Cloud SDK
+        uses: google-github-actions/setup-gcloud@v0
+        with:
+          service_account_key: ${{ secrets.FIREBASE_SERVICE_ACCOUNT }}
+          export_default_credentials: true
+      - name: Run Update Algolia Script
+        run: npx ts-node ./scripts/update-algolia-index.ts ${{ github.event.inputs.term }}

functions/package.json

@@ -43,6 +43,7 @@
     "@types/ioredis": "^4.27.1",
     "@types/jest": "^26.0.24",
     "@types/node": "^14.18.3",
+    "@types/node-fetch": "^2.6.4",
     "@types/object-hash": "^2.1.1",
     "@types/supertest": "^2.0.11",
     "@types/swagger-ui-express": "^4.1.3",

functions/scripts/update-algolia-index.ts

@@ -0,0 +1,78 @@
+import fetch from 'node-fetch';
+import algoliasearch from 'algoliasearch';
+
+if (process.argv.length != 3) throw Error('Term argument not found.');
+
+const term: string = process.argv[2];
+
+if (!/20\d{2}0[1,5,9]/.test(term.trim()))
+  throw Error('Invalid term argument format');
+
+const BASE = 'https://courseup.vikelabs.ca/api';
+
+const client = algoliasearch('ALGOLIA_APP_ID', 'ALGOLIA_ADMIN_KEY');
+const index = client.initIndex('ALGOLIA_INDEX_NAME');
+
+interface Course {
+  subject: string;
+  code: string;
+  pid: string;
+  description: string;
+  title: string;
+}
+
+const getCourses = async (term: string): Promise<Course[]> => {
+  const res = await fetch(`${BASE}/courses/${term}`);
+  const data: Course[] = await res.json();
+  return data;
+};
+
+const getCourse = async (term: string, course: Course): Promise<Course> => {
+  const res = await fetch(
+    `${BASE}/courses/${term}/${course.subject}/${course.code}`
+  );
+  const data: Course = await res.json();
+  return data;
+};
+
+const main = async () => {
+  const courses: Course[] = await getCourses(term);
+
+  console.log(`Found ${courses.length} courses for ${term}`);
+
+  const values = courses.values();
+
+  const vals: Course[] = [];
+
+  const workers = Array(50)
+    .fill(values)
+    .map(async (iterator) => {
+      for (const course of iterator) {
+        const courseDetails = await getCourse(term, course);
+        console.log(course.subject, course.code);
+        vals.push({ ...courseDetails });
+      }
+    });
+
+  await Promise.allSettled(workers);
+
+  const coursesForIndex = vals.map((course) => ({
+    objectID: `${course.subject}${course.code}`,
+    subject: course.subject,
+    code: course.code,
+    pid: course.pid,
+    description: course.description,
+    title: course.title,
+  }));
+
+  index
+    .saveObjects(coursesForIndex)
+    .then(({ objectIDs }) => {
+      console.log(objectIDs);
+    })
+    .catch((err) => {
+      console.log(err);
+    });
+};
+
+main();

functions/tsconfig.dev.json

@@ -8,7 +8,7 @@
     "outDir": "lib",
     "sourceMap": true,
     "strict": true,
-    "target": "ES2019"
+    "target": "es2020"
   },
   "include": ["scripts", "src", ".eslintrc.js"]
 }

functions/tsconfig.json

@@ -8,7 +8,7 @@
     "outDir": "lib",
     "sourceMap": true,
     "strict": true,
-    "target": "ES2019"
+    "target": "es2020"
   },
   "compileOnSave": true,
   "include": ["src"],