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

[Doc] Add note about Node 12 deprecation warnings #2566

Merged

Conversation

jcalcaben
Copy link
Contributor

Description

Adds a note about a deprecation warning that shows up in the log when using Node12. This is caused by a dependency and is noted where we specify Node requirements.

Related Issue

Closes PWA-698

Acceptance

Any developer

Verification Stakeholders

Any developer

Specification

Verification Steps

  1. Run HTML preview server

  2. Verify note appears on the following pages:

    • /tutorials/pwa-studio-fundamentals/
    • /tutorials/pwa-studio-fundamentals/project-setup/
    • /venia-pwa-concept/features/modular-components/
    • /venia-pwa-concept/setup/

Screenshots / Screen Captures (if appropriate)

Checklist

  • I have added tests to cover my changes, if necessary.
  • I have updated the documentation accordingly, if necessary.

@jcalcaben jcalcaben added pkg:pwa-devdocs documentation This pertains to documentation. docs documentation labels Jul 20, 2020
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jul 20, 2020

Fails
🚫 A version label is required. A maintainer must add one.
Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 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).
📖

Associated JIRA tickets: PWA-698.

Generated by 🚫 dangerJS against fc080a8

@devops-pwa-codebuild
Copy link
Collaborator

devops-pwa-codebuild commented Jul 20, 2020

Performance Test Results

The following fails have been reported by WebpageTest. These numbers indicates a possible performance issue with the PR which requires further manual testing to validate.

https://pr-2566.pwa-venia.com : LH Performance Expected 0.85 Actual 0.52, LH Best Practices Expected 1 Actual 0.92, WPT Cache Expected 90 Actual 83.333333333333
https://pr-2566.pwa-venia.com/venia-tops.html : LH Performance Expected 0.75 Actual 0.34, LH Best Practices Expected 1 Actual 0.92
https://pr-2566.pwa-venia.com/valeria-two-layer-tank.html : LH Performance Expected 0.8 Actual 0.41, LH Accessibility Expected 0.9 Actual 0.89, LH Best Practices Expected 1 Actual 0.92, WPT Cache Expected 65 Actual 52.333333333333

tjwiebell
tjwiebell previously approved these changes Jul 20, 2020
Copy link
Contributor

@tjwiebell tjwiebell left a comment

Choose a reason for hiding this comment

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

Changes look good, but I don't see any deprecation warnings on develop; any chance we solved this, or I'm missing a step to repro?

Copy link
Contributor

@sirugh sirugh left a comment

Choose a reason for hiding this comment

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

I think we should clarify that the warning will say the following:

(node:89176) [DEP0066] DeprecationWarning: OutgoingMessage.prototype._headers is deprecated

@@ -17,6 +17,10 @@ During the course of the tutorials, you will create a new storefront application
- Node >= 10.14.1
- Yarn (recommended) or NPM

{: .bs-callout .bs-callout-info}
If you are using Node 12, you may see a deprecation warning in your logs.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would be specific about this log, rather than just say "there might be a deprecation warning". That way other deprecation notices, should they arise, are noticed and not ignored.

I should have documented this originally but this is the "expected" warning:

Image from Gyazo

@dpatil-magento
Copy link
Contributor

Verification steps pass, QA Approved.

@dpatil-magento dpatil-magento merged commit 4c649b6 into develop Jul 21, 2020
@dpatil-magento dpatil-magento deleted the jimothy/pwa-698_add-node12-deprecation-warning branch July 21, 2020 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation documentation This pertains to documentation. pkg:pwa-devdocs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants