{
Company Data Usage
-
;
+ monthUsage: Record;
+ yearUsage: Record;
+ }
+ >
data={this.users.result}
columns={[
{
@@ -1008,46 +1015,74 @@ export default class CompanyPage extends React.Component {
Header: emailHeader,
accessor: 'userEmail',
minWidth: 200,
- onFilter: (data: UserOverviewUsage, keyword) =>
+ onFilter: (data, keyword) =>
filterByKeyword(data.userEmail, keyword),
},
- {
- id: 'totalUsage',
- Header: usageHeader,
- minWidth: 100,
- accessor: 'totalUsage',
- Cell(props: { original: UserOverviewUsage }) {
- return (
-
- );
- },
- },
this.resourcesTypeToggleValue ===
ToggleValue.ALL_RESOURCES
? {
- id: 'endpoint',
+ id: 'totalUsage',
+ Header: usageHeader,
+ minWidth: 100,
+ Cell(props: {
+ original: UserOverviewUsage;
+ }) {
+ return (
+
+ );
+ },
+ }
+ : {
+ id: 'totalUsage',
+ Header: usageHeader,
+ minWidth: 100,
+ Cell(props: {
+ original: UserOverviewUsage;
+ }) {
+ return (
+
+ );
+ },
+ },
+ this.resourcesTypeToggleValue ===
+ ToggleValue.ALL_RESOURCES
+ ? {
+ id: 'mostUsedEndpoint',
Header: endpointHeader,
minWidth: 200,
- accessor: 'endpoint',
- onFilter: (
- data: UserOverviewUsage,
- keyword
- ) =>
- filterByKeyword(data.endpoint, keyword),
+ onFilter: (data, keyword) =>
+ filterByKeyword(
+ data.yearUsage[currentYearStr]
+ ?.mostUsedEndpoint,
+ keyword
+ ),
+ accessor: x =>
+ x.yearUsage[currentYearStr]
+ ?.mostUsedEndpoint,
}
: {
- id: 'noPrivateEndpoint',
- Header: noPrivateEndpointHeader,
+ id: 'mostUsedPublicEndpoint',
+ Header: publicEndpointHeader,
minWidth: 200,
- accessor: 'noPrivateEndpoint',
- onFilter: (
- data: UserOverviewUsage,
- keyword
- ) =>
+ accessor: x =>
+ x.yearUsage[currentYearStr]
+ ?.mostUsedPublicEndpoint,
+ onFilter: (data, keyword) =>
filterByKeyword(
- data.noPrivateEndpoint,
+ data.yearUsage[currentYearStr]
+ ?.mostUsedPublicEndpoint,
keyword
),
},
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsPage.tsx b/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsPage.tsx
index 04622fd65..8e1400908 100644
--- a/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsPage.tsx
+++ b/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsPage.tsx
@@ -5,15 +5,14 @@ import { inject, observer } from 'mobx-react';
import { RouterStore } from 'mobx-react-router';
import React from 'react';
import { match } from 'react-router-dom';
-import { ToggleValue, UsageRecord } from './UsageAnalysisPage';
import Client from 'app/shared/api/clientInstance';
-import {
- USAGE_DETAIL_TIME_KEY,
- USAGE_ALL_TIME_KEY,
- USAGE_ALL_TIME_VALUE,
-} from 'app/config/constants';
import ResourceUsageDetailsTable from './ResourceUsageDetailsTable';
import { decodeResourceUsageDetailPageURL } from 'app/shared/utils/Utils';
+import {
+ TimeGroupedUsageRecords,
+ mapUsageSummaryToTimeGroupedUsageRecords,
+ ToggleValue,
+} from './usage-analysis-utils';
@inject('routing')
@observer
@@ -27,40 +26,21 @@ export default class ResourceUsageDetailsPage extends React.Component<{
this.props.match.params['endpoint']
);
- readonly resourceDetail = remoteData>({
+ readonly resourceDetail = remoteData({
await: () => [],
invoke: async () => {
this.resource = await Client.resourceDetailGetUsingGET({
endpoint: this.endpoint,
});
- const result = new Map();
- const yearSummary = this.resource.year;
- const yearUsage: UsageRecord[] = [];
- Object.keys(yearSummary).forEach(resourceEntry => {
- yearUsage.push({
- resource: resourceEntry,
- usage: yearSummary[resourceEntry],
- time: USAGE_ALL_TIME_VALUE,
- });
- });
- result.set(USAGE_ALL_TIME_KEY, yearUsage);
-
- const monthSummary = this.resource.month;
- const detailUsage: UsageRecord[] = [];
- Object.keys(monthSummary).forEach(month => {
- const monthUsage = monthSummary[month];
- Object.keys(monthUsage).forEach(resourceEntry => {
- detailUsage.push({
- resource: resourceEntry,
- usage: monthUsage[resourceEntry],
- time: month,
- });
- });
- });
- result.set(USAGE_DETAIL_TIME_KEY, detailUsage);
- return Promise.resolve(result);
+ return Promise.resolve(
+ mapUsageSummaryToTimeGroupedUsageRecords(this.resource, 'email')
+ );
+ },
+ default: {
+ 'Day Detail': [],
+ 'Year Detail': [],
+ 'Month Detail': [],
},
- default: new Map(),
});
constructor(props: Readonly<{ routing: RouterStore; match: match }>) {
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsTable.tsx b/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsTable.tsx
index d1f50fad8..ce66a5963 100644
--- a/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsTable.tsx
+++ b/src/main/webapp/app/pages/usageAnalysisPage/ResourceUsageDetailsTable.tsx
@@ -7,14 +7,12 @@ import React from 'react';
import { Row } from 'react-bootstrap';
import {
getUsageTableColumnDefinition,
- ToggleValue,
- UsageRecord,
UsageTableColumnKey,
} from 'app/pages/usageAnalysisPage/UsageAnalysisPage';
import {
- USAGE_DETAIL_TIME_KEY,
- USAGE_ALL_TIME_KEY,
+ USAGE_MONTH_DETAIL_TIME_KEY,
PAGE_ROUTE,
+ USAGE_YEAR_DETAIL_TIME_KEY,
} from 'app/config/constants';
import { UsageToggleGroup } from './UsageToggleGroup';
import {
@@ -23,9 +21,14 @@ import {
} from 'app/components/oncokbTable/HeaderConstants';
import UsageText from 'app/shared/texts/UsageText';
import { Link } from 'react-router-dom';
+import {
+ UsageRecord,
+ TimeGroupedUsageRecords,
+ ToggleValue,
+} from './usage-analysis-utils';
type IResourceUsageDetailsTable = {
- data: Map;
+ data: TimeGroupedUsageRecords;
loadedData: boolean;
defaultTimeType: ToggleValue;
};
@@ -48,25 +51,25 @@ export default class ResourceUsageDetailsTable extends React.Component<
<>
- filterByKeyword(row.resource, keyword),
+ filterByKeyword(row.userEmail, keyword),
Cell(props: { original: UsageRecord }) {
return props.original.userId ? (
- {props.original.resource}
+ {props.original.userEmail}
) : (
- {props.original.resource}
+ {props.original.userEmail}
);
},
},
@@ -102,7 +105,7 @@ export default class ResourceUsageDetailsTable extends React.Component<
>({
+ readonly usageDetail = remoteData({
await: () => [],
- invoke: async () => {
- const resource = await client.resourceUsageGetUsingGET({});
- const result = new Map();
- const yearSummary = resource.year;
- const yearUsage: UsageRecord[] = [];
- Object.keys(yearSummary).forEach(resourceEntry => {
- yearUsage.push({
- resource: resourceEntry,
- usage: yearSummary[resourceEntry],
- time: '',
- });
- });
- result.set(USAGE_ALL_TIME_KEY, yearUsage);
- this.dropdownList.push(USAGE_ALL_TIME_KEY);
-
- const monthSummary = resource.month;
- Object.keys(monthSummary).forEach(month => {
- const monthUsage = monthSummary[month];
- const usageArray: UsageRecord[] = [];
- Object.keys(monthUsage).forEach(resourceEntry => {
- usageArray.push({
- resource: resourceEntry,
- usage: monthUsage[resourceEntry],
- time: month,
- });
- });
- result.set(month, usageArray);
- this.dropdownList.push(month);
- });
-
- return Promise.resolve(result);
+ async invoke() {
+ return await client.resourceUsageGetUsingGET({});
+ },
+ default: {
+ day: {},
+ month: {},
+ year: {},
},
- default: new Map(),
});
@autobind
@@ -216,20 +166,6 @@ export default class UsageAnalysisPage extends React.Component<{
this.usageType = usageType;
}
- @computed get calculateResourcesTabData(): UsageRecord[] {
- if (
- this.resourceTabResourcesTypeToggleValue === ToggleValue.ALL_RESOURCES
- ) {
- return this.usageDetail.result.get(this.dropdownValue) || [];
- } else {
- return (this.usageDetail.result.get(this.dropdownValue) || []).filter(
- function (usage) {
- return !usage.resource.includes('/private/');
- }
- );
- }
- }
-
render() {
return (
<>
@@ -250,112 +186,11 @@ export default class UsageAnalysisPage extends React.Component<{
-
- filterByKeyword(row.resource, keyword),
- Cell(props: { original: UsageRecord }) {
- return props.original.resource ? (
-
- {props.original.resource}
-
- ) : (
- {props.original.resource}
- );
- },
- },
- {
- ...getUsageTableColumnDefinition(UsageTableColumnKey.USAGE),
- Cell(props: { original: UsageRecord }) {
- return ;
- },
- },
- {
- ...getUsageTableColumnDefinition(
- UsageTableColumnKey.OPERATION
- ),
- sortable: false,
- className: 'd-flex justify-content-center',
- Cell(props: { original: UsageRecord }) {
- return (
-
-
-
- );
- },
- },
- ]}
- loading={!this.usageDetail.isComplete}
- defaultSorted={[
- {
- id: UsageTableColumnKey.USAGE,
- desc: true,
- },
- ]}
- showPagination={true}
- minRows={1}
- filters={() => {
- const monthDropdown: any = [];
- if (this.usageDetail.isComplete) {
- this.dropdownList
- .sort()
- .reverse()
- .forEach(key => {
- monthDropdown.push(
-
- {key}
-
- );
- });
- }
- return this.usageDetail.isComplete ? (
-
- (this.dropdownValue = evt)}
- >
- {monthDropdown}
-
-
-
- ) : (
-
- );
- }}
+
+
+ {props.original.resource}
+ {' '}
+ {isResources && <>({props.original.maxUsageProportion}%)}
+
+ ) : (
+ N/A
+ );
},
- this.resourcesTypeToggleValue === ToggleValue.ALL_RESOURCES
- ? {
- id: 'endpoint',
- Header: endpointHeader,
- minWidth: 200,
- accessor: (row: UserOverviewUsage) =>
- `${row.endpoint} (${row.maxUsageProportion}%)`,
- onFilter: (row: UserOverviewUsage, keyword: string) =>
- filterByKeyword(row.endpoint, keyword),
- Cell(props: { original: UserOverviewUsage }) {
- return props.original.endpoint ? (
-
-
- {props.original.endpoint}
- {' '}
- ({props.original.maxUsageProportion}%)
-
- ) : (
- N/A
- );
- },
- }
- : {
- id: 'noPrivateEndpoint',
- Header: noPrivateEndpointHeader,
- minWidth: 200,
- accessor: (row: UserOverviewUsage) =>
- `${row.endpoint} (${row.noPrivateMaxUsageProportion}%)`,
- onFilter: (row: UserOverviewUsage, keyword: string) =>
- filterByKeyword(row.noPrivateEndpoint, keyword),
- Cell(props: { original: UserOverviewUsage }) {
- return props.original.endpoint ? (
-
-
- {props.original.endpoint}
- {' '}
- ({props.original.maxUsageProportion}%)
-
- ) : (
- N/A
- );
- },
- },
- {
+ });
+ columns.push({
+ ...getUsageTableColumnDefinition(UsageTableColumnKey.TIME),
+ Header: filterDependentTimeHeader(this.timeTypeToggleValue),
+ onFilter: (row: UsageRecord, keyword: string) =>
+ filterByKeyword(row.time, keyword),
+ });
+ if (isResources) {
+ columns.push({
...getUsageTableColumnDefinition(UsageTableColumnKey.OPERATION),
sortable: false,
className: 'd-flex justify-content-center',
- Cell(props: { original: UserOverviewUsage }) {
+ Cell(props: { original: UsageRecord }) {
return props.original.userId ? (
);
},
- },
- ];
+ });
+ }
+ return columns;
}
- readonly dateGroupedColumns = [
- {
- id: 'userEmail',
- Header: emailHeader,
- accessor: 'resource',
- onFilter: (row: UsageRecord, keyword: string) =>
- filterByKeyword(row.resource, keyword),
- Cell(props: { original: UsageRecord }) {
- return props.original.userId ? (
-
- {props.original.resource}
-
- ) : (
- {props.original.resource}
- );
- },
- },
- {
- ...getUsageTableColumnDefinition(UsageTableColumnKey.USAGE),
- Cell(props: { original: UsageRecord }) {
- return ;
- },
- },
- {
- ...getUsageTableColumnDefinition(UsageTableColumnKey.TIME),
- Header: filterDependentTimeHeader(this.timeTypeToggleValue),
- onFilter: (row: UsageRecord, keyword: string) =>
- filterByKeyword(row.time, keyword),
- },
- {
- ...getUsageTableColumnDefinition(UsageTableColumnKey.OPERATION),
- sortable: false,
- className: 'd-flex justify-content-center',
- Cell(props: { original: UsageRecord }) {
- return props.original.userId ? (
-
-
-
- ) : (
-
- );
- },
- },
- ];
-
@computed get resetDefaultSort(): SortingRule[] {
const sortingRules: SortingRule[] = [];
if (this.filterToggled) {
@@ -282,7 +173,7 @@ export default class UsageAnalysisTable extends React.Component<
});
}
- if (this.timeTypeToggleValue === ToggleValue.RESULTS_IN_TOTAL) {
+ if (this.timeTypeToggleValue === ToggleValue.RESULTS_BY_YEAR) {
sortingRules.push({
id: 'totalUsage',
desc: true,
@@ -328,7 +219,7 @@ export default class UsageAnalysisTable extends React.Component<
- key={this.timeTypeToggleValue}
- data={this.props.data}
- columns={this.getAllTimeColumns}
- loading={!this.props.loadedData}
- defaultSorted={this.resetDefaultSort}
- showPagination={true}
- minRows={1}
- defaultPageSize={this.props.defaultPageSize}
- filters={this.filters}
- />
- );
- } else {
- return (
-
- key={this.timeTypeToggleValue}
- data={this.calculateDateGroupedData}
- columns={this.dateGroupedColumns}
- loading={!this.props.loadedData}
- defaultSorted={this.resetDefaultSort}
- showPagination={true}
- minRows={1}
- defaultPageSize={this.props.defaultPageSize}
- filters={this.filters}
- />
- );
- }
+ return (
+
+ key={this.timeTypeToggleValue}
+ data={this.calculateDateGroupedData}
+ columns={this.dateGroupedColumns}
+ loading={!this.props.loadedData}
+ defaultSorted={this.resetDefaultSort}
+ showPagination={true}
+ minRows={1}
+ defaultPageSize={this.props.defaultPageSize}
+ filters={this.filters}
+ />
+ );
}
render() {
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/UsageToggleGroup.tsx b/src/main/webapp/app/pages/usageAnalysisPage/UsageToggleGroup.tsx
index dbd6da521..96f163cdb 100644
--- a/src/main/webapp/app/pages/usageAnalysisPage/UsageToggleGroup.tsx
+++ b/src/main/webapp/app/pages/usageAnalysisPage/UsageToggleGroup.tsx
@@ -1,7 +1,7 @@
import { observer } from 'mobx-react';
import React from 'react';
import { ToggleButton, ToggleButtonGroup } from 'react-bootstrap';
-import { ToggleValue } from './UsageAnalysisPage';
+import { ToggleValue } from './usage-analysis-utils';
type IUsageToggleGroupProps = {
defaultValue: ToggleValue;
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsPage.tsx b/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsPage.tsx
index 0b36f6bf2..244161067 100644
--- a/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsPage.tsx
+++ b/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsPage.tsx
@@ -10,17 +10,17 @@ import { Col, Row } from 'react-bootstrap';
import UserUsageDetailsTable from './UserUsageDetailsTable';
import { InfoRow } from '../AccountPage';
import {
- USAGE_DETAIL_TIME_KEY,
- USAGE_ALL_TIME_KEY,
- USAGE_ALL_TIME_VALUE,
+ USAGE_MONTH_DETAIL_TIME_KEY,
+ USAGE_YEAR_DETAIL_TIME_KEY,
USAGE_DAY_DETAIL_TIME_KEY,
} from 'app/config/constants';
import { remoteData } from 'cbioportal-frontend-commons';
+import { notifyError } from 'app/shared/utils/NotificationUtils';
import {
- ToggleValue,
UsageRecord,
-} from 'app/pages/usageAnalysisPage/UsageAnalysisPage';
-import { notifyError } from 'app/shared/utils/NotificationUtils';
+ TimeGroupedUsageRecords,
+ ToggleValue,
+} from './usage-analysis-utils';
@inject('routing')
@observer
@@ -36,37 +36,48 @@ export default class UserUsageDetailsPage extends React.Component<{
super(props);
}
- readonly usageDetail = remoteData>({
+ readonly usageDetail = remoteData({
await: () => [],
invoke: async () => {
- const result = new Map();
+ const result: TimeGroupedUsageRecords = {
+ [USAGE_YEAR_DETAIL_TIME_KEY]: [],
+ [USAGE_MONTH_DETAIL_TIME_KEY]: [],
+ [USAGE_DAY_DETAIL_TIME_KEY]: [],
+ };
try {
this.user = await client.userUsageGetUsingGET({ userId: this.userId });
if (this.user.summary !== null) {
const yearSummary = this.user.summary.year;
- const yearUsage: UsageRecord[] = [];
- Object.keys(yearSummary).forEach(resourceEntry => {
- yearUsage.push({
- resource: resourceEntry,
- usage: yearSummary[resourceEntry],
- time: USAGE_ALL_TIME_VALUE,
+ const yearDetailSummary: UsageRecord[] = [];
+ Object.keys(yearSummary).forEach(year => {
+ const yearUsage = yearSummary[year];
+ Object.keys(yearUsage).forEach(resourceEntry => {
+ yearDetailSummary.push({
+ userEmail: this.user.userEmail,
+ usage: yearUsage[resourceEntry],
+ time: year,
+ resource: resourceEntry,
+ maxUsageProportion: 0,
+ });
});
});
- result.set(USAGE_ALL_TIME_KEY, yearUsage);
+ result[USAGE_YEAR_DETAIL_TIME_KEY] = yearDetailSummary;
const monthSummary = this.user.summary.month;
- const detailSummary: UsageRecord[] = [];
+ const monthDetailSummary: UsageRecord[] = [];
Object.keys(monthSummary).forEach(month => {
const monthUsage = monthSummary[month];
Object.keys(monthUsage).forEach(resourceEntry => {
- detailSummary.push({
- resource: resourceEntry,
+ monthDetailSummary.push({
+ userEmail: this.user.userEmail,
usage: monthUsage[resourceEntry],
time: month,
+ resource: resourceEntry,
+ maxUsageProportion: 0,
});
});
});
- result.set(USAGE_DETAIL_TIME_KEY, detailSummary);
+ result[USAGE_MONTH_DETAIL_TIME_KEY] = monthDetailSummary;
const daySummary = this.user.summary.day;
const dayDetailSummary: UsageRecord[] = [];
@@ -74,20 +85,26 @@ export default class UserUsageDetailsPage extends React.Component<{
const dayUsage = daySummary[day];
Object.keys(dayUsage).forEach(resourceEntry => {
dayDetailSummary.push({
- resource: resourceEntry,
+ userEmail: this.user.userEmail,
usage: dayUsage[resourceEntry],
time: day,
+ resource: resourceEntry,
+ maxUsageProportion: 0,
});
});
});
- result.set(USAGE_DAY_DETAIL_TIME_KEY, dayDetailSummary);
+ result[USAGE_DAY_DETAIL_TIME_KEY] = dayDetailSummary;
}
} catch (error) {
notifyError(error, 'Failed to load user data usage with error: ');
}
return Promise.resolve(result);
},
- default: new Map(),
+ default: {
+ [USAGE_YEAR_DETAIL_TIME_KEY]: [],
+ [USAGE_MONTH_DETAIL_TIME_KEY]: [],
+ [USAGE_DAY_DETAIL_TIME_KEY]: [],
+ },
});
render() {
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsTable.tsx b/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsTable.tsx
index 56ea352a1..181b7da3f 100644
--- a/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsTable.tsx
+++ b/src/main/webapp/app/pages/usageAnalysisPage/UserUsageDetailsTable.tsx
@@ -7,17 +7,16 @@ import React from 'react';
import { Row } from 'react-bootstrap';
import {
getUsageTableColumnDefinition,
- ToggleValue,
- UsageRecord,
UsageTableColumnKey,
} from 'app/pages/usageAnalysisPage/UsageAnalysisPage';
import {
PAGE_ROUTE,
TABLE_DAY_FORMAT,
TABLE_MONTH_FORMAT,
- USAGE_ALL_TIME_KEY,
USAGE_DAY_DETAIL_TIME_KEY,
- USAGE_DETAIL_TIME_KEY,
+ USAGE_MONTH_DETAIL_TIME_KEY,
+ USAGE_YEAR_DETAIL_TIME_KEY,
+ TABLE_YEAR_FORMAT,
} from 'app/config/constants';
import { UsageToggleGroup } from './UsageToggleGroup';
import { UsageAnalysisCalendarButton } from 'app/components/calendarButton/UsageAnalysisCalendarButton';
@@ -28,9 +27,15 @@ import {
} from 'app/components/oncokbTable/HeaderConstants';
import UsageText from 'app/shared/texts/UsageText';
import { Link } from 'react-router-dom';
+import {
+ TimeGroupedUsageRecords,
+ UsageRecord,
+ isPrivateResource,
+ ToggleValue,
+} from './usage-analysis-utils';
type IUserUsageDetailsTable = {
- data: Map;
+ data: TimeGroupedUsageRecords;
loadedData: boolean;
defaultResourcesType: ToggleValue;
defaultTimeType: ToggleValue;
@@ -63,23 +68,21 @@ export default class UserUsageDetailsTable extends React.Component<
}
@computed get calculateData(): UsageRecord[] {
- let data = this.props.data.get(
- this.timeTypeToggleValue === ToggleValue.RESULTS_IN_TOTAL
- ? USAGE_ALL_TIME_KEY
+ let data = this.props.data[
+ this.timeTypeToggleValue === ToggleValue.RESULTS_BY_YEAR
+ ? USAGE_YEAR_DETAIL_TIME_KEY
: this.timeTypeToggleValue === ToggleValue.RESULTS_BY_MONTH
- ? USAGE_DETAIL_TIME_KEY
+ ? USAGE_MONTH_DETAIL_TIME_KEY
: USAGE_DAY_DETAIL_TIME_KEY
- );
- if (
- this.filterToggled &&
- data &&
- this.timeTypeToggleValue !== ToggleValue.RESULTS_IN_TOTAL
- ) {
+ ];
+ if (this.filterToggled && data) {
let tableFormat: string;
if (this.timeTypeToggleValue === ToggleValue.RESULTS_BY_MONTH) {
tableFormat = TABLE_MONTH_FORMAT;
} else if (this.timeTypeToggleValue === ToggleValue.RESULTS_BY_DAY) {
tableFormat = TABLE_DAY_FORMAT;
+ } else if (this.timeTypeToggleValue === ToggleValue.RESULTS_BY_YEAR) {
+ tableFormat = TABLE_YEAR_FORMAT;
}
data = data.filter(resource => {
const fromTime = moment(this.fromDate).format(tableFormat);
@@ -91,7 +94,7 @@ export default class UserUsageDetailsTable extends React.Component<
return data || [];
} else if (this.resourcesTypeToggleValue === ToggleValue.PUBLIC_RESOURCES) {
return (data || []).filter(function (usage) {
- return !usage.resource.includes('/private/');
+ return !isPrivateResource(usage.resource);
});
} else if (this.resourcesTypeToggleValue === ToggleValue.CUMULATIVE_USAGE) {
if (data) {
@@ -102,9 +105,11 @@ export default class UserUsageDetailsTable extends React.Component<
data.forEach(resource => {
if (!cumulativeData.has(resource.time)) {
cumulativeData.set(resource.time, {
- resource: 'ALL',
+ userEmail: 'ALL',
usage: 0,
time: resource.time,
+ resource: resource.resource,
+ maxUsageProportion: 0,
});
}
const resourceTimeRange = cumulativeData.get(resource.time);
@@ -187,7 +192,7 @@ export default class UserUsageDetailsTable extends React.Component<
{
+ const isPrivateResourceTests: [string, boolean][] = [
+ ['/api/private/something', true],
+ ['/api/something', false],
+ ['/api/something/private', false],
+ ];
+
+ test.each(isPrivateResourceTests)(
+ 'For "%s" isPrivateResource should return %s',
+ (resource, expected) => {
+ const actual = isPrivateResource(resource);
+ expect(actual).toEqual(expected);
+ }
+ );
+
+ const mapUserOrResourceUsageToUsageRecordsTests: [
+ Parameters,
+ ReturnType
+ ][] = [
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_YEAR,
+ true,
+ '2019-01-01',
+ '2019-12-31',
+ true,
+ ],
+ [],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_YEAR,
+ false,
+ '2019-01-01',
+ '2019-12-31',
+ true,
+ ],
+ [
+ {
+ maxUsageProportion: 25.3,
+ resource: '/api/private/search/typeahead',
+ time: '2020',
+ usage: 4436,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_YEAR,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ true,
+ ],
+ [
+ {
+ maxUsageProportion: 25.3,
+ resource: '/api/private/search/typeahead',
+ time: '2020',
+ usage: 4436,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_YEAR,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ false,
+ ],
+ [
+ {
+ maxUsageProportion: 40,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020',
+ usage: 2299,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_MONTH,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ true,
+ ],
+ [
+ {
+ maxUsageProportion: 49.4,
+ resource: '/api/private/search/typeahead',
+ time: '2020-01',
+ usage: 376,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_MONTH,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ false,
+ ],
+ [
+ {
+ maxUsageProportion: 100,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020-01',
+ usage: 186,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_DAY,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ true,
+ ],
+ [
+ {
+ maxUsageProportion: 100,
+ resource: '/api/private/search/typeahead',
+ time: '2020-01-01',
+ usage: 48,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ [
+ [
+ userOverviewUsageWithUsageTypes,
+ ToggleValue.RESULTS_BY_DAY,
+ true,
+ '2020-01-01',
+ '2020-12-31',
+ false,
+ ],
+ [
+ {
+ maxUsageProportion: 100,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020-01-01',
+ usage: 48,
+ userEmail: '0doej@FakeCo.com',
+ userId: '0',
+ },
+ ],
+ ],
+ ];
+
+ test.each(mapUserOrResourceUsageToUsageRecordsTests)(
+ 'For "%s" mapUserOrResourceUsageToUsageRecords should return %s',
+ (
+ [
+ incomingData,
+ timeTypeToggleValue,
+ filterToggled,
+ fromDate,
+ toDate,
+ isAllUsage,
+ ],
+ expected
+ ) => {
+ const actual = mapUserOrResourceUsageToUsageRecords(
+ incomingData,
+ timeTypeToggleValue,
+ filterToggled,
+ fromDate,
+ toDate,
+ isAllUsage
+ );
+ expect(actual).toEqual(expected);
+ }
+ );
+
+ const mapUsageSummaryToTimeGroupedUsageRecordsTests: [
+ Parameters,
+ ReturnType
+ ][] = [
+ [
+ [usageSummaryWithUsageTypesEmail, 'email'],
+ {
+ 'Day Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020-02-04',
+ usage: 30,
+ userEmail: '0doej@FakeCo.com',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020-03-01',
+ usage: 26,
+ userEmail: '0doej@FakeCo.com',
+ userId: undefined,
+ },
+ ],
+ 'Month Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020-02',
+ usage: 30,
+ userEmail: '0doej@FakeCo.com',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020-02',
+ usage: 75,
+ userEmail: '1smithj@DemoLLC.com',
+ userId: undefined,
+ },
+ ],
+ 'Year Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020',
+ usage: 712,
+ userEmail: '0doej@FakeCo.com',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '',
+ time: '2020',
+ usage: 1019,
+ userEmail: '1smithj@DemoLLC.com',
+ userId: undefined,
+ },
+ ],
+ },
+ ],
+ [
+ [usageSummaryWithUsageTypesResource, 'resource'],
+ {
+ 'Day Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020-01-01',
+ usage: 127,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020-01-07',
+ usage: 74,
+ userEmail: '',
+ userId: undefined,
+ },
+ ],
+ 'Month Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020-01',
+ usage: 265,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/private/search/typeahead',
+ time: '2020-01',
+ usage: 230,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/private/utils/numbers/levels/',
+ time: '2020-01',
+ usage: 21,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/mutations/byProteinChange',
+ time: '2020-01',
+ usage: 115,
+ userEmail: '',
+ userId: undefined,
+ },
+ ],
+ 'Year Detail': [
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/structuralVariants',
+ time: '2020',
+ usage: 1924,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/private/search/typeahead',
+ time: '2020',
+ usage: 1868,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/private/utils/numbers/levels/',
+ time: '2020',
+ usage: 1713,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/mutations/byProteinChange',
+ time: '2020',
+ usage: 1731,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/private/utils/numbers/main/',
+ time: '2020',
+ usage: 1081,
+ userEmail: '',
+ userId: undefined,
+ },
+ {
+ maxUsageProportion: 0,
+ resource: '/api/v1/annotate/copyNumberAlterations',
+ time: '2020',
+ usage: 1035,
+ userEmail: '',
+ userId: undefined,
+ },
+ ],
+ },
+ ],
+ ];
+
+ test.each(mapUsageSummaryToTimeGroupedUsageRecordsTests)(
+ 'For "%s" mapUsageSummaryToTimeGroupedUsageRecords should return %s',
+ ([usageSummary, keyType], expected) => {
+ const actual = mapUsageSummaryToTimeGroupedUsageRecords(
+ usageSummary,
+ keyType
+ );
+ expect(actual).toEqual(expected);
+ }
+ );
+});
diff --git a/src/main/webapp/app/pages/usageAnalysisPage/usage-analysis-utils.ts b/src/main/webapp/app/pages/usageAnalysisPage/usage-analysis-utils.ts
new file mode 100644
index 000000000..218b5a350
--- /dev/null
+++ b/src/main/webapp/app/pages/usageAnalysisPage/usage-analysis-utils.ts
@@ -0,0 +1,206 @@
+import {
+ UserStats,
+ UsageSummary,
+ UserOverviewUsage,
+} from 'app/shared/api/generated/API';
+import {
+ TABLE_MONTH_FORMAT,
+ TABLE_DAY_FORMAT,
+ TABLE_YEAR_FORMAT,
+ USAGE_YEAR_DETAIL_TIME_KEY,
+ USAGE_MONTH_DETAIL_TIME_KEY,
+ USAGE_DAY_DETAIL_TIME_KEY,
+} from 'app/config/constants';
+import moment from 'moment';
+
+export enum ToggleValue {
+ ALL_RESOURCES = 'All Resources',
+ PUBLIC_RESOURCES = 'Only Public Resources',
+ CUMULATIVE_USAGE = 'Cumulative Usage',
+ RESULTS_BY_YEAR = 'By Year',
+ RESULTS_BY_MONTH = 'By Month',
+ RESULTS_BY_DAY = 'By Day',
+}
+
+export type TimeGroupedUsageRecords = {
+ [USAGE_YEAR_DETAIL_TIME_KEY]: UsageRecord[];
+ [USAGE_MONTH_DETAIL_TIME_KEY]: UsageRecord[];
+ [USAGE_DAY_DETAIL_TIME_KEY]: UsageRecord[];
+};
+
+export type UsageRecord = {
+ resource: string;
+ userEmail: string;
+ maxUsageProportion: number;
+ usage: number;
+ time: string;
+ userId?: string;
+};
+
+export type UserOverviewUsageWithUsageTypes = UserOverviewUsage & {
+ yearUsage: Record;
+ monthUsage: Record;
+ dayUsage: Record;
+};
+
+export type UsageSummaryWithUsageTypes = UsageSummary & {
+ year: Record>;
+ month: Record>;
+ day: Record>;
+};
+
+export function isPrivateResource(resource: string) {
+ return resource.startsWith('/api/private/');
+}
+
+function checkIfUserUsage(
+ incomingData: UsageSummaryWithUsageTypes | UserOverviewUsageWithUsageTypes[]
+): incomingData is UserOverviewUsageWithUsageTypes[] {
+ return Array.isArray(incomingData);
+}
+
+function createResourceTableRecord(
+ time: string,
+ usageSummary: Record,
+ keyType: 'resource' | 'email',
+ isAllUsage: boolean
+): UsageRecord[] {
+ return Object.entries(usageSummary)
+ .filter(([key]) => isAllUsage || !isPrivateResource(key))
+ .map(
+ ([key, usage]): UsageRecord => {
+ return {
+ userId: undefined,
+ userEmail: keyType === 'email' ? key : '',
+ usage,
+ time,
+ resource: keyType === 'resource' ? key : '',
+ maxUsageProportion: 0,
+ };
+ }
+ );
+}
+
+function createUserTableRecord(
+ userId: string | undefined,
+ userEmail: string,
+ usage: Record,
+ isAllUsage: boolean
+): UsageRecord[] {
+ return Object.entries(usage).map(
+ ([time, userStats]): UsageRecord => {
+ return {
+ userId,
+ userEmail,
+ usage: isAllUsage ? userStats.totalUsage : userStats.totalPublicUsage,
+ time,
+ resource: isAllUsage
+ ? userStats.mostUsedEndpoint
+ : userStats.mostUsedPublicEndpoint,
+ maxUsageProportion: isAllUsage
+ ? userStats.maxUsageProportion
+ : userStats.publicMaxUsageProportion,
+ };
+ }
+ );
+}
+
+export function mapUserOrResourceUsageToUsageRecords(
+ incomingData: UsageSummaryWithUsageTypes | UserOverviewUsageWithUsageTypes[],
+ timeTypeToggleValue: ToggleValue,
+ filterToggled: boolean,
+ fromDate: string | undefined,
+ toDate: string | undefined,
+ isAllUsage: boolean
+) {
+ let data: UsageRecord[];
+ const isByYear = timeTypeToggleValue === ToggleValue.RESULTS_BY_YEAR;
+ const isByMonth = timeTypeToggleValue === ToggleValue.RESULTS_BY_MONTH;
+ const isByDay = timeTypeToggleValue === ToggleValue.RESULTS_BY_DAY;
+
+ if (isByYear && checkIfUserUsage(incomingData)) {
+ data = incomingData.flatMap(({ userId, userEmail, yearUsage }) => {
+ return createUserTableRecord(userId, userEmail, yearUsage, isAllUsage);
+ });
+ } else if (isByMonth && checkIfUserUsage(incomingData)) {
+ data = incomingData.flatMap(({ userId, userEmail, monthUsage }) => {
+ return createUserTableRecord(userId, userEmail, monthUsage, isAllUsage);
+ });
+ } else if (isByDay && checkIfUserUsage(incomingData)) {
+ data = incomingData.flatMap(({ userId, userEmail, dayUsage }) => {
+ return createUserTableRecord(userId, userEmail, dayUsage, isAllUsage);
+ });
+ } else if (isByYear && !checkIfUserUsage(incomingData)) {
+ data = Object.entries(incomingData.year).flatMap(([time, usageSummary]) => {
+ return createResourceTableRecord(
+ time,
+ usageSummary,
+ 'resource',
+ isAllUsage
+ );
+ });
+ } else if (isByMonth && !checkIfUserUsage(incomingData)) {
+ data = Object.entries(incomingData.month).flatMap(
+ ([time, usageSummary]) => {
+ return createResourceTableRecord(
+ time,
+ usageSummary,
+ 'resource',
+ isAllUsage
+ );
+ }
+ );
+ } else if (isByDay && !checkIfUserUsage(incomingData)) {
+ data = Object.entries(incomingData.day).flatMap(([time, usageSummary]) => {
+ return createResourceTableRecord(
+ time,
+ usageSummary,
+ 'resource',
+ isAllUsage
+ );
+ });
+ } else {
+ data = [];
+ }
+
+ if (filterToggled && data.length > 0) {
+ let tableFormat: string;
+ if (timeTypeToggleValue === ToggleValue.RESULTS_BY_MONTH) {
+ tableFormat = TABLE_MONTH_FORMAT;
+ } else if (timeTypeToggleValue === ToggleValue.RESULTS_BY_DAY) {
+ tableFormat = TABLE_DAY_FORMAT;
+ } else {
+ tableFormat = TABLE_YEAR_FORMAT;
+ }
+ data = data.filter(resource => {
+ const fromTime = moment(fromDate).format(tableFormat);
+ const toTime = moment(toDate).format(tableFormat);
+ return resource.time >= fromTime && resource.time <= toTime;
+ });
+ }
+
+ return data;
+}
+
+export function mapUsageSummaryToTimeGroupedUsageRecords(
+ usageSummary: UsageSummaryWithUsageTypes,
+ keyType: Parameters[2]
+): TimeGroupedUsageRecords {
+ return {
+ [USAGE_YEAR_DETAIL_TIME_KEY]: Object.entries(
+ usageSummary.year
+ ).flatMap(([time, usage]) =>
+ createResourceTableRecord(time, usage, keyType, true)
+ ),
+ [USAGE_MONTH_DETAIL_TIME_KEY]: Object.entries(
+ usageSummary.month
+ ).flatMap(([time, usage]) =>
+ createResourceTableRecord(time, usage, keyType, true)
+ ),
+ [USAGE_DAY_DETAIL_TIME_KEY]: Object.entries(
+ usageSummary.day
+ ).flatMap(([time, usage]) =>
+ createResourceTableRecord(time, usage, keyType, true)
+ ),
+ };
+}
diff --git a/src/main/webapp/app/pages/userPage/UserPage.tsx b/src/main/webapp/app/pages/userPage/UserPage.tsx
index 809058634..2b7ff888d 100644
--- a/src/main/webapp/app/pages/userPage/UserPage.tsx
+++ b/src/main/webapp/app/pages/userPage/UserPage.tsx
@@ -20,13 +20,8 @@ import {
LicenseType,
NOT_CHANGEABLE_AUTHORITIES,
PAGE_ROUTE,
- PAGE_TITLE,
REDIRECT_TIMEOUT_MILLISECONDS,
THRESHOLD_TRIAL_TOKEN_VALID_DEFAULT,
- USAGE_ALL_TIME_KEY,
- USAGE_ALL_TIME_VALUE,
- USAGE_DAY_DETAIL_TIME_KEY,
- USAGE_DETAIL_TIME_KEY,
USER_AUTHORITIES,
} from 'app/config/constants';
import {
@@ -42,6 +37,7 @@ import {
UserMailsDTO,
UserUsage,
UserCompany,
+ UsageSummary,
} from 'app/shared/api/generated/API';
import client from 'app/shared/api/clientInstance';
import { DefaultTooltip, remoteData } from 'cbioportal-frontend-commons';
@@ -76,11 +72,6 @@ import {
} from 'app/shared/utils/FormValidationUtils';
import AuthenticationStore from 'app/store/AuthenticationStore';
import ButtonWithTooltip from 'app/shared/button/ButtonWithTooltip';
-import {
- ToggleValue,
- UsageRecord,
-} from 'app/pages/usageAnalysisPage/UsageAnalysisPage';
-import UserUsageDetailsTable from 'app/pages/usageAnalysisPage/UserUsageDetailsTable';
import { DateSelector } from 'app/components/dateSelector/DateSelector';
import { KeyInputGroups } from 'app/pages/userPage/KeyInputGroups';
import { Label } from 'reactstrap';
@@ -90,6 +81,8 @@ import {
} from 'app/shared/utils/UrlUtils';
import { sortBy } from 'app/shared/utils/LodashUtils';
import { Helmet } from 'react-helmet-async';
+import { ToggleValue } from '../usageAnalysisPage/usage-analysis-utils';
+import UsageAnalysisTable from '../usageAnalysisPage/UsageAnalysisTable';
export enum AccountStatus {
ACTIVATED = 'Activated',
@@ -179,56 +172,19 @@ export default class UserPage extends React.Component {
this.reactions.forEach(disposer => disposer());
}
- readonly usageDetail = remoteData>({
+ readonly usageDetail = remoteData({
await: () => [],
invoke: async () => {
this.userUsage = await client.userUsageGetUsingGET({
userId: this.user.id,
});
- const result = new Map();
- if (this.userUsage.summary !== null) {
- const yearSummary = this.userUsage.summary.year;
- const yearUsage: UsageRecord[] = [];
- Object.keys(yearSummary).forEach(resourceEntry => {
- yearUsage.push({
- resource: resourceEntry,
- usage: yearSummary[resourceEntry],
- time: USAGE_ALL_TIME_VALUE,
- });
- });
- result.set(USAGE_ALL_TIME_KEY, yearUsage);
-
- const monthSummary = this.userUsage.summary.month;
- const detailSummary: UsageRecord[] = [];
- Object.keys(monthSummary).forEach(month => {
- const monthUsage = monthSummary[month];
- Object.keys(monthUsage).forEach(resourceEntry => {
- detailSummary.push({
- resource: resourceEntry,
- usage: monthUsage[resourceEntry],
- time: month,
- });
- });
- });
- result.set(USAGE_DETAIL_TIME_KEY, detailSummary);
-
- const daySummary = this.userUsage.summary.day;
- const dayDetailSummary: UsageRecord[] = [];
- Object.keys(daySummary).forEach(day => {
- const dayUsage = daySummary[day];
- Object.keys(dayUsage).forEach(resourceEntry => {
- dayDetailSummary.push({
- resource: resourceEntry,
- usage: dayUsage[resourceEntry],
- time: day,
- });
- });
- });
- result.set(USAGE_DAY_DETAIL_TIME_KEY, dayDetailSummary);
- }
- return Promise.resolve(result);
+ return this.userUsage.summary;
+ },
+ default: {
+ day: {},
+ month: {},
+ year: {},
},
- default: new Map(),
});
readonly usersUserMails = remoteData({
@@ -1084,12 +1040,13 @@ export default class UserPage extends React.Component {
Data usage
-
diff --git a/src/main/webapp/app/shared/api/generated/API-docs.json b/src/main/webapp/app/shared/api/generated/API-docs.json
index 7f09a105b..467c36dd1 100644
--- a/src/main/webapp/app/shared/api/generated/API-docs.json
+++ b/src/main/webapp/app/shared/api/generated/API-docs.json
@@ -3382,13 +3382,6 @@
},
"title": "Contact"
},
- "JSONObject": {
- "type": "object",
- "title": "JSONObject",
- "additionalProperties": {
- "type": "object"
- }
- },
"KeyAndPasswordVM": {
"type": "object",
"properties": {
@@ -3620,6 +3613,14 @@
},
"title": "ManagedUserVM"
},
+ "MapOfstringAndlong": {
+ "type": "object",
+ "title": "MapOfstringAndlong",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
"PasswordChangeDTO": {
"type": "object",
"properties": {
@@ -3717,7 +3718,8 @@
"additionalProperties": {
"type": "object",
"additionalProperties": {
- "type": "object"
+ "type": "integer",
+ "format": "int64"
}
}
},
@@ -3726,15 +3728,19 @@
"additionalProperties": {
"type": "object",
"additionalProperties": {
- "type": "object"
+ "type": "integer",
+ "format": "int64"
}
}
},
"year": {
"type": "object",
"additionalProperties": {
- "type": "integer",
- "format": "int64"
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int64"
+ }
}
}
},
@@ -4040,43 +4046,57 @@
"dayUsage": {
"type": "object",
"additionalProperties": {
- "type": "integer",
- "format": "int64"
+ "$ref": "#/definitions/UserStats"
+ }
+ },
+ "monthUsage": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/UserStats"
}
},
- "endpoint": {
+ "userEmail": {
"type": "string"
},
- "maxUsageProportion": {
- "type": "number",
- "format": "float"
+ "userId": {
+ "type": "string"
},
- "monthUsage": {
+ "yearUsage": {
"type": "object",
"additionalProperties": {
- "type": "integer",
- "format": "int64"
+ "$ref": "#/definitions/UserStats"
}
+ }
+ },
+ "title": "UserOverviewUsage"
+ },
+ "UserStats": {
+ "type": "object",
+ "properties": {
+ "maxUsageProportion": {
+ "type": "number",
+ "format": "float"
},
- "noPrivateEndpoint": {
+ "mostUsedEndpoint": {
"type": "string"
},
- "noPrivateMaxUsageProportion": {
+ "mostUsedPublicEndpoint": {
+ "type": "string"
+ },
+ "publicMaxUsageProportion": {
"type": "number",
"format": "float"
},
- "totalUsage": {
+ "totalPublicUsage": {
"type": "integer",
"format": "int64"
},
- "userEmail": {
- "type": "string"
- },
- "userId": {
- "type": "string"
+ "totalUsage": {
+ "type": "integer",
+ "format": "int64"
}
},
- "title": "UserOverviewUsage"
+ "title": "UserStats"
},
"UserUsage": {
"type": "object",
diff --git a/src/main/webapp/app/shared/api/generated/API.ts b/src/main/webapp/app/shared/api/generated/API.ts
index 51e9c76f5..053824e58 100644
--- a/src/main/webapp/app/shared/api/generated/API.ts
+++ b/src/main/webapp/app/shared/api/generated/API.ts
@@ -113,7 +113,6 @@ export type Contact = {
'phone': string
};
-export type JSONObject = {};
export type KeyAndPasswordVM = {
'key': string
@@ -206,6 +205,7 @@ export type ManagedUserVM = {
'tokenValidDays': number
};
+export type MapOfstringAndlong = {};
export type PasswordChangeDTO = {
'currentPassword': string
@@ -381,21 +381,27 @@ export type UserMailsDTO = {
export type UserOverviewUsage = {
'dayUsage': {}
- 'endpoint': string
+ 'monthUsage': {}
- 'maxUsageProportion': number
+ 'userEmail': string
- 'monthUsage': {}
+ 'userId': string
- 'noPrivateEndpoint': string
+ 'yearUsage': {}
- 'noPrivateMaxUsageProportion': number
+};
+export type UserStats = {
+ 'maxUsageProportion': number
- 'totalUsage': number
+ 'mostUsedEndpoint': string
- 'userEmail': string
+ 'mostUsedPublicEndpoint': string
- 'userId': string
+ 'publicMaxUsageProportion': number
+
+ 'totalPublicUsage': number
+
+ 'totalUsage': number
};
export type UserUsage = {
diff --git a/src/main/webapp/app/shared/texts/UsageText.tsx b/src/main/webapp/app/shared/texts/UsageText.tsx
index 578e246a8..3cb7a0cd4 100644
--- a/src/main/webapp/app/shared/texts/UsageText.tsx
+++ b/src/main/webapp/app/shared/texts/UsageText.tsx
@@ -1,9 +1,9 @@
import React from 'react';
-function getUsageTextClassName(usage: number) {
- if (usage >= 1000000000) {
+function getUsageTextClassName(usage: number | undefined) {
+ if (usage !== undefined && usage >= 1000000000) {
return 'text-danger';
- } else if (usage >= 1000000) {
+ } else if (usage !== undefined && usage >= 1000000) {
return 'text-warning';
} else {
return '';
@@ -11,11 +11,11 @@ function getUsageTextClassName(usage: number) {
}
const UsageText: React.FunctionComponent<{
- usage: number;
+ usage: number | undefined;
}> = ({ usage }) => {
return (
- {usage.toLocaleString()}
+ {usage?.toLocaleString() ?? 'N/A'}
);
};
diff --git a/src/test/java/org/mskcc/cbio/oncokb/web/rest/UsageAnalysisControllerIT.java b/src/test/java/org/mskcc/cbio/oncokb/web/rest/UsageAnalysisControllerIT.java
index 24ac4c7cd..cdf1d4f37 100644
--- a/src/test/java/org/mskcc/cbio/oncokb/web/rest/UsageAnalysisControllerIT.java
+++ b/src/test/java/org/mskcc/cbio/oncokb/web/rest/UsageAnalysisControllerIT.java
@@ -20,6 +20,7 @@
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;
import java.util.*;
+import java.util.AbstractMap.SimpleEntry;
import java.util.Map.Entry;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -27,7 +28,6 @@
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
-import org.mockito.Spy;
import org.mskcc.cbio.oncokb.config.Constants;
import org.mskcc.cbio.oncokb.domain.User;
import org.mskcc.cbio.oncokb.domain.enumeration.FileExtension;
@@ -465,43 +465,15 @@ private void safeSetNestedValueInFilesObject(
obj.addProperty(lastKey, value);
}
- /**
- * Set an empty object to the value found in the files JSON object based on the JSON path created by the
- * keys. If an object is missing in the JSON path then it's created.
- * @param value The value that is going to be added to value located in the JSON path.
- * @param firstKey First key in the files object.
- * @param index Array index of the array the {@code firstKey} parameter points to.
- * @param keys The remaining JSON path keys.
- */
- private void safeSetNestedEmptyObjectInFilesObject(
- String firstKey,
- String... keys
- ) {
- KeyValuePair pair = safeFetchJsonObjectFromFilesObject(
- firstKey,
- keys
- );
- String lastKey = pair.key;
- JsonObject obj = pair.value;
- if (!obj.has(lastKey)) {
- obj.add(lastKey, new JsonObject());
- }
- }
-
private void addUsers(String[] userNames) throws Exception {
LocalDate today = TimeUtil.getCurrentNYTime(this.clock).toLocalDate();
int currentYear = today.getYear();
int userId = -1;
for (String userName : userNames) {
- int totalUsage = 0;
userId++;
// force ordering to consistent since we are doing strict checks on
// asserts for json
userName = userId + userName;
- HashMap userResourceUsage = new HashMap<>();
- for (String oncokbEndpoint : sampleOncokbEndpoints) {
- userResourceUsage.put(oncokbEndpoint, 0);
- }
int companyIndex = userId % fakeCompanies.length;
String companyName = fakeCompanies[companyIndex];
@@ -520,9 +492,12 @@ private void addUsers(String[] userNames) throws Exception {
"/api/usage/summary/users?companyId=" + companyDTO.getId(),
};
- for (int yearIndex = 0; yearIndex < 4; yearIndex++) {
+ for (int yearIndex = 0; yearIndex < 6; yearIndex++) {
+ boolean yearShouldBeRecorded = false;
+ Map yearUserResourceUsage = createUserResourceUsageMap();
+ int yearTotalUsage = 0;
+ int yearTotalPublicUsage = 0;
int year = currentYear - yearIndex;
- Boolean isThisYear = yearIndex == 0;
DateTimeFormatter dayFormatter = DateTimeFormatter.ofPattern(
"yyyy-MM-dd"
@@ -534,6 +509,10 @@ private void addUsers(String[] userNames) throws Exception {
String yearKey = String.valueOf(year);
for (int month = 1; month <= 12; month++) {
+ boolean monthShouldBeRecorded = false;
+ Map monthUserResourceUsage = createUserResourceUsageMap();
+ int monthTotalUsage = 0;
+ int monthTotalPublicUsage = 0;
YearMonth yearMonth = YearMonth.of(year, month);
String monthKey = yearMonth.format(monthFormatter);
LocalDate start = yearMonth.atDay(1).atStartOfDay().toLocalDate();
@@ -547,12 +526,16 @@ private void addUsers(String[] userNames) throws Exception {
!date.isAfter(end) && !date.isAfter(today);
date = date.plusDays(1)
) {
+ boolean dayShouldBeRecorded = false;
+ Map dayUserResourceUsage = createUserResourceUsageMap();
+ int dayTotalUsage = 0;
+ int dayTotalPublicUsage = 0;
int j = 0;
String dayKey = date.format(dayFormatter);
while (random.nextInt() % 5 == 0 && j < 5) {
j++;
String oncokbEndpoint = getNextOncokbEndpoint();
- int value = random.nextInt(100);
+ int value = random.nextInt(100) + 1;
updateResourceYearFile(
value,
@@ -584,33 +567,29 @@ private void addUsers(String[] userNames) throws Exception {
dayKey
);
- boolean isAfterOrEqualToPast12Months = date.isAfter(
- today.minusMonths(11).withDayOfMonth(1).minusDays(1)
+ boolean isAfterOrEqualToPast3FullYears = date.isAfter(
+ today.minusYears(3).withDayOfYear(1).minusDays(1)
);
boolean isBeforeOrEqualToToday = date.isBefore(
today.plusMonths(1).withDayOfMonth(1)
);
- // update expected response for monthly resource summary
- if (isThisYear) {
+ if (isAfterOrEqualToPast3FullYears && isBeforeOrEqualToToday) {
updateResourceSummaryExpectedResponse(
value,
oncokbEndpoint,
- monthKey
+ yearKey,
+ monthKey,
+ dayKey
);
- }
-
- // update expected response for user usage endpoint
- if (isThisYear) {
safeAddNestedValueInFilesObject(
value,
usageUserEndpoint,
"summary",
"year",
+ yearKey,
oncokbEndpoint
);
- }
- if (isAfterOrEqualToPast12Months && isBeforeOrEqualToToday) {
safeAddNestedValueInFilesObject(
value,
usageUserEndpoint,
@@ -627,86 +606,97 @@ private void addUsers(String[] userNames) throws Exception {
dayKey,
oncokbEndpoint
);
- }
-
- if (isThisYear) {
updateSpecificEndpointUserUsageExpectedResponse(
value,
user,
oncokbEndpoint,
- monthKey
+ yearKey,
+ monthKey,
+ dayKey
);
- }
-
- // update user endpoint usage endpoint
- if (isAfterOrEqualToPast12Months && isBeforeOrEqualToToday) {
- for (String usageSummaryEndpoint : userUsageSummaryEndpoints) {
- safeAddNestedValueInFilesObject(
- value,
- usageSummaryEndpoint,
- userId,
- "dayUsage",
- dayKey
- );
-
- safeAddNestedValueInFilesObject(
- value,
- usageSummaryEndpoint,
- userId,
- "monthUsage",
- monthKey
- );
- }
- }
- if (isThisYear) {
- userResourceUsage.put(
+ // track for user endpoint usage endpoint
+ dayUserResourceUsage.put(
+ oncokbEndpoint,
+ dayUserResourceUsage.get(oncokbEndpoint) + value
+ );
+ monthUserResourceUsage.put(
+ oncokbEndpoint,
+ monthUserResourceUsage.get(oncokbEndpoint) + value
+ );
+ yearUserResourceUsage.put(
oncokbEndpoint,
- userResourceUsage.get(oncokbEndpoint) + value
+ yearUserResourceUsage.get(oncokbEndpoint) + value
);
- for (String usageSummaryEndpoint : userUsageSummaryEndpoints) {
- safeAddNestedValueInFilesObject(
- value,
- usageSummaryEndpoint,
- userId,
- "totalUsage"
- );
+ if (!oncokbEndpoint.startsWith("/api/private/")) {
+ dayTotalPublicUsage += value;
+ monthTotalPublicUsage += value;
+ yearTotalPublicUsage += value;
}
- totalUsage += value;
+ dayTotalUsage += value;
+ monthTotalUsage += value;
+ yearTotalUsage += value;
+ dayShouldBeRecorded = true;
+ monthShouldBeRecorded = true;
+ yearShouldBeRecorded = true;
}
}
+ if (dayShouldBeRecorded) {
+ updateUserSummaryUsageExpectedResponse(
+ "dayUsage",
+ dayKey,
+ user,
+ dayTotalUsage,
+ dayTotalPublicUsage,
+ userUsageSummaryEndpoints,
+ dayUserResourceUsage
+ );
+ }
+ }
+ if (monthShouldBeRecorded) {
+ updateUserSummaryUsageExpectedResponse(
+ "monthUsage",
+ monthKey,
+ user,
+ monthTotalUsage,
+ monthTotalPublicUsage,
+ userUsageSummaryEndpoints,
+ monthUserResourceUsage
+ );
}
}
+ if (yearShouldBeRecorded) {
+ updateUserSummaryUsageExpectedResponse(
+ "yearUsage",
+ yearKey,
+ user,
+ yearTotalUsage,
+ yearTotalPublicUsage,
+ userUsageSummaryEndpoints,
+ yearUserResourceUsage
+ );
+ }
}
- Entry maxResourceEntry = userResourceUsage
- .entrySet()
- .stream()
- .max(Map.Entry.comparingByValue())
- .orElseThrow(Exception::new);
- Entry maxNoPrivateResourceEntry = userResourceUsage
- .entrySet()
- .stream()
- .filter(x -> !x.getKey().startsWith("/api/private/"))
- .max(Map.Entry.comparingByValue())
- .orElseThrow(Exception::new);
-
- updateUserSummaryUsageExpectedResponse(
- user,
- totalUsage,
- userUsageSummaryEndpoints,
- maxResourceEntry,
- maxNoPrivateResourceEntry
- );
updateUserUsageExpectedResponse(user, userDto, usageUserEndpoint);
}
}
+ private HashMap createUserResourceUsageMap() {
+ HashMap userResourceUsage = new HashMap<>();
+ for (String oncokbEndpoint : sampleOncokbEndpoints) {
+ userResourceUsage.put(oncokbEndpoint, 0);
+ }
+ return userResourceUsage;
+ }
+
private void updateSpecificEndpointUserUsageExpectedResponse(
int value,
User user,
String oncokbEndpoint,
- String monthKey
+ String yearKey,
+ String monthKey,
+ String dayKey
) {
String usageResourcesEndpoint =
"/api/usage/resources?endpoint=" + oncokbEndpoint;
@@ -714,6 +704,7 @@ private void updateSpecificEndpointUserUsageExpectedResponse(
value,
usageResourcesEndpoint,
"year",
+ yearKey,
user.getEmail()
);
safeAddNestedValueInFilesObject(
@@ -723,16 +714,40 @@ private void updateSpecificEndpointUserUsageExpectedResponse(
monthKey,
user.getEmail()
);
- safeSetNestedEmptyObjectInFilesObject(usageResourcesEndpoint, "day");
+ safeAddNestedValueInFilesObject(
+ value,
+ usageResourcesEndpoint,
+ "day",
+ dayKey,
+ user.getEmail()
+ );
}
private void updateUserSummaryUsageExpectedResponse(
+ String timePeriodKey,
+ String timePeriodValue,
User user,
int totalUsage,
+ int totalPublicUsage,
String[] userUsageSummaryEndpoints,
- Entry maxResourceEntry,
- Entry maxNoPrivateResourceEntry
- ) {
+ Map userResourceUsage
+ )
+ throws Exception {
+ Entry maxResourceEntry = userResourceUsage
+ .entrySet()
+ .stream()
+ .filter(x -> x.getValue() > 0)
+ .max(Map.Entry.comparingByValue())
+ .orElse(new SimpleEntry("", 0));
+
+ Entry maxPublicResourceEntry = userResourceUsage
+ .entrySet()
+ .stream()
+ .filter(
+ x -> !x.getKey().startsWith("/api/private/") && x.getValue() > 0
+ )
+ .max(Map.Entry.comparingByValue())
+ .orElse(new SimpleEntry("", 0));
int userId = user.getId().intValue();
for (String usageSummaryUrl : userUsageSummaryEndpoints) {
safeSetNestedValueInFilesObject(
@@ -747,33 +762,58 @@ private void updateUserSummaryUsageExpectedResponse(
userId,
"userEmail"
);
+ safeSetNestedValueInFilesObject(
+ totalUsage,
+ usageSummaryUrl,
+ userId,
+ timePeriodKey,
+ timePeriodValue,
+ "totalUsage"
+ );
+ safeSetNestedValueInFilesObject(
+ totalPublicUsage,
+ usageSummaryUrl,
+ userId,
+ timePeriodKey,
+ timePeriodValue,
+ "totalPublicUsage"
+ );
safeSetNestedValueInFilesObject(
maxResourceEntry.getKey(),
usageSummaryUrl,
userId,
- "endpoint"
+ timePeriodKey,
+ timePeriodValue,
+ "mostUsedEndpoint"
);
safeSetNestedValueInFilesObject(
- maxNoPrivateResourceEntry.getKey(),
+ maxPublicResourceEntry.getKey(),
usageSummaryUrl,
userId,
- "noPrivateEndpoint"
+ timePeriodKey,
+ timePeriodValue,
+ "mostUsedPublicEndpoint"
);
safeSetNestedValueInFilesObject(
(int) (1000 * ((float) maxResourceEntry.getValue() / totalUsage)) /
10f,
usageSummaryUrl,
userId,
+ timePeriodKey,
+ timePeriodValue,
"maxUsageProportion"
);
safeSetNestedValueInFilesObject(
(int) (
- 1000 * ((float) maxNoPrivateResourceEntry.getValue() / totalUsage)
+ 1000 *
+ ((float) maxPublicResourceEntry.getValue() / totalPublicUsage)
) /
10f,
usageSummaryUrl,
userId,
- "noPrivateMaxUsageProportion"
+ timePeriodKey,
+ timePeriodValue,
+ "publicMaxUsageProportion"
);
}
}
@@ -818,13 +858,16 @@ private void updateUserUsageExpectedResponse(
private void updateResourceSummaryExpectedResponse(
int value,
String oncokbEndpoint,
- String monthKey
+ String yearKey,
+ String monthKey,
+ String dayKey
) {
String usageSummaryResources = "/api/usage/summary/resources";
safeAddNestedValueInFilesObject(
value,
usageSummaryResources,
"year",
+ yearKey,
oncokbEndpoint
);
safeAddNestedValueInFilesObject(
@@ -834,8 +877,13 @@ private void updateResourceSummaryExpectedResponse(
monthKey,
oncokbEndpoint
);
-
- safeSetNestedEmptyObjectInFilesObject(usageSummaryResources, "day");
+ safeAddNestedValueInFilesObject(
+ value,
+ usageSummaryResources,
+ "day",
+ dayKey,
+ oncokbEndpoint
+ );
}
private void updateResourceYearFile(