Improve routing logic

[AntoineGautier]

TODO

• Merge main
• Update LBL commit after merging Change __ctrlFlow annotations modelica-buildings#4093

Description

This PR

• changes the annotations used to mark template classes and their packages, see

  ctrl-flow-dev/server/src/parser/README.md

  Lines 177 to 187 in 6659aba

  	The template discovery process relies on a grep for the following hierarchical class annotations:
  	- `__ctrlFlow(routing="root()`: Marks the lop-level package containing all templates, e.g.,
  	`Buildings.Templates`
  	- `__ctrlFlow(routing="template")`: Marks individual template classes, e.g.,
  	`Buildings.Templates.AirHandlersFans.VAVMultiZone`
  	All template classes, and all packages between the root package and the template classes
  	are considered as "entry points" and added to the `templateNodes` array of [loader.ts](./loader.ts).
  	This means that the class URI ultimately dictates the explorer tree structure,
  	starting from the "root" package which must be unique inside a library.

  and joint PR in MBL Change __ctrlFlow annotations modelica-buildings#4093
• stores all the data needed to support a multiple tier tree structure within the templateNodes array, see

  ctrl-flow-dev/server/src/parser/loader.ts

  Lines 38 to 40 in 6659aba

  	// Master list of TemplateNode objects representing all templates and packages.
  	// It is intended to be used in the future when the UI can handle nested packages.
  	const templateNodes: TemplateNode[] = [];

• prunes the entry points to keep only the immediate parent package of each template class, due to the current limitation of the UI that does not support a multiple tier tree structure, as explained in the linked issue), see

  ctrl-flow-dev/server/src/parser/template.ts

  Lines 226 to 243 in 6659aba

  	// Fix for https://github.com/lbl-srg/ctrl-flow-dev/issues/422
  	// Currently the UI does not support nested system types.
  	// Therefore, we only add the Modelica class name of the containing package.
  	const type = parser.findElement(path.join("."));
  	if (type && type.entryPoint) {
  	if (!type.description) {
  	console.error(
  	"Error: missing class description string in entry point " +
  	type.modelicaPath,
  	);
  	process.exit(1);
  	}
  	const systemType = {
  	description: type.description,
  	modelicaPath: type.modelicaPath,
  	};
  	this.systemTypes.unshift(systemType);
  	systemTypeStore.set(type.modelicaPath, systemType);

Related Issue(s)

#422

Dependency to #424

Testing

With these changes, and using a temporary branch of MBL that adds __ctrlFlow(routing="template") to both the HP plant template and its controller, we get the following template list in the UI (to be compared to the screenshot from the issue page).

[JayHuLBL]

lop-level --> top-level

[AntoineGautier]

Yes

[JayHuLBL]

Do we want to keep this?

[AntoineGautier]

No. I've removed it.

[JayHuLBL]

It looks good. Please see the inline comments.

[AntoineGautier]

@JayHuLBL Thanks!

• We can merge this to staging for testing the deployment.
• Before merging to main, we should wait for Change __ctrlFlow annotations modelica-buildings#4093 and update MBL commit to MBL latest master.

[JayHuLBL]

@AntoineGautier Only one small question. Other than that, it looks good to me.