Merge pull request #1 from SQL-MisterMagoo/feature_ssb

Add SSB support

Author: SQL-MisterMagoo

Blazor.PWA.MSBuild.Tasks/Blazor.PWA.MSBuild.Tasks.csproj

@@ -69,6 +69,7 @@ I will add more network caching strategies, but for now it has just one - cache
   </ItemGroup>
 
   <ItemGroup>
+    <None Remove="Templates\ServiceWorker\sw_fetch-none.template.js" />
     <None Remove="Templates\ServiceWorker\sw_register-beforeinstallprompt.template.js" />
     <None Remove="Templates\ServiceWorker\sw_register-installable-banner.template.js" />
     <None Remove="Templates\ServiceWorker\sw_register-installable-blazor.template.js" />

Blazor.PWA.MSBuild.Tasks/Templates/ServiceWorker/sw_fetch-none.template.js

@@ -0,0 +1,3 @@
+self.addEventListener(networkFetchEvent, event => {
+    return fetch(event.request);
+});

Blazor.PWA.MSBuild.Tasks/build/BlazorPWA.MSBuild.Manifest.targets

@@ -71,10 +71,11 @@
 
     <!-- Add manifest to index.html -->
     <PropertyGroup>
-      <IndexFile>$(WWWRoot)$(ServiceWorkerIndexUrl)</IndexFile>
+      <IndexFile Condition="'$(BlazorProjectType)' == 'CSB'">$(WWWRoot)$(ProjectIndexPage)</IndexFile>
+      <IndexFile Condition="'$(BlazorProjectType)' == 'SSB'">$(ProjectHomePage)</IndexFile>
       <IndexLines>$([System.IO.File]::ReadAllText($(IndexFile)))</IndexLines>
     </PropertyGroup>
-
+    <Message Importance="high" Text="Blazor Project Type detected as $(BlazorProjectType)"/>
     <Message Importance="high" Text="Adding manifest to $(IndexFile)"
       Condition="'$(IndexLines.Contains(rel=&quot;manifest&quot;))'=='false'"/>
 

Blazor.PWA.MSBuild.Tasks/build/BlazorPWA.MSBuild.ServiceWorker.targets

@@ -48,16 +48,26 @@
       </ServiceWorkerPreCacheGeneratedFiles>
 
       <!-- Setup the declarations for the Service Worker -->
-      <ServiceWorkerConstants Condition="'$(ServiceWorkerConstants)' == ''">
+      <ServiceWorkerConstants Condition="'$(ServiceWorkerConstants)' == '' AND '$(BlazorProjectType)' == 'CSB'">
         const baseURL = '$(ServiceWorkerBaseURL)'%3B;
-        const indexURL = '$(ServiceWorkerBaseUrl)$(ServiceWorkerIndexURL)'%3B;
+        const indexURL = '$(ServiceWorkerBaseUrl)$(ProjectIndexPage)'%3B;
         const networkFetchEvent = '$(ServiceWorkerNetworkFetchEvent)'%3B;
         const swInstallEvent = '$(ServiceWorkerInstallEvent)'%3B;
         const swInstalledEvent = '$(ServiceWorkerInstalledEvent)'%3B;
         const swActivateEvent = '$(ServiceWorkerActivateEvent)'%3B;
         const staticCachePrefix = '$(ServiceWorkerCacheName)-v'%3B;
         const staticCacheName = '$(ServiceWorkerCacheName)-v$(ServiceWorkerCacheVersion)'%3B;
       </ServiceWorkerConstants>
+
+      <!-- Setup the declarations for the Service Worker -->
+      <ServiceWorkerConstants Condition="'$(ServiceWorkerConstants)' == '' AND '$(BlazorProjectType)' == 'SSB'">
+        const baseURL = '$(ServiceWorkerBaseURL)'%3B;
+        const indexURL = '$(ServiceWorkerBaseUrl)$(ProjectHomePage)'%3B;
+        const networkFetchEvent = '$(ServiceWorkerNetworkFetchEvent)'%3B;
+        const swInstallEvent = '$(ServiceWorkerInstallEvent)'%3B;
+        const swInstalledEvent = '$(ServiceWorkerInstalledEvent)'%3B;
+        const swActivateEvent = '$(ServiceWorkerActivateEvent)'%3B;
+      </ServiceWorkerConstants>
     </PropertyGroup>
 
     <!-- The "Templates" properties are used to define where to find templates for the service worker sections -->
@@ -69,7 +79,7 @@
       <!-- The file that contains template code for the network fetch event in the service worker -->
       <ServiceWorkerTemplateNetwork Condition="'$(ServiceWorkerTemplateNetwork)' == ''">$(ServiceWorkerTemplatePath)sw_$(ServiceWorkerNetworkFetchEvent)-$(ServiceWorkerPattern).template.js</ServiceWorkerTemplateNetwork>
     </PropertyGroup>
-    <Message Importance="high" Text="Exclude:;@(ServiceWorkerPreCacheExcludeFiles);@(ServiceWorkerPreCacheExcludeReleaseFiles);"/>
+
     <ItemGroup>
       <!-- Build a list of files to pre-cache -->
       <DistFiles Include="$(ServiceWorkerPreCacheIncludeFiles);" />
@@ -92,10 +102,12 @@
     <WriteLinesToFile File="$(WWWRoot)$(ServiceWorkerFileName)"
                       Overwrite="true"
                       Lines="$(ServiceWorkerConstants)" />
-    <WriteLinesToFile File="$(WWWRoot)$(ServiceWorkerFileName)"
+    <WriteLinesToFile Condition="'$(BlazorProjectType)' == 'CSB'"
+                      File="$(WWWRoot)$(ServiceWorkerFileName)"
                       Overwrite="false"
                       Lines="const requiredFiles = [;@(DistFiles -> '&quot;/%(RecursiveDir)%(FileName)%(Extension)&quot;'->Replace('\','/'),',%0D%0A');]%3B;" />
-    <WriteLinesToFile File="$(WWWRoot)$(ServiceWorkerFileName)"
+    <WriteLinesToFile Condition="'$(BlazorProjectType)' == 'CSB'"
+                      File="$(WWWRoot)$(ServiceWorkerFileName)"
                       Overwrite="false"
                       Lines="@(InstallTemplateLines);" />
     <WriteLinesToFile File="$(WWWRoot)$(ServiceWorkerFileName)"

Blazor.PWA.MSBuild.Tasks/build/BlazorPWA.MSBuild.ServiceWorkerRegister.targets

@@ -93,7 +93,8 @@
   <Target Name="_ServiceWorkerUpdateIndex">
     <!-- Add ServiceWorkerRegister.js to index.html -->
     <PropertyGroup>
-      <IndexFile>$(WWWRoot)$(ServiceWorkerIndexUrl)</IndexFile>
+      <IndexFile Condition="'$(BlazorProjectType)' == 'CSB'">$(WWWRoot)$(ProjectIndexPage)</IndexFile>
+      <IndexFile Condition="'$(BlazorProjectType)' == 'SSB'">$(ProjectHomePage)</IndexFile>
       <IndexLines>$([System.IO.File]::ReadAllText($(IndexFile)))</IndexLines>
     </PropertyGroup>
 

Blazor.PWA.MSBuild.Tasks/build/BlazorPWA.MSBuild.targets

@@ -4,16 +4,23 @@
   <Import Project="..\build\BlazorPWA.MSBuild.ServiceWorkerRegister.targets" />
   <Import Project="..\build\BlazorPWA.MSBuild.Manifest.targets" />
 
+  <PropertyGroup Label="ProjectTypes">
+    <!-- Project type -->
+    <BlazorProjectType Condition="'$(BlazorProjectType)' == '' AND '$(TargetFramework)' == 'netcoreapp3.1'">SSB</BlazorProjectType>
+    <BlazorProjectType Condition="'$(BlazorProjectType)' == '' AND '$(TargetFramework)' == 'netcoreapp3.0'">SSB</BlazorProjectType>
+    <BlazorProjectType Condition="'$(BlazorProjectType)' == '' AND '$(TargetFramework)' == 'netstandard2.0'">CSB</BlazorProjectType>
+  </PropertyGroup>
+
   <PropertyGroup Label="ServiceWorker">
     <!-- The service worker file names to generate -->
     <ServiceWorkerFileName Condition="'$(ServiceWorkerFileName)' == ''">ServiceWorker.js</ServiceWorkerFileName>
     <ServiceWorkerRegisterFileName Condition="'$(ServiceWorkerRegisterFileName)' == ''">ServiceWorkerRegister.js</ServiceWorkerRegisterFileName>
 
     <!-- The PWA strategy to implement in the service worker -->
-    <!-- Currently only supports offline-first -->
+    <!-- Currently only supports offline-first or none -->
+    <ServiceWorkerPattern Condition="'$(BlazorProjectType)' == 'CSB' AND '$(ServiceWorkerPattern)' == ''">offline-first</ServiceWorkerPattern>
+    <ServiceWorkerPattern Condition="'$(BlazorProjectType)' == 'SSB' AND '$(ServiceWorkerPattern)' == ''">none</ServiceWorkerPattern>
     <ServiceWorkerPattern Condition="'$(ServiceWorkerPattern)' == ''">offline-first</ServiceWorkerPattern>
-    <!-- Remove this when we implement more patterns -->
-    <ServiceWorkerPattern>offline-first</ServiceWorkerPattern>
 
     <!-- The Cache name and version together form the name of the application browser cache e.g. blazor-cache-v1 -->
     <ServiceWorkerCacheName Condition="'$(ServiceWorkerCacheName)' == ''">blazor-cache</ServiceWorkerCacheName>
@@ -22,8 +29,11 @@
     <!-- The "home route" url for the application -->
     <ServiceWorkerBaseUrl Condition="'$(ServiceWorkerBaseUrl)' == ''">/</ServiceWorkerBaseUrl>
 
-    <!-- The actual home page served up for the base URL - so we have a way to cache it -->
-    <ServiceWorkerIndexUrl Condition="'$(ServiceWorkerIndexUrl)' == ''">index.html</ServiceWorkerIndexUrl>
+    <!-- The CSB home page served up for the base URL -->
+    <ProjectIndexPage Condition="'$(ProjectIndexPage)' == ''">index.html</ProjectIndexPage>
+
+    <!-- The SSB home page served up for the base URL -->
+    <ProjectHomePage Condition="'$(ProjectHomePage)' == ''">Pages/_Host.cshtml</ProjectHomePage>
 
   </PropertyGroup>
 
@@ -54,7 +64,7 @@
           BeforeTargets="$(CreatePWABeforeTargets)"
           Condition="'$(ServiceWorkerPattern)'!='' AND '$(ServiceWorkerCacheName)'!='' AND '$(ServiceWorkerCacheVersion)'!='' AND (!Exists('$(WWWRoot)$(ServiceWorkerFileName)') OR '$(ServiceWorkerForce)'=='true')">
 
-    <Message Importance="high" Text="Building Your PWA: Type: $(ServiceWorkerPattern) CacheName: $(ServiceWorkerCacheName) CacheVersion: $(ServiceWorkerCacheVersion)"/>
+    <Message Importance="high" Text="Building Your $(BlazorProjectType) PWA: Type: $(ServiceWorkerPattern) CacheName: $(ServiceWorkerCacheName) CacheVersion: $(ServiceWorkerCacheVersion)"/>
     <CallTarget Targets="BuildServiceWorkerInstaller"/>
     <CallTarget Targets="BuildServiceWorkerManifest"/>
     <CallTarget Targets="BuildServiceWorker"/>

CHANGELOG.md

@@ -1,3 +1,12 @@
+#### 16/10/2019
+
+- Added new **Property** **`BlazorProjectType`** - used to select the type of Blazor project (SSB/CSB). This property will auto-configure but can be overridden in your csproj file in cases where auto-configure is wrong.
+- Added new **ServiceWorkerPattern** value - "none" - primarily intended for SSB projects (where it is the default) - this service worker does nothing.
+- Removed **Property** **`ServiceWorkerIndexUrl`** 
+- Added new **Property** **`ProjectIndexPage`** - used to identify the name of a _CSB_ index page - defaults to `index.html`
+- Added new **Property** **`ProjectHomePage`** - used to identify the name of a _SSB_ index page - defaults to `Pages\_Host.cshtml`
+- Added **`BlazorProjectType`** to build output.
+
 #### 10/08/2019 - 13/08/2019
 
 - Added new **Property** **`ServiceWorkerUpdateAlertText`** - used to change the default text in the "Update available alert".

README.md

@@ -1,14 +1,14 @@
 # Blazor PWA Builder - MSBuild
 
-The easiest way to turn your Client Side Blazor project into a Progressive Web App (PWA).
+The easiest way to turn your Server Side And Client Side Blazor projects into Progressive Web Apps (PWA).
 
 This project, when added to your build process, will generate the required files to enable basic PWA abilities for your project.
 
-It generates a manifest.json, a Service Worker with pre-caching of all required files and an installer for the Service Worker.
+It generates a manifest.json, a Service Worker with pre-caching of all required files (Blazor WebAssembly only) and an installer for the Service Worker.
 
-It currently includes a simple banner to notify the user that your application can be installed, and a simple alert to notify users when your application has been updated.
+It currently includes a simple banner, by default, to notify the user that your application can be installed, and a simple alert to notify users when your application has been updated (CSB Only).
 
-This is to be considered a Beta release - I am looking for feedback/issues/requests.
+This is now an official release - I am looking for feedback/issues/requests.
 
 ### Browser compatibility