feat(GODT-2705): added log entries for focus service on client and server sides.

(cherry picked from commit ae65385c38)

internal/focus/service.go

@@ -45,6 +45,7 @@ type Service struct {
 	raiseCh chan struct{}
 	version *semver.Version
 
+	log          *logrus.Entry
 	panicHandler async.PanicHandler
 }
 
@@ -55,13 +56,14 @@ func NewService(locator service.Locator, version *semver.Version, panicHandler a
 		server:       grpc.NewServer(),
 		raiseCh:      make(chan struct{}, 1),
 		version:      version,
+		log:          logrus.WithField("pkg", "focus/service"),
 		panicHandler: panicHandler,
 	}
 
 	proto.RegisterFocusServer(serv.server, serv)
 
 	if listener, err := net.Listen("tcp", net.JoinHostPort(Host, fmt.Sprint(0))); err != nil {
-		logrus.WithError(err).Warn("Failed to start focus serv")
+		serv.log.WithError(err).Warn("Failed to start focus service")
 	} else {
 		config := service.Config{}
 		// retrieve the port assigned by the system, so that we can put it in the config file.
@@ -71,9 +73,9 @@ func NewService(locator service.Locator, version *semver.Version, panicHandler a
 		}
 		config.Port = address.Port
 		if path, err := service.SaveGRPCServerConfigFile(locator, &config, serverConfigFileName); err != nil {
-			logrus.WithError(err).WithField("path", path).Warn("Could not write focus gRPC service config file")
+			serv.log.WithError(err).WithField("path", path).Warn("Could not write focus gRPC service config file")
 		} else {
-			logrus.WithField("path", path).Info("Successfully saved gRPC Focus service config file")
+			serv.log.WithField("path", path).Info("Successfully saved gRPC Focus service config file")
 		}
 
 		go func() {
@@ -90,12 +92,14 @@ func NewService(locator service.Locator, version *semver.Version, panicHandler a
 
 // Raise implements the gRPC FocusService interface; it raises the application.
 func (service *Service) Raise(context.Context, *emptypb.Empty) (*emptypb.Empty, error) {
+	service.log.Debug("Raise")
 	service.raiseCh <- struct{}{}
 	return &emptypb.Empty{}, nil
 }
 
 // Version implements the gRPC FocusService interface; it returns the version of the service.
 func (service *Service) Version(context.Context, *emptypb.Empty) (*proto.VersionResponse, error) {
+	service.log.Debug("Version")
 	return &proto.VersionResponse{
 		Version: service.version.Original(),
 	}, nil

internal/frontend/bridge-gui/bridge-gui/main.cpp

@@ -196,7 +196,7 @@ bool isBridgeRunning() {
 //****************************************************************************************************************************************************
 void focusOtherInstance() {
     try {
-        FocusGRPCClient client;
+        FocusGRPCClient client(app().log());
         GRPCConfig sc;
         QString const path = FocusGRPCClient::grpcFocusServerConfigPath(bridgepp::userConfigDir());
         QFile file(path);
@@ -209,7 +209,6 @@ void focusOtherInstance() {
             throw Exception("Server did not provide gRPC Focus service configuration.");
         }
 
-
         QString error;
         if (!client.connectToServer(5000, sc.port, &error)) {
             throw Exception("Could not connect to bridge focus service for a raise call.", error);
@@ -286,7 +285,9 @@ int main(int argc, char *argv[]) {
 
         initQtApplication();
 
+        CommandLineOptions const cliOptions = parseCommandLine(argc, argv);
         Log &log = initLog();
+        log.setLevel(cliOptions.logLevel);
 
         QLockFile lock(bridgepp::userCacheDir() + "/" + bridgeGUILock);
         if (!checkSingleInstance(lock)) {
@@ -294,8 +295,6 @@ int main(int argc, char *argv[]) {
             return EXIT_FAILURE;
         }
 
-        CommandLineOptions const cliOptions = parseCommandLine(argc, argv);
-
 #ifdef Q_OS_MACOS
         registerSecondInstanceHandler();
         setDockIconVisibleState(!cliOptions.noWindow);
@@ -304,7 +303,6 @@ int main(int argc, char *argv[]) {
         // In attached mode, we do not intercept stderr and stdout of bridge, as we did not launch it ourselves, so we output the log to the console.
         // When not in attached mode, log entries are forwarded to bridge, which output it on stdout/stderr. bridge-gui's process monitor intercept
         // these outputs and output them on the command-line.
-        log.setLevel(cliOptions.logLevel);
         log.info(QString("New Sentry reporter - id: %1.").arg(getProtectedHostname()));
 
         QString bridgeexec;

internal/frontend/bridge-gui/bridgepp/bridgepp/FocusGRPC/FocusGRPCClient.cpp

@@ -46,6 +46,15 @@ QString grpcFocusServerConfigFilename() {
 }
 
 
+//****************************************************************************************************************************************************
+/// \param[in] log The log.
+//****************************************************************************************************************************************************
+FocusGRPCClient::FocusGRPCClient(Log& log)
+    :log_(log) {
+
+}
+
+
 //****************************************************************************************************************************************************
 /// \return The absolute path of the focus service config path.
 //****************************************************************************************************************************************************
@@ -91,6 +100,7 @@ bool FocusGRPCClient::connectToServer(qint64 timeoutMs, quint16 port, QString *o
             throw Exception("Connexion check with focus service failed.");
         }
 
+        log_.debug(QString("Successfully connected to focus gRPC service."));
         return true;
     }
     catch (Exception const &e) {
@@ -106,6 +116,7 @@ bool FocusGRPCClient::connectToServer(qint64 timeoutMs, quint16 port, QString *o
 /// \return The status for the call.
 //****************************************************************************************************************************************************
 grpc::Status FocusGRPCClient::raise() {
+    log_.debug("FocusGRPCService::raise()");
     ClientContext ctx;
     return stub_->Raise(&ctx, empty, &empty);
 }
@@ -116,6 +127,7 @@ grpc::Status FocusGRPCClient::raise() {
 /// \return The status for the call.
 //****************************************************************************************************************************************************
 grpc::Status FocusGRPCClient::version(QString &outVersion) {
+    log_.debug("FocusGRPCService::version()");
     ClientContext ctx;
     VersionResponse response;
     Status status = stub_->Version(&ctx, empty, &response);

internal/frontend/bridge-gui/bridgepp/bridgepp/FocusGRPC/FocusGRPCClient.h

@@ -22,6 +22,7 @@
 
 #include "grpc++/grpc++.h"
 #include "focus.grpc.pb.h"
+#include "../Log/Log.h"
 
 
 namespace bridgepp {
@@ -36,7 +37,7 @@ public: // static member functions
     static QString grpcFocusServerConfigPath(QString const &configDir); ///< Return the path of the gRPC Focus server config file.
 
 public: // member functions.
-    FocusGRPCClient() = default; ///< Default constructor.
+    FocusGRPCClient(Log& log); ///< Default constructor.
     FocusGRPCClient(FocusGRPCClient const &) = delete; ///< Disabled copy-constructor.
     FocusGRPCClient(FocusGRPCClient &&) = delete; ///< Disabled assignment copy-constructor.
     ~FocusGRPCClient() = default; ///< Destructor.
@@ -48,6 +49,7 @@ public: // member functions.
     grpc::Status version(QString &outVersion); ///< Performs the 'version' call.
 
 private:
+    Log &log_; ///< The log to use for logging calls
     std::shared_ptr<grpc::Channel> channel_ { nullptr }; ///< The gRPC channel.
     std::shared_ptr<focus::Focus::Stub> stub_ { nullptr }; ///< The gRPC stub (a.k.a. client).
 };