fix(ingestion): Fixed STS token refresh mechanism for sagemaker source #11252

skrydal · 2024-08-27T16:19:22Z

Beside change (fix) to sagemaker source using new refresh mechanism (also fixed), this PR introduces others - which were needed due to these changes:

Introduced session info logging in aws_common, along with a special class allowing costly session check to be done only while DEBUG-level is turned on
Adjusted glue source tests due to the above (even though glue source didn't get the same refresh mechanism as sagemaker source, the tests needed to be adjusted)
Test, positioned along the sagemaker test, of the new mechanism

Checklist

The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
Links to related issues (if applicable)
Tests for the changes have been added/updated (if applicable)
Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

coderabbitai · 2024-08-27T16:19:30Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

treff7es · 2024-09-02T08:16:52Z

metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py

-        return False
+    @staticmethod
+    def get_caller_identity(session: Session) -> Optional[str]:
+        logger.info("Retrieving identity of session: %s", session.profile_name)


We prefer to use format string instead of parameter if possible

treff7es · 2024-09-02T08:17:26Z

metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py

-        return False
+    @staticmethod
+    def get_caller_identity(session: Session) -> Optional[str]:
+        logger.info("Retrieving identity of session: %s", session.profile_name)


Suggested change

logger.info("Retrieving identity of session: %s", session.profile_name)

logger.info(f"Retrieving identity of session: {session.profile_name}")

treff7es · 2024-09-02T08:37:49Z

metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py

+    def __repr__(self):
+        if not self.value_stored:
+            self.value = self.callback(*self.args)
+            self.value_stored = True


Is this store mechanism used anywhere?

Maybe I missed it, but you are not reusing this anywhere.

It is used by DEBUG logger to avoid costly call to sts if we are not on DEBUG level. See here:
https://github.com/datahub-project/datahub/pull/11252/files#diff-658ffa764c667e22fae4a46946899527226fa9e0ce7464d35cf56bd4c2a29726R220

Yes, it was more because I saw you cache the value in LazyLogEvalator, but the LazyLogEvaulator instance is never reused.
It is not a problem as it can be useful in the future.

It is reused actually. We create it once when log.debug line is hit. Then the repr function is called (assuming DEBUG-level is set) to print to console. And then it is called again (now using the cached value) because beside logging to console we also log to a file if debugging is turned on, so caching is, in fact, used.

treff7es · 2024-09-02T08:42:19Z

metadata-ingestion/src/datahub/ingestion/source/aws/sagemaker_processors/feature_groups.py

@@ -55,9 +61,9 @@ def get_feature_group_details(
        """
        Get details of a feature group (including list of component features).
        """
-
+        logger.debug("Attempting to describe feature group: %s", feature_group_name)


Same here as above, please prefer fstrings where possible

treff7es · 2024-09-02T08:46:56Z

metadata-ingestion/src/datahub/ingestion/source/aws/aws_common.py

-            return True
-        return False
+    @staticmethod
+    def get_caller_identity(session: Session) -> Optional[str]:


Can this change over time, or can we cache this?

The logic of the ingestor itself does not need it, we extract the caller identity from the session to make sure we acquired correct role (in debug mode only)

Added extensive role logging

138e542

github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Aug 27, 2024

Got back to proper functioning of credentials refresh check

f7e7bba

vercel bot deployed to Preview August 27, 2024 16:51 View deployment

Reduced verbosity and improved refreshing code

287a39a

vercel bot deployed to Preview August 28, 2024 15:54 View deployment

Linting

aea9b35

vercel bot deployed to Preview August 28, 2024 16:13 View deployment

Added verbosity to sagemaker-related aws calls

6a7b8bc

vercel bot deployed to Preview August 29, 2024 13:36 View deployment

skrydal added 2 commits August 29, 2024 18:10

Client factory used by all sagemaker sub-steps

07f7dcf

Added missing assignment

934d73f

vercel bot deployed to Preview August 29, 2024 16:32 View deployment

skrydal and others added 4 commits August 29, 2024 19:00

Getting rid of static sagemaker client

61869c8

Fix sagemaker tests assuming no lazy evaluator

feb5c6d

Added stubbing of the sts client for debug logging

5d5dcae

Merge branch 'datahub-project:master' into sts_logging

37a6b34

vercel bot deployed to Preview August 30, 2024 13:56 View deployment

skrydal added 2 commits August 30, 2024 17:04

Linting

88ce18c

New test for testing new functionality

b8cebfd

vercel bot deployed to Preview August 31, 2024 12:34 View deployment

Fixed glue tests

8cd4294

skrydal changed the title ~~[DO NOT MERGE] Added extensive role logging~~ fix(ingestion): Fixed STS token refresh mechanism for sagemaker source Sep 1, 2024

Linting

4282cd0

vercel bot deployed to Preview September 1, 2024 10:15 View deployment

Linting

52be907

vercel bot deployed to Preview September 1, 2024 14:35 View deployment

skrydal added 2 commits September 1, 2024 20:29

Fixing tests

5918411

Fixed delta lake tests

18d0d73

Merge branch 'master' into sts_logging

3dd3c7e

vercel bot deployed to Preview September 1, 2024 19:03 View deployment

treff7es approved these changes Sep 2, 2024

View reviewed changes

Merge branch 'master' into sts_logging

e315673

vercel bot deployed to Preview September 9, 2024 10:11 View deployment

Merge branch 'master' into sts_logging

f17e4a6

vercel bot deployed to Preview September 10, 2024 11:48 View deployment

datahub-cyborg bot added the pending-submitter-response Issue/request has been reviewed but requires a response from the submitter label Dec 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(ingestion): Fixed STS token refresh mechanism for sagemaker source #11252

fix(ingestion): Fixed STS token refresh mechanism for sagemaker source #11252

skrydal commented Aug 27, 2024 •

edited

Loading

coderabbitai bot commented Aug 27, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

treff7es Sep 2, 2024

treff7es Sep 2, 2024

treff7es Sep 2, 2024

treff7es Sep 2, 2024

skrydal Sep 2, 2024

treff7es Sep 2, 2024

skrydal Sep 2, 2024

treff7es Sep 2, 2024

treff7es Sep 2, 2024

skrydal Sep 2, 2024

	logger.info("Retrieving identity of session: %s", session.profile_name)
	logger.info(f"Retrieving identity of session: {session.profile_name}")

fix(ingestion): Fixed STS token refresh mechanism for sagemaker source #11252

Are you sure you want to change the base?

fix(ingestion): Fixed STS token refresh mechanism for sagemaker source #11252

Conversation

skrydal commented Aug 27, 2024 • edited Loading

Checklist

coderabbitai bot commented Aug 27, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skrydal commented Aug 27, 2024 •

edited

Loading

coderabbitai bot commented Aug 27, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)