Locust client does not send cookies automatically ?

[tomohirohiratsuka]

Overview

We are encountering an issue where, after a successful login, the cookies that are set during the login process are not automatically included in subsequent requests using self.client.get(). This is observed when using Locust for load testing.

Problem Description

• Expected Behavior: After logging in and having the access_token and refresh_token set in the cookies, these cookies should be automatically included in the subsequent requests.
• Observed Behavior: Although the cookies are set after the login request, they are not automatically sent with the next requests, specifically for self.client.get(). Cookies need to be manually passed via the cookies parameter for subsequent requests to include them.

Steps to Reproduce

1. Sample Code:
   The following code demonstrates the issue. After the login, the cookies should be automatically included in the next requests, but they are not.

from locust import HttpUser, task, between
from locust.exception import StopUser

class UserBehavior(HttpUser):
    wait_time = between(1, 3)

    def on_start(self):
        self.login("[email protected]", "password")

    def login(self, email, password):
        """Login request and save cookies"""
        login_data = {
            "provider": {
                "type": "email",
                "email": email,
                "password": password
            }
        }
        response = self.client.post("/api/auth/signin", json=login_data)

        if response.status_code == 200:
            print(f"User Cookie: {self.client.cookies}")
            print(f"User {email} logged in successfully.")
        else:
            print(f"User {email} login failed.")
            raise StopUser()

    @task
    def me(self):
        """Get the user info after login"""
#        res = self.client.get("/api/auth/me") does not send cookies
#        res = self.client.get("/api/auth/me", cookies=self.client.cookies) does not send cookies
# only below works to send
          access_token = self.client.cookies.get("access_token")
          refresh_token = self.client.cookies.get("refresh_token")
          self.client.get("/api/auth/me", cookies={"access_token": access_token, "refresh_token": refresh_token})

        print(res.request.headers)

2. Observed Issue:

   • After logging in, cookies are set in the self.client.cookies.
   • However, when trying to make the GET request to /api/auth/me, the cookies are not automatically included.

3. Expected Behavior:

   • The cookies set during login (e.g., access_token and refresh_token) should be automatically sent with the GET request to /api/auth/me.

Questions to Address

• Is this the expected behavior for Locust?

  • Is it expected that cookies are not automatically included in subsequent requests unless explicitly provided?

• How can we ensure that cookies are automatically included in subsequent requests without manually passing the cookies parameter?

  • Are there any configurations or settings within Locust that need to be adjusted for this?

  Thank you

[cyberw]

Is this the expected behavior for Locust?

No, it should work out of the box.

The most likely explanation is that the client (a requests.Session instance) chooses not to send the cookies because it feels they are not relevant for the request. Could be a domain mismatch or that the cookies are marked Secure, but it is not a secure connection. It could also be a bug in requests (but that is less likely). Are you using the latest versions of Locust and requests?

Maybe try printing the http conversation https://docs.locust.io/en/stable/running-in-debugger.html#print-http-communication

You could also try using FastHttpUser.

[tomohirohiratsuka]

Thank you for your response.

Are you using the latest versions of Locust and requests?

yes it's 2.32.8

I've tried checking the logging of request details, but it seems that cookies are still not being sent.
I’ve created a simple example repo:
https://github.com/tomohirohiratsuka/locust-cookies-behavior

It works fine in the browser, but when using Locust, it fails.
I’m new to Locust, so I may have missed some configuration.
I would appreciate it if you could check the repo above.

Thank you.