feat: Preview migration api [FC-0114] #37818
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @ChrisChV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
| unsupportedBlocksChildren = fetch_block_types( | ||
| [ | ||
| f'context_key = "{source_key}"', | ||
| f'breadcrumbs.usage_key IN [{quoted_keys}]' | ||
| ], | ||
| ) | ||
| # Final unsupported blocks count | ||
| unsupported_blocks_count = len(unsupported_blocks) + unsupportedBlocksChildren["estimatedTotalHits"] | ||
| unsupported_percentage = (unsupported_blocks_count / total_blocks) * 100 |
There was a problem hiding this comment.
@ChrisChV As per latest requirements, we need to ignore children counts from the total counts and percentage. So we can skip this part. You'll still need to fetch this data to subtract the children count from total block counts.
See openedx/frontend-app-authoring#2525 (comment) and the related PR: openedx/frontend-app-authoring#2774
| "filter": [f'context_key = "{context_key}"'], | ||
| "limit": limit, | ||
| "offset": offset, | ||
| "attributesToRetrieve": ["usage_key"] + extra_attributes_to_retrieve, |
There was a problem hiding this comment.
| "attributesToRetrieve": ["usage_key"] + extra_attributes_to_retrieve, | |
| "attributesToRetrieve": ["usage_key"] + (extra_attributes_to_retrieve or []), |
| if not hits: | ||
| break | ||
|
|
||
| results.extend(hits) |
There was a problem hiding this comment.
NIT: instead of extending and storing all data in a single list, I would convert this function to a generator to yeild values.
| hits = response["hits"] | ||
| if not hits: | ||
| break |
There was a problem hiding this comment.
This causes an additional request to mieillisearch each time even if the result is smaller than limit amount. We should check estimatedTotal hits with limit and offset, something like this:
hits = response["hits"]
results.extend(hits)
if response["estimatedTotalHits"] <= limit + offset:
break
offset += limit
navinkarkera
left a comment
navinkarkera
left a comment
There was a problem hiding this comment.
@ChrisChV Looks good!
- I tested this: Played around with the rest api.
- I read through the code
- I checked for accessibility issues
- Includes documentation
3 participants
Description
Supporting information
Testing instructions
Deadline
"None"
Other information
N/A