@noeva/etl-core 1.0.0-next.0 → 1.0.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/dist/cli.js +143 -117
- package/dist/guida/404.html +2 -2
- package/dist/guida/GUIDA_SVILUPPO.html +9 -6
- package/dist/guida/TECHNICAL_OVERVIEW.html +5 -5
- package/dist/guida/assets/{GUIDA_SVILUPPO.md.B_lGYssk.js → GUIDA_SVILUPPO.md.Dj20s7gS.js} +5 -2
- package/dist/guida/assets/{GUIDA_SVILUPPO.md.B_lGYssk.lean.js → GUIDA_SVILUPPO.md.Dj20s7gS.lean.js} +1 -1
- package/dist/guida/assets/{TECHNICAL_OVERVIEW.md.C9V6rGhh.js → TECHNICAL_OVERVIEW.md.DQP0pWc8.js} +1 -1
- package/dist/guida/assets/{app.Bgu6oi0F.js → app.vAJRZtow.js} +1 -1
- package/dist/guida/assets/chunks/@localSearchIndexroot.Bhyx8u0i.js +1 -0
- package/dist/guida/assets/chunks/{VPLocalSearchBox.ByJkVQg0.js → VPLocalSearchBox.D3nX303F.js} +1 -1
- package/dist/guida/assets/chunks/{theme.DvCzVyXX.js → theme.Bq6mfDhZ.js} +2 -2
- package/dist/guida/connectors/README.html +3 -3
- package/dist/guida/connectors/file.html +3 -3
- package/dist/guida/connectors/http.html +3 -3
- package/dist/guida/connectors/imap.html +3 -3
- package/dist/guida/connectors/jira.html +3 -3
- package/dist/guida/connectors/noeva.html +3 -3
- package/dist/guida/connectors/oauth.html +3 -3
- package/dist/guida/connectors/postgres.html +3 -3
- package/dist/guida/connectors/process.html +3 -3
- package/dist/guida/connectors/sendgrid.html +3 -3
- package/dist/guida/connectors/smtp.html +3 -3
- package/dist/guida/connectors/sqlserver.html +3 -3
- package/dist/guida/conventions/node-columns.html +3 -3
- package/dist/guida/conventions/node-descriptor.html +3 -3
- package/dist/guida/conventions/run-report.html +3 -3
- package/dist/guida/conventions/run-trace.html +3 -3
- package/dist/guida/conventions/variabili-del-core.html +3 -3
- package/dist/guida/conventions/versioni-di-pipeline.html +3 -3
- package/dist/guida/guide/claude-code/index.html +3 -3
- package/dist/guida/guide/claude-code/prompt.html +3 -3
- package/dist/guida/guide/claude-code/strumenti.html +3 -3
- package/dist/guida/guide/grafo.html +3 -3
- package/dist/guida/guide/usare/app-desktop.html +3 -3
- package/dist/guida/guide/usare/esito-di-una-run.html +3 -3
- package/dist/guida/guide/usare/index.html +3 -3
- package/dist/guida/hashmap.json +1 -1
- package/dist/guida/index.html +3 -3
- package/dist/guida/nodes/README.html +3 -3
- package/dist/guida/nodes/action.html +3 -3
- package/dist/guida/nodes/ai.html +3 -3
- package/dist/guida/nodes/join.html +3 -3
- package/dist/guida/nodes/lookup.html +3 -3
- package/dist/guida/nodes/pipeline.html +3 -3
- package/dist/guida/nodes/route.html +3 -3
- package/dist/guida/nodes/sink.html +3 -3
- package/dist/guida/nodes/source.html +3 -3
- package/dist/guida/nodes/task.html +3 -3
- package/dist/guida/nodes/transform.html +3 -3
- package/dist/guida/nodes/try-catch.html +3 -3
- package/dist/guida/nodes/union.html +3 -3
- package/dist/guida/pipelines/README.html +3 -3
- package/dist/guida/pipelines/crm-leads-sync.html +3 -3
- package/dist/guida/pipelines/cross-workspace-csv-merge.html +3 -3
- package/dist/guida/pipelines/movimenti-per-conto.html +3 -3
- package/dist/guida/pipelines/orders-enriched-daily.html +3 -3
- package/dist/guida/pipelines/test-posta.html +3 -3
- package/dist/guida/runbooks/aggiornamento-pm2.html +3 -3
- package/dist/guida/runbooks/deployment.html +3 -3
- package/dist/guida/runbooks/etl-worker.html +3 -3
- package/dist/guida/runbooks/graph-server.html +3 -3
- package/dist/guida/runbooks/mask-key.html +3 -3
- package/dist/guida/runbooks/oauth-google-posta.html +3 -3
- package/dist/guida/runbooks/rollback-di-pipeline.html +3 -3
- package/dist/guida/runbooks/scd2-rehash.html +3 -3
- package/dist/guida/runbooks/sql-task-truncate-swap.html +3 -3
- package/dist/guida/runbooks/stato-incrementale.html +3 -3
- package/dist/guida/sub-pipelines/README.html +3 -3
- package/dist/guida/sub-pipelines/riepilogo-ordini.html +3 -3
- package/docs/.vitepress/lib/published-docs.ts +4 -3
- package/kit/blocco-agents.md +7 -1
- package/package.json +1 -1
- package/dist/guida/assets/chunks/@localSearchIndexroot.B3k7jzMh.js +0 -1
- /package/dist/guida/assets/{TECHNICAL_OVERVIEW.md.C9V6rGhh.lean.js → TECHNICAL_OVERVIEW.md.DQP0pWc8.lean.js} +0 -0
|
@@ -13,7 +13,7 @@ import{_ as o,o as i,c as a,a5 as s}from"./chunks/framework.qdetmeNX.js";const g
|
|
|
13
13
|
<span class="line"><span>AGENTS.md # le istruzioni per l'agente, con il blocco del kit</span></span>
|
|
14
14
|
<span class="line"><span>.github/workflows/ci.yml # la CI: il setup, poi \`etl ci\`</span></span>
|
|
15
15
|
<span class="line"><span>.github/workflows/image.yml # l'immagine del deploy, a mano o su tag</span></span>
|
|
16
|
-
<span class="line"><span>ecosystem.config.cjs # una riga: il deploy sotto PM2</span></span></code></pre></div><p><strong>Crearlo.</strong> <code>etl init <slug></code> scrive nella cartella corrente il boilerplate del pacchetto, poi lancia <code>git init</code> con un primo commit e crea i branch <code>dev</code>, <code>staging</code> e <code>main</code>, con <code>HEAD</code> su <code>dev</code>. La cartella dev'essere vuota: altrimenti il comando si ferma con exit <code>2</code> senza scrivere niente, e lo stesso vale per uno slug che non è fatto di minuscole, cifre e trattini. Senza un'identità di git si ferma prima di scrivere, con exit <code>1</code>. Non crea il repo su GitHub né il secret del PAT, che restano a mano. Il boilerplate è magro, perché ciò che deve evolvere arriva per dipendenza:</p><table tabindex="0"><thead><tr><th>File</th><th>Cosa contiene</th></tr></thead><tbody><tr><td><code>package.json</code></td><td><code>noeva-etl-<slug></code>, ESM, il core alla versione che genera il repo, il <code>packageManager</code> del core, gli alias <code>pipeline:*</code> e la toolchain nelle <code>devDependencies</code></td></tr><tr><td><code>etl.config.ts</code></td><td><code>client</code> e il catalogo vuoto</td></tr><tr><td><code>.env.example</code></td><td>le sole variabili obbligatorie del core (<code>NOEVA_API_BASE_URL</code>, <code>NOEVA_API_KEY</code>, <code>NOEVA_WORKSPACE_ID</code>)</td></tr><tr><td><code>.npmrc</code></td><td>il registry di <code>@my-ginkgo</code> su GitHub Packages, senza token</td></tr><tr><td><code>tsconfig.json</code>, <code>eslint.config.js</code>, <code>vitest.config.ts</code></td><td>una riga sul preset</td></tr><tr><td><code>.gitignore</code></td><td><code>.env</code>, <code>.runs/</code>, <code>.state/</code>, <code>logs/</code> di PM2, il sito costruito, la sua cache e i file temporanei di VitePress, <code>docs/catalogo.md</code></td></tr><tr><td><code>.prettierignore</code></td><td>il lockfile e gli snapshot del piano, che <code>etl versions snapshot</code> scrive con la sua formattazione</td></tr><tr><td><code>src/pipelines/</code>, <code>docs/pipelines/</code></td><td>vuote: le cartelle delle pipeline e le loro schede</td></tr><tr><td><code>AGENTS.md</code>, <code>CLAUDE.md</code></td><td>le istruzioni per l'agente, con il blocco gestito dal core; <code>CLAUDE.md</code> è solo <code>@AGENTS.md</code></td></tr><tr><td><code>.claude/</code></td><td>file gestiti: il kit dell'agente in <code>skills/</code>, <code>agents/</code> e <code>hooks/</code> <code>noeva-etl-*</code>, e la voce dell'hook in <code>settings.json</code> (§10)</td></tr><tr><td><code>.github/workflows/ci.yml</code></td><td>file gestito: checkout con <code>fetch-depth: 0</code>, pnpm e node, install col PAT nel secret <code>NOEVA_ETL_PACKAGES_TOKEN</code>, poi <code>pnpm exec etl ci</code></td></tr><tr><td><code>.github/workflows/image.yml</code></td><td>file gestito: l'immagine col Dockerfile del pacchetto, su <code>ghcr.io/<owner>/noeva-etl-<slug></code> con tag = SHA, a mano o su tag; il PAT come BuildKit secret</td></tr><tr><td><code>ecosystem.config.cjs</code></td><td>file gestito: una riga su <code>ecosystem()</code> di <code>@noeva/etl-core/pm2</code>, che avvia <code>etl serve</code> sotto PM2</td></tr></tbody></table><p><strong>La toolchain</strong> sta nelle <code>devDependencies</code> del repo: <code>vitest</code>, <code>eslint</code>, <code>typescript</code>, <code>prettier</code> e <code>@types/node</code>, con i range che <code>etl init</code> legge dal <code>package.json</code> del core installato. Con pnpm le dipendenze del core non si vedono dal repo, e senza <code>vitest</code> e <code>@types/node</code> installati lì <code>tsc --noEmit</code> non trova i tipi dei test; con gli stessi range pnpm tiene una sola copia per il core e per il repo. Li
|
|
16
|
+
<span class="line"><span>ecosystem.config.cjs # una riga: il deploy sotto PM2</span></span></code></pre></div><p><strong>Crearlo.</strong> <code>etl init <slug></code> scrive nella cartella corrente il boilerplate del pacchetto, poi lancia <code>git init</code> con un primo commit e crea i branch <code>dev</code>, <code>staging</code> e <code>main</code>, con <code>HEAD</code> su <code>dev</code>. La cartella dev'essere vuota: altrimenti il comando si ferma con exit <code>2</code> senza scrivere niente, e lo stesso vale per uno slug che non è fatto di minuscole, cifre e trattini. Senza un'identità di git si ferma prima di scrivere, con exit <code>1</code>. Non crea il repo su GitHub né il secret del PAT, che restano a mano. Il boilerplate è magro, perché ciò che deve evolvere arriva per dipendenza:</p><table tabindex="0"><thead><tr><th>File</th><th>Cosa contiene</th></tr></thead><tbody><tr><td><code>package.json</code></td><td><code>noeva-etl-<slug></code>, ESM, il core alla versione che genera il repo, il <code>packageManager</code> del core, gli alias <code>pipeline:*</code> e la toolchain nelle <code>devDependencies</code></td></tr><tr><td><code>etl.config.ts</code></td><td><code>client</code> e il catalogo vuoto</td></tr><tr><td><code>.env.example</code></td><td>le sole variabili obbligatorie del core (<code>NOEVA_API_BASE_URL</code>, <code>NOEVA_API_KEY</code>, <code>NOEVA_WORKSPACE_ID</code>)</td></tr><tr><td><code>.npmrc</code></td><td>il registry di <code>@my-ginkgo</code> su GitHub Packages, senza token</td></tr><tr><td><code>tsconfig.json</code>, <code>eslint.config.js</code>, <code>vitest.config.ts</code></td><td>una riga sul preset</td></tr><tr><td><code>.gitignore</code></td><td><code>.env</code>, <code>.runs/</code>, <code>.state/</code>, <code>logs/</code> di PM2, il sito costruito, la sua cache e i file temporanei di VitePress, <code>docs/catalogo.md</code></td></tr><tr><td><code>.prettierignore</code></td><td>il lockfile e gli snapshot del piano, che <code>etl versions snapshot</code> scrive con la sua formattazione</td></tr><tr><td><code>src/pipelines/</code>, <code>docs/pipelines/</code></td><td>vuote: le cartelle delle pipeline e le loro schede</td></tr><tr><td><code>AGENTS.md</code>, <code>CLAUDE.md</code></td><td>le istruzioni per l'agente, con il blocco gestito dal core; <code>CLAUDE.md</code> è solo <code>@AGENTS.md</code></td></tr><tr><td><code>.claude/</code></td><td>file gestiti: il kit dell'agente in <code>skills/</code>, <code>agents/</code> e <code>hooks/</code> <code>noeva-etl-*</code>, e la voce dell'hook in <code>settings.json</code> (§10)</td></tr><tr><td><code>.github/workflows/ci.yml</code></td><td>file gestito: checkout con <code>fetch-depth: 0</code>, pnpm e node, install col PAT nel secret <code>NOEVA_ETL_PACKAGES_TOKEN</code>, poi <code>pnpm exec etl ci</code></td></tr><tr><td><code>.github/workflows/image.yml</code></td><td>file gestito: l'immagine col Dockerfile del pacchetto, su <code>ghcr.io/<owner>/noeva-etl-<slug></code> con tag = SHA, a mano o su tag; il PAT come BuildKit secret</td></tr><tr><td><code>ecosystem.config.cjs</code></td><td>file gestito: una riga su <code>ecosystem()</code> di <code>@noeva/etl-core/pm2</code>, che avvia <code>etl serve</code> sotto PM2</td></tr></tbody></table><p><strong>La toolchain</strong> sta nelle <code>devDependencies</code> del repo: <code>vitest</code>, <code>eslint</code>, <code>typescript</code>, <code>prettier</code> e <code>@types/node</code>, con i range che <code>etl init</code> legge dal <code>package.json</code> del core installato. Con pnpm le dipendenze del core non si vedono dal repo, e senza <code>vitest</code> e <code>@types/node</code> installati lì <code>tsc --noEmit</code> non trova i tipi dei test; con gli stessi range pnpm tiene una sola copia per il core e per il repo. Li riallinea <code>etl upgrade</code> a ogni bump, coi range del core nuovo.</p><p><strong>La CI.</strong> <code>ci.yml</code> non usa workflow riusabili dell'org, così regge al transfer del repo, e gira sulle PR verso <code>dev</code> e <code>main</code> e sui push su <code>main</code>. Il secret <code>NOEVA_ETL_PACKAGES_TOKEN</code> del repo cliente è un <strong>PAT classic <code>read:packages</code></strong> dell'utente invitato, che serve solo a installare il core. Nel repo del core lo stesso nome indica un PAT <code>write:packages</code>, che pubblica il pacchetto: non è lo stesso token.</p><p><strong>I file gestiti.</strong> Il blocco di <code>AGENTS.md</code>, fra <code><!-- noeva-etl:inizio … --></code> e <code><!-- noeva-etl:fine --></code>, lo scrive <code>etl agent sync</code>; il resto del file è del repo. Dice all'agente di lanciare <code>etl upgrade --check</code> prima di ogni nuovo sviluppo, di leggere il changelog del core prima di ogni bump, e porta le regole su doc nello stesso commit, <code>--realign</code> e i tre rollback. I file gestiti che <code>etl init</code> scrive sono i due YAML (<code>ci.yml</code> e <code>image.yml</code>), <code>ecosystem.config.cjs</code>, il kit dell'agente in <code>.claude/{skills,agents,hooks}/noeva-etl-*</code> con la voce dell'hook in <code>.claude/settings.json</code> (§10), e il blocco di <code>AGENTS.md</code>; tutto il resto è del repo. Un file gestito che il repo vuole tenersi si dichiara in <code>etl.config.ts</code> con <code>unmanaged: [".github/workflows/ci.yml"]</code> (per il kit, la cartella di una skill, il file di un subagent, <code>AGENTS.md</code> per il blocco o <code>.claude/settings.json</code> per la voce dell'hook), e da lì l'aggiornamento è del repo. <code>image.yml</code> costruisce l'immagine del deploy col Dockerfile del pacchetto (<a href="./runbooks/deployment#immagine-del-repo-cliente">Deploy § Immagine del repo cliente</a>), e <code>ecosystem.config.cjs</code> è la riga che avvia <code>etl serve</code> sotto PM2 (<a href="./runbooks/aggiornamento-pm2">Aggiornare un deploy PM2</a>).</p><p><strong>Il catalogo.</strong> <code>etl.config.ts</code> esporta <code>defineEtlConfig({ client, pipelines })</code>: <code>client</code> è lo slug del cliente, <code>pipelines</code> le pipeline importate come valori. Ogni comando che lavora sulle pipeline (<code>list</code>, <code>plan</code>, <code>run</code>, <code>state</code>, <code>versions</code>, <code>env</code>, <code>catalog</code>, <code>docs</code>, <code>ci</code>, <code>serve</code>, <code>worker</code>) legge questo file: la CLI lo cerca risalendo dalla cartella corrente, e <code>--config <file></code> lo indica a mano. Il TypeScript gira dai sorgenti con <code>tsx</code>, quindi il <code>package.json</code> del repo dichiara <code>"type": "module"</code>. Un config assente o che non si importa, un export di forma sbagliata, una voce che non è una <code>RunnablePipeline</code>, un nome ripetuto (anche fra pipeline e sub-pipeline) o un <code>client</code> che non è uno slug fermano il comando con exit <code>2</code> e un errore che nomina la causa; un catalogo vuoto è permesso, con un avviso. Grafi, dispatch del worker e annuncio del catalogo a noeva-server vedono le stesse pipeline: non c'è un registro a parte.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// etl.config.ts</span></span>
|
|
17
17
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineEtlConfig } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "@noeva/etl-core"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
|
18
18
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { testPosta } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "@noeva/etl-core/pipelines"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
|
19
19
|
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { fattureDaily } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "./src/pipelines/fatture-daily/run.js"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
|
@@ -35,6 +35,9 @@ import{_ as o,o as i,c as a,a5 as s}from"./chunks/framework.qdetmeNX.js";const g
|
|
|
35
35
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> .</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">build</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div><p>Gli undici tipi di nodo. A questi si aggiunge il nodo <a href="./nodes/pipeline"><code>pipeline</code></a>, <code>.pipeline(from, id, sub, { params?, deps?, fromPort?, deadLetter?, purpose? })</code>, che istanzia una sub-pipeline e alla costruzione diventa i suoi nodi:</p><table tabindex="0"><thead><tr><th>Nodo</th><th>Metodo</th><th>Cosa fa</th></tr></thead><tbody><tr><td><code>source</code></td><td><code>.source(id, source)</code></td><td>punto d'ingresso di uno stream</td></tr><tr><td><code>transform</code></td><td><code>.transform(from, id, t, opts)</code></td><td>trasformazione pura; accetta <code>deadLetter</code></td></tr><tr><td><code>lookup</code></td><td><code>.lookup(from, id, config, opts)</code></td><td>lettura <strong>in sola lettura</strong> in mezzo al grafo, a batch, da un DB o un'API REST; accetta <code>deadLetter</code> e <code>recordReport</code></td></tr><tr><td><code>ai</code></td><td><code>.ai(from, id, config, opts)</code></td><td>domanda a un <strong>modello</strong> per ogni record, con la risposta che arricchisce il record (es. <code>noevaAiExtract</code>); si esegue come un <code>lookup</code>; accetta <code>deadLetter</code> e <code>recordReport</code></td></tr><tr><td><code>action</code></td><td><code>.action(from, id, action, opts)</code></td><td><strong>scrittura per record</strong> in mezzo al grafo, con un record in uscita su cui il grafo prosegue; accetta <code>deadLetter</code> e <code>recordReport</code></td></tr><tr><td><code>route</code></td><td><code>.route(from, id, { routes }, opts)</code></td><td><strong>smistamento esclusivo</strong>: ogni record esce sulla porta della prima condizione vera, o su <code>default</code>; ogni porta va collegata; accetta <code>deadLetter</code></td></tr><tr><td><code>join</code></td><td><code>.join(id, { build, probe, … })</code></td><td>fan-in <strong>a chiave</strong>: join inner/left, lato <code>build</code> in memoria e <code>probe</code> in streaming; accetta <code>deadLetter</code></td></tr><tr><td><code>union</code></td><td><code>.union(id, { from, order })</code></td><td>fan-in di N flussi con la stessa forma, record invariati: <code>interleave</code> (default) nell'ordine di arrivo, <code>concat</code> nell'ordine di <code>from</code></td></tr><tr><td><code>try-catch</code></td><td><code>.tryCatch(from, id, opts)</code></td><td>apre uno scope di gestione errori sui nodi a valle, con una porta <code>catch</code></td></tr><tr><td><code>sink</code></td><td><code>.sink(from, sink)</code></td><td>scrittura verso l'esterno; l'id del nodo è <code>sink.name</code></td></tr><tr><td><code>task</code></td><td><code>.task(id, task, opts)</code></td><td>operazione <strong>senza record</strong> (truncate, scambio di tabelle), avviata dagli edge di controllo <code>after</code></td></tr></tbody></table><p>Il cheatsheet dei nodi, con una scheda di dettaglio per ciascuno (opzioni, errori, esempi), è in <a href="./nodes/README">Tipi di nodo</a>.</p><p>Il <strong>fan-out</strong> invece è libero: basta agganciare più nodi allo stesso <code>from</code>, e il runner duplica lo stream. La forma del grafo è validata <strong>a runtime</strong> su <code>.build()</code>: cicli, id sconosciuti o più di un ingresso su un nodo diverso da <code>join</code> e <code>union</code> esplodono come <code>GraphValidationError</code> alla costruzione. Esempio di riferimento completo: <a href="./pipelines/orders-enriched-daily"><code>orders-enriched-daily</code></a>.</p><p>Oltre agli edge di dati ci sono gli <strong>edge di controllo</strong>: l'opzione <code>after</code> di <code>.task()</code> e <code>.source()</code> dice «parti solo dopo che questi nodi sono riusciti». Partono da un <code>task</code> o da un <code>sink</code> e arrivano a un <code>task</code> o a una <code>source</code>. Dettagli nella scheda <a href="./nodes/task"><code>task</code></a>.</p><p>Ogni nodo ha uno <strong>scopo</strong>, <code>purpose</code>, scritto per chi legge il grafo nell'app: che cosa fa il nodo e perché serve, in una-tre frasi di business. Lo verificano <code>etl catalog check</code> ed <code>etl docs build</code>.</p><p>Il <code>RunContext</code> che ogni nodo riceve porta env, parametri di lancio (<code>ctx.params</code>), logger, metriche, il segnale d'arresto e lo store dello stato di pipeline. Gli errori di dominio sono <code>EtlError</code> (<code>ValidationError</code>, <code>ExtractError</code>, <code>LoadError</code>, <code>ConfigError</code>, <code>GraphValidationError</code>, <code>JoinError</code>, <code>LookupError</code>, <code>ActionError</code>, <code>TaskError</code>, <code>AssertionError</code>, <code>GraphRunFailure</code>): un errore che non lo è conta come bug.</p><h2 id="_5-come-gira-una-pipeline" tabindex="-1">5. Come gira una pipeline <a class="header-anchor" href="#_5-come-gira-una-pipeline" aria-label="Permalink to "5. Come gira una pipeline""></a></h2><p>Il grafo è <strong>pull-based</strong>: la domanda parte dai sink e risale verso le source, quindi è il ritmo di scrittura a regolare quello di lettura (backpressure gratis). I record scorrono in streaming, mai tutti in memoria — tranne il lato <code>build</code> di un <code>join</code> e le transform che trattengono lo stream, come <code>sort</code>, che hanno un tetto obbligatorio.</p><p>Quando un record fallisce ci sono tre percorsi, dal più locale al più drastico:</p><ul><li><strong>Dead-letter per nodo</strong> — <code>{ deadLetter: sink }</code> su un <code>transform</code>, <code>lookup</code>, <code>ai</code>, <code>action</code>, <code>route</code> o <code>join</code>. Il record che solleva <code>EtlError</code> esce come envelope <code>DeadLetter</code> su quel sink e <strong>lo stream continua</strong>. Adatto alle trasformazioni <strong>stateless</strong> (map/mapColumns/flatMap/explode/unpivot/filter/validate, <code>parse</code>, <code>hashRow</code>, <code>surrogateKey</code>, <code>mask</code>). Sul <code>.pipeline()</code> della root la <code>deadLetter</code> si distribuisce a ogni nodo isolabile dell'istanza, istanze annidate comprese (<a href="./nodes/pipeline#deadletter-sull-istanza"><code>deadLetter</code> sull'istanza</a>).</li><li><strong>Nodo <code>try-catch</code></strong> — protegge tutti i nodi raggiungibili dalla sua porta <code>out</code>, sink compresi. Di default è <code>per-record</code>: ogni record che fallisce va sul ramo <code>catch</code>, che è fatto di nodi veri e può loggare, rimappare o instradare altrove. In <code>circuit-breaker</code> al primo errore la sub-stream si ferma.</li><li><strong>Fail-fast</strong> — il default, senza dead-letter né guard: l'errore aborta la run. È l'unica scelta sensata per le trasformazioni <strong>stateful</strong> (es. <code>groupBy</code>, <code>sort</code>, <code>serialize</code>): un'aggregazione spezzata per record darebbe un risultato falso. Vale per tutto il grafo: al primo errore fatale il runner annulla anche i rami indipendenti e aspetta che ogni sink e ogni task chiuda prima di riportare la run fallita. Un <code>task</code> che fallisce è sempre fatale.</li></ul><p>Un errore che <strong>non</strong> è un <code>EtlError</code> (un <code>TypeError</code>, un bug) aborta sempre la run, anche dentro un guard: un bug non va scaricato in un sink di scarto, va visto. Qualunque sia la scelta, nessun record sparisce in silenzio: ogni scarto è contato nel report.</p><p>Ogni <code>run()</code> produce un <code>GraphRunReport</code>:</p><ul><li><strong>stato</strong> — <code>success</code>, <code>partial</code> (arrivata in fondo con scarti o errori catturati) o <code>failed</code>;</li><li><strong>totali</strong> — <code>extracted</code> (somma delle source), <code>written</code> (somma dei sink: su un fan-out lo stesso record scritto due volte conta due), <code>rejected</code>, <code>rejectedReasons</code>;</li><li><strong>per nodo</strong> — <code>nodes[]</code> ed <code>edges[]</code> con la topologia reale e i contatori di ogni nodo, <code>caught</code> sui guard, tempi di attraversamento;</li><li><strong>stato di pipeline</strong> — <code>state</code>, una voce per source incrementale: da dove ha letto, cosa propone, se il watermark è stato committato;</li><li>metriche ed errore — <strong>mai segreti o payload</strong>.</li></ul><p>È il "prodotto" del servizio: chi invoca la pipeline decide se archiviarlo, alertare, ecc. Schema completo in <a href="./conventions/run-report">Il report di run</a>.</p><h2 id="_6-cosa-c-e-gia-pronto" tabindex="-1">6. Cosa c'è già pronto <a class="header-anchor" href="#_6-cosa-c-e-gia-pronto" aria-label="Permalink to "6. Cosa c'è già pronto""></a></h2><p><strong>Connettori</strong>, uno per subpath di <code>@noeva/etl-core/connectors/</code>:</p><ul><li><strong>PostgreSQL</strong> (<code>postgres</code>) — source con cursor streaming, sink con upsert <code>ON CONFLICT</code> o in modalità SCD2 (dimensioni storicizzate), task SQL <code>postgresSqlTask</code> (statement in una transazione, per il nodo <code>task</code>).</li><li><strong>SQL Server</strong> (<code>sqlserver</code>) — source streaming, sink con <code>MERGE</code> o in modalità SCD2, task SQL <code>mssqlSqlTask</code>.</li><li><strong>File</strong> (<code>file</code>) — architettura a due assi componibili: <ul><li><em>storage</em>: dove vivono i file (locale, <strong>S3</strong>, <strong>SFTP</strong>, <strong>FTP/FTPS</strong>);</li><li><em>codec</em>: come si (de)serializzano — <strong>CSV</strong> (anche grezzo, <code>csvRawCodec</code>), <strong>JSON/NDJSON</strong>, <strong>XML</strong>, <strong>XLSX</strong>, <strong>Parquet</strong>. Storage e codec si combinano liberamente (es. CSV su S3, Parquet su SFTP).</li></ul></li><li><strong>Noeva</strong> (<code>noeva</code>) — file dei workspace Noeva via noeva-server-api: lettura di un file o di una cartella intera, scrittura di uno o più file in <code>overwrite</code> o <code>new-version</code>, upload con elaborazione AI (<code>noevaUploadAction</code>), lookup su stato e testo estratto ed estrazione AI di campi strutturati (<code>noevaAiExtract</code>, nodo <code>ai</code>).</li><li><strong>IMAP</strong> (<code>imap</code>) — caselle di posta: <code>imapSource</code> legge i messaggi di una cartella (allegati ed EML grezzo), le action <code>imapFlagAction</code> e <code>imapSpostaAction</code> marcano e spostano, con la cartella come coda.</li><li><strong>SMTP</strong> (<code>smtp</code>) — notifiche email: <code>smtpAction</code> e <code>smtpSink</code> inviano una mail costruita da una funzione del record, con Message-ID deterministico contro i doppioni.</li><li><strong>SendGrid</strong> (<code>sendgrid</code>) — mail via API REST v3: <code>sendgridAction</code> e <code>sendgridSink</code>, con la stessa mail di SMTP (<code>MailInUscita</code>), sandbox per le prove, retry di <code>429</code> e <code>5xx</code>; <code>mailAction</code> e <code>mailSink</code> (<code>mail</code>) scelgono fra SMTP e SendGrid da configurazione.</li><li><strong>HTTP</strong> (<code>http</code>) — API REST per i nodi <code>lookup</code> e <code>action</code>: <code>httpLookup</code> legge in sola lettura, una richiesta per batch o una <code>GET</code> per chiave, <code>httpAction</code> scrive e prosegue con l'esito; la risposta è validata da uno schema Zod e le credenziali vengono dal registry <code>HTTP_INSTANCES</code>. Il loro trasporto, <code>richiestaHttp</code>, è condiviso con i connettori REST di dominio, come Jira.</li><li><strong>Jira Cloud</strong> (<code>jira</code>) — <code>jiraIssues</code> legge le issue di una JQL, pagina dopo pagina, con i siti nel registry <code>JIRA_INSTANCES</code>; i campi si dichiarano per id o per nome e diventano colonne normalizzate, con gli ADF convertiti in testo. <code>jiraIssueLookup</code> legge le stesse issue per chiave, e <code>jiraChangelogLookup</code>, <code>jiraCommentsLookup</code> e <code>jiraWorklogsLookup</code> danno a ogni issue la sua lista completa. <code>jiraCreateIssue</code>, <code>jiraUpdateIssue</code>, <code>jiraTransition</code>, <code>jiraUpsertIssue</code> (per ID esterno), <code>jiraAddComment</code> e <code>jiraAddWorklog</code> (con una chiave di deduplica obbligatoria) e <code>jiraLinkIssues</code> scrivono come nodi <code>action</code>, con l'esito come dato.</li><li><strong>Processo esterno</strong> (<code>process</code>) — <code>processoEsternoAction</code> lancia un programma per record, senza shell, in una cartella temporanea sempre cancellata: i file del record entrano, i file di <code>uscita/</code> e un riepilogo JSON validato con Zod escono. Ambiente da allowlist e timeout obbligatorio.</li><li><strong>OAuth2</strong> (<code>oauth</code>) — non un connettore ma l'<strong>identità</strong> che IMAP e SMTP usano dove la password non basta più (Gmail, Workspace, Microsoft 365): tiene il refresh token e ne scambia uno nuovo quando l'access token scade, con un registry proprio <code>OAUTH_INSTANCES</code>.</li></ul><p>Le schede, con configurazione e variabili d'ambiente di ognuno, sono in <a href="./connectors/README">Connettori</a>.</p><p><strong>Trasformazioni riusabili</strong>, dalla radice del pacchetto: <code>groupBy</code> (aggregazione stateful generica init/reduce/finalize), <code>dedup</code> (duplicati per chiave), <code>mapColumns</code> (select, rename, cast e colonne calcolate, con lineage di colonna) e <code>castValue</code> (i suoi cast stretti, usabili da soli), <code>explode</code> (un campo array → un record per elemento), <code>unpivot</code> e <code>pivot</code> (dal formato largo al lungo e ritorno, con colonne dichiarate), <code>sort</code> (ordinamento stabile su più chiavi), <code>chunk</code> (record in lotti di N per un sink o un'API con limite di payload), <code>parse</code> (byte di un file → righe, con un <code>FileCodec</code>) e <code>serialize</code> (record → un file per gruppo, stateful), <code>hashRow</code> e <code>surrogateKey</code> (hash di riga e chiave surrogata deterministici), <code>mask</code> (mascheramento e pseudonimizzazione delle colonne con dati personali), <code>profile</code> (profilo delle colonne nel report del nodo, a memoria costante), <code>assert</code> (controlli sul dataset a fine stream). Il catalogo completo è in <a href="./nodes/transform#transform-pronte">transform</a>.</p><p><strong>Pipeline d'esempio</strong>, con la loro scheda nella sezione «Esempi» di questa guida:</p><ul><li><a href="./pipelines/orders-enriched-daily"><code>orders-enriched-daily</code></a> — dataset demo in memoria, esempio di riferimento per una pipeline <strong>a grafo</strong>: due sorgenti, join a chiave, fan-out su due sink, dead-letter isolato su due nodi indipendenti, try/catch e un'istanza della sub-pipeline <a href="./sub-pipelines/riepilogo-ordini"><code>riepilogo-ordini</code></a>.</li><li><a href="./pipelines/movimenti-per-conto"><code>movimenti-per-conto</code></a> — dataset demo in memoria, esempio di riferimento per le transform di file e di ordinamento in mezzo al grafo: <code>parse</code>, <code>sort</code> e <code>serialize</code>, da estratti conto CSV a un CSV per conto.</li><li><a href="./pipelines/crm-leads-sync"><code>crm-leads-sync</code></a> — copia fra due istanze Postgres dello stesso registry, con un try/catch per record.</li><li><a href="./pipelines/cross-workspace-csv-merge"><code>cross-workspace-csv-merge</code></a> — merge di un CSV fra due workspace Noeva, con un <code>union</code> e la scrittura in <code>new-version</code> su entrambi.</li></ul><p><strong>Pipeline pronte</strong>, da dichiarare nel catalogo: <a href="./pipelines/test-posta"><code>test-posta</code></a>, la prova dei connettori IMAP e SMTP di un'installazione.</p><h2 id="_7-i-comandi" tabindex="-1">7. I comandi <a class="header-anchor" href="#_7-i-comandi" aria-label="Permalink to "7. I comandi""></a></h2><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> init</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> <</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">slu</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">g</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">></span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # in una cartella vuota: il boilerplate di un repo cliente</span></span>
|
|
36
36
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ci</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # il gate completo del repo, lo stesso della CI</span></span>
|
|
37
37
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> agent</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> sync</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # riscrive il kit dell'agente dal core installato (§10)</span></span>
|
|
38
|
+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> upgrade</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --check</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # versione installata e ultima, changelog e deriva dei file gestiti</span></span>
|
|
39
|
+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> upgrade</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # il bump del core e il sync dei file gestiti</span></span>
|
|
40
|
+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> exec</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> upgrade</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --sync</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # solo il sync dei file gestiti col core installato</span></span>
|
|
38
41
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> list</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # le pipeline del catalogo; le pronte marcate con «pronta»</span></span>
|
|
39
42
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> plan</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # la topologia di ogni pipeline (JSON, ultima riga)</span></span>
|
|
40
43
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> <</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">pipelin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">e</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">></span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # esegue una pipeline</span></span>
|
|
@@ -48,4 +51,4 @@ import{_ as o,o as i,c as a,a5 as s}from"./chunks/framework.qdetmeNX.js";const g
|
|
|
48
51
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> build</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # il gate della documentazione, poi il sito del cliente</span></span>
|
|
49
52
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> dev</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # lo stesso sito in sviluppo</span></span>
|
|
50
53
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> serve</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # grafi via HTTP + worker</span></span>
|
|
51
|
-
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> worker</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # solo il daemon su processes</span></span></code></pre></div><p><strong><code>etl ci</code></strong> è il gate del repo, lo stesso in locale e nella CI. Esegue, in quest'ordine, <code>tsc --noEmit</code>, ESLint (<code>lint</code>), Prettier in <code>--check</code> (<code>format</code>), vitest con <code>--passWithNoTests</code> (<code>test</code>), <code>etl versions check</code>, <code>etl catalog check</code> ed <code>etl docs build</code>. Su stderr ogni fase si annuncia con <code>▶ <fase></code>, e la prima che fallisce ferma il gate: <code>etl ci: la fase «<fase>» è fallita</code>, con l'exit code della fase. Gli strumenti sono quelli installati nel repo, o in mancanza quelli fra le dipendenze del core; i comandi <code>etl</code> girano in processo sul catalogo già caricato. Un catalogo vuoto passa, con l'avviso del caricamento, e un repo appena creato senza test pure; senza <code>origin/dev</code>, prima del primo push, il gate delle versioni dà l'avviso «nessuna base» e controlla solo gli snapshot (vedi <a href="./conventions/versioni-di-pipeline">Versioni di pipeline</a>). Quali fasi girano arriva con il bump del core, mentre <code>ci.yml</code> resta fermo. Un core non aggiornato sarà un avviso e mai un errore: il controllo è quello di <code>etl upgrade --check</code>, che non c'è ancora.</p><p><strong><code>etl env check</code></strong> verifica l'ambiente sull'intero catalogo: su stdout una riga per variabile obbligatoria mancante, <code><VARIABILE>\\t<provenienze></code>, dove la provenienza è <code>core</code>, <code>pipeline <nome></code> o <code>istanza <connettore> <id> (<pipeline che la usano>)</code>; su stderr un avviso per ogni chiave del <code>.env</code> che nessuno dichiara (solo il nome, mai il valore) e il riepilogo. Esce con <code>1</code> se manca un'obbligatoria, <code>0</code> altrimenti, anche con sconosciute. Le variabili del core sono in <a href="./conventions/variabili-del-core">Variabili d'ambiente del core</a>; quelle di una pipeline le dà il suo <code>environment(env)</code>, scritto con <code>ambienteDellaPipeline</code> di <code>./connector-kit</code> dagli stessi manifest della run (vedi <a href="./pipelines/test-posta"><code>test-posta</code></a>). Senza, il check ricade sul piano, che non mostra tutte le variabili di un'istanza (l'utente di un DB, l'identità OAuth2), e quelle variabili, se stanno nel <code>.env</code>, compaiono fra le sconosciute. Legge l'ambiente del processo, con il <code>.env</code> alla radice del repo che la CLI carica da sola prima di ogni comando (le variabili già nel processo vincono). Resta fuori dalla CI: serve l'ambiente vero.</p><p><strong><code>etl catalog check</code></strong> è la conformità del catalogo: gli stessi controlli in ogni repo, che arrivano aggiornati con il bump del core. Su stdout una riga per violazione, <code><regola>\\t<pipeline>: <dettaglio></code>; su stderr il riepilogo e gli avvisi del caricamento. Esce con <code>0</code> se il catalogo è conforme (anche vuoto, con l'avviso), <code>1</code> con almeno una violazione, <code>2</code> per un errore d'uso o di configurazione. Le regole:</p><table tabindex="0"><thead><tr><th>Regola</th><th>Cosa verifica</th></tr></thead><tbody><tr><td><code>changelog</code></td><td>numeri da 1 senza buchi, date <code>AAAA-MM-GG</code> in ordine, ticket, voci non vuote</td></tr><tr><td><code>piano-senza-credenziali</code></td><td><code>getSpec()</code> senza <code>.env</code> non lancia, il piano ha il nome della pipeline, almeno una source e un sink, si serializza in JSON e i nodi stanno nella proiezione</td></tr><tr><td><code>scopo-dei-nodi</code></td><td>ogni nodo e ogni istanza ha uno scopo; esenti il collettore dei dead-letter e i nodi di confine di un'istanza, che genera il core</td></tr><tr><td><code>piano-senza-segreti</code></td><td>con l'ambiente di <code>.env.example</code> e un valore riconoscibile al posto di ogni segreto il piano si disegna dalla configurazione risolta e non contiene segreti; poi lo stesso con le credenziali alternative</td></tr><tr><td><code>cartella-orfana</code></td><td>ogni <code>run.ts</code> sotto <code>src/pipelines/</code> esporta una pipeline del catalogo: una pipeline tolta da <code>etl.config.ts</code> non resta senza controlli</td></tr></tbody></table><p>L'ambiente di prova di <code>piano-senza-segreti</code> è il <code>.env.example</code> alla radice del config, più le variabili segrete che le pipeline dichiarano con <code>environment(env)</code>. È segreta una variabile il cui nome contiene <code>PASSWORD</code>, <code>SECRET</code>, <code>TOKEN</code>, <code>API_KEY</code>, <code>ACCESS_KEY</code> o <code>PRIVATE_KEY</code>. Le credenziali commentate (<code># IMAP_ACCESS_TOKEN=</code>) sono alternative: il secondo passaggio le attiva e toglie quella attiva con lo stesso prefisso (<code>IMAP_PASSWORD</code>). Per questo <code>.env.example</code> deve essere completo: una pipeline che con quelle variabili si disegna dall'esempio (un valore con la parola «esempio» nel piano) è una violazione, perché il controllo sui segreti guarderebbe solo i segnaposto.</p><p><strong><code>etl versions</code></strong> tiene le versioni di pipeline: ogni cambio di piano è una versione nuova, con la sua voce nel changelog e lo snapshot del piano. Il gate, il rollback di una pipeline sola e il riallineamento al core sono in <a href="./conventions/versioni-di-pipeline">Versioni di pipeline</a> e nel <a href="./runbooks/rollback-di-pipeline">runbook del rollback</a>.</p><p><strong><code>etl docs build</code></strong> costruisce la documentazione del cliente, con configurazione, tema e componenti dei grafi dal pacchetto: in un repo cliente <code>docs/</code> è solo markdown. Il sito va in <code>docs/.vitepress/dist</code> (<code>--outDir</code> per un'altra cartella), col nome del cliente nel titolo, e comprende tutto <code>docs/</code>, ADR compresi, più una pagina indice del catalogo, <code>docs/catalogo.md</code>, che il build genera e che non si versiona. <strong><code>etl docs dev</code></strong> serve lo stesso sito in sviluppo (<code>--port <n></code>). Il sito costruito lo serve <code>etl serve</code> su <code>/guida/</code>, accanto alla guida del core su <code>/guida/core/</code> (<a href="./runbooks/graph-server">runbook del server</a>). Prima di costruire il comando controlla la documentazione, e con un problema si ferma: una riga per problema su stdout, <code><regola>\\t<dove>: <dettaglio></code>, ed exit <code>1</code>.</p><table tabindex="0"><thead><tr><th>Regola</th><th>Cosa verifica</th></tr></thead><tbody><tr><td><code>scheda-mancante</code></td><td>ogni pipeline del catalogo ha una pagina con <code><PipelineDag name="…" /></code>, ogni sub-pipeline che una di loro istanzia una con <code><SubPipelineDag></code></td></tr><tr><td><code>scopo-mancante</code></td><td>ogni nodo e ogni istanza ha uno scopo, come <code>scopo-dei-nodi</code> di <code>etl catalog check</code></td></tr><tr><td><code>link-rotto</code></td><td>ogni link porta a una pagina pubblicata o a un file di <code>docs/</code>; un link fuori da <code>docs/</code> è rotto, perché non si pubblica</td></tr><tr><td><code>core-non-risolto</code></td><td>un link <code>core:nodes/lookup.md</code> porta a una pagina della guida del core installata</td></tr><tr><td><code>catalogo-del-repo</code></td><td><code>docs/catalogo.md</code> è quella generata: una scritta a mano non si sovrascrive</td></tr></tbody></table><p>Le pipeline pronte sono esenti: la loro scheda sta in questa guida, e nell'indice del catalogo sono una riga col link qui. Un link <code>core:</code> diventa <code>/guida/core/<pagina></code>, la guida del core servita dallo stesso deploy; si valida contro le pagine della guida nel pacchetto installato, quindi se un bump rinomina una pagina il build del cliente fallisce. Il piano si disegna senza l'ambiente del processo, come lo snapshot.</p><h2 id="_8-aggiungere-le-cose-piu-comuni" tabindex="-1">8. Aggiungere le cose più comuni <a class="header-anchor" href="#_8-aggiungere-le-cose-piu-comuni" aria-label="Permalink to "8. Aggiungere le cose più comuni""></a></h2><h3 id="una-nuova-pipeline" tabindex="-1">Una nuova pipeline <a class="header-anchor" href="#una-nuova-pipeline" aria-label="Permalink to "Una nuova pipeline""></a></h3><p>Una cartella <code>src/pipelines/<nome>/</code> con: <code>schema.ts</code> (contratti Zod input/output), <code>pipeline.ts</code> (il grafo con <code>graph()...build()</code>, sorgenti e sink <strong>iniettati</strong>, non scritti dentro), <code>changelog.ts</code> (le versioni di pipeline, una nuova parte dalla v1), <code>run.ts</code> (il collegamento dei connettori concreti e la lettura dell'ambiente), <code>pipeline.test.ts</code> (end-to-end con <code>arraySource</code>/<code>arraySink</code>: record validi caricati, invalidi al dead-letter, metriche corrette). Se legge variabili d'ambiente, il suo <code>run.ts</code> dichiara anche <code>environment(env)</code> con <code>ambienteDellaPipeline</code>, dagli stessi manifest e istanze della run, così <code>etl env check</code> le vede tutte. Le sue variabili obbligatorie vanno in <code>.env.example</code>, che è anche l'ambiente di prova di <code>etl catalog check</code>. Poi si aggiunge al catalogo in <code>etl.config.ts</code>, se ne scrive lo snapshot del piano con <code>pnpm etl versions snapshot <nome></code> (<code>versions/v1.plan.json</code>) e si crea la scheda <code>docs/pipelines/<nome>.md</code> (vedi <a href="./pipelines/README">Le schede di una pipeline</a>).</p><h3 id="una-nuova-sub-pipeline" tabindex="-1">Una nuova sub-pipeline <a class="header-anchor" href="#una-nuova-sub-pipeline" aria-label="Permalink to "Una nuova sub-pipeline""></a></h3><p>Un pezzo di grafo riusato da più pipeline, o più volte nella stessa, è una sub-pipeline: <code>src/sub-pipelines/<nome>/</code> con <code>schema.ts</code> (contratti d'ingresso e d'uscita, e lo <code>z.object</code> dei parametri se ne ha), <code>sub-pipeline.ts</code> (<code>subPipeline({ … })</code>, con <code>params</code> per i dati che ogni istanza fissa e <code>deps</code> per i connettori che riceve dalla root) e <code>sub-pipeline.test.ts</code> (con <code>runSubPipeline</code>, <code>recordIds</code> acceso e spento). Un parametro compare in chiaro nel piano: le credenziali arrivano solo dentro una dipendenza. Lo scopo dei nodi del corpo si scrive nella definizione, quello dell'istanza al punto di chiamata (<a href="./nodes/pipeline#scopo">Scopo</a>). Non si dichiara nel catalogo: arriva insieme alla prima root che la istanzia con <code>.pipeline()</code>. Scheda in <code>docs/sub-pipelines/<nome>.md</code> (vedi <a href="./sub-pipelines/README">Le schede di una sub-pipeline</a>).</p><h3 id="un-connettore-del-cliente" tabindex="-1">Un connettore del cliente <a class="header-anchor" href="#un-connettore-del-cliente" aria-label="Permalink to "Un connettore del cliente""></a></h3><p>Un sistema che conosce solo il cliente (il suo gestionale, la sua API) è un connettore del repo cliente, in <code>src/connectors/</code>: implementa <code>Source<T></code>, <code>Sink<T></code> o l'interfaccia di un <code>lookup</code> o di un'<code>action</code>, con gli strumenti di <code>@noeva/etl-core/connector-kit</code>, e ha la sua scheda in <code>docs/connectors/</code>. Un connettore che serve a più clienti va nel core.</p><h3 id="una-nuova-trasformazione" tabindex="-1">Una nuova trasformazione <a class="header-anchor" href="#una-nuova-trasformazione" aria-label="Permalink to "Una nuova trasformazione""></a></h3><p>Funzione pura, senza side-effect verso sistemi esterni (quelli stanno solo nei nodi che li dichiarano), così è testabile in isolamento. Prima di scriverne una, guarda le <a href="./nodes/transform#transform-pronte">transform pronte</a>. Se è stateful (come <code>groupBy</code>), va usata in fail-fast: niente dead-letter sul suo nodo (vedi §5).</p><h2 id="_9-cosa-non-fare-vincoli-non-negoziabili" tabindex="-1">9. Cosa NON fare (vincoli non negoziabili) <a class="header-anchor" href="#_9-cosa-non-fare-vincoli-non-negoziabili" aria-label="Permalink to "9. Cosa NON fare (vincoli non negoziabili)""></a></h2><ul><li><strong>Niente import dai percorsi interni del core</strong> — solo il pacchetto e i suoi subpath (§3).</li><li><strong>Niente <code>any</code></strong> — dati esterni entrano come <code>unknown</code>, si restringono con Zod.</li><li><strong>Niente IO dentro una <code>Transform</code></strong> — per una lettura c'è il nodo <code>lookup</code>, per una scrittura il nodo <code>action</code>, per un'operazione senza record il nodo <code>task</code>.</li><li><strong>Niente scarti silenziosi</strong> — ogni record invalido ha un percorso esplicito: dead-letter o fail-fast, mai un semplice skip.</li><li><strong>Sink non idempotenti</strong> — un retry/riesecuzione non deve mai duplicare dati (upsert su chiave naturale, MERGE, o write-then-swap, vedi <a href="./runbooks/sql-task-truncate-swap">il runbook</a>).</li><li><strong>Niente segreti</strong> nel codice, nei log o nel report — solo variabili d'ambiente, documentate in <code>.env.example</code>.</li><li><strong>Codice senza test o senza scheda aggiornata non è "finito"</strong> — codice e documentazione cambiano nello stesso commit, e <code>etl docs build</code> lo verifica.</li></ul><h2 id="_10-il-kit-dell-agente" tabindex="-1">10. Il kit dell'agente <a class="header-anchor" href="#_10-il-kit-dell-agente" aria-label="Permalink to "10. Il kit dell'agente""></a></h2><p>Il repo cliente porta il kit con cui Claude Code, o un altro agente, lavora secondo le regole del core: la skill <code>etl-graph</code> (come si costruisce, si cabla e si configura un grafo sull'API pubblica), le skill di scaffolding e di review (<code>/new-pipeline</code>, <code>/new-connector</code>, <code>/new-transform</code>, <code>/etl-review</code>, <code>/doc-sync</code>) e i subagent che materializzano e rivedono una pipeline, più l'hook che blocca commit e push su <code>dev</code>, <code>staging</code> e <code>main</code>. I file del kit sono del core e arrivano con la sua versione: <code>etl init</code> li scrive alla nascita del repo, e <code>pnpm exec etl agent sync</code> li riscrive dal core installato in <code>.claude/skills/noeva-etl-*</code>, <code>.claude/agents/noeva-etl-*</code> e <code>.claude/hooks/noeva-etl-*</code>, insieme alla voce dell'hook in <code>.claude/settings.json</code> e al blocco gestito di <code>AGENTS.md</code>. Toglie anche le voci <code>noeva-etl-*</code> che il kit non ha più, e salta quelle in <code>unmanaged</code>. I file si committano: li vedono anche gli agenti che non sono Claude, e un bump del core mostra il diff del kit. Il resto di <code>.claude/</code> e di <code>AGENTS.md</code> è del cliente. Il kit rimanda a questa guida invece di ricopiarla. Il catalogo completo è in <a href="./guide/claude-code/strumenti">Skill e subagent</a>.</p>`,82)])])}const u=o(n,[["render",t]]);export{g as __pageData,u as default};
|
|
54
|
+
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> worker</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # solo il daemon su processes</span></span></code></pre></div><p><strong><code>etl ci</code></strong> è il gate del repo, lo stesso in locale e nella CI. Esegue, in quest'ordine, <code>tsc --noEmit</code>, ESLint (<code>lint</code>), Prettier in <code>--check</code> (<code>format</code>), vitest con <code>--passWithNoTests</code> (<code>test</code>), <code>etl versions check</code>, <code>etl catalog check</code> ed <code>etl docs build</code>. Su stderr ogni fase si annuncia con <code>▶ <fase></code>, e la prima che fallisce ferma il gate: <code>etl ci: la fase «<fase>» è fallita</code>, con l'exit code della fase. Gli strumenti sono quelli installati nel repo, o in mancanza quelli fra le dipendenze del core; i comandi <code>etl</code> girano in processo sul catalogo già caricato. Un catalogo vuoto passa, con l'avviso del caricamento, e un repo appena creato senza test pure; senza <code>origin/dev</code>, prima del primo push, il gate delle versioni dà l'avviso «nessuna base» e controlla solo gli snapshot (vedi <a href="./conventions/versioni-di-pipeline">Versioni di pipeline</a>). Quali fasi girano arriva con il bump del core, mentre <code>ci.yml</code> resta fermo. Prima delle fasi <code>etl ci</code> guarda l'ultima versione del core sul registry: un core non aggiornato è un avviso (<code>Avviso: il core installato è …</code>) e mai un errore, così un commit vecchio non diventa rosso perché è uscita una release; anche un registry che non risponde è solo un avviso.</p><p><strong><code>etl upgrade --check</code></strong> è in sola lettura, e il blocco di <code>AGENTS.md</code> lo chiede prima di ogni nuovo sviluppo. Su stdout dà la versione del core installata e l'ultima sul registry, le sezioni del <code>CHANGELOG.md</code> del core fra le due, lette dal tarball della versione nuova senza installarla, con le major (<code>[MAJOR]</code>) e le voci «Cambia il piano» (<code>[CAMBIA IL PIANO]</code>) in evidenza in testa, e la deriva dei file gestiti: <code>modificato</code> (diverso dal template del core installato), <code>mancante</code> o <code>in più</code> (un file sotto <code>noeva-etl-*</code> che il kit non porta), con <code>saltato</code> per quelli in <code>unmanaged</code>. Per <code>AGENTS.md</code> e <code>.claude/settings.json</code> conta solo la parte gestita, il blocco e la voce dell'hook. Chi ha installato una versione rilasciata segue il dist-tag <code>latest</code>; chi ha una prerelease <code>next</code> segue la più recente fra <code>latest</code> e <code>next</code>. Il registry è npmjs, o quello di <code>npm_config_registry</code>. Esce con <code>0</code>, o con <code>1</code> se il registry non risponde.</p><p><strong><code>etl upgrade</code></strong> fa il bump. Si ferma con exit <code>1</code> su un file gestito <code>modificato</code> o <code>in più</code>, che l'aggiornamento sovrascriverebbe, e lo nomina; procede con <code>--force</code>, e le modifiche si perdono. Un file in <code>unmanaged</code> non lo ferma e non si riscrive. Poi stampa il changelog, porta <code>@noeva/etl-core</code> all'ultima nel <code>package.json</code>, col prefisso che il range aveva (<code>^</code>, <code>~</code> o un pin esatto), e la toolchain delle <code>devDependencies</code> ai range del core nuovo, lancia <code>pnpm install</code> e infine la CLI del core appena installato (<code>pnpm exec etl upgrade --sync --force</code>), che risincronizza i file gestiti col suo template: i due YAML, <code>ecosystem.config.cjs</code> e il kit come <code>etl agent sync</code>. Se il changelog dice «Cambia il piano» suggerisce <code>pnpm exec etl versions snapshot --realign --ticket <chiave></code>. Con il core già all'ultima versione risincronizza soltanto i file gestiti; <code>etl upgrade --sync</code> fa lo stesso senza andare sul registry, per esempio dopo un bump fatto a mano con pnpm, e si ferma come l'upgrade su un file toccato a mano, salvo <code>--force</code>. Package.json, lockfile e file gestiti si committano insieme, in una PR del bump. Un core dichiarato con <code>file:</code>, <code>link:</code> o <code>workspace:</code> si aggiorna a mano.</p><p><strong><code>etl env check</code></strong> verifica l'ambiente sull'intero catalogo: su stdout una riga per variabile obbligatoria mancante, <code><VARIABILE>\\t<provenienze></code>, dove la provenienza è <code>core</code>, <code>pipeline <nome></code> o <code>istanza <connettore> <id> (<pipeline che la usano>)</code>; su stderr un avviso per ogni chiave del <code>.env</code> che nessuno dichiara (solo il nome, mai il valore) e il riepilogo. Esce con <code>1</code> se manca un'obbligatoria, <code>0</code> altrimenti, anche con sconosciute. Le variabili del core sono in <a href="./conventions/variabili-del-core">Variabili d'ambiente del core</a>; quelle di una pipeline le dà il suo <code>environment(env)</code>, scritto con <code>ambienteDellaPipeline</code> di <code>./connector-kit</code> dagli stessi manifest della run (vedi <a href="./pipelines/test-posta"><code>test-posta</code></a>). Senza, il check ricade sul piano, che non mostra tutte le variabili di un'istanza (l'utente di un DB, l'identità OAuth2), e quelle variabili, se stanno nel <code>.env</code>, compaiono fra le sconosciute. Legge l'ambiente del processo, con il <code>.env</code> alla radice del repo che la CLI carica da sola prima di ogni comando (le variabili già nel processo vincono). Resta fuori dalla CI: serve l'ambiente vero.</p><p><strong><code>etl catalog check</code></strong> è la conformità del catalogo: gli stessi controlli in ogni repo, che arrivano aggiornati con il bump del core. Su stdout una riga per violazione, <code><regola>\\t<pipeline>: <dettaglio></code>; su stderr il riepilogo e gli avvisi del caricamento. Esce con <code>0</code> se il catalogo è conforme (anche vuoto, con l'avviso), <code>1</code> con almeno una violazione, <code>2</code> per un errore d'uso o di configurazione. Le regole:</p><table tabindex="0"><thead><tr><th>Regola</th><th>Cosa verifica</th></tr></thead><tbody><tr><td><code>changelog</code></td><td>numeri da 1 senza buchi, date <code>AAAA-MM-GG</code> in ordine, ticket, voci non vuote</td></tr><tr><td><code>piano-senza-credenziali</code></td><td><code>getSpec()</code> senza <code>.env</code> non lancia, il piano ha il nome della pipeline, almeno una source e un sink, si serializza in JSON e i nodi stanno nella proiezione</td></tr><tr><td><code>scopo-dei-nodi</code></td><td>ogni nodo e ogni istanza ha uno scopo; esenti il collettore dei dead-letter e i nodi di confine di un'istanza, che genera il core</td></tr><tr><td><code>piano-senza-segreti</code></td><td>con l'ambiente di <code>.env.example</code> e un valore riconoscibile al posto di ogni segreto il piano si disegna dalla configurazione risolta e non contiene segreti; poi lo stesso con le credenziali alternative</td></tr><tr><td><code>cartella-orfana</code></td><td>ogni <code>run.ts</code> sotto <code>src/pipelines/</code> esporta una pipeline del catalogo: una pipeline tolta da <code>etl.config.ts</code> non resta senza controlli</td></tr></tbody></table><p>L'ambiente di prova di <code>piano-senza-segreti</code> è il <code>.env.example</code> alla radice del config, più le variabili segrete che le pipeline dichiarano con <code>environment(env)</code>. È segreta una variabile il cui nome contiene <code>PASSWORD</code>, <code>SECRET</code>, <code>TOKEN</code>, <code>API_KEY</code>, <code>ACCESS_KEY</code> o <code>PRIVATE_KEY</code>. Le credenziali commentate (<code># IMAP_ACCESS_TOKEN=</code>) sono alternative: il secondo passaggio le attiva e toglie quella attiva con lo stesso prefisso (<code>IMAP_PASSWORD</code>). Per questo <code>.env.example</code> deve essere completo: una pipeline che con quelle variabili si disegna dall'esempio (un valore con la parola «esempio» nel piano) è una violazione, perché il controllo sui segreti guarderebbe solo i segnaposto.</p><p><strong><code>etl versions</code></strong> tiene le versioni di pipeline: ogni cambio di piano è una versione nuova, con la sua voce nel changelog e lo snapshot del piano. Il gate, il rollback di una pipeline sola e il riallineamento al core sono in <a href="./conventions/versioni-di-pipeline">Versioni di pipeline</a> e nel <a href="./runbooks/rollback-di-pipeline">runbook del rollback</a>.</p><p><strong><code>etl docs build</code></strong> costruisce la documentazione del cliente, con configurazione, tema e componenti dei grafi dal pacchetto: in un repo cliente <code>docs/</code> è solo markdown. Il sito va in <code>docs/.vitepress/dist</code> (<code>--outDir</code> per un'altra cartella), col nome del cliente nel titolo, e comprende tutto <code>docs/</code>, ADR compresi, più una pagina indice del catalogo, <code>docs/catalogo.md</code>, che il build genera e che non si versiona. <strong><code>etl docs dev</code></strong> serve lo stesso sito in sviluppo (<code>--port <n></code>). Il sito costruito lo serve <code>etl serve</code> su <code>/guida/</code>, accanto alla guida del core su <code>/guida/core/</code> (<a href="./runbooks/graph-server">runbook del server</a>). Prima di costruire il comando controlla la documentazione, e con un problema si ferma: una riga per problema su stdout, <code><regola>\\t<dove>: <dettaglio></code>, ed exit <code>1</code>.</p><table tabindex="0"><thead><tr><th>Regola</th><th>Cosa verifica</th></tr></thead><tbody><tr><td><code>scheda-mancante</code></td><td>ogni pipeline del catalogo ha una pagina con <code><PipelineDag name="…" /></code>, ogni sub-pipeline che una di loro istanzia una con <code><SubPipelineDag></code></td></tr><tr><td><code>scopo-mancante</code></td><td>ogni nodo e ogni istanza ha uno scopo, come <code>scopo-dei-nodi</code> di <code>etl catalog check</code></td></tr><tr><td><code>link-rotto</code></td><td>ogni link porta a una pagina pubblicata o a un file di <code>docs/</code>; un link fuori da <code>docs/</code> è rotto, perché non si pubblica</td></tr><tr><td><code>core-non-risolto</code></td><td>un link <code>core:nodes/lookup.md</code> porta a una pagina della guida del core installata</td></tr><tr><td><code>catalogo-del-repo</code></td><td><code>docs/catalogo.md</code> è quella generata: una scritta a mano non si sovrascrive</td></tr></tbody></table><p>Le pipeline pronte sono esenti: la loro scheda sta in questa guida, e nell'indice del catalogo sono una riga col link qui. Un link <code>core:</code> diventa <code>/guida/core/<pagina></code>, la guida del core servita dallo stesso deploy; si valida contro le pagine della guida nel pacchetto installato, quindi se un bump rinomina una pagina il build del cliente fallisce. Il piano si disegna senza l'ambiente del processo, come lo snapshot.</p><h2 id="_8-aggiungere-le-cose-piu-comuni" tabindex="-1">8. Aggiungere le cose più comuni <a class="header-anchor" href="#_8-aggiungere-le-cose-piu-comuni" aria-label="Permalink to "8. Aggiungere le cose più comuni""></a></h2><h3 id="una-nuova-pipeline" tabindex="-1">Una nuova pipeline <a class="header-anchor" href="#una-nuova-pipeline" aria-label="Permalink to "Una nuova pipeline""></a></h3><p>Una cartella <code>src/pipelines/<nome>/</code> con: <code>schema.ts</code> (contratti Zod input/output), <code>pipeline.ts</code> (il grafo con <code>graph()...build()</code>, sorgenti e sink <strong>iniettati</strong>, non scritti dentro), <code>changelog.ts</code> (le versioni di pipeline, una nuova parte dalla v1), <code>run.ts</code> (il collegamento dei connettori concreti e la lettura dell'ambiente), <code>pipeline.test.ts</code> (end-to-end con <code>arraySource</code>/<code>arraySink</code>: record validi caricati, invalidi al dead-letter, metriche corrette). Se legge variabili d'ambiente, il suo <code>run.ts</code> dichiara anche <code>environment(env)</code> con <code>ambienteDellaPipeline</code>, dagli stessi manifest e istanze della run, così <code>etl env check</code> le vede tutte. Le sue variabili obbligatorie vanno in <code>.env.example</code>, che è anche l'ambiente di prova di <code>etl catalog check</code>. Poi si aggiunge al catalogo in <code>etl.config.ts</code>, se ne scrive lo snapshot del piano con <code>pnpm etl versions snapshot <nome></code> (<code>versions/v1.plan.json</code>) e si crea la scheda <code>docs/pipelines/<nome>.md</code> (vedi <a href="./pipelines/README">Le schede di una pipeline</a>).</p><h3 id="una-nuova-sub-pipeline" tabindex="-1">Una nuova sub-pipeline <a class="header-anchor" href="#una-nuova-sub-pipeline" aria-label="Permalink to "Una nuova sub-pipeline""></a></h3><p>Un pezzo di grafo riusato da più pipeline, o più volte nella stessa, è una sub-pipeline: <code>src/sub-pipelines/<nome>/</code> con <code>schema.ts</code> (contratti d'ingresso e d'uscita, e lo <code>z.object</code> dei parametri se ne ha), <code>sub-pipeline.ts</code> (<code>subPipeline({ … })</code>, con <code>params</code> per i dati che ogni istanza fissa e <code>deps</code> per i connettori che riceve dalla root) e <code>sub-pipeline.test.ts</code> (con <code>runSubPipeline</code>, <code>recordIds</code> acceso e spento). Un parametro compare in chiaro nel piano: le credenziali arrivano solo dentro una dipendenza. Lo scopo dei nodi del corpo si scrive nella definizione, quello dell'istanza al punto di chiamata (<a href="./nodes/pipeline#scopo">Scopo</a>). Non si dichiara nel catalogo: arriva insieme alla prima root che la istanzia con <code>.pipeline()</code>. Scheda in <code>docs/sub-pipelines/<nome>.md</code> (vedi <a href="./sub-pipelines/README">Le schede di una sub-pipeline</a>).</p><h3 id="un-connettore-del-cliente" tabindex="-1">Un connettore del cliente <a class="header-anchor" href="#un-connettore-del-cliente" aria-label="Permalink to "Un connettore del cliente""></a></h3><p>Un sistema che conosce solo il cliente (il suo gestionale, la sua API) è un connettore del repo cliente, in <code>src/connectors/</code>: implementa <code>Source<T></code>, <code>Sink<T></code> o l'interfaccia di un <code>lookup</code> o di un'<code>action</code>, con gli strumenti di <code>@noeva/etl-core/connector-kit</code>, e ha la sua scheda in <code>docs/connectors/</code>. Un connettore che serve a più clienti va nel core.</p><h3 id="una-nuova-trasformazione" tabindex="-1">Una nuova trasformazione <a class="header-anchor" href="#una-nuova-trasformazione" aria-label="Permalink to "Una nuova trasformazione""></a></h3><p>Funzione pura, senza side-effect verso sistemi esterni (quelli stanno solo nei nodi che li dichiarano), così è testabile in isolamento. Prima di scriverne una, guarda le <a href="./nodes/transform#transform-pronte">transform pronte</a>. Se è stateful (come <code>groupBy</code>), va usata in fail-fast: niente dead-letter sul suo nodo (vedi §5).</p><h2 id="_9-cosa-non-fare-vincoli-non-negoziabili" tabindex="-1">9. Cosa NON fare (vincoli non negoziabili) <a class="header-anchor" href="#_9-cosa-non-fare-vincoli-non-negoziabili" aria-label="Permalink to "9. Cosa NON fare (vincoli non negoziabili)""></a></h2><ul><li><strong>Niente import dai percorsi interni del core</strong> — solo il pacchetto e i suoi subpath (§3).</li><li><strong>Niente <code>any</code></strong> — dati esterni entrano come <code>unknown</code>, si restringono con Zod.</li><li><strong>Niente IO dentro una <code>Transform</code></strong> — per una lettura c'è il nodo <code>lookup</code>, per una scrittura il nodo <code>action</code>, per un'operazione senza record il nodo <code>task</code>.</li><li><strong>Niente scarti silenziosi</strong> — ogni record invalido ha un percorso esplicito: dead-letter o fail-fast, mai un semplice skip.</li><li><strong>Sink non idempotenti</strong> — un retry/riesecuzione non deve mai duplicare dati (upsert su chiave naturale, MERGE, o write-then-swap, vedi <a href="./runbooks/sql-task-truncate-swap">il runbook</a>).</li><li><strong>Niente segreti</strong> nel codice, nei log o nel report — solo variabili d'ambiente, documentate in <code>.env.example</code>.</li><li><strong>Codice senza test o senza scheda aggiornata non è "finito"</strong> — codice e documentazione cambiano nello stesso commit, e <code>etl docs build</code> lo verifica.</li></ul><h2 id="_10-il-kit-dell-agente" tabindex="-1">10. Il kit dell'agente <a class="header-anchor" href="#_10-il-kit-dell-agente" aria-label="Permalink to "10. Il kit dell'agente""></a></h2><p>Il repo cliente porta il kit con cui Claude Code, o un altro agente, lavora secondo le regole del core: la skill <code>etl-graph</code> (come si costruisce, si cabla e si configura un grafo sull'API pubblica), le skill di scaffolding e di review (<code>/new-pipeline</code>, <code>/new-connector</code>, <code>/new-transform</code>, <code>/etl-review</code>, <code>/doc-sync</code>) e i subagent che materializzano e rivedono una pipeline, più l'hook che blocca commit e push su <code>dev</code>, <code>staging</code> e <code>main</code>. I file del kit sono del core e arrivano con la sua versione: <code>etl init</code> li scrive alla nascita del repo, e <code>pnpm exec etl agent sync</code> li riscrive dal core installato in <code>.claude/skills/noeva-etl-*</code>, <code>.claude/agents/noeva-etl-*</code> e <code>.claude/hooks/noeva-etl-*</code>, insieme alla voce dell'hook in <code>.claude/settings.json</code> e al blocco gestito di <code>AGENTS.md</code>. Toglie anche le voci <code>noeva-etl-*</code> che il kit non ha più, e salta quelle in <code>unmanaged</code>. I file si committano: li vedono anche gli agenti che non sono Claude, e un bump del core mostra il diff del kit. Il resto di <code>.claude/</code> e di <code>AGENTS.md</code> è del cliente. Il kit rimanda a questa guida invece di ricopiarla. Il catalogo completo è in <a href="./guide/claude-code/strumenti">Skill e subagent</a>.</p>`,84)])])}const u=o(n,[["render",t]]);export{g as __pageData,u as default};
|
package/dist/guida/assets/{GUIDA_SVILUPPO.md.B_lGYssk.lean.js → GUIDA_SVILUPPO.md.Dj20s7gS.lean.js}
RENAMED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{_ as o,o as i,c as a,a5 as s}from"./chunks/framework.qdetmeNX.js";const g=JSON.parse('{"title":"Guida allo sviluppo","description":"","frontmatter":{},"headers":[],"relativePath":"GUIDA_SVILUPPO.md","filePath":"GUIDA_SVILUPPO.md"}'),n={name:"GUIDA_SVILUPPO.md"};function t(d,e,c,l,r,p){return i(),a("div",null,[...e[0]||(e[0]=[s("",
|
|
1
|
+
import{_ as o,o as i,c as a,a5 as s}from"./chunks/framework.qdetmeNX.js";const g=JSON.parse('{"title":"Guida allo sviluppo","description":"","frontmatter":{},"headers":[],"relativePath":"GUIDA_SVILUPPO.md","filePath":"GUIDA_SVILUPPO.md"}'),n={name:"GUIDA_SVILUPPO.md"};function t(d,e,c,l,r,p){return i(),a("div",null,[...e[0]||(e[0]=[s("",84)])])}const u=o(n,[["render",t]]);export{g as __pageData,u as default};
|
package/dist/guida/assets/{TECHNICAL_OVERVIEW.md.C9V6rGhh.js → TECHNICAL_OVERVIEW.md.DQP0pWc8.js}
RENAMED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{_ as t,C as r,o as n,c as a,a5 as o,E as s}from"./chunks/framework.qdetmeNX.js";const v=JSON.parse('{"title":"noeva-etl — Technical Overview","description":"","frontmatter":{},"headers":[],"relativePath":"TECHNICAL_OVERVIEW.md","filePath":"TECHNICAL_OVERVIEW.md"}'),c={name:"TECHNICAL_OVERVIEW.md"};function d(l,e,p,u,g,h){const i=r("MermaidDiagram");return n(),a("div",null,[e[0]||(e[0]=o('<h1 id="noeva-etl-—-technical-overview" tabindex="-1">noeva-etl — Technical Overview <a class="header-anchor" href="#noeva-etl-—-technical-overview" aria-label="Permalink to "noeva-etl — Technical Overview""></a></h1><blockquote><p>Documento condivisibile. Spiega <strong>cos'è</strong>, <strong>per cosa è pensato</strong>, <strong>cosa può fare</strong>, <strong>come si espande</strong> e <strong>qual è la direzione</strong> del prodotto.</p></blockquote><hr><h2 id="_1-in-una-frase" tabindex="-1">1. In una frase <a class="header-anchor" href="#_1-in-una-frase" aria-label="Permalink to "1. In una frase""></a></h2><p><strong>noeva-etl</strong> è una <strong>piattaforma BI/ETL code-first in TypeScript</strong>: si costruiscono pipeline di integrazione dati (estrazione → trasformazione → caricamento) come <strong>software versionato, testato e documentato</strong>, non come job grafici opachi. Il nucleo di esecuzione di ogni pipeline è <strong>semplice, stateless e portabile</strong>: esegue una pipeline e restituisce un risultato completo (report di run), senza possedere database né stato proprio.</p><p>Il servizio si invoca in tre modi (vedi §5): <strong>batch</strong> (<code>etl run</code>, un container = una esecuzione, esito su stdout), <strong>daemon</strong> (<code>etl worker</code>, poller sulla tabella <code>processes</code> di Noeva, per l'integrazione con l'orchestrazione job del prodotto) e <strong>server + daemon</strong> (<code>etl serve</code>, il default dell'immagine: espone i grafi e le run all'app desktop <code>noeva-etl-ui</code> e avvia i worker nello stesso processo).</p><h2 id="_2-per-cosa-e-stato-pensato" tabindex="-1">2. Per cosa è stato pensato <a class="header-anchor" href="#_2-per-cosa-e-stato-pensato" aria-label="Permalink to "2. Per cosa è stato pensato""></a></h2><p>Sostituire l'approccio "ETL a scatola nera" (es. Talend) con uno <strong>code-first</strong>:</p><ul><li><strong>Versionabile</strong> — ogni pipeline è codice in git, rivedibile in Pull Request.</li><li><strong>Testabile</strong> — connettori, trasformazioni e pipeline hanno test automatici (gate in CI).</li><li><strong>Documentato</strong> — ogni pipeline/decisione ha la sua scheda/ADR, aggiornati nello stesso commit.</li><li><strong>Portabile</strong> — un'unica immagine container gira sull'infra del cliente (Docker locale, ECS proprio o gestito da noi).</li><li><strong>Agnostico</strong> — nessun lock-in: sorgenti e destinazioni sono intercambiabili; il servizio non impone un DB o un cloud.</li></ul><p>Target d'uso: integrazioni dati ricorrenti e affidabili (sincronizzazioni, fatti per la BI, normalizzazioni cross-database) dove <strong>correttezza, ripetibilità e tracciabilità</strong> contano.</p><h2 id="_3-cosa-puo-fare-oggi" tabindex="-1">3. Cosa può fare oggi <a class="header-anchor" href="#_3-cosa-puo-fare-oggi" aria-label="Permalink to "3. Cosa può fare oggi""></a></h2><table tabindex="0"><thead><tr><th>Capacità</th><th>Dettaglio</th></tr></thead><tbody><tr><td><strong>Primitive componibili</strong></td><td><code>Source<T></code> (estrazione), <code>Transform<I,O></code> (trasformazione), <code>Sink<T></code> (caricamento), <code>GraphPipeline</code> (DSL a grafo <code>graph()...build()</code>)</td></tr><tr><td><strong>Nodi del grafo</strong></td><td><code>source</code>, <code>transform</code>, <strong><code>lookup</code></strong> (lettura a metà grafo da un DB o da un'API REST), <strong><code>ai</code></strong> (domanda a un modello per record), <strong><code>action</code></strong> (scrittura per record con un record in uscita), <strong><code>route</code></strong> (smistamento esclusivo su porte), <code>join</code> (fan-in a chiave), <strong><code>union</code></strong> (fan-in di flussi con la stessa forma), <code>try-catch</code> (ramo di gestione errori), <code>sink</code>, <strong><code>task</code></strong> (operazione senza record, prima o dopo il caricamento, ordinata dagli edge di controllo <code>after</code>)</td></tr><tr><td><strong>Streaming</strong></td><td>I connettori lavorano su <code>AsyncIterable</code>: dataset grandi senza caricarli in memoria</td></tr><tr><td><strong>Contratti dati (Zod)</strong></td><td>Validazione di schema su input e output di ogni pipeline (<code>validate</code>)</td></tr><tr><td><strong>Trasformazioni</strong></td><td><code>map</code>, <code>filter</code>, mappatura dichiarativa di colonne <code>mapColumns</code> (select, rename, cast, colonne calcolate, con lineage di colonna), espansione 1:N (<code>flatMapTransform</code>, <code>explode</code>), aggregazione stateful riusabile <code>groupBy</code> (init/reduce/finalize), deduplica <code>dedup</code>, passaggio fra formato largo e lungo <code>unpivot</code>/<code>pivot</code>, ordinamento stabile <code>sort</code>, lotti di dimensione fissa <code>chunk</code>, decodifica e codifica di file in mezzo al grafo <code>parse</code>/<code>serialize</code>, hash di riga <code>hashRow</code> e chiave surrogata <code>surrogateKey</code>, mascheramento e pseudonimizzazione dei dati personali <code>mask</code>, profilo delle colonne nel report del nodo <code>profile</code>, controlli sul dataset <code>assert</code></td></tr><tr><td><strong>Gestione errori</strong></td><td><strong>dead-letter</strong> per nodo (record invalidi instradati altrove, la run prosegue), ramo <strong>catch</strong> di un nodo <code>try-catch</code>, o <strong>fail-fast</strong> esplicito, che al primo errore fatale annulla anche i rami indipendenti — mai scarti silenziosi</td></tr><tr><td><strong>Idempotenza</strong></td><td>Sink con upsert/MERGE su chiave naturale: rieseguire non duplica</td></tr><tr><td><strong>Connettori reali</strong></td><td><strong>PostgreSQL</strong> (cursor streaming + upsert <code>ON CONFLICT</code> o SCD2 + lookup + task SQL), <strong>SQL Server</strong> (streaming + <code>MERGE</code> o SCD2 + lookup + task SQL), <strong>file</strong> (filesystem/S3/SFTP/FTP × CSV/JSON/XML/XLSX/Parquet), <strong>Noeva</strong> (file e cartelle dei workspace + upload con elaborazione AI come <code>action</code> + lookup su stato e testo estratto), <strong>HTTP</strong> (lookup e action su API REST, <code>httpLookup</code> e <code>httpAction</code>), <strong>Jira Cloud</strong> (<code>jiraIssues</code>: le issue di una JQL su API REST v3, in colonne normalizzate, e <code>jiraIssueLookup</code> per chiave; changelog, commenti e worklog completi come lista; <code>jiraCreateIssue</code>, <code>jiraUpdateIssue</code>, <code>jiraTransition</code>, <code>jiraUpsertIssue</code> per ID esterno, <code>jiraAddComment</code> e <code>jiraAddWorklog</code> con chiave di deduplica e <code>jiraLinkIssues</code> come <code>action</code>, testo in markdown), <strong>IMAP</strong>, <strong>SMTP</strong> e <strong>SendGrid</strong> (posta in lettura e invio, con OAuth2 dove la casella lo richiede), <strong>processo esterno</strong> (<code>processoEsternoAction</code>: un programma lanciato per record in un nodo <code>action</code>, senza shell)</td></tr><tr><td><strong>Cross-database</strong></td><td>Una pipeline può leggere da un DB e scrivere su un altro (es. PG → SQL Server)</td></tr><tr><td><strong>GraphRunReport</strong></td><td>Risultato auto-descrittivo di ogni run (vedi §6)</td></tr><tr><td><strong>CLI & container</strong></td><td><code>etl list</code> / <code>etl run <pipeline></code> / <code>etl serve</code> / <code>etl runs list</code> / <code>etl state show</code> / <code>etl versions snapshot</code> (anche <code>--realign</code>) / <code>etl versions check</code> / <code>etl versions rollback</code> / <code>etl env check</code> / <code>etl catalog check</code> / <code>etl docs build</code> / <code>etl ci</code> / <code>etl init</code> / <code>etl agent sync</code>; immagine Docker</td></tr><tr><td><strong>App desktop</strong></td><td><code>noeva-etl-ui</code> (Tauri): DAG delle pipeline, avvio manuale, storico ed esito delle run, nodo per nodo — mostra, non costruisce</td></tr><tr><td><strong>Worker daemon</strong></td><td><code>etl worker</code> — poller su <code>processes</code> via <code>noeva-server-api</code> (claim/progress HTTP, mai Supabase diretto), dispatch verso il catalogo di <code>etl.config.ts</code>; una istanza serve N workspace</td></tr></tbody></table><p><strong>Esempi inclusi</strong>: le pipeline della sezione «Esempi» di questa guida, come <a href="./pipelines/orders-enriched-daily"><code>orders-enriched-daily</code></a> (join a chiave, fan-out, try/catch) e <a href="./pipelines/crm-leads-sync"><code>crm-leads-sync</code></a> (copia fra due istanze Postgres).</p><h2 id="_4-come-funziona-architettura" tabindex="-1">4. Come funziona (architettura) <a class="header-anchor" href="#_4-come-funziona-architettura" aria-label="Permalink to "4. Come funziona (architettura)""></a></h2><p>Ogni pipeline è un <strong>grafo</strong> di nodi (DAG), costruito in codice col DSL <code>graph()…build()</code>:</p>',15)),s(i,{code:"flowchart%20LR%0A%20%20ordini%5B%22source%3Cbr%2F%3Eordini%22%5D%20--%3E%20valida%5B%22transform%3Cbr%2F%3Evalidate%20(contratto)%22%5D%0A%20%20clienti%5B%22source%3Cbr%2F%3Eclienti%22%5D%20--%3E%20join%5B%22join%3Cbr%2F%3E(a%20chiave)%22%5D%0A%20%20valida%20-.record%20invalido.-%3E%20scarti%5B%22dead-letter%22%5D%0A%20%20valida%20--%3E%20join%0A%20%20join%20--%3E%20lookup%5B%22lookup%3Cbr%2F%3E(lettura%20DB%20o%20API)%22%5D%0A%20%20lookup%20--%3E%20guard%5B%22try-catch%22%5D%0A%20%20guard%20--%3E%20dwh%5B%22sink%3Cbr%2F%3EDWH%22%5D%0A%20%20guard%20--%3E%20file%5B%22sink%3Cbr%2F%3Efile%22%5D%0A%20%20guard%20-.catch.-%3E%20errori%5B%22ramo%20errori%22%5D%0A"}),e[1]||(e[1]=o(`<ul><li><strong>Core</strong> (<code>src/core</code>) — primitive + runner; <strong>non contiene logica di dominio</strong>.</li><li><strong>Dependency Injection</strong> — la <em>definizione</em> della pipeline è agnostica: sorgente e sink concreti si iniettano all'avvio. Per questo lo stesso codice gira su DB diversi e si testa con connettori in-memory.</li><li><strong>Streaming pull-based</strong> — i record scorrono dai source ai sink senza essere caricati tutti in memoria; è il ritmo di scrittura a regolare quello di lettura.</li><li><strong>Tre percorsi per un record che fallisce</strong>: <em>dead-letter</em> sul nodo (il record va altrove, la run prosegue), ramo <em>catch</em> di un nodo <code>try-catch</code> (gli errori di un intero tratto del grafo finiscono su nodi di gestione dedicati), <em>fail-fast</em> (la run si ferma — obbligatorio per le aggregazioni stateful).</li><li><strong>Osservabilità</strong> — logger JSON strutturato + metriche; ogni run produce un <code>GraphRunReport</code> con i conteggi di ogni nodo.</li></ul><p>Stack: TypeScript ESM strict, Node ≥ 20, <code>pnpm</code>, <code>tsup</code>, <code>vitest</code>, ESLint/Prettier, Zod. Dipendenze runtime: i driver dei database (<code>pg</code>, <code>mssql</code>), le librerie per storage e formati dei file (AWS SDK, SFTP, FTP, CSV, XLSX, XML, Parquet), <code>express</code> per il server locale di <code>etl serve</code>. Nessuna dipendenza Supabase: il claim/report sulla tabella <code>processes</code> passa da <code>noeva-server-api</code> via HTTP (<code>fetch</code> nativo).</p><h2 id="_5-come-si-usa-e-si-distribuisce" tabindex="-1">5. Come si usa e si distribuisce <a class="header-anchor" href="#_5-come-si-usa-e-si-distribuisce" aria-label="Permalink to "5. Come si usa e si distribuisce""></a></h2><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># in un repo cliente, in sviluppo</span></span>
|
|
1
|
+
import{_ as t,C as r,o as n,c as a,a5 as o,E as s}from"./chunks/framework.qdetmeNX.js";const v=JSON.parse('{"title":"noeva-etl — Technical Overview","description":"","frontmatter":{},"headers":[],"relativePath":"TECHNICAL_OVERVIEW.md","filePath":"TECHNICAL_OVERVIEW.md"}'),c={name:"TECHNICAL_OVERVIEW.md"};function d(l,e,p,u,g,h){const i=r("MermaidDiagram");return n(),a("div",null,[e[0]||(e[0]=o('<h1 id="noeva-etl-—-technical-overview" tabindex="-1">noeva-etl — Technical Overview <a class="header-anchor" href="#noeva-etl-—-technical-overview" aria-label="Permalink to "noeva-etl — Technical Overview""></a></h1><blockquote><p>Documento condivisibile. Spiega <strong>cos'è</strong>, <strong>per cosa è pensato</strong>, <strong>cosa può fare</strong>, <strong>come si espande</strong> e <strong>qual è la direzione</strong> del prodotto.</p></blockquote><hr><h2 id="_1-in-una-frase" tabindex="-1">1. In una frase <a class="header-anchor" href="#_1-in-una-frase" aria-label="Permalink to "1. In una frase""></a></h2><p><strong>noeva-etl</strong> è una <strong>piattaforma BI/ETL code-first in TypeScript</strong>: si costruiscono pipeline di integrazione dati (estrazione → trasformazione → caricamento) come <strong>software versionato, testato e documentato</strong>, non come job grafici opachi. Il nucleo di esecuzione di ogni pipeline è <strong>semplice, stateless e portabile</strong>: esegue una pipeline e restituisce un risultato completo (report di run), senza possedere database né stato proprio.</p><p>Il servizio si invoca in tre modi (vedi §5): <strong>batch</strong> (<code>etl run</code>, un container = una esecuzione, esito su stdout), <strong>daemon</strong> (<code>etl worker</code>, poller sulla tabella <code>processes</code> di Noeva, per l'integrazione con l'orchestrazione job del prodotto) e <strong>server + daemon</strong> (<code>etl serve</code>, il default dell'immagine: espone i grafi e le run all'app desktop <code>noeva-etl-ui</code> e avvia i worker nello stesso processo).</p><h2 id="_2-per-cosa-e-stato-pensato" tabindex="-1">2. Per cosa è stato pensato <a class="header-anchor" href="#_2-per-cosa-e-stato-pensato" aria-label="Permalink to "2. Per cosa è stato pensato""></a></h2><p>Sostituire l'approccio "ETL a scatola nera" (es. Talend) con uno <strong>code-first</strong>:</p><ul><li><strong>Versionabile</strong> — ogni pipeline è codice in git, rivedibile in Pull Request.</li><li><strong>Testabile</strong> — connettori, trasformazioni e pipeline hanno test automatici (gate in CI).</li><li><strong>Documentato</strong> — ogni pipeline/decisione ha la sua scheda/ADR, aggiornati nello stesso commit.</li><li><strong>Portabile</strong> — un'unica immagine container gira sull'infra del cliente (Docker locale, ECS proprio o gestito da noi).</li><li><strong>Agnostico</strong> — nessun lock-in: sorgenti e destinazioni sono intercambiabili; il servizio non impone un DB o un cloud.</li></ul><p>Target d'uso: integrazioni dati ricorrenti e affidabili (sincronizzazioni, fatti per la BI, normalizzazioni cross-database) dove <strong>correttezza, ripetibilità e tracciabilità</strong> contano.</p><h2 id="_3-cosa-puo-fare-oggi" tabindex="-1">3. Cosa può fare oggi <a class="header-anchor" href="#_3-cosa-puo-fare-oggi" aria-label="Permalink to "3. Cosa può fare oggi""></a></h2><table tabindex="0"><thead><tr><th>Capacità</th><th>Dettaglio</th></tr></thead><tbody><tr><td><strong>Primitive componibili</strong></td><td><code>Source<T></code> (estrazione), <code>Transform<I,O></code> (trasformazione), <code>Sink<T></code> (caricamento), <code>GraphPipeline</code> (DSL a grafo <code>graph()...build()</code>)</td></tr><tr><td><strong>Nodi del grafo</strong></td><td><code>source</code>, <code>transform</code>, <strong><code>lookup</code></strong> (lettura a metà grafo da un DB o da un'API REST), <strong><code>ai</code></strong> (domanda a un modello per record), <strong><code>action</code></strong> (scrittura per record con un record in uscita), <strong><code>route</code></strong> (smistamento esclusivo su porte), <code>join</code> (fan-in a chiave), <strong><code>union</code></strong> (fan-in di flussi con la stessa forma), <code>try-catch</code> (ramo di gestione errori), <code>sink</code>, <strong><code>task</code></strong> (operazione senza record, prima o dopo il caricamento, ordinata dagli edge di controllo <code>after</code>)</td></tr><tr><td><strong>Streaming</strong></td><td>I connettori lavorano su <code>AsyncIterable</code>: dataset grandi senza caricarli in memoria</td></tr><tr><td><strong>Contratti dati (Zod)</strong></td><td>Validazione di schema su input e output di ogni pipeline (<code>validate</code>)</td></tr><tr><td><strong>Trasformazioni</strong></td><td><code>map</code>, <code>filter</code>, mappatura dichiarativa di colonne <code>mapColumns</code> (select, rename, cast, colonne calcolate, con lineage di colonna), espansione 1:N (<code>flatMapTransform</code>, <code>explode</code>), aggregazione stateful riusabile <code>groupBy</code> (init/reduce/finalize), deduplica <code>dedup</code>, passaggio fra formato largo e lungo <code>unpivot</code>/<code>pivot</code>, ordinamento stabile <code>sort</code>, lotti di dimensione fissa <code>chunk</code>, decodifica e codifica di file in mezzo al grafo <code>parse</code>/<code>serialize</code>, hash di riga <code>hashRow</code> e chiave surrogata <code>surrogateKey</code>, mascheramento e pseudonimizzazione dei dati personali <code>mask</code>, profilo delle colonne nel report del nodo <code>profile</code>, controlli sul dataset <code>assert</code></td></tr><tr><td><strong>Gestione errori</strong></td><td><strong>dead-letter</strong> per nodo (record invalidi instradati altrove, la run prosegue), ramo <strong>catch</strong> di un nodo <code>try-catch</code>, o <strong>fail-fast</strong> esplicito, che al primo errore fatale annulla anche i rami indipendenti — mai scarti silenziosi</td></tr><tr><td><strong>Idempotenza</strong></td><td>Sink con upsert/MERGE su chiave naturale: rieseguire non duplica</td></tr><tr><td><strong>Connettori reali</strong></td><td><strong>PostgreSQL</strong> (cursor streaming + upsert <code>ON CONFLICT</code> o SCD2 + lookup + task SQL), <strong>SQL Server</strong> (streaming + <code>MERGE</code> o SCD2 + lookup + task SQL), <strong>file</strong> (filesystem/S3/SFTP/FTP × CSV/JSON/XML/XLSX/Parquet), <strong>Noeva</strong> (file e cartelle dei workspace + upload con elaborazione AI come <code>action</code> + lookup su stato e testo estratto), <strong>HTTP</strong> (lookup e action su API REST, <code>httpLookup</code> e <code>httpAction</code>), <strong>Jira Cloud</strong> (<code>jiraIssues</code>: le issue di una JQL su API REST v3, in colonne normalizzate, e <code>jiraIssueLookup</code> per chiave; changelog, commenti e worklog completi come lista; <code>jiraCreateIssue</code>, <code>jiraUpdateIssue</code>, <code>jiraTransition</code>, <code>jiraUpsertIssue</code> per ID esterno, <code>jiraAddComment</code> e <code>jiraAddWorklog</code> con chiave di deduplica e <code>jiraLinkIssues</code> come <code>action</code>, testo in markdown), <strong>IMAP</strong>, <strong>SMTP</strong> e <strong>SendGrid</strong> (posta in lettura e invio, con OAuth2 dove la casella lo richiede), <strong>processo esterno</strong> (<code>processoEsternoAction</code>: un programma lanciato per record in un nodo <code>action</code>, senza shell)</td></tr><tr><td><strong>Cross-database</strong></td><td>Una pipeline può leggere da un DB e scrivere su un altro (es. PG → SQL Server)</td></tr><tr><td><strong>GraphRunReport</strong></td><td>Risultato auto-descrittivo di ogni run (vedi §6)</td></tr><tr><td><strong>CLI & container</strong></td><td><code>etl list</code> / <code>etl run <pipeline></code> / <code>etl serve</code> / <code>etl runs list</code> / <code>etl state show</code> / <code>etl versions snapshot</code> (anche <code>--realign</code>) / <code>etl versions check</code> / <code>etl versions rollback</code> / <code>etl env check</code> / <code>etl catalog check</code> / <code>etl docs build</code> / <code>etl ci</code> / <code>etl init</code> / <code>etl agent sync</code> / <code>etl upgrade</code>; immagine Docker</td></tr><tr><td><strong>App desktop</strong></td><td><code>noeva-etl-ui</code> (Tauri): DAG delle pipeline, avvio manuale, storico ed esito delle run, nodo per nodo — mostra, non costruisce</td></tr><tr><td><strong>Worker daemon</strong></td><td><code>etl worker</code> — poller su <code>processes</code> via <code>noeva-server-api</code> (claim/progress HTTP, mai Supabase diretto), dispatch verso il catalogo di <code>etl.config.ts</code>; una istanza serve N workspace</td></tr></tbody></table><p><strong>Esempi inclusi</strong>: le pipeline della sezione «Esempi» di questa guida, come <a href="./pipelines/orders-enriched-daily"><code>orders-enriched-daily</code></a> (join a chiave, fan-out, try/catch) e <a href="./pipelines/crm-leads-sync"><code>crm-leads-sync</code></a> (copia fra due istanze Postgres).</p><h2 id="_4-come-funziona-architettura" tabindex="-1">4. Come funziona (architettura) <a class="header-anchor" href="#_4-come-funziona-architettura" aria-label="Permalink to "4. Come funziona (architettura)""></a></h2><p>Ogni pipeline è un <strong>grafo</strong> di nodi (DAG), costruito in codice col DSL <code>graph()…build()</code>:</p>',15)),s(i,{code:"flowchart%20LR%0A%20%20ordini%5B%22source%3Cbr%2F%3Eordini%22%5D%20--%3E%20valida%5B%22transform%3Cbr%2F%3Evalidate%20(contratto)%22%5D%0A%20%20clienti%5B%22source%3Cbr%2F%3Eclienti%22%5D%20--%3E%20join%5B%22join%3Cbr%2F%3E(a%20chiave)%22%5D%0A%20%20valida%20-.record%20invalido.-%3E%20scarti%5B%22dead-letter%22%5D%0A%20%20valida%20--%3E%20join%0A%20%20join%20--%3E%20lookup%5B%22lookup%3Cbr%2F%3E(lettura%20DB%20o%20API)%22%5D%0A%20%20lookup%20--%3E%20guard%5B%22try-catch%22%5D%0A%20%20guard%20--%3E%20dwh%5B%22sink%3Cbr%2F%3EDWH%22%5D%0A%20%20guard%20--%3E%20file%5B%22sink%3Cbr%2F%3Efile%22%5D%0A%20%20guard%20-.catch.-%3E%20errori%5B%22ramo%20errori%22%5D%0A"}),e[1]||(e[1]=o(`<ul><li><strong>Core</strong> (<code>src/core</code>) — primitive + runner; <strong>non contiene logica di dominio</strong>.</li><li><strong>Dependency Injection</strong> — la <em>definizione</em> della pipeline è agnostica: sorgente e sink concreti si iniettano all'avvio. Per questo lo stesso codice gira su DB diversi e si testa con connettori in-memory.</li><li><strong>Streaming pull-based</strong> — i record scorrono dai source ai sink senza essere caricati tutti in memoria; è il ritmo di scrittura a regolare quello di lettura.</li><li><strong>Tre percorsi per un record che fallisce</strong>: <em>dead-letter</em> sul nodo (il record va altrove, la run prosegue), ramo <em>catch</em> di un nodo <code>try-catch</code> (gli errori di un intero tratto del grafo finiscono su nodi di gestione dedicati), <em>fail-fast</em> (la run si ferma — obbligatorio per le aggregazioni stateful).</li><li><strong>Osservabilità</strong> — logger JSON strutturato + metriche; ogni run produce un <code>GraphRunReport</code> con i conteggi di ogni nodo.</li></ul><p>Stack: TypeScript ESM strict, Node ≥ 20, <code>pnpm</code>, <code>tsup</code>, <code>vitest</code>, ESLint/Prettier, Zod. Dipendenze runtime: i driver dei database (<code>pg</code>, <code>mssql</code>), le librerie per storage e formati dei file (AWS SDK, SFTP, FTP, CSV, XLSX, XML, Parquet), <code>express</code> per il server locale di <code>etl serve</code>. Nessuna dipendenza Supabase: il claim/report sulla tabella <code>processes</code> passa da <code>noeva-server-api</code> via HTTP (<code>fetch</code> nativo).</p><h2 id="_5-come-si-usa-e-si-distribuisce" tabindex="-1">5. Come si usa e si distribuisce <a class="header-anchor" href="#_5-come-si-usa-e-si-distribuisce" aria-label="Permalink to "5. Come si usa e si distribuisce""></a></h2><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># in un repo cliente, in sviluppo</span></span>
|
|
2
2
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> list</span></span>
|
|
3
3
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pnpm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> etl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> <</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">pipelin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">e</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">></span></span>
|
|
4
4
|
<span class="line"></span>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{t as p}from"./chunks/theme.
|
|
1
|
+
import{t as p}from"./chunks/theme.Bq6mfDhZ.js";import{R as s,a8 as i,a9 as u,aa as c,ab as l,ac as f,ad as d,ae as m,af as h,ag as g,ah as A,d as v,u as y,v as C,s as P,ai as b,aj as w,ak as R,a7 as E}from"./chunks/framework.qdetmeNX.js";function r(e){if(e.extends){const a=r(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const n=r(p),S=v({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=y();return C(()=>{P(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&b(),w(),R(),n.setup&&n.setup(),()=>E(n.Layout)}});async function T(){globalThis.__VITEPRESS__=!0;const e=D(),a=j();a.provide(u,e);const t=c(e.route);return a.provide(l,t),a.component("Content",f),a.component("ClientOnly",d),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),n.enhanceApp&&await n.enhanceApp({app:a,router:e,siteData:m}),{app:a,router:e,data:t}}function j(){return A(S)}function D(){let e=s;return h(a=>{let t=g(a),o=null;return t&&(e&&(t=t.replace(/\.js$/,".lean.js")),o=import(t)),s&&(e=!1),o},n.NotFound)}s&&T().then(({app:e,router:a,data:t})=>{a.go().then(()=>{i(a.route,t.site),e.mount("#app")})});export{T as createApp};
|