Use Standard Go program layout #37

kimanimichael · 2024-08-09T17:17:12Z

rodneyosodo

It would be a good idea to separate the API from the service logic and repository layers. This is a well-known architectural pattern called Hexagonal Architecture https://dev.to/bagashiz/building-restful-api-with-hexagonal-architecture-in-go-1mij

rodneyosodo · 2024-08-17T08:27:52Z

.gitignore

@@ -1,2 +1,2 @@
-whitepointinventory
+build
 .idea/


Add new line

rodneyosodo · 2024-08-17T08:28:02Z

build/build_run.sh

+
+go build -o build/whitepointinventory ./cmd/whitepointinventory
+
+build/whitepointinventory


add new line

rodneyosodo · 2024-08-17T08:28:43Z

cmd/whitepointinventory/whitepointinventory.go

@@ -0,0 +1,111 @@
+package main
+


Since this is one binary project you can use cmd/main.go rather than cmd/whitepointinventory/whitepointinventory.go

rodneyosodo · 2024-08-17T08:29:20Z

cmd/whitepointinventory/whitepointinventory.go

+	}
+	log.Printf("Server starting on port %s", portString)
+
+	err = srv.ListenAndServe()


inline error check

if err := srv.ListenAndServer(); err != nil {

Implemented

rodneyosodo · 2024-08-17T08:31:25Z

docker/Dockerfile

@@ -10,7 +10,7 @@ RUN go mod download

 COPY . .

-RUN go build -o whitepointinventory
+RUN go build -o whitepointinventory ./cmd/whitepointinventory

 FROM alpine:latest


You can use scratch instead of an alpine image

Changed to a scratch base image

rodneyosodo · 2024-08-17T08:31:46Z

docker/Dockerfile

@@ -10,7 +10,7 @@ RUN go mod download

 COPY . .

-RUN go build -o whitepointinventory
+RUN go build -o whitepointinventory ./cmd/whitepointinventory

 FROM alpine:latest


Don't copy the env file

rodneyosodo · 2024-08-17T08:32:14Z

build/build_run.sh

@@ -0,0 +1,5 @@
+rm -rf build/whitepointinventory


It will overwrite no need to remove

The script runs the old binary if there's an error in compilation, which is undesired behaviour for this particular use case. Hence why I remove it.

rodneyosodo · 2024-08-17T08:33:08Z

pkg/jsonresponses/json.go

@@ -1,12 +1,12 @@
-package main
+package jsonresponses


Not a good package name you can rename it to internal/api -> package api

I intend the APIs here to be public APIs. What would be a good package name to still have them in the pkg directory?

Public you mean people outside the project would import it as a package?

The change the name

rodneyosodo · 2024-08-17T08:34:50Z

pkg/health/health.go

+	"net/http"
+)
+
+func HandlerHealth(w http.ResponseWriter, r *http.Request) {


Have a look at https://github.com/mszostok/version or https://github.com/nelkinda/health-go then you can create a health endpoint with those values

This is the standard https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check#section-5

…explicitly defined in docker-compose.yml file

Covers cases where .env is not needed e.g. when environment is explicitly defined in a docker-compose.yml file

…/gensql

…ated endpoints

kimanimichael · 2024-10-06T12:11:11Z

73 commits one PR. Just merge 😂

Had to refactor entire code-base. I am doing some clean up and then you can re-review. You can just check of all your comments are handled.

…se handlers

kimanimichael · 2024-10-14T19:30:21Z

It would be a good idea to separate the API from the service logic and repository layers. This is a well-known architectural pattern called Hexagonal Architecture https://dev.to/bagashiz/building-restful-api-with-hexagonal-architecture-in-go-1mij

Done.

kimanimichael · 2024-10-16T22:14:09Z

73 commits one PR. Just merge 😂

Had to refactor entire code-base. I am doing some clean up and then you can re-review. You can just check of all your comments are handled.

You can check if your comments are handled now.

rodneyosodo · 2024-10-19T09:58:04Z

internal/middleware/middleware_auth.go

+
+func (a *UserAuth) MiddlewareAuth(handler authedHandler) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		APIKey, err := auth.GetAPIKey(r.Header)


Suggested change

APIKey, err := auth.GetAPIKey(r.Header)

apiKey, err := auth.GetAPIKey(r.Header)

For non exported variables start with small letter. This applies to everyplace.

rodneyosodo · 2024-10-19T09:59:22Z

internal/middleware/middleware_auth.go

@@ -0,0 +1,33 @@
+package middleware


rename file to auth.go

rodneyosodo · 2024-10-19T10:05:11Z

internal/domain/payments_repository.go

@@ -0,0 +1,11 @@
+package domain


Try and reduce the underscores in file naming. Use DDD where we have different domains farmer, payments, purchases and users

domain(for example users)

api
repository

repository.go
middleware(if you have any)
domain(for example user).go (defines the repository and service interface)
service.go (implements service)

rodneyosodo · 2024-10-19T10:06:27Z

.golangci.yml

+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.


Add this to CI for example https://github.com/rodneyosodo/gophercon-africa-2024/blob/main/.github/workflows/ci.yaml

kimanimichael added 13 commits August 9, 2024 20:14

feat(standard_layout): Remove vendor folder

b3ddf9e

feat(standard_layout): Move auth to pkg

7208c17

feat(standard_layout): Move User to pkg

d0ea19f

feat(standard_layout): Refactor farmers to internal

0babe36

feat(standard_layout): Refactor models to internal/

607c7cb

feat(standard_layout): Refactor payments to internal/

6455f60

feat(standard_layout): Refactor purchases to internal/

70a5946

feat(standard_layout): Refactor json responses to pkg/

8e68508

feat(standard_layout): Refactor middleware responses to internal/

345441d

feat(standard_layout): Refactor health responses to pkg/

226ae2b

feat(standard_layout): Refactor main to cmd/whitepointinventory/

7d1af7c

feat(standard_layout): Refactor - Update build command

03611bf

feat(standard_layout): Move build script to build/

aa86154

rodneyosodo suggested changes Aug 17, 2024

View reviewed changes

kimanimichael added 16 commits August 19, 2024 23:27

feat(standard_layout): Move main package to cmd/main.go

78043dc

feat(standard_layout): Inline error check

302e6e2

feat(standard_layout): Use scratch base image for already built binary

21770e3

feat(standard_layout): Remove copying of .env file as environment is …

0451e1f

…explicitly defined in docker-compose.yml file

feat(standard_layout): Remove fatal error handling on .env load failure

4dc2147

Covers cases where .env is not needed e.g. when environment is explicitly defined in a docker-compose.yml file

feat(standard_layout): Add linter

1bc5a8f

feat(standard_layout): Add new line at EOF

c124e39

feat(standard_layout): Handle error for Write(dat)

9398b78

feat(standard_layout): Init ports

1e42330

feat(standard_layout): Init user

3760443

feat(standard_layout): Init user service

04f5e9f

feat(standard_layout): Init user repository

07436fc

feat(standard_layout): Move sqlc queries to adapters/sqlc

c5a57ed

feat(standard_layout): Move schema to adapters/sqlc

c46311e

feat(standard_layout): Move generated go sql code to adapters/db/sqlc…

3d6e947

…/gensql

feat(standard_layout): Move sqlc.yaml to adapters/db/sqlc/

db2e19d

kimanimichael added 7 commits October 6, 2024 11:08

refactor(standard_layout): Register get purchases routes

ac0c1a0

refactor(standard_layout): Refactor get transasction struct

91dcd64

refactor(standard_layout): Get ID from request body

7f1549b

refactor(standard_layout): Implement purchase deletion

01225b4

refactor(standard_layout): Register missing routes

34adccd

refactor(standard_layout): Make transaction deletions to be authentic…

c148407

…ated endpoints

refactor(standard_layout): Init driver and driven components

c77dfa9

kimanimichael added 13 commits October 6, 2024 20:51

refactor(standard_layout): Require user service in payment and purcha…

78c5ccd

…se handlers

refactor(standard_layout): Fix routing

5e09990

refactor(standard_layout): Respond with custom responses

7d24655

refactor(standard_layout): Add user ID to payment

dd0f9c6

refactor(standard_layout): Respond with custom responses

7a5a6db

refactor(standard_layout): Hash password during creation

42ca9d3

refactor(standard_layout): Fix missing backward compatibility

bc5a4b8

refactor(standard_layout): Fix bugs causing incompatibilty

410c7a9

refactor(standard_layout): Return updated payment response

a28c296

refactor(standard_layout): Enhance returned user

dace7ee

refactor(standard_layout): Add farmer name check during creation

158e46d

refactor(standard_layout): Customize error statements

5af3189

refactor(standard_layout): Remove unused code from previous layout

38c35d7

kimanimichael force-pushed the feat/standard_layout branch from 02a8287 to 38c35d7 Compare October 10, 2024 18:40

feat(standard_layout): Add health endpoint

7098121

kimanimichael added 3 commits October 16, 2024 17:15

feat(standard_layout): Minimize duplication of transaction from user

d2b7fb8

feat(standard_layout): Resolve conflicts with master

4c6b1af

feat(standard_layout): Remove unused packages

23c4806

kimanimichael requested a review from rodneyosodo October 16, 2024 22:13

rodneyosodo suggested changes Oct 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Standard Go program layout #37

Use Standard Go program layout #37

kimanimichael commented Aug 9, 2024

rodneyosodo left a comment

rodneyosodo Aug 17, 2024

kimanimichael Aug 28, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 28, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 17, 2024

kimanimichael Aug 19, 2024

rodneyosodo Aug 20, 2024

kimanimichael Aug 20, 2024

rodneyosodo Aug 20, 2024

rodneyosodo Aug 17, 2024

kimanimichael Oct 14, 2024

kimanimichael commented Oct 6, 2024

kimanimichael commented Oct 14, 2024

kimanimichael commented Oct 16, 2024

rodneyosodo Oct 19, 2024

rodneyosodo Oct 19, 2024

rodneyosodo Oct 19, 2024

rodneyosodo Oct 19, 2024


		go build -o build/whitepointinventory ./cmd/whitepointinventory

		build/whitepointinventory

	APIKey, err := auth.GetAPIKey(r.Header)
	apiKey, err := auth.GetAPIKey(r.Header)

Use Standard Go program layout #37

Are you sure you want to change the base?

Use Standard Go program layout #37

Conversation

kimanimichael commented Aug 9, 2024

rodneyosodo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kimanimichael commented Oct 6, 2024

kimanimichael commented Oct 14, 2024

kimanimichael commented Oct 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment