-
Notifications
You must be signed in to change notification settings - Fork 15
Add experiments using ConfigCat #15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
58cd0b2
Add experiments using ConfigCat
jeanp413 fcd177e
Fix configcat key
jeanp413 afe3aa5
Fix
jeanp413 4750c5c
Don't use configcat in prerelease versions as it's already enabled
jeanp413 4d401d9
update github actions
jeanp413 e4e2654
:lipstick:
jeanp413 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,90 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Gitpod. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import * as vscode from 'vscode'; | ||
| import * as configcat from 'configcat-node'; | ||
| import * as configcatcommon from 'configcat-common'; | ||
| import * as semver from 'semver'; | ||
| import Log from './common/logger'; | ||
|
|
||
| const EXPERTIMENTAL_SETTINGS = [ | ||
| 'gitpod.remote.useLocalApp' | ||
| ]; | ||
|
|
||
| export class ExperimentalSettings { | ||
| private configcatClient: configcatcommon.IConfigCatClient; | ||
| private extensionVersion: semver.SemVer; | ||
|
|
||
| constructor(key: string, extensionVersion: string, private logger: Log) { | ||
| this.configcatClient = configcat.createClientWithLazyLoad(key, { | ||
| logger: { | ||
| debug(): void { }, | ||
| log(): void { }, | ||
| info(): void { }, | ||
| warn(message: string): void { logger.warn(`ConfigCat: ${message}`); }, | ||
| error(message: string): void { logger.error(`ConfigCat: ${message}`); } | ||
| }, | ||
| requestTimeoutMs: 1500, | ||
| cacheTimeToLiveSeconds: 60 | ||
| }); | ||
| this.extensionVersion = new semver.SemVer(extensionVersion); | ||
| } | ||
|
|
||
| async get<T>(key: string, userId?: string): Promise<T | undefined> { | ||
| const config = vscode.workspace.getConfiguration('gitpod'); | ||
| const values = config.inspect<T>(key.substring('gitpod.'.length)); | ||
| if (!values || !EXPERTIMENTAL_SETTINGS.includes(key)) { | ||
| this.logger.error(`Cannot get invalid experimental setting '${key}'`); | ||
| return values?.globalValue ?? values?.defaultValue; | ||
| } | ||
| if (this.isPreRelease()) { | ||
| // PreRelease versions always have experiments enabled by default | ||
| return values.globalValue ?? values.defaultValue; | ||
| } | ||
| if (values.globalValue !== undefined) { | ||
| // User setting have priority over configcat so return early | ||
| return values.globalValue; | ||
| } | ||
|
|
||
| const user = userId ? new configcatcommon.User(userId) : undefined; | ||
| const configcatKey = key.replace(/\./g, '_'); // '.' are not allowed in configcat | ||
| const experimentValue = (await this.configcatClient.getValueAsync(configcatKey, undefined, user)) as T | undefined; | ||
|
|
||
| return experimentValue ?? values.defaultValue; | ||
| } | ||
|
|
||
| async inspect<T>(key: string, userId?: string): Promise<{ key: string; defaultValue?: T; globalValue?: T; experimentValue?: T } | undefined> { | ||
| const config = vscode.workspace.getConfiguration('gitpod'); | ||
| const values = config.inspect<T>(key.substring('gitpod.'.length)); | ||
| if (!values || !EXPERTIMENTAL_SETTINGS.includes(key)) { | ||
| this.logger.error(`Cannot inspect invalid experimental setting '${key}'`); | ||
| return values; | ||
| } | ||
|
|
||
| const user = userId ? new configcatcommon.User(userId) : undefined; | ||
| const configcatKey = key.replace(/\./g, '_'); // '.' are not allowed in configcat | ||
| const experimentValue = (await this.configcatClient.getValueAsync(configcatKey, undefined, user)) as T | undefined; | ||
|
|
||
| return { key, defaultValue: values.defaultValue, globalValue: values.globalValue, experimentValue }; | ||
| } | ||
|
|
||
| isUserOverride(key: string): boolean { | ||
| const config = vscode.workspace.getConfiguration('gitpod'); | ||
| const values = config.inspect(key.substring('gitpod.'.length)); | ||
| return values?.globalValue !== undefined; | ||
| } | ||
|
|
||
| forceRefreshAsync(): Promise<void> { | ||
| return this.configcatClient.forceRefreshAsync(); | ||
| } | ||
|
|
||
| private isPreRelease() { | ||
| return this.extensionVersion.minor % 2 === 1; | ||
| } | ||
|
|
||
| dispose(): void { | ||
| this.configcatClient.dispose(); | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disable configcat for now before merging