liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

API patch improvements

Browse Source 
- add PatchObject.CheckIsValid
- use transaction when creating member, as to not create a member if the
patch is invalid
- return edited system in `PATCH /s` endpoint
This commit is contained in:
spiral 2021-04-21 22:57:19 +01:00
parent a2d2036851
commit b34ed5c4c0
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
10 changed files with 103 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
PluralKit.API/Controllers/v1/MemberController.cs
View File

@ -1,3 +1,4 @@
using System;
using System.Threading.Tasks;
using Dapper;
@ -54,18 +55,28 @@ namespace PluralKit.API
if (memberCount >= memberLimit)
return BadRequest($"Member limit reached ({memberCount} / {memberLimit}).");
var member = await _repo.CreateMember(conn, systemId, properties.Value<string>("name"));
await using var tx = await conn.BeginTransactionAsync();
var member = await _repo.CreateMember(conn, systemId, properties.Value<string>("name"), transaction: tx);
MemberPatch patch;
try
{
patch = JsonModelExt.ToMemberPatch(properties);
patch.CheckIsValid();
}
catch (JsonModelParseError e)
{
await tx.RollbackAsync();
return BadRequest(e.Message);
}
catch (InvalidPatchException e)
{
await tx.RollbackAsync();
return BadRequest($"Request field '{e.Message}' is invalid.");
}
member = await _repo.UpdateMember(conn, member.Id, patch);
member = await _repo.UpdateMember(conn, member.Id, patch, transaction: tx);
await tx.CommitAsync();
return Ok(member.ToJson(User.ContextFor(member)));
}
@ -85,11 +96,16 @@ namespace PluralKit.API
try
{
patch = JsonModelExt.ToMemberPatch(changes);
patch.CheckIsValid();
}
catch (JsonModelParseError e)
{
return BadRequest(e.Message);
}
catch (InvalidPatchException e)
{
return BadRequest($"Request field is invalid: {e.Message}");
}
var newMember = await _repo.UpdateMember(conn, member.Id, patch);
return Ok(newMember.ToJson(User.ContextFor(newMember)));

8
PluralKit.API/Controllers/v1/SystemController.cs
View File

@ -1,3 +1,4 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
@ -140,13 +141,18 @@ namespace PluralKit.API
try
{
patch = JsonModelExt.ToSystemPatch(changes);
patch.CheckIsValid();
}
catch (JsonModelParseError e)
{
return BadRequest(e.Message);
}
catch (InvalidPatchException e)
{
return BadRequest($"Request field '{e.Message}' is invalid.");
}
await _repo.UpdateSystem(conn, system!.Id, patch);
system = await _repo.UpdateSystem(conn, system!.Id, patch);
return Ok(system.ToJson(User.ContextFor(system)));
}

11
PluralKit.Bot/Utils/AvatarUtils.cs
View File

@ -25,17 +25,8 @@ namespace PluralKit.Bot {
using (var client = new HttpClient())
{
Uri uri;
try
{
uri = new Uri(url);
if (!uri.IsAbsoluteUri || (uri.Scheme != "http" && uri.Scheme != "https"))
if (!PluralKit.Core.MiscUtils.TryMatchUri(url, out var uri))
throw Errors.InvalidUrl(url);
}
catch (UriFormatException)
{
throw Errors.InvalidUrl(url);
}
var response = await client.GetAsync(uri);
if (!response.IsSuccessStatusCode) // Check status code

9
PluralKit.Core/Database/Repository/ModelRepository.Group.cs
View File

@ -1,5 +1,6 @@
#nullable enable
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
@ -30,22 +31,22 @@ namespace PluralKit.Core
return conn.QuerySingleOrDefaultAsync<int>(query.ToString(), new {Id = id, PrivacyFilter = privacyFilter});
}
public async Task<PKGroup> CreateGroup(IPKConnection conn, SystemId system, string name)
public async Task<PKGroup> CreateGroup(IPKConnection conn, SystemId system, string name, IDbTransaction? transaction = null)
{
var group = await conn.QueryFirstAsync<PKGroup>(
"insert into groups (hid, system, name) values (find_free_group_hid(), @System, @Name) returning *",
new {System = system, Name = name});
new {System = system, Name = name}, transaction);
_logger.Information("Created group {GroupId} in system {SystemId}: {GroupName}", group.Id, system, name);
return group;
}
public Task<PKGroup> UpdateGroup(IPKConnection conn, GroupId id, GroupPatch patch)
public Task<PKGroup> UpdateGroup(IPKConnection conn, GroupId id, GroupPatch patch, IDbTransaction? transaction = null)
{
_logger.Information("Updated {GroupId}: {@GroupPatch}", id, patch);
var (query, pms) = patch.Apply(UpdateQueryBuilder.Update("groups", "id = @id"))
.WithConstant("id", id)
.Build("returning *");
return conn.QueryFirstAsync<PKGroup>(query, pms);
return conn.QueryFirstAsync<PKGroup>(query, pms, transaction);
}
public Task DeleteGroup(IPKConnection conn, GroupId group)

9
PluralKit.Core/Database/Repository/ModelRepository.Member.cs
View File

@ -1,4 +1,5 @@
#nullable enable
using System.Data;
using System.Threading.Tasks;
using Dapper;
@ -19,23 +20,23 @@ namespace PluralKit.Core
public Task<PKMember?> GetMemberByDisplayName(IPKConnection conn, SystemId system, string name) =>
conn.QueryFirstOrDefaultAsync<PKMember?>("select * from members where lower(display_name) = lower(@Name) and system = @SystemID", new { Name = name, SystemID = system });
public async Task<PKMember> CreateMember(IPKConnection conn, SystemId id, string memberName)
public async Task<PKMember> CreateMember(IPKConnection conn, SystemId id, string memberName, IDbTransaction? transaction = null)
{
var member = await conn.QueryFirstAsync<PKMember>(
"insert into members (hid, system, name) values (find_free_member_hid(), @SystemId, @Name) returning *",
new {SystemId = id, Name = memberName});
new {SystemId = id, Name = memberName}, transaction);
_logger.Information("Created {MemberId} in {SystemId}: {MemberName}",
member.Id, id, memberName);
return member;
}
public Task<PKMember> UpdateMember(IPKConnection conn, MemberId id, MemberPatch patch)
public Task<PKMember> UpdateMember(IPKConnection conn, MemberId id, MemberPatch patch, IDbTransaction? transaction = null)
{
_logger.Information("Updated {MemberId}: {@MemberPatch}", id, patch);
var (query, pms) = patch.Apply(UpdateQueryBuilder.Update("members", "id = @id"))
.WithConstant("id", id)
.Build("returning *");
return conn.QueryFirstAsync<PKMember>(query, pms);
return conn.QueryFirstAsync<PKMember>(query, pms, transaction);
}
public Task DeleteMember(IPKConnection conn, MemberId id)

11
PluralKit.Core/Models/Patch/GroupPatch.cs
View File

@ -1,4 +1,6 @@
#nullable enable
using System.Text.RegularExpressions;
namespace PluralKit.Core
{
public class GroupPatch: PatchObject
@ -24,5 +26,14 @@ namespace PluralKit.Core
.With("icon_privacy", IconPrivacy)
.With("list_privacy", ListPrivacy)
.With("visibility", Visibility);
public new void CheckIsValid()
{
if (Icon.Value != null && !MiscUtils.TryMatchUri(Icon.Value, out var avatarUri))
throw new InvalidPatchException("avatar_url");
if (Color.Value != null && (!Regex.IsMatch(Color.Value, "^[0-9a-fA-F]{6}$")))
throw new InvalidPatchException("color");
}
}
}

10
PluralKit.Core/Models/Patch/MemberPatch.cs
View File

@ -1,4 +1,5 @@
#nullable enable
using System.Text.RegularExpressions;
using NodaTime;
@ -44,5 +45,14 @@ namespace PluralKit.Core
.With("birthday_privacy", BirthdayPrivacy)
.With("avatar_privacy", AvatarPrivacy)
.With("metadata_privacy", MetadataPrivacy);
public new void CheckIsValid()
{
if (AvatarUrl.Value != null && !MiscUtils.TryMatchUri(AvatarUrl.Value, out var avatarUri))
throw new InvalidPatchException("avatar_url");
if (Color.Value != null && (!Regex.IsMatch(Color.Value, "^[0-9a-fA-F]{6}$")))
throw new InvalidPatchException("color");
}
}
}

12
PluralKit.Core/Models/Patch/PatchObject.cs
View File

@ -1,7 +1,17 @@
namespace PluralKit.Core
using System;
namespace PluralKit.Core
{
public class InvalidPatchException : Exception
{
public InvalidPatchException(string message) : base(message) {}
}
public abstract class PatchObject
{
public abstract UpdateQueryBuilder Apply(UpdateQueryBuilder b);
public void CheckIsValid() {}
}
}

11
PluralKit.Core/Models/Patch/SystemPatch.cs
View File

@ -1,4 +1,6 @@
#nullable enable
using System.Text.RegularExpressions;
namespace PluralKit.Core
{
public class SystemPatch: PatchObject
@ -33,5 +35,14 @@ namespace PluralKit.Core
.With("front_history_privacy", FrontHistoryPrivacy)
.With("pings_enabled", PingsEnabled)
.With("latch_timeout", LatchTimeout);
public new void CheckIsValid()
{
if (AvatarUrl.Value != null && !MiscUtils.TryMatchUri(AvatarUrl.Value, out var avatarUri))
throw new InvalidPatchException("avatar_url");
if (Color.Value != null && (!Regex.IsMatch(Color.Value, "^[0-9a-fA-F]{6}$")))
throw new InvalidPatchException("color");
}
}
}

24
PluralKit.Core/Utils/MiscUtils.cs Normal file
View File

@ -0,0 +1,24 @@
using System;
namespace PluralKit.Core
{
public static class MiscUtils
{
public static bool TryMatchUri(string input, out Uri uri)
{
try
{
uri = new Uri(input);
if (!uri.IsAbsoluteUri || (uri.Scheme != "http" && uri.Scheme != "https"))
return false;
}
catch (UriFormatException)
{
uri = null;
return false;
}
return true;
}
}
}