Unverified Commit 18a2c1ef authored by Simon Esposito's avatar Simon Esposito Committed by GitHub
Browse files

Implement JavaScript runtime (#473) 

Add support for JavaScript as a runtime language.
Loads an index.js file found in the module folder.
parent ef6c266d

go.mod

+5 −2
Original line number Diff line number Diff line
@@ -10,10 +10,13 @@ require ( 
	github.com/cznic/mathutil v0.0.0-20181122101859-297441e03548 // indirect

	github.com/cznic/strutil v0.0.0-20181122101858-275e90344537 // indirect

	github.com/dgrijalva/jwt-go v3.2.1-0.20200107013213-dc14462fd587+incompatible

	github.com/dlclark/regexp2 v1.4.0 // indirect

	github.com/dop251/goja v0.0.0-20201212162034-be0895b77e07

	github.com/facebookgo/ensure v0.0.0-20160127193407-b4ab57deab51 // indirect

	github.com/facebookgo/stack v0.0.0-20160209184415-751773369052 // indirect

	github.com/facebookgo/subset v0.0.0-20150612182917-8dac2c3c4870 // indirect

	github.com/glycerine/go-unsnap-stream v0.0.0-20190901134440-81cf024a9e0a // indirect

	github.com/go-sourcemap/sourcemap v2.1.3+incompatible // indirect

	github.com/go-sql-driver/mysql v1.4.1 // indirect

	github.com/gobuffalo/packr v1.30.1

	github.com/gofrs/uuid v0.0.0-20190510204422-abfe1881e60e
@@ -22,7 +25,7 @@ require ( 
	github.com/gorilla/mux v1.7.4

	github.com/gorilla/websocket v1.4.2

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

	github.com/heroiclabs/nakama-common v1.10.1-0.20201216111513-63718253d289

	github.com/heroiclabs/nakama-common v1.10.1-0.20201216142705-136e6c0d214f

	github.com/jackc/fake v0.0.0-20150926172116-812a484cc733 // indirect

	github.com/jackc/pgx v3.5.0+incompatible

	github.com/jmhodges/levigo v1.0.0 // indirect
@@ -49,7 +52,7 @@ require ( 
	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9

	golang.org/x/net v0.0.0-20200925080053-05aa5d4ee321 // indirect

	golang.org/x/sys v0.0.0-20200926100807-9d91bd62050c // indirect

	// golang.org/x/sys v0.0.0-20200803210538-64077c9b5642

	golang.org/x/text v0.3.4 // indirect

	google.golang.org/genproto v0.0.0-20201019141844-1ed22bb0c154

	google.golang.org/grpc v1.33.1

	google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.0.0

go.sum

+10 −4
Original line number Diff line number Diff line
@@ -91,6 +91,10 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c 
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

github.com/dgrijalva/jwt-go v3.2.1-0.20200107013213-dc14462fd587+incompatible h1:CiQ/hJK0Lsc/2Gm9uMSIe7cFE+h0sbTwHuTGQkIZpio=

github.com/dgrijalva/jwt-go v3.2.1-0.20200107013213-dc14462fd587+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=

github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E=

github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc=

github.com/dop251/goja v0.0.0-20201212162034-be0895b77e07 h1:Fn066OGb3xiuFSljnjA5gq7zzNj/4Df2St727lGnhMI=

github.com/dop251/goja v0.0.0-20201212162034-be0895b77e07/go.mod h1:Mw6PkjjMXWbTj+nnj4s3QPXq1jaT0s5pC0iFD4+BOAA=

github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=

github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=

github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
@@ -114,6 +118,8 @@ github.com/glycerine/goconvey v0.0.0-20190410193231-58a59202ab31/go.mod h1:Ogl1T 
github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU=

github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=

github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=

github.com/go-sourcemap/sourcemap v2.1.3+incompatible h1:W1iEw64niKVGogNgBN3ePyLFfuisuzeidWPMPWmECqU=

github.com/go-sourcemap/sourcemap v2.1.3+incompatible/go.mod h1:F8jJfvm2KbVjc5NqelyYJmf/v5J0dwNLS2mL4sNA1Jg=

github.com/go-sql-driver/mysql v1.4.1 h1:g24URVg0OFbNUTx9qqY1IRZ9D9z3iPyi5zKhQZpNwpA=

github.com/go-sql-driver/mysql v1.4.1/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=

github.com/gobuffalo/envy v1.7.0 h1:GlXgaiBkmrYMHco6t4j7SacKO4XUjvh5pwXh0f4uxXU=
@@ -199,10 +205,8 @@ github.com/grpc-ecosystem/grpc-gateway/v2 v2.0.1/go.mod h1:oVMjMN64nzEcepv1kdZKg 
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.10.0 h1:Vpp0Jhhgd+I+Z6f0vFQskJxY3wSnY7U+l1hS242S9nI=

github.com/heroiclabs/nakama-common v1.10.0/go.mod h1:li7bMQwOYA0NjT3DM4NKQBNruULPa2hrqdiSaaTwui4=

github.com/heroiclabs/nakama-common v1.10.1-0.20201216111513-63718253d289 h1:ahqYHVClvF9F1UaS/Slg3J8T1Q3IloFgzgAGigAapEs=

github.com/heroiclabs/nakama-common v1.10.1-0.20201216111513-63718253d289/go.mod h1:li7bMQwOYA0NjT3DM4NKQBNruULPa2hrqdiSaaTwui4=

github.com/heroiclabs/nakama-common v1.10.1-0.20201216142705-136e6c0d214f h1:RTKN7L8sWQjsyBEv4fW65MsHbLxnO/NbgR/l+M3uaF4=

github.com/heroiclabs/nakama-common v1.10.1-0.20201216142705-136e6c0d214f/go.mod h1:li7bMQwOYA0NjT3DM4NKQBNruULPa2hrqdiSaaTwui4=

github.com/hpcloud/tail v1.0.0 h1:nfCOvKYfkgYP8hkirhJocXT2+zOD8yUNjXaWfTlyFKI=

github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=

github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
@@ -455,6 +459,8 @@ golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= 
golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=

golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=

golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

golang.org/x/text v0.3.4 h1:0YWbFKbhXG/wIiuHDSKpS0Iy7FSA+u45VtBMfQcFTTc=

golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=

golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=

golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=

server/config.go

+92 −33
Original line number Diff line number Diff line
@@ -181,17 +181,29 @@ func CheckConfig(logger *zap.Logger, config Config) map[string]string { 
			logger.Fatal("Bad database connection URL", zap.String("database.address", address), zap.Error(err))

		}

	}

	if config.GetRuntime().MinCount < 0 {

		logger.Fatal("Minimum runtime instance count must be >= 0", zap.Int("runtime.min_count", config.GetRuntime().MinCount))

	if config.GetRuntime().GetLuaMinCount() < 0 {

		logger.Fatal("Minimum Lua runtime instance count must be >= 0", zap.Int("runtime.lua_min_count", config.GetRuntime().GetLuaMinCount()))

	}

	if config.GetRuntime().MaxCount < 1 {

		logger.Fatal("Maximum runtime instance count must be >= 1", zap.Int("runtime.max_count", config.GetRuntime().MaxCount))

	if config.GetRuntime().GetLuaMaxCount() < 1 {

		logger.Fatal("Maximum Lua runtime instance count must be >= 1", zap.Int("runtime.lua_max_count", config.GetRuntime().GetLuaMinCount()))

	}

	if config.GetRuntime().MinCount > config.GetRuntime().MaxCount {

		logger.Fatal("Minimum runtime instance count must be less than or equal to maximum runtime instance count", zap.Int("runtime.min_count", config.GetRuntime().MinCount), zap.Int("runtime.max_count", config.GetRuntime().MaxCount))

	if config.GetRuntime().GetLuaMinCount() > config.GetRuntime().GetLuaMaxCount() {

		logger.Fatal("Minimum Lua runtime instance count must be less than or equal to maximum Lua runtime instance count", zap.Int("runtime.lua_min_count", config.GetRuntime().GetLuaMinCount()), zap.Int("runtime.lua_max_count", config.GetRuntime().GetLuaMaxCount()))

	}

	if config.GetRuntime().CallStackSize < 1 {

		logger.Fatal("Runtime instance call stack size must be >= 1", zap.Int("runtime.call_stack_size", config.GetRuntime().CallStackSize))

	if config.GetRuntime().GetLuaCallStackSize() < 1 {

		logger.Fatal("Lua runtime instance call stack size must be >= 1", zap.Int("runtime.lua_call_stack_size", config.GetRuntime().GetLuaCallStackSize()))

	}

	if config.GetRuntime().GetLuaRegistrySize() < 128 {

		logger.Fatal("Lua runtime instance registry size must be >= 128", zap.Int("runtime.registry_size", config.GetRuntime().GetLuaRegistrySize()))

	}

	if config.GetRuntime().JsMinCount < 0 {

		logger.Fatal("Minimum JavaScript runtime instance count must be >= 0", zap.Int("runtime.js_min_count", config.GetRuntime().JsMinCount))

	}

	if config.GetRuntime().JsMaxCount < 1 {

		logger.Fatal("Maximum JavaScript runtime instance count must be >= 1", zap.Int("runtime.js_max_count", config.GetRuntime().JsMinCount))

	}

	if config.GetRuntime().JsMinCount > config.GetRuntime().JsMaxCount {

		logger.Fatal("Minimum JavaScript runtime instance count must be less than or equal to maximum JavaScript runtime instance count", zap.Int("runtime.js_min_count", config.GetRuntime().JsMinCount), zap.Int("runtime.js_max_count", config.GetRuntime().JsMaxCount))

	}

	if config.GetRuntime().EventQueueSize < 1 {

		logger.Fatal("Runtime event queue stack size must be >= 1", zap.Int("runtime.event_queue_size", config.GetRuntime().EventQueueSize))
@@ -199,9 +211,6 @@ func CheckConfig(logger *zap.Logger, config Config) map[string]string { 
	if config.GetRuntime().EventQueueWorkers < 1 {

		logger.Fatal("Runtime event queue workers must be >= 1", zap.Int("runtime.event_queue_workers", config.GetRuntime().EventQueueWorkers))

	}

	if config.GetRuntime().RegistrySize < 128 {

		logger.Fatal("Runtime instance registry size must be >= 128", zap.Int("runtime.registry_size", config.GetRuntime().RegistrySize))

	}

	if config.GetMatch().InputQueueSize < 1 {

		logger.Fatal("Match input queue size must be >= 1", zap.Int("match.input_queue_size", config.GetMatch().InputQueueSize))

	}
@@ -647,13 +656,60 @@ type RuntimeConfig struct { 
	Env                []string          `yaml:"env" json:"env" usage:"Values to pass into Runtime as environment variables."`

	Path               string            `yaml:"path" json:"path" usage:"Path for the server to scan for Lua and Go library files."`

	HTTPKey            string            `yaml:"http_key" json:"http_key" usage:"Runtime HTTP Invocation key."`

	MinCount          int               `yaml:"min_count" json:"min_count" usage:"Minimum number of runtime instances to allocate. Default 16."`

	MaxCount          int               `yaml:"max_count" json:"max_count" usage:"Maximum number of runtime instances to allocate. Default 48."`

	CallStackSize     int               `yaml:"call_stack_size" json:"call_stack_size" usage:"Size of each runtime instance's call stack. Default 128."`

	RegistrySize      int               `yaml:"registry_size" json:"registry_size" usage:"Size of each runtime instance's registry. Default 512."`

	MinCount           int               `yaml:"min_count" json:"min_count" usage:"Minimum number of Lua runtime instances to allocate. Default 16."` // Kept for backwards compatibility

	LuaMinCount        int               `yaml:"lua_min_count" json:"lua_min_count" usage:"Minimum number of Lua runtime instances to allocate. Default 16."`

	MaxCount           int               `yaml:"max_count" json:"max_count" usage:"Maximum number of Lua runtime instances to allocate. Default 48."` // Kept for backwards compatibility

	LuaMaxCount        int               `yaml:"lua_max_count" json:"lua_max_count" usage:"Maximum number of Lua runtime instances to allocate. Default 48."`

	JsMinCount         int               `yaml:"js_min_count" json:"js_min_count" usage:"Maximum number of Javascript runtime instances to allocate. Default 48."`

	JsMaxCount         int               `yaml:"js_max_count" json:"js_max_count" usage:"Maximum number of Javascript runtime instances to allocate. Default 48."`

	CallStackSize      int               `yaml:"call_stack_size" json:"call_stack_size" usage:"Size of each runtime instance's call stack. Default 128."` // Kept for backwards compatibility

	LuaCallStackSize   int               `yaml:"lua_call_stack_size" json:"lua_call_stack_size" usage:"Size of each runtime instance's call stack. Default 128."`

	RegistrySize       int               `yaml:"registry_size" json:"registry_size" usage:"Size of each Lua runtime instance's registry. Default 512."` // Kept for backwards compatibility

	LuaRegistrySize    int               `yaml:"lua_registry_size" json:"lua_registry_size" usage:"Size of each Lua runtime instance's registry. Default 512."`

	EventQueueSize     int               `yaml:"event_queue_size" json:"event_queue_size" usage:"Size of the event queue buffer. Default 65536."`

	EventQueueWorkers  int               `yaml:"event_queue_workers" json:"event_queue_workers" usage:"Number of workers to use for concurrent processing of events. Default 8."`

	ReadOnlyGlobals   bool              `yaml:"read_only_globals" json:"read_only_globals" usage:"When enabled marks all Lua runtime global tables as read-only to reduce memory footprint. Default true."`

	ReadOnlyGlobals    bool              `yaml:"read_only_globals" json:"read_only_globals" usage:"When enabled marks all Lua runtime global tables as read-only to reduce memory footprint. Default true."` // Kept for backwards compatibility

	LuaReadOnlyGlobals bool              `yaml:"lua_read_only_globals" json:"lua_read_only_globals" usage:"When enabled marks all Lua runtime global tables as read-only to reduce memory footprint. Default true."`

}



// Function to allow backwards compatibility for MinCount config

func (r *RuntimeConfig) GetLuaMinCount() int {

	if r.MinCount != 0 {

		return r.MinCount

	}

	return r.LuaMinCount

}



// Function to allow backwards compatibility for MaxCount config

func (r *RuntimeConfig) GetLuaMaxCount() int {

	if r.MaxCount != 0 {

		return r.MaxCount

	}

	return r.LuaMaxCount

}



// Function to allow backwards compatibility for CallStackSize config

func (r *RuntimeConfig) GetLuaCallStackSize() int {

	if r.CallStackSize != 0 {

		return r.CallStackSize

	}

	return r.LuaCallStackSize

}



// Function to allow backwards compatibility for RegistrySize config

func (r *RuntimeConfig) GetLuaRegistrySize() int {

	if r.RegistrySize != 0 {

		return r.RegistrySize

	}

	return r.LuaRegistrySize

}



// Function to allow backwards compatibility for LuaReadOnlyGlobals config

func (r *RuntimeConfig) GetLuaReadOnlyGlobals() bool {

	if r.ReadOnlyGlobals != true {

		return r.ReadOnlyGlobals

	}

	return r.LuaReadOnlyGlobals

}



// NewRuntimeConfig creates a new RuntimeConfig struct.
@@ -663,13 +719,16 @@ func NewRuntimeConfig() *RuntimeConfig { 
		Env:                make([]string, 0),

		Path:               "",

		HTTPKey:            "defaulthttpkey",

		MinCount:          16,

		MaxCount:          48,

		CallStackSize:     128,

		RegistrySize:      512,

		LuaMinCount:        16,

		LuaMaxCount:        48,

		LuaCallStackSize:   128,

		LuaRegistrySize:    512,

		JsMinCount:         16,

		JsMaxCount:         32,

		EventQueueSize:     65536,

		EventQueueWorkers:  8,

		ReadOnlyGlobals:    true,

		LuaReadOnlyGlobals: true,

	}

}

server/metrics.go

+12 −1
Original line number Diff line number Diff line
@@ -17,12 +17,13 @@ package server 
import (

	"context"

	"fmt"

	"go.uber.org/atomic"

	"io"

	"net/http"

	"strings"

	"time"



	"go.uber.org/atomic"



	"github.com/gorilla/handlers"

	"github.com/uber-go/tally"

	"github.com/uber-go/tally/prometheus"
@@ -267,6 +268,16 @@ func (m *Metrics) GaugeRuntimes(value float64) { 
	m.prometheusScope.Gauge("lua_runtimes").Update(value)

}



// Set the absolute value of currently allocated Lua runtime VMs.

func (m *Metrics) GaugeLuaRuntimes(value float64) {

	m.prometheusScope.Gauge("lua_runtimes").Update(value)

}



// Set the absolute value of currently allocated JavaScript runtime VMs.

func (m *Metrics) GaugeJsRuntimes(value float64) {

	m.prometheusScope.Gauge("javascript_runtimes").Update(value)

}



// Set the absolute value of currently running authoritative matches.

func (m *Metrics) GaugeAuthoritativeMatches(value float64) {

	m.prometheusScope.Gauge("authoritative_matches").Update(value)

server/runtime.go

+781 −146

File changed.

Preview size limit exceeded, changes collapsed.