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

前後のmessageを更新しようとすると、型チェックで落ちるのを修正 #96

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

kamecha
Copy link
Owner

@kamecha kamecha commented Jul 29, 2024

バッファ変数に保存してた情報にvim・denops側で齟齬が生じてたのが原因

denops→vimでundefined→0に解釈されるらしく、
vim→denopsと値が渡されたときにundefinedチェックできない

denops側でundefinedだったら、そもそもvim側に入れないように修正

Summary by CodeRabbit

  • New Features

    • Enhanced user data processing for improved clarity and type safety.
    • Improved message construction and handling in the channel timeline.
  • Bug Fixes

    • Refined logic to ensure quoted messages are included only when applicable.

Copy link

coderabbitai bot commented Jul 29, 2024

Walkthrough

The recent modifications enhance the functionality of user data processing in denops/traqvim/model.ts. The getUser function now ensures clear type safety by explicitly typing API responses, while the channelTimeline function refines message construction logic. These changes improve data handling by ensuring well-defined structures, enhancing the control flow of the application, and preparing the code for potential future optimizations.

Changes

Files Change Summary
denops/traqvim/model.ts Enhanced getUser and channelTimeline functions for improved type safety and message construction logic, ensuring cleaner data handling and better control flow.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant UserManager
    participant MessageManager

    Client->>UserManager: getUser(userId)
    UserManager->>API: Fetch user detail
    API-->>UserManager: Return user detail
    UserManager-->>Client: Return User

    Client->>MessageManager: channelTimeline(params)
    MessageManager->>API: Fetch channel messages
    API-->>MessageManager: Return messages
    MessageManager-->>Client: Return Message[]
Loading

🐰 "In code we waddle, with joy we leap,
Type safety's here, our data to keep.
Messages crafted with care and delight,
Hopping through changes, all feels just right!
A burrow of logic, neat and refined,
With each little tweak, new treasures we find!" 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@kamecha kamecha merged commit 1edd60d into master Jul 29, 2024
1 check passed
@kamecha kamecha deleted the fix/var-message-type branch July 29, 2024 02:37
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d39796 and 7b81547.

Files selected for processing (1)
  • denops/traqvim/model.ts (3 hunks)
Additional comments not posted (2)
denops/traqvim/model.ts (2)

142-152: LGTM!

The changes improve type safety and clarity by explicitly typing the API response and mapping properties to construct the user object.


Line range hint 185-213:
LGTM!

The changes refine the data structures used in the function, improve type definitions, and enhance the control flow regarding how messages are constructed and returned.

However, ensure that all function calls to channelTimeline match the new logic.

@@ -139,7 +139,17 @@ export const homeChannelId = async (): Promise<string> => {
// userIdからユーザー情報を取得する
export const getUser = async (userId: string): Promise<traq.User> => {
const userRes = await api.api.getUser(userId);
const user = userRes.data;
const userDetail: traq.UserDetail = userRes.data;
// TODO: もっと良い変換方法ありそうなんで、見つけたらやっとく
Copy link

Choose a reason for hiding this comment

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

Reminder: Improve data transformation method.

The TODO comment indicates a potential for finding a better transformation method.

Do you want me to assist in finding and implementing a more efficient data transformation method?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant