Play Framework 2.7の本番環境で公開アセットからファイルを直接読み込みたい

Question

前提・実現したいこと

Play Framework 2.7 で本番環境（sbt compile stage）にした場合、開発環境では存在する公開アセット(Publicフォルダ)がWebJarsの機能でjarファイル内にまとめられているようなのですが、そこからファイルを直接読み込む方法を教えてください。
※conf/routesの「controllers.Assets.at(file)」のように開発環境でも本番環境でも同じ処理で取得する方法があれば、教えて欲しいです。

発生している問題・エラーメッセージ

開発中（sbt run）のときは普通にPublicフォルダが存在しているので、次のような処理で読み込めますが、本番環境ではファイルが見つからないエラーが出ます。

val html = Source.fromFile("public/ui/index.html").mkString

試したこと

• 本番環境のルートにpublicフォルダをコピー
• 本番環境にはpublicフォルダが存在しないため、本番環境のルートに開発環境のpublicフォルダをコピー
• binフォルダのbatファイルでカレントディレクトリを１階層上に調整

rem バッチの上の方に追加
cd /d "%~dp0"
cd /d ..

一応、上記処置をすれば、本番環境でも無理やりな感じで動きますが、きれいなやり方が知りたいです。

2021-06-23補足追記

図1.本番環境用に「sbt compile stage」を実行した際の{プロジェクト}/target/universal/stage フォルダ
※publicが見当たりません

図2.{プロジェクト}/target/universal/stage/lib/{アプリケーション名}-assets.jarを圧縮展開したフォルダ
※この中に公開アセットファイルが入っているようです。

補足情報（FW/ツールのバージョンなど）

OS : Windows 10 Pro x64
FW : Play Framework 2.7.2
Java : 1.8.0_192(64-Bit Server VM)
Scala : 2.12.8
sbt : 0.13.11

Answer 1

結局、本番環境で公開アセットから直接リソースを読み込む方法はわからなかったのですが、def vueappでMode.Dev以外の場合はAssets.atを呼び出すように修正したところ、目的の動作になりましたので、一応これで解決とします。

package controllers

import com.mohiva.play.silhouette.api.actions.SecuredRequest
import com.mohiva.play.silhouette.api.repositories.AuthInfoRepository
import com.mohiva.play.silhouette.api.{LogoutEvent, Silhouette}
import javax.inject.Inject
import models.services.IndexRenderService
import play.api.{Environment, Mode}
import play.api.http.ContentTypes
import play.api.i18n.I18nSupport
import play.api.libs.ws.WSClient
import play.api.mvc._
import utils.auth.DefaultEnv

import scala.concurrent.{ExecutionContext} //, Future}

/** The basic application controller.
  *
  * @param components The Play controller components.
  * @param silhouette The Silhouette stack.
  */
class ApplicationController @Inject() (
    components: ControllerComponents,
    silhouette: Silhouette[DefaultEnv],
    environment: Environment,
    ws: WSClient,
    indexRenderService: IndexRenderService,
    authInfoRepository: AuthInfoRepository,
    myAssets: controllers.Assets
)(implicit ec: ExecutionContext)
    extends AbstractController(components)
    with I18nSupport {

  /** @return vuejs index.html page with CSRF set
    */
  def vueapp(path: String) = silhouette.UserAwareAction.async { implicit req =>
    environment.mode match {
      case Mode.Dev =>
        fetchWebpackServer(path)
      case _ =>
        //renderIndexPage()
        myAssets.at(path = "/public/ui", "index.html")(req)
    }
  }

  /** Handles the Sign Out action.
    *
    * @return The result to display.
    */
  def signOut = silhouette.SecuredAction.async {
    implicit request: SecuredRequest[DefaultEnv, AnyContent] =>
      silhouette.env.eventBus.publish(LogoutEvent(request.identity, request))
      silhouette.env.authenticatorService.discard(request.authenticator, Ok)
  }

  /** Retrieves resource from WebPack server. CSRF token will be injected to HTML files.
    *
    * @param path    HTTP resource path
    * @param request HTTP request
    * @return
    */
  private def fetchWebpackServer(
      path: String
  )(implicit request: RequestHeader) = {
    ws.url(s"http://localhost:8080/$path").get().map { r =>
      if (r.contentType.equalsIgnoreCase(HTML(Codec.utf_8))) {
        val html = r.bodyAsBytes.utf8String
        Ok(indexRenderService.setCsrfToken(html)).as(ContentTypes.HTML)
      } else {
        new Status(r.status)(r.bodyAsBytes).as(r.contentType)
      }
    }
  }

  
  ///** Renders index page by injecting CSRF token
  // *
  // * @param request HTTP request
  // * @return
  // */
  //private def renderIndexPage()(implicit request: RequestHeader) = {
  //  Future.successful {
  //    val html = indexRenderService.render(
  //      Some(
  //        "Scala PlayFramework authentication and user management sample using Silhouette VueJs"
  //      )
  //   )
  //    Ok(html).as(ContentTypes.HTML)
  //  }
  //}
   

}

Answer 2

"public/ui/index.html"はシステムのrootから相対パスになっていますが、
今回のケースで使いたいのはproject rootからの相対パスです。
このあたりを参考に試してみてください。

Comments

[wat77]

返信ありがとうございます。
「試したこと」の補足に追記したのですが、「sbt compile stage」で本番環境デプロイ用のファイルを生成すると、その中にはpublicフォルダはなく、公開アセットはjarファイルの中に圧縮されているようでして、単純なパス調整ではうまくいきませんでした。

[rysh]

プロジェクトそのままgithubで公開するか圧縮してどこかにアップロードできません？

[wat77]

元々はsilhouetteの公式のv7.0向けサンプル「silhouette-vuejs-app」を元にプロジェクトを作成しようとしてたのですが、説明どおりの手順を行ってるはずなのに、本番環境向けで動かなかったため、仕方がないので、処理を変更しようかと思い、四苦八苦してました。

以下のソースの16行目が本番環境でうまく動かない部分になります。
https://github.com/SunPj/silhouette-vuejs-app/blob/master/app/models/services/IndexRenderService.scala

環境構築だけして、まだ全然コーディングしてませんので、上記からダウンロードしたコードでこちらの環境と同じになるかと思います。

本家に質問した方がいい案件かなとも思いながら、こちらに質問させていただきました。すみません。

[kiino]

横からですいません。
該当のServiceクラスは Mode.Dev 、つまり開発環境のローカル起動の場合のみを想定している実装なのではないでしょうか。

https://github.com/SunPj/silhouette-vuejs-app/blob/09d159cc349c9893a4dc913109049d5d6b04bfea/app/controllers/ApplicationController.scala#L36-L37

なので本番環境で動かないのは仕方ないといいますか、想定動作のような気がします
本番環境での動作環境設定を dev 以外にする。とすれば該当エントリーポイントからの実行が可能になるのではないでしょうか

[wat77]

ソースのご確認、ありがとうございます。

https://github.com/SunPj/silhouette-vuejs-app/tree/09d159cc349c9893a4dc913109049d5d6b04bfea#running-in-production

上記Readme.mdに本番環境（製品版）の実行方法が記載されていまして、そちらで動作させたときに問題が出ています。（開発時の実行方法では問題ありません）
loggerを追加して確認しましたが、Mode.Devの方は通っていません。

本番環境（製品版）の場合、以下の順に処理されてます。
①https://github.com/SunPj/silhouette-vuejs-app/blob/09d159cc349c9893a4dc913109049d5d6b04bfea/app/controllers/ApplicationController.scala#L39

②https://github.com/SunPj/silhouette-vuejs-app/blob/09d159cc349c9893a4dc913109049d5d6b04bfea/app/controllers/ApplicationController.scala#L80

③https://github.com/SunPj/silhouette-vuejs-app/blob/09d159cc349c9893a4dc913109049d5d6b04bfea/app/models/services/IndexRenderService.scala#L16
（ここでエラー）