Add preference to bypass service worker cache

Jasper van Merle committed 7 years ago

Commit 0e9aa881 parent ec8616e6 files · +28 −1Browse files

Unified · Split

6 files

assets/javascripts/app/settings.coffee +6 −0
assets/javascripts/templates/pages/settings_tmpl.coffee +4 −0
assets/javascripts/views/content/settings_page.coffee +7 −0
docs/adding-docs.md +2 −0
lib/app.rb +4 −0
views/service-worker.js.erb +5 −1

assets/javascripts/app/settings.coffee+6−0

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

assets/javascripts/templates/pages/settings_tmpl.coffee+4−0

         <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>

assets/javascripts/views/content/settings_page.coffee+7−0

     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

docs/adding-docs.md+2−0

@@ -2,6 +2,8 @@ Adding a documentation may look like a daunting task but once you get the hang o · 1 unmodified line
2		2
3	Note: please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation.	3	Note: please read the [contributing guidelines](../.github/CONTRIBUTING.md) before submitting a new documentation.
4		4
		5	Note: when editing any of the files in the `assets` directory or the `public` directory, you'll have to bypass the service worker cache. To do this, go to the Preferences page on your local instance of DevDocs, check "Bypass Service Worker cache" and refresh the page.
		6
5	1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)	7	1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
6	2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page).	8	2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page).
7	3. Check that the scraper is listed in `thor docs:list`.	9	3. Check that the scraper is listed in `thor docs:list`.

lib/app.rb+4−0

       app_theme == 'dark'
     end
+    def bypass_cache?
+      !memoized_cookies['bypassCache'].nil?
+    end
     def redirect_via_js(path)
       response.set_cookie :initial_path, value: path, expires: Time.now + 15, path: '/'
       redirect '/', 302

views/service-worker.js.erb+5−1

   event.waitUntil((async () => {
     const keys = await caches.keys();
     const jobs = keys.map(key => key !== cacheName ? caches.delete(key) : Promise.resolve());
-    return await Promise.all(jobs);
+    return Promise.all(jobs);
   })());
 });
 <%# Handle HTTP requests %>
 self.addEventListener('fetch', event => {
   event.respondWith((async () => {
+    <% if bypass_cache? %>
+    return fetch(event.request);
+    <% else %>
     const cachedResponse = await caches.match(event.request);
     if (cachedResponse) return cachedResponse;
       throw err;
     }
+    <% end %>
   })());
 });