Further Code Review fixes: strong signing, moved MemoryFileCache, documentation

Author: Marcin Drobik

src/React.Owin/JsxFileMiddleware.cs

@@ -28,14 +28,19 @@ static JsxFileMiddleware()
             Initializer.Initialize(_ => _);
         }
 
+        /// <summary>
+        /// Creates a new instance of the JsxFileMiddleware.
+        /// </summary>
+        /// <param name="next">The next middleware in the pipeline.</param>
+        /// <param name="options">The configuration options.</param>
         public JsxFileMiddleware(Func<IDictionary<string, object>, Task> next, JsxFileOptions options)
         {
             if (next == null)
                 throw new ArgumentNullException("next");
 
             // Default values
             options = options ?? new JsxFileOptions();
-            var extenstions = (options.Extensions == null || !options.Extensions.Any()) ? new[] { ".jsx" } : options.Extensions;
+            var extensions = (options.Extensions == null || !options.Extensions.Any()) ? new[] { ".jsx", ".js" } : options.Extensions;
             var fileOptions = options.StaticFileOptions ?? new StaticFileOptions();
 
             // Wrap the file system with JSX file system
@@ -49,10 +54,15 @@ public JsxFileMiddleware(Func<IDictionary<string, object>, Task> next, JsxFileOp
                     OnPrepareResponse = fileOptions.OnPrepareResponse,
                     RequestPath = fileOptions.RequestPath,
                     ServeUnknownFileTypes = fileOptions.ServeUnknownFileTypes,
-                    FileSystem = new JsxFileSystem(reactEnvironment.JsxTransformer, fileOptions.FileSystem, extenstions)
+                    FileSystem = new JsxFileSystem(reactEnvironment.JsxTransformer, fileOptions.FileSystem, extensions)
                 });
         }
 
+        /// <summary>
+        /// Processes a request to determine if it matches a known JSX file, and if so, serves it compiled to JavaScript.
+        /// </summary>
+        /// <param name="environment">OWIN environment dictionary which stores state information about the request, response and relevant server state.</param>
+        /// <returns/>
         public Task Invoke(IDictionary<string, object> environment)
         {
             return _internalStaticMiddleware.Invoke(environment);

src/React.Owin/JsxFileOptions.cs

@@ -19,7 +19,7 @@ namespace React.Owin
     public class JsxFileOptions
     {
         /// <summary>
-        /// Collection of extensions that will be treated as JSX files. Defaults to ".jsx".
+        /// Collection of extensions that will be treated as JSX files. Defaults to ".jsx" and ".js".
         /// </summary>
         public IEnumerable<string> Extensions { get; set; }
 

src/React.Owin/JsxFileSystem.cs

@@ -24,20 +24,20 @@ internal class JsxFileSystem : Microsoft.Owin.FileSystems.IFileSystem
     {
         private readonly IJsxTransformer _transformer;
         private readonly Microsoft.Owin.FileSystems.IFileSystem _physicalFileSystem;
-        private readonly string[] _extenstions;
+        private readonly string[] _extensions;
 
-        public JsxFileSystem(IJsxTransformer transformer, string root, IEnumerable<string> extenstions)
-            : this(transformer, new PhysicalFileSystem(root), extenstions)
+        public JsxFileSystem(IJsxTransformer transformer, string root, IEnumerable<string> extensions)
+            : this(transformer, new PhysicalFileSystem(root), extensions)
         {            
         }
 
-        public JsxFileSystem(IJsxTransformer transformer, Microsoft.Owin.FileSystems.IFileSystem fileSystem, IEnumerable<string> extenstions)
+        public JsxFileSystem(IJsxTransformer transformer, Microsoft.Owin.FileSystems.IFileSystem fileSystem, IEnumerable<string> extensions)
         {
             _transformer = transformer;
             _physicalFileSystem = fileSystem;
 
             // Make sure the extensions start with dot
-            _extenstions = extenstions.Select(extenstion => extenstion.StartsWith(".") ? extenstion : "." + extenstion).ToArray();
+            _extensions = extensions.Select(extension => extension.StartsWith(".") ? extension : "." + extension).ToArray();
         }
 
         public bool TryGetFileInfo(string subpath, out IFileInfo fileInfo)
@@ -48,7 +48,7 @@ public bool TryGetFileInfo(string subpath, out IFileInfo fileInfo)
             if (!_physicalFileSystem.TryGetFileInfo(subpath, out internalFileInfo))
                 return false;
 
-            if (internalFileInfo.IsDirectory || !_extenstions.Any(internalFileInfo.Name.EndsWith))
+            if (internalFileInfo.IsDirectory || !_extensions.Any(internalFileInfo.Name.EndsWith))
                 return false;
 
             fileInfo = new JsxFileInfo(_transformer, internalFileInfo);

src/React.Owin/MemoryFileCache.cs

@@ -17,7 +17,7 @@
     <DebugSymbols>true</DebugSymbols>
     <DebugType>full</DebugType>
     <Optimize>false</Optimize>
-    <OutputPath>bin\Debug\</OutputPath>
+    <OutputPath>..\..\bin\Debug\React.Owin\</OutputPath>
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
@@ -27,7 +27,7 @@
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
-    <OutputPath>bin\Release\</OutputPath>
+    <OutputPath>..\..\bin\Release\React.Owin\</OutputPath>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
@@ -39,6 +39,9 @@
   <PropertyGroup>
     <AssemblyOriginatorKeyFile>..\Key.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>
+  <PropertyGroup>
+    <SignAssembly>true</SignAssembly>
+  </PropertyGroup>
   <ItemGroup>
     <Reference Include="Microsoft.Owin, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
@@ -69,7 +72,6 @@
     </Compile>
     <Compile Include="AssemblyRegistration.cs" />
     <Compile Include="EntryAssemblyFileSystem.cs" />
-    <Compile Include="MemoryFileCache.cs" />
     <Compile Include="JsxFileMiddleware.cs" />
     <Compile Include="JsxFileExtensions.cs" />
     <Compile Include="JsxFileOptions.cs" />

src/React.Owin/React.Owin.csproj

@@ -0,0 +1,82 @@
+/*
+ *  Copyright (c) 2014-2015, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant 
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.Caching;
+
+namespace React
+{
+    /// <summary>
+    /// Memory cache implementation for React.ICache. Uses System.Runtime.Caching.
+    /// </summary>
+    public class MemoryFileCache : ICache
+    {
+        private readonly ObjectCache _cache;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="MemoryFileCache"/> class.
+        /// </summary>		
+        public MemoryFileCache()
+        {
+            _cache = MemoryCache.Default;
+        }
+
+        /// <summary>
+        /// Get an item from the cache. Returns <paramref name="fallback"/> if the item does
+        /// not exist.
+        /// </summary>
+        /// <typeparam name="T">Type of data</typeparam>
+        /// <param name="key">The cache key</param>
+        /// <param name="fallback">Value to return if item is not in the cache</param>
+        /// <returns>Data from cache, otherwise <paramref name="fallback"/></returns>
+        public T Get<T>(string key, T fallback = default(T))
+        {
+            return (T)(_cache.Get(key) ?? fallback);
+        }
+
+        /// <summary>
+        /// Sets an item in the cache.
+        /// </summary>
+        /// <typeparam name="T">Type of data</typeparam>
+        /// <param name="key">The cache key</param>
+        /// <param name="data">Data to cache</param>
+        /// <param name="slidingExpiration">
+        /// Sliding expiration, if cache key is not accessed in this time period it will 
+        /// automatically be removed from the cache
+        /// </param>
+        /// <param name="cacheDependencyFiles">
+        /// Filenames this cached item is dependent on. If any of these files change, the cache
+        /// will be cleared automatically
+        /// </param>
+        /// <param name="cacheDependencyKeys">
+        /// Other cache keys this cached item is dependent on. If any of these keys change, the
+        /// cache will be cleared automatically
+        /// </param>
+        public void Set<T>(string key, T data, TimeSpan slidingExpiration, IEnumerable<string> cacheDependencyFiles = null, IEnumerable<string> cacheDependencyKeys = null)
+        {
+            if (data == null)
+            {
+                _cache.Remove(key);
+                return;
+            }
+
+            var policy = new CacheItemPolicy { SlidingExpiration = slidingExpiration };
+
+            if (cacheDependencyFiles != null && cacheDependencyFiles.Any())
+                policy.ChangeMonitors.Add(new HostFileChangeMonitor(cacheDependencyFiles.ToList()));
+
+            if (cacheDependencyKeys != null && cacheDependencyKeys.Any())
+                policy.ChangeMonitors.Add(_cache.CreateCacheEntryChangeMonitor(cacheDependencyKeys));
+
+            _cache.Set(key, data, policy);
+        }
+    }
+}

src/React/MemoryFileCache.cs

@@ -78,6 +78,7 @@
     <Reference Include="System.Configuration" />
     <Reference Include="System.Core" />
     <Reference Include="Microsoft.CSharp" />
+    <Reference Include="System.Runtime.Caching" />
   </ItemGroup>
   <ItemGroup>
     <Compile Include="..\SharedAssemblyInfo.cs">
@@ -90,6 +91,7 @@
     <Compile Include="Exceptions\ReactScriptLoadException.cs" />
     <Compile Include="Exceptions\ReactServerRenderingException.cs" />
     <Compile Include="JavaScriptWithSourceMap.cs" />
+    <Compile Include="MemoryFileCache.cs" />
     <Compile Include="SourceMap.cs" />
     <Compile Include="SystemEnvironmentUtils.cs" />
     <Compile Include="Exceptions\JsxUnsupportedEngineException.cs" />