Merge pull request #47 from rarimo/add-maintenance

Add maintenance

config-testing.yaml

@@ -8,6 +8,9 @@ db:
 listener:
   addr: localhost:8000
 
+maintenance:
+  is_maintenance: false
+
 event_types:
   types:
     - name: free_weekly

config.yaml

@@ -8,6 +8,9 @@ db:
 listener:
   addr: localhost:8000
 
+maintenance:
+  is_maintenance: false
+
 event_types:
   types:
     - name: passport_scan

docs/spec/components/schemas/Maintenance.yaml

@@ -0,0 +1,15 @@
+allOf:
+  - $ref: '#/components/schemas/MaintenanceKey'
+  - type: object
+    required:
+      - attributes
+    properties:
+      attributes:
+        type: object
+        required:
+          - maintenance
+        properties:
+          maintenance:
+            type: bool
+            example: false
+            description: "true if the service is under maintenance and false otherwise."

docs/spec/components/schemas/MaintenanceKey.yaml

@@ -0,0 +1,7 @@
+type: object
+required:
+  - type
+properties:
+  type:
+    type: string
+    enum: [ maintenance ]

docs/spec/paths/integrations@rarime-points-svc@v1@public@maintenance.yaml

@@ -0,0 +1,18 @@
+get:
+  tags:
+    - Maintenance
+  summary: Get maintenance status
+  description: Returns true if the service is under maintenance and false otherwise.
+  operationId: getMaintenanceStatus
+  responses:
+    200:
+      description: Success
+      content:
+        application/vnd.api+json:
+          schema:
+            type: object
+            required:
+              - data
+            properties:
+              data:
+                $ref: '#/components/schemas/Maintenance'

internal/config/main.go

@@ -26,6 +26,7 @@ type Config interface {
 	Levels() Levels
 	Verifier() *zk.Verifier
 	PointPrice() PointsPrice
+	Maintenance() Maintenance
 }
 
 type config struct {
@@ -39,10 +40,12 @@ type config struct {
 	sbtcheck.SbtChecker
 	countrier.Countrier
 
-	levels     comfig.Once
-	verifier   comfig.Once
-	pointPrice comfig.Once
-	getter     kv.Getter
+	levels      comfig.Once
+	verifier    comfig.Once
+	pointPrice  comfig.Once
+	maintenance comfig.Once
+
+	getter kv.Getter
 }
 
 func New(getter kv.Getter) Config {

internal/config/maintenance.go

@@ -0,0 +1,27 @@
+package config
+
+import (
+	"fmt"
+
+	"gitlab.com/distributed_lab/figure/v3"
+	"gitlab.com/distributed_lab/kit/kv"
+)
+
+type Maintenance struct {
+	IsMaintenance bool `fig:"is_maintenance"`
+}
+
+func (c *config) Maintenance() Maintenance {
+	return c.maintenance.Do(func() interface{} {
+		var cfg Maintenance
+
+		err := figure.Out(&cfg).
+			From(kv.MustGetStringMap(c.getter, "maintenance")).
+			Please()
+		if err != nil {
+			panic(fmt.Errorf("failed to figure out is_maintenance: %w", err))
+		}
+
+		return cfg
+	}).(Maintenance)
+}

internal/service/handlers/ctx.go

@@ -30,6 +30,7 @@ const (
 	verifierCtxKey
 	levelsCtxKey
 	countriesConfigCtxKey
+	maintenanceCtxKey
 )
 
 func CtxLog(entry *logan.Entry) func(context.Context) context.Context {
@@ -161,3 +162,13 @@ func CtxCountriesConfig(config countrier.Config) func(context.Context) context.C
 func CountriesConfig(r *http.Request) countrier.Config {
 	return r.Context().Value(countriesConfigCtxKey).(countrier.Config)
 }
+
+func CtxMaintenance(maintenance config.Maintenance) func(context.Context) context.Context {
+	return func(ctx context.Context) context.Context {
+		return context.WithValue(ctx, maintenanceCtxKey, maintenance)
+	}
+}
+
+func MaintenanceConfig(r *http.Request) config.Maintenance {
+	return r.Context().Value(maintenanceCtxKey).(config.Maintenance)
+}

internal/service/handlers/maintenance.go

@@ -0,0 +1,21 @@
+package handlers
+
+import (
+	"net/http"
+
+	"github.com/rarimo/rarime-points-svc/resources"
+	"gitlab.com/distributed_lab/ape"
+)
+
+func MaintenanceHandler(w http.ResponseWriter, r *http.Request) {
+	ape.Render(w, resources.MaintenanceResponse{
+		Data: resources.Maintenance{
+			Key: resources.Key{
+				Type: resources.MAINTENANCE,
+			},
+			Attributes: resources.MaintenanceAttributes{
+				Maintenance: MaintenanceConfig(r).IsMaintenance,
+			},
+		},
+	})
+}

internal/service/router.go

@@ -25,6 +25,7 @@ func Run(ctx context.Context, cfg config.Config) {
 			handlers.CtxLevels(cfg.Levels()),
 			handlers.CtxVerifier(cfg.Verifier()),
 			handlers.CtxCountriesConfig(cfg.Countries()),
+			handlers.CtxMaintenance(cfg.Maintenance()),
 		),
 		handlers.DBCloneMiddleware(cfg.DB()),
 	)
@@ -51,6 +52,7 @@ func Run(ctx context.Context, cfg config.Config) {
 			r.Get("/point_price", handlers.GetPointPrice)
 			r.Get("/countries_config", handlers.GetCountriesConfig)
 			r.Get("/event_types", handlers.ListEventTypes)
+			r.Get("/maintenance", handlers.MaintenanceHandler)
 		})
 		// must be accessible only within the cluster
 		r.Route("/private", func(r chi.Router) {

resources/model_maintenance.go

@@ -0,0 +1,43 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+import "encoding/json"
+
+type Maintenance struct {
+	Key
+	Attributes MaintenanceAttributes `json:"attributes"`
+}
+type MaintenanceResponse struct {
+	Data     Maintenance `json:"data"`
+	Included Included    `json:"included"`
+}
+
+type MaintenanceListResponse struct {
+	Data     []Maintenance   `json:"data"`
+	Included Included        `json:"included"`
+	Links    *Links          `json:"links"`
+	Meta     json.RawMessage `json:"meta,omitempty"`
+}
+
+func (r *MaintenanceListResponse) PutMeta(v interface{}) (err error) {
+	r.Meta, err = json.Marshal(v)
+	return err
+}
+
+func (r *MaintenanceListResponse) GetMeta(out interface{}) error {
+	return json.Unmarshal(r.Meta, out)
+}
+
+// MustMaintenance - returns Maintenance from include collection.
+// if entry with specified key does not exist - returns nil
+// if entry with specified key exists but type or ID mismatches - panics
+func (c *Included) MustMaintenance(key Key) *Maintenance {
+	var maintenance Maintenance
+	if c.tryFindEntry(key, &maintenance) {
+		return &maintenance
+	}
+	return nil
+}

resources/model_maintenance_attributes.go

@@ -0,0 +1,10 @@
+/*
+ * GENERATED. Do not modify. Your changes might be overwritten!
+ */
+
+package resources
+
+type MaintenanceAttributes struct {
+	// true if the service is under maintenance and false otherwise.
+	Maintenance bool `json:"maintenance"`
+}

resources/model_resource_type.go

@@ -16,6 +16,7 @@ const (
 	EVENT                ResourceType = "event"
 	EVENT_TYPE           ResourceType = "event_type"
 	JOIN_PROGRAM         ResourceType = "join_program"
+	MAINTENANCE          ResourceType = "maintenance"
 	PASSPORT_EVENT_STATE ResourceType = "passport_event_state"
 	POINT_PRICE          ResourceType = "point_price"
 	VERIFY_PASSPORT      ResourceType = "verify_passport"