Added env var for disabling update checks #3986
Open
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
|
Kudos, SonarCloud Quality Gate passed!
|
Amndeep7
requested changes
Jan 23, 2023
| @@ -25,6 +25,7 @@ ONE_SESSION_PER_USER=<If users are only allowed to be logged in on one browser, | |||
| CLASSIFICATION_BANNER_TEXT=<If a sensitivity classification banner should be shown to users, for example FOUO (if nothing is provided, no banner is shown)> | |||
| CLASSIFICATION_BANNER_TEXT_COLOR=<The color of the text on the sensitivity classification banner, if enabled (defaults to white)> | |||
| CLASSIFICATION_BANNER_COLOR=<The color of the sensitivity classification banner, if enabled (defaults to red)> | |||
| DISABLE_UPDATE_CHECK=<Disable checking GitHub for an updated version of Heimdall2 (defaults to false)> | |||
There was a problem hiding this comment.
please match other variable names
Suggested change
| DISABLE_UPDATE_CHECK=<Disable checking GitHub for an updated version of Heimdall2 (defaults to false)> | |
| UPDATE_CHECK_DISABLED=<Disable checking GitHub for an updated version of Heimdall2 (defaults to false)> |
| @@ -56,7 +56,8 @@ export class ConfigService { | |||
| oidcName: this.get('OIDC_NAME') || '', | |||
| ldap: this.get('LDAP_ENABLED')?.toLocaleLowerCase() === 'true' || false, | |||
There was a problem hiding this comment.
Suggested change
| ldap: this.get('LDAP_ENABLED')?.toLocaleLowerCase() === 'true' || false, | |
| ldap: this.get('LDAP_ENABLED')?.toLowerCase() === 'true', |
| @@ -56,7 +56,8 @@ export class ConfigService { | |||
| oidcName: this.get('OIDC_NAME') || '', | |||
| ldap: this.get('LDAP_ENABLED')?.toLocaleLowerCase() === 'true' || false, | |||
| registrationEnabled: this.isRegistrationAllowed(), | |||
| localLoginEnabled: this.isLocalLoginAllowed() | |||
| localLoginEnabled: this.isLocalLoginAllowed(), | |||
| disableUpdateCheck: !!this.get('DISABLE_UPDATE_CHECK') | |||
There was a problem hiding this comment.
This will only check if there's a non-empty string. Also please propagate moving the 'disable' part to the end of the name.
$ node
Welcome to Node.js v18.12.1.
Type ".help" for more information.
> false
false
> 'false'
'false'
> !'false'
false
> !!'false'
true
Suggested change
| disableUpdateCheck: !!this.get('DISABLE_UPDATE_CHECK') | |
| updateCheckDisabled: this.get('UPDATE_CHECK_DISABLED')?.toLowerCase() === 'true' |
| @@ -54,7 +55,7 @@ export class AppInfo extends VuexModule implements IAppInfoState { | |||
|
|
|||
| @Action | |||
| public async CheckForUpdates() { | |||
| if (this.checkedForUpdates === false) { | |||
| if (!ServerModule.disableUpdateCheck && this.checkedForUpdates === false) { | |||
There was a problem hiding this comment.
Please move this into its own guard clause where we can set 'SET_VERSION' to the deployed instance's version and 'SET_CHECKED_FOR_UPDATES' to true.
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 PR adds an environment config item for disabling checks for Heimdall2 updates.
This is useful in cases where Heimdall2 is being used as a component of a larger system, and that system's maintainers do not wish this update banner to appear for end users.
It also is useful in airgapped usecases where Heimdall2 may not have access to GitHub to check for a newer version.