setup github auth and update dependencies

Author: NewerKey

app-config.production.yaml

@@ -0,0 +1,9 @@
+app:
+  baseUrl: prodlink
+
+backend:
+  baseUrl: prodlink
+  cors:
+    origin: prodlink
+    methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
+    credentials: true

package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "engines": {
-    "node": "20 || 22"
+    "node": "18 || 20"
   },
   "scripts": {
     "dev": "yarn workspaces foreach -A --include backend --include app --parallel -v -i run start",

packages/app/src/App.tsx

@@ -34,7 +34,7 @@ import { CatalogGraphPage } from '@backstage/plugin-catalog-graph';
 import { RequirePermission } from '@backstage/plugin-permission-react';
 import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
 
-import { googleAuthApiRef } from '@backstage/core-plugin-api';
+import { googleAuthApiRef, githubAuthApiRef } from '@backstage/core-plugin-api';
 import { SignInPage, SignInProviderConfig } from '@backstage/core-components';
 
 const googleProvider: SignInProviderConfig = {
@@ -44,6 +44,12 @@ const googleProvider: SignInProviderConfig = {
   apiRef: googleAuthApiRef,
 };
 
+const githubProvider: SignInProviderConfig = {
+  id: 'github-auth-provider',
+  title: 'GitHub',
+  message: 'Sign in using GitHub',
+  apiRef: githubAuthApiRef,
+};
 
 const app = createApp({
   apis,
@@ -53,7 +59,8 @@ const app = createApp({
         {...props}
         auto
         providers={[
-          googleProvider
+          googleProvider,
+          githubProvider
         ]}
       />
     ),

packages/backend/src/index.ts

@@ -1,18 +1,64 @@
 import { createBackend } from '@backstage/backend-defaults';
-// import { customGoogleAuth } from './plugins/plugins_helper/googleCustomAuth';
 
+import { createBackendModule } from '@backstage/backend-plugin-api';
+import { stringifyEntityRef } from '@backstage/catalog-model';
+import { githubAuthenticator } from '@backstage/plugin-auth-backend-module-github-provider';
+import { authProvidersExtensionPoint, createOAuthProviderFactory } from '@backstage/plugin-auth-node';
+
+// Create a new backend instance
 const backend = createBackend();
 
 backend.add(import('@backstage/plugin-app-backend'));
-// backend.add(import('@spotify/backstage-plugin-soundcheck-backend'));
 backend.add(import('@backstage/plugin-proxy-backend'))
 backend.add(import('@backstage/plugin-scaffolder-backend'));
 backend.add(import('@backstage/plugin-techdocs-backend'));
 
 // Add the auth backend
 backend.add(import('@backstage/plugin-auth-backend'));
 backend.add(import('@backstage/plugin-auth-backend-module-google-provider'));
-// backend.add(customGoogleAuth);
+
+// Custom Github Auth Provider
+export const customGithubAuth = createBackendModule({
+    pluginId: 'auth',
+    moduleId: 'githubProvider',
+    register(reg) {
+        reg.registerInit({
+            deps: { providers: authProvidersExtensionPoint },
+            async init({ providers }) {
+                providers.registerProvider({
+                    providerId: 'github',
+                    factory: createOAuthProviderFactory({
+                        authenticator: githubAuthenticator,
+                        async signInResolver(info, ctx) {
+                           const { profile: { email } } = info;
+
+                           if (!email) {
+                            throw new Error('User profile has no email');
+                           }
+
+                           const [userId] = email.split('@');
+
+                           const userEntity = stringifyEntityRef({
+                            kind: 'User',
+                            namespace: 'default',
+                            name: userId,
+                           })
+
+                           return ctx.issueToken({
+                            claims: {
+                                sub: userEntity,
+                                ent: [userEntity],
+                            }
+                           })
+                        },
+                    }),
+                });
+            },
+        });
+    },
+});
+
+backend.add(customGithubAuth);
 
 // Add the catalog backend and the catalog entities
 backend.add(import('@backstage/plugin-catalog-backend'));

yarn.lock

@@ -385,7 +385,7 @@ __metadata:
     ajv-formats: "npm:^2.1.1"
     avsc: "npm:^5.7.5"
     js-yaml: "npm:^4.1.0"
-    jsonpath-plus: "npm:^10.0.0"
+    jsonpath-plus: "npm:^10.0.7"
     node-fetch: "npm:2.6.7"
   checksum: 10c0/340906e46bb87486d738917035433dc19eafcd4f9dcef7168f8d1379b559d67aa1489e51fd3a030ec4bab74c7708b8a7e3fd01af83ab51a6dbbf9bf32f8d6e2f
   languageName: node
@@ -9097,7 +9097,7 @@ __metadata:
     byline: "npm:^5.0.0"
     isomorphic-ws: "npm:^5.0.0"
     js-yaml: "npm:^4.1.0"
-    jsonpath-plus: "npm:^7.2.0"
+    jsonpath-plus: "npm:^10.0.7"
     openid-client: "npm:^5.3.0"
     request: "npm:^2.88.0"
     rfc4648: "npm:^1.3.0"
@@ -9125,7 +9125,7 @@ __metadata:
     form-data: "npm:^4.0.0"
     isomorphic-ws: "npm:^5.0.0"
     js-yaml: "npm:^4.1.0"
-    jsonpath-plus: "npm:^10.0.0"
+    jsonpath-plus: "npm:^10.0.7"
     node-fetch: "npm:^2.6.9"
     openid-client: "npm:^5.6.5"
     rfc4648: "npm:^1.3.0"
@@ -13567,7 +13567,7 @@ __metadata:
     ajv-errors: "npm:~3.0.0"
     ajv-formats: "npm:~2.1.0"
     es-aggregate-error: "npm:^1.0.7"
-    jsonpath-plus: "npm:7.1.0"
+    jsonpath-plus: "npm:10.0.7"
     lodash: "npm:~4.17.21"
     lodash.topath: "npm:^4.5.2"
     minimatch: "npm:3.1.2"
@@ -18867,7 +18867,7 @@ __metadata:
   version: 1.0.2
   resolution: "codeowners-utils@npm:1.0.2"
   dependencies:
-    cross-spawn: "npm:^7.0.2"
+    cross-spawn: "npm:^7.0.3"
     find-up: "npm:^4.1.0"
     ignore: "npm:^5.1.4"
     locate-path: "npm:^5.0.0"
@@ -19754,7 +19754,7 @@ __metadata:
   version: 7.0.3
   resolution: "cross-env@npm:7.0.3"
   dependencies:
-    cross-spawn: "npm:^7.0.1"
+    cross-spawn: "npm:^7.0.3"
   bin:
     cross-env: src/bin/cross-env.js
     cross-env-shell: src/bin/cross-env-shell.js
@@ -19798,7 +19798,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.1, cross-spawn@npm:^7.0.2, cross-spawn@npm:^7.0.3":
+"cross-spawn@npm:^7.0.3":
   version: 7.0.3
   resolution: "cross-spawn@npm:7.0.3"
   dependencies:
@@ -22044,7 +22044,7 @@ __metadata:
     "@ungap/structured-clone": "npm:^1.2.0"
     ajv: "npm:^6.12.4"
     chalk: "npm:^4.0.0"
-    cross-spawn: "npm:^7.0.2"
+    cross-spawn: "npm:^7.0.3"
     debug: "npm:^4.3.2"
     doctrine: "npm:^3.0.0"
     escape-string-regexp: "npm:^4.0.0"
@@ -23047,7 +23047,7 @@ __metadata:
   version: 3.1.1
   resolution: "foreground-child@npm:3.1.1"
   dependencies:
-    cross-spawn: "npm:^7.0.0"
+    cross-spawn: "npm:^7.0.3"
     signal-exit: "npm:^4.0.1"
   checksum: 10c0/9700a0285628abaeb37007c9a4d92bd49f67210f09067638774338e146c8e9c825c5c877f072b2f75f41dc6a2d0be8664f79ffc03f6576649f54a84fb9b47de0
   languageName: node
@@ -26984,7 +26984,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"jsonpath-plus@npm:10.2.0, jsonpath-plus@npm:^10.0.0, jsonpath-plus@npm:^10.2.0, jsonpath-plus@npm:^6.0.1 || ^10.1.0":
+"jsonpath-plus@npm:10.0.7":
+  version: 10.0.7
+  resolution: "jsonpath-plus@npm:7.1.0"
+  checksum: 10c0/3a74b39f434c6496191eaa2820331407d89868b59cfbb9458c0f665e6877a67125b506d68c887746420660e7a3c4f279367182bec38093f3a0129f3757c85c48
+  languageName: node
+  linkType: hard
+
+"jsonpath-plus@npm:10.2.0, jsonpath-plus@npm:^10.0.7 || ^10.1.0, jsonpath-plus@npm:^10.2.0":
   version: 10.2.0
   resolution: "jsonpath-plus@npm:10.2.0"
   dependencies:
@@ -26998,22 +27005,8 @@ __metadata:
   languageName: node
   linkType: hard
 
-"jsonpath-plus@npm:7.1.0":
-  version: 7.1.0
-  resolution: "jsonpath-plus@npm:7.1.0"
-  checksum: 10c0/3a74b39f434c6496191eaa2820331407d89868b59cfbb9458c0f665e6877a67125b506d68c887746420660e7a3c4f279367182bec38093f3a0129f3757c85c48
-  languageName: node
-  linkType: hard
-
-"jsonpath-plus@npm:^6.0.1":
-  version: 6.0.1
-  resolution: "jsonpath-plus@npm:6.0.1"
-  checksum: 10c0/ecbe5caad723a42e1cc4a28058ca837eba00d36075766a7f3cf828491648e3b64d9fa0d5a64dd868e7c3180b1f9fcec565c32a1c05b34bef9f88c3c0c7acd1a2
-  languageName: node
-  linkType: hard
-
-"jsonpath-plus@npm:^7.2.0":
-  version: 7.2.0
+"jsonpath-plus@npm:^10.0.7":
+  version: 10.0.7
   resolution: "jsonpath-plus@npm:7.2.0"
   checksum: 10c0/b4fbb8387b80721a47e8098f390dbaa5c74ff4e778832d9f662bcf4ab6038ded26944b8dd433f0474b51fb3e0d7e960990c03af89f4f922a6dc0905102ed86b2
   languageName: node
@@ -29925,7 +29918,7 @@ __metadata:
     "@jsep-plugin/ternary": "npm:^1.0.2"
     astring: "npm:^1.8.1"
     jsep: "npm:^1.2.0"
-    jsonpath-plus: "npm:^6.0.1"
+    jsonpath-plus: "npm:^10.0.7"
     lodash.topath: "npm:^4.5.2"
   dependenciesMeta:
     jsonpath-plus:
@@ -29944,7 +29937,7 @@ __metadata:
     "@jsep-plugin/ternary": "npm:^1.0.2"
     astring: "npm:^1.8.1"
     jsep: "npm:^1.2.0"
-    jsonpath-plus: "npm:^6.0.1 || ^10.1.0"
+    jsonpath-plus: "npm:^10.0.7 || ^10.1.0"
     lodash.topath: "npm:^4.5.2"
   dependenciesMeta:
     jsonpath-plus: