Skip to content
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

Broken links to remote repositories #1689

Closed
gok99 opened this issue Feb 24, 2022 · 12 comments · Fixed by #1830
Closed

Broken links to remote repositories #1689

gok99 opened this issue Feb 24, 2022 · 12 comments · Fixed by #1830

Comments

@gok99
Copy link
Contributor

gok99 commented Feb 24, 2022

This issue consolidates issues with links in the report to remote repositories. These links should be fixed for when (a) no remote repositories exist or (b) remote repository is not yet supported by RepoSense (is not Github, GitLab or Bitbucket). The following report links redirect to broken links if either of the above conditions are satisfied.

  1. Commit ramp link (also mentioned in Clicking on ramps in ramp chart generated using local repos redirects to non-existent link #231):
    image
  2. Link to author profile
    image
  3. Link to group repo tree
    image
  4. Link to blame view
    image
  5. Link to history view
    image

To discuss:

What should be the expected behaviour in the above scenarios if either (a) or (b) is satisfied? Some options:

  • Hide the links entirely
  • Popover that explains that link is not available
@gok99
Copy link
Contributor Author

gok99 commented Feb 24, 2022

Report links with remote repositories that are supported and not GitHub (either GitLab or Bitbucket) are expected to be fixed in #1644.

@chan-j-d
Copy link
Contributor

Current links behaviour on master branch as of 1 April 2022

#1644 has standardized the behaviour of links to be

  • Repository cloned from GitHub/GitLab/BitBucket - All links work
  • All other types of repos (local or unsupported remote) - Links are disabled but buttons look identical

#1679 should allow partial support of local repos cloned from remote repos to support links that are already present on the remote repo.

@chan-j-d
Copy link
Contributor

Besides the two suggestions you have, I might add an 'intermediate' suggestion where

  • The buttons are present but the hover message states that the link does not work

@zhoukerrr
Copy link
Contributor

@chan-j-d Actually I prefer the button to be hidden entirely or disabled because sometimes we click the button before seeing the hover message.

@gok99
Copy link
Contributor Author

gok99 commented Apr 14, 2022

Actually I prefer the button to be hidden entirely or disabled

I think I agree. There is no ambiguity that a link is not supported if there isn't a link (icon) in the first place

@Jay-luozhijie
Copy link
Contributor

Hi is this issue still open? It is OK to work on this issue?

@gok99
Copy link
Contributor Author

gok99 commented Aug 16, 2022

Sure, I've assigned you the issue!

@Jay-luozhijie
Copy link
Contributor

OK thanks! Shall I hide the button when the link doesn't work?

@gok99
Copy link
Contributor Author

gok99 commented Aug 16, 2022

Yes, that appears to be the conclusion from above.

@Zhou-Jiahao-1998, do update this thread if you have better ideas for handling missing/unsupported remotes.

@zhoukerrr
Copy link
Contributor

@gok99 Actually now that I think about it again, I prefer disabling the button and add a hover message. That way the user won't be able to click and is likely gonna see an explanation in the hover message. Hiding without stating anything might cause confusion?

@gok99
Copy link
Contributor Author

gok99 commented Aug 16, 2022

@Zhou-Jiahao-1998 That makes sense!

@LuoZhijie-tom You could do this instead. Perhaps something like This remote link is unsupported

@Jay-luozhijie
Copy link
Contributor

OK sure!

dcshzj pushed a commit that referenced this issue Oct 16, 2022
There are some links in the report to the report repos such as view
group repo. However, when the link is missing or not supported by
RepoSense (i.e. is not Github, GitLab or Bitbucket), it points to
a non-existent link.

Let's disable the link when it is broken and change the message when the
users hover over the link to "This remote link is unsupported", so that
the users will know that the link is broken.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Closed/Completed
Development

Successfully merging a pull request may close this issue.

4 participants