Implement log wrappers for all versions of gocb and gocbcore (#5039)

* Combine all gocb loggers into a shared method

* Work around vet false-positive for const equality checks.

See github.com/golang/go/issues/28446 for detail

* Move gocb log level equality checking to a test

Author: bbrks

base/logger_external.go

@@ -15,16 +15,22 @@ import (
 	"os"
 
 	"github.com/couchbase/clog"
+	"github.com/couchbase/gocb"
+	"github.com/couchbase/gocbcore"
 	"github.com/couchbase/goutils/logging"
-	"gopkg.in/couchbase/gocb.v1"
-	"gopkg.in/couchbase/gocbcore.v7"
+	gocbv1 "gopkg.in/couchbase/gocb.v1"
+	gocbcorev7 "gopkg.in/couchbase/gocbcore.v7"
 )
 
 // This file implements wrappers around the loggers of external packages
 // so that all of SG's logging output is consistent
 func initExternalLoggers() {
 	gocb.SetLogger(GoCBLogger{})
 	gocbcore.SetLogger(GoCBCoreLogger{})
+
+	gocbv1.SetLogger(GoCBV1Logger{})
+	gocbcorev7.SetLogger(GoCBCoreV7Logger{})
+
 	logging.SetLogger(CBGoUtilsLogger{})
 	clog.SetLoggerCallback(ClogCallback)
 }
@@ -44,7 +50,7 @@ var _ gocb.Logger = GoCBLogger{}
 //   Debug  -> SG Trace
 //   Trace  -> SG Trace
 //   Others -> no-op
-func (GoCBLogger) Log(level gocb.LogLevel, _ int, format string, v ...interface{}) error {
+func (GoCBLogger) Log(level gocb.LogLevel, offset int, format string, v ...interface{}) error {
 	switch level {
 	case gocb.LogError:
 		logTo(context.TODO(), LevelError, KeyAll, KeyGoCB.String()+": "+format, v...)
@@ -58,33 +64,22 @@ func (GoCBLogger) Log(level gocb.LogLevel, _ int, format string, v ...interface{
 	return nil
 }
 
-// ******************************************************
-// Implementation of github.com/couchbase/gocbcore.Logger
-// ******************************************************
+type GoCBV1Logger struct{}
 type GoCBCoreLogger struct{}
+type GoCBCoreV7Logger struct{}
 
+var _ gocbv1.Logger = GoCBV1Logger{}
 var _ gocbcore.Logger = GoCBCoreLogger{}
+var _ gocbcorev7.Logger = GoCBCoreV7Logger{}
 
-// Log wraps the levelled SG logs for gocbcore to use.
-// Log levels are mapped as follows:
-//   Error  -> SG Error
-//   Warn   -> SG Warn
-//   Info   -> SG Debug
-//   Debug  -> SG Trace
-//   Trace  -> SG Trace
-//   Others -> no-op
-func (GoCBCoreLogger) Log(level gocbcore.LogLevel, _ int, format string, v ...interface{}) error {
-	switch level {
-	case gocbcore.LogError:
-		logTo(context.TODO(), LevelError, KeyAll, KeyGoCB.String()+": "+format, v...)
-	case gocbcore.LogWarn:
-		logTo(context.TODO(), LevelWarn, KeyAll, KeyGoCB.String()+": "+format, v...)
-	case gocbcore.LogInfo:
-		logTo(context.TODO(), LevelDebug, KeyGoCB, format, v...)
-	case gocbcore.LogDebug, gocbcore.LogTrace:
-		logTo(context.TODO(), LevelTrace, KeyGoCB, format, v...)
-	}
-	return nil
+func (GoCBV1Logger) Log(level gocbv1.LogLevel, offset int, format string, v ...interface{}) error {
+	return GoCBLogger{}.Log(gocb.LogLevel(level), offset, format, v...)
+}
+func (GoCBCoreLogger) Log(level gocbcore.LogLevel, offset int, format string, v ...interface{}) error {
+	return GoCBLogger{}.Log(gocb.LogLevel(level), offset, format, v...)
+}
+func (GoCBCoreV7Logger) Log(level gocbcorev7.LogLevel, offset int, format string, v ...interface{}) error {
+	return GoCBLogger{}.Log(gocb.LogLevel(level), offset, format, v...)
 }
 
 // ******************************************************

base/logger_external_test.go

@@ -0,0 +1,35 @@
+package base
+
+import (
+	"testing"
+
+	"github.com/couchbase/gocb"
+	"github.com/couchbase/gocbcore"
+	"github.com/stretchr/testify/assert"
+	gocbv1 "gopkg.in/couchbase/gocb.v1"
+	gocbcorev7 "gopkg.in/couchbase/gocbcore.v7"
+)
+
+func TestGoCBLogLevelEquality(t *testing.T) {
+	// Ensures all gocb and gocbcore log levels match between versions.
+	// If they don't, we'll need to revisit the log wrappers to not just do direct type conversions to implement 4 loggers.
+	assert.Equal(t, gocb.LogError, gocb.LogLevel(gocbcore.LogError))
+	assert.Equal(t, gocb.LogError, gocb.LogLevel(gocbv1.LogError))
+	assert.Equal(t, gocb.LogError, gocb.LogLevel(gocbcorev7.LogError))
+
+	assert.Equal(t, gocb.LogWarn, gocb.LogLevel(gocbcore.LogWarn))
+	assert.Equal(t, gocb.LogWarn, gocb.LogLevel(gocbv1.LogWarn))
+	assert.Equal(t, gocb.LogWarn, gocb.LogLevel(gocbcorev7.LogWarn))
+
+	assert.Equal(t, gocb.LogInfo, gocb.LogLevel(gocbcore.LogInfo))
+	assert.Equal(t, gocb.LogInfo, gocb.LogLevel(gocbv1.LogInfo))
+	assert.Equal(t, gocb.LogInfo, gocb.LogLevel(gocbcorev7.LogInfo))
+
+	assert.Equal(t, gocb.LogDebug, gocb.LogLevel(gocbcore.LogDebug))
+	assert.Equal(t, gocb.LogDebug, gocb.LogLevel(gocbv1.LogDebug))
+	assert.Equal(t, gocb.LogDebug, gocb.LogLevel(gocbcorev7.LogDebug))
+
+	assert.Equal(t, gocb.LogTrace, gocb.LogLevel(gocbcore.LogTrace))
+	assert.Equal(t, gocb.LogTrace, gocb.LogLevel(gocbv1.LogTrace))
+	assert.Equal(t, gocb.LogTrace, gocb.LogLevel(gocbcorev7.LogTrace))
+}