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

[CE-134] Adjust Rate Limits (limit customfields+contexts fetching) #134

Closed
clouless opened this issue Aug 19, 2023 · 1 comment
Closed
Milestone

Comments

@clouless
Copy link
Member

clouless commented Aug 19, 2023

Bug

Not all customfields and contexts are displayed to administrator and user.
Sometimes timeouts on large data when displaying options list.

Acceptance Criteria

  • ⚡ Since we use Forge we have to find the most acceptable solution within the possibilities of execution time (timeouts) and request limitations (rate limit).
  • ✅ Display all customfields with working pagination
  • ✅ Display all customfields when filter (search) is used with working pagination
  • ✅ Display all contexts with working pagination and filter
  • ✅ No timeouts when displaying options list with 1,000+ options.

Limits

We need to introduce these limits, since the app will otherwise be slow and possibly hit forge rate limits or produce timeouts:

User view:

  • list customfields:
    • pagination without filter: Maximum number of 150 fields will be displayed. (=max 3 API request per page, ordered by field name)
    • pagination with filter: Maximum number of 150 fields will be displayed. (=max 3 API request per page, ordered by field name, filter via memory)
  • list contexts of field:
    • pagination without filter: max 300 contexts will be displayed.. (=max 3 API request per page, order implicit name)
    • pagination with filter: max 300 contexts will be displayed. (=max 3 API requests, order implicit, filter in memory)
  • list options of context:
    • Maximum number of 1,000 options displayed per context. (=max 10 API requests, ordered by internal order)
  • Note that this applies to fields and contexts the user has permissions granted to

Admin view:

  • list customfields:
    • pagination without filter: All fields will be displayed. (=1 API request per page, ordered by field name)
    • pagination with filter: All fields will be displayed. (=1 API request per page, ordered by field name, filter via API)
  • list contexts of field:
    • pagination without filter: All contexts will be displayed. (=1 API request per page, order implicit)
    • pagination with filter: max 300 contexts will be displayed. (=max 3 API requests, order implicit, filter in memory)
  • list options of context:
    • Maximum number of 1,000 options displayed per context. (=max 10 API requests, ordered by internal order)

⚡ The limits are now included in the admin guide get started page:

default options limits see: #139

@clouless clouless added this to the cloud milestone Aug 19, 2023
@clouless clouless changed the title [CE-134] Pagination of customfields broken [CE-134] Pagination of customfields broken in Field Editor Aug 19, 2023
@clouless clouless changed the title [CE-134] Pagination of customfields broken in Field Editor [CE-134] Pagination of customfields+contexts broken in Field Editor Aug 20, 2023
@clouless clouless changed the title [CE-134] Pagination of customfields+contexts broken in Field Editor [CE-134] Adjust Rate Limits (limit customfields+contexts fetching) Aug 21, 2023
@clouless
Copy link
Member Author

✅ released to the marketplace in version 2.3.0 on 2023-08-24

See https://codeclou.io/customfield-editor-for-jira/cloud/release-notes/

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

No branches or pull requests

1 participant