Support jsonc

Author: mjarkk

README.md

@@ -55,7 +55,9 @@ go install github.com/script-development/rtcv_scraper_client/[email protected]
 
 Use [gen-env](https://bitbucket.org/teamscript/cli-tools/src/main/gen-env/) to generate a `env.json` file.
 
-#### `2.1.` Mocking RTCV
+The env.json parser supports jsonc (json with comments) so you can comment out sections if you so desire and even rename the `env.json` to `env.jsonc`.
+
+#### *2.1.* Mocking RTCV
 
 When developing a scraper you might want to mock RT-CV so you don't have to relay on another service.
 

env.go

@@ -1,10 +1,80 @@
 package main
 
 import (
+	"encoding/json"
 	"errors"
 	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+
+	"muzzammil.xyz/jsonc"
 )
 
+var customEnvFileVarName = "RTCV_SCRAPER_CLIENT_ENV_FILE"
+var envAsVarName = "RTCV_SCRAPER_CLIENT_ENV"
+
+func mustReadEnv() Env {
+	envFilename := "env.json"
+	alternativeFileName := os.Getenv(customEnvFileVarName)
+	if alternativeFileName != "" {
+		envFilename = alternativeFileName
+	}
+
+	notFoundErr := func() string {
+		if alternativeFileName != "" {
+			return "no " + alternativeFileName + " file or $" + envAsVarName + " environment variable found, cannot continue"
+		}
+		return "no env.json(c) file or $" + envAsVarName + " environment variable found, cannot continue"
+	}
+
+	envFileBytes, err := ioutil.ReadFile(envFilename)
+	if err == nil {
+		return mustParseEnv(envFileBytes)
+	}
+
+	envFileBytes = []byte(os.Getenv(envAsVarName))
+	if len(envFileBytes) != 0 {
+		return mustParseEnv(envFileBytes)
+	}
+
+	if !os.IsNotExist(err) {
+		log.Fatal("unable to read env file, error: " + err.Error())
+	}
+
+	if alternativeFileName != "" {
+		log.Fatalln(notFoundErr())
+	}
+
+	envFilename = "env.jsonc"
+	envFileBytes, err = ioutil.ReadFile(envFilename)
+	if err != nil {
+		log.Fatalln(notFoundErr())
+	}
+
+	return mustParseEnv(envFileBytes)
+}
+
+func mustParseEnv(b []byte) Env {
+	envJSON := jsonc.ToJSON(b)
+	if !json.Valid(envJSON) {
+		log.Fatal("env file is not valid json or jsonc")
+	}
+
+	env := Env{}
+	err := json.Unmarshal(envJSON, &env)
+	if err != nil {
+		log.Fatal("unable to parse env file, error: " + err.Error())
+	}
+
+	err = env.validate()
+	if err != nil {
+		log.Fatal("validating env failed, error: " + err.Error())
+	}
+
+	return env
+}
+
 // Env contains the structure of an env.json file
 type Env struct {
 	PrivateKey         string      `json:"private_key"`

examples/deno/env.json renamed to examples/deno/env.jsonc

@@ -7,4 +7,5 @@
         "api_key": "bbb"
     },
     "alternative_servers": []
+    // "mock_mode": true
 }

go.mod

@@ -4,7 +4,10 @@ go 1.18
 
 require github.com/valyala/fasthttp v1.40.0
 
-require github.com/gorilla/websocket v1.5.0 // indirect
+require (
+	github.com/gorilla/websocket v1.5.0 // indirect
+	muzzammil.xyz/jsonc v1.0.0 // indirect
+)
 
 require (
 	github.com/andybalholm/brotli v1.0.4 // indirect

go.sum

@@ -33,3 +33,5 @@ golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuX
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+muzzammil.xyz/jsonc v1.0.0 h1:B6kaT3wHueZ87mPz3q1nFuM1BlL32IG0wcq0/uOsQ18=
+muzzammil.xyz/jsonc v1.0.0/go.mod h1:rFv8tUUKe+QLh7v02BhfxXEf4ZHhYD7unR93HL/1Uvo=

main.go

@@ -1,9 +1,7 @@
 package main
 
 import (
-	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"os/exec"
@@ -14,34 +12,7 @@ import (
 )
 
 func main() {
-	envFilename := "env.json"
-	alternativeFileName := os.Getenv("RTCV_SCRAPER_CLIENT_ENV_FILE")
-	if alternativeFileName != "" {
-		envFilename = alternativeFileName
-	}
-
-	envEnvName := "RTCV_SCRAPER_CLIENT_ENV"
-	envFile, err := ioutil.ReadFile(envFilename)
-	if err != nil {
-		if !os.IsNotExist(err) {
-			log.Fatal("unable to read env file, error: " + err.Error())
-		}
-		envFile = []byte(os.Getenv(envEnvName))
-		if len(envFile) == 0 {
-			log.Fatalf("no %s file or %s environment variable found, cannot continue", envFilename, envEnvName)
-		}
-	}
-
-	env := Env{}
-	err = json.Unmarshal(envFile, &env)
-	if err != nil {
-		log.Fatal("unable to parse env file, error: " + err.Error())
-	}
-
-	err = env.validate()
-	if err != nil {
-		log.Fatal("validating env failed, error: " + err.Error())
-	}
+	env := mustReadEnv()
 
 	api := NewAPI()
 
@@ -50,6 +21,7 @@ func main() {
 		credentials = append(credentials, server.toCredArg(false))
 	}
 
+	var err error
 	var loginUsers []EnvUser
 	if !env.MockMode {
 		err = api.SetCredentials(credentials)