.github/workflows/stale.yml

@@ -19,8 +19,8 @@ jobs:
       - uses: actions/stale@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: "This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days."
-          close-issue-message: "This issue was closed because it has been stalled for 10 days with no activity. This does not necessarily mean that the issue is bad, but it most likely means that nobody is willing to take the time to fix it. If you have found Locust useful, then consider contributing a fix yourself!"
-          stale-pr-message: "This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days."
-          close-pr-message: "This PR was closed because it has been stalled for 10 days with no activity."
-          days-before-close: 10
+          stale-issue-message: "This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 20 days."
+          close-issue-message: "This issue was closed because it has been marked stale for 20 days with no activity. This does not necessarily mean that the issue is bad, but it most likely means that nobody is willing to take the time to fix it. If you have found Locust useful, then consider contributing a fix yourself!"
+          stale-pr-message: "This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 20 days."
+          close-pr-message: "This PR was closed because it has been marked stale for 20 days with no activity."
+          days-before-close: 20

README.md

@@ -51,7 +51,7 @@ Locust has a user friendly web interface that shows the progress of your test in
 <picture>
 <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-light.png" alt="Locust UI charts" height="100" width="200"/>
 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-dark.png" alt="Locust UI charts" height="100" width="200"/>
-<img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-light.png" alt="Locust UI charts" height="100" width="200"/> 
+<img src="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/bottlenecked-server-light.png" alt="Locust UI charts" height="100" width="200"/>
 </picture>
 <picture>
 <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/locustio/locust/refs/heads/master/docs/images/webui-running-statistics-light.png" alt="Locust UI stats" height="100" width="200"/>

docs/api.rst

@@ -22,6 +22,20 @@ FastHttpUser class
     :members: wait_time, tasks, client, abstract, rest
     :noindex:
 
+PostgresUser class
+==================
+
+.. autoclass:: locust.contrib.postgres.PostgresUser
+    :members: wait_time, tasks, client, abstract
+    :noindex:
+
+MongoDBUser class
+=================
+
+.. autoclass:: locust.contrib.mongodb.MongoDBUser
+    :members: wait_time, tasks, client, abstract, rest
+    :noindex:
+
 TaskSet class
 =============
 

docs/changelog.rst

@@ -4,6 +4,13 @@ Changelog Highlights
 
 For full details of changes, please see https://github.com/locustio/locust/releases or https://github.com/locustio/locust/blob/master/CHANGELOG.md
 
+2.32.7
+======
+* Fix readme image ref links by @changchaishi in https://github.com/locustio/locust/pull/3031
+* Add tab showing `Locust Cloud <https://www.locust.cloud>`_ features https://github.com/locustio/locust/pull/3032
+* Minor UI enhancements https://github.com/locustio/locust/pull/3035, https://github.com/locustio/locust/pull/3036, https://github.com/locustio/locust/pull/3037
+* Code quality: Fix unused imports and switch on related ruff check https://github.com/locustio/locust/pull/3034
+
 2.32.6
 ======
 * Update Dockerfile to use Python 3.12 https://github.com/locustio/locust/pull/3029

docs/configuration.rst

@@ -57,7 +57,7 @@ You can specify an additional file using the ``--config`` flag.
 
 Here's a minimalistic example of the configuration file supported by Locust:
 
-Have a look later in this article for :ref:`All available configuration options`
+Have a look later in this article for `All available configuration options`_
 
 locust.conf
 --------------

docs/quickstart.rst

@@ -32,17 +32,17 @@ Locust's web interface
 
 Open http://localhost:8089
 
-.. image:: images/webui-splash-screenshot.png
+.. image:: images/webui-splash-light.png
 
 | Provide the host name of your server and try it out!
 
 The following screenshots show what it might look like when running this test using 50 concurrent users, with a ramp up rate of 1 user/s
 
-.. image:: images/webui-running-statistics.png
+.. image:: images/webui-running-statistics-light.png
 
 | Under the *Charts* tab you'll find things like requests per second (RPS), response times and number of running users:
 
-.. image:: images/bottlenecked_server.png
+.. image:: images/bottlenecked-server-light.png
 
 .. note::
 

examples/custom_shape/wait_user_count.py

@@ -1,6 +1,5 @@
 from locust import HttpUser, LoadTestShape, TaskSet, constant, task
 
-import math
 import random
 import time
 from collections import namedtuple

examples/dispatch_test_scripts/locustfile.py

@@ -1,7 +1,5 @@
 from locust import HttpUser, LoadTestShape, constant, task
 
-import math
-
 
 class UserA(HttpUser):
     wait_time = constant(600)

examples/events.py

@@ -3,7 +3,7 @@
 track the sum of the content-length header in all successful HTTP responses
 """
 
-from locust import HttpUser, TaskSet, between, events, task, web
+from locust import HttpUser, TaskSet, between, events, task
 
 
 class MyTaskSet(TaskSet):

examples/extend_web_ui.py

@@ -4,14 +4,14 @@
 successful HTTP responses and display them in the web UI.
 """
 
-from locust import HttpUser, TaskSet, between, events, task, web
+from locust import HttpUser, TaskSet, between, events, task
 
 import json
 import os
 from html import escape
 from time import time
 
-from flask import Blueprint, jsonify, make_response, render_template, request
+from flask import Blueprint, make_response, render_template, request
 
 
 class MyTaskSet(TaskSet):

examples/manual_stats_reporting.py

@@ -20,7 +20,7 @@ def my_task(self):
 from locust import User, constant, events, task
 
 import random
-from contextlib import ContextDecorator, contextmanager
+from contextlib import contextmanager
 from time import sleep, time
 
 

examples/mongodb/locustfile.py

@@ -1,4 +1,4 @@
-from locust import between, task
+from locust import task
 from locust.contrib.mongodb import MongoDBUser
 
 import os

examples/postgres/locustfile.py

@@ -1,4 +1,4 @@
-from locust import TaskSet, between, task
+from locust import task
 from locust.contrib.postgres import PostgresUser
 
 import os

examples/terraform/aws/plan/basic.py

@@ -1,7 +1,5 @@
 from locust import HttpUser, between, task
 
-import time
-
 
 class Quickstart(HttpUser):
     wait_time = between(1, 5)

examples/web_ui_cache_stats.py

@@ -4,14 +4,14 @@
 and display them in the web UI.
 """
 
-from locust import HttpUser, TaskSet, between, events, task, web
+from locust import HttpUser, TaskSet, between, events, task
 
 import json
 import os
 from html import escape
 from time import time
 
-from flask import Blueprint, jsonify, make_response, render_template, request
+from flask import Blueprint, make_response, render_template, request
 
 
 class MyTaskSet(TaskSet):

locust/__init__.py

@@ -5,7 +5,7 @@
     print("Uninstall trio package and remove the setting.")
     try:
         # preserve backwards compatibility for now
-        import trio
+        import trio  # noqa: F401
     except ModuleNotFoundError:
         # dont show a massive callstack if trio is not installed
         os._exit(1)
@@ -50,6 +50,9 @@
     "events",
     "LoadTestShape",
     "run_single_user",
+    "HttpLocust",
+    "Locust",
+    "__version__",
 )
 
 # Used for raising a DeprecationWarning if old Locust/HttpLocust is used

locust/argument_parser.py

@@ -10,7 +10,6 @@
 import os
 import platform
 import socket
-import ssl
 import sys
 import tempfile
 import textwrap

locust/contrib/fasthttp.py

@@ -3,7 +3,7 @@
 from locust.env import Environment
 from locust.exception import CatchResponseError, LocustError, ResponseError
 from locust.user import User
-from locust.util.deprecation import DeprecatedFastHttpLocustClass as FastHttpLocust
+from locust.util.deprecation import DeprecatedFastHttpLocustClass as FastHttpLocust  # noqa: F401
 
 import json
 import json as unshadowed_json  # some methods take a named parameter called json

locust/html.py

@@ -1,9 +1,6 @@
-import glob
 import os
-import pathlib
 from html import escape
 from itertools import chain
-from json import dumps
 
 from jinja2 import Environment as JinjaEnvironment
 from jinja2 import FileSystemLoader

locust/main.py

@@ -8,7 +8,6 @@
 import importlib.metadata
 import inspect
 import itertools
-import json
 import logging
 import os
 import signal
@@ -39,12 +38,12 @@
 
 # import external plugins if  installed to allow for registering custom arguments etc
 try:
-    import locust_plugins  # pyright: ignore[reportMissingImports]
+    import locust_plugins  # pyright: ignore[reportMissingImports] # noqa: F401
 except ModuleNotFoundError as e:
     if e.msg != "No module named 'locust_plugins'":
         raise
 try:
-    import locust_cloud  # pyright: ignore[reportMissingImports]
+    import locust_cloud  # pyright: ignore[reportMissingImports] # noqa: F401
 
     locust_cloud_version = f" (locust-cloud {importlib.metadata.version('locust-cloud')})"
 except ModuleNotFoundError as e:

locust/rpc/__init__.py

@@ -1,2 +1,7 @@
+__all__ = (
+    "Message",
+    "rpc",
+)
+
 from . import zmqrpc as rpc
 from .protocol import Message

locust/runners.py

@@ -1002,7 +1002,7 @@ def client_listener(self) -> NoReturn:
                 elif msg.data != __version__ and msg.data != -1:
                     if msg.data[0:4] == __version__[0:4]:
                         logger.debug(
-                            f"A worker ({client_id}) running a different patch version ({msg.data}) connected, master version is {__version__}"
+                            f"A worker ({client_id}) running a different patch version ({repr(msg.data)}) connected, master version is {repr(__version__)}"
                         )
                     else:
                         logger.warning(

locust/test/test_fasthttp.py

@@ -1,5 +1,4 @@
 from locust import FastHttpUser
-from locust.argument_parser import parse_options
 from locust.contrib.fasthttp import FastHttpSession
 from locust.exception import CatchResponseError, InterruptTaskSet, LocustError, ResponseError
 from locust.user import TaskSet, task

locust/test/test_load_locustfile.py

@@ -6,7 +6,6 @@
 
 import filecmp
 import os
-import pathlib
 import textwrap
 
 from .mock_locustfile import MOCK_LOCUSTFILE_CONTENT, mock_locustfile

locust/test/test_main.py

@@ -9,7 +9,7 @@
 import sys
 import textwrap
 import unittest
-from subprocess import DEVNULL, PIPE, STDOUT
+from subprocess import PIPE, STDOUT
 from tempfile import TemporaryDirectory
 from unittest import TestCase
 

locust/test/test_parser.py

@@ -10,7 +10,6 @@
 import os
 import unittest
 from io import StringIO
-from random import randint
 from tempfile import NamedTemporaryFile, TemporaryDirectory
 from unittest import mock
 

locust/test/test_sequential_taskset.py

@@ -1,4 +1,4 @@
-from locust import User, constant, task
+from locust import User, task
 from locust.exception import RescheduleTask
 from locust.user.sequential_taskset import SequentialTaskSet
 

locust/test/test_wait_time.py

@@ -1,5 +1,4 @@
 from locust import TaskSet, User, between, constant, constant_throughput
-from locust.exception import MissingWaitTimeError
 
 import random
 import time

locust/test/test_web.py

@@ -10,24 +10,19 @@
 from locust.user import User, task
 from locust.web import WebUI
 
-import copy
 import csv
 import json
 import logging
 import os
-import re
-import textwrap
 import traceback
 from io import StringIO
-from tempfile import NamedTemporaryFile, TemporaryDirectory
+from tempfile import NamedTemporaryFile
 
 import gevent
 import requests
 from flask_login import UserMixin
 from pyquery import PyQuery as pq
 
-from ..util.load_locustfile import load_locustfile
-from .mock_locustfile import mock_locustfile
 from .testcases import LocustTestCase
 from .util import create_tls_cert
 

locust/test/test_zmqrpc.py

@@ -1,4 +1,4 @@
-from locust.exception import RPCError, RPCReceiveError, RPCSendError
+from locust.exception import RPCError, RPCSendError
 from locust.rpc import Message, zmqrpc
 from locust.test.testcases import LocustTestCase
 

locust/user/__init__.py

@@ -1,2 +1,9 @@
+__all__ = (
+    "HttpUser",
+    "tag",
+    "task",
+    "TaskSet",
+    "User",
+)
 from .task import TaskSet, tag, task
 from .users import HttpUser, User

locust/web.py

@@ -10,7 +10,6 @@
 from io import StringIO
 from itertools import chain
 from json import dumps
-from time import time
 from typing import TYPE_CHECKING, Any, TypedDict
 
 import gevent

locust/webui/src/components/LineChart/LineChart.tsx

@@ -1,5 +1,12 @@
 import { useEffect, useState, useRef } from 'react';
-import { init, dispose, ECharts, connect } from 'echarts';
+import {
+  init,
+  dispose,
+  ECharts,
+  connect,
+  XAXisComponentOption,
+  GridComponentOption,
+} from 'echarts';
 
 import { CHART_THEME } from 'components/LineChart/LineChart.constants';
 import {
@@ -21,6 +28,8 @@ interface IBaseChartType extends ILineChartMarkers, ILineChartTimeAxis {
 
 interface ILineChartProps<ChartType extends IBaseChartType> extends ILineChart<ChartType> {
   shouldReplaceMergeLines?: boolean;
+  xAxis?: XAXisComponentOption;
+  grid?: GridComponentOption;
 }
 
 export default function LineChart<ChartType extends IBaseChartType>({
@@ -31,6 +40,8 @@ export default function LineChart<ChartType extends IBaseChartType>({
   chartValueFormatter,
   splitAxis,
   yAxisLabels,
+  xAxis,
+  grid,
   scatterplot,
   shouldReplaceMergeLines = false,
 }: ILineChartProps<ChartType>) {
@@ -55,6 +66,8 @@ export default function LineChart<ChartType extends IBaseChartType>({
         chartValueFormatter,
         splitAxis,
         yAxisLabels,
+        xAxis,
+        grid,
         scatterplot,
       }),
     );

locust/webui/src/components/LineChart/LineChart.types.ts

@@ -14,6 +14,8 @@ export interface ILineChart<ChartType> {
   chartValueFormatter?: (value?: any) => string | number;
   splitAxis?: boolean;
   yAxisLabels?: string | [string, string];
+  grid?: any;
+  xAxis?: any;
   scatterplot?: boolean;
 }
 

locust/webui/src/components/LineChart/LineChart.utils.ts

@@ -78,6 +78,8 @@ export const createOptions = <ChartType extends Pick<ICharts, 'time'>>({
   chartValueFormatter,
   splitAxis,
   yAxisLabels,
+  xAxis,
+  grid,
   scatterplot,
 }: ILineChart<ChartType>) => ({
   title: { text: title },
@@ -106,15 +108,17 @@ export const createOptions = <ChartType extends Pick<ICharts, 'time'>>({
     },
     borderWidth: 0,
   },
-  xAxis: {
-    type: 'time',
-    min: (charts.time || [new Date().toISOString()])[0],
-    startValue: (charts.time || [])[0],
-    axisLabel: {
-      formatter: formatTimeAxis,
-    },
-  },
-  grid: { left: 60, right: 40 },
+  xAxis: xAxis
+    ? xAxis
+    : {
+        type: 'time',
+        min: (charts.time || [new Date().toISOString()])[0],
+        startValue: (charts.time || [])[0],
+        axisLabel: {
+          formatter: formatTimeAxis,
+        },
+      },
+  grid: grid ? grid : { left: 60, right: 40 },
   yAxis: createYAxis({ splitAxis, yAxisLabels }),
   series: getSeriesData<ChartType>({ charts, lines, scatterplot }),
   color: colors,

locust/webui/src/components/LineChart/tests/LineChartUtils.test.tsx

@@ -178,6 +178,32 @@ describe('createOptions', () => {
     expect(options.series).toEqual(mockScatterplotSeriesData);
     expect(options.color).toEqual(['#fff']);
   });
+
+  test('should allow xAxis config to be overriden', () => {
+    const mockXAxisConfig = {
+      type: 'category' as any,
+      minInterval: 1,
+    };
+    const options = createOptions<MockChartType>({
+      ...createOptionsDefaultProps,
+      xAxis: mockXAxisConfig,
+    });
+
+    expect(options.xAxis).toEqual(mockXAxisConfig);
+  });
+
+  test('should allow grid config to be overriden', () => {
+    const mockGridConfig = {
+      left: '6%',
+      right: '6%',
+    };
+    const options = createOptions<MockChartType>({
+      ...createOptionsDefaultProps,
+      grid: mockGridConfig,
+    });
+
+    expect(options.grid).toEqual(mockGridConfig);
+  });
 });
 
 describe('createMarkLine', () => {

locust/webui/src/components/LocustCloudTab/LocustCloudTab.tsx

@@ -0,0 +1,60 @@
+import { Box, Link, Typography } from '@mui/material';
+
+import Markdown from 'components/Markdown/Markdown';
+import { useSelector } from 'redux/hooks';
+
+const firstParagraph = `
+Ready to take your load tests to the next level? With [Locust Cloud](locust.cloud), we take care of everything!
+\n
+Whether your doing small load, or needing to generate millions of requests, we take care of the
+load generation. 
+\n
+Not sure where to start? Get professional load test consultation! We have over 20 years of experience load testing in a wide array of industries!
+\n
+Locust Cloud comes powered with a suite of features, including advanced graphs, stored testruns, open telemetry, and so much more!
+`;
+
+export default function LocustCloudTab() {
+  const isDarkMode = useSelector(({ theme: { isDarkMode } }) => isDarkMode);
+
+  return (
+    <Box>
+      <Box sx={{ mb: 2 }}>
+        <Typography component='h2' mb={1} variant='h4'>
+          Power Up Your Load Tests!
+        </Typography>
+        <Markdown content={firstParagraph} />
+      </Box>
+      <ul>
+        <li>
+          <Typography sx={{ mb: 2 }}>
+            Our main graphs offer a concise view of the most vital stats, and go further by allowing
+            you to dig into data for each requests in your testrun
+          </Typography>
+          {isDarkMode ? (
+            <img src='/assets/graphs-dark.png' width='100%' />
+          ) : (
+            <img src='/assets/graphs-light.png' width='100%' />
+          )}
+        </li>
+        <li>
+          <Typography sx={{ mb: 2 }}>
+            The testruns tab offers a detailed overview of how your system has performed
+            historically. This allows you to easily track and detect any changes in the performance
+            of your system.
+          </Typography>
+          {isDarkMode ? (
+            <img src='/assets/testruns-dark.png' width='100%' />
+          ) : (
+            <img src='/assets/testruns-light.png' width='100%' />
+          )}
+          <Typography>
+            Vist us at{' '}
+            <Link href='https://www.locust.cloud/get-started?plan=basic'>locust.cloud</Link> for a
+            free consultation today!
+          </Typography>
+        </li>
+      </ul>
+    </Box>
+  );
+}

locust/webui/src/components/Tabs/Tabs.constants.tsx

@@ -1,5 +1,6 @@
 import ExceptionsTab from 'components/ExceptionsTab/ExceptionsTab';
 import FailuresTable from 'components/FailuresTable/FailuresTable';
+import LocustCloudTab from 'components/LocustCloudTab/LocustCloudTab';
 import LogViewer from 'components/LogViewer/LogViewer';
 import Reports from 'components/Reports/Reports';
 import StatsTable from 'components/StatsTable/StatsTable';
@@ -52,6 +53,11 @@ export const tabConfig = {
     title: 'Workers',
     shouldDisplayTab: (state: IRootState) => state.swarm.isDistributed,
   },
+  locustCloud: {
+    component: LocustCloudTab,
+    key: 'locustcloud',
+    title: 'Locust Cloud',
+  },
 };
 
 export const baseTabs: ITab[] = [
@@ -63,4 +69,5 @@ export const baseTabs: ITab[] = [
   tabConfig.reports,
   tabConfig.logs,
   tabConfig.workers,
+  tabConfig.locustCloud,
 ];

locust/webui/src/hooks/tests/useSortByField.test.tsx

@@ -1,3 +1,4 @@
+import { useState } from 'react';
 import { act, render } from '@testing-library/react';
 import { describe, expect, test } from 'vitest';
 
@@ -21,13 +22,12 @@ function MockHook({
   hasTotalRow?: boolean;
   defaultSortKey?: keyof (typeof mockStats)[0];
 }) {
-  const { onTableHeadClick, sortedRows, currentSortField } = useSortByField(
-    hasTotalRow ? mockStatsWithTotalRow : mockStats,
-    {
-      hasTotalRow,
-      defaultSortKey,
-    },
-  );
+  const [stats, setStats] = useState(hasTotalRow ? mockStatsWithTotalRow : mockStats);
+
+  const { onTableHeadClick, sortedRows, currentSortField } = useSortByField(stats, {
+    hasTotalRow,
+    defaultSortKey,
+  });
 
   return (
     <div>
@@ -45,6 +45,9 @@ function MockHook({
       >
         Sort by numFailures
       </button>
+      <button data-testid='emptyStats' onClick={() => setStats([])}>
+        Empty stats
+      </button>
       <span data-testid='sortedStats'>{JSON.stringify(sortedRows)}</span>
       <span data-testid='currentSortField'>{currentSortField}</span>
     </div>
@@ -127,4 +130,16 @@ describe('useSortByField', () => {
     expect(getByTestId('sortedStats').textContent).toBe(JSON.stringify(mockStats));
     expect(getByTestId('currentSortField').textContent).toBe('');
   });
+
+  test('should allow the sorted rows to be set to empty', () => {
+    const { getByTestId } = render(<MockHook />);
+
+    expect(getByTestId('sortedStats').textContent).toBe(JSON.stringify(mockStats));
+
+    act(() => {
+      getByTestId('emptyStats').click();
+    });
+
+    expect(getByTestId('sortedStats').textContent).toBe(JSON.stringify([]));
+  });
 });

locust/webui/src/hooks/useSortByField.ts

@@ -77,6 +77,9 @@ export default function useSortByField<Row>(
   useEffect(() => {
     if (rows.length) {
       sortStats(currentSortField.current || defaultSortKey);
+    } else if (sortStats.length) {
+      // allows tables to be empty in the case of filtering
+      setSortedRows(rows);
     }
   }, [rows]);
 

locust/webui/src/pages/Auth.tsx

@@ -76,6 +76,9 @@ export default function Auth({
         {info && !customForm && !usernamePasswordCallback && (
           <Alert severity='info'>{<Markdown content={info} />}</Alert>
         )}
+        {error && !customForm && !usernamePasswordCallback && (
+          <Alert severity='error'>{<Markdown content={error} />}</Alert>
+        )}
         {authProviders && (
           <Box sx={{ display: 'flex', flexDirection: 'column', rowGap: 1 }}>
             {authProviders.map(({ label, callbackUrl, iconUrl }, index) => (

locust/webui/src/styles/theme.ts

@@ -17,9 +17,8 @@ const createTheme = (mode: PaletteMode) =>
           ':root': {
             '--footer-height': '40px',
           },
-          p: {
-            margin: 0,
-          },
+          p: { margin: 0 },
+          ul: { paddingLeft: '16px' },
         },
       },
     },

locust/webui/vite.lib.config.ts

@@ -11,6 +11,7 @@ export default defineConfig((config: UserConfig) => ({
     dts({
       outDir: './lib/types',
       exclude: ['**/*.test.ts', '**/*.test.tsx', '**/test', '**/tests'],
+      rollupTypes: true,
     }),
     config.mode !== 'production' &&
       config.mode !== 'test' &&

pyproject.toml

@@ -193,7 +193,7 @@ extend-exclude = [
     "examples/issue_*.py",
     "src/readthedocs-sphinx-search/",
 ]
-lint.ignore = ["E402", "E501", "E713", "E731", "E741", "F401"]
+lint.ignore = ["E402", "E501", "E713", "E731", "E741"]
 lint.select = ["E", "F", "W", "UP", "FA102", "I001"]
 
 [tool.ruff.lint.per-file-ignores]