Cache feature flags on disk #1384
Merged
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
This will allow feature flags to be shared across steps in the same job, avoiding an error we saw earlier where the init action had the flag enabled, but the analyze step had it disabled. This uses the runner's temp folder to cache the flags file, which will stick around until the job completes.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+325
to
+328
| fs.writeFileSync( | ||
| cachedFeatureFlags, | ||
| JSON.stringify(actualFeatureEnablement) | ||
| ); |
Check failure
Code scanning / CodeQL
Potential file system race condition
There was a problem hiding this comment.
Huh.. should we be checking files we write to?
There was a problem hiding this comment.
This does feel like an FP. I will contact the team.
angelapwen
previously approved these changes
Nov 21, 2022
Comment on lines
+325
to
+328
| fs.writeFileSync( | ||
| cachedFeatureFlags, | ||
| JSON.stringify(actualFeatureEnablement) | ||
| ); |
There was a problem hiding this comment.
Huh.. should we be checking files we write to?
src/feature-flags.ts
Outdated
| @@ -55,6 +58,8 @@ export const featureConfig: Record< | |||
| */ | |||
| type GitHubFeatureFlagsApiResponse = Partial<Record<Feature, boolean>>; | |||
|
|
|||
| export const FEATURE_FLAGS_FILE_NAME = "feature-flags.json"; | |||
There was a problem hiding this comment.
Wondering if this could be renamed to include local or cache somehow so it's easier to remember the difference between this file and the remote server-side flags 🤔
angelapwen
approved these changes
Nov 21, 2022
This was referenced Nov 25, 2022
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.
This will allow feature flags to be shared across steps in the same job, avoiding an error we saw earlier where the init action had the flag enabled, but the analyze step had it disabled.
This uses the runner's temp folder to cache the flags file, which will stick around until the job completes.
Merge / deployment checklist