From e178a830e88c5c28e7d6f9a01f4318e7ffda8da9 Mon Sep 17 00:00:00 2001 From: Charles Lowell Date: Tue, 4 Jul 2023 11:43:56 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=91=8Dupdate=20changelog=20entry=20to=20i?= =?UTF-8?q?nclude=20instructions=20for=20upgrade?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles Lowell --- .changeset/rotten-colts-decide.md | 35 ++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/.changeset/rotten-colts-decide.md b/.changeset/rotten-colts-decide.md index 9fddafe6f8..9a6245a65f 100644 --- a/.changeset/rotten-colts-decide.md +++ b/.changeset/rotten-colts-decide.md @@ -2,4 +2,37 @@ '@backstage/plugin-catalog-backend-module-incremental-ingestion': minor --- -Allow incremental event handlers to be async; Force event handler to indicate if it made a change +**BREAKING** Allow incremental event handlers to be async; Force event handler +to indicate if it made a change. Instead of returning `null` or `undefined` from an event +handler to indicate no-oop, instead return the value { type: "ignored" }. + +**before** + +```javascript +import { createDelta, shouldIgnore } from "./my-delta-creater"; + +eventHandler: { + onEvent(params) { + if (shouldIgnore(params)) { + return; + } + return createDelta(params); + } +} +``` + +**after** + +```javascript +import { createDelta, shouldIgnore } from "./my-delta-creater"; + +eventHandler: { + async onEvent(params) { + if (shouldIgnore(params) { + return { type: "ignored" }; + } + // code to create delta can now be async if needed + return await createDelta(params); + } +} +```