Upgrade Octokit authentication to fix deprecation warnings (#1344)

Upgrade @octokit/rest to v17

@octokit/rest v16 uses a format that will be 
deprecated starting from v17 to construct
an Octokit object, and will cause authentication
request to fail.

Let's upgrade the octokit version to v17
and use the new format so that future upgrades
can happen more smoothly.

Author: yucongkoo

package.json

@@ -42,8 +42,9 @@
     "@angular/router": "^13.4.0",
     "@apollo/client": "3.3.0",
     "@github/markdown-toolbar-element": "^2.1.1",
-    "@octokit/rest": "^16.37.0",
+    "@octokit/auth-oauth-user": "^2.1.2",
     "@octokit/core": "^4.2.1",
+    "@octokit/rest": "^17.11.0",
     "apollo-angular": "^3.0.1",
     "arcsecond": "^4.1.0",
     "core-js": "^3.16.4",

src/app/auth/auth.component.ts

@@ -83,7 +83,7 @@ export class AuthComponent implements OnInit, OnDestroy {
           throw new Error(data.error);
         }
         this.authService.storeOAuthAccessToken(data.token);
-        this.logger.info('AuthComponent: Sucessfully obtained access token');
+        this.logger.info('AuthComponent: Successfully octained access token');
       })
       .catch((err) => {
         this.logger.info(`AuthComponent: Error in data fetched from access token URL: ${err}`);

src/app/core/services/github.service.ts

@@ -33,6 +33,7 @@ import { SessionData } from '../models/session.model';
 import { ERRORCODE_NOT_FOUND, ErrorHandlingService } from './error-handling.service';
 import { LoggingService } from './logging.service';
 import { GithubRestIssue } from '../models/github/github-rest-issue';
+import { createOAuthUserAuth } from '@octokit/auth-oauth-user';
 
 const { Octokit } = require('@octokit/rest');
 const CATCHER_ORG = 'CATcher-org';
@@ -72,8 +73,9 @@ export class GithubService {
 
   storeOAuthAccessToken(accessToken: string) {
     octokit = new Octokit({
-      auth() {
-        return `Token ${accessToken}`;
+      authStrategy: createOAuthUserAuth,
+      auth: {
+        token: accessToken
       },
       log: {
         debug: (message, ...otherInfo) => this.logger.debug('GithubService: ' + message, ...otherInfo),
@@ -439,7 +441,7 @@ export class GithubService {
 
   fetchDataFile(): Observable<{}> {
     return from(
-      octokit.repos.getContents({ owner: MOD_ORG, repo: DATA_REPO, path: 'data.csv', headers: GithubService.IF_NONE_MATCH_EMPTY })
+      octokit.repos.getContent({ owner: MOD_ORG, repo: DATA_REPO, path: 'data.csv', headers: GithubService.IF_NONE_MATCH_EMPTY })
     ).pipe(
       map((rawData) => {
         return { data: atob(rawData['data']['content']) };
@@ -470,7 +472,7 @@ export class GithubService {
    */
   fetchSettingsFile(): Observable<SessionData> {
     return from(
-      octokit.repos.getContents({ owner: MOD_ORG, repo: DATA_REPO, path: 'settings.json', headers: GithubService.IF_NONE_MATCH_EMPTY })
+      octokit.repos.getContent({ owner: MOD_ORG, repo: DATA_REPO, path: 'settings.json', headers: GithubService.IF_NONE_MATCH_EMPTY })
     ).pipe(
       map((rawData) => JSON.parse(atob(rawData['data']['content']))),
       catchError((err) => {