[feature]: Debugging Reporter #2910

sirugh · 2020-12-17T17:26:29Z

Description

This feature/hackathon project should make it easier for folks to provide debugging info about their Magento/PWA Studio system.

I was not able to access extension or target usage info. I wasn't sure what the optimal way to do this was. Perhaps there is some tooling we have already written that exposes it.

Related Issue

Closes PWA-1091.

Acceptance

Verification Stakeholders

Specification

Verification Steps

Scaffold a new app using this branch
DEBUG_PROJECT_CREATION=1 ../pwa-studio/packages/create-pwa/bin/create-pwa
In the scaffold, yarn install and yarn build:report
See output!

Screenshots / Screen Captures (if appropriate)

Checklist

I have added tests to cover my changes, if necessary.
I have added translations for new strings, if necessary.
I have updated the documentation accordingly, if necessary.

Signed-off-by: sirugh <rugh@adobe.com>

packages/venia-ui/upward.yml

Signed-off-by: sirugh <rugh@adobe.com>

PWAStudioBot · 2020-12-17T17:36:34Z

	Messages
📖	Associated JIRA tickets: PWA-1091.
📖	DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).
📖	Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

Generated by 🚫 dangerJS against d527baa

Signed-off-by: sirugh <rugh@adobe.com>

revanth0212 · 2020-12-17T17:51:36Z

Love it ❤️

Can you also add a feature where the whole output is copied to the clipboard so people can simply paste it into the issue?

.github/ISSUE_TEMPLATE/bug_report.md

sirugh · 2020-12-17T17:57:36Z

Can you also add a feature where the whole output is copied to the clipboard so people can simply paste it into the issue?

Copy commands differ across operating systems. I figured for now it's easy enough to just ask folks to copy the output of the command into the issue when creating one.

revanth0212 · 2020-12-17T17:58:53Z

Can you also add a feature where the whole output is copied to the clipboard so people can simply paste it into the issue?

Copy commands differ across operating systems. I figured for now it's easy enough to just ask folks to copy the output of the command into the issue when creating one.

Ahhh got it. Makes sense.

Signed-off-by: sirugh <rugh@adobe.com>

revanth0212 · 2020-12-17T18:03:13Z

.github/ISSUE_TEMPLATE/bug_report.md

 If applicable, add screenshots to help explain your problem.

 **Additional context**
-Add any other context about the problem here.
+
+Paste the output of `yarn build:report`, and any other context about the problem, here.


revanth0212 · 2020-12-21T21:12:06Z

packages/pwa-buildpack/lib/cli/generate-build-report.js

+}
+
+function inspectBuildEnv() {
+    const osVersion = os.version();


We need to be careful of this. os.version is added in node 13.

Failed in my local machine since I was running node 10. Do we recommend a minimum version of node for using PWA Studio?

Started working after I moved to the latest stable (14.15.3).

Oops, you're right! Our monorepo package.json requires at least 10, but if this doesn't work in 10 we need a fall back (upgrading to minimum 12 is definitely out of scope).

revanth0212 · 2020-12-21T21:42:08Z

packages/pwa-buildpack/lib/cli/generate-build-report.js

+
+function inspectBuildEnv() {
+    const osVersion = os.version();
+    const nodeVersion = process.version();


Are you sure of this API? I checked the node docs and realized process.version is a string, not a function.

Another good catch. I wonder how I got this to work. Maybe I had it written when I ran it for the screenshot and forgot to push? 🤷 Thanks for fixing :)

revanth0212 · 2021-01-12T19:34:05Z

Not sure why the test job failed on AWS. Works fine in my local. Gonna investigate the logs for more info.

revanth0212 · 2021-01-12T19:38:00Z

Not sure why the test job failed on AWS. Works fine in my local. Gonna investigate the logs for more info.

Found it

Our CICD must be on a version of Node that does not support os.version API. We have documented this in the code but not implemented for it in tests. My bad. Ill update the tests to handle this.

sirugh

Approved again - we skip the os.version check if we aren't on >= node 13.

dpatil-magento · 2021-01-29T15:43:41Z

@sirugh @revanth0212 Have some queries with respect this report tool code dependency with rest of pwa-studio.

Any reason it can't be an extension? Was expecting this to work both on cloned/forked repo and scaffolded project on need basis and not by default, something like yarn venia add -D @magento/venia-sample-language-packs@0.0.1 and then yarn build:report
Hope it does not interfere in default yarn install and yarn build.

sirugh · 2021-01-29T16:06:17Z

Any reason it can't be an extension?

Haha no, but it is easier to make it a utility of buildpack than a random extension. Also the initial ticket/request suggested it be a buildpack utility, which is why I went that direction.

Stop trying to throw in scope @dpatil-magento!

Hope it does not interfere in default yarn install and yarn build.

Try it :P

updated by requestor :P

dpatil-magento · 2021-01-29T17:50:21Z

QA Approved.

sirugh added 3 commits December 16, 2020 12:14

Add script command. Remove sample backend script

ba9e55a

Signed-off-by: sirugh <rugh@adobe.com>

Initial

c0a6e56

Signed-off-by: sirugh <rugh@adobe.com>

More

abd3484

Signed-off-by: sirugh <rugh@adobe.com>

m2-community-project bot added the Progress: ready for review label Dec 17, 2020

sirugh commented Dec 17, 2020

View reviewed changes

packages/venia-ui/upward.yml Outdated Show resolved Hide resolved

cleanup

eb1a6cf

Signed-off-by: sirugh <rugh@adobe.com>

PWAStudioBot added pkg:pwa-buildpack pkg:venia-concept pkg:venia-ui labels Dec 17, 2020

sirugh added 2 commits December 17, 2020 11:42

remove unused const

3663c4b

Signed-off-by: sirugh <rugh@adobe.com>

Update bug report template

ed501b7

Signed-off-by: sirugh <rugh@adobe.com>

revanth0212 reviewed Dec 17, 2020

View reviewed changes

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved

m2-community-project bot assigned revanth0212 Dec 17, 2020

m2-community-project bot added Progress: review and removed Progress: ready for review labels Dec 17, 2020

sirugh added 2 commits December 17, 2020 12:00

Update bug report template

0a4bfa4

Remove magento version check since not all backends will expose it

4072227

Signed-off-by: sirugh <rugh@adobe.com>

revanth0212 reviewed Dec 17, 2020

View reviewed changes

revanth0212 reviewed Dec 21, 2020

View reviewed changes

revanth0212 previously requested changes Dec 21, 2020

View reviewed changes

m2-community-project bot added Progress: changes requested and removed Progress: review labels Dec 21, 2020

process.version() -> process.version

750d7b4

m2-community-project bot added Progress: approved and removed Progress: review labels Jan 12, 2021

jimbo previously approved these changes Jan 12, 2021

View reviewed changes

m2-community-project bot assigned jimbo Jan 12, 2021

Run tests if env is valid.

a061195

revanth0212 dismissed stale reviews from jimbo and tjwiebell via a061195 January 12, 2021 20:19

sirugh commented Jan 12, 2021

View reviewed changes

m2-community-project bot added Progress: review and removed Progress: approved labels Jan 12, 2021

jimbo approved these changes Jan 12, 2021

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: review labels Jan 12, 2021

Merge branch 'develop' into rugh/hackathon-2020-build-report

d527baa

dpatil-magento merged commit 28026fb into develop Jan 29, 2021

dpatil-magento deleted the rugh/hackathon-2020-build-report branch January 29, 2021 17:51

m2-community-project bot added Progress: done and removed Progress: approved labels Jan 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature]: Debugging Reporter #2910

[feature]: Debugging Reporter #2910

sirugh commented Dec 17, 2020 •

edited

Loading

PWAStudioBot commented Dec 17, 2020 •

edited

Loading

revanth0212 commented Dec 17, 2020

sirugh commented Dec 17, 2020

revanth0212 commented Dec 17, 2020

revanth0212 Dec 17, 2020

revanth0212 Dec 21, 2020 •

edited

Loading

sirugh Dec 22, 2020

revanth0212 Dec 21, 2020

sirugh Dec 22, 2020

revanth0212 commented Jan 12, 2021

revanth0212 commented Jan 12, 2021

sirugh left a comment

dpatil-magento commented Jan 29, 2021

sirugh commented Jan 29, 2021 •

edited

Loading

dpatil-magento commented Jan 29, 2021

[feature]: Debugging Reporter #2910

[feature]: Debugging Reporter #2910

Conversation

sirugh commented Dec 17, 2020 • edited Loading

Description

Related Issue

Acceptance

Verification Stakeholders

Specification

Verification Steps

Screenshots / Screen Captures (if appropriate)

Checklist

PWAStudioBot commented Dec 17, 2020 • edited Loading

revanth0212 commented Dec 17, 2020

sirugh commented Dec 17, 2020

revanth0212 commented Dec 17, 2020

revanth0212 Dec 17, 2020

Choose a reason for hiding this comment

revanth0212 Dec 21, 2020 • edited Loading

Choose a reason for hiding this comment

sirugh Dec 22, 2020

Choose a reason for hiding this comment

revanth0212 Dec 21, 2020

Choose a reason for hiding this comment

sirugh Dec 22, 2020

Choose a reason for hiding this comment

revanth0212 commented Jan 12, 2021

revanth0212 commented Jan 12, 2021

sirugh left a comment

Choose a reason for hiding this comment

dpatil-magento commented Jan 29, 2021

sirugh commented Jan 29, 2021 • edited Loading

dpatil-magento commented Jan 29, 2021

sirugh commented Dec 17, 2020 •

edited

Loading

PWAStudioBot commented Dec 17, 2020 •

edited

Loading

revanth0212 Dec 21, 2020 •

edited

Loading

sirugh commented Jan 29, 2021 •

edited

Loading