From ae23f7c7bc956d40040c7a7a45aa2dedd293ebc4 Mon Sep 17 00:00:00 2001
From: Praburaj <praburaj.t@microsoft.com>
Date: Mon, 2 Mar 2015 16:38:38 -0800
Subject: [PATCH] Adding a feature to get the traceidentifier for a request

Addresses : https://github.com/aspnet/HttpAbstractions/issues/117

Related changes in Helios & weblistener in separate PRs.
---
 .../IRequestIdentifierFeature.cs              | 18 ++++++++++++++++++
 src/Microsoft.AspNet.Owin/OwinConstants.cs    |  8 ++++++++
 src/Microsoft.AspNet.Owin/OwinEnvironment.cs  |  7 +++++--
 .../OwinFeatureCollection.cs                  | 19 ++++++++++++++++++-
 4 files changed, 49 insertions(+), 3 deletions(-)
 create mode 100644 src/Microsoft.AspNet.Http.Interfaces/IRequestIdentifierFeature.cs

diff --git a/src/Microsoft.AspNet.Http.Interfaces/IRequestIdentifierFeature.cs b/src/Microsoft.AspNet.Http.Interfaces/IRequestIdentifierFeature.cs
new file mode 100644
index 00000000..642dca12
--- /dev/null
+++ b/src/Microsoft.AspNet.Http.Interfaces/IRequestIdentifierFeature.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+
+namespace Microsoft.AspNet.Http.Interfaces
+{
+    /// <summary>
+    /// Feature to identify a request.
+    /// </summary>
+    public interface IRequestIdentifierFeature
+    {
+        /// <summary>
+        /// Identifier to trace a request.
+        /// </summary>
+        Guid TraceIdentifier { get; }
+    }
+}
diff --git a/src/Microsoft.AspNet.Owin/OwinConstants.cs b/src/Microsoft.AspNet.Owin/OwinConstants.cs
index b86dfc1a..98ed1c42 100644
--- a/src/Microsoft.AspNet.Owin/OwinConstants.cs
+++ b/src/Microsoft.AspNet.Owin/OwinConstants.cs
@@ -20,6 +20,14 @@ internal static class OwinConstants
 
         #endregion
 
+        #region OWIN v1.1.0 - 3.2.1 Request Data
+
+        // OWIN 1.1.0 http://owin.org/html/owin.html
+
+        public const string RequestId = "owin.RequestId";
+
+        #endregion
+
         #region OWIN v1.0.0 - 3.2.2. Response Data
 
         // http://owin.org/spec/owin-1.0.0.html
diff --git a/src/Microsoft.AspNet.Owin/OwinEnvironment.cs b/src/Microsoft.AspNet.Owin/OwinEnvironment.cs
index f64f2743..7e17a7d1 100644
--- a/src/Microsoft.AspNet.Owin/OwinEnvironment.cs
+++ b/src/Microsoft.AspNet.Owin/OwinEnvironment.cs
@@ -80,7 +80,7 @@ public OwinEnvironment(HttpContext context)
                 { OwinConstants.Security.User, new FeatureMap<IHttpAuthenticationFeature>(feature => feature.User,
                     ()=> null, (feature, value) => feature.User = Utilities.MakeClaimsPrincipal((IPrincipal)value),
                     () => new HttpAuthenticationFeature())
-                },
+                }
             };
 
             // owin.CallCancelled is required but the feature may not be present.
@@ -113,6 +113,9 @@ public OwinEnvironment(HttpContext context)
             }
 
             _context.Items[typeof(HttpContext).FullName] = _context; // Store for lookup when we transition back out of OWIN
+
+            // The request identifier is a string per the spec.
+            _entries[OwinConstants.RequestId] = new FeatureMap<IRequestIdentifierFeature>(feature => feature.TraceIdentifier.ToString());
         }
 
         // Public in case there's a new/custom feature interface that needs to be added.
@@ -369,7 +372,7 @@ public FeatureMap(Func<TFeature, object> getter, Action<TFeature, object> setter
             }
 
             public FeatureMap(Func<TFeature, object> getter, Func<object> defaultFactory, Action<TFeature, object> setter)
-                : base(typeof(TFeature), feature => getter((TFeature)feature), defaultFactory,(feature, value) => setter((TFeature)feature, value))
+                : base(typeof(TFeature), feature => getter((TFeature)feature), defaultFactory, (feature, value) => setter((TFeature)feature, value))
             {
             }
 
diff --git a/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs b/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs
index 11d5892c..af443bcc 100644
--- a/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs
+++ b/src/Microsoft.AspNet.Owin/OwinFeatureCollection.cs
@@ -32,7 +32,8 @@ public class OwinFeatureCollection :
         IHttpRequestLifetimeFeature,
         IHttpAuthenticationFeature,
         IHttpWebSocketFeature,
-        IOwinEnvironmentFeature
+        IOwinEnvironmentFeature,
+        IRequestIdentifierFeature
     {
         public IDictionary<string, object> Environment { get; set; }
         private bool _headersSent;
@@ -427,6 +428,22 @@ public bool IsReadOnly
             get { return true; }
         }
 
+        Guid IRequestIdentifierFeature.TraceIdentifier
+        {
+            get
+            {
+                var requestId = Prop<string>(OwinConstants.RequestId);
+                Guid requestIdentifier;
+
+                if (requestId != null && Guid.TryParse(requestId, out requestIdentifier))
+                {
+                    return requestIdentifier;
+                }
+
+                return Guid.Empty;
+            }
+        }
+
         public bool Remove(KeyValuePair<Type, object> item)
         {
             throw new NotSupportedException();