Standardize naming for preview default limits (#4709)

#### Does this PR need a docs update or release note?

- [ ]  Yes, it's included
- [ ] 🕐 Yes, but in a later PR
- [x]  No

#### Type of change

- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [ ] 🗺️ Documentation
- [ ] 🤖 Supportability/Tests
- [ ] 💻 CI/Deployment
- [x] 🧹 Tech Debt/Cleanup

#### Test Plan

- [ ] 💪 Manual
- [x]  Unit test
- [ ] 💚 E2E
This commit is contained in:
ashmrtn 2023-11-17 19:43:34 -08:00 committed by GitHub
parent dac4c70f61
commit fd91d36c91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 42 additions and 42 deletions

View File

@ -32,11 +32,11 @@ import (
const ( const (
restrictedDirectory = "Site Pages" restrictedDirectory = "Site Pages"
defaultPreviewNumContainers = 5 defaultPreviewMaxContainers = 5
defaultPreviewNumItemsPerContainer = 10 defaultPreviewMaxItemsPerContainer = 10
defaultPreviewNumItems = defaultPreviewNumContainers * defaultPreviewNumItemsPerContainer defaultPreviewMaxItems = defaultPreviewMaxContainers * defaultPreviewMaxItemsPerContainer
defaultPreviewNumBytes int64 = 100 * 1024 * 1024 defaultPreviewMaxBytes int64 = 100 * 1024 * 1024
defaultPreviewNumPages = 50 defaultPreviewMaxPages = 50
) )
// Collections is used to retrieve drive data for a // Collections is used to retrieve drive data for a
@ -761,23 +761,23 @@ func newPagerLimiter(opts control.Options) *pagerLimiter {
res := &pagerLimiter{limits: opts.PreviewLimits} res := &pagerLimiter{limits: opts.PreviewLimits}
if res.limits.MaxContainers == 0 { if res.limits.MaxContainers == 0 {
res.limits.MaxContainers = defaultPreviewNumContainers res.limits.MaxContainers = defaultPreviewMaxContainers
} }
if res.limits.MaxItemsPerContainer == 0 { if res.limits.MaxItemsPerContainer == 0 {
res.limits.MaxItemsPerContainer = defaultPreviewNumItemsPerContainer res.limits.MaxItemsPerContainer = defaultPreviewMaxItemsPerContainer
} }
if res.limits.MaxItems == 0 { if res.limits.MaxItems == 0 {
res.limits.MaxItems = defaultPreviewNumItems res.limits.MaxItems = defaultPreviewMaxItems
} }
if res.limits.MaxBytes == 0 { if res.limits.MaxBytes == 0 {
res.limits.MaxBytes = defaultPreviewNumBytes res.limits.MaxBytes = defaultPreviewMaxBytes
} }
if res.limits.MaxPages == 0 { if res.limits.MaxPages == 0 {
res.limits.MaxPages = defaultPreviewNumPages res.limits.MaxPages = defaultPreviewMaxPages
} }
return res return res

View File

@ -4271,11 +4271,11 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
require.LessOrEqual( require.LessOrEqual(
suite.T(), suite.T(),
int64(1024*1024), int64(1024*1024),
defaultPreviewNumBytes, defaultPreviewMaxBytes,
"default number of bytes changed; DefaultNumBytes test case may need updating!") "default number of bytes changed; DefaultNumBytes test case may need updating!")
require.Zero( require.Zero(
suite.T(), suite.T(),
defaultPreviewNumBytes%(1024*1024), defaultPreviewMaxBytes%(1024*1024),
"default number of bytes isn't divisible by 1MB; DefaultNumBytes test case may need updating!") "default number of bytes isn't divisible by 1MB; DefaultNumBytes test case may need updating!")
// The number of pages returned can be indirectly tested by checking how many // The number of pages returned can be indirectly tested by checking how many
@ -4311,7 +4311,7 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
{ {
name: "DefaultNumItems", name: "DefaultNumItems",
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewNumItems + 1, numItemsPerContainer: defaultPreviewMaxItems + 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
MaxItemsPerContainer: 99999999, MaxItemsPerContainer: 99999999,
@ -4320,14 +4320,14 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
MaxPages: 99999999, MaxPages: 99999999,
}, },
expect: expected{ expect: expected{
numItems: defaultPreviewNumItems, numItems: defaultPreviewMaxItems,
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewNumItems, numItemsPerContainer: defaultPreviewMaxItems,
}, },
}, },
{ {
name: "DefaultNumContainers", name: "DefaultNumContainers",
numContainers: defaultPreviewNumContainers + 1, numContainers: defaultPreviewMaxContainers + 1,
numItemsPerContainer: 1, numItemsPerContainer: 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
@ -4339,15 +4339,15 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
expect: expected{ expect: expected{
// Root is counted as a container in the code but won't be counted or // Root is counted as a container in the code but won't be counted or
// have items in the test. // have items in the test.
numItems: defaultPreviewNumContainers - 1, numItems: defaultPreviewMaxContainers - 1,
numContainers: defaultPreviewNumContainers - 1, numContainers: defaultPreviewMaxContainers - 1,
numItemsPerContainer: 1, numItemsPerContainer: 1,
}, },
}, },
{ {
name: "DefaultNumItemsPerContainer", name: "DefaultNumItemsPerContainer",
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewNumItemsPerContainer + 1, numItemsPerContainer: defaultPreviewMaxItemsPerContainer + 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
MaxItems: 99999999, MaxItems: 99999999,
@ -4356,14 +4356,14 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
MaxPages: 99999999, MaxPages: 99999999,
}, },
expect: expected{ expect: expected{
numItems: defaultPreviewNumItemsPerContainer, numItems: defaultPreviewMaxItemsPerContainer,
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewNumItemsPerContainer, numItemsPerContainer: defaultPreviewMaxItemsPerContainer,
}, },
}, },
{ {
name: "DefaultNumPages", name: "DefaultNumPages",
numContainers: defaultPreviewNumPages + 1, numContainers: defaultPreviewMaxPages + 1,
numItemsPerContainer: 1, numItemsPerContainer: 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
@ -4373,15 +4373,15 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
MaxBytes: 99999999, MaxBytes: 99999999,
}, },
expect: expected{ expect: expected{
numItems: defaultPreviewNumPages, numItems: defaultPreviewMaxPages,
numContainers: defaultPreviewNumPages, numContainers: defaultPreviewMaxPages,
numItemsPerContainer: 1, numItemsPerContainer: 1,
}, },
}, },
{ {
name: "DefaultNumBytes", name: "DefaultNumBytes",
numContainers: 1, numContainers: 1,
numItemsPerContainer: int(defaultPreviewNumBytes/1024/1024) + 1, numItemsPerContainer: int(defaultPreviewMaxBytes/1024/1024) + 1,
itemSize: 1024 * 1024, itemSize: 1024 * 1024,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
@ -4391,9 +4391,9 @@ func (suite *CollectionsUnitSuite) TestGet_PreviewLimits_Defaults() {
MaxPages: 99999999, MaxPages: 99999999,
}, },
expect: expected{ expect: expected{
numItems: int(defaultPreviewNumBytes) / 1024 / 1024, numItems: int(defaultPreviewMaxBytes) / 1024 / 1024,
numContainers: 1, numContainers: 1,
numItemsPerContainer: int(defaultPreviewNumBytes) / 1024 / 1024, numItemsPerContainer: int(defaultPreviewMaxBytes) / 1024 / 1024,
}, },
}, },
} }

View File

@ -25,9 +25,9 @@ import (
) )
const ( const (
defaultPreviewContainerLimit = 5 defaultPreviewMaxContainers = 5
defaultPreviewItemsPerContainerLimit = 10 defaultPreviewMaxItemsPerContainer = 10
defaultPreviewItemLimit = defaultPreviewContainerLimit * defaultPreviewItemsPerContainerLimit defaultPreviewMaxItems = defaultPreviewMaxContainers * defaultPreviewMaxItemsPerContainer
) )
func CreateCollections( func CreateCollections(
@ -167,15 +167,15 @@ func populateCollections(
// Configure limits with reasonable defaults if they're not set. // Configure limits with reasonable defaults if they're not set.
if effectiveLimits.MaxContainers == 0 { if effectiveLimits.MaxContainers == 0 {
effectiveLimits.MaxContainers = defaultPreviewContainerLimit effectiveLimits.MaxContainers = defaultPreviewMaxContainers
} }
if effectiveLimits.MaxItemsPerContainer == 0 { if effectiveLimits.MaxItemsPerContainer == 0 {
effectiveLimits.MaxItemsPerContainer = defaultPreviewItemsPerContainerLimit effectiveLimits.MaxItemsPerContainer = defaultPreviewMaxItemsPerContainer
} }
if effectiveLimits.MaxItems == 0 { if effectiveLimits.MaxItems == 0 {
effectiveLimits.MaxItems = defaultPreviewItemLimit effectiveLimits.MaxItems = defaultPreviewMaxItems
} }
} }

View File

@ -2212,7 +2212,7 @@ func (suite *CollectionPopulationSuite) TestFilterContainersAndFillCollections_P
{ {
name: "DefaultMaxItems", name: "DefaultMaxItems",
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewItemLimit + 1, numItemsPerContainer: defaultPreviewMaxItems + 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
MaxItemsPerContainer: 999, MaxItemsPerContainer: 999,
@ -2220,13 +2220,13 @@ func (suite *CollectionPopulationSuite) TestFilterContainersAndFillCollections_P
}, },
expect: expected{ expect: expected{
numContainers: 1, numContainers: 1,
numItemsPerContainer: defaultPreviewItemLimit, numItemsPerContainer: defaultPreviewMaxItems,
numItems: defaultPreviewItemLimit, numItems: defaultPreviewMaxItems,
}, },
}, },
{ {
name: "DefaultMaxContainers", name: "DefaultMaxContainers",
numContainers: defaultPreviewContainerLimit + 1, numContainers: defaultPreviewMaxContainers + 1,
numItemsPerContainer: 1, numItemsPerContainer: 1,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
@ -2234,15 +2234,15 @@ func (suite *CollectionPopulationSuite) TestFilterContainersAndFillCollections_P
MaxItems: 999, MaxItems: 999,
}, },
expect: expected{ expect: expected{
numContainers: defaultPreviewContainerLimit, numContainers: defaultPreviewMaxContainers,
numItemsPerContainer: 1, numItemsPerContainer: 1,
numItems: defaultPreviewContainerLimit, numItems: defaultPreviewMaxContainers,
}, },
}, },
{ {
name: "DefaultMaxItemsPerContainer", name: "DefaultMaxItemsPerContainer",
numContainers: 5, numContainers: 5,
numItemsPerContainer: defaultPreviewItemsPerContainerLimit, numItemsPerContainer: defaultPreviewMaxItemsPerContainer,
limits: control.PreviewItemLimits{ limits: control.PreviewItemLimits{
Enabled: true, Enabled: true,
MaxItems: 999, MaxItems: 999,
@ -2250,8 +2250,8 @@ func (suite *CollectionPopulationSuite) TestFilterContainersAndFillCollections_P
}, },
expect: expected{ expect: expected{
numContainers: 5, numContainers: 5,
numItemsPerContainer: defaultPreviewItemsPerContainerLimit, numItemsPerContainer: defaultPreviewMaxItemsPerContainer,
numItems: 5 * defaultPreviewItemsPerContainerLimit, numItems: 5 * defaultPreviewMaxItemsPerContainer,
}, },
}, },
} }