feat generator: add support for sqlc code generation (#146)

* feat generator: add support for sqlc code generation

* add command to add/remove postgres

* add docs

Author: chebykinn

.golangci.yml

@@ -0,0 +1,2 @@
+run:
+  deadline: 5m

cmd/mify/cmd/add.go

@@ -12,6 +12,7 @@ var (
 	addClientName      string
 	addServiceLanguage string
 	addFrontendType    string
+	addDatabaseEngine  string
 )
 
 var addServiceCmd = &cobra.Command{
@@ -71,11 +72,25 @@ var addApiGatewayCmd = &cobra.Command{
 	},
 }
 
+var addDatabase = &cobra.Command{
+	Use:   "database",
+	Short: "Add database",
+	Long:  `Add a database to workspace (default is Postgres)`,
+	Run: func(cmd *cobra.Command, args []string) {
+		for _, ival := range args {
+			if err := mify.AddPostgres(appContext, workspacePath, ival); err != nil {
+				fmt.Fprintf(os.Stderr, "failed to add postgres to service: %s\n", err)
+				os.Exit(2)
+			}
+		}
+	},
+}
+
 // addCmd represents the add command
 var addCmd = &cobra.Command{
 	Use:   "add",
-	Short: "Add <service|client|frontend>",
-	Long:  `Add a service, frontend or clients`,
+	Short: "Add <service|client|frontend|database>",
+	Long:  `Add a service, frontend or clients, or database`,
 	PersistentPreRun: func(*cobra.Command, []string) {
 		err := appContext.LoadWorkspace()
 		if err != nil {
@@ -107,8 +122,18 @@ func init() {
 		"Template (e.g. nuxtjs, react-ts)",
 	)
 
+	addDatabase.PersistentFlags().StringVarP(
+		&addDatabaseEngine,
+		"engine",
+		"e",
+		"postgres",
+		"DB Engine (Postgres, for now)",
+	)
+
 	addCmd.AddCommand(addServiceCmd)
 	addCmd.AddCommand(addClientCmd)
 	addCmd.AddCommand(addFrontendCmd)
 	addCmd.AddCommand(addApiGatewayCmd)
+	addCmd.AddCommand(addApiGatewayCmd)
+	addCmd.AddCommand(addDatabase)
 }

cmd/mify/cmd/remove.go

@@ -20,18 +20,33 @@ var removeClientCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		for _, ival := range args {
 			if err := mify.RemoveClient(appContext, workspacePath, ival, removeClientName); err != nil {
-				fmt.Fprintf(os.Stderr, "failed to add client to service: %s\n", err)
+				fmt.Fprintf(os.Stderr, "failed to remove client to service: %s\n", err)
 				os.Exit(2)
 			}
 		}
 	},
 }
 
-// addCmd represents the add command
+var removeDatabaseCmd = &cobra.Command{
+	Use:   "database",
+	Short: "Remove database",
+	Long:  `Remove database from service`,
+	Args:  cobra.MinimumNArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		for _, ival := range args {
+			if err := mify.RemovePostgres(appContext, workspacePath, ival); err != nil {
+				fmt.Fprintf(os.Stderr, "failed to remove database from service: %s\n", err)
+				os.Exit(2)
+			}
+		}
+	},
+}
+
+// removeCmd represents the remove command
 var removeCmd = &cobra.Command{
 	Use:   "remove",
-	Short: "Remove client",
-	Long:  `Remove client from service`,
+	Short: "Remove client or database",
+	Long:  `Remove client or database from service`,
 	PersistentPreRun: func(*cobra.Command, []string) {
 		err := appContext.LoadWorkspace()
 		if err != nil {
@@ -48,4 +63,5 @@ func init() {
 	}
 
 	removeCmd.AddCommand(removeClientCmd)
+	removeCmd.AddCommand(removeDatabaseCmd)
 }

docs/docs/components/postgres.md

@@ -17,7 +17,9 @@ postgres:
 After that you will be able to get `pgxpool.Pool` from `MifyServiceContext`
 `Postgres()` method. You can use it to directly make queries or use in some library.
 
-Here's an example how you can use it:
+### Using without helpers
+
+Here's an example how you can use it, just run queries from pool, which is created on startup:
 ```go
 
 func (s *PathToApiService) PathToApiGet(ctx *core.MifyRequestContext) (openapi.ServiceResponse, error) {
@@ -26,6 +28,49 @@ func (s *PathToApiService) PathToApiGet(ctx *core.MifyRequestContext) (openapi.S
 }
 ```
 
+### Using with sqlc
+
+After adding postgres you will notice `sql-queries/<service_db_name>` directory
+inside `go-services`. Create any file with `.sql` extension and refer to
+`queries.sql.example` or sqlc [documentation](https://docs.sqlc.dev/en/latest/tutorials/getting-started-postgresql.html)
+for adding queries. After you add them, run `mify generate` to translate them
+to go. Generated helpers with lie in `postgres` package, here's an example of
+how to use them, assuming you followed sqlc tutorial:
+
+```go
+// Call this from service_extra.go
+func NewAuthorsStorage(ctx *core.MifyServiceContext) *AuthorsStorage {
+    return &AuthorsStorage{
+        pool: ctx.Postgres(),
+    }
+}
+
+func (s *AuthorsStorage) CreateAuthor(
+    ctx *core.MifyRequestContext, name string, bio string) (domain.Author, error) {
+    dbConn := postgres.New(s.pool)
+    tx, err := s.pool.BeginTx(ctx, pgx.TxOptions{})
+    if err != nil {
+        return domain.Author{}, err
+    }
+    defer tx.Rollback(ctx)
+    res, err := dbConn.WithTx(tx).CreateAuthor(ctx, postgres.CreateAuthorParams{
+        Name: name,
+        Bio: bio,
+    })
+    if err != nil {
+        return domain.Author{}, err
+    }
+    if err := tx.Commit(ctx); err != nil {
+        return domain.Author{}, err
+    }
+    return domain.Author{
+        ID: res.ID,
+        Name: res.Name,
+        Bio: res.Bio,
+    }, nil
+}
+```
+
 ### Migrations
 
 Mify includes a way to apply migrations for a database via dbmate.

docs/docusaurus.config.js

@@ -55,10 +55,16 @@ const config = {
             label: 'Docs',
           },
           {
-            href: '#',
+            type: 'doc',
+            docId: 'cloud/overview',
             position: 'right',
             label: 'Cloud',
           },
+          {
+            href: 'https://mify.io/pricing',
+            label: 'Pricing',
+            position: 'right',
+          },
           {
             href: 'https://github.com/mify-io/mify',
             label: 'GitHub',

docs/src/css/custom.css

@@ -29,7 +29,6 @@
     max-width: 130em;
     width: 100%;
     margin: 0 auto;
-    padding: 0 2rem;
 }
 
 .navbar__logo {

go.mod

@@ -9,21 +9,27 @@ require (
 	github.com/getkin/kin-openapi v0.88.0
 	github.com/go-resty/resty/v2 v2.7.0
 	github.com/google/uuid v1.2.0
+	github.com/kyleconroy/sqlc v1.17.0
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/otiai10/copy v1.7.0
 	github.com/pmezard/go-difflib v1.0.0
-	github.com/spf13/cobra v1.3.0
+	github.com/spf13/cobra v1.6.1
 	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.10.1
 	github.com/vbauerster/mpb/v7 v7.3.2
-	golang.org/x/text v0.3.7
+	golang.org/x/text v0.7.0
 	gopkg.in/yaml.v2 v2.4.0
 	k8s.io/client-go v0.20.6
 )
 
 require (
 	github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 // indirect
 	github.com/acomagu/bufpipe v1.0.3 // indirect
+	github.com/antlr/antlr4/runtime/Go/antlr v0.0.0-20220626175859-9abda183db8e // indirect
+	github.com/benbjohnson/clock v1.1.0 // indirect
+	github.com/bytecodealliance/wasmtime-go/v5 v5.0.0 // indirect
+	github.com/cubicdaiya/gonp v1.0.4 // indirect
+	github.com/cznic/mathutil v0.0.0-20181122101859-297441e03548 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/emirpasic/gods v1.12.0 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
@@ -34,8 +40,9 @@ require (
 	github.com/google/gofuzz v1.1.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/imdario/mergo v0.3.12 // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/inconshreveable/mousetrap v1.0.1 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect
@@ -46,6 +53,11 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
+	github.com/pganalyze/pg_query_go/v2 v2.2.0 // indirect
+	github.com/pingcap/errors v0.11.5-0.20210425183316-da1aaba5fb63 // indirect
+	github.com/pingcap/log v0.0.0-20210906054005-afc726e70354 // indirect
+	github.com/pingcap/tidb/parser v0.0.0-20220725134311-c80026e61f00 // indirect
+	github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0 // indirect
 	github.com/sergi/go-diff v1.1.0 // indirect
 	github.com/spf13/afero v1.8.0 // indirect
 	github.com/spf13/cast v1.4.1 // indirect
@@ -55,17 +67,19 @@ require (
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/goleak v1.1.12 // indirect
 	go.uber.org/multierr v1.7.0 // indirect
-	golang.org/x/crypto v0.0.0-20220126234351-aa10faf2a1f8 // indirect
-	golang.org/x/exp v0.0.0-20220303212507-bbda1eaf7a17 // indirect
+	golang.org/x/crypto v0.6.0 // indirect
+	golang.org/x/exp v0.0.0-20220428152302-39d4317da171 // indirect
 	golang.org/x/oauth2 v0.0.0-20211104180415-d3ed0bb246c8 // indirect
-	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
-	golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 // indirect
+	golang.org/x/sync v0.1.0 // indirect
+	golang.org/x/sys v0.5.0 // indirect
+	golang.org/x/term v0.5.0 // indirect
 	golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/ini.v1 v1.66.3 // indirect
+	gopkg.in/natefinch/lumberjack.v2 v2.0.0 // indirect
 	gopkg.in/warnings.v0 v0.1.2 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apimachinery v0.20.6 // indirect
 	k8s.io/klog/v2 v2.4.0 // indirect
 	k8s.io/utils v0.0.0-20201110183641-67b214c5f920 // indirect
@@ -101,10 +115,10 @@ require (
 	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/samber/lo v1.37.0
 	github.com/sirupsen/logrus v1.8.1 // indirect
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.8.0
 	go.uber.org/zap v1.20.0
-	golang.org/x/net v0.0.0-20220127074510-2fabfed7e28f // indirect
+	golang.org/x/net v0.6.0 // indirect
 	google.golang.org/genproto v0.0.0-20220126215142-9970aeb2e350 // indirect
 	google.golang.org/grpc v1.44.0 // indirect
-	google.golang.org/protobuf v1.27.1 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 )