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

Document app freeze with wrong password prompt integration. #11778

Conversation

heyitsdross
Copy link
Contributor

Closes #11766

Document freezes in preferences panel resulting from improper password prompter integration on dev machine for developers.

Mandatory checks

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@Siedlerchr
Copy link
Member

Thanks!
PS: I can recommend markdown lint for VsCode https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You modified Markdown (*.md) files and did not meet JabRef's rules for consistently formatted Markdown files.
To ensure consistent styling, we have markdown-lint in place.
Markdown lint's rules help to keep our Markdown files consistent within this repository and consistent with the Markdown files outside here.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "Markdown".

@Siedlerchr Siedlerchr added this pull request to the merge queue Sep 16, 2024
@heyitsdross
Copy link
Contributor Author

@Siedlerchr I'm using IntelliJ, in which there seems to be no plugin for markdownlint. There's a ruby gem and a node package, but I'm unsure if I can run either locally against the project and have it work.

@Siedlerchr
Copy link
Member

Yeah here as well but that's why I edit the markdown stuff with VsCode

Merged via the queue into JabRef:main with commit fb9cdef Sep 16, 2024
25 checks passed
@heyitsdross
Copy link
Contributor Author

@Siedlerchr Sensible, sensible. Apparently there's a plugin for neovim or something, I'll get that up and running at some point, but to be honest, it's kind of sad that there's no command line utility written in Rust or C or something which can perform the linting.

@heyitsdross heyitsdross deleted the feature/11766-document-preferences-pane-app-freeze branch September 16, 2024 20:54
@subhramit
Copy link
Collaborator

subhramit commented Sep 16, 2024

@Siedlerchr Sensible, sensible. Apparently there's a plugin for neovim or something, I'll get that up and running at some point, but to be honest, it's kind of sad that there's no command line utility written in Rust or C or something which can perform the linting.

You can also always use the github web vscode editor (and install the markdown-lint extension on the fly). Just press "." in the PR when you want to edit. You can also preview the markdown while editing that way.

@koppor
Copy link
Member

koppor commented Sep 17, 2024

@Siedlerchr I'm using IntelliJ, in which there seems to be no plugin for markdownlint.

What about https://github.com/Strajk/intellij-plugin-markdownlint?

It is said to be slow (Strajk/intellij-plugin-markdownlint#4), but could work?

@koppor
Copy link
Member

koppor commented Sep 17, 2024

but to be honest, it's kind of sad that there's no command line utility written in Rust or C or something which can perform the linting.

Smalltalk: https://github.com/0xpayne/gpt-migrate on https://github.com/DavidAnson/markdownlint 🤣🤣

Note that one can use npx markdownlint. Then, npx installs the latest version of the package and runs it. OK, still some NodeJS is required ^^.


## Attempts to open preferences panel freezes application

This is likely caused by improper integration of your OS or Desktop Environment with your password prompting program or password manager. Ensure that these are working properly, then restart your machine and attempt to run the program.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to detail "Ensure that these are working properly"? Maybe, giving an example?

Copy link
Contributor Author

@heyitsdross heyitsdross Sep 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could detail what some of the desired states would be, ie. If everything works, a password prompt will appear as the program starts, given the keyring your OS uses hasn't already been unlocked.

The trouble is, it depends on OS what the exact implementation being used is, and therefore how to configure it will vary. I don't have Windows or MacOS personally, so I can only speak for Linux users and state that their xdg-desktop-portal settings need to refer to active and valid portal implementations they have installed. And that may not be the whole story; my lack of knowledge means I'd need to do further research to confirm or deny that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, even these sentences help.

What do you think of:

To clarify, in an ideal scenario, a password prompt should appear when the program starts, provided the keyring your OS uses has not already been unlocked. However, the implementation details vary depending on the operating system, which makes troubleshooting more complex.

For Windows and macOS users, specific configurations may differ based on the password management tools and settings used, so ensure your OS's password management system is properly set up and functioning.

For Linux users, ensure that your `xdg-desktop-portal` settings refer to active and valid portal implementations installed on your system. However, there might be other factors involved, so additional research or guidance specific to your distribution may be necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, we can always change the description if we learn more later.

Should I reopen the issue, or just make a PR for the same issue? Or rather document the change in a new issue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just make another PR, e.g. follow up to ###

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Attempts to open preferences pane causes application freeze
4 participants