Merge pull request #242 from traPtitech/feature/#200-response-version

Feature/#200 response version

.github/workflows/develop.yml

@@ -12,6 +12,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Set KNOQ_VERSION env
+        run: echo "KNOQ_VERSION=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
+      - name: Set KNOQ_REVISION env
+        run: echo "KNOQ_REVISION=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
       - name: Set up Docker Buildx
@@ -28,5 +32,8 @@ jobs:
           context: .
           push: true
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            KNOQ_VERSION=${{ env.KNOQ_VERSION }}
+            KNOQ_REVISION=${{ env.KNOQ_REVISION }}
           tags: |
             ghcr.io/traptitech/${{ env.IMAGE_NAME }}:beta

.github/workflows/main.yml

@@ -14,6 +14,10 @@ jobs:
       - name: Set IMAGE_TAG env
         run: echo "IMAGE_TAG=$(echo ${GITHUB_REF:11})" >> $GITHUB_ENV
       - uses: actions/checkout@v2
+      - name: Set KNOQ_VERSION env
+        run: echo "KNOQ_VERSION=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
+      - name: Set KNOQ_REVISION env
+        run: echo "KNOQ_REVISION=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v1
       - name: Set up Docker Buildx
@@ -30,6 +34,9 @@ jobs:
           context: .
           push: true
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            KNOQ_VERSION=${{ env.KNOQ_VERSION }}
+            KNOQ_REVISION=${{ env.KNOQ_REVISION }}
           tags: |
             ghcr.io/traptitech/${{ env.IMAGE_NAME }}:latest
             ghcr.io/traptitech/${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}

README.md

@@ -41,6 +41,8 @@ knoQ の全ての機能を動作させるためには、追加の情報が必要
 | WEBHOOK_SECRET  | 環境変数 |                                        | Bot 情報                                                                   |
 | CHANNEL_ID      | 環境変数 |                                        | Bot の送信先チャンネル                                                     |
 | TOKEN_KEY       | 環境変数 | `random32wordsXXXXXXXXXXXXXXXXXXX`     | Token を暗号化する。長さ 32 文字のランダム文字列。存在しない場合はエラー。 |
+| KNOQ_VERSION    | 環境変数 | UNKNOWN                                | knoQ のバージョン (github actions でイメージ作成時に指定)                  |
+| KNOQ_REVISION   | 環境変数 | UNKNOWN                                | git の sha1 (github actions でイメージ作成時に指定)                        |
 | DEVELOPMENT     | 環境変数 |                                        | 開発時かどうか                                                             |
 | service.json    | ファイル | 空のファイル                           | google calendar api に必要（権限は必要なし）                               |
 

development/.env.example

@@ -5,4 +5,6 @@ WEBHOOK_ID=
 WEBHOOK_SECRET=
 CHANNEL_ID=
 TOKEN_KEY=
+KNOQ_VERSION=
+KNOQ_REVISION=
 DEVELOPMENT=

development/docker-compose.yml

@@ -23,6 +23,7 @@ services:
       WEBHOOK_SECRET: ${WEBHOOK_SECRET}
       CHANNEL_ID: ${CHANNEL_ID}
       TOKEN_KEY: ${TOKEN_KEY:-random32wordsXXXXXXXXXXXXXXXXXXX}
+      KNOQ_VERSION: ${KNOQ_VERSION:-dev}
       DEVELOPMENT: true
     volumes:
       - ../main.go:/srv/knoq/main.go

docs/swagger.yaml

@@ -4,7 +4,7 @@ info:
   title: traP knoQ
   description: |
     This is a sample knoQ server.
-  version: 2.1.0
+  version: 2.1.3
 
 servers:
   - url: http://knoq.trap.jp/api
@@ -29,6 +29,8 @@ tags:
     description: 認証
   - name: iCal
     description: ics出力
+  - name: public
+    description: 外部公開API
 
 paths:
   /rooms:
@@ -525,6 +527,7 @@ paths:
     post:
       tags:
         - authentication
+        - public
       operationId: getAuthParams
       description: リクエストに必要な情報を返す
       responses:
@@ -572,6 +575,26 @@ paths:
                 type: string
               example: "BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:github.com/lestrrat-go/ical\nBEGIN:VTIMEZONE\nTZID:Asia/Tokyo\nBEGIN:STANDARD\nDTSTART:19700101T000000\nTZNAME:JST\nTZOFFSETFROM:+9000\nTZOFFSETTO:+9000\nEND:STANDARD\nEND:VTIMEZONE\nBEGIN:VEVENT\nCREATED:20'200'827T09'400'8Z\nDESCRIPTION:asd¥n-----------------------------------¥nイベント詳細ページ¥nhttp://loc\nalhost:'400'0/events/855cff6d-aef6-4de2-8ba5-bc0c3e76a617\nDTEND:20'200'828T1'400'00Z\nDTSTAMP:20'200'904T145144Z\nDTSTART:20'200'828T050000Z\nLAST-MODIFIED:20'200'827T09'400'8Z\nLOCATION:dfaaa\nORGANIZER:18984a38-4dc7-41ab-9c8d-f5469a8e30a9\nSUMMARY:sadfwe\nUID:855cff6d-aef6-4de2-8ba5-bc0c3e76a617\nEND:VEVENT\nBEGIN:VEVENT\nCREATED:20'200'827T09'400'8Z\nDESCRIPTION:asd¥n-----------------------------------¥nイベント詳細ページ¥nhttp://loc\nalhost:'400'0/events/855cff6d-aef6-4de2-8ba5-bc0c3e76a617\nDTEND:20'200'828T1'400'00Z\nDTSTAMP:20'200'904T145144Z\nDTSTART:20'200'828T050000Z\nLAST-MODIFIED:20'200'827T09'400'8Z\nLOCATION:dfaaa\nORGANIZER:18984a38-4dc7-41ab-9c8d-f5469a8e30a9\nSUMMARY:sadfwe\nUID:855cff6d-aef6-4de2-8ba5-bc0c3e76a617\nEND:VEVENT\nEND:VCALENDAR"
 
+  /version:
+    get:
+      tags:
+        - public
+      operationId: getVersion
+      description: version情報を取得
+      responses:
+        '200':
+          description: versionを出力
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  version:
+                    type: string
+                    example: v2.1.3
+                  revision:
+                    type: string
+                    example: 587c185
 components:
   schemas:
     # will delete

domain/domain.go

@@ -7,6 +7,8 @@ import (
 )
 
 var (
+	VERSION     string = "UNKNOWN"
+	REVISION    string = "UNKNOWN"
 	DEVELOPMENT bool
 )
 

infra/db/event.go

@@ -165,7 +165,7 @@ func createEventFilter(expr filter.Expr) (string, []interface{}, error) {
 		filter.AttrName:      "events.name",
 		filter.AttrGroup:     "events.group_id",
 		filter.AttrRoom:      "events.room_id",
-		filter.AttrTag:       "events.event_tags.tag_id",
+		filter.AttrTag:       "event_tags.tag_id",
 		filter.AttrEvent:     "events.id",
 		filter.AttrTimeStart: "events.time_start",
 		filter.AttrTimeEnd:   "events.time_end",

main.go

@@ -24,6 +24,8 @@ import (
 
 func main() {
 	logger, _ := zap.NewDevelopment()
+	domain.VERSION = os.Getenv("KNOQ_VERSION")
+	domain.REVISION = os.Getenv("KNOQ_REVISION")
 	domain.DEVELOPMENT, _ = strconv.ParseBool(os.Getenv("DEVELOPMENT"))
 
 	gormRepo := db.GormRepository{}

presentation/presentation.go

@@ -7,3 +7,8 @@ type Model struct {
 	UpdatedAt time.Time  `json:"updatedAt"`
 	DeletedAt *time.Time `json:"deletedAt,omitempty"`
 }
+
+type Version struct {
+	Version  string `json:"version"`
+	Revision string `json:"revision"`
+}

router/middleware.go

@@ -74,6 +74,16 @@ func AccessLoggingMiddleware(logger *zap.Logger) echo.MiddlewareFunc {
 	}
 }
 
+// ServerVersionMiddleware X-KNOQ-VERSIONをレスポンスヘッダーを追加するミドルウェア
+func ServerVersionMiddleware(version string) echo.MiddlewareFunc {
+	return func(next echo.HandlerFunc) echo.HandlerFunc {
+		return func(c echo.Context) error {
+			c.Response().Header().Set("X-KNOQ-VERSION", version)
+			return next(c)
+		}
+	}
+}
+
 // TraQUserMiddleware traQユーザーか判定するミドルウェア
 // TODO funcname fix
 func (h *Handlers) TraQUserMiddleware(next echo.HandlerFunc) echo.HandlerFunc {

router/router.go

@@ -46,6 +46,8 @@ func (h *Handlers) SetupRoute() *echo.Echo {
 	}
 	e.Use(session.Middleware(sessions.NewCookieStore(h.SessionKey)))
 
+	e.Use(ServerVersionMiddleware(domain.VERSION))
+
 	// TODO fix "portal origin"
 	e.Use(middleware.CORSWithConfig(middleware.CORSConfig{
 		AllowOrigins:     []string{"https://portal.trap.jp", "http://localhost:8080"},
@@ -142,6 +144,7 @@ func (h *Handlers) SetupRoute() *echo.Echo {
 	e.POST("/api/authParams", h.HandlePostAuthParams)
 	e.GET("/api/callback", h.HandleCallback)
 	e.GET("/api/ical/v1/:userIDsecret", h.HandleGetiCalByPrivateID)
+	e.GET("/api/version", h.HandleGetVersion)
 
 	e.Use(middleware.StaticWithConfig(middleware.StaticConfig{
 		Skipper: func(c echo.Context) bool {

router/version.go

@@ -0,0 +1,16 @@
+package router
+
+import (
+	"net/http"
+
+	"github.com/labstack/echo/v4"
+	"github.com/traPtitech/knoQ/domain"
+	"github.com/traPtitech/knoQ/presentation"
+)
+
+func (h *Handlers) HandleGetVersion(c echo.Context) error {
+	return c.JSON(http.StatusOK, presentation.Version{
+		Version:  domain.VERSION,
+		Revision: domain.REVISION,
+	})
+}