refactor(frontend): Reactivityで型を明示するように #12791
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
packages/frontend
|
このPRによるapi.jsonの差分 差分はこちら--- base
+++ head
@@ -400,6 +400,10 @@
"type": "string",
"nullable": true
},
+ "shortName": {
+ "type": "string",
+ "nullable": true
+ },
"objectStorageS3ForcePathStyle": {
"type": "boolean",
"nullable": false
@@ -515,6 +519,7 @@
"maintainerEmail",
"maintainerName",
"name",
+ "shortName",
"objectStorageS3ForcePathStyle",
"privacyPolicyUrl",
"repositoryUrl",
@@ -31954,79 +31959,9 @@
"type": "array",
"nullable": false,
"items": {
- "properties": {
- "id": {
- "type": "string"
- },
- "firstRetrievedAt": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "usersCount": {
- "type": "number"
- },
- "notesCount": {
- "type": "number"
- },
- "followingCount": {
- "type": "number"
- },
- "followersCount": {
- "type": "number"
- },
- "isNotResponding": {
- "type": "boolean"
- },
- "isSuspended": {
- "type": "boolean"
- },
- "isBlocked": {
- "type": "boolean"
- },
- "softwareName": {
- "type": "string"
- },
- "softwareVersion": {
- "type": "string"
- },
- "openRegistrations": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "maintainerName": {
- "type": "string"
- },
- "maintainerEmail": {
- "type": "string"
- },
- "isSilenced": {
- "type": "boolean"
- },
- "iconUrl": {
- "type": "string"
- },
- "faviconUrl": {
- "type": "string"
- },
- "themeColor": {
- "type": "string"
- },
- "infoUpdatedAt": {
- "type": "string",
- "nullable": true
- },
- "latestRequestReceivedAt": {
- "type": "string",
- "nullable": true
- }
- }
+ "type": "object",
+ "nullable": false,
+ "$ref": "#/components/schemas/FederationInstance"
}
},
"otherFollowersCount": {
@@ -32036,79 +31971,9 @@
"type": "array",
"nullable": false,
"items": {
- "properties": {
- "id": {
- "type": "string"
- },
- "firstRetrievedAt": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "usersCount": {
- "type": "number"
- },
- "notesCount": {
- "type": "number"
- },
- "followingCount": {
- "type": "number"
- },
- "followersCount": {
- "type": "number"
- },
- "isNotResponding": {
- "type": "boolean"
- },
- "isSuspended": {
- "type": "boolean"
- },
- "isBlocked": {
- "type": "boolean"
- },
- "softwareName": {
- "type": "string"
- },
- "softwareVersion": {
- "type": "string"
- },
- "openRegistrations": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "maintainerName": {
- "type": "string"
- },
- "maintainerEmail": {
- "type": "string"
- },
- "isSilenced": {
- "type": "boolean"
- },
- "iconUrl": {
- "type": "string"
- },
- "faviconUrl": {
- "type": "string"
- },
- "themeColor": {
- "type": "string"
- },
- "infoUpdatedAt": {
- "type": "string",
- "nullable": true
- },
- "latestRequestReceivedAt": {
- "type": "string",
- "nullable": true
- }
- }
+ "type": "object",
+ "nullable": false,
+ "$ref": "#/components/schemas/FederationInstance"
}
},
"otherFollowingCount": {
@@ -32274,79 +32139,9 @@
"type": "array",
"nullable": false,
"items": {
- "properties": {
- "id": {
- "type": "string"
- },
- "firstRetrievedAt": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "usersCount": {
- "type": "number"
- },
- "notesCount": {
- "type": "number"
- },
- "followingCount": {
- "type": "number"
- },
- "followersCount": {
- "type": "number"
- },
- "isNotResponding": {
- "type": "boolean"
- },
- "isSuspended": {
- "type": "boolean"
- },
- "isBlocked": {
- "type": "boolean"
- },
- "softwareName": {
- "type": "string"
- },
- "softwareVersion": {
- "type": "string"
- },
- "openRegistrations": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "maintainerName": {
- "type": "string"
- },
- "maintainerEmail": {
- "type": "string"
- },
- "isSilenced": {
- "type": "boolean"
- },
- "iconUrl": {
- "type": "string"
- },
- "faviconUrl": {
- "type": "string"
- },
- "themeColor": {
- "type": "string"
- },
- "infoUpdatedAt": {
- "type": "string",
- "nullable": true
- },
- "latestRequestReceivedAt": {
- "type": "string",
- "nullable": true
- }
- }
+ "type": "object",
+ "nullable": false,
+ "$ref": "#/components/schemas/FederationInstance"
}
},
"otherFollowersCount": {
@@ -32356,79 +32151,9 @@
"type": "array",
"nullable": false,
"items": {
- "properties": {
- "id": {
- "type": "string"
- },
- "firstRetrievedAt": {
- "type": "string"
- },
- "host": {
- "type": "string"
- },
- "usersCount": {
- "type": "number"
- },
- "notesCount": {
- "type": "number"
- },
- "followingCount": {
- "type": "number"
- },
- "followersCount": {
- "type": "number"
- },
- "isNotResponding": {
- "type": "boolean"
- },
- "isSuspended": {
- "type": "boolean"
- },
- "isBlocked": {
- "type": "boolean"
- },
- "softwareName": {
- "type": "string"
- },
- "softwareVersion": {
- "type": "string"
- },
- "openRegistrations": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "maintainerName": {
- "type": "string"
- },
- "maintainerEmail": {
- "type": "string"
- },
- "isSilenced": {
- "type": "boolean"
- },
- "iconUrl": {
- "type": "string"
- },
- "faviconUrl": {
- "type": "string"
- },
- "themeColor": {
- "type": "string"
- },
- "infoUpdatedAt": {
- "type": "string",
- "nullable": true
- },
- "latestRequestReceivedAt": {
- "type": "string",
- "nullable": true
- }
- }
+ "type": "object",
+ "nullable": false,
+ "$ref": "#/components/schemas/FederationInstance"
}
},
"otherFollowingCount": {
@@ -48589,25 +48314,42 @@
"type": "object",
"nullable": false,
"properties": {
- "place": {
+ "id": {
"type": "string",
- "nullable": false
+ "nullable": false,
+ "format": "id",
+ "example": "xxxxxxxxxx"
},
"url": {
"type": "string",
"nullable": false,
"format": "url"
},
+ "place": {
+ "type": "string",
+ "nullable": false
+ },
+ "ratio": {
+ "type": "number",
+ "nullable": false
+ },
"imageUrl": {
"type": "string",
"nullable": false,
"format": "url"
+ },
+ "dayOfWeek": {
+ "type": "integer",
+ "nullable": false
}
},
"required": [
- "place",
+ "id",
"url",
- "imageUrl"
+ "place",
+ "ratio",
+ "imageUrl",
+ "dayOfWeek"
]
}
},
@@ -56438,7 +56180,19 @@
"application/json": {
"schema": {
"type": "object",
- "nullable": false
+ "nullable": false,
+ "properties": {
+ "sourceLang": {
+ "type": "string"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "sourceLang",
+ "text"
+ ]
}
}
} |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #12791 +/- ##
===========================================
- Coverage 79.79% 79.77% -0.02%
===========================================
Files 956 956
Lines 108807 108794 -13
Branches 8372 8372
===========================================
- Hits 86818 86789 -29
- Misses 21989 22005 +16 ☔ View full report in Codecov by Sentry. |
syuilo
reviewed
Dec 25, 2023
syuilo
reviewed
Dec 25, 2023
samunohito
reviewed
Dec 25, 2023
syuilo
reviewed
Dec 25, 2023
だったのが みたいに初期値に空配列を入れるように変わってる箇所がいくつかあるけど、「値がまだfetchされていない」ことと「fetchしたけど結果が空だった」ことは区別される場合が多いから不具合が起きそう |
|
ので みたいにするのが良さそう |
|
ごもっともです。修正します。 |
|
元々空配列だった部分についてはあえてそのままにしてあります🙏 |
syuilo
reviewed
Dec 25, 2023
| @@ -62,7 +62,7 @@ const props = defineProps<{ | |||
| }>(); | |||
|
|
|||
| const note = ref<null | Misskey.entities.Note>(); | |||
| const clips = ref(); | |||
| const clips = ref<Misskey.entities.Clip[]>(); | |||
There was a problem hiding this comment.
Suggested change
| const clips = ref<Misskey.entities.Clip[]>(); | |
| const clips = ref<Misskey.entities.Clip[] | null>(null); |
かも
There was a problem hiding this comment.
これは undefined になるのでいいかなと思っていたのですが、null に寄せたほうが良いでしょうか？
There was a problem hiding this comment.
どっちでも良さそう
ただ undefined にする場合でも型は
Misskey.entities.Clip[] | undefinedにする必要がありそう
There was a problem hiding this comment.
初期値の省略時は Ref<Misskey.entities.Clip[] | undefined> で推論されるので、明示する必要はなさそうです。
https://ja.vuejs.org/guide/typescript/composition-api#typing-ref
| @@ -53,7 +54,7 @@ const props = withDefaults(defineProps<{ | |||
| }); | |||
|
|
|||
| const tab = ref(props.initialTab); | |||
| const role = ref(); | |||
| const role = ref<Misskey.entities.Role>(); | |||
There was a problem hiding this comment.
Suggested change
| const role = ref<Misskey.entities.Role>(); | |
| const role = ref<Misskey.entities.Role | null>(null); |
| @@ -58,8 +59,8 @@ const { widgetProps, configure, save } = useWidgetPropsManager(name, | |||
| emit, | |||
| ); | |||
|
|
|||
| const list = ref(); | |||
| const users = ref([]); | |||
| const list = ref<Misskey.entities.UserList>(); | |||
There was a problem hiding this comment.
Suggested change
| const list = ref<Misskey.entities.UserList>(); | |
| const list = ref<Misskey.entities.UserList | null>(null); |
|
🙏🙏🙏🙏🙏 |
|
ご丁寧なレビューありがとうございました🙏 |
camilla-ett
pushed a commit
to kaseiski/misskey
that referenced
this pull request
Jan 2, 2024
* refactor(frontend): Reactivityで型を明示するように * fix: プロパティの参照が誤っているのを修正 * fix: 初期化の値を空配列に書き換えていた部分をnullに置き換え
madonuko
pushed a commit
to FyraLabs/nyaakey
that referenced
this pull request
Feb 26, 2024
* refactor(frontend): Reactivityで型を明示するように * fix: プロパティの参照が誤っているのを修正 * fix: 初期化の値を空配列に書き換えていた部分をnullに置き換え
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Vue の Reactivity を用いている箇所で、型を明示する必要がある箇所について（全てではないですが）ある程度修正を行いました。また、必要に応じてエンドポイントのスキーマを更新しました。
Why
ref()、ref<any>()はRef<any>と推論されます。any以外の型を明示することで、このようなanyをなるべく減らします。ref(null)はRef<null>と推論されるため、null以外の値を代入しようとするとエラーが発生してしまいます。型を明示することで、このエラーをなるべく減らします1。ref([])はRef<never[]>と推論されるため、何かしらの値を代入しようとするとエラーが発生します。型を明示することで、このエラーをなるべく減らします。Additional info (optional)
Checklist
Footnotes
なお
ref(null)については、修正しきれなかった箇所は（anyで検索した際に候補に出るようにしたいので）ref<any>(null)へ書き換えを行っていますが、もしこれが不適切であればもとに戻します。 ↩