fix(auth): update auth to use localStorage (#543)

* feat(auth): enhance postMessage handling and improve cookie settings

* fix(auth): Auth Issue fixed

* fix(auth): Gist methods updated for new auth integration

* fix(auth): Unified auth with local storage

* feat(auth): Enhance authentication flow with GitHub access token support

* refactor(auth): Implement in-time GitHub token retrieval for API calls

* Update config/passport.ts

* remove redis

* cleanups

* More cleanups

* Update src/controllers/auth.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fixed lint issues

* Removed console logs

* Changed to use handle options

* simplify, fox import

* code style

* update typedoc

* update eslint

* chore: switch to npm

* update vscode setting

* update express, simplify cors

* debug at main url

* Send token through URL

* redirect to backend

* Minor changes

---------

Co-authored-by: Yuvvan Talreja <31566676+yuvvantalreja@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

.env.sample

@@ -4,8 +4,3 @@ GITHUB_CLIENT_SECRET=# client secret of the application
 
 # Session ID configuration
 SESSION_SECRET=# secret key for session ID generation
-
-# Redis session store configuration
-REDIS_HOST=localhost
-REDIS_PORT=6379
-REDIS_PASSWORD=

.eslintignore

@@ -13,7 +13,7 @@ jobs:
         uses: actions/setup-node@v4
 
       - name: Install Node dependencies
-        run: yarn --frozen-lockfile
+        run: npm ci
 
-      - run: yarn lint
-      - run: yarn build
+      - run: npm run lint
+      - run: npm run build

.eslintrc.json

@@ -2,8 +2,6 @@
 logs
 *.log
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 
 # Dependency directories
 node_modules/

.github/workflows/test.yml

@@ -14,7 +14,7 @@ https://github.com/vega/editor-backend.
 
 2. Install all dependencies.
     ```
-    $ yarn install
+    $ npm install
     ```
 
 3. Put configurations in a `.env` file in the root directory.
@@ -29,15 +29,15 @@ https://github.com/vega/editor-backend.
 
     # GitHub OAuth app credentials
     GITHUB_CLIENT_ID=a901f0948b144d29fbdf 
-    GITHUB_CLIENT_SECRET=dfdb84ff29fde4eaa160078d13e024530238ebe0
+    GITHUB_CLIENT_SECRET=8a2269fd225321f19f2a19e7629e3ad63d94df68
 
     # Session ID configuration
     SESSION_SECRET=secret
     ```
 
 5.  Run the back-end server.
     ```
-    $ yarn start
+    $ npm start
     ```
 
 6.  Go to the home route (which usually is `http://localhost:3000/`). Otherwise
@@ -56,5 +56,5 @@ Go to https://vega.github.io/editor-backend/.
   plugin](https://marketplace.visualstudio.com/items?itemName=stkb.rewrap) to
   assist formatting of markdown files. Press <kbd>Alt</kbd> + <kbd>Q</kbd> to
   limit lines at 80 characters.
-- The project uses ESLint to format the code. Run `yarn format` to fix
+- The project uses ESLint to format the code. Run `npm run format` to fix
   formatting where it's possible to do so automatically.

.gitignore

@@ -22,24 +22,6 @@ export const githubOauth = {
   GITHUB_CLIENT_SECRET: process.env.GITHUB_CLIENT_SECRET,
 };
 
-/**
- * Stores the configuration for redis store.
- */
-export const redisConfiguration = {
-  /**
-   * Host name for redis store.
-   */
-  REDIS_HOST: process.env.REDIS_HOST,
-  /**
-   * Host password for redis store.
-   */
-  REDIS_PASSWORD: process.env.REDIS_PASSWORD,
-  /**
-   * Port number for redis store.
-   */
-  REDIS_PORT: +process.env.REDIS_PORT,
-};
-
 /**
  * Secret used to sign the session ID cookie.
  *
@@ -60,21 +42,15 @@ export const allowedOrigins: string[] = [
   'https://vega.github.io',
   'http://localhost:8081',
   'http://localhost:8080',
+  'http://localhost:1234',
   'http://0.0.0.0:8080',
 ];
 
 /**
  * Stores the type of environment of project. It is either `development` or
  * `production`.
  *
- * _Exported as `nodeEnv` to differentiate behaviour of app on development and
+ * _Exported as `nodeEnv` to differentiate behavior of app on development and
  * production server._
  */
 export const nodeEnv: string = process.env.NODE_ENV;
-
-/**
- * Stores the expiry date of the cookie set.
- *
- * _Exported as `cookieExpiry`_.
- */
-export const cookieExpiry: number = 90 * 24 * 60 * 60; // 90 days

README.md

@@ -1,37 +1,15 @@
 import passport from 'passport';
 import passportGitHub from 'passport-github2';
 
-import { githubOauth } from './index';
-import { authUrl, hostUrl } from '../src/urls';
+import { githubOauth } from './index.js';
+import { authUrl, hostUrl } from '../src/urls.js';
 
 /**
  * OAuth strategy to authenticate with GitHub. Reference:
  * http://www.passportjs.org/packages/passport-github2/
  */
 const GitHubStrategy = passportGitHub.Strategy;
 
-/**
- * Serializes user profile returned after authentication.
- *
- * @param {object} user User profile
- * @param {function} done Method called internally by passport.js to resume
- * process
- */
-passport.serializeUser((user, done) => {
-  done(null, user);
-});
-
-/**
- * Deserializes cookie sent to know which user is logged in.
- *
- * @param {object} user The GitHub profile of the user
- * @param {function} done Method called internally by passport.js to resume
- * process
- */
-passport.deserializeUser((user, done) => {
-  done(null, user);
-});
-
 /**
  * GitHub OAuth strategy configuration.
  *
@@ -42,7 +20,17 @@ passport.use(new GitHubStrategy({
   clientID: githubOauth.GITHUB_CLIENT_ID,
   clientSecret: githubOauth.GITHUB_CLIENT_SECRET,
   callbackURL: `${hostUrl}${authUrl.callback}`,
+  scope: ['gist'],
 }, (accessToken, refreshToken, profile, done) => {
+
+  if (!profile) {
+    return done(new Error('Failed to retrieve GitHub profile'));
+  }
+
+  if (!accessToken) {
+    return done(new Error('No access token provided'));
+  }
+
   done(null, { ...profile, accessToken });
 }));
 

config/index.ts

@@ -0,0 +1,45 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    ignores: ['node_modules/**', 'docs/**'],
+  },
+  {
+    files: ['src/**/*.ts', 'config/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    rules: {
+      'arrow-parens': ['error', 'as-needed'],
+      'arrow-spacing': 'error',
+      'block-spacing': 'error',
+      'comma-dangle': ['error', 'always-multiline'],
+      'comma-spacing': ['error', { before: false, after: true }],
+      'curly': ['error', 'all'],
+      'eol-last': ['error', 'always'],
+      'keyword-spacing': ['error', { before: true, after: true }],
+      'max-len': ['error', { code: 120 }],
+      'no-console': ['error', { allow: ['warn', 'error'] }],
+      'no-dupe-class-members': 'error',
+      'no-mixed-operators': 'error',
+      'no-trailing-spaces': 'error',
+      'no-undef': 'off',
+      'object-curly-spacing': ['error', 'always'],
+      'quotes': ['error', 'single'],
+      'semi': ['error', 'always'],
+      'space-before-blocks': ['error', 'always'],
+      'space-in-parens': ['error', 'never'],
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-member-accessibility': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-use-before-define': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+    },
+  },
+);