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

chore(connect): deviceCommands call and commonCall shallow structure #16735

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mroz22
Copy link
Contributor

@mroz22 mroz22 commented Jan 30, 2025

  • commit 1: this should be little more readable. transport already never throws and returns { success: true|false}-like objects instead. This commit propagates this trend to a higher layer (deviceCommads call and deviceCommands commonCall. deviceCommands.typedCall still throws but adds "cause" arg transport-error if the error originated in the transport layer. pls check @marekrjpolak
  • commit 2: todo for @komret
  • commit 3: to be debated @marekrjpolak

Copy link

coderabbitai bot commented Jan 30, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@mroz22 mroz22 force-pushed the komar branch 2 times, most recently from 6a456da to 785bcc5 Compare January 30, 2025 16:14
throw error;

if ('isTransportError' in response) {
throw new Error(response.error, { cause: 'transport-error' });
Copy link
Contributor

Choose a reason for hiding this comment

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

Two-parametrical Error constructor is not supported in es2019 => build:lib error. Can we change the target to esnext or something?

// throw error anyway, next call should be resolved properly
throw error;

if ('isTransportError' in response) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to be safe?

Suggested change
if ('isTransportError' in response) {
if ('isTransportError' in response && response.isTransportError) {

Comment on lines 361 to 359
): Promise<
DefaultPayloadMessage | (ErrorGeneric<ReadWriteError> & { isTransportError: true })
> {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not a big fan of somehow inconsistent return types.

Comment on lines +377 to +387
return {
...res,
isTransportError: true,
};
Copy link
Contributor

Choose a reason for hiding this comment

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

Given that _commonCall is not throwing any more in this case, it will change the logic below in _filterCommonTypes, e.g. this._commonCall('PinMatrixAck', { pin }).then(response => ...), right? Do we mind?

// res.message is not propagated to higher levels, only logged here. webusb/node-bridge may return message with additional information
res.message,
);
throw new Error(res.error);
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe I'm missing the point, but why don't we just do the throw new Error(res.error, { cause: 'transport-error' }) thing here, instead of all the other changes? It would propagate upwards anyway, right?

@mroz22 mroz22 force-pushed the komar branch 3 times, most recently from f85d1b7 to 0b7aa27 Compare February 3, 2025 12:09
@mroz22 mroz22 added the no-project This label is used to specify that PR doesn't need to be added to a project label Feb 3, 2025
@mroz22 mroz22 force-pushed the komar branch 7 times, most recently from fa0a122 to 403f0d0 Compare February 5, 2025 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-project This label is used to specify that PR doesn't need to be added to a project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants