Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Change default period to today for brand new sites (#5298)
RobertJoonas27290b9899de
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex ee43468a30..8ae5b58907 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -33,6 +33,7 @@ All notable changes to this project will be documented in this file.### Changed+- Default period for brand new sites is now `today` rather than `last 28 days`. On the next day, the default changes to `last 28 days`.- Increase decimal precision of the "Exit rate" metric from 0 to 1 (e.g. 67 -> 66.7)- Increase decimal precision of the "Conversion rate" metric from 1 to 2 (e.g. 16.7 -> 16.67)- The "Last 30 days" period is now "Last 28 days" on the dashboard and also the new default. Keyboard shortcut `T` still works for last 30 days.diff --git a/assets/js/dashboard/query-context.tsx b/assets/js/dashboard/query-context.tsxindex 6f9d869106..05571dc3dc 100644--- a/assets/js/dashboard/query-context.tsx+++ b/assets/js/dashboard/query-context.tsx@@ -68,6 +68,7 @@ export default function QueryContextProvider({const defaultValues = queryDefaultValueconst storedValues = getSavedTimePreferencesFromStorage({ site })const timeQuery = getDashboardTimeSettings({+ site,searchValues: { period, comparison, match_day_of_week },storedValues,defaultValues,diff --git a/assets/js/dashboard/query-time-periods.test.ts b/assets/js/dashboard/query-time-periods.test.tsindex b002bc2dbe..a1f2a90b55 100644--- a/assets/js/dashboard/query-time-periods.test.ts+++ b/assets/js/dashboard/query-time-periods.test.ts@@ -1,3 +1,4 @@+import { DEFAULT_SITE } from '../../test-utils/app-context-providers'import {ComparisonMode,getDashboardTimeSettings,@@ -5,6 +6,7 @@ import {getStoredPeriod,QueryPeriod} from './query-time-periods'+import { formatISO, utcNow } from './util/date'describe(`${getStoredPeriod.name}`, () => {const domain = 'any.site'@@ -22,8 +24,10 @@ describe(`${getStoredPeriod.name}`, () => {})describe(`${getDashboardTimeSettings.name}`, () => {+ const site = DEFAULT_SITE+const defaultValues = {- period: QueryPeriod['7d'],+ period: QueryPeriod['28d'],comparison: null,match_day_of_week: true}@@ -41,6 +45,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {it('returns defaults if nothing stored and no search', () => {expect(getDashboardTimeSettings({+ site: site,searchValues: emptySearchValues,storedValues: emptyStoredValues,defaultValues,@@ -49,9 +54,37 @@ describe(`${getDashboardTimeSettings.name}`, () => {).toEqual(defaultValues)})+ it('defaults period to today if the site was created today', () => {+ expect(+ getDashboardTimeSettings({+ site: { ...site, nativeStatsBegin: formatISO(utcNow()) },+ searchValues: emptySearchValues,+ storedValues: emptyStoredValues,+ defaultValues,+ segmentIsExpanded: false+ })+ ).toEqual({ ...defaultValues, period: 'day' })+ })++ it('defaults period to today if the site was created yesterday', () => {+ expect(+ getDashboardTimeSettings({+ site: {+ ...site,+ nativeStatsBegin: formatISO(utcNow().subtract(1, 'day'))+ },+ searchValues: emptySearchValues,+ storedValues: emptyStoredValues,+ defaultValues,+ segmentIsExpanded: false+ })+ ).toEqual({ ...defaultValues, period: 'day' })+ })+it('returns stored values if no search', () => {expect(getDashboardTimeSettings({+ site: site,searchValues: emptySearchValues,storedValues: {period: QueryPeriod['12mo'],@@ -71,6 +104,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {it('uses values from search above all else, treats ComparisonMode.off as null', () => {expect(getDashboardTimeSettings({+ site: site,searchValues: {period: QueryPeriod['year'],comparison: ComparisonMode.off,@@ -94,6 +128,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {it('respects segmentIsExpanded: true option: comparison and edit segment mode are mutually exclusive', () => {expect(getDashboardTimeSettings({+ site: site,searchValues: {period: QueryPeriod['custom'],comparison: ComparisonMode.previous_period,diff --git a/assets/js/dashboard/query-time-periods.ts b/assets/js/dashboard/query-time-periods.tsindex f0ddf48165..dfaf9cab2e 100644--- a/assets/js/dashboard/query-time-periods.ts+++ b/assets/js/dashboard/query-time-periods.ts@@ -16,6 +16,7 @@ import {isThisMonth,isThisYear,isToday,+ isTodayOrYesterday,lastMonth,nowForSite,parseNaiveDate,@@ -533,11 +534,13 @@ export function getSavedTimePreferencesFromStorage({}export function getDashboardTimeSettings({+ site,searchValues,storedValues,defaultValues,segmentIsExpanded}: {+ site: PlausibleSitesearchValues: Record<'period' | 'comparison' | 'match_day_of_week', unknown>storedValues: ReturnType<typeof getSavedTimePreferencesFromStorage>defaultValues: Pick<@@ -549,10 +552,12 @@ export function getDashboardTimeSettings({let period: QueryPeriodif (isValidPeriod(searchValues.period)) {period = searchValues.period+ } else if (isValidPeriod(storedValues.period)) {+ period = storedValues.period+ } else if (isTodayOrYesterday(site.nativeStatsBegin)) {+ period = QueryPeriod.day} else {- period = isValidPeriod(storedValues.period)- ? storedValues.period- : defaultValues.period+ period = defaultValues.period}let comparison: ComparisonMode | nulldiff --git a/assets/js/dashboard/util/date.js b/assets/js/dashboard/util/date.jsindex a783bc305a..8fff39c09c 100644--- a/assets/js/dashboard/util/date.js+++ b/assets/js/dashboard/util/date.js@@ -3,6 +3,10 @@ import utc from 'dayjs/plugin/utc'dayjs.extend(utc)+export function utcNow() {+ return dayjs()+}+// https://stackoverflow.com/a/50130338export function formatISO(date) {return date.format('YYYY-MM-DD')@@ -95,6 +99,12 @@ export function isToday(site, date) {return isSameDate(date, nowForSite(site))}+export function isTodayOrYesterday(isoDate) {+ const isoToday = formatISO(dayjs())+ const isoYesterday = formatISO(dayjs().subtract(1, 'day'))+ return isoDate === isoToday || isoDate === isoYesterday+}+export function isThisMonth(site, date) {return formatMonthYYYY(date) === formatMonthYYYY(nowForSite(site))}diff --git a/assets/test-utils/app-context-providers.tsx b/assets/test-utils/app-context-providers.tsxindex cb73c60726..9c11a5579c 100644--- a/assets/test-utils/app-context-providers.tsx+++ b/assets/test-utils/app-context-providers.tsx@@ -22,6 +22,29 @@ type TestContextProvidersProps = {preloaded?: { segments?: SavedSegments }}+export const DEFAULT_SITE: PlausibleSite = {+ domain: 'plausible.io/unit',+ offset: 0,+ hasGoals: false,+ hasProps: false,+ funnelsAvailable: false,+ propsAvailable: false,+ siteSegmentsAvailable: false,+ conversionsOptedOut: false,+ funnelsOptedOut: false,+ propsOptedOut: false,+ revenueGoals: [],+ funnels: [],+ statsBegin: '',+ nativeStatsBegin: '',+ embedded: false,+ background: '',+ isDbip: false,+ flags: {},+ validIntervalsByPeriod: {},+ shared: false+}+export const TestContextProviders = ({children,routerProps,@@ -29,30 +52,7 @@ export const TestContextProviders = ({preloaded,user}: TestContextProvidersProps) => {- const defaultSite: PlausibleSite = {- domain: 'plausible.io/unit',- offset: 0,- hasGoals: false,- hasProps: false,- funnelsAvailable: false,- propsAvailable: false,- siteSegmentsAvailable: false,- conversionsOptedOut: false,- funnelsOptedOut: false,- propsOptedOut: false,- revenueGoals: [],- funnels: [],- statsBegin: '',- nativeStatsBegin: '',- embedded: false,- background: '',- isDbip: false,- flags: {},- validIntervalsByPeriod: {},- shared: false- }-- const site = { ...defaultSite, ...siteOptions }+ const site = { ...DEFAULT_SITE, ...siteOptions }const queryClient = new QueryClient({defaultOptions: {