Admin API for listing all tokens of an identity

Applications/AdminApi/src/AdminApi/Extensions/IServiceCollectionExtensions.cs

@@ -10,9 +10,13 @@
 using Backbone.BuildingBlocks.Application.Abstractions.Infrastructure.UserContext;
 using Backbone.Modules.Devices.Application.Devices.Commands.RegisterDevice;
 using Backbone.Modules.Devices.Application.Devices.DTOs;
+using Backbone.Modules.Tokens.Application.Infrastructure.Persistence.Repository;
+using Backbone.Modules.Tokens.Infrastructure.Persistence.Database;
+using Backbone.Modules.Tokens.Infrastructure.Persistence.Repository;
 using FluentValidation;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.OData;
+using Microsoft.Extensions.Options;
 using Microsoft.OData.ModelBuilder;
 
 namespace Backbone.AdminApi.Extensions;
@@ -148,7 +152,7 @@ private static Func<ActionContext, IActionResult> InvalidModelStateResponseFacto
         var responsePayload = new HttpResponseEnvelopeError(
             HttpError.ForProduction(GenericApplicationErrors.Validation.InputCannotBeParsed().Code,
                 formattedMessage,
-                ""));
+                "")); // TODO: add docs
 
         return new BadRequestObjectResult(responsePayload);
     };
@@ -175,4 +179,18 @@ public static IServiceCollection AddOData(this IServiceCollection services)
 
         return services;
     }
+
+    public static void AddPersistence(this IServiceCollection services)
+    {
+        var infrastructureConfiguration = services.BuildServiceProvider().GetRequiredService<IOptions<TokensConfiguration.InfrastructureConfiguration>>().Value;
+
+        services.AddDatabase(options =>
+        {
+            options.Provider = infrastructureConfiguration.SqlDatabase.Provider;
+            options.DbConnectionString = infrastructureConfiguration.SqlDatabase.ConnectionString;
+        });
+
+        // Note: Registration required. Only Modules have their used repositories registered in the DI container.
+        services.AddTransient<ITokensRepository, TokensRepository>();
+    }
 }

Applications/AdminApi/src/AdminApi/Extensions/TokensServiceCollectionExtensions.cs

@@ -1,9 +1,5 @@
 using Backbone.AdminApi.Configuration;
 using Backbone.Modules.Tokens.Application.Extensions;
-using Backbone.Modules.Tokens.Application.Infrastructure.Persistence.Repository;
-using Backbone.Modules.Tokens.Infrastructure.Persistence.Database;
-using Backbone.Modules.Tokens.Infrastructure.Persistence.Repository;
-using Microsoft.Extensions.Options;
 
 namespace Backbone.AdminApi.Extensions;
 
@@ -15,17 +11,7 @@ public static IServiceCollection AddTokens(this IServiceCollection services, ICo
 
         services.ConfigureAndValidate<TokensConfiguration.InfrastructureConfiguration>(configuration.GetSection("Infrastructure").Bind);
 
-        var infrastructureConfiguration = services.BuildServiceProvider().GetRequiredService<IOptions<TokensConfiguration.InfrastructureConfiguration>>().Value;
-
-        services.AddDatabase(options =>
-        {
-            options.Provider = infrastructureConfiguration.SqlDatabase.Provider;
-            options.DbConnectionString = infrastructureConfiguration.SqlDatabase.ConnectionString;
-        });
-
-        // Note: Registration required. Only Modules have their used repositories registered in the DI container.
-        services.AddTransient<ITokensRepository, TokensRepository>();
-
+        services.AddPersistence();
         return services;
     }
 }

Applications/AdminApi/src/AdminApi/appsettings.json

@@ -1,91 +1,94 @@
 {
-  "AllowedHosts": "*",
-  "Authentication": {
-    "JwtLifetimeInSeconds": 300
-  },
-  "Infrastructure": {
-    "EventBus": {
-      "SubscriptionClientName": "adminui"
-    }
-  },
-  "Modules": {
-    "Announcements": {
-      "Application": {
-        "Pagination": {
-          "DefaultPageSize": 50,
-          "MaxPageSize": 200
-        }
-      },
-      "Infrastructure": {
-        "SqlDatabase": {
-          "EnableHealthCheck": true
-        }
-      }
+    "AllowedHosts": "*",
+    "Authentication": {
+        "JwtLifetimeInSeconds": 300
     },
-    "Challenges": {
-      "Infrastructure": {
-        "SqlDatabase": {
-          "EnableHealthCheck": true
-        }
-      }
-    },
-    "Quotas": {
-      "Application": {
-        "Pagination": {
-          "DefaultPageSize": 50,
-          "MaxPageSize": 200
-        }
-      },
-      "Infrastructure": {
-        "SqlDatabase": {
-          "EnableHealthCheck": true
+    "Infrastructure": {
+        "EventBus": {
+            "SubscriptionClientName": "adminui"
         }
-      }
     },
-    "Devices": {
-      "Application": {
-        "Pagination": {
-          "DefaultPageSize": 50,
-          "MaxPageSize": 200
+    "Modules": {
+        "Announcements": {
+            "Application": {
+                "Pagination": {
+                    "DefaultPageSize": 50,
+                    "MaxPageSize": 200
+                }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
+        "Challenges": {
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
+        "Quotas": {
+            "Application": {
+                "Pagination": {
+                    "DefaultPageSize": 50,
+                    "MaxPageSize": 200
+                }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
+        "Devices": {
+            "Application": {
+                "Pagination": {
+                    "DefaultPageSize": 50,
+                    "MaxPageSize": 200
+                }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
+        },
+
+        "Tokens": {
+            "Application": {
+                "Pagination": {
+                    "DefaultPageSize": 50,
+                    "MaxPageSize": 200
+                }
+            },
+            "Infrastructure": {
+                "SqlDatabase": {
+                    "EnableHealthCheck": true
+                }
+            }
         }
-      },
-      "Infrastructure": {
-        "SqlDatabase": {
-          "EnableHealthCheck": true
-        }
-      }
-    },
-    "Tokens": {
-      "Application": {
-        "Pagination": {
-          "DefaultPageSize": 50,
-          "MaxPageSize": 200
-        }
-      },
-      "Infrastructure": {
-        "SqlDatabase": {
-          "EnableHealthCheck": true
-        }
-      }
-    }
-  },
-  "Logging": {
-    "MinimumLevel": {
-      "Default": "Warning",
-      "Override": {
-        "Backbone": "Information",
-        "Enmeshed": "Information",
-        "AdminApi": "Information",
-        "Microsoft": "Information"
-      }
     },
-    "WriteTo": {
-      "Console": {
-        "Name": "Console",
-        "Args": {
-          "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
+    "Logging": {
+        "MinimumLevel": {
+            "Default": "Warning",
+            "Override": {
+                "Backbone": "Information",
+                "Enmeshed": "Information",
+                "AdminApi": "Information",
+                "Microsoft": "Information"
+            }
+        },
+        "WriteTo": {
+            "Console": {
+                "Name": "Console",
+                "Args": {
+                    "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact"
+                }
+            }
         }
-      }
+
     }
-  }
+
 }

Applications/AdminApi/test/AdminApi.Tests.Integration/Features/Tokens/GET.feature

@@ -0,0 +1,10 @@
+@Integration
+Feature: GET /Tokens?createdBy={identity-address}
+
+Listing all tokens of an identity that doesn't have any tokens
+
+    Scenario: Get all Tokens for an identity with no tokens
+        Given an identity with no tokens
+        When a GET request is sent to the /Tokens endpoint with the identity's address
+        Then the response status code is 200 (OK)
+        And the response content is an empty array

Applications/AdminApi/test/AdminApi.Tests.Integration/StepDefinitions/TokensStepDefinitions.cs

@@ -0,0 +1,51 @@
+using Backbone.AdminApi.Sdk.Endpoints.Identities.Types.Responses;
+using Backbone.AdminApi.Sdk.Endpoints.Tokens.Response;
+using Backbone.AdminApi.Sdk.Services;
+using Backbone.AdminApi.Tests.Integration.Configuration;
+using Backbone.AdminApi.Tests.Integration.Extensions;
+using Backbone.BuildingBlocks.SDK.Endpoints.Common.Types;
+using Microsoft.Extensions.Options;
+using PaginationFilter = Backbone.BuildingBlocks.SDK.Endpoints.Common.Types.PaginationFilter;
+
+
+namespace Backbone.AdminApi.Tests.Integration.StepDefinitions;
+
+[Binding]
+[Scope(Feature = "GET /Tokens?createdBy={identity-address}")]
+internal class TokensStepDefinitions(HttpClientFactory factory, IOptions<HttpClientOptions> options) : BaseStepDefinitions(factory, options)
+{
+    private ApiResponse<CreateIdentityResponse>? _createIdentityResponse;
+    private string _newIdentity = string.Empty;
+    private ApiResponse<ListTokensTestResponse> _tokensResult = null!;
+
+    [Given(@"an identity with no tokens")]
+    public async Task GivenAnIdentityWithNoTokens()
+    {
+        _createIdentityResponse = await IdentityCreationHelper.CreateIdentity(_client);
+
+        _createIdentityResponse.Should().BeASuccess();
+
+        _newIdentity = _createIdentityResponse.Result!.Address;
+    }
+
+
+    [When(@"a GET request is sent to the /Tokens endpoint with the identity's address")]
+    public async Task WhenAGETRequestIsSentToTheTokensEndpointWithTheIdentitysAddress()
+    {
+        _tokensResult = await _client.Tokens.ListTokensByIdentity(new PaginationFilter { PageNumber = 1, PageSize = 5 }, _newIdentity, CancellationToken.None);
+    }
+
+    [Then(@"the response status code is (\d+) \(.+\)")]
+    public void ThenTheResponseStatusCodeIs(int expectedStatusCode)
+    {
+        ((int)_tokensResult!.Status).Should().Be(expectedStatusCode);
+    }
+
+
+    [Then(@"the response content is an empty array")]
+    public void ThenTheResponseContentIsAnEmptyArray()
+    {
+        var tokens = _tokensResult.Result!.Count;
+        tokens.Should().Be(0);
+    }
+}

Modules/Tokens/src/Tokens.Application/Tokens/Queries/ListTokensByIdentity/Validator.cs

@@ -10,16 +10,13 @@ public class Validator : AbstractValidator<ListTokensByIdentityQuery>
     public Validator()
     {
         RuleFor(q => q.CreatedBy)
-            .Cascade(CascadeMode.Stop)
             .DetailedNotEmpty();
 
         RuleFor(q => q.PaginationFilter.PageNumber)
-            .Cascade(CascadeMode.Stop)
             .GreaterThanOrEqualTo(1)
             .WithErrorCode(GenericApplicationErrors.Validation.InvalidPropertyValue().Code);
 
         RuleFor(q => q.PaginationFilter.PageSize)
-            .Cascade(CascadeMode.Stop)
             .GreaterThanOrEqualTo(1)
             .WithErrorCode(GenericApplicationErrors.Validation.InvalidPropertyValue().Code);
     }

Sdks/AdminApi.Sdk/src/AdminApi.Sdk.csproj

@@ -3,5 +3,6 @@
         <ProjectReference Include="..\..\..\BuildingBlocks\src\BuildingBlocks.SDK\BuildingBlocks.SDK.csproj" />
         <ProjectReference Include="..\..\..\BuildingBlocks\src\Crypto\Crypto.csproj" />
         <ProjectReference Include="..\..\..\BuildingBlocks\src\Tooling\Tooling.csproj" />
+        <ProjectReference Include="..\..\..\Modules\Tokens\src\Tokens.Domain\Tokens.Domain.csproj" />
     </ItemGroup>
 </Project>

Sdks/AdminApi.Sdk/src/Client.cs

@@ -9,6 +9,7 @@
 using Backbone.AdminApi.Sdk.Endpoints.Metrics;
 using Backbone.AdminApi.Sdk.Endpoints.Relationships;
 using Backbone.AdminApi.Sdk.Endpoints.Tiers;
+using Backbone.AdminApi.Sdk.Endpoints.Tokens;
 using Backbone.BuildingBlocks.SDK.Endpoints.Common;
 using Backbone.Tooling.JsonConverters;
 
@@ -34,6 +35,7 @@ private Client(HttpClient httpClient, string apiKey)
         Tiers = new TiersEndpoint(endpointClient);
         Challenges = new ChallengesEndpoint(endpointClient);
         Messages = new MessagesEndpoint(endpointClient);
+        Tokens = new TokensEndpoint(endpointClient);
     }
 
     public ApiKeyValidationEndpoint ApiKeyValidation { get; }
@@ -46,6 +48,8 @@ private Client(HttpClient httpClient, string apiKey)
     public ChallengesEndpoint Challenges { get; }
     public MessagesEndpoint Messages { get; }
 
+    public TokensEndpoint Tokens { get; }
+
     public static Client Create(string baseUrl, string apiKey)
     {
         return Create(new HttpClient { BaseAddress = new Uri(baseUrl) }, apiKey);