Update session sample and documentation (dotnet#1517)

Author: troydai

aspnet/fundamentals/app-state.rst

@@ -75,20 +75,19 @@ For example, some simple :doc:`middleware` could add something to the ``Items``
 .. code-block:: c#
 
   app.Use(async (context, next) =>
-    {
+  {
       // perform some verification
       context.Items["isVerified"] = true;
       await next.Invoke();
-    });
+  });
 
 and later in the pipeline, another piece of middleware could access it:
 
 .. code-block:: c#
 
   app.Run(async (context) =>
   {
-    await context.Response.WriteAsync("Verified request? "
-      + context.Items["isVerified"]);
+      await context.Response.WriteAsync("Verified request? " + context.Items["isVerified"]);
   });
 
 .. note:: Since keys into ``Items`` are simple strings, if you are developing middleware that needs to work across many applications, you may wish to prefix your keys with a unique identifier to avoid key collisions (e.g. "MyComponent.isVerified" instead of just "isVerified").
@@ -108,7 +107,7 @@ ASP.NET ships with several implementations of ``IDistributedCache``, including a
 
 .. code-block:: c#
 
-  services.AddCaching();
+  services.AddDistributedMemoryCache();
   services.AddSession();
 
 Then, add the following to ``Configure`` and you're ready to use session in your application code:
@@ -152,13 +151,15 @@ Once session is installed and configured, you refer to it via HttpContext, which
 
   public interface ISession
   {
-    Task LoadAsync();
-    Task CommitAsync();
-    bool TryGetValue(string key, out byte[] value);
-    void Set(string key, byte[] value);
-    void Remove(string key);
-    void Clear();
-    IEnumerable<string> Keys { get; }
+      bool IsAvailable { get; }
+      string Id { get; }
+      IEnumerable<string> Keys { get; }
+      Task LoadAsync();
+      Task CommitAsync();
+      bool TryGetValue(string key, out byte[] value);
+      void Set(string key, byte[] value);
+      void Remove(string key);
+      void Clear();
   }
 
 Because``Session`` is built on top of ``IDistributedCache``, you must always serialize the object instances being stored. Thus, the interface works with ``byte[]`` not simply ``object``. However, there are extension methods that make working with simple types such as ``String`` and ``Int32`` easier, as well as making it easier to get a byte[] value from session.
@@ -184,7 +185,7 @@ The associated sample application demonstrates how to work with Session, includi
   :language: c#
   :lines: 15-23
   :dedent: 8
-  :emphasize-lines: 3,5-8
+  :emphasize-lines: 2,6
 
 When you first navigate to the web server, it displays a screen indicating that no session has yet been established:
 
@@ -195,7 +196,7 @@ This default behavior is produced by the following middleware in *Startup.cs*, w
 .. literalinclude:: app-state/sample/src/AppState/Startup.cs
   :linenos:
   :language: c#
-  :lines: 75-103
+  :lines: 77-107
   :dedent: 12
   :emphasize-lines: 4,6,8-11,28-29
 
@@ -204,23 +205,21 @@ This default behavior is produced by the following middleware in *Startup.cs*, w
 .. literalinclude:: app-state/sample/src/AppState/Model/RequestEntry.cs
   :linenos:
   :language: c#
-  :lines: 5-10
+  :lines: 3-
   :dedent: 4
 
 .. literalinclude:: app-state/sample/src/AppState/Model/RequestEntryCollection.cs
   :linenos:
   :language: c#
-  :lines: 7-
+  :lines: 6-
   :dedent: 4
 
-.. note:: The types that are to be stored in session must be marked with ``[Serializable]``.
-
 Fetching the current instance of ``RequestEntryCollection`` is done via the ``GetOrCreateEntries`` helper method:
 
 .. literalinclude:: app-state/sample/src/AppState/Startup.cs
   :linenos:
   :language: c#
-  :lines: 107-122
+  :lines: 109-124
   :dedent: 8
   :emphasize-lines: 4,8-9
 
@@ -239,7 +238,7 @@ Establishing the session is done in the middleware that handles requests to "/se
 .. literalinclude:: app-state/sample/src/AppState/Startup.cs
   :linenos:
   :language: none
-  :lines: 54-73
+  :lines: 56-75
   :dedent: 12
   :emphasize-lines: 2,8-14
 
@@ -248,7 +247,7 @@ Requests to this path will get or create a ``RequestEntryCollection``, will add
 .. literalinclude:: app-state/sample/src/AppState/Startup.cs
   :linenos:
   :language: c#
-  :lines: 124-130
+  :lines: 126-132
   :dedent: 8
   :emphasize-lines: 6
 
@@ -259,7 +258,7 @@ The sample includes one more piece of middleware worth mentioning, which is mapp
 .. literalinclude:: app-state/sample/src/AppState/Startup.cs
   :linenos:
   :language: c#
-  :lines: 40-53
+  :lines: 42-54
   :dedent: 12
   :emphasize-lines: 2,13
 

aspnet/fundamentals/app-state/sample/global.json

@@ -1,6 +1,3 @@
 {
-  "projects": [ "src", "test" ],
-  "sdk": {
-    "version": "1.0.0-rc1-final"
-  }
+  "projects": [ "src", "test" ]
 }

aspnet/fundamentals/app-state/sample/src/AppState/Model/RequestEntry.cs

@@ -1,8 +1,5 @@
-using System;
-
-namespace AppState.Model
+namespace AppState.Model
 {
-    
     public class RequestEntry
     {
         public string Path { get; set; }

aspnet/fundamentals/app-state/sample/src/AppState/Model/RequestEntryCollection.cs

@@ -1,5 +1,4 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 
 namespace AppState.Model

aspnet/fundamentals/app-state/sample/src/AppState/Program.cs

@@ -0,0 +1,18 @@
+using System.IO;
+using Microsoft.AspNetCore.Hosting;
+
+namespace AppState
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            var host = new WebHostBuilder().UseKestrel()
+                                           .UseContentRoot(Directory.GetCurrentDirectory())
+                                           .UseStartup<Startup>()
+                                           .Build();
+
+            host.Run();
+        }
+    }
+}

aspnet/fundamentals/app-state/sample/src/AppState/Startup.cs

@@ -1,39 +1,41 @@
 using System;
-using Microsoft.AspNet.Builder;
-using Microsoft.AspNet.Http;
+using AppState.Model;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using AppState.Model;
-using Microsoft.AspNet.Hosting;
 using Newtonsoft.Json;
 
 namespace AppState
 {
     public class Startup
     {
-        // For more information on how to configure your application, visit http://go.microsoft.com/fwlink/?LinkID=398940
         public void ConfigureServices(IServiceCollection services)
         {
-            services.AddCaching();
+            services.AddDistributedMemoryCache();
 
             services.AddSession(options =>
             {
                 options.IdleTimeout = TimeSpan.FromSeconds(10);
             });
         }
 
-        public void Configure(IApplicationBuilder app, 
-            IHostingEnvironment env, 
-            ILoggerFactory loggerFactory)
+        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
         {
-            loggerFactory.MinimumLevel = LogLevel.Debug;
             loggerFactory.AddConsole(LogLevel.Debug);
-            app.UseIISPlatformHandler();
+
             if (env.IsDevelopment())
             {
                 app.UseDeveloperExceptionPage();
             }
 
+            app.Use(async (context, next) =>
+            {
+                context.Items["entry_time"] = DateTime.Now;
+                await next.Invoke();
+            });
+
             // don't count favicon requests
             app.Map("/favicon.ico", ignore => { });
 
@@ -43,7 +45,7 @@ public void Configure(IApplicationBuilder app,
                 subApp.Run(async context =>
                 {
                     await context.Response.WriteAsync("<html><body>");
-                    await context.Response.WriteAsync("Requested at: " + DateTime.Now.ToString() + "<br>");
+                    await context.Response.WriteAsync("Requested at: " + DateTime.Now.ToString("hh:mm:ss.ffff") + "<br>");
                     await context.Response.WriteAsync("This part of the application isn't referencing Session...<br><a href=\"/\">Return</a>");
                     await context.Response.WriteAsync("</body></html>");
                 });
@@ -65,10 +67,10 @@ public void Configure(IApplicationBuilder app,
                     {
                         context.Session.SetString("StartTime", DateTime.Now.ToString());
                     }
+
                     await context.Response.WriteAsync("<html><body>");
                     await context.Response.WriteAsync($"Counting: You have made {collection.TotalCount()} requests to this application.<br><a href=\"/\">Return</a>");
                     await context.Response.WriteAsync("</body></html>");
-
                 });
             });
 
@@ -128,8 +130,5 @@ private void SaveEntries(HttpContext context, RequestEntryCollection collection)
 
             context.Session.Set("RequestEntries", serializedResult);
         }
-
-        // Entry point for the application.
-        public static void Main(string[] args) => Microsoft.AspNet.Hosting.WebApplication.Run<Startup>(args);
     }
 }

aspnet/fundamentals/app-state/sample/src/AppState/project.json

@@ -1,33 +1,31 @@
 {
-  "webroot": "wwwroot",
-  "version": "1.0.0-*",
-
-  "dependencies": {
-    "Microsoft.AspNet.Diagnostics": "1.0.0-rc1-final",
-    "Microsoft.AspNet.IISPlatformHandler": "1.0.0-rc1-final",
-    "Microsoft.AspNet.Server.Kestrel": "1.0.0-rc1-final",
-    "Microsoft.AspNet.Session": "1.0.0-rc1-final",
-    "Microsoft.Extensions.Caching.Memory": "1.0.0-rc1-final",
-    "Microsoft.Extensions.Logging": "1.0.0-rc1-final",
-    "Microsoft.Extensions.Logging.Console": "1.0.0-rc1-final",
-    "Newtonsoft.Json": "7.0.1"
+  "buildOptions": {
+    "emitEntryPoint": true
   },
-
-  "commands": {
-    "web": "Microsoft.AspNet.Server.Kestrel"
+  "dependencies": {
+    "Microsoft.AspNetCore.Server.IISIntegration": "1.0.0",
+    "Microsoft.AspNetCore.Diagnostics": "1.0.0",
+    "Microsoft.AspNetCore.Server.Kestrel": "1.0.0",
+    "Microsoft.AspNetCore.Session": "1.0.0",
+    "Microsoft.Extensions.Caching.Memory": "1.0.0",
+    "Microsoft.Extensions.Logging": "1.0.0",
+    "Microsoft.Extensions.Logging.Console": "1.0.0",
+    "Newtonsoft.Json": "9.0.1"
   },
-
   "frameworks": {
-    "dnx451": { },
-    "dnxcore50": { }
+    "net451": {},
+    "netcoreapp1.0": {
+      "dependencies": {
+        "Microsoft.NETCore.App": {
+          "version": "1.0.0",
+          "type": "platform"
+        }
+      }
+    }
   },
-
-  "exclude": [
-    "wwwroot",
-    "node_modules"
-  ],
-  "publishExclude": [
-    "**.user",
-    "**.vspscc"
-  ]
-}
+  "publishOptions": {
+    "include": [
+      "wwwroot"
+    ]
+  }
+}