Job and notebook URL generation in setup-stitch command #22
Conversation
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
- Update job URLs to use proper format: /jobs/<job-id>/runs/<run-id>?o=<workspace-id>
- Add get_job_run_status() call to retrieve job_id from run_id for correct URL construction
- Update notebook URLs to include workspace ID parameter and URL encoding for spaces
- Add proper error handling with fallback to generic URLs if job status lookup fails
- Update function signatures to pass client for API calls
- Fix test assertion to match new message format ("What you can do now" vs "Choose from the following options")
There was a problem hiding this comment.
Pull Request Overview
This PR updates the messaging and behavior for the setup-stitch command, ensuring a more descriptive and guided experience for users in their Databricks workspace.
- Updated test assertions to check for new user guidance messages.
- Modified command handling to build and display detailed post-launch guidance messages and summary details.
- Added functions to display post-launch options and detailed technical summaries.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/unit/commands/test_setup_stitch.py | Updated test assertions to check for the new, more informative messages. |
| chuck_data/commands/setup_stitch.py | Updated message construction and added functions for user guidance and detailed summary display. |
Comments suppressed due to low confidence (1)
chuck_data/commands/setup_stitch.py:496
- Add unit tests for _display_post_launch_options and the related functions (_display_detailed_summary and _build_post_launch_guidance_message) to ensure that the output messages are formatted and behave as expected.
def _display_post_launch_options(console, launch_result, metadata, client=None):
| lines.append(f"• you can ask me about the status of the job (id {run_id})") | ||
|
|
||
| # Get workspace URL for constructing browser links | ||
| workspace_url = get_workspace_url() |
There was a problem hiding this comment.
Consider handling the case where get_workspace_url() might return None before passing it to normalize_workspace_url to prevent potential runtime errors.
Suggested change
| workspace_url = get_workspace_url() | |
| workspace_url = get_workspace_url() | |
| if workspace_url is None: | |
| logging.warning("Workspace URL could not be retrieved. Aborting operation.") | |
| return |
| normalize_workspace_url, | ||
| ) | ||
|
|
||
| lines = [] |
There was a problem hiding this comment.
[nitpick] Consider separating the technical summary details from the main post-launch guidance message to improve readability and maintain a clearer separation of user information versus technical details.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.