restructured files and directories to be more organised and easier to navigate

Author: McSwitch

.gitignore

@@ -1,4 +1,3 @@
 .idea
-cmd/base.meta.go
-service/base.meta.go
+service/_base/meta.go
 build

cmd/_base/.gitkeep

@@ -0,0 +1 @@
+The base uniform implementation of the command layer, don't add, edit or remove any of these files

cmd/_base/execute.go

@@ -0,0 +1,42 @@
+package _base
+
+import (
+	"fmt"
+	"github.com/nats-io/go-nats"
+	"github.com/spf13/cobra"
+	"os"
+	service "service/service/_base"
+)
+
+var NatsUri string
+var NatsCert string
+var NatsKey string
+var DisableTls bool
+
+var RootCmd = &cobra.Command{
+	Use:   service.AppName,
+	Short: service.AppDescription,
+	Long:  service.AppDescription,
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := cmd.Help(); err != nil {
+			panic(err)
+		}
+	},
+}
+
+func init() {
+	// future: enable support for AWS EventBridge, Azure Event Grid and Google Cloud Pub/Sub support as well to migrate to simplify cloud migration
+
+	// base infrastructure command-line arguments should be included on all cobra commands hence we link it to the RootCmd
+	RootCmd.PersistentFlags().StringVarP(&NatsUri, "nats", "n", nats.DefaultURL, "The nats cluster URI")
+	RootCmd.PersistentFlags().StringVarP(&NatsCert, "nats-cert", "", "/etc/ssl/certs/ssl-bundle.crt", "The nats cluster TLS certificate file path")
+	RootCmd.PersistentFlags().StringVarP(&NatsKey, "nats-key", "", "/etc/ssl/private/ssl.key", "The nats cluster TLS key file path")
+	RootCmd.PersistentFlags().BoolVar(&DisableTls, "disable-tls", false, "A flag indicating if service should disable tls encryption")
+}
+
+func Execute() {
+	if err := RootCmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}

cmd/base.helpers.go renamed to cmd/_base/helpers.go

@@ -1,17 +1,17 @@
-package cmd
+package _base
 
 import (
 	"crypto/tls"
 	"fmt"
 	"github.com/nats-io/go-nats"
 	"github.com/spf13/cobra"
-	"service/service"
+	service "service/service/_base"
 )
 
-func compileNatsOptions() []nats.Option {
+func CompileNatsOptions() []nats.Option {
 	var natsOptions = make([]nats.Option, 0)
-	if !disableTls {
-		cert, err := tls.LoadX509KeyPair(natsCert, natsKey)
+	if !DisableTls {
+		cert, err := tls.LoadX509KeyPair(NatsCert, NatsKey)
 		if err != nil {
 			panic(err)
 		}
@@ -27,7 +27,7 @@ func compileNatsOptions() []nats.Option {
 	return natsOptions
 }
 
-func command(name string, handler func(cmd *cobra.Command, args []string), description string) *cobra.Command {
+func Command(name string, handler func(cmd *cobra.Command, args []string), description string) *cobra.Command {
 	if description == "" {
 		description = fmt.Sprintf("Request the running %s to execute the %s command", service.AppName, name)
 	}

cmd/_base/version.go

@@ -0,0 +1,23 @@
+package _base
+
+import (
+	"fmt"
+	"github.com/spf13/cobra"
+	service "service/service/_base"
+)
+
+var VersionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Show " + service.AppName + " version information",
+	Long:  "Show " + service.AppName + " version information",
+	Run:VersionHandler,
+}
+
+// we expose the version handler so that each service may modify how their version information is displayed
+var VersionHandler = func(cmd *cobra.Command, args []string) {
+	fmt.Printf("%s version %s, build %s\n", service.AppName, service.AppVersion, service.AppCommit)
+}
+
+func init() {
+	RootCmd.AddCommand(VersionCmd)
+}

cmd/base.execute.go

@@ -0,0 +1 @@
+Add your custom command-line-interface (CLI) interactions here for things like master data setup, cronjob routines, etc.

cmd/base.version.go

@@ -0,0 +1,26 @@
+package commands
+
+/* Example
+This is just an example command for reference
+*/
+
+import (
+	"github.com/spf13/cobra"
+	"service/cmd/_base"
+	service "service/service/_base"
+	"time"
+)
+
+func init() {
+	pingCmd := _base.Command("ping", func(cmd *cobra.Command, args []string) {
+		service.Command("ping", time.Second, _base.NatsUri, _base.CompileNatsOptions(), map[string]string{
+			// todo: link custom flags to arg values here, example: "custom": custom,
+		}, func(data []byte) {
+			// todo: handle response data, if any is received
+		})
+	}, "Ping the currently running service instance")
+
+	// todo: add custom CLI flags here
+
+	_base.RootCmd.AddCommand(pingCmd)
+}

cmd/command.ping.go

@@ -0,0 +1,7 @@
+package cmd
+
+import "service/cmd/_base"
+
+func Execute() {
+	_base.Execute()
+}

cmd/commands/.gitkeep

@@ -2,27 +2,35 @@ package cmd
 
 import (
 	"github.com/spf13/cobra"
-	"service/service"
+	"service/cmd/_base"
+	service "service/service/_base"
 )
 
-var runCmd = &cobra.Command{
-	Use:   "run",
-	Short: "Run " + service.AppName + " service",
-	Long:  "Run " + service.AppName + " service",
-	Run: func(cmd *cobra.Command, args []string) {
-		service.InitializeDiary(test, level, rate)
-		service.Execute(limit, test, natsUri, compileNatsOptions(), service.M{
-			// todo: add custom args here
-		})
-	},
-}
-
 func init() {
+	var level string
+	var rate int
+	var limit int
+	var test bool
+	// todo: add custom flag variables here
+
+	var runCmd = &cobra.Command{
+		Use:   "run",
+		Short: "Run " + service.AppName + " service",
+		Long:  "Run " + service.AppName + " service",
+		Run: func(cmd *cobra.Command, args []string) {
+			service.InitializeDiary(test, level, rate)
+			service.Execute(limit, test, _base.NatsUri, _base.CompileNatsOptions(), service.M{
+				// todo: link custom flags to arg values here, example: "custom": custom,
+			})
+		},
+	}
+
+	// set the service's environment configurations via many command-line-interface (CLI) arguments
 	runCmd.Flags().StringVarP(&level, "lvl", "l", "trace", "The logging level ['trace', 'debug', 'info', 'notice', 'warning', 'error', 'fatal'] that service is running in")
 	runCmd.Flags().IntVarP(&rate, "rate", "r", 1000, "The sample rate of the trace logs used for performance auditing [set to -1 to log every trace]")
 	runCmd.Flags().IntVarP(&limit, "limit", "x", 1000, "The messages per second that each topic worker will be limited to [set to 0 or less for maximum throughput]")
 	runCmd.Flags().BoolVar(&test, "test", false, "A flag indicating if service should enter into test mode")
-	runCmd.Flags().BoolVar(&disableTls, "disable-tls", false, "A flag indicating if service should disable tls encryption")
+	// todo: add custom CLI flags here
 
-	rootCmd.AddCommand(runCmd)
+	_base.RootCmd.AddCommand(runCmd)
 }

cmd/commands/ping.go

@@ -1,6 +1,8 @@
 package main
 
-import "service/cmd"
+import (
+	"service/cmd"
+)
 
 func main() {
 	cmd.Execute()

cmd/execute.go

@@ -0,0 +1 @@
+The base uniform implementation of the service layer, don't add, edit or remove any of these files

cmd/run.go

@@ -1,13 +1,14 @@
-package service
+package _base
 
 import (
 	"fmt"
 	"github.com/go-diary/diary"
 	"github.com/go-uniform/uniform"
 	"github.com/nats-io/go-nats"
+	"time"
 )
 
-func Command(cmd, natsUri string, natsOptions []nats.Option, args map[string]string) {
+func Command(cmd string, timeout time.Duration, natsUri string, natsOptions []nats.Option, args map[string]string, responseHandler func([]byte)) {
 	defer func() {
 		if r := recover(); r != nil {
 			if _, e := fmt.Printf("%v", r); e != nil {
@@ -28,9 +29,14 @@ func Command(cmd, natsUri string, natsOptions []nats.Option, args map[string]str
 	defer c.Close()
 
 	d.Page(-1, traceRate, true, AppName, nil, "", "", nil, func(p diary.IPage) {
-		p.Info(cmd, nil)
-		if err := c.Publish(p, local(command(cmd)), uniform.Request{
+		if err := c.Request(p, TargetCommand(cmd), timeout, uniform.Request{
 			Parameters: args,
+		}, func(r uniform.IRequest, p diary.IPage) {
+			if responseHandler != nil {
+				var data []byte
+				r.Read(&data)
+				responseHandler(data)
+			}
 		}); err != nil {
 			panic(err)
 		}