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

Feature: Automatically log issues on GitHub #16702

Open
Lamparter opened this issue Jan 12, 2025 · 12 comments
Open

Feature: Automatically log issues on GitHub #16702

Lamparter opened this issue Jan 12, 2025 · 12 comments

Comments

@Lamparter
Copy link
Contributor

What feature or improvement do you think would benefit Files?

When you add an ID to a YAML marker in an issue template, e.g.:

  # Files Version
  - type: input
    id: files_version # <-- THIS
    attributes:
      label: Files Version

You can then generate a URI to auto fill that value.
Try it out at https://github.com/files-community/Files/issues/new?template=bug_report.yml&files_version=abc123!

The app should be able to launch a URI when an error occurs, or this generated link could appear in the log file.

Requirements

  • Add id attribute to each field of issue template
  • Write a helper to calculate the URL for a stack trace
  • (automatically|prompt to) open the URL when Files crashes

Files Version

3.8.11.0

Windows Version

10.0.22631.4602

Comments

No response

@Josh65-2201
Copy link
Member

Josh65-2201 commented Jan 12, 2025

If you send it using Files settings > About > Feedback it already does this

@Lamparter
Copy link
Contributor Author

It fills in the version, yes, but not more information like crash details etc.
The point of this is that it takes that to the next level.

@yaira2
Copy link
Member

yaira2 commented Jan 12, 2025

Which details do you have in mind?

@Lamparter
Copy link
Contributor Author

The log file could be uploaded, for example.

Log file

App encodes log file in uri

Log

Or, the app could try to "calculate" what happened, to attempt to fill out the steps to reproduce section

  1. App loaded (1s)
  2. App crashed while loading cloud drives

@yaira2
Copy link
Member

yaira2 commented Jan 13, 2025

The log file could be uploaded, for example.

This would be cool, however there are privacy concerns with automatically uploading files, particularly ones that may contain paths.

Or, the app could try to "calculate" what happened, to attempt to fill out the steps to reproduce section

I'd like to hear more details about this proposal.

@yaira2 yaira2 added the needs - additional info Needs more information from the reporter label Jan 13, 2025
@Lamparter
Copy link
Contributor Author

This would be cool, however there are privacy concerns with automatically uploading files, particularly ones that may contain paths

I'm not sure it would be difficult to redact paths.
Also, it's not different from the current configuration. The issue would still require a small amount of user interaction and they would be encouraged to review the issue body

Or, the app could try to "calculate" what happened, to attempt to fill out the steps to reproduce section

The best way to start on this would be by logging the actions the user takes.

@yaira2
Copy link
Member

yaira2 commented Jan 13, 2025

The paths are often required to debug, but at least the user is in control of the file and can choose not to upload it.

@Lamparter
Copy link
Contributor Author

The log file wouldn't be uploaded directly, instead it would be inside a details block the user could edit.

Log file

(Log file inserted here)

The paths are often required to debug

Surely the app could just do a regex replace of the user profile directory with %userprofile%?

@Josh65-2201
Copy link
Member

Josh65-2201 commented Jan 13, 2025

There's also emails that come from cloud drive names that should be filtered if this is going to be done.

@Lamparter
Copy link
Contributor Author

Lamparter commented Jan 13, 2025

As I said, the file wouldn't be directly uploaded so the user could still edit it.
Also, the user would still need to review the issue before sending, so it wouldn't be different from the current process where the user uploads the log file and can optionally exclude sensitive data.

@yaira2 yaira2 removed the needs - additional info Needs more information from the reporter label Jan 13, 2025
@yaira2
Copy link
Member

yaira2 commented Jan 15, 2025

As I said, the file wouldn't be directly uploaded so the user could still edit it.

This will cause manually opened issues to have the file uploaded in one way, while those opened via Files would be uploaded in a different way.

@Lamparter
Copy link
Contributor Author

What's wrong with that?

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

No branches or pull requests

3 participants