Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat disable duplicate user or group permission #242

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,8 @@ describe('WorkspaceCreator', () => {
color: '#000000',
description: 'test workspace description',
defaultVISTheme: 'categorical',
})
}),
expect.any(Array)
);
await waitFor(() => {
expect(notificationToastsAddSuccess).toHaveBeenCalled();
Expand All @@ -190,7 +191,8 @@ describe('WorkspaceCreator', () => {
expect.objectContaining({
name: 'test workspace name',
features: expect.arrayContaining(['app1', 'app2', 'app3']),
})
}),
expect.any(Array)
);
await waitFor(() => {
expect(notificationToastsAddSuccess).toHaveBeenCalled();
Expand All @@ -216,10 +218,8 @@ describe('WorkspaceCreator', () => {
expect(workspaceClientCreate).toHaveBeenCalledWith(
expect.objectContaining({
name: 'test workspace name',
permissions: expect.arrayContaining([
expect.objectContaining({ type: 'user', userId: 'test user id' }),
]),
})
}),
expect.arrayContaining([expect.objectContaining({ type: 'user', userId: 'test user id' })])
);
await waitFor(() => {
expect(notificationToastsAddSuccess).toHaveBeenCalled();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export const WorkspaceCreator = () => {
async (data: WorkspaceFormSubmitData) => {
let result;
try {
result = await workspaceClient.create(data);
const { permissions, ...attributes } = data;
result = await workspaceClient.create(attributes, permissions);
} catch (error) {
notifications?.toasts.addDanger({
title: i18n.translate('workspace.create.failed', {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,20 @@ const getNumberOfErrors = (formErrors: WorkspaceFormErrors) => {
return numberOfErrors;
};

const isUserOrGroupPermissionSettingDuplicated = (
permissionSettings: Array<Partial<WorkspacePermissionSetting>>,
permissionSettingToCheck: WorkspacePermissionSetting
) =>
permissionSettings.some(
(permissionSetting) =>
(permissionSettingToCheck.type === WorkspacePermissionItemType.User &&
permissionSetting.type === WorkspacePermissionItemType.User &&
permissionSettingToCheck.userId === permissionSetting.userId) ||
(permissionSettingToCheck.type === WorkspacePermissionItemType.Group &&
permissionSetting.type === WorkspacePermissionItemType.Group &&
permissionSettingToCheck.group === permissionSetting.group)
);

const workspaceHtmlIdGenerator = htmlIdGenerator();

const defaultVISThemeOptions = [{ value: 'categorical', text: 'Categorical' }];
Expand Down Expand Up @@ -377,6 +391,14 @@ export const WorkspaceForm = ({
for (let i = 0; i < formData.permissions.length; i++) {
const permission = formData.permissions[i];
if (isValidWorkspacePermissionSetting(permission)) {
if (
isUserOrGroupPermissionSettingDuplicated(formData.permissions.slice(0, i), permission)
) {
permissionErrors[i] = i18n.translate('workspace.form.permission.invalidate.group', {
defaultMessage: 'Duplicate permission setting',
});
continue;
}
continue;
}
if (!permission.type) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ export const WorkspaceUpdater = () => {
return;
}
try {
result = await workspaceClient.update(currentWorkspace?.id, data);
const { permissions, ...attributes } = data;
result = await workspaceClient.update(currentWorkspace?.id, attributes, permissions);
} catch (error) {
notifications?.toasts.addDanger({
title: i18n.translate('workspace.update.failed', {
Expand Down
14 changes: 6 additions & 8 deletions src/plugins/workspace/public/workspace_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -176,16 +176,16 @@ export class WorkspaceClient {
* @returns
*/
public async create(
attributes: Omit<WorkspaceAttribute, 'id'> & {
permissions: WorkspaceRoutePermissionItem[];
}
attributes: Omit<WorkspaceAttribute, 'id'>,
permissions?: WorkspaceRoutePermissionItem[]
): Promise<IResponse<WorkspaceAttribute>> {
const path = this.getPath();

const result = await this.safeFetch<WorkspaceAttribute>(path, {
method: 'POST',
body: JSON.stringify({
attributes,
permissions,
}),
});

Expand Down Expand Up @@ -264,15 +264,13 @@ export class WorkspaceClient {
*/
public async update(
id: string,
attributes: Partial<
WorkspaceAttribute & {
permissions: WorkspaceRoutePermissionItem[];
}
>
attributes: Partial<WorkspaceAttribute>,
permissions?: WorkspaceRoutePermissionItem[]
): Promise<IResponse<boolean>> {
const path = this.getPath(id);
const body = {
attributes,
permissions,
};

const result = await this.safeFetch(path, {
Expand Down
111 changes: 24 additions & 87 deletions src/plugins/workspace/server/routes/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,8 @@
import { schema } from '@osd/config-schema';
import { ensureRawRequest } from '../../../../core/server';

import {
ACL,
Permissions,
CoreSetup,
Logger,
WorkspacePermissionMode,
} from '../../../../core/server';
import { IWorkspaceDBImpl, WorkspaceRoutePermissionItem } from '../types';
import { CoreSetup, Logger, WorkspacePermissionMode } from '../../../../core/server';
import { IWorkspaceDBImpl, WorkspacePermissionItem } from '../types';

export const WORKSPACES_API_BASE_URL = '/api/workspaces';

Expand All @@ -22,8 +16,6 @@ const workspacePermissionMode = schema.oneOf([
schema.literal(WorkspacePermissionMode.Write),
schema.literal(WorkspacePermissionMode.LibraryRead),
schema.literal(WorkspacePermissionMode.LibraryWrite),
schema.literal(WorkspacePermissionMode.Read),
schema.literal(WorkspacePermissionMode.Write),
]);

const workspacePermission = schema.oneOf([
Expand All @@ -47,44 +39,8 @@ const workspaceAttributesSchema = schema.object({
icon: schema.maybe(schema.string()),
reserved: schema.maybe(schema.boolean()),
defaultVISTheme: schema.maybe(schema.string()),
permissions: schema.maybe(
schema.oneOf([workspacePermission, schema.arrayOf(workspacePermission)])
),
});

const convertToACL = (
workspacePermissions: WorkspaceRoutePermissionItem | WorkspaceRoutePermissionItem[]
) => {
workspacePermissions = Array.isArray(workspacePermissions)
? workspacePermissions
: [workspacePermissions];

const acl = new ACL();

workspacePermissions.forEach((permission) => {
switch (permission.type) {
case 'user':
acl.addPermission(permission.modes, { users: [permission.userId] });
return;
case 'group':
acl.addPermission(permission.modes, { groups: [permission.group] });
return;
}
});

return acl.getPermissions() || {};
};

const convertFromACL = (permissions: Permissions) => {
const acl = new ACL(permissions);

return acl.toFlatList().map(({ name, permissions: modes, type }) => ({
type: type === 'users' ? 'user' : 'group',
modes,
...{ [type === 'users' ? 'userId' : 'group']: name },
}));
};

export function registerRoutes({
client,
logger,
Expand Down Expand Up @@ -123,18 +79,7 @@ export function registerRoutes({
return res.ok({ body: result });
}
return res.ok({
body: {
...result,
result: {
...result.result,
workspaces: result.result.workspaces.map((workspace) => ({
...workspace,
...(workspace.permissions
? { permissions: convertFromACL(workspace.permissions) }
: {}),
})),
},
},
body: result,
});
})
);
Expand Down Expand Up @@ -162,15 +107,7 @@ export function registerRoutes({
}

return res.ok({
body: {
...result,
result: {
...result.result,
...(result.result.permissions
? { permissions: convertFromACL(result.result.permissions) }
: {}),
},
},
body: result,
});
})
);
Expand All @@ -180,31 +117,29 @@ export function registerRoutes({
validate: {
body: schema.object({
attributes: workspaceAttributesSchema,
permissions: schema.maybe(
schema.oneOf([workspacePermission, schema.arrayOf(workspacePermission)])
),
}),
},
},
router.handleLegacyErrors(async (context, req, res) => {
const { attributes } = req.body;
const { attributes, permissions: permissionsInRequest } = req.body;
const rawRequest = ensureRawRequest(req);
const authInfo = rawRequest?.auth?.credentials?.authInfo as { user_name?: string } | null;
const { permissions: permissionsInAttributes, ...others } = attributes;
let permissions: WorkspaceRoutePermissionItem[] = [];
if (permissionsInAttributes) {
permissions = Array.isArray(permissionsInAttributes)
? permissionsInAttributes
: [permissionsInAttributes];
let permissions: WorkspacePermissionItem[] = [];
if (permissionsInRequest) {
permissions = Array.isArray(permissionsInRequest)
? permissionsInRequest
: [permissionsInRequest];
}

// Assign workspace owner to current user
if (!!authInfo?.user_name) {
permissions.push({
type: 'user',
userId: authInfo.user_name,
modes: [WorkspacePermissionMode.LibraryWrite],
});
permissions.push({
type: 'user',
userId: authInfo.user_name,
modes: [WorkspacePermissionMode.Write],
modes: [WorkspacePermissionMode.LibraryWrite, WorkspacePermissionMode.Write],
});
}

Expand All @@ -215,8 +150,8 @@ export function registerRoutes({
logger,
},
{
...others,
...(permissions.length ? { permissions: convertToACL(permissions) } : {}),
...attributes,
...(permissions.length ? { permissions } : {}),
}
);
return res.ok({ body: result });
Expand All @@ -231,14 +166,16 @@ export function registerRoutes({
}),
body: schema.object({
attributes: workspaceAttributesSchema,
permissions: schema.maybe(
schema.oneOf([workspacePermission, schema.arrayOf(workspacePermission)])
),
}),
},
},
router.handleLegacyErrors(async (context, req, res) => {
const { id } = req.params;
const { attributes } = req.body;
const { permissions, ...others } = attributes;
let finalPermissions: WorkspaceRoutePermissionItem[] = [];
const { attributes, permissions } = req.body;
let finalPermissions: WorkspacePermissionItem[] = [];
if (permissions) {
finalPermissions = Array.isArray(permissions) ? permissions : [permissions];
}
Expand All @@ -251,8 +188,8 @@ export function registerRoutes({
},
id,
{
...others,
...(finalPermissions.length ? { permissions: convertToACL(finalPermissions) } : {}),
...attributes,
...(finalPermissions.length ? { finalPermissions } : {}),
}
);
return res.ok({ body: result });
Expand Down
5 changes: 2 additions & 3 deletions src/plugins/workspace/server/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,12 @@ import {
SavedObjectsFindResponse,
CoreSetup,
WorkspacePermissionMode,
Permissions,
WorkspaceAttribute,
SavedObjectsServiceStart,
} from '../../../core/server';

export interface WorkspaceAttributeWithPermission extends WorkspaceAttribute {
permissions?: Permissions;
permissions?: WorkspacePermissionItem[];
}

export interface WorkspaceFindOptions {
Expand Down Expand Up @@ -75,7 +74,7 @@ export type IResponse<T> =
error?: string;
};

export type WorkspaceRoutePermissionItem = {
export type WorkspacePermissionItem = {
modes: Array<
| WorkspacePermissionMode.LibraryRead
| WorkspacePermissionMode.LibraryWrite
Expand Down
Loading
Loading