forked from sourcegraph/cody
-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
do not block on getting the site version or is-cody-enabled during au…
…th (sourcegraph#5823) The site version and Cody API version is now exposed in the `siteVersion` global observable, which returns the site version and Cody API version for the currently authenticated endpoint (and caches the value). If the Sourcegraph instance does not have Cody enabled, this means that the error message will come later, not at sign-in. With one box, the lines are getting blurrier anyway, and the logic for determining if Cody was enabled was complex and often treated network errors as "Cody is disabled". It is not worth it to invest time in making this more robust because few users will encounter this, and those who do will just get an error that Cody is disabled when they actually try to perform any operation. This means that initial auth takes 1-3 less HTTP requests. ## Test plan CI & e2e
- Loading branch information
Showing
26 changed files
with
249 additions
and
390 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import { describe, expect, test } from 'vitest' | ||
| import { inferCodyApiVersion } from './siteVersion' | ||
|
|
||
| describe('inferCodyApiVersion', () => { | ||
| test('returns API version 0 for a legacy instance', () => { | ||
| expect(inferCodyApiVersion('5.2.0', false)).toBe(0) | ||
| }) | ||
|
|
||
| test('returns API version 1 for older versions', () => { | ||
| expect(inferCodyApiVersion('5.4.0', false)).toBe(1) | ||
| expect(inferCodyApiVersion('5.5.0', false)).toBe(1) | ||
| expect(inferCodyApiVersion('5.6.0', false)).toBe(1) | ||
| expect(inferCodyApiVersion('5.7.0', false)).toBe(1) | ||
| }) | ||
|
|
||
| test('returns API version 2 for newer versions', () => { | ||
| expect(inferCodyApiVersion('5.8.0', false)).toBe(2) | ||
| expect(inferCodyApiVersion('5.9.0', false)).toBe(2) | ||
| expect(inferCodyApiVersion('5.10.1', false)).toBe(2) | ||
| }) | ||
|
|
||
| test('returns API version 2 for dotcom', () => { | ||
| expect(inferCodyApiVersion('1.2.3', true)).toBe(2) | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| import { Observable, map } from 'observable-fns' | ||
| import semver from 'semver' | ||
| import { authStatus } from '../auth/authStatus' | ||
| import { logError } from '../logger' | ||
| import { | ||
| distinctUntilChanged, | ||
| pick, | ||
| promiseFactoryToObservable, | ||
| storeLastValue, | ||
| } from '../misc/observable' | ||
| import { | ||
| firstResultFromOperation, | ||
| pendingOperation, | ||
| switchMapReplayOperation, | ||
| } from '../misc/observableOperation' | ||
| import { isError } from '../utils' | ||
| import { isDotCom } from './environments' | ||
| import { graphqlClient } from './graphql' | ||
|
|
||
| export interface SiteAndCodyAPIVersions { | ||
| siteVersion: string | ||
| codyAPIVersion: CodyApiVersion | ||
| } | ||
|
|
||
| /** | ||
| * Observe the site version and Cody API version of the currently authenticated endpoint. | ||
| */ | ||
| export const siteVersion: Observable<SiteAndCodyAPIVersions | null | typeof pendingOperation> = | ||
| authStatus.pipe( | ||
| pick('authenticated', 'endpoint', 'pendingValidation'), | ||
| distinctUntilChanged(), | ||
| switchMapReplayOperation( | ||
| ( | ||
| authStatus | ||
| ): Observable<SiteAndCodyAPIVersions | Error | null | typeof pendingOperation> => { | ||
| if (authStatus.pendingValidation) { | ||
| return Observable.of(pendingOperation) | ||
| } | ||
|
|
||
| if (!authStatus.authenticated) { | ||
| return Observable.of(null) | ||
| } | ||
|
|
||
| return promiseFactoryToObservable(signal => graphqlClient.getSiteVersion(signal)).pipe( | ||
| map((siteVersion): SiteAndCodyAPIVersions | null | typeof pendingOperation => { | ||
| if (isError(siteVersion)) { | ||
| logError( | ||
| 'siteVersion', | ||
| `Failed to get site version from ${authStatus.endpoint}: ${siteVersion}` | ||
| ) | ||
| return null | ||
| } | ||
| return { | ||
| siteVersion, | ||
| codyAPIVersion: inferCodyApiVersion(siteVersion, isDotCom(authStatus)), | ||
| } | ||
| }) | ||
| ) | ||
| } | ||
| ), | ||
| map(result => (isError(result) ? null : result)) // the operation catches its own errors, so errors will never get here | ||
| ) | ||
|
|
||
| const siteVersionStorage = storeLastValue(siteVersion) | ||
|
|
||
| /** | ||
| * Get the current site version. If authentication is pending, it awaits successful authentication. | ||
| */ | ||
| export function currentSiteVersion(): Promise<SiteAndCodyAPIVersions | null> { | ||
| return firstResultFromOperation(siteVersionStorage.observable) | ||
| } | ||
|
|
||
| type CodyApiVersion = 0 | 1 | 2 | ||
|
|
||
| /** @internal Exported for testing only. */ | ||
| export function inferCodyApiVersion(version: string, isDotCom: boolean): CodyApiVersion { | ||
| const parsedVersion = semver.valid(version) | ||
| const isLocalBuild = parsedVersion === '0.0.0' | ||
|
|
||
| if (isDotCom || isLocalBuild) { | ||
| // The most recent version is api-version=2, which was merged on 2024-09-11 | ||
| // https://github.com/sourcegraph/sourcegraph/pull/470 | ||
| return 2 | ||
| } | ||
|
|
||
| // On Cloud deployments from main, the version identifier will use a format | ||
| // like "2024-09-11_5.7-4992e874aee2", which does not parse as SemVer. We | ||
| // make a best effort go parse the date from the version identifier | ||
| // allowing us to selectively enable new API versions on instances like SG02 | ||
| // (that deploy frequently) without crashing on other Cloud deployments that | ||
| // release less frequently. | ||
| const isCloudBuildFromMain = parsedVersion === null | ||
| if (isCloudBuildFromMain) { | ||
| const date = parseDateFromPreReleaseVersion(version) | ||
| if (date && date >= new Date('2024-09-11')) { | ||
| return 2 | ||
| } | ||
| // It's safe to bump this up to api-version=2 after the 5.8 release | ||
| return 1 | ||
| } | ||
|
|
||
| // 5.8.0+ is the first version to support api-version=2. | ||
| if (semver.gte(parsedVersion, '5.8.0')) { | ||
| return 2 | ||
| } | ||
|
|
||
| // 5.4.0+ is the first version to support api-version=1. | ||
| if (semver.gte(parsedVersion, '5.4.0')) { | ||
| return 1 | ||
| } | ||
|
|
||
| return 0 // zero refers to the legacy, unversioned, Cody API | ||
| } | ||
|
|
||
| // Pre-release versions have a format like this "2024-09-11_5.7-4992e874aee2". | ||
| // This function return undefined for stable Enterprise releases like "5.7.0". | ||
| function parseDateFromPreReleaseVersion(version: string): Date | undefined { | ||
| try { | ||
| const dateString = version.split('_').at(1) | ||
| if (!dateString) { | ||
| return undefined | ||
| } | ||
| return new Date(dateString) | ||
| } catch { | ||
| return undefined | ||
| } | ||
| } |
Oops, something went wrong.