fix!: Remove mutating 'addInterceptor' methods from client config #901
Conversation
| @@ -106,6 +106,8 @@ class SwiftWriter( | |||
|
|
|||
| fun addImport(symbol: Symbol) { | |||
| symbol.references.forEach { addImport(it.symbol) } | |||
| val additionalImports = symbol.getProperty("additionalImports").getOrElse { emptyList<Symbol>() } as List<Symbol> | |||
| additionalImports.forEach { addImport(it) } | |||
There was a problem hiding this comment.
Additional imports were moved from the bottom to the top of this method because the early-exit on line 111 below causes additional imports to not be added when the enclosing type of the symbol is a Swift built-in.
(This was preventing the needed imports from being rendered for the symbols [ClientRuntime.InterceptorProvider] and [ClientRuntime.HttpInterceptorProvider].)
| /// | ||
| /// - Parameter provider: The `InterceptorProvider` to add. | ||
| func addInterceptorProvider(_ provider: InterceptorProvider) | ||
|
|
There was a problem hiding this comment.
The add methods are removed from this & the following default config protocols
| FunctionParameter.NoLabel("provider", ClientRuntimeTypes.Core.InterceptorProvider) | ||
| ), | ||
| ) | ||
| ) |
There was a problem hiding this comment.
Codegen of the add methods into client config is removed here & in the file below.
| /** | ||
| * The methods to render in the generated client configuration | ||
| */ | ||
| fun getMethods(ctx: ProtocolGenerator.GenerationContext): Set<Function> = setOf() |
There was a problem hiding this comment.
This was only used for the add interceptor methods, so it is now removed.
|
Closing in favor of an alternate approach |
Description of changes
Removes the
addInterceptorProvidermethods from client config for both interceptors & HTTP interceptors. The purpose of this change is to remove mutating methods from client config types.Interceptors may be added by using the
interceptorProviderandhttpInterceptorProviderparams on the config initializer.This is technically a breaking change because it removes a means of adding interceptors to a client config. Impact is expected to be minimal because (1) customers are likely not providing their own interceptors, and (2) there is an alternate, non-mutating method (described above) to add interceptors.
Scope
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.