-
Notifications
You must be signed in to change notification settings - Fork 766
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for forwarding Nexus HTTP requests (#5793)
## What changed? <!-- Describe what has changed in this PR --> * Added a new component `cluster.HttpClientCache` which serves a similar purpose to our gRPC `ClientBean` but provides HTTP clients for remote clusters. * Added logic to forward Nexus requests from standby clusters to active. * Exposed frontend `namespace.Registry` from our test `temporalImpl` so that tests can use `Eventually` functions to wait for namespace data to be updated in-memory without having to use `time.Sleep` ## Why? <!-- Tell your future self why have you made these changes --> So that Nexus requests can be forwarded across clusters. ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> New unit and functional tests.
- Loading branch information
Showing
14 changed files
with
862 additions
and
62 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| // The MIT License | ||
| // | ||
| // Copyright (c) 2024 Temporal Technologies Inc. All rights reserved. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
|
|
||
| package cluster | ||
|
|
||
| import ( | ||
| "crypto/tls" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
|
|
||
| "go.temporal.io/api/serviceerror" | ||
|
|
||
| "go.temporal.io/server/common/collection" | ||
| ) | ||
|
|
||
| type tlsConfigProvider interface { | ||
| GetRemoteClusterClientConfig(hostname string) (*tls.Config, error) | ||
| } | ||
|
|
||
| type FrontendHTTPClient struct { | ||
| http.Client | ||
| Address string | ||
| } | ||
|
|
||
| type FrontendHTTPClientCache struct { | ||
| metadata Metadata | ||
| tlsProvider tlsConfigProvider | ||
| clients *collection.FallibleOnceMap[string, *FrontendHTTPClient] | ||
| } | ||
|
|
||
| func NewFrontendHTTPClientCache( | ||
| metadata Metadata, | ||
| tlsProvider tlsConfigProvider, | ||
| ) *FrontendHTTPClientCache { | ||
| cache := &FrontendHTTPClientCache{ | ||
| metadata: metadata, | ||
| tlsProvider: tlsProvider, | ||
| } | ||
| cache.clients = collection.NewFallibleOnceMap(cache.newClientForCluster) | ||
| metadata.RegisterMetadataChangeCallback(cache, cache.evictionCallback) | ||
| return cache | ||
| } | ||
|
|
||
| // Get returns a cached HttpClient if available, or constructs a new one for the given cluster name. | ||
| func (c *FrontendHTTPClientCache) Get(targetClusterName string) (*FrontendHTTPClient, error) { | ||
| return c.clients.Get(targetClusterName) | ||
| } | ||
|
|
||
| func (c *FrontendHTTPClientCache) newClientForCluster(targetClusterName string) (*FrontendHTTPClient, error) { | ||
| targetInfo, ok := c.metadata.GetAllClusterInfo()[targetClusterName] | ||
| if !ok { | ||
| return nil, serviceerror.NewNotFound(fmt.Sprintf("could not find cluster metadata for cluster %s", targetClusterName)) | ||
| } | ||
|
|
||
| address, err := url.Parse(targetInfo.HTTPAddress) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| client := http.Client{} | ||
|
|
||
| if c.tlsProvider != nil { | ||
| tlsClientConfig, err := c.tlsProvider.GetRemoteClusterClientConfig(address.Hostname()) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| client.Transport = &http.Transport{TLSClientConfig: tlsClientConfig} | ||
| } | ||
|
|
||
| return &FrontendHTTPClient{ | ||
| Address: targetInfo.HTTPAddress, | ||
| Client: client, | ||
| }, nil | ||
| } | ||
|
|
||
| // evictionCallback is invoked by cluster.Metadata when cluster information changes. | ||
| // It invalidates clients which are either no longer present or have had their HTTP address changed. | ||
| // It is assumed that TLS information has not changed for clusters that are unmodified. | ||
| func (c *FrontendHTTPClientCache) evictionCallback(oldClusterMetadata map[string]*ClusterInformation, newClusterMetadata map[string]*ClusterInformation) { | ||
| for oldClusterName, oldClusterInfo := range oldClusterMetadata { | ||
| if oldClusterName == c.metadata.GetCurrentClusterName() || oldClusterInfo == nil { | ||
| continue | ||
| } | ||
|
|
||
| newClusterInfo, exists := newClusterMetadata[oldClusterName] | ||
| if !exists || oldClusterInfo.HTTPAddress != newClusterInfo.HTTPAddress { | ||
| // Cluster was removed or had its HTTP address changed, so invalidate the cached client for that cluster. | ||
| client, ok := c.clients.Pop(oldClusterName) | ||
| if ok { | ||
| client.CloseIdleConnections() | ||
| } | ||
| } | ||
| } | ||
| } |
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
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
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
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
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
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
Oops, something went wrong.