/
service_stream.go
208 lines (170 loc) · 5.65 KB
/
service_stream.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
// Copyright (c) 2022 Proton AG
//
// This file is part of Proton Mail Bridge.Bridge.
//
// Proton Mail Bridge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Proton Mail Bridge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.
package grpc
import (
"context"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/emptypb"
)
// RunEventStream implement the gRPC server->Client event stream.
func (s *Service) RunEventStream(request *EventStreamRequest, server Bridge_RunEventStreamServer) error {
s.log.Debug("Starting Event stream")
if s.isStreamingEvents() {
return status.Errorf(codes.AlreadyExists, "the service is already streaming") // TO-DO GODT-1667 decide if we want to kill the existing stream.
}
s.bridge.SetCurrentPlatform(request.ClientPlatform)
s.createEventStreamChannel()
s.eventStreamDoneCh = make(chan struct{})
// TO-DO GODT-1667 We should have a safer we to close this channel? What if an event occur while we are closing?
defer func() {
close(s.eventStreamCh)
s.deleteEventStreamChannel()
close(s.eventStreamDoneCh)
s.eventStreamDoneCh = nil
}()
// if events occurred before streaming started, they've been queued. Now that the stream channel is available
// we can flush the queued
go func() {
s.eventQueueMutex.Lock()
defer s.eventQueueMutex.Unlock()
for _, event := range s.eventQueue {
s.eventStreamCh <- event
}
s.eventQueue = nil
}()
for {
select {
case <-s.eventStreamDoneCh:
s.log.Debug("Stop Event stream")
return nil
case event := <-s.eventStreamCh:
s.log.WithField("event", event).Debug("Sending event")
if err := server.Send(event); err != nil {
s.log.Debug("Stop Event stream")
return err
}
case <-server.Context().Done():
s.log.Info("Client closed the stream, initiating shutdown")
s.quit()
return nil
}
}
}
// StopEventStream stops the event stream.
func (s *Service) StopEventStream(_ context.Context, _ *emptypb.Empty) (*emptypb.Empty, error) {
return &emptypb.Empty{}, s.stopEventStream()
}
func (s *Service) stopEventStream() error {
s.eventStreamChMutex.RLock()
defer s.eventStreamChMutex.RUnlock()
if s.eventStreamCh == nil {
return status.Errorf(codes.NotFound, "The service is not streaming")
}
s.eventStreamDoneCh <- struct{}{}
return nil
}
// SendEvent sends an event to the via the gRPC event stream.
func (s *Service) SendEvent(event *StreamEvent) error {
if !s.isStreamingEvents() { // nobody is connected to the event stream, we queue events
s.queueEvent(event)
return nil
}
s.eventStreamCh <- event
return nil
}
// StartEventTest sends all the known event via gRPC.
func (s *Service) StartEventTest() error { //nolint:funlen
const dummyAddress = "dummy@proton.me"
events := []*StreamEvent{
// app
NewInternetStatusEvent(true),
NewToggleAutostartFinishedEvent(),
NewResetFinishedEvent(),
NewReportBugFinishedEvent(),
NewReportBugSuccessEvent(),
NewReportBugErrorEvent(),
NewShowMainWindowEvent(),
// login
NewLoginError(LoginErrorType_FREE_USER, "error"),
NewLoginTfaRequestedEvent(dummyAddress),
NewLoginTwoPasswordsRequestedEvent(),
NewLoginFinishedEvent("userID"),
NewLoginAlreadyLoggedInEvent("userID"),
// update
NewUpdateErrorEvent(UpdateErrorType_UPDATE_SILENT_ERROR),
NewUpdateManualReadyEvent("2.0"),
NewUpdateManualRestartNeededEvent(),
NewUpdateForceEvent("2.0"),
NewUpdateSilentRestartNeededEvent(),
NewUpdateIsLatestVersionEvent(),
NewUpdateCheckFinishedEvent(),
// cache
NewCacheErrorEvent(CacheErrorType_CACHE_UNAVAILABLE_ERROR),
NewCacheLocationChangeSuccessEvent(),
NewCacheChangeLocalCacheFinishedEvent(true),
NewIsCacheOnDiskEnabledChanged(true),
NewDiskCachePathChanged("/dummy/path"),
// mail settings
NewMailSettingsErrorEvent(MailSettingsErrorType_IMAP_PORT_ISSUE),
NewMailSettingsUseSslForSmtpFinishedEvent(),
NewMailSettingsChangePortFinishedEvent(),
// keychain
NewKeychainChangeKeychainFinishedEvent(),
NewKeychainHasNoKeychainEvent(),
NewKeychainRebuildKeychainEvent(),
// mail
NewMailNoActiveKeyForRecipientEvent(dummyAddress),
NewMailAddressChangeEvent(dummyAddress),
NewMailAddressChangeLogoutEvent(dummyAddress),
NewMailApiCertIssue(),
// user
NewUserToggleSplitModeFinishedEvent("userID"),
NewUserDisconnectedEvent("username"),
NewUserChangedEvent("userID"),
}
for _, event := range events {
if err := s.SendEvent(event); err != nil {
return err
}
}
return nil
}
func (s *Service) queueEvent(event *StreamEvent) {
s.eventQueueMutex.Lock()
defer s.eventQueueMutex.Unlock()
if event.isInternetStatus() {
s.eventQueue = append(filterOutInternetStatusEvents(s.eventQueue), event)
} else {
s.eventQueue = append(s.eventQueue, event)
}
}
func (s *Service) isStreamingEvents() bool {
s.eventStreamChMutex.RLock()
defer s.eventStreamChMutex.RUnlock()
return s.eventStreamCh != nil
}
func (s *Service) createEventStreamChannel() {
s.eventStreamChMutex.Lock()
defer s.eventStreamChMutex.Unlock()
s.eventStreamCh = make(chan *StreamEvent)
}
func (s *Service) deleteEventStreamChannel() {
s.eventStreamChMutex.Lock()
defer s.eventStreamChMutex.Unlock()
s.eventStreamCh = nil
}