-
Notifications
You must be signed in to change notification settings - Fork 0
OOP for project writers #104
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
Open
tmikula-dev
wants to merge
6
commits into
master
Choose a base branch
from
feature/94-oop-for-writers
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c3071e3
OOP approach for writer classes.
tmikula-dev 5c8fdaa
OOP approach for the handlers.
tmikula-dev 768ea46
OOP approach for the main script.
tmikula-dev 8cdd815
test updates for writer scripts
tmikula-dev 65fe266
test updates for handler scripts
tmikula-dev 4afdeb9
Test updates for trace logging.
tmikula-dev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,59 @@ | ||
| # | ||
| # Copyright 2026 ABSA Group Limited | ||
| # | ||
| # 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. | ||
| # | ||
|
|
||
tmikula-dev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| """ | ||
| This module provides abstract base class for all EventGate writers. | ||
| """ | ||
|
|
||
| from abc import ABC, abstractmethod | ||
| from typing import Any, Dict, Optional, Tuple | ||
|
|
||
|
|
||
| class Writer(ABC): | ||
| """ | ||
| Abstract base class for EventGate writers. | ||
| All writers inherit from this class and implement the write() method. Writers use lazy initialization. | ||
| """ | ||
|
|
||
| def __init__(self, config: Dict[str, Any]) -> None: | ||
| self.config = config | ||
|
|
||
| @abstractmethod | ||
| def write(self, topic_name: str, message: Dict[str, Any]) -> Tuple[bool, Optional[str]]: | ||
| """ | ||
| Publish a message to the target system. | ||
| Args: | ||
| topic_name: Target writer topic (destination) name. | ||
| message: JSON-serializable payload to publish. | ||
| Returns: | ||
| Tuple of (success: bool, error_message: Optional[str]). | ||
| - (True, None) on success or when writer is disabled/skipped. | ||
| - (False, "error description") on failure. | ||
| """ | ||
|
|
||
| @abstractmethod | ||
| def check_health(self) -> Tuple[bool, str]: | ||
| """ | ||
| Check writer health and connectivity. | ||
| Returns: | ||
| Tuple of (is_healthy: bool, message: str). | ||
| - (True, "ok") - configured and working. | ||
| - (True, "not configured") - not configured, skipped. | ||
| - (False, "error message") - configured but failing. | ||
| """ | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: AbsaOSS/EventGate
Length of output: 120
🏁 Script executed:
Repository: AbsaOSS/EventGate
Length of output: 2382
🏁 Script executed:
Repository: AbsaOSS/EventGate
Length of output: 593
Verify constructor behavior aligns with issue
#94requirements.The writers registry structure is well-designed, but
WriterPostgres.__init__(lines 50-61 insrc/writers/writer_postgres.py) violates issue#94's requirement to "avoid any initialization logic in constructors that can throw exceptions."When
POSTGRES_SECRET_NAMEandPOSTGRES_SECRET_REGIONenvironment variables are set, the constructor immediately callsaws_secrets.get_secret_value(), which can raiseBotoCoreError,ClientError, orKeyError. Since this instantiation occurs during Lambda handler initialization, it will cause the entire handler to fail if Secrets Manager is unavailable, resulting in cold-start failures.Defer secrets loading to lazy initialization in
write()orcheck_health()to ensure the handler initializes successfully regardless of Secrets Manager availability, fully complying with the stated design goal.🤖 Prompt for AI Agents