Merge pull request #304 from Developer-Autodesk/task/INVGEN-44987

msimko81 · web-flow · commit 86ea628ff6b4 · 2020-09-03T14:06:45.000+02:00
Move BucketKeyProvider and ProfileProvider out of UserResolver
diff --git a/WebApplication.Tests/InitializerTestBase.cs b/WebApplication.Tests/InitializerTestBase.cs
@@ -96,14 +96,17 @@ public InitializerTestBase(DefaultProjectsConfiguration defaultProjectsConfigura
 
             var fdaClient = new FdaClient(publisher, appBundleZipPathsOptions);
             IOptions<DefaultProjectsConfiguration> defaultProjectsOptions = Options.Create(defaultProjectsConfiguration);
-            var userResolver = new UserResolver(resourceProvider, forgeOSS, forgeConfigOptions, localCache, NullLogger<UserResolver>.Instance, null);
+            var profileProvider = new ProfileProvider(forgeOSS);
+            var bucketPrefixProvider = new BucketPrefixProvider(forgeConfigOptions, null);
+            var bucketKeyProvider = new LoggedInUserBucketKeyProvider(forgeConfigOptions, profileProvider, bucketPrefixProvider);
+            var userResolver = new UserResolver(resourceProvider, forgeOSS, bucketKeyProvider, localCache, NullLogger<UserResolver>.Instance, profileProvider);
             var arranger = new Arranger(httpClientFactory, userResolver);
 
             // TODO: linkGenerator should be mocked
             var dtoGenerator = new DtoGenerator(linkGenerator: null, localCache);
             var projectWork = new ProjectWork(new NullLogger<ProjectWork>(), arranger, fdaClient, dtoGenerator, userResolver);
             initializer = new Initializer(new NullLogger<Initializer>(), fdaClient,
-                                            defaultProjectsOptions, projectWork, userResolver, localCache);
+                                            defaultProjectsOptions, projectWork, userResolver, localCache, bucketPrefixProvider);
 
             testFileDirectory = Directory.CreateDirectory(Path.Combine(Path.GetTempPath(), Path.GetRandomFileName()));
             httpClient = new HttpClient();
diff --git a/WebApplication/Controllers/JobsHub.cs b/WebApplication/Controllers/JobsHub.cs
@@ -25,6 +25,7 @@
 using WebApplication.Definitions;
 using WebApplication.Job;
 using WebApplication.Processing;
+using WebApplication.Services;
 using WebApplication.State;
 using WebApplication.Utilities;
 
@@ -111,16 +112,19 @@ public async Task SendErrorAsync(object arg0, object arg1, object arg2)
         private readonly ILogger<JobsHub> _logger;
         private readonly ProjectWork _projectWork;
         private readonly LinkGenerator _linkGenerator;
+        private readonly ProfileProvider _profileProvider;
         private readonly UserResolver _userResolver;
         private readonly Sender _sender;
         private readonly Uploads _uploads;
         private readonly DtoGenerator _dtoGenerator;
 
-        public JobsHub(ILogger<JobsHub> logger, ProjectWork projectWork, LinkGenerator linkGenerator, UserResolver userResolver, Uploads uploads, DtoGenerator dtoGenerator)
+        public JobsHub(ILogger<JobsHub> logger, ProjectWork projectWork, LinkGenerator linkGenerator, UserResolver userResolver, 
+            ProfileProvider profileProvider, Uploads uploads, DtoGenerator dtoGenerator)
         {
             _logger = logger;
             _projectWork = projectWork;
             _linkGenerator = linkGenerator;
+            _profileProvider = profileProvider;
             _userResolver = userResolver;
             _uploads = uploads;
             _dtoGenerator = dtoGenerator;
@@ -132,7 +136,7 @@ public async Task CreateUpdateJob(string projectId, InventorParameters parameter
         {
             _logger.LogInformation($"invoked CreateJob, connectionId : {Context.ConnectionId}");
 
-            _userResolver.Token = token;
+            _profileProvider.Token = token;
 
             // create job and run it
             var job = new UpdateModelJobItem(_logger, projectId, parameters, _projectWork);
@@ -143,7 +147,7 @@ public async Task CreateRFAJob(string projectId, string hash, string token)
         {
             _logger.LogInformation($"invoked CreateRFAJob, connectionId : {Context.ConnectionId}");
 
-            _userResolver.Token = token;
+            _profileProvider.Token = token;
 
             // create job and run it
             var job = new RFAJobItem(_logger, projectId, hash, _projectWork, _linkGenerator);
@@ -154,7 +158,7 @@ public async Task CreateDrawingDownloadJob(string projectId, string hash, string
         {
             _logger.LogInformation($"invoked CreateDrawingDownloadJob, connectionId : {Context.ConnectionId}");
 
-            _userResolver.Token = token;
+            _profileProvider.Token = token;
 
             // create job and run it
             var job = new DrawingJobItem(_logger, projectId, hash, _projectWork, _linkGenerator);
@@ -165,22 +169,22 @@ public async Task CreateAdoptJob(string packageId, string token)
         {
             _logger.LogInformation($"invoked CreateAdoptJob, connectionId : {Context.ConnectionId}");
 
-            _userResolver.Token = token;
+            _profileProvider.Token = token;
 
             // get upload information
             (ProjectInfo projectInfo, string fileName) = _uploads.GetUploadData(packageId);
             _uploads.ClearUploadData(packageId);
 
             // create job and run it
-            var job = new AdoptJobItem(_logger, projectInfo, fileName, _projectWork, _userResolver, _dtoGenerator);
+            var job = new AdoptJobItem(_logger, projectInfo, fileName, _projectWork, _dtoGenerator, _userResolver);
             await RunJobAsync(job);
         }
 
         public async Task CreateDrawingPdfJob(string projectId, string hash, string token)
         {
             _logger.LogInformation($"invoked CreateDrawingPdfJob, connectionId : {Context.ConnectionId}");
 
-            _userResolver.Token = token;
+            _profileProvider.Token = token;
 
             // create job and run it
             var job = new ExportDrawingPdfJobItem(_logger, projectId, hash, _projectWork, _linkGenerator);
diff --git a/WebApplication/Controllers/LoginController.cs b/WebApplication/Controllers/LoginController.cs
@@ -24,6 +24,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using WebApplication.Definitions;
+using WebApplication.Services;
 using WebApplication.State;
 using WebApplication.Utilities;
 
@@ -36,18 +37,18 @@ public class LoginController : ControllerBase
         private static readonly ProfileDTO AnonymousProfile = new ProfileDTO { Name = "Anonymous", AvatarUrl = "logo-xs-white-BG.svg" };
 
         private readonly ILogger<LoginController> _logger;
-        private readonly UserResolver _userResolver;
+        private readonly ProfileProvider _profileProvider;
         private readonly InviteOnlyModeConfiguration _inviteOnlyModeConfig;
 
         /// <summary>
         /// Forge configuration.
         /// </summary>
         public ForgeConfiguration Configuration { get; }
 
-        public LoginController(ILogger<LoginController> logger, IOptions<ForgeConfiguration> optionsAccessor, UserResolver userResolver, IOptions<InviteOnlyModeConfiguration> inviteOnlyModeOptionsAccessor)
+        public LoginController(ILogger<LoginController> logger, IOptions<ForgeConfiguration> optionsAccessor, ProfileProvider profileProvider, IOptions<InviteOnlyModeConfiguration> inviteOnlyModeOptionsAccessor)
         {
             _logger = logger;
-            _userResolver = userResolver;
+            _profileProvider = profileProvider;
             Configuration = optionsAccessor.Value.Validate();
             _inviteOnlyModeConfig = inviteOnlyModeOptionsAccessor.Value;
         }
@@ -82,9 +83,9 @@ public RedirectResult Get()
         public async Task<ActionResult<ProfileDTO>> Profile()
         {
             _logger.LogInformation("Get profile");
-            if (_userResolver.IsAuthenticated)
+            if (_profileProvider.IsAuthenticated)
             {
-                dynamic profile = await _userResolver.GetProfileAsync();
+                dynamic profile = await _profileProvider.GetProfileAsync();
                 if (_inviteOnlyModeConfig.Enabled)
                 {
                     var inviteOnlyChecker = new InviteOnlyChecker(_inviteOnlyModeConfig);
diff --git a/WebApplication/Controllers/ProjectsController.cs b/WebApplication/Controllers/ProjectsController.cs
@@ -24,6 +24,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using WebApplication.Definitions;
+using WebApplication.Services;
 using WebApplication.State;
 using WebApplication.Utilities;
 using Project = WebApplication.State.Project;
@@ -37,13 +38,15 @@ public class ProjectsController : ControllerBase
         private readonly ILogger<ProjectsController> _logger;
         private readonly DtoGenerator _dtoGenerator;
         private readonly UserResolver _userResolver;
+        private readonly ProfileProvider _profileProvider;
         private readonly Uploads _uploads;
 
-        public ProjectsController(ILogger<ProjectsController> logger, DtoGenerator dtoGenerator, UserResolver userResolver, Uploads uploads)
+        public ProjectsController(ILogger<ProjectsController> logger, DtoGenerator dtoGenerator, UserResolver userResolver, ProfileProvider profileProvider, Uploads uploads)
         {
             _logger = logger;
             _dtoGenerator = dtoGenerator;
             _userResolver = userResolver;
+            _profileProvider = profileProvider;
             _uploads = uploads;
         }
 
@@ -78,7 +81,7 @@ public async Task<IEnumerable<ProjectDTO>> ListAsync()
         [HttpPost]
         public async Task<ActionResult<ProjectDTO>> CreateProject([FromForm]NewProjectModel projectModel)
         {
-            if (!_userResolver.IsAuthenticated)
+            if (!_profileProvider.IsAuthenticated)
             {
                 _logger.LogError("Attempt to create project for anonymous user");
                 return BadRequest();
@@ -116,7 +119,7 @@ public async Task<ActionResult<ProjectDTO>> CreateProject([FromForm]NewProjectMo
         [HttpDelete]
         public async Task<StatusCodeResult> DeleteProjects([FromBody] List<string> projectNameList)
         {
-            if (!_userResolver.IsAuthenticated)
+            if (!_profileProvider.IsAuthenticated)
             {
                 _logger.LogError("Attempt to delete projects for anonymous user");
                 return BadRequest();
diff --git a/WebApplication/Initializer.cs b/WebApplication/Initializer.cs
@@ -17,7 +17,6 @@
 /////////////////////////////////////////////////////////////////////
 
 using System;
-using System.Collections;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
@@ -44,14 +43,15 @@ public class Initializer
         private readonly FdaClient _fdaClient;
         private readonly ProjectWork _projectWork;
         private readonly UserResolver _userResolver;
+        private readonly BucketPrefixProvider _bucketPrefixProvider;
         private readonly LocalCache _localCache;
         private readonly OssBucket _bucket;
 
         /// <summary>
         /// Constructor.
         /// </summary>
         public Initializer(ILogger<Initializer> logger, FdaClient fdaClient, IOptions<DefaultProjectsConfiguration> optionsAccessor,
-                            ProjectWork projectWork, UserResolver userResolver, LocalCache localCache)
+                            ProjectWork projectWork, UserResolver userResolver, LocalCache localCache, BucketPrefixProvider bucketPrefixProvider)
         {
             _logger = logger;
             _fdaClient = fdaClient;
@@ -62,6 +62,8 @@ public Initializer(ILogger<Initializer> logger, FdaClient fdaClient, IOptions<De
 
             // bucket for anonymous user
             _bucket = _userResolver.AnonymousBucket;
+
+            _bucketPrefixProvider = bucketPrefixProvider;
         }
         public async Task InitializeBundlesAsync()
         {
@@ -140,7 +142,7 @@ public async Task ClearAsync(bool deleteUserBuckets)
                 _logger.LogInformation($"Deleting user buckets for registered users");
                 // delete all user buckets
                 var buckets = await _bucket.GetBucketsAsync();
-                string userBucketPrefix = _userResolver.GetBucketPrefix();
+                string userBucketPrefix = _bucketPrefixProvider.GetBucketPrefix();
                 foreach (string bucket in buckets)
                 {
                     if (bucket.Contains(userBucketPrefix))
diff --git a/WebApplication/Job/AdoptJobItem.cs b/WebApplication/Job/AdoptJobItem.cs
@@ -33,13 +33,13 @@ internal class AdoptJobItem : JobItemBase
         private readonly UserResolver _userResolver;
         private readonly DtoGenerator _dtoGenerator;
 
-        public AdoptJobItem(ILogger logger, ProjectInfo projectInfo, string fileName, ProjectWork projectWork, UserResolver userResolver, DtoGenerator dtoGenerator)
+        public AdoptJobItem(ILogger logger, ProjectInfo projectInfo, string fileName, ProjectWork projectWork, DtoGenerator dtoGenerator, UserResolver userResolver)
             : base(logger, null, projectWork)
         {
             _projectInfo = projectInfo;
             _fileName = fileName;
-            _userResolver = userResolver;
             _dtoGenerator = dtoGenerator;
+            _userResolver = userResolver;
         }
 
         public override async Task ProcessJobAsync(IResultSender resultSender)
diff --git a/WebApplication/Middleware/HeaderTokenHandler.cs b/WebApplication/Middleware/HeaderTokenHandler.cs
@@ -19,6 +19,7 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Net.Http.Headers;
+using WebApplication.Services;
 using WebApplication.State;
 
 namespace WebApplication.Middleware
@@ -37,7 +38,7 @@ public HeaderTokenHandler(RequestDelegate next)
             _next = next;
         }
 
-        public async Task InvokeAsync(HttpContext context, UserResolver resolver)
+        public async Task InvokeAsync(HttpContext context, ProfileProvider profileProvider)
         {
             while (context.Request.Headers.TryGetValue(HeaderNames.Authorization, out var values))
             {
@@ -48,7 +49,7 @@ public async Task InvokeAsync(HttpContext context, UserResolver resolver)
                 string token = headerValue.Substring(BearerPrefix.Length);
                 if (string.IsNullOrEmpty(token)) break;
 
-                resolver.Token = token;
+                profileProvider.Token = token;
                 break;
             }
 
diff --git a/WebApplication/Middleware/RouteTokenHandler.cs b/WebApplication/Middleware/RouteTokenHandler.cs
@@ -21,6 +21,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.Logging;
+using WebApplication.Services;
 using WebApplication.State;
 
 namespace WebApplication.Middleware
@@ -37,13 +38,13 @@ public RouteTokenHandler(RequestDelegate next)
             _next = next;
         }
 
-        public async Task InvokeAsync(HttpContext context, UserResolver resolver, ILogger<RouteTokenHandler> logger)
+        public async Task InvokeAsync(HttpContext context, ProfileProvider profileProvider, ILogger<RouteTokenHandler> logger)
         {
             string token = context.GetRouteValue("token") as string; // IMPORTANT: parameter name must be in sync with route definition
             if (!string.IsNullOrEmpty(token))
             {
                 logger.LogInformation("Extracted token from route");
-                resolver.Token = token;
+                profileProvider.Token = token;
             }
 
             // Call the next delegate/middleware in the pipeline
diff --git a/WebApplication/Services/BucketPrefixProvider.cs b/WebApplication/Services/BucketPrefixProvider.cs
@@ -0,0 +1,24 @@
+﻿using Autodesk.Forge.Core;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+namespace WebApplication.Services
+{
+    public class BucketPrefixProvider
+    {
+        private readonly ForgeConfiguration _forgeConfig;
+        private readonly IConfiguration _configuration;
+
+        public BucketPrefixProvider(IOptions<ForgeConfiguration> forgeConfiguration, IConfiguration configuration)
+        {
+            _configuration = configuration;
+            _forgeConfig = forgeConfiguration.Value;
+        }
+
+        public string GetBucketPrefix()
+        {
+            string suffix = _configuration?.GetValue<string>("BucketKeySuffix");
+            return $"authd{suffix}-{_forgeConfig.ClientId}".ToLowerInvariant();
+        }
+    }
+}
diff --git a/WebApplication/Services/IBucketKeyProvider.cs b/WebApplication/Services/IBucketKeyProvider.cs
@@ -0,0 +1,9 @@
+﻿using System.Threading.Tasks;
+
+namespace WebApplication.Services
+{
+    public interface IBucketKeyProvider
+    {
+        Task<string> GetBucketKeyAsync();
+    }
+}
diff --git a/WebApplication/Services/LoggedInUserBucketKeyProvider.cs b/WebApplication/Services/LoggedInUserBucketKeyProvider.cs
@@ -0,0 +1,36 @@
+﻿using System.Threading.Tasks;
+using Autodesk.Forge.Core;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+using WebApplication.Utilities;
+
+namespace WebApplication.Services
+{
+    public class LoggedInUserBucketKeyProvider : IBucketKeyProvider
+    {
+        private readonly ForgeConfiguration _forgeConfig;
+        private readonly ProfileProvider _profileProvider;
+        private readonly BucketPrefixProvider _bucketPrefixProvider;
+
+        public LoggedInUserBucketKeyProvider(IOptions<ForgeConfiguration> forgeConfiguration, ProfileProvider profileProvider, BucketPrefixProvider bucketPrefixProvider)
+        {
+            _profileProvider = profileProvider;
+            _forgeConfig = forgeConfiguration.Value;
+            _bucketPrefixProvider = bucketPrefixProvider;
+        }
+
+        public async Task<string> GetBucketKeyAsync()
+        {
+            dynamic profile = await _profileProvider.GetProfileAsync();
+            var userId = profile.userId;
+
+            // an OSS bucket must have a unique name, so it should be generated in a way,
+            // so it a Forge user gets registered into several deployments it will not cause
+            // name collisions. So use client ID (as a salt) to generate bucket name.
+            var userHash = Crypto.GenerateHashString(_forgeConfig.ClientId + userId);
+            var bucketKey = $"{_bucketPrefixProvider.GetBucketPrefix()}-{userId.Substring(0, 3)}-{userHash}".ToLowerInvariant();
+
+            return bucketKey;
+        }
+    }
+}
diff --git a/WebApplication/Services/MigrationBucketKeyProvider.cs b/WebApplication/Services/MigrationBucketKeyProvider.cs
@@ -0,0 +1,14 @@
+﻿using System.Threading.Tasks;
+
+namespace WebApplication.Services
+{
+    public class MigrationBucketKeyProvider : IBucketKeyProvider
+    {
+        public string BucketKey { private get; set; }
+
+        public Task<string> GetBucketKeyAsync()
+        {
+            return Task.FromResult(BucketKey);
+        }
+    }
+}
diff --git a/WebApplication/Services/ProfileProvider.cs b/WebApplication/Services/ProfileProvider.cs
diff --git a/WebApplication/Startup.cs b/WebApplication/Startup.cs
diff --git a/WebApplication/State/UserResolver.cs b/WebApplication/State/UserResolver.cs

Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,13 @@ internal class AdoptJobItem : JobItemBase`
`33`	`33`	`private readonly UserResolver _userResolver;`
`34`	`34`	`private readonly DtoGenerator _dtoGenerator;`
`35`	`35`
`36`		`- public AdoptJobItem(ILogger logger, ProjectInfo projectInfo, string fileName, ProjectWork projectWork, UserResolver userResolver, DtoGenerator dtoGenerator)`
	`36`	`+ public AdoptJobItem(ILogger logger, ProjectInfo projectInfo, string fileName, ProjectWork projectWork, DtoGenerator dtoGenerator, UserResolver userResolver)`
`37`	`37`	`: base(logger, null, projectWork)`
`38`	`38`	`{`
`39`	`39`	`_projectInfo = projectInfo;`
`40`	`40`	`_fileName = fileName;`
`41`		`- _userResolver = userResolver;`
`42`	`41`	`_dtoGenerator = dtoGenerator;`
	`42`	`+ _userResolver = userResolver;`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`public override async Task ProcessJobAsync(IResultSender resultSender)`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`using System.Threading.Tasks;`
`20`	`20`	`using Microsoft.AspNetCore.Http;`
`21`	`21`	`using Microsoft.Net.Http.Headers;`
	`22`	`+using WebApplication.Services;`
`22`	`23`	`using WebApplication.State;`
`23`	`24`
`24`	`25`	`namespace WebApplication.Middleware`
`@@ -37,7 +38,7 @@ public HeaderTokenHandler(RequestDelegate next)`
`37`	`38`	`_next = next;`
`38`	`39`	`}`
`39`	`40`
`40`		`- public async Task InvokeAsync(HttpContext context, UserResolver resolver)`
	`41`	`+ public async Task InvokeAsync(HttpContext context, ProfileProvider profileProvider)`
`41`	`42`	`{`
`42`	`43`	`while (context.Request.Headers.TryGetValue(HeaderNames.Authorization, out var values))`
`43`	`44`	`{`
`@@ -48,7 +49,7 @@ public async Task InvokeAsync(HttpContext context, UserResolver resolver)`
`48`	`49`	`string token = headerValue.Substring(BearerPrefix.Length);`
`49`	`50`	`if (string.IsNullOrEmpty(token)) break;`
`50`	`51`
`51`		`- resolver.Token = token;`
	`52`	`+ profileProvider.Token = token;`
`52`	`53`	`break;`
`53`	`54`	`}`
`54`	`55`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`using Microsoft.AspNetCore.Http;`
`22`	`22`	`using Microsoft.AspNetCore.Routing;`
`23`	`23`	`using Microsoft.Extensions.Logging;`
	`24`	`+using WebApplication.Services;`
`24`	`25`	`using WebApplication.State;`
`25`	`26`
`26`	`27`	`namespace WebApplication.Middleware`
`@@ -37,13 +38,13 @@ public RouteTokenHandler(RequestDelegate next)`
`37`	`38`	`_next = next;`
`38`	`39`	`}`
`39`	`40`
`40`		`- public async Task InvokeAsync(HttpContext context, UserResolver resolver, ILogger<RouteTokenHandler> logger)`
	`41`	`+ public async Task InvokeAsync(HttpContext context, ProfileProvider profileProvider, ILogger<RouteTokenHandler> logger)`
`41`	`42`	`{`
`42`	`43`	`string token = context.GetRouteValue("token") as string; // IMPORTANT: parameter name must be in sync with route definition`
`43`	`44`	`if (!string.IsNullOrEmpty(token))`
`44`	`45`	`{`
`45`	`46`	`logger.LogInformation("Extracted token from route");`
`46`		`- resolver.Token = token;`
	`47`	`+ profileProvider.Token = token;`
`47`	`48`	`}`
`48`	`49`
`49`	`50`	`// Call the next delegate/middleware in the pipeline`