feat: add healthcheck api

Author: hisasann

nuxt.config.ts

@@ -11,7 +11,10 @@ module.exports = {
   mode: 'universal',
   srcDir: 'src/',
 
-  // ビルド時に渡される env の値は、ここに記載することで文字列に置換される
+  /**
+   * 環境変数
+   * ビルド時に渡される env の値は、ここに記載することで文字列に置換される
+   */
   env: {
     NODE_ENV: process.env.NODE_ENV,
     BUILD_ENV: process.env.BUILD_ENV,
@@ -20,12 +23,13 @@ module.exports = {
     externalEndpointUrl: process.env.externalEndpointUrl
   },
 
-  /*
-   ** Build configuration
+  /**
+   * Build configuration
+   * webpack のビルドに関する設定はここに書く
    */
   build: {
-    /*
-     ** You can extend webpack config here
+    /**
+     * You can extend webpack config here
      */
     extend(config: Configuration, ctx: Context): void {
       // Run ESLint on save
@@ -54,8 +58,11 @@ module.exports = {
       }
     },
     extractCSS: isProduction,
+
+    // ビルドを爆速にする
     // https://qiita.com/toaru/items/0690a9110c94052bb479
     hardSource: true,
+
     terser: {
       terserOptions: {
         compress: {
@@ -74,8 +81,8 @@ module.exports = {
     host: '0.0.0.0' // デフォルト: localhost
   },
 
-  /*
-   ** Headers of the page
+  /**
+   * Headers of the page
    */
   head: {
     title: pkg.name,
@@ -87,21 +94,22 @@ module.exports = {
     link: [{ rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }]
   },
 
-  /*
-   ** Customize the progress-bar color
+  /**
+   * Customize the progress-bar color
    */
   loading: {
     color: 'blue',
     height: '5px'
   },
 
-  /*
-   ** Global CSS
+  /**
+   * Global CSS
+   * 他の scss ファイルに依存しない scss はこちらに
    */
   css: ['@/assets/styles/reset.scss', '@/assets/styles/main.scss'],
 
-  /*
-   ** Plugins to load before mounting the App
+  /**
+   * Plugins to load before mounting the App
    */
   plugins: [
     '@/plugins/axios.ts',
@@ -143,8 +151,8 @@ module.exports = {
     config: {} // Additional config
   },
 
-  /*
-   ** Axios module configuration
+  /**
+   * Axios module configuration
    */
   axios: {
     // See https://github.com/nuxt-community/axios-module#options
@@ -168,7 +176,17 @@ module.exports = {
     }
   },
 
+  /**
+   * Sass の @extend を使う場合はこのパスの scss ファイルに CSS クラスを書く
+   */
   styleResources: {
     scss: ['@/assets/styles/components/**/*.scss']
-  }
+  },
+
+  /**
+   * nuxt サーバーを API サーバーとして使う場合のミドルウェアを定義する
+   */
+  serverMiddleware: [
+    { path: '/api/healthcheck', handler: '~/api/healthcheck.js' }
+  ]
 }

src/api/healthcheck.js

@@ -0,0 +1,44 @@
+// https://ja.nuxtjs.org/api/configuration-servermiddleware/
+const axios = require('axios')
+
+const HEALTHCHECK_PATH = '/healthcheck'
+
+// 関数の仕様はこちら
+// https://github.com/senchalabs/connect#appusefn
+module.exports = (req, res, next) => {
+  console.log('/start healthcheck---')
+
+  let internalHealthcheckUrl
+
+  if (process.env.BUILD_ENV === 'docker') {
+    /** docker のビルド環境の環境変数から値を取ってくる */
+    internalHealthcheckUrl = `${
+      process.env.internalEndpointUrl
+    }${HEALTHCHECK_PATH}`
+  } else {
+    /** docker でビルドされていない場合は、 .env.local から値を取ってくる */
+    internalHealthcheckUrl = `http://localhost:5000${HEALTHCHECK_PATH}`
+  }
+  console.log('internalHealthcheckUrl:', internalHealthcheckUrl)
+
+  res.writeHead(200, {
+    'Content-Type': 'text/plain'
+    // 'Content-Type': 'application/json'
+  })
+
+  axios.get(`${internalHealthcheckUrl}`).then(response => {
+    console.log(response.data)
+    console.log(response.status)
+
+    // res.writeHead を使う場合は、 end しか使えない
+    // https://qiita.com/kukimo/items/e686d480209464c6372f
+    // res.write('ok')
+    res.end('ok')
+  })
+
+  console.log('/end healthcheck---')
+
+  // このミドルウェアがレスポンスを返さず、次に処理を移譲させるなら next() を実行すること
+  // https://expressjs.com/en/guide/writing-middleware.html
+  // next()
+}

tools/server.js

@@ -87,6 +87,13 @@ function uuid() {
   return uuid
 }
 
+/**
+ * get '/healthcheck'
+ */
+app.get('/healthcheck', function(req, res) {
+  res.send('ok')
+})
+
 /**
  * post '/login'
  */