sendproof-core 0.1.0.alpha.1

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 (229) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +55 -0
  4. data/lib/sendproof/assets.rb +70 -0
  5. data/lib/sendproof/attribution.rb +98 -0
  6. data/lib/sendproof/capture.rb +66 -0
  7. data/lib/sendproof/clock.rb +54 -0
  8. data/lib/sendproof/configuration.rb +241 -0
  9. data/lib/sendproof/data_store.rb +34 -0
  10. data/lib/sendproof/dynamodb/store.rb +183 -0
  11. data/lib/sendproof/dynamodb.rb +17 -0
  12. data/lib/sendproof/elasticsearch/store.rb +24 -0
  13. data/lib/sendproof/elasticsearch.rb +17 -0
  14. data/lib/sendproof/firestore/interceptor.rb +38 -0
  15. data/lib/sendproof/firestore/store.rb +150 -0
  16. data/lib/sendproof/firestore.rb +99 -0
  17. data/lib/sendproof/handler.rb +23 -0
  18. data/lib/sendproof/identity.rb +37 -0
  19. data/lib/sendproof/limits.rb +113 -0
  20. data/lib/sendproof/middleware.rb +68 -0
  21. data/lib/sendproof/mongo/engine.rb +692 -0
  22. data/lib/sendproof/mongo/guarded.rb +100 -0
  23. data/lib/sendproof/mongo/plain.rb +45 -0
  24. data/lib/sendproof/mongo/store.rb +54 -0
  25. data/lib/sendproof/mongo/subscriber.rb +21 -0
  26. data/lib/sendproof/mongo.rb +41 -0
  27. data/lib/sendproof/mongoid/store.rb +58 -0
  28. data/lib/sendproof/mongoid.rb +65 -0
  29. data/lib/sendproof/observed_request.rb +108 -0
  30. data/lib/sendproof/opensearch/store.rb +21 -0
  31. data/lib/sendproof/opensearch.rb +17 -0
  32. data/lib/sendproof/operation_matcher.rb +28 -0
  33. data/lib/sendproof/pool_hooks.rb +80 -0
  34. data/lib/sendproof/preview_request.rb +44 -0
  35. data/lib/sendproof/preview_transport.rb +331 -0
  36. data/lib/sendproof/protocol.rb +81 -0
  37. data/lib/sendproof/provider.rb +83 -0
  38. data/lib/sendproof/recorder.rb +298 -0
  39. data/lib/sendproof/redaction.rb +98 -0
  40. data/lib/sendproof/redis/commands.rb +76 -0
  41. data/lib/sendproof/redis/store.rb +205 -0
  42. data/lib/sendproof/redis.rb +18 -0
  43. data/lib/sendproof/search/middleware.rb +39 -0
  44. data/lib/sendproof/search/store.rb +213 -0
  45. data/lib/sendproof/search.rb +82 -0
  46. data/lib/sendproof/stores/classify.rb +346 -0
  47. data/lib/sendproof/stores/guard.rb +127 -0
  48. data/lib/sendproof/stores/tables.rb +1328 -0
  49. data/lib/sendproof/stores.rb +12 -0
  50. data/lib/sendproof/trace_store.rb +110 -0
  51. data/lib/sendproof/transaction_control.rb +187 -0
  52. data/lib/sendproof/ui/action-bar.js +91 -0
  53. data/lib/sendproof/ui/api.js +239 -0
  54. data/lib/sendproof/ui/app.css +848 -0
  55. data/lib/sendproof/ui/app.js +742 -0
  56. data/lib/sendproof/ui/autofill.js +137 -0
  57. data/lib/sendproof/ui/code-copy.js +71 -0
  58. data/lib/sendproof/ui/code-picker.js +149 -0
  59. data/lib/sendproof/ui/commands.js +197 -0
  60. data/lib/sendproof/ui/components.js +77 -0
  61. data/lib/sendproof/ui/context-bar.js +82 -0
  62. data/lib/sendproof/ui/copy.js +92 -0
  63. data/lib/sendproof/ui/coverage-popover.js +35 -0
  64. data/lib/sendproof/ui/crumb-fit.js +80 -0
  65. data/lib/sendproof/ui/deprecation.js +164 -0
  66. data/lib/sendproof/ui/display-settings.js +175 -0
  67. data/lib/sendproof/ui/doc-diff.js +209 -0
  68. data/lib/sendproof/ui/docs-view.js +347 -0
  69. data/lib/sendproof/ui/favicon.png +0 -0
  70. data/lib/sendproof/ui/favicon.svg +1 -0
  71. data/lib/sendproof/ui/field-help.js +52 -0
  72. data/lib/sendproof/ui/field-modules.js +23 -0
  73. data/lib/sendproof/ui/fields/controls.js +179 -0
  74. data/lib/sendproof/ui/fields/dom.js +36 -0
  75. data/lib/sendproof/ui/fields/infer.js +71 -0
  76. data/lib/sendproof/ui/fields/lookup-source.js +63 -0
  77. data/lib/sendproof/ui/fields/lookup.js +285 -0
  78. data/lib/sendproof/ui/fields/render.js +496 -0
  79. data/lib/sendproof/ui/fields/select.js +175 -0
  80. data/lib/sendproof/ui/fields/validate.js +363 -0
  81. data/lib/sendproof/ui/fields/validation-formats.js +164 -0
  82. data/lib/sendproof/ui/fields/validation-references.js +68 -0
  83. data/lib/sendproof/ui/fields/validation-values.js +137 -0
  84. data/lib/sendproof/ui/generate-menu.js +44 -0
  85. data/lib/sendproof/ui/generate.js +184 -0
  86. data/lib/sendproof/ui/header-editor.js +777 -0
  87. data/lib/sendproof/ui/headers.js +188 -0
  88. data/lib/sendproof/ui/highlight.js +257 -0
  89. data/lib/sendproof/ui/history-popover.js +24 -0
  90. data/lib/sendproof/ui/i18n.js +253 -0
  91. data/lib/sendproof/ui/icons.js +87 -0
  92. data/lib/sendproof/ui/index.html +70 -0
  93. data/lib/sendproof/ui/issues.js +187 -0
  94. data/lib/sendproof/ui/json-view.js +166 -0
  95. data/lib/sendproof/ui/lang-icons.js +62 -0
  96. data/lib/sendproof/ui/layout.js +262 -0
  97. data/lib/sendproof/ui/listbox.js +334 -0
  98. data/lib/sendproof/ui/locales/ar-capture.js +366 -0
  99. data/lib/sendproof/ui/locales/ar-stores.js +116 -0
  100. data/lib/sendproof/ui/locales/ar.js +561 -0
  101. data/lib/sendproof/ui/locales/cs-capture.js +442 -0
  102. data/lib/sendproof/ui/locales/cs-stores.js +116 -0
  103. data/lib/sendproof/ui/locales/cs.js +689 -0
  104. data/lib/sendproof/ui/locales/da-capture.js +347 -0
  105. data/lib/sendproof/ui/locales/da-stores.js +116 -0
  106. data/lib/sendproof/ui/locales/da.js +522 -0
  107. data/lib/sendproof/ui/locales/de-capture.js +347 -0
  108. data/lib/sendproof/ui/locales/de-stores.js +116 -0
  109. data/lib/sendproof/ui/locales/de.js +519 -0
  110. data/lib/sendproof/ui/locales/el-capture.js +347 -0
  111. data/lib/sendproof/ui/locales/el-stores.js +116 -0
  112. data/lib/sendproof/ui/locales/el.js +520 -0
  113. data/lib/sendproof/ui/locales/en-capture.js +349 -0
  114. data/lib/sendproof/ui/locales/en-stores.js +95 -0
  115. data/lib/sendproof/ui/locales/en.js +522 -0
  116. data/lib/sendproof/ui/locales/es-capture.js +353 -0
  117. data/lib/sendproof/ui/locales/es-stores.js +116 -0
  118. data/lib/sendproof/ui/locales/es.js +525 -0
  119. data/lib/sendproof/ui/locales/fa-capture.js +348 -0
  120. data/lib/sendproof/ui/locales/fa-stores.js +116 -0
  121. data/lib/sendproof/ui/locales/fa.js +521 -0
  122. data/lib/sendproof/ui/locales/fi-capture.js +347 -0
  123. data/lib/sendproof/ui/locales/fi-stores.js +116 -0
  124. data/lib/sendproof/ui/locales/fi.js +523 -0
  125. data/lib/sendproof/ui/locales/fr-capture.js +353 -0
  126. data/lib/sendproof/ui/locales/fr-stores.js +116 -0
  127. data/lib/sendproof/ui/locales/fr.js +525 -0
  128. data/lib/sendproof/ui/locales/he-capture.js +358 -0
  129. data/lib/sendproof/ui/locales/he-stores.js +116 -0
  130. data/lib/sendproof/ui/locales/he.js +529 -0
  131. data/lib/sendproof/ui/locales/hi-capture.js +348 -0
  132. data/lib/sendproof/ui/locales/hi-stores.js +116 -0
  133. data/lib/sendproof/ui/locales/hi.js +523 -0
  134. data/lib/sendproof/ui/locales/id-capture.js +347 -0
  135. data/lib/sendproof/ui/locales/id-stores.js +116 -0
  136. data/lib/sendproof/ui/locales/id.js +521 -0
  137. data/lib/sendproof/ui/locales/it-capture.js +361 -0
  138. data/lib/sendproof/ui/locales/it-stores.js +116 -0
  139. data/lib/sendproof/ui/locales/it.js +523 -0
  140. data/lib/sendproof/ui/locales/ja-capture.js +346 -0
  141. data/lib/sendproof/ui/locales/ja-stores.js +116 -0
  142. data/lib/sendproof/ui/locales/ja.js +521 -0
  143. data/lib/sendproof/ui/locales/ko-capture.js +346 -0
  144. data/lib/sendproof/ui/locales/ko-stores.js +116 -0
  145. data/lib/sendproof/ui/locales/ko.js +522 -0
  146. data/lib/sendproof/ui/locales/nb-capture.js +349 -0
  147. data/lib/sendproof/ui/locales/nb-stores.js +116 -0
  148. data/lib/sendproof/ui/locales/nb.js +521 -0
  149. data/lib/sendproof/ui/locales/nl-capture.js +355 -0
  150. data/lib/sendproof/ui/locales/nl-stores.js +116 -0
  151. data/lib/sendproof/ui/locales/nl.js +520 -0
  152. data/lib/sendproof/ui/locales/pl-capture.js +432 -0
  153. data/lib/sendproof/ui/locales/pl-stores.js +116 -0
  154. data/lib/sendproof/ui/locales/pl.js +528 -0
  155. data/lib/sendproof/ui/locales/pt-BR-capture.js +350 -0
  156. data/lib/sendproof/ui/locales/pt-BR-stores.js +116 -0
  157. data/lib/sendproof/ui/locales/pt-BR.js +523 -0
  158. data/lib/sendproof/ui/locales/pt-PT-capture.js +350 -0
  159. data/lib/sendproof/ui/locales/pt-PT-stores.js +116 -0
  160. data/lib/sendproof/ui/locales/pt-PT.js +523 -0
  161. data/lib/sendproof/ui/locales/ru-capture.js +437 -0
  162. data/lib/sendproof/ui/locales/ru-stores.js +116 -0
  163. data/lib/sendproof/ui/locales/ru.js +624 -0
  164. data/lib/sendproof/ui/locales/sv-capture.js +349 -0
  165. data/lib/sendproof/ui/locales/sv-stores.js +116 -0
  166. data/lib/sendproof/ui/locales/sv.js +518 -0
  167. data/lib/sendproof/ui/locales/th-capture.js +347 -0
  168. data/lib/sendproof/ui/locales/th-stores.js +116 -0
  169. data/lib/sendproof/ui/locales/th.js +521 -0
  170. data/lib/sendproof/ui/locales/tr-capture.js +348 -0
  171. data/lib/sendproof/ui/locales/tr-stores.js +116 -0
  172. data/lib/sendproof/ui/locales/tr.js +521 -0
  173. data/lib/sendproof/ui/locales/uk-capture.js +442 -0
  174. data/lib/sendproof/ui/locales/uk-stores.js +116 -0
  175. data/lib/sendproof/ui/locales/uk.js +630 -0
  176. data/lib/sendproof/ui/locales/vi-capture.js +346 -0
  177. data/lib/sendproof/ui/locales/vi-stores.js +116 -0
  178. data/lib/sendproof/ui/locales/vi.js +523 -0
  179. data/lib/sendproof/ui/locales/zh-Hans-capture.js +347 -0
  180. data/lib/sendproof/ui/locales/zh-Hans-stores.js +116 -0
  181. data/lib/sendproof/ui/locales/zh-Hans.js +523 -0
  182. data/lib/sendproof/ui/locales/zh-Hant-capture.js +346 -0
  183. data/lib/sendproof/ui/locales/zh-Hant-stores.js +116 -0
  184. data/lib/sendproof/ui/locales/zh-Hant.js +522 -0
  185. data/lib/sendproof/ui/manifest.json +866 -0
  186. data/lib/sendproof/ui/markdown.js +39 -0
  187. data/lib/sendproof/ui/model-view.js +182 -0
  188. data/lib/sendproof/ui/navigation.js +233 -0
  189. data/lib/sendproof/ui/operation-header.js +76 -0
  190. data/lib/sendproof/ui/operations.js +7 -0
  191. data/lib/sendproof/ui/overview-view.js +63 -0
  192. data/lib/sendproof/ui/personas.js +59 -0
  193. data/lib/sendproof/ui/popover.js +71 -0
  194. data/lib/sendproof/ui/preview-false.js +108 -0
  195. data/lib/sendproof/ui/request-editor.js +496 -0
  196. data/lib/sendproof/ui/response-metadata.js +354 -0
  197. data/lib/sendproof/ui/response-viewer.js +618 -0
  198. data/lib/sendproof/ui/result-blocked.js +155 -0
  199. data/lib/sendproof/ui/result-capture.js +25 -0
  200. data/lib/sendproof/ui/result-database.js +185 -0
  201. data/lib/sendproof/ui/result-effects.js +176 -0
  202. data/lib/sendproof/ui/result-headers.js +106 -0
  203. data/lib/sendproof/ui/result-logs.js +408 -0
  204. data/lib/sendproof/ui/result-states.js +213 -0
  205. data/lib/sendproof/ui/results.js +371 -0
  206. data/lib/sendproof/ui/router.js +118 -0
  207. data/lib/sendproof/ui/schema-model.js +336 -0
  208. data/lib/sendproof/ui/schema-tree.js +344 -0
  209. data/lib/sendproof/ui/schema.js +397 -0
  210. data/lib/sendproof/ui/security.js +31 -0
  211. data/lib/sendproof/ui/seeded-menu.js +69 -0
  212. data/lib/sendproof/ui/settings.js +93 -0
  213. data/lib/sendproof/ui/shortcuts-sheet.js +73 -0
  214. data/lib/sendproof/ui/shortcuts.js +190 -0
  215. data/lib/sendproof/ui/sidebar.js +289 -0
  216. data/lib/sendproof/ui/signin.js +259 -0
  217. data/lib/sendproof/ui/snippets.js +530 -0
  218. data/lib/sendproof/ui/store-marks.js +47 -0
  219. data/lib/sendproof/ui/stores.js +131 -0
  220. data/lib/sendproof/ui/styles.css +971 -0
  221. data/lib/sendproof/ui/toggletip.js +53 -0
  222. data/lib/sendproof/ui/uuid.js +10 -0
  223. data/lib/sendproof/ui/view.js +122 -0
  224. data/lib/sendproof/ui/views.css +653 -0
  225. data/lib/sendproof/version.rb +9 -0
  226. data/lib/sendproof/workbench.rb +102 -0
  227. data/lib/sendproof-core.rb +3 -0
  228. data/lib/sendproof.rb +121 -0
  229. metadata +292 -0
@@ -0,0 +1,113 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sendproof
4
+ # Capture limits shared by every adapter. They match the .NET adapter so UIs behave identically.
5
+ module Limits
6
+ LOGS = 500
7
+ EFFECTS = 100
8
+ CHANGES = 200
9
+ PROPERTIES = 32
10
+ PARAMETERS = 64
11
+ NAME = 256
12
+ TEXT = 4096
13
+ PAYLOAD_BYTES = 16 * 1024
14
+ LOG_BUDGET = 128 * 1024
15
+ PAYLOAD_BUDGET = 128 * 1024
16
+ MAX_DEPTH = 16
17
+ RESPONSE_BYTES = 1024 * 1024
18
+
19
+ module_function
20
+
21
+ # Truncates to at most +maximum+ characters.
22
+ def clip(value, maximum = TEXT)
23
+ value = value.to_s
24
+ value.length <= maximum ? value : value[0, maximum]
25
+ end
26
+
27
+ # Serializes +value+ to plain JSON data within the payload limits.
28
+ # @return [Object, nil] parsed JSON value, or nil when it is cyclic, too big or fails to serialize
29
+ def snapshot(value)
30
+ return nil if value.nil?
31
+ # Reject oversized plain data before serializing it, so a huge host payload is never copied.
32
+ return nil unless bounded?(value)
33
+
34
+ json = JSON.generate(value, max_nesting: MAX_DEPTH)
35
+ return nil if json.bytesize > PAYLOAD_BYTES
36
+
37
+ parsed = JSON.parse(json, max_nesting: MAX_DEPTH)
38
+ fits?(parsed) ? parsed : nil
39
+ rescue StandardError, SystemStackError
40
+ # Host payloads can be cyclic or raise from a getter. Capture must never interrupt the application.
41
+ nil
42
+ end
43
+
44
+ def size(value)
45
+ value.nil? ? 0 : JSON.generate(value).length
46
+ end
47
+
48
+ # Applies the change count, payload budget and per-value limits.
49
+ # @param changes [Array<Hash>] with :operation, :table, :key, :before, :after and optionally :store, :namespace, :via
50
+ # @return [Array(Array<Hash>, Boolean)] snapshots and a truncated flag
51
+ def snapshot_changes(changes)
52
+ result = []
53
+ truncated = changes.length > CHANGES
54
+ remaining = PAYLOAD_BUDGET
55
+ changes.first(CHANGES).each do |change|
56
+ key = change[:key].nil? ? nil : snapshot(change[:key])
57
+ before = change[:before].nil? ? nil : snapshot(change[:before])
58
+ after = change[:after].nil? ? nil : snapshot(change[:after])
59
+ operation = clip(change[:operation], NAME)
60
+ table = clip(change[:table], NAME)
61
+ remaining -= size(key) + size(before) + size(after) + operation.length + table.length
62
+ if remaining.negative?
63
+ truncated = true
64
+ break
65
+ end
66
+
67
+ truncated ||= (key.nil? && !change[:key].nil?) || (before.nil? && !change[:before].nil?) ||
68
+ (after.nil? && !change[:after].nil?) || operation != change[:operation].to_s ||
69
+ table != change[:table].to_s
70
+ entry = { operation:, table:, key:, before:, after: }
71
+ # Data-store changes also name their store, database and, for an upsert or replacement, how.
72
+ entry[:store] = clip(change[:store], NAME) if change[:store]
73
+ entry[:namespace] = clip(change[:namespace], NAME) if change[:namespace]
74
+ entry[:via] = change[:via].to_s if change[:via]
75
+ result << entry
76
+ end
77
+ [result, truncated]
78
+ end
79
+
80
+ # Walks plain Ruby data (strings, symbols, arrays, hashes) and stops at the first value that
81
+ # {fits?} would reject, or once the strings alone exceed {PAYLOAD_BYTES}. Other objects are
82
+ # left to the serializer. +budget+ is a one-element array so the remaining bytes are shared.
83
+ def bounded?(value, depth = 0, budget = [PAYLOAD_BYTES])
84
+ return false if depth >= MAX_DEPTH
85
+
86
+ case value
87
+ when String
88
+ value.length <= TEXT && (budget[0] -= value.bytesize) >= 0
89
+ when Symbol then bounded?(value.to_s, depth, budget)
90
+ when Array
91
+ value.length <= PARAMETERS && value.all? { |item| bounded?(item, depth + 1, budget) }
92
+ when Hash
93
+ value.length <= PARAMETERS && value.all? do |name, item|
94
+ key = name.to_s
95
+ key.length <= NAME && (budget[0] -= key.bytesize) >= 0 && bounded?(item, depth + 1, budget)
96
+ end
97
+ else true
98
+ end
99
+ end
100
+
101
+ def fits?(value, depth = 0)
102
+ return false if depth >= MAX_DEPTH
103
+
104
+ case value
105
+ when String then value.length <= TEXT
106
+ when Array then value.length <= PARAMETERS && value.all? { |item| fits?(item, depth + 1) }
107
+ when Hash
108
+ value.length <= PARAMETERS && value.all? { |name, item| name.length <= NAME && fits?(item, depth + 1) }
109
+ else true
110
+ end
111
+ end
112
+ end
113
+ end
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sendproof
4
+ # Rack middleware that adds the workbench, preview transport and observed sends to an application.
5
+ #
6
+ # use Sendproof::Middleware, environment: ENV["RACK_ENV"], environments: %w[development],
7
+ # open_api_url: "/openapi.json", identity: ->(request) { ... }
8
+ #
9
+ # Place it after session and authentication middleware and before the router, so the preview
10
+ # request is routed, authenticated and authorized by the host exactly like a real call.
11
+ class Middleware
12
+ # @param config [Configuration, nil] a shared configuration; otherwise built from +options+
13
+ def initialize(app, config = nil, **options)
14
+ @app = app
15
+ @config = config || Configuration.new(**options)
16
+ @config.validate!
17
+ @workbench = Workbench.new(@config)
18
+ @preview = PreviewTransport.new(app, @config)
19
+ end
20
+
21
+ def call(env)
22
+ return @app.call(env) unless @config.enabled?
23
+
24
+ # Every request seen here is attributed: its store writes never fail another request's Preview.
25
+ Attribution.request { dispatch(env) }
26
+ end
27
+
28
+ private
29
+
30
+ def dispatch(env)
31
+ request = Rack::Request.new(env)
32
+ path = env["PATH_INFO"].to_s
33
+ prefix = reserved_index(path)
34
+ return @preview.call(env, request, prefix) if prefix
35
+
36
+ if Protocol.requests_rollback?(env)
37
+ return Protocol.problem(400, "Use the Sendproof preview URL for rollback requests.")
38
+ end
39
+ return @workbench.call(env, request, path) if path == "/sendproof" || path.start_with?("/sendproof/")
40
+
41
+ call_observed(env, request)
42
+ end
43
+
44
+ # Index of +/sendproof/_preview+ when it is a whole path segment, comparing case-insensitively.
45
+ def reserved_index(path)
46
+ index = path.downcase.index(Protocol::PREFIX)
47
+ return nil unless index
48
+
49
+ stop = index + Protocol::PREFIX.length
50
+ index if stop == path.length || path[stop] == "/"
51
+ end
52
+
53
+ def call_observed(env, request)
54
+ return @app.call(env) if request.head? || !Protocol.requests_trace?(env) || !Protocol.same_origin?(request)
55
+
56
+ observed = ObservedRequest.new(config: @config)
57
+ env[ENV_KEY] = observed
58
+ begin
59
+ status, headers, body = @app.call(env)
60
+ rescue Exception # rubocop:disable Lint/RescueException -- the trace must be discarded for any unwinding
61
+ observed.finish(nil, failed: true)
62
+ raise
63
+ end
64
+ observed.finish(headers)
65
+ [status, headers, body]
66
+ end
67
+ end
68
+ end