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

feat: update RetryEncode api #99

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Conversation

Tohrusky
Copy link
Member

@Tohrusky Tohrusky commented Jan 6, 2025

Summary by Sourcery

New Features:

  • Simplified the RetryEncodeTask API.

Copy link

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This pull request updates the RetryEncode API by removing the encode_param and script parameters from the RetryEncodeTaskRequest and the corresponding usages in the Task.vue component.

Sequence diagram for the simplified RetryEncode task flow

sequenceDiagram
    participant User
    participant TaskComponent
    participant RetryEncodeAPI

    User->>TaskComponent: Click retry encode
    TaskComponent->>TaskComponent: Show confirmation dialog
    User->>TaskComponent: Confirm retry
    TaskComponent->>RetryEncodeAPI: RetryEncodeTask(video_key, index, timeout, queue)
    Note over RetryEncodeAPI: No longer requires encode_param and script
Loading

Class diagram showing changes to RetryEncodeTaskRequest interface

classDiagram
    class RetryEncodeTaskRequest {
        +string video_key
        +number index
        +number timeout (optional)
        +string queue (optional)
        +any [property: string]
    }
    note for RetryEncodeTaskRequest "Removed encode_param and script fields"
Loading

File-Level Changes

Change Details Files
Removed the encode_param and script parameters from the RetryEncodeTaskRequest interface.
  • Removed the encode_param parameter.
  • Removed the script parameter.
src/api/type.ts
Removed the usage of the encode_param and script parameters in the RetryEncodeTask function call.
  • Removed the script.value argument.
  • Removed the encodeParam.value argument.
src/views/Task.vue
Removed the usage of the encodeParam and script variables.
  • Removed the destructuring of encodeParam from the useSettingStore.
  • Removed the destructuring of script from the useSettingStore.
src/views/Task.vue

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Tohrusky - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

video_key: string
index: number
timeout?: number
queue?: string
[property: string]: any
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Consider removing the index signature to make the interface more type-safe

Since encode_param and script are being removed, it seems the interface is becoming more specific. The index signature allowing arbitrary properties could mask potential errors. Consider making the interface strict by removing [property: string]: any.

@Tohrusky Tohrusky merged commit d4fb012 into TensoRaws:main Jan 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant