Implement external properties/soft-deleting features

npavlyk82 · npavlyk82 · commit e42358211e14 · 2025-02-07T15:11:34.000+02:00
diff --git a/src/Core/Token.cs b/src/Core/Token.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace Bewit
@@ -22,6 +23,12 @@ protected Token(string nonce, DateTime expirationDate)
 
         public DateTime ExpirationDate { get; private set; }
 
+        [JsonIgnore]
+        public bool? IsDeleted { get; set; } = false;
+
+        [JsonIgnore]
+        public Dictionary<string, string> ExtraProperties { get; set; }
+
         public static Token Create(string nonce, DateTime expirationDate)
         {
             if (string.IsNullOrWhiteSpace(nonce))
diff --git a/src/Extensions.HotChocolate/Generation/BewitMiddleware.cs b/src/Extensions.HotChocolate/Generation/BewitMiddleware.cs
@@ -23,7 +23,8 @@ public async Task InvokeAsync(
             if (context.Result is TPayload result)
             {
                 BewitToken<TPayload> bewit
-                    = await tokenGenerator.GenerateBewitTokenAsync(result, context.RequestAborted);
+                    = await tokenGenerator.GenerateBewitTokenAsync(
+                        result, context.RequestAborted, context.GetBewitTokenExtraProperties());
 
                 context.Result = (string)bewit;
             }
diff --git a/src/Extensions.HotChocolate/Generation/BewitTokenExtraPropertiesHelper.cs b/src/Extensions.HotChocolate/Generation/BewitTokenExtraPropertiesHelper.cs
@@ -0,0 +1,51 @@
+using System.Collections.Generic;
+using System.Linq;
+using HotChocolate.Resolvers;
+
+namespace Bewit.Extensions.HotChocolate.Generation;
+
+public static class BewitTokenExtraPropertiesHelper
+
+{
+    private const string ExtraPropertyPrefix = "BewitTokenExtraProperty:";
+
+    public static void AddBewitTokenExtraProperties(
+        this IResolverContext resolverContext, Dictionary<string, string> extraProperties)
+    {
+        if (extraProperties == null)
+        {
+            return;
+        }
+
+        resolverContext.ScopedContextData =
+             resolverContext.ScopedContextData.SetItems(
+                  extraProperties.ToDictionary(
+                      ctx => $"{ExtraPropertyPrefix}{ctx.Key}",
+                      ctx => (object)ctx.Value));
+    }
+
+    public static Dictionary<string, string> GetBewitTokenExtraProperties(this IMiddlewareContext context)
+    {
+        Dictionary<string, string> extraProperties = new Dictionary<string, string>();
+
+        foreach (var key in context.ScopedContextData.Keys)
+        {
+            if (!key.StartsWith(ExtraPropertyPrefix))
+            {
+                continue;
+            }
+
+            object extraPropertyValue = context.ScopedContextData.GetValueOrDefault(key);
+
+            if (extraPropertyValue != null)
+            {
+                extraProperties.Add(
+                    key.Substring(ExtraPropertyPrefix.Length),
+                    extraPropertyValue.ToString());
+            }
+        }
+
+        return extraProperties;
+    }
+
+}
diff --git a/src/Extensions.HotChocolate/Generation/BewitUrlMiddleware.cs b/src/Extensions.HotChocolate/Generation/BewitUrlMiddleware.cs
@@ -29,7 +29,7 @@ public async Task InvokeAsync(
 
                 BewitToken<string> bewit =
                     await tokenGenerator.GenerateBewitTokenAsync(
-                        uri.PathAndQuery, context.RequestAborted);
+                        uri.PathAndQuery, context.RequestAborted, context.GetBewitTokenExtraProperties());
 
                 var parametersToAdd = new Dictionary<string, string>
                 {
diff --git a/src/Generation/BewitTokenGenerator.cs b/src/Generation/BewitTokenGenerator.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Globalization;
 using System.Text;
 using System.Threading;
@@ -43,19 +44,23 @@ public BewitTokenGenerator(
 
         public Task<BewitToken<T>> GenerateBewitTokenAsync(
             T payload,
-            CancellationToken cancellationToken)
+            CancellationToken cancellationToken,
+            Dictionary<string, string> extraProperties = null)
         {
             var token = Token.Create(CreateNextToken(), CreateExpirationDate());
+            token.ExtraProperties = extraProperties;
             return GenerateBewitTokenImplAsync(payload, token, cancellationToken);
 
         }
 
         public Task<BewitToken<T>> GenerateIdentifiableBewitTokenAsync(
             T payload,
             string identifier,
-            CancellationToken cancellationToken)
+            CancellationToken cancellationToken,
+            Dictionary<string, string> extraProperties = null)
         {
             var token = new IdentifiableToken(identifier, CreateNextToken(), CreateExpirationDate());
+            token.ExtraProperties = extraProperties;
             return GenerateBewitTokenImplAsync(payload, token, cancellationToken);
         }
 
diff --git a/src/Generation/IBewitTokenGenerator.cs b/src/Generation/IBewitTokenGenerator.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -7,6 +8,7 @@ public interface IBewitTokenGenerator<T>
     {
         Task<BewitToken<T>> GenerateBewitTokenAsync(
             T payload,
-            CancellationToken cancellationToken);
+            CancellationToken cancellationToken,
+            Dictionary<string, string> extraProperties = null);
     }
 }
diff --git a/src/Generation/IIdentifiableBewitTokenGenerator.cs b/src/Generation/IIdentifiableBewitTokenGenerator.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -8,7 +9,8 @@ public interface IIdentifiableBewitTokenGenerator<T>
     Task<BewitToken<T>> GenerateIdentifiableBewitTokenAsync(
         T payload,
         string identifier,
-        CancellationToken cancellationToken);
+        CancellationToken cancellationToken,
+        Dictionary<string, string> extraProperties = null);
 
     Task InvalidateIdentifier(
         string identifier,
diff --git a/src/Storage.MongoDB/MongoNonceOptions.cs b/src/Storage.MongoDB/MongoNonceOptions.cs
@@ -26,5 +26,8 @@ public class MongoNonceOptions
         /// ReUse will keep it in the storage.
         /// </summary>
         public NonceUsage NonceUsage { get; set; } = NonceUsage.OneTime;
+
+
+        public int RecordExpireAfterDays { get; set; } = 365 * 2;
     }
 }
diff --git a/src/Storage.MongoDB/MongoNonceRepository.cs b/src/Storage.MongoDB/MongoNonceRepository.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 using MongoDB.Bson.Serialization;
@@ -27,6 +28,8 @@ static MongoNonceRepository()
             {
                 cm.MapIdMember(c => c.Nonce);
                 cm.MapField(c => c.ExpirationDate);
+                cm.MapField(c => c.IsDeleted);
+                cm.MapField(c => c.ExtraProperties);
                 cm.SetIgnoreExtraElements(true);
             });
         }
@@ -38,24 +41,51 @@ public MongoNonceRepository(IMongoDatabase database, MongoNonceOptions options)
 
             _collection.Indexes.CreateOne(new CreateIndexModel<Token>(
                 Builders<Token>.IndexKeys.Ascending(nameof(IdentifiableToken.Identifier))));
+
+            _collection.Indexes.CreateOne(new CreateIndexModel<Token>(
+                Builders<Token>.IndexKeys.Combine(
+                    Builders<Token>.IndexKeys.Ascending(nameof(Token.Nonce)),
+                    Builders<Token>.IndexKeys.Ascending(nameof(Token.IsDeleted)))));
+
+            _collection.Indexes.CreateOne(new CreateIndexModel<Token>(
+                Builders<Token>.IndexKeys.Ascending(nameof(Token.ExpirationDate)),
+                new CreateIndexOptions
+                {
+                    ExpireAfter = TimeSpan.FromDays(options.RecordExpireAfterDays)
+                }));
         }
 
         public async ValueTask InsertOneAsync(
             Token token, CancellationToken cancellationToken)
         {
+            if (token.ExtraProperties != null)
+            {
+                foreach (KeyValuePair<string, string> searchAttribute in token.ExtraProperties)
+                {
+                    _collection.Indexes.CreateOne(new CreateIndexModel<Token>(
+                        Builders<Token>.IndexKeys.Ascending($"{nameof(token.ExtraProperties)}.{searchAttribute.Key}")));
+                }
+            }
+
             await _collection.InsertOneAsync(token, cancellationToken: cancellationToken);
         }
 
         public async ValueTask<Token?> TakeOneAsync(
             string token,
             CancellationToken cancellationToken)
         {
-            FilterDefinition<Token> findFilter = Builders<Token>.Filter.Eq(n => n.Nonce, token);
+            FilterDefinition<Token> findFilter =
+                Builders<Token>.Filter.Eq(n => n.Nonce, token) &
+                (Builders<Token>.Filter.Not(Builders<Token>.Filter.Exists(n => n.IsDeleted)) |
+                 Builders<Token>.Filter.Eq(n => n.IsDeleted, false));
+
+            UpdateDefinition<Token> updateDefinition =
+                Builders<Token>.Update.Set(x => x.IsDeleted, true);
 
             if (_options.NonceUsage == NonceUsage.OneTime)
             {
                 return await _collection
-                    .FindOneAndDeleteAsync(findFilter, cancellationToken: cancellationToken);
+                    .FindOneAndUpdateAsync(findFilter, updateDefinition, cancellationToken: cancellationToken);
             }
 
             return await _collection
diff --git a/test/Extensions.HotChocolate.Tests/Integration/BewitUrlMiddlewareTests.cs b/test/Extensions.HotChocolate.Tests/Integration/BewitUrlMiddlewareTests.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -59,7 +60,34 @@ await gqlClient.QueryAsync<GiveMeAccessResult>(query,
             res.Data.RequestAccess.Should().Be("https://www.google.com/a/b/?c=d&bewit=eyJUb2tlbiI6eyJOb25jZSI6IjcyNGU3YWNjLWJlNTctNDlhMS04MTk1LTQ2YTAzYzYyNzFjNiIsIkV4cGlyYXRpb25EYXRlIjoiMjAxNy0wMS0wMVQwMTowMjowMS4wMDFaIn0sIlBheWxvYWQiOiIvYS9iLz9jPWQiLCJIYXNoIjoiOWxaak9tTlFqVG0xbUlUVjZ2LzNtU1NBTFBXRndmNXNaQ3pqc3J6eXhwQT0ifQ%253D%253D");
         }
 
-        private static TestServer CreateTestServer()
+        [Fact]
+        public async Task InvokeAsync_WithExtraProperties_ShouldNotImpactBewitToken()
+        {
+            //Arrange
+            TestServer testServer = CreateTestServer(
+                new Dictionary<string, string> { ["foo"] = "bar" });
+            HttpClient client = testServer.CreateClient();
+            GraphQLClient gqlClient = new GraphQLClient(client);
+            QueryRequest query = new QueryRequest(
+                string.Empty,
+                @"mutation giveMeAccess {
+                    RequestAccess
+                }",
+                "giveMeAccess",
+                new Dictionary<string, object>());
+
+            //Act
+            QueryResponse<GiveMeAccessResult> res =
+                await gqlClient.QueryAsync<GiveMeAccessResult>(query,
+                    CancellationToken.None);
+
+            //Assert
+            res.Data.Should().NotBeNull();
+            res.Data.RequestAccess.Should().Be("https://www.google.com/a/b/?c=d&bewit=eyJUb2tlbiI6eyJOb25jZSI6IjcyNGU3YWNjLWJlNTctNDlhMS04MTk1LTQ2YTAzYzYyNzFjNiIsIkV4cGlyYXRpb25EYXRlIjoiMjAxNy0wMS0wMVQwMTowMjowMS4wMDFaIn0sIlBheWxvYWQiOiIvYS9iLz9jPWQiLCJIYXNoIjoiOWxaak9tTlFqVG0xbUlUVjZ2LzNtU1NBTFBXRndmNXNaQ3pqc3J6eXhwQT0ifQ%253D%253D");
+        }
+
+        private static TestServer CreateTestServer(
+            Dictionary<string, string>? extraProperties = null)
         {
             IWebHostBuilder hostBuilder = new WebHostBuilder()
                 .ConfigureServices(services =>
@@ -79,7 +107,12 @@ private static TestServer CreateTestServer()
                             d.Name("Mutation");
                             d.Field("RequestAccess")
                                 .Type<NonNullType<StringType>>()
-                                .Resolve(ctx => "https://www.google.com/a/b/?c=d")
+                                .Resolve(ctx =>
+                                {
+                                    ctx.AddBewitTokenExtraProperties(extraProperties);
+
+                                    return "https://www.google.com/a/b/?c=d";
+                                })
                                 .UseBewitUrlProtection();
                         });
                 })
diff --git a/test/Storage.MongoDB.Tests/NonceRepositoryTests.cs b/test/Storage.MongoDB.Tests/NonceRepositoryTests.cs
@@ -82,7 +82,7 @@ await repository.TakeOneAsync(nextToken,
             //Assert
             var items = (
                 await collection.FindAsync(
-                    Builders<Token>.Filter.Empty,
+                    Builders<Token>.Filter.Eq(x => x.IsDeleted, false),
                     cancellationToken: CancellationToken.None)
             ).ToList();
             items.Should().BeEmpty();

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ public async Task InvokeAsync(`
`23`	`23`	`if (context.Result is TPayload result)`
`24`	`24`	`{`
`25`	`25`	`BewitToken<TPayload> bewit`
`26`		`- = await tokenGenerator.GenerateBewitTokenAsync(result, context.RequestAborted);`
	`26`	`+ = await tokenGenerator.GenerateBewitTokenAsync(`
	`27`	`+ result, context.RequestAborted, context.GetBewitTokenExtraProperties());`
`27`	`28`
`28`	`29`	`context.Result = (string)bewit;`
`29`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public async Task InvokeAsync(`
`29`	`29`
`30`	`30`	`BewitToken<string> bewit =`
`31`	`31`	`await tokenGenerator.GenerateBewitTokenAsync(`
`32`		`- uri.PathAndQuery, context.RequestAborted);`
	`32`	`+ uri.PathAndQuery, context.RequestAborted, context.GetBewitTokenExtraProperties());`
`33`	`33`
`34`	`34`	`var parametersToAdd = new Dictionary<string, string>`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.Collections.Generic;`
`1`	`2`	`using System.Threading;`
`2`	`3`	`using System.Threading.Tasks;`
`3`	`4`
`@@ -7,6 +8,7 @@ public interface IBewitTokenGenerator<T>`
`7`	`8`	`{`
`8`	`9`	`Task<BewitToken<T>> GenerateBewitTokenAsync(`
`9`	`10`	`T payload,`
`10`		`- CancellationToken cancellationToken);`
	`11`	`+ CancellationToken cancellationToken,`
	`12`	`+ Dictionary<string, string> extraProperties = null);`
`11`	`13`	`}`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,8 @@ public class MongoNonceOptions`
`26`	`26`	`/// ReUse will keep it in the storage.`
`27`	`27`	`/// </summary>`
`28`	`28`	`public NonceUsage NonceUsage { get; set; } = NonceUsage.OneTime;`
	`29`	`+`
	`30`	`+`
	`31`	`+ public int RecordExpireAfterDays { get; set; } = 365 * 2;`
`29`	`32`	`}`
`30`	`33`	`}`