chore: add domainName to InstanceConnectionInfo, part of DNS Config.

Author: hessjcg

src/instance-connection-info.ts

@@ -16,4 +16,5 @@ export interface InstanceConnectionInfo {
   projectId: string;
   regionId: string;
   instanceId: string;
+  domainName: string | undefined;
 }

src/parse-instance-connection-name.ts

@@ -15,6 +15,24 @@
 import {InstanceConnectionInfo} from './instance-connection-info';
 import {CloudSQLConnectorError} from './errors';
 
+const connectionNameRegex =
+  /^(?<projectId>[^:]+(:[^:]+)?):(?<regionId>[^:]+):(?<instanceId>[^:]+)$/;
+
+// The domain name pattern in accordance with RFC 1035, RFC 1123 and RFC 2181.
+// From Go Connector:
+const domainNameRegex =
+  /^(?:[_a-z0-9](?:[_a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z](?:[a-z0-9-]{0,61}[a-z0-9])?)?$/;
+
+export function isValidDomainName(name: string): boolean {
+  const matches = String(name).match(domainNameRegex);
+  return Boolean(matches);
+}
+
+export function isInstanceConnectionName(name: string): boolean {
+  const matches = String(name).match(connectionNameRegex);
+  return Boolean(matches);
+}
+
 export function parseInstanceConnectionName(
   instanceConnectionName: string | undefined
 ): InstanceConnectionInfo {
@@ -26,20 +44,8 @@ export function parseInstanceConnectionName(
     });
   }
 
-  const connectionNameRegex =
-    /(?<projectId>[^:]+(:[^:]+)?):(?<regionId>[^:]+):(?<instanceId>[^:]+)/;
   const matches = String(instanceConnectionName).match(connectionNameRegex);
-  if (!matches) {
-    throw new CloudSQLConnectorError({
-      message:
-        'Malformed instance connection name provided: expected format ' +
-        `of "PROJECT:REGION:INSTANCE", got ${instanceConnectionName}`,
-      code: 'EBADCONNECTIONNAME',
-    });
-  }
-
-  const unmatchedItems = matches[0] !== matches.input;
-  if (unmatchedItems || !matches.groups) {
+  if (!matches || !matches.groups) {
     throw new CloudSQLConnectorError({
       message:
         'Malformed instance connection name provided: expected format ' +
@@ -52,5 +58,6 @@ export function parseInstanceConnectionName(
     projectId: matches.groups.projectId,
     regionId: matches.groups.regionId,
     instanceId: matches.groups.instanceId,
+    domainName: undefined,
   };
 }

test/cloud-sql-instance.ts

@@ -80,6 +80,7 @@ t.test('CloudSQLInstance', async t => {
         projectId: 'my-project',
         regionId: 'us-east1',
         instanceId: 'my-instance',
+        domainName: undefined,
       },
       'should have expected connection info'
     );

test/parse-instance-connection-name.ts

@@ -13,7 +13,11 @@
 // limitations under the License.
 
 import t from 'tap';
-import {parseInstanceConnectionName} from '../src/parse-instance-connection-name';
+import {
+  parseInstanceConnectionName,
+  isValidDomainName,
+  isInstanceConnectionName,
+} from '../src/parse-instance-connection-name';
 
 t.throws(
   () => parseInstanceConnectionName(undefined),
@@ -71,6 +75,7 @@ t.same(
     projectId: 'my-project',
     regionId: 'region-1',
     instanceId: 'my-instance',
+    domainName: undefined,
   },
   'should be able to parse standard data'
 );
@@ -81,6 +86,23 @@ t.same(
     projectId: 'google.com:PROJECT',
     regionId: 'region-02',
     instanceId: 'my-instance',
+    domainName: undefined,
   },
   'should support legacy domain scoped project id'
 );
+
+t.same(isValidDomainName('project.example.com'), true, 'valid domain name');
+
+t.same(isValidDomainName('google.com:PROJECT'), false, 'invalid domain name');
+
+t.same(
+  isInstanceConnectionName('my-project:region-1:my-instance'),
+  true,
+  'invalid domain name'
+);
+
+t.same(
+  isInstanceConnectionName('project.example.com'),
+  false,
+  'should validate domain name'
+);