WIP: new oauth plugin for NBS to replace backend plugin

.eslintrc.js

@@ -1,3 +1,7 @@
 module.exports = {
   root: true,
+  rules: {
+    // React 17+ JSX transform doesn't require React to be in scope
+    'react/react-in-jsx-scope': 'off',
+  },
 };

.github/workflows/release.yaml

@@ -1,7 +1,11 @@
 name: Release
 
-# This workflow will draft a release for a plugin when tagged.  The tag format
-# is <name>/v<version> without the backstage-plugin- prefix, e.g. coder/v0.0.0
+# This workflow will draft a release for a plugin when tagged. The tag format
+# is <plugin-directory>/v<version> where plugin-directory is the exact directory
+# name under plugins/, e.g.:
+#   - backstage-plugin-coder/v0.0.0
+#   - auth-backend-module-coder-provider/v0.0.0
+#   - backstage-plugin-devcontainers-backend/v0.0.0
 
 on:
   push:
@@ -20,19 +24,32 @@ jobs:
       plugin: ${{ steps.split.outputs.plugin }}
       version: ${{ steps.split.outputs.version }}
     steps:
+      - uses: actions/checkout@v4
       - env:
           TAG: ${{ github.ref_name }}
         id: split
         run: |
           parts=(${TAG//\/v/ })
-          echo "plugin=${parts[0]}" >> $GITHUB_OUTPUT
-          echo "version=${parts[1]}" >> $GITHUB_OUTPUT
+          PLUGIN_NAME="${parts[0]}"
+          VERSION="${parts[1]}"
+
+          if [[ ! -d "plugins/${PLUGIN_NAME}" ]]; then
+            echo "Error: Plugin directory 'plugins/${PLUGIN_NAME}' not found"
+            echo "Tag should match the exact directory name in plugins/"
+            exit 1
+          fi
+
+          echo "plugin=${PLUGIN_NAME}" >> $GITHUB_OUTPUT
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+
+          echo "Plugin: ${PLUGIN_NAME}"
+          echo "Version: ${VERSION}"
   plugin:
     needs: split-tag
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: plugins/backstage-plugin-${{ needs.split-tag.outputs.plugin }}
+        working-directory: plugins/${{ needs.split-tag.outputs.plugin }}
     name: ${{ needs.split-tag.outputs.plugin }} v${{ needs.split-tag.outputs.version }}
     steps:
       - uses: actions/checkout@v4
@@ -51,4 +68,4 @@ jobs:
       - uses: softprops/action-gh-release@v2
         with:
           draft: true
-          files: plugins/backstage-plugin-${{ needs.split-tag.outputs.plugin }}/*.tgz
+          files: plugins/${{ needs.split-tag.outputs.plugin }}/*.tgz

.github/workflows/test.yaml

@@ -29,18 +29,22 @@ jobs:
         id: filter
         with:
           filters: |
-            coder:
+            backstage-plugin-coder:
               - ".github/workflows/test.yaml"
               - "yarn.lock"
               - "plugins/backstage-plugin-coder/**"
-            devcontainers-backend:
+            backstage-plugin-devcontainers-backend:
               - ".github/workflows/test.yaml"
               - "yarn.lock"
               - "plugins/backstage-plugin-devcontainers-backend/**"
-            devcontainers-react:
+            backstage-plugin-devcontainers-react:
               - ".github/workflows/test.yaml"
               - "yarn.lock"
               - "plugins/backstage-plugin-devcontainers-react/**"
+            auth-backend-module-coder-provider:
+              - ".github/workflows/test.yaml"
+              - "yarn.lock"
+              - "plugins/auth-backend-module-coder-provider/**"
   plugin:
     needs: changes
     if: ${{ needs.changes.outputs.plugins != '' && toJson(fromJson(needs.changes.outputs.plugins)) != '[]' }}
@@ -51,7 +55,7 @@ jobs:
     name: ${{ matrix.plugin }}
     defaults:
       run:
-        working-directory: plugins/backstage-plugin-${{ matrix.plugin }}
+        working-directory: plugins/${{ matrix.plugin }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -60,7 +64,7 @@ jobs:
           cache: yarn
       - run: yarn install --frozen-lockfile
       # The Prettier command is in the root package.json.
-      - run: yarn prettier --check plugins/backstage-plugin-${{ matrix.plugin }}
+      - run: yarn prettier --check plugins/${{ matrix.plugin }}
         id: fmt
         working-directory: .
       - run: yarn lint
@@ -73,20 +77,29 @@ jobs:
       - run: yarn test
         id: test
         if: success() || failure()
-      # Must run tsc first to generate the .d.ts files.
-      - run: yarn tsc && yarn build
+      - run: yarn tsc
+        working-directory: .
+        if: success() || failure()
+      # Build the plugin
+      - run: yarn build
         id: build
+        if: success() || failure()
       # Version it with the SHA and upload to the run as an artifact in case
       # someone needs to download it for testing.
-      - run: yarn version --new-version "0.0.0-devel+$GITHUB_SHA"
+      - name: Set development version
         id: version
-      - run: yarn pack
+        run: |
+          SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
+          node -e "const fs=require('fs'); const pkg=JSON.parse(fs.readFileSync('package.json')); pkg.version='dev-${SHORT_SHA}'; fs.writeFileSync('package.json', JSON.stringify(pkg,null,2)+'\n');"
+          echo "Set version to dev-${SHORT_SHA}"
+      - name: Pack plugin
         id: pack
+        run: yarn pack --out '%s-%v.tgz'
       - uses: actions/upload-artifact@v4
         id: upload
         with:
           name: ${{ matrix.plugin }}
-          path: plugins/backstage-plugin-${{ matrix.plugin }}/*.tgz
+          path: plugins/${{ matrix.plugin }}/*.tgz
       # Since we continued on failures above, fail now if there were errors.  We
       # allow skipped jobs to pass, but not failed or cancelled jobs.
       - name: Check required

.gitignore

@@ -7,26 +7,27 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-lerna-debug.log*
 
 # Coverage directory generated when running tests with coverage
 coverage
 
 # Dependencies
 node_modules/
 
-# Yarn 3 files
+# Yarn files
 .pnp.*
 .yarn/*
-!.yarn/patches
-!.yarn/plugins
+# This is skipped because we specify the Yarn version in the root package.json
 !.yarn/releases
+# Important that we re-include the plugins directory because we need Backstage's
+# official Yarn plugin to simplify managing dependencies for each Backstage
+# release. The package.json files are updated to include the special
+# "backstage:^" value for version numbers, which will break without the plugin
+!.yarn/plugins
+!.yarn/patches
 !.yarn/sdks
 !.yarn/versions
 
-# Node version directives
-.nvmrc
-
 # dotenv environment variables file
 .env
 .env.test
@@ -52,3 +53,8 @@ site
 
 # E2E test reports
 e2e-test-report/
+
+# Cache
+.cache/
+# Local configuration overrides (contains secrets)
+app-config.local.yaml

.node-version

@@ -1 +1 @@
-18.19.0
+20.19.0

.nvmrc

@@ -0,0 +1 @@
+20.19.0

.prettierignore

@@ -2,5 +2,4 @@ dist
 dist-types
 coverage
 .vscode
-.coder.yaml
-app-config.local.yaml
+.coder.yaml

.yarn/plugins/@yarnpkg/plugin-backstage.cjs

@@ -0,0 +1,9 @@
+/* eslint-disable */
+//prettier-ignore
+module.exports = {
+name: "@yarnpkg/plugin-backstage",
+factory: function (require) {
+"use strict";var plugin=(()=>{var ee=Object.create;var R=Object.defineProperty;var re=Object.getOwnPropertyDescriptor;var te=Object.getOwnPropertyNames;var oe=Object.getPrototypeOf,ne=Object.prototype.hasOwnProperty;var f=(e=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(e,{get:(r,t)=>(typeof require<"u"?require:r)[t]}):e)(function(e){if(typeof require<"u")return require.apply(this,arguments);throw Error('Dynamic require of "'+e+'" is not supported')});var se=(e,r)=>()=>(r||e((r={exports:{}}).exports,r),r.exports),ae=(e,r)=>{for(var t in r)R(e,t,{get:r[t],enumerable:!0})},M=(e,r,t,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of te(r))!ne.call(e,o)&&o!==t&&R(e,o,{get:()=>r[o],enumerable:!(n=re(r,o))||n.enumerable});return e};var S=(e,r,t)=>(t=e!=null?ee(oe(e)):{},M(r||!e||!e.__esModule?R(t,"default",{value:e,enumerable:!0}):t,e)),ie=e=>M(R({},"__esModule",{value:!0}),e);var H=se((Ae,z)=>{"use strict";var $=class e extends Error{constructor(r){super(e._prepareSuperMessage(r)),Object.defineProperty(this,"name",{value:"NonError",configurable:!0,writable:!0}),Error.captureStackTrace&&Error.captureStackTrace(this,e)}static _prepareSuperMessage(r){try{return JSON.stringify(r)}catch{return String(r)}}},fe=[{property:"name",enumerable:!1},{property:"message",enumerable:!1},{property:"stack",enumerable:!1},{property:"code",enumerable:!0}],D=Symbol(".toJSON called"),le=e=>{e[D]=!0;let r=e.toJSON();return delete e[D],r},T=({from:e,seen:r,to_:t,forceEnumerable:n,maxDepth:o,depth:a})=>{let i=t||(Array.isArray(e)?[]:{});if(r.push(e),a>=o)return i;if(typeof e.toJSON=="function"&&e[D]!==!0)return le(e);for(let[s,p]of Object.entries(e)){if(typeof Buffer=="function"&&Buffer.isBuffer(p)){i[s]="[object Buffer]";continue}if(typeof p!="function"){if(!p||typeof p!="object"){i[s]=p;continue}if(!r.includes(e[s])){a++,i[s]=T({from:e[s],seen:r.slice(),forceEnumerable:n,maxDepth:o,depth:a});continue}i[s]="[Circular]"}}for(let{property:s,enumerable:p}of fe)typeof e[s]=="string"&&Object.defineProperty(i,s,{value:e[s],enumerable:n?!0:p,configurable:!0,writable:!0});return i},ge=(e,r={})=>{let{maxDepth:t=Number.POSITIVE_INFINITY}=r;return typeof e=="object"&&e!==null?T({from:e,seen:[],forceEnumerable:!0,maxDepth:t,depth:0}):typeof e=="function"?`[Function: ${e.name||"anonymous"}]`:e},me=(e,r={})=>{let{maxDepth:t=Number.POSITIVE_INFINITY}=r;if(e instanceof Error)return e;if(typeof e=="object"&&e!==null&&!Array.isArray(e)){let n=new Error;return T({from:e,seen:[],to_:n,maxDepth:t,depth:0}),n}return new $(e)};z.exports={serializeError:ge,deserializeError:me}});var ve={};ae(ve,{default:()=>xe});var P=f("@yarnpkg/core");var E=f("@yarnpkg/core");var U=S(f("assert")),q=f("semver"),v=f("@yarnpkg/fslib");var d=S(f("fs")),l=f("path");function _(e,r){let t=e;for(let n=0;n<1e3;n++){let o=(0,l.resolve)(t,"package.json");if(d.default.existsSync(o)&&r(o))return t;let i=(0,l.dirname)(t);if(i===t)return;t=i}throw new Error(`Iteration limit reached when searching for root package.json at ${e}`)}function ce(e){let r=_(e,()=>!0);if(!r)throw new Error(`No package.json found while searching for package root of ${e}`);return r}function pe(e){if(!d.default.existsSync((0,l.resolve)(e,"src")))throw new Error("Tried to access monorepo package root dir outside of Backstage repository");return(0,l.resolve)(e,"../..")}function O(e){let r=ce(e),t=d.default.realpathSync(process.cwd()).replace(/^[a-z]:/,s=>s.toLocaleUpperCase("en-US")),n="",o=()=>(n||(n=pe(r)),n),a="",i=()=>(a||(a=_(t,s=>{try{let p=d.default.readFileSync(s,"utf8");return!!JSON.parse(p).workspaces}catch(p){throw new Error(`Failed to parse package.json file while searching for root, ${p}`)}})??t),a);return{ownDir:r,get ownRoot(){return o()},targetDir:t,get targetRoot(){return i()},resolveOwn:(...s)=>(0,l.resolve)(r,...s),resolveOwnRoot:(...s)=>(0,l.resolve)(o(),...s),resolveTarget:(...s)=>(0,l.resolve)(t,...s),resolveTargetRoot:(...s)=>(0,l.resolve)(i(),...s)}}var B="backstage.json";function u(e){if(typeof e!="object"||e===null||Array.isArray(e))return!1;let r=e;return!(typeof r.name!="string"||r.name===""||typeof r.message!="string")}var J=S(H());function G(e){if(u(e)){let r=String(e);return r!=="[object Object]"?r:`${e.name}: ${e.message}`}return`unknown error '${e}'`}var x=class extends Error{cause;constructor(r,t){let n=r;if(t!==void 0){let o=G(t);n?n+=`; caused by ${o}`:n=`caused by ${o}`}super(n),Error.captureStackTrace?.(this,this.constructor),(!this.name||this.name==="Error")&&this.constructor.name!=="Error"&&(this.name=this.constructor.name),this.cause=u(t)?t:void 0}};var k=class extends x{constructor(r,t){super(r,t),this.name=u(t)?t.name:"Error"}};var K=e=>{let r=!1,t;return()=>(r||(t=e(),r=!0),t)};var y=f("@yarnpkg/fslib");var Y=()=>y.npath.toPortablePath(O(y.npath.fromPortablePath(y.ppath.cwd())).targetRoot);var h=K(()=>{let e=v.ppath.join(Y(),B),r=null;try{let t=v.xfs.readJsonSync(e).version;(0,U.default)(t!==void 0,"Version field is missing"),r=(0,q.valid)(t),(0,U.default)(r!==null,"Version exists but is not valid semver")}catch(t){throw new k("Valid version string not found in backstage.json",t)}return r});var w=f("@yarnpkg/core"),Q=f("@yarnpkg/fslib");var ue="https://versions.backstage.io",de="https://raw.githubusercontent.com/backstage/versions/main";function ke(e,r){return new Promise((t,n)=>{let o=setTimeout(()=>{r.aborted||t()},e);r.addEventListener("abort",()=>{clearTimeout(o),n(new Error("Aborted"))})})}async function ye(e,r,t){let n=new AbortController,o=new AbortController,a=e(n.signal).then(s=>(o.abort(),s)),i=ke(t,o.signal).then(()=>r(o.signal)).then(s=>(n.abort(),s));return Promise.any([a,i]).catch(()=>a)}async function A(e){let r=encodeURIComponent(e.version),t=e.fetch??fetch,n=e.versionsBaseUrl??ue,o=e.gitHubRawBaseUrl??de,a=await ye(i=>t(`${n}/v1/releases/${r}/manifest.json`,{signal:i}),i=>t(`${o}/v1/releases/${r}/manifest.json`,{signal:i}),500);if(a.status===404)throw new Error(`No release found for ${e.version} version`);if(a.status!==200)throw new Error(`Unexpected response status ${a.status} when fetching release from ${a.url}.`);return a.json()}var c="backstage:";var j=f("process"),m=async(e,r)=>{let t=w.structUtils.stringifyIdent(e),n=w.structUtils.parseRange(e.range);if(n.protocol!==c)throw new Error(`Unsupported version protocol in version range "${e.range}" for package ${t}`);if(n.selector!=="^")throw new Error(`Unexpected version selector "${n.selector}" for package ${t}`);let o=h(),a=j.env.BACKSTAGE_MANIFEST_FILE,s=(a?await Q.xfs.readJsonSync(a):await A({version:o,versionsBaseUrl:j.env.BACKSTAGE_VERSIONS_BASE_URL,fetch:async p=>{let F=await w.httpUtils.get(p,{configuration:r,jsonResponse:!0});return{status:200,url:p,json:()=>F}}})).packages.find(p=>p.name===t);if(!s)throw new Error(`Package ${t} not found in manifest for Backstage v${o}. This means the specified package is not included in this Backstage release. This may imply the package has been replaced with an alternative - please review the documentation for the package. If you need to continue using this package, it will be necessary to switch to manually managing its version.`);return s.version};var he=e=>E.structUtils.parseRange(e).protocol===c,we=(e,r,t)=>e!=="dependencies"?e:t.manifest.ensureDependencyMeta(E.structUtils.makeDescriptor(r,"unknown")).optional?"optionalDependencies":e,L=async(e,r)=>{for(let t of["dependencies","devDependencies"]){let n=Array.from(e.manifest.getForScope(t).values()).filter(o=>o.range.startsWith(c));for(let o of n){let a=E.structUtils.stringifyIdent(o);if(E.structUtils.parseRange(o.range).selector!=="^")throw new Error(`Unexpected version range "${o.range}" for dependency on "${a}"`);let s=we(t,o,e);r[s][a]=`^${await m(o,e.project.configuration)}`}}if(["dependencies","devDependencies","optionalDependencies"].some(t=>Object.values(r[t]??{}).some(he)))throw new Error(`Failed to replace all "backstage:" ranges in manifest for ${r.name}`)};var C=f("@yarnpkg/core");var V=async(e,r)=>{let t=C.structUtils.parseRange(e.range);if(t.protocol!==c)return e;if(t.selector!=="^")throw new Error(`Invalid backstage: version range found: ${e.range}`);return C.structUtils.bindDescriptor(e,{backstage:h(),npm:await m(e,r.configuration)})};var X=f("@yarnpkg/core");var N=async(e,r,t,n)=>{let o=X.structUtils.parseRange(t.range);if(t.scope==="backstage"&&o.protocol!==c){let a=t.range;try{t.range=`${c}^`,await m(t,e.project.configuration),console.info(`Setting ${t.scope}/${t.name} to ${c}^`)}catch{t.range=a}}};var Z=f("@yarnpkg/core");var I=async(e,r,t,n)=>{let o=Z.structUtils.parseRange(n.range);n.scope==="backstage"&&o.protocol!==c&&console.warn(`${n.name} should be set to "${c}^" instead of "${n.range}". Make sure this change is intentional and not a mistake.`)};var g=f("@yarnpkg/core"),W=f("@yarnpkg/plugin-npm");var b=class e{static protocol=c;supportsDescriptor=r=>r.range.startsWith(e.protocol);async getCandidates(r,t,n){let o=g.structUtils.parseRange(r.range).params?.npm;if(!o||Array.isArray(o))throw new Error(`Missing npm parameter on backstage: range "${r.range}"`);return new W.NpmSemverResolver().getCandidates(g.structUtils.makeDescriptor(r,`npm:^${o}`),t,n)}getResolutionDependencies(r){let t=g.structUtils.parseRange(r.range).params?.npm;if(!t)throw new Error(`Missing npm parameter on backstage: range "${r.range}".`);return{[g.structUtils.stringifyIdent(r)]:g.structUtils.makeDescriptor(r,`npm:^${t}`)}}async getSatisfying(r,t,n,o){let a=r,i=g.structUtils.parseRange(a.range);if(i.protocol===c){let s=i.params?.npm;a=g.structUtils.makeDescriptor(r,`npm:^${s}`)}return new W.NpmSemverResolver().getSatisfying(a,t,n,o)}bindDescriptor=r=>r;supportsLocator=()=>!1;shouldPersistResolution=()=>{throw new Error("Unreachable: BackstageNpmResolver should never persist resolution as it uses npm: protocol")};resolve=async()=>{throw new Error("Unreachable: BackstageNpmResolver should never resolve as it uses npm: protocol")}};var Ee="\x1B[31;1m",be="\x1B[0m";P.semverUtils.satisfiesWithPrereleases(P.YarnVersion,"^4.1.1")||(console.error(),console.error(`${Ee}Unsupported yarn version${be}: The Backstage yarn plugin only works with yarn ^4.1.1. Please upgrade yarn, or remove this plugin with "yarn plugin remove @yarnpkg/plugin-backstage".`),console.error());var Re={hooks:{afterWorkspaceDependencyAddition:N,afterWorkspaceDependencyReplacement:I,reduceDependency:V,beforeWorkspacePacking:L},resolvers:[b]},xe=Re;return ie(ve);})();
+return plugin;
+}
+};