@7n/rules 1.8.0 → 1.8.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.8.1] - 2026-07-17
4
+
5
+ ### Changed
6
+
7
+ - docs(adr): нормалізувати чернетки ADR у канонічний MADR-формат
8
+
3
9
  ## [1.8.0] - 2026-07-16
4
10
 
5
11
  ### Added
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@7n/rules",
3
- "version": "1.8.0",
3
+ "version": "1.8.1",
4
4
  "description": "CLI еталонних правил і skills (префікс n-): синк у репозиторій, дельта-lint, конформність",
5
5
  "keywords": [
6
6
  "cli",
@@ -7,7 +7,13 @@
7
7
  * - `batch-v1beta1-apiversion` — apiVersion batch/v1beta1 → batch/v1 (CronJob/Job);
8
8
  * - `schema-modeline-first` — перемістити `# yaml-language-server: $schema=…` у перший рядок;
9
9
  * - `kustomization-patches-sort` — впорядкувати `patches[]` (реюз детекторних sort-ключів);
10
- * - `deployment-strategy` — проставити канонічний `spec.strategy` RollingUpdate.
10
+ * - `deployment-strategy` — проставити канонічний `spec.strategy` RollingUpdate;
11
+ * - `hasura-configmap-env` — проставити обов'язкові `HASURA_GRAPHQL_*` env у Hasura ConfigMap;
12
+ * - `hasura-httproute-rule1-filters` — проставити канонічний RequestRedirect у правило 1
13
+ * Hasura-канона HTTPRoute (лише overwrite існуючого правила, без синтезу нових);
14
+ * - `svc-clusterip-type` — проставити `spec.type: ClusterIP` у `svc.yaml`;
15
+ * - `svc-hl-cluster-ip` — проставити `spec.clusterIP: None` у `svc-hl.yaml`
16
+ * (без перейменування `metadata.name`, суфікс `-hl` — не T0).
11
17
  *
12
18
  * Правки роблять через `yaml` Document/Documents (зберігають коментарі), окрім modeline
13
19
  * (чистий текст). Семантичну коректність гарантує canonical re-detect (rego) — T0
@@ -20,6 +26,9 @@ import { parseAllDocuments, parseDocument } from 'yaml'
20
26
 
21
27
  import {
22
28
  compareStringTuplesEn,
29
+ findHasuraCanonStart,
30
+ HASURA_REQUIRED_ENV_VALUES,
31
+ hasuraRuleHasExactRedirect,
23
32
  kustomizationPatchSortKey,
24
33
  loadSnippetSpec,
25
34
  replaceBatchV1beta1ApiVersionInYamlText,
@@ -127,6 +136,167 @@ export function ensureNetworkPolicyEgress(content) {
127
136
  return docs.map(d => d.toString().replace(LEADING_DOC_SEPARATOR_RE, '').trimEnd()).join('\n---\n') + '\n'
128
137
  }
129
138
 
139
+ /**
140
+ * Чи значення читається як логічне `true` (boolean або рядок, case-insensitive) —
141
+ * дзеркалить `is_value_true` з `k8s.hasura_configmap.rego`.
142
+ * @param {unknown} v значення з `data`
143
+ * @returns {boolean} true, якщо значення означає true
144
+ */
145
+ function isTruthyBool(v) {
146
+ if (v === true) return true
147
+ return typeof v === 'string' && v.trim().toLowerCase() === 'true'
148
+ }
149
+
150
+ /**
151
+ * Чи значення читається як логічне `false` — дзеркалить `is_value_false`.
152
+ * @param {unknown} v значення з `data`
153
+ * @returns {boolean} true, якщо значення означає false
154
+ */
155
+ function isFalsyBool(v) {
156
+ if (v === false) return true
157
+ return typeof v === 'string' && v.trim().toLowerCase() === 'false'
158
+ }
159
+
160
+ /**
161
+ * Проставляє обов'язкові `HASURA_GRAPHQL_*` env-ключі (`HASURA_REQUIRED_ENV_VALUES`,
162
+ * дзеркалить `k8s.hasura_configmap.rego`) у `data` документа `kind: ConfigMap`. Ключ з
163
+ * очікуванням `null` (наприклад `HASURA_GRAPHQL_DISABLE_EVENTING`) — довільне значення,
164
+ * T0 проставляє лише якщо ключ відсутній (дефолт `'true'`).
165
+ * @param {string} content вміст configmap.yaml
166
+ * @returns {string|null} новий вміст або null, якщо змін немає / парс невпевнений
167
+ */
168
+ export function ensureHasuraConfigMapRequiredEnv(content) {
169
+ let doc
170
+ try {
171
+ doc = parseDocument(content)
172
+ } catch {
173
+ return null
174
+ }
175
+ if (doc.errors?.length) return null
176
+ if (doc.get('kind') !== 'ConfigMap') return null
177
+
178
+ let changed = false
179
+ for (const [key, expected] of Object.entries(HASURA_REQUIRED_ENV_VALUES)) {
180
+ const current = doc.getIn(['data', key])
181
+ if (expected === null) {
182
+ if (current === undefined) {
183
+ doc.setIn(['data', key], 'true')
184
+ changed = true
185
+ }
186
+ continue
187
+ }
188
+ if (expected === 'true') {
189
+ if (!isTruthyBool(current)) {
190
+ doc.setIn(['data', key], 'true')
191
+ changed = true
192
+ }
193
+ continue
194
+ }
195
+ if (expected === 'false') {
196
+ if (!isFalsyBool(current)) {
197
+ doc.setIn(['data', key], 'false')
198
+ changed = true
199
+ }
200
+ continue
201
+ }
202
+ if (current !== expected) {
203
+ doc.setIn(['data', key], expected)
204
+ changed = true
205
+ }
206
+ }
207
+ if (!changed) return null
208
+ return doc.toString()
209
+ }
210
+
211
+ /**
212
+ * Проставляє канонічний RequestRedirect (правило 1 Hasura-канона, `k8s.hasura_httproute.rego`)
213
+ * у вже знайдене правило `Exact "<prefix>/ql"`. Фіксує лише **існуюче** правило (overwrite
214
+ * `filters`) — правила 2-4 (rule2/3/4_missing) потребують синтезу нового правила з
215
+ * `backendRef`, якого нізвідки достовірно вивести, тож НЕ T0 (за тим самим принципом, що й
216
+ * `internal-url-invalid` у `hasura/internal_urls`: людське рішення про інфраструктуру).
217
+ * @param {string} content вміст hr.yaml (HTTPRoute, може бути multi-doc)
218
+ * @returns {string|null} новий вміст або null, якщо змін немає / не застосовно / парс невпевнений
219
+ */
220
+ export function ensureHasuraHttpRouteRule1Filters(content) {
221
+ let docs
222
+ try {
223
+ docs = parseAllDocuments(content)
224
+ } catch {
225
+ return null
226
+ }
227
+ if (docs.some(d => d.errors?.length)) return null
228
+ let changed = false
229
+ for (const doc of docs) {
230
+ if (doc.get('kind') !== 'HTTPRoute') continue
231
+ const plainRules = doc.toJSON()?.spec?.rules
232
+ if (!Array.isArray(plainRules) || plainRules.length === 0) continue
233
+ const start = findHasuraCanonStart(plainRules)
234
+ if (start === null) continue
235
+ const consolePath = `${start.prefix}/ql/console`
236
+ if (hasuraRuleHasExactRedirect(plainRules[start.startIndex], consolePath)) continue // вже канонічно
237
+ const canonicalFilters = [
238
+ {
239
+ type: 'RequestRedirect',
240
+ requestRedirect: { statusCode: 302, path: { type: 'ReplaceFullPath', replaceFullPath: consolePath } }
241
+ }
242
+ ]
243
+ doc.setIn(['spec', 'rules', start.startIndex, 'filters'], doc.createNode(canonicalFilters))
244
+ changed = true
245
+ }
246
+ if (!changed) return null
247
+ return docs.map(d => d.toString().replace(LEADING_DOC_SEPARATOR_RE, '').trimEnd()).join('\n---\n') + '\n'
248
+ }
249
+
250
+ /**
251
+ * Проставляє `spec.type: ClusterIP` у документ `kind: Service` (`svc.yaml`, `k8s.svc_yaml.rego`).
252
+ * @param {string} content вміст svc.yaml (може бути multi-doc)
253
+ * @returns {string|null} новий вміст або null, якщо змін немає / не застосовно / парс невпевнений
254
+ */
255
+ export function ensureSvcClusterIpType(content) {
256
+ let docs
257
+ try {
258
+ docs = parseAllDocuments(content)
259
+ } catch {
260
+ return null
261
+ }
262
+ if (docs.some(d => d.errors?.length)) return null
263
+ let changed = false
264
+ for (const doc of docs) {
265
+ if (doc.get('kind') !== 'Service') continue
266
+ if (doc.getIn(['spec', 'type']) === 'ClusterIP') continue
267
+ doc.setIn(['spec', 'type'], 'ClusterIP')
268
+ changed = true
269
+ }
270
+ if (!changed) return null
271
+ return docs.map(d => d.toString().replace(LEADING_DOC_SEPARATOR_RE, '').trimEnd()).join('\n---\n') + '\n'
272
+ }
273
+
274
+ /**
275
+ * Проставляє `spec.clusterIP: None` у документ `kind: Service` (`svc-hl.yaml`, `k8s.svc_hl_yaml.rego`).
276
+ * Не чіпає `metadata.name` (суфікс `-hl`) — перейменування ресурсу впливає на посилання з
277
+ * інших файлів (ConfigMap/Deployment/HTTPRoute), тож НЕ T0.
278
+ * @param {string} content вміст svc-hl.yaml (може бути multi-doc)
279
+ * @returns {string|null} новий вміст або null, якщо змін немає / не застосовно / парс невпевнений
280
+ */
281
+ export function ensureSvcHlClusterIp(content) {
282
+ let docs
283
+ try {
284
+ docs = parseAllDocuments(content)
285
+ } catch {
286
+ return null
287
+ }
288
+ if (docs.some(d => d.errors?.length)) return null
289
+ let changed = false
290
+ for (const doc of docs) {
291
+ if (doc.get('kind') !== 'Service') continue
292
+ if (doc.getIn(['spec', 'clusterIP']) === 'None') continue
293
+ doc.setIn(['spec', 'clusterIP'], 'None')
294
+ changed = true
295
+ }
296
+ if (!changed) return null
297
+ return docs.map(d => d.toString().replace(LEADING_DOC_SEPARATOR_RE, '').trimEnd()).join('\n---\n') + '\n'
298
+ }
299
+
130
300
  /**
131
301
  * Застосовує текстовий трансформер до унікальних файлів із targets і пише зміни.
132
302
  * @param {import('../../../scripts/lib/lint-surface/types.mjs').LintViolation[]} targets violations із файлами для правки
@@ -224,5 +394,29 @@ export const patterns = [
224
394
  'networkpolicy-egress',
225
395
  ensureNetworkPolicyEgress,
226
396
  n => `канонічний spec.egress проставлено: ${n} файл(ів)`
397
+ ),
398
+ fileTransformPattern(
399
+ 'k8s-manifests-hasura-configmap-env',
400
+ 'hasura-configmap-env',
401
+ ensureHasuraConfigMapRequiredEnv,
402
+ n => `обов'язкові HASURA_GRAPHQL_* env проставлено: ${n} файл(ів)`
403
+ ),
404
+ fileTransformPattern(
405
+ 'k8s-manifests-hasura-httproute-rule1-filters',
406
+ 'hasura-httproute-rule1-filters',
407
+ ensureHasuraHttpRouteRule1Filters,
408
+ n => `правило 1 Hasura-канона (RequestRedirect) проставлено: ${n} файл(ів)`
409
+ ),
410
+ fileTransformPattern(
411
+ 'k8s-manifests-svc-clusterip-type',
412
+ 'svc-clusterip-type',
413
+ ensureSvcClusterIpType,
414
+ n => `svc.yaml spec.type: ClusterIP проставлено: ${n} файл(ів)`
415
+ ),
416
+ fileTransformPattern(
417
+ 'k8s-manifests-svc-hl-cluster-ip',
418
+ 'svc-hl-cluster-ip',
419
+ ensureSvcHlClusterIp,
420
+ n => `svc-hl.yaml spec.clusterIP: None проставлено: ${n} файл(ів)`
227
421
  )
228
422
  ]
@@ -2283,6 +2283,21 @@ export const HASURA_REQUIRED_ENV_KEYS = [
2283
2283
  'HASURA_GRAPHQL_DISABLE_EVENTING'
2284
2284
  ]
2285
2285
 
2286
+ /**
2287
+ * Очікувані значення `HASURA_REQUIRED_ENV_KEYS` (дзеркалить `k8s.hasura_configmap.rego`).
2288
+ * `'true'`/`'false'` — приймаються як boolean або рядок (case-insensitive); рядкове значення
2289
+ * (наприклад `ENABLED_LOG_TYPES`) — точний exact match; `null` — ключ обов'язковий, значення
2290
+ * довільне (T0 проставляє дефолт `'true'`, якщо ключ відсутній).
2291
+ */
2292
+ export const HASURA_REQUIRED_ENV_VALUES = {
2293
+ HASURA_GRAPHQL_ENABLE_REMOTE_SCHEMA_PERMISSIONS: 'true',
2294
+ HASURA_GRAPHQL_ENABLE_RELAY: 'false',
2295
+ HASURA_GRAPHQL_ENABLE_TELEMETRY: 'false',
2296
+ HASURA_GRAPHQL_ENABLED_LOG_TYPES: 'startup,http-log',
2297
+ HASURA_GRAPHQL_ENABLED_APIS: 'metadata,graphql,pgdump',
2298
+ HASURA_GRAPHQL_DISABLE_EVENTING: null
2299
+ }
2300
+
2286
2301
  const K8S_YAML_EXT_RE = /\.ya?ml$/iu
2287
2302
 
2288
2303
  /**
@@ -2720,7 +2735,7 @@ function hasuraRuleMatchesSinglePathNoHeaders(rule, pathType, pathValue) {
2720
2735
  * @param {string} toPath очікуваний `requestRedirect.path.replaceFullPath`
2721
2736
  * @returns {boolean} true — якщо filters відповідають канону редиректу
2722
2737
  */
2723
- function hasuraRuleHasExactRedirect(rule, toPath) {
2738
+ export function hasuraRuleHasExactRedirect(rule, toPath) {
2724
2739
  const r = asPlainRecord(rule)
2725
2740
  if (r === null) return false
2726
2741
  const filters = r.filters
@@ -2830,7 +2845,7 @@ function hasuraRuleIsWebsocket(rule, qlPath) {
2830
2845
  * @param {unknown[]} rules вміст `spec.rules` HTTPRoute
2831
2846
  * @returns {{ prefix: string, startIndex: number } | null} виявлений префікс і позиція правила 1 або null
2832
2847
  */
2833
- function findHasuraCanonStart(rules) {
2848
+ export function findHasuraCanonStart(rules) {
2834
2849
  for (const [i, rule] of rules.entries()) {
2835
2850
  const r = asPlainRecord(rule)
2836
2851
  const matches = r === null ? null : r.matches
@@ -3166,7 +3181,7 @@ function recordHasuraDeploymentName(rec, dir, hasuraByDir) {
3166
3181
  * звіряє канон 4 правил (див. `httpRouteHasuraCanonViolation` і k8s.mdc).
3167
3182
  * @param {string} root корінь репозиторію
3168
3183
  * @param {string[]} yamlFiles абсолютні шляхи до `*.yaml` під `k8s`
3169
- * @param {(msg: string) => void} fail callback реєстрації помилки
3184
+ * @param {(msg: string, opts?: string | { reason?: string, file?: string, data?: object }) => void} fail callback реєстрації помилки
3170
3185
  * @returns {Promise<void>} результат
3171
3186
  */
3172
3187
  async function validateHasuraHttpRouteCanon(root, yamlFiles, fail) {
@@ -3193,7 +3208,12 @@ async function validateHasuraHttpRouteCanon(root, yamlFiles, fail) {
3193
3208
  })
3194
3209
  for (const v of violations) {
3195
3210
  const rel = (relative(root, v.filename) || v.filename).replaceAll('\\', '/')
3196
- fail(`${rel}: ${v.message}`)
3211
+ // T0 автофіксить лише "rule1_filters" (детермінований overwrite існуючого правила);
3212
+ // rule2/3/4-missing вимагають синтезу нового правила з backendRef — не T0 (k8s.mdc).
3213
+ const hint = REGO_HINT_HASURA_HTTPROUTE_RULE1_RE.test(v.message)
3214
+ ? { reason: 'hasura-httproute-rule1-filters', file: rel, data: { kind: 'hasura-httproute-rule1-filters' } }
3215
+ : undefined
3216
+ fail(`${rel}: ${v.message}`, hint)
3197
3217
  }
3198
3218
  }
3199
3219
 
@@ -3613,7 +3633,7 @@ async function validateHasuraConfigMapRemoteSchemaPermissions(root, yamlFilesAbs
3613
3633
  })
3614
3634
  for (const v of violations) {
3615
3635
  const rel = (relative(root, v.filename) || v.filename).replaceAll('\\', '/')
3616
- fail(`${rel}: ${v.message}`)
3636
+ fail(`${rel}: ${v.message}`, { reason: 'hasura-configmap-env', file: rel, data: { kind: 'hasura-configmap-env' } })
3617
3637
  }
3618
3638
  if (violations.length === 0) {
3619
3639
  passFn(
@@ -6466,6 +6486,10 @@ export async function regenerateLegacyNetworkPolicyDocsInFile(npAbs, fail) {
6466
6486
  const REGO_HINT_DEPLOYMENT_STRATEGY_RE = /spec\.strategy має бути RollingUpdate/u
6467
6487
  const REGO_HINT_NETWORKPOLICY_EGRESS_RE = /відсутнє обовʼязкове egress-правило/u
6468
6488
  const REGO_HINT_KUSTOMIZATION_PATCHES_RE = /patches має бути за алфавітом/u
6489
+ /** Стадія `rule1_filters` `k8s.hasura_httproute` — єдина автофіксовна (overwrite існуючого правила, без синтезу нового). */
6490
+ const REGO_HINT_HASURA_HTTPROUTE_RULE1_RE = /правило 1 Hasura-канона \(rules\[\d+\]/u
6491
+ const REGO_HINT_SVC_CLUSTERIP_RE = /spec\.type[^\n]*ClusterIP|додай spec\.type: ClusterIP/u
6492
+ const REGO_HINT_SVC_HL_CLUSTERIP_RE = /spec\.clusterIP[^\n]*None|додай spec\.clusterIP: None/u
6469
6493
  /**
6470
6494
  * Structured fix-hint (#3) для rego-violation із `runAllK8sRego` — щоб T0
6471
6495
  * (`fix-manifests.mjs`) автофіксив детерміновано, не парсячи message. Класифікація
@@ -6486,6 +6510,12 @@ function k8sRegoFixHint(ns, file, message) {
6486
6510
  if (ns === 'k8s.kustomization' && REGO_HINT_KUSTOMIZATION_PATCHES_RE.test(m)) {
6487
6511
  return { reason: 'kustomization-patches-sort', file, data: { kind: 'kustomization-patches-sort' } }
6488
6512
  }
6513
+ if (ns === 'k8s.svc_yaml' && REGO_HINT_SVC_CLUSTERIP_RE.test(m)) {
6514
+ return { reason: 'svc-clusterip-type', file, data: { kind: 'svc-clusterip-type' } }
6515
+ }
6516
+ if (ns === 'k8s.svc_hl_yaml' && REGO_HINT_SVC_HL_CLUSTERIP_RE.test(m)) {
6517
+ return { reason: 'svc-hl-cluster-ip', file, data: { kind: 'svc-hl-cluster-ip' } }
6518
+ }
6489
6519
  // немає збігу — implicit undefined (без trailing return: no-redundant-jump + no-useless-undefined тихі)
6490
6520
  }
6491
6521