Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PWA + offline #325

Closed
wants to merge 3 commits into from
Closed

PWA + offline #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f59508
Add PWA service worker, manifest, and assets
m-bers Jan 24, 2021
0bffe11
Fix service worker caching
m-bers Jan 24, 2021
47a65fc
cache api and html so actually works offline
geekgonecrazy Jan 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions internal/view/content.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
<link href="css/custom-dialog.css" rel="stylesheet">
<link href="css/bookmark-item.css" rel="stylesheet">

<link rel="manifest" href="manifest.json">

<script src="js/dayjs.min.js"></script>
<script src="js/vue.min.js"></script>
</head>
Expand Down Expand Up @@ -85,6 +87,19 @@
}
});
</script>
<script type="module">
if ('serviceWorker' in navigator) {
window.addEventListener('load', function() {
navigator.serviceWorker.register('pwabuilder-sw.js');
});
}
</script>
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@pwabuilder/pwaupdate';

const el = document.createElement('pwa-update');
document.body.appendChild(el);
</script>
</body>

</html>
15 changes: 15 additions & 0 deletions internal/view/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
<link href="css/custom-dialog.css" rel="stylesheet">
<link href="css/bookmark-item.css" rel="stylesheet">

<link rel="manifest" href="manifest.json">

<script src="js/vue.min.js"></script>
<script src="js/url.min.js"></script>
</head>
Expand Down Expand Up @@ -171,6 +173,19 @@
}
})
</script>
<script type="module">
if ('serviceWorker' in navigator) {
window.addEventListener('load', function() {
navigator.serviceWorker.register('pwabuilder-sw.js');
});
}
</script>
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@pwabuilder/pwaupdate';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have this living with our other static assets? It seems weird to me that we serve everything bundled withing the binary but this is fetched from an outside service.


const el = document.createElement('pwa-update');
document.body.appendChild(el);
</script>
</body>

</html>
15 changes: 15 additions & 0 deletions internal/view/login.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
<link href="css/fontawesome.min.css" rel="stylesheet">
<link href="css/stylesheet.css" rel="stylesheet">

<link rel="manifest" href="manifest.json">

<script src="js/vue.min.js"></script>
<script src="js/url.min.js"></script>
</head>
Expand Down Expand Up @@ -143,6 +145,19 @@
}
})
</script>
<script type="module">
if ('serviceWorker' in navigator) {
window.addEventListener('load', function() {
navigator.serviceWorker.register('pwabuilder-sw.js');
});
}
</script>
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@pwabuilder/pwaupdate';

const el = document.createElement('pwa-update');
document.body.appendChild(el);
</script>
</body>

</html>
26 changes: 26 additions & 0 deletions internal/view/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"start_url": "/",
"short_name": "Shiori",
"background_color": "",
"url": "/",
"lang": "English",
"name": "Shiori",
"display": "standalone",
"orientation": "any",
"share_target": {
"action": "/share-target/",
"method": "GET",
"params": {
"title": "title",
"text": "text",
"url": "url"
}
},
"icons": [
{
"src": "/res/apple-touch-icon-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
]
}
102 changes: 102 additions & 0 deletions internal/view/pwabuilder-sw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
//This is the service worker with the Advanced caching

importScripts('https://storage.googleapis.com/workbox-cdn/releases/5.1.2/workbox-sw.js');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before, can we bundle this within shiori?


const API_CACHE = "api";
const BOOKMARK_CACHE = "bookmarks";
const HTML_CACHE = "html";
const JS_CACHE = "javascript";
const STYLE_CACHE = "stylesheets";
const IMAGE_CACHE = "images";
const FONT_CACHE = "fonts";

self.addEventListener("message", (event) => {
if (event.data && event.data.type === "SKIP_WAITING") {
self.skipWaiting();
}
});

workbox.routing.registerRoute(
({url, request, event}) => url.pathname === '/api/bookmarks',
new workbox.strategies.NetworkFirst({
cacheName: API_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 50,
}),
],
})
);

workbox.routing.registerRoute(
({url, event}) => event.request.destination === 'document' && url.pathname.startsWith('/bookmark'),
new workbox.strategies.NetworkFirst({
cacheName: BOOKMARK_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 500,
}),
],
})
);

workbox.routing.registerRoute(
({url, event}) => event.request.destination === 'document' && !url.pathname.startsWith('/bookmark'),
new workbox.strategies.NetworkFirst({
cacheName: HTML_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 10,
}),
],
})
);


workbox.routing.registerRoute(
({event}) => event.request.destination === 'script',
new workbox.strategies.StaleWhileRevalidate({
cacheName: JS_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 15,
}),
],
})
);

workbox.routing.registerRoute(
({event}) => event.request.destination === 'style',
new workbox.strategies.StaleWhileRevalidate({
cacheName: STYLE_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 15,
}),
],
})
);

workbox.routing.registerRoute(
({event}) => event.request.destination === 'image',
new workbox.strategies.StaleWhileRevalidate({
cacheName: IMAGE_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 15,
}),
],
})
);

workbox.routing.registerRoute(
({event}) => event.request.destination === 'font',
new workbox.strategies.StaleWhileRevalidate({
cacheName: FONT_CACHE,
plugins: [
new workbox.expiration.ExpirationPlugin({
maxEntries: 15,
}),
],
})
);
Binary file added internal/view/res/apple-touch-icon-512x512.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
156 changes: 90 additions & 66 deletions internal/webserver/assets-prod.go
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions internal/webserver/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ func ServeApp(cfg Config) error {
return path.Join(cfg.RootPath, route)
}

router.GET(jp("/pwabuilder-sw.js"), hdl.serveFile)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be served from /js/... as with the other javascript files.

router.GET(jp("/manifest.json"), hdl.serveFile)

router.GET(jp("/js/*filepath"), hdl.serveJsFile)
router.GET(jp("/res/*filepath"), hdl.serveFile)
router.GET(jp("/css/*filepath"), hdl.serveFile)
Expand Down