Merge pull request #9 from SQL-MisterMagoo/chucker-master

Chucker master - local branch for PR #5

Author: SQL-MisterMagoo

Blazor.PWA.MSBuild.Tasks/Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <VersionPrefix>1.0.1</VersionPrefix>
+    <VersionPrefix>1.0.2</VersionPrefix>
     <VersionSuffix>beta$([System.DateTime]::Now.ToString("yyyyMMdd-HHmmss"))</VersionSuffix>
     <VersionSuffix Condition="'$(Configuration)' == 'Release'"></VersionSuffix>
   </PropertyGroup>

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

@@ -13,6 +13,8 @@
 
       <!-- Base URL for the app -->
       <ManifestBaseUrl Condition="'$(ManifestBaseUrl)' == ''">/</ManifestBaseUrl>
+      <ManifestBaseUrl Condition="!'$(ManifestBaseUrl.StartsWith(/))'">/$(ManifestBaseUrl)</ManifestBaseUrl>
+      <ManifestBaseUrl Condition="!'$(ManifestBaseUrl.EndsWith(/))'">$(ManifestBaseUrl)/</ManifestBaseUrl>
 
       <!-- Please see https://developers.google.com/web/fundamentals/web-app-manifest/#display for options -->
       <ManifestDisplay Condition="'$(ManifestDisplay)' == ''">standalone</ManifestDisplay>
@@ -82,7 +84,7 @@
     <WriteLinesToFile 
       File="$(IndexFile)" 
       Overwrite="true" 
-      Lines="$(IndexLines.Replace('&lt;/head&gt;','    &lt;link href=&quot;/$(ManifestFileName)&quot; rel=&quot;manifest&quot;/&gt;%0D%0A&lt;/head&gt;'))"
+      Lines="$(IndexLines.Replace('&lt;/head&gt;','    &lt;link href=&quot;$(ManifestBaseUrl)$(ManifestFileName)&quot; rel=&quot;manifest&quot;/&gt;%0D%0A&lt;/head&gt;'))"
       Condition="'$(IndexLines.Contains(rel=&quot;manifest&quot;))'=='false'"/>
   </Target>
 </Project>

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

@@ -49,7 +49,7 @@
 
       <!-- Setup the declarations for the Service Worker -->
       <ServiceWorkerConstants Condition="'$(ServiceWorkerConstants)' == '' AND '$(BlazorProjectType)' == 'CSB'">
-        const baseURL = '$(ServiceWorkerBaseURL)'%3B;
+        const baseURL = '$(ServiceWorkerBaseUrl)'%3B;
         const indexURL = '$(ServiceWorkerBaseUrl)$(ProjectIndexPage)'%3B;
         const networkFetchEvent = '$(ServiceWorkerNetworkFetchEvent)'%3B;
         const swInstallEvent = '$(ServiceWorkerInstallEvent)'%3B;
@@ -61,7 +61,7 @@
 
       <!-- Setup the declarations for the Service Worker -->
       <ServiceWorkerConstants Condition="'$(ServiceWorkerConstants)' == '' AND '$(BlazorProjectType)' == 'SSB'">
-        const baseURL = '$(ServiceWorkerBaseURL)'%3B;
+        const baseURL = '$(ServiceWorkerBaseUrl)'%3B;
         const indexURL = '$(ServiceWorkerBaseUrl)$(ProjectHomePage)'%3B;
         const networkFetchEvent = '$(ServiceWorkerNetworkFetchEvent)'%3B;
         const swInstallEvent = '$(ServiceWorkerInstallEvent)'%3B;
@@ -105,7 +105,7 @@
     <WriteLinesToFile Condition="'$(BlazorProjectType)' == 'CSB'"
                       File="$(WWWRoot)$(ServiceWorkerFileName)"
                       Overwrite="false"
-                      Lines="const requiredFiles = [;@(DistFiles -> '&quot;/%(RecursiveDir)%(FileName)%(Extension)&quot;'->Replace('\','/'),',%0D%0A');]%3B;" />
+                      Lines="const requiredFiles = [;@(DistFiles -> '&quot;$(ServiceWorkerBaseUrl)%(RecursiveDir)%(FileName)%(Extension)&quot;'->Replace('\','/'),',%0D%0A');]%3B;" />
     <WriteLinesToFile Condition="'$(BlazorProjectType)' == 'CSB'"
                       File="$(WWWRoot)$(ServiceWorkerFileName)"
                       Overwrite="false"

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

@@ -34,7 +34,7 @@
       <ServiceWorkerBlazorInstallMethod Condition="'$(ServiceWorkerBlazorInstallMethod)'==''">PWAInstallable</ServiceWorkerBlazorInstallMethod>
       <!-- Setup the declarations for the Service Worker Register -->
       <ServiceWorkerRegisterConstants Condition="'$(ServiceWorkerRegisterConstants)' == ''">
-        const serviceWorkerFileName = '$(ServiceWorkerBaseURL)$(ServiceWorkerFileName)'%3B;
+        const serviceWorkerFileName = '$(ServiceWorkerBaseUrl)$(ServiceWorkerFileName)'%3B;
         const swInstalledEvent = '$(ServiceWorkerInstalledEvent)'%3B;
         const staticCachePrefix = '$(ServiceWorkerCacheName)-v'%3B;
         const updateAlertMessage = '$(ServiceWorkerUpdateAlertText)'%3B;
@@ -110,7 +110,7 @@
     <WriteLinesToFile
       File="$(IndexFile)"
       Overwrite="true"
-      Lines="$(IndexLines.Replace('&lt;/head&gt;','    &lt;script src=&quot;$(ServiceWorkerRegisterFileName)&quot;&gt;&lt;/script&gt;%0D%0A&lt;/head&gt;'))"
+      Lines="$(IndexLines.Replace('&lt;/head&gt;','    &lt;script src=&quot;$(ServiceWorkerBaseUrl)$(ServiceWorkerRegisterFileName)&quot;&gt;&lt;/script&gt;%0D%0A&lt;/head&gt;'))"
       Condition="'$(IndexLines.Contains($(ServiceWorkerRegisterFileName)))'=='false'"
       />
 

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

@@ -28,6 +28,8 @@
 
     <!-- The "home route" url for the application -->
     <ServiceWorkerBaseUrl Condition="'$(ServiceWorkerBaseUrl)' == ''">/</ServiceWorkerBaseUrl>
+    <ServiceWorkerBaseUrl Condition="!'$(ServiceWorkerBaseUrl.StartsWith(/))'">/$(ServiceWorkerBaseUrl)</ServiceWorkerBaseUrl>
+    <ServiceWorkerBaseUrl Condition="!'$(ServiceWorkerBaseUrl.EndsWith(/))'">$(ServiceWorkerBaseUrl)/</ServiceWorkerBaseUrl>
 
     <!-- The CSB home page served up for the base URL -->
     <ProjectIndexPage Condition="'$(ProjectIndexPage)' == ''">index.html</ProjectIndexPage>

CHANGELOG.md

@@ -1,3 +1,13 @@
+#### 06/12/2019
+
+- PR #5 from @chucker merged with these changes
+- Bug: **Property** **`ManifestBaseUrl`** - used to specify the base Url in the manifest.json was not being used in the index `<head>` link for **manifest.json**
+- Bug: **Property** **`ServiceWorkerBaseUrl`** - used to specify the base Url in the ServiceWorker was not being used in the _required files_ list.
+- Bug: **Property** **`ServiceWorkerBaseUrl`** - used to specify the base Url in the ServiceWorker was not being used in the index `<head>` link for **ServiceWorker.js**
+- Also @SQL-MisterMagoo 
+- Added code to automatically add leading and trailing slashes to **Property** **`ManifestBaseUrl`** 
+- Added code to automatically add leading and trailing slashes to **Property** **`ServiceWorkerBaseUrl`** 
+ 
 #### 11/11/2019
 
 - Added new **Property** **`ServiceWorkerIgnoreHosts`** - used to prevent service worker installation on specific hosts e.g. localhost

README.md

@@ -21,13 +21,13 @@ I don't have a Mac, but I believe Safari does not prompt on desktop either.
 Install the nuget BlazorPWA.MsBuild
 
 #### Package Manager:
-`Install-Package BlazorPWA.MSBuild -Version 1.0.1`
+`Install-Package BlazorPWA.MSBuild -Version 1.0.2`
 
 #### .NET Cli:
-`dotnet add package BlazorPWA.MSBuild --version 1.0.1`
+`dotnet add package BlazorPWA.MSBuild --version 1.0.2`
 
 #### Package Reference
-`<PackageReference Include="BlazorPWA.MSBuild" Version="1.0.1"/>`
+`<PackageReference Include="BlazorPWA.MSBuild" Version="1.0.2"/>`
 
 ## Configuration
 
@@ -171,6 +171,40 @@ The service worker will not register itself when the `hostname` matches anything
 
 *Note: the single quotes around each hostname are required for now*
 
+### Handle different base Urls for different configurations
+
+Sample csproj file for two different base Urls
+
+``` XML
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <ManifestForce>true</ManifestForce>
+    <ServiceWorkerForce>true</ServiceWorkerForce>
+  </PropertyGroup>
+  
+  <PropertyGroup Condition="'$(Configuration)' == 'Release'">
+    <ServiceWorkerBaseUrl>prod</ServiceWorkerBaseUrl>
+    <ManifestBaseUrl>prod</ManifestBaseUrl>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
+    <ServiceWorkerBaseUrl>dev</ServiceWorkerBaseUrl>
+    <ManifestBaseUrl>dev</ManifestBaseUrl>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BlazorPWA.MSBuild" Version="1.0.1-beta20191206-002218">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+</Project>
+```
+This project file use **`ManifestForce`** and **`ServiceWorkerForce`** to ensure that the **manifest.json** and **ServiceWorker.js** files are rebuilt - otherwise they would not change when you changed configuration.
+
 ## Roadmap
 
 - [ ] At the moment, there is only one choice for caching strategy - Cache First/Network Fallback - I will add more (https://developers.google.com/web/ilt/pwa/introduction-to-progressive-web-app-architectures#caching_strategies_supported_by_sw-toolbox)