Updated to Version 1.41 with razorEngine 3.9.3 and Template-Caching

Author: BeniGemperle

.gitignore

@@ -154,3 +154,6 @@ $RECYCLE.BIN/
 
 # Mac desktop service store files
 .DS_Store
+
+.vs
+packages/

Description.txt

@@ -1,7 +1,7 @@
 Group: Misc
 FriendlyName: Razor MessageService
 SystemName: ToSIC.RazorMessageService
-Version: 1.40
+Version: 1.41
 SupportedVersions: 3.80
 Author: 2sic Internet Solutions
 DisplayOrder: 1

Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.4.0.0")]
-[assembly: AssemblyFileVersion("1.4.0.0")]
+[assembly: AssemblyVersion("1.4.1.0")]
+[assembly: AssemblyFileVersion("1.4.1.0")]

README.md

@@ -106,6 +106,11 @@ How to Install
 
 Version
 ----
+###1.41
+* Updated to RazorEngine 3.9.3
+* Improved Performance with TemplateCaching. First use of a Mail-Template might take up to 2 Seconds to compile. But afterward no more recompilation is needed. Updating the mail template will cause a re-compilation.
+* Works with nopCommerce 3.80
+
 ###1.40
 * Works with nopCommerce 3.80
 

RazorWorkflowMessageService.cs

@@ -16,7 +16,12 @@
 using Nop.Services.Events;
 using Nop.Services.Localization;
 using Nop.Services.Stores;
-using Nop.Services.Messages;    // customized
+using Nop.Services.Messages;
+// customized
+using RazorEngine;
+using RazorEngine.Templating;
+using System.Security.Cryptography;
+using System.Text;
 
 namespace ToSic.Nop.Plugins.RazorMessageService
 {
@@ -89,27 +94,30 @@ protected virtual int SendNotification(MessageTemplate messageTemplate,
 			var subject = messageTemplate.GetLocalized(mt => mt.Subject, languageId);
 			var body = messageTemplate.GetLocalized(mt => mt.Body, languageId);
 
-			//Replace subject and body tokens 
-			var subjectReplaced = _tokenizer.Replace(subject, tokens, false);
-			var bodyReplaced = _tokenizer.Replace(body, tokens, true);
-
 			#region Customized
+			// Run Razor befor tokenizer to prevent unneded recompilation of the Razor-Template which would be very resource intensive
+
 			// Razor-Parse Subject
 			bool subjectSuccess;
-			var subjectParsed = RazorParseSafe(subjectReplaced, razorModel, out subjectSuccess);
+			var subjectRazorParsed = RazorParseSafe(messageTemplate.Id, subject, razorModel, out subjectSuccess);
 			if (subjectSuccess)
-				subjectReplaced = subjectParsed;
+				subject = subjectRazorParsed;
 			else
-				subjectReplaced += subjectParsed;
+				subject += subjectRazorParsed; // in case of an error, append the error-text returned
+
 			// Razor-Parse Body
 			bool bodySuccess;
-			var bodyParsed = RazorParseSafe(bodyReplaced, razorModel, out bodySuccess);
+			var bodyRazorParsed = RazorParseSafe(messageTemplate.Id, body, razorModel, out bodySuccess);
 			if (bodySuccess)
-				bodyReplaced = bodyParsed;
+				body = bodyRazorParsed;
 			else
-				bodyReplaced += bodyParsed;
+				body += bodyRazorParsed; // in case of an error, append the error-text returned
 			#endregion
 
+			//Replace subject and body tokens 
+			var subjectReplaced = _tokenizer.Replace(subject, tokens, false);
+			var bodyReplaced = _tokenizer.Replace(body, tokens, true);
+
 			var email = new QueuedEmail
 			{
 				Priority = QueuedEmailPriority.High,
@@ -137,15 +145,38 @@ protected virtual int SendNotification(MessageTemplate messageTemplate,
 		}
 
 		#region Customized
+
+		/// <summary>
+		/// work arounf MD5 has for razorengine caching.
+		/// </summary>
+		/// <param name="input"></param>
+		/// <returns></returns>
+		private static string GetMd5Hash(string input)
+		{
+			var md5 = MD5.Create();
+			var inputBytes = System.Text.Encoding.ASCII.GetBytes(input);
+			var hash = md5.ComputeHash(inputBytes);
+			var sb = new StringBuilder();
+			foreach (byte t in hash)
+			{
+				sb.Append(t.ToString("X2"));
+			}
+
+			return sb.ToString();
+		}
+
 		/// <summary>
 		/// Parse text with Razor and handle Template Exception
 		/// </summary>
-		private static string RazorParseSafe(string text, object model, out bool success)
+		private static string RazorParseSafe(int templateId, string text, object model, out bool success)
 		{
 			string result;
 			try
 			{
-				result = RazorEngine.Razor.Parse(text, model);
+				var key = "MailTemplate" + templateId + GetMd5Hash(text);
+
+				result = Engine.Razor.RunCompile(text, key, model: model);
+
 				success = true;
 			}
 			catch (RazorEngine.Templating.TemplateCompilationException ex)
@@ -183,7 +214,7 @@ protected virtual EmailAccount GetEmailAccountOfMessageTemplate(MessageTemplate
 			if (emailAccountId == 0)
 				emailAccountId = messageTemplate.EmailAccountId;
 
-            var emailAccount = _emailAccountService.GetEmailAccountById(emailAccountId);
+			var emailAccount = _emailAccountService.GetEmailAccountById(emailAccountId);
 			if (emailAccount == null)
 				emailAccount = _emailAccountService.GetEmailAccountById(_emailAccountSettings.DefaultEmailAccountId);
 			if (emailAccount == null)

ToSic.Nop.Plugins.RazorMessageService.csproj

@@ -55,8 +55,8 @@
       <HintPath>..\nopCommerce_3.80_NoSource\bin\Nop.Services.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="RazorEngine">
-      <HintPath>packages\RazorEngine.3.6.1\lib\net45\RazorEngine.dll</HintPath>
+    <Reference Include="RazorEngine, Version=3.9.3.0, Culture=neutral, PublicKeyToken=9ee697374c7e744a, processorArchitecture=MSIL">
+      <HintPath>packages\RazorEngine.3.9.3\lib\net45\RazorEngine.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System" />

packages.config

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Microsoft.AspNet.Razor" version="3.0.0" targetFramework="net451" />
-  <package id="RazorEngine" version="3.6.1" targetFramework="net451" />
+  <package id="RazorEngine" version="3.9.3" targetFramework="net451" />
 </packages>