Skip to content
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

[TT-10134] Fixed backward compatibility issue caused by analyticsEnabled #123

Merged
merged 4 commits into from
Oct 13, 2023

Conversation

komalsukhani
Copy link
Collaborator

@komalsukhani komalsukhani commented Oct 4, 2023

Description

analyticsEnabled will support following values
1. ""/ nil
Analytics will be enabled/disabled based on pump installations. It is supported for backward compatibility.
If global.components.pump is set to true, TYK_GW_ENABLEANALYTICS will be set to true. Otherwise TYK_GW_ENABLEANALYTICS will not be set.

2. "false"
Will set TYK_GW_ENABLEANALYTICS to false.

3. true
Will set TYK_GW_ENABLEANALYTICS to true.

By default, analyticsEnabled is set to "" for all charts.

Related Issue

TT-10134

Motivation and Context

Test Coverage For This Change

Have tested tyk-oss chart with following settings

AnalyticsEnabled global.components.pump Value of TYK_GW_ENABLEANALYTICS
"" true true
"" false Not set
nil true true
nil false Not set
false true false
true false true

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)
  • Documentation updates or improvements.

Checklist

  • Make sure you are requesting to pull a topic/feature/bugfix branch (right side). If PRing from your fork, don't come from your master!
  • Make sure you are making a pull request against our master branch (left side). Also, it would be best if you started your change off our latest master.
  • My change requires a change to the documentation.
    • I have manually updated the README(s)/documentation accordingly.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@komalsukhani komalsukhani marked this pull request as ready for review October 4, 2023 11:39
@komalsukhani komalsukhani requested a review from a team as a code owner October 4, 2023 11:39
@komalsukhani komalsukhani requested review from buraksekili and removed request for a team October 4, 2023 11:39
@jakub-bochenski
Copy link
Contributor

FWIF I'm not using the umbrella charts, so this is still not backwards compatible in my case

@komalsukhani
Copy link
Collaborator Author

komalsukhani commented Oct 4, 2023

@jakub-bochenski When analyticsEnabled is set to false and pump is set to false or doesn't exist(in case of tyk-gateway), environment variable will not be set as before.
That way it will be backward compatible for you, right?

@jakub-bochenski
Copy link
Contributor

Oh, it seems it will

Sorry, I missed that part

@komalsukhani
Copy link
Collaborator Author

No worries. I have updated the description to make it more clear.

Copy link
Collaborator

@buraksekili buraksekili left a comment

Choose a reason for hiding this comment

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

lgtm!

@singhpr singhpr merged commit 9911cf1 into main Oct 13, 2023
@singhpr singhpr deleted the fix/TT-10134/fix_backward_compatibility_issue branch October 13, 2023 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants