User story

As a developer who use AAA service to authenticate user, i want to send user data to server, so that those data can be save into server database

Acceptance Criteria

• Should be able to send user data like name, email, and password
• Should return a JSON object with field code, message and status
• Should return a JSON that contain field validation error when data email invalid

Non-Functional Requirements

• The API should recover that return error JSON when program experiencing a panic
• API should process the request and respond within maximum 10 seconds in a end-to-end setup.

Issue type : 🦌 New Feature

Descriptions :
no description present

Task :

• #192
• #198
• #199

Technical Description
Initialize GO modules to defines the module’s module path, which is also the import path used for the root directory, and its dependency requirements, which are the other modules needed for a successful build. Each dependency requirement is written as a module path and a specific semantic version.

Acceptance Criteria

• go.mod and go.sum files should present on root directory
• env example should present on root directory and contain prefix ZO on every variable

Technical type : 🦌 New Feature

Task :

• Init GO Modules
• Set main function
• Init Go server
• Create folder structure
• Init ENV

• Label Docs
• Pull Requests
• Issues

Technical Description
Create silent type for logger to disable logger. This type is very useful when we want to disable when run unit testing

Acceptance Criteria

• Logger shouldn't appear on unit test result

Technical type : 🦌 New Feature

Task :

• Add silent type on logger
• Implement silent type on uni testing

Research Docker

Issue type : 🦧 Documentation content changes

Update License:

• Checking license
• Update year

User story

As a developer who use AAA service to authenticate user, i want to receive a JWT Token from server when i send user username and his password, so that i can use those JWT token to navigate user into secure resources

Acceptance Criteria

• Should be able receive a POST request from URL /login
• Should be able to send user username and his password in the API request. These fields are mandatory
• Should return a JSON object with field access_token and refresh_token

Non-Functional Requirements

• The API should support a load of 50 API requests per second without failing.
• API should process the request and respond within maximum 500 milliseconds in a cloud-to-cloud setup.

Issue type : 🦌 New Feature

Descriptions :

• For debugging purpose the API should return user data alongside with JWT

Task :

• #222
• #223
• #224
• #225
• #226
• #227
• #228

Technical Description
Research how to construct JSON Response, include success response and error response

Acceptance Criteria

• Section JSON Response should present on README file

Technical type : 🦧 Documentation content changes

Task :

• How to construct base response on go
• Best way to build success response
• Best way to build error response include message, error code, HTTP code, etc

Technical Description
Refactor how to initialize log for every package. The purpose of this refactoring is to reduce setter function for logger for every package that need logger.

// setup handler
handler := handler.New()
handler.SetLogger(log)

Acceptance Criteria

• logger setter function on package server and handler should be gone

Technical type : 🏇🏼 Refactoring (no functional changes, no api changes)

Task :

• Remove logger setter function in handler
• Init logger when package initialize (on New function)
• Remove app field logger
• Remove Sync function
• Create function log fLog
• Implement singleton patter when init logger

• Research implement ExpressJS using Typescript
• Research project structures

Technical Description
Implement config to all across package in the project.

Acceptance Criteria

• config package should be present on destination package

Technical type : 🦌 New Feature

Task :

• implement config on server
• implement config on logger

Technical Description
Initialize GitHub action that perform go test, code coverage and go build with multiple operating system (windows, linux, and mac os) matrix.

Acceptance Criteria

• GitHub action should use at lease 1.16 go version
• GitHub action should use ubuntu-latest as container operating system
• GitHub action should run when pull request open
• GitHub action should run when there is changes on branch
• GitHub action should produce test report and code coverage in text base file
• GitHub action should display those test report and code coverage in pull request comment
• GitHub action should fail when code coverage bellow 50%

Technical type :

• 🦌 New Feature
• 🏅 Build related changes

Task :

• Init workflow yaml
• Setup Go
• Setup unit testing job
• Setup code coverage job
• Display test report and code coverage in pull request comment
• #322
• #323

Technical Description
Initialize middle-ware server such as 404 Page, Compression, Transaction ID, Request ID, and swagger UI

Acceptance Criteria

• middleware.go should present on internal directory
• middleware package should present on middleware.go files

Technical type : 🐞 Possible Bug

Task :

• 404 Page Not found
• RequestID middle-ware
• Swagger UI as a middle-ware
• TransactionID middle-ware
• Recover middleware
• Response Time middleware
• Implement Logger
• Implement config ENV

Research PosgresSQL

Issue type : 🦧 Documentation content changes

Descriptions :
Research how to setup PosgresSQL and implemented in typescript

Technical Description
Remove current logger system which is zap logger and replace it with zerolog. I conside zerolog because it have a better performance than zap logger based on this benchmark:

and also zero logger have better prettier print on console and easy to structure logging with custom field

Acceptance Criteria

• Zerolog dependency present on go.mod and go.sum files
• Zerolog should be create structured logging
• Zerolog should be provide pretty log

Technical type :

• 🦌 New Feature
• 🏇🏼 Refactoring (no functional changes, no api changes)
• 🦧 Documentation content changes

Task :

• Install Zerolog
• Implement Zerolog and remove Zap Logger
• Update README

Technical Description
Initialize SSL on server so that https can be run

Acceptance Criteria

• server can be access with https schema

Technical type : 🦌 New Feature

Task :

• Research how to implement SSL
• Implement SSL on fiber server

Route: /login

Technical Description
Update Git docs about how to write better commit messages based on this articles https://medium.com/swlh/writing-better-commit-messages-9b0b6ff60c67

Acceptance Criteria

• git.md present on .github directory

Technical type : 🦧 Documentation content changes

Task :

• Create git.md
• Create guideline how to write better commit message

Research Promise (async)

Issue type : 🦧 Documentation content changes

Descriptions :
Research Promise (async),how it works, and how i implemented on typescript

Technical Description
Initialize Pprof on Fiber server.

Acceptance Criteria

• There are endpoint to navigate user into pprof web based

Technical type : 🦌 New Feature

Task :

• Init pprof
• Create endpoint to navigate into pprof

Technical Description
Spike password hashing like argon2ID, bcrypt, etc, how they work, how to implement it, how it benchmark and how to save those hashing format into database

Acceptance Criteria

• No acceptance criteria required

Technical type : 🦧 Documentation content changes

Task :

• How they work
• How to implement it
• Hows their benchmark
• How to save thier hashing format into database

Technical Description
Define server time out on fiber config. There are three timeout, write, read and idle that should be define on config.

Acceptance Criteria

• Read, write, and idle timeout should be present on fiber config on server.go
• env example should contain timeout config

Technical type :

• 🦌 New Feature

Task :

• Init timeout config
• implement timeout on server.go

Technical Description
Avoid panic when error parse logger level occurs, replace panic with generic prinln and set level into zerolog trace

Acceptance Criteria
Program didn't panic when config LOG_LEVEL set to "UNKNOWN" and logger level set to trace

Technical type : 🐞 Possible Bug

Task :
Refactor logger to meet acceptance criteria

Technical Description
Define default error handler on fiber server. For default the app should give error status code 500 with message "Internal server error". If the error type is *reponse{}, the app should sent a response with the provided status code, message and data.

Acceptance Criteria

• Error method should present on handler package
• Error handler should be implement when server initializing

Technical type : 🦌 New Feature

Task :

• #215
• #217
• #218

init error handler based on this article https://docs.gofiber.io/guide/error-handling#default-error-handler

Technical Description
Initialize GO env variable config with viper.

Acceptance Criteria

• Package viper present on go.mod and go.sum files.
• Config file and package present on internal directory

Technical type : 🦌 New Feature

Task :

• Install package viper
• Create config package and init struct
• Implement viper
• Update README

• Remove unnecessary tech
• Update tech stack
• Update .gitignore

Technical Description
Initialize SQL database, and init package with Postgress SQL

Acceptance Criteria

• SQL Postgress should present on go.mod and go.sum files
• Package database should present on the project

Technical type : 🐞 Possible Bug

Task :

• install pstgress SQL
• init package database
• init sql transaction interface
• implement sql transaction
• implement ENV
• Implement Timeout

Technical Description
Initialize Swagger UI with path /docs

Acceptance Criteria

• Program should server Swagger UI when program receive request into URL /docs

Technical type : 🦌 New Feature

Task :

• Install Swagger UI
• Implement Swagger as handler
• Construct OpenAPI Swagger

Technical Description
Initialize Visual Studio Code config for debugging an enable certain plugin.

Acceptance Criteria

• Directory .vscode should present on root directory

Technical type : 🦌 New Feature

Task :

• Init debugging config
• init workspace setting

Create Database Schema based on this ERD:

Technical Description
Initialize Makefile to write script to automate a golang run or golang build

Acceptance Criteria

• Makefile files should present on root directory

Technical type : 🦌 New Feature

Task :

• Init Makefile
• export env
• script go run
• script go build

Technical Description
Initialize 404 response if URL doesn't match with any routing.

Acceptance Criteria

Technical type : 🦌 New Feature

Task :

• Init 404 middle ware