open-vault/ui/app/components/calendar-widget.js
claire bontempo 4a9610f382
UI: combine current + history client count tabs into one dashboard (#17575)
* WIP/initial routing-ish

* refactor date dropdown to reuse in modal and allowe current month selection

* swap linter disable line

* refactor date-dropdown to return object

* refactor calendar widget, add tests

* change calendar start and end args to getters

* refactor dashboard to use date objects instead of array of year, month

* remove dashboard files for easier to follow git diff

* comment out dashboard tab until route name updated

* delete current tab and route

* fix undefined banner time

* cleanup version history serializer and upgrade data

* first pass of updating tests

* add changelog

* update client count util test

* validate end time is after start time

* update comment

* add current month to calendar widget

* add comments for code changes to make following API update

* Removed a modified file from pull request

* address comments/cleanup

* update variables to const

* update test const

* rename history -> dashboard, fix tests

* fix timestamps for attribution chart

* update release note

* refactor using backend start and end time params

* add test for adapter formatting time params

* fix tests

* cleanup adapter comment and query params

* change back history file name for diff

* rename file using cli

* revert filenames

* rename files via git cli

* revert route file name

* last cli rename

* refactor mirage

* hold off on running total changes

* update params in test

* refactor to remove conditional assertions

* finish tests

* fix firefox tooltip

* remove current-when

* refactor version history

* add timezone/UTC note

* final cleanup!!!!

* fix test

* fix client count date tests

* fix date-dropdown test

* clear datedropdown completely

* update date selectors to accommodate new year (#18586)

* Revert "hold off on running total changes"

This reverts commit 8dc79a626d549df83bc47e290392a556c670f98f.

* remove assumed 0 values

* update average helper to only calculate for array of objects

* remove passing in bar chart data, map in running totals component instead

* cleanup usage stat component

* clear  ss filters for new queries

* update csv export, add explanation to modal

* update test copy

* consistently return null if no upgrade during activity (instead of empty array)

* update description, add clarifying comments

* update tes

* add more clarifying comments

* fix historic single month chart

* remove old test tag

* Update ui/app/components/clients/dashboard.js
2023-01-26 18:21:12 -08:00

114 lines
3.8 KiB
JavaScript

import Component from '@glimmer/component';
import { action } from '@ember/object';
import { tracked } from '@glimmer/tracking';
import { ARRAY_OF_MONTHS, parseAPITimestamp } from 'core/utils/date-formatters';
import { addYears, isSameYear, subYears } from 'date-fns';
/**
* @module CalendarWidget
* CalendarWidget component is used in the client counts dashboard to select a month/year to query the /activity endpoint.
* The component returns an object with selected date info, example: { dateType: 'endDate', monthIdx: 0, monthName: 'January', year: 2022 }
*
* @example
* ```js
* <CalendarWidget @startTimestamp={{this.startTime}} @endTimestamp={{this.endTime}} @selectMonth={{this.handleSelection}} />
*
* @param {string} startTimestamp - ISO timestamp string of the calendar widget's start time, displays in dropdown trigger
* @param {string} endTimestamp - ISO timestamp string for the calendar widget's end time, displays in dropdown trigger
* @param {function} selectMonth - callback function from parent - fires when selecting a month or clicking "Current billing period"
* />
* ```
*/
export default class CalendarWidget extends Component {
currentDate = new Date();
@tracked calendarDisplayDate = this.currentDate; // init to current date, updates when user clicks on calendar chevrons
@tracked showCalendar = false;
@tracked tooltipTarget = null;
@tracked tooltipText = null;
// both date getters return a date object
get startDate() {
return parseAPITimestamp(this.args.startTimestamp);
}
get endDate() {
return parseAPITimestamp(this.args.endTimestamp);
}
get displayYear() {
return this.calendarDisplayDate.getFullYear();
}
get disableFutureYear() {
return isSameYear(this.calendarDisplayDate, this.currentDate);
}
get disablePastYear() {
// calendar widget should only go as far back as the passed in start time
return isSameYear(this.calendarDisplayDate, this.startDate);
}
get widgetMonths() {
const startYear = this.startDate.getFullYear();
const startMonthIdx = this.startDate.getMonth();
return ARRAY_OF_MONTHS.map((month, index) => {
let readonly = false;
// if widget is showing same year as @startTimestamp year, disable if month is before start month
if (startYear === this.displayYear && index < startMonthIdx) {
readonly = true;
}
// if widget showing current year, disable if month is later than current month
if (this.displayYear === this.currentDate.getFullYear() && index > this.currentDate.getMonth()) {
readonly = true;
}
return {
index,
year: this.displayYear,
name: month,
readonly,
};
});
}
@action
addTooltip() {
if (this.disablePastYear) {
const previousYear = this.displayYear - 1;
this.tooltipText = `${previousYear} is unavailable because it is before your start date. Change your start month to a date in ${previousYear} to see data for this year.`;
this.tooltipTarget = '#previous-year';
}
}
@action
removeTooltip() {
this.tooltipTarget = null;
}
@action
addYear() {
this.calendarDisplayDate = addYears(this.calendarDisplayDate, 1);
}
@action
subYear() {
this.calendarDisplayDate = subYears(this.calendarDisplayDate, 1);
}
@action
toggleShowCalendar() {
this.showCalendar = !this.showCalendar;
this.calendarDisplayDate = this.endDate;
}
@action
handleDateShortcut(dropdown, { target }) {
this.args.selectMonth({ dateType: target.name }); // send clicked shortcut to parent callback
this.showCalendar = false;
dropdown.close();
}
@action
selectMonth(month, dropdown) {
const { index, year, name } = month;
this.toggleShowCalendar();
this.args.selectMonth({ monthIdx: index, monthName: name, year, dateType: 'endDate' });
dropdown.close();
}
}