Skip to content

Commit

Permalink
Make the Blazor Wasm sample site be able to test PWA
Browse files Browse the repository at this point in the history
  • Loading branch information
jsakamoto committed Dec 13, 2023
1 parent 1050244 commit dcd4e2f
Show file tree
Hide file tree
Showing 8 changed files with 97 additions and 1 deletion.
6 changes: 5 additions & 1 deletion SampleSites/Client/SampleSite.Client.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<ServiceWorkerAssetsManifest>service-worker-assets.js</ServiceWorkerAssetsManifest>
</PropertyGroup>

<ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
Expand All @@ -26,8 +27,11 @@
</ItemGroup>

<ItemGroup>
<!--<PackageReference Include="System.Net.Http.Json" Version="5.0.0" />-->
<ProjectReference Include="..\Components\SampleSite.Components.csproj" />
</ItemGroup>

<ItemGroup>
<ServiceWorker Include="wwwroot\service-worker.js" PublishedContent="wwwroot\service-worker.published.js" />
</ItemGroup>

</Project>
Binary file added SampleSites/Client/wwwroot/icon-192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added SampleSites/Client/wwwroot/icon-512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions SampleSites/Client/wwwroot/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
<meta name="description" content="This is the demonstration site of the class library that provides gamepad API access for your Blazor apps." />
<meta name="keywords" content="blazor,gamepad" />
<base href="/" />
<link rel="manifest" href="manifest.webmanifest" />
<link rel="icon" href="./_content/SampleSite.Components/nupkg-icon.png" />
<link rel="apple-touch-icon" sizes="512x512" href="icon-512.png" />
<link rel="apple-touch-icon" sizes="192x192" href="icon-192.png" />
<link rel="stylesheet" href="css/blazor-ui.css" />
<link rel="stylesheet" href="_content/SampleSite.Components/styles.css" />
</head>
Expand All @@ -30,6 +33,7 @@

<script src="_framework/blazor.webassembly.js"></script>
<!--<script src="_content/Toolbelt.Blazor.Gamepad/script.min.js"></script>-->
<script>navigator.serviceWorker.register('service-worker.js');</script>
</body>

</html>
22 changes: 22 additions & 0 deletions SampleSites/Client/wwwroot/manifest.webmanifest
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "Blazor Gamepad Sample App",
"short_name": "Blazor Gamepad",
"id": "./",
"start_url": "./",
"display": "standalone",
"background_color": "#ffffff",
"theme_color": "#03173d",
"prefer_related_applications": false,
"icons": [
{
"src": "icon-512.png",
"type": "image/png",
"sizes": "512x512"
},
{
"src": "icon-192.png",
"type": "image/png",
"sizes": "192x192"
}
]
}
4 changes: 4 additions & 0 deletions SampleSites/Client/wwwroot/service-worker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// In development, always fetch from the network and do not enable offline support.
// This is because caching would make development more difficult (changes would not
// be reflected on the first load after each change).
self.addEventListener('fetch', () => { });
55 changes: 55 additions & 0 deletions SampleSites/Client/wwwroot/service-worker.published.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// Caution! Be sure you understand the caveats before publishing an application with
// offline support. See https://aka.ms/blazor-offline-considerations

self.importScripts('./service-worker-assets.js');
self.addEventListener('install', event => event.waitUntil(onInstall(event)));
self.addEventListener('activate', event => event.waitUntil(onActivate(event)));
self.addEventListener('fetch', event => event.respondWith(onFetch(event)));

const cacheNamePrefix = 'offline-cache-';
const cacheName = `${cacheNamePrefix}${self.assetsManifest.version}`;
const offlineAssetsInclude = [/\.dll$/, /\.pdb$/, /\.wasm/, /\.html/, /\.js$/, /\.json$/, /\.css$/, /\.woff$/, /\.png$/, /\.jpe?g$/, /\.gif$/, /\.ico$/, /\.blat$/, /\.dat$/, /\.br$/ ];
const offlineAssetsExclude = [ /^service-worker\.js$/ ];

// Replace with your base path if you are hosting on a subfolder. Ensure there is a trailing '/'.
const base = "/";
const baseUrl = new URL(base, self.origin);
const manifestUrlList = self.assetsManifest.assets.map(asset => new URL(asset.url, baseUrl).href);

async function onInstall(event) {
console.info('Service worker: Install');

// Fetch and cache all matching items from the assets manifest
const assetsRequests = self.assetsManifest.assets
.filter(asset => offlineAssetsInclude.some(pattern => pattern.test(asset.url)))
.filter(asset => !offlineAssetsExclude.some(pattern => pattern.test(asset.url)))
.map(asset => new Request(asset.url, { integrity: asset.hash, cache: 'no-cache' }));
await caches.open(cacheName).then(cache => cache.addAll(assetsRequests));
}

async function onActivate(event) {
console.info('Service worker: Activate');

// Delete unused caches
const cacheKeys = await caches.keys();
await Promise.all(cacheKeys
.filter(key => key.startsWith(cacheNamePrefix) && key !== cacheName)
.map(key => caches.delete(key)));
}

async function onFetch(event) {
let cachedResponse = null;
if (event.request.method === 'GET') {
// For all navigation requests, try to serve index.html from cache,
// unless that request is for an offline resource.
// If you need some URLs to be server-rendered, edit the following check to exclude those URLs
const shouldServeIndexHtml = event.request.mode === 'navigate'
&& !manifestUrlList.some(url => url === event.request.url);

const request = shouldServeIndexHtml ? 'index.html' : event.request;
const cache = await caches.open(cacheName);
cachedResponse = await cache.match(request);
}

return cachedResponse || fetch(event.request);
}
7 changes: 7 additions & 0 deletions SampleSites/Server/SampleSite.Server.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,11 @@
<ProjectReference Include="..\Components\SampleSite.Components.csproj" />
</ItemGroup>

<ItemGroup>
<Content Update="wwwroot\favicon.ico">
<ExcludeFromSingleFile>true</ExcludeFromSingleFile>
<CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
</Content>
</ItemGroup>

</Project>

0 comments on commit dcd4e2f

Please sign in to comment.