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] Usage of envinfo to supply information in bug reports #2027

Closed
thernstig opened this issue Apr 29, 2020 · 3 comments · Fixed by #2237
Closed

[Feature] Usage of envinfo to supply information in bug reports #2027

thernstig opened this issue Apr 29, 2020 · 3 comments · Fixed by #2237

Comments

@thernstig
Copy link
Contributor

thernstig commented Apr 29, 2020

Currently the bug report template requires these fields:

**Context:**
- Playwright Version: [what Playwright version do you use?]
- Operating System: [e.g. Windows, Linux or Mac]
- Node version: [e.g. 10.12, 10.14]
- Browser: [e.g. All, Chromium, Firefox, WebKit]
- Extra: [any specific details about your environment]

If you start using https://github.com/tabrindle/envinfo you can get more detailed information, especially if you push a preset to the to the repo to this file https://github.com/tabrindle/envinfo/blob/master/src/presets.js. It can then be executed like:

npx envinfo --preset playwright

And you can just ask users to execute that in their environment and copy&paste the results. It would also make Playwright more official being seen as a preset there 😃 Just an idea - perfectly fine to close if you do not want this.

@mxschmitt
Copy link
Member

mxschmitt commented May 3, 2020

What would be useful in your mind?

A output like would result:

 System:
    OS: macOS Mojave 10.14.5
    CPU: (8) x64 Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz
    Memory: 2.97 GB / 16.00 GB
    Shell: 5.3 - /bin/zsh
  Binaries:
    Node: 8.16.0 - ~/.nvm/versions/node/v8.16.0/bin/node
    Yarn: 1.15.2 - ~/.yarn/bin/yarn
    npm: 6.9.0 - ~/.nvm/versions/node/v8.16.0/bin/npm
  Languages:
    Bash: 4.4.23 - /usr/local/bin/bash
  npmPackages:
    playwright-core: ^0.16.0 => 0.16.0
    jest: ^22.2.1 => 22.2.1

If we use this configuration.

{
    System: ['OS', 'CPU', 'Memory', 'Container', 'Shell'],
    Binaries: ['Node', 'Yarn', 'npm'],
    Languages: [
      'Bash',
    ],
    npmPackages: ['playwright-core'],
  }

Some questions:

  • Is Bash version useful? Since we use it to start webkit
  • Should additional NPM global packages be provided?
  • Is playwright-core correct or should I also add cr/wk/ff there?

@yury-s
Copy link
Member

yury-s commented May 6, 2020

I'd start with bare minimum of what we are currently asking (so bash is probably excessive, same about other global packages). It'd be useful to collect info about browser-specific playwright packages too.

@aslushnikov
Copy link
Contributor

Thanks @mxschmitt for handling this!

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 a pull request may close this issue.

5 participants