feat(cloudsql/sqlserver): update to V2 sample. (GoogleCloudPlatform#2586)

* feat(cloudsql/sqlserver): update to V2 sample. * Lint. * Lint. * Restore env. vars for non-sqlserver tests. * Address review comment. * Address review comments. * Lint. * Update to fix tests.

Author: jsimonweb

.kokoro/build.sh

@@ -118,6 +118,8 @@ if [[ $SQL_CLIENT ]]; then
 wget --quiet https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
 chmod +x cloud_sql_proxy
 if [[ $SQL_CLIENT == 'sqlserver' ]]; then
+export INSTANCE_HOST=127.0.0.1
+export DB_PORT=1433
 ./cloud_sql_proxy -instances="${INSTANCE_CONNECTION_NAME}"=tcp:1433 &>> cloud_sql_proxy.log &
 elif [[ $SQL_CLIENT == 'mysql' ]]; then
 export INSTANCE_HOST=127.0.0.1

cloud-sql/sqlserver/mssql/README.md

@@ -6,9 +6,8 @@
 [create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project).
 
 1. [Create a Google Cloud SQL "SQL Server" instance](
- https://console.cloud.google.com/sql/choose-instance-engine).
-
-1. Under the instance's "USERS" tab, create a new user. Note the "User name" and "Password".
+ https://cloud.google.com/sql/docs/sqlserver/create-instance). Note the instance `connection name` of the instance that you create,
+ and password that you specify for the default 'sqlserver' user.
 
 1. Under the instance's "DATABASES" tab, create a new database.
 
@@ -28,6 +27,8 @@ Use the information noted in the previous steps to set the following environment
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
 export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_HOST='127.0.0.1'
+export DB_PORT='1433'
 export DB_USER='my-db-user'
 export DB_PASS='my-db-pass'
 export DB_NAME='my_db'

cloud-sql/sqlserver/mssql/app.yaml

@@ -20,7 +20,8 @@ env_variables:
  DB_USER: MY_DB_USER
  DB_PASS: MY_DB_PASSWORD
  DB_NAME: MY_DATABASE
- DEPLOYED: true
+ INSTANCE_HOST: '172.17.0.1'
+ DB_PORT: '1433'
 
 beta_settings:
  # The connection name of your instance, available by using

cloud-sql/sqlserver/mssql/connect-tcp.js

@@ -0,0 +1,41 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+// [START cloud_sql_sqlserver_mssql_connect_tcp]
+const mssql = require('mssql');
+
+// connectTcpPool initializes a TCP connection pool for a Cloud SQL
+// instance of SQL Server.
+const createTcpPool = async config => {
+ // Note: Saving credentials in environment variables is convenient, but not
+ // secure - consider a more secure solution such as
+ // Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
+ // keep secrets safe.
+ const dbConfig = {
+ server: process.env.INSTANCE_HOST, // e.g. '127.0.0.1'
+ port: parseInt(process.env.DB_PORT), // e.g. 1433
+ user: process.env.DB_USER, // e.g. 'my-db-user'
+ password: process.env.DB_PASS, // e.g. 'my-db-password'
+ database: process.env.DB_NAME, // e.g. 'my-database'
+ options: {
+ trustServerCertificate: true,
+ },
+ // ... Specify additional properties here.
+ ...config,
+ };
+ return await mssql.connect(dbConfig);
+};
+// [END cloud_sql_sqlserver_mssql_connect_tcp]
+module.exports = createTcpPool;

cloud-sql/sqlserver/mssql/deployment.yaml

@@ -38,7 +38,7 @@ spec:
  env:
  - name: PORT
  value: "8080"
- - name: DB_HOST
+ - name: INSTANCE_HOST
  value: "127.0.0.1"
  - name: DB_PORT
  value: "1433" 

cloud-sql/sqlserver/mssql/server.js renamed to cloud-sql/sqlserver/mssql/index.js

@@ -15,6 +15,7 @@
 'use strict';
 
 const express = require('express');
+const createTcpPool = require('./connect-tcp.js');
 const mssql = require('mssql');
 
 const app = express();
@@ -50,32 +51,8 @@ async function accessSecretVersion(secretName) {
  return version.payload.data;
 }
 
-// [START cloud_sql_sqlserver_mssql_create]
 const createPool = async () => {
- const config = {pool: {}, options: {}};
-
- // Check if a Secret Manager secret version is defined
- // If a version is defined, retrieve the secret from Secret Manager and set as the DB_PASS
- const {CLOUD_SQL_CREDENTIALS_SECRET} = process.env;
- if (CLOUD_SQL_CREDENTIALS_SECRET) {
- const secrets = await accessSecretVersion(CLOUD_SQL_CREDENTIALS_SECRET);
- try {
- process.env.DB_PASS = secrets.toString();
- } catch (err) {
- err.message = `Unable to parse secret from Secret Manager. Make sure that the secret is JSON formatted: \n ${err.message} `;
- throw err;
- }
- }
-
- config.user = process.env.DB_USER; // e.g. 'my-db-user'
- config.password = process.env.DB_PASS; // e.g. 'my-db-password'
- config.database = process.env.DB_NAME; // e.g. 'my-database'
- // set the server to '172.17.0.1' when connecting from App Engine Flex
- config.server = process.env.DEPLOYED ? '172.17.0.1' : '127.0.0.1';
- config.port = 1433;
-
- // [START_EXCLUDE]
-
+ const config = {pool: {}};
  // [START cloud_sql_sqlserver_mssql_timeout]
  // 'connectionTimeout` is the maximum number of milliseconds to wait trying to establish an
  // initial connection. After the specified amount of time, an exception will be thrown.
@@ -87,7 +64,6 @@ const createPool = async () => {
  // and not be checked out before it is automatically closed
  (config.pool.idleTimeoutMillis = 600000),
  // [END cloud_sql_sqlserver_mssql_timeout]
-
  // [START cloud_sql_sqlserver_mssql_limit]
  // 'max' limits the total number of concurrent connections this pool will keep. Ideal
  // values for this setting are highly variable on app design, infrastructure, and database.
@@ -103,11 +79,21 @@ const createPool = async () => {
  config.pool.createRetryIntervalMillis = 200;
  // [END cloud_sql_sqlserver_mssql_backoff]
 
- // [END_EXCLUDE]
- config.options.trustServerCertificate = true;
- return await mssql.connect(config);
+ // Check if a Secret Manager secret version is defined
+ // If a version is defined, retrieve the secret from Secret Manager and set as the DB_PASS
+ const {CLOUD_SQL_CREDENTIALS_SECRET} = process.env;
+ if (CLOUD_SQL_CREDENTIALS_SECRET) {
+ const secrets = await accessSecretVersion(CLOUD_SQL_CREDENTIALS_SECRET);
+ try {
+ process.env.DB_PASS = secrets.toString();
+ } catch (err) {
+ err.message = `Unable to parse secret from Secret Manager. Make sure that the secret is JSON formatted: \n ${err.message} `;
+ throw err;
+ }
+ }
+
+ return createTcpPool(config);
 };
-// [END cloud_sql_sqlserver_mssql_create]
 
 const ensureSchema = async pool => {
  // Wait for tables to be created (if they don't already exist).
@@ -148,7 +134,7 @@ app.use(async (req, res, next) => {
 });
 
 // Serve the index page, showing vote tallies.
-app.get('/', async (req, res) => {
+const httpGet = async (req, res) => {
  try {
  // Get the 5 most recent votes.
  const recentVotesQuery = pool
@@ -192,10 +178,12 @@ app.get('/', async (req, res) => {
  )
  .end();
  }
-});
+};
+
+app.get('/', httpGet);
 
 // Handle incoming vote requests and inserting them into the database.
-app.post('/', async (req, res) => {
+const httpPost = async (req, res) => {
  const {team} = req.body;
  const timestamp = new Date();
 
@@ -236,20 +224,28 @@ app.post('/', async (req, res) => {
  // [END cloud_sql_sqlserver_mssql_connection]
 
  res.status(200).send(`Successfully voted for ${team} at ${timestamp}`).end();
-});
-
-const PORT = parseInt(process.env.PORT) || 8080;
-const server = app.listen(PORT, () => {
- console.log(`App listening on port ${PORT}`);
- console.log('Press Ctrl+C to quit.');
-});
+};
 
-const environment = process.env.NODE_ENV || 'development';
-if (environment === 'development') {
- process.on('unhandledRejection', err => {
- console.error(err);
- throw err;
- });
-}
+app.post('*', httpPost);
+
+/**
+ * Responds to GET and POST requests for TABS vs SPACES sample app.
+ *
+ * @param {Object} req Cloud Function request context.
+ * @param {Object} res Cloud Function response context.
+ */
+exports.votes = (req, res) => {
+ switch (req.method) {
+ case 'GET':
+ httpGet(req, res);
+ break;
+ case 'POST':
+ httpPost(req, res);
+ break;
+ default:
+ res.status(405).send({error: 'Something blew up!'});
+ break;
+ }
+};
 
-module.exports = server;
+module.exports = app;

cloud-sql/sqlserver/mssql/package.json

@@ -12,6 +12,7 @@
  "node": ">=10.0.0"
  },
  "scripts": {
+ "start": "node server/server.js",
  "system-test": "mocha test/*.test.js --timeout=60000 --exit",
  "test": "npm run system-test"
  },

cloud-sql/sqlserver/mssql/server/server.js

@@ -0,0 +1,31 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const app = require('../index.js');
+
+const PORT = parseInt(process.env.PORT) || 8080;
+const server = app.listen(PORT, () => {
+ console.log(`App listening on port ${PORT}`);
+ console.log('Press Ctrl+C to quit.');
+});
+
+const environment = process.env.NODE_ENV || 'development';
+if (environment === 'development') {
+ process.on('unhandledRejection', err => {
+ console.error(err);
+ throw err;
+ });
+}
+
+module.exports = server;

cloud-sql/sqlserver/mssql/test/server.test.js

@@ -18,7 +18,7 @@ const path = require('path');
 const request = require('supertest');
 const assert = require('assert');
 
-const SAMPLE_PATH = path.join(__dirname, '../server.js');
+const SAMPLE_PATH = path.join(__dirname, '../server/server.js');
 
 const server = require(SAMPLE_PATH);
 

cloud-sql/sqlserver/mssql/views/index.pug

@@ -58,7 +58,7 @@ html(lang="en")
  }
  }
  };
- xhr.open("POST", "/", true);
+ xhr.open("POST", "/votes", true);
  xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
  xhr.send("team=" + team);
  }