Merge branch '5929-sdk-togglemodule-only-works-locally' into 'master'

fix(SDK): repair ToggleModule

See merge request codingame/game-engine!205

Author: Bullle

engine/modules/toggle/src/main/resources/view/toggle-module/ToggleModule.js

@@ -1,20 +1,21 @@
-import { api as entityModule } from '../../entity-module/GraphicEntityModule.js'
-import { toggles } from '../../config.js'
-import {ErrorLog} from '../core/ErrorLog.js'
-import {MissingToggleError} from './errors/MissingToggleError.js'
+import { api as entityModule } from '../entity-module/GraphicEntityModule.js'
+import { ErrorLog } from '../core/ErrorLog.js'
+import { MissingToggleError } from './errors/MissingToggleError.js'
+import { DuplicateToggleValueError } from './errors/DuplicateToggleValueError.js'
 
 export class ToggleModule {
   constructor (assets) {
     this.previousFrame = {}
     this.missingToggles = {}
+
     ToggleModule.refreshContent = () => {
       if (!this.currentFrame) {
         return
       }
       for (const registeredEntity in this.currentFrame.registered) {
         const entity = entityModule.entities.get(parseInt(registeredEntity))
         const toggleInfo = this.currentFrame.registered[registeredEntity]
-        const toggleState = toggles[toggleInfo.name]
+        const toggleState = ToggleModule.toggles[toggleInfo.name]
 
         if (toggleState == null && !this.missingToggles[toggleInfo.name]) {
           ErrorLog.push(new MissingToggleError(toggleInfo.name))
@@ -25,9 +26,24 @@ export class ToggleModule {
         )
       }
     }
+
+    pushDuplicateErrors()
   }
+
   static refreshContent () {}
 
+  static defineToggle (option) {
+    checkDuplicates(option)
+
+    ToggleModule.toggles[option.toggle] = option.default
+    option.get = () => ToggleModule.toggles[option.toggle]
+    option.set = (value) => {
+      ToggleModule.toggles[option.toggle] = value
+      ToggleModule.refreshContent()
+    }
+    return option
+  }
+
   static get name () {
     return 'toggles'
   }
@@ -53,3 +69,32 @@ export class ToggleModule {
     ToggleModule.refreshContent()
   }
 }
+
+ToggleModule.toggles = {}
+ToggleModule.optionValues = {}
+
+function checkDuplicates (option) {
+  ToggleModule.optionValues[option.toggle] = []
+
+  for (const key in option.values) {
+    const value = option.values[key]
+    let matchedPair = ToggleModule.optionValues[option.toggle].find(elem => elem.value === value)
+
+    if (!matchedPair) {
+      matchedPair = { keys: [ ], value }
+      ToggleModule.optionValues[option.toggle].push(matchedPair)
+    }
+
+    matchedPair.keys.push(key)
+  }
+}
+
+function pushDuplicateErrors () {
+  for (const toggle in ToggleModule.optionValues) {
+    for (const optionValues of ToggleModule.optionValues[toggle]) {
+      if (optionValues.keys.length > 1) {
+        ErrorLog.push(new DuplicateToggleValueError(toggle, optionValues))
+      }
+    }
+  }
+}

engine/modules/toggle/src/main/resources/view/toggle-module/errors/DuplicateToggleValueError.js

@@ -0,0 +1,8 @@
+export class DuplicateToggleValueError extends Error {
+  constructor (toggle, dup, cause) {
+    super('(' + dup.keys.toString() + ') have the same value \'' + dup.value + '\' in toggle "' + toggle + '". Avoid those duplicates in your config.js.')
+    this.toggle = toggle
+    this.cause = cause
+    this.name = 'DuplicateToggleValueError'
+  }
+}

playground/extensions/extensions-toggle.md

@@ -29,36 +29,25 @@ export const modules = [
 
 // The list of toggles displayed in the options of the viewer
 export const options = [
-  {
-  // The name displayed over the toggle
+  ToggleModule.defineToggle({
+    // The name of the toggle
+    // replace "myToggle" by the name of the toggle you want to use
+    toggle: 'myToggle',
+    // The text displayed over the toggle
     title: 'MY TOGGLE',
-    // Getters and setters for the on/off state of your toggle
-    get: function () {
-      return toggles.myToggle // replace "myToggle" by the name of the toggle you want to use
-    },
-    set: function (value) {
-      toggles.myToggle = value // replace "myToggle" by the name of the toggle you want to use
-      ToggleModule.refreshContent()
-    },
     // The labels for the on/off states of your toggle
     values: {
       'TOGGLED ON': true,
       'TOGGLED OFF': false
-    }
-  },
-  {
-    title: 'MY OTHER TOGGLE',
+    },
+    // Default value of your toggle
+    default: true
+  }),
+  ToggleModule.defineToggle({
+    toggle: 'myOtherToggle',
     ⋮
-  }
+  })
 ]
-
-// The list of the toggles used by the ToggleModule
-// replace "myToggle" by the name of the toggle you want to use
-export const toggles = {
-  myToggle: true, // default value of your toggle
-  myOtherToggle: false
-}
-
 ```
 
 ## Usage

playground/misc/misc-3-release-notes.md

@@ -2,6 +2,12 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
+## Next Version
+
+### 🐞 Bug fix
+
+- Fixed ToggleModule and improved the API.
+
 ## 3.4.6
 
 ### 🐞 Bug fix