chore: update ipType to env variable

kgala2 · kgala2 · commit 0e47c454ba1e · 2025-03-27T23:24:51.000-07:00
diff --git a/.cl/cloudbuild.yaml b/.cl/cloudbuild.yaml
@@ -16,6 +16,8 @@ steps:
   - id: run integration tests
     name: node:latest
     entrypoint: bash
+    env: 
+      - "IP_TYPE=PRIVATE"
     secretEnv: ['MYSQL_CONNECTION_NAME', 'MYSQL_USER', 'MYSQL_IAM_USER', 'MYSQL_PASS', 'MYSQL_DB', 'POSTGRES_CONNECTION_NAME', 'POSTGRES_USER', 'POSTGRES_IAM_USER', 'POSTGRES_PASS', 'POSTGRES_DB', 'POSTGRES_CAS_CONNECTION_NAME', 'POSTGRES_CAS_PASS', 'POSTGRES_CUSTOMER_CAS_CONNECTION_NAME', 'POSTGRES_CUSTOMER_CAS_PASS', 'POSTGRES_CUSTOMER_CAS_DOMAIN_NAME', 'POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME', 'SQLSERVER_CONNECTION_NAME', 'SQLSERVER_USER', 'SQLSERVER_PASS', 'SQLSERVER_DB']
     args:
       - "-c"
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ const {Pool} = pg;
 const connector = new Connector();
 const clientOpts = await connector.getOptions({
   instanceConnectionName: 'my-project:region:my-instance',
-  ipType: 'PUBLIC',
+  ipType: process.env.IP_TYPE || 'PUBLIC',
 });
 const pool = new Pool({
   ...clientOpts,
@@ -122,7 +122,7 @@ import {Connector} from '@google-cloud/cloud-sql-connector';
 const connector = new Connector();
 const clientOpts = await connector.getOptions({
   instanceConnectionName: 'my-project:region:my-instance',
-  ipType: 'PUBLIC',
+  ipType: process.env.IP_TYPE || 'PUBLIC',
 });
 const pool = await mysql.createPool({
   ...clientOpts,
@@ -150,7 +150,7 @@ const {Connector} = require('@google-cloud/cloud-sql-connector');
 const connector = new Connector();
 const clientOpts = await connector.getTediousOptions({
   instanceConnectionName: process.env.SQLSERVER_CONNECTION_NAME,
-  ipType: 'PUBLIC',
+  ipType: process.env.IP_TYPE || 'PUBLIC',
 });
 const connection = new Connection({
   // Please note that the `server` property here is not used and is only defined
@@ -481,7 +481,7 @@ import {Connector} from '@google-cloud/cloud-sql-connector';
 const connector = new Connector();
 const clientOpts = await connector.getOptions({
   domainName: 'prod-db.mycompany.example.com',
-  ipType: 'PUBLIC',
+  ipType: process.env.IP_TYPE || 'PUBLIC',
 });
 
 const pool = await mysql.createPool({
diff --git a/examples/knex/mysql2/connect.cjs b/examples/knex/mysql2/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, user, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/knex/mysql2/connect.mjs b/examples/knex/mysql2/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, user, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/knex/pg/connect.cjs b/examples/knex/pg/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, user, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/knex/pg/connect.mjs b/examples/knex/pg/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, user, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/knex/tedious/connect.cjs b/examples/knex/tedious/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, user, password, databaseName })
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
 
diff --git a/examples/knex/tedious/connect.mjs b/examples/knex/tedious/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, user, password, database
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
 
diff --git a/examples/prisma/mysql/connect.cjs b/examples/prisma/mysql/connect.cjs
@@ -21,7 +21,7 @@ async function connect({instanceConnectionName, user, database}) {
   const connector = new Connector();
   await connector.startLocalProxy({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
     listenOptions: {path},
   });
diff --git a/examples/prisma/mysql/connect.mjs b/examples/prisma/mysql/connect.mjs
@@ -21,7 +21,7 @@ export async function connect({instanceConnectionName, user, database}) {
   const connector = new Connector();
   await connector.startLocalProxy({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
     listenOptions: {path},
   });
diff --git a/examples/prisma/postgresql/connect.cjs b/examples/prisma/postgresql/connect.cjs
@@ -21,7 +21,7 @@ async function connect({instanceConnectionName, user, database}) {
   const connector = new Connector();
   await connector.startLocalProxy({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
     listenOptions: {path},
   });
diff --git a/examples/prisma/postgresql/connect.mjs b/examples/prisma/postgresql/connect.mjs
@@ -21,7 +21,7 @@ export async function connect({instanceConnectionName, user, database}) {
   const connector = new Connector();
   await connector.startLocalProxy({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
     listenOptions: {path},
   });
diff --git a/examples/sequelize/mysql2/connect.cjs b/examples/sequelize/mysql2/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/sequelize/mysql2/connect.mjs b/examples/sequelize/mysql2/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, databaseName }
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/sequelize/pg/connect.cjs b/examples/sequelize/pg/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, databaseName }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/sequelize/pg/connect.mjs b/examples/sequelize/pg/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, databaseName }
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
 
diff --git a/examples/sequelize/tedious/connect.cjs b/examples/sequelize/tedious/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, password, databaseNam
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
 
diff --git a/examples/sequelize/tedious/connect.mjs b/examples/sequelize/tedious/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, password, data
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
 
diff --git a/examples/typeorm/mysql2/connect.cjs b/examples/typeorm/mysql2/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, database }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new typeorm.DataSource({
diff --git a/examples/typeorm/mysql2/connect.mjs b/examples/typeorm/mysql2/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, database }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new DataSource({
diff --git a/examples/typeorm/mysql2/connect.ts b/examples/typeorm/mysql2/connect.ts
@@ -19,7 +19,7 @@ export async function connect({instanceConnectionName, username, database}) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new DataSource({
diff --git a/examples/typeorm/pg/connect.cjs b/examples/typeorm/pg/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, database }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new typeorm.DataSource({
diff --git a/examples/typeorm/pg/connect.mjs b/examples/typeorm/pg/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, database }) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new DataSource({
diff --git a/examples/typeorm/pg/connect.ts b/examples/typeorm/pg/connect.ts
@@ -19,7 +19,7 @@ export async function connect({instanceConnectionName, username, database}) {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const dataSource = new DataSource({
diff --git a/examples/typeorm/tedious/connect.cjs b/examples/typeorm/tedious/connect.cjs
@@ -19,7 +19,7 @@ async function connect({ instanceConnectionName, username, password, database })
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
   });
   const dataSource = new typeorm.DataSource({
     type: 'mssql',
diff --git a/examples/typeorm/tedious/connect.mjs b/examples/typeorm/tedious/connect.mjs
@@ -19,7 +19,7 @@ export async function connect({ instanceConnectionName, username, password, data
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
   });
   const dataSource = new DataSource({
     type: 'mssql',
diff --git a/examples/typeorm/tedious/connect.ts b/examples/typeorm/tedious/connect.ts
@@ -24,7 +24,7 @@ export async function connect({
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
   });
   const dataSource = new DataSource({
     type: 'mssql',
diff --git a/src/connector.ts b/src/connector.ts
@@ -35,7 +35,7 @@ export declare interface UnixSocketOptions {
 // to the Connector.getOptions method when calling it, e.g:
 // const connector = new Connector()
 // const connectionOptions:ConnectionOptions = {
-//   ipType: 'PUBLIC',
+//   ipType: process.env.IP_TYPE || 'PUBLIC',
 //   instanceConnectionName: 'PROJECT:REGION:INSTANCE',
 // };
 // await connector.getOptions(connectionOptions);
@@ -64,7 +64,7 @@ interface PromisedStreamFunction {
 // the Connector.getOptions method, e.g:
 // const connector = new Connector()
 // const driverOptions:DriverOptions = await connector.getOptions({
-//   ipType: 'PUBLIC',
+//   ipType: process.env.IP_TYPE || 'PUBLIC',
 //   instanceConnectionName: 'PROJECT:REGION:INSTANCE',
 // });
 export declare interface DriverOptions {
@@ -213,7 +213,7 @@ export class Connector {
   //
   // const connector = new Connector()
   // const opts = await connector.getOptions({
-  //   ipType: 'PUBLIC',
+  //   ipType: process.env.IP_TYPE || 'PUBLIC',
   //   instanceConnectionName: 'PROJECT:REGION:INSTANCE',
   // });
   // const pool = new Pool(opts)
@@ -307,7 +307,7 @@ export class Connector {
   // const connector = new Connector();
   // await connector.startLocalProxy({
   //   instanceConnectionName,
-  //   ipType: 'PUBLIC',
+  //   ipType: process.env.IP_TYPE || 'PUBLIC',
   //   listenOptions: {path},
   // });
   // const datasourceUrl =
diff --git a/system-test/mysql2-connect.cjs b/system-test/mysql2-connect.cjs
@@ -20,7 +20,7 @@ t.test('open connection and run basic mysql commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: process.env.MYSQL_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
   const conn = await mysql.createConnection({
@@ -42,7 +42,7 @@ t.test('open IAM connection and run basic mysql commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: process.env.MYSQL_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const conn = await mysql.createConnection({
diff --git a/system-test/mysql2-connect.mjs b/system-test/mysql2-connect.mjs
@@ -20,7 +20,7 @@ t.test('open connection and run basic mysql commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: process.env.MYSQL_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'PASSWORD',
   });
   const conn = await mysql.createConnection({
@@ -42,7 +42,7 @@ t.test('open IAM connection and run basic mysql commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: process.env.MYSQL_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const conn = await mysql.createConnection({
diff --git a/system-test/pg-connect.cjs b/system-test/pg-connect.cjs
@@ -49,7 +49,7 @@ t.test('open IAM connection and retrieves standard pg tables', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: process.env.POSTGRES_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const client = new Client({
diff --git a/system-test/pg-connect.mjs b/system-test/pg-connect.mjs
@@ -50,7 +50,7 @@ t.test('open IAM connection and retrieves standard pg tables', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getOptions({
     instanceConnectionName: String(process.env.POSTGRES_CONNECTION_NAME),
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
     authType: 'IAM',
   });
   const client = new Client({
diff --git a/system-test/tedious-connect.cjs b/system-test/tedious-connect.cjs
@@ -20,7 +20,7 @@ t.test('open connection and run basic sqlserver commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName: process.env.SQLSERVER_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
   });
   const connection = new Connection({
     server: '0.0.0.0',
diff --git a/system-test/tedious-connect.mjs b/system-test/tedious-connect.mjs
@@ -20,7 +20,7 @@ t.test('open connection and run basic sqlserver commands', async t => {
   const connector = new Connector();
   const clientOpts = await connector.getTediousOptions({
     instanceConnectionName: process.env.SQLSERVER_CONNECTION_NAME,
-    ipType: 'PUBLIC',
+    ipType: process.env.IP_TYPE || 'PUBLIC',
   });
   const connection = new Connection({
     server: '0.0.0.0',
diff --git a/test/connector.ts b/test/connector.ts
diff --git a/test/x-serial/connector-integration.ts b/test/x-serial/connector-integration.ts
