feat: Update Cloud SQL MySQL samples to include more connection methods by shubha-rajan · Pull Request #7054 · GoogleCloudPlatform/java-docs-samples

shubha-rajan · 2022-04-22T22:33:08Z

Please review this PR to bring this sample into compliance with the standards in go/csql-v2-connectivity-samples. This PR only covers MySQL; I'll update the other two samples once this one is reviewed.

I have followed Sample Format Guide
pom.xml parent set to latest shared-configuration
Appropriate changes to README are included in PR
API's need to be enabled to test (tell us)
Environment Variables need to be set (ask us to set them)
Tests pass: mvn clean verify required
Lint passes: mvn -P lint checkstyle:check required
Static Analysis: mvn -P lint clean compile pmd:cpd-check spotbugs:check advisory only
Please merge this PR for me once it is approved.

snippet-bot · 2022-04-22T22:33:12Z

You are about to delete the following sample browser pages.

cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:49, tag cloud_sql_mysql_servlet_create(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:79, tag cloud_sql_mysql_servlet_limit(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:88, tag cloud_sql_mysql_servlet_timeout(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:98, tag cloud_sql_mysql_servlet_backoff(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:103, tag cloud_sql_mysql_servlet_lifetime(usage: page 1).

You are about to delete the following frozen region tags.

cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:49, tag cloud_sql_mysql_servlet_create(usage: page 1 page 2 page 3 page 4 page 5 page 6 page 7 page 8 page 9).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:79, tag cloud_sql_mysql_servlet_limit(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:88, tag cloud_sql_mysql_servlet_timeout(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:98, tag cloud_sql_mysql_servlet_backoff(usage: page 1).
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:103, tag cloud_sql_mysql_servlet_lifetime(usage: page 1).

Here is the summary of changes.

You are about to add 12 region tags.

cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolFactory.java:24, tag cloud_sql_mysql_servlet_limit
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolFactory.java:33, tag cloud_sql_mysql_servlet_timeout
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolFactory.java:43, tag cloud_sql_mysql_servlet_backoff
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolFactory.java:48, tag cloud_sql_mysql_servlet_lifetime
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectorConnectionPoolFactory.java:19, tag cloud_sql_mysql_servlet_connect_connector
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectorConnectionPoolFactory.java:20, tag cloud_sql_mysql_servlet_connect_unix
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectorConnectionPoolFactory.java:67, tag cloud_sql_mysql_servlet_connect_connector
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectorConnectionPoolFactory.java:74, tag cloud_sql_mysql_servlet_connect_unix
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/TcpConnectionPoolFactory.java:19, tag cloud_sql_mysql_servlet_connect_tcp
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/TcpConnectionPoolFactory.java:20, tag cloud_sql_mysql_servlet_connect_tcp_sslcerts
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/TcpConnectionPoolFactory.java:46, tag cloud_sql_mysql_servlet_connect_tcp
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/TcpConnectionPoolFactory.java:79, tag cloud_sql_mysql_servlet_connect_tcp

You are about to delete 5 region tags.

cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:49, tag cloud_sql_mysql_servlet_create
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:79, tag cloud_sql_mysql_servlet_limit
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:88, tag cloud_sql_mysql_servlet_timeout
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:98, tag cloud_sql_mysql_servlet_backoff
cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java:103, tag cloud_sql_mysql_servlet_lifetime

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

lesv · 2022-04-27T00:13:49Z

Are you going to add any tags? (SnippetBot is unhappy)

shubha-rajan · 2022-04-27T17:00:49Z

Are you going to add any tags? (SnippetBot is unhappy)

Yes, I'll need to change the tags in our documentation right after merging this.

enocom · 2022-04-27T17:03:29Z

@shubha-rajan Let's pin the tags in the docs. Once we're done with all the samples, we'll make a pass and unpin everything.

Co-authored-by: Jack Wotherspoon <jackwoth@google.com>

kurtisvg · 2022-04-28T20:29:03Z

+  @SuppressFBWarnings(
+      value = "USBR_UNNECESSARY_STORE_BEFORE_RETURN",
+      justification = "Necessary for sample region tag.")


Can we scrap these SuppressFBWarnings or suppress in the pom somehow?

They're already scrapped. I think you're looking at an outdated version?

kurtisvg · 2022-04-28T20:34:43Z

+    // See the link below for more information on how to configure SSL Certificates for use with
+    // MySQL Connector/J
+    //


// See the _link below_ for more information on how to configure SSL Certificates for use with // MySQL Connector/J // 👀

added the link

kurtisvg · 2022-04-28T20:43:32Z

+  private void createTable(DataSource pool) throws SQLException {
+    // Safely attempt to create the table schema.
+    try (Connection conn = pool.getConnection()) {
+      String stmt =
+          "CREATE TABLE IF NOT EXISTS votes ( "
+              + "vote_id SERIAL NOT NULL, time_cast timestamp NOT NULL, candidate CHAR(6) NOT NULL,"
+              + " PRIMARY KEY (vote_id) );";
+      try (PreparedStatement createTableStatement = conn.prepareStatement(stmt);) {
+        createTableStatement.execute();
+      }
+    }
+  }
+
+  // Used to validate user input. All user provided data should be validated and sanitized before
+  // being used something like a SQL query. Returns null if invalid.
+  @Nullable
+  private String validateTeam(String input) {
+    if (input != null) {
+      input = input.toUpperCase(Locale.ENGLISH);
+      // Must be either "TABS" or "SPACES"
+      if (!"TABS".equals(input) && !"SPACES".equals(input)) {
+        return null;
+      }
+    }
+    return input;
+  }


Is there any way to abstract some of this out so it's shared between the function and the servlet?

…nectorConnectionPoolFactory.java Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

…plateData.java Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

kurtisvg · 2022-04-29T21:16:13Z

+  private static final String DB_NAME = System.getenv("DB_NAME");
+
+  public static DataSource createConnectionPool() {
+


nit: no newline?

kurtisvg · 2022-04-29T21:16:53Z

+    // Unix sockets are not natively supported in Java, so it is necessary to use the Cloud SQL JDBC
+    // Socket Factory to connect.
+    // Note: For Java users, the Cloud SQL JDBC Socket Factory can provide authenticated connections
+    // which is usually preferable to using the Cloud SQL Proxy with Unix sockets.
+    // See https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory for details.


nit: Should we s/SocketFactory/Java connector here?

kurtisvg · 2022-04-29T21:17:59Z

+import java.util.Locale;
+import javax.annotation.Nullable;
+
+public class InputValidator {


nit: You could merge InputValidator and DatabaseSetup into a utils class instead of each having it's own file if you wanted

enocom · 2022-05-02T15:40:21Z

+
+    // [END cloud_sql_mysql_servlet_connect_connector]
+    // Unix sockets are not natively supported in Java, so it is necessary to use the Cloud SQL
+    // Java Connector to connect.


I think we need another sentence here that explains what enabling the Unix socket does. Something like, "When setting INSTANCE_UNIX_SOCKET, the connector will do X, Y, and Z," where X, Y, and Z are the things it does differently than just using the connector without a Unix socket.

gcf-merge-on-green · 2022-05-02T22:56:11Z

Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot.

update mysql sample to include new region tags

bd79d41

product-auto-label Bot added the samples Issues that are directly related to samples. label Apr 22, 2022

shubha-rajan changed the title ~~(WIP) update Cloud SQL samples~~ (WIP) feat: Update Cloud SQL MySQL samples to include more connection methods Apr 22, 2022

shubha-rajan added 7 commits April 22, 2022 15:40

add license header

65b4ef7

move connection code for TCP and connector to separate files

aa506d7

add functions sample

d8f9198

add missing license headers

6e1ead5

Update region tag

09b8580

reformat code

b1915ee

fix function sample

a111d15

shubha-rajan force-pushed the cloudsql-v2-samples branch from 777bccf to a111d15 Compare April 26, 2022 16:59

shubha-rajan added 2 commits April 26, 2022 15:45

get function working

34b7b4d

update instructions for deploying to Functions

0c2ef0f

shubha-rajan marked this pull request as ready for review April 26, 2022 23:10

shubha-rajan requested a review from a team April 26, 2022 23:10

shubha-rajan requested review from a team and yoshi-approver as code owners April 26, 2022 23:10

blunderbuss-gcf Bot assigned lesv Apr 26, 2022

shubha-rajan requested review from enocom and kurtisvg April 26, 2022 23:11

shubha-rajan changed the title ~~(WIP) feat: Update Cloud SQL MySQL samples to include more connection methods~~ feat: Update Cloud SQL MySQL samples to include more connection methods Apr 26, 2022

lesv approved these changes Apr 27, 2022

View reviewed changes

jackwotherspoon reviewed Apr 27, 2022

View reviewed changes

Comment thread cloud-sql/mysql/servlet/.env.yaml Outdated

enocom requested changes Apr 27, 2022

View reviewed changes

shubha-rajan and others added 2 commits April 27, 2022 11:51

Update cloud-sql/mysql/servlet/.env.yaml

dbf82e3

Co-authored-by: Jack Wotherspoon <jackwoth@google.com>

add imports and environment variables to sample

2367b8e

shubha-rajan added 2 commits April 28, 2022 14:10

Update README.md

b51e07f

Update ConnectorConnectionPoolFactory.java

0134a35

shubha-rajan requested review from enocom and jackwotherspoon April 28, 2022 21:13

formatting

9d992b3

shubha-rajan added the snippet-bot:force-run Force snippet-bot runs its logic label Apr 29, 2022

snippet-bot Bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Apr 29, 2022

kurtisvg suggested changes Apr 29, 2022

View reviewed changes

shubha-rajan and others added 4 commits April 29, 2022 10:05

Update cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/Con…

90016c2

…nectorConnectionPoolFactory.java Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

Update TcpConnectionPoolFactory.java

8fc722f

Update cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/Tem…

d78947c

…plateData.java Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>

Factor out common methods in servlet and cloud function

dc809d5

shubha-rajan requested a review from kurtisvg April 29, 2022 18:08

kurtisvg approved these changes Apr 29, 2022

View reviewed changes

shubha-rajan added 3 commits April 29, 2022 14:30

combine DatabaseSetup and InputValidator classes

ff96d05

refactor cloud function to use initialization on demand

77b0a55

formatting

e2e3183

shubha-rajan mentioned this pull request May 2, 2022

feat: Update Postgres samples to include more connection methods #7080

Merged

9 tasks

enocom approved these changes May 2, 2022

View reviewed changes

Update ConnectorConnectionPoolFactory.java

eeebe2e

shubha-rajan added automerge Merge the pull request once unit tests and other checks pass. and removed automerge Merge the pull request once unit tests and other checks pass. labels May 2, 2022

Update ConnectorConnectionPoolFactory.java

ba8e5c7

shubha-rajan added the automerge Merge the pull request once unit tests and other checks pass. label May 2, 2022

Update TcpConnectionPoolFactory.java

b4b461c

gcf-merge-on-green Bot removed the automerge Merge the pull request once unit tests and other checks pass. label May 2, 2022

lesv merged commit f63f258 into main May 2, 2022

lesv deleted the cloudsql-v2-samples branch May 2, 2022 23:17

		private static final String DB_NAME = System.getenv("DB_NAME");

		public static DataSource createConnectionPool() {

Conversation

shubha-rajan commented Apr 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot Bot commented Apr 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lesv commented Apr 27, 2022

Uh oh!

shubha-rajan commented Apr 27, 2022

Uh oh!

enocom commented Apr 27, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gcf-merge-on-green Bot commented May 2, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

shubha-rajan commented Apr 22, 2022 •

edited

Loading

snippet-bot Bot commented Apr 22, 2022 •

edited

Loading