Merge pull request #1376 from matrix-org/hs/additional-addresses-excl…

…usive Exclusively allow additional addresses when connecting to IRC
matrix-org · Jun 9, 2021 · 67f83b9 · 67f83b9
2 parents 0bea1ce + 898a551
commit 67f83b9
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/changelog.d/1376.feature b/changelog.d/1376.feature
@@ -0,0 +1 @@
+Allow only using the `additionalAddresses` field when connecting to IRC.
diff --git a/config.sample.yaml b/config.sample.yaml
@@ -55,8 +55,13 @@ ircService:
       # It is also used in the Third Party Lookup API as the instance `desc`
       # property, where each server is an instance.
       name: "ExampleNet"
-
+      # Additional addresses to connect to, used for load balancing between IRCDs.
       additionalAddresses: [ "irc2.example.com" ]
+      # Typically additionalAddresses would be in addition to the address key given above,
+      # but some configurations wish to exclusively use additional addresses while reserving
+      # the top key for identification purposes. Set this to true to exclusively use the
+      # additionalAddresses array when connecting to servers.
+      onlyAdditionalAddresses: false
       #
       # [DEPRECATED] Use `name`, above, instead.
       # A human-readable description string

diff --git a/config.schema.yml b/config.schema.yml
@@ -160,6 +160,8 @@ properties:
                             type: "array"
                             items:
                                 type: "string"
+                        onlyAdditionalAddresses:
+                            type: "boolean"
                         ssl:
                             type: "boolean"
                         ca:

diff --git a/src/irc/IrcServer.ts b/src/irc/IrcServer.ts
@@ -38,6 +38,7 @@ export interface IrcServerConfig {
     password?: string;
     allowExpiredCerts?: boolean;
     additionalAddresses?: string[];
+    onlyAdditionalAddresses: boolean;
     dynamicChannels: {
         enabled: boolean;
         published: boolean;
@@ -686,6 +687,7 @@ export class IrcServer {
     public static get DEFAULT_CONFIG(): IrcServerConfig {
         return {
             sendConnectionMessages: true,
+            onlyAdditionalAddresses: false,
             quitDebounce: {
                 enabled: false,
                 quitsPerSecond: 5,
@@ -797,7 +799,12 @@ export class IrcServer {
         }
 
         this.addresses = config.additionalAddresses || [];
-        this.addresses.push(this.domain);
+        // Don't include the original domain if not configured to.
+        if (!config.onlyAdditionalAddresses) {
+            this.addresses.push(this.domain);
+        } else if (this.addresses.length === 0) {
+            throw Error("onlyAdditionalAddresses is true, but no additional addresses are provided in the config");
+        }
         this.excludedUsers = config.excludedUsers.map((excluded) => {
             return {
                 ...excluded,