Skip to content

Migrate live chat to YouTube.js #3054

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.

Sign up for GitHub

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

Merged
FreeTubeBot merged 1 commit into from
Jan 13, 2023
Merged

Migrate live chat to YouTube.js #3054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@
"@fortawesome/free-brands-svg-icons": "^6.2.1",
"@fortawesome/free-solid-svg-icons": "^6.2.1",
"@fortawesome/vue-fontawesome": "^2.0.9",
"@freetube/youtube-chat": "^1.1.2",
"@freetube/yt-comment-scraper": "^6.2.0",
"@silvermine/videojs-quality-selector": "^1.2.5",
"autolinker": "^4.0.0",
Expand All @@ -77,7 +76,7 @@
"vue-observe-visibility": "^1.0.0",
"vue-router": "^3.6.5",
"vuex": "^3.6.2",
"youtubei.js": "^2.8.0",
"youtubei.js": "^2.9.0",
"yt-channel-info": "^3.2.1"
},
"devDependencies": {
Expand Down
207 changes: 125 additions & 82 deletions src/renderer/components/watch-video-live-chat/watch-video-live-chat.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ import FtCard from '../ft-card/ft-card.vue'
import FtButton from '../ft-button/ft-button.vue'

import autolinker from 'autolinker'
import { LiveChat } from '@freetube/youtube-chat'
import { getRandomColorClass } from '../../helpers/colors'
import { stripHTML } from '../../helpers/utils'
import { getLocalVideoInfo, parseLocalTextRuns } from '../../helpers/api/local'

export default Vue.extend({
name: 'WatchVideoLiveChat',
Expand All @@ -15,23 +14,23 @@ export default Vue.extend({
'ft-card': FtCard,
'ft-button': FtButton
},
beforeRouteLeave: function () {
this.liveChat.stop()
this.hasEnded = true
},
props: {
liveChat: {
type: EventTarget,
default: null
},
videoId: {
type: String,
required: true
},
channelName: {
channelId: {
type: String,
required: true
}
},
data: function () {
return {
liveChat: null,
liveChatInstance: null,
isLoading: true,
hasError: false,
hasEnded: false,
Expand All @@ -43,15 +42,15 @@ export default Vue.extend({
comments: [],
superChatComments: [],
superChat: {
id: '',
author: {
name: '',
thumbnail: ''
thumbnailUrl: ''
},
message: [
''
],
message: '',
superChat: {
amount: ''
amount: '',
colorClass: ''
}
}
}
Expand All @@ -73,22 +72,24 @@ export default Vue.extend({
}
},

hideLiveChat: function () {
return this.$store.getters.getHideLiveChat
},

scrollingBehaviour: function () {
return this.$store.getters.getDisableSmoothScrolling ? 'auto' : 'smooth'
}
},
beforeDestroy: function () {
this.hasEnded = true
this.liveChatInstance?.stop()
this.liveChatInstance = null
},
created: function () {
if (!process.env.IS_ELECTRON) {
this.hasError = true
this.errorMessage = this.$t('Video["Live Chat is currently not supported in this build."]')
} else {
switch (this.backendPreference) {
case 'local':
this.getLiveChatLocal()
this.liveChatInstance = this.liveChat
this.startLiveChatLocal()
break
case 'invidious':
if (this.backendFallback) {
Expand All @@ -111,95 +112,137 @@ export default Vue.extend({
this.getLiveChatLocal()
},

getLiveChatLocal: function () {
this.liveChat = new LiveChat({ liveId: this.videoId })
getLiveChatLocal: async function () {
const videoInfo = await getLocalVideoInfo(this.videoId)
this.liveChatInstance = videoInfo.getLiveChat()

this.isLoading = false
this.startLiveChatLocal()
},

startLiveChatLocal: function () {
this.liveChatInstance.once('start', initialData => {
/**
* @type {import ('youtubei.js/dist/src/parser/index').LiveChatContinuation}
*/
const liveChatContinuation = initialData

const actions = liveChatContinuation.actions.filter(action => action.type === 'AddChatItemAction')

for (const { item } of actions) {
switch (item.type) {
case 'LiveChatTextMessage':
this.parseLiveChatComment(item)
break
case 'LiveChatPaidMessage':
this.parseLiveChatSuperChat(item)
}
}

this.liveChat.on('start', (liveId) => {
this.isLoading = false

setTimeout(() => {
this.$refs.liveChatComments?.scrollTo({
top: this.$refs.liveChatComments.scrollHeight,
behavior: 'instant'
})
})
})

this.liveChat.on('end', (reason) => {
console.error('Live chat has ended')
console.error(reason)
this.hasError = true
this.showEnableChat = false
this.errorMessage = this.$t('Video["Chat is disabled or the Live Stream has ended."]')
this.liveChatInstance.on('chat-update', action => {
if (this.hasEnded) {
return
}
if (action.type === 'AddChatItemAction') {
switch (action.item.type) {
case 'LiveChatTextMessage':
this.parseLiveChatComment(action.item)
break
case 'LiveChatPaidMessage':
this.parseLiveChatSuperChat(action.item)
break
}
}
})

this.liveChat.on('error', (err) => {
this.hasError = true
this.errorMessage = err
this.showEnableChat = false
this.liveChatInstance.once('end', () => {
this.hasEnded = true
this.liveChatInstance = null
})

this.liveChat.on('comment', (comment) => {
this.parseLiveChatComment(comment)
this.liveChatInstance.once('error', error => {
this.liveChatInstance.stop()
this.liveChatInstance = null
console.error(error)
this.errorMessage = error
this.hasError = true
this.isLoading = false
this.hasEnded = true
})

this.liveChat.start()
this.liveChatInstance.start()
},

/**
* @param {import('youtubei.js/dist/src/parser/classes/livechat/items/LiveChatTextMessage').default} comment
*/
parseLiveChatComment: function (comment) {
if (this.hasEnded) {
return
/**
* can also be undefined if there is no badge
* @type {import('youtubei.js/dist/src/parser/classes/LiveChatAuthorBadge').default}
*/
const badge = comment.author.badges.find(badge => badge.type === 'LiveChatAuthorBadge' && badge.custom_thumbnail)

const parsedComment = {
message: autolinker.link(parseLocalTextRuns(comment.message.runs, 20)),
author: {
name: comment.author.name.text,
thumbnailUrl: comment.author.thumbnails.at(-1).url,
isOwner: comment.author.id === this.channelId,
isModerator: comment.author.is_moderator,
isMember: !!badge
}
}

comment.messageHtml = ''

comment.message.forEach((text) => {
if (typeof text === 'undefined') return

if (typeof (text.navigationEndpoint) !== 'undefined') {
if (typeof (text.navigationEndpoint.watchEndpoint) !== 'undefined') {
const htmlRef = `<a href="https://www.youtube.com/watch?v=${text.navigationEndpoint.watchEndpoint.videoId}">${text.text}</a>`
comment.messageHtml = stripHTML(comment.messageHtml) + htmlRef
} else {
comment.messageHtml = stripHTML(comment.messageHtml + text.text)
}
} else if (typeof (text.alt) !== 'undefined') {
const htmlImg = `<img src="${text.url}" alt="${text.alt}" class="liveChatEmoji" height="24" width="24" />`
comment.messageHtml = stripHTML(comment.messageHtml) + htmlImg
} else {
comment.messageHtml = stripHTML(comment.messageHtml + text.text)
if (badge) {
parsedComment.badge = {
url: badge.custom_thumbnail.at(-1).url,
tooltip: badge.tooltip ?? ''
}
})

comment.messageHtml = autolinker.link(comment.messageHtml)

if (typeof this.$refs.liveChatComments === 'undefined' && typeof this.$refs.liveChatMessage === 'undefined') {
console.error("Can't find chat object. Stopping chat connection")
this.liveChat.stop()
return
}

this.comments.push(comment)

if (typeof (comment.superchat) !== 'undefined') {
comment.superchat.colorClass = getRandomColorClass()

this.superChatComments.unshift(comment)

setTimeout(() => {
this.removeFromSuperChat(comment.id)
}, 120000)
}
this.pushComment(parsedComment)
},

if (comment.author.name[0] === 'Ge' || comment.author.name[0] === 'Ne') {
comment.superChat = {
amount: '$5.00',
/**
* @param {import('youtubei.js/dist/src/parser/classes/livechat/items/LiveChatPaidMessage').default} superChat
*/
parseLiveChatSuperChat: function (superChat) {
const parsedComment = {
id: superChat.id,
message: autolinker.link(parseLocalTextRuns(superChat.message.runs, 20)),
author: {
name: superChat.author.name.text,
thumbnailUrl: superChat.author.thumbnails[0].url
},
superChat: {
amount: superChat.purchase_amount,
colorClass: getRandomColorClass()
}
}

this.superChatComments.unshift(comment)
this.superChatComments.unshift(parsedComment)

setTimeout(() => {
this.removeFromSuperChat(comment.id)
}, 120000)
}
setTimeout(() => {
this.removeFromSuperChat(parsedComment.id)
}, 120000)

this.pushComment(parsedComment)
},

pushComment: function (comment) {
this.comments.push(comment)

if (this.stayAtBottom) {
if (!this.isLoading && this.stayAtBottom) {
setTimeout(() => {
this.$refs.liveChatComments?.scrollTo({
top: this.$refs.liveChatComments.scrollHeight,
Expand Down
Loading