Silverfish/proton-bridge
1
0
Fork 1
mirror of https://github.com/ProtonMail/proton-bridge.git synced 2025-12-10 04:36:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat(GODT-2556): Add functional test for Heartbeat Init and telemetry availability.

Browse Source
This commit is contained in:
Romain LE JEUNE
2023-04-21 10:06:01 +02:00
committed by Romain Le Jeune
parent 4adc6d60b9
commit d3fc9a50f6
8 changed files with 150 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
internal/app/app.go
View File

@ -268,6 +268,7 @@ func run(c *cli.Context) error {
logrus.Warn("The vault is corrupt and has been wiped")
b.PushError(bridge.ErrVaultCorrupt)
}
// Start telemetry heartbeat process
b.StartHeartbeat(b)

30
internal/bridge/heartbeat.go
View File

@ -83,18 +83,6 @@ func (bridge *Bridge) SetLastHeartbeatSent(timestamp time.Time) error {
func (bridge *Bridge) StartHeartbeat(manager telemetry.HeartbeatManager) {
bridge.heartbeat = telemetry.NewHeartbeat(manager, 1143, 1025, bridge.GetGluonCacheDir(), keychain.DefaultHelper)
safe.RLock(func() {
var splitMode = false
for _, user := range bridge.users {
if user.GetAddressMode() == vault.SplitMode {
splitMode = true
break
}
}
bridge.heartbeat.SetNbAccount(len(bridge.users))
bridge.heartbeat.SetSplitMode(splitMode)
}, bridge.usersLock)
bridge.heartbeat.SetRollout(bridge.GetUpdateRollout())
bridge.heartbeat.SetAutoStart(bridge.GetAutostart())
bridge.heartbeat.SetAutoUpdate(bridge.GetAutoUpdate())
@ -113,5 +101,21 @@ func (bridge *Bridge) StartHeartbeat(manager telemetry.HeartbeatManager) {
}
bridge.heartbeat.SetPrevVersion(bridge.GetLastVersion().String())
bridge.heartbeat.TrySending()
safe.RLock(func() {
var splitMode = false
for _, user := range bridge.users {
if user.GetAddressMode() == vault.SplitMode {
splitMode = true
break
}
}
var nbAccount = len(bridge.users)
bridge.heartbeat.SetNbAccount(nbAccount)
bridge.heartbeat.SetSplitMode(splitMode)
// Do not try to send if there is no user yet.
if nbAccount > 0 {
bridge.heartbeat.TrySending()
}
}, bridge.usersLock)
}

9
internal/bridge/settings.go
View File

@ -300,7 +300,14 @@ func (bridge *Bridge) GetTelemetryDisabled() bool {
}
func (bridge *Bridge) SetTelemetryDisabled(isDisabled bool) error {
return bridge.vault.SetTelemetryDisabled(isDisabled)
if err := bridge.vault.SetTelemetryDisabled(isDisabled); err != nil {
return err
}
// If telemetry is re-enabled locally, try to send the heartbeat.
if !isDisabled {
bridge.heartbeat.TrySending()
}
return nil
}
func (bridge *Bridge) GetUpdateChannel() updater.Channel {

8
internal/telemetry/heartbeat.go
View File

@ -157,7 +157,13 @@ func (heartbeat *Heartbeat) TrySending() {
heartbeat.log.WithFields(logrus.Fields{
"metrics": heartbeat.metrics,
}).Error("Failed to send heartbeat")
} else if err := heartbeat.manager.SetLastHeartbeatSent(now); err != nil {
return
}
heartbeat.log.WithFields(logrus.Fields{
"metrics": heartbeat.metrics,
}).Debug("Heartbeat sent")
if err := heartbeat.manager.SetLastHeartbeatSent(now); err != nil {
heartbeat.log.WithError(err).Warn("Cannot save last heartbeat sent to the vault.")
}
}

11
tests/bdd_test.go
View File

@ -135,9 +135,14 @@ func TestFeatures(testingT *testing.T) {
ctx.Step(`^bridge stops$`, s.bridgeStops)
ctx.Step(`^bridge is version "([^"]*)" and the latest available version is "([^"]*)" reachable from "([^"]*)"$`, s.bridgeVersionIsAndTheLatestAvailableVersionIsReachableFrom)
ctx.Step(`^the user has disabled automatic updates$`, s.theUserHasDisabledAutomaticUpdates)
ctx.Step(`^the user has disabled automatic start`, s.theUserHasDisabledAutomaticStart)
ctx.Step(`^the user has enabled alternative routing`, s.theUserHasEnabledAlternativeRouting)
ctx.Step(`^the user set IMAP mode to SSL`, s.theUserSetIMAPModeToSSL)
ctx.Step(`^the user set SMTP mode to SSL`, s.theUserSetSMTPModeToSSL)
ctx.Step(`^the user changes the IMAP port to (\d+)$`, s.theUserChangesTheIMAPPortTo)
ctx.Step(`^the user changes the SMTP port to (\d+)$`, s.theUserChangesTheSMTPPortTo)
ctx.Step(`^the user sets the address mode of user "([^"]*)" to "([^"]*)"$`, s.theUserSetsTheAddressModeOfUserTo)
ctx.Step(`^the user changes the default keychain application`, s.theUserChangesTheDefaultKeychainApplication)
ctx.Step(`^the user changes the gluon path$`, s.theUserChangesTheGluonPath)
ctx.Step(`^the user deletes the gluon files$`, s.theUserDeletesTheGluonFiles)
ctx.Step(`^the user deletes the gluon cache$`, s.theUserDeletesTheGluonCache)
@ -234,9 +239,9 @@ func TestFeatures(testingT *testing.T) {
// ==== TELEMETRY ====
ctx.Step(`^bridge eventually sends the following heartbeat:$`, s.bridgeEventuallySendsTheFollowingHeartbeat)
ctx.Step(`^bridge needs to send heartbeat$`, s.bridgeNeedsToSendHeartbeat)
ctx.Step(`^bridge do not need to send heartbeat$`, s.bridgeDoNotNeedToSendHeartbeat)
ctx.Step(`^heartbeat is not whitelisted$`, s.heartbeatIsNotwhitelisted)
ctx.Step(`^bridge needs to send heartbeat`, s.bridgeNeedsToSendHeartbeat)
ctx.Step(`^bridge do not need to send heartbeat`, s.bridgeDoNotNeedToSendHeartbeat)
ctx.Step(`^heartbeat is not whitelisted`, s.heartbeatIsNotwhitelisted)
},
Options: &godog.Options{
Format: "pretty",

23
tests/bridge_test.go
View File

@ -80,6 +80,10 @@ func (s *scenario) theUserSetsTheAddressModeOfUserTo(user, mode string) error {
}
}
func (s *scenario) theUserChangesTheDefaultKeychainApplication() error {
return s.t.bridge.SetKeychainApp("CustomKeychainApp")
}
func (s *scenario) theUserChangesTheGluonPath() error {
gluonDir, err := os.MkdirTemp(s.t.dir, "gluon")
if err != nil {
@ -118,7 +122,6 @@ func (s *scenario) theUserHasDisabledAutomaticUpdates() error {
started = true
}
if err := s.t.bridge.SetAutoUpdate(false); err != nil {
return err
}
@ -128,10 +131,26 @@ func (s *scenario) theUserHasDisabledAutomaticUpdates() error {
return err
}
}
return nil
}
func (s *scenario) theUserHasDisabledAutomaticStart() error {
return s.t.bridge.SetAutostart(false)
}
func (s *scenario) theUserHasEnabledAlternativeRouting() error {
s.t.expectProxyCtlAllowProxy()
return s.t.bridge.SetProxyAllowed(true)
}
func (s *scenario) theUserSetIMAPModeToSSL() error {
return s.t.bridge.SetIMAPSSL(true)
}
func (s *scenario) theUserSetSMTPModeToSSL() error {
return s.t.bridge.SetSMTPSSL(true)
}
func (s *scenario) theUserReportsABug() error {
return s.t.bridge.ReportBug(context.Background(), "osType", "osVersion", "description", "username", "email", "client", false)
}

4
tests/ctx_bridge_test.go
View File

@ -175,6 +175,7 @@ func (t *testCtx) initBridge() (<-chan events.Event, error) {
t.bridge = bridge
t.heartbeat.setBridge(bridge)
bridge.StartHeartbeat(t.heartbeat)
return t.events.collectFrom(eventCh), nil
@ -344,6 +345,9 @@ func (t *testCtx) closeFrontendClient() error {
return nil
}
func (t *testCtx) expectProxyCtlAllowProxy() {
t.mocks.ProxyCtl.EXPECT().AllowProxy()
}
type mockRestarter struct{}

85
tests/features/bridge/heartbeat.feature
View File

@ -4,7 +4,7 @@ Feature: Send Telemetry Heartbeat
And bridge starts
Scenario: Send at first start - one user
Scenario: Send at first start - one user default settings
Then bridge telemetry feature is enabled
And bridge needs to send heartbeat
When the user logs in with username "[user:user1]" and password "password"
@ -37,6 +37,89 @@ Feature: Send Telemetry Heartbeat
"""
And bridge do not need to send heartbeat
Scenario: Send at first start - one user modified settings
Then bridge telemetry feature is enabled
And bridge needs to send heartbeat
When the user has disabled automatic updates
And the user has disabled automatic start
And the user has enabled alternative routing
And the user hides All Mail
And the user set IMAP mode to SSL
And the user set SMTP mode to SSL
And the user changes the IMAP port to 42695
And the user changes the SMTP port to 56942
And the user changes the gluon path
And the user changes the default keychain application
When the user logs in with username "[user:user1]" and password "password"
And user "[user:user1]" finishes syncing
Then bridge eventually sends the following heartbeat:
"""
{
"MeasurementGroup": "bridge.any.usage",
"Event": "bridge_heartbeat",
"Values": {
"nb_account": 1
},
"Dimensions": {
"auto_update": "off",
"auto_start": "off",
"beta": "off",
"doh": "on",
"split_mode": "off",
"show_all_mail": "off",
"imap_connection_mode": "ssl",
"smtp_connection_mode": "ssl",
"imap_port": "custom",
"smtp_port": "custom",
"cache_location": "custom",
"keychain_pref": "custom",
"prev_version": "0.0.0",
"rollout": 42
}
}
"""
And bridge do not need to send heartbeat
Scenario: Send at first start - one user telemetry disabled
Then bridge telemetry feature is enabled
And bridge needs to send heartbeat
When the user disables telemetry in bridge settings
And the user logs in with username "[user:user1]" and password "password"
And user "[user:user1]" finishes syncing
And bridge needs to send heartbeat
Then the user sets the address mode of user "[user:user1]" to "split"
And the user enables telemetry in bridge settings
Then bridge eventually sends the following heartbeat:
"""
{
"MeasurementGroup": "bridge.any.usage",
"Event": "bridge_heartbeat",
"Values": {
"nb_account": 1
},
"Dimensions": {
"auto_update": "on",
"auto_start": "on",
"beta": "off",
"doh": "off",
"split_mode": "on",
"show_all_mail": "on",
"imap_connection_mode": "starttls",
"smtp_connection_mode": "starttls",
"imap_port": "default",
"smtp_port": "default",
"cache_location": "default",
"keychain_pref": "default",
"prev_version": "0.0.0",
"rollout": 42
}
}
"""
And bridge do not need to send heartbeat
Scenario: GroupMeasurement rejected by API
Given heartbeat is not whitelisted
Then bridge telemetry feature is enabled