uploadcare / file-uploader

Stack-agnostic library for uploading, processing, and editing images on-the-fly
https://uploadcare.com/docs/file-uploader/
MIT License
85 stars 14 forks source link

feat: async `secureDeliveryProxyUrlResolver` #677

Closed nd0ut closed 3 months ago

nd0ut commented 4 months ago

Description

Checklist

Summary by CodeRabbit

These changes enhance the user experience by ensuring smoother and more reliable image processing within the application.

coderabbitai[bot] commented 4 months ago

Walkthrough

These updates primarily introduce asynchronous behavior across various components. The changes involve converting methods to async and using await to handle operations that involve network requests or other asynchronous tasks. This enhances error handling, improves the readability of conditional statements, and ensures smoother execution of key functions within the classes.

Changes

Files/Paths Change Summary
abstract/Block.js proxyUrl method now returns Promise<String>, converted to async with error handling.
abstract/UploaderBlock.js Reformatted conditional statements for better readability.
blocks/CloudImageEditor/src/... Introduced async/await in various methods to handle asynchronous operations and error handling.
blocks/CloudImageEditor/src/EditorFilterControl.js Refactored init$ property, added async to _observerCallback, simplified on.click handler, used optional chaining.
blocks/CloudImageEditor/src/EditorImageCropper.js Added _waitForImage async method, used await for proxyUrl, updated _cancelPreload with optional chaining.
blocks/CloudImageEditor/src/EditorImageFader.js Added async to methods involving image loading and processing to ensure smooth execution.
blocks/EditorToolbar.js Added async to _preloadEditedImage method, used optional chaining for _cancelPreload call.
blocks/FileItem/FileItem.js Changed thumbUrl assignment to await result of proxyUrl for asynchronous behavior.
types/exported.d.ts Updated SecureDeliveryProxyUrlResolver to return Promise<string> | string for async support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Block
    participant CloudImageEditorBlock
    participant EditorImageCropper
    participant EditorImageFader

    User->>Block: Call proxyUrl()
    Block->>Block: Resolve proxy URL (async)
    Block-->>User: Return Promise<String>

    User->>CloudImageEditorBlock: Create cdnUrl with proxyUrl
    CloudImageEditorBlock->>Block: await proxyUrl()
    Block-->>CloudImageEditorBlock: Return proxy URL

    User->>EditorImageCropper: Wait for image
    EditorImageCropper->>Block: await proxyUrl()
    Block-->>EditorImageCropper: Return proxy URL
    EditorImageCropper-->>User: Image loaded

    User->>EditorImageFader: Set transformations
    EditorImageFader->>Block: await proxyUrl()
    Block-->>EditorImageFader: Return proxy URL
    EditorImageFader-->>User: Transformations set

Poem

In the land of code where changes roam, Asynchronous tasks now find their home. Methods await and promises fly, Errors caught, they say goodbye. Smooth and swift, the updates flow, Like a rabbit’s leap through fields aglow. 🐇✨


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.