Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENG-2280] Adds storage limit status messaging to file notifications #9561

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

UdayVarkhedkar
Copy link
Contributor

Purpose

Notifies admins on a given project if the project is approaching or over OSF Storage limits. This is necessary because admin contributors may not see initially see or be notified if the project is approaching OSF Storage limits.

Changes

  • Adds storage_limit_context as a part of the context sent to file_updated.html.mako
  • Updates file_updated.html.mako to use storage_limit_context to selectively show storage usage messaging

QA Notes

  • Verify that upon file actions, the file notification provides the appropriate storage usage messaging:
    • approaching storage caps vs over storage caps
    • messaging for public vs private projects

What are the areas of risk?

  • Because of the way in which storage usage is calculated and cached, we may see instances of the storage usage messaging either being relevant to the state of the project prior to the file change but no longer being accurate or instances of no storage usage messaging because the storage usage has not been calculated before the code that stores these emails runs.

Any concerns/considerations/questions that development raised?

  • I added messaging for when the project is over the storage limit as well as approaching (approaching is what the ticket requested); there is conversation in the product-consults flow around the desirability of this addition.

Documentation

N/A

Side Effects

N/A

Ticket

JIRA Ticket

@UdayVarkhedkar
Copy link
Contributor Author

Example of storage usage messaging for a private project approaching storage limits:
image

Example of storage usage messaging for a public project approaching storage limits:
image

The messaging if the project is over storage limits, as opposed to approaching, is similar but replaces the 'approaching' with 'over' to be something like:
This <public/private> project is over the...

@UdayVarkhedkar UdayVarkhedkar marked this pull request as ready for review December 3, 2020 21:40
Copy link
Collaborator

@jwalz jwalz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just one tiny question

This private project is ${storage_limit_context['storage_limit_status']} the 5GB OSF Storage limit and requires your attention. In order to avoid disruption of your workflow, please take action through one of the following options:<br>
<ul>
<li>Connect an <a href="https://help.osf.io/hc/en-us/sections/360003623833-Storage-add-ons">OSF Storage add-on</a> to continue managing your research efficiently from OSF. OSF add-ons are an easy way to extend your storage space while also streamlining your data management workflow.</li>
<li>Free up space by making one or more of your components public. <a href="https://help.osf.io/hc/en-us/articles/360019737614-Create-Components">Organize your project with components</a> to take advantage of the flexible structure and maximize storage options.</li>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the "organize your project" bit be its own list entry?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be combined! Here's the doc I adapted the language from (https://docs.google.com/document/d/1gB5Ya4InmZ3ozOQND1E-drVxnwYJZmzlfV1ohqwr-kQ/edit#bookmark=id.oty6uwnocayh); there are some modifications because we decided to include the storage messaging in file notifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants