-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provides an implementation of the `SessionMap` that's backed by JDBC.
- Loading branch information
Showing
12 changed files
with
545 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
java/server/src/org/openqa/selenium/grid/sessionmap/jdbc/BUILD.bazel
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| load("@rules_jvm_external//:defs.bzl", "artifact") | ||
| load("//java:version.bzl", "SE_VERSION") | ||
| load("//java:defs.bzl", "java_export") | ||
|
|
||
| java_export( | ||
| name = "jdbc", | ||
| srcs = glob(["*.java"]), | ||
| maven_coordinates = "org.seleniumhq.selenium:selenium-session-map-jdbc:%s" % SE_VERSION, | ||
| pom_template = "//java/client/src/org/openqa/selenium:template-pom", | ||
| visibility = [ | ||
| "//visibility:public", | ||
| ], | ||
| deps = [ | ||
| "//java:auto-service", | ||
| "//java/client/src/org/openqa/selenium/json", | ||
| "//java/server/src/org/openqa/selenium/events", | ||
| "//java/client/src/org/openqa/selenium/remote", | ||
| "//java/server/src/org/openqa/selenium/grid/server", | ||
| "//java/server/src/org/openqa/selenium/grid/sessionmap", | ||
| "//java/server/src/org/openqa/selenium/grid/config", | ||
| "//java/server/src/org/openqa/selenium/grid/log", | ||
| "//java/server/src/org/openqa/selenium/grid/data", | ||
| artifact("com.beust:jcommander"), | ||
| artifact("com.google.guava:guava"), | ||
| ], | ||
| ) |
186 changes: 186 additions & 0 deletions
186
java/server/src/org/openqa/selenium/grid/sessionmap/jdbc/JdbcBackedSessionMap.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you 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. | ||
|
|
||
| package org.openqa.selenium.grid.sessionmap.jdbc; | ||
|
|
||
| import static org.openqa.selenium.grid.data.SessionClosedEvent.SESSION_CLOSED; | ||
|
|
||
| import org.openqa.selenium.Capabilities; | ||
| import org.openqa.selenium.ImmutableCapabilities; | ||
| import org.openqa.selenium.NoSuchSessionException; | ||
| import org.openqa.selenium.events.EventBus; | ||
| import org.openqa.selenium.grid.config.Config; | ||
| import org.openqa.selenium.grid.config.ConfigException; | ||
| import org.openqa.selenium.grid.data.Session; | ||
| import org.openqa.selenium.grid.log.LoggingOptions; | ||
| import org.openqa.selenium.grid.server.EventBusOptions; | ||
| import org.openqa.selenium.grid.sessionmap.SessionMap; | ||
| import org.openqa.selenium.internal.Require; | ||
| import org.openqa.selenium.json.Json; | ||
| import org.openqa.selenium.remote.SessionId; | ||
| import org.openqa.selenium.remote.tracing.Tracer; | ||
|
|
||
| import java.io.Closeable; | ||
| import java.net.URI; | ||
| import java.net.URISyntaxException; | ||
| import java.sql.Connection; | ||
| import java.sql.PreparedStatement; | ||
| import java.sql.ResultSet; | ||
| import java.sql.SQLException; | ||
| import java.util.logging.Logger; | ||
|
|
||
|
|
||
| public class JdbcBackedSessionMap extends SessionMap implements Closeable { | ||
|
|
||
| private static final Json JSON = new Json(); | ||
| private static final Logger LOG = Logger.getLogger(JdbcBackedSessionMap.class.getName()); | ||
| private static final String TABLE_NAME = "sessions_map"; | ||
| private static final String SESSION_ID_COL = "session_ids"; | ||
| private static final String SESSION_CAPS_COL = "session_caps"; | ||
| private static final String SESSION_URI_COL = "session_uri"; | ||
| private final EventBus bus; | ||
| private final Connection connection; | ||
|
|
||
|
|
||
| public JdbcBackedSessionMap(Tracer tracer, Connection jdbcConnection, EventBus bus) { | ||
| super(tracer); | ||
|
|
||
| Require.nonNull("JDBC Connection Object", jdbcConnection); | ||
| this.bus = Require.nonNull("Event bus", bus); | ||
|
|
||
| this.connection = jdbcConnection; | ||
| this.bus.addListener(SESSION_CLOSED, event -> { | ||
| SessionId id = event.getData(SessionId.class); | ||
| remove(id); | ||
| }); | ||
| } | ||
|
|
||
| public static SessionMap create(Config config) { | ||
| Tracer tracer = new LoggingOptions(config).getTracer(); | ||
| EventBus bus = new EventBusOptions(config).getEventBus(); | ||
|
|
||
| JdbcSessionMapOptions sessionMapOptions = new JdbcSessionMapOptions(config); | ||
|
|
||
| Connection connection; | ||
|
|
||
| try { | ||
| connection = sessionMapOptions.getJdbcConnection(); | ||
| } catch (SQLException e) { | ||
| throw new ConfigException(e); | ||
| } | ||
|
|
||
| return new JdbcBackedSessionMap(tracer, connection, bus); | ||
| } | ||
| @Override | ||
| public boolean add(Session session) { | ||
| Require.nonNull("Session to add", session); | ||
|
|
||
| try { | ||
| return insertSessionStatement(session).executeUpdate() >= 1; | ||
|
|
||
| } catch (SQLException e) { | ||
| throw new JdbcException(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Session get(SessionId id) throws NoSuchSessionException { | ||
| Require.nonNull("Session ID", id); | ||
|
|
||
| URI uri = null; | ||
| Capabilities caps = null; | ||
| String rawUri = null; | ||
|
|
||
| try (ResultSet sessions = readSessionStatement(id).executeQuery()){ | ||
| if (!sessions.next()) { | ||
| throw new NoSuchSessionException("Unable to find..."); | ||
| } | ||
|
|
||
| rawUri = sessions.getString(SESSION_URI_COL); | ||
| String rawCapabilities = sessions.getString(SESSION_CAPS_COL); | ||
|
|
||
| caps = rawCapabilities == null ? | ||
| new ImmutableCapabilities() : | ||
| JSON.toType(rawCapabilities, Capabilities.class); | ||
| try { | ||
| uri = new URI(rawUri); | ||
| } catch (URISyntaxException e) { | ||
| throw new NoSuchSessionException(String.format("Unable to convert session id (%s) to uri: %s", id, rawUri), e); | ||
| } | ||
|
|
||
| return new Session(id, uri, caps); | ||
| } catch (SQLException e) { | ||
| throw new JdbcException(e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void remove(SessionId id) { | ||
| Require.nonNull("Session ID", id); | ||
|
|
||
| try { | ||
| getDeleteSqlForSession(id).executeUpdate(); | ||
| } catch (SQLException e) { | ||
| throw new JdbcException(e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| try { | ||
| connection.close(); | ||
| } catch (SQLException e) { | ||
| LOG.warning("SQL exception while closing JDBC Connection:" + e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| private PreparedStatement insertSessionStatement(Session session) throws SQLException { | ||
| PreparedStatement insertStatement = connection.prepareStatement(String.format("insert into %1$s (%2$s, %3$s, %4$s) values (?, ?, ?)", | ||
| TABLE_NAME, | ||
| SESSION_ID_COL, | ||
| SESSION_URI_COL, | ||
| SESSION_CAPS_COL)); | ||
|
|
||
| insertStatement.setString(1, session.getId().toString()); | ||
| insertStatement.setString(2, session.getUri().toString()); | ||
| insertStatement.setString(3, JSON.toJson(session.getCapabilities())); | ||
|
|
||
| return insertStatement; | ||
| } | ||
|
|
||
| private PreparedStatement readSessionStatement(SessionId sessionId) throws SQLException { | ||
| PreparedStatement getSessionsStatement = connection.prepareStatement(String.format("select * from %1$s where %2$s = ?", | ||
| TABLE_NAME, | ||
| SESSION_ID_COL)); | ||
|
|
||
| getSessionsStatement.setMaxRows(1); | ||
| getSessionsStatement.setString(1, sessionId.toString()); | ||
|
|
||
| return getSessionsStatement; | ||
| } | ||
|
|
||
| private PreparedStatement getDeleteSqlForSession(SessionId sessionId) throws SQLException{ | ||
| PreparedStatement deleteSessionStatement = connection.prepareStatement(String.format("delete from %1$s where %2$s = ?", | ||
| TABLE_NAME, | ||
| SESSION_ID_COL)); | ||
|
|
||
| deleteSessionStatement.setString(1, sessionId.toString()); | ||
|
|
||
| return deleteSessionStatement; | ||
|
|
||
| } | ||
| } |
39 changes: 39 additions & 0 deletions
39
java/server/src/org/openqa/selenium/grid/sessionmap/jdbc/JdbcException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you 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. | ||
|
|
||
| package org.openqa.selenium.grid.sessionmap.jdbc; | ||
|
|
||
|
|
||
| import org.openqa.selenium.WebDriverException; | ||
|
|
||
| public class JdbcException extends WebDriverException { | ||
| public JdbcException() { | ||
| super(); | ||
| } | ||
|
|
||
| public JdbcException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| public JdbcException(Throwable cause) { | ||
| super(cause); | ||
| } | ||
|
|
||
| public JdbcException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
| } |
Oops, something went wrong.