config

Documentation

Overview

Application configurations package.

Index

• Constants
• Variables
• func PrepareTestListener(t *testing.T) net.Listener
• func PrepareTestListenerWithPort(t *testing.T, port string) net.Listener
• func PrepareTestServer(t *testing.T, listener net.Listener, handler http.Handler) *httptest.Server

Constants

const (
	// Default HTTP server port if not specified elsewhere.
	DEFAULT_PORT = "8054"

	// Default HTTP port to run Go tests.
	DEFAULT_TEST_PORT     = "8777"
	DEFAULT_TEST_SSE_PORT = "8778"

	// Time interval after that a heartbeat event of type 'message' is to be sent to connected clients/subscribers.
	HEARTBEAT_SLEEP_TIME = 20

	// Limiter's settings, limit = req per duration.
	LIMITER_REQS_NUM     = 100
	LIMITER_DURATION_SEC = 30

	// The anti-duplication const(s).
	APP_ENVIRONMENT      = "APP_ENVIRONMENT"
	APP_PORT             = "APP_PORT"
	DOCKER_INTERNAL_PORT = "DOCKER_INTERNAL_PORT"
	LIMITER_DISABLED     = "LIMITER_DISABLED"
	REGISTRATION_ENABLED = "REGISTRATION_ENABLED"
	SERVER_PORT          = "SERVER_PORT"
)

Variables

var (
	// AppEnvironment is a string variable that determines the purpose of the very instance.
	AppEnvironment string = func() string {
		if os.Getenv(APP_ENVIRONMENT) != "" {
			return os.Getenv(APP_ENVIRONMENT)
		} else {
			return "dev"
		}
	}()

	// EnchartedSW is a string variable to hold the templated ServiceWorker contents to load into the very main FE app handler.
	EnchartedSW = func() string {

		tpl, err := os.ReadFile("/opt/web/app-worker.js.tmpl")
		if err != nil {
			return ""
		}
		return fmt.Sprintf("%s", tpl)
	}()

	// IsLimiterDisabled is a feature flag for the API limiter middleware imported at the APIRouter.
	IsLimiterDisabled bool = func() bool {
		if os.Getenv(LIMITER_DISABLED) == "" {
			return false
		}
		boolVal, err := strconv.ParseBool(os.Getenv(LIMITER_DISABLED))
		if err != nil {
			return false
		}
		return boolVal
	}()

	// IsRegistrationEnabled is a boolean to hold the logic for the registration functionality.
	IsRegistrationEnabled bool = func() bool {
		if os.Getenv(REGISTRATION_ENABLED) != "" {
			boolVal, err := strconv.ParseBool(os.Getenv(REGISTRATION_ENABLED))
			if err != nil {
				return false
			}
			return boolVal
		} else {
			return true
		}
	}()

	// ServerPort is a string variable holding the TCP port where the main HTTP server is to listen for incoming connections.
	ServerPort = func() string {
		if os.Getenv(SERVER_PORT) != "" {
			return os.Getenv(SERVER_PORT)
		}

		if os.Getenv(DOCKER_INTERNAL_PORT) != "" {
			return os.Getenv(DOCKER_INTERNAL_PORT)
		}

		if os.Getenv(APP_PORT) != "" {
			return os.Getenv(APP_PORT)
		}

		return DEFAULT_PORT
	}()
)

var (
	// UsersDeletionList holds the list of acounts to be ceased from the database including their posts/polls/assets.
	// The server has to be restarted for changes to apply there. This list also prevents listed nicknames (case insensitive) to be registered.
	UserDeletionList []string = []string{
		"admin",
		"administrator",
		"caller",
		"littr",
		"moderator",
		"nickname",
		"passphrase",
		"superuser",
		"test",
		"tester",
		"user",
		"voter",
	}

	// UsersToUnshade array is used in a procedure's loop to manually unshade listed users.
	// Thus listed accounts should have a zero (0) on stats page.
	UsersToUnshade []string = []string{}
)

var (
	// NicknameLengthMax is the maximum nickname length to be allowed to register.
	NicknameLengthMax int = 12

	// MaxPostLength is the maximal length of the fully shown post in the flow. Posts longer than that are to be shorten/hidden.
	MaxPostLength int = 500
)

Functions

func PrepareTestListener

func PrepareTestListener(t *testing.T) net.Listener

Create a custom network TCP connection listener.

func PrepareTestListenerWithPort

func PrepareTestListenerWithPort(t *testing.T, port string) net.Listener

func PrepareTestServer

func PrepareTestServer(t *testing.T, listener net.Listener, handler http.Handler) *httptest.Server

Create a custom HTTP server configuration suitable to serve with the SSE streamer.