v.3.2 - added .vue file caching

Author: jesperhoy

README.md

@@ -81,11 +81,13 @@ The really cool part about in-line templates is that they can include ASP.NET We
 </vue:Component>        
 ```
 
-## When to use in-line vs. .vue files?
+## .vue files vs. in-line templates
 
-If you need to include server rendered data inside the Vue template (see above), then in-line is the only option.
+If you need to include server rendered data inside the Vue template with `<%...%>` tags (see above), then an in-line template is the only option.
 
-Otherwise, the easiest way is to start in-line. Then at some point when the page becomes too big, it is easy to copy the content of each component/app control to separate (.vue) file.
+Otherwise, the easiest way is to start with in-line templates. Then at some point when the page becomes too big, it is easy to copy the content of each component/app control to separate (.vue) file.
+
+Note: When using .vue files, the JavaScript output is cached between requests (involved .vue files including component imports are monitored for changes). This means that for the first request, using .vue files will be slower than in-line templates because the files(s) have to be loaded from disc. But for subsequent requests, .vue files will be faster than in-line templates because the template processing is already done.
 
 
 ## Web Forms controls 

sample-web-site/Bin/VueJSWebForms.dll

@@ -9,7 +9,7 @@ Friend Module Module1
       If content.Length = 0 Then Throw New Exception("Template is empty")
       If content.StartsWith("<template>", StringComparison.InvariantCultureIgnoreCase) Then
         If Not String.IsNullOrEmpty(prpOptions) Then Throw New Exception("Control cannot have 'Options' property when content starts with <template>")
-        Return "(" & VueFilesToJS.CompileText(content, ctx.Server.MapPath("~/"), ctx.Request.Url.AbsolutePath, prpsquashWS) & ")()"
+        Return "(" & VueFilesToJS.Compile(ctx.Server.MapPath("~/"), ctx.Request.Url.AbsolutePath, prpsquashWS, content) & ")()"
       Else
         prpOptions = If(prpOptions, "").Trim
         If prpOptions.Length = 0 Then prpOptions = "{}"
@@ -19,12 +19,26 @@ Friend Module Module1
                   "template:" & VueFilesToJS.JSStringEncode(content) & "," &
                   prpOptions.Substring(1)
       End If
+    End If
+
+    REM .vue File
+    If content.Length > 0 Then Throw New Exception("Control cannot have content when used with 'File' property")
+    If Not String.IsNullOrEmpty(prpOptions) Then Throw New Exception("Control cannot both 'File' and 'Options' properties")
+
+    'If Not useCache Then Return "(" & VueFilesToJS.Compile(ctx.Server.MapPath("~/"), prpFile, prpsquashWS) & ")()"
+
+    Dim f As String
+    Dim CacheKey = "VueJSWebForm:" & ctx.Request.MapPath(prpFile)
+    Dim obj = ctx.Cache.Get(CacheKey)
+    If obj Is Nothing Then
+      Dim FileList As New List(Of String)
+      f = VueFilesToJS.Compile(ctx.Server.MapPath("~/"), prpFile, prpsquashWS, Nothing, AddressOf FileList.Add)
+      ctx.Cache.Add(CacheKey, f, New Web.Caching.CacheDependency(FileList.ToArray), Web.Caching.Cache.NoAbsoluteExpiration, Web.Caching.Cache.NoSlidingExpiration, Web.Caching.CacheItemPriority.Normal, Nothing)
     Else
-      REM .vue File
-      If content.Length > 0 Then Throw New Exception("Control cannot have content when used with 'File' property")
-      If Not String.IsNullOrEmpty(prpOptions) Then Throw New Exception("Control cannot both 'File' and 'Options' properties")
-      Return "(" & VueFilesToJS.Compile(ctx.Server.MapPath("~/"), prpFile, prpsquashWS) & ")()"
+      f = DirectCast(obj, String)
     End If
+
+    Return "(" & f & ")()"
   End Function
 
 End Module

src/Module1.vb

@@ -31,5 +31,5 @@ Imports System.Runtime.InteropServices
 ' by using the '*' as shown below:
 ' <Assembly: AssemblyVersion("1.0.*")>
 
-<Assembly: AssemblyVersion("3.1.1.0")>
-<Assembly: AssemblyFileVersion("3.1.1.0")>
+<Assembly: AssemblyVersion("3.2.0.0")>
+<Assembly: AssemblyFileVersion("3.2.0.0")>

src/My Project/AssemblyInfo.vb

@@ -2,25 +2,20 @@
   Private Components As New Dictionary(Of String, Component)
   Private WsRoot As String
   Private SquashWS As Boolean
+  Private FileReadCallback As Action(Of String) = Nothing
 
-  Public Shared Function Compile(wsRootPath As String, vueFile As String, Optional squashWS As Boolean = True) As String
+  Public Shared Function Compile(wsRootPath As String, sourceFile As String, Optional squashWS As Boolean = True, Optional rootFileContent As String = Nothing, Optional fileReadCallback As Action(Of String) = Nothing) As String
     If wsRootPath.EndsWith("\") Then wsRootPath = wsRootPath.Substring(0, wsRootPath.Length - 1)
-    Dim inst = New VueFilesToJS With {.WsRoot = wsRootPath, .SquashWS = squashWS}
-    Return inst.ProcRoot(vueFile, AddressOf My.Computer.FileSystem.ReadAllText)
-  End Function
-
-  Public Shared Function CompileText(txt As String, wsRootPath As String, vueFile As String, Optional squashWS As Boolean = True) As String
-    If wsRootPath.EndsWith("\") Then wsRootPath = wsRootPath.Substring(0, wsRootPath.Length - 1)
-    Dim inst = New VueFilesToJS With {.WsRoot = wsRootPath, .SquashWS = squashWS}
-    Return inst.ProcRoot(vueFile, Function(fn) txt)
+    Dim inst = New VueFilesToJS With {.WsRoot = wsRootPath, .SquashWS = squashWS, .FileReadCallback = fileReadCallback}
+    Return inst.ProcRoot(sourceFile, rootFileContent)
   End Function
 
   Private Sub New()
     REM private constructor so only Compile function can create instance
   End Sub
 
-  Private Function ProcRoot(vueFile As String, loadFile As Func(Of String, String)) As String
-    Dim res = ParseVueFile(vueFile, Nothing, loadFile)
+  Private Function ProcRoot(vueFile As String, FileContent As String) As String
+    Dim res = ParseVueFile(vueFile, Nothing, FileContent)
 
     Dim sb As New System.Text.StringBuilder
     sb.AppendLine("function() {")
@@ -38,10 +33,16 @@
   End Function
 
   'wsroot = "c:\web-sites\tjek" (no ending \)
-  Private Function ParseVueFile(vueFile As String, fromComp As Component, loadFile As Func(Of String, String)) As ParseVueFileResult
+  Private Function ParseVueFile(vueFile As String, fromComp As Component, Optional fileContent As String = Nothing) As ParseVueFileResult
     Dim cp = ResolvePath(vueFile)
     Dim vfWin = WsRoot & cp.Replace("/", "\") & JustFN(vueFile)
-    Dim x = loadFile(vfWin).Trim
+    Dim x As String
+    If fileContent Is Nothing Then
+      If FileReadCallback IsNot Nothing Then FileReadCallback(vfWin)
+      x = My.Computer.FileSystem.ReadAllText(vfWin).Trim
+    Else
+      x = fileContent.Trim
+    End If
 
     If Not x.EndsWith("</script>") Then Throw New Exception(".vue file '" & vueFile & "' does not end with </script>")
     x = x.Substring(0, x.Length - 9).Trim
@@ -171,7 +172,7 @@
     c = New Component With {.Name = compName, .File = vueFile}
     If parentComp IsNot Nothing Then parentComp.SubComps.Add(c)
     Components.Add(compName, c)
-    c.pvfr = ParseVueFile(vueFile, c, AddressOf My.Computer.FileSystem.ReadAllText)
+    c.pvfr = ParseVueFile(vueFile, c)
   End Sub
 
   Private Class Component