hikiko4ern/coub-addons

Coub.com дополнительный функционал / additional features

coub-addons

Web Extension, добавляющий дополнительный функционал на Coub.com

Warning

Расширение находится на раннем этапе разработки, поэтому временно:

• тестируется только на Firefox-based браузерах (Firefox, Waterfox, LibreWolf и прочие лисьи форки) и может не работать в других
  например, фильтрация запросов сейчас построена на webRequest.filterResponseData и не будет работать в Chromium-based браузерах и Safari, в которых используемое API всё ещё не реализовано
• не публикуется в сторах и не подписывается, из-за чего для постоянной установки требует отключенной проверки подписи (в Firefox это настройка xpinstall.signatures.required)
• периодически могут вноситься обратно несовместимые изменения, требующие ручной миграции настроек (хотя такого ещё ни разу не было, и, я надеюсь, не будет, но бэкапы делай, бэкапы - это здорово)
• проект не следует SemVer и плохо сконфигурирован (да и в целом ведёт себя плохо)

Если всё прочитанное не отпугнуло желание попробовать, качай последний релиз (если я не забыл его создать) или смотри секцию Building с инструкцией по самостоятельной сборке

Минимальные поддерживаемые версии браузеров:

• Firefox 101

Features

• скрытие дизлайкнутых коубов

• скрытие коубов, историй и комментариев от заблокированных каналов

• скрытие коубов по названию и тегам, содержащим указанные фразы или соответствующим регулярным выражениям

• скрытие рекоубов и репостов историй

• быстрое копирование/блокировка тега через контекстное меню

• предотвращение изменения скорости воспроизведения при нажатии W/S

• дополнительные клавиатурные сокращения:

  действие	сочетание по умолчанию
  поставить/убрать дизлайк	D (Dislike)
  добавить/убрать из закладок	B (Bookmark)
  переключить полноэкранный режим	F (Fullscreen)
  скопировать ссылку на коуб	—

  NOTE: если сокращения не работают (особенно если расширение только что было установлено/обновлено), попробуйте обновить страницу - данный функционал работает через вклинивание в виджеты Coub'а и требует применения патчей до момента создания виджетов.

Tip

Фильтрация коубов (дизлайкнутых, от заблокированных каналов и т.д.) применяется к ответам запросов к API, в связи с чем:

• изменение фильтров не влияет на уже загруженные коубы

  так, если открыть сообщество Anime и поставить дизлайк первому коубу, он будет скрыт не сразу, а только при следующем запросе списка (например, после обновления страницы или после перехода на другую страницу и возвращения в сообщество)

• в некоторых ситуациях может порождать состояния, которые логика самого Coub.com не учитывает (пример - #5)

Building

Сборка из исходников "с нуля"

Требуются глобально установленные:

• Node.js¹ со включенным Corepack
• Rust (MSRV: 1.73.0)
• wasm-opt из Binaryen (опционально, используется для оптимизации WASM из segmenter-utils)

1. устанавливаем зависимости

   pnpm i -P

2. собираем

   pnpm zip:ff

3. открываем about:addons, жмём на шестерню, Install Add-on From File..., выбираем .output/coub-addons-x.x.x-firefox.zip, соглашаемся с установкой непроверенного расширения

Сборка из подготовленных исходников версии

С новыми релизами также публикуется архив coub-addons-x.x.x-sources.zip, содержащий исходный код для Firefox-based браузеров с скомпилированными и оптимизированными некоторыми пакетами (на данный момент только segmenter-utils), из которых можно собрать код, соответствующий опубликованному в coub-addons-x.x.x-firefox.zip.

Требуются глобально установленные:

• Node.js¹ со включенным Corepack

1. распаковываем архив coub-addons-x.x.x-sources.zip

2. устанавливаем зависимости

   pnpm i -P --frozen-lockfile

3. собираем

   pnpm zip:ff

NOTE: контрольные суммы архивов не совпадут из-за хранимых в ZIP-архиве временны́х меток файлов, но контрольные суммы файлов должны совпадать.

TODO

Ссылки на некоторые интересные лейблы:

• планируемый новый функционал: T-feature New feature or request
• вызываемые этим расширением баги на Coub.com: T-site bug Issues leading to bugs on Coub.com

Contributing

1. устанавливаем Node.js¹ и Rust

   для удобства в Taskfile собраны некоторые команды
   посмотреть их список: pnpm task -l, запустить: pnpm task {task} (например, pnpm task su:watch)

2. устанавливаем зависимости

   pnpm i

3. если не хочется, чтобы dev-версия расширения конфликтовала с prod-версией, создаём файл .env.local с содержимым:

   [email protected]
   # см. https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_specific_settings#extension_id_format

4. выполняем pnpm dev:ff для дев-сборки под Firefox-based браузеры

5. загружаем расширение из директории .output/firefox-mv2

Сгенерировать N фейковых каналов для стора blockedChannels:

1. выполняем

   node ./utils/fakeBlockedChannels.js N # где N - положительное число

2. открываем настройки расширения и импортируем бэкап из созданного файла

Footnotes

1. требуемая версия указана в .nvmrc. Рекомендуется использовать менеджеры версий Node.js, поддерживающие Corepack - например, fnm. ↩ ↩² ↩³

coub-addons's Issues

добавить экспорт/импорт настроек

при экспорте собирать все настройки вместе с их версиями в одну JSONку

при импорте разбирать настройки на сторы, прогонять миграции при необходимости и сохранять в хранилище

кнопка "Блокировать" добавляется не во все дропдауны канала

на данный момент не работает как минимум с [data-no-initial] дропдаунами в комментах - там данные канала подгружаются асинхронно, но т.к. дропдаун маунтится сразу (скрытым), CS обрабатывает его, но из-за отсутствия необходимого контента не добавляет свой

вроде можно отказаться от текущего подхода с MutationObserver, вклиниться в ChannelDropdown.prototype.setDropdownContent и докидывать контент в CS при вызове этого метода

добавить блокировку коубов по тегам

вероятно, стоит сделать два типа фильтров:

• по словам как простой, тупой фильтр
• по RegExp для более сложных правил

оба типа должны работать вместе (возможно, сначала фильтр по словам, потом фильтры по регуляркам)

вопросы:

• как определять word boundary? юзать Unicode-aware регулярки? Intl.Segmenter (всё ещё не реализован в Firefox)? мб WordSegmenter из unicode-org/icu4x?

добавить страницу настроек

в настройках:

• выводить список заблокированных каналов с ссылкой на канал и возможность удалить из списка
• выводить список заблокированных тегов с возможностью удалить из списка
• позволить экспортировать/импортировать все настройки

не исключать лайкнутые и добавленные в закладки коубы для заблокированных каналов

загружать следующую страницу, если все коубы были выкинуты

сейчас при выкидывании всех коубов со страницы следующая страница загружена не будет

например, если на первой странице 10 коубов, и все они были выкинуты при фильтрации, вторая страница загружена не будет, и вместо ленты будет показана пустота

добавить блокировку коубов по названию

реализация как в тегах #2, только фильтрация по полю title

добавить дополнительные keyboard shortcuts

добавить шорткаты:

• перейти в полноэкранный режим (F, Fullscreen, как в плеере того же YouTube?)
• добавить в закладки (B, Bookmark?)
• поставить дизлайк (D, Dislike?)

в идеале они должны срабатывать только в тех же условиях, когда срабатывают шорткаты самого Coub.com (когда плеер в фокусе?)
шорткаты, которые нашёл:

• L ставит лайк
• P ставит на паузу
• R рестартит коуб
• J переходит к следующему коубу
• K переходит к предыдущему коубу
• W ускоряет воспроизведение
• S замедляет воспроизведение

💭 может здесь же добавить настройку, предотвращаюую срабатывание W и S? в 99% случаев они бесполезны и раздражают

актуализировать данные заблокированных каналов

сейчас permalink вместе с остальными данными канала сохраняются один раз при блокировке канала, но т.к. они могут быть изменены юзером, данные неизбежно устареют

при получении данных о канале (например, в таймлайне коубов) стоит брать актуальную информацию и обновлять данные в списке заблокированных каналов, если они устарели

при блокировании каналов с разных вкладок перетирается состояние

кейс:

1. открыть страницу канала A и заблокировать канал A
2. открыть страницу канала B и заблокировать канал B
3. вернуться на вкладку с открытым каналом A и разблокировать канал A

ожидаемое поведение:
канал A разблокируется, канал B останется заблокирован

текущее поведение:
разблокируются оба канала

отменять запросы коубов для заблокированных каналов

сейчас при открытии страницы заблокированного канала уходят запросы /api/v2/timeline/channel/[permalink], из которых потом удаляются все коубы, которые не были лайкнуты или добавлены в закладки

чтобы "отменить" запрос, можно вернуть { redirectUrl: 'data:application/json;base64,DATA' }, где DATA:

{
  "page": 1,
  "per_page": 10,
  "total_pages": 0,
  "coubs": []
}

при этом:

1. запросы с ?type=likes отменять и фильтровать не надо
2. на странице вместо [title] нет коубов стоит писать [title] заблокирован?

управление через Media Session API

сейчас Coub.com не взаимодействует с Media Session API, из-за чего воспроизведение коубов не реагирует на команды управления воспроизведением (play/pause влияет только на аудио, но не на видео)

хочется:

• ставить на паузу аудио вместе с видео
• перелистывать коубы вперёд/назад
• видеть информацию о текущем коубе в интерфейсе ОС

не скрываются дизлайкнутые коубы в `/api/v2/coubs/*/category_suggestions`

в ответе приходит { coubs: [...] }
пример:

{
	"id": 196903034,
	"title": "Everlasting winter",
	"views_count": 20514,
	"permalink": "3c9t5r",
	"image_url": "https://3fc4ed44-3fbc-419a-97a1-a29742511391.selcdn.net/coub_storage/coub/simple/cw_image/aa21e8b434f/c281fdc1ebed236a05873/med_1691301992_00027.jpg",
	"image_width": 484,
	"image_height": 480,
	"video_url": "https://3fc4ed44-3fbc-419a-97a1-a29742511391.selcdn.net/coub_storage/coub/simple/cw_file/2511eb8c0dc/071e707d1d97be9918a78/muted_mp4_med_size_1691301930_muted_med.mp4"
}