feat: add auth fallback logic for when official Coder components are not mounted

Parkreiner commented 5 months ago

Closes #111 Did not expect this to the hardest part of the umbrella issue.

Video demo: https://github.com/coder/backstage-plugins/assets/28937484/1a859f52-168c-436e-aa60-014bc36c97f1

Changes made

Added auth provider so that we can track official Coder components as they're used throughout the Backstage application
- If there are no official Coder components on the screen while there is a CoderProvider being rendered, a fallback auth input will appear while the user is not authenticated
Redesigned some of the auth-adjacent components so that they're easier to use and remove the need for duplicating component and styling usage in two places
Updated tests to account for changes

Notes

Part of what makes this all so complicated is that we have to jump through so many hoops, purely because (1) we don't control the entire app, and (2) because we're going to give users access to the SDK, we don't even have 100% control of our own plugin logic
Just because this PR is so big as-is, I'm going to make a smaller PR with tests for the new functionality

Remaining pieces for umbrella issue

Swapping in the vendored version of the SDK
Updating some of the existing SDK logic to improve dev ergonomics (e.g., adding the unlink token functionality to the SDK hook, making ready-made versions of useQuery/useMutation that are pre-wired with auth for all relevant properties)
- Both hooks are basically already made and have full type-safety; just need to put them through their paces
Writing documentation/tips for how to use the SDK
Updating the existing documentation to account for some breaking API changes

code-asher commented 5 months ago

About to review, but I wanted to check if my intuition here is right: when we switch to OAuth, I imagine some/most of this goes away? Since by just asking for the token, that triggers Backstage's UI for the OAuth flow, and it resolves once that flow is done or canceled.

Parkreiner commented 5 months ago

About to review, but I wanted to check if my intuition here is right: when we switch to OAuth, I imagine some/most of this goes away? Since by just asking for the token, that triggers Backstage's UI for the OAuth flow, and it resolves once that flow is done or canceled.

@code-asher Possibly? I was under the impression that we'd be keeping both forms of auth (though obviously pushing users to prefer the OAuth version). In which case, this might not go away, but just become more deemphasized

Depending on what oauth looks like, we could make it so that these main auth components never actually mount, and you don't have to worry about the fallback UI

coder / backstage-plugins