Mirakurun やアカウントの資格情報を未設定でも使用できるように改善 (#16)

* Update README.md

* Mirakurun の導入しなくても動作するように設計変更

* 資格情報などが設定されず連携機能を提供できない場合にログを出力

* URL を Pages に変更

* Update README.md

* PR 時に走る CI を修正

* ci7lus/elaina:latest に関する記述を追加

* ログレベルを変更可能にした

* バッジの CI 名を修正

Author: SlashNephy

.github/workflows/check.yml

@@ -0,0 +1,37 @@
+name: Check PR
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths-ignore:
+      - '*.md'
+
+  workflow_dispatch:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Using Caches
+        uses: actions/cache@v2.1.3
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+      - name: Setup JDK
+        uses: actions/setup-java@v1.4.3
+        with:
+          java-version: 1.8
+
+      - name: Grant Execute Permission to gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build

.github/workflows/main.yml .github/workflows/docker.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Docker
 
 on:
   push:
@@ -9,13 +9,6 @@ on:
     branches-ignore:
       - 'releases/**'
 
-  pull_request:
-    types:
-      - opened
-      - synchronize
-    paths-ignore:
-      - '*.md'
-
   release:
     types:
       - published
@@ -43,14 +36,14 @@ jobs:
         if: github.event_name == 'push' && github.ref == 'refs/heads/master'
         uses: docker/build-push-action@v2
         with:
-          push: ${{ github.event_name != 'pull_request' }}
+          push: true
           tags: ${{ env.DOCKER_BASE_NAME }}:latest
 
       - name: Build & Push (dev)
         if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
         uses: docker/build-push-action@v2
         with:
-          push: ${{ github.event_name != 'pull_request' }}
+          push: true
           tags: ${{ env.DOCKER_BASE_NAME }}:dev
 
       - name: Build & Push (Release)

README.md

@@ -1,15 +1,17 @@
 # saya: Japanese DTV backend service with powerful features
 
 [![Kotlin](https://img.shields.io/badge/Kotlin-1.4.21-blue)](https://kotlinlang.org)
-[![Docker Build Status](https://img.shields.io/docker/build/slashnephy/saya)](https://hub.docker.com/r/slashnephy/saya)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/SlashNephy/saya)](https://github.com/SlashNephy/saya/releases)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/SlashNephy/saya/Docker)](https://hub.docker.com/r/slashnephy/saya)
 [![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/slashnephy/saya)](https://hub.docker.com/r/slashnephy/saya)
+[![Docker Pulls](https://img.shields.io/docker/pulls/slashnephy/saya)](https://hub.docker.com/r/slashnephy/saya)
 [![license](https://img.shields.io/github/license/SlashNephy/saya)](https://github.com/SlashNephy/saya/blob/master/LICENSE)
 [![issues](https://img.shields.io/github/issues/SlashNephy/saya)](https://github.com/SlashNephy/saya/issues)
 [![pull requests](https://img.shields.io/github/issues-pr/SlashNephy/saya)](https://github.com/SlashNephy/saya/pulls)
 
 saya is still in heavy development.  
 
-- [REST API docs](https://atmos.starry.blue/saya)
+- [REST API docs](https://slashnephy.github.io/saya)
 - [Roadmap](https://github.com/SlashNephy/saya/projects/1)
 
 ---
@@ -34,14 +36,25 @@ saya is still in heavy development.
 次のプロジェクトとの併用を想定しています。
 
 - [Chinachu/Mirakurun](https://github.com/Chinachu/Mirakurun) or [mirakc/mirakc](https://github.com/mirakc/mirakc)
-  - Mirakurun と mirakc のどちらでも動作します。
+  - Mirakurun と mirakc のどちらでも動作します。なくても動作しますが一部制約が生じます。
 - [l3tnun/EPGStation](https://github.com/l3tnun/EPGStation)
+  - saya を動作させる上では不要です。elaina 上で番組を再生する場合に必要です。
 - [ci7lus/elaina](https://github.com/ci7lus/elaina)
+  - EPGStation を介した番組プレイヤーです。saya の API をフロントエンドで利用しています。
 
-# Setup
+# Docker
 
 環境構築が容易なので Docker で導入することをおすすめします。
 
+現在のベースイメージは `alpine` です。いくつかタグを用意しています。
+
+- `:latest`
+  master ブランチへのプッシュの際にビルドされます。安定しています。
+- `:dev`
+  dev ブランチへのプッシュの際にビルドされます。開発版のため, 不安定である可能性があります。
+- `:v<tag>`
+  GitHub 上のリリースに対応します。
+
 `docker-compose.yml`
 
 ```yaml
@@ -53,7 +66,7 @@ services:
     image: slashnephy/saya:latest
     restart: always
     ports:
-      - 1017:1017/tcp
+      - 1017:1017/tcp # いれいな
     # 環境変数で各種設定を行います
     # () 内の値はデフォルト値を示します
     environment:
@@ -64,6 +77,9 @@ services:
       # HTTP サーバのベース URI ("/")
       # リバースプロキシ時に直下以外に置きたい場合に変更します
       SAYA_BASE_URI: /
+      # ログレベル ("INFO")
+      # 利用可能な値: ALL, TRACE, DEBUG, INFO, WARN, ERROR, OFF
+      SAYA_LOG: DEBUG
       # Mirakurun のホスト, ポート番号 ("mirakurun", 40772)
       MIRAKURUN_HOST: mirakurun
       MIRAKURUN_PORT: 40772
@@ -76,13 +92,38 @@ services:
       TWITTER_AT: xxx
       TWITTER_ATS: xxx
 
+  elaina:
+    container_name: elaina
+    image: ci7lus/elaina:latest
+    restart: always
+    ports:
+      - 1234:1234/tcp
+
   mirakurun:
   epgstation:
     # https://github.com/l3tnun/docker-mirakurun-epgstation 等を参考にしてください。
     # サービス名, ポート番号等の変更がある場合には `MIRAKURUN_HOST`, `MIRAKURUN_PORT` の修正が必要になります。
 ```
 
-`http://localhost:1017/` にサーバが起動しているはずです。
+```console
+# イメージ更新
+docker pull slashnephy/saya:latest
+
+# 起動
+docker-compose up -d
+
+# ログ表示
+docker-compose logs -f
+
+# 停止
+docker-compose down
+```
+
+up すると `http://localhost:1017/` に saya が, `http://localhost:1234/` に elaina が起動しているはずです。
+
+# Endpoints
+
+TODO...
 
 # Acknowledgments
 

src/main/kotlin/blue/starry/saya/Module.kt

@@ -1,6 +1,7 @@
 package blue.starry.saya
 
 import blue.starry.saya.common.Env
+import blue.starry.saya.common.createSayaLogger
 import blue.starry.saya.endpoints.getIndex
 import blue.starry.saya.endpoints.wsLiveComments
 import blue.starry.saya.endpoints.wsTimeshiftComments
@@ -36,7 +37,7 @@ fun Application.module() {
         allowCredentials = true
     }
     install(CallLogging) {
-        logger = KotlinLogging.logger("saya.server")
+        logger = KotlinLogging.createSayaLogger("saya.server")
         format { call ->
             when (val status = call.response.status()) {
                 HttpStatusCode.Found -> "$status: ${call.request.toLogString()} -> ${call.response.headers[HttpHeaders.Location]}"

src/main/kotlin/blue/starry/saya/common/Env.kt

@@ -6,6 +6,7 @@ object Env {
     val SAYA_HOST by string { "0.0.0.0" }
     val SAYA_PORT by int { 1017 }
     val SAYA_BASE_URI by string { "/" }
+    val SAYA_LOG by string { "INFO" }
 
     val MIRAKURUN_HOST by string { "mirakurun" }
     val MIRAKURUN_PORT by int { 40772 }

src/main/kotlin/blue/starry/saya/common/Logger.kt

@@ -0,0 +1,15 @@
+package blue.starry.saya.common
+
+import ch.qos.logback.classic.Level
+import mu.KLogger
+import mu.KotlinLogging
+
+internal fun KotlinLogging.createSayaLogger(name: String): KLogger {
+    val logger = logger(name)
+    val underlying = logger.underlyingLogger
+    if (underlying is ch.qos.logback.classic.Logger) {
+        underlying.level = Level.toLevel(Env.SAYA_LOG, Level.INFO)
+    }
+
+    return logger
+}

src/main/kotlin/blue/starry/saya/common/ReadOnlyContainer.kt

@@ -8,12 +8,12 @@ import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import kotlin.time.minutes
 
-class ReadOnlyContainer<T: Any>(private val block: suspend () -> List<T>) {
+class ReadOnlyContainer<T: Any>(private val block: suspend () -> List<T>?) {
     private val mutex = Mutex()
     private val collection = mutableListOf<T>()
 
     private val initialJob = GlobalScope.launch {
-        collection.addAll(block())
+        collection.addAll(block() ?: return@launch)
     }
 
     init {
@@ -29,7 +29,7 @@ class ReadOnlyContainer<T: Any>(private val block: suspend () -> List<T>) {
         initialJob.join()
 
         mutex.withLock {
-            val new = block()
+            val new = block() ?: return
 
             collection.clear()
             collection.addAll(new)

src/main/kotlin/blue/starry/saya/endpoints/Comments.kt

@@ -1,5 +1,6 @@
 package blue.starry.saya.endpoints
 
+import blue.starry.saya.common.createSayaLogger
 import blue.starry.saya.models.Comment
 import blue.starry.saya.models.JikkyoChannel
 import blue.starry.saya.models.TimeshiftCommentControl
@@ -32,7 +33,7 @@ import mu.KotlinLogging
 import java.util.concurrent.atomic.AtomicLong
 import kotlin.math.roundToLong
 
-private val logger = KotlinLogging.logger("saya.endpoints")
+private val logger = KotlinLogging.createSayaLogger("saya.endpoints")
 
 private suspend fun DefaultWebSocketSession.rejectWs(message: () -> String) {
     close(CloseReason(CloseReason.Codes.CANNOT_ACCEPT, message()))

src/main/kotlin/blue/starry/saya/services/Client.kt

@@ -6,6 +6,7 @@ import blue.starry.penicillin.core.session.config.application
 import blue.starry.penicillin.core.session.config.httpClient
 import blue.starry.penicillin.core.session.config.token
 import blue.starry.saya.common.Env
+import blue.starry.saya.services.mirakurun.MirakurunApi
 import blue.starry.saya.services.miyoutv.MiyouTVApi
 import io.ktor.client.*
 import io.ktor.client.engine.cio.*
@@ -22,6 +23,7 @@ import mu.KotlinLogging
 import kotlin.time.minutes
 
 const val SayaUserAgent = "saya/2.0 (+https://github.com/SlashNephy/saya)"
+private val logger = KotlinLogging.logger("saya.client")
 
 val SayaHttpClient = run {
     HttpClient(CIO) {
@@ -57,6 +59,7 @@ val SayaTwitterClient = run {
     val (ck, cs) = Env.TWITTER_CK to Env.TWITTER_CS
     val (at, ats) = Env.TWITTER_AT to Env.TWITTER_ATS
     if (ck == null || cs == null || at == null || ats == null) {
+        logger.info { "Twitter の資格情報が設定されていません。Twitter 連携機能は提供しません。" }
         return@run null
     }
 
@@ -70,12 +73,19 @@ val SayaTwitterClient = run {
 }
 
 val SayaAnnictClient = run {
-    AnnictClient(Env.ANNICT_TOKEN ?: return@run null)
+    val token = Env.ANNICT_TOKEN
+    if (token == null) {
+        logger.info { "Annict の資格情報が設定されていません。Annict 連携機能は提供しません。" }
+        return@run null
+    }
+
+    AnnictClient(token)
 }
 
 val SayaMiyouTVApi = run {
     val (email, pass) = Env.MORITAPO_EMAIL to Env.MORITAPO_PASSWORD
     if (email == null || pass == null) {
+        logger.info { "MiyouTV の資格情報が設定されていません。MiyouTV 連携機能は提供しません。" }
         return@run null
     }
 
@@ -85,3 +95,19 @@ val SayaMiyouTVApi = run {
 
     MiyouTVApi(login.token)
 }
+
+val SayaMirakurunApi = run {
+    try {
+        val api = MirakurunApi(Env.MIRAKURUN_HOST, Env.MIRAKURUN_PORT)
+
+        // 接続テスト
+        runBlocking {
+            api.getStatus()
+        }
+
+        api
+    } catch (e: ResponseException) {
+        logger.info { "Mirakurun/mirakc に接続できません。Mirakurun/mirakc 連携機能は提供しません。" }
+        null
+    }
+}

src/main/kotlin/blue/starry/saya/services/mirakurun/Conversion.kt

@@ -1,6 +1,7 @@
 package blue.starry.saya.services.mirakurun
 
 import blue.starry.jsonkt.jsonObjectOf
+import blue.starry.saya.common.createSayaLogger
 import blue.starry.saya.models.TunerProcess
 import kotlinx.serialization.json.jsonPrimitive
 import mu.KotlinLogging
@@ -10,7 +11,7 @@ import blue.starry.saya.models.Program as SayaProgram
 import blue.starry.saya.models.Service as SayaService
 import blue.starry.saya.models.Tuner as SayaTuner
 
-private val logger = KotlinLogging.logger("saya.mirakurun")
+private val logger = KotlinLogging.createSayaLogger("saya.mirakurun")
 
 fun Service.toSayaService(): SayaService? {
     return SayaService(