fix: removeIED - prevent duplicate LNode's by stee-re · Pull Request #147 · openscd/scl-lib

stee-re · 2026-05-27T13:29:48Z

resolves #121

Summary

When multiple IEDs reference the same LNode, removing those IEDs sequentially can result in duplicate LNode
entries with iedName="None". This PR modifies the default behaviour for removeIED() to delete all LNodes bound to that IED by default, but exposes a new optional flag preserveLNodes which will instead, set the LNodes ideName="None". In cases where setting the iedName="None" would lead to a duplicate LNode, then it is removed instead.
E.g.

remove(myIEDElement, {preserveLNodes: true});

Changes

tIED/removeIED.ts:
- Added RemoveIedOptions interface with an optional preserveLNodes flag (defaults to false)
- Added the following LNode related functions:
- removeBoundLNodes() - Default handling for LNodes - find any (public) matching LNodes and create a Remove edit for them.
- detachLNodeBindings() - if "preserveLNodes flag set, this function is called instead, to instead set the LNodes iedName to "None", taking care to avoid duplicates. Any LNodes encountered which would cause a duplicate, are removed instead.

Helper functions

lNodeKey - creates a key for the LNode based on all the other attributes (except iedName) which combined, must be unique.
removeLNode() & setLNodeToNone() - oneliner functions, there only to make the code more readable.
getLNodeByIedName() used to find the bound LNodes (and the specification LNodes (set ot None))

Other Changed files

index.ts: Exported RemoveIedOptions type
tIED/removeIED.spec.ts: Added tests for LNode removal and opt-in LNode updating behaviour
tIED/removeIED.testfile.ts: Added test fixture with duplicate LNode scenario
.gitignore: Added IDE and build artifact patterns

Code coverage 99.52%

resolves openscd#121

danyill

Thank you for looking at this and my apologies for the delay in reviewing.

I've flagged just a few small "tidyness", feel free to fix or not as you wish.

danyill · 2026-06-21T09:38:12Z

+     * - Find all LNode references with matching iedName and either set them to None, or delete them if setting them to None would result in duplicate LNode keys within the same scope.
+     *   The scope is defined as the nearest Bay, VL or Substation parent.
+     */
+    describe("without 'preservveNodes' set (default)", () => {


Suggested change

describe("without 'preservveNodes' set (default)", () => {

describe("without 'preserveNodes' set (default)", () => {

danyill · 2026-06-21T09:38:38Z

+     *   The scope is defined as the nearest Bay, VL or Substation parent.
+     */
+    describe("without 'preservveNodes' set (default)", () => {
+      //TODO consider changing this into a forEach (Substation, VL and Bay) array test.


Suggested change

//TODO consider changing this into a forEach (Substation, VL and Bay) array test.

It looks like an array already...

danyill · 2026-06-21T09:43:50Z

+
+          //


Suggested change

//

Just removing a little crud.

danyill · 2026-06-21T09:45:25Z

+      // Do keep in mind however, the subject SCL has 2 of everything. E.g. S1 & S2
+      ["Bay", "VoltageLevel", "Substation"].forEach((scope) => {
+        it(`Within a ${scope}, it sets all bound LNodes to None`, () => {
+          //we're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur (yet).


Suggested change

//we're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur (yet).

// We're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur (yet).

danyill · 2026-06-21T09:46:12Z

+  describe("referenced LNode's", () => {
+    /*
+     * Here we need to test:
+     * - Delete all LNode references found with matching iedName, BUT only inside the substation section (but not inside Private sections).


I thought after reading this you would have put an LNode inside a Private section to test this...

danyill · 2026-06-21T09:47:05Z

+
+      ["Bay", "VoltageLevel", "Substation"].forEach((scope) => {
+        it(`Within a ${scope}, it removes 'would-be' duplicates`, () => {
+          //we're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur.


Suggested change

//we're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur.

// We're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur.

danyill · 2026-06-21T10:00:03Z

+function removeBoundLNodes(ied: Element, name: string): Remove[] {
+  return (getLNodesByIedName(ied.ownerDocument, name) ?? []).map(removeLNode);
+}


Is it me or is this very verbose? Or is that the AI secret sauce 😉

Why not just?

Suggested change

function removeBoundLNodes(ied: Element, name: string): Remove[] {

return (getLNodesByIedName(ied.ownerDocument, name) ?? []).map(removeLNode);

}

function removeBoundLNodes(ied: Element, name: string): Remove[] {

return (getLNodesByIedName(ied.ownerDocument, name) ?? []).map( { node: ln };);

}

danyill · 2026-06-21T10:01:48Z

+    return [];
+  }
+
+  const UnboundLNodesByScope = new Map<Element, Set<string>>();


Suggested change

const UnboundLNodesByScope = new Map<Element, Set<string>>();

const unboundLNodesByScope = new Map<Element, Set<string>>();

Why would this start with a capital letter?

fix: removeIED - prevent duplicate LNode's

4ef2497

resolves openscd#121

stee-re force-pushed the feat_removeIED-duplicates-issue branch 2 times, most recently from ec48b77 to 4ef2497 Compare May 27, 2026 13:32

stee-re requested review from JakobVogelsang and danyill and removed request for danyill May 27, 2026 13:32

This was referenced May 27, 2026

Remove IEDs - duplicated entries / lines OMICRONEnergyOSS/oscd-academy#55

Open

tIED: removeIeds behaviours with LNodes #121

Open

danyill approved these changes Jun 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: removeIED - prevent duplicate LNode's#147

fix: removeIED - prevent duplicate LNode's#147
stee-re wants to merge 1 commit into
openscd:mainfrom
stee-re:feat_removeIED-duplicates-issue

stee-re commented May 27, 2026 •

edited

Loading

Uh oh!

danyill left a comment

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

danyill Jun 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	describe("without 'preservveNodes' set (default)", () => {
	describe("without 'preserveNodes' set (default)", () => {

	//we're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur (yet).
	// We're using the "duplicates" test file, but by only deleting 1 IED, no duplicates occur (yet).

	const UnboundLNodesByScope = new Map<Element, Set<string>>();
	const unboundLNodesByScope = new Map<Element, Set<string>>();

Conversation

stee-re commented May 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Helper functions

Other Changed files

Uh oh!

danyill left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

stee-re commented May 27, 2026 •

edited

Loading