Skip to content

Feature: Generated Warlock SystemIDs

Problem Statement

Currently, the Warlock server requires a manually defined SystemID in the configuration to ensure the correct server is being used. To automate this process and enhance reliability, the SystemID should be generated based on the contents of a file directory using MD5 hashing of file contents. This will allow the server to generate a unique SystemID on startup if one is not defined in the config and store it to a file for client-side use.

Who will benefit?

Developers and administrators who configure and maintain the Warlock server and clients will benefit from an automated and reliable way to generate and use SystemIDs, ensuring the correct server is always identified.

Benefits and risks

Benefits

  • Automates the generation of a unique SystemID, reducing the need for manual configuration.
  • Ensures consistency and reliability in server-client communication by using a SystemID based on the actual contents of the file directory.
  • Simplifies the startup process by generating and storing the SystemID automatically.

Risks

  • Potential for increased startup time due to MD5 hashing of the file contents.
  • Need to ensure that the hashing process is efficient and does not introduce significant delays.

Proposed solution

  1. On Warlock server startup, check if a SystemID is defined in the configuration.
  2. If no SystemID is defined, generate one by performing an MD5 hash on the contents of a specified file directory.
  3. Store the generated SystemID to a file on the server.
  4. Modify the client-side to load the SystemID from the file and use it when communicating with the server to ensure the correct Warlock server is being used.

Examples

N/A

Priority/Severity

  • High (This will bring a huge increase in performance/productivity/usability/legislative cover)
  • Medium (This will bring a good increase in performance/productivity/usability)
  • Low (anything else e.g., trivial, minor improvements)