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

to属性でオブジェクトを使用するように変更 #334

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

dye8128
Copy link
Contributor

@dye8128 dye8128 commented Jul 11, 2024

User description

close #332
#314 の対応(to属性にstring型変数が指定されているものについては未完)


PR Type

Enhancement


Description

  • router-linkto属性を文字列からオブジェクト形式に変更
  • 各コンポーネントおよびページでのルーティングの一貫性を向上
  • コードの可読性と保守性を向上

Changes walkthrough 📝

Relevant files
Enhancement
22 files
ContestTeamItem.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Contest/ContestTeamItem.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
ContestTeams.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Contest/ContestTeams.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
ContestItem.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Contests/ContestItem.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
EventItem.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Events/EventItem.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
PageHeader.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Layout/PageHeader.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
ProjectItem.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/Projects/ProjectItem.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
UserProfileDesktop.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/User/UserProfileDesktop.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
UserProfileMobile.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/User/UserProfileMobile.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
AccountItem.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/components/UserAccounts/AccountItem.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
Contest.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/Contest.vue

  • router-linkto属性をオブジェクト形式に変更
+5/-2     
ContestEdit.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/ContestEdit.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
ContestNew.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/ContestNew.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
ContestTeamEdit.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/ContestTeamEdit.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
ContestTeamNew.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/ContestTeamNew.vue

  • router-linkto属性をオブジェクト形式に変更
+4/-1     
Contests.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/Contests.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
Event.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/Event.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
Project.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/Project.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
ProjectNew.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/ProjectNew.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
Projects.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/Projects.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
UserAccountEdit.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/UserAccountEdit.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
UserAccountNew.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/UserAccountNew.vue

  • router-linkto属性をオブジェクト形式に変更
+1/-1     
UserAccounts.vue
`router-link`の`to`属性をオブジェクト形式に変更                                                 

src/pages/UserAccounts.vue

  • router-linkto属性をオブジェクト形式に変更
+2/-2     

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

Copy link
Contributor

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No key issues to review

Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Possible issue
パラメータの存在を確認し、デフォルト値を提供することで、ルーティングの安全性を向上させます。


:to属性のオブジェクト内で、contestIdteamIdの値が直接参照されていますが、これらの値が未定義またはnullの場合に問題が発生する可能性があります。これを防ぐために、これらの値の存在を確認するロジックを追加することをお勧めします。

src/components/Contest/ContestTeamItem.vue [20-22]

 :to="{
   name: 'ContestTeamEdit',
-  params: { contestId: contestId, teamId: contestTeam.id }
+  params: {
+    contestId: contestId || 'defaultContestId',
+    teamId: contestTeam ? contestTeam.id : 'defaultTeamId'
+  }
 }"
 
Suggestion importance[1-10]: 8

Why: The suggestion correctly identifies a potential issue with undefined or null values for contestId and teamId, and provides a robust solution by adding default values. This improves the safety and reliability of the routing logic.

8
Enhancement
パラメータprojectIdにデフォルト値を設定して、ルーティングの堅牢性を向上させます。

:to属性で使用されているprojectIdが未定義の場合に備えて、デフォルト値を設定することを提案します。これにより、ルート解決時のエラーを防ぐことができます。

src/components/Projects/ProjectItem.vue [14-15]

-:to="{ name: 'Project', params: { projectId: project.id } }"
+:to="{ name: 'Project', params: { projectId: project.id || 'defaultProjectId' } }"
 
Suggestion importance[1-10]: 7

Why: The suggestion enhances the robustness of the routing by providing a default value for projectId, which is a good practice to prevent potential errors. However, the likelihood of projectId being undefined might be low, so the impact is minor.

7
パラメータcontestIdにデフォルト値を設定して、ルーティングの堅牢性を向上させます。

:to属性のオブジェクトでcontestIdを使用していますが、この値が常に存在するとは限らないため、存在しない場合のデフォルト値を設定することを推奨します。

src/pages/ContestTeamEdit.vue [139-140]

-:to="{ name: 'Contest', params: { contestId: contestId } }"
+:to="{ name: 'Contest', params: { contestId: contestId || 'defaultContestId' } }"
 
Suggestion importance[1-10]: 7

Why: The suggestion improves the reliability of the routing by ensuring that contestId has a default value if it is undefined. This is a useful enhancement, though the actual occurrence of contestId being undefined might be rare.

7

@Pugma
Copy link
Collaborator

Pugma commented Jul 11, 2024

formatだけ忘れてそうなのでお願いします!

@Pugma Pugma requested review from Kaki256 and ogu-kazemiya July 11, 2024 09:50
@dye8128
Copy link
Contributor Author

dye8128 commented Jul 11, 2024

formatかけたので確認お願いします!

Copy link
Contributor

@ogu-kazemiya ogu-kazemiya left a comment

Choose a reason for hiding this comment

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

他のところは問題なさそうです!

src/pages/Project.vue Show resolved Hide resolved
Copy link
Contributor

@mehm8128 mehm8128 left a comment

Choose a reason for hiding this comment

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

#314
もcloseに指定しておくとよさそうです(メインはこれの対応だと思うので))

@dye8128
Copy link
Contributor Author

dye8128 commented Jul 12, 2024

確かに #314 への対応が主なのですが、string型変数が :to に指定されている箇所があり(PageInfoPanel.vueなど)、これの対応が終わっていないためcloseに指定していないです
これの対応については、別ブランチを立てて作業中です(fix/url-type)

そのため一時的な対応として、 #332 のcloseと #314 の一部を含むPRを出しました
(Pugma君とのペアプロでこの対応をすることになりました)

@mehm8128
Copy link
Contributor

なるほどです
ではcloseまで書かなくても、関連issueとしてPRの説明文にissueのURLを貼っておく(closeとか書かずにURL貼るだけなら元issueはcloseされないので)と、後で見返すときになんでこのPRが作られたのか等が分かりやすくなりそうです

@dye8128
Copy link
Contributor Author

dye8128 commented Jul 12, 2024

分かりました、ありがとうございます!
PR文を訂正しました!

@ogu-kazemiya ogu-kazemiya self-requested a review July 12, 2024 12:58
Copy link
Contributor

@ogu-kazemiya ogu-kazemiya left a comment

Choose a reason for hiding this comment

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

OKです

@dye8128 dye8128 merged commit b97d71a into main Jul 12, 2024
9 checks passed
@dye8128 dye8128 deleted the fix/router-link branch July 12, 2024 21:55
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.

backボタン押すと404
4 participants