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,131 @@
1
+ // Data stores (spec/data-stores.md): what each store is called, what it calls its parts, its mark,
2
+ // and what discovery says about it. Every view that names a store goes through here, so the store's
3
+ // name always sits beside its mark as text and no meaning depends on the logo (mock v6-icons.js).
4
+ import { esc, icon } from './components.js';
5
+ import { formatList, t } from './i18n.js';
6
+ import { MARKS } from './store-marks.js';
7
+
8
+ /**
9
+ * Known stores by `system` id (capabilities `dataStores[].system`, change `store`, log `db.system`).
10
+ * `kind` picks the nouns: sql (table, row), document (collection, document), item (table, item),
11
+ * key (key prefix, key), index (index, document) and container (container, item).
12
+ */
13
+ export const STORES = {
14
+ sqlite: { name: 'SQLite', kind: 'sql' },
15
+ postgresql: { name: 'PostgreSQL', kind: 'sql' },
16
+ mysql: { name: 'MySQL', kind: 'sql' },
17
+ mariadb: { name: 'MariaDB', kind: 'sql' },
18
+ sqlserver: { name: 'SQL Server', kind: 'sql' },
19
+ mongodb: { name: 'MongoDB', kind: 'document' },
20
+ redis: { name: 'Redis', kind: 'key' },
21
+ dynamodb: { name: 'DynamoDB', kind: 'item' },
22
+ cassandra: { name: 'Cassandra', kind: 'sql' },
23
+ elasticsearch: { name: 'Elasticsearch', kind: 'index' },
24
+ opensearch: { name: 'OpenSearch', kind: 'index' },
25
+ cosmosdb: { name: 'Cosmos DB', kind: 'container' },
26
+ firestore: { name: 'Firestore', kind: 'document' },
27
+ };
28
+
29
+ /** The id the binding's own SQL database goes by: changes and logs without a store are SQL. */
30
+ export const SQL = 'sql';
31
+
32
+ // OpenTelemetry's db.system.name values that differ from Sendproof's ids (data-stores.md).
33
+ const ALIASES = { 'aws.dynamodb': 'dynamodb', 'azure.cosmosdb': 'cosmosdb', mssql: 'sqlserver', postgres: 'postgresql' };
34
+ const normal = system => {
35
+ const id = String(system ?? '').trim().toLowerCase();
36
+ return ALIASES[id] ?? id;
37
+ };
38
+
39
+ /** Whether an id can name the binding's SQL database: a known SQL provider, or one Sendproof has no mark for (oracle…). A document or key-value id is a binding mistake. */
40
+ const isSqlProvider = id => !!id && id !== SQL && (STORES[id] ? STORES[id].kind === 'sql' && id !== 'cassandra' : true);
41
+
42
+ /**
43
+ * The SQL provider behind `capabilities.database`. A binding that reports `database.system` (the
44
+ * provider id: sqlite, postgresql, mysql, mariadb, mssql…) is believed. Older bindings send only
45
+ * the database's display name, so a file name ending in .db, .sqlite or .sqlite3 is guessed to be
46
+ * a SQLite file; anything else is shown as a generic "SQL database".
47
+ */
48
+ export function sqlSystem(capabilities = {}) {
49
+ const database = capabilities.database;
50
+ const reported = normal(typeof database === 'object' ? database?.system : '');
51
+ if (isSqlProvider(reported)) return reported;
52
+ const name = typeof database === 'string' ? database : database?.name;
53
+ return /\.(db|sqlite3?)$/i.test(name || '') ? 'sqlite' : SQL;
54
+ }
55
+
56
+ /** A store's display name. Unknown ids are shown as the binding sent them. */
57
+ export function storeName(system) {
58
+ const id = normal(system);
59
+ if (id === SQL) return t('store.sql');
60
+ return STORES[id]?.name ?? String(system ?? '');
61
+ }
62
+
63
+ /** The noun family for a store: sql, document, item, key, index or container. */
64
+ export const storeKind = system => STORES[normal(system)]?.kind ?? (normal(system) === SQL ? 'sql' : 'document');
65
+
66
+ /** "Collection", "Table", "Key prefix"…: what the store calls the place a record lives. */
67
+ export const containerNoun = system => t('store.container.' + storeKind(system));
68
+
69
+ /** "3 documents", "2 rows", "1 key": a record count in the store's own words. */
70
+ export const recordCount = (system, n) => t('store.count.' + storeKind(system), { n });
71
+
72
+ /**
73
+ * The store's mark as inline SVG at 14, 16, 20 or 28 px. Stores without a usable mark (and ids
74
+ * Sendproof doesn't know) get the generic store glyph at the same size, so layouts never change.
75
+ */
76
+ export function storeMark(system, size = 14) {
77
+ const id = normal(system);
78
+ const mark = MARKS[id];
79
+ if (!mark) return `<span class="mk mk-${size} mk-other" aria-hidden="true">${icon('db', true)}</span>`;
80
+ return `<svg class="mk mk-${size} mk-${id}" viewBox="${mark.box}" aria-hidden="true" focusable="false">${mark.body}</svg>`;
81
+ }
82
+
83
+ /** The mark followed by the name: the one way a store is labelled inline. */
84
+ export const storeLabel = (system, size = 14) =>
85
+ `<span class="store-label">${storeMark(system, size)}<span>${esc(storeName(system))}</span></span>`;
86
+
87
+ /** The hooked stores from discovery, normalised: [{ system, name, mode, reason }]. */
88
+ export function dataStores(capabilities = {}) {
89
+ return (Array.isArray(capabilities.dataStores) ? capabilities.dataStores : [])
90
+ .filter(store => store && typeof store.system === 'string')
91
+ .map(store => ({ system: normal(store.system), name: typeof store.name === 'string' ? store.name : '', mode: store.mode === 'preview' ? 'preview' : 'guard', reason: typeof store.reason === 'string' ? store.reason : '' }));
92
+ }
93
+
94
+ /** The discovery entry for one store, if it is hooked. */
95
+ export const dataStore = (capabilities, system) => dataStores(capabilities).find(store => store.system === normal(system));
96
+
97
+ /**
98
+ * The `previewUnavailable` entry for an operation (an API author marked it `preview: false`), or
99
+ * undefined. Read-only methods never Preview anyway, so they never match.
100
+ */
101
+ export function previewUnavailable(op, capabilities = {}) {
102
+ if (!op) return undefined;
103
+ const entry = (Array.isArray(capabilities.previewUnavailable) ? capabilities.previewUnavailable : [])
104
+ .find(item => item && String(item.method).toUpperCase() === op.method && item.path === op.path);
105
+ if (!entry) return undefined;
106
+ return { reason: authorReason(entry.reason), stores: (Array.isArray(entry.stores) ? entry.stores : []).map(normal) };
107
+ }
108
+
109
+ /**
110
+ * An author's reason without a leading "Preview unavailable:", which the UI already says in its
111
+ * own words: "Preview unavailable: this operation writes to Redis" reads "This operation writes to Redis".
112
+ */
113
+ export function authorReason(reason) {
114
+ const text = String(reason ?? '').replace(/^\s*preview unavailable\s*[:·–-]\s*/i, '').trim();
115
+ return text ? text[0].toUpperCase() + text.slice(1) : '';
116
+ }
117
+
118
+ /** "Redis", "Redis and DynamoDB": store names as a list in this locale. */
119
+ export const storeNames = systems => formatList([...new Set(systems)].map(storeName));
120
+
121
+ /**
122
+ * The 409 body of a Preview the write guard stopped (spec/preview-unavailable.schema.json), or
123
+ * undefined for any other response. Only `code` decides; the title is protocol text.
124
+ */
125
+ export function blockedPreview(status, body) {
126
+ if (status !== 409 || !body || typeof body !== 'object' || body.code !== 'preview_unavailable') return undefined;
127
+ return {
128
+ detail: String(body.detail ?? ''), store: normal(body.store), operation: String(body.operation ?? ''),
129
+ title: String(body.title ?? ''), type: body.type,
130
+ };
131
+ }