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

Restored return type for 'request' method #297

Merged
merged 4 commits into from
May 23, 2024

Conversation

KazuyaUchida
Copy link
Contributor

request実行後にbodyにアクセスしようとするとResourceInterfaceにはプロパティとしてbodyがないため、静的解析でエラーが発生してしまう

/** @var ResourceInterface */
protected $resource;

$this->resource->uri($url)->withQuery($prams)->linkCrawl('meta')->request()->body;

変更履歴ではrectorとsaでの修正履歴のためIF自体が変わったわけではない模様なので、使用しているリソースに影響が出ないようにreturn typeをrector適用前の状態に戻した

Copy link

coderabbitai bot commented May 23, 2024

Important

Review Skipped

Auto reviews are disabled on this repository.

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.

ウォークスルー

この変更は、ResourceClientModuleRequestInterfaceの2つの主要なファイルに影響を与えています。ResourceClientModuleでは、configureDeprecatedBindingsメソッドから@phpstan-ignoreアノテーションが削除されました。RequestInterfaceでは、requestメソッドの戻り値の型ヒントが変更されました。

変更点

ファイル 変更内容の要約
src/Module/ResourceClientModule.php configureDeprecatedBindingsメソッドから@phpstan-ignoreアノテーションを削除。
src/RequestInterface.php requestメソッドの戻り値の型ヒントを`ResourceObject

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

@koriym
Copy link
Member

koriym commented May 23, 2024

@coderabbitai review

Copy link

coderabbitai bot commented May 23, 2024

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f11403d) to head (d709630).

Current head d709630 differs from pull request most recent head b9662d0

Please upload reports for the commit b9662d0 to get more accurate results.

Additional details and impacted files
@@             Coverage Diff             @@
##                 1.x      #297   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       504       504           
===========================================
  Files             83        83           
  Lines           1346      1346           
===========================================
  Hits            1346      1346           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Removed phpstan ignore comments in the configureDeprecatedBindings function of the ResourceClientModule class. The code now adheres to phpstan static analysis tool, improving code quality and reducing technical debt.
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 f11403d and d709630.
Files selected for processing (2)
  • src/Module/ResourceClientModule.php (1 hunks)
  • src/RequestInterface.php (1 hunks)
Additional comments not posted (1)
src/Module/ResourceClientModule.php (1)

100-101: configureDeprecatedBindings メソッドから @phpstan-ignore アノテーションを削除しました。これにより、HalLinkReverseLinkInterface のバインディングが PHPStan の静的解析チェックに準拠していることが示されます。新しい PHPStan エラーが発生していないか確認してください。

src/RequestInterface.php Show resolved Hide resolved
The commit adds the @inheritdoc annotation to all methods in the FakeRequest class. The clear reference to the documentation from the implemented interfaces will aid readability and further understanding of the code base.
@koriym koriym merged commit e5fddca into bearsunday:1.x May 23, 2024
12 of 13 checks passed
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.

2 participants