Make service worker opt-in in development

Jasper van Merle committed 7 years ago

Commit 576f32d1 parent 0cd152712 files · +36 −31Browse files

Showing the changes to assets/javascripts (7 of 12 files). Show all

Unified · Split

7 files

@@ -14,3 +14,4 @@ app.config = · 13 unmodified lines
14	release: <%= Time.now.utc.httpdate.to_json %>	14	release: <%= Time.now.utc.httpdate.to_json %>
15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'	15	mathml_stylesheet: '<%= App.cdn_origin %>/mathml.css'
16	service_worker_path: '/service-worker.js'	16	service_worker_path: '/service-worker.js'
		17	service_worker_enabled: <%= App.environment == 'production' \|\| !ENV["ENABLE_SERVICE_WORKER"].nil? %>

@@ -2,7 +2,7 @@ class app.ServiceWorker · 1 unmodified line
2	$.extend @prototype, Events	2	$.extend @prototype, Events
3		3
4	@isEnabled: ->	4	@isEnabled: ->
5	!!navigator.serviceWorker	5	!!navigator.serviceWorker and app.config.service_worker_enabled
6		6
7	constructor: ->	7	constructor: ->
8	@registration = null	8	@registration = null

     'manualUpdate'
     'fastScroll'
     'arrowScroll'
-    'bypassCache'
     'docs'
     'dark'
     'layout'
     @set 'size', value
     return
-  setBypassCache: (value) ->
-    @set 'bypassCache', value
-    app.serviceWorker?.updateInBackground()
-    return
   dump: ->
     @store.dump()

   if app.ServiceWorker.isEnabled()
     """ Yes! Even offline, you can open a new tab, go to <a href="//devdocs.io">devdocs.io</a>, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """
   else
-    """ No. Service Workers aren't available in your browser (or are disabled), so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
+    reason = "aren't available in your browser (or are disabled)"
+    if app.config.env != 'production'
+      reason = "are disabled in your development instance of DevDocs (enable them by setting the ENABLE_SERVICE_WORKERS environment variable)"
+    """ No. Service Workers #{reason}, so loading <a href="//devdocs.io">devdocs.io</a> offline won't work.<br>
         The current tab will continue to function even when you go offline (provided you installed all the documentations beforehand). """
 app.templates.offlineDoc = (doc, status) ->

@@ -8,7 +8,7 @@ app.templates.intro = """ · 7 unmodified lines
8	<p>Thanks for downloading DevDocs. Here are a few things you should know:	8	<p>Thanks for downloading DevDocs. Here are a few things you should know:
9	<ol class="_intro-list">	9	<ol class="_intro-list">
10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,	10	<li>Your local version of DevDocs won't self-update. Unless you're modifying the code,
11	I recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.	11	we recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.
12	<li>Run <code>thor docs:list</code> to see all available documentations.	12	<li>Run <code>thor docs:list</code> to see all available documentations.
13	<li>Run <code>thor docs:download <name></code> to download documentations.	13	<li>Run <code>thor docs:download <name></code> to download documentations.
14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.	14	<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.

         <input type="checkbox" form="settings" name="layout" value="_sidebar-hidden"#{if settings['_sidebar-hidden'] then ' checked' else ''}>Automatically hide and show the sidebar
         <small>Tip: drag the edge of the sidebar to resize it.</small>
       </label>
-      <label class="_settings-label">
-        <input type="checkbox" form="settings" name="bypassCache" value="1"#{if settings.bypassCache then ' checked' else ''}>Bypass Service Worker cache
-        <small>When this is checked, the Service Worker will always fetch the latest version of requested files. Useful when making changes to the DevDocs source code.</small>
-      </label>
     </div>
   </div>

     settings.dark = app.settings.get('dark')
     settings.smoothScroll = !app.settings.get('fastScroll')
     settings.arrowScroll = app.settings.get('arrowScroll')
-    settings.bypassCache = app.settings.get('bypassCache')
     settings[layout] = app.settings.hasLayout(layout) for layout in app.settings.LAYOUTS
     settings
     app.settings.set('fastScroll', !enable)
     return
-  toggleBypassCache: (enable) ->
-    app.settings.setBypassCache(!!enable)
-    return
   toggle: (name, enable) ->
     app.settings.set(name, enable)
     return
         @toggleSmoothScroll input.checked
       when 'import'
         @import input.files[0], input
-      when 'bypassCache'
-        @toggleBypassCache input.checked
       else
         @toggle input.name, input.checked
     return