Release 3.0

.dockerignore

@@ -1,22 +1,22 @@
 # Compiled output
 bin
 
+# Documentation
+docs
+
 # Version control
 .git
 .gitignore
 
 # CI/CD files.
 .github
 
-# Configuration files.
-configs.yaml
-
 # IDE Metadata
 .idea
 .vscode
 
-# Secrets
-keys
+# Configuration files.
+configs
 
 # Logs
 logs

.gitignore

@@ -5,8 +5,8 @@ bin
 .idea
 .vscode
 
-# Secrets
-keys
+# Configs
+configs/configs.yaml
 
 # Logs
 logs

.golangci.yaml

@@ -3,29 +3,46 @@ issues:
   # Issues are auto fixed.
   fix: true
 
+linters-settings:
+  gci:
+    # Section configuration to compare against.
+    # Section names are case-insensitive and may contain parameters in ().
+    # The default order of sections is `standard > default > custom > blank > dot`,
+    # If `custom-order` is `true`, it follows the order of `sections` option.
+    # Default: ["standard", "default"]
+    sections:
+      - standard # Standard section: captures all standard packages.
+      - default # Default section: contains all imports that could not be matched to another section type.
+      - prefix(github.com/shivanshkc/rosenbridge) # Custom section: groups all imports with the specified Prefix.
+      - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
+      - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
+    # Enable custom order of sections.
+    # If `true`, make the section order the same as the order of `sections`.
+    # Default: false
+    custom-order: true
+
 linters:
   # Initially all linters are enabled.
   enable-all: true
   # Following linters are disabled.
   disable:
     - deadcode
+    - depguard
     - exhaustivestruct
     - exhaustruct
-    - gci
     - gochecknoglobals
     - godox
-    - goerr113
     - golint
     - ifshort
     - interfacer
     - ireturn
     - maligned
     - nlreturn
     - nosnakecase
-    - paralleltest
     - scopelint
     - structcheck
     - tagliatelle
     - testpackage
+    - paralleltest
     - varcheck
     - wsl

Dockerfile → Containerfile

@@ -1,14 +1,14 @@
 #------------------------------------------------------------------
-FROM golang:1.17-alpine as builder
+FROM golang:1.19-alpine as builder
 
 # Update alpine.
 RUN apk update && apk upgrade
 
 # Install alpine dependencies.
 RUN apk --no-cache --update add build-base bash
 
-# Create and change to the 'project' directory.
-WORKDIR /project
+# Create and change to the 'service' directory.
+WORKDIR /service
 
 # Install project dependencies.
 COPY go.mod go.sum ./
@@ -19,18 +19,18 @@ COPY . .
 RUN make test
 
 # Build application binary.
-RUN make build-alpine
+RUN GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -v -o bin/main
 
 #-------------------------------------------------------------------
 FROM alpine:3
 
-# Create and change to the the 'project' directory.
-WORKDIR /project
+# Create and change to the the 'service' directory.
+WORKDIR /service
 
 # Copy the files to the production image from the builder stage.
-COPY --from=builder /project/bin /project/
+COPY --from=builder /service/bin /service/
 
 # Run the web service on container startup.
-CMD ["/project/main"]
+CMD ["/service/main"]
 
 #-------------------------------------------------------------------

Makefile

@@ -1,32 +1,23 @@
 SHELL=/usr/bin/env bash
 
 # Project specific properties.
-application_name           = rosenbridge
-application_binary_name    = main
+application_name        = rosenbridge
+application_binary_name = main
+
+# Container specific properties.
 application_image_name     = rosenbridge
 application_container_name = rosenbridge-1
 
 # For ProtoBuf code generation.
-proto_path=src/proto/*.proto
+proto_path=pkg/proto/*.proto
 
 # Builds the project.
-build:
-	@echo "+$@"
-	@go build -o bin/$(application_binary_name)
-
-# Builds the project for alpine linux.
-build-alpine:
+build: tidy lint
 	@echo "+$@"
-	@GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -v -o bin/main
+	@go build -o bin/$(application_binary_name) cmd/$(application_name)/main.go
 
 # Runs the project after linting and building it anew.
-run: tidy lint build
-	@echo "+$@"
-	@echo "########### Running the application binary ############"
-	@bin/$(application_binary_name)
-
-# Runs the project.
-run-only:
+run: build
 	@echo "+$@"
 	@echo "########### Running the application binary ############"
 	@bin/$(application_binary_name)
@@ -44,25 +35,22 @@ tidy:
 # Runs golang-ci-lint over the project.
 lint:
 	@echo "+$@"
-	@golangci-lint run
+	@golangci-lint run ./...
 
 # Builds the docker image for the project.
 image:
 	@echo "+$@"
-	@docker build -t $(application_image_name):latest .
+	@docker build --network host --file Containerfile --tag $(application_image_name):latest .
 
 # Runs the project container assuming the image is already built.
 container:
 	@echo "+$@"
 	@echo "############### Removing old container ################"
 	@docker rm -f $(application_container_name)
+
 	@echo "################ Running new container ################"
-	@docker run \
-		--detach \
-		--name $(application_container_name) \
-		--restart unless-stopped \
-		--net host \
-		--volume $(PWD)/configs.yaml:/etc/configs.yaml \
+	@docker run --name $(application_container_name) --detach --net host --restart unless-stopped \
+		--volume configs/configs.yaml:/etc/$(application_name)/configs.yaml \
 		$(application_image_name):latest
 
 # Generates code using the found protocol buffer files.

README.md

@@ -1,2 +1 @@
-# rosenbridge
-A distributed hub for fast asynchronous communication between machines.
+# Rosenbridge

cmd/rosenbridge/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"github.com/shivanshkc/rosenbridge/v3/internal/http"
+	"github.com/shivanshkc/rosenbridge/v3/pkg/config"
+	"github.com/shivanshkc/rosenbridge/v3/pkg/logger"
+)
+
+func main() {
+	// Initialize basic dependencies.
+	cfg := config.Load()
+	log := logger.New(cfg)
+
+	// Initialize the HTTP server.
+	server := http.Server{
+		Config:     cfg,
+		Logger:     log,
+		Middleware: &http.Middleware{Logger: log},
+	}
+
+	// This internally calls ListenAndServe.
+	// This is a blocking call and will panic if the server is unable to start.
+	server.Start()
+}

configs/configs.sample.yaml

@@ -0,0 +1,10 @@
+---
+application:
+  name: rosenbridge
+
+http_server:
+  addr: localhost:8080
+
+logger:
+  level: trace
+  pretty: true