kocoded/oqtane.framework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #266 from sbwalker/master

Browse Source 
infrastructure for dealing with client cache invalidation in a multi-user environment
This commit is contained in:
Shaun Walker 2020-03-09 15:39:25 -04:00 committed by GitHub
commit cb7bc282e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 130 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Oqtane.Client/Modules/ModuleBase.cs
View File

@ -125,7 +125,7 @@ namespace Oqtane.Modules
// logging methods
public async Task Log(Alias alias, LogLevel level, string function, Exception exception, string message, params object[] args)
{
int pageId = PageState.Page.PageId;
int pageId = ModuleState.PageId;
int moduleId = ModuleState.ModuleId;
int? userId = null;
if (PageState.User != null)

4
Oqtane.Client/Services/AliasService.cs
View File

@ -39,7 +39,7 @@ namespace Oqtane.Services
return await _http.GetJsonAsync<Alias>(apiurl + "/" + AliasId.ToString());
}
public async Task<Alias> GetAliasAsync(string Url)
public async Task<Alias> GetAliasAsync(string Url, DateTime LastSyncDate)
{
Uri uri = new Uri(Url);
string name = uri.Authority;
@ -51,7 +51,7 @@ namespace Oqtane.Services
{
name = name.Substring(0, name.Length - 1);
}
return await _http.GetJsonAsync<Alias>(apiurl + "/name/" + WebUtility.UrlEncode(name));
return await _http.GetJsonAsync<Alias>(apiurl + "/name/" + WebUtility.UrlEncode(name) + "?lastsyncdate=" + LastSyncDate.ToString("yyyyMMddHHmmssfff"));
}
public async Task<Alias> AddAliasAsync(Alias alias)

3
Oqtane.Client/Services/Interfaces/IAliasService.cs
View File

@ -1,4 +1,5 @@
using Oqtane.Models;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
@ -10,7 +11,7 @@ namespace Oqtane.Services
Task<Alias> GetAliasAsync(int AliasId);
Task<Alias> GetAliasAsync(string Url);
Task<Alias> GetAliasAsync(string Url, DateTime LastSyncDate);
Task<Alias> AddAliasAsync(Alias Alias);

1
Oqtane.Client/Shared/PageState.cs
View File

@ -17,5 +17,6 @@ namespace Oqtane.Shared
public int ModuleId { get; set; }
public string Action { get; set; }
public bool EditMode { get; set; }
public DateTime LastSyncDate { get; set; }
}
}

52
Oqtane.Client/Shared/SiteRouter.razor
View File

@ -66,16 +66,17 @@
private async Task Refresh()
{
Alias alias;
Alias alias = null;
Site site;
List<Page> pages;
Page page;
User user;
User user = null;
List<Module> modules;
int moduleid = -1;
string action = "";
bool editmode = false;
Reload reload = Reload.None;
DateTime lastsyncdate = DateTime.Now;
// get Url path and querystring ( and remove anchors )
string path = new Uri(_absoluteUri).PathAndQuery.Substring(1);
@ -99,26 +100,15 @@
if (PageState != null)
{
editmode = PageState.EditMode;
lastsyncdate = PageState.LastSyncDate;
user = PageState.User;
}
if (PageState == null || reload == Reload.Application)
{
alias = null;
}
else
{
alias = PageState.Alias;
}
alias = await AliasService.GetAliasAsync(_absoluteUri, lastsyncdate);
SiteState.Alias = alias; // set state for services
lastsyncdate = alias.SyncDate;
// check if site has changed
Alias current = await AliasService.GetAliasAsync(_absoluteUri);
if (alias == null || current.Name != alias.Name)
{
alias = current;
SiteState.Alias = alias; // set state for services
reload = Reload.Site;
}
if (PageState == null || reload <= Reload.Site)
if (PageState == null || alias.SiteId != PageState.Alias.SiteId)
{
site = await SiteService.GetSiteAsync(alias.SiteId, alias);
}
@ -128,11 +118,34 @@
}
if (site != null)
{
// process sync events
if (alias.SyncEvents.Any())
{
if (PageState != null && alias.SyncEvents.Exists(item => item.EntityName == "Page" && item.EntityId == PageState.Page.PageId))
{
reload = Reload.Page;
}
if (alias.SyncEvents.Exists(item => item.EntityName == "Site" && item.EntityId == alias.SiteId))
{
reload = Reload.Site;
}
if (user != null && alias.SyncEvents.Exists(item => item.EntityName == "User" && item.EntityId == user.UserId))
{
reload = Reload.Site;
}
}
if (PageState == null || reload >= Reload.Site)
{
#if WASM
ModuleDefinitionService.LoadModuleDefinitionsAsync(site.SiteId); // download assemblies to browser when running client-side
#endif
var authState = await AuthenticationStateProvider.GetAuthenticationStateAsync();
if (authState.User.Identity.IsAuthenticated)
{
user = await UserService.GetUserAsync(authState.User.Identity.Name, site.SiteId);
}
pages = await PageService.GetPagesAsync(site.SiteId);
}
else
@ -249,6 +262,7 @@
}
pagestate.Modules = modules;
pagestate.EditMode = editmode;
pagestate.LastSyncDate = lastsyncdate;
OnStateChange?.Invoke(pagestate);
}

14
Oqtane.Server/Controllers/AliasController.cs
View File

@ -8,6 +8,7 @@ using Oqtane.Infrastructure;
using System.Linq;
using System;
using System.Net;
using System.Globalization;
namespace Oqtane.Controllers
{
@ -15,11 +16,13 @@ namespace Oqtane.Controllers
public class AliasController : Controller
{
private readonly IAliasRepository _aliases;
private readonly ISyncManager _syncManager;
private readonly ILogManager _logger;
public AliasController(IAliasRepository aliases, ILogManager logger)
public AliasController(IAliasRepository aliases, ISyncManager syncManager, ILogManager logger)
{
_aliases = aliases;
_syncManager = syncManager;
_logger = logger;
}
@ -39,9 +42,9 @@ namespace Oqtane.Controllers
return _aliases.GetAlias(id);
}
// GET api/<controller>/name/localhost:12345
// GET api/<controller>/name/localhost:12345?lastsyncdate=yyyyMMddHHmmssfff
[HttpGet("name/{name}")]
public Alias Get(string name)
public Alias Get(string name, string lastsyncdate)
{
name = WebUtility.UrlDecode(name);
List<Alias> aliases = _aliases.GetAliases().ToList();
@ -57,6 +60,11 @@ namespace Oqtane.Controllers
// use first alias if name does not exist
alias = aliases.FirstOrDefault();
}
// get sync events
alias.SyncDate = DateTime.Now;
alias.SyncEvents = _syncManager.GetSyncEvents(DateTime.ParseExact(lastsyncdate, "yyyyMMddHHmmssfff", CultureInfo.InvariantCulture));
return alias;
}

5
Oqtane.Server/Controllers/PageController.cs
View File

@ -17,14 +17,16 @@ namespace Oqtane.Controllers
private readonly IModuleRepository _modules;
private readonly IPageModuleRepository _pageModules;
private readonly IUserPermissions _userPermissions;
private readonly ISyncManager _syncManager;
private readonly ILogManager _logger;
public PageController(IPageRepository pages, IModuleRepository modules, IPageModuleRepository pageModules, IUserPermissions userPermissions, ILogManager logger)
public PageController(IPageRepository pages, IModuleRepository modules, IPageModuleRepository pageModules, IUserPermissions userPermissions, ISyncManager syncManager, ILogManager logger)
{
_pages = pages;
_modules = modules;
_pageModules = pageModules;
_userPermissions = userPermissions;
_syncManager = syncManager;
_logger = logger;
}
@ -88,6 +90,7 @@ namespace Oqtane.Controllers
if (_userPermissions.IsAuthorized(User, "Edit", permissions))
{
Page = _pages.AddPage(Page);
_syncManager.AddSyncEvent("Site", Page.SiteId);
_logger.Log(LogLevel.Information, this, LogFunction.Create, "Page Added {Page}", Page);
}
else

13
Oqtane.Server/Infrastructure/Interfaces/ISyncManager.cs Normal file
View File

@ -0,0 +1,13 @@
using Oqtane.Models;
using Oqtane.Shared;
using System;
using System.Collections.Generic;
namespace Oqtane.Infrastructure
{
public interface ISyncManager
{
List<SyncEvent> GetSyncEvents(DateTime LastSyncDate);
void AddSyncEvent(string EntityName, int EntityId);
}
}

44
Oqtane.Server/Infrastructure/SyncManager.cs Normal file
View File

@ -0,0 +1,44 @@
using Microsoft.Extensions.DependencyInjection;
using Oqtane.Models;
using Oqtane.Repository;
using System;
using System.Collections.Generic;
using System.Linq;
namespace Oqtane.Infrastructure
{
public class SyncManager : ISyncManager
{
private readonly IServiceScopeFactory ServiceScopeFactory;
private List<SyncEvent> SyncEvents { get; set; }
public SyncManager(IServiceScopeFactory ServiceScopeFactory)
{
this.ServiceScopeFactory = ServiceScopeFactory;
SyncEvents = new List<SyncEvent>();
}
private int TenantId
{
get
{
using (var scope = ServiceScopeFactory.CreateScope())
{
return scope.ServiceProvider.GetRequiredService<ITenantResolver>().GetTenant().TenantId;
}
}
}
public List<SyncEvent> GetSyncEvents(DateTime LastSyncDate)
{
return SyncEvents.Where(item => item.TenantId == TenantId && item.ModifiedOn >= LastSyncDate).ToList();
}
public void AddSyncEvent(string EntityName, int EntityId)
{
SyncEvents.Add(new SyncEvent { TenantId = TenantId, EntityName = EntityName, EntityId = EntityId, ModifiedOn = DateTime.Now });
// trim sync events
SyncEvents.RemoveAll(item => item.ModifiedOn < DateTime.Now.AddHours(-1));
}
}
}

1
Oqtane.Server/Startup.cs
View File

@ -162,6 +162,7 @@ namespace Oqtane.Server
// register singleton scoped core services
services.AddSingleton<IConfigurationRoot>(Configuration);
services.AddSingleton<IInstallationManager, InstallationManager>();
services.AddSingleton<ISyncManager, SyncManager>();
// register transient scoped core services
services.AddTransient<IModuleDefinitionRepository, ModuleDefinitionRepository>();

6
Oqtane.Shared/Models/Alias.cs
View File

@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations.Schema;
namespace Oqtane.Models
@ -15,6 +16,11 @@ namespace Oqtane.Models
public string ModifiedBy { get; set; }
public DateTime ModifiedOn { get; set; }
[NotMapped]
public DateTime SyncDate { get; set; }
[NotMapped]
public List<SyncEvent> SyncEvents { get; set; }
[NotMapped]
public string Path
{

12
Oqtane.Shared/Models/SyncEvent.cs Normal file
View File

@ -0,0 +1,12 @@
using System;
namespace Oqtane.Models
{
public class SyncEvent
{
public int TenantId { get; set; }
public string EntityName { get; set; }
public int EntityId { get; set; }
public DateTime ModifiedOn { get; set; }
}
}