feat: Add support for MongoDB databaseOptions keys `autoSelectFamil…

…y`, `autoSelectFamilyAttemptTimeout` (#9579)
parse-community · Jan 30, 2025 · 5966068 · 5966068
1 parent d1f6d3a
commit 5966068
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/spec/ParseConfigKey.spec.js b/spec/ParseConfigKey.spec.js
@@ -84,6 +84,8 @@ describe('Config Keys', () => {
         minPoolSize: 5,
         connectTimeoutMS: 5000,
         socketTimeoutMS: 5000,
+        autoSelectFamily: true,
+        autoSelectFamilyAttemptTimeout: 3000
       },
     })).toBeResolved();
     expect(loggerErrorSpy.calls.all().reduce((s, call) => s += call.args[0], '')).not.toMatch(invalidKeyErrorMessage);

diff --git a/src/Options/Definitions.js b/src/Options/Definitions.js
@@ -1043,6 +1043,18 @@ module.exports.FileUploadOptions = {
   },
 };
 module.exports.DatabaseOptions = {
+  autoSelectFamily: {
+    env: 'PARSE_SERVER_DATABASE_AUTO_SELECT_FAMILY',
+    help:
+      'The MongoDB driver option to set whether the socket attempts to connect to IPv6 and IPv4 addresses until a connection is established. If available, the driver will select the first IPv6 address.',
+    action: parsers.booleanParser,
+  },
+  autoSelectFamilyAttemptTimeout: {
+    env: 'PARSE_SERVER_DATABASE_AUTO_SELECT_FAMILY_ATTEMPT_TIMEOUT',
+    help:
+      'The MongoDB driver option to specify the amount of time in milliseconds to wait for a connection attempt to finish before trying the next address when using the autoSelectFamily option. If set to a positive integer less than 10, the value 10 is used instead.',
+    action: parsers.numberParser('autoSelectFamilyAttemptTimeout'),
+  },
   connectTimeoutMS: {
     env: 'PARSE_SERVER_DATABASE_CONNECT_TIMEOUT_MS',
     help:

diff --git a/src/Options/docs.js b/src/Options/docs.js
diff --git a/src/Options/index.js b/src/Options/index.js
@@ -610,6 +610,10 @@ export interface DatabaseOptions {
   connectTimeoutMS: ?number;
   /* The MongoDB driver option to specify the amount of time, in milliseconds, spent attempting to send or receive on a socket before timing out. Specifying 0 means no timeout. */
   socketTimeoutMS: ?number;
+  /* The MongoDB driver option to set whether the socket attempts to connect to IPv6 and IPv4 addresses until a connection is established. If available, the driver will select the first IPv6 address. */
+  autoSelectFamily: ?boolean;
+  /* The MongoDB driver option to specify the amount of time in milliseconds to wait for a connection attempt to finish before trying the next address when using the autoSelectFamily option. If set to a positive integer less than 10, the value 10 is used instead. */
+  autoSelectFamilyAttemptTimeout: ?number;
 }
 
 export interface AuthAdapter {