v2.0.0

🎉 PWA Studio 2.0.0 is live on NPM. Welcome!

What's new

This is a brief development summary for this release.

For a list of relevant Pull Requests related to the 2.0 release, see this GitHub query result.

Server platform and language independence

• UPWARD spec introduced for cross platform server behavior configuration.
  An UPWARD file describes a stack-agnostic server that is used for server side rendering, asset delivery, and proxying.
• A PWA package can now define its network requirements in an UPWARD file.
• A PWA can now be deployed on any tech stack as long as the server is UPWARD compliant.
• UPWARD servers implemented in NodeJS and PHP
• UPWARD spec published and open for community contribution.

Related documentation updates

• UPWARD spec overview(#382)
• UPWARD-js server(#382)

Improved developer experience

• Implemented consistent patterns for workflow, such as action/reducer organization and container/presentational separation, in the Venia reference storefront source code.
• Venia components are now portable and can be used in any React application.
• New centralized driver and adapter concepts for all PWA-Studio component input/output.
• Configurable low level UI elements, such as lists and forms, available for developers without the need for drivers or adapters.
• Improved error handling to help detection and recoverability.

Related documentation updates

• Modular Venia components (#796)
• Venia directory structure(#487 #752)

Venia app-like experience

• Pagination feature added to Venia reference storefront for app-like navigation.
• Inline checkout implemented in the Venia reference storefront.
• Basic account creation and management implemented in Venia.
• Loading state implemented to improved the app-like experience.

Related documentation updates

• Venia Checkout implementation (#673)

Improved shopper experience

• Braintree checkout integration in the Venia reference storefront.
• Search with intelligent previews implemented in the Venia reference storefront.

Related documentation updates

• Braintree integration(#793)

PWA compliance

• Web App Manifest file created for the Venia reference storefront.
  This file provides the metadata for adding the Venia storefront to a mobile home screen.
• Service worker optimizations.

Performance enhancements

• Smart caching implemented to improve service worker catalog caching
• Bandwidth usage optimizations achieved using:
  • Dynamic image compression/resize
  • Advanced minification
  • Bundle splitting
• Improved app performance on devices, including smoother renders and faster Time To First Meaningful Paint.

GraphQL usage

• GraphQL usage increased to match coverage updates in Magento 2.3.0.

Magento Cloud compatibility

• A new Magento module (Magento_UpwardConnector) is available to route frontend requests through an UPWARD-PHP server.
• Solution Implementers(SI) can replace existing Magento cloud storefronts with a new PWA storefront using the UPWARD connector module.
• Documentation created for deploying storefront to Magento Cloud
• Assistance offered by Magento Enterprise Cloud deployment team

Related documentation updates

• README for the Magento_UpwardConnector module, which contains Cloud deployment instructions.

Other documentation updates

New topics

• Theme vs Storefront (#509)
• Install Venia sample data (#474)
• Peregrine Routing (#453)

Updated topics

• Certificate and Valet+ troubleshooting (#637)
• Tools and Libraries (#621)

Known issues

• After submitting a successful order, the application throws up an error notification, and the user has to actively click out of the error notification. (#916)
• Create account page displayed with null values for email, first and last name when creating an account during a guest checkout. (#830)
• (Mobile specific) When there are more categories, users cannot scroll to Sign in button. It blocks user from signing to the account. (#824)

Other notable updates

• Switched from NPM to Yarn for package management
• Setup Venia storefront video developed and available in Magento U

v2.0.0 Release Candidate 2: UPWARD

UPWARD has landed!

PWA Studio is now powered by the UPWARD specification in its middle tier implementation. It no longer relies on Magento's web server to generate application shells. This is a big change! Read more about it in the specification documents.

Changelog

James Zetlen 2018-10-04 Add UPWARD specification, guide, tests, reference implementation (#248)

• doc(upward): UPWARD spec and paper

• feat(upward): test suite and reference impl

• feat(dev): finalize UpwardPlugin for dev mode

• refactor: encapsulate domain gen

• feat(stage): add HTTPS to staging server

James Zetlen 2018-10-04 Update queries for latest 2.3 schema and add validator script (#318)

• fix: update query for small_image schema change

• feat(venia): Script to lint queries against schema

v2.0.0 Release Candidate 1

This is a prerelease in preparation for a larger architectural change in RC2. Here is a rough changelog:

Jonathan Stein 2018-10-03 Account creation (issue #250) (#293) * create generic input component

• create login component, action and reducer catch

• Hook login form to utilize and store token

• Add navigation animation and user icon

• add auth to REST requests

• Add user icon

• add auth header login_token to graphql queries

• Change animation, add user to store

• Move user logic into separate action/reducer

• Add token to auth headers when token is available (rest)

• Style sign in form, fix user reducer

• Rename log in -> sign in. Wire up sign in form.

• Style error messages in sign in form

• write test for signIn and input, small style and prop fixes

• Add redux actions to create account and transfer guest cart to user's account

• add form, navheader and create account components, update styles

• Transferring cart to a newly created customer account created an
  issue where a guest cart could not be made. getCartDetails now checks if
  a user is signed in.

• add debounce email check

• add error display and checkbox components, wire up account creation with redux

• add automatic login

• Close createaccount if user is signed in

• let checkbox highlight on focus, add firstname and lastname required fields

• Tests for createAccount form

• use browser persistence instead of interacting directly with local storage

• add autocomplete to input

• set default username and replace Form component with Informed's Form

• start switch to Text component from Informed

• switch to dot lookup in navigation states

• Set initial value of CreateAccount (inform)

• modify user actions/reducers to be in release 2.0 format

• write tests for async User actions

Jimmy Sanford 2018-10-01 Update hardcoded client path in root template (#315) Now that client assets are output to web/js, the currently
hardcoded path in root.phtml needs to be updated.

James Zetlen 2018-10-01 fix: reducer removes guestCartId when it fails (#314)

James Zetlen 2018-09-28 fix(dev): merge 'assets' and 'output' paths (#220) - Remove the concept of the "assets" directory entirely, and set the
"output" directory to be just "web/".

• Remove the old logo asset from /web/ (pre-Venia rebrand!)
• Gitignore entire "web" directory
• Set JS files to output to 'web/js' subdirectory by adding directory
  prefix to output.filename and output.chunkFilename
• Modify tests, documentation, and type expectations to remove
  paths.assets

• Check if captureStackTrace exists before calling

• Add test to ensure captureStackTrace isn't called when it does not exist

Unit tests should use MemoryRouter, not BrowserRouter, and do
shallow rendering rather than full mounting.

• feat(dev): Make PWADevServer host/SSL optional (#175)

PWADevServer attempts to create a unique domain name, create local
SSL certificates, and tell the OS to trust those certificates, for
every new project. It also tries to confirm they exist on every run!

This causes many problems for users under some common conditions:

• No administrative access to local machine
• No OpenSSL installed, or wrong OpenSSL installed
• OS cannot be scripted to trust certificates
• Developer uses Firefox, which uses its own cert store

Additionally, some bugs in the implementation have caused some
developers' projects to enter an unusable state.

• Adds provideUniqueHost flag to PWADevServer configuration.
  PWADevServer will no longer try to create or retrieve a custom domain
  name unless provideUniqueHost is in its configuration in
  webpack.config.js as either a custom string or true.
• Adds provideSSLCert flag to PWADevServer configuration. PWADevServer
  will no longer try to create or retrieve a trusted SSL certificate
  unless provideSSLCert: true is in its configuration in
  webpack.config.js.
• Modifies custom domain name creation strategy to ensure uniqueness
  based on a hash of the full local path, rather than using the local
  flat file database.

We created these features for the needs of the developer working on
several PWAs at once on their local machine, so that they don't have to
set up manual SSL every time, and they have no conflicts with Service
Workers. This could be considered "bonus functionality", as it's not
critical to the setup of a minimum viable PWA. It was meant to establish
our focus on developer experience, and articulate the parts of developer
setup that PWA Studio can "own".

However, we soon learned that we could not maintain all scenarios for
automated setup and continue to make progress with shopper-facing
features. We still really want to support and automate all of these
scenarios, but for now, our implementations are a hindrance and we are
turning them off by default.

Paul 2018-09-26 Default pragma (#229) chore: Switch back to default pragma

• Switched import { Component, createElement } from 'react';) to import React from 'react', { Component };
• Switched import { Fragment, createElement } from 'react';) to import React from 'react', { Fragment };
• Switched import { createElement } from 'react';) to import React from 'react';
• Added eslint-plugin-react and updated eslint configuration
  accordingly

Jimmy Sanford 2018-09-25 Merge develop branch (#298) * Reorganize redux, add address form

• refactor(redux): Reorganize actions and reducers (#212)
• feature(checkout): Add address form to checkout flow (#226)
• test(redux): Add tests for redux actions (#239)

v1.1.0 -- Legacy "Theme" Release

This is intended to be the final "minor" release on the existing PWA Studio architecture. Those who are working on projects currently based on master can continue to open pull requests against master if they are hotfix-sized changes, meaning that they fix bugs or performance issues, and do not change any public APIs or expected behaviors.

Significant Changes

There is no established prior release to which to compare, so this changelog reflects a diff of the last month of merged changes.

• chore(cicd): Removed Greenkeeper to increase test coverage before automating package updates
• chore(community): Added Community Contributors
• chore(cicd): Switched Lerna to "fixed" mode so all packages share a version
• feat(dev): Added root-level NPM scripts to ease common development modes
• chore(dependencies): Refactored developer dependencies to root as much as possible
• fix(compat): Changed Babel settings to address later browsers
• cleanup(peregrine): Removed unused Peregrine Simulators
• fix(peregrine): Handled absence of Error.captureStackTrace
• refactor(buildpack): Refactored PWADevServer to make SSL and hostnames optional and generate hostnames differently
• fix(buildpack): Fixed duplicated dependencies bug in MagentoRootComponentsPlugin
• fix(buildpack): Added better error reporting for SSL cert generation problems
• docs(peregrine): Added documentation for Peregrine utilities and components
• docs(buildpack): Added documentation for Buildpack utilities, specifically PWADevServer
• docs: Added Basic Concepts documentation for CSS Modules
• docs(venia): Updated Venia setup docs
• feat(venia): Added browser-routed Link elements to navigate between pages
• chore(venia): Adjusted Webpack config for clearer reporting

Acknowledgments

Thanks to all our community contributors, core engineers, documenters, and managers for helping us to formalize our process and take the next big step.