go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-17 00:17:59 +02:00
Code Issues Releases Activity

Completed removing example-project directory and moving all files back a

Browse Source 
a directory
This commit is contained in:
Lee Brown
2019-07-13 12:16:28 -08:00
parent bcf022aa18
commit 6117a813f2
66 changed files with 263 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -89,7 +89,6 @@ Clone the repo into your desired location. This project uses Go modules and does
You should now be able to compile the project locally. You should now be able to compile the project locally.
``` ```
cd example-project/
GO111MODULE=on go install ./... GO111MODULE=on go install ./...
``` ```
@ -101,7 +100,6 @@ This project is using Go Module support for vendoring dependencies.
We are using the `tidy` command to maintain the dependencies and make sure the project can create reproducible builds. We are using the `tidy` command to maintain the dependencies and make sure the project can create reproducible builds.
``` ```
cd example-project
GO111MODULE=on go mod tidy GO111MODULE=on go mod tidy
``` ```
@ -129,7 +127,7 @@ There is a `docker-compose` file that knows how to build and run all the service
Navigate to the root of the project and first set your AWS configs. Copy `sample.env_docker_compose` to `.env_docker_compose` and update the credentials for docker-compose. Navigate to the root of the project and first set your AWS configs. Copy `sample.env_docker_compose` to `.env_docker_compose` and update the credentials for docker-compose.
``` ```
$ cd $GOPATH/src/geeks-accelerator/oss/saas-starter-kit/example-project $ cd $GOPATH/src/geeks-accelerator/oss/saas-starter-kit
$ cp sample.env_docker_compose .env_docker_compose $ cp sample.env_docker_compose .env_docker_compose
``` ```
@ -163,13 +161,13 @@ Running `docker-compose down` will properly stop and terminate the Docker Compos
## Web App ## Web App
[cmd/web-app](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/example-project/cmd/web-app) [cmd/web-app](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/cmd/web-app)
Responsive web application that renders HTML using the `html/template` package from the standard library to enable direct interaction with clients and their users. It allows clients to sign up new accounts and provides user authentication with HTTP sessions. The web app relies on the Golang business logic packages developed to provide an API for internal requests. Responsive web application that renders HTML using the `html/template` package from the standard library to enable direct interaction with clients and their users. It allows clients to sign up new accounts and provides user authentication with HTTP sessions. The web app relies on the Golang business logic packages developed to provide an API for internal requests.
## Web API ## Web API
[cmd/web-api](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/example-project/cmd/web-api) [cmd/web-api](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/cmd/web-api)
REST API available to clients for supporting deeper integrations. This API is also a foundation for third-party integrations. The API implements JWT authentication that renders results as JSON to clients. This API is not directly used by the web app to prevent locking the functionally needed internally for development of the web app to the same functionality exposed to clients. It is believed that in the beginning, having to define an additional API for internal purposes is worth at additional effort as the internal API can handle more flexible updates. The API exposed to clients can then be maintained in a more rigid/structured process to manage client expectations. REST API available to clients for supporting deeper integrations. This API is also a foundation for third-party integrations. The API implements JWT authentication that renders results as JSON to clients. This API is not directly used by the web app to prevent locking the functionally needed internally for development of the web app to the same functionality exposed to clients. It is believed that in the beginning, having to define an additional API for internal purposes is worth at additional effort as the internal API can handle more flexible updates. The API exposed to clients can then be maintained in a more rigid/structured process to manage client expectations.
@ -199,18 +197,18 @@ $ curl -H "Authorization: Bearer ${TOKEN}" http://localhost:3000/v1/users
``` ```
## Schema ## Schema
[cmd/schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/example-project/cmd/schema) [cmd/schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/cmd/schema)
Schema is a minimalistic database migration helper that can manually be invoked via CLI. It provides schema versioning and migration rollback. Schema is a minimalistic database migration helper that can manually be invoked via CLI. It provides schema versioning and migration rollback.
To support POD architecture, the schema for the entire project is defined globally and is located inside internal: [internal/schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/example-project/internal/schema) To support POD architecture, the schema for the entire project is defined globally and is located inside internal: [internal/schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/tree/master/internal/schema)
Keeping a global schema helps ensure business logic then can be decoupled across multiple packages. It’s a firm belief that data models should not be part of feature functionality. Globally defined structs are dangerous as they create large code dependencies. Structs for the same database table can be defined by package to help mitigate large code dependencies. Keeping a global schema helps ensure business logic then can be decoupled across multiple packages. It’s a firm belief that data models should not be part of feature functionality. Globally defined structs are dangerous as they create large code dependencies. Structs for the same database table can be defined by package to help mitigate large code dependencies.
The example schema package provides two separate methods for handling schema migration. The example schema package provides two separate methods for handling schema migration.
* [Migrations](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/blob/master/example-project/internal/schema/migrations.go) * [Migrations](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/blob/master/internal/schema/migrations.go)
List of direct SQL statements for each migration with defined version ID. A database table is created to persist executed migrations. Upon run of each schema migration run, the migraction logic checks the migration database table to check if it’s already been executed. Thus, schema migrations are only ever executed once. Migrations are defined as a function to enable complex migrations so results from query manipulated before being piped to the next query. List of direct SQL statements for each migration with defined version ID. A database table is created to persist executed migrations. Upon run of each schema migration run, the migraction logic checks the migration database table to check if it’s already been executed. Thus, schema migrations are only ever executed once. Migrations are defined as a function to enable complex migrations so results from query manipulated before being piped to the next query.
* [Init Schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/blob/master/example-project/internal/schema/init_schema.go) * [Init Schema](https://gitlab.com/geeks-accelerator/oss/saas-starter-kit/blob/master/internal/schema/init_schema.go)
If you have a lot of migrations, it can be a pain to run all them, as an example, when you are deploying a new instance of the app, in a clean database. To prevent this, use the initSchema function that will run if no migration was run before (in a new clean database). If you are using this to help seed the database, you will need to create everything needed, all tables, foreign keys, etc. If you have a lot of migrations, it can be a pain to run all them, as an example, when you are deploying a new instance of the app, in a clean database. To prevent this, use the initSchema function that will run if no migration was run before (in a new clean database). If you are using this to help seed the database, you will need to create everything needed, all tables, foreign keys, etc.
Another bonus with the globally defined schema allows testing to spin up database containers on demand include all the migrations. The testing package enables unit tests to programmatically execute schema migrations before running any unit tests. Another bonus with the globally defined schema allows testing to spin up database containers on demand include all the migrations. The testing package enables unit tests to programmatically execute schema migrations before running any unit tests.
@ -220,7 +218,7 @@ Another bonus with the globally defined schema allows testing to spin up databas
Login to the local postgres container Login to the local postgres container
```bash ```bash
docker exec -it example-project_postgres_1 /bin/bash docker exec -it saas-starter-kit_postgres_1 /bin/bash
bash-4.4# psql -u postgres shared bash-4.4# psql -u postgres shared
``` ```

4
cmd/schema/main.go
View File

@ -7,8 +7,8 @@ import (
"net/url" "net/url"
"os" "os"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/flag" "geeks-accelerator/oss/saas-starter-kit/internal/platform/flag"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/schema" "geeks-accelerator/oss/saas-starter-kit/internal/schema"
"github.com/kelseyhightower/envconfig" "github.com/kelseyhightower/envconfig"
"github.com/lib/pq" "github.com/lib/pq"
_ "github.com/lib/pq" _ "github.com/lib/pq"

2
cmd/web-api/Dockerfile
View File

@ -19,7 +19,7 @@ RUN GO111MODULE=off go get gopkg.in/go-playground/validator.v9 && \
RUN GO111MODULE=on go get -u github.com/swaggo/swag/cmd/swag RUN GO111MODULE=on go get -u github.com/swaggo/swag/cmd/swag
# Change dir to project base. # Change dir to project base.
WORKDIR $GOPATH/src/gitlab.com/geeks-accelerator/oss/saas-starter-kit/example-project WORKDIR $GOPATH/src/gitlab.com/geeks-accelerator/oss/saas-starter-kit
# Enable go modules. # Enable go modules.
ENV GO111MODULE="on" ENV GO111MODULE="on"

8
cmd/web-api/ecs-task-definition.json
View File

@ -34,10 +34,10 @@
{"name": "ECS_SERVICE", "value": "{ECS_SERVICE}"}, {"name": "ECS_SERVICE", "value": "{ECS_SERVICE}"},
{"name": "WEB_API_HTTP_HOST", "value": "{HTTP_HOST}"}, {"name": "WEB_API_HTTP_HOST", "value": "{HTTP_HOST}"},
{"name": "WEB_API_HTTPS_HOST", "value": "{HTTPS_HOST}"}, {"name": "WEB_API_HTTPS_HOST", "value": "{HTTPS_HOST}"},
{"name": "WEB_API_APP_PROJECT", "value": "{APP_PROJECT}"}, {"name": "WEB_API_SERVICE_PROJECT", "value": "{APP_PROJECT}"},
{"name": "WEB_API_APP_BASE_URL", "value": "{APP_BASE_URL}"}, {"name": "WEB_API_SERVICE_BASE_URL", "value": "{APP_BASE_URL}"},
{"name": "WEB_API_APP_HOST_PRIMARY", "value": "{HOST_PRIMARY}"}, {"name": "WEB_API_SERVICE_HOST_NAMES", "value": "{HOST_NAMES}"},
{"name": "WEB_API_APP_HOST_NAMES", "value": "{HOST_NAMES}"}, {"name": "WEB_API_SERVICE_ENABLE_HTTPS", "value": "{HTTPS_ENABLED}"},
{"name": "WEB_API_REDIS_HOST", "value": "{CACHE_HOST}"}, {"name": "WEB_API_REDIS_HOST", "value": "{CACHE_HOST}"},
{"name": "WEB_API_DB_HOST", "value": "{DB_HOST}"}, {"name": "WEB_API_DB_HOST", "value": "{DB_HOST}"},
{"name": "WEB_API_DB_USER", "value": "{DB_USER}"}, {"name": "WEB_API_DB_USER", "value": "{DB_USER}"},

6
cmd/web-api/handlers/account.go
View File

@ -5,9 +5,9 @@ import (
"net/http" "net/http"
"strconv" "strconv"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

2
cmd/web-api/handlers/check.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis" "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis"

6
cmd/web-api/handlers/project.go
View File

@ -6,9 +6,9 @@ import (
"strconv" "strconv"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/project" "geeks-accelerator/oss/saas-starter-kit/internal/project"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

10
cmd/web-api/handlers/routes.go
View File

@ -5,11 +5,11 @@ import (
"net/http" "net/http"
"os" "os"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
saasSwagger "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger" saasSwagger "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
_ "geeks-accelerator/oss/saas-starter-kit/example-project/internal/signup" _ "geeks-accelerator/oss/saas-starter-kit/internal/signup"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis" "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis"
) )

8
cmd/web-api/handlers/signup.go
View File

@ -4,10 +4,10 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/signup" "geeks-accelerator/oss/saas-starter-kit/internal/signup"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

6
cmd/web-api/handlers/user.go
View File

@ -7,9 +7,9 @@ import (
"strings" "strings"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

6
cmd/web-api/handlers/user_account.go
View File

@ -2,9 +2,9 @@ package handlers
import ( import (
"context" "context"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user_account" "geeks-accelerator/oss/saas-starter-kit/internal/user_account"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

122
cmd/web-api/main.go
View File

@ -6,6 +6,7 @@ import (
"encoding/json" "encoding/json"
"expvar" "expvar"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"log" "log"
"net" "net"
"net/http" "net/http"
@ -18,12 +19,12 @@ import (
"syscall" "syscall"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/cmd/web-api/docs" "geeks-accelerator/oss/saas-starter-kit/cmd/web-api/docs"
"geeks-accelerator/oss/saas-starter-kit/example-project/cmd/web-api/handlers" "geeks-accelerator/oss/saas-starter-kit/cmd/web-api/handlers"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/devops" "geeks-accelerator/oss/saas-starter-kit/internal/platform/devops"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/flag" "geeks-accelerator/oss/saas-starter-kit/internal/platform/flag"
"github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials" "github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/aws/session"
@ -72,6 +73,7 @@ func main() {
log := log.New(os.Stdout, service+" : ", log.LstdFlags|log.Lmicroseconds|log.Lshortfile) log := log.New(os.Stdout, service+" : ", log.LstdFlags|log.Lmicroseconds|log.Lshortfile)
// ========================================================================= // =========================================================================
// Configuration // Configuration
var cfg struct { var cfg struct {
@ -87,12 +89,12 @@ func main() {
WriteTimeout time.Duration `default:"5s" envconfig:"WRITE_TIMEOUT"` WriteTimeout time.Duration `default:"5s" envconfig:"WRITE_TIMEOUT"`
DisableHTTP2 bool `default:"false" envconfig:"DISABLE_HTTP2"` DisableHTTP2 bool `default:"false" envconfig:"DISABLE_HTTP2"`
} }
App struct { Service struct {
Name string `default:"web-api" envconfig:"NAME"` Name string `default:"web-api" envconfig:"NAME"`
Project string `default:"" envconfig:"PROJECT"` Project string `default:"" envconfig:"PROJECT"`
BaseUrl string `default:"" envconfig:"BASE_URL" example:"http://example-project.com"` BaseUrl string `default:"" envconfig:"BASE_URL" example:"http://api.eproc.tech"`
HostPrimary string `envconfig:"HOST_PRIMARY" example:"example-project.com"` HostNames []string `envconfig:"HOST_NAMES" example:"alternative-subdomain.eproc.tech"`
HostNames []string `envconfig:"HOST_NAMES" example:"subdomain.example-project.com"` EnableHTTPS bool `default:"false" envconfig:"ENABLE_HTTPS"`
TemplateDir string `default:"./templates" envconfig:"TEMPLATE_DIR"` TemplateDir string `default:"./templates" envconfig:"TEMPLATE_DIR"`
DebugHost string `default:"0.0.0.0:4000" envconfig:"DEBUG_HOST"` DebugHost string `default:"0.0.0.0:4000" envconfig:"DEBUG_HOST"`
ShutdownTimeout time.Duration `default:"5s" envconfig:"SHUTDOWN_TIMEOUT"` ShutdownTimeout time.Duration `default:"5s" envconfig:"SHUTDOWN_TIMEOUT"`
@ -160,6 +162,7 @@ func main() {
return // We displayed help. return // We displayed help.
} }
// ========================================================================= // =========================================================================
// Config Validation & Defaults // Config Validation & Defaults
@ -173,16 +176,16 @@ func main() {
// deployments and distributed to each instance of the service running. // deployments and distributed to each instance of the service running.
if cfg.Aws.SecretsManagerConfigPrefix == "" { if cfg.Aws.SecretsManagerConfigPrefix == "" {
var pts []string var pts []string
if cfg.App.Project != "" { if cfg.Service.Project != "" {
pts = append(pts, cfg.App.Project) pts = append(pts, cfg.Service.Project)
} }
pts = append(pts, cfg.Env, cfg.App.Name) pts = append(pts, cfg.Env, cfg.Service.Name)
cfg.Aws.SecretsManagerConfigPrefix = filepath.Join(pts...) cfg.Aws.SecretsManagerConfigPrefix = filepath.Join(pts...)
} }
// If base URL is empty, set the default value from the HTTP Host // If base URL is empty, set the default value from the HTTP Host
if cfg.App.BaseUrl == "" { if cfg.Service.BaseUrl == "" {
baseUrl := cfg.HTTP.Host baseUrl := cfg.HTTP.Host
if !strings.HasPrefix(baseUrl, "http") { if !strings.HasPrefix(baseUrl, "http") {
if strings.HasPrefix(baseUrl, "0.0.0.0:") { if strings.HasPrefix(baseUrl, "0.0.0.0:") {
@ -194,15 +197,39 @@ func main() {
} }
baseUrl = "http://" + baseUrl baseUrl = "http://" + baseUrl
} }
cfg.App.BaseUrl = baseUrl cfg.Service.BaseUrl = baseUrl
} }
// When HTTPS is not specifically enabled, but an HTTP host is set, enable HTTPS.
if !cfg.Service.EnableHTTPS && cfg.HTTPS.Host != "" {
cfg.Service.EnableHTTPS = true
}
// Determine the primary host by parsing host from the base app URL.
baseSiteUrl, err := url.Parse(cfg.Service.BaseUrl)
if err != nil {
log.Fatalf("main : Parse service base URL : %s : %+v", cfg.Service.BaseUrl, err)
}
// Drop any ports from the base app URL.
var primaryServiceHost string
if strings.Contains(baseSiteUrl.Host, ":") {
primaryServiceHost, _, err = net.SplitHostPort(baseSiteUrl.Host)
if err != nil {
log.Fatalf("main : SplitHostPort : %s : %+v", baseSiteUrl.Host, err)
}
} else {
primaryServiceHost = baseSiteUrl.Host
}
// ========================================================================= // =========================================================================
// Log App Info // Log Service Info
// Print the build version for our logs. Also expose it under /debug/vars. // Print the build version for our logs. Also expose it under /debug/vars.
expvar.NewString("build").Set(build) expvar.NewString("build").Set(build)
log.Printf("main : Started : Application Initializing version %q", build) log.Printf("main : Started : Service Initializing version %q", build)
defer log.Println("main : Completed") defer log.Println("main : Completed")
// Print the config for our logs. It's important to any credentials in the config // Print the config for our logs. It's important to any credentials in the config
@ -216,6 +243,7 @@ func main() {
log.Printf("main : Config : %v\n", string(cfgJSON)) log.Printf("main : Config : %v\n", string(cfgJSON))
} }
// ========================================================================= // =========================================================================
// Init AWS Session // Init AWS Session
var awsSession *session.Session var awsSession *session.Session
@ -239,6 +267,7 @@ func main() {
awsSession = awstrace.WrapSession(awsSession) awsSession = awstrace.WrapSession(awsSession)
} }
// ========================================================================= // =========================================================================
// Start Redis // Start Redis
// Ensure the eviction policy on the redis cluster is set correctly. // Ensure the eviction policy on the redis cluster is set correctly.
@ -272,6 +301,7 @@ func main() {
} }
} }
// ========================================================================= // =========================================================================
// Start Database // Start Database
var dbUrl url.URL var dbUrl url.URL
@ -322,27 +352,14 @@ func main() {
log.Fatalf("main : Constructing authenticator : %+v", err) log.Fatalf("main : Constructing authenticator : %+v", err)
} }
// ========================================================================= // =========================================================================
// Init redirect middleware to ensure all requests go to the primary domain. // Load middlewares that need to be configured specific for the service.
primaryDomain := cfg.App.HostPrimary
// When primary host is not set, we can parse host from the base app URL. var serviceMiddlewares []web.Middleware
if primaryDomain == "" {
baseSiteUrl, err := url.Parse(cfg.App.BaseUrl)
if err != nil {
log.Fatalf("main : Parse App Base URL : %s : %+v", cfg.App.BaseUrl, err)
}
if strings.Contains(baseSiteUrl.Host, ":") {
primaryDomain, _, err = net.SplitHostPort(baseSiteUrl.Host)
if err != nil {
log.Fatalf("main : SplitHostPort : %s : %+v", baseSiteUrl.Host, err)
}
} else {
primaryDomain = baseSiteUrl.Host
}
}
// Init redirect middleware to ensure all requests go to the primary domain contained in the base URL.
if primaryServiceHost != "127.0.0.0" && primaryServiceHost != "localhost" {
redirect := mid.DomainNameRedirect(mid.DomainNameRedirectConfig{ redirect := mid.DomainNameRedirect(mid.DomainNameRedirectConfig{
RedirectConfig: mid.RedirectConfig{ RedirectConfig: mid.RedirectConfig{
Code: http.StatusMovedPermanently, Code: http.StatusMovedPermanently,
@ -353,9 +370,12 @@ func main() {
return false return false
}, },
}, },
DomainName: primaryDomain, DomainName: primaryServiceHost,
HTTPSEnabled: (cfg.HTTPS.Host != ""), HTTPSEnabled: cfg.Service.EnableHTTPS,
}) })
serviceMiddlewares = append(serviceMiddlewares, redirect)
}
// ========================================================================= // =========================================================================
// Start Tracing Support // Start Tracing Support
@ -371,13 +391,14 @@ func main() {
// //
// /debug/vars - Added to the default mux by the expvars package. // /debug/vars - Added to the default mux by the expvars package.
// /debug/pprof - Added to the default mux by the net/http/pprof package. // /debug/pprof - Added to the default mux by the net/http/pprof package.
if cfg.App.DebugHost != "" { if cfg.Service.DebugHost != "" {
go func() { go func() {
log.Printf("main : Debug Listening %s", cfg.App.DebugHost) log.Printf("main : Debug Listening %s", cfg.Service.DebugHost)
log.Printf("main : Debug Listener closed : %v", http.ListenAndServe(cfg.App.DebugHost, http.DefaultServeMux)) log.Printf("main : Debug Listener closed : %v", http.ListenAndServe(cfg.Service.DebugHost, http.DefaultServeMux))
}() }()
} }
// ========================================================================= // =========================================================================
// ECS Task registration for services that don't use an AWS Elastic Load Balancer. // ECS Task registration for services that don't use an AWS Elastic Load Balancer.
err = devops.EcsServiceTaskInit(log, awsSession) err = devops.EcsServiceTaskInit(log, awsSession)
@ -392,9 +413,9 @@ func main() {
{ {
docs.SwaggerInfo.Version = build docs.SwaggerInfo.Version = build
u, err := url.Parse(cfg.App.BaseUrl) u, err := url.Parse(cfg.Service.BaseUrl)
if err != nil { if err != nil {
log.Fatalf("main : Parse app base url %s : %+v", cfg.App.BaseUrl, err) log.Fatalf("main : Parse app base url %s : %+v", cfg.Service.BaseUrl, err)
} }
docs.SwaggerInfo.Host = u.Host docs.SwaggerInfo.Host = u.Host
@ -417,7 +438,7 @@ func main() {
if cfg.HTTP.Host != "" { if cfg.HTTP.Host != "" {
api := http.Server{ api := http.Server{
Addr: cfg.HTTP.Host, Addr: cfg.HTTP.Host,
Handler: handlers.API(shutdown, log, masterDb, redisClient, authenticator, redirect), Handler: handlers.API(shutdown, log, masterDb, redisClient, authenticator, serviceMiddlewares...),
ReadTimeout: cfg.HTTP.ReadTimeout, ReadTimeout: cfg.HTTP.ReadTimeout,
WriteTimeout: cfg.HTTP.WriteTimeout, WriteTimeout: cfg.HTTP.WriteTimeout,
MaxHeaderBytes: 1 << 20, MaxHeaderBytes: 1 << 20,
@ -434,7 +455,7 @@ func main() {
if cfg.HTTPS.Host != "" { if cfg.HTTPS.Host != "" {
api := http.Server{ api := http.Server{
Addr: cfg.HTTPS.Host, Addr: cfg.HTTPS.Host,
Handler: handlers.API(shutdown, log, masterDb, redisClient, authenticator, redirect), Handler: handlers.API(shutdown, log, masterDb, redisClient, authenticator, serviceMiddlewares...),
ReadTimeout: cfg.HTTPS.ReadTimeout, ReadTimeout: cfg.HTTPS.ReadTimeout,
WriteTimeout: cfg.HTTPS.WriteTimeout, WriteTimeout: cfg.HTTPS.WriteTimeout,
MaxHeaderBytes: 1 << 20, MaxHeaderBytes: 1 << 20,
@ -442,12 +463,12 @@ func main() {
// Generate a unique list of hostnames. // Generate a unique list of hostnames.
var hosts []string var hosts []string
if cfg.App.HostPrimary != "" { if primaryServiceHost != "" {
hosts = append(hosts, cfg.App.HostPrimary) hosts = append(hosts, primaryServiceHost)
} }
for _, h := range cfg.App.HostNames { for _, h := range cfg.Service.HostNames {
h = strings.TrimSpace(h) h = strings.TrimSpace(h)
if h != cfg.App.HostPrimary { if h != "" && h != primaryServiceHost {
hosts = append(hosts, h) hosts = append(hosts, h)
} }
} }
@ -482,6 +503,7 @@ func main() {
}() }()
} }
// ========================================================================= // =========================================================================
// Shutdown // Shutdown
@ -500,7 +522,7 @@ func main() {
} }
// Create context for Shutdown call. // Create context for Shutdown call.
ctx, cancel := context.WithTimeout(context.Background(), cfg.App.ShutdownTimeout) ctx, cancel := context.WithTimeout(context.Background(), cfg.Service.ShutdownTimeout)
defer cancel() defer cancel()
// Handle closing connections for both possible HTTP servers. // Handle closing connections for both possible HTTP servers.
@ -509,7 +531,7 @@ func main() {
// Asking listener to shutdown and load shed. // Asking listener to shutdown and load shed.
err := api.Shutdown(ctx) err := api.Shutdown(ctx)
if err != nil { if err != nil {
log.Printf("main : Graceful shutdown did not complete in %v : %v", cfg.App.ShutdownTimeout, err) log.Printf("main : Graceful shutdown did not complete in %v : %v", cfg.Service.ShutdownTimeout, err)
err = api.Close() err = api.Close()
} }

10
cmd/web-api/tests/account_test.go
View File

@ -7,11 +7,11 @@ import (
"net/http" "net/http"
"testing" "testing"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

10
cmd/web-api/tests/project_test.go
View File

@ -8,11 +8,11 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/project" "geeks-accelerator/oss/saas-starter-kit/internal/project"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

12
cmd/web-api/tests/signup_test.go
View File

@ -8,12 +8,12 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/signup" "geeks-accelerator/oss/saas-starter-kit/internal/signup"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

16
cmd/web-api/tests/tests_test.go
View File

@ -14,14 +14,14 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/cmd/web-api/handlers" "geeks-accelerator/oss/saas-starter-kit/cmd/web-api/handlers"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/signup" "geeks-accelerator/oss/saas-starter-kit/internal/signup"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user_account" "geeks-accelerator/oss/saas-starter-kit/internal/user_account"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/iancoleman/strcase" "github.com/iancoleman/strcase"
"github.com/pborman/uuid" "github.com/pborman/uuid"

14
cmd/web-api/tests/user_account_test.go
View File

@ -8,13 +8,13 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user_account" "geeks-accelerator/oss/saas-starter-kit/internal/user_account"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

12
cmd/web-api/tests/user_test.go
View File

@ -9,12 +9,12 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user_account" "geeks-accelerator/oss/saas-starter-kit/internal/user_account"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

2
cmd/web-app/Dockerfile
View File

@ -6,7 +6,7 @@ RUN apk --update --no-cache add \
git git
# Change dir to project base. # Change dir to project base.
WORKDIR $GOPATH/src/gitlab.com/geeks-accelerator/oss/saas-starter-kit/example-project WORKDIR $GOPATH/src/gitlab.com/geeks-accelerator/oss/saas-starter-kit
# Enable go modules. # Enable go modules.
ENV GO111MODULE="on" ENV GO111MODULE="on"

2
cmd/web-app/handlers/check.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis" "gopkg.in/DataDog/dd-trace-go.v1/contrib/go-redis/redis"

2
cmd/web-app/handlers/root.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
) )

6
cmd/web-app/handlers/routes.go
View File

@ -5,9 +5,9 @@ import (
"net/http" "net/http"
"os" "os"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
) )

2
cmd/web-app/handlers/user.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
) )

14
cmd/web-app/main.go
View File

@ -5,7 +5,7 @@ import (
"encoding/json" "encoding/json"
"expvar" "expvar"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
"html/template" "html/template"
"log" "log"
@ -21,12 +21,12 @@ import (
"syscall" "syscall"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/cmd/web-app/handlers" "geeks-accelerator/oss/saas-starter-kit/cmd/web-app/handlers"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/devops" "geeks-accelerator/oss/saas-starter-kit/internal/platform/devops"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/flag" "geeks-accelerator/oss/saas-starter-kit/internal/platform/flag"
img_resize "geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/img-resize" img_resize "geeks-accelerator/oss/saas-starter-kit/internal/platform/img-resize"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
template_renderer "geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web/template-renderer" template_renderer "geeks-accelerator/oss/saas-starter-kit/internal/platform/web/template-renderer"
"github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials" "github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/aws/session"

8
cmd/web-app/tests/tests_test.go
View File

@ -8,10 +8,10 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/cmd/web-app/handlers" "geeks-accelerator/oss/saas-starter-kit/cmd/web-app/handlers"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
) )
var a http.Handler var a http.Handler

8
cmd/web-app/tests/user_test.go
View File

@ -8,10 +8,10 @@ import (
"strings" "strings"
"testing" "testing"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts" "github.com/google/go-cmp/cmp/cmpopts"
"gopkg.in/mgo.v2/bson" "gopkg.in/mgo.v2/bson"

2
go.mod
View File

@ -1,4 +1,4 @@
module geeks-accelerator/oss/saas-starter-kit/example-project module geeks-accelerator/oss/saas-starter-kit
require ( require (
github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect

4
internal/account/account.go
View File

@ -3,10 +3,10 @@ package account
import ( import (
"context" "context"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pborman/uuid" "github.com/pborman/uuid"

4
internal/account/account_test.go
View File

@ -7,8 +7,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/dgrijalva/jwt-go" "github.com/dgrijalva/jwt-go"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"

2
internal/account/models.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"database/sql" "database/sql"
"database/sql/driver" "database/sql/driver"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"github.com/lib/pq" "github.com/lib/pq"

4
internal/mid/auth.go
View File

@ -5,8 +5,8 @@ import (
"net/http" "net/http"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

2
internal/mid/errors.go
View File

@ -5,7 +5,7 @@ import (
"log" "log"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

2
internal/mid/logger.go
View File

@ -6,7 +6,7 @@ import (
"net/http" "net/http"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

2
internal/mid/metrics.go
View File

@ -6,7 +6,7 @@ import (
"net/http" "net/http"
"runtime" "runtime"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

2
internal/mid/panics.go
View File

@ -5,7 +5,7 @@ import (
"net/http" "net/http"
"runtime/debug" "runtime/debug"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

2
internal/mid/redirect.go
View File

@ -4,7 +4,7 @@ import (
"context" "context"
"net/http" "net/http"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
) )

10
internal/mid/saas-swagger/README.md
View File

@ -26,7 +26,7 @@ saas middleware to automatically generate RESTful API documentation with Swagger
4. Import following in your code: 4. Import following in your code:
```go ```go
import "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger" // saas-swagger middleware import "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger" // saas-swagger middleware
``` ```
**Canonical example:** **Canonical example:**
@ -43,10 +43,10 @@ saas middleware to automatically generate RESTful API documentation with Swagger
"syscall" "syscall"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
saasSwagger "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger" saasSwagger "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger"
_ "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger/example/docs" // docs is generated by Swag CLI, you have to import it. _ "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
) )
// @title SaaS Example API // @title SaaS Example API

10
internal/mid/saas-swagger/example/main.go
View File

@ -9,11 +9,11 @@ import (
"syscall" "syscall"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid" "geeks-accelerator/oss/saas-starter-kit/internal/mid"
saasSwagger "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger" saasSwagger "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger"
_ "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger/example/docs" // docs is generated by Swag CLI, you have to import it. _ "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/flag" "geeks-accelerator/oss/saas-starter-kit/internal/platform/flag"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/kelseyhightower/envconfig" "github.com/kelseyhightower/envconfig"
) )

2
internal/mid/saas-swagger/swagger.go
View File

@ -9,7 +9,7 @@ import (
"regexp" "regexp"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/swaggo/files" "github.com/swaggo/files"
"github.com/swaggo/swag" "github.com/swaggo/swag"

4
internal/mid/saas-swagger/swagger_test.go
View File

@ -7,8 +7,8 @@ import (
"os" "os"
"testing" "testing"
_ "geeks-accelerator/oss/saas-starter-kit/example-project/internal/mid/saas-swagger/example/docs" _ "geeks-accelerator/oss/saas-starter-kit/internal/mid/saas-swagger/example/docs"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
) )

2
internal/mid/trace.go
View File

@ -3,7 +3,7 @@ package mid
import ( import (
"context" "context"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"

4
internal/platform/auth/auth_test.go
View File

@ -7,8 +7,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/pborman/uuid" "github.com/pborman/uuid"
) )

2
internal/platform/logger/log.go
View File

@ -3,7 +3,7 @@ package logger
import ( import (
"context" "context"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
) )
// WithContext manual injects context values to log message including Trace ID // WithContext manual injects context values to log message including Trace ID

2
internal/platform/session/session.go
View File

@ -1,7 +1,7 @@
package session package session
import ( import (
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
) )
// ctxKey represents the type of value for the context key. // ctxKey represents the type of value for the context key.

6
internal/platform/tests/main.go
View File

@ -3,7 +3,7 @@ package tests
import ( import (
"context" "context"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/schema" "geeks-accelerator/oss/saas-starter-kit/internal/schema"
"io" "io"
"log" "log"
"os" "os"
@ -11,8 +11,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/docker" "geeks-accelerator/oss/saas-starter-kit/internal/platform/docker"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/aws/session"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
) )

2
internal/platform/web/models.go
View File

@ -3,7 +3,7 @@ package web
import ( import (
"context" "context"
"fmt" "fmt"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/dustin/go-humanize" "github.com/dustin/go-humanize"
"strings" "strings"
"time" "time"

2
internal/platform/web/template-renderer/template_renderer.go
View File

@ -11,7 +11,7 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"

2
internal/project/models.go
View File

@ -3,7 +3,7 @@ package project
import ( import (
"context" "context"
"database/sql/driver" "database/sql/driver"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/lib/pq" "github.com/lib/pq"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

4
internal/project/project.go
View File

@ -3,8 +3,8 @@ package project
import ( import (
"context" "context"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pborman/uuid" "github.com/pborman/uuid"

4
internal/project/project_test.go
View File

@ -1,8 +1,8 @@
package project package project
import ( import (
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"os" "os"

4
internal/signup/models.go
View File

@ -2,8 +2,8 @@ package signup
import ( import (
"context" "context"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
) )
// SignupRequest contains information needed perform signup. // SignupRequest contains information needed perform signup.

10
internal/signup/signup.go
View File

@ -2,13 +2,13 @@ package signup
import ( import (
"context" "context"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user_account" "geeks-accelerator/oss/saas-starter-kit/internal/user_account"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer" "gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

6
internal/signup/signup_test.go
View File

@ -5,9 +5,9 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/user" "geeks-accelerator/oss/saas-starter-kit/internal/user"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/pborman/uuid" "github.com/pborman/uuid"
"github.com/pkg/errors" "github.com/pkg/errors"

4
internal/user/auth.go
View File

@ -4,12 +4,12 @@ import (
"context" "context"
"crypto/rsa" "crypto/rsa"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"github.com/dgrijalva/jwt-go" "github.com/dgrijalva/jwt-go"
"strings" "strings"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/lib/pq" "github.com/lib/pq"

4
internal/user/auth_test.go
View File

@ -5,8 +5,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/pborman/uuid" "github.com/pborman/uuid"
"github.com/pkg/errors" "github.com/pkg/errors"

4
internal/user/models.go
View File

@ -3,8 +3,8 @@ package user
import ( import (
"context" "context"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"github.com/lib/pq" "github.com/lib/pq"

4
internal/user/user.go
View File

@ -3,10 +3,10 @@ package user
import ( import (
"context" "context"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pborman/uuid" "github.com/pborman/uuid"

4
internal/user/user_test.go
View File

@ -7,8 +7,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/dgrijalva/jwt-go" "github.com/dgrijalva/jwt-go"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"

4
internal/user_account/models.go
View File

@ -3,10 +3,10 @@ package user_account
import ( import (
"context" "context"
"database/sql/driver" "database/sql/driver"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/lib/pq" "github.com/lib/pq"
"github.com/pkg/errors" "github.com/pkg/errors"
"gopkg.in/go-playground/validator.v9" "gopkg.in/go-playground/validator.v9"

6
internal/user_account/user_account.go
View File

@ -3,11 +3,11 @@ package user_account
import ( import (
"context" "context"
"database/sql" "database/sql"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/account" "geeks-accelerator/oss/saas-starter-kit/internal/account"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web" "geeks-accelerator/oss/saas-starter-kit/internal/platform/web"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pborman/uuid" "github.com/pborman/uuid"

4
internal/user_account/user_account_test.go
View File

@ -8,8 +8,8 @@ import (
"testing" "testing"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth" "geeks-accelerator/oss/saas-starter-kit/internal/platform/auth"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"github.com/dgrijalva/jwt-go" "github.com/dgrijalva/jwt-go"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/huandu/go-sqlbuilder" "github.com/huandu/go-sqlbuilder"

4
tools/truss/cmd/dbtable2crud/dbtable2crud.go
View File

@ -7,8 +7,8 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/schema" "geeks-accelerator/oss/saas-starter-kit/internal/schema"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/internal/goparse" "geeks-accelerator/oss/saas-starter-kit/tools/truss/internal/goparse"
"github.com/dustin/go-humanize/english" "github.com/dustin/go-humanize/english"
"github.com/fatih/camelcase" "github.com/fatih/camelcase"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"

2
tools/truss/cmd/dbtable2crud/models.go
View File

@ -4,7 +4,7 @@ import (
"log" "log"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/internal/goparse" "geeks-accelerator/oss/saas-starter-kit/tools/truss/internal/goparse"
"github.com/fatih/structtag" "github.com/fatih/structtag"
"github.com/jmoiron/sqlx" "github.com/jmoiron/sqlx"
"github.com/pkg/errors" "github.com/pkg/errors"

2
tools/truss/cmd/dbtable2crud/templates.go
View File

@ -13,7 +13,7 @@ import (
"strings" "strings"
"text/template" "text/template"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/internal/goparse" "geeks-accelerator/oss/saas-starter-kit/tools/truss/internal/goparse"
"github.com/dustin/go-humanize/english" "github.com/dustin/go-humanize/english"
"github.com/fatih/camelcase" "github.com/fatih/camelcase"
"github.com/iancoleman/strcase" "github.com/iancoleman/strcase"

12
tools/truss/cmd/devops/service_deploy.go
View File

@ -18,8 +18,8 @@ import (
"strings" "strings"
"time" "time"
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/tests" "geeks-accelerator/oss/saas-starter-kit/internal/platform/tests"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/internal/retry" "geeks-accelerator/oss/saas-starter-kit/tools/truss/internal/retry"
"github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr" "github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/service/acm" "github.com/aws/aws-sdk-go/service/acm"
@ -2569,6 +2569,7 @@ func ServiceDeploy(log *log.Logger, req *serviceDeployRequest) error {
"{DATADOG_ESSENTIAL}": "true", "{DATADOG_ESSENTIAL}": "true",
"{HTTP_HOST}": "0.0.0.0:80", "{HTTP_HOST}": "0.0.0.0:80",
"{HTTPS_HOST}": "", // Not enabled by default "{HTTPS_HOST}": "", // Not enabled by default
"{HTTPS_ENABLED}": "false",
"{APP_PROJECT}": req.ProjectName, "{APP_PROJECT}": req.ProjectName,
"{APP_BASE_URL}": "", // Not set by default, requires a hostname to be defined. "{APP_BASE_URL}": "", // Not set by default, requires a hostname to be defined.
@ -2605,10 +2606,15 @@ func ServiceDeploy(log *log.Logger, req *serviceDeployRequest) error {
placeholders["{DATADOG_ESSENTIAL}"] = "false" placeholders["{DATADOG_ESSENTIAL}"] = "false"
} }
// For HTTPS support.
if req.EnableHTTPS {
placeholders["{HTTPS_ENABLED}"] = "true"
// When there is no Elastic Load Balancer, we need to terminate HTTPS on the app. // When there is no Elastic Load Balancer, we need to terminate HTTPS on the app.
if req.EnableHTTPS && !req.EnableEcsElb { if !req.EnableEcsElb {
placeholders["{HTTPS_HOST}"] = "0.0.0.0:443" placeholders["{HTTPS_HOST}"] = "0.0.0.0:443"
} }
}
// When a domain name if defined for the service, set the App Base URL. Default to HTTPS if enabled. // When a domain name if defined for the service, set the App Base URL. Default to HTTPS if enabled.
if req.ServiceHostPrimary != "" { if req.ServiceHostPrimary != "" {

4
tools/truss/main.go
View File

@ -11,8 +11,8 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/cmd/dbtable2crud" "geeks-accelerator/oss/saas-starter-kit/tools/truss/cmd/dbtable2crud"
"geeks-accelerator/oss/saas-starter-kit/example-project/tools/truss/cmd/devops" "geeks-accelerator/oss/saas-starter-kit/tools/truss/cmd/devops"
"github.com/kelseyhightower/envconfig" "github.com/kelseyhightower/envconfig"
"github.com/lib/pq" "github.com/lib/pq"
_ "github.com/lib/pq" _ "github.com/lib/pq"