codec RAW -> NONE
This commit is contained in:
@@ -0,0 +1,63 @@
|
||||
# 015 Asset Codec `NONE` Canonicalization in Specs
|
||||
|
||||
## Briefing
|
||||
|
||||
A decision `013` fechou que o valor canonico para ausencia de codec adicional passa a ser `NONE`, com `RAW` tratado apenas como alias legado durante a migracao curta.
|
||||
|
||||
O runtime precisa publicar essa semantica nas specs antes de seguir com a propagacao completa em codigo e tooling.
|
||||
|
||||
## Decisions de Origem
|
||||
|
||||
- `docs/runtime/decisions/013-asset-codec-none-vs-raw.md`
|
||||
|
||||
## Alvo
|
||||
|
||||
Atualizar o contrato normativo de assets para que:
|
||||
|
||||
1. `codec = NONE` seja o valor canonico publicado;
|
||||
2. `RAW` apareca apenas como legado/deprecated durante a janela curta de transicao;
|
||||
3. a semantica de `codec` fique clara como camada generica de transformacao do payload;
|
||||
4. a diferenca entre `codec` e layout especifico de `bank_type` fique explicita.
|
||||
|
||||
## Escopo
|
||||
|
||||
- revisar `docs/runtime/specs/15-asset-management.md`
|
||||
- revisar `docs/runtime/specs/13-cartridge.md` somente se necessario para coerencia de referencia
|
||||
- revisar `docs/runtime/learn/mental-model-asset-management.md` somente se a explicacao pedagogica ficar contraditoria apos a mudanca normativa
|
||||
|
||||
## Fora de Escopo
|
||||
|
||||
- alterar codigo do runtime
|
||||
- alterar packer
|
||||
- encerrar a compatibilidade legacy em runtime
|
||||
- redefinir layout de `TILES` ou `SOUNDS`
|
||||
|
||||
## Plano de Execucao
|
||||
|
||||
1. Trocar o valor canonico publicado de `RAW` para `NONE` em `specs/15`.
|
||||
2. Explicitar que:
|
||||
- `NONE` significa ausencia de codec generico adicional;
|
||||
- `NONE` nao significa ausencia de decode do bank;
|
||||
- layouts especificos continuam pertencendo ao contrato do `bank_type`.
|
||||
3. Registrar `RAW` apenas como alias legado durante a migracao curta.
|
||||
4. Revisar linguagem de `OP_MODE` para evitar que `codec` pareca dono do layout de `TILES`.
|
||||
5. Ajustar referencias editoriais relacionadas se houver contradicao residual.
|
||||
|
||||
## Criterios de Aceite
|
||||
|
||||
- `docs/runtime/specs/15-asset-management.md` publica `NONE` como valor canonico
|
||||
- a spec deixa claro que `codec` e camada generica de transformacao
|
||||
- a spec nao atribui a `codec` o layout especifico de `TILES` ou `SOUNDS`
|
||||
- `RAW` aparece apenas como legado/deprecated, se aparecer
|
||||
|
||||
## Tests / Validacao
|
||||
|
||||
- revisao editorial cruzada entre `specs/15`, `specs/13` e a decision `013`
|
||||
- checklist de coerencia contra o contrato atual de `TILES`
|
||||
- verificacao de que o texto nao fecha prematuramente contratos para banks genericos futuros como `BLOB`
|
||||
|
||||
## Riscos
|
||||
|
||||
- deixar a linguagem de transicao ambigua e publicar dupla semantica por tempo demais
|
||||
- descrever `NONE` de forma que pareca "sem decode"
|
||||
- endurecer demais `codec` e bloquear banks genericos futuros
|
||||
@@ -0,0 +1,61 @@
|
||||
# 016 Asset Codec `NONE` Runtime and Tests
|
||||
|
||||
## Briefing
|
||||
|
||||
Com a decision `013`, o runtime deve migrar o valor canonico de `codec` para `NONE` sem quebrar a transicao curta a partir de `RAW`.
|
||||
|
||||
Esta PR executa a propagacao em codigo, fixtures e testes do runtime.
|
||||
|
||||
## Decisions de Origem
|
||||
|
||||
- `docs/runtime/decisions/013-asset-codec-none-vs-raw.md`
|
||||
|
||||
## Alvo
|
||||
|
||||
Atualizar o runtime para que:
|
||||
|
||||
1. `NONE` seja aceito como valor principal de `codec`;
|
||||
2. `RAW` seja aceito apenas como alias legado durante a janela curta de transicao;
|
||||
3. fixtures e testes passem a publicar `NONE` como valor canonico;
|
||||
4. `TILES` e `SOUNDS` fiquem coerentes com a decision.
|
||||
|
||||
## Escopo
|
||||
|
||||
- atualizar `crates/console/prometeu-drivers/src/asset.rs`
|
||||
- atualizar fixtures/testes em `prometeu-drivers`, `prometeu-hal` e `prometeu-system`
|
||||
- ajustar comentarios inline onde `RAW` ainda apareca como valor canonico
|
||||
|
||||
## Fora de Escopo
|
||||
|
||||
- remover imediatamente a compatibilidade com `RAW`
|
||||
- alterar packer
|
||||
- introduzir novos codecs
|
||||
- mudar contratos de layout de `TILES` ou `SOUNDS`
|
||||
- publicar banks genericos novos como `BLOB`
|
||||
|
||||
## Plano de Execucao
|
||||
|
||||
1. Atualizar o path de resolucao de `codec` para aceitar `NONE` como valor canonico.
|
||||
2. Preservar `RAW` como alias legado durante a transicao curta.
|
||||
3. Migrar fixtures e testes para emitir `NONE`.
|
||||
4. Revisar comentarios e exemplos inline para remover `RAW` como default canonico.
|
||||
5. Validar que `TILES` e `SOUNDS` continuam operando sem regressao comportamental.
|
||||
|
||||
## Criterios de Aceite
|
||||
|
||||
- runtime aceita `NONE` em `TILES` e `SOUNDS`
|
||||
- runtime continua aceitando `RAW` apenas como alias legado
|
||||
- fixtures e testes passam a usar `NONE` como valor canonico
|
||||
- nenhum comentario ou helper novo reforca `RAW` como valor principal
|
||||
|
||||
## Tests / Validacao
|
||||
|
||||
- testes unitarios do asset loader
|
||||
- testes do runtime/VM que passam por asset loading
|
||||
- revisao de fixtures de cartridge/asset metadata
|
||||
|
||||
## Riscos
|
||||
|
||||
- deixar paths diferentes tratando `NONE` e `RAW` de forma inconsistente
|
||||
- migrar fixtures parcialmente e mascarar regressao real
|
||||
- prolongar compatibilidade legacy sem rastro claro para remocao futura
|
||||
@@ -36,7 +36,8 @@ Uma PR deste diretório deve:
|
||||
|
||||
## Roadmap Atual
|
||||
|
||||
Nenhuma PR em aberto no momento.
|
||||
- `015-asset-codec-none-canonicalization-in-specs.md`
|
||||
- `016-asset-codec-none-runtime-and-tests.md`
|
||||
|
||||
## PRs Finalizadas
|
||||
|
||||
|
||||
Reference in New Issue
Block a user