From 9e0c9e64cd0cfdc89d0f1e5128ac3c8adaf1cc3e Mon Sep 17 00:00:00 2001 From: Sebastian Date: Thu, 13 Jun 2019 16:49:59 +0100 Subject: [PATCH] Contributor fix. --- .../Apps/AppGrain.cs | 63 ++++++++--- .../Invitation/InviteUserCommandMiddleware.cs | 4 +- .../Apps/Invitation/InvitedResult.cs | 4 +- .../Apps/AppContributorsController.cs | 23 ++-- .../Apps/Models/ContributorAssignedDto.cs | 30 ------ .../Controllers/Apps/Models/ContributorDto.cs | 16 ++- .../Apps/Models/ContributorsDto.cs | 36 ++++++- .../Apps/Models/ContributorsMetadata.cs | 17 +++ .../Api/Controllers/Assets/Models/AssetDto.cs | 7 +- .../contributors-page.component.html | 15 +-- .../contributors-page.component.ts | 6 +- .../services/contributors.service.spec.ts | 101 ++++++++++++------ .../shared/services/contributors.service.ts | 63 +++++++---- .../shared/state/contributors.state.spec.ts | 76 ++++--------- .../app/shared/state/contributors.state.ts | 70 ++++-------- .../Apps/AppGrainTests.cs | 32 +++--- .../InviteUserCommandMiddlewareTests.cs | 8 +- 17 files changed, 320 insertions(+), 251 deletions(-) delete mode 100644 src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs create mode 100644 src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs diff --git a/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs b/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs index 63ac53ab9..11f93323c 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/AppGrain.cs @@ -60,11 +60,13 @@ namespace Squidex.Domain.Apps.Entities.Apps switch (command) { case CreateApp createApp: - return CreateAsync(createApp, c => + return CreateReturnAsync(createApp, async c => { GuardApp.CanCreate(c); Create(c); + + return await GetRawStateAsync(); }); case AssignContributor assignContributor: @@ -74,111 +76,137 @@ namespace Squidex.Domain.Apps.Entities.Apps AssignContributor(c, !Snapshot.Contributors.ContainsKey(assignContributor.ContributorId)); - return EntityCreatedResult.Create(c.ContributorId, Version); + return await GetRawStateAsync(); }); case RemoveContributor removeContributor: - return UpdateAsync(removeContributor, c => + return UpdateReturnAsync(removeContributor, async c => { GuardAppContributors.CanRemove(Snapshot.Contributors, c); RemoveContributor(c); + + return await GetRawStateAsync(); }); case AttachClient attachClient: - return UpdateAsync(attachClient, c => + return UpdateReturnAsync(attachClient, async c => { GuardAppClients.CanAttach(Snapshot.Clients, c); AttachClient(c); + + return await GetRawStateAsync(); }); case UpdateClient updateClient: - return UpdateAsync(updateClient, c => + return UpdateReturnAsync(updateClient, async c => { GuardAppClients.CanUpdate(Snapshot.Clients, c, Snapshot.Roles); UpdateClient(c); + + return await GetRawStateAsync(); }); case RevokeClient revokeClient: - return UpdateAsync(revokeClient, c => + return UpdateReturnAsync(revokeClient, async c => { GuardAppClients.CanRevoke(Snapshot.Clients, c); RevokeClient(c); + + return await GetRawStateAsync(); }); case AddLanguage addLanguage: - return UpdateAsync(addLanguage, c => + return UpdateReturnAsync(addLanguage, async c => { GuardAppLanguages.CanAdd(Snapshot.LanguagesConfig, c); AddLanguage(c); + + return await GetRawStateAsync(); }); case RemoveLanguage removeLanguage: - return UpdateAsync(removeLanguage, c => + return UpdateReturnAsync(removeLanguage, async c => { GuardAppLanguages.CanRemove(Snapshot.LanguagesConfig, c); RemoveLanguage(c); + + return await GetRawStateAsync(); }); case UpdateLanguage updateLanguage: - return UpdateAsync(updateLanguage, c => + return UpdateReturnAsync(updateLanguage, async c => { GuardAppLanguages.CanUpdate(Snapshot.LanguagesConfig, c); UpdateLanguage(c); + + return await GetRawStateAsync(); }); case AddRole addRole: - return UpdateAsync(addRole, c => + return UpdateReturnAsync(addRole, async c => { GuardAppRoles.CanAdd(Snapshot.Roles, c); AddRole(c); + + return await GetRawStateAsync(); }); case DeleteRole deleteRole: - return UpdateAsync(deleteRole, c => + return UpdateReturnAsync(deleteRole, async c => { GuardAppRoles.CanDelete(Snapshot.Roles, c, Snapshot.Contributors, Snapshot.Clients); DeleteRole(c); + + return await GetRawStateAsync(); }); case UpdateRole updateRole: - return UpdateAsync(updateRole, c => + return UpdateReturnAsync(updateRole, async c => { GuardAppRoles.CanUpdate(Snapshot.Roles, c); UpdateRole(c); + + return await GetRawStateAsync(); }); case AddPattern addPattern: - return UpdateAsync(addPattern, c => + return UpdateReturnAsync(addPattern, async c => { GuardAppPatterns.CanAdd(Snapshot.Patterns, c); AddPattern(c); + + return await GetRawStateAsync(); }); case DeletePattern deletePattern: - return UpdateAsync(deletePattern, c => + return UpdateReturnAsync(deletePattern, async c => { GuardAppPatterns.CanDelete(Snapshot.Patterns, c); DeletePattern(c); + + return await GetRawStateAsync(); }); case UpdatePattern updatePattern: - return UpdateAsync(updatePattern, c => + return UpdateReturnAsync(updatePattern, async c => { GuardAppPatterns.CanUpdate(Snapshot.Patterns, c); UpdatePattern(c); + + return await GetRawStateAsync(); }); case ChangePlan changePlan: @@ -384,6 +412,11 @@ namespace Squidex.Domain.Apps.Entities.Apps return new AppContributorAssigned { ContributorId = actor.Identifier, Role = Role.Owner }; } + public Task GetRawStateAsync() + { + return Task.FromResult(Snapshot); + } + public Task> GetStateAsync() { return J.AsTask(Snapshot); diff --git a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs index 0bf99f271..7bde0a4cd 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InviteUserCommandMiddleware.cs @@ -35,9 +35,9 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation await next(); - if (assignContributor.IsCreated && context.PlainResult is EntityCreatedResult id) + if (assignContributor.IsCreated && context.PlainResult is IAppEntity app) { - context.Complete(new InvitedResult { Id = id }); + context.Complete(new InvitedResult { App = app }); } return; diff --git a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs index 695be0a4b..45c6df7b9 100644 --- a/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs +++ b/src/Squidex.Domain.Apps.Entities/Apps/Invitation/InvitedResult.cs @@ -5,12 +5,10 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== -using Squidex.Infrastructure.Commands; - namespace Squidex.Domain.Apps.Entities.Apps.Invitation { public sealed class InvitedResult { - public EntityCreatedResult Id { get; set; } + public IAppEntity App { get; set; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs index 98187cf77..acc83e266 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/AppContributorsController.cs @@ -9,6 +9,7 @@ using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Net.Http.Headers; using Squidex.Areas.Api.Controllers.Apps.Models; +using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Commands; using Squidex.Domain.Apps.Entities.Apps.Invitation; using Squidex.Domain.Apps.Entities.Apps.Services; @@ -47,7 +48,7 @@ namespace Squidex.Areas.Api.Controllers.Apps [ApiCosts(0)] public IActionResult GetContributors(string app) { - var response = ContributorsDto.FromApp(App, appPlansProvider); + var response = ContributorsDto.FromApp(App, appPlansProvider, this, false); Response.Headers[HeaderNames.ETag] = App.Version.ToString(); @@ -66,7 +67,7 @@ namespace Squidex.Areas.Api.Controllers.Apps /// [HttpPost] [Route("apps/{app}/contributors/")] - [ProducesResponseType(typeof(ContributorAssignedDto), 201)] + [ProducesResponseType(typeof(ContributorsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppContributorsAssign)] [ApiCosts(1)] @@ -75,15 +76,15 @@ namespace Squidex.Areas.Api.Controllers.Apps var command = request.ToCommand(); var context = await CommandBus.PublishAsync(command); - var response = (ContributorAssignedDto)null; + var response = (ContributorsDto)null; - if (context.PlainResult is EntityCreatedResult idOrValue) + if (context.PlainResult is IAppEntity newApp) { - response = ContributorAssignedDto.FromId(idOrValue.IdOrValue, false); + response = ContributorsDto.FromApp(newApp, appPlansProvider, this, false); } else if (context.PlainResult is InvitedResult invited) { - response = ContributorAssignedDto.FromId(invited.Id.IdOrValue, true); + response = ContributorsDto.FromApp(invited.App, appPlansProvider, this, true); } return Ok(response); @@ -95,20 +96,24 @@ namespace Squidex.Areas.Api.Controllers.Apps /// The name of the app. /// The id of the contributor. /// - /// 204 => User removed from app. + /// 200 => User removed from app. /// 400 => User is not assigned to the app. /// 404 => Contributor or app not found. /// [HttpDelete] [Route("apps/{app}/contributors/{id}/")] + [ProducesResponseType(typeof(ContributorsDto), 200)] [ProducesResponseType(typeof(ErrorDto), 400)] [ApiPermission(Permissions.AppContributorsRevoke)] [ApiCosts(1)] public async Task DeleteContributor(string app, string id) { - await CommandBus.PublishAsync(new RemoveContributor { ContributorId = id }); + var command = new RemoveContributor { ContributorId = id }; + var context = await CommandBus.PublishAsync(command); - return NoContent(); + var response = ContributorsDto.FromApp(context.Result(), appPlansProvider, this, false); + + return Ok(response); } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs deleted file mode 100644 index 871fcc6e9..000000000 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorAssignedDto.cs +++ /dev/null @@ -1,30 +0,0 @@ -// ========================================================================== -// Squidex Headless CMS -// ========================================================================== -// Copyright (c) Squidex UG (haftungsbeschraenkt) -// All rights reserved. Licensed under the MIT license. -// ========================================================================== - -using System.ComponentModel.DataAnnotations; - -namespace Squidex.Areas.Api.Controllers.Apps.Models -{ - public sealed class ContributorAssignedDto - { - /// - /// The id of the user that has been assigned as contributor. - /// - [Required] - public string ContributorId { get; set; } - - /// - /// Indicates if the user was created. - /// - public bool IsCreated { get; set; } - - public static ContributorAssignedDto FromId(string id, bool isCreated) - { - return new ContributorAssignedDto { ContributorId = id, IsCreated = isCreated }; - } - } -} diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs index 42ea190e5..30814f92d 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorDto.cs @@ -5,11 +5,13 @@ // All rights reserved. Licensed under the MIT license. // ========================================================================== +using System; using System.ComponentModel.DataAnnotations; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class ContributorDto + public sealed class ContributorDto : Resource { /// /// The id of the user that contributes to the app. @@ -21,5 +23,17 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// The role of the contributor. /// public string Role { get; set; } + + public static ContributorDto FromIdAndRole(string id, string role, ApiController controller, string app) + { + var result = new ContributorDto { ContributorId = id, Role = role }; + + return CreateLinks(result, controller, app); + } + + private static ContributorDto CreateLinks(ContributorDto result, ApiController controller, string app) + { + return result; + } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs index e482b1a69..cbeaab92c 100644 --- a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsDto.cs @@ -6,13 +6,15 @@ // ========================================================================== using System.ComponentModel.DataAnnotations; +using Newtonsoft.Json; using Squidex.Domain.Apps.Entities.Apps; using Squidex.Domain.Apps.Entities.Apps.Services; using Squidex.Infrastructure; +using Squidex.Web; namespace Squidex.Areas.Api.Controllers.Apps.Models { - public sealed class ContributorsDto + public sealed class ContributorsDto : Resource { /// /// The contributors. @@ -25,13 +27,37 @@ namespace Squidex.Areas.Api.Controllers.Apps.Models /// public int MaxContributors { get; set; } - public static ContributorsDto FromApp(IAppEntity app, IAppPlansProvider plans) + /// + /// The metadata. + /// + [JsonProperty("_meta")] + public ContributorsMetadata Metadata { get; set; } + + public static ContributorsDto FromApp(IAppEntity app, IAppPlansProvider plans, ApiController controller, bool isInvited) { - var plan = plans.GetPlanForApp(app); + var contributors = app.Contributors.ToArray(x => ContributorDto.FromIdAndRole(x.Key, x.Value, controller, app.Name)); + + var result = new ContributorsDto + { + Contributors = contributors, + }; - var contributors = app.Contributors.ToArray(x => new ContributorDto { ContributorId = x.Key, Role = x.Value }); + if (isInvited) + { + result.Metadata = new ContributorsMetadata + { + IsInvited = isInvited.ToString() + }; + } - return new ContributorsDto { Contributors = contributors, MaxContributors = plan.MaxContributors }; + result.MaxContributors = plans.GetPlanForApp(app).MaxContributors; + + return CreateLinks(result, controller, app.Name); + } + + private static ContributorsDto CreateLinks(ContributorsDto result, ApiController controller, string app) + { + return result; } } } diff --git a/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs new file mode 100644 index 000000000..0d0950441 --- /dev/null +++ b/src/Squidex/Areas/Api/Controllers/Apps/Models/ContributorsMetadata.cs @@ -0,0 +1,17 @@ +// ========================================================================== +// Squidex Headless CMS +// ========================================================================== +// Copyright (c) Squidex UG (haftungsbeschraenkt) +// All rights reserved. Licensed under the MIT license. +// ========================================================================== + +namespace Squidex.Areas.Api.Controllers.Apps.Models +{ + public sealed class ContributorsMetadata + { + /// + /// Indicates whether the user has been invited. + /// + public string IsInvited { get; set; } + } +} diff --git a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs index 67d292a78..f44c9d25a 100644 --- a/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs +++ b/src/Squidex/Areas/Api/Controllers/Assets/Models/AssetDto.cs @@ -112,8 +112,11 @@ namespace Squidex.Areas.Api.Controllers.Assets.Models /// public long Version { get; set; } + /// + /// The metadata. + /// [JsonProperty("_meta")] - public AssetMetadata Meta { get; set; } + public AssetMetadata Metadata { get; set; } public static AssetDto FromAsset(IAssetEntity asset, ApiController controller, string app, bool isDuplicate = false) { @@ -121,7 +124,7 @@ namespace Squidex.Areas.Api.Controllers.Assets.Models if (isDuplicate) { - response.Meta = new AssetMetadata { IsDuplicate = "true" }; + response.Metadata = new AssetMetadata { IsDuplicate = "true" }; } return CreateLinks(response, controller, app); diff --git a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.html b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.html index 5019d2d82..83a3223b2 100644 --- a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.html +++ b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.html @@ -23,21 +23,24 @@ - + @@ -47,7 +50,7 @@
- + - {{contributorInfo.contributor.contributorId | sqxUserName}} + {{contributor.contributorId | sqxUserName}} - -
-
+
diff --git a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts index 79105759c..0d5e85e6b 100644 --- a/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts +++ b/src/Squidex/app/features/settings/pages/contributors/contributors-page.component.ts @@ -37,7 +37,7 @@ export class UsersDataSource implements AutocompleteSource { const results: any[] = []; for (let user of users) { - if (!contributors!.find(t => t.contributor.contributorId === user.id)) { + if (!contributors!.find(t => t.contributorId === user.id)) { results.push(user); } } @@ -110,7 +110,7 @@ export class ContributorsPageComponent implements OnInit { } } - public trackByContributor(index: number, contributorInfo: { contributor: ContributorDto }) { - return contributorInfo.contributor.contributorId; + public trackByContributor(index: number, contributor: ContributorDto) { + return contributor.contributorId; } } diff --git a/src/Squidex/app/shared/services/contributors.service.spec.ts b/src/Squidex/app/shared/services/contributors.service.spec.ts index 930f1b9c0..f069d2551 100644 --- a/src/Squidex/app/shared/services/contributors.service.spec.ts +++ b/src/Squidex/app/shared/services/contributors.service.spec.ts @@ -11,11 +11,13 @@ import { inject, TestBed } from '@angular/core/testing'; import { AnalyticsService, ApiUrlConfig, - ContributorAssignedDto, ContributorDto, ContributorsDto, + ContributorsPayload, ContributorsService, - Version + Resource, + Version, + withLinks } from '@app/shared/internal'; describe('ContributorsService', () => { @@ -52,34 +54,13 @@ describe('ContributorsService', () => { expect(req.request.method).toEqual('GET'); expect(req.request.headers.get('If-Match')).toBeNull(); - req.flush({ - contributors: [ - { - contributorId: '123', - role: 'Owner' - }, - { - contributorId: '456', - role: 'Owner' - } - ], - maxContributors: 100 - }, { + req.flush(contributorsResponse(1, 2, 3), { headers: { etag: '2' } }); - expect(contributors!).toEqual({ - payload: { - contributors: [ - new ContributorDto('123', 'Owner'), - new ContributorDto('456', 'Owner') - ], - maxContributors: 100 - }, - version: new Version('2') - }); + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); it('should make post request to assign contributor', @@ -87,10 +68,10 @@ describe('ContributorsService', () => { const dto = { contributorId: '123', role: 'Owner' }; - let contributorAssignedDto: ContributorAssignedDto; + let contributors: ContributorsDto; contributorsService.postContributor('my-app', dto, version).subscribe(result => { - contributorAssignedDto = result.payload; + contributors = result; }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/contributors'); @@ -98,21 +79,77 @@ describe('ContributorsService', () => { expect(req.request.method).toEqual('POST'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({ contributorId: '123', isCreated: true }); + req.flush(contributorsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); - expect(contributorAssignedDto!.contributorId).toEqual('123'); + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); it('should make delete request to remove contributor', inject([ContributorsService, HttpTestingController], (contributorsService: ContributorsService, httpMock: HttpTestingController) => { - contributorsService.deleteContributor('my-app', '123', version).subscribe(); + const resource: Resource = { + _links: { + 'delete': { method: 'DELETE', href: '/api/apps/my-app/contributors/123' } + } + }; + + let contributors: ContributorsDto; + + contributorsService.deleteContributor('my-app', resource, version).subscribe(result => { + contributors = result; + }); const req = httpMock.expectOne('http://service/p/api/apps/my-app/contributors/123'); expect(req.request.method).toEqual('DELETE'); expect(req.request.headers.get('If-Match')).toEqual(version.value); - req.flush({}); + req.flush(contributorsResponse(1, 2, 3), { + headers: { + etag: '2' + } + }); + + expect(contributors!).toEqual({ payload: createContributors(1, 2, 3), version: new Version('2') }); })); -}); \ No newline at end of file + + function contributorsResponse(...ids: number[]) { + return { + contributors: ids.map(id => ({ + contributorId: `id${id}`, role: id % 2 === 0 ? 'Owner' : 'Developer', + _links: { + update: { method: 'PUT', href: `/contributors/id${id}` } + } + })), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + } + }; + } +}); + +export function createContributors(...ids: number[]): ContributorsPayload { + return { + contributors: ids.map(id => + withLinks(new ContributorDto(`id${id}`, id % 2 === 0 ? 'Owner' : 'Developer'), { + _links: { + update: { method: 'PUT', href: `/contributors/id${id}` } + } + })), + maxContributors: ids.length * 13, + _links: { + create: { method: 'POST', href: '/contributors' } + }, + _meta: { + isInvited: 'true' + } + }; +} \ No newline at end of file diff --git a/src/Squidex/app/shared/services/contributors.service.ts b/src/Squidex/app/shared/services/contributors.service.ts index 690d10818..73b56bb0b 100644 --- a/src/Squidex/app/shared/services/contributors.service.ts +++ b/src/Squidex/app/shared/services/contributors.service.ts @@ -15,18 +15,27 @@ import { ApiUrlConfig, HTTP, mapVersioned, + Metadata, Model, pretifyError, + Resource, + ResourceLinks, Version, - Versioned + Versioned, + withLinks } from '@app/framework'; -export type ContributorsDto = Versioned<{ +export type ContributorsDto = Versioned; +export type ContributorsPayload = { + readonly _links?: ResourceLinks, + readonly _meta?: Metadata readonly contributors: ContributorDto[], readonly maxContributors: number -}>; +}; export class ContributorDto extends Model { + public readonly _links: ResourceLinks = {}; + constructor( public readonly contributorId: string, public readonly role: string @@ -35,11 +44,6 @@ export class ContributorDto extends Model { } } -export interface ContributorAssignedDto { - readonly contributorId: string; - readonly isCreated?: boolean; -} - export interface AssignContributorDto { readonly contributorId: string; readonly role: string; @@ -62,25 +66,19 @@ export class ContributorsService { mapVersioned(payload => { const body = payload.body; - const items: any[] = body.contributors; - - const contributors = - items.map(item => - new ContributorDto( - item.contributorId, - item.role)); - - return { contributors, maxContributors: body.maxContributors }; + return parseContributors(body); }), pretifyError('Failed to load contributors. Please reload.')); } - public postContributor(appName: string, dto: AssignContributorDto, version: Version): Observable> { + public postContributor(appName: string, dto: AssignContributorDto, version: Version): Observable { const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors`); return HTTP.postVersioned(this.http, url, dto, version).pipe( mapVersioned(payload => { - return payload.body; + const body = payload.body; + + return parseContributors(body); }), tap(() => { this.analytics.trackEvent('Contributor', 'Configured', appName); @@ -88,13 +86,34 @@ export class ContributorsService { pretifyError('Failed to add contributors. Please reload.')); } - public deleteContributor(appName: string, contributorId: string, version: Version): Observable> { - const url = this.apiUrl.buildUrl(`api/apps/${appName}/contributors/${contributorId}`); + public deleteContributor(appName: string, resource: Resource, version: Version): Observable { + const link = resource._links['delete']; + + const url = this.apiUrl.buildUrl(link.href); - return HTTP.deleteVersioned(this.http, url, version).pipe( + return HTTP.requestVersioned(this.http, link.method, url, version).pipe( + mapVersioned(payload => { + const body = payload.body; + + return parseContributors(body); + }), tap(() => { this.analytics.trackEvent('Contributor', 'Deleted', appName); }), pretifyError('Failed to delete contributors. Please reload.')); } +} + +function parseContributors(body: any) { + const items: any[] = body.contributors; + + const contributors = + items.map(item => + withLinks( + new ContributorDto( + item.contributorId, + item.role), + item)); + + return withLinks({ contributors, maxContributors: body.maxContributors, _links: {} }, body); } \ No newline at end of file diff --git a/src/Squidex/app/shared/state/contributors.state.spec.ts b/src/Squidex/app/shared/state/contributors.state.spec.ts index f103f4bad..f529d80fb 100644 --- a/src/Squidex/app/shared/state/contributors.state.spec.ts +++ b/src/Squidex/app/shared/state/contributors.state.spec.ts @@ -9,29 +9,25 @@ import { of } from 'rxjs'; import { IMock, It, Mock, Times } from 'typemoq'; import { - ContributorDto, ContributorsService, ContributorsState, DialogService, versioned } from '@app/shared/internal'; +import { createContributors } from '../services/contributors.service.spec'; + import { TestValues } from './_test-helpers'; describe('ContributorsState', () => { const { app, appsState, - authService, - modifier, newVersion, version } = TestValues; - const oldContributors = [ - new ContributorDto('id1', 'Developer'), - new ContributorDto(modifier, 'Developer') - ]; + const oldContributors = createContributors(1, 2, 3); let dialogs: IMock; let contributorsService: IMock; @@ -41,7 +37,7 @@ describe('ContributorsState', () => { dialogs = Mock.ofType(); contributorsService = Mock.ofType(); - contributorsState = new ContributorsState(contributorsService.object, appsState.object, authService.object, dialogs.object); + contributorsState = new ContributorsState(contributorsService.object, appsState.object, dialogs.object); }); afterEach(() => { @@ -51,17 +47,14 @@ describe('ContributorsState', () => { describe('Loading', () => { it('should load contributors', () => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load().subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: oldContributors[1] } - ]); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); expect(contributorsState.snapshot.isMaxReached).toBeFalsy(); expect(contributorsState.snapshot.isLoaded).toBeTruthy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(version); dialogs.verify(x => x.notifyInfo(It.isAnyString()), Times.never()); @@ -69,7 +62,7 @@ describe('ContributorsState', () => { it('should show notification on load when reload is true', () => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load(true).subscribe(); @@ -82,61 +75,36 @@ describe('ContributorsState', () => { describe('Updates', () => { beforeEach(() => { contributorsService.setup(x => x.getContributors(app)) - .returns(() => of(versioned(version, { contributors: oldContributors, maxContributors: 3 }))).verifiable(); + .returns(() => of(versioned(version, oldContributors))).verifiable(); contributorsState.load().subscribe(); }); - it('should add contributor to snapshot when assigned', () => { - const newContributor = new ContributorDto('id3', 'Developer'); + it('should update contributors when user assigned', () => { + const updated = createContributors(1, 2, 3); - const request = { contributorId: 'mail2stehle@gmail.com', role: newContributor.role }; - const response = { contributorId: newContributor.contributorId, isCreated: true }; + const request = { contributorId: 'mail2stehle@gmail.com', role: 'Developer' }; contributorsService.setup(x => x.postContributor(app, request, version)) - .returns(() => of(versioned(newVersion, response))).verifiable(); + .returns(() => of(versioned(newVersion, updated))).verifiable(); contributorsState.assign(request).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: oldContributors[1] }, - { isCurrentUser: false, contributor: newContributor } - ]); - expect(contributorsState.snapshot.isMaxReached).toBeTruthy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); - it('should update contributor in snapshot when assigned and already added', () => { - const newContributor = new ContributorDto(modifier, 'Owner'); - - const request = { ...newContributor }; - const response = { contributorId: newContributor.contributorId, isCreated: true }; - - contributorsService.setup(x => x.postContributor(app, request, version)) - .returns(() => of(versioned(newVersion, response))).verifiable(); - - contributorsState.assign(request).subscribe(); - - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: false, contributor: oldContributors[0] }, - { isCurrentUser: true, contributor: newContributor } - ]); - expect(contributorsState.snapshot.isMaxReached).toBeFalsy(); - expect(contributorsState.snapshot.maxContributors).toBe(3); - expect(contributorsState.snapshot.version).toEqual(newVersion); - }); + it('should update contributors when contribution revoked', () => { + const updated = createContributors(1, 2, 3); - it('should remove contributor from snapshot when revoked', () => { - contributorsService.setup(x => x.deleteContributor(app, oldContributors[0].contributorId, version)) - .returns(() => of(versioned(newVersion))).verifiable(); + contributorsService.setup(x => x.deleteContributor(app, oldContributors.contributors[0], version)) + .returns(() => of(versioned(newVersion, updated))).verifiable(); - contributorsState.revoke(oldContributors[0]).subscribe(); + contributorsState.revoke(oldContributors.contributors[0]).subscribe(); - expect(contributorsState.snapshot.contributors.values).toEqual([ - { isCurrentUser: true, contributor: oldContributors[1] } - ]); + expect(contributorsState.snapshot.contributors.values).toEqual(oldContributors.contributors); + expect(contributorsState.snapshot.maxContributors).toBe(oldContributors.maxContributors); expect(contributorsState.snapshot.version).toEqual(newVersion); }); }); diff --git a/src/Squidex/app/shared/state/contributors.state.ts b/src/Squidex/app/shared/state/contributors.state.ts index be7a8c83b..70f2eee03 100644 --- a/src/Squidex/app/shared/state/contributors.state.ts +++ b/src/Squidex/app/shared/state/contributors.state.ts @@ -13,6 +13,7 @@ import { DialogService, ErrorDto, ImmutableArray, + ResourceLinks, shareMapSubscribed, shareSubscribed, State, @@ -23,20 +24,12 @@ import { import { AssignContributorDto, ContributorDto, + ContributorsPayload, ContributorsService } from './../services/contributors.service'; -import { AuthService } from './../services/auth.service'; import { AppsState } from './apps.state'; -interface SnapshotContributor { - // The contributor. - contributor: ContributorDto; - - // Indicates if the contributor is the ucrrent user. - isCurrentUser: boolean; -} - interface Snapshot { // All loaded contributors. contributors: ContributorsList; @@ -52,9 +45,12 @@ interface Snapshot { // The app version. version: Version; + + // The links. + links: ResourceLinks; } -type ContributorsList = ImmutableArray; +type ContributorsList = ImmutableArray; @Injectable() export class ContributorsState extends State { @@ -74,13 +70,16 @@ export class ContributorsState extends State { this.changes.pipe(map(x => x.maxContributors), distinctUntilChanged()); + public links = + this.changes.pipe(map(x => x.links), + distinctUntilChanged()); + constructor( private readonly contributorsService: ContributorsService, private readonly appsState: AppsState, - private readonly authState: AuthService, private readonly dialogs: DialogService ) { - super({ contributors: ImmutableArray.empty(), version: new Version(''), maxContributors: -1 }); + super({ contributors: ImmutableArray.empty(), version: new Version(''), maxContributors: -1, links: {} }); } public load(isReload = false): Observable { @@ -94,19 +93,15 @@ export class ContributorsState extends State { this.dialogs.notifyInfo('Contributors reloaded.'); } - const contributors = ImmutableArray.of(payload.contributors.map(x => this.createContributor(x))); - - this.replaceContributors(contributors, version, payload.maxContributors); + this.replaceContributors(version, payload); }), shareSubscribed(this.dialogs)); } public revoke(contributor: ContributorDto): Observable { - return this.contributorsService.deleteContributor(this.appName, contributor.contributorId, this.version).pipe( - tap(({ version }) => { - const contributors = this.snapshot.contributors.filter(x => x.contributor.contributorId !== contributor.contributorId); - - this.replaceContributors(contributors, version); + return this.contributorsService.deleteContributor(this.appName, contributor, this.version).pipe( + tap(({ version, payload }) => { + this.replaceContributors(version, payload); }), shareSubscribed(this.dialogs)); } @@ -121,32 +116,21 @@ export class ContributorsState extends State { } }), tap(({ version, payload }) => { - const contributors = this.updateContributors(payload.contributorId, request.role); - - this.replaceContributors(contributors, version); + this.replaceContributors(version, payload); }), - shareMapSubscribed(this.dialogs, x => x.payload.isCreated)); + shareMapSubscribed(this.dialogs, x => x.payload._meta && x.payload._meta['isInvited'] === '1')); } - private updateContributors(id: string, role: string) { - const contributor = new ContributorDto(id, role); - const contributors = this.snapshot.contributors; - - if (contributors.find(x => x.contributor.contributorId === id)) { - return contributors.map(x => x.contributor.contributorId === id ? this.createContributor(contributor) : x); - } else { - return contributors.push(this.createContributor(contributor)); - } - } - - private replaceContributors(contributors: ImmutableArray, version: Version, maxContributors?: number) { + private replaceContributors(version: Version, payload: ContributorsPayload) { this.next(s => { - maxContributors = maxContributors || s.maxContributors; + const maxContributors = payload.maxContributors || s.maxContributors; const isLoaded = true; - const isMaxReached = maxContributors > 0 && maxContributors <= contributors.length; + const isMaxReached = maxContributors > 0 && maxContributors <= payload.contributors.length; + + const contributors = ImmutableArray.of(payload.contributors); - return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version }; + return { ...s, contributors, maxContributors, isLoaded, isMaxReached, version: version, links: payload._links }; }); } @@ -154,15 +138,7 @@ export class ContributorsState extends State { return this.appsState.appName; } - private get userId() { - return this.authState.user!.id; - } - private get version() { return this.snapshot.version; } - - private createContributor(contributor: ContributorDto): SnapshotContributor { - return { contributor, isCurrentUser: contributor.contributorId === this.userId }; - } } \ No newline at end of file diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs index cf6a405df..b5d79dee6 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/AppGrainTests.cs @@ -84,7 +84,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(Id, 4)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(AppName, sut.Snapshot.Name); @@ -187,7 +187,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(contributorId, 5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Role.Editor, sut.Snapshot.Contributors[contributorId]); @@ -207,7 +207,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(EntityCreatedResult.Create(contributorId, 6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(Role.Owner, sut.Snapshot.Contributors[contributorId]); @@ -227,7 +227,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.Contributors.ContainsKey(contributorId)); @@ -246,7 +246,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.Clients.ContainsKey(clientId)); @@ -266,7 +266,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.Clients.ContainsKey(clientId)); @@ -286,7 +286,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(7)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(clientNewName, sut.Snapshot.Clients[clientId].Name); @@ -306,7 +306,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -326,7 +326,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.False(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -346,7 +346,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.True(sut.Snapshot.LanguagesConfig.Contains(Language.DE)); @@ -365,7 +365,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(5, sut.Snapshot.Roles.Count); @@ -385,7 +385,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(4, sut.Snapshot.Roles.Count); @@ -405,7 +405,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( @@ -422,7 +422,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(5)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(initialPatterns.Count + 1, sut.Snapshot.Patterns.Count); @@ -442,7 +442,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); Assert.Equal(initialPatterns.Count, sut.Snapshot.Patterns.Count); @@ -462,7 +462,7 @@ namespace Squidex.Domain.Apps.Entities.Apps var result = await sut.ExecuteAsync(CreateCommand(command)); - result.ShouldBeEquivalent(new EntitySavedResult(6)); + result.ShouldBeEquivalent(sut.Snapshot); LastEvents .ShouldHaveSameEvents( diff --git a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs index 24e01634a..32a17a952 100644 --- a/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs +++ b/tests/Squidex.Domain.Apps.Entities.Tests/Apps/Invitation/InviteUserCommandMiddlewareTests.cs @@ -34,13 +34,13 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .Returns(true); - var result = EntityCreatedResult.Create("13", 13L); + var result = A.Fake(); context.Complete(result); await sut.HandleAsync(context); - Assert.Same(context.Result().Id, result); + Assert.Same(context.Result().App, result); A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .MustHaveHappened(); @@ -55,13 +55,13 @@ namespace Squidex.Domain.Apps.Entities.Apps.Invitation A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .Returns(false); - var result = EntityCreatedResult.Create("13", 13L); + var result = A.Fake(); context.Complete(result); await sut.HandleAsync(context); - Assert.Same(context.Result>(), result); + Assert.Same(context.Result(), result); A.CallTo(() => userResolver.CreateUserIfNotExists("me@email.com", true)) .MustHaveHappened();