Commit @53920e0315f62917961a5b9fa4f8640997ea35ef

Yi EungJun 2014-04-28

config: Fix config error while starting Yobi

Problem: An error occurs while starting Yobi in product mode if there is
no conf/application.conf.

Reason: Yobi has a feature to initilizate conf/application.conf by
copying from conf/application.conf.default. But it does not work for
product mode because Application.onLoadConfig, which does the
initialization, runs after configuration has been loaded.

Solution: Run the config initialization in Build.scala.

@53920e0315f62917961a5b9fa4f8640997ea35ef

25c8bec

53920e0

app/Global.java

--- app/Global.java

+++ app/Global.java


 import static play.mvc.Results.badRequest;
 
 public class Global extends GlobalSettings {
-    public static final String APPLICATION_CONF_DEFAULT = "application.conf.default";
-    public static final String APPLICATION_CONF = "application.conf";
-    public static final String CONFIG_DIRNAME = "conf";
     private final String DEFAULT_SECRET = "VA2v:_I=h9>?FYOH:@ZhW]01P<mWZAKlQ>kk>Bo`mdCiA>pDw64FcBuZdDh<47Ew";
 
     private boolean isRestartRequired = false;
     private boolean isValidationRequired = false;
-
-    @Override
-    public Configuration onLoadConfig(play.Configuration config, File path, ClassLoader classloader) {
-        String basePath = path.getAbsolutePath();
-        Path pathToDefaultConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF_DEFAULT);
-        Path pathToConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF);
-        File configFile = pathToConfig.toFile();
-
-        if (!configFile.exists()) {
-            try {
-                Files.copy(pathToDefaultConfig, pathToConfig);
-            } catch (IOException e) {
-                play.Logger.error("Failed to initialize configuration", e);
-                return null;
-            }
-            Config parsedConfig = ConfigFactory.parseFileAnySyntax(configFile);
-            return new Configuration(ConfigFactory.load(classloader, parsedConfig));
-        } else {
-            if (!configFile.isFile()) {
-                play.Logger.error(
-                        "Failed to initialize configuration: " + pathToConfig + " is a directory.");
-                return null;
-            }
-        }
-
-        return null;
-    }
 
     public void onStart(Application app) {
         isValidationRequired = !validateSecret();

25c8bec

53920e0

project/Build.scala

--- project/Build.scala

+++ project/Build.scala


 import play.Project.javaEbean
 import play.Project.templatesImport
 import play.Project.lessEntryPoints
+import java.nio.file.Files
+import java.nio.file.Paths
+import java.io.IOException;
 
 object ApplicationBuild extends Build {
 
   val appName         = "yobi"
   val appVersion      = "1.0-SNAPSHOT"
+  val APPLICATION_CONF_DEFAULT = "application.conf.default"
+  val APPLICATION_CONF = "application.conf"
+  val CONFIG_DIRNAME = "conf"
 
   val appDependencies = Seq(
     // Add your project dependencies here,

       scalacOptions ++= Seq("-feature")
     )
 
-  val main = play.Project(appName, appVersion, appDependencies)
+  val initConfig = {
+    val basePath = new File(System.getProperty("user.dir")).getAbsolutePath()
+    val pathToDefaultConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF_DEFAULT)
+    val pathToConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF)
+    val configFile = pathToConfig.toFile()
+
+    if (!configFile.exists()) {
+        try {
+          Files.copy(pathToDefaultConfig, pathToConfig)
+        } catch {
+            case e: IOException => throw new Exception("Failed to initialize configuration", e)
+        }
+    } else {
+        if (!configFile.isFile()) {
+            throw new Exception("Failed to initialize configuration: '" + pathToConfig + "' is a directory.")
+        }
+    }
+  }
+
+  val main = {
+    initConfig
+    play.Project(appName, appVersion, appDependencies)
     .settings(projectSettings: _*)
     .settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*)
+  }
 }

Add a comment

Open 0
Closed 0

List

...	...	@@ -68,40 +68,10 @@
68	68	import static play.mvc.Results.badRequest;
69	69
70	70	public class Global extends GlobalSettings {
71		- public static final String APPLICATION_CONF_DEFAULT = "application.conf.default";
72		- public static final String APPLICATION_CONF = "application.conf";
73		- public static final String CONFIG_DIRNAME = "conf";
74	71	private final String DEFAULT_SECRET = "VA2v:_I=h9>?FYOH:@ZhW]01P<mWZAKlQ>kk>Bo`mdCiA>pDw64FcBuZdDh<47Ew";
75	72
76	73	private boolean isRestartRequired = false;
77	74	private boolean isValidationRequired = false;
78		-
79		- @Override
80		- public Configuration onLoadConfig(play.Configuration config, File path, ClassLoader classloader) {
81		- String basePath = path.getAbsolutePath();
82		- Path pathToDefaultConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF_DEFAULT);
83		- Path pathToConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF);
84		- File configFile = pathToConfig.toFile();
85		-
86		- if (!configFile.exists()) {
87		- try {
88		- Files.copy(pathToDefaultConfig, pathToConfig);
89		- } catch (IOException e) {
90		- play.Logger.error("Failed to initialize configuration", e);
91		- return null;
92		- }
93		- Config parsedConfig = ConfigFactory.parseFileAnySyntax(configFile);
94		- return new Configuration(ConfigFactory.load(classloader, parsedConfig));
95		- } else {
96		- if (!configFile.isFile()) {
97		- play.Logger.error(
98		- "Failed to initialize configuration: " + pathToConfig + " is a directory.");
99		- return null;
100		- }
101		- }
102		-
103		- return null;
104		- }
105	75
106	76	public void onStart(Application app) {
107	77	isValidationRequired = !validateSecret();

...	...	@@ -5,11 +5,17 @@
5	5	import play.Project.javaEbean
6	6	import play.Project.templatesImport
7	7	import play.Project.lessEntryPoints
	8	+import java.nio.file.Files
	9	+import java.nio.file.Paths
	10	+import java.io.IOException;
8	11
9	12	object ApplicationBuild extends Build {
10	13
11	14	val appName = "yobi"
12	15	val appVersion = "1.0-SNAPSHOT"
	16	+ val APPLICATION_CONF_DEFAULT = "application.conf.default"
	17	+ val APPLICATION_CONF = "application.conf"
	18	+ val CONFIG_DIRNAME = "conf"
13	19
14	20	val appDependencies = Seq(
15	21	// Add your project dependencies here,
...	...	@@ -59,7 +65,29 @@
59	65	scalacOptions ++= Seq("-feature")
60	66	)
61	67
62		- val main = play.Project(appName, appVersion, appDependencies)
	68	+ val initConfig = {
	69	+ val basePath = new File(System.getProperty("user.dir")).getAbsolutePath()
	70	+ val pathToDefaultConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF_DEFAULT)
	71	+ val pathToConfig = Paths.get(basePath, CONFIG_DIRNAME, APPLICATION_CONF)
	72	+ val configFile = pathToConfig.toFile()
	73	+
	74	+ if (!configFile.exists()) {
	75	+ try {
	76	+ Files.copy(pathToDefaultConfig, pathToConfig)
	77	+ } catch {
	78	+ case e: IOException => throw new Exception("Failed to initialize configuration", e)
	79	+ }
	80	+ } else {
	81	+ if (!configFile.isFile()) {
	82	+ throw new Exception("Failed to initialize configuration: '" + pathToConfig + "' is a directory.")
	83	+ }
	84	+ }
	85	+ }
	86	+
	87	+ val main = {
	88	+ initConfig
	89	+ play.Project(appName, appVersion, appDependencies)
63	90	.settings(projectSettings: _*)
64	91	.settings(net.virtualvoid.sbt.graph.Plugin.graphSettings: _*)
	92	+ }
65	93	}

Delete comment