refactor(*): refactor configuration

Author: vm-001

.github/workflows/release-test.yml

@@ -17,7 +17,7 @@ jobs:
         run: |
           docker compose up -d
           sleep 10
-          STATUS_CODE=$(curl -o /dev/null -s -w "%{http_code}" http://localhost:8080)
+          STATUS_CODE=$(curl -o /dev/null -s -w "%{http_code}" http://localhost:9601)
           if [ "$STATUS_CODE" -ne 200 ]; then
             echo "API failed with status code $STATUS_CODE"
             exit 1

.github/workflows/test.yml

@@ -1,5 +1,8 @@
 name: Test
 
+permissions:
+  contents: read
+
 on:
   pull_request:
     paths-ignore:
@@ -13,59 +16,78 @@ on:
       - '**/*.gif'
 
 jobs:
-  unit-tests:
+  tests-unit:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v4
-
     - uses: actions/setup-go@v5
       with:
         go-version-file: go.mod
-
-    - name: run tests
-      run: make test-coverage
-
-    - name: upload coverage reselt to Codecov
+    - name: runs tests
+      run: |
+        make test-unit FLAGS=-coverprofile=coverage.txt
+        cat coverage.txt
+    - name: uploads coverage reselt
       uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         fail_ci_if_error: true
         flags: unit
 
-    services:
-      httpbin:
-        image: kennethreitz/httpbin
-        ports:
-          - 9999:80
-
-  integration-tests:
+  tests-integration-main:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
-
-      - name: start dependencies
+      - name: starts dependencies
         run: |
           mkdir -p test/output/otel
           sudo chmod 777 -R test/output/otel
           make test-deps
           sleep 3
           docker compose -f test/docker-compose.yml logs
-
-      - name: install
+      - name: installs webhookx
         run: make install
-
+      - name: installs ginkgo
+        run: go install github.com/onsi/ginkgo/v2/ginkgo
       - name: run tests
-        run: make test-integration-coverage
-
-      - name: upload coverage reselt to Codecov
+        run: |
+          make test-main FLAGS="-coverpkg=github.com/webhookx-io/webhookx/... --cover --coverprofile=coverage.txt"
+          cat coverage.txt
+      - name: upload coverage reselt
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
           flags: integration
+
+  tests-integration-o11:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+      - name: starts dependencies
+        run: |
+          mkdir -p test/output/otel
+          sudo chmod 777 -R test/output/otel
+          make test-deps
+          sleep 3
+          docker compose -f test/docker-compose.yml logs
+      - name: installs webhookx
+        run: make install
+      - name: install ginkgo
+        run: go install github.com/onsi/ginkgo/v2/ginkgo
+      - name: run tests
+        run: |
+          make test-o11 FLAGS="-coverpkg=github.com/webhookx-io/webhookx/... --cover --coverprofile=coverage.txt"
+          cat coverage.txt
+      - name: upload coverage reselt
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          flags: integration-o11

Dockerfile

@@ -13,6 +13,9 @@ FROM alpine:3.15
 
 COPY --from=build-env /go/src/webhookx-io/webhookx/webhookx /usr/local/bin
 
-EXPOSE 8080
+EXPOSE 9600
+EXPOSE 9601
+EXPOSE 9602
+
 
 CMD ["webhookx", "start"]

Makefile

@@ -24,17 +24,14 @@ test-deps:
 	mkdir -p test/output/otel
 	docker compose -f test/docker-compose.yml up -d
 
-test: clean
-	go test $$(go list ./... | grep -v /test/ | grep -v /examples/ )
+test-unit: clean
+	go test $$(go list ./... | grep -v /test/ | grep -v /examples/ ) $(FLAGS)
 
-test-coverage: clean
-	go test $$(go list ./... | grep -v /test/ | grep -v /examples/ ) -coverprofile=coverage.txt
+test-o11: clean
+	ginkgo -r $(FLAGS) ./test/metrics ./test/tracing
 
-test-integration: clean
-	go test -p 1 -v ./test/...
-
-test-integration-coverage: clean
-	go test -p 1 -v ./test/... --coverpkg ./... -coverprofile=coverage.txt
+test-main: clean
+	ginkgo -r --skip-package=metrics,tracing $(FLAGS) ./test
 
 goreleaser:
 	goreleaser release --snapshot --clean

README.md

@@ -23,7 +23,7 @@ WebhookX is an open-source webhooks gateway for message receiving, processing, a
 
 ## Features
 
-- **Admin API:** Expose a RESTful API on port `:8080` for managing WebhookX entities.
+- **Admin API:** Expose a RESTful API on port `:9601` for managing WebhookX entities.
 - **Retries:** Automatically retry unsuccessful deliveries with configurable delays.
 - **Fan out:** Route events to multiple endpoints based on the event type.
 - **Rate Limiting:** Protect the gateway ingestion and delivery endpoints from overload.
@@ -67,7 +67,7 @@ curl -O https://raw.githubusercontent.com/webhookx-io/webhookx/main/docker-compo
 Once it's running, you will see HTTP 200 response
 
 ```
-curl http://localhost:8080
+curl http://localhost:9601
 ```
 
 ```http
@@ -102,10 +102,10 @@ Once it is set up, you're ready to send events to WebhookX.
 
 ### 3. Send events to WebhookX
 
-> The Ingestion is exposed on port  `:8081`
+> The Ingestion is exposed on port  `:9600`
 
 ```
-curl -X POST http://localhost:8081 \
+curl -X POST http://localhost:9600 \
 --header 'Content-Type: application/json' \
 --data '{
     "event_type": "charge.succeeded",
@@ -125,12 +125,12 @@ We sent a `charge.succeeded` event including `data` to WebhookX, and it will be
 >
 > Attempt object represents the delivery result of an event, and contains inspection information. 
 
-> The Admin is exposed on port  `:8080`
+> The Admin is exposed on port  `:9601`
 
 Let's make a request to retrieve the attempt list
 
 ```
-curl http://localhost:8080/workspaces/default/attempts
+curl http://localhost:9601/workspaces/default/attempts
 ```
 
 <details>
@@ -174,7 +174,7 @@ curl http://localhost:8080/workspaces/default/attempts
 To inspect the data such as `request.headers`, `request.body`, `response.headers`, and  `response.body`, try
 
 ```
-http://localhost:8080/workspaces/default/attempts/338lax8Xe774EhimzBukip37Zne
+http://localhost:9601/workspaces/default/attempts/338lax8Xe774EhimzBukip37Zne
 ```
 
 <details>
@@ -243,8 +243,8 @@ Usage:
 Available Commands:
   admin       Admin commands
   completion  Generate the autocompletion script for the specified shell
+  db          Database commands
   help        Help about any command
-  migrations  
   start       Start server
   version     Print the version
 

app/app.go

@@ -218,10 +218,11 @@ func (app *Application) initialize() error {
 			Dispatcher: dispatcher,
 			EventBus:   app.bus,
 		}
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err := accesslog.NewAccessLogger("admin", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err
@@ -247,10 +248,11 @@ func (app *Application) initialize() error {
 			Srv:         app.srv,
 			RateLimiter: ratelimiter.NewRedisLimiter(client),
 		}
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err := accesslog.NewAccessLogger("proxy", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err
@@ -268,10 +270,11 @@ func (app *Application) initialize() error {
 
 	if cfg.Status.IsEnabled() {
 		var accessLogger accesslog.AccessLogger
-		if cfg.AccessLog.Enabled() {
+		if cfg.AccessLog.Enabled {
 			accessLogger, err = accesslog.NewAccessLogger("status", accesslog.Options{
-				File:   cfg.AccessLog.File,
-				Format: string(cfg.AccessLog.Format),
+				File:    cfg.AccessLog.File,
+				Format:  string(cfg.AccessLog.Format),
+				Colored: cfg.AccessLog.Colored,
 			})
 			if err != nil {
 				return err

cmd/admin_dump.go

@@ -70,7 +70,7 @@ func newAdminDumpCmd() *cobra.Command {
 	}
 
 	dump.Flags().StringVarP(&workspace, "workspace", "", "default", "Set a specific workspace.")
-	dump.Flags().StringVarP(&addr, "addr", "", defaultAdminURL, "HTTP address of WebhookX's Admin API.")
+	dump.Flags().StringVarP(&addr, "addr", "", AdminURL, "HTTP address of WebhookX's Admin API.")
 	dump.Flags().IntVarP(&timeout, "timeout", "", 10, "Set the request timeout for the client to connect with WebhookX (in seconds).")
 
 	return dump

cmd/admin_sync.go

@@ -80,7 +80,7 @@ func newAdminSyncCmd() *cobra.Command {
 	}
 
 	sync.Flags().StringVarP(&workspace, "workspace", "", "default", "Set a specific workspace.")
-	sync.Flags().StringVarP(&addr, "addr", "", defaultAdminURL, "HTTP address of WebhookX's Admin API.")
+	sync.Flags().StringVarP(&addr, "addr", "", AdminURL, "HTTP address of WebhookX's Admin API.")
 	sync.Flags().IntVarP(&timeout, "timeout", "", 10, "Set the request timeout for the client to connect with WebhookX (in seconds).")
 
 	return sync

cmd/db.go

@@ -48,10 +48,9 @@ func newDatabaseResetCmd() *cobra.Command {
 func newDatabaseCmd() *cobra.Command {
 
 	database := &cobra.Command{
-		Use:     "db",
-		Aliases: []string{"migrations"},
-		Short:   "Database commands",
-		Long:    ``,
+		Use:   "db",
+		Short: "Database commands",
+		Long:  ``,
 	}
 
 	database.PersistentFlags().StringVarP(&configurationFile, "config", "", "", "The configuration filename")

cmd/root.go

@@ -6,8 +6,8 @@ import (
 	"os"
 )
 
-const (
-	defaultAdminURL = "http://localhost:8080"
+var (
+	AdminURL = "http://localhost:9601"
 )
 
 var (
@@ -18,11 +18,15 @@ var (
 
 func initConfig() {
 	var err error
+
+	var options config.Options
 	if configurationFile != "" {
-		cfg, err = config.InitWithFile(configurationFile)
-	} else {
-		cfg, err = config.Init()
+		buf, err := os.ReadFile(configurationFile)
+		cobra.CheckErr(err)
+		options.YAML = buf
 	}
+
+	cfg, err = config.New(&options)
 	cobra.CheckErr(err)
 
 	err = cfg.Validate()