Add extra and gifted execution minutes

[tw4l]

Fixes #1358

Could use a good bit of additional manual testing, edge cases/fuzz testing welcomed (e.g. this has not been tested across months yet)! And very open to any suggestions to simplify the implementation on backend and/or frontend.

Overview

• Adds extraExecMinutes and giftedExecMinutes org quotas, which are not reset monthly but a one-time update-able bucket
• Adds quotaUpdate field to Organization to track when quotas were updated with timestamp
• Adds extraExecMinutesAvailable and giftedExecMinutesAvailable fields to Organization to help with tracking available time left (includes tested migration to initialize these to 0)
• Modifies org backend to track time across multiple categories, using monthly exec time first, then gifted, then extra
• Updates Dashboard crawling meter to include all types of execution time if extraExecMinutes and/or giftedExecMinutes are set above 0
• Updates Dashboard Usage History table to include all types of execution time
• Adds backend nightly test to check handling of quotas and execution time

Screenshots

Only monthly quota set, no execution time used yet

Only monthly quota set, with some execution time used

All three quotas set, no execution time used yet

All three quotas set, some execution time used

Tooltips

Quota reached

With storage quota also enabled

[Shrinks99]

Getting a runtime error on this branch, ran yarn to make sure I was up to date but still no success:

ERROR
Expected a finite number
module.exports@webpack-internal:///./node_modules/pretty-ms/index.js:10:9
Dashboard/this.formatExecutionSeconds/<@webpack-internal:///./src/pages/org/dashboard.ts:58:196
when@webpack-internal:///./node_modules/lit-html/development/directives/when.js:11:24
Dashboard/this.formatExecutionSeconds@webpack-internal:///./src/pages/org/dashboard.ts:58:69
renderCrawlingMeter/<@webpack-internal:///./src/pages/org/dashboard.ts:452:28
when@webpack-internal:///./node_modules/lit-html/development/directives/when.js:11:91
renderCrawlingMeter@webpack-internal:///./src/pages/org/dashboard.ts:441:71
render/<@webpack-internal:///./src/pages/org/dashboard.ts:235:22
renderCard/<@webpack-internal:///./src/pages/org/dashboard.ts:503:107
when@webpack-internal:///./node_modules/lit-html/development/directives/when.js:11:24
renderCard@webpack-internal:///./src/pages/org/dashboard.ts:503:73
render@webpack-internal:///./src/pages/org/dashboard.ts:234:18
update@webpack-internal:///./node_modules/lit-element/development/lit-element.js:138:28
performUpdate@webpack-internal:///./node_modules/@lit/reactive-element/development/reactive-element.js:831:22
scheduleUpdate@webpack-internal:///./node_modules/@lit/reactive-element/development/reactive-element.js:766:21
__enqueueUpdate@webpack-internal:///./node_modules/@lit/reactive-element/development/reactive-element.js:739:29

---

In the screenshots the inner shadow which helps the user discern the difference between the filled and unfilled part of the bar graph appears to be missing from the coloured backgrounds. Out of context, a completely unfilled graph might look more filled than we want it to without this!

---

For the tooltips, it looks like you've made discrete tooltips for each section (filled and unfilled) whereas in the mockups I had them as one so users could easily compare how many minutes in each section they had used? Open to other opinions if you have a reason this method is better.

I think I should have made a comment about this in the Figma, sorry :(

[tw4l]

Getting a runtime error on this branch, ran yarn to make sure I was up to date but still no success: ...

Looking into it!

In the screenshots the inner shadow which helps the user discern the difference between the filled and unfilled part of the bar graph appears to be missing from the coloured backgrounds. Out of context, a completely unfilled graph might look more filled than we want it to without this!

Ah, I missed that and you're entirely right! Will add in a follow-up commit.

For the tooltips, it looks like you've made discrete tooltips for each section (filled and unfilled) whereas in the mockups I had them as one so users could easily compare how many minutes in each section they had used? Open to other opinions if you have a reason this method is better.

I think I should have made a comment about this in the Figma, sorry :(

No reason to be sorry! This was just a holdover from a previous iteration and I hadn't noticed the difference in the mockups! Happy to change

[tw4l]

Blocked on #1386, which refactors a helper used extensively in this PR. Will wait for that to be merged first.

Update: merged and rebased

[tw4l]

@Shrinks99 @emma-sg Branch has been updated to resolve review comments, including:

• Rebase on latest humanizeExecutionSeconds work
• Add box shadow for remaining time bars
• Fix yarn runtime error
• Display single tooltip for used/remaining sections of each type of execution time when either extra or gifted execution minute quotas are enabled

Updated screenshots

No extra/gifted execution minute quotas (similar behavior as before)

Extra/gifted execution minute quotas added

(Single tooltip per type of execution minutes, displays if cursor is over used or remaining, centering on used if present)

[tw4l]

And one additional tweak to add right border-radius for execution time used bars if there is still remaining time in that category:

[tw4l]

Right border-radius now fixed so that the quota bar shows underneath without any white pixels:

Close-up:

This also made it easier to always center the tooltip on the execution type, rather than just on the used portion, e.g.:

[emma-sg]

Sweet! Nicely done, all works well as far as I can tell with my poking around

[ikreymer]

Nice! Looks good overall, but noticed one issue:
When changing the quota for the current month, I noticed that the bar resets to the entire monthly quota being used.
See attachment:

The actual usage is 3m 2s but the meter shows that all 20 mins have been used

[tw4l]

Let's update the logic so that monthlyExecSeconds <= monthly quota. That means if there's no monthly quota, it is not incremented, and otherwise only incremented up to the quota, eg. if there's a quota of 6000 seconds but actual shutdown takes 6030 seconds, crawlExecSeconds can go up to 6030 while monthlyExecSeconds will top at 6000.

Done!

[ikreymer]

I think we can finally merge this! (@tw4l just want to make sure the PR message is still accurate, if any tweaks should be made before merging)