feat(refresh-endpoint): Add e2e integration tests

e2e-tests/development-refresh-endpoint/.gitignore

@@ -0,0 +1,76 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+
+# gatsby files
+.cache/
+public
+
+# Mac files
+.DS_Store
+
+# Yarn
+yarn-error.log
+.pnp/
+.pnp.js
+# Yarn Integrity file
+.yarn-integrity
+
+# misc files
+cypress/screenshots
+cypress/fixtures
+cypress/videos
+
+__history__.json

e2e-tests/development-refresh-endpoint/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 gatsbyjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

e2e-tests/development-refresh-endpoint/README.md

@@ -0,0 +1,97 @@
+<p align="center">
+  <a href="https://www.gatsbyjs.org">
+    <img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
+  </a>
+</p>
+<h1 align="center">
+  Gatsby's default starter
+</h1>
+
+Kick off your project with this default boilerplate ([live demo](https://gatsby-starter-default-demo.netlify.app/)). This barebones starter ships with the main Gatsby configuration files you might need.
+
+_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
+
+## 🚀 Quick start
+
+1.  **Create a Gatsby site.**
+
+    Use the Gatsby CLI to create a new site, specifying the default starter.
+
+    ```shell
+    # create a new Gatsby site using the default starter
+    gatsby new my-default-starter
+    ```
+
+1.  **Start developing.**
+
+    Navigate into your new site’s directory and start it up.
+
+    ```shell
+    cd my-default-starter/
+    gatsby develop
+    ```
+
+1.  **Open the source code and start editing!**
+
+    Your site is now running at `http://localhost:8000`!
+
+    \_Note: You'll also see a second link: `http://localhost:8000/___graphql`. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql).\_
+
+    Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
+
+## 🧐 What's inside?
+
+A quick look at the top-level files and directories you'll see in a Gatsby project.
+
+    .
+    ├── node_modules
+    ├── src
+    ├── .gitignore
+    ├── .prettierrc
+    ├── gatsby-browser.js
+    ├── gatsby-config.js
+    ├── gatsby-node.js
+    ├── gatsby-ssr.js
+    ├── LICENSE
+    ├── package-lock.json
+    ├── package.json
+    ├── README.md
+    └── yarn.lock
+
+1.  **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
+
+2.  **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
+
+3.  **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
+
+4.  **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
+
+5.  **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
+
+6.  **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
+
+7.  **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
+
+8.  **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
+
+9.  **`LICENSE`**: Gatsby is licensed under the MIT license.
+
+10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**
+
+11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
+
+12. **`README.md`**: A text file containing useful reference information about your project.
+
+13. **`yarn.lock`**: [Yarn](https://yarnpkg.com/) is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as `package-lock.json`, just for a different package management system.
+
+## 🎓 Learning Gatsby
+
+Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
+
+- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
+
+- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
+
+## 💫 Deploy
+
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)

e2e-tests/development-refresh-endpoint/cypress.json

@@ -0,0 +1,4 @@
+{
+  "baseUrl": "http://localhost:8000",
+  "failOnStatusCode": false
+}

e2e-tests/development-refresh-endpoint/cypress/integration/functionality/refresh-endpoint.js

@@ -0,0 +1,73 @@
+describe(`When the refresh endpoint is hit`, () => {
+  afterEach(() => {
+    waitUntilRefreshFinishes()
+  })
+
+  describe(`and accessing any page while refreshing`, () => {
+    it(`the page shown should be restarting page for 404 page`, () => {
+      cy.request(`/non-existing`).then(response => {
+        expect(response.body).not.to.include(`<title>Restarting...</title>`)
+      })
+      cy.request(`POST`, `/__refresh`)
+      cy.request(`/non-existing`).then(response => {
+        expect(response.body).to.include(`<title>Restarting...</title>`)
+      })
+    })
+
+    it(`the page shown should be restarting page for existing pages`, () => {
+      cy.request(`/page-2/`).then(response => {
+        expect(response.body).not.to.include(`<title>Restarting...</title>`)
+      })
+      cy.request(`POST`, `/__refresh`)
+      cy.request(`/page-2/`).then(response => {
+        expect(response.body).to.include(`<title>Restarting...</title>`)
+      })
+    })
+  })
+
+  describe(`and it was not already refreshing`, () => {
+    it(`should return empty body`, () => {
+      cy.request(`POST`, `/__refresh`).then(response => {
+        expect(response.body).to.be.equal(``)
+      })
+    })
+  })
+  describe(`and it was already refreshing`, () => {
+    it(`should put new requests with unique body in a queue`, () => {
+      cy.request(`POST`, `/__refresh`).then(response => {
+        expect(response.body).to.be.equal(``)
+      })
+      cy.request(`POST`, `/__refresh`).then(response => {
+        expect(response.body).to.include(`queued`)
+      })
+      cy.request(`POST`, `/__refresh`).then(response => {
+        expect(response.body).to.include(`already queued`)
+      })
+      cy.request(`POST`, `/__refresh`, `otherBody`).then(response => {
+        expect(response.body).to.include(`queued`)
+      })
+      cy.request(`POST`, `/__refresh`, `otherBody`).then(response => {
+        expect(response.body).to.include(`already queued`)
+      })
+    })
+  })
+})
+
+function waitUntilRefreshFinishes() {
+  cy.waitUntil(
+    () =>
+      cy
+        .request(`/`)
+        .then(
+          response => !response.body.includes(`<title>Restarting...</title>`)
+        ),
+    {
+      timeout: 60000,
+      interval: 2000,
+    }
+  )
+
+  cy.request(`/`).then(response => {
+    expect(response.body).not.to.include(`<title>Restarting...</title>`)
+  })
+}

e2e-tests/development-refresh-endpoint/cypress/plugins/index.js

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

e2e-tests/development-refresh-endpoint/cypress/support/commands.js

@@ -0,0 +1,2 @@
+import "@testing-library/cypress/add-commands"
+import "cypress-wait-until"

e2e-tests/development-refresh-endpoint/cypress/support/index.js

@@ -0,0 +1,2 @@
+import "gatsby-cypress"
+import "./commands"

e2e-tests/development-refresh-endpoint/gatsby-config.js

@@ -0,0 +1,31 @@
+// isomorphic-fetch sets global.fetch which seems to conflicts with source-map@<0.8.0 where it does a
+// simple browser check if (global.fetch) which is true when isomorphic-fetch is used. This creates an
+// exception in react-hot-loader. @see https://github.com/gatsbyjs/gatsby/pull/13713
+require(`isomorphic-fetch`)
+
+module.exports = {
+  siteMetadata: {
+    title: `Gatsby Default Starter`,
+    description: `Kick off your next, great Gatsby project with this default starter. This barebones starter ships with the main Gatsby configuration files you might need.`,
+    author: `@gatsbyjs`,
+    social: {
+      twitter: `kylemathews`,
+    },
+  },
+  plugins: [
+    `gatsby-plugin-react-helmet`,
+    `gatsby-plugin-sharp`,
+    {
+      resolve: `gatsby-plugin-manifest`,
+      options: {
+        name: `gatsby-starter-default`,
+        short_name: `starter`,
+        start_url: `/`,
+        background_color: `#663399`,
+        theme_color: `#663399`,
+        display: `minimal-ui`,
+        icon: `src/images/gatsby-icon.png`, // This path is relative to the root of the site.
+      },
+    }
+  ],
+}

e2e-tests/development-refresh-endpoint/gatsby-node.js

@@ -0,0 +1,10 @@
+const path = require(`path`)
+exports.createPages = async function createPages({
+  actions: { createPage },
+}) {
+
+  createPage({
+    path: `/page/`,
+    component: path.resolve(`src/pages/page.js`),
+  })
+}

e2e-tests/development-refresh-endpoint/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "e2e-development-refresh-endpoint",
+  "description": "An e2e-test validating development refresh endpoint functionality",
+  "version": "1.0.0",
+  "author": "Daniel Aparicio <[email protected]>",
+  "dependencies": {
+    "gatsby": "^2.4.4",
+    "gatsby-plugin-react-helmet": "^3.0.6",
+    "gatsby-plugin-sharp": "^2.0.37",
+    "isomorphic-fetch": "^2.2.1",
+    "prop-types": "^15.6.2",
+    "react": "16.8.6",
+    "react-dom": "16.8.6",
+    "react-helmet": "^5.2.1"
+  },
+  "keywords": [
+    "gatsby",
+    "gatsby-e2e"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "gatsby build",
+    "develop": "cross-env CYPRESS_SUPPORT=y ENABLE_GATSBY_RESTARTING_SCREEN_ON_REFRESH=true ENABLE_GATSBY_REFRESH_ENDPOINT=true gatsby develop",
+    "serve": "gatsby serve",
+    "start": "npm run develop",
+    "format": "prettier --write \"src/**/*.js\"",
+    "test": "npm run start-server-and-test || (npm run reset && exit 1)",
+    "start-server-and-test": "start-server-and-test develop http://localhost:8000 cy:run",
+    "cy:open": "cypress open",
+    "cy:run": "(is-ci && cypress run --browser chrome --record) || cypress run --browser chrome"
+  },
+  "devDependencies": {
+    "@testing-library/cypress": "^4.0.4",
+    "cross-env": "^5.2.0",
+    "cypress": "3.4.1",
+    "cypress-wait-until": "1.7.1",
+    "fs-extra": "^7.0.1",
+    "gatsby-cypress": "0.4.4",
+    "is-ci": "^2.0.0",
+    "prettier": "2.0.4",
+    "start-server-and-test": "^1.7.11",
+    "yargs": "^12.0.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gatsbyjs/gatsby"
+  }
+}