Skip to content

Improve error logs related to invalid source url in model generation #709

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
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

riyaa14
Copy link
Contributor

@riyaa14 riyaa14 commented Apr 3, 2025

Description

This PR fixes #

Before

Test 1: GitHub repo with no releases & Test 2: Private GitHub repository

Screenshot 2025-04-23 at 5 43 47 PM

Test 3: Invalid source URL format, with blob in its URL, thus couldn't read the files

Screenshot 2025-04-23 at 5 43 13 PM

After

Test 1: GitHub repo with no releases & Test 2: Private GitHub repository

Screenshot 2025-04-23 at 6 10 22 PM

Test 3: Invalid source URL format, with blob in its URL, thus couldn't read the files

Screenshot 2025-04-23 at 5 37 43 PM

Notes for Reviewers

Signed commits

  • [*] Yes, I signed my commits.

TO DO

  • Improve error logging for "unable to fetch latest release"
  • enhance error for components not generated: changes to be made in Server in meshery/meshery repo

…odel

Signed-off-by: Riya Garg <riyag1452003@gmail.com>
Copy link
Contributor

Warning

You have reached your daily quota limit. As a reminder, free tier users are limited to 5 requests per day. Please wait up to 24 hours and I will start processing your requests again!

@leecalcote
Copy link
Member

leecalcote commented Apr 3, 2025

@riyaa14, thank you. This is an improvement. 🙂 From the looks of it, it seems that we can be more accurate with the suggested probable cause. At the point in time in our logic where we are unable to retrieve the latest release tag, it should be the case that we've already been able to reach the URL that the user has provided and have moved along in our logic to looking up the release tag. If this is true, suggesting that the #1 most probable cause is an invalid source URL is inaccurate, and not helpful to users resolving this issue, then retrying and being successful.

Here is the URL that I used when I received this error: git://github.com/Azure/azure-service-operator/blob/main/charts/azure-service-operator-1.9.0.tgz. Be a user. Try using this URL to create a model. When you get a failure message. What are you to do with the information provided in the Suggested Remediation?

  • As a user, can I point to a tarred Helm chart? This information isn't provided by the event. The event also does not link users to additional documentation on this topic, but should.

  • As a user, can I include "blob" or branch name ("main" or "master" or other) in the URL? I should be able to do so. We should not be placing this burden on the user. We can parse the URL intelligently with ease.

  • As a user, .... there are many other questions here that need answers. The two above are examples.

@riyaa14, this discussion is still on the topic of our very first assignment: documentation of the various scenarios in which mesheryctl registry and mesheryctl model commands are run, and how their UX should improve. The flow for these scenarios is simply invoked from the UI, but the source code is the same centrally sourced code from MeshKit.

Let's be discerning with our event notifications, ensuring that we are offering information back to the user at each step and specific to each step of the generation process.

@FaheemOnHub, where is the updated contributing docs on custom event notification formats? All events should include a link to a docs page, @riyaa14 @lekaf974 @alphaX86 @hexxdump. // @zihanKuang

The list of scenarios you've fathomed are now documented in the Meshery Test Plan spreadsheet as test cases, I think (awesome!). Please, please put your user hat on and attempt to use the Import Model and Create Model wizards - - with no assumption of prior knowledge. How can we improve? What doesn't make sense?

These need reconciled and improved:

  1. https://docs.meshery.io/guides/configuration-management/generating-models - missing the new import and create wizards found in the UI.
  2. https://docs.meshery.io/guides/configuration-management/importing-models - missing an explanation from the perspective of the UI.
  3. https://docs.meshery.io/project/contributing/contributing-models-quick-start - arguably the best, consolidated user guide, but is categorized under "Contributing Guides"

// @ianrwhitney @amitamrutiya

Signed-off-by: Riya Garg <riyag1452003@gmail.com>
@leecalcote leecalcote added the kind/enhancement Improvement in current feature label Apr 17, 2025
Signed-off-by: Riya Garg <96983874+riyaa14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvement in current feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants