robotframework-dashboard 1.8.2__tar.gz → 2.0.0__tar.gz

{robotframework_dashboard-1.8.2/robotframework_dashboard.egg-info → robotframework_dashboard-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-dashboard
-Version: 1.8.2
+Version: 2.0.0
 Summary: Output processor and dashboard generator for Robot Framework output files
 Home-page: https://github.com/marketsquare/robotframework-dashboard
 Author: Tim de Groot

{robotframework_dashboard-1.8.2 → robotframework_dashboard-2.0.0}/README.md

@@ -82,6 +82,20 @@ For detailed usage instructions, advanced examples, and full documentation, visi
 - 🗄️ [**Custom Database Class**](https://marketsquare.github.io/robotframework-dashboard/custom-database-class.html) - Extend or replace the default database backend to suit your storage needs, including SQLite, MySQL, or custom implementations.
 - 🔔 [**Listener Integration**](https://marketsquare.github.io/robotframework-dashboard/listener-integration.html) - Use a listener to automatically push test results to the dashboard for every executed run, integrating seamlessly into CI/CD pipelines.
 - 📂 [**Log Linking**](https://marketsquare.github.io/robotframework-dashboard/log-linking.html) - Enable clickable log navigation from dashboard graphs, covering file naming conventions, local and server usage, and remote log uploads.
+- 📈 [**Performance**](https://marketsquare.github.io/robotframework-dashboard/performance.html) - Performance results across different workload sizes, guidance on scaling to hundreds of runs, and tips for large result sets.
+
+
+## 📈 Performance
+
+robotframework-dashboard is designed to stay fast even as your result set grows. Key characteristics:
+
+- **XML processing** scales linearly with file size — the `robot.api` parser is the bottleneck, not the dashboard code itself. Typical runs process in **under 1 second each**.
+- **Dashboard generation** is nearly always **under 1 second** regardless of scale — data is already aggregated in the database, so re-generating HTML after adding new runs is essentially free.
+- **Incremental processing** — output files already in the database are automatically skipped, so you can safely re-run against a folder of XMLs without re-processing old results.
+- **HTML size** stays modest (~500 KB–1 MB for typical workloads) thanks to zlib compression of the embedded data.
+- **Dashboard rendering** (Chart.js in the browser) depends on how many runs are displayed. The default limit is **20 runs** (near-instant). Raising it to **50 runs** takes a few seconds as Chart.js renders all graphs. At **100+ runs**, initial rendering can approach **~10 seconds or more!**. This is also affected by your suite and test size — selecting **"All Suites"** or **"All Tests"** in their respective sections amplifies render time significantly, since each unique name becomes a separate data series. Use the quantity filter to keep the displayed run count manageable.
+
+For detailed results and scaling guidance, see the [Performance docs](https://marketsquare.github.io/robotframework-dashboard/performance.html).
 
 
 ## 🛠️ Contributions

{robotframework_dashboard-1.8.2 → robotframework_dashboard-2.0.0}/robotframework_dashboard/abstractdb.py

@@ -35,7 +35,7 @@ class AbstractDatabaseProcessor(ABC):
 
     @abstractmethod
     def insert_output_data(
-        self, output_data: dict, tags: list, run_alias: str, path: Path, project_version: str, timezone: str = ""
+        self, output_data: dict, tags: list, run_alias: str, path: Path, project_version: str, custom_filters, timezone
     ) -> None:
         """Mandatory: This function inserts the data of an output file into the database"""
         pass  # pragma: no cover