luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

Client count: remove default period and extra controllers (#14050) 

* remove controllerS

* remove default report months

* remove default months from the config page

* fix tests

* clean up edit config
This commit is contained in:
Angel Garbarino 2022-02-14 11:30:48 -07:00 committed by GitHub
parent 2a08838ed5
commit 687469552c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 131 additions and 174 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ui/app/components/clients/config.js
View File

@ -34,11 +34,6 @@ export default class ConfigComponent extends Component {
helperText: 'The number of months of activity logs to maintain for client tracking.',
valueKey: 'retentionMonths',
},
{
label: 'Default display',
helperText: 'The number of months we’ll display in the Vault usage dashboard by default.',
valueKey: 'defaultReportMonths',
},
];
}

3
ui/app/controllers/vault/cluster/clients/config.js
View File

@ -1,3 +0,0 @@
import Controller from '@ember/controller';
export default class ConfigController extends Controller {}

3
ui/app/controllers/vault/cluster/clients/current.js
View File

@ -1,3 +0,0 @@
import Controller from '@ember/controller';
export default class CurrentController extends Controller {}

3
ui/app/controllers/vault/cluster/clients/history.js
View File

@ -1,3 +0,0 @@
import Controller from '@ember/controller';
export default class HistoryController extends Controller {}

3
ui/app/controllers/vault/cluster/clients/index.js
View File

@ -1,3 +0,0 @@
import Controller from '@ember/controller';
export default class ClientsController extends Controller {}

6
ui/app/models/clients/config.js
View File

@ -6,10 +6,6 @@ import { apiPath } from 'vault/macros/lazy-capabilities';
const M = Model.extend({
queriesAvailable: attr('boolean'),
defaultReportMonths: attr('number', {
label: 'Default display',
subText: 'The number of months we’ll display in the Vault usage dashboard by default.',
}),
retentionMonths: attr('number', {
label: 'Retention period',
subText: 'The number of months of activity logs to maintain for client tracking.',
@ -24,7 +20,7 @@ const M = Model.extend({
}),
configAttrs: computed(function () {
let keys = ['enabled', 'defaultReportMonths', 'retentionMonths'];
let keys = ['enabled', 'retentionMonths'];
return expandAttributeMeta(this, keys);
}),
});

3
ui/app/serializers/clients/config.js
View File

@ -22,9 +22,8 @@ export default ApplicationSerializer.extend({
const oldEnabled = json.enabled;
json.enabled = oldEnabled === 'On' ? 'enable' : 'disable';
}
json.default_report_months = parseInt(json.default_report_months, 10);
json.retention_months = parseInt(json.retention_months, 10);
if (isNaN(json.default_report_months) || isNaN(json.retention_months)) {
if (isNaN(json.retention_months)) {
throw new Error('Invalid number value');
}
delete json.queries_available;

230
ui/app/templates/components/clients/config.hbs
View File

@ -1,16 +1,47 @@
{{#if @isLoading}}
<LayoutLoading />
{{else}}
{{#if (eq @mode "edit")}}
<form onsubmit={{action "onSaveChanges"}} data-test-pricing-metrics-config-form>
<div class="box is-sideless is-fullwidth is-marginless">
<MessageError @model={{@model}} @errorMessage={{this.error}} />
{{#each @model.configAttrs as |attr|}}
{{#if (and (eq attr.type "string") (eq attr.options.editType "boolean"))}}
<label class="is-label">Usage data collection</label>
{{#if attr.options.helpText}}
{{#if (eq @mode "edit")}}
<form onsubmit={{action "onSaveChanges"}} data-test-pricing-metrics-config-form>
<div class="box is-sideless is-fullwidth is-marginless">
<MessageError @model={{@model}} @errorMessage={{this.error}} />
{{#each @model.configAttrs as |attr|}}
{{#if (and (eq attr.type "string") (eq attr.options.editType "boolean"))}}
<label class="is-label">Usage data collection</label>
{{#if attr.options.helpText}}
<p class="sub-text">
{{attr.options.helpText}}
{{#if attr.options.docLink}}
<a href={{attr.options.docLink}} target="_blank" rel="noopener noreferrer">
See our documentation
</a>
for help.
{{/if}}
</p>
{{/if}}
<div class="control is-flex has-bottom-margin-l">
<input
data-test-field
type="checkbox"
id={{attr.name}}
name={{attr.name}}
class="switch is-rounded is-success is-small"
checked={{eq (get @model attr.name) attr.options.trueValue}}
onchange={{action (action "updateBooleanValue" attr) value="target.checked"}}
/>
<label for={{attr.name}}>
{{#if (eq @model.enabled "Off")}}
Data collection is off
{{else}}
Data collection is on
{{/if}}
</label>
</div>
{{else if (eq attr.type "number")}}
<div class="has-top-margin-s">
<label for={{attr.name}} class="is-label">
{{attr.options.label}}
</label>
{{#if attr.options.subText}}
<p class="sub-text">
{{attr.options.helpText}}
{{attr.options.subText}}
{{#if attr.options.docLink}}
<a href={{attr.options.docLink}} target="_blank" rel="noopener noreferrer">
See our documentation
@ -19,117 +50,82 @@
{{/if}}
</p>
{{/if}}
<div class="control is-flex has-bottom-margin-l">
<div class="control">
<input
data-test-field
type="checkbox"
id={{attr.name}}
name={{attr.name}}
class="switch is-rounded is-success is-small"
checked={{eq (get @model attr.name) attr.options.trueValue}}
onchange={{action (action "updateBooleanValue" attr) value="target.checked"}}
disabled={{eq @model.enabled "Off"}}
autocomplete="off"
spellcheck="false"
onchange={{action (mut (get @model attr.name)) value="target.value"}}
value={{or (get @model attr.name) attr.options.defaultValue}}
class="input"
maxLength={{attr.options.characterLimit}}
/>
<label for={{attr.name}}>
{{#if (eq @model.enabled "Off")}}
Data collection is off
{{else}}
Data collection is on
{{/if}}
</label>
</div>
{{else if (eq attr.type "number")}}
<div class="has-top-margin-s">
<label for={{attr.name}} class="is-label">
{{attr.options.label}}
</label>
{{#if attr.options.subText}}
<p class="sub-text">
{{attr.options.subText}}
{{#if attr.options.docLink}}
<a href={{attr.options.docLink}} target="_blank" rel="noopener noreferrer">
See our documentation
</a>
for help.
{{/if}}
</p>
{{/if}}
<div class="control">
<input
data-test-field
id={{attr.name}}
disabled={{eq @model.enabled "Off"}}
autocomplete="off"
spellcheck="false"
onchange={{action (mut (get @model attr.name)) value="target.value"}}
value={{or (get @model attr.name) attr.options.defaultValue}}
class="input"
maxLength={{attr.options.characterLimit}}
/>
</div>
</div>
{{/if}}
{{/each}}
</div>
<div class="field is-grouped-split box is-fullwidth is-bottomless">
<div class="control">
<button
type="submit"
disabled={{this.buttonDisabled}}
class="button is-primary"
data-test-edit-metrics-config-save={{true}}
>
Save
</button>
<LinkTo @route="vault.cluster.clients.config" class="button">
Cancel
</LinkTo>
</div>
</div>
</form>
<Modal
@title={{this.modalTitle}}
@onClose={{action (mut this.modalOpen) false}}
@isActive={{this.modalOpen}}
@type="warning"
@showCloseButton={{true}}
>
<section class="modal-card-body">
{{#if (eq @model.enabled "On")}}
<p class="has-bottom-margin-s">
Vault will start tracking data starting from today’s date,
{{date-format (now) "d MMMM yyyy"}}. You will not be able to see or query usage until the end of the month.
</p>
<p>If you’ve previously enabled usage tracking, that historical data will still be available to you.</p>
{{else}}
<p class="has-bottom-margin-s">
Turning usage tracking off means that all data for the current month will be deleted. You will still be able to
query previous months.
</p>
<p>Are you sure?</p>
</div>
{{/if}}
</section>
<footer class="modal-card-foot modal-card-foot-outlined">
<button
type="button"
class="button is-secondary"
onclick={{action (mut this.modalOpen) false}}
data-test-metrics-config-cancel
>
Cancel
</button>
<button type="button" class="button is-primary" onclick={{perform this.save}}>
Continue
</button>
</footer>
</Modal>
{{else}}
<div
class="tabs-container box is-bottomless is-marginless is-fullwidth is-paddingless"
data-test-pricing-metrics-config-table
>
{{#each this.infoRows as |item|}}
<InfoTableRow @label={{item.label}} @helperText={{item.helperText}} @value={{get @model item.valueKey}} />
{{/each}}
</div>
{{/if}}
<div class="field is-grouped-split box is-fullwidth is-bottomless">
<div class="control">
<button
type="submit"
disabled={{this.buttonDisabled}}
class="button is-primary"
data-test-edit-metrics-config-save={{true}}
>
Save
</button>
<LinkTo @route="vault.cluster.clients.config" class="button">
Cancel
</LinkTo>
</div>
</div>
</form>
<Modal
@title={{this.modalTitle}}
@onClose={{action (mut this.modalOpen) false}}
@isActive={{this.modalOpen}}
@type="warning"
@showCloseButton={{true}}
>
<section class="modal-card-body">
{{#if (eq @model.enabled "On")}}
<p class="has-bottom-margin-s">
Vault will start tracking data starting from today’s date,
{{date-format (now) "d MMMM yyyy"}}. You will not be able to see or query usage until the end of the month.
</p>
<p>If you’ve previously enabled usage tracking, that historical data will still be available to you.</p>
{{else}}
<p class="has-bottom-margin-s">
Turning usage tracking off means that all data for the current month will be deleted. You will still be able to
query previous months.
</p>
<p>Are you sure?</p>
{{/if}}
</section>
<footer class="modal-card-foot modal-card-foot-outlined">
<button
type="button"
class="button is-secondary"
onclick={{action (mut this.modalOpen) false}}
data-test-metrics-config-cancel
>
Cancel
</button>
<button type="button" class="button is-primary" onclick={{perform this.save}}>
Continue
</button>
</footer>
</Modal>
{{else}}
<div
class="tabs-container box is-bottomless is-marginless is-fullwidth is-paddingless"
data-test-pricing-metrics-config-table
>
{{#each this.infoRows as |item|}}
<InfoTableRow @label={{item.label}} @helperText={{item.helperText}} @value={{get @model item.valueKey}} />
{{/each}}
</div>
{{/if}}

30
ui/app/templates/components/clients/current.hbs
View File

@ -45,25 +45,21 @@
</DocLink>
</AlertBanner>
{{/if}}
{{#if @isLoading}}
<LayoutLoading />
{{else}}
{{#if this.totalUsageCounts}}
<Clients::UsageStats
@title={{date-format this.responseTimestamp "MMMM"}}
{{#if this.totalUsageCounts}}
<Clients::UsageStats
@title={{date-format this.responseTimestamp "MMMM"}}
@totalUsageCounts={{this.totalUsageCounts}}
/>
{{#if this.hasAttributionData}}
<Clients::Attribution
@chartLegend={{this.chartLegend}}
@totalClientsData={{this.totalClientsData}}
@totalUsageCounts={{this.totalUsageCounts}}
@selectedNamespace={{this.selectedNamespace}}
@startTimeDisplay={{date-format this.responseTimestamp "MMMM yyyy"}}
@isDateRange={{false}}
@timestamp={{this.responseTimestamp}}
/>
{{#if this.hasAttributionData}}
<Clients::Attribution
@chartLegend={{this.chartLegend}}
@totalClientsData={{this.totalClientsData}}
@totalUsageCounts={{this.totalUsageCounts}}
@selectedNamespace={{this.selectedNamespace}}
@startTimeDisplay={{date-format this.responseTimestamp "MMMM yyyy"}}
@isDateRange={{false}}
@timestamp={{this.responseTimestamp}}
/>
{{/if}}
{{/if}}
{{/if}}
{{/if}}

8
ui/app/templates/vault/cluster/clients/edit.hbs
View File

@ -1,9 +1 @@
<PageHeader as |p|>
<p.levelLeft>
<h1 class="title is-3">
Configure usage tracking
</h1>
</p.levelLeft>
</PageHeader>
<Clients::Config @model={{@model}} @mode="edit" />

11
ui/tests/integration/components/clients-config-test.js
View File

@ -34,7 +34,6 @@ module('Integration | Component | client count config', function (hooks) {
configAttrs: [
createAttr('enabled', 'string', { editType: 'boolean' }),
createAttr('retentionMonths', 'number'),
createAttr('defaultReportMonths', 'number'),
],
changedAttributes: () => ({}),
save: () => {},
@ -54,7 +53,7 @@ module('Integration | Component | client count config', function (hooks) {
assert.dom('[data-test-pricing-metrics-config-table]').exists('Pricing metrics config table exists');
const rows = document.querySelectorAll('.info-table-row');
assert.equal(rows.length, 3, 'renders 3 infotable rows');
assert.equal(rows.length, 2, 'renders 2 infotable rows');
assert.ok(
find('[data-test-row-value="Usage data collection"]').textContent.includes('On'),
'Enabled value matches model'
@ -63,10 +62,6 @@ module('Integration | Component | client count config', function (hooks) {
find('[data-test-row-value="Retention period"]').textContent.includes('24'),
'Retention period value matches model'
);
assert.ok(
find('[data-test-row-value="Default display"]').textContent.includes('12'),
'Default display value matches model'
);
});
test('TODO: it shows the config edit form when mode = edit', async function (assert) {
@ -77,7 +72,7 @@ module('Integration | Component | client count config', function (hooks) {
assert.dom('[data-test-pricing-metrics-config-form]').exists('Pricing metrics config form exists');
const fields = document.querySelectorAll('[data-test-field]');
assert.equal(fields.length, 3, 'renders 3 fields');
assert.equal(fields.length, 2, 'renders 2 fields');
});
test('it shows a modal with correct messaging when disabling', async function (assert) {
@ -126,7 +121,7 @@ module('Integration | Component | client count config', function (hooks) {
test('it does not show a modal on save if enable left unchanged', async function (assert) {
// Simulates the model when something other than enabled changed
const simModel = generateModel({
changedAttributes: () => ({ defaultReportMonths: [24, '48'] }),
changedAttributes: () => ({ retentionMonths: [24, '48'] }),
});
this.set('model', simModel);
await render(hbs`