Skip to content

Commit

Permalink
[gatsby] don't run service-workers outside of https or localhost (ga…
Browse files Browse the repository at this point in the history
…tsbyjs#3502)

* [gatsby] don't run service-workers outside of https or localhost
see: gatsbyjs#3385

* add detail around running local changes to CONTRIBUTING.md

* Update CONTRIBUTING.md

* format
  • Loading branch information
busticated authored and jastack committed Jan 24, 2018
1 parent 94b2b7a commit e5b24d4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ The usual contributing steps are:
build of all packages and then watch for changes to packages' source code and
compile these changes on-the-fly as you work.
* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli`
* Run `yarn install` in each of the sites you're testing with.
* For each of your Gatsby test sites, run the `gatsby-dev` command there to copy
the built files from your cloned copy of Gatsby. It'll watch for your changes
to Gatsby packages and copy them into the site. For more detailed instructions
Expand Down
6 changes: 4 additions & 2 deletions docs/docs/deploy-gatsby.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,11 @@ git remote add origin git@gitlab.com:examplerepository
git add .
git push -u origin master
```

You can deploy sites on Gitlab Pages with or without a custom domain. If you choose to use the default setup (without a custom domain), or if you create a project site, you will need to setup your site with path prefixing. If adding a custom domain, you can skip the Path Prefix step, and remove `--prefix-paths` from the gitlab-ci.yml file.

### Path Prefix

As the site will be hosted under yourname.gitlab.io/examplerepository/, you will need to configure Gatsby to use the Path Prefix plugin.

In the `gatsby-config.js`, set the `pathPrefix` to be added to your site's link
Expand Down Expand Up @@ -157,12 +159,12 @@ CI stage. You can have multiple stages, e.g. 'Test', 'Build', 'Deploy' etc.
`script:` starts the next part of the CI stage, telling it to start running the
below scripts inside the image selected. We have used the `yarn install` and
`./node_modules/.bin/gatsby build --prefix-paths` which will install all dependancies, and
start the static site build, respectively.
start the static site build, respectively.

We have used
`./node_modules/.bin/gatsby build --prefix-paths` because we then don't have to install
gatsby-cli to build the image, as it has already been included and installed
with `yarn install`. We have included `--prefix-paths` as when running the command *without* that flag, Gatsby ignores your pathPrefix. `artifacts:` and `paths:` are used to tell GitLab pages
with `yarn install`. We have included `--prefix-paths` as when running the command _without_ that flag, Gatsby ignores your pathPrefix. `artifacts:` and `paths:` are used to tell GitLab pages
where the static files are kept. `only:` and `master` tells the CI to only run
the above instructions when the master branch is deployed.

Expand Down
9 changes: 8 additions & 1 deletion packages/gatsby/cache-dir/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ apiRunnerAsync(`onClientEntry`).then(() => {
*
* Let's unregister the service workers in development, and tidy up a few errors.
*/
if (`serviceWorker` in navigator) {
if (supportsServiceWorkers(location, navigator)) {
navigator.serviceWorker.getRegistrations().then(registrations => {
for (let registration of registrations) {
registration.unregister()
Expand Down Expand Up @@ -69,3 +69,10 @@ apiRunnerAsync(`onClientEntry`).then(() => {
})
}
})

function supportsServiceWorkers(location, navigator) {
if (location.hostname === `localhost` || location.protocol === `https:`) {
return `serviceWorker` in navigator
}
return false
}

0 comments on commit e5b24d4

Please sign in to comment.