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.

Sign up for GitHub

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

[Saved Object Aggregation View] Use namespace registry to add tenant filter #1169

Merged
merged 16 commits into from
Nov 2, 2022
Merged

[Saved Object Aggregation View] Use namespace registry to add tenant filter #1169

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
1978641
[Saved Object Aggregation View] Use namespace register to register te…
cwperks Oct 28, 2022
1b81368
Run eslint --fix
cwperks Oct 28, 2022
91c999e
Merge branch 'main' into register-namespaces
cliu123 Oct 31, 2022
92cf494
Populate with [namespaceValue] if namespaces aren't provided with req…
cwperks Oct 31, 2022
ee9ead0
Merge branch 'register-namespaces' of https://github.com/cwperks/secu…
cwperks Oct 31, 2022
056d04c
Use _all convention for requests for all namespaces
cwperks Nov 1, 2022
6d919d5
Remove _all convention
cwperks Nov 1, 2022
571a130
Check for not undefined and not null
cwperks Nov 1, 2022
b49644b
Use not not when checking if namespaces is supplied in the request
cwperks Nov 1, 2022
ce58514
Merge branch 'main' into register-namespaces
DarshitChanpura Nov 2, 2022
abfae9a
Move utils to common folder
cliu123 Nov 2, 2022
0e1178b
Remove the unnecessary export tenantColumn in public/index.js
cliu123 Nov 2, 2022
30fd8f5
Move globalTenantName to common
cliu123 Nov 2, 2022
0993186
Merge branch 'move_utils_to_common_folder' into register-namespaces
cwperks Nov 2, 2022
c5a3a0f
import default tenant
cwperks Nov 2, 2022
e946d2f
Merge changes from main
cwperks Nov 2, 2022
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
27 changes: 27 additions & 0 deletions public/apps/configuration/utils/tenant-utils.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,33 @@ export function transformRoleTenantPermissions(
}));
}

export function getNamespacesToRegister(accountInfo: any) {
const tenants = accountInfo.tenants || {};
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cliu123 I noticed when testing this change that the following data structure comes out as:

{
    "global_tenant": true,
    "admin_tenant": true,
    "admin": true
}

Will the values in this map of tenants ever contain false? If so, should this skip over the tenants where the value in this object is false?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cwperks You might have logged in as admin, then you are expected to have all tenant permissions. If you create a role, grant permission to a specific tenant, create a user, map the role to the user, and log in as the user, then you'll see the difference.

const availableTenantNames = Object.keys(tenants!);
const namespacesToRegister = availableTenantNames.map((tenant) => {
if (tenant === globalTenantName) {
return {
id: GLOBAL_USER_DICT.Value,
name: GLOBAL_USER_DICT.Label,
};
} else if (tenant === accountInfo.user_name) {
return {
id: `${PRIVATE_USER_DICT.Value}${accountInfo.user_name}`,
name: PRIVATE_USER_DICT.Label,
};
}
return {
id: tenant,
name: tenant,
};
});
namespacesToRegister.push({
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will always include default in the dropdown. default comes into play when OSD deployments with existing saved objects enable the saved object aggregation view feature. These objects do not have the namespace of the saved object populated and will be given the default (or null) namespace.

id: DEFAULT_TENANT,
name: DEFAULT_TENANT,
});
return namespacesToRegister;
}

export function isPrivateTenant(selectedTenant: string | null) {
return selectedTenant !== null && selectedTenant === PRIVATE_TENANT_SYMBOL;
}
Expand Down
60 changes: 60 additions & 0 deletions public/apps/configuration/utils/test/tenant-utils.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import {
transformRoleTenantPermissionData,
getTenantPermissionType,
transformRoleTenantPermissions,
getNamespacesToRegister,
} from '../tenant-utils';
import {
RoleViewTenantInvalidText,
Expand Down Expand Up @@ -282,4 +283,63 @@ describe('Tenant list utils', () => {
expect(result[0]).toMatchObject(expectedRoleTenantPermissionView);
});
});

describe('get list of namespaces to register', () => {
it('resolves to list of namespaces with a custom tenant', () => {
const authInfo = {
user_name: 'user1',
tenants: {
global_tenant: true,
user1_tenant: true,
user1: true,
},
};
const expectedNamespaces = [
{
id: GLOBAL_USER_DICT.Value,
name: GLOBAL_USER_DICT.Label,
},
{
id: 'user1_tenant',
name: 'user1_tenant',
},
{
id: `${PRIVATE_USER_DICT.Value}user1`,
name: PRIVATE_USER_DICT.Label,
},
{
id: 'default',
name: 'default',
},
];
const result = getNamespacesToRegister(authInfo);
expect(result).toMatchObject(expectedNamespaces);
});

it('resolves to list of namespaces without a custom tenant', () => {
const authInfo = {
user_name: 'user1',
tenants: {
global_tenant: true,
user1: true,
},
};
const expectedNamespaces = [
{
id: GLOBAL_USER_DICT.Value,
name: GLOBAL_USER_DICT.Label,
},
{
id: `${PRIVATE_USER_DICT.Value}user1`,
name: PRIVATE_USER_DICT.Label,
},
{
id: 'default',
name: 'default',
},
];
const result = getNamespacesToRegister(authInfo);
expect(result).toMatchObject(expectedNamespaces);
});
});
});
9 changes: 8 additions & 1 deletion public/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import {
} from './types';
import { addTenantToShareURL } from './services/shared-link';
import { interceptError } from './utils/logout-utils';
import { tenantColumn } from './apps/configuration/utils/tenant-utils';
import { tenantColumn, getNamespacesToRegister } from './apps/configuration/utils/tenant-utils';

async function hasApiPermission(core: CoreSetup): Promise<boolean | undefined> {
try {
Expand Down Expand Up @@ -157,6 +157,13 @@ export class SecurityPlugin
deps.savedObjectsManagement.columns.register(
(tenantColumn as unknown) as SavedObjectsManagementColumn<string>
);
if (!!accountInfo) {
const namespacesToRegister = getNamespacesToRegister(accountInfo);
deps.savedObjectsManagement.namespaces.registerAlias('Tenant');
namespacesToRegister.forEach((ns) => {
deps.savedObjectsManagement.namespaces.register(ns as SavedObjectsManagementNamespace);
});
}
}

// Return methods that should be available to other plugins
Expand Down
29 changes: 17 additions & 12 deletions server/saved_objects/saved_objects_wrapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,24 +104,29 @@ export class SecuritySavedObjectsClientWrapper {
availableTenantNames.splice(index, 1);
}
}
const typeToNamespacesMap: any = {};
if (isPrivateTenant(selectedTenant!)) {
namespaceValue = selectedTenant! + username;
}
const searchTypes = Array.isArray(options.type) ? options.type : [options.type];
searchTypes.forEach((t) => {
if ('namespaces' in options) {
if (options.namespaces && options.namespaces.length > 0) {
const typeToNamespacesMap: any = {};
const searchTypes = Array.isArray(options.type) ? options.type : [options.type];
searchTypes.forEach((t) => {
typeToNamespacesMap[t] = options.namespaces;
} else {
typeToNamespacesMap[t] = availableTenantNames;
});
if (searchTypes.includes('config')) {
if (options.namespaces.includes(namespaceValue)) {
typeToNamespacesMap.config = [namespaceValue];
} else {
delete typeToNamespacesMap.config;
}
}
});
if ('config' in typeToNamespacesMap) {
typeToNamespacesMap.config = [namespaceValue];

options.typeToNamespacesMap = new Map(Object.entries(typeToNamespacesMap));
options.type = '';
options.namespaces = [];
} else {
options.namespaces = [namespaceValue];
}
options.typeToNamespacesMap = new Map(Object.entries(typeToNamespacesMap));
options.type = '';
options.namespaces = [];

return await wrapperOptions.client.find(options);
};
Expand Down