[WIP] 🔥 Feature!: Add Req and Res API #2894

nickajacks1 · 2024-03-03T23:21:35Z

CURRENT STATUS

Change ctx.Response to return a new fiber.Response object. Minimal changes required to get things to build.

TODO

Description

Split the existing Ctx API into two separate APIs for Requests and Responses. Having distinct APIs for Request and Response types will allow developers to more easily write self-documenting code by avoiding ambiguous methods such as Ctx.Cookie and Ctx.Cookies. Much of the existing Ctx API simply calls the corresponding Req or Res API. For example, Ctx.Get calls Request.Get and Ctx.Set calls Response.Set.

Because Express defines only res and req APIs with no context API, this change will make it easier to manage Fiber's adherence to Express's APIs. In addition, it will allow us to avoid needing to create certain one-off methods. For example, Ctx.GetRespHeader can now become Ctx.Res().Get

Although the majority of the Ctx API is unchanged, Ctx.Request and Ctx.Response have been removed in favor of Ctx.Req and Ctx.Res. Now, instead of a raw fasthttp.Request or fasthttp.Response, we return fiber.Request and fiber.Response objects, which implement their respective APIs. As such, this is a breaking change for users who access Ctx.Request and Ctx.Response direct.

Inspired by Koa and fasthttp, both of which have individual request/response objects and a single context object whose methods are simply aliases for corresponding methods on the req/res APIs.

Deprecation:

Ctx.GetRespHeader is replaced by Ctx.Res().Get

Related to #2854

Changes introduced

List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.

Benchmarks: Describe any performance benchmarks and improvements related to the changes.
Documentation Update: Detail the updates made to the documentation and links to the changed files.
Changelog/What's New: Include a summary of the additions for the upcoming release notes.
Migration Guide: If necessary, provide a guide or steps for users to migrate their existing code to accommodate these changes.
API Alignment with Express: Explain how the changes align with the Express API.
API Longevity: Discuss the steps taken to ensure that the new or updated APIs are consistent and not prone to breaking changes.
Examples: Provide examples demonstrating the new features or changes in action.

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)
Enhancement (improvement to existing features and functionality)
Documentation update (changes to documentation)
Performance improvement (non-breaking change which improves efficiency)
Code consistency (non-breaking change which improves code reliability and robustness)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
Conducted a self-review of the code and provided comments for complex or critical parts.
Updated the documentation in the /docs/ directory for Fiber's documentation.
Added or updated unit tests to validate the effectiveness of the changes or new features.
Ensured that new and existing unit tests pass locally with the changes.
Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
Aimed for optimal performance with minimal allocations in the new code.
Provided benchmarks for the new code to analyze and improve upon.

coderabbitai · 2024-03-03T23:21:41Z

Important

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

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.

gaby · 2024-03-04T05:51:22Z

client.go

@@ -19,14 +19,16 @@ import (
 	"github.com/valyala/fasthttp"
 )

+// XXX TODO FIXME had to comment out the below types


I wouldnt worry about client.go until #1986 is merged

@nickajacks1 Now its merge, you might need to fix the merge conflcits to be able to pull all the recent changes to main

codecov · 2024-03-05T03:37:13Z

Codecov Report

Attention: Patch coverage is 95.40079% with 35 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@4d1e993). Click here to learn what that means.

Files	Patch %	Lines
request.go	95.54%	12 Missing and 3 partials ⚠️
response.go	94.14%	11 Missing and 4 partials ⚠️
bind.go	50.00%	1 Missing ⚠️
ctx.go	98.33%	1 Missing ⚠️
ctx_interface.go	96.00%	1 Missing ⚠️
middleware/cache/cache.go	90.90%	1 Missing ⚠️
middleware/filesystem/filesystem.go	87.50%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2894   +/-   ##
=======================================
  Coverage        ?   82.98%           
=======================================
  Files           ?      118           
  Lines           ?     8541           
  Branches        ?        0           
=======================================
  Hits            ?     7088           
  Misses          ?     1116           
  Partials        ?      337

Flag	Coverage Δ
unittests	`82.98% <95.40%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

gaby · 2024-03-05T03:46:30Z

@nickajacks1 Just so you are aware, the tests are very unstable/flaky right now in main. This is because we no longer retry failed tests multiple times on the CI. This is being fixing in #2892

nickajacks1 · 2024-03-10T00:04:56Z

3/9: Moved some more methods from Ctx to Request. Rebased.

nickajacks1 · 2024-03-18T01:15:30Z

3/17: Rebase. Moved more trivial methods to Request.

nickajacks1 · 2024-04-15T00:23:53Z

Hi @gofiber/maintainers

Sorry this is taking so long.
I've reached the first major milestone - the Request API is fully moved over to the Request type.
I'd like to get a health check - does the overall direction still seem OK? If so, I suspect that moving the Response API over will be comparatively quick.
None of the unit tests have been moved over. IMO that's quite a bit of work and shouldn't hold up v3 since it's not public facing and can be done at any time.

nickajacks1 · 2024-04-21T17:23:38Z

Even though Express has Locals as part of the res API, I feel like it makes more sense to keep it as part of Ctx since it doesn't inherently have anything to do with the response (or request for that matter). I'm going to leave in Ctx for now.

ReneWerner87 · 2024-04-21T19:36:00Z

ok, sounds reasonable we can always adapt it later

nickajacks1 · 2024-04-21T21:39:56Z

Ok, the Response API is fully moved over.

Some remaining work:
I didn't move Redirect to the Response API yet. The Redirect API has some dependencies on DefaultCtx that requires more thought. Moving Redirect to Res won't break the API in any way, so we can take our time thinking about this.

Next week I'll start on either the docs or the interface part.

gaby reviewed Mar 4, 2024

View reviewed changes

nickajacks1 force-pushed the reqres branch from 700a679 to ce81df0 Compare March 5, 2024 03:35

nickajacks1 force-pushed the reqres branch from ce81df0 to 8a8ee1b Compare March 10, 2024 00:02

nickajacks1 force-pushed the reqres branch from 8a8ee1b to a05dd1d Compare March 18, 2024 01:14

gaby added the v3 label Mar 27, 2024

nickajacks1 force-pushed the reqres branch from a05dd1d to 04948fd Compare April 15, 2024 00:19

ReneWerner87 linked an issue Apr 17, 2024 that may be closed by this pull request

📝 [v3 Proposal]: Koa Style ctx.Request and ctx.Response Objects #2854

Open

3 tasks

ReneWerner87 added the ✏️ Feature label Apr 20, 2024

ReneWerner87 assigned nickajacks1 Apr 20, 2024

ReneWerner87 added this to the v3 milestone Apr 20, 2024

feat: Create Ctx.Req API

8dbd147

nickajacks1 force-pushed the reqres branch 2 times, most recently from 2a82670 to 31fde6b Compare April 21, 2024 21:13

feat: Create Ctx.Res API

d305ed8

nickajacks1 force-pushed the reqres branch from 31fde6b to d305ed8 Compare April 21, 2024 21:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] 🔥 Feature!: Add Req and Res API #2894

[WIP] 🔥 Feature!: Add Req and Res API #2894

nickajacks1 commented Mar 3, 2024 •

edited

coderabbitai bot commented Mar 3, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

gaby Mar 4, 2024 •

edited

gaby Mar 28, 2024

codecov bot commented Mar 5, 2024 •

edited

gaby commented Mar 5, 2024

nickajacks1 commented Mar 10, 2024

nickajacks1 commented Mar 18, 2024

nickajacks1 commented Apr 15, 2024

nickajacks1 commented Apr 21, 2024

ReneWerner87 commented Apr 21, 2024

nickajacks1 commented Apr 21, 2024

[WIP] 🔥 Feature!: Add Req and Res API #2894

Are you sure you want to change the base?

[WIP] 🔥 Feature!: Add Req and Res API #2894

Conversation

nickajacks1 commented Mar 3, 2024 • edited

CURRENT STATUS

Description

Deprecation:

Changes introduced

Type of change

Checklist

coderabbitai bot commented Mar 3, 2024 • edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

gaby Mar 4, 2024 • edited

Choose a reason for hiding this comment

gaby Mar 28, 2024

Choose a reason for hiding this comment

codecov bot commented Mar 5, 2024 • edited

Codecov Report

gaby commented Mar 5, 2024

nickajacks1 commented Mar 10, 2024

nickajacks1 commented Mar 18, 2024

nickajacks1 commented Apr 15, 2024

nickajacks1 commented Apr 21, 2024

ReneWerner87 commented Apr 21, 2024

nickajacks1 commented Apr 21, 2024

nickajacks1 commented Mar 3, 2024 •

edited

coderabbitai bot commented Mar 3, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

gaby Mar 4, 2024 •

edited

codecov bot commented Mar 5, 2024 •

edited