Попередження та вивід лінтера
Нефатальні попередження, які компілятор видає під час компіляції. Попередження не зупиняють збірку — вони виявляють недоліки в написанні, детерміновані розв’язання нічиїх, які обрав компілятор, і ресурси, яких шаблони розробника так і не використали. Кожна знахідка потрапляє до stderr із префіксом, що вказує її вид, — warning:, lint: або notice:, залежно від того, який прохід її виявив, — тож конвеєри CI можуть перехоплювати їх і показувати знову; згенеровані артефакти створюються попри це.
Про фатальні зупинки компіляції (діагностики, що зупиняють збірку) див. fatal-halts.md.
Усі попередження за коротким кодом
Частина того, про що компілятор повідомляє без зупинки збирання, є окремою умовою: вона має короткий код — такий самий чотирицифровий ідентифікатор, який друкує діагностика, що зупиняє збирання, — і фіксоване речення, з якого починається її повідомлення. Таблиця нижче зіставляє одне з іншим, тож код, який у вас є, вказує на суть знахідки, навіть коли рядок, який ви читаєте, є попередженням, а не зупинкою.
Місце тут визначає оголошення, а не опис. Кожне правило, яке перевіряє компілятор, вказує, що робить порушення, — зупиняє збирання або повідомляє про знахідку й дає збиранню завершитися, — і рядки нижче належать до другого типу. Тож попередження, додане до компілятора, з’являється тут без написаного вручну рядка, а те, що стає умовою зупинки, звідси зникає.
Дві межі того, що охоплює таблиця, і обидві варто знати, перш ніж вирішити, що код відсутній:
- Не все на цій сторінці належить до них. Кілька знахідок, описаних нижче, виявляє окремий прохід, а не оголошене правило, а деякі взагалі не мають умови — рядки, які вони друкують, усе одно точно такі, як описано в їхніх розділах, але коду для пошуку немає, а отже, немає й рядка. Код класу
unsupported-field— саме такий випадок: він називає клас знахідок, а не умову. - Рядок тут не обіцяє розділу нижче. Попередження, що виникає на пізньому етапі рендерингу, лише каталогізовано, а не описано, тож код може вказувати на речення тут, а докладніше його розглянуто в fatal-halts.md у розділі «Conditions that do not halt a build», де каталогізовано всі умови з кодом, які не зупиняють збирання.
sentinels.md пояснює будь-який короткий код, який друкує збирання, — як попередження, так і зупинки, — і з нього варто почати, коли ви ще не знаєте, з яким типом маєте справу.
| Короткий код | Починається з |
|---|---|
E0004 | annotation contribution overridden by an explicit value |
E0037 | cross-boundary link between endpoints rendered by different providers is not supported |
E0149 | attachment name is a near miss for a declared slot |
E0167 | Recipe publishes a provides key its Component does not declare |
E0173 | declared parameter is read by no reference in the Aggregate |
E0174 | uses socket name is a near miss for a declared socket |
E0256 | annotation binding declares one path in both pillar lists |
E0297 | inherited boundary directory carries no template variable, so it resolves to the path the extended Release writes to |
Лінт перекриття стовпів схеми
Спрацьовує, коли сутність Component або Feature оголошує однакову назву властивості в обох стовпах, values: та infra:, свого блоку spec.schema: на однаковій глибині вкладеності. Автори схем, які розміщують однакову назву поля в обох стовпах, зазвичай мають на увазі лише один із них; лінт позначає дублювання, щоб автор міг вирішити, якому стовпу належить поле.
Місце в конвеєрі. Лінт виконується на етапі валідації після уніфікації схем, перед побудовою топології. Він обходить схему після розгортання компактної форми, не переходячи за $ref: (див. правило м’якого пропуску нижче), і повідомляє про кожну властивість, що перекривається, окремим попередженням.
Форма виводу:
notice: LINT: Component "core/compute/web-server:1.0.0" at ./catalog/component/core/compute/web-server/1.0.0/component.yaml declares property "storage_size" in both values: and infra: pillars (path: storage_size)Для вкладених властивостей шлях — це шлях через крапку до властивості від кореня стовпа:
notice: LINT: Feature "core/db-pool:1.0.0" at ./catalog/feature/core/db-pool/1.0.0/feature.yaml declares property "timeout" in both values: and infra: pillars (path: connection.timeout)Завантаження всього каталогу — aggrega validate без аргументу — називає кожну сутність за назвою та версією і за файлом, з якого її прочитано, як показано вище. Збірка або валідація однієї сутності Release читає лише ті сутності, до яких ця Release дотягується, і називає кожну за її назвою та версією — at core/db-pool:1.0.0 — один раз на сутність, хоч скільки посилань у Release до неї ведуть: сутність Aggregate, що називає Feature за самою назвою, і сутність Manifest, що зіставляє її за назвою та версією, ведуть до однієї Feature, про яку повідомляється один раз.
Видимість у редакторі. Знахідка потрапляє в діагностику редактора через мовний сервер, з рівнем попередження, на початок файлу, а не на ключ — вона називає сутність каталогу, а не позицію в документі, який ви редагуєте, тож немає ключа автора, на якому могла б стояти позначка. Її виявляють до етапу рендерингу артефактів, тому вона не потребує перемикача: сеанс редактора показує її незалежно від того, чи ввімкнено serve.build_on_inspect.
Дисципліна м’якого пропуску. Обхід завершується без попередження, коли гілка схеми містить один із запасних виходів JSON Schema 2020-12, що унеможливлюють статичне виведення наборів властивостей: $ref (посилання між документами або в межах документа), patternProperties (оголошення властивостей за формою ключа), additionalProperties, встановлене в true або в схему (властивості, які гілка допускає, не називаючи їх), та оператори композиції oneOf / anyOf / allOf (диз’юнкції та кон’юнкції, гілки яких можуть оголошувати різні набори властивостей). Обхід таких гілок або вимагав би обчислення схеми, на яку посилаються чи яку скомпоновано, під час лінтування (клас роботи, якого лінт не виконує), або давав би хибні спрацьовування, коли назва властивості values: однієї гілки випадково збігається з назвою властивості infra: іншої гілки. Для відповідної глибини вкладеності лінт не видає попередження; глибші рівні тієї самої схеми все одно обходяться та лінтуються.
Примітка для авторів. Компілятор не відхиляє перекриття назв у стовпах — лінт є лише рекомендаційним. Сутність Component зі storage_size в обох стовпах компілюється; values.storage_size з боку розробника та infra.storage_size з боку оператора валідуються незалежно схемами своїх стовпів, а шаблон valuesMapping: сутності Recipe обирає, значення якого стовпа потрапляє у відрендерений вивід. Лінт існує тому, що такий шаблон авторства майже завжди є помилкою; свідоме дублювання між стовпами трапляється настільки рідко, що автори, яким воно справді потрібне, можуть ігнорувати попередження. Про ширшу механіку між стовпами — зокрема рідкісні випадки, коли навмисна передача між стовпами виправдана, — див. vocabulary/data-pillars.md, розділ «Cross-pillar mechanics».
Лінт перекриття binding-map
Спрацьовує, коли прив’язка анотації в сутності Manifest оголошує той самий шлях через крапку і в списку maps.infra, і в списку maps.values. Такий шлях пролягав би через обидва стовпи; детерміноване розв’язання конфлікту компілятором спрямовує його через infra:, через що бік values: стає недосяжним із сутності Aggregate. Лінт повідомляє про це, щоб автор міг або звузити прив’язку до одного стовпа, або свідомо прийняти маршрутизацію лише через бік infra.
Місце в конвеєрі. Лінт запускається після розв’язання сутності Manifest і до того, як спрацьовує будь-яке розгортання анотацій, тож збірка повідомляє про прив’язку з перекриттям незалежно від того, чи досягає її колись анотація сутності Aggregate. Лінт обходить прив’язки в mappings.features.annotations у тому порядку, в якому їх написано, перетинає списки maps.infra і maps.values кожної прив’язки та повідомляє по одній знахідці на кожен шлях із перекриттям. У межах однієї прив’язки шляхи з перекриттям повідомляються в порядку, в якому їх оголошує список maps.values цієї прив’язки, — у порядку, в якому ви їх написали, — тож повторні запуски на однакових вхідних даних повідомляють однакову послідовність.
Форма виводу:
lint: annotation binding declares one path in both pillar lists (Manifest, at .spec.mappings.features.annotations, "compliance.aggrega.ai/data-class", on Feature "core/pii-redaction", at path "classifier_endpoint", which the routing tie-break sends through the pillar "infra", declare a second binding under another annotation key to route it through "values") lint: annotation binding declares one path in both pillar lists (Manifest, at .spec.mappings.features.annotations.audit-scope, "audit-scope", on Feature "core/pii-redaction", at path "retention_endpoint", which the routing tie-break sends through the pillar "infra", declare a second binding under another annotation key to route it through "values")Ці два рядки походять з однієї збірки над однією сутністю Manifest, а відрізняє їхні локатори форма ключа анотації. Локатор адресує документ шляхом через крапку, тож він зупиняється на першому сегменті, що сам містить крапку: audit-scope її не містить, і локатор досягає прив’язки, тоді як compliance.aggrega.ai/data-class містить, і локатор натомість називає блок annotations, у якому він міститься. Саме тому ключ-порушник також є першим значенням у лапках кожної знахідки — це та частина, яку локатор не завжди може передати.
Видимість у редакторі. Знахідка також потрапляє до діагностики редактора через мовний сервер, із рівнем серйозності warning, і розташовується там, куди сягає її локатор: на самій прив’язці для простого ключа і на охопному блоці annotations для ключа, що містить крапку. Автор, який ніколи не читає виведення в терміналі, все одно її бачить. Вона виникає до етапу рендерингу артефактів, тож не потребує перемикача: сеанс редактора показує її незалежно від того, чи ввімкнено serve.build_on_inspect.
Програмне зіставлення. Знахідка містить ErrAnnotationBindingPillarOverlap з pkg/resolver, тож споживач розпізнає клас за допомогою errors.Is, а не зіставленням тексту повідомлення. Як і будь-який дорадчий сентинел, вона ніколи не впливає на вердикт збірки — див. sentinels.md щодо методу доступу та кодів умови.
Детерміноване розв’язання конфлікту. Середовище виконання розв’язує колізію, спрямовуючи шлях виключно через стовп infra:. Цей вибір однаковий у всіх збірках; автор може на нього покладатися. Бік values: вилучається з фактичної маршрутизації прив’язки — анотації з боку Aggregate, що намагаються досягти цього шляху, не отримують цілі маршрутизації, і збірка зупиняється на боці Aggregate під час розгортання із зупинкою, описаною в fatal-halts.md «An annotation routes through a pillar its authoring side may not use (Анотація маршрутизується через стовп, який її бік написання не може використовувати)». Лінт — це засіб раннього попередження; ця зупинка — засіб примусового виконання.
Примітка для авторів. Як і лінт перекриття стовпів схеми, цей лінт є дорадчим — прив’язка компілюється, а розв’язання конфлікту під час виконання дає детерміноване виведення. Лінт спрацьовує, бо такий шаблон написання майже завжди ненавмисний; автор прив’язки, який справді хотів би, щоб обидва стовпи маршрутизували той самий шлях, написав би дві окремі прив’язки з різними ключами анотацій.
Лінт близького збігу зі слотом приєднання
Спрацьовує, коли екземпляр компонента приєднує Feature під ім’ям, яке не є жодним з оголошених слотів featuresSchema його типу Component, але відрізняється від одного з них на одне редагування — один вставлений, видалений чи замінений символ або два сусідні символи, переставлені місцями, — і selector цього слота приєднана Feature не задовольняє. Саме так виглядає друкарська помилка в імені слота, і лінт називає обидва написання, щоб автор бачив цю пару.
Навіщо він існує. Оголошення слота не закриває поверхню приєднань: приєднання під ім’ям, яке не оголошує жоден слот, допустиме, бо саме ця відкритість дає змогу одній сутності каталогу слугувати і для приєднання, що заповнює слот, і для облікових даних, спільних на ширшому рівні. Ціна в тому, що неправильно написане ім’я слота мовчки стає вільним приєднанням, а не заповненням слота, який мав на увазі автор, — збірка завершується успішно, а слот просто лишається порожнім. Лінт є задекларованим пом’якшенням саме для цього випадку.
Місце в конвеєрі. Лінт виконується під час розв’язання, в тому самому проході, що й семантичні перевірки з урахуванням каталогу, над розв’язаною сутністю Aggregate. Він звіряє імена приєднань кожного екземпляра компонента з оголошеними іменами слотів типу Component цього екземпляра й видає одне попередження на кожну пару близького збігу.
Форма виводу:
lint: attachment name is a near miss for a declared slot (Aggregate nearmiss, at .spec.components.db.features.app_user_passwrod, "app_user_passwrod", on component type "core/datastore/postgres", near the declared slot "app_user_password")Перше значення в лапках — ім’я, під яким записано приєднання, і саме про нього йдеться в першому реченні попередження. Два наступні вводяться словами, що кажуть, чим вони є: тип Component, на якому розміщено приєднання, та оголошений слот, від якого воно відрізняється на одне редагування.
Видимість у редакторі. Попередження також потрапляє до діагностики редактора через мовний сервер, із рівнем серйозності warning, і розташовується на проблемному ключі приєднання. Автор, який ніколи не читає вивід термінала, однаково бачить цю пару. Воно виникає до етапу рендерингу артефактів, тож не потребує жодного перемикача: сеанс редактора показує його незалежно від того, чи ввімкнено serve.build_on_inspect.
Поріг і його компроміс. Лінт зіставляє імена лише на відстані одного редагування і лише тоді, коли обидва імені мають щонайменше чотири символи. Коротші імена майже всі відрізняються одне від одного на одне редагування, тож їх зіставлення давало б шум, а не сигнал; понад одне редагування пари перестають бути схожими на друкарські помилки. Перестановка рахується як одне редагування, а не два, бо переставлена пара символів — найпоширеніша помилка, і суворіший підрахунок її б пропускав.
Примітка для авторів. Лінт має рекомендаційний характер і ніколи не змінює вердикт збірки — компілятор не контролює, як автор називає приєднання. Автор, який навмисно приєднує Feature під ім’ям, схожим на слот, може ігнорувати попередження; приєднання поводиться точно так, як його записано.
Не тоді, коли Feature підходить до слота. Ім’я, що відрізняється на одне редагування від слота, чий selector приєднана Feature задовольняє, попередження не викликає. Така пара — не помилково написане вільне приєднання, а заповнення, записане під іншим ім’ям, і чи це важливо, залежить від того, чи лишиться слот порожнім, а це відомо лише після згортання всіх рівнів. Якщо слот лишається порожнім, збірка зупиняється й називає приєднання та слот — див. «An attachment written under another name fits a slot its component leaves empty (Приєднання, записане під іншим ім’ям, підходить до слота, який його компонент лишає порожнім)» у fatal-halts.md, — тож ця зупинка є єдиною повідомленою знахідкою, без попередження поруч. Якщо слот зв’язує щось інше, приєднання є звичайним додатковим, і нічого не повідомляється. Слот, що не оголошує selector, не підходить для жодної Feature, тож ім’я, близьке до такого слота, завжди викликає попередження.
Не на з’єднанні. Лінт читає власний блок features: компонента, який є відкритим. Приєднання, які несе з’єднання, мають ключами слоти, оголошені його сокетом, і нічого іншого, тож ім’я на відстані одного редагування від одного з цих слотів там недопустиме: натомість збірка зупиняється, і зупинка в тому самому реченні називає слот, до якого близьке це ім’я. Попередження поруч не виникає. Див. «A connection carries an attachment under a name its socket declares no slot for (З’єднання несе приєднання під ім’ям, для якого його сокет не оголошує слота)» у fatal-halts.md.
Лінт майже збігу назви сокета в uses
Спрацьовує, коли власний блок uses: компонента називає сокет, що не є одним з оголошених сокетів usesSchema його типу Component, але відрізняється від одного з них на одне редагування — один вставлений, видалений чи замінений символ або два сусідні символи, переставлені місцями. Саме такий вигляд має друкарська помилка в назві сокета, і лінт називає обидва написання, щоб автор бачив пару.
Навіщо він існує. Оголошення сокета не закриває поверхню uses: у власному компоненті розробника: назва сокета, яку не оголошує жоден запис usesSchema, допустима, бо мовчання каталогу щодо сокета означає, що з’єднання не передбачили, а не заборонили, і топологією сутності Aggregate володіє розробник. Ціна цього в тому, що назва сокета з помилкою стає окремим ad-hoc з’єднанням, а не підключенням сокета, який мав на увазі автор, — збірка успішна, задуманий сокет просто лишається непідключеним, а ad-hoc ребро не має ні селектора, ні контракту на рівні ребра. Лінт — це оприлюднений захід пом’якшення саме для цього випадку. Про те, від чого відмовляється ad-hoc сокет і що він зберігає, див. entities/component.md «Сокети топології: usesSchema».
Яку поверхню він охоплює. Лише власний блок uses: компонента — єдину поверхню, де приймається неоголошена назва сокета. uses: прикріплення Feature може називати лише сокет, який оголошує прикріплена Feature, а uses: на рівні ребра в Release може називати лише сокет, який оголошує споживацький Component; хибна назва в будь-якому з цих місць уже зупиняє збірку, тож попередженню нічого додати.
Місце в конвеєрі. Лінт виконується під час розв’язання, у тому самому проході, що й семантичні перевірки з урахуванням каталогу, над розв’язаним Aggregate. Він звіряє власні назви сокетів кожного екземпляра компонента з оголошеними назвами сокетів типу Component цього екземпляра і видає одне попередження на кожну пару майже збігу. Компонент, що надходить із підагрегата, не охоплюється: його внутрішні компоненти вбудовуються в граф уже після цього проходу.
Форма виводу:
lint: uses socket name is a near miss for a declared socket (Aggregate aggregate, at .spec.components.web, "databses", on component type "core/devtool/adminer", near the declared socket "databases")Перше значення в лапках — назва сокета, яку написав автор, і саме про неї йдеться в першому реченні попередження. Два наступні вводяться словами, що кажуть, чим вони є: тип Component, на якому назвали сокет, і оголошений сокет, від якого назва відрізняється на одне редагування. Наслідок, який попередження не розписує, — той, що описано вище: назва з помилкою є ad-hoc з’єднанням, тож вона не має ні селектора, ні контракту на рівні ребра, а сокет, який мав на увазі автор, лишається непідключеним.
Видимість у редакторі. Попередження також потрапляє до діагностики редактора через мовний сервер, із рівнем серйозності warning, і прив’язується до компонента, чий блок uses: містить проблемну назву. Автор, який ніколи не читає вивід термінала, однаково бачить пару. Воно виникає до етапу рендерингу артефактів, тож не потребує перемикача: сеанс редактора показує його незалежно від того, чи ввімкнено serve.build_on_inspect.
Поріг і його компроміс. Лінт зіставляє назви лише на відстані одного редагування і лише тоді, коли обидві назви мають щонайменше чотири символи, — та сама межа, що й у лінта майже збігу слота прикріплення, з тієї самої причини. Нижче цієї довжини майже кожна коротка назва відрізняється від будь-якої іншої на одне редагування, тож їх зіставлення давало б шум, а не сигнал; понад одне редагування пари перестають бути схожими на друкарські помилки. Перестановка рахується як одне редагування, а не два, бо переставлена пара символів — найпоширеніша помилка, і суворіший підрахунок її пропускав би.
Примітка для авторів. Лінт має рекомендаційний характер і ніколи не змінює вердикт збірки — компілятор не контролює, як автор називає сокет. Автор, який навмисно створює ad-hoc з’єднання під назвою, схожою на оголошений сокет (з’єднання cache поруч з оголошеним сокетом caches, призначене для іншого), може ігнорувати попередження; ребро поводиться саме так, як його написано. Прапорця для його вимкнення немає, і він не потрібен: попередження не впливає на вердикт.
Лінт неоголошеного ключа provides
Спрацьовує, коли Recipe, прив’язаний до екземпляра компонента, публікує у своєму provides: ключ, який тип Component цього екземпляра не оголошує у своєму контракті spec.schema.provides:.
Навіщо він існує. Публікувати більше, ніж оголошує Component, допустимо, і так буде й надалі: контракт provides вимагає підмножини й дозволяє надмножину, тож Recipe, що покриває контракт свого Component і додатково видає зайві ключі, — це Recipe, який цей контракт виконує. Лінт називає наслідок, який інакше непомітний з жодного боку. Споживач, що читає через ребро uses:, бачить оголошений контракт цілі, а не те, що випадково видає Recipe цілі, — саме це забезпечує взаємозамінність Recipes: два Recipes, що реалізують один Component, тоді надають споживачеві однакову поверхню, і їх заміна не може непомітно прибрати ключ, від якого споживач почав залежати. Тому неоголошений ключ не передається через ребро, а шаблон-споживач, який його читає, рендерить порожнє значення замість того, щоб завершитися помилкою.
Знахідка повідомляється в місці її причини — на Recipe, що опублікував ключ, — бо саме там її можна назвати. У споживача ключ є посиланням у шаблоні, яке компілятор не може віднести до конкретної цілі, а діагностика, що вгадувала б, була б гіршою за її відсутність. Тому ці два місця навмисно не збігаються: порожнє значення з’являється у споживача, пояснення — тут, і обидва потрапляють у той самий вивід збирання.
Що з чим порівнюється. Написані автором ключі provides: прив’язаного Recipe порівнюються з оголошеними ключами spec.schema.provides: типу Component. Це та сама оголошена множина, з якою перевіряється ключ from: усередині блоку inject:, тож обидві перевірки однаково розуміють, що оголошує Component. Порівняння точне, а не перевірка схожості, тому, на відміну від двох лінтів близьких збігів вище, воно не має порогу і не утворює пар назв.
Порівнюється той Recipe, до якого екземпляр фактично прив’язаний, — за тим самим іменем екземпляра і типом каталогу, за якими прив’язує рендеринг, тож перевизначення Recipe для окремого екземпляра в Manifest враховується, а не усереднюється. Екземпляр компонента, тип якого не відповідає жодному Component каталогу, пропускається: жодне оголошення не було прочитано, а це не те саме, що оголошення порожньої множини.
Місце в конвеєрі. Лінт виконується під час розв’язання, у тому самому проході, що й семантичні перевірки з урахуванням каталогу, над розв’язаною сутністю Aggregate — до рендерингу, тож він з’являється як у aggrega validate --release, так і в aggrega build. Охоплено і Components, оголошені в корені сутності Aggregate, і компоненти, вкладені в підсистеми. Компонент, що надходить із вкладеного агрегату, не охоплено: його внутрішні компоненти вбудовуються в граф уже після цього проходу, тож неоголошений ключ такого компонента й далі приховано від споживачів, але жодне попередження його не називає.
Формат виводу. Один рядок на кожну пару екземпляра компонента й ключа, що називає Recipe, який опублікував ключ, і Component, що його не оголошує:
lint: Recipe publishes a provides key its Component does not declare (Recipe broker-with-region, at .spec.provides.region, "region", on component type "core/ai-model/openai-compatible", bound to component instance "gateway")Знахідка належить екземпляру, якого вона стосується, тож десять екземплярів одного типу Component, що публікують той самий неоголошений ключ, дають десять рядків, а не один, і кожен називає свій екземпляр. Кожен рядок віднесено до Recipe, що опублікував ключ, бо саме цей документ ви редагуєте, щоб усунути проблему. Обхід детермінований, тож той самий вхід дає ту саму послідовність попереджень під час кожного запуску.
Видимість у редакторі. Попередження також потрапляє в діагностику редактора через мовний сервер, із рівнем серйозності warning, і розміщується на екземплярі компонента, чий type: прив’язує Recipe. Автор, який ніколи не читає вивід термінала, однаково його бачить. Воно виникає до етапу рендерингу артефактів, тож не потребує перемикача: сеанс редактора показує його незалежно від того, чи ввімкнено serve.build_on_inspect.
Примітка для авторів. Лінт має рекомендаційний характер і ніколи не змінює результат збирання — Recipe, що публікує більше, ніж оголошує його Component, усе одно збирається. Виправлень два, і яке з них правильне, вирішує автор: оголосити ключ у Component, якщо споживачі мають його читати, або залишити його неоголошеним, якщо це власний робочий стан Recipe, — у такому разі місце для такого стану в locals:. Протилежний випадок не є рекомендаційним: Component, що оголошує ключ, який його Recipe не публікує, залишає контракт невиконаним і зупиняє збирання.
Попередження Ghost Infrastructure Tracker
Спрацьовує, коли ключ, оголошений автором, досягає вузла, а жоден шаблон, оголошений прив’язаною сутністю Recipe, ніколи на нього не посилається. Непрочитані ключі стають тихою інфраструктурою: конфігурацією, яку запросив розробник або оператор, але яку Recipe ніколи не передає у відрендерений вихід. Трекер показує їх, щоб розбіжність між написаним і тим, що містить вихід, була видимою, а не прихованою.
Які написані ключі порівнюються. Три групи для кожного вузла:
.values— власний стовп вузла з боку розробника..infra— власний стовп вузла з боку оператора..context.uses.<alias>.values— значення для окремого з’єднання, що передаються на кожному ребріuses:, через яке вузол споживає. Ця група автоматично обмежена споживачем: мапаusesвузла містить лише ребра, джерелом яких він є, тож непрочитане значення з’єднання завжди приписується вузлу, який його написав, і ніколи цілі ребра.
Які посилання збираються. Кожен шаблон, оголошений прив’язаною сутністю Recipe. Попередження стверджує, що ключ не читає ніщо, а це твердження про всю Recipe, тож будь-що вужче за всю Recipe зробило б його хибним, а не наближеним: ключ, який споживає координата source:, було б позначено непрочитаним тим самим запуском, що завантажив названу ним версію. Читаються такі блоки:
valuesMapping:— накладка значень, що передається провайдеру.source:— усе поле, якщо воно написане як один рядок, і кожне його рядкове поле, якщо воно написане як об’єкт. Координата джерела — це шаблон, що обчислюється для кожного споживчого екземпляра, тож версія, назва чарту, git-посилання чи підкаталог модуля, обрані з.valuesабо.infra, читають ці ключі.locals:іprovides:, кожен запис.assertions:, кожен запис.workload:— синтезоване тіло сутності Workload.artifacts:— вміст кожного запису.pipeline:— вхідwith:кожного кроку та його умоваwhen:.
Далі йдуть три обмеження, і всі три є межами того, що можна чесно стверджувати, а не довільним вибором. Кожне з них приглушує читання, а не розширює його, і цей напрям найдешевший: незвітований ключ коштує читачеві одного попередження, яке він усе одно може знайти, прочитавши Recipe, тоді як хибно звітований повідомляє йому, що робоче налаштування проігноровано.
- Recipe без вбудованого
valuesMapping:не читається взагалі. Її ключі пропускаються, а не звітуються, хоч би що робили інші її шаблони. - Блоку, який Recipe імпортує з файлу чи з посилання на бібліотеку, на цьому етапі немає під рукою, тож його посилання неможливо зібрати. Ключі вузла повністю пропускаються, а не звітуються — це однаково стосується імпортованого
valuesMapping:, імпортованогоworkload:та імпортованого записуartifacts:. - Шаблон, який не вдається розібрати, не дає жодного набору посилань. Звітування кожного ключа як непрочитаного поховало б діагностику розбору, яку обчислення видає для того самого шаблону, тому натомість нічого не звітується. Запис
artifacts:читається зі стандартними роздільниками{{ }}, а це не та пара, яку кожен провайдер оголошує для цього поля; прочитане з неправильною парою, таке тіло дає посилання, яких автор ніколи не писав, або не розбирається, і обидва наслідки лише приглушують попередження.
valueSchema сокета ніколи не позначається. usesSchema.<socket>.valueSchema оголошує контракт, якому має відповідати значення з’єднання. Це схема, а не написаний екземпляр, і вона не входить до порівнюваних входів — тож її ніколи не може бути звітовано. Те, що створює оголошене за замовчуванням значення сокета, є екземпляром, як і будь-який інший, прочитаним чи непрочитаним залежно від нього самого.
Посилання на весь стовп вважає прочитаним кожен ключ під ним. {{ .infra.port }} позначає port як прочитаний і залишає інші ключі стовпа придатними для попередження. {{ optional .infra `port` 8080 }} передає всю мапу .infra функції, тож зібране посилання називає стовп, а не ключ під ним, кожен ключ цього стовпа вважається прочитаним, і стовп нічого не видає. Те саме стосується ітерації range по стовпу та доступу до одного запису uses через index. Автор Recipe, якому потрібне покриття окремих ключів, пише посилання на окремі ключі.
Це поширюється на всі блоки вище, і це варто знати, перш ніж вважати тихий стовп пропущеним попередженням: Recipe, у якої версію source: написано як {{ optional .infra `source_version` "1.2.3" }}, передала функції всю мапу .infra, тож ця Recipe нічого не звітує про жоден ключ .infra на жодному вузлі, який вона рендерить. Стовп .values це не зачіпає — обидва рахуються окремо.
Місце в конвеєрі. Трекер працює на етапі базового рендерингу, поряд з обчисленням шаблонів. Кожен шаблон Recipe розбирається й обходиться, щоб зібрати шляхи полів через крапку, на які він посилається (.values.port, .infra.replicas, .context.uses.<alias>.values.retry_budget); розв’язаний набір ключів кожної групи порівнюється з об’єднанням цих посилань, і різниця становить непрочитаний набір. Обходиться Recipe у написаному вигляді: координата source: читається як текст шаблону, а не як значення, яке цей шаблон дав для цього екземпляра.
Форма виводу. Один рядок на кожен непрочитаний ключ із назвою вузла, шляху групи, ключа та Recipe, жоден шаблон якої його не читає:
warning: node "data.main-db": .values key "database_name" is read by no template in recipe "helm-postgres-sourced-with-artifacts" — correct the spelling, or remove the key warning: node "data.main-db": .infra key "storage_class" is read by no template in recipe "helm-postgres-sourced-with-artifacts" — correct the spelling, or remove the key warning: node "frontend": .context.uses.my-api.values key "retry_budget" is read by no template in recipe "helm-web-ui-sourced-with-artifacts" — correct the spelling, or remove the keyРядок не називає жодного поля Recipe, і це навмисно: автором ключа є розробник, оператор або автор ребра uses:, яким він передається, і ніхто з них не редагує Recipe. Назва блоку, в якому шукали посилання, дала б такому читачеві координату в документі, який він не відкриває. Два способи виправлення, які пропонує рядок, — це ті два, якими він може скористатися: найчастіша причина — помилка в написанні ключа, а ключ, який ніколи не мав читатися, варто видалити.
Порядок фіксований: .values вузла, потім його .infra, потім кожен псевдонім uses у порядку виведення ребер, з ключами, відсортованими в межах кожної групи. Тому той самий вхід на кожному запуску дає ту саму послідовність попереджень.
Видимість у редакторі. Попередження потрапляє до діагностики редактора лише тоді, коли мовний сервер виконує етап рендерингу артефактів під час огляду графа IR — aggrega serve --build-on-inspect або ключ конфігурації serve.build_on_inspect, який він перевизначає і який за замовчуванням вимкнено. Цей перемикач додає попередження, які збірка видає під час рендерингу, і жодної з перевірок, на яких збірка зупиняється. Запис називає вузол, а не написаний ключ, тож він відображається на ключі kind: сутності Aggregate.
Чому попередження, а не фатальна зупинка. Розробники можуть цілком законно споживати різні підмножини .values в умовній логіці шаблонів — Recipe, шаблон якої розгалужується за .values.mode, читає mode, але умовно читає .values.replication_password лише тоді, коли mode == "replication". Статичний обхід не може визначити, чи є ключ без посилань байдужим, чи помилкою. Мета трекера — зробити розбіжність видимою, а не контролювати її; тихе пропускання — це той збій, якому трекер запобігає.
Реакція автора Recipe. Коли автор Recipe бачить попередження Ghost Infrastructure для ключа, який, на його думку, мала споживати Recipe, виправлення полягає в тому, щоб передати ключ у шаблон. Коли непрочитаний ключ — навмисний пропуск (можливість, яку чарт не підтримує, або зручність написання, яку Recipe свідомо ігнорує), автор може задокументувати пропуск у коментарі-заголовку Recipe, щоб майбутні читачі знали, що розбіжність навмисна.
Попередження про непрочитані оголошені параметри
Спрацьовує, коли сутність Aggregate оголошує запис у spec.parameters:, і жодне посилання {{ .parameters.<key> }} у власному тексті цієї сутності Aggregate його не читає.
Оголошений параметр — це засіб авторингу для зміни одного значення залежно від сутності Release: сутність Release виконує оголошення, а посилання переносить отримане значення у значення компонента, до яких воно належить. Оголошення, яке ніщо не читає, залишає цю варіативність без місця призначення: що б не надала для нього сутність Release, згенерований результат той самий. Це форма на рівні параметрів того самого недоліку, що й у авторського ключа значень, який ніщо не споживає.
Значення за замовчуванням не є винятком. Значення за замовчуванням, яке не читає жодне посилання, потрапляє у результат не більше, ніж значення, надане сутністю Release, тож оголошення зі значенням за замовчуванням повідомляється так само, як і оголошення без нього.
Які посилання збираються. Власний текст сутності Aggregate, і нічого більше. З цього випливають три наслідки:
- Параметр, до якого звертається лише предикат
validate:схеми сутності Component, тут не видно. Такий предикат називає параметр через розв’язану мапу параметрів, а не через посилання з крапками в сутності Aggregate, тому оголошення повідомляється як непрочитане, хоча предикат його читає. - Текст, який не розбирається як шаблон, не дає жодного набору посилань. Повідомлення про кожне оголошення як непрочитане приховало б діагностику, яку інтерполяція видає для того самого тексту, тому натомість нічого не повідомляється.
- Посилання на всю мапу
parameters— ітерування по ній або звернення до одного запису через index — зараховує кожне оголошення як прочитане, оскільки зібране посилання тоді називає мапу, а не ключ у ній, і жодного твердження щодо окремого ключа зробити не можна.
Місце в конвеєрі. Перевірка виконується під час розв’язання, над сирим текстом сутності Aggregate та її оголошеним контрактом параметрів — до генерування. Тому вона з’являється як з aggrega validate, так і з aggrega build.
Форма виводу. Один рядок на кожне непрочитане оголошення, з назвою сутності Aggregate та локатором оголошення:
lint: declared parameter is read by no reference in the Aggregate (Aggregate fullstack-app, at .spec.parameters.unread_probe, "unread_probe")Результати надходять у порядку, у якому сутність Aggregate оголошує свої параметри, тож та сама сутність Aggregate дає ту саму послідовність під час кожного запуску. Кожен містить локатор оголошення, який називає проблемний ключ. Повідомлення також називає ключ, тому він з’являється двічі в рядку термінала, що виводить і локатор: редактор показує повідомлення в позиції, де його розмістив, і ніколи не показує текст локатора, тож повідомлення без ключа виглядало б однаково для кожного непрочитаного оголошення.
Видимість у редакторі. Це попередження також потрапляє в діагностику редактора через мовний сервер, із рівнем серйозності warning, і розміщується на оголошенні, яке називає його локатор, а не на сутності Aggregate загалом. Воно видається до етапу генерування артефактів, тому не потребує перемикача: сеанс редактора показує його незалежно від того, чи увімкнено serve.build_on_inspect.
Чому попередження, а не фатальна зупинка. Параметр може бути оголошений раніше за посилання, яке його читатиме, а статичний обхід не може відрізнити це від помилки — з тієї самої причини перевірка авторських ключів лише радить. Компілятор не контролює, які налаштування відкриває автор.
Попередження про прив’язку Provider до необслуговуваної можливості
Спрацьовує, коли запис у plugins.providers у конфігурації робочого простору називає capability без uri, і жоден із плагінів-провайдерів, які читає збірка, не обслуговує цю можливість. Плагіни, які читає збірка, — це ті, що лежать у її каталогах, провайдери, вбудовані в компілятор, і плагіни, записані в її lock-файлі.
Навіщо воно існує. Прив’язку читають лише тоді, коли capability: сутності Recipe запитує її можливість, а запис, що не називає жодного плагіна, не вибирає нічого такого, чого розв’язання можливості не вибрало б і без нього. Тому запис із помилкою в назві можливості — hlem замість helm — ніхто не читає і він нічого не змінює, а без цього попередження ніщо б про це не повідомило.
Чому попередження, а не фатальна зупинка. Прив’язки записують один раз для всього робочого простору, тоді як збірка стосується однієї сутності Release. Плагін, що обслуговує можливість, може читати лише інша сутність Release у робочому просторі, а ця збірка його не бачить, тож зупинка тут відхилила б коректний робочий простір на підставі здогадки. Запис, який також називає плагін, — інший випадок: pull розв’язує кожен такий запис незалежно від того, чи використовує його Recipe, тож збірка має плагін і знає, що він обслуговує, а можливість, якої цей плагін не обслуговує, спричиняє зупинку — див. fatal-halts.md «A plugins.providers binding names a plugin that does not serve the capability (Прив’язка plugins.providers називає плагін, який не обслуговує цю можливість)». Про запис для можливості, яку обслуговує якийсь плагін, що його читає збірка, нічого не повідомляється, незалежно від того, чи використовує його Recipe у цій сутності Release.
Місце в конвеєрі. Кожна збірка і кожна валідація сутності Release читає кожен запис у складеній конфігурації робочого простору — шари разом із їхніми супутніми providers_append — до аналізу графа сутності Release, тому попередження з’являється як у aggrega validate --release, так і в aggrega build, а також в aggrega pull, яка один раз рендерить сутність Release над lock-файлом, який збирається записати, щоб виявити зовнішні вхідні дані, які отримує її збірка. Ця оцінка нічого не змінює в тому, який плагін рендерить Recipe; це зчитується з lock-файлу.
Форма виводу. Один рядок на запис, у порядку складеного списку, із назвою можливості та обслуговуваною можливістю на відстані одного редагування, якщо така є:
warning: plugins.providers entry names a capability no provider-rendering plugin the build reads serves: capability "hlem", which is one edit from "helm"; the entry names no plugin, so it selects nothing a Recipe would not resolve without it, and none of the plugins this build reads — in the catalog directories, inside the compiler, or among those the lockfile records — serves the capability: correct its spelling, or keep it where the plugin serving it is one only another Release readsПоріг. Варіант написання пропонується лише на відстані одного редагування і лише тоді, коли обидві назви мають щонайменше чотири символи, — та сама межа, що й у лінтерів близьких збігів вище, і з тієї самої причини.
Видимість у редакторі. Попередження потрапляє до діагностики редактора через мовний сервер із рівнем серйозності warning. Запис міститься у файлі конфігурації, а не в документі, що редагується, тому його розміщують на початку цього документа, а не на ключі.
Покриття метаданих за сутностями
Те, які оболонки сутностей містять metadata.labels і metadata.annotations, залежить від виду. Component, Feature і види бібліотек містять обидва ключі; Aggregate містить лише мітки; Recipe, FeatureRecipe, Manifest, Release і Plugin не приймають жодного з цих ключів на рівні оболонки. Стан мови містить позицію для кожної сутності, і саме до нього слід звертатися.
Видимість у редакторі. Жодне попередження цього не охоплює, за жодного налаштування: тут немає про що повідомляти, бо сутність або містить ці ключі, або не приймає їх, а ключ, якого вид не приймає, — це питання, на яке відповідає його схема під час завантаження документа, а не те, про що згодом повідомляє етап рендерингу. Автор звіряється зі сторінкою стану, а не чекає на попередження.
Попередження про непідтримувані поля
Один клас охоплює все, що ви написали, але ціль не може виконати. Він має два члени — поле Workload, яке ціль не може виразити, і анотацію aggrega.ai/, на яку ціль не реагує, — і вони мають один код класу та один прапорець придушення, бо автор, який хоче вимкнути «те, що ця ціль ігнорує», хоче вимкнути це разом, а не по одному перемикачу.
Поле Workload, яке ціль не може виразити
Цілі відрізняються точністю відтворення. Поле Workload, яке одна ціль виражає нативно, може не мати відповідника в іншій — наприклад, Docker Compose не має поняття обмеження планування, сервісного облікового запису чи класу пріоритету. Коли Workload оголошує таке поле, а ціль не може його виразити, поле опускається з попередженням, по одному попередженню на кожне написане поле. Воно не відкидається мовчки і не вважається фатальною помилкою.
Відмінність від фатальної зупинки — у гранулярності. Непідтримувана форма гучно зупиняє збірку — ціль узагалі не може створити робоче навантаження такої форми. Підтримувана форма, що містить невиразне поле, рендериться без цього поля і повідомляє про це.
На цілі compose клас наразі охоплює scheduling, serviceAccount, replicas, runtimeClassName, priorityClassName, imagePullSecrets, dnsPolicy, dnsConfig.options, runAsNonRoot контейнера та кожен ключ розширеного ресурсу, крім nvidia.com/gpu, — наприклад, amd.com/gpu, — оскільки той зарезервовано як GPU NVIDIA. Наведені нижче випадки видають часткový варіант того самого класу, де поле скорочується, а не видаляється:
persistentTemplate— шаблонування томів для кожної репліки недоступне, тож том зводиться до одного спільного постійного тому, а не зникає.- Запис
attachmentsконтейнера зas: env— compose не може отримати змінну середовища з вкладення, тож змінна видається з порожнім значенням. Попередження називає запис за його авторською координатою (containers.<name>.attachments.<KEY>абоinitContainers[<i>].attachments.<KEY>для позиційного init-запису), тож зрозуміло, яка змінна надходить порожньою і якому контейнеру вона належить. Запис зas: fileмонтується через bind-mount звичайним чином і нічого не викликає. - Запис
volumes, який не монтує жоден контейнер, — попередження називає том за його авторською координатою (volumes.<name>). Що потрапляє у вивід, залежить від варіанта: томpersistentабоpersistentTemplateусе одно оголошується як іменований том, який потім створюється й залишається невикористаним, тоді як томconfigmap,secretабоephemeralпотрапляє у вивід лише через точку монтування контейнера, тож якщо його ніщо не монтує, оголошення взагалі не дає виводу. У будь-якому разі написаний вами том нічого не робить: змонтуйте його з контейнера або видаліть. Кожен контейнер робочого навантаження вважається тим, хто монтує, включно з init-контейнерами, тож том, змонтований лише init-контейнером, нічого не викликає. - Блок
health, що оголошує більше одного слота перевірки, — сервіс compose має лише одинhealthcheck, тож порядок пріоритетуlive > ready > startupзалишає один слот, а кожен інший оголошений слот не потрапляє в жодну частину виводу. Попередження називає блок за його авторською координатою (containers.<name>.healthабоinitContainers[<i>].healthдля позиційного init-запису) і називає як перекладений слот, так і відкинуті слоти, тож зрозуміло, яка перевірка діє у виводі, а який авторський намір не діє. Блок з одним слотом перекладається без втрат і нічого не викликає. hostNetworkу робочому навантаженні, яке також оголошуєinitContainers, — власний сервіс робочого навантаження працює в мережі вузла, але кожен init-контейнер стає окремим сервісом, що самостійно приєднується до мережі межі, бо спільний простір імен з основним сервісом зробив би очікування основного сервісу на нього циклічним. Це вужче, ніж модельована форма pod, де всі контейнери мають один простір імен, тож різницю названо, а не залишено для виявлення під час виконання. Робоче навантаження, що оголошуєhostNetworkбез init-контейнерів, перекладається без втрат і нічого не викликає.
Анотація, на яку ціль не реагує
Анотації aggrega.ai/ — це директиви платформи, які провайдер читає й застосовує до того, що рендерить: простір імен, префікс реєстру, сервісний обліковий запис. Які з них читає провайдер — це власне оголошення цього провайдера, зроблене для кожного виду вводу, бо провайдер, якому належить кожне поле одиниці розгортання, яку він сам синтезує, часто не має куди помістити те саме значення, коли рендерить вендорований артефакт. Матрицю наведено в Well-Known Annotations.
Власний Recipe вузла та кожна функція, приєднана до цього вузла, рендеряться окремо, кожна через ціль, яку називає її власний capability:, і для видів вводу, які оголошують її власні source:, workload: і artifacts:. Коли така анотація потрапляє в один із цих рендерів, а оголошення розв’язаної цілі не охоплює ключ у жодному з видів вводу, які оголошує саме цей рендер, ціль нічого не застосовує для цього ключа, і збірка повідомляє про це попередженням, що називає ключ, ціль і кожен вид вводу, який оголошує цей рендер:
warning: node "frontend" (provider "helm-chart"): target "helm-chart" does not support annotation aggrega.ai/namespace on sourced input and ignored itЦі наслідки випливають із того, як анотації потрапляють у рендер, і кожен із них навмисний:
- Один написаний рядок може дати кілька попереджень. Анотація межі каскадно поширюється на кожен компонент під нею, а ці компоненти можуть рендеритися через різні цілі та різні види вводу. Кожне попередження — правдиве твердження про один рендер, тож ви отримуєте по одному на кожен рендер, який не може застосувати ключ, — і саме це також показує, які частини вашого виводу зачеплено.
- Функція, приєднана до вузла, оцінюється за її власним FeatureRecipe, а не за Recipe вузла. Вкладення, що генерує власні ресурси, рендерить їх через ціль, яку називає його FeatureRecipe, для видів вводу, які оголошує цей FeatureRecipe, — тож анотація, яку застосовує власна ціль вузла, може не потрапити ні в що у файлах вкладення, і навпаки. Про кожне вам повідомляють незалежно, бо це різні файли. Те саме стосується функції, приєднаної до межі, а не до іменованого компонента. Вкладення, чий FeatureRecipe не оголошує жодного з
source:,workload:іartifacts:, не рендерить власних файлів — воно робить внесок, впроваджуючи значення, через реброuses, яке несе його Feature, або через конвеєр над документами, видані чимось іншим, — тож немає власного виводу, у якому могло б бракувати анотації, і про нього нічого не попереджається. - Рендер, що оголошує більше одного виду вводу, оцінюється за всіма ними. Його оголошені види поєднуються додаванням, а їхні виводи складаються, тож ціль, яка читає ключ у будь-якому з них, застосовує його, і значення з’являється у відрендереному виводі. У такому разі нічого не попереджається, бо нема про що повідомляти. Попередження з’являється лише тоді, коли кожен оголошений вид пропускає ключ, і воно називає їх усі —
on sourced or synthesized input. - Перевіряються лише голі ключі
aggrega.ai/. Ключ із підпрефіксом —compliance.aggrega.ai/data-classабо ваш власнийacme.aggrega.ai/team— це ваш словник, який компілятор передає без інтерпретації. Про нього ніколи нічого не попереджається. - Ціль, яка взагалі не оголошує заяви про підтримку, нічого не викликає. Попередження порівнює написане вами з тим, що, за словами провайдера, він читає; провайдер, який нічого не заявив, не дає з чим порівнювати, а виведення відмови з мовчання повідомило б про заяву, якої автор провайдера ніколи не робив. Провайдер, який не читає жодного з ключів, заявляє про це через
readsNoWellKnownAnnotations: true, як це робитьterraform, і тоді попередження виникає щодо кожного простого ключа, що доходить до одного з його рендерингів.
Чому попередження, а не зупинка. Межа, яка правомірно охоплює компоненти на різнорідних цілях, завжди матиме якийсь вузол, що не може застосувати певний ключ, — це нормальна форма Release, що охоплює кілька цілей, а не помилка, — тож відмова у збірці відхиляла б коректні Releases. Значення проходить без змін, і попередження повідомляє вам про це.
Код класу та гарантія позасмугової передачі
Кожне попередження містить стабільний, придатний для машинного зіставлення код класу unsupported-field, тож інструменти можуть зіставляти клас, а не розбирати текст повідомлення. Кожен член класу — поле, пропущене повністю, поле у скороченій формі та анотація, на яку не відреаговано, — має цей єдиний код, і саме це дає змогу одним фільтром приглушити весь клас. Попередження передаються поза смугою відносно згенерованих артефактів, а отже, згенеровані байти ідентичні побайтово незалежно від того, чи виводяться попередження, — приглушення не може змінити ваш вивід.
Видимість у редакторі. Кожен член класу потрапляє до діагностики редактора лише тоді, коли мовний сервер під час перегляду графа IR виконує етап генерації артефактів — aggrega serve --build-on-inspect або ключ конфігурації serve.build_on_inspect, який цей прапорець перевизначає і який типово вимкнено. Цей перемикач додає рекомендаційні повідомлення, які збірка видає під час генерації, і жодної з перевірок, на яких збірка зупиняється. Наведений вище код класу передається в опублікованій діагностиці так само, як і в рядку термінала, тож клієнт редактора зіставляє той самий клас, який читає автор. Кожен запис називає вузол і ціль, а не ключ авторського коду, тому його відображено на ключі kind: сутності Aggregate.
Приглушення класу
Обидві команди, що виконують генерацію, приймають --no-unsupported-field-warnings, який приглушує лише цей клас, тоді як усі інші попередження генерації й далі виводяться:
aggrega build --release release.yaml --no-unsupported-field-warningsaggrega validate ./catalog/recipe/compose/mariadb/1.0.0/recipe.yaml --no-unsupported-field-warningsПрапорець впливає лише на відображення і не змінює згенерований вивід. aggrega lint не має відповідного прапорця, бо не виконує проходу генерації — він перевіряє лише домовленості публікації, тож жодне попередження генерації там виникнути не може.
Використовуйте прапорець, коли ви свідомо погодилися на знижену точність — наприклад, ціль compose для локальної розробки, де поля планування та сервісного облікового запису робочого Workload очікувано не діють. В інших випадках не вмикайте його: саме з попередження ви дізнаєтеся, що поле, яке ви написали, не доходить до цілі.
Значення, оголошене чутливим, передається як літерал
Спрацьовує, коли приєднання заповнює слот, доставляючи дане, яке його схема оголошує чутливим, у ключ доставки як літеральне значення, а не як посилання, яке ціль розв’язує під час розгортання.
Форма виводу. Один рядок на кожен ключ доставки, що називає екземпляр приєднання, механізм доставки, до якого потрапляє ключ, і сам ключ, з прив’язкою до вузла та цілі, що його відрендерили:
warning: node "db" (provider "compose"): attachment "user_password" delivers a value declared sensitive to env delivery key "MARIADB_PASSWORD" as a literal; where the target supports it, fill the slot with an attachment that delivers a reference insteadКод класу. Попередження має стабільний, придатний для машинного зіставлення код класу sensitive-by-value, тож інструменти зіставляють клас, а не розбирають текст повідомлення. Код передається і в рядку термінала, і в структурованій діагностиці, яку публікує мовний сервер, тож автор і клієнт редактора читають той самий клас — за умови видимості в редакторі, описаної нижче, яка визначає, чи мовний сервер узагалі публікує це попередження.
Видимість у редакторі. Попередження потрапляє до діагностики редактора лише тоді, коли мовний сервер виконує етап рендерингу артефактів під час перегляду графа IR — aggrega serve --build-on-inspect або ключ конфігурації serve.build_on_inspect, який цей прапорець перевизначає і який типово вимкнений. Цей перемикач додає попередження, які збірка видає під час рендерингу, і жодної з перевірок, на яких збірка зупиняється. Запис називає вузол і ціль, а не ключ авторського коду, тому відображається на ключі kind: сутності Aggregate.
Це окремий клас, і --no-unsupported-field-warnings його не охоплює. Цей прапорець вимикає клас unsupported-field, описаний вище; це попередження все одно з’являється поряд із ним. Прапорця, який вимикав би саме це попередження, немає.
Збірка завершується успішно, а відрендерені байти не змінюються. Попередження передається поза смугою відносно відрендерених артефактів, як і клас unsupported-field, тож те, що потрапляє до вашого виводу, однакове незалежно від того, чи з’являється цей рядок.
Значення, оголошене чутливим, потрапляє до цілі через відображення значень
Спрацьовує, коли рендер із source: передає своїй цілі вихід valuesMapping:, тоді як сутність, чиї значення читає це відображення, оголошує листок values чутливим: відображення в сутності Recipe над листком, який оголошує її Component, або відображення в сутності FeatureRecipe для Feature, приєднаної до компонента, над листком, який оголошує ця Feature. Відображення — це один шаблон, ключі виходу якого є його власним винаходом, тож жодне оголошення не називає жодного з них, і ціль не отримує для листка позначки чутливості на рівні ключа. Це єдина форма рендеру, за якої оголошення не досягає жодного відрендереного ключа, хоча автор усе ще має на нього важіль.
Форма виводу. Один рядок на кожен оголошений листок, що називає листок за його авторською координатою та сутність Recipe або FeatureRecipe, чиє відображення керує зіставленням, з прив’язкою до вузла й цілі, які його відрендерили. Рядок для приєднаної Feature починається з імені, під яким її приєднано, бо один компонент може мати кілька приєднань однієї Feature, і інакше їхні рядки були б однаковими — другий рядок нижче стосується Feature, приєднаної до компонента api як token:
warning: node "api" (provider "terraform"): "values.token" is declared sensitive, but recipe "terraform/api" maps its values through a valuesMapping whose output keys no declaration names, so the target receives no per-key sensitivity marking for it; where the mapping reads it, the mapping's whole output is marked as carrying a value declared sensitive instead; a recipe declaring no valuesMapping renders the declared leaf paths as its own keys, and the per-key marking travels with them warning: node "api" (provider "terraform"): attachment "token": "values.token" is declared sensitive, but FeatureRecipe "terraform/api-token" maps its values through a valuesMapping whose output keys no declaration names, so the target receives no per-key sensitivity marking for it; where the mapping reads it, the mapping's whole output is marked as carrying a value declared sensitive instead; a FeatureRecipe declaring no valuesMapping renders the declared leaf paths as its own keys, and the per-key marking travels with themЩо є важелем. Без відображення значення, які отримує рендер із джерела, мають ключами самі шляхи оголошених листків, тож оголошення точно зіставляється зі своїм відрендереним ключем і позначка передається разом із ним — для цілі Terraform це згенерований файл перевизначення, описаний у розділі Вхідні параметри модуля, оголошені чутливими. З відображенням позначка, яка все ж надходить, охоплює вихід відображення загалом і лише там, де відображення читає оголошене значення: вона визначає текст, який складає плагін, коли відмовляє чи попереджає, і не змінює жодного відрендереного байта.
Три форми мовчать, і це зроблено навмисно. Рендер лише артефактів і рендер лише робочого навантаження взагалі не передають своїй цілі мапи значень, тож листок values не має там відрендереного ключа для позначення, хоч як його написано. Feature, приєднана до межі, теж не викликає попередження, хоч би що відображала її FeatureRecipe: межа не має блоку values:, тож таке приєднання рендериться з порожнім стовпом values, жоден із листків values її Feature не може там нести дані, і вилучення відображення нічого б не позначило. Кожна з цих ситуацій є постійною властивістю форми, а не тим, що автор може змінити, тож попередження про неї спрацьовувало б під час кожної збірки й не вказувало б, що робити; натомість цю межу пояснено в розділі Оголошення листка чутливим. Рендер із source: без valuesMapping: також мовчить, бо там позначка надходить.
Код класу. Попередження має стабільний, придатний для машинного зіставлення код класу sensitivity-not-conveyed, тож інструменти зіставляють клас, а не розбирають текст повідомлення: інструмент build асистента перелічує з ним кожну знахідку в advisories. Він називає клас знахідок, а не зареєстровану умову, тому не має рядка в таблиці на початку цієї сторінки.
Видимість у редакторі. Попередження потрапляє до діагностики редактора з рівнем серйозності warning і тим самим рядком, що його друкує збірка в терміналі, щоразу, коли мовний сервер рендерить сутність Release — під час збірки чи попереднього перегляду збірки, які в нього запитано, або під час перегляду графа IR з aggrega serve --build-on-inspect чи з ключем конфігурації serve.build_on_inspect, який цей прапорець перевизначає і який типово вимкнено. Запис називає вузол і ціль, а не авторський ключ, тому його показано на ключі kind: сутності Aggregate.
Це окремий клас, і --no-unsupported-field-warnings його не охоплює. Цей прапорець вимикає повідомлення цілі про точність відтворення — інше судження, ухвалене з інших причин; це попередження все одно з’являється поряд. Прапорця, який вимикав би саме його, немає.
Збірка успішна, а відрендерені байти не змінюються. Попередження повідомляє про відсутність — жоден відрендерений ключ не несе позначки, — а відображення є звичайною підтримуваною формою, тож немає причини зупиняти збірку, і у вашому виводі нічого не змінюється, з’являється рядок чи ні.
Виклик модуля Terraform, який рушій завантажує під час ініціалізації
Спрацьовує, коли модуль Terraform, який збірка вендорить, або написане автором тіло Terraform у сутності Recipe оголошує блок module, чий source Terraform завантажує під час ініціалізації конфігурації, а не читає з файлів, які розмістила збірка: адреса реєстру, URL архіву git, Mercurial або HTTP, бакет S3 чи GCS, абсолютний шлях — або локальний шлях, що виходить за межі вендореного модуля й указує на файли, яких збірка не вендорила. Lock-файл фіксує коміт і дайджест архіву вендореного модуля, а власний lock-файл залежностей Terraform записує лише провайдери, тож модуль, названий таким викликом, завантажується в тій версії, яку тоді обере рушій, і ніщо із записаного цією збіркою його не охоплює.
Що читається. Конфігураційні файли, які рушій завантажує під час виклику модуля, — ті, що лежать безпосередньо у власному каталозі модуля та в кожному каталозі, якого звідти досягає локальний source, — і нічого в каталозі, який ніхто не викликає, тож про виклик, написаний у каталозі examples/ чи tests/ модуля, не повідомляється. Читається те, що каже source, і ніколи — модуль, який цей source називає. Файл у spec.boundary.artifacts сутності Recipe обчислює й записує сам компілятор і не передає жодному провайдеру, тож блок module, написаний у ньому, не читається й не викликає попередження. Структурна перевірка вхідних даних на сторінці провайдера повністю описує це правило.
Форма виводу. Один рядок на виклик: вузол і провайдер, далі блок, файл і рядок, де він розташований, і source у написаному вигляді; для source, що виходить за межі модуля, про це й сказано замість назви завантаження:
warning: node "app" (provider "terraform"): module "vpc" (main.tf, line 2) has the source "terraform-aws-modules/vpc/aws", which Terraform downloads when the configuration is initialised, at whatever version it then selects, so no commit or digest this build records covers that module warning: node "app" (provider "terraform"): module "shared" (main.tf, line 2) has the local source "../shared", which resolves outside the module this build placed, so Terraform reads whatever sits at that path when the configuration is initialised rather than files this build vendoredВиклики надходять у тому порядку, в якому рушій їх досягає, — спершу власний каталог модуля, далі кожен каталог у порядку, в якому його вперше досягає локальний source, а в межах файлу — у порядку написання блоків, — тож однакові вхідні дані дають однакову послідовність під час кожного запуску. Їх породжує кожен запуск, що виконує рендеринг: aggrega build; aggrega pull, яка один раз рендерить Release, щоб з’ясувати, що завантажує його збірка; і aggrega validate над Recipe, модуль якого є в робочому просторі, — вона рендерить цей Recipe окремо.
Код класу. Кожне попередження має стабільний, придатний для машинного зіставлення код класу module-fetched-at-init, тож інструменти зіставляють клас, а не розбирають текст повідомлення. Код передається у структурованій діагностиці: інструмент build асистента перелічує з ним кожну знахідку в advisories, а мовний сервер публікує його в кожному записі. Він називає клас знахідок, а не зареєстровану умову, тому не має рядка в таблиці на початку цієї сторінки.
Видимість у редакторі. Попередження потрапляє в діагностику редактора на рівні aggrega-build із серйозністю warning щоразу, коли мовний сервер рендерить Release, — під час запитаної збірки чи попереднього перегляду збірки або під час перегляду IR-графа з aggrega serve --build-on-inspect чи з ключем конфігурації serve.build_on_inspect, який цей прапорець перевизначає і який типово вимкнено. Запис називає вузол, а не авторський ключ, тому відображається на ключі kind: сутності Aggregate.
Це окремий клас, і жоден прапорець його не вимикає. --no-unsupported-field-warnings вимикає клас непідтримуваних полів і цей клас не охоплює.
Збірка успішна, а відрендерені байти не змінюються. Попередження передається окремо від відрендерених артефактів, тож вендорений модуль, написане автором тіло й коренева конфігурація побайтово ідентичні незалежно від того, чи з’являється воно.
Чому попередження, а не зупинка. Модуль, що викликає інший модуль, — це коректні вхідні дані: Terraform завантажує викликаний модуль, і конфігурація працює. Автор втрачає лише закріплення цього модуля збіркою, а це факт, про який слід повідомити, а не помилка, через яку слід відмовити; чи прийнятне таке завантаження — вирішує автор.
Плагін запущено без записаного дайджесту, з яким його можна було б звірити
Спрацьовує, коли компілятор збирається запустити плагін, байти цього плагіна має контролювати записаний дайджест, а робочий простір не містить для нього жодного. Плагін запускається; попередження — це спосіб дізнатися, що ніщо не порівняло запущені байти з байтами, які хтось перевірив.
aggrega pull записує дайджест кожного отриманого плагіна у lock-файл сутності Release, і кожне подальше розв’язання порівнює знайдені байти з цим дайджестом. Робочий простір, для якого ще не виконано pull, або той, чий lock-файл старший за плагін, який конфігурація відтоді приєднала, не має дайджесту для цього плагіна — тож порівнянню немає з чим порівнювати, і без цього рядка воно пройшло б непомітно.
Крок конвеєра, провайдер або плагін, приєднаний у ролі вердикту, чия сутність Plugin написана в одному з ваших каталогів, також не має дайджесту, і pull його не надає: pull ніколи не фіксує таку сутність, а збірка щоразу читає її .wasm наново — у звичайному випадку з місця поруч із сутністю — а не звіряє з чимось, що записав pull. Виняток — плагін, приєднаний у ролі перетворення й написаний там само: його байти формують результат рендерингу, тож pull записує дайджест знайденого для нього .wasm, і після цього збірка перевіряє плагін за дайджестом, а цей рядок для нього не виводиться.
warning: plugin "governance/label-injector:1.0.0" resolved from cache with no recorded digest to check it against, so it runs unverified; run `aggrega pull --release <release>` to record it warning: plugin "pipeline-step/patch" resolved from local with no recorded digest to check it against, so it runs unverified; it is read from beside its Plugin entity in a catalog directory on every build, and a pull records its digest only for a plugin attached at a transform role; otherwise publish the plugin and reference the published entity to have its digest recordedЦе рядок, який збірка, отримання чи валідація показує серед інших своїх попереджень. Команда, що розв’язує плагін поза таким запуском, — інсталяція, перелік чи запуск власних плагінів командного рядка робочого простору або aggrega lint, що розв’язує плагіни, якими виконує лінтинг, — виводить те саме речення окремим рядком, без відступу.
Рядок називає джерело, з якого надійшли байти, — тим самим словом, яким його позначають aggrega pull і aggrega plugin list, — і завершується тим, що справджується для цього джерела. Для байтів із кешу вмісту виправлення — виконати pull для сутності Release, що записує дайджест і робить кожен подальший запуск цього плагіна перевіреним. Для байтів, прочитаних поруч із сутністю Plugin у каталозі, pull записує дайджест лише для плагіна, приєднаного в ролі перетворення, і рядок про це повідомляє: для будь-якого іншого плагіна, написаного там, жоден pull цього не змінить, а щоб поставити його під записаний дайджест, його слід опублікувати й посилатися на опубліковану сутність.
Показується один раз для кожного плагіна в межах кожної команди, скільки б разів команда не розв’язувала цей плагін. Рендеринг розв’язує свого провайдера один раз на вузол, а збірка, яка заповнює власний файл блокування, може рендерити сутність Release більше одного разу; повторення рядка щоразу поховало б його. Служба редактора показує його у власному потоці помилок один раз за весь час своєї роботи, тоді як кожен запит, на який вона відповідає, заново повідомляє його редактору, — тож хоч би з якої відповіді брав дані редактор, вона повідомить вам, які плагіни цей запуск використав без перевірки.
Видимість у редакторі. Попередження потрапляє в діагностику редактора разом з іншими рекомендаціями запуску, з рівнем серйозності «попередження»: валідація сутності Release публікує його на сутності Aggregate цієї сутності Release, а збірка чи попередній перегляд збірки, яких просить редактор, публікує його на шарі aggrega-build. Воно називає плагін, а не ключ, який ви написали, тому розміщується на початку файлу. Оскільки кожен запуск повідомляє те, що розв’язав, запис лишається доти, доки запуск розв’язує плагін без перевірки, і зникає з першим запуском, який цього не робить. Воно не змінює жодного вердикту й не зриває жодного розв’язання, тож відповідь сеансу однакова незалежно від того, чи його показано.
Два розв’язання нічого не виводять, і жодне з них не є недоглядом:
- Плагін, вбудований у сам компілятор.
aggrega pullзаписує те, що завантажив, а для байтів, які постачаються в бінарному файлі, завантажувати нічого — тож дайджест для такого плагіна ніколи не записується, і немає нічого, що ви могли б запустити, аби це змінити. Ідентичністю цих байтів є сам бінарний файл. Власні плагіни компілятора та їхні версії перелічуєaggrega plugin list, і вони фіксуються в розділіtoolchainlock-файлу. - Розв’язання, до якого дайджест ніколи не мав застосовуватися.
aggrega validate --plugin ./some.wasmвказує на файл, який ви назвали в командному рядку, аaggrega lintперевіряє саме той артефакт, який інспектує; в обох випадках плагін є предметом перевірки, а не інструментом, якому довіряють, тож немає запису, з яким його можна було б звірити.
Чому попередження, а не зупинка. Читати документ варто й у робочому просторі, який ще ніхто не підготував, — відмова валідувати чи перевіряти лінтером, доки хтось не виконає aggrega pull, зробила б звітні команди непридатними саме тоді, коли вони найкорисніші. aggrega build без lock-файлу взагалі не створює артефактів, тож збірка стикається з цим попередженням лише для плагіна, для якого її lock-файл не записує дайджесту, — у звичайному випадку це плагін, прочитаний поруч зі своєю сутністю в каталозі.
Коли відсутній lock-файл натомість призводить до відмови. Коли редактор запитує в служби компілятора граф сутності Release, а робочий простір зовсім не має lock-файлу, служба зупиняється й просить його, а не малює граф. Lock-файл, який існує і просто не містить дайджесту для плагіна, — це описаний вище випадок: плагін запускається, і це попередження повідомляє вам про це. Намальований граф — це те, на основі чого потім міркує читач, і граф, побудований з неперевірених байтів, виглядав би точнісінько як перевірений. Див. aggrega serve.
A published archive carries an entry Windows cannot use (Опублікований архів містить запис, який Windows не може використати)
Спрацьовує, коли aggrega push — або його --dry-run — публікує архів, один із записів якого містить частину, яку Windows не може зберегти в такому написанні: ім’я, яке Windows резервує для пристрою, як-от CON, PRN, AUX, NUL, COM1 або LPT1, у будь-якому регістрі літер і з будь-яким розширенням, або частину, що закінчується крапкою чи пробілом. aux/x.yaml містить таку частину в назві каталогу; report. і COM1.yaml — в імені файлу. У Windows aggrega відмовляється розпаковувати такий запис, тож робочий простір у Windows узагалі не може використати цю версію. Попередження виникає на всіх платформах, бо публікація призначена для будь-кого, хто її завантажить, і саме з нього автор дізнається про це раніше, ніж хтось у Windows.
Що перевіряється. Імена, які міститиме архів: власне ім’я файлу документа сутності, а потім кожен файл, який сутність називає поруч із ним, — файли, що їх перелічує розділ Bundling. Тож документ із назвою con.yaml, який імпортує файл схеми, отримує попередження через власне ім’я. Сутність, яка нічого не називає, публікується лише як її документ, який споживач розміщує під іменем, обраним продуктом, а не тим, яке задали ви, тому попередження для неї ніколи не виникає, хоч би як називався її файл. Plugin не публікує архіву, і для нього попередження теж ніколи не виникає.
Формат виводу. Один рядок на запис у стандартний потік помилок, у порядку складання імен — спершу документ, потім файли, які він містить, у лексичному порядку, — перед власним звітом пробного запуску чи публікації у стандартному виводі:
warning: an entry this publication carries cannot be used on Windows (the entry "aux/x.yaml", its segment "aux"). Windows reserves device names such as CON, PRN, AUX, NUL, COM1 and LPT1, in any letter case and whatever extension follows, and does not hold a segment ending in a full stop or a space as written, so a workspace on Windows refuses to unpack the entry. This warning does not stop the publication; rename that segment to publish a version Windows can useПерше значення в лапках — запис так, як його називає архів. Друге — перший із його сегментів (частин, які розділяють скісні риски), що його Windows не може зберегти; саме цю частину слід перейменувати. Рядок починається з незмінного речення цієї умови. Його виводить публікація, а не правило, яке обчислює збірка, тому в таблиці на початку цієї сторінки для нього немає рядка; таблиця всіх умов наводить його під кодом E0344.
Нічого не відхиляє. Push або його пробний запуск виконується чи відхиляється так само, як і без попередження, і завершується з тим самим результатом.
Куди ще потрапляє. Інструмент асистента publish-entity повертає ті самі записи як windows_unusable_entries, а aggrega serve відповідає на aggrega/publishEntity з ними як windowsUnusableEntries; кожне з полів відсутнє, якщо таких записів немає. Див. aggrega mcp і aggrega serve. Сервіс також передає сам рядок попередження запиту, який просив звіт, разом з рештою звіту публікації.
Видимість у редакторі. Як діагностика — жодної: публікація не є збіркою, тож нічого звідси не потрапляє до списку проблем. Редактор, що публікує через сервіс, читає windowsUnusableEntries у відповіді.
Чому попередження, а не зупинка. Таке ім’я допустиме, а Linux і macOS використовують файл під його іменем, тож відхилення публікації означало б відхилити робочу сутність на підставі здогаду про те, хто її завантажить. Чи перейменовувати — вирішує автор.