Merge branch 'config-checker' into 'master'

Builder · Builder · commit e0dbd7de3c2f · 2019-01-30T13:50:20.000Z
fix(sdk): remove Title field from config helper

See merge request codingame/game-engine!182
diff --git a/playground/misc/misc-3-release-notes.md b/playground/misc/misc-3-release-notes.md
@@ -9,6 +9,7 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 - Included missing `addAgent` polymorphism – custom nickname with default avatar.
 - Improved display of player output in local test page.
 - Better handling of errors from initializing modules.
+- Unused `title` property no longer mandatory in `config.ini`.
 - `setFrameDuration()` now throws an exception on non-positive values.
 
 ## 3.3.1
@@ -37,7 +38,7 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 ### ⚠️ Known issues
 
 - Maven modules not available as dependencies
-- `setFrameDuration()` does not work in the `init()`
+- `setFrameDuration()` does not work in the `init()`.
 
 ## 3.1.0
 
@@ -47,11 +48,11 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 
 ### 🐞 Bug fix
 
-- Fixed an issue with sprites
+- Fixed an issue with sprites.
 
 ### ⚠️ Known issues
 
-- `setFrameDuration()` does not work in the `init()`
+- `setFrameDuration()` does not work in the `init()`.
 
 ## 3.0.0
 *January 11, 2019*
@@ -77,7 +78,7 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 
 ### ⚠️ Known issues
 
-- `setFrameDuration()` does not work in the `init()`
+- `setFrameDuration()` does not work in the `init()`.
 
 ## 2.15
 *November 29, 2018*
@@ -113,7 +114,7 @@ The CodinGame SDK is regularly updated and improved. This document lets you know
 
 ### 🎁 New feature
 
-- Local test page design now matches the website one
+- Local test page design now matches the website one.
 
 ## 2.8
 *August 9, 2018*
diff --git a/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java b/runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java
@@ -39,7 +39,6 @@ enum GameType {
     }
 
     public static class GameConfig {
-        private String title;
         private boolean leaguesDetected;
         private GameType gameType;
         private Map<String, QuestionConfig> questionsConfig = new HashMap<>();
@@ -67,14 +66,6 @@ public boolean isLeaguesDetected() {
         public void setLeaguesDetected(boolean leaguesDetected) {
             this.leaguesDetected = leaguesDetected;
         }
-
-        public String getTitle() {
-            return title;
-        }
-
-        public void setTitle(String title) {
-            this.title = title;
-        }
     }
 
     class TestCase {
@@ -117,7 +108,6 @@ public void setIsValidator(Boolean isValidator) {
     }
 
     public static class QuestionConfig {
-        private String title;
         private boolean configDetected;
         private Map<Integer, String> statementsLanguageMap = new HashMap<Integer, String>();
         private Map<Integer, String> welcomeLanguageMap = new HashMap<Integer, String>();
@@ -185,14 +175,6 @@ public List<TestCase> getTestCases() {
             return testCases;
         }
 
-        public String getTitle() {
-            return title;
-        }
-
-        public void setTitle(String title) {
-            this.title = title;
-        }
-
         public Map<Integer, String> getStatementsLanguageMap() {
             return statementsLanguageMap;
         }
@@ -266,8 +248,6 @@ public void setConfigDetected(boolean configDetected) {
         }
 
         public void merge(QuestionConfig defaultConfig) {
-            this.title = ObjectUtils.firstNonNull(title, defaultConfig.title);
-
             this.statementsLanguageMap = firstNonNullOrEmptyMap(
                 statementsLanguageMap,
                 defaultConfig.statementsLanguageMap
@@ -383,7 +363,6 @@ public GameConfig findConfig(Path rootDir) throws IOException {
                     try (FileInputStream is = new FileInputStream(p.toFile())) {
                         config.load(is);
 
-                        String title = config.getProperty("title");
                         String minPlayers = config.getProperty("min_players");
                         String maxPlayers = config.getProperty("max_players");
                         String criteria = config.getProperty("criteria");
@@ -392,7 +371,6 @@ public GameConfig findConfig(Path rootDir) throws IOException {
                         String sortingOrder = config.getProperty("sorting_order");
                         String questionType = config.getProperty("type");
 
-                        questionConfig.setTitle(title);
                         questionConfig.setMinPlayers(minPlayers != null ? Integer.valueOf(minPlayers) : null);
                         questionConfig.setMaxPlayers(maxPlayers != null ? Integer.valueOf(maxPlayers) : null);
                         questionConfig.setCriteria(criteria);
@@ -454,7 +432,6 @@ public GameConfig findConfig(Path rootDir) throws IOException {
         });
 
         QuestionConfig defaultConfig = questionsConfig.get("");
-        gameConfig.setTitle(defaultConfig.getTitle());
 
         // If there is more than 1 element in leagues, then we have a real league system and the empty string key in leagues
         // represents the default value. So if we have a real league system, we will remove the default config and override
@@ -463,11 +440,6 @@ public GameConfig findConfig(Path rootDir) throws IOException {
             questionsConfig.remove("");
             for (String leagueKey : questionsConfig.keySet()) {
                 QuestionConfig questionConfig = questionsConfig.get(leagueKey);
-                // If not set, we force the title of the league with the concatenation of the main title and the league dir. name
-                ObjectUtils.firstNonNull(
-                    questionConfig.title,
-                    String.format("%s - %s", defaultConfig.title, leagueKey)
-                );
                 questionConfig.merge(defaultConfig);
                 questionConfig.configDetected = isPresentConfigIni(gameConfig, questionConfig);
             }
@@ -519,7 +491,6 @@ public GameConfig findConfig(Path rootDir) throws IOException {
     }
 
     private boolean isPresentConfigIni(GameConfig gameConfig, QuestionConfig questionConfig) {
-        return gameConfig.getTitle() != null
-            || questionConfig.minPlayers != null || questionConfig.maxPlayers != null;
+        return questionConfig.minPlayers != null || questionConfig.maxPlayers != null;
     }
 }
diff --git a/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java b/runner/src/main/java/com/codingame/gameengine/runner/Renderer.java
@@ -484,8 +484,6 @@ private void checkConfigIni(GameConfig gameConfig, QuestionConfig questionConfig
         throws MissingConfigException {
         if (!questionConfig.isConfigDetected()) {
             throw new MissingConfigException(tag + "Missing config.ini file");
-        } else if (gameConfig.getTitle() == null || gameConfig.getTitle().isEmpty()) {
-            throw new MissingConfigException(tag + "Missing title property in config.ini.");
         } else if (questionConfig.getMinPlayers() == null) {
             throw new MissingConfigException(tag + "Missing min_players property in config.ini.");
         } else if (questionConfig.getMaxPlayers() == null) {
@@ -640,7 +638,6 @@ public void handleRequest(HttpServerExchange exchange) throws Exception {
 
                                             exchange.getRequestReceiver().receiveFullString((e, data) -> {
                                                 ConfigResponseDto configResponseDto = new Gson().fromJson(data, ConfigResponseDto.class);
-                                                config.put("title", configResponseDto.title);
                                                 config.put("min_players", String.valueOf(configResponseDto.minPlayers));
                                                 config.put("max_players", String.valueOf(configResponseDto.maxPlayers));
                                                 config.put("type", configResponseDto.type);
diff --git a/runner/src/main/java/com/codingame/gameengine/runner/dto/ConfigResponseDto.java b/runner/src/main/java/com/codingame/gameengine/runner/dto/ConfigResponseDto.java
@@ -1,7 +1,6 @@
 package com.codingame.gameengine.runner.dto;
 
 public class ConfigResponseDto {
-    public String title;
     public int minPlayers;
     public int maxPlayers;
     public String type;
diff --git a/runner/src/main/resources/view/test.html b/runner/src/main/resources/view/test.html
@@ -65,12 +65,6 @@
 			<div class="form-popup">
 				<form id="config-form" name="form">
 					<p><span ng-bind="formStatement"></span></p>
-					<p>
-						<label for="title">Title*</label>
-					</p>
-					<p>
-						<input required type="text" ng-model="config.title" />
-					</p>
 					<div ng-if="config.type != 'solo' && config.type != 'opti'">
 						<p>
 							<label for="min_players">Min players*</label>
