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

PCH Refactor: Refactor internal API and external services #2889

Merged
merged 49 commits into from
Oct 25, 2024

Conversation

vaurdan
Copy link
Contributor

@vaurdan vaurdan commented Oct 25, 2024

Description

This PR is the final one related with the extensive refactoring of the internal REST API, and the external services. This is a combination of the following PRs:

All of these PRs have been reviewed and approved before merging to the refactor/internal-api branch.

Motivation and context

How has this been tested?

Tested locally and through new and updated integration tests.

vaurdan and others added 30 commits August 22, 2024 14:23
…o refactor/internal-api-stats

# Conflicts:
#	tests/Integration/RestAPI/ContentHelper/ContentHelperFeatureTestTrait.php
…elper

REST API Refactor: Base classes and Content Helper namespace implementation
acicovic and others added 10 commits September 6, 2024 10:34
* Apply suggestions from #2731

* Apply suggestions from #2735

* Add dynamic settings endpoint calls
* Implement the new Content API service, and remove old RemoteAPI code

* Implement caching mechanism for service endpoints

* Implement the Suggestions API service

* Address PHPCS & PHPStan errors and warnings

* Fix post-merge issues and namespaces

* Add condition when validate api credentials returns false.

* Address code review feedback

* Adjust some DocBlocks and whitespace

* Make the services base URL static, and remove the old consts

* Fix PHPStan (not including tests)

* Fix misplaced `@since` tag

---------

Co-authored-by: Alex Cicovic <[email protected]>
* Implement and update integration tests

* Adjust some DocBlocks and whitespace

* Adjust some DocBlocks and whitespace

* Fix tests

* Fix leaking tests

* Apply code review suggestions

* Remove backticks from function summary

* Improve code formatting consistency between 2 tests

---------

Co-authored-by: Alex Cicovic <[email protected]>
@vaurdan vaurdan added this to the 3.17.0 milestone Oct 25, 2024
@vaurdan vaurdan self-assigned this Oct 25, 2024
@vaurdan vaurdan requested a review from a team as a code owner October 25, 2024 08:14
@vaurdan vaurdan linked an issue Oct 25, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

46 files out of 128 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

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


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>, 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 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.

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.

# Conflicts:
#	build/content-helper/editor-sidebar.asset.php
#	build/content-helper/editor-sidebar.js
@acicovic acicovic changed the title PCH Refactor: Refactored Internal API & External Services PCH Refactor: Refactore Internal API and External Services Oct 25, 2024
@acicovic acicovic changed the title PCH Refactor: Refactore Internal API and External Services PCH Refactor: Refactor Internal API and External Services Oct 25, 2024
@acicovic
Copy link
Collaborator

We'll not be re-reviewing that code, since it has been already been reviewed per PR. Having said that, let's address the SonarCloud warnings if they have any merit.

@vaurdan
Copy link
Contributor Author

vaurdan commented Oct 25, 2024

@acicovic SonarCloud fixed 🙂

Copy link
Collaborator

@acicovic acicovic left a comment

Choose a reason for hiding this comment

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

Phew! This was lots of work!

Thank you for your diligence and for getting this through the very end!

Let's merge this! This will allow us to merge the rest of the pending PRs, and have a test build for 3.17.0 soon! 🙂

If we find any bugs, we can address them in separate PRs.

@vaurdan vaurdan merged commit bf22e90 into develop Oct 25, 2024
36 checks passed
@vaurdan vaurdan deleted the refactor/internal-api branch October 25, 2024 11:13
@acicovic acicovic changed the title PCH Refactor: Refactor Internal API and External Services PCH Refactor: Refactor internal API and external services Nov 6, 2024
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.

Refactor all endpoints code
2 participants