Add instrumentation code for SSO

backend/app/adapter/facebook/instrumentation.go

@@ -0,0 +1,9 @@
+package facebook
+
+import (
+	"github.com/short-d/short/backend/app/usecase/instrumentation"
+)
+
+func NewInstrumentationFactory() instrumentation.SSOInstrumentation {
+	return instrumentation.NewSSO("facebook")
+}

backend/app/adapter/facebook/sso.go

@@ -2,6 +2,8 @@ package facebook
 
 import "github.com/short-d/short/backend/app/usecase/sso"
 
+const ProviderName = "facebook"
+
 // AccountLinker links user's Facebook account with Short account.
 type AccountLinker sso.AccountLinker
 

backend/app/adapter/github/instrumentation.go

@@ -0,0 +1,9 @@
+package github
+
+import (
+	"github.com/short-d/short/backend/app/usecase/instrumentation"
+)
+
+func NewInstrumentation() instrumentation.SSO {
+	return instrumentation.NewSSO("github")
+}

backend/app/adapter/github/sso.go

@@ -2,6 +2,8 @@ package github
 
 import "github.com/short-d/short/backend/app/usecase/sso"
 
+const ProviderName = "github"
+
 // AccountLinker links user's Github account with Short account.
 type AccountLinker sso.AccountLinker
 

backend/app/adapter/google/instrumentation.go

@@ -0,0 +1,9 @@
+package google
+
+import (
+	"github.com/short-d/short/backend/app/usecase/instrumentation"
+)
+
+func NewInstrumentation() instrumentation.SSO {
+	return instrumentation.NewSSO("google")
+}

backend/app/adapter/google/sso.go

@@ -2,6 +2,8 @@ package google
 
 import "github.com/short-d/short/backend/app/usecase/sso"
 
+const ProviderName = "google"
+
 // AccountLinker links user's Google account with Short account.
 type AccountLinker sso.AccountLinker
 

backend/app/adapter/request/instrumentationfactory.go

@@ -0,0 +1,25 @@
+package request
+
+import (
+	"github.com/short-d/app/fw/analytics"
+	"github.com/short-d/app/fw/logger"
+	"github.com/short-d/app/fw/metrics"
+	"github.com/short-d/app/fw/timer"
+	"github.com/short-d/short/backend/app/usecase/keygen"
+)
+
+type SSOInstrumentationFactory struct {
+	ssoProviderName string
+	keyGen          keygen.KeyGenerator
+	logger          logger.Logger
+	timer           timer.Timer
+	metrics         metrics.Metrics
+	analytics       analytics.Analytics
+	client          Client
+}
+
+// NewInstrumentationcFactory creates Instrumentation factory.
+func NewSSOInstrumentationFactory(
+	provider string) SSOInstrumentationFactory {
+	return SSOInstrumentationFactory{}
+}

backend/app/adapter/routing/handle/sso_signin.go

@@ -1,6 +1,7 @@
 package handle
 
 import (
+	"github.com/short-d/short/backend/app/adapter/request"
 	"net/http"
 	"net/url"
 
@@ -10,8 +11,10 @@ import (
 
 // SSOSignIn redirects user to the sign in page.
 func SSOSignIn(
+	instrumentationFactory request.InstrumentationFactory,
 	singleSignOn sso.SingleSignOn,
 	webFrontendURL string,
+	provider string,
 ) router.Handle {
 	return func(w http.ResponseWriter, r *http.Request, params router.Params) {
 		token := getToken(params)
@@ -20,6 +23,7 @@ func SSOSignIn(
 			return
 		}
 		signInLink := singleSignOn.GetSignInLink()
+		//insert instrumentation
 		http.Redirect(w, r, signInLink, http.StatusSeeOther)
 	}
 }

backend/app/adapter/routing/route.go

@@ -20,6 +20,7 @@ import (
 // NewShort creates HTTP routing table.
 func NewShort(
 	instrumentationFactory request.InstrumentationFactory,
+	ssoInstrumentationFactory request.SSOInstrumentationFactory,
 	webFrontendURL string,
 	timer timer.Timer,
 	shortLinkRetriever shortlink.Retriever,
@@ -41,8 +42,10 @@ func NewShort(
 			Method: "GET",
 			Path:   "/oauth/github/sign-in",
 			Handle: handle.SSOSignIn(
+				instrumentationFactory,
 				sso.SingleSignOn(githubSSO),
 				webFrontendURL,
+				github.ProviderName,
 			),
 		},
 		{
@@ -57,8 +60,10 @@ func NewShort(
 			Method: "GET",
 			Path:   "/oauth/facebook/sign-in",
 			Handle: handle.SSOSignIn(
+				instrumentationFactory,
 				sso.SingleSignOn(facebookSSO),
 				webFrontendURL,
+				facebook.ProviderName,
 			),
 		},
 		{
@@ -67,14 +72,17 @@ func NewShort(
 			Handle: handle.SSOSignInCallback(
 				sso.SingleSignOn(facebookSSO),
 				*frontendURL,
+				facebook.ProviderName,
 			),
 		},
 		{
 			Method: "GET",
 			Path:   "/oauth/google/sign-in",
 			Handle: handle.SSOSignIn(
+				instrumentationFactory,
 				sso.SingleSignOn(googleSSO),
 				webFrontendURL,
+				google.ProviderName,
 			),
 		},
 		{

backend/app/usecase/instrumentation/instrumentation.go

@@ -180,6 +180,7 @@ func NewInstrumentation(
 	searchFailedCh := make(chan ctx.ExecutionContext)
 	madeFeatureDecisionCh := make(chan ctx.ExecutionContext)
 	trackCh := make(chan ctx.ExecutionContext)
+	ssoSignIn := make(chan ctx.ExecutionContext)
 
 	ins := &Instrumentation{
 		logger:                          logger,
@@ -210,6 +211,7 @@ func NewInstrumentation(
 		go func() { searchFailedCh <- c }()
 		go func() { madeFeatureDecisionCh <- c }()
 		go func() { trackCh <- c }()
+		go func() { ssoSignIn <- c }()
 		close(ctxCh)
 	}()
 	return *ins

backend/app/usecase/instrumentation/sso.go

@@ -0,0 +1,54 @@
+package instrumentation
+
+import (
+	"fmt"
+	"github.com/short-d/app/fw/analytics"
+	"github.com/short-d/app/fw/ctx"
+	"github.com/short-d/app/fw/logger"
+	"github.com/short-d/app/fw/metrics"
+	"github.com/short-d/app/fw/timer"
+	"github.com/short-d/short/backend/app/usecase/keygen"
+)
+
+type SSOInstrumentation struct {
+	event     string
+	keyGen    keygen.KeyGenerator
+	logger    logger.Logger
+	timer     timer.Timer
+	metrics   metrics.Metrics
+	analytics analytics.Analytics
+	ssoSignIn chan ctx.ExecutionContext
+}
+
+func (i SSOInstrumentation) StartingSSO() {
+}
+
+func (i SSOInstrumentation) UserAlreadySignedIn() {
+
+}
+
+func (i SSOInstrumentation) RetrievingAuthToken() {
+
+}
+
+func (i SSOInstrumentation) SignInFailed() {
+
+}
+
+func (i SSOInstrumentation) SignInSucceeded() {
+
+}
+
+func (i SSOInstrumentation) VerifyingAuthToken(token string) {
+	i.logger.Info("Checking if auth token exists")
+}
+
+func (i SSOInstrumentation) RedirectingUserToSignInLink(signInLink string) {
+
+}
+
+func NewSSO(providerName string) SSOInstrumentation {
+	return SSOInstrumentation{
+		event: fmt.Sprintf("%s-SSO", providerName),
+	}
+}

backend/app/usecase/sso/sso.go

@@ -2,7 +2,6 @@ package sso
 
 import (
 	"errors"
-
 	"github.com/short-d/short/backend/app/usecase/authenticator"
 )
 

backend/dep/provider/facebook.go

@@ -3,6 +3,7 @@ package provider
 import (
 	"github.com/short-d/app/fw/webreq"
 	"github.com/short-d/short/backend/app/adapter/facebook"
+	"github.com/short-d/short/backend/app/adapter/request"
 	"github.com/short-d/short/backend/app/adapter/sqldb"
 	"github.com/short-d/short/backend/app/usecase/sso"
 )
@@ -36,6 +37,10 @@ func NewFacebookAccountLinker(
 	return facebook.AccountLinker(factory.NewAccountLinker(facebookSSORepo))
 }
 
+func NewInstrumentationFactory() request.InstrumentationFactory {
+
+}
+
 // NewFacebookSSO creates FacebookSingleSignOn.
 func NewFacebookSSO(
 	ssoFactory sso.Factory,
@@ -47,6 +52,7 @@ func NewFacebookSSO(
 		ssoFactory.NewSingleSignOn(
 			identityProvider,
 			account,
-			sso.AccountLinker(linker)),
+			sso.AccountLinker(linker),
+			facebook.NewInstrumentation()),
 	)
 }

backend/dep/provider/github.go

@@ -44,6 +44,7 @@ func NewGithubSSO(
 			identityProvider,
 			account,
 			sso.AccountLinker(accountLinker),
+			github.NewInstrumentationFactory(),
 		),
 	)
 }

backend/dep/provider/google.go

@@ -47,7 +47,8 @@ func NewGoogleSSO(
 		ssoFactory.NewSingleSignOn(
 			identityProvider,
 			account,
-			sso.AccountLinker(linker)),
+			sso.AccountLinker(linker),
+			google.NewInstrumentationFactory()),
 	)
 }
 

backend/dep/wire.go

@@ -72,6 +72,7 @@ var observabilitySet = wire.NewSet(
 	network.NewProxy,
 	request.NewClient,
 	request.NewInstrumentationFactory,
+	request.NewSSOInstrumentationFactory,
 )
 
 var githubAPISet = wire.NewSet(