Unverified Commit c3cdce4d authored by Fernando Takagi's avatar Fernando Takagi Committed by GitHub
Browse files

Expose custom metrics functions to runtimes (#822)

parent 91f7d3e2

go.mod

+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ require ( 
	github.com/gorilla/mux v1.8.0

	github.com/gorilla/websocket v1.4.2

	github.com/grpc-ecosystem/grpc-gateway/v2 v2.7.0

	github.com/heroiclabs/nakama-common v1.22.1-0.20220328201422-bed57ba110d8

	github.com/heroiclabs/nakama-common v1.22.1-0.20220421143658-94ea09b04aff

	github.com/jackc/pgconn v1.10.0

	github.com/jackc/pgerrcode v0.0.0-20201024163028-a0d42d470451

	github.com/jackc/pgtype v1.8.1

go.sum

+2 −2
Original line number Diff line number Diff line
@@ -255,8 +255,8 @@ github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHh 
github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=

github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=

github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=

github.com/heroiclabs/nakama-common v1.22.1-0.20220328201422-bed57ba110d8 h1:2gUIdPre/Q57HUwd+GtbSc3CucU/wqgEVpmIF5tiSto=

github.com/heroiclabs/nakama-common v1.22.1-0.20220328201422-bed57ba110d8/go.mod h1:WF4YG46afwY3ibzsXnkt3zvhQ3tBY03IYeU7xSLr8HE=

github.com/heroiclabs/nakama-common v1.22.1-0.20220421143658-94ea09b04aff h1:o0b1y1lK0Vmkmta27L/2/zUzXgFcHGtgK+jatuuFWDk=

github.com/heroiclabs/nakama-common v1.22.1-0.20220421143658-94ea09b04aff/go.mod h1:WF4YG46afwY3ibzsXnkt3zvhQ3tBY03IYeU7xSLr8HE=

github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=

github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=

github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=

server/runtime_javascript.go

+3 −3
Original line number Diff line number Diff line
@@ -1532,7 +1532,7 @@ func NewRuntimeProviderJS(logger, startupLogger *zap.Logger, db *sql.DB, protojs 
				return nil, nil

			}



			return NewRuntimeJavascriptMatchCore(logger, name, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, leaderboardRankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, streamManager, router, matchProvider.CreateMatch, eventFn, id, node, stopped, mc, modCache)

			return NewRuntimeJavascriptMatchCore(logger, name, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, leaderboardRankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, metrics, streamManager, router, matchProvider.CreateMatch, eventFn, id, node, stopped, mc, modCache)

		})



	runtimeProviderJS.newFn = func() *RuntimeJS {
@@ -1546,7 +1546,7 @@ func NewRuntimeProviderJS(logger, startupLogger *zap.Logger, db *sql.DB, protojs 
			logger.Fatal("Failed to initialize JavaScript runtime", zap.Error(err))

		}



		nakamaModule := NewRuntimeJavascriptNakamaModule(logger, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, leaderboardRankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, streamManager, router, eventFn, matchProvider.CreateMatch)

		nakamaModule := NewRuntimeJavascriptNakamaModule(logger, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, leaderboardRankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, metrics, streamManager, router, eventFn, matchProvider.CreateMatch)

		nk := runtime.ToValue(nakamaModule.Constructor(runtime))

		nkInst, err := runtime.New(nk)

		if err != nil {
@@ -1935,7 +1935,7 @@ func evalRuntimeModules(rp *RuntimeProviderJS, modCache *RuntimeJSModuleCache, m 
		return nil, nil, err

	}



	nakamaModule := NewRuntimeJavascriptNakamaModule(rp.logger, rp.db, rp.protojsonMarshaler, rp.protojsonUnmarshaler, rp.config, rp.socialClient, rp.leaderboardCache, rp.leaderboardRankCache, localCache, leaderboardScheduler, rp.sessionRegistry, rp.sessionCache, rp.matchRegistry, rp.tracker, rp.streamManager, rp.router, rp.eventFn, matchProvider.CreateMatch)

	nakamaModule := NewRuntimeJavascriptNakamaModule(rp.logger, rp.db, rp.protojsonMarshaler, rp.protojsonUnmarshaler, rp.config, rp.socialClient, rp.leaderboardCache, rp.leaderboardRankCache, localCache, leaderboardScheduler, rp.sessionRegistry, rp.sessionCache, rp.matchRegistry, rp.tracker, rp.metrics, rp.streamManager, rp.router, rp.eventFn, matchProvider.CreateMatch)

	nk := r.ToValue(nakamaModule.Constructor(r))

	nkInst, err := r.New(nk)

	if err != nil {

server/runtime_javascript_match_core.go

+2 −2
Original line number Diff line number Diff line
@@ -67,7 +67,7 @@ type RuntimeJavaScriptMatchCore struct { 
	// ctxCancelFn context.CancelFunc

}



func NewRuntimeJavascriptMatchCore(logger *zap.Logger, module string, db *sql.DB, protojsonMarshaler *protojson.MarshalOptions, protojsonUnmarshaler *protojson.UnmarshalOptions, config Config, socialClient *social.Client, leaderboardCache LeaderboardCache, rankCache LeaderboardRankCache, localCache *RuntimeJavascriptLocalCache, leaderboardScheduler LeaderboardScheduler, sessionRegistry SessionRegistry, sessionCache SessionCache, matchRegistry MatchRegistry, tracker Tracker, streamManager StreamManager, router MessageRouter, matchCreateFn RuntimeMatchCreateFunction, eventFn RuntimeEventCustomFunction, id uuid.UUID, node string, stopped *atomic.Bool, matchHandlers *jsMatchHandlers, modCache *RuntimeJSModuleCache) (RuntimeMatchCore, error) {

func NewRuntimeJavascriptMatchCore(logger *zap.Logger, module string, db *sql.DB, protojsonMarshaler *protojson.MarshalOptions, protojsonUnmarshaler *protojson.UnmarshalOptions, config Config, socialClient *social.Client, leaderboardCache LeaderboardCache, rankCache LeaderboardRankCache, localCache *RuntimeJavascriptLocalCache, leaderboardScheduler LeaderboardScheduler, sessionRegistry SessionRegistry, sessionCache SessionCache, matchRegistry MatchRegistry, tracker Tracker, metrics Metrics, streamManager StreamManager, router MessageRouter, matchCreateFn RuntimeMatchCreateFunction, eventFn RuntimeEventCustomFunction, id uuid.UUID, node string, stopped *atomic.Bool, matchHandlers *jsMatchHandlers, modCache *RuntimeJSModuleCache) (RuntimeMatchCore, error) {

	runtime := goja.New()



	jsLoggerInst, err := NewJsLogger(runtime, logger)
@@ -75,7 +75,7 @@ func NewRuntimeJavascriptMatchCore(logger *zap.Logger, module string, db *sql.DB 
		logger.Fatal("Failed to initialize JavaScript runtime", zap.Error(err))

	}



	nakamaModule := NewRuntimeJavascriptNakamaModule(logger, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, rankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, streamManager, router, eventFn, matchCreateFn)

	nakamaModule := NewRuntimeJavascriptNakamaModule(logger, db, protojsonMarshaler, protojsonUnmarshaler, config, socialClient, leaderboardCache, rankCache, localCache, leaderboardScheduler, sessionRegistry, sessionCache, matchRegistry, tracker, metrics, streamManager, router, eventFn, matchCreateFn)

	nk := runtime.ToValue(nakamaModule.Constructor(runtime))

	nkInst, err := runtime.New(nk)

	if err != nil {

server/runtime_javascript_nakama.go

+68 −1
Original line number Diff line number Diff line
@@ -69,6 +69,7 @@ type runtimeJavascriptNakamaModule struct { 
	localCache           *RuntimeJavascriptLocalCache

	leaderboardScheduler LeaderboardScheduler

	tracker              Tracker

	metrics              Metrics

	sessionRegistry      SessionRegistry

	sessionCache         SessionCache

	matchRegistry        MatchRegistry
@@ -80,7 +81,7 @@ type runtimeJavascriptNakamaModule struct { 
	eventFn       RuntimeEventCustomFunction

}



func NewRuntimeJavascriptNakamaModule(logger *zap.Logger, db *sql.DB, protojsonMarshaler *protojson.MarshalOptions, protojsonUnmarshaler *protojson.UnmarshalOptions, config Config, socialClient *social.Client, leaderboardCache LeaderboardCache, rankCache LeaderboardRankCache, localCache *RuntimeJavascriptLocalCache, leaderboardScheduler LeaderboardScheduler, sessionRegistry SessionRegistry, sessionCache SessionCache, matchRegistry MatchRegistry, tracker Tracker, streamManager StreamManager, router MessageRouter, eventFn RuntimeEventCustomFunction, matchCreateFn RuntimeMatchCreateFunction) *runtimeJavascriptNakamaModule {

func NewRuntimeJavascriptNakamaModule(logger *zap.Logger, db *sql.DB, protojsonMarshaler *protojson.MarshalOptions, protojsonUnmarshaler *protojson.UnmarshalOptions, config Config, socialClient *social.Client, leaderboardCache LeaderboardCache, rankCache LeaderboardRankCache, localCache *RuntimeJavascriptLocalCache, leaderboardScheduler LeaderboardScheduler, sessionRegistry SessionRegistry, sessionCache SessionCache, matchRegistry MatchRegistry, tracker Tracker, metrics Metrics, streamManager StreamManager, router MessageRouter, eventFn RuntimeEventCustomFunction, matchCreateFn RuntimeMatchCreateFunction) *runtimeJavascriptNakamaModule {

	return &runtimeJavascriptNakamaModule{

		logger:               logger,

		config:               config,
@@ -93,6 +94,7 @@ func NewRuntimeJavascriptNakamaModule(logger *zap.Logger, db *sql.DB, protojsonM 
		matchRegistry:        matchRegistry,

		router:               router,

		tracker:              tracker,

		metrics:              metrics,

		socialClient:         socialClient,

		leaderboardCache:     leaderboardCache,

		rankCache:            rankCache,
@@ -122,6 +124,9 @@ func (n *runtimeJavascriptNakamaModule) Constructor(r *goja.Runtime) func(goja.C 
func (n *runtimeJavascriptNakamaModule) mappings(r *goja.Runtime) map[string]func(goja.FunctionCall) goja.Value {

	return map[string]func(goja.FunctionCall) goja.Value{

		"event":                           n.event(r),

		"metricsCounterAdd":               n.metricsCounterAdd(r),

		"metricsGaugeSet":                 n.metricsGaugeSet(r),

		"metricsTimerRecord":              n.metricsTimerRecord(r),

		"uuidv4":                          n.uuidV4(r),

		"cronNext":                        n.cronNext(r),

		"sqlExec":                         n.sqlExec(r),
@@ -340,6 +345,54 @@ func (n *runtimeJavascriptNakamaModule) event(r *goja.Runtime) func(goja.Functio 
	}

}



// @group metrics

// @summary Add a custom metrics counter.

// @param name(type=string) The name of the custom metrics counter.

// @param tags(type=map[string]string) The metrics tags associated with this counter.

// @param delta(type=number) An integer value to update this metric with.

func (n *runtimeJavascriptNakamaModule) metricsCounterAdd(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {

		name := getJsString(r, f.Argument(0))

		tags := getJsStringMap(r, f.Argument(1))

		delta := getJsInt(r, f.Argument(2))

		n.metrics.CustomCounter(name, tags, delta)



		return goja.Undefined()

	}

}



// @group metrics

// @summary Add a custom metrics gauge.

// @param name(type=string) The name of the custom metrics gauge.

// @param tags(type=map[string]string) The metrics tags associated with this gauge.

// @param value(type=number) A value to update this metric with.

func (n *runtimeJavascriptNakamaModule) metricsGaugeSet(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {

		name := getJsString(r, f.Argument(0))

		tags := getJsStringMap(r, f.Argument(1))

		value := getJsFloat(r, f.Argument(2))

		n.metrics.CustomGauge(name, tags, value)



		return goja.Undefined()

	}

}



// @group metrics

// @summary Add a custom metrics timer.

// @param name(type=string) The name of the custom metrics timer.

// @param tags(type=map[string]string) The metrics tags associated with this timer.

// @param value(type=number) An integer value to update this metric with (in nanoseconds).

func (n *runtimeJavascriptNakamaModule) metricsTimerRecord(r *goja.Runtime) func(goja.FunctionCall) goja.Value {

	return func(f goja.FunctionCall) goja.Value {

		name := getJsString(r, f.Argument(0))

		tags := getJsStringMap(r, f.Argument(1))

		value := getJsInt(r, f.Argument(2))

		n.metrics.CustomTimer(name, tags, time.Duration(value))



		return goja.Undefined()

	}

}



// @group utils

// @summary Generate a version 4 UUID in the standard 36-character string representation.

// @return uuid(string) The newly generated version 4 UUID identifier string.
@@ -7489,6 +7542,20 @@ func getJsInt(r *goja.Runtime, v goja.Value) int64 { 
	return i

}



func getJsFloat(r *goja.Runtime, v goja.Value) float64 {

	e := v.Export()

	f, ok := e.(float64)

	if !ok {

		i, ok := e.(int64)

		if ok {

			return float64(i)

		} else {

			panic(r.NewTypeError("expects number"))

		}

	}

	return f

}



func getJsBool(r *goja.Runtime, v goja.Value) bool {

	b, ok := v.Export().(bool)

	if !ok {