ribice / gorsk Goto Github PK

I feel Echo is superior to Gin in many ways.

1. Echo's handler returns an error, which is much nicer compared to empty returns.
2. Echo's documentation is far superior to Gin's README
3. More active development - Issues on Gin barely have any replies.

It would be easier to move to Echo once #1 is resolved.

• What are the layers you have in this codebase?
• If it follows/matches Clean arch by Uncle Bob - https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html

What are the layers here, could you please explain the code architecture a little bit. Which layer talks to which layer and which one is outer most layer and which one here are the inner most?

Currently payload is stored in JWT Claims, and in middleware it is then passed to context.

I don't really like this implementation. Also by removing it the project will be less dependant on Gin.

Token should have only expiry info and be used for authentication. For authorization purposes and getting user info, details should be fetched from Redis with JWT token as key.

Additionally this will require use of docker-compose, for running Redis.

Hi

I cannot see where ENVIRONMENT_NAME is use id. I can see JWT_SECRET user as well as "psn" (DATABASE_URL) in the code
it seem setting ENVIRONMENT_NAME to "dev" it is not working.

I am having certificate error like I am in PROD.
go: downloading github.com/segmentio/encoding v0.1.10
pkg/api/auth/auth.go:8:2: found packages auth (auth.go) and gorsk (company.go) in /home/go/github.com/buscando/gocar
../../../pkg/mod/github.com/go-pg/pg/[email protected]/pgjson/json.go:7:2: github.com/segmentio/[email protected]:
Get "https://storage.googleapis.com/proxy-golang-org-prod/ xxx": x509: certificate signed by unknown authority

Any help is appreciated

Thank you
Marcelo

While verifying test results using standard library only, I felt that it was way too verbose and the output wasn't as nice.

https://github.com/stretchr/testify provides assert method for verifying test results, which is written in a single line and writes a meaningful output to stdout.

I did not want to add another dependency, but this one feel justifiable.

Hi Mr Ribice,
My name is Mouhamed, I’m a software engineer and I’m new to Golang.
I decide to use it to build Restful API, and after few research on which framework to use, I found your GitHub repository about Gorsk. For me it’s an amazing work and I decided to use it.
But can I have more details about the workflow on gorsk for example the migrations. What is the best way to write them ? In the main file or create differences packages inside ? (I come from Django rest framework so please understand :))
Also can I have a project sample to explore before starting and doing messy things :).

Trying to run go run cmd/api/main.go, but get problem with "internal package not allowed"
I clone project under $GOPATH/src, then

=> ~/go/bin/dep ensure -v
=> go run cmd/api/main.go
cmd/api/main.go:44:2: use of internal package not allowed
cmd/api/main.go:45:2: use of internal package not allowed
cmd/api/main.go:36:2: use of internal package not allowed
cmd/api/main.go:46:2: use of internal package not allowed
cmd/api/main.go:47:2: use of internal package not allowed 

After removed github.com/ribice from import in all go files, so

import (
        ...
	"gorsk/internal"
        ...
)

Everything goes well.

I have setup the server according to the docs and running it normally via: go run cmd/api/main.go. Requesting the /swaggerui endpoint returns the following JSON error message:

$ curl http://localhost:8080/swaggerui/ 
"code=404, message=Not Found"

The error occurs regardless of the trailing / character in the URL.

... have methods that takes in echo.Context as one of its parameters:

I noticed the same trend in gorsk-gin:
here

among others..

Why do you have it as a parameter if it is never used within the methods? Is its inclusion a placeholder for edge use cases?

Thanks for publishing this code. I find it immensely useful to think about how to go about structuring API in Go.

Go Version : 1.12
Os : MACOS (Linux)

I ran go get https://github.com/ribice/gorsk and got this error
https:/github.com/ribice/gorsk: https:/github.com/ribice/gorsk: invalid import path: malformed import path "https:/github.com/ribice/gorsk": invalid char ':
Am I missing something. I am a go starter running go version 1.12

Is there a way to have cookie based authentication instead of jwt one? Also because of this:
http://cryto.net/~joepie91/blog/2016/06/13/stop-using-jwt-for-sessions/

When enforcing certain location, currently all users with role company_admin can do the change.

In order to EnforceLocation, company_id needs to be retrieved (from locations table) and then matched if user is company_admin.

My problem might be basic, I'm new to go, sorry.

I'd like to add in the database multiple common field defined in pkg/utl/model/model.go like that:

// Base contains common fields for all tables
type Base struct {
	ID        int       `json:"id"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	DeletedAt time.Time `json:"deleted_at,omitempty" pg:",soft_delete"`
	CreatedBy int `json:"created_by"`
	UpdatedBy int `json:"updated_by"`
	DeletedBy int `json:"deleted_by,omitempty"`
}

The idea is fill the fields with the ID of the authenticated user like it fills times with the use of go-pg hooks functions.

So still in pkg/utl/model/model.go I'd like to be able to do something like:

// BeforeInsert hooks into insert operations, setting createdAt and updatedAt to current time
func (b *Base) BeforeInsert(_ orm.DB) error {
	now := time.Now()
	b.CreatedAt = now
	b.UpdatedAt = now

	b.CreatedByID = contextUserID
	b.UpdatedByID = contextUserID

	return nil
}

// BeforeUpdate hooks into update operations, setting updatedAt to current time
func (b *Base) BeforeUpdate(_ orm.DB) error {
	b.UpdatedAt = time.Now()

	b.UpdatedByID = contextUserID

	return nil
}

// BeforeUpdate hooks into delete operations
func (b *Base) BeforeDelete(_ orm.DB) error {
	
	b.DeletedByID = contextUserID

	return nil
}

In this file how can I access echo.Context.Get("id") to fill contextUserID?

(Merry Christmas ;))

Serve SwaggerUI under /swagger route

Return user data on /me API

Just curious....

According to https://www.ribice.ba/golang-web-frameworks/ article, you're suggesting Chi is better than echo. But, looks like you've rewritten it with echo instead. Can you please share the thought process? TIA

I think this would be more logical to have routes like below because user should be singular when manipulating only one entry don't you think?

POST /login: accepts username/passwords and returns jwt token and refresh token
GET /refresh/:token: refreshes sessions and returns jwt token
GET /me: returns info about currently logged in user
GET /swaggerui/: launches swaggerui in browser
GET /v1/users: returns list of users
GET /v1/user/:id: returns single user
POST /v1/user: creates a new user
PATCH /v1/user/:id/password: changes password for a user
DELETE /v1/user/:id: deletes a user

Also, I'm wondering about route if version should be on every routes or not.

The following package-level struct definition in pkg/utl/server/error.go is over-ridden by an identical struct definition in the handler func:

type resp struct {
	Message string `json:"message"`
}

Not a big deal, but probably better to remove it.

When testing config.go, config.invalid.yml and config.testdata.yml are being used.

They are located at same directory as other config files, which should not be the case due to clutter. They need to be moved to separate folder, e.g. testdata.

Initially I added a .sql file for database migration. I didn't like the fact that it had to be executed manually, so I added another executable located at cmd/migration.

Currently it creates necessary tables and data, without any constraints or relations.

go-pg has support for these (CreateTableOptions).

This also needs to be changed for integration tests.

Due to 'bug' in go-swagger, swagger docs are currently not being generated.

The main reason is usage /golang.org/x/crypto package, which has Linter/Code issues. Go-swagger complains with error:

swagger generate spec -o ./swagger.json --scan-models
/usr/local/go/src/crypto/x509/root_cgo_darwin.go:210:30: cannot convert nil (untyped nil value) to _Ctype_CFDataRef
/usr/local/go/src/crypto/x509/root_cgo_darwin.go:211:39: cannot convert nil (untyped nil value) to _Ctype_CFDataRef
/usr/local/go/src/crypto/x509/root_cgo_darwin.go:221:22: cannot convert nil (untyped nil value) to _Ctype_CFDataRef
/Users/ribice/go/src/github.com/ugorji/go/codec/goversion_makemap_gte_go19.go:12:10: MakeMapWithSize not declared by package reflect
/Users/ribice/go/src/github.com/ugorji/go/codec/goversion_makemap_gte_go19.go:14:9: MakeMapWithSize not declared by package reflect
couldn't load packages due to errors: github.com/ugorji/go/codec, crypto/x509

Per author's words:

I think it migh tmake it consider less packages
otherwise the error is probably a setting here: https://github.com/go-swagger/go-swagger/blob/master/scan/scanner.go#L205-L216
or a bug here: https://github.com/go-swagger/go-swagger/blob/master/scan/classifier.go#L72:30

Also I installed go-swagger using brew, which downloads latest release (6 months old). Perhaps download from master using go-get and running the binary would solve the issue.

• I feel adding docker and docker-compose setup will make local development way easier and could replace the replace-all package steps while getting started.
• Also, how about using Go modules?

A makefile target can also be used instead of manual package name change. See this.

Would be happy to submit PRs if above sound useful.

P.S.: Nice work on v2 👍

Looks like there may be a hard-coded credential in the source at the following location:

No idea if the credential is live but its probably a good idea to either replace it with a more generic placeholder or, ideally, show how this should be sourced from environment/configuration.

Hey just wanted to check that you meant to have this here!

If yes, then we're good, was just browsing and wanted to double check!

README references pkg/utl/model folder, but it seems such files were moved to root level in d89f430

I was wondering if this (having the files at root level) is generally the preferred approach, or if it's better to use the folder as suggested in the readme?

Inside pkg/utl/model create a new file named car.go. Inside put your entity (struct), and methods on the struct if you need them.

I tried to rename but failed, something wrong?
task relocate TARGET=github.com/author/gorsk

task relocate TARGET=github.com/author/gorsk                                                                                                                                               ─╯
 *** Relocating packages to github.com\/author\/gorsk ***
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
sed: can't read s/gorsk/gorsk/g: No such file or directory
....

Currently authorization token is passed as "Authorization:$token", as I had some issues with Bearer keyword and jwt-go library.

Will need to fix this, but I'm curious are there any drawbacks of using it like this (no Bearer keyword)?

What comes to my mind is rate limiting (link) and other security related middleware (e.g. XSS, DNSPrefetchControl etc.)

Most of them are available in Helmet package, but it will be better to write them manually after #2.

Gorsk currently only logs DB errors.

Perhaps logging middleware should be added with requestID generation, being passed to logger.

Also requests/responses could be logged.

Hi, please introduce my name is Naray Citra from Indonesia. I learned Golang since 2 weeks ago, same as you my programming experience is Java with SpringBoot :). I found your started kit by searching google :). I like your stater kit, but i still newbie in Golang, i have some questions for you. How we separate the pkg into microservice and containerized it? Can you give an example for that?

Hello @ribice ,

First, thanks for this repo, it's really nice to have something to start with !

I have a question regarding Pagination struct and was wondering why its located into models directory?
To me pagination mechanism relates to API stuff and is not really to domain.
Is there any reason I am missing to have it here ?

https://github.com/ribice/gorsk/blob/master/pkg/utl/model/pagination.go

Thanks

Database tests needs to be improved.

UserDB Update tests updates all columns, instead of only mentioned ones. Manually works fine.

Tests on structs package should be completed.

Currently select queries are retrieved using:

var entity model.User{} 
db.Model(&entity).Where("id = ?", id).Select()

It should be replaced with

entity := model.User{ID: id}
db.Select(&entity)

Reproduce

By using latest go-swagger

swagger generate spec -o assets/swaggerui/swagger.json --scan-models -b github.com/ribice/gorsk/pkg/api

check assets/swaggerui/swagger.json

How about using https://github.com/spf13/viper for configuration management? We won't be restricted to YAML files for configurations.

Would be happy to contribute if this looks like a suitable enhancement.

P.S.: Loved gorsk. Saved me a lot of effort in standardising things. 👍 :)