vue-cli icon indicating copy to clipboard operation
vue-cli copied to clipboard

[Vue PWA] Feature - Inject environment variables in service-worker.js

Open esynaps opened this issue 5 years ago • 4 comments

What problem does this feature solve?

We need to inject environment variables in service-worker.js

process.env.VUE_APP_MY_VAR should be replaced by the DefinePlugin of webpack (automatically configured by Vue CLI) by a value defined in my .env but it works for all files except the "service-worker.js"

My vue.config.js

module.exports = {
  transpileDependencies: [],
  configureWebpack: {
    resolve: {
      symlinks: false
    }
  },
  pwa: {
    workboxPluginMode: 'InjectManifest',
    workboxOptions: {
      swSrc: 'public/service-worker.js'
    }
  }
}

What does the proposed API look like?

I found two obscure solutions for this problem :

The first one : https://stackoverflow.com/a/57051150/4864628

The second (better): https://github.com/diachedelic/vue-cli-plugin-bundle-service-worker

This last solution uses webpack to bundle the service-worker.js file. In my opinion this should be the default behavior of Vue PWA.

esynaps avatar Jan 07 '20 14:01 esynaps

So... no way?

rodrigogs avatar Apr 03 '20 04:04 rodrigogs

While waiting for the managers to take care of it, I recommend this link which served as an alternative

https://stackoverflow.com/a/57051150/4864628

esynaps avatar Apr 03 '20 07:04 esynaps

This would be a great feature. I'm having the same issue and need to change the service worker to cache different API requests depending on deployed environment e.g. QA, UAT and Prod.

Phoen1x84 avatar Sep 03 '20 07:09 Phoen1x84

You can encapsulate variables into a query string appended to the service worker script path.

navigator.serviceWorker.register(
    import.meta.env.VITE_SW_PATH + (import.meta.env.VITE_SW_PATH.includes('?') ? '&' : '?') + 'vapid_public_key=' + import.meta.env.VITE_VAPID_PUBLIC_KEY
)

In service worker:

variables = Object.fromEntries(self.serviceWorker.scriptURL.split('?')[1].split('&').map((value, idx) => idx === 1 ? decodeURIComponent(value) : value))

Use .env.development during development & .env.production or actual environment variables to influence what happens at build time.

Tobiaqs avatar Mar 27 '24 10:03 Tobiaqs