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

Document Exceptions in Asset Repository Functions #38975

Open
wants to merge 3 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

pykettk
Copy link
Member

@pykettk pykettk commented Jul 26, 2024

Description (*)

The updateDesignParams() function has the capacity to throw the UnexpectedValueException but this is not documented in either of the functions that call it. Additionally, the createAsset() function has the potential to throw a LocalizedException which is not documented by either of the functions that make use of it.

Manual testing scenarios (*)

  1. Create a class that makes use of the modified functions
  2. Observe your IDE report the potential for the aforementioned exceptions

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Document Exceptions in Asset Repository Functions #38988: Document Exceptions in Asset Repository Functions

The `updateDesignParams()` function has the capacity to throw the `UnexpectedValueException` but this is not documented in either of the functions that call it. Additionally, the `createAsset()` function has the potential to throw a `LocalizedException` which is not documented by either of the functions that make use of it.
Copy link

m2-assistant bot commented Jul 26, 2024

Hi @pykettk. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:
  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@m2-github-services m2-github-services added Partner: Youwe partners-contribution Pull Request is created by Magento Partner labels Jul 26, 2024
@pykettk
Copy link
Member Author

pykettk commented Jul 26, 2024

@magento run all tests

@pykettk pykettk changed the title Document Exceptions in AssetRepository URL Functions Document Exceptions in Asset Repository Functions Jul 26, 2024
@pykettk
Copy link
Member Author

pykettk commented Jul 26, 2024

@magento run Sample Data Tests CE, Sample Data Tests EE, Sample Data Tests B2B

Copy link

Failed to run the builds. Please try to re-run them later.

@pykettk
Copy link
Member Author

pykettk commented Jul 29, 2024

@magento run all tests

@pykettk
Copy link
Member Author

pykettk commented Jul 29, 2024

The failing tests do not appear to be related to these proposed changes.

@pykettk pykettk marked this pull request as ready for review July 29, 2024 14:58
@engcom-Hotel engcom-Hotel added Priority: P3 May be fixed according to the position in the backlog. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it labels Jul 30, 2024
@engcom-Hotel
Copy link
Contributor

@magento create issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Partner: Youwe partners-contribution Pull Request is created by Magento Partner Priority: P3 May be fixed according to the position in the backlog. Progress: pending review Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Document Exceptions in Asset Repository Functions
3 participants