Merge pull request #67 from oracle/66-vsession-options

66 vsession options

Author: jeandelavarene

.github/workflows/startup/01_createUser.sql

@@ -34,10 +34,12 @@
 -- tables, and to query some V$ views:
 --   v$open_cursor (to verify if cursors are being closed).
 --   v$transaction (to verify if TransactionDefinitions are applied).
+--   v$session (to verify if VSESSION_* Options are applied).
 ALTER SESSION SET CONTAINER=xepdb1;
 CREATE ROLE r2dbc_test_user;
 GRANT SELECT ON v_$open_cursor TO r2dbc_test_user;
 GRANT SELECT ON v_$transaction TO r2dbc_test_user;
+GRANT SELECT ON v_$session TO r2dbc_test_user;
 
 CREATE USER test IDENTIFIED BY test;
 GRANT connect, resource, unlimited tablespace, r2dbc_test_user TO test;

src/main/java/oracle/r2dbc/OracleR2dbcOptions.java

@@ -223,4 +223,40 @@ private OracleR2dbcOptions() {}
    */
   public static final Option<CharSequence> ENABLE_QUERY_RESULT_CACHE =
     Option.valueOf(OracleConnection.CONNECTION_PROPERTY_ENABLE_QUERY_RESULT_CACHE);
+
+  /**
+   * Configures the Oracle JDBC Connection used by Oracle R2DBC as specified by:
+   * {@link OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_TERMINAL}
+   */
+  public static final Option<CharSequence> VSESSION_TERMINAL =
+    Option.valueOf(OracleConnection.CONNECTION_PROPERTY_THIN_VSESSION_TERMINAL);
+
+  /**
+   * Configures the Oracle JDBC Connection used by Oracle R2DBC as specified by:
+   * {@link OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_MACHINE}
+   */
+  public static final Option<CharSequence> VSESSION_MACHINE =
+    Option.valueOf(OracleConnection.CONNECTION_PROPERTY_THIN_VSESSION_MACHINE);
+
+  /**
+   * Configures the Oracle JDBC Connection used by Oracle R2DBC as specified by:
+   * {@link OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_OSUSER}
+   */
+  public static final Option<CharSequence> VSESSION_OSUSER =
+    Option.valueOf(OracleConnection.CONNECTION_PROPERTY_THIN_VSESSION_OSUSER);
+
+  /**
+   * Configures the Oracle JDBC Connection used by Oracle R2DBC as specified by:
+   * {@link OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_PROGRAM}
+   */
+  public static final Option<CharSequence> VSESSION_PROGRAM =
+    Option.valueOf(OracleConnection.CONNECTION_PROPERTY_THIN_VSESSION_PROGRAM);
+
+  /**
+   * Configures the Oracle JDBC Connection used by Oracle R2DBC as specified by:
+   * {@link OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_PROCESS}
+   */
+  public static final Option<CharSequence> VSESSION_PROCESS =
+    Option.valueOf(OracleConnection.CONNECTION_PROPERTY_THIN_VSESSION_PROCESS);
+
 }

src/main/java/oracle/r2dbc/impl/OracleReactiveJdbcAdapter.java

@@ -126,17 +126,20 @@
 final class OracleReactiveJdbcAdapter implements ReactiveJdbcAdapter {
 
   /**
+   * <p>
    * The set of JDBC connection properties that this adapter supports. Each
    * property in this set is represented as an {@link Option} having the name
    * of the supported JDBC connection property. When a property is configured
    * with a sensitive value, such as a password, it is represented in this
    * set as a {@linkplain Option#sensitiveValueOf(String) sensitive Option}.
+   * </p><p>
    * If a new Option is added to this set, then it <i>must</i> be documented
    * in the javadoc of {@link #createDataSource(ConnectionFactoryOptions)},
    * and in any other reference that lists which options the Oracle R2DBC Driver
    * supports. Undocumented options are useless; Other programmers won't be
    * able to use an option if they have no way to understand what the option
    * does or how it should be configured.
+   * </p>
    */
   private static final Set<Option<CharSequence>>
     JDBC_CONNECTION_PROPERTY_OPTIONS = Set.of(
@@ -198,7 +201,14 @@ final class OracleReactiveJdbcAdapter implements ReactiveJdbcAdapter {
       // Allow the client-side ResultSet cache to be disabled. It is
       // necessary to do so when using the serializable transaction isolation
       // level in order to prevent phantom reads.
-      OracleR2dbcOptions.ENABLE_QUERY_RESULT_CACHE
+      OracleR2dbcOptions.ENABLE_QUERY_RESULT_CACHE,
+
+      // Allow v$session attributes to be configured for tracing
+      OracleR2dbcOptions.VSESSION_OSUSER,
+      OracleR2dbcOptions.VSESSION_TERMINAL,
+      OracleR2dbcOptions.VSESSION_PROCESS,
+      OracleR2dbcOptions.VSESSION_PROGRAM,
+      OracleR2dbcOptions.VSESSION_MACHINE
     );
 
   /** Guards access to a JDBC {@code Connection} created by this adapter */
@@ -379,6 +389,21 @@ public AsyncLock getLock() {
    *   </li><li>
    *   {@linkplain OracleConnection#CONNECTION_PROPERTY_IMPLICIT_STATEMENT_CACHE_SIZE
    *     oracle.jdbc.implicitStatementCacheSize}
+   *   </li><li>
+   *   {@linkplain OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_OSUSER
+   *     v$session.osuser}
+   *   </li><li>
+   *   {@linkplain OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_TERMINAL
+   *     v$session.terminal}
+   *   </li><li>
+   *   {@linkplain OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_PROCESS
+   *     v$session.process}
+   *   </li><li>
+   *   {@linkplain OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_PROGRAM
+   *     v$session.program}
+   *   </li><li>
+   *   {@linkplain OracleConnection#CONNECTION_PROPERTY_THIN_VSESSION_MACHINE
+   *     v$session.machine}
    *   </li>
    * </ul>
    *

src/test/java/oracle/r2dbc/impl/OracleReactiveJdbcAdapterTest.java

@@ -30,6 +30,7 @@
 import oracle.jdbc.OracleConnection;
 import oracle.jdbc.datasource.OracleDataSource;
 import oracle.r2dbc.OracleR2dbcOptions;
+import oracle.r2dbc.test.DatabaseConfig;
 import org.junit.jupiter.api.Test;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -63,6 +64,7 @@
 import static io.r2dbc.spi.ConnectionFactoryOptions.PORT;
 import static io.r2dbc.spi.ConnectionFactoryOptions.STATEMENT_TIMEOUT;
 import static io.r2dbc.spi.ConnectionFactoryOptions.USER;
+import static java.lang.String.format;
 import static oracle.r2dbc.test.DatabaseConfig.connectTimeout;
 import static oracle.r2dbc.test.DatabaseConfig.host;
 import static oracle.r2dbc.test.DatabaseConfig.password;
@@ -210,7 +212,7 @@ public void testCreateDataSource() throws SQLException {
   public void testTnsAdmin() throws IOException {
 
     // Create an Oracle Net Descriptor
-    String descriptor = String.format(
+    String descriptor = format(
       "(DESCRIPTION=(ADDRESS=(HOST=%s)(PORT=%d)(PROTOCOL=tcp))" +
         "(CONNECT_DATA=(SERVICE_NAME=%s)))",
       host(), port(), serviceName());
@@ -227,13 +229,13 @@ public void testTnsAdmin() throws IOException {
     try {
       // Expect to connect with the descriptor in the R2DBC URL
       awaitNone(awaitOne(
-        ConnectionFactories.get(String.format(
+        ConnectionFactories.get(format(
           "r2dbc:oracle://%s:%s@?oracle.r2dbc.descriptor=%s",
           user(), password(), descriptor))
           .create())
         .close());
       awaitNone(awaitOne(
-        ConnectionFactories.get(ConnectionFactoryOptions.parse(String.format(
+        ConnectionFactories.get(ConnectionFactoryOptions.parse(format(
           "r2dbc:oracle://@?oracle.r2dbc.descriptor=%s", descriptor))
           .mutate()
           .option(USER, user())
@@ -245,14 +247,14 @@ public void testTnsAdmin() throws IOException {
       // Expect to connect with the tnsnames.ora file, when a URL specifies
       // the file path and an alias
       awaitNone(awaitOne(
-        ConnectionFactories.get(String.format(
+        ConnectionFactories.get(format(
           "r2dbc:oracle://%s:%s@?oracle.r2dbc.descriptor=%s&TNS_ADMIN=%s",
           user(), password(), "test_alias", userDir))
           .create())
           .close());
       awaitNone(awaitOne(
         ConnectionFactories.get(ConnectionFactoryOptions.parse(
-          String.format(
+          format(
             "r2dbc:oracle://@?oracle.r2dbc.descriptor=%s&TNS_ADMIN=%s",
             "test_alias", userDir))
           .mutate()
@@ -288,14 +290,14 @@ public void testTnsAdmin() throws IOException {
 
       // Create an ojdbc.properties file containing the user name
       Files.writeString(Path.of("ojdbc.properties"),
-        String.format("user=%s", user()),
+        format("user=%s", user()),
         StandardOpenOption.CREATE_NEW);
       try {
         // Expect to connect with the tnsnames.ora and ojdbc.properties files,
         // when a URL specifies their path and an alias, the properties file
         // specifies a user, and a standard option specifies the password.
         awaitNone(awaitOne(
-          ConnectionFactories.get(ConnectionFactoryOptions.parse(String.format(
+          ConnectionFactories.get(ConnectionFactoryOptions.parse(format(
             "r2dbc:oracle://?oracle.r2dbc.descriptor=%s&TNS_ADMIN=%s",
             "test_alias", userDir))
             .mutate()
@@ -469,6 +471,63 @@ public void testExecutorOption() {
     }
   }
 
+  /**
+   * Verifies the
+   * {@link OracleR2dbcOptions#VSESSION_OSUSER},
+   * {@link OracleR2dbcOptions#VSESSION_TERMINAL},
+   * {@link OracleR2dbcOptions#VSESSION_PROCESS},
+   * {@link OracleR2dbcOptions#VSESSION_PROGRAM}, and
+   * {@link OracleR2dbcOptions#VSESSION_MACHINE} options.
+   */
+  @Test
+  public void testVSessionOptions() {
+    String osuser = "test-osuser";
+    String terminal = "test-terminal";
+    String process = "test-process";
+    String program = "test-program";
+    String machine = "test-machine";
+
+    // Verify configuration with URL parameters
+    Connection connection = awaitOne(ConnectionFactories.get(
+      ConnectionFactoryOptions.parse(
+        format("r2dbc:oracle://%s:%d/%s" +
+          "?v$session.osuser=%s" +
+          "&v$session.terminal=%s" +
+          "&v$session.process=%s" +
+          "&v$session.program=%s" +
+          "&v$session.machine=%s",
+          host(), port(), serviceName(),
+          osuser, terminal, process, program, machine))
+      .mutate()
+      .option(USER, user())
+      .option(PASSWORD, password())
+      .build())
+      .create());
+    try {
+      Result result = awaitOne(connection.createStatement(
+        "SELECT count(*)" +
+          " FROM v$session" +
+          " WHERE osuser=?" +
+          " AND terminal=?" +
+          " AND process=?" +
+          " AND program=?" +
+          " AND machine=?")
+        .bind(0, osuser)
+        .bind(1, terminal)
+        .bind(2, process)
+        .bind(3, program)
+        .bind(4, machine)
+        .execute());
+
+      assertEquals(
+        Integer.valueOf(1),
+        awaitOne(result.map(row -> row.get(0, Integer.class))));
+    }
+    finally {
+      tryAwaitNone(connection.close());
+    }
+  }
+
   /**
    * Verifies that an attempt to connect with a {@code listeningChannel}
    * results in an {@link R2dbcTimeoutException}.