From 4cb938c57fcd5241ed0d8c0402526fbc16fc9dc9 Mon Sep 17 00:00:00 2001
From: Xavier Michelon <xavier.michelon@proton.ch>
Date: Wed, 13 Mar 2024 08:20:29 +0100
Subject: [PATCH] chore: added bridge-rollout cli tool.

---
 utils/bridge-rollout/README.md         | 20 ++++++
 utils/bridge-rollout/bridge-rollout.go | 85 ++++++++++++++++++++++++++
 2 files changed, 105 insertions(+)
 create mode 100644 utils/bridge-rollout/README.md
 create mode 100644 utils/bridge-rollout/bridge-rollout.go

diff --git a/utils/bridge-rollout/README.md b/utils/bridge-rollout/README.md
new file mode 100644
index 00000000..197a386a
--- /dev/null
+++ b/utils/bridge-rollout/README.md
@@ -0,0 +1,20 @@
+@@ -0,0 +1,10 @@
+# Vault Editor
+
+Bridge uses an encrypted vault to store persistent data. One of the parameters stored in this vault is the roll factor (between 0.0 and 1.0)
+
+It can be built with `make vault-editor` in the bridge source code root directory.
+
+Example usage:
+
+Setting the rollout value:
+```bash
+$ ./bridge-rollout set -v=0.81
+0.81
+```
+Note that the provided value will be clamped between 0 and 1.
+
+```bash
+$ ./bridge-rollout get
+0.81
+```
diff --git a/utils/bridge-rollout/bridge-rollout.go b/utils/bridge-rollout/bridge-rollout.go
new file mode 100644
index 00000000..e199e20c
--- /dev/null
+++ b/utils/bridge-rollout/bridge-rollout.go
@@ -0,0 +1,85 @@
+// Copyright (c) 2024 Proton AG
+//
+// This file is part of Proton Mail 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 main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/ProtonMail/gluon/async"
+	"github.com/ProtonMail/proton-bridge/v3/internal/app"
+	"github.com/ProtonMail/proton-bridge/v3/internal/locations"
+	"github.com/ProtonMail/proton-bridge/v3/internal/vault"
+	"github.com/ProtonMail/proton-bridge/v3/pkg/keychain"
+	"github.com/sirupsen/logrus"
+	"github.com/urfave/cli/v2"
+)
+
+func main() {
+	logrus.SetLevel(logrus.ErrorLevel)
+	app := cli.NewApp()
+
+	app.Commands = []*cli.Command{
+		{
+			Name:   "get",
+			Action: getRollout,
+			Usage:  "get the bridge rollout value",
+		},
+		{
+			Name:   "set",
+			Action: setRollout,
+			Flags: []cli.Flag{
+				&cli.Float64Flag{
+					Name:     "value",
+					Usage:    "the rollout value",
+					Required: true,
+					Aliases:  []string{"v"},
+				},
+			},
+			Usage: "set the bridge rollout value",
+		},
+	}
+	if err := app.Run(os.Args); err != nil {
+		logrus.Fatal(err)
+	}
+}
+
+func getRollout(_ *cli.Context) error {
+	return app.WithLocations(func(locations *locations.Locations) error {
+		return app.WithKeychainList(async.NoopPanicHandler{}, func(keychains *keychain.List) error {
+			return app.WithVault(locations, keychains, async.NoopPanicHandler{}, func(vault *vault.Vault, insecure, corrupt bool) error {
+				fmt.Println(vault.GetUpdateRollout())
+				return nil
+			})
+		})
+	})
+}
+
+func setRollout(c *cli.Context) error {
+	return app.WithLocations(func(locations *locations.Locations) error {
+		return app.WithKeychainList(async.NoopPanicHandler{}, func(keychains *keychain.List) error {
+			return app.WithVault(locations, keychains, async.NoopPanicHandler{}, func(vault *vault.Vault, insecure, corrupt bool) error {
+				clamped := max(0.0, min(1.0, c.Float64("value")))
+				if err := vault.SetUpdateRollout(clamped); err != nil {
+					return err
+				}
+				return getRollout(c)
+			})
+		})
+	})
+}