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.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +55 -0
- data/lib/sendproof/assets.rb +70 -0
- data/lib/sendproof/attribution.rb +98 -0
- data/lib/sendproof/capture.rb +66 -0
- data/lib/sendproof/clock.rb +54 -0
- data/lib/sendproof/configuration.rb +241 -0
- data/lib/sendproof/data_store.rb +34 -0
- data/lib/sendproof/dynamodb/store.rb +183 -0
- data/lib/sendproof/dynamodb.rb +17 -0
- data/lib/sendproof/elasticsearch/store.rb +24 -0
- data/lib/sendproof/elasticsearch.rb +17 -0
- data/lib/sendproof/firestore/interceptor.rb +38 -0
- data/lib/sendproof/firestore/store.rb +150 -0
- data/lib/sendproof/firestore.rb +99 -0
- data/lib/sendproof/handler.rb +23 -0
- data/lib/sendproof/identity.rb +37 -0
- data/lib/sendproof/limits.rb +113 -0
- data/lib/sendproof/middleware.rb +68 -0
- data/lib/sendproof/mongo/engine.rb +692 -0
- data/lib/sendproof/mongo/guarded.rb +100 -0
- data/lib/sendproof/mongo/plain.rb +45 -0
- data/lib/sendproof/mongo/store.rb +54 -0
- data/lib/sendproof/mongo/subscriber.rb +21 -0
- data/lib/sendproof/mongo.rb +41 -0
- data/lib/sendproof/mongoid/store.rb +58 -0
- data/lib/sendproof/mongoid.rb +65 -0
- data/lib/sendproof/observed_request.rb +108 -0
- data/lib/sendproof/opensearch/store.rb +21 -0
- data/lib/sendproof/opensearch.rb +17 -0
- data/lib/sendproof/operation_matcher.rb +28 -0
- data/lib/sendproof/pool_hooks.rb +80 -0
- data/lib/sendproof/preview_request.rb +44 -0
- data/lib/sendproof/preview_transport.rb +331 -0
- data/lib/sendproof/protocol.rb +81 -0
- data/lib/sendproof/provider.rb +83 -0
- data/lib/sendproof/recorder.rb +298 -0
- data/lib/sendproof/redaction.rb +98 -0
- data/lib/sendproof/redis/commands.rb +76 -0
- data/lib/sendproof/redis/store.rb +205 -0
- data/lib/sendproof/redis.rb +18 -0
- data/lib/sendproof/search/middleware.rb +39 -0
- data/lib/sendproof/search/store.rb +213 -0
- data/lib/sendproof/search.rb +82 -0
- data/lib/sendproof/stores/classify.rb +346 -0
- data/lib/sendproof/stores/guard.rb +127 -0
- data/lib/sendproof/stores/tables.rb +1328 -0
- data/lib/sendproof/stores.rb +12 -0
- data/lib/sendproof/trace_store.rb +110 -0
- data/lib/sendproof/transaction_control.rb +187 -0
- data/lib/sendproof/ui/action-bar.js +91 -0
- data/lib/sendproof/ui/api.js +239 -0
- data/lib/sendproof/ui/app.css +848 -0
- data/lib/sendproof/ui/app.js +742 -0
- data/lib/sendproof/ui/autofill.js +137 -0
- data/lib/sendproof/ui/code-copy.js +71 -0
- data/lib/sendproof/ui/code-picker.js +149 -0
- data/lib/sendproof/ui/commands.js +197 -0
- data/lib/sendproof/ui/components.js +77 -0
- data/lib/sendproof/ui/context-bar.js +82 -0
- data/lib/sendproof/ui/copy.js +92 -0
- data/lib/sendproof/ui/coverage-popover.js +35 -0
- data/lib/sendproof/ui/crumb-fit.js +80 -0
- data/lib/sendproof/ui/deprecation.js +164 -0
- data/lib/sendproof/ui/display-settings.js +175 -0
- data/lib/sendproof/ui/doc-diff.js +209 -0
- data/lib/sendproof/ui/docs-view.js +347 -0
- data/lib/sendproof/ui/favicon.png +0 -0
- data/lib/sendproof/ui/favicon.svg +1 -0
- data/lib/sendproof/ui/field-help.js +52 -0
- data/lib/sendproof/ui/field-modules.js +23 -0
- data/lib/sendproof/ui/fields/controls.js +179 -0
- data/lib/sendproof/ui/fields/dom.js +36 -0
- data/lib/sendproof/ui/fields/infer.js +71 -0
- data/lib/sendproof/ui/fields/lookup-source.js +63 -0
- data/lib/sendproof/ui/fields/lookup.js +285 -0
- data/lib/sendproof/ui/fields/render.js +496 -0
- data/lib/sendproof/ui/fields/select.js +175 -0
- data/lib/sendproof/ui/fields/validate.js +363 -0
- data/lib/sendproof/ui/fields/validation-formats.js +164 -0
- data/lib/sendproof/ui/fields/validation-references.js +68 -0
- data/lib/sendproof/ui/fields/validation-values.js +137 -0
- data/lib/sendproof/ui/generate-menu.js +44 -0
- data/lib/sendproof/ui/generate.js +184 -0
- data/lib/sendproof/ui/header-editor.js +777 -0
- data/lib/sendproof/ui/headers.js +188 -0
- data/lib/sendproof/ui/highlight.js +257 -0
- data/lib/sendproof/ui/history-popover.js +24 -0
- data/lib/sendproof/ui/i18n.js +253 -0
- data/lib/sendproof/ui/icons.js +87 -0
- data/lib/sendproof/ui/index.html +70 -0
- data/lib/sendproof/ui/issues.js +187 -0
- data/lib/sendproof/ui/json-view.js +166 -0
- data/lib/sendproof/ui/lang-icons.js +62 -0
- data/lib/sendproof/ui/layout.js +262 -0
- data/lib/sendproof/ui/listbox.js +334 -0
- data/lib/sendproof/ui/locales/ar-capture.js +366 -0
- data/lib/sendproof/ui/locales/ar-stores.js +116 -0
- data/lib/sendproof/ui/locales/ar.js +561 -0
- data/lib/sendproof/ui/locales/cs-capture.js +442 -0
- data/lib/sendproof/ui/locales/cs-stores.js +116 -0
- data/lib/sendproof/ui/locales/cs.js +689 -0
- data/lib/sendproof/ui/locales/da-capture.js +347 -0
- data/lib/sendproof/ui/locales/da-stores.js +116 -0
- data/lib/sendproof/ui/locales/da.js +522 -0
- data/lib/sendproof/ui/locales/de-capture.js +347 -0
- data/lib/sendproof/ui/locales/de-stores.js +116 -0
- data/lib/sendproof/ui/locales/de.js +519 -0
- data/lib/sendproof/ui/locales/el-capture.js +347 -0
- data/lib/sendproof/ui/locales/el-stores.js +116 -0
- data/lib/sendproof/ui/locales/el.js +520 -0
- data/lib/sendproof/ui/locales/en-capture.js +349 -0
- data/lib/sendproof/ui/locales/en-stores.js +95 -0
- data/lib/sendproof/ui/locales/en.js +522 -0
- data/lib/sendproof/ui/locales/es-capture.js +353 -0
- data/lib/sendproof/ui/locales/es-stores.js +116 -0
- data/lib/sendproof/ui/locales/es.js +525 -0
- data/lib/sendproof/ui/locales/fa-capture.js +348 -0
- data/lib/sendproof/ui/locales/fa-stores.js +116 -0
- data/lib/sendproof/ui/locales/fa.js +521 -0
- data/lib/sendproof/ui/locales/fi-capture.js +347 -0
- data/lib/sendproof/ui/locales/fi-stores.js +116 -0
- data/lib/sendproof/ui/locales/fi.js +523 -0
- data/lib/sendproof/ui/locales/fr-capture.js +353 -0
- data/lib/sendproof/ui/locales/fr-stores.js +116 -0
- data/lib/sendproof/ui/locales/fr.js +525 -0
- data/lib/sendproof/ui/locales/he-capture.js +358 -0
- data/lib/sendproof/ui/locales/he-stores.js +116 -0
- data/lib/sendproof/ui/locales/he.js +529 -0
- data/lib/sendproof/ui/locales/hi-capture.js +348 -0
- data/lib/sendproof/ui/locales/hi-stores.js +116 -0
- data/lib/sendproof/ui/locales/hi.js +523 -0
- data/lib/sendproof/ui/locales/id-capture.js +347 -0
- data/lib/sendproof/ui/locales/id-stores.js +116 -0
- data/lib/sendproof/ui/locales/id.js +521 -0
- data/lib/sendproof/ui/locales/it-capture.js +361 -0
- data/lib/sendproof/ui/locales/it-stores.js +116 -0
- data/lib/sendproof/ui/locales/it.js +523 -0
- data/lib/sendproof/ui/locales/ja-capture.js +346 -0
- data/lib/sendproof/ui/locales/ja-stores.js +116 -0
- data/lib/sendproof/ui/locales/ja.js +521 -0
- data/lib/sendproof/ui/locales/ko-capture.js +346 -0
- data/lib/sendproof/ui/locales/ko-stores.js +116 -0
- data/lib/sendproof/ui/locales/ko.js +522 -0
- data/lib/sendproof/ui/locales/nb-capture.js +349 -0
- data/lib/sendproof/ui/locales/nb-stores.js +116 -0
- data/lib/sendproof/ui/locales/nb.js +521 -0
- data/lib/sendproof/ui/locales/nl-capture.js +355 -0
- data/lib/sendproof/ui/locales/nl-stores.js +116 -0
- data/lib/sendproof/ui/locales/nl.js +520 -0
- data/lib/sendproof/ui/locales/pl-capture.js +432 -0
- data/lib/sendproof/ui/locales/pl-stores.js +116 -0
- data/lib/sendproof/ui/locales/pl.js +528 -0
- data/lib/sendproof/ui/locales/pt-BR-capture.js +350 -0
- data/lib/sendproof/ui/locales/pt-BR-stores.js +116 -0
- data/lib/sendproof/ui/locales/pt-BR.js +523 -0
- data/lib/sendproof/ui/locales/pt-PT-capture.js +350 -0
- data/lib/sendproof/ui/locales/pt-PT-stores.js +116 -0
- data/lib/sendproof/ui/locales/pt-PT.js +523 -0
- data/lib/sendproof/ui/locales/ru-capture.js +437 -0
- data/lib/sendproof/ui/locales/ru-stores.js +116 -0
- data/lib/sendproof/ui/locales/ru.js +624 -0
- data/lib/sendproof/ui/locales/sv-capture.js +349 -0
- data/lib/sendproof/ui/locales/sv-stores.js +116 -0
- data/lib/sendproof/ui/locales/sv.js +518 -0
- data/lib/sendproof/ui/locales/th-capture.js +347 -0
- data/lib/sendproof/ui/locales/th-stores.js +116 -0
- data/lib/sendproof/ui/locales/th.js +521 -0
- data/lib/sendproof/ui/locales/tr-capture.js +348 -0
- data/lib/sendproof/ui/locales/tr-stores.js +116 -0
- data/lib/sendproof/ui/locales/tr.js +521 -0
- data/lib/sendproof/ui/locales/uk-capture.js +442 -0
- data/lib/sendproof/ui/locales/uk-stores.js +116 -0
- data/lib/sendproof/ui/locales/uk.js +630 -0
- data/lib/sendproof/ui/locales/vi-capture.js +346 -0
- data/lib/sendproof/ui/locales/vi-stores.js +116 -0
- data/lib/sendproof/ui/locales/vi.js +523 -0
- data/lib/sendproof/ui/locales/zh-Hans-capture.js +347 -0
- data/lib/sendproof/ui/locales/zh-Hans-stores.js +116 -0
- data/lib/sendproof/ui/locales/zh-Hans.js +523 -0
- data/lib/sendproof/ui/locales/zh-Hant-capture.js +346 -0
- data/lib/sendproof/ui/locales/zh-Hant-stores.js +116 -0
- data/lib/sendproof/ui/locales/zh-Hant.js +522 -0
- data/lib/sendproof/ui/manifest.json +866 -0
- data/lib/sendproof/ui/markdown.js +39 -0
- data/lib/sendproof/ui/model-view.js +182 -0
- data/lib/sendproof/ui/navigation.js +233 -0
- data/lib/sendproof/ui/operation-header.js +76 -0
- data/lib/sendproof/ui/operations.js +7 -0
- data/lib/sendproof/ui/overview-view.js +63 -0
- data/lib/sendproof/ui/personas.js +59 -0
- data/lib/sendproof/ui/popover.js +71 -0
- data/lib/sendproof/ui/preview-false.js +108 -0
- data/lib/sendproof/ui/request-editor.js +496 -0
- data/lib/sendproof/ui/response-metadata.js +354 -0
- data/lib/sendproof/ui/response-viewer.js +618 -0
- data/lib/sendproof/ui/result-blocked.js +155 -0
- data/lib/sendproof/ui/result-capture.js +25 -0
- data/lib/sendproof/ui/result-database.js +185 -0
- data/lib/sendproof/ui/result-effects.js +176 -0
- data/lib/sendproof/ui/result-headers.js +106 -0
- data/lib/sendproof/ui/result-logs.js +408 -0
- data/lib/sendproof/ui/result-states.js +213 -0
- data/lib/sendproof/ui/results.js +371 -0
- data/lib/sendproof/ui/router.js +118 -0
- data/lib/sendproof/ui/schema-model.js +336 -0
- data/lib/sendproof/ui/schema-tree.js +344 -0
- data/lib/sendproof/ui/schema.js +397 -0
- data/lib/sendproof/ui/security.js +31 -0
- data/lib/sendproof/ui/seeded-menu.js +69 -0
- data/lib/sendproof/ui/settings.js +93 -0
- data/lib/sendproof/ui/shortcuts-sheet.js +73 -0
- data/lib/sendproof/ui/shortcuts.js +190 -0
- data/lib/sendproof/ui/sidebar.js +289 -0
- data/lib/sendproof/ui/signin.js +259 -0
- data/lib/sendproof/ui/snippets.js +530 -0
- data/lib/sendproof/ui/store-marks.js +47 -0
- data/lib/sendproof/ui/stores.js +131 -0
- data/lib/sendproof/ui/styles.css +971 -0
- data/lib/sendproof/ui/toggletip.js +53 -0
- data/lib/sendproof/ui/uuid.js +10 -0
- data/lib/sendproof/ui/view.js +122 -0
- data/lib/sendproof/ui/views.css +653 -0
- data/lib/sendproof/version.rb +9 -0
- data/lib/sendproof/workbench.rb +102 -0
- data/lib/sendproof-core.rb +3 -0
- data/lib/sendproof.rb +121 -0
- metadata +292 -0
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "set"
|
|
4
|
+
|
|
5
|
+
module Sendproof
|
|
6
|
+
# Raised to the handler when the write guard refuses a command during a Preview. No byte of the
|
|
7
|
+
# command reached the store. The Preview answers 409 even when the handler rescues this error and
|
|
8
|
+
# returns 200: the mark on the request's recorder, not the handler's response, decides.
|
|
9
|
+
class PreviewWriteBlocked < StandardError
|
|
10
|
+
# @return [String] the store id, such as +"redis"+
|
|
11
|
+
attr_reader :store
|
|
12
|
+
# @return [String] the refused command or action name
|
|
13
|
+
attr_reader :operation
|
|
14
|
+
|
|
15
|
+
def initialize(store, operation, detail)
|
|
16
|
+
super(detail)
|
|
17
|
+
@store = store
|
|
18
|
+
@operation = operation
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# Raised when a handler tries to end or escape the Preview transaction: a raw SQL +COMMIT+, a
|
|
23
|
+
# MongoDB +commitTransaction+, or a store command sent with a session other than the Preview's.
|
|
24
|
+
# The Preview answers 500 without confirmation even if the handler rescues it.
|
|
25
|
+
class PreviewTransactionControl < StandardError; end
|
|
26
|
+
|
|
27
|
+
module Stores
|
|
28
|
+
# The write guard of spec/data-stores.md: the single decision point every store hook calls before
|
|
29
|
+
# it sends a command, plus the helpers hooks share for logging and redaction.
|
|
30
|
+
#
|
|
31
|
+
# Outside a Preview the guard does nothing, so Send and observed Send are never blocked.
|
|
32
|
+
module Guard
|
|
33
|
+
# Display names used in "Preview unavailable: this operation writes to <Store>".
|
|
34
|
+
NAMES = { "mongodb" => "MongoDB", "redis" => "Redis", "dynamodb" => "DynamoDB", "elasticsearch" => "Elasticsearch",
|
|
35
|
+
"opensearch" => "OpenSearch", "firestore" => "Firestore" }.freeze
|
|
36
|
+
|
|
37
|
+
module_function
|
|
38
|
+
|
|
39
|
+
# @return [String] the display name of a store id; an unknown id is shown as given
|
|
40
|
+
def store_name(store) = NAMES.fetch(store.to_s, store.to_s)
|
|
41
|
+
|
|
42
|
+
# @return [String] the reason shown for a write to a guarded store
|
|
43
|
+
def write_reason(store) = "Preview unavailable: this operation writes to #{store_name(store)}"
|
|
44
|
+
|
|
45
|
+
# Call before sending a store command. Does nothing for anything but a write. In a Preview it marks
|
|
46
|
+
# the recorder blocked (the first block wins), logs a blocked +Db+ entry and raises
|
|
47
|
+
# {PreviewWriteBlocked}. Outside a Preview it lets the write through, unless it belongs to no request
|
|
48
|
+
# while a Preview is open: {Attribution} then refuses it the same way and blocks every open Preview.
|
|
49
|
+
#
|
|
50
|
+
# @param kind [Symbol] from {Classify}; only +:write+ blocks
|
|
51
|
+
# @param detail [String, nil] replaces the default "writes to <Store>" reason, for example for a
|
|
52
|
+
# MongoDB command that can't run inside a transaction
|
|
53
|
+
def guard(store, operation, kind, detail = nil)
|
|
54
|
+
return unless kind == :write
|
|
55
|
+
|
|
56
|
+
recorder = Capture.preview
|
|
57
|
+
unless recorder
|
|
58
|
+
Attribution.refuse_unattributed(store, operation)
|
|
59
|
+
return
|
|
60
|
+
end
|
|
61
|
+
reason = detail || write_reason(store)
|
|
62
|
+
recorder.block(store: store, operation: operation, detail: reason)
|
|
63
|
+
recorder.db(system: store, operation: operation, blocked: true)
|
|
64
|
+
raise PreviewWriteBlocked.new(store, operation, reason)
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Refuses something that would end or escape the Preview transaction. Records the fault on the
|
|
68
|
+
# current Preview, so the Preview fails with 500 even if the handler rescues the error, and
|
|
69
|
+
# returns the error for the caller to raise. Outside a Preview it returns +nil+.
|
|
70
|
+
#
|
|
71
|
+
# @return [PreviewTransactionControl, nil]
|
|
72
|
+
def refuse_in_preview(message)
|
|
73
|
+
recorder = Capture.preview or return nil
|
|
74
|
+
error = PreviewTransactionControl.new(message)
|
|
75
|
+
recorder.refuse(error)
|
|
76
|
+
error
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Replaces every literal in a command document with +"?"+, keeping field names and operators,
|
|
80
|
+
# for the +statement+ of a MongoDB +Db+ entry (OpenTelemetry +db.query.text+). BSON values,
|
|
81
|
+
# times and binary strings are literals too.
|
|
82
|
+
def sanitize_document(value)
|
|
83
|
+
case value
|
|
84
|
+
when Array then value.map { |item| sanitize_document(item) }
|
|
85
|
+
when Hash then value.to_h { |name, inner| [name.to_s, sanitize_document(inner)] }
|
|
86
|
+
else "?"
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Validates the optional label a host gives a store for capabilities +dataStores+. Discovery is
|
|
91
|
+
# shown to anyone who can open the workbench, so the label must be a display name such as
|
|
92
|
+
# +catalog+: never a connection string, URL, host:port, user or password.
|
|
93
|
+
#
|
|
94
|
+
# @return [String, nil]
|
|
95
|
+
# @raise [ArgumentError] when the label looks like a connection detail
|
|
96
|
+
def store_label(name)
|
|
97
|
+
return nil if name.nil?
|
|
98
|
+
|
|
99
|
+
text = name.to_s
|
|
100
|
+
if !name.is_a?(String) || text.strip.empty? || text.length > 64 || text.match?(%r{[[:cntrl:]/\\@=;:?#%]})
|
|
101
|
+
raise ArgumentError, 'A data store name must be a display label such as "catalog", not a connection string, URL or host.'
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
text
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Normalizes host-declared reads ("TreatAsRead") into an exact-match set, after +transform+.
|
|
108
|
+
#
|
|
109
|
+
# @param names [Array<String>, nil]
|
|
110
|
+
# @param spaces [Boolean] allow a space inside a name, for an Elasticsearch operation such as
|
|
111
|
+
# +POST /{}/_my_read+; a wildcard is never allowed
|
|
112
|
+
# @return [Set<String>, nil]
|
|
113
|
+
# @raise [ArgumentError] for a wildcard or blank name
|
|
114
|
+
def read_set(names, spaces: false, &transform)
|
|
115
|
+
return nil if names.nil?
|
|
116
|
+
|
|
117
|
+
forbidden = spaces ? /[*?\t\r\n]/ : /[*?\s]/
|
|
118
|
+
unless names.is_a?(Array) && names.all? { |name| name.is_a?(String) && !name.strip.empty? && !name.match?(forbidden) }
|
|
119
|
+
raise ArgumentError, "treat_as_read takes exact command names, without wildcards."
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
transform ||= :itself.to_proc
|
|
123
|
+
names.to_set(&transform)
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|