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

a #25

Closed
wants to merge 4 commits into from
Closed

a #25

wants to merge 4 commits into from

Conversation

penginn-net
Copy link
Owner

@penginn-net penginn-net commented Oct 18, 2024

What

Why

Additional info (optional)

Checklist

  • コントリビューションガイドを読みました( Read the contribution guide)
  • ローカル環境で動作しました(Test working in a local environment)
  • (必要なら)CHANGELOG_YOJO.mdの更新((If needed) Update CHANGELOG_YOJO.md)
  • (必要なら)テストの追加((If possible) Add tests)

Summary by CodeRabbit

  • 新機能

    • 高度な検索機能の改善により、ユーザーの可視性やインデックス権限に基づいたフィルタリングが強化されました。
    • ユーザーが自身のノートに簡単にアクセスできるようになりました。
  • バグ修正

    • ユーザーのインタラクションに応じて、検索結果に表示されるノートの条件が見直されました。
  • テスト

    • 高度な検索機能に対する新しいテストケースが追加され、ユーザーの権限とノートのインデックス状態が正しく反映されることを確認しました。

Copy link

coderabbitai bot commented Oct 18, 2024

Walkthrough

AdvancedSearchService.tsAdvancedSearchServiceクラスにおいて、filterメソッドが改良され、ユーザーの可視性やインデックス権限に関する追加チェックが含まれるようになりました。これにより、特定の条件に基づいてノートがフィルタリングされ、searchNoteメソッドも新しいフィルタリングロジックに合わせて更新されました。また、search-notes.tsのテストスイートには新しいテストケースが追加され、ユーザーの権限やノートのインデックス可能性を正しく尊重することが確認されています。

Changes

ファイルパス 変更内容概要
packages/backend/src/core/AdvancedSearchService.ts filterメソッドとsearchNoteメソッドのロジックが更新され、ユーザーの可視性やインデックス権限に基づくチェックが追加されました。メソッドシグネチャも変更されています。
packages/backend/test/e2e/search-notes.ts 新しいテストケースが追加され、ユーザー権限とノートのインデックス可能性を確認するためのアサーションが強化されました。テストのリファクタリングも行われました。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AdvancedSearchService
    participant NoteDatabase

    User->>AdvancedSearchService: searchNote(me, opts, pagination, q)
    AdvancedSearchService->>NoteDatabase: filter(notes, visibility, indexability)
    NoteDatabase-->>AdvancedSearchService: return filtered notes
    AdvancedSearchService-->>User: return search results
Loading

🐇 うさぎの詩 🐇

ノートは見えぬ、誰の目にも
フィルターの魔法、かけられて
反応あれば、再び現れ
友の輪の中、秘密の花
みんなのために、今、咲き誇れ! 🌸


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Oct 18, 2024

이 PR에 의한 api.json 차이

차이점은 여기에서 볼 수 있음

Get diff files from Workflow Page

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
packages/backend/test/e2e/search-notes.ts (1)

Line range hint 315-340: コメントアウトされたテストコードがあります

センシティブオプションに関するテストがコメントアウトされています。実装予定で一時的にコメントアウトしている場合は問題ありませんが、不要であれば削除を検討してください。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5f02ee4 and 39d4daf.

📒 Files selected for processing (2)
  • packages/backend/src/core/AdvancedSearchService.ts (3 hunks)
  • packages/backend/test/e2e/search-notes.ts (4 hunks)
🧰 Additional context used
🔇 Additional comments (10)
packages/backend/test/e2e/search-notes.ts (7)

218-225: テストケースが正しく追加されています

'可視性 followers, specified でてこない' のテストで、フォロワー以外や指定ユーザー以外にはノートが検索結果に表示されないことを確認しています。


Line range hint 226-236: テストケースが正しく追加されています

'可視性 followers, specified でてくる' のテストで、フォロワーや指定ユーザーにはノートが検索結果に表示されることを確認しています。


240-278: isIndexable フラグの影響を正しくテストしています

ユーザーの isIndexable フラグを false に設定した場合に、検索結果からノートが除外されることを確認しています。また、isIndexabletrue に戻すことで、再びノートが検索結果に表示されることを確認しています。


279-288: ミュートユーザーのノートの表示を確認しています

ミュートしていない場合、ノートが検索結果に表示されることを確認しています。


Line range hint 289-296: ミュートしたユーザーのノートが検索結果に表示されないことを確認しています

ミュートしたユーザーのノートが検索結果に表示されないことを正しくテストしています。


Line range hint 307-314: ブロックされている場合のノートが検索結果に表示されないことを確認しています

ブロックされている場合、ノートが検索結果に表示されないことを正しくテストしています。


Line range hint 341-491: indexable が false の場合の挙動を詳細にテストしています

ユーザーがリアクション、リノート、返信、お気に入り、クリップ、投票といったアクションを行った場合に、isIndexablefalse のノートでも検索結果に表示されることを確認しています。各ケースでの検索結果の変化を包括的にテストしており、テストの網羅性が高いです。

packages/backend/src/core/AdvancedSearchService.ts (3)

1106-1107: LGTM!ユーザーIDのチェックが適切に行われています


1185-1187: LGTM!可視性のチェックが正しく実装されています


1122-1122: ⚠️ Potential issue

論理エラー:ダイレクトメッセージの条件式が逆になっています

Line 1122の条件式で、'specified'な可視性のノートに対して、自分が宛先に含まれている場合にnullを返しています。しかし、これは意図と逆であり、自分が宛先に含まれていない場合にnullを返すべきです。

以下の差分を適用して論理エラーを修正してください:

- if (Note._source.visibility === 'specified' && Note._source.visibleUserIds && Note._source.visibleUserIds.includes(meUserId)) return null; //ダイレクトで自分が宛先に含まれていない
+ if (Note._source.visibility === 'specified' && Note._source.visibleUserIds && !Note._source.visibleUserIds.includes(meUserId)) return null; //ダイレクトで自分が宛先に含まれていない

Likely invalid or redundant comment.

packages/backend/test/e2e/search-notes.ts Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
packages/backend/src/core/AdvancedSearchService.ts (2)

Line range hint 1123-1181: ユーザーインタラクションのチェックロジックが複雑です。

現在のインタラクションチェック(リアクション、投票、クリップ、お気に入り、Renote、返信)は、各チェックごとにOpenSearchクエリを実行しています。これは以下の問題を引き起こす可能性があります:

  1. パフォーマンスの低下:多数のOpenSearchクエリが実行されます。
  2. コードの重複:各チェックで似たようなクエリ構造が繰り返されています。

以下の改善を検討してください:

  1. 複数のインタラクションタイプを1つのクエリでチェックする。
  2. クエリ結果をキャッシュして再利用する。
  3. 共通のクエリ生成ロジックを抽出し、再利用可能な関数にする。

例えば:

private async checkUserInteractions(noteId: string, userId: string): Promise<boolean> {
  const interactionTypes = ['reaction', 'pollVote', 'favorite', 'renote', 'reply'];
  const queries = interactionTypes.map(type => ({
    index: this.getIndexForType(type),
    body: {
      query: {
        bool: {
          must: [
            { term: { [type === 'renote' ? 'renoteId' : 'noteId']: noteId } },
            { term: { userId: userId } },
          ],
        },
      },
    },
    size: 0,
  }));

  const results = await this.opensearch.msearch({ body: queries.flatMap(q => [q, q.body]) });
  return results.responses.some(response => response.hits.total.value > 0);
}

// 使用例
const hasInteraction = await this.checkUserInteractions(Note._id, meUserId);
if (hasInteraction) return Note;

このアプローチにより、コードの重複が減り、パフォーマンスが向上する可能性があります。


Line range hint 1106-1189: 全体的な改善が見られますが、さらなる最適化の余地があります。

filterメソッドの変更により、ユーザーの権限とノートの可視性に関するより包括的なチェックが導入されました。これらの変更は機能性を向上させていますが、以下の点でさらなる改善が可能です:

  1. 非インデックス可能なユーザーの処理ロジックを簡略化し、可読性を向上させる。
  2. ユーザーインタラクションのチェックを最適化し、複数のOpenSearchクエリを統合する。
  3. 可視性チェックのロジックに関するコメントを追加し、特に'public'と'home'の扱いについて説明を加える。

これらの改善により、コードの保守性とパフォーマンスが向上する可能性があります。

さらに、将来的にはユーザーインタラクションのチェックロジックを別のサービスに分離することを検討してください。これにより、AdvancedSearchServiceの責務がより明確になり、コードの組織化が改善される可能性があります。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c34ea5f and b957858.

📒 Files selected for processing (2)
  • packages/backend/src/core/AdvancedSearchService.ts (3 hunks)
  • packages/backend/test/e2e/search-notes.ts (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/backend/test/e2e/search-notes.ts
🧰 Additional context used
🔇 Additional comments (3)
packages/backend/src/core/AdvancedSearchService.ts (3)

1106-1108: ユーザー自身のノートの処理が改善されました。

ユーザー自身のノートを即座に返すようになり、不要なチェックを回避しています。これは効率的な改善です。


1182-1189: インデックス可能なユーザーの可視性チェックが簡略化されています。

インデックス可能なユーザーの投稿に対する可視性チェックが簡潔になっていますが、以下の点に注意が必要です:

  1. 'public'と'home'の可視性を同じように扱っていますが、これは意図的ですか?
  2. フォロワー限定とダイレクト投稿のチェックが適切に行われています。

この部分のロジックは明確で理解しやすくなっています。ただし、'public'と'home'の扱いが同じである理由について、コメントで説明を追加することを検討してください。


1119-1122: ⚠️ Potential issue

非インデックス可能なユーザーの処理に注意が必要です。

非インデックス可能なユーザーの投稿に対する可視性チェックが追加されていますが、以下の点に注意が必要です:

  1. user.isIndexable === false && meUserId !== undefined && user.id !== meUserId の条件が複雑で、理解しづらい可能性があります。
  2. フォロワー限定投稿とダイレクト投稿の可視性チェックが行われていますが、これらのチェックは後のインタラクションチェックの前に行われるべきではないでしょうか。

これらのチェックの順序を再考し、可読性を向上させることを検討してください。例えば:

- if (user.isIndexable === false && meUserId !== undefined && user.id !== meUserId) {
+ if (!user.isIndexable && meUserId && user.id !== meUserId) {
+   // 可視性チェックを最初に行う
+   if (Note._source.visibility === 'followers' && !Followings.includes(Note._source.userId)) return null;
+   if (Note._source.visibility === 'specified' && Note._source.visibleUserIds && !Note._source.visibleUserIds.includes(meUserId)) return null;
+
+   // その後でインタラクションチェックを行う
    // ... (インタラクションチェックのコード)
  }

Likely invalid or redundant comment.

@penginn-net penginn-net closed this Dec 7, 2024
@penginn-net penginn-net deleted the fix3 branch December 7, 2024 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant