Skip to content

Commit 8bb6e38

Browse files
samugisamugi
committed
chore(schema): convert shorthand fields deprecations
convert shorthand fields usages of the deprecation module to the new attribute-based deprecation.
1 parent 2d15641 commit 8bb6e38

File tree

3 files changed

+66
-47
lines changed

3 files changed

+66
-47
lines changed

‎kong/plugins/acme/schema.lua

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
local typedefs = require "kong.db.schema.typedefs"
22
local reserved_words = require "kong.plugins.acme.reserved_words"
33
local redis_schema = require "kong.tools.redis.schema"
4-
local deprecation = require("kong.deprecation")
54

65
local tablex = require "pl.tablex"
76

@@ -43,37 +42,41 @@ local LEGACY_SCHEMA_TRANSLATIONS = {
4342
type = "string",
4443
len_min = 0,
4544
translate_backwards = {'password'},
45+
deprecation = {
46+
message = "acme: config.storage_config.redis.auth is deprecated, please use config.storage_config.redis.password instead",
47+
removal_in_version = "4.0", },
4648
func = function(value)
47-
deprecation("acme: config.storage_config.redis.auth is deprecated, please use config.storage_config.redis.password instead",
48-
{ after = "4.0", })
4949
return { password = value }
5050
end
5151
}},
5252
{ ssl_server_name = {
5353
type = "string",
5454
translate_backwards = {'server_name'},
55+
deprecation = {
56+
message = "acme: config.storage_config.redis.ssl_server_name is deprecated, please use config.storage_config.redis.server_name instead",
57+
removal_in_version = "4.0", },
5558
func = function(value)
56-
deprecation("acme: config.storage_config.redis.ssl_server_name is deprecated, please use config.storage_config.redis.server_name instead",
57-
{ after = "4.0", })
5859
return { server_name = value }
5960
end
6061
}},
6162
{ namespace = {
6263
type = "string",
6364
len_min = 0,
6465
translate_backwards = {'extra_options', 'namespace'},
66+
deprecation = {
67+
message = "acme: config.storage_config.redis.namespace is deprecated, please use config.storage_config.redis.extra_options.namespace instead",
68+
removal_in_version = "4.0", },
6569
func = function(value)
66-
deprecation("acme: config.storage_config.redis.namespace is deprecated, please use config.storage_config.redis.extra_options.namespace instead",
67-
{ after = "4.0", })
6870
return { extra_options = { namespace = value } }
6971
end
7072
}},
7173
{ scan_count = {
7274
type = "integer",
7375
translate_backwards = {'extra_options', 'scan_count'},
76+
deprecation = {
77+
message = "acme: config.storage_config.redis.scan_count is deprecated, please use config.storage_config.redis.extra_options.scan_count instead",
78+
removal_in_version = "4.0", },
7479
func = function(value)
75-
deprecation("acme: config.storage_config.redis.scan_count is deprecated, please use config.storage_config.redis.extra_options.scan_count instead",
76-
{ after = "4.0", })
7780
return { extra_options = { scan_count = value } }
7881
end
7982
}},

‎kong/plugins/rate-limiting/schema.lua

+27-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
local typedefs = require "kong.db.schema.typedefs"
22
local redis_schema = require "kong.tools.redis.schema"
3-
local deprecation = require "kong.deprecation"
43

54
local SYNC_RATE_REALTIME = -1
65

@@ -104,82 +103,91 @@ return {
104103
{ redis_host = {
105104
type = "string",
106105
translate_backwards = {'redis', 'host'},
106+
deprecation = {
107+
message = "rate-limiting: config.redis_host is deprecated, please use config.redis.host instead",
108+
removal_in_version = "4.0", },
107109
func = function(value)
108-
deprecation("rate-limiting: config.redis_host is deprecated, please use config.redis.host instead",
109-
{ after = "4.0", })
110110
return { redis = { host = value } }
111111
end
112112
} },
113113
{ redis_port = {
114114
type = "integer",
115115
translate_backwards = {'redis', 'port'},
116+
deprecation = {
117+
message = "rate-limiting: config.redis_port is deprecated, please use config.redis.port instead",
118+
removal_in_version = "4.0", },
116119
func = function(value)
117-
deprecation("rate-limiting: config.redis_port is deprecated, please use config.redis.port instead",
118-
{ after = "4.0", })
119120
return { redis = { port = value } }
120121
end
121122
} },
122123
{ redis_password = {
123124
type = "string",
124125
len_min = 0,
125126
translate_backwards = {'redis', 'password'},
127+
deprecation = {
128+
message = "rate-limiting: config.redis_password is deprecated, please use config.redis.password instead",
129+
removal_in_version = "4.0", },
126130
func = function(value)
127-
deprecation("rate-limiting: config.redis_password is deprecated, please use config.redis.password instead",
128-
{ after = "4.0", })
129131
return { redis = { password = value } }
130132
end
131133
} },
132134
{ redis_username = {
133135
type = "string",
134136
translate_backwards = {'redis', 'username'},
137+
deprecation = {
138+
message = "rate-limiting: config.redis_username is deprecated, please use config.redis.username instead",
139+
removal_in_version = "4.0", },
135140
func = function(value)
136-
deprecation("rate-limiting: config.redis_username is deprecated, please use config.redis.username instead",
137-
{ after = "4.0", })
138141
return { redis = { username = value } }
139142
end
140143
} },
141144
{ redis_ssl = {
142145
type = "boolean",
143146
translate_backwards = {'redis', 'ssl'},
147+
deprecation = {
148+
message = "rate-limiting: config.redis_ssl is deprecated, please use config.redis.ssl instead",
149+
removal_in_version = "4.0", },
144150
func = function(value)
145-
deprecation("rate-limiting: config.redis_ssl is deprecated, please use config.redis.ssl instead",
146-
{ after = "4.0", })
147151
return { redis = { ssl = value } }
148152
end
149153
} },
150154
{ redis_ssl_verify = {
151155
type = "boolean",
152156
translate_backwards = {'redis', 'ssl_verify'},
157+
deprecation = {
158+
message = "rate-limiting: config.redis_ssl_verify is deprecated, please use config.redis.ssl_verify instead",
159+
removal_in_version = "4.0", },
153160
func = function(value)
154-
deprecation("rate-limiting: config.redis_ssl_verify is deprecated, please use config.redis.ssl_verify instead",
155-
{ after = "4.0", })
156161
return { redis = { ssl_verify = value } }
157162
end
158163
} },
159164
{ redis_server_name = {
160165
type = "string",
161166
translate_backwards = {'redis', 'server_name'},
167+
deprecation = {
168+
message = "rate-limiting: config.redis_server_name is deprecated, please use config.redis.server_name instead",
169+
removal_in_version = "4.0", },
162170
func = function(value)
163-
deprecation("rate-limiting: config.redis_server_name is deprecated, please use config.redis.server_name instead",
164-
{ after = "4.0", })
165171
return { redis = { server_name = value } }
166172
end
167173
} },
168174
{ redis_timeout = {
169175
type = "integer",
170176
translate_backwards = {'redis', 'timeout'},
177+
deprecation = {
178+
message = "rate-limiting: config.redis_timeout is deprecated, please use config.redis.timeout instead",
179+
removal_in_version = "4.0", },
171180
func = function(value)
172-
deprecation("rate-limiting: config.redis_timeout is deprecated, please use config.redis.timeout instead",
173-
{ after = "4.0", })
174181
return { redis = { timeout = value } }
175182
end
176183
} },
177184
{ redis_database = {
178185
type = "integer",
179186
translate_backwards = {'redis', 'database'},
187+
deprecation = {
188+
message = "rate-limiting: config.redis_database is deprecated, please use config.redis.database instead",
189+
removal_in_version = "4.0", },
180190
func = function(value)
181-
deprecation("rate-limiting: config.redis_database is deprecated, please use config.redis.database instead",
182-
{ after = "4.0", })
183191
return { redis = { database = value } }
184192
end
185193
} },

‎kong/plugins/response-ratelimiting/schema.lua

+27-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
local typedefs = require "kong.db.schema.typedefs"
22
local redis_schema = require "kong.tools.redis.schema"
3-
local deprecation = require "kong.deprecation"
43

54
local ORDERED_PERIODS = { "second", "minute", "hour", "day", "month", "year" }
65

@@ -143,82 +142,91 @@ return {
143142
{ redis_host = {
144143
type = "string",
145144
translate_backwards = {'redis', 'host'},
145+
deprecation = {
146+
message = "response-ratelimiting: config.redis_host is deprecated, please use config.redis.host instead",
147+
removal_in_version = "4.0", },
146148
func = function(value)
147-
deprecation("response-ratelimiting: config.redis_host is deprecated, please use config.redis.host instead",
148-
{ after = "4.0", })
149149
return { redis = { host = value } }
150150
end
151151
} },
152152
{ redis_port = {
153153
type = "integer",
154154
translate_backwards = {'redis', 'port'},
155+
deprecation = {
156+
message = "response-ratelimiting: config.redis_port is deprecated, please use config.redis.port instead",
157+
removal_in_version = "4.0", },
155158
func = function(value)
156-
deprecation("response-ratelimiting: config.redis_port is deprecated, please use config.redis.port instead",
157-
{ after = "4.0", })
158159
return { redis = { port = value } }
159160
end
160161
} },
161162
{ redis_password = {
162163
type = "string",
163164
len_min = 0,
164165
translate_backwards = {'redis', 'password'},
166+
deprecation = {
167+
message = "response-ratelimiting: config.redis_password is deprecated, please use config.redis.password instead",
168+
removal_in_version = "4.0", },
165169
func = function(value)
166-
deprecation("response-ratelimiting: config.redis_password is deprecated, please use config.redis.password instead",
167-
{ after = "4.0", })
168170
return { redis = { password = value } }
169171
end
170172
} },
171173
{ redis_username = {
172174
type = "string",
173175
translate_backwards = {'redis', 'username'},
176+
deprecation = {
177+
message = "response-ratelimiting: config.redis_username is deprecated, please use config.redis.username instead",
178+
removal_in_version = "4.0", },
174179
func = function(value)
175-
deprecation("response-ratelimiting: config.redis_username is deprecated, please use config.redis.username instead",
176-
{ after = "4.0", })
177180
return { redis = { username = value } }
178181
end
179182
} },
180183
{ redis_ssl = {
181184
type = "boolean",
182185
translate_backwards = {'redis', 'ssl'},
186+
deprecation = {
187+
message = "response-ratelimiting: config.redis_ssl is deprecated, please use config.redis.ssl instead",
188+
removal_in_version = "4.0", },
183189
func = function(value)
184-
deprecation("response-ratelimiting: config.redis_ssl is deprecated, please use config.redis.ssl instead",
185-
{ after = "4.0", })
186190
return { redis = { ssl = value } }
187191
end
188192
} },
189193
{ redis_ssl_verify = {
190194
type = "boolean",
191195
translate_backwards = {'redis', 'ssl_verify'},
196+
deprecation = {
197+
message = "response-ratelimiting: config.redis_ssl_verify is deprecated, please use config.redis.ssl_verify instead",
198+
removal_in_version = "4.0", },
192199
func = function(value)
193-
deprecation("response-ratelimiting: config.redis_ssl_verify is deprecated, please use config.redis.ssl_verify instead",
194-
{ after = "4.0", })
195200
return { redis = { ssl_verify = value } }
196201
end
197202
} },
198203
{ redis_server_name = {
199204
type = "string",
200205
translate_backwards = {'redis', 'server_name'},
206+
deprecation = {
207+
message = "response-ratelimiting: config.redis_server_name is deprecated, please use config.redis.server_name instead",
208+
removal_in_version = "4.0", },
201209
func = function(value)
202-
deprecation("response-ratelimiting: config.redis_server_name is deprecated, please use config.redis.server_name instead",
203-
{ after = "4.0", })
204210
return { redis = { server_name = value } }
205211
end
206212
} },
207213
{ redis_timeout = {
208214
type = "integer",
209215
translate_backwards = {'redis', 'timeout'},
216+
deprecation = {
217+
message = "response-ratelimiting: config.redis_timeout is deprecated, please use config.redis.timeout instead",
218+
removal_in_version = "4.0", },
210219
func = function(value)
211-
deprecation("response-ratelimiting: config.redis_timeout is deprecated, please use config.redis.timeout instead",
212-
{ after = "4.0", })
213220
return { redis = { timeout = value } }
214221
end
215222
} },
216223
{ redis_database = {
217224
type = "integer",
218225
translate_backwards = {'redis', 'database'},
226+
deprecation = {
227+
message = "response-ratelimiting: config.redis_database is deprecated, please use config.redis.database instead",
228+
removal_in_version = "4.0", },
219229
func = function(value)
220-
deprecation("response-ratelimiting: config.redis_database is deprecated, please use config.redis.database instead",
221-
{ after = "4.0", })
222230
return { redis = { database = value } }
223231
end
224232
} },

0 commit comments

Comments
 (0)