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

Desktop: Show installed plugins in Help - About Joplin #6143

Closed
roman-r-m opened this issue Feb 12, 2022 · 32 comments · Fixed by #7711
Closed

Desktop: Show installed plugins in Help - About Joplin #6143

roman-r-m opened this issue Feb 12, 2022 · 32 comments · Fixed by #7711
Labels
desktop All desktop platforms enhancement Feature requests and code enhancements

Comments

@roman-r-m
Copy link
Collaborator

roman-r-m commented Feb 12, 2022

  • The list of plugin should appear within the About box.
  • When clicking on "Copy", that list should be included too.
  • If there are more than 20 plugins, just add "..." in the About box, but still make sure that all the plugins are copied when pressing "Copy". Also please check that the dialog is not broken when there are 20 plugins.

image

@roman-r-m roman-r-m added enhancement Feature requests and code enhancements good first issue desktop All desktop platforms labels Feb 12, 2022
@roman-r-m roman-r-m changed the title Desktop: Show installed plugins in "Help - About Joplin" Desktop: Show installed plugins in Help - About Joplin Feb 12, 2022
@Aman-Mandal
Copy link

Hey..can I take this issue?

@roman-r-m
Copy link
Collaborator Author

go for it

@Aman-Mandal
Copy link

Actually am very new in this.. can you tell me what exactly I need to do ? I would be glad if you can help
Thankyouuuu

@roman-r-m
Copy link
Collaborator Author

On high level:

  • Check out the code
  • Make sure you can build the app
  • Start it, find the dialog
  • Find in the code where it's created; see how it's populated
  • Find the class that keeps track of installed plugins
  • Access this class from the place where the dialog is populated, get the list of plugins, and display them

@tessus
Copy link
Collaborator

tessus commented Feb 12, 2022

Was this discussed on the forum? If so, please add the link in the description.
Some people use many plugins (20+). I think it would mess up the About dialog. But maybe not.

I'd rather go for something similar to Synchronisation Status.

@roman-r-m
Copy link
Collaborator Author

roman-r-m commented Feb 12, 2022

I sent a message to Laurent and we was fine with it.

But I see your point - I assumed this dialog is just like every other view and the list could be made scrollable. But now having looked at how it's done I am no longer sure.

The idea was that often when someone reports an issue the 1st question is "what plugins do you have". If we could add this info to the version it should save some time.

@tessus
Copy link
Collaborator

tessus commented Feb 12, 2022

I totally understand the reasoning behind it. I think it makes sense to put it in the About dialog or at least add the installed plugins, when you click the Copy button. I am just afraid it messes up the About dialog when a lot of plugins are used.

We can always add a Copy button to a window like Synchronisation Status. So, in case it messes up the About dialog, creating a separate menu item Installed plugins with a Copy button would do the trick.

@roman-r-m
Copy link
Collaborator Author

add the installed plugins, when you click the Copy button

This is what Android Studio does. I agree this makes more sense.

I suggest when someone implements this we have a look and if it does indeed messes up the dialog we can ask to implement only the copy - the difference between the 2 approaches looks to be trivial.

@Daeraxa
Copy link
Collaborator

Daeraxa commented Feb 12, 2022

Could the list of plugins just be within a scrollable frame within the main about dialogue box? (I'm sure there is a technical term for what I mean). This actually is how software I use at work displays installed drivers which can easily exceed 100 on some systems.

@roman-r-m
Copy link
Collaborator Author

From a quick look I think that dialog only supports plain text

@ahsenkamal
Copy link

I'd love to help ... is it assigned or I could still work on it?

@roman-r-m
Copy link
Collaborator Author

I'd love to help ... is it assigned or I could still work on it?

If you read the comments above, you'll see that Aman-Mandal was going to work on it.

@ahsenkamal
Copy link

If you read the comments above, you'll see that Aman-Mandal was going to work on it.

I'm new to all this, does it mean that I can not do anything related to this issue now?

@roman-r-m
Copy link
Collaborator Author

I'm new to all this, does it mean that I can not do anything related to this issue now?

Well you can, it just may not be the most useful thing as someone else has already starting working on this and may be first to submit a PR.

@ahsenkamal
Copy link

Well you can, it just may not be the most useful thing as someone else has already starting working on this and may be first to submit a PR.

Okay thanks

@Aman-Mandal
Copy link

If you read the comments above, you'll see that Aman-Mandal was going to work on it.

I'm new to all this, does it mean that I can not do anything related to this issue now?

Hey you can go ahead.. am sorry , am unable to solve this issue

@rookieCoder9
Copy link

Is this issue still available? If yes, I would like to fix it! I have read the above comments. What is the expected outcome - scrollable frame or ... followed by a few plugins?

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 10, 2022

Have you read the closed PR that is linked just above your comment? There are comments in there and things you need to be aware of.
Otherwise yes, the issue/enhancement is still active as it has not been closed.
This other PR too - #6201

@rookieCoder9
Copy link

Yeah, I have already read that and the problems with that commit. I always comment after reading the above discussion! But it is always good to first ask the moderator before working on the issue. Let me go through it.
But still, the expected outcome isn't clear ? Will there be a scrollable area to display all plugins?

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 10, 2022

The goal is in the issue text:

If there are more than 20 plugins, just add "..." in the About box, but still make sure that all the plugins are copied when pressing "Copy". Also please check that the dialog is not broken when there are 20 plugins.

There are other comments pointing out that the popup being used doesn't support anything beyond plain text so I don't think scrolling is even an option.

@rookieCoder9
Copy link

rookieCoder9 commented Mar 12, 2022

Hey, I have fixed my issue locally but don't know how to write unit tests. Can someone help me how to write unit tests?

Below I am attaching ss.
The first two are with around 17 plugins installed. The next ones are with 34 plugins installed. Last is with 20 Plugins installed. Please give feedback.

Screenshot from 2022-03-12 16-24-49
Screenshot from 2022-03-12 16-26-33
Screenshot from 2022-03-12 16-28-21
Screenshot from 2022-03-12 16-28-33
Screenshot from 2022-03-12 16-37-24

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 12, 2022

There is newly (as in the last few days) updated documentation on test units so make sure you read that: https://github.com/laurent22/joplin/blob/dev/CONTRIBUTING.md#automated-tests

@rookieCoder9
Copy link

Thanks, I will go through it and will soon raise PR :)

@rookieCoder9
Copy link

Hey, I am still not getting how to add tests for this bug fix . Please help!

I have read the documentation of Jest but couldn't find a suitable test for this bug fix.

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 14, 2022

To start with this is an enhancement, not a bug fix so therefore tests are even more critical that they are included.

If you want to ask specific questions about how to do something like that then I would advise asking in the forum development category but you won't get anywhere just asking "how to I do it" because that is a vital part of the challenge of adding a feature or creating a fix that you need to overcome. You at the very least need to demonstrate specifically what you are stuck on and what you have already done.

Otherwise you should look at other merged PRs and see how they have implemented tests so you can understand what you need to do.

@rookieCoder9
Copy link

Ok, thanks I will ask my doubts in the forum. Further, I will look at the previous merged PRs tests.

@mirchandani-mohnish
Copy link

mirchandani-mohnish commented Mar 21, 2022

@rookieCoder9 , are you done with the tests or are nearing the end given that you have not made a pull request. Can I help in any way?

@rajdama
Copy link

rajdama commented Mar 28, 2022

Screenshot 2022-03-28 122915

I am not able to see the installed plugins in the dialog box.

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 28, 2022

I am not able to see the installed plugins in the dialog box.

There is no merged PR for this and you are running prod so this is entirely expected.

@rajdama
Copy link

rajdama commented Mar 28, 2022

I am not able to see the installed plugins in the dialog box.

There is no merged PR for this and you are running prod so this is entirely expected.

I am not able to see the installed plugins in the dialog box.

There is no merged PR for this and you are running prod so this is entirely expected.

What you mean by prod I didn't understood

@Daeraxa
Copy link
Collaborator

Daeraxa commented Mar 28, 2022

Literally in your screenshot (prod, win32) i.e. a "full" release version of Joplin.
You aren't running a dev version with somebody else's commit to add the plugins it and it obviously wouldn't contain your own code to fix it so I'm not sure what you are expecting to see. This entire issue exists to add the plugins list to the box.

@rajdama
Copy link

rajdama commented Mar 28, 2022

Literally in your screenshot (prod, win32) i.e. a "full" release version of Joplin. You aren't running a dev version with somebody else's commit to add the plugins it and it obviously wouldn't contain your own code to fix it so I'm not sure what you are expecting to see. This entire issue exists to add the plugins list to the box.

Ok I got it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
desktop All desktop platforms enhancement Feature requests and code enhancements
Projects
None yet
9 participants