feat: retrieve and store snykCodeInlineIgnore feature flag [IDE-440][IDE-441] #492
Conversation
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
bastiandoetsch
changed the title
cat2608
reviewed
Jul 19, 2024
Comment on lines
20
to
24
|
|
||
| async fetchFeatureFlagWithoutErrorHandling(flagName: string): Promise<boolean> { | ||
| const ffStatus = await this.commandExecutor.executeCommand<FeatureFlagStatus>(SNYK_FEATURE_FLAG_COMMAND, flagName); | ||
| return ffStatus?.ok ?? false; | ||
| } |
There was a problem hiding this comment.
What if we provide a fallback values instead so we don't need this extra function?
async fetchFeatureFlag(flagName: string, fallbackValue = false): Promise<boolean> {
try {
const ffStatus = await this.commandExecutor.executeCommand<FeatureFlagStatus>(
SNYK_FEATURE_FLAG_COMMAND,
flagName,
);
return ffStatus?.ok ?? false;
} catch (error) {
console.warn(`Failed to fetch feature flag ${flagName}: ${error}`);
return fallbackValue;
}
}The we change the setupFeatureFlags to handle multiple asynchronous operations concurrently with allSettled. I'll add and example in that bit, one sec 🙏
There was a problem hiding this comment.
Sounds good!
cat2608
reviewed
Jul 19, 2024
src/snyk/base/modules/snykLib.ts
Outdated
Comment on lines
53
to
67
| async setupFeatureFlags(): Promise<void> { | ||
| const isEnabled = await this.featureFlagService.fetchFeatureFlag(FEATURE_FLAGS.consistentIgnores); | ||
| let isEnabled = await this.featureFlagService.fetchFeatureFlag(FEATURE_FLAGS.consistentIgnores); | ||
| configuration.setFeatureFlag(FEATURE_FLAGS.consistentIgnores, isEnabled); | ||
|
|
||
| try { | ||
| isEnabled = await this.featureFlagService.fetchFeatureFlagWithoutErrorHandling( | ||
| FEATURE_FLAGS.snykCodeInlineIgnore, | ||
| ); | ||
| } catch (err) { | ||
| // if we cannot get the feature flag, we default to true for | ||
| // minimal disruption of the existing customer feature | ||
| isEnabled = true; | ||
| } | ||
| configuration.setFeatureFlag(FEATURE_FLAGS.snykCodeInlineIgnore, isEnabled); | ||
| } |
There was a problem hiding this comment.
I just saw that if we provide a fallback to fetchFeatureFlag as commented before and we don't mind concurrency, instead of allSettle we go:
async setupFeatureFlags(): Promise<void> {
const flags = [
{ flag: FEATURE_FLAGS.consistentIgnores, fallback: false },
{ flag: FEATURE_FLAGS.snykCodeInlineIgnore, fallback: true },
];
for (const { flag, fallback } of flags) {
const isEnabled = await this.featureFlagService.fetchFeatureFlag(flag, fallback);
configuration.setFeatureFlag(flag, isEnabled);
}
}There was a problem hiding this comment.
I tried with allSettle but the code gets a bit more complicated because we need to loop the array of results and assert the fulfilled value
There was a problem hiding this comment.
concurrency should actually be the default here - feel free to push your suggestion :)
cat2608
approved these changes
Jul 19, 2024
cat2608
deleted the
feat/IDE-440_retrieve-feature-flag-for-snykCodeInlineIgnore
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Use the new FeatureFlagService in Visual Studio Code to get snykCodeInlineIgnore FF.
Checklist
Screenshots / GIFs
Visuals that may help the reviewer. Please add screenshots for any UI change. GIFs are most welcome!