sourcegraph/client
Peter Guy 5ee5e8817b
fix(search): VSCode Search extension: remove auth provider (#63262)
VSCode extensions can use authentication providers to enable
authentication actions from the Accounts menu, and to allow for
federated authentication. The Sourcegraph Search extension needs neither
of those - it can meet all of its authentication needs with the existing
actions in is side panel.

On top of that, the authentication provider isn't implemented quite
correctly, which leads to issues like #43608.

This PR removes the authentication provider.

It retains all of the expected behavior of the extension: the user can
still authenticate against sourcegraph.com or private instances using an
access token, and log out.

## Test plan

### First
Build and run locally.
```
git switch peterguy/vscode-remove-auth-provider
cd client/vscode
pnpm run build
```
### Then
- Launch extension in VSCode: open the `Run and Debug` sidebar view in
VS Code, then select `Launch VS Code Extension` from the dropdown menu.
- Note that the Accounts icon does not display a "1" badge and "Sign in
with SOURCEGRAPH_AUTH" is not present in the menu.
- Click on `Have an account?` to open the login dialog.
- Enter an access token and the URL of the Sourcegraph instance to which
you would like to connect.
- Click `Authenticate account`.
- Check the Accounts icon and menu - should not be anything there that's
a result of Sourcegraph Search.
- In the Help and Feedback section, click your username to open the
logout panel, then log out.
- Note again, the lack of modifications to the Accounts icon and menu
from the Sourcegraph Search extension.

## Changelog

- Remove interaction between the Sourcegraph Search extension and the
Accounts menu.
2024-06-19 11:23:10 -07:00
..
branded fix(search): Better diagnostic message for invalid and incomplete select: filter value (#63266) 2024-06-15 10:06:49 +02:00
browser fix(Source): Fix documentation URLs for code hosts help pages (#63274) 2024-06-17 14:32:46 -04:00
build-config web: Update rxjs to v7 (#61122) 2024-03-18 14:02:57 +01:00
client-api v2t: add v2 telemetry to the client/shared folder (#62586) 2024-06-03 16:34:28 -07:00
codeintellify Migrate deprecated rxjs functions/methods (#61222) 2024-04-08 11:23:34 +02:00
cody-context-filters-test-dataset Create a shared Cody Ignore dataset (#61968) 2024-05-09 13:18:35 +00:00
cody-shared Rename smartContext to smartContextWindow (#62948) 2024-05-28 10:00:34 -07:00
cody-ui Cody web: Bring back old packages from git history (#61376) 2024-04-08 14:21:41 +02:00
common chore: Centralize languages package as source-of-truth (#63292) 2024-06-18 13:10:24 +00:00
eslint-plugin-wildcard chore: upgrade to Aspect CLI 5.8.5 (#57961) 2023-10-30 17:01:58 +02:00
extension-api Docs: update links to point to new site (#60381) 2024-02-13 00:23:47 +00:00
extension-api-types use @typescript-eslint projectService for faster eslint (#57851) 2023-10-24 01:40:40 +00:00
http-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
jetbrains bazel: transcribe test ownership to bazel tags (#62664) 2024-05-16 15:51:16 +01:00
observability-client reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
observability-server reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
shared Chore: remove search console (#63322) 2024-06-19 11:05:03 -06:00
storybook fix: update links for dev docs (#62758) 2024-05-17 13:47:34 +02:00
template-parser reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
testing chore(bazel): enable rules_esbuild sandbox with object-inspect workaround (#61969) 2024-06-05 15:34:29 +01:00
vscode fix(search): VSCode Search extension: remove auth provider (#63262) 2024-06-19 11:23:10 -07:00
web feat(plg): Use react-query for team management (#63267) 2024-06-19 19:05:14 +02:00
web-sveltekit chore(ci): mark web-sveltekit:e2e_test as flaky (#63351) 2024-06-19 17:44:09 +00:00
wildcard feat(plg): Apply designs to Cody Pro pages (#63244) 2024-06-19 10:58:46 +02:00
BUILD.bazel Added ts_projects for storybook files in client/* (#59400) 2024-01-09 10:37:53 -08:00
README.md use esbuild for client/web builds (#57365) 2023-10-23 10:59:06 -07:00

Frontend packages

List

  • web: The web application deployed to http://sourcegraph.com/
  • browser: The Sourcegraph browser extension adds tooltips to code on different code hosts.
  • vscode: The Sourcegraph VS Code extension.
  • extension-api: The Sourcegraph extension API types for the Sourcegraph extensions. Published as sourcegraph.
  • extension-api-types: The Sourcegraph extension API types for client applications that embed Sourcegraph extensions and need to communicate with them. Published as @sourcegraph/extension-api-types.
  • sandboxes: All demos-mvp (minimum viable product) for the Sourcegraph web application.
  • shared: Contains common TypeScript/React/SCSS client code shared between the browser extension and the web app. Everything in this package is code-host agnostic.
  • branded: Contains React components and implements the visual design language we use across our web app and e.g. in the options menu of the browser extension. Over time, components from shared and branded packages should be moved into the wildcard package.
  • wildcard: Package that encapsulates storybook configuration and contains our Wildcard design system components. If we're using a component in two or more different areas (e.g. web-app and browser-extension) then it should live in the wildcard package. Otherwise the components should be better colocated with the code where they're actually used.
  • search: Search-related code that may be shared between all clients, both branded (e.g. web, VS Code extension) and unbranded (e.g. browser extension)
  • storybook: Storybook configuration.

Further migration plan

  1. Fix circular dependency in TS project-references graph wildcard package should not rely on web and probably shared, branded too. Ideally it should be an independent self-contained package.

  2. Decide on package naming and update existing package names. Especially it should be done for a shared package because we have multiple shared folders inside of other packages. It's hard to understand from where dependency is coming from and it's not possible to refactor import paths using find-and-replace.

  3. Investigate if we can painlessly switch to npm workspaces.

  4. Content of packages shared and branded should be moved to wildcard and refactored using the latest FE rules and conventions. Having different packages clearly communicates the migration plan. Developers first should look for components in the wildcard package and then fall-back to legacy packages if wildcard doesn't have the solution to their problem yet.

  5. shared contains utility functions, types, polyfills, etc which is not a part of the Wildcard component library. These modules should be moved into utils package and other new packages: e.g. api for GraphQL client and type generators, etc.

  6. Packages should use package name (e.g. @sourcegraph/wildcard) for imports instead of the relative paths (e.g. ../../../../wildcard/src/components/Markdown) to avoid long relative-paths and make dependency graph between packages clear. (Typescript will warn if packages have circular dependencies). It's easy to refactor such isolated packages, extract functionality into new ones, or even into new repositories.