NAME

Bencher::Scenario::URIEscaping - Benchmark URI escaping using various modules

VERSION

This document describes version 0.005 of Bencher::Scenario::URIEscaping (from Perl distribution Bencher-Scenario-URIEscaping), released on 2020-06-18.

SYNOPSIS

To run benchmark with default option:

% bencher -m URIEscaping

To run module startup overhead benchmark:

% bencher --module-startup -m URIEscaping

For more options (dump scenario, list/include/exclude/add participants, list/include/exclude/add datasets, etc), see bencher or run bencher --help.

DESCRIPTION

Packaging a benchmark script as a Bencher scenario makes it convenient to include/exclude/add participants/datasets (either via CLI or Perl code), send the result to a central repository, among others . See Bencher and bencher (CLI) for more details.

BENCHMARKED MODULES

Version numbers shown below are the versions used when running the sample benchmark.

URI::Escape 3.31

URI::XSEscape 0.001000

URI::Escape::XS 0.14

URI::Encode 1.1.1

URI::Encode::XS 0.11

BENCHMARK PARTICIPANTS

URI::Escape::uri_escape (perl_code) [escape]

Function call template:
```
URI::Escape::uri_escape(<str>)
```
URI::Escape::uri_escape_utf8 (perl_code) [escape, utf8]

Function call template:
```
URI::Escape::uri_escape_utf8(<str>)
```
URI::Escape::uri_unescape (perl_code) [unescape]

Function call template:
```
URI::Escape::uri_unescape(<str>)
```
URI::XSEscape::uri_escape (perl_code) [escape]

Function call template:
```
URI::XSEscape::uri_escape(<str>)
```
URI::XSEscape::uri_escape_utf8 (perl_code) [escape, utf8]

Function call template:
```
URI::XSEscape::uri_escape_utf8(<str>)
```
URI::XSEscape::uri_unescape (perl_code) [unescape]

Function call template:
```
URI::XSEscape::uri_unescape(<str>)
```
URI::Escape::XS::uri_escape (perl_code) [escape]

Function call template:
```
URI::Escape::XS::uri_escape(<str>)
```
URI::Escape::XS::uri_unescape (perl_code) [unescape]

Function call template:
```
URI::Escape::XS::uri_unescape(<str>)
```
URI::Encode::uri_encode (perl_code) [escape]

Function call template:
```
URI::Encode::uri_encode(<str>)
```
URI::Encode::uri_decode (perl_code) [unescape]

Function call template:
```
URI::Encode::uri_decode(<str>)
```
URI::Encode::XS::uri_encode (perl_code) [escape]

Function call template:
```
URI::Encode::XS::uri_encode(<str>)
```
URI::Encode::XS::uri_decode (perl_code) [unescape]

Function call template:
```
URI::Encode::XS::uri_decode(<str>)
```

BENCHMARK DATASETS

empty [escape]
ascii53 [escape]
utf36 [escape, utf8]
u_ascii53 [unescape]
ascii66 [escape]
u_ascii66 [unescape]

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.30.2, CPU: Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz (4 cores), OS: GNU/Linux LinuxMint version 19, OS kernel: Linux version 4.15.0-91-generic.

Benchmark with default options (bencher -m URIEscaping):

#table1#
+--------------------------------+-----------+--------------+--------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                    | dataset   | ds_tags      | p_tags       | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+--------------------------------+-----------+--------------+--------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| URI::Encode::uri_decode        | u_ascii53 | unescape     | unescape     |      3600 |  280      |                 0.00% |            834128.52% | 4.5e-07 |      23 |
| URI::Encode::uri_encode        | ascii53   | escape       | escape       |      3600 |  280      |                 0.32% |            831493.00% | 4.2e-07 |      21 |
| URI::Encode::uri_encode        | ascii66   | escape       | escape       |      3600 |  280      |                 1.28% |            823568.11% | 6.6e-07 |      22 |
| URI::Encode::uri_decode        | u_ascii66 | unescape     | unescape     |      3700 |  270      |                 2.58% |            813173.26% | 4.8e-07 |      20 |
| URI::Encode::uri_encode        | empty     | escape       | escape       |      3800 |  260      |                 6.14% |            785883.33% | 4.8e-07 |      20 |
| URI::Escape::uri_escape_utf8   | ascii53   | escape       | escape, utf8 |    140000 |    7.15   |              3816.41% |             21200.83% | 2.7e-09 |      30 |
| URI::Escape::uri_escape        | ascii53   | escape       | escape       |    144000 |    6.93   |              3936.82% |             20565.50% | 3.3e-09 |      20 |
| URI::Escape::uri_unescape      | u_ascii53 | unescape     | unescape     |    164390 |    6.083  |              4501.06% |             18031.23% | 2.5e-11 |      24 |
| URI::Escape::uri_escape_utf8   | utf36     | escape, utf8 | escape, utf8 |    168000 |    5.97   |              4589.58% |             17688.97% | 1.5e-09 |      26 |
| URI::Escape::uri_escape_utf8   | ascii66   | escape       | escape, utf8 |    219000 |    4.57   |              6026.25% |             13517.27% | 1.5e-09 |      24 |
| URI::Escape::uri_escape        | ascii66   | escape       | escape       |    230000 |    4.35   |              6332.56% |             12868.85% | 1.6e-09 |      23 |
| URI::Escape::uri_unescape      | u_ascii66 | unescape     | unescape     |    280000 |    3.6    |              7604.67% |             10727.56% |   5e-09 |      20 |
| URI::Escape::uri_escape_utf8   | empty     | escape       | escape, utf8 |   1700000 |    0.59   |             47092.42% |              1667.72% | 8.3e-10 |      20 |
| URI::Escape::XS::uri_escape    | ascii53   | escape       | escape       |   2500000 |    0.41   |             68577.90% |              1114.70% | 5.5e-10 |      26 |
| URI::Escape::XS::uri_escape    | ascii66   | escape       | escape       |   2462000 |    0.4062 |             68799.80% |              1110.79% | 2.4e-11 |      31 |
| URI::Escape::uri_escape        | empty     | escape       | escape       |   2508000 |    0.3987 |             70104.43% |              1088.28% | 2.2e-11 |      20 |
| URI::XSEscape::uri_escape_utf8 | ascii66   | escape       | escape, utf8 |   2690000 |    0.372  |             75194.07% |              1007.96% | 2.1e-10 |      20 |
| URI::XSEscape::uri_escape_utf8 | ascii53   | escape       | escape, utf8 |   2730000 |    0.366  |             76397.44% |               990.53% | 1.7e-10 |      31 |
| URI::Escape::XS::uri_unescape  | u_ascii53 | unescape     | unescape     |   2862000 |    0.3494 |             79994.19% |               941.56% | 1.7e-11 |      20 |
| URI::XSEscape::uri_escape_utf8 | utf36     | escape, utf8 | escape, utf8 |   2976000 |    0.336  |             83197.91% |               901.50% | 2.4e-11 |      20 |
| URI::Escape::XS::uri_escape    | empty     | escape       | escape       |   3051000 |    0.3278 |             85291.12% |               876.95% | 5.8e-12 |      23 |
| URI::Escape::XS::uri_unescape  | u_ascii66 | unescape     | unescape     |   3150000 |    0.317  |             88177.67% |               845.01% | 1.1e-10 |      20 |
| URI::XSEscape::uri_escape_utf8 | empty     | escape       | escape, utf8 |   3750000 |    0.267  |            104754.54% |               695.61% | 8.6e-11 |      32 |
| URI::XSEscape::uri_unescape    | u_ascii53 | unescape     | unescape     |   4920000 |    0.203  |            137523.90% |               506.17% | 2.4e-11 |      20 |
| URI::XSEscape::uri_unescape    | u_ascii66 | unescape     | unescape     |   4983000 |    0.2007 |            139356.66% |               498.20% | 1.7e-11 |      20 |
| URI::XSEscape::uri_escape      | ascii66   | escape       | escape       |   5500000 |    0.18   |            152651.86% |               446.13% | 2.7e-10 |      27 |
| URI::XSEscape::uri_escape      | ascii53   | escape       | escape       |   5700000 |    0.18   |            159472.86% |               422.79% | 2.6e-10 |      29 |
| URI::XSEscape::uri_escape      | empty     | escape       | escape       |  10000000 |    0.1    |            278783.59% |               199.13% | 1.6e-10 |      20 |
| URI::Encode::XS::uri_encode    | ascii53   | escape       | escape       |  12000000 |    0.083  |            335845.34% |               148.32% | 2.1e-10 |      20 |
| URI::Encode::XS::uri_encode    | ascii66   | escape       | escape       |  12000000 |    0.0831 |            336757.14% |               147.65% | 2.4e-11 |      24 |
| URI::Encode::XS::uri_decode    | u_ascii66 | unescape     | unescape     |  12000000 |    0.083  |            336990.50% |               147.48% | 2.1e-10 |      20 |
| URI::Encode::XS::uri_decode    | u_ascii53 | unescape     | unescape     |  12700000 |    0.0789 |            354725.57% |               135.11% |   6e-11 |      23 |
| URI::Encode::XS::uri_encode    | empty     | escape       | escape       |  30000000 |    0.034  |            834128.52% |                 0.00% | 7.8e-11 |      20 |
+--------------------------------+-----------+--------------+--------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Benchmark module startup overhead (bencher -m URIEscaping --module-startup):

#table2#
+---------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+
| participant         | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors   | samples |
+---------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+
| URI::Encode         |      20   |              15   |                 0.00% |               241.33% |   0.00021 |      20 |
| URI::Escape         |      10   |               5   |                71.67% |                98.83% |   0.00024 |      20 |
| URI::Encode::XS     |       8   |               3   |               118.60% |                56.14% |   0.00012 |      20 |
| URI::Escape::XS     |       8   |               3   |               128.19% |                49.58% |   0.00011 |      21 |
| URI::XSEscape       |       5.8 |               0.8 |               198.63% |                14.30% | 2.2e-05   |      20 |
| perl -e1 (baseline) |       5   |               0   |               241.33% |                 0.00% |   0.00014 |      20 |
+---------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

BENCHMARK NOTES

URI::Encode::XS is the fastest, but it does not support custom list of safe characters. If you don't want to encode / as %2F, for example, you're out of luck. For URI escaping with custom character list support, the fastest is URI::XSEscape followed by URI::Escape::XS.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher-Scenario-URIEscaping.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenario-URIEscaping.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher-Scenario-URIEscaping

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install Bencher::Scenario::URIEscaping, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Bencher::Scenario::URIEscaping

CPAN shell

perl -MCPAN -e shell
install Bencher::Scenario::URIEscaping

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)