Предупреждения и вывод линтера
Нефатальные предупреждения, которые компилятор выдаёт во время компиляции. Предупреждения не останавливают сборку — они указывают на недочёты в авторском коде, на детерминированные варианты разрешения неоднозначностей, выбранные компилятором, и на ресурсы, которые шаблоны разработчика так и не использовали. Каждая находка попадает в 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 |
Линт schema-pillar-overlap
Срабатывает, когда сущность 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».
Линт пересечения карт привязки
Срабатывает, когда привязка аннотации в 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, в котором находится ключ. Поэтому проблемный ключ также является первым значением в кавычках в каждом сообщении — это единственная часть, которую локатор не всегда может передать.
Видимость в редакторе. Сообщение также попадает в диагностику редактора через языковой сервер с уровнем предупреждения и располагается там, куда указывает его локатор: на самой привязке для простого ключа и на охватывающем блоке 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 (Аннотация направляется через столп, который её авторская сторона использовать не может)». Линт — это ранее предупреждение, а та остановка — механизм принуждения.
Примечание для авторов. Как и линт пересечения столпов схемы, этот линт носит рекомендательный характер: привязка компилируется, а разрешение конфликта во время выполнения даёт детерминированный результат. Линт срабатывает потому, что такой шаблон почти всегда непреднамерен; автор привязки, который действительно хочет, чтобы оба столпа направляли один и тот же путь, написал бы две отдельные привязки с разными ключами аннотаций.
Lint близкого промаха по слоту вложения
Срабатывает, когда экземпляр компонента прикрепляет Feature под именем, которое не входит в число объявленных слотов featuresSchema его типа Component, но отстоит от одного из них на одну правку — один вставленный, удалённый или заменённый символ либо два переставленных соседних символа, — причём прикреплённая Feature не удовлетворяет selector этого слота. Именно так выглядит опечатка в имени слота, и lint называет оба написания, чтобы автор увидел пару.
Зачем он нужен. Объявление слота не закрывает поверхность вложений: вложение под именем, которое не объявляет ни один слот, допустимо, потому что именно эта открытость позволяет одной сущности каталога служить и вложением, заполняющим слот, и учётными данными, общими для более широкой области. Цена в том, что слот с опечаткой в имени молча становится свободным вложением, а не заполнением слота, который имел в виду автор, — сборка проходит успешно, а слот просто остаётся пустым. Lint — это раскрытая мера смягчения именно для этого случая.
Место в конвейере. Lint выполняется на этапе разрешения, в том же проходе, что и семантические проверки с учётом каталога, над разрешённым 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.
Порог и его компромисс. Lint сопоставляет имена только на расстоянии одной правки и только когда оба имени имеют длину не менее четырёх символов. При меньшей длине почти любое короткое имя отстоит от любого другого на одну правку, поэтому их сопоставление давало бы шум, а не сигнал; при расстоянии больше одной правки пары перестают походить на опечатки. Перестановка считается одной правкой, а не двумя, потому что переставленная пара символов — самая частая ошибка, и более строгий подсчёт её бы пропускал.
Примечание для авторов. Lint носит рекомендательный характер и никогда не меняет вердикт сборки — компилятор не контролирует, как автор называет вложение. Автор, который намеренно прикрепляет Feature под именем, похожим на слот, может игнорировать предупреждение; вложение ведёт себя ровно так, как написано.
Не там, где Feature подходит слоту. Имя на расстоянии одной правки от слота, selector которого прикреплённая Feature удовлетворяет, предупреждения не вызывает. Такая пара — не свободное вложение с опечаткой, а заполнение, записанное под другим именем, и важно ли это, зависит от того, останется ли слот пустым, а это известно только после свёртки всех областей. Если слот остаётся пустым, сборка останавливается и называет вложение и слот — см. «An attachment written under another name fits a slot its component leaves empty (Вложение, записанное под другим именем, подходит слоту, который его компонент оставляет пустым)» в fatal-halts.md, — так что остановка — единственная сообщаемая находка, без предупреждения рядом с ней. Если слот привязывает что-то другое, вложение является обычным дополнительным, и ничего не сообщается. Слоту, не объявляющему selector, не подходит ни одна Feature, поэтому имя рядом с таким слотом всегда вызывает предупреждение.
Не для соединения. Lint читает собственный блок 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, раздел «Topology Sockets: 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 соединение, поэтому оно не несёт ни селектора, ни контракта на уровне ребра, а сокет, который имел в виду автор, остаётся неподключённым.
Видимость в редакторе. Предупреждение также попадает в диагностику редактора через языковой сервер, с уровнем серьёзности «предупреждение», и указывает на компонент, блок uses: которого содержит ошибочное имя. Автор, который никогда не читает вывод терминала, всё равно увидит пару. Оно выдаётся до этапа рендеринга артефактов, поэтому не требует никакой настройки: сеанс редактора показывает его независимо от того, включён ли serve.build_on_inspect.
Порог и его компромисс. Линт объединяет имена в пару только на расстоянии одной правки и только если оба имени имеют длину не менее четырёх символов — та же граница, что и у линта близкого промаха в имени слота присоединения, и по той же причине. При меньшей длине почти любое короткое имя отличается от любого другого на одну правку, так что такие пары давали бы шум, а не сигнал; при расстоянии больше одной правки пары перестают походить на опечатки. Перестановка считается одной правкой, а не двумя, потому что переставленная пара символов — самая частая ошибка, и более строгий подсчёт её бы пропускал.
Примечание для авторов. Линт носит рекомендательный характер и никогда не меняет вердикт сборки — компилятор не контролирует, как автор называет сокет. Автор, который намеренно проводит ad-hoc соединение под именем, похожим на объявленный сокет (соединение cache рядом с объявленным сокетом caches, предназначенное для другого), может игнорировать предупреждение; ребро ведёт себя ровно так, как написано. Флага для его подавления нет, и он не нужен: предупреждение не влияет на вердикт.
Lint необъявленного ключа provides
Срабатывает, когда Recipe, привязанный к экземпляру компонента, публикует в своём provides: ключ, который тип Component этого экземпляра не объявляет в своём контракте spec.schema.provides:.
Зачем он нужен. Публиковать больше, чем объявляет Component, допустимо и останется допустимым: контракт provides требует подмножества и разрешает надмножество, поэтому Recipe, который покрывает контракт своего Component и вдобавок выдаёт дополнительные ключи, — это Recipe, который этот контракт выполняет. Lint называет последствие, которое иначе не видно ни с одной из сторон. Потребитель, читающий через ребро uses:, видит объявленный контракт цели, а не то, что выдаёт Recipe цели, — именно это сохраняет взаимозаменяемость Recipes: два Recipes, реализующих один Component, предъявляют потребителю одну и ту же поверхность, и их замена не может незаметно отнять ключ, на который потребитель начал полагаться. Поэтому необъявленный ключ не передаётся через ребро, а шаблон-потребитель, который его читает, отображает пустое значение, а не завершается ошибкой.
Находка сообщается в месте её причины — в Recipe, который опубликовал ключ, — потому что именно там её можно назвать. У потребителя ключ — это ссылка в шаблоне, которую компилятор не может отнести к конкретной цели, а диагностика, основанная на догадке, была бы хуже, чем никакая. Поэтому они намеренно разнесены: пустое значение появляется у потребителя, объяснение — здесь, и оба появляются в одном и том же выводе сборки.
Что с чем сравнивается. Написанные автором ключи provides: привязанного Recipe сравниваются с объявленными ключами spec.schema.provides: типа Component. Это то же объявленное множество, с которым сверяется ключ from: внутри блока inject:, поэтому обе проверки одинаково понимают, что объявляет Component. Сравнение точное, а не проверка на сходство, поэтому, в отличие от двух lint-проверок близких промахов выше, у него нет порога и оно не сопоставляет имена.
Сравнивается тот 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.
Примечание для авторов. Lint носит рекомендательный характер и никогда не меняет вердикт сборки — 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. Перечисленные ниже случаи выдают частичный вариант того же класса, при котором поле сокращается, а не удаляется:
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/ — это платформенные директивы, которые провайдер читает и применяет к тому, что отрисовывает: пространство имён, префикс реестра, сервисная учётная запись. Какие из них читает провайдер, определяет собственное объявление этого провайдера, сделанное для каждого вида входных данных, потому что провайдеру, который владеет каждым полем единицы развёртывания, синтезируемой им самим, часто некуда поместить то же значение при отрисовке вендорного артефакта. Матрица приведена в разделе Общеизвестные аннотации.
Собственный 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-файл фиксирует коммит и дайджест архива вендоренного модуля, а собственный файл блокировки зависимостей 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 ничего не меняет, и чтобы поставить его под записанный дайджест, его нужно опубликовать и ссылаться на опубликованную сущность.
Показывается один раз на плагин для каждой команды, сколько бы раз команда ни разрешала этот плагин. Рендеринг разрешает провайдер один раз на узел, а сборка, которая заполняет собственный lock-файл, может рендерить сущность Release более одного раза; повтор строки каждый раз похоронил бы её. Служба редактора показывает её в собственном потоке ошибок один раз за всё время своей работы, тогда как каждый запрос, на который она отвечает, заново сообщает о ней редактору, — поэтому какой бы ответ ни использовал редактор, он сообщает вам, какие плагины этот запуск использовал без проверки.
Видимость в редакторе. Предупреждение попадает в диагностику редактора вместе с другими рекомендациями запуска, с уровнем серьёзности «предупреждение»: проверка сущности Release публикует его на сущности Aggregate этой сущности Release, а сборка или предпросмотр сборки, которые запрашивает редактор, публикуют его на слое aggrega-build. Оно называет плагин, а не ключ, который вы написали, поэтому размещается в начале файла. Поскольку каждый запуск сообщает о том, что разрешил, запись остаётся, пока запуск разрешает плагин без проверки, и исчезает с первым запуском, который этого не делает. Оно не меняет вердиктов и не проваливает разрешений, поэтому ответы сеанса одинаковы независимо от того, показано ли оно.
Два разрешения ничего не выводят, и ни одно из них не упущение:
- Плагин, встроенный в сам компилятор.
aggrega pullзаписывает то, что загрузил, а для байтов, поставляемых в бинарном файле, загружать нечего — поэтому дайджест для такого плагина никогда не записывается, и вы не могли бы ничего запустить, чтобы это изменить. Идентичность этих байтов — сам бинарный файл. Собственные плагины компилятора и их версии перечисляетaggrega plugin list, и они записываются в разделtoolchainlock-файла. - Разрешение, к которому дайджест никогда не должен был применяться.
aggrega validate --plugin ./some.wasmуказывает на файл, названный вами в командной строке, аaggrega lintисследует тот самый артефакт, который проверяет; в обоих случаях плагин — предмет проверки, а не инструмент, которому доверяют, поэтому нет записи, с которой его можно было бы сверить.
Почему предупреждение, а не остановка. Чтение документа имеет смысл и в рабочем пространстве, которое ещё никто не подготовил, — отказ выполнять validate или lint, пока кто-нибудь не запустит aggrega pull, сделал бы команды отчётов непригодными именно тогда, когда они полезнее всего. aggrega build вообще не создаёт артефакты без lock-файла, поэтому сборка встречает это предупреждение только для плагина, для которого её lock-файл не содержит дайджеста, — в обычном случае это плагин, прочитанный рядом со своей сущностью в каталоге.
Когда отсутствие lock-файла приводит к отказу. Когда редактор запрашивает у службы компилятора граф сущности Release, а в рабочем пространстве вообще нет lock-файла, служба останавливается и запрашивает его, а не рисует граф. Lock-файл, который существует, но просто не содержит дайджеста для плагина, — это описанный выше случай: плагин запускается, и это предупреждение сообщает вам об этом. Нарисованный граф — то, о чём затем рассуждает читатель, и граф, построенный из непроверенных байтов, выглядел бы точно так же, как проверенный. См. aggrega serve.
Опубликованный архив содержит запись, которую 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 используют файл под его именем, поэтому отказ в публикации отклонил бы работающую сущность на основании догадки о том, кто её загрузит. Переименовывать или нет — решает автор.