[Bug]: Some issues with clips

[hgdagon]

What actually happened?

A few minor issues I noticed I noticed with clips.
The video_id property is always an empty string.
clip.fetch_video() complains that the id cannot be empty.
I tried modifying the method to pass my own id, and I got a different error:
{'error': 'Bad Request', 'status': 400, 'message': 'The parameter "id" was malformed: value must be a numeric'}' Judging by the documentation, this would be the id of VOD this clip is sourced from, that means a clip doesn't expose the direct URL of the actual video of the clip itself. Slightly off topic, but still: clip.thumbnail.urlandclip.thumbnail.base_url` both return the same URL with the preview.

I tried quite a few clips and got these issues consistently.

What did you expect to happen instead?

Properly populated video_id property.
A property (or method) returning the direct link to the mp4 of the clip.
clip.thumbnail.base_url containing the base URL.

Minimum reproducible example:

clips = await ctx.chatter.fetch_clips()
if clips:
    clip = random.choice(clips)
    assert clip.thumbnail.url == clip.thumbnail.base_url
    print(f'{clip.video_id=}') # Empty string
    video = await clip.fetch_video() # Error

Steps to reproduce the problem

Compare url and base_url of a clip's thumbnail
try running fetch_video() on the clip.

Additional logs:

No response

System and Environment information

3.0.1

[EvieePy]

Thanks for the issue. Clips don't have a guaranteed video_id value but Twitch being Twitch, have not nullified this field and as such it is always a string, albeit sometimes empty. We tried to keep all Helix models as close to the Twitch API results as possible.

Twitch will send an empty string for video_id when the video is not available, which can be due to the broadcaster or Twitch deleting the video or because you are retrieving the clip too soon after it's creation (usually needs a few minutes).

With all that being said this is a documentation issue however as I noticed none of this is currently documented on our end.

Relevant twitch docs:

https://dev.twitch.tv/docs/api/clips/
https://dev.twitch.tv/docs/api/reference/#get-clips

[hgdagon]

OK, so the problem is in the implementation on Twitch's side. In that case, I still think there's a bug in the fetch_video() method. Currently it's like this:

    async def fetch_video(self) -> Video | None:
        data: list[Video] = await self._http.get_videos(ids=[self.video_id], period="all", sort="time", type="all", first=1)
        return data[0] if data else None

I suggest this change (or something similar):

    async def fetch_video(self) -> Video | None:
        if not self.video_id:
            return None

        data: list[Video] = await self._http.get_videos(ids=[self.video_id], period="all", sort="time", type="all", first=1)
        return data[0] if data else None

get_videos() expects ids to be ids: list[str | int] | None = None, so I'm assuming the backend will accept a list of strings.

[EvieePy]

Yes I agree the method should return None when the Clip doesn't have a video_id. I will fix this and add some documentation