Skip to content

Stub ReadWriteSplittingPlugin #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion aws_wrapper/plugin_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
from aws_wrapper.hostinfo import HostAvailability, HostInfo, HostRole
from aws_wrapper.iam_plugin import IamAuthPluginFactory
from aws_wrapper.plugin import CanReleaseResources
from aws_wrapper.read_write_splitting_plugin import \
ReadWriteSplittingPluginFactory
from aws_wrapper.utils.cache_map import CacheMap
from aws_wrapper.utils.messages import Messages
from aws_wrapper.utils.notifications import (ConnectionEvent, HostEvent,
Expand Down Expand Up @@ -419,7 +421,8 @@ class PluginManager(CanReleaseResources):
"aurora_connection_tracker": AuroraConnectionTrackerPluginFactory,
"aurora_host_list": AuroraHostListPluginFactory,
"host_monitoring": HostMonitoringPluginFactory,
"failover": FailoverPluginFactory
"failover": FailoverPluginFactory,
"readWriteSplitting": ReadWriteSplittingPluginFactory
}

def __init__(
Expand Down
80 changes: 80 additions & 0 deletions aws_wrapper/read_write_splitting_plugin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# 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.

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
from aws_wrapper.host_list_provider import HostListProviderService
from aws_wrapper.hostinfo import HostInfo
from aws_wrapper.plugin_service import PluginService
from aws_wrapper.utils.properties import Properties

from typing import Any, Callable, Set

from aws_wrapper.pep249 import Connection
from aws_wrapper.plugin import Plugin, PluginFactory
from aws_wrapper.utils.notifications import (ConnectionEvent,
OldConnectionSuggestedAction)


class ReadWriteSplittingPlugin(Plugin):
_SUBSCRIBED_METHODS: Set[str] = {"init_host_provider",
"connect",
"notify_connection_changed",
"Connection.set_read_only",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI, different drivers implement set read only differently, so we'll have to keep this in mind and make sure this string matches whatever method is called to set read only. More details here

"Connection.clear_warnings"}

def __init__(self, plugin_service: PluginService, props: Properties):
self._plugin_service = plugin_service
self._properties = props

@property
def subscribed_methods(self) -> Set[str]:
return self._SUBSCRIBED_METHODS

def init_host_provider(
self,
props: Properties,
host_list_provider_service: HostListProviderService,
init_host_provider_func: Callable):
...

def connect(
self,
host_info: HostInfo,
props: Properties,
initial: bool,
connect_func: Callable) -> Connection:
return Connection()

def force_connect(
self,
host_info: HostInfo,
props: Properties,
initial: bool,
force_connect_func: Callable) -> Connection:
return Connection()

def notify_connection_changed(self, changes: Set[ConnectionEvent]) -> OldConnectionSuggestedAction:
return OldConnectionSuggestedAction.NO_OPINION

def execute(self, target: type, method_name: str, execute_func: Callable, *args: Any) -> Any:
...


class ReadWriteSplittingPluginFactory(PluginFactory):
def get_instance(self, plugin_service: PluginService, props: Properties) -> Plugin:
return ReadWriteSplittingPlugin(plugin_service, props)