duel 0.1.8 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +146 -1
  3. data/README.md +35 -0
  4. data/docs/ci.md +96 -3
  5. data/docs/configuration.md +35 -1
  6. data/docs/how-it-works.md +14 -8
  7. data/docs/plugins.md +16 -0
  8. data/lib/duel/across.rb +1 -6
  9. data/lib/duel/baseline.rb +8 -7
  10. data/lib/duel/cli.rb +45 -19
  11. data/lib/duel/comment.rb +71 -10
  12. data/lib/duel/config.rb +113 -2
  13. data/lib/duel/context.rb +33 -34
  14. data/lib/duel/control.rb +52 -0
  15. data/lib/duel/init.rb +142 -18
  16. data/lib/duel/lane.rb +734 -0
  17. data/lib/duel/lock.rb +34 -4
  18. data/lib/duel/memory.rb +14 -5
  19. data/lib/duel/metric.rb +97 -26
  20. data/lib/duel/native.rb +199 -32
  21. data/lib/duel/platform.rb +31 -0
  22. data/lib/duel/process_sample.rb +74 -49
  23. data/lib/duel/resource.rb +71 -42
  24. data/lib/duel/result.rb +165 -0
  25. data/lib/duel/rubies.rb +21 -3
  26. data/lib/duel/runner.rb +13 -1039
  27. data/lib/duel/spawn.rb +327 -0
  28. data/lib/duel/summary.rb +10 -10
  29. data/lib/duel/templates/perf-caller.yml.erb +43 -0
  30. data/lib/duel/templates/perf-comment-caller.yml.erb +42 -0
  31. data/lib/duel/templates/perf-comment.yml.erb +45 -3
  32. data/lib/duel/templates/perf.yml.erb +143 -7
  33. data/lib/duel/testing.rb +3 -0
  34. data/lib/duel/version.rb +1 -1
  35. data/lib/duel/worker.rb +13 -4
  36. data/lib/duel/worker_process.rb +142 -0
  37. data/lib/duel.rb +27 -3
  38. data/sig/duel/cli.rbs +8 -0
  39. data/sig/duel/comment.rbs +16 -1
  40. data/sig/duel/config.rbs +52 -2
  41. data/sig/duel/context.rbs +4 -31
  42. data/sig/duel/control.rbs +27 -0
  43. data/sig/duel/init.rbs +56 -0
  44. data/sig/duel/lane.rbs +202 -0
  45. data/sig/duel/lock.rbs +8 -1
  46. data/sig/duel/memory.rbs +1 -1
  47. data/sig/duel/metric.rbs +53 -10
  48. data/sig/duel/native.rbs +109 -9
  49. data/sig/duel/platform.rbs +13 -0
  50. data/sig/duel/process_sample.rbs +7 -9
  51. data/sig/duel/resource.rbs +28 -9
  52. data/sig/duel/result.rbs +164 -0
  53. data/sig/duel/rubies.rbs +4 -0
  54. data/sig/duel/runner.rbs +3 -460
  55. data/sig/duel/spawn.rbs +111 -0
  56. data/sig/duel/summary.rbs +3 -2
  57. data/sig/duel/worker_process.rbs +90 -0
  58. data/sig/duel.rbs +17 -3
  59. metadata +121 -107
data/sig/duel.rbs CHANGED
@@ -6,6 +6,11 @@ module Duel
6
6
  class Error < StandardError
7
7
  end
8
8
 
9
+ # What Duel raises when something a run needs fails: a resource that
10
+ # didn't start, a worker that died or hung.
11
+ class Failed < Error
12
+ end
13
+
9
14
  # What a benchmark is judged on, if not both its timings and its
10
15
  # counts (see DSL#duel).
11
16
  type only = :count | :timing
@@ -166,9 +171,8 @@ module Duel
166
171
  # @api private
167
172
  def self.measured: [T] (bool measuring) { () -> T } -> T
168
173
 
169
- # Loads a config file (.duel.rb): a fresh configuration, rooted where
170
- # the file is.
171
- # @api private
174
+ # Loads a config file (.duel.rb) and returns its configuration, which
175
+ # is Duel.config from then on.
172
176
  def self.load_config: (String path) -> Config
173
177
 
174
178
  # Where +method+ is defined ("file:line"), or whose it is.
@@ -201,6 +205,16 @@ module Duel
201
205
  # @api private
202
206
  def self.plugins: () -> Hash[Symbol, Module & _Plugin]
203
207
 
208
+ # Whether a server that a plugin starts for a worker can listen on a
209
+ # Unix socket that a worker can reach: not on Windows, nor where Ruby
210
+ # has none. Where it can't, the server listens on a port (see
211
+ # Resource#port).
212
+ def self.unix_sockets?: () -> bool
213
+
214
+ # Whether Duel runs on Windows: for a plugin to do what it does
215
+ # differently there.
216
+ def self.windows?: () -> bool
217
+
204
218
  self.@defining_file: String?
205
219
 
206
220
  # The file of benchmarks that called the DSL method running, if one is.
metadata CHANGED
@@ -1,132 +1,146 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: duel
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.8
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
- - Erik Berlin
7
+ - Erik Berlin
8
8
  bindir: exe
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies:
12
- - !ruby/object:Gem::Dependency
13
- name: fiddle
14
- requirement: !ruby/object:Gem::Requirement
15
- requirements:
16
- - - "~>"
17
- - !ruby/object:Gem::Version
18
- version: '1.1'
19
- type: :runtime
20
- prerelease: false
21
- version_requirements: !ruby/object:Gem::Requirement
22
- requirements:
23
- - - "~>"
24
- - !ruby/object:Gem::Version
25
- version: '1.1'
26
- description: Duel runs your benchmarks on two versions of your code side by side,
27
- the baseline (where your branch left main, say) and the candidate, and fails if
28
- the candidate is slower at any of them. Timings are judged by a distribution-free
29
- confidence interval for paired CPU-time ratios and confirmed in fresh processes,
30
- so it fails on real regressions, not noise.
12
+ - !ruby/object:Gem::Dependency
13
+ name: fiddle
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ -
17
+ - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: "1.1"
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ -
25
+ - ~>
26
+ - !ruby/object:Gem::Version
27
+ version: "1.1"
28
+ description: "Duel runs your benchmarks on two versions of your code side by side, the baseline (where your branch left main, say) and the candidate, and fails if the candidate is slower at any of them. Timings are judged by a distribution-free confidence interval for paired CPU-time ratios and confirmed in fresh processes, so it fails on real regressions, not noise."
31
29
  email:
32
- - sferik@gmail.com
30
+ - sferik@gmail.com
33
31
  executables:
34
- - duel
32
+ - duel
35
33
  extensions: []
36
34
  extra_rdoc_files: []
37
35
  files:
38
- - AGENT_PROMPT.md
39
- - CHANGELOG.md
40
- - LICENSE
41
- - README.md
42
- - docs/README.md
43
- - docs/benchmarks.md
44
- - docs/ci.md
45
- - docs/configuration.md
46
- - docs/how-it-works.md
47
- - docs/json.md
48
- - docs/plugins.md
49
- - docs/troubleshooting.md
50
- - exe/duel
51
- - lib/duel.rb
52
- - lib/duel/across.rb
53
- - lib/duel/baseline.rb
54
- - lib/duel/cli.rb
55
- - lib/duel/comment.rb
56
- - lib/duel/config.rb
57
- - lib/duel/context.rb
58
- - lib/duel/init.rb
59
- - lib/duel/json_report.rb
60
- - lib/duel/lock.rb
61
- - lib/duel/memory.rb
62
- - lib/duel/message.rb
63
- - lib/duel/metric.rb
64
- - lib/duel/native.rb
65
- - lib/duel/process_sample.rb
66
- - lib/duel/profile.rb
67
- - lib/duel/rake_task.rb
68
- - lib/duel/resource.rb
69
- - lib/duel/rubies.rb
70
- - lib/duel/runner.rb
71
- - lib/duel/stats.rb
72
- - lib/duel/summary.rb
73
- - lib/duel/templates/benchmark_duel.rb.erb
74
- - lib/duel/templates/duel.gitlab-ci.yml.erb
75
- - lib/duel/templates/duel.rb.erb
76
- - lib/duel/templates/perf-comment.yml.erb
77
- - lib/duel/templates/perf.yml.erb
78
- - lib/duel/testing.rb
79
- - lib/duel/version.rb
80
- - lib/duel/worker.rb
81
- - sig/duel.rbs
82
- - sig/duel/across.rbs
83
- - sig/duel/baseline.rbs
84
- - sig/duel/cli.rbs
85
- - sig/duel/comment.rbs
86
- - sig/duel/config.rbs
87
- - sig/duel/context.rbs
88
- - sig/duel/init.rbs
89
- - sig/duel/json_report.rbs
90
- - sig/duel/lock.rbs
91
- - sig/duel/memory.rbs
92
- - sig/duel/message.rbs
93
- - sig/duel/metric.rbs
94
- - sig/duel/native.rbs
95
- - sig/duel/process_sample.rbs
96
- - sig/duel/profile.rbs
97
- - sig/duel/rake_task.rbs
98
- - sig/duel/resource.rbs
99
- - sig/duel/rubies.rbs
100
- - sig/duel/runner.rbs
101
- - sig/duel/stats.rbs
102
- - sig/duel/summary.rbs
103
- - sig/duel/testing.rbs
104
- - sig/duel/version.rbs
105
- - sig/duel/worker.rbs
106
- - sig/manifest.yaml
107
- homepage: https://github.com/sferik/duel-ruby
36
+ - AGENT_PROMPT.md
37
+ - CHANGELOG.md
38
+ - LICENSE
39
+ - README.md
40
+ - docs/README.md
41
+ - docs/benchmarks.md
42
+ - docs/ci.md
43
+ - docs/configuration.md
44
+ - docs/how-it-works.md
45
+ - docs/json.md
46
+ - docs/plugins.md
47
+ - docs/troubleshooting.md
48
+ - exe/duel
49
+ - lib/duel.rb
50
+ - lib/duel/across.rb
51
+ - lib/duel/baseline.rb
52
+ - lib/duel/cli.rb
53
+ - lib/duel/comment.rb
54
+ - lib/duel/config.rb
55
+ - lib/duel/context.rb
56
+ - lib/duel/control.rb
57
+ - lib/duel/init.rb
58
+ - lib/duel/json_report.rb
59
+ - lib/duel/lane.rb
60
+ - lib/duel/lock.rb
61
+ - lib/duel/memory.rb
62
+ - lib/duel/message.rb
63
+ - lib/duel/metric.rb
64
+ - lib/duel/native.rb
65
+ - lib/duel/platform.rb
66
+ - lib/duel/process_sample.rb
67
+ - lib/duel/profile.rb
68
+ - lib/duel/rake_task.rb
69
+ - lib/duel/resource.rb
70
+ - lib/duel/result.rb
71
+ - lib/duel/rubies.rb
72
+ - lib/duel/runner.rb
73
+ - lib/duel/spawn.rb
74
+ - lib/duel/stats.rb
75
+ - lib/duel/summary.rb
76
+ - lib/duel/templates/benchmark_duel.rb.erb
77
+ - lib/duel/templates/duel.gitlab-ci.yml.erb
78
+ - lib/duel/templates/duel.rb.erb
79
+ - lib/duel/templates/perf-caller.yml.erb
80
+ - lib/duel/templates/perf-comment-caller.yml.erb
81
+ - lib/duel/templates/perf-comment.yml.erb
82
+ - lib/duel/templates/perf.yml.erb
83
+ - lib/duel/testing.rb
84
+ - lib/duel/version.rb
85
+ - lib/duel/worker.rb
86
+ - lib/duel/worker_process.rb
87
+ - sig/duel.rbs
88
+ - sig/duel/across.rbs
89
+ - sig/duel/baseline.rbs
90
+ - sig/duel/cli.rbs
91
+ - sig/duel/comment.rbs
92
+ - sig/duel/config.rbs
93
+ - sig/duel/context.rbs
94
+ - sig/duel/control.rbs
95
+ - sig/duel/init.rbs
96
+ - sig/duel/json_report.rbs
97
+ - sig/duel/lane.rbs
98
+ - sig/duel/lock.rbs
99
+ - sig/duel/memory.rbs
100
+ - sig/duel/message.rbs
101
+ - sig/duel/metric.rbs
102
+ - sig/duel/native.rbs
103
+ - sig/duel/platform.rbs
104
+ - sig/duel/process_sample.rbs
105
+ - sig/duel/profile.rbs
106
+ - sig/duel/rake_task.rbs
107
+ - sig/duel/resource.rbs
108
+ - sig/duel/result.rbs
109
+ - sig/duel/rubies.rbs
110
+ - sig/duel/runner.rbs
111
+ - sig/duel/spawn.rbs
112
+ - sig/duel/stats.rbs
113
+ - sig/duel/summary.rbs
114
+ - sig/duel/testing.rbs
115
+ - sig/duel/version.rbs
116
+ - sig/duel/worker.rbs
117
+ - sig/duel/worker_process.rbs
118
+ - sig/manifest.yaml
119
+ homepage: "https://github.com/sferik/duel-ruby"
108
120
  licenses:
109
- - MIT
121
+ - MIT
110
122
  metadata:
111
- source_code_uri: https://github.com/sferik/duel-ruby
112
- changelog_uri: https://github.com/sferik/duel-ruby/blob/main/CHANGELOG.md
113
- bug_tracker_uri: https://github.com/sferik/duel-ruby/issues
114
- rubygems_mfa_required: 'true'
123
+ source_code_uri: "https://github.com/sferik/duel-ruby"
124
+ changelog_uri: "https://github.com/sferik/duel-ruby/blob/main/CHANGELOG.md"
125
+ bug_tracker_uri: "https://github.com/sferik/duel-ruby/issues"
126
+ rubygems_mfa_required: "true"
115
127
  rdoc_options: []
116
128
  require_paths:
117
- - lib
129
+ - lib
118
130
  required_ruby_version: !ruby/object:Gem::Requirement
119
131
  requirements:
120
- - - ">="
121
- - !ruby/object:Gem::Version
122
- version: '3.4'
132
+ -
133
+ - ">="
134
+ - !ruby/object:Gem::Version
135
+ version: "3.4"
123
136
  required_rubygems_version: !ruby/object:Gem::Requirement
124
137
  requirements:
125
- - - ">="
126
- - !ruby/object:Gem::Version
127
- version: '0'
138
+ -
139
+ - ">="
140
+ - !ruby/object:Gem::Version
141
+ version: "0"
128
142
  requirements: []
129
- rubygems_version: 4.0.24
143
+ rubygems_version: 4.1.0
130
144
  specification_version: 4
131
- summary: 'Performance regression guards: fail when a change makes your code slower'
145
+ summary: "Performance regression guards: fail when a change makes your code slower"
132
146
  test_files: []