FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Cache feature flags on disk by aeisenberg · Pull Request #1384 · github/codeql-action · GitHub

/ codeql-action Public

Cache feature flags on disk - #1384

Merged
aeisenberg merged 4 commits into
mainfrom
aeisenberg/feature-flags-disk
Nov 21, 2022
ConversationCommits (4)ChecksFiles changed
Merged

Cache feature flags on disk#1384
aeisenberg merged 4 commits into
mainfrom
aeisenberg/feature-flags-disk

Conversation

aeisenberg commented Nov 21, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

Cache feature flags on disk
c29fca4 
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.
aeisenberg requested a review from a team as a code owner November 21, 2022 19:17
github-advanced-security AI found potential problems Nov 21, 2022
View reviewed changes
Comment thread src/feature-flags.test.ts
Comment on lines +325 to +328
fs.writeFileSync(
cachedFeatureFlags,
JSON.stringify(actualFeatureEnablement)
);

Check failure

Code scanning / CodeQL

Potential file system race condition

The file may have changed since it [was checked](1). The file may have changed since it [was checked](2).

angelapwen Nov 21, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Huh.. should we be checking files we write to?

aeisenberg Nov 21, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This does feel like an FP. I will contact the team.

angelapwen previously approved these changes Nov 21, 2022
View reviewed changes

angelapwen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks!! Makes sense, just a couple of naming thoughts

Comment thread src/feature-flags.test.ts
Comment on lines +325 to +328
fs.writeFileSync(
cachedFeatureFlags,
JSON.stringify(actualFeatureEnablement)
);

angelapwen Nov 21, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Huh.. should we be checking files we write to?

Comment thread src/feature-flags.ts
Comment thread src/feature-flags.ts Outdated
*/
type GitHubFeatureFlagsApiResponse = Partial<Record<Feature, boolean>>;

export const FEATURE_FLAGS_FILE_NAME = "feature-flags.json";

angelapwen Nov 21, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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
View reviewed changes

angelapwen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks! Extra test looks 👍

aeisenberg merged commit 26df9a9 into main Nov 21, 2022
aeisenberg deleted the aeisenberg/feature-flags-disk branch November 21, 2022 23:25
This was referenced Nov 25, 2022
Merged
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
angelapwen angelapwen approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL