VRTL endpoints disappears

.github/workflows/vrtl-docker-release.yml

@@ -0,0 +1,53 @@
+name: Build and Push VRTL Misskey Docker Image
+
+on:
+  push:
+    tags:
+      - 'v*-vrtl.*'
+
+env:
+  DOCKER_REGISTRY_NAME: ghcr.io
+  DOCKER_IMAGE_NAME: anatawa12/vrtl-misskey
+
+jobs:
+  build:
+    permissions:
+      contents: read
+      packages: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to Docker hub
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.DOCKER_REGISTRY_NAME }}
+          username: ${{ github.repository_owner }}
+          password: ${{ github.token }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.DOCKER_REGISTRY_NAME }}/${{ env.DOCKER_IMAGE_NAME }}
+
+      - name: Build & Push
+        uses: docker/build-push-action@v2
+        env:
+          DOCKER_BUILDKIT: 1
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: ${{ env.DOCKER_REGISTRY_NAME }}/${{ env.DOCKER_IMAGE_NAME }}:latest
+          build-args: BUILDKIT_INLINE_CACHE=1

CHANGELOG-VRTL.md

@@ -0,0 +1,27 @@
+# CHANGELOG about VRTL
+
+VRTLのブランチで行われた変更点をまとめています
+
+<!-- VV Please add changelog here VV -->
+
+--- 2024.10.1-vrtl.1 released at this time ---
+
+--- 2024.9.0-vrtl.1 released at this time ---
+
+--- 2024.8.0-vrtl.1 released at this time ---
+
+- fix(frontend): VRTL VSTLの名前が表示されないところがある問題 (anatawa12#97) - 2024/08/07
+- fic(frontend): VRTL VSTLでリプライのトグルが表示されない問題 (anatawa12#92) - 2024/08/04
+
+--- 2024.7.0-vrtl.1 released at this time ---
+
+--- 2024.5.0-vrtl.2 released at this time ---
+
+- chore(backend): VRTL参加サーバーの取得に失敗したときのリトライの間隔を短く
+- feat: VRTL/VSTLに連合なし投稿を含めるかを選択可能に
+  - もともとのVRTL/VSTLでは連合なし投稿が常に含まれていましたが、正しくVRTL/VSTLのノートを表現するために含めないようにできるようになりました
+  - VSTLの場合、連合なし投稿を含めないようにしてもフォローしている人の連合なし投稿は表示されます
+- fix(frontend): ウィジェットでVRTL/VSTLが使用できない問題を修正
+- fix(backend): 自分自身に対するリプライがwithReplies = falseなVRTL/VSTLにて含まれていない問題を修正
+- feat(backend): `vmimiRelayTimelineImplemented` と `disableVmimiRelayTimeline` nodeinfo に追加しました
+	- これによりサードパーティクライアントがVRTLの有無を認知できるようになりました。

README.md

@@ -1,3 +1,131 @@
+# Anatawa12's fork of Misskey
+
+This is anatawa12's fork of Misskey.
+
+This fork is used for several purposes:
+
+- The repository for [vmimi-relay timeline] extension development. I'm the maintainer of the [vmimi-relay timeline].
+- The repository for writing pull-requests to the vmimi relay users. I'm usually sending pull requests to the vmimi relay users after each updates.
+- The repository for writing pull-requests to the upstream repository. I'm one of the contributors of the upstream repository.
+- The repository for writing pull-requests to the [misskey.niri.la]. I'm one of the maintainers of the [misskey.niri.la].
+
+This branch is the branch for releasing the Vmimi Relay Timeline extension.
+
+## Vmimi Relay Timeline
+
+The Vmimi Relay Timeline is additional timelines for Misskey servers who belong to the [Virtual Kemomimi Relay].
+This extension adds two timelines: Vmimi Relay Timeline (VRTL) and Vmimi Social Timeline (VSTL).
+
+ぶいみみリレータイムラインは[ぶいみみリレー][Virtual Kemomimi Relay]に参加しているサーバー向けのmisskeyの拡張タイムラインです。
+この拡張はふたつのタイムラインを追加します: ぶいみみリレータイムライン (VRTL) とぶいみみソーシャルタイムライン (VSTL) です。
+
+### Vmimi Relay Timeline (VRTL)
+
+The Vmimi Relay Timeline (VRTL) is the timeline that shows the posts from the Virtual Kemomimi Relay users.
+This timeline is designed to be similar to the Local Timeline,
+but it shows the posts from the Virtual Kemomimi Relay users.
+
+ぶいみみリレータイムライン (VRTL) はぶいみみリレーに参加しているユーザーの投稿を表示するタイムラインです。
+このタイムラインはローカルタイムラインに似ていますが、ぶいみみリレーに参加しているユーザーの投稿を表示します。
+
+### Vmimi Social Timeline (VSTL)
+
+The Vmimi Social Timeline (VSTL) is the timeline that shows the posts from
+the Virtual Kemomimi Relay users and the users you are following.
+In other words, this timeline is the combination of the VRTL and the Home Timeline.
+This timeline is designed to be similar to the Social Timeline,
+but it shows the posts from the Virtual Kemomimi Relay users instead of the Local Timeline.
+
+ぶいみみソーシャルタイムライン (VSTL) はぶいみみリレーに参加しているユーザーとフォローしているユーザーの投稿を表示するタイムラインです。
+つまり、このタイムラインはVRTLとホームタイムラインの組み合わせです。
+このタイムラインはソーシャルタイムラインに似ていますが、ローカルタイムラインの代わりにぶいみみリレーに参加しているユーザーの投稿を表示します。
+
+### How to use the Vmimi Relay Timeline
+
+First, this extension is designed for servers who joined the [Virtual Kemomimi Relay]
+so you have to join the [Virtual Kemomimi Relay] to use this extension.
+
+After that, you have two ways to use the Vmimi Relay Timeline:
+- Use releases of the misskey docker image if you're using official docker image.
+  The image is designed to be a drop-in replacement of the official image.
+  The image name is [`ghcr.io/anatawa12/vrtl-misskey:latest`].
+- Merge the extension branch to your fork and build the image by yourself.
+  You can merge the [`vmimi-relay-timeline/generic`] branch to your fork.
+  If you ask me, I'll create a pull request to your fork. Feel free to ask me.
+
+はじめに、この拡張は[ぶいみみリレー][Virtual Kemomimi Relay]に参加しているサーバー向けに設計されているため、この拡張を使用するには[ぶいみみリレー][Virtual Kemomimi Relay]に参加する必要があります。
+
+その後、ぶいみみリレータイムラインを使用する方法はふたつあります:
+- 公式のdockerイメージを使用している場合は、VRTLのdockerイメージを使用してください。
+  のイメージは公式イメージの代わりとして使用できます。
+  イメージ名は [`ghcr.io/anatawa12/vrtl-misskey:latest`] です。
+- このブランチをあなたのフォークにマージして、自分でイメージをビルドしてください。
+  [`vmimi-relay-timeline/generic`] ブランチをあなたのフォークにマージすることで、この拡張を使用できます。
+  必要であれば、あなたのフォークにプルリクエストを作成します。お気軽にお尋ねください。
+
+### Notes for Third-party Client Developers
+
+Here are the technical notes for third-party misskey client developers.
+
+サードパーティ Misskey クライアント向けの技術的な情報です
+
+#### Detecting Vmimi Relay Timeline
+
+There is `vmimiRelayTimelineImplemented` property on `metadata` object of `nodeinfo`.
+If it's true, your client can assume that the VRTL is implemented for the sever.
+
+`nodeinfo`の`metadata`オブジェクトに`vmimiRelayTimelineImplemented`プロパティがあります。
+この値が true であれば、VRTLがそのサーバーにて実装されてると考えて問題ありません
+
+#### Endpoints and Channels of Vmimi Relay Timeline
+
+The fetch note endpoint for VRTL and VSTL are `notes/vmimi-relay-timeline` and `notes/vmimi-relay-hybrid-timeline`,
+and the channel name for them are `vmimiRelayTimeline` and `vmimiRelayHybridTimeline`.
+
+Those endpoints and channels have almost same options as LTL / STL but they have one extra option specific to VRTL/VSTL.
+The `withLocalOnly` flag (true by default) indicates if the timeline should include local only (non-federated) notes from server (local) timeline.
+
+For more details, see `misskey-js`.
+
+VRTLとVSTLのfetchエンドポイントはそれぞれ `notes/vmimi-relay-timeline`と `notes/vmimi-relay-hybrid-timeline`で、
+チャンネルは `vmimiRelayTimeline` と `vmimiRelayHybridTimeline` です。
+
+これらのエンドポイントとチャンネルは LTL/STL とほぼ同じオプションを持っていますが、 VRTL/VSTL に固有オプションが一つあります。
+`withLocalOnly` (デフォルトtrue) はタイムラインにローカルのみ(連合なし)ノートがタイムラインに含まれるかどうかを示します。
+
+### Branches related to Vmimi Relay Timeline
+
+- [`vmimi-relay-timeline/generic`]:
+  The branch for the Vmimi Relay Timeline extension development.
+  All changes to the Vmimi Relay Timeline extension will be merged to this branch.
+  This branch should be based on the latest official release of Misskey.
+  This branch does not include any changes other than the Vmimi Relay Timeline extension itself.
+- [`vmimi-relay-timeline/releases`]:
+  The branch for releasing the Vmimi Relay Timeline extension.
+  This branch includes the changes for `package.json` and changes to the repository link.
+- `vmimi-relay-timeline/forks/nirila`, `vmimi-relay-timeline/forks/buiso` and other branches:
+  Those branches are the branches for sending pull requests to each fork-based server.
+  Those branches are not permanent; they will be deleted after each pull request is merged.
+
+### How the Vmimi Relay Timeline works
+
+The Vmimi Relay Timeline is implemented as a server-whitelisted timeline.
+
+The Vmimi Relay provides the API endpoint to get the list of joined servers.
+The Vmimi Relay Timeline extension fetches the list of joined servers from the Vmimi Relay
+and filters the received / created notes by the list.
+For implementation simplicity, the Vmimi Relay Timeline includes all public notes of the local server including
+non-federated notes, but this behavior may change in the future.
+
+[Virtual Kemomimi Relay]: https://relay.virtualkemomimi.net/
+[misskey.niri.la]: https://github.com/niri-la/misskey.niri.la/
+[vmimi-relay timeline]: #vmimi-relay-timeline
+[`vmimi-relay-timeline/generic`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline/generic
+[`vmimi-relay-timeline/releases`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline/releases
+[`ghcr.io/anatawa12/vrtl-misskey:latest`]: https://github.com/anatawa12/misskey/pkgs/container/vrtl-misskey
+
+---
+
 <div align="center">
 <a href="https://misskey-hub.net">
 	<img src="./assets/title_float.svg" alt="Misskey logo" style="border-radius:50%" width="300"/>

locales/index.d.ts

@@ -4862,6 +4862,10 @@ export interface Locale extends ILocale {
      * TLに現在フォロー中の人全員の返信を含めないようにする
      */
     "hideRepliesToOthersInTimelineAll": string;
+    /**
+     * TLに連合なし投稿を含める
+     */
+    "showLocalOnlyInTimeline": string;
     /**
      * この操作は元に戻せません。本当にTLに現在フォロー中の人全員の返信を含めるようにしますか？
      */
@@ -5766,6 +5770,14 @@ export interface Locale extends ILocale {
          * グローバルタイムラインでは、接続している他のすべてのサーバーからの投稿を見られます。
          */
         "global": string;
+        /**
+         * ぶいみみリレータイムラインでは、バーチャルケモミミリレーサーバーに参加しているサーバーのユーザー全員の投稿を見られます。
+         */
+        "vmimi-relay": string;
+        /**
+         * ぶいみみソーシャルタイムラインには、ホームタイムラインとぶいみみリレータイムラインの投稿が両方表示されます。
+         */
+        "vmimi-relay-social": string;
     };
     "_serverRules": {
         /**
@@ -6913,6 +6925,10 @@ export interface Locale extends ILocale {
              * ローカルタイムラインの閲覧
              */
             "ltlAvailable": string;
+            /**
+             * ぶいみみリレータイムラインの閲覧
+             */
+            "vrtlAvailable": string;
             /**
              * パブリック投稿の許可
              */
@@ -9104,6 +9120,14 @@ export interface Locale extends ILocale {
          * グローバル
          */
         "global": string;
+        /**
+         * ぶいみみリレー
+         */
+        "vmimi-relay": string;
+        /**
+         * ぶいみみソーシャル
+         */
+        "vmimi-relay-social": string;
     };
     "_play": {
         /**

locales/ja-JP.yml

@@ -1211,6 +1211,7 @@ showRepliesToOthersInTimeline: "TLに他の人への返信を含める"
 hideRepliesToOthersInTimeline: "TLに他の人への返信を含めない"
 showRepliesToOthersInTimelineAll: "TLに現在フォロー中の人全員の返信を含めるようにする"
 hideRepliesToOthersInTimelineAll: "TLに現在フォロー中の人全員の返信を含めないようにする"
+showLocalOnlyInTimeline: "TLに連合なし投稿を含める"
 confirmShowRepliesAll: "この操作は元に戻せません。本当にTLに現在フォロー中の人全員の返信を含めるようにしますか？"
 confirmHideRepliesAll: "この操作は元に戻せません。本当にTLに現在フォロー中の人全員の返信を含めないようにしますか？"
 externalServices: "外部サービス"
@@ -1456,6 +1457,8 @@ _timelineDescription:
   local: "ローカルタイムラインでは、このサーバーにいるユーザー全員の投稿を見られます。"
   social: "ソーシャルタイムラインには、ホームタイムラインとローカルタイムラインの投稿が両方表示されます。"
   global: "グローバルタイムラインでは、接続している他のすべてのサーバーからの投稿を見られます。"
+  vmimi-relay: "ぶいみみリレータイムラインでは、バーチャルケモミミリレーサーバーに参加しているサーバーのユーザー全員の投稿を見られます。"
+  vmimi-relay-social: "ぶいみみソーシャルタイムラインには、ホームタイムラインとぶいみみリレータイムラインの投稿が両方表示されます。"
 
 _serverRules:
   description: "新規登録前に表示する、サーバーの簡潔なルールを設定します。内容は利用規約の要約とすることを推奨します。"
@@ -1787,6 +1790,7 @@ _role:
   _options:
     gtlAvailable: "グローバルタイムラインの閲覧"
     ltlAvailable: "ローカルタイムラインの閲覧"
+    vrtlAvailable: "ぶいみみリレータイムラインの閲覧"
     canPublicNote: "パブリック投稿の許可"
     mentionMax: "ノート内の最大メンション数"
     canInvite: "サーバー招待コードの発行"
@@ -2400,6 +2404,8 @@ _timelines:
   local: "ローカル"
   social: "ソーシャル"
   global: "グローバル"
+  vmimi-relay: "ぶいみみリレー"
+  vmimi-relay-social: "ぶいみみソーシャル"
 
 _play:
   new: "Playの作成"

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "misskey",
-	"version": "2025.1.0",
+	"version": "2025.1.0-vrtl.1",
 	"codename": "nasubi",
 	"repository": {
 		"type": "git",

packages/backend/migration/1713168415416-VmimiRelayTimeline.js

@@ -0,0 +1,16 @@
+/*
+ * SPDX-FileCopyrightText: anatawa12 and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class VmimiRelayTimeline1713168415416 {
+    name = 'VmimiRelayTimeline1713168415416'
+
+    async up(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" ADD "vmimiRelayTimelineCacheMax" integer NOT NULL DEFAULT '300'`);
+    }
+
+    async down(queryRunner) {
+        await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "vmimiRelayTimelineCacheMax"`);
+    }
+}

packages/backend/migration/1716641282089-repositoryUrl-vmimi-relay-timeline.js

@@ -0,0 +1,18 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+export class RepositoryUrlVmimiRelayTimeline1716641282089 {
+    name = 'RepositoryUrlVmimiRelayTimeline1716641282089'
+
+    async up(queryRunner) {
+        await queryRunner.query(`UPDATE "meta" SET "repositoryUrl" = 'https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline-releases?tab=readme-ov-file#vmimi-relay-timeline'`);
+        await queryRunner.query(`ALTER TABLE "meta" ALTER COLUMN "repositoryUrl" SET DEFAULT 'https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline-releases?tab=readme-ov-file#vmimi-relay-timeline'`);
+    }
+
+    async down(queryRunner) {
+        // no valid down migration for repositoryUrl value
+         await queryRunner.query(`ALTER TABLE "meta" ALTER COLUMN "repositoryUrl" SET DEFAULT 'https://github.com/misskey-dev/misskey'`);
+    }
+}

packages/backend/src/core/CoreModule.ts

@@ -149,12 +149,14 @@ import { ApMentionService } from './activitypub/models/ApMentionService.js';
 import { ApNoteService } from './activitypub/models/ApNoteService.js';
 import { ApPersonService } from './activitypub/models/ApPersonService.js';
 import { ApQuestionService } from './activitypub/models/ApQuestionService.js';
+import { VmimiRelayTimelineService } from './VmimiRelayTimelineService.js';
 import { QueueModule } from './QueueModule.js';
 import { QueueService } from './QueueService.js';
 import { LoggerService } from './LoggerService.js';
 import type { Provider } from '@nestjs/common';
 
 //#region 文字列ベースでのinjection用(循環参照対応のため)
+const $VmimiRelayTimelineService: Provider = { provide: 'VmimiRelayTimelineService', useExisting: VmimiRelayTimelineService };
 const $LoggerService: Provider = { provide: 'LoggerService', useExisting: LoggerService };
 const $AbuseReportService: Provider = { provide: 'AbuseReportService', useExisting: AbuseReportService };
 const $AbuseReportNotificationService: Provider = { provide: 'AbuseReportNotificationService', useExisting: AbuseReportNotificationService };
@@ -306,6 +308,7 @@ const $ApQuestionService: Provider = { provide: 'ApQuestionService', useExisting
 		QueueModule,
 	],
 	providers: [
+		VmimiRelayTimelineService,
 		LoggerService,
 		AbuseReportService,
 		AbuseReportNotificationService,
@@ -453,6 +456,7 @@ const $ApQuestionService: Provider = { provide: 'ApQuestionService', useExisting
 		QueueService,
 
 		//#region 文字列ベースでのinjection用(循環参照対応のため)
+		$VmimiRelayTimelineService,
 		$LoggerService,
 		$AbuseReportService,
 		$AbuseReportNotificationService,
@@ -600,6 +604,7 @@ const $ApQuestionService: Provider = { provide: 'ApQuestionService', useExisting
 		//#endregion
 	],
 	exports: [
+		VmimiRelayTimelineService,
 		QueueModule,
 		LoggerService,
 		AbuseReportService,
@@ -747,6 +752,7 @@ const $ApQuestionService: Provider = { provide: 'ApQuestionService', useExisting
 		QueueService,
 
 		//#region 文字列ベースでのinjection用(循環参照対応のため)
+		$VmimiRelayTimelineService,
 		$LoggerService,
 		$AbuseReportService,
 		$AbuseReportNotificationService,