| // Copyright 2020 Google LLC |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain p copy of the License at |
| // |
| // https://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| |
| package wire |
| |
| import ( |
| "context" |
| "fmt" |
| "time" |
| |
| "golang.org/x/xerrors" |
| |
| vkit "cloud.google.com/go/pubsublite/apiv1" |
| gax "github.com/googleapis/gax-go/v2" |
| pb "google.golang.org/genproto/googleapis/cloud/pubsublite/v1" |
| ) |
| |
| // partitionCountReceiver receives updated partition counts. Calls are |
| // non-overlapping. |
| type partitionCountReceiver func(partitionCount int) |
| |
| // partitionCountWatcher periodically retrieves the number of partitions for a |
| // topic and notifies a receiver if it changes. |
| type partitionCountWatcher struct { |
| // Immutable after creation. |
| ctx context.Context |
| adminClient *vkit.AdminClient |
| topicPath string |
| receiver partitionCountReceiver |
| callOption gax.CallOption |
| initialTimeout time.Duration |
| pollPeriod time.Duration |
| |
| // Fields below must be guarded with mu. |
| partitionCount int |
| pollUpdate *periodicTask |
| |
| abstractService |
| } |
| |
| func newPartitionCountWatcher(ctx context.Context, adminClient *vkit.AdminClient, |
| settings PublishSettings, topicPath string, receiver partitionCountReceiver) *partitionCountWatcher { |
| |
| p := &partitionCountWatcher{ |
| ctx: ctx, |
| adminClient: adminClient, |
| topicPath: topicPath, |
| receiver: receiver, |
| callOption: resourceExhaustedRetryer(), |
| initialTimeout: settings.Timeout, |
| pollPeriod: settings.ConfigPollPeriod, |
| } |
| |
| // Polling the topic partition count can be disabled in settings if the period |
| // is <= 0. |
| backgroundTask := p.updatePartitionCount |
| if settings.ConfigPollPeriod <= 0 { |
| backgroundTask = func() {} |
| } |
| p.pollUpdate = newPeriodicTask(settings.ConfigPollPeriod, backgroundTask) |
| return p |
| } |
| |
| // Start retrieves the first topic partition count asynchronously. |
| func (p *partitionCountWatcher) Start() { |
| p.mu.Lock() |
| defer p.mu.Unlock() |
| |
| if p.unsafeUpdateStatus(serviceStarting, nil) { |
| go p.updatePartitionCount() |
| } |
| } |
| |
| // Stop background polling for partition count updates. |
| func (p *partitionCountWatcher) Stop() { |
| p.mu.Lock() |
| defer p.mu.Unlock() |
| p.unsafeInitiateShutdown(nil) |
| } |
| |
| // updatePartitionCount is called in a goroutine. |
| func (p *partitionCountWatcher) updatePartitionCount() { |
| p.mu.Lock() |
| prevPartitionCount := p.partitionCount |
| p.mu.Unlock() |
| |
| newPartitionCount, err := func() (int, error) { |
| // Ensure the first update respects PublishSettings.Timeout. |
| timeout := p.initialTimeout |
| if prevPartitionCount > 0 { |
| timeout = p.pollPeriod |
| } |
| cctx, cancel := context.WithCancel(p.ctx) |
| rt := newRequestTimer(timeout, cancel, ErrBackendUnavailable) |
| |
| req := &pb.GetTopicPartitionsRequest{Name: p.topicPath} |
| resp, err := p.adminClient.GetTopicPartitions(cctx, req, p.callOption) |
| rt.Stop() |
| |
| p.mu.Lock() |
| defer p.mu.Unlock() |
| |
| if p.status >= serviceTerminating { |
| // Returning the current partition count here ensures that the receiver |
| // func will not be invoked below. |
| return p.partitionCount, nil |
| } |
| if err != nil { |
| if p.partitionCount > 0 { |
| // Ignore errors after the first update. |
| // TODO: Log the error. |
| return p.partitionCount, nil |
| } |
| err = xerrors.Errorf("pubsublite: failed to update topic partition count: %w", rt.ResolveError(err)) |
| p.unsafeInitiateShutdown(err) |
| return 0, err |
| } |
| if resp.GetPartitionCount() <= 0 { |
| err := fmt.Errorf("pubsublite: topic has invalid number of partitions %d", resp.GetPartitionCount()) |
| p.unsafeInitiateShutdown(err) |
| return 0, err |
| } |
| |
| p.partitionCount = int(resp.GetPartitionCount()) |
| return p.partitionCount, nil |
| }() |
| |
| if err == nil && prevPartitionCount != newPartitionCount { |
| p.receiver(newPartitionCount) |
| |
| if prevPartitionCount == 0 { |
| p.onStartupComplete() |
| } |
| } |
| } |
| |
| func (p *partitionCountWatcher) onStartupComplete() { |
| p.mu.Lock() |
| defer p.mu.Unlock() |
| |
| // Set the watcher as active and start background polling updates after the |
| // initial partition count has been processed. |
| if p.unsafeUpdateStatus(serviceActive, nil) { |
| p.pollUpdate.Start() |
| } |
| } |
| |
| func (p *partitionCountWatcher) unsafeInitiateShutdown(err error) { |
| if p.unsafeUpdateStatus(serviceTerminated, err) { |
| p.pollUpdate.Stop() |
| } |
| } |