Deprecation cleanup for 2.12 release #4806

dttung2905 · 2023-07-17T14:03:34Z

Hi team,

I did a cleanup for 2.12 which is going to be released somewhere in Sept 2023. 🙏 . Its still a WIP and I will update the keda-docs repo later

Checklist

I have verified that my change is according to the deprecations & breaking changes policy
Changelog has been updated and is aligned with our changelog requirements
A PR is opened to update the documentation Remove deprecated metricName field in docs for 2.12 release keda-docs#1205
Commits are signed with Developer Certificate of Origin (DCO - learn more)

Fixes: #4899

github-actions · 2023-07-17T14:03:47Z

Thank you for your contribution! 🙏 We will review your PR as soon as possible.

🏖️ Over the summer, the response time will be longer than usual due to maintainers taking time off so please bear with us.

While you are waiting, make sure to:

Add an entry in our changelog in alphabetical order and link related issue
Update the documentation, if needed
Add unit & e2e tests for your changes
GitHub checks are passing
Is the DCO check failing? Here is how you can fix DCO issues

Learn more about:

Our contribution guide

.github/workflows/release-build.yml

pkg/scalers/azure_blob_scaler.go

pkg/scalers/azure_log_analytics_scaler.go

pkg/scalers/cassandra_scaler.go

pkg/scalers/couchdb_scaler.go

pkg/scalers/mongo_scaler.go

pkg/scalers/mssql_scaler.go

pkg/scalers/postgresql_scaler.go

pkg/scalers/prometheus_scaler.go

pkg/scalers/rabbitmq_scaler.go

dttung2905 · 2023-07-19T15:13:49Z

@JorTurFer I will take a look at the failed CI test. https://github.com/kedacore/keda/actions/runs/5600564910/jobs/10243134785?pr=4806. Seems like the removal of the CI breaks something 😆

JorTurFer

Looking good, just an small nit inline.
Could you update changelog adding this breaking change?
We should review docs as well to remove the parameter from both places at once

JorTurFer · 2023-07-20T15:20:44Z

pkg/scalers/azure_blob_scaler.go

-		meta.MetricName = kedautil.NormalizeString(fmt.Sprintf("azure-blob-%s", meta.BlobContainerName))
-	}
-
+	meta.MetricName = kedautil.NormalizeString(fmt.Sprintf("azure-blob-%s", meta.BlobContainerName))


Do we need to generate this here? I mean, if we have only one option for MetricName and it's used once, maybe we could remove the object variable and generate the name wherever is used. WDYT? (If you agree, this also applies to other scalers)

Yes. I just did another round of refactoring to remove this metricName object var. Added a few test cases. Please help me review it 🙏

pkg/scalers/mssql_scaler.go

JorTurFer · 2023-07-31T07:26:58Z

Could you resolve the conflicts with .github/workflows/release-build.yml? 🙏

dttung2905 · 2023-07-31T09:30:05Z

Thanks @JorTurFer 😄. I will resolve the conflct in .github/workflows/release-build.yml later tonight when I try to fix the rest of the unit test for other scalers too

JorTurFer · 2023-07-31T10:17:52Z

Sure, no rush at all 😄
I have just reviewed some PRs xD

controllers/keda/scaledobject_controller_test.go

JorTurFer · 2023-08-15T14:44:03Z

we should update this comment too:

keda/controllers/keda/hpa.go

Lines 224 to 226 in b18ccd6

    
           if kedacontrollerutil.Contains(externalMetricNames, externalMetricName) { 
        
           	return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s, please refer the documentation how to define metricName manually", externalMetricName, scaledObject.Name) 
        
           }

dttung2905 · 2023-08-16T15:08:38Z

we should update this comment too:

keda/controllers/keda/hpa.go

Lines 224 to 226 in b18ccd6

if kedacontrollerutil.Contains(externalMetricNames, externalMetricName) {

return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s, please refer the documentation how to define metricName manually", externalMetricName, scaledObject.Name)

}

@JorTurFer wdyt about this ?

return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s. metricName is deprecated except for some few particular scalers. Please refer to the documentation whether metricName is required ", externalMetricName, scaledObject.Name)

JorTurFer · 2023-08-16T15:14:02Z

we should update this comment too:

keda/controllers/keda/hpa.go

Lines 224 to 226 in b18ccd6

if kedacontrollerutil.Contains(externalMetricNames, externalMetricName) {

return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s, please refer the documentation how to define metricName manually", externalMetricName, scaledObject.Name)

}

@JorTurFer wdyt about this ?
return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s. metricName is deprecated except for some few particular scalers. Please refer to the documentation whether metricName is required ", externalMetricName, scaledObject.Name)

I'd just say something like:

return nil, fmt.Errorf("metricName %s defined multiple times in ScaledObject %s", externalMetricName, scaledObject.Name)

It's something that never should happen thanks to the index in the prefix, and if it happens, we should review them in the code, so opening an issue is worth

dttung2905 · 2023-08-19T14:20:14Z

pkg/scalers/azure_log_analytics_scaler_test.go

-	{map[string]string{"metricName": "testName", "tenantIdFromEnv": "d248da64-0e1e-4f79-b8c6-72ab7aa055eb", "clientIdFromEnv": "41826dd4-9e0a-4357-a5bd-a88ad771ea7d", "clientSecretFromEnv": "U6DtAX5r6RPZxd~l12Ri3X8J9urt5Q-xs", "workspaceIdFromEnv": "074dd9f8-c368-4220-9400-acb6e80fc325", "query": query, "threshold": "1900000000"}, 1, "azure-log-analytics-testName"},
-}
-
-func TestLogAnalyticsParseMetadataMetricName(t *testing.T) {


I remove this chunk because it is testing against an object variable metricName which we don't use

dttung2905 · 2023-08-19T14:42:18Z

pkg/scalers/prometheus_scaler.go

@@ -251,7 +239,7 @@ func (s *prometheusScaler) Close(context.Context) error {
 }

 func (s *prometheusScaler) GetMetricSpecForScaling(context.Context) []v2.MetricSpec {
-	metricName := kedautil.NormalizeString(fmt.Sprintf("prometheus-%s", s.metadata.metricName))


@JorTurFer Do you have any context why we have another extra prometheus prefix here . I will just remove it. wdyt?

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

JorTurFer

Thanks for this contribution! 💪

JorTurFer · 2023-08-23T14:57:18Z

/run-e2e
Update: You can check the progress here

Signed-off-by: Yoon Park <yoongon.park@gmail.com>

Signed-off-by: anton.lysina <alysina@gmail.com>

dttung2905 requested a review from a team as a code owner July 17, 2023 14:03

JorTurFer reviewed Jul 17, 2023

View reviewed changes

JorTurFer reviewed Jul 20, 2023

View reviewed changes

JorTurFer reviewed Jul 31, 2023

View reviewed changes

pkg/scalers/mssql_scaler.go Outdated Show resolved Hide resolved

dttung2905 force-pushed the clean-up-2-12-deprecation branch 2 times, most recently from fa09231 to 6611c38 Compare August 5, 2023 03:22

dttung2905 commented Aug 5, 2023

View reviewed changes

controllers/keda/scaledobject_controller_test.go Show resolved Hide resolved

dttung2905 mentioned this pull request Aug 9, 2023

Remove deprecated metricName field in docs for 2.12 release kedacore/keda-docs#1205

Merged

1 task

dttung2905 force-pushed the clean-up-2-12-deprecation branch from 0d85b64 to 9bc2ec8 Compare August 13, 2023 07:07

dttung2905 mentioned this pull request Aug 13, 2023

metricName shouldn't be required and should be deprecated for all the scalers #4220

Closed

5 tasks

dttung2905 force-pushed the clean-up-2-12-deprecation branch from 9bc2ec8 to da4d346 Compare August 16, 2023 15:44

dttung2905 commented Aug 19, 2023

View reviewed changes

dttung2905 added 5 commits August 23, 2023 21:32

Recommit with comply with DCO

d023877

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

Code Review fixes

2cae8e2

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

remove MetricName object variable

2b07879

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

Fix CI precommit hook

fdfb2b3

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

Add Changelog for PR

6af6b6a

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>

dttung2905 force-pushed the clean-up-2-12-deprecation branch from d6f5484 to 6af6b6a Compare August 23, 2023 14:13

dttung2905 changed the title ~~WIP: Deprecation cleanup for 2.12 release~~ Deprecation cleanup for 2.12 release Aug 23, 2023

JorTurFer closed this in kedacore/keda-docs#1205 Aug 23, 2023

JorTurFer reopened this Aug 23, 2023

JorTurFer approved these changes Aug 23, 2023

View reviewed changes

JorTurFer enabled auto-merge (squash) August 23, 2023 14:57

JorTurFer disabled auto-merge August 23, 2023 19:50

JorTurFer merged commit 1f4a685 into kedacore:main Aug 23, 2023

yoongon pushed a commit to yoongon/keda that referenced this pull request Aug 26, 2023

Deprecation cleanup for 2.12 release (kedacore#4806)

805242b

Signed-off-by: Yoon Park <yoongon.park@gmail.com>

novicr pushed a commit to novicr/keda that referenced this pull request Aug 26, 2023

Deprecation cleanup for 2.12 release (kedacore#4806)

1352c76

Adarsh-verma-14 pushed a commit to Adarsh-verma-14/keda that referenced this pull request Sep 4, 2023

Deprecation cleanup for 2.12 release (kedacore#4806)

17b964e

toniiiik pushed a commit to toniiiik/keda that referenced this pull request Jan 15, 2024

Deprecation cleanup for 2.12 release (kedacore#4806)

6612e99

Signed-off-by: anton.lysina <alysina@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecation cleanup for 2.12 release #4806

Deprecation cleanup for 2.12 release #4806

dttung2905 commented Jul 17, 2023 •

edited

Loading

github-actions bot commented Jul 17, 2023

dttung2905 commented Jul 19, 2023

JorTurFer left a comment •

edited

Loading

JorTurFer Jul 20, 2023

dttung2905 Aug 19, 2023

JorTurFer commented Jul 31, 2023

dttung2905 commented Jul 31, 2023

JorTurFer commented Jul 31, 2023

JorTurFer commented Aug 15, 2023

dttung2905 commented Aug 16, 2023

JorTurFer commented Aug 16, 2023

dttung2905 Aug 19, 2023

dttung2905 Aug 19, 2023

JorTurFer left a comment

JorTurFer commented Aug 23, 2023 •

edited by github-actions bot

Loading

Deprecation cleanup for 2.12 release #4806

Deprecation cleanup for 2.12 release #4806

Conversation

dttung2905 commented Jul 17, 2023 • edited Loading

Checklist

github-actions bot commented Jul 17, 2023

dttung2905 commented Jul 19, 2023

JorTurFer left a comment • edited Loading

Choose a reason for hiding this comment

JorTurFer Jul 20, 2023

Choose a reason for hiding this comment

dttung2905 Aug 19, 2023

Choose a reason for hiding this comment

JorTurFer commented Jul 31, 2023

dttung2905 commented Jul 31, 2023

JorTurFer commented Jul 31, 2023

JorTurFer commented Aug 15, 2023

dttung2905 commented Aug 16, 2023

JorTurFer commented Aug 16, 2023

dttung2905 Aug 19, 2023

Choose a reason for hiding this comment

dttung2905 Aug 19, 2023

Choose a reason for hiding this comment

JorTurFer left a comment

Choose a reason for hiding this comment

JorTurFer commented Aug 23, 2023 • edited by github-actions bot Loading

dttung2905 commented Jul 17, 2023 •

edited

Loading

JorTurFer left a comment •

edited

Loading

JorTurFer commented Aug 23, 2023 •

edited by github-actions bot

Loading