Build production failing if I have application.properties configuration  #212

Activity

1. mkurz commented on Jan 28, 2022

   

   mkurz

   on Jan 28, 2022

   Member

   More actions

   @almothafar I just released play-ebean 6.2.0-RC4, please have a look at the release notes how to upgrade: https://github.com/playframework/play-ebean/releases/tag/6.2.0-RC4. Please let me know if this problem you reported here is fixed with that release, thanks!
2. mkurz commented on Mar 6, 2023

   

   mkurz

   on Mar 6, 2023

   Member

   More actions

   The problem here is that the typesafe config loads conf/application.properties on top of application.conf, meaning Play's app config will also contain all the ebean.* configs (databasePlatformName, idType,...). But the application.properties file here is only meant for ebean, not for Play... As long as ebean's config was called ebean.properties (which is deprecated) there was no problem of course because typesafe config doesn't care about such a file. But now when it loads the application.properties it tries to iterate over the ebean.* keys which then fails:
   

   play-ebean/play-ebean/src/main/java/play/db/ebean/EbeanParsedConfig.java

   Lines 43 to 65 in 6e70610

   	public static EbeanParsedConfig parseFromConfig(Config config) {
   	Config playEbeanConfig = config.getConfig("play.ebean");
   	String defaultDatasource = playEbeanConfig.getString("defaultDatasource");
   	String ebeanConfigKey = playEbeanConfig.getString("config");
   	Map<String, List<String>> datasourceModels = new HashMap<>();
   	if (config.hasPath(ebeanConfigKey)) {
   	Config ebeanConfig = config.getConfig(ebeanConfigKey);
   	ebeanConfig.root().forEach((key, raw) -> {
   	List<String> models;
   	if (raw.valueType() == ConfigValueType.STRING) {
   	// Support legacy comma separated string
   	models = Arrays.asList(((String) raw.unwrapped()).split(","));
   	} else {
   	models = ebeanConfig.getStringList(key);
   	}
   	datasourceModels.put(key, models);
   	});
   	}
   	return new EbeanParsedConfig(defaultDatasource, datasourceModels);
   	}

   The immediate solution is to just use (and recommend) application.yaml instead of application.properties: https://ebean.io/docs/intro/configuration/

   Long term we coud just switch Play's default ebean config key to be play.ebean instead of just ebean:
   

   play-ebean/play-ebean/src/main/resources/reference.conf

   Line 8 in 6e70610

   config = "ebean"
3. mkurz

   closed this as completedin #904on Oct 8, 2026
4. mkurz commented on Oct 8, 2026

   

   mkurz

   on Oct 8, 2026

   Last edited by mkurz

   Member

   More actions

   This got fixed by

   • Ignore Ebean settings below ebean.* that are no lists of models #904
   • (backports: [8.x] Ignore Ebean settings below ebean.* that are no lists of models #906 for 8.x, [7.x] Ignore Ebean settings below ebean.* that are no lists of models #908 for 7.x),

   which will be part of the next releases. Here's what was going on, and how to configure this:

   Cause

   Besides conf/application.conf, Play also loads conf/application.properties into its configuration. That's the same file Ebean reads its own settings from (Ebean doesn't read application.conf). Play Ebean reads the lists of models from ebean.<server> in Play's configuration, and took every entry below ebean. for such a list. So with the application.properties above, ebean.default was an object (databasePlatformName, idType, allQuotedIdentifiers) instead of a list of models, and Play Ebean failed with default has type OBJECT rather than LIST. That happened in the sbt plugin when loading the models to enhance, as in the stack trace above, and at runtime as well. Global Ebean settings like ebean.migration.run=false had the same effect.

   What changed

   Play Ebean now only uses strings and lists below ebean. as lists of models, and ignores everything else, like these ebean.default.* settings.

   How to configure it

   Keep the list of models in conf/application.conf:

   ebean.default = ["models.*"]
   

   and Ebean's own settings in conf/application.properties:

   ebean.default.databasePlatformName=sqlserver17
   ebean.default.idType=IDENTITY
   ebean.default.allQuotedIdentifiers=true

   In Play's configuration, application.conf takes precedence over application.properties, so Play Ebean gets the list of models from there, while Ebean reads its settings from application.properties itself.

   Even better, use conf/application.yaml for Ebean's settings, which only Ebean reads, so they don't end up in Play's configuration at all. That's also the place for settings directly below ebean., like ebean.dumpMetricsOnShutdown=true: as all values in application.properties are strings, Play Ebean takes such a setting for a list of models, of an Ebean server without a database, which it then skips.

   With older releases, you can avoid the collision by moving Play Ebean's lists of models to a different key:

   play.ebean.config = "ebeanModels"
   ebeanModels.default = ["models.*"]
   

   The docs now explain where Ebean's own settings go.

   👍React with 👍1Reacted by Al-Mothafar Al-Hasan

   🎉React with 🎉1Reacted by Al-Mothafar Al-Hasan