[tree] Child node 'path/to/my/file.ext' does not belong to this 'WorkspaceNodeId' tree

[kittaakos]

Description

I can see multiple Child node 'path/to/my/file.ext' does not belong to this 'WorkspaceNodeId' tree errors in the console after updating to next@0.14.0-next.d5c81105 (d5c8110).

This seems to be a regression after #6679. (CC: @akosyakov)

Related change:
5b45e12#diff-c4f0263c39593601b3f84451c2de4106R281-R283

Reproduction Steps

Start the application.

OS and Theia version:
d5c8110

Diagnostics:

[kittaakos]

this.nodes[root.id] !== root is always false:

[akosyakov]

@kittaakos Do you know how to reproduce it from sources? the issue is that we used to reset the tree with some old state, now we don't reset it, but report as an error that it has to be fixed by the developer.

I don't think we want to go back with resetting some old root.

[kittaakos]

Do you know how to reproduce

Not yet. If I put a breakpoint and stop for a second or two here:

theia/packages/navigator/src/browser/navigator-tree.ts

Lines 75 to 82 in d5c8110

	return {
	id: WorkspaceNode.id,
	name: multiRootName || WorkspaceNode.name,
	parent: undefined,
	children: [],
	visible: false,
	selected: false
	};

I do not see the error. Otherwise, it pops up twice per each app start.

Edit: I was wrong, I can see the same error.

[akosyakov]

I do not see the error. Otherwise, it pops up twice per each app start.

Do you start the browser example from theia repo and as a workspace using this repo? I'm looking for a way to reproduce it. You can debug how many times NavigatorMode.updateRoot is called and from there.

Popping up twice also does not sound bad, before it could go in the infinite loop. Maybe we should just remove console.error and wait till someone reports the real functional issue. You don't see any real issues for the navigator from the user perspective, correct? cc @svenefftinge

[kittaakos]

You don't see any real issues

Correct, I don't.

I will take care of the investigation as it does not happen from the Theia source but from a downstream project. 😕

[akosyakov]

Ok, please check why it happens that the navigator root replaced twice for you on the startup. It should not happen without explicit workspace changes from the user. Also check that your code does not keep references to navigator nodes and don't pass them to the navigator model after the navigator root is changed.

[kittaakos]

twice for you on the startup

Once the model initialization, the second time is the layout restorer.

Also check that your code does not keep references to navigator nodes

I am not aware of any tree/tree-model customizations. It rather seems like a timing issue that I cannot reproduce in Theia. See the GIF, the roots are out of sync. I am still on this issue, as from time to time, the navigator is empty 😕

[kittaakos]

This is not a Theia bug but was in my code. The missing return messed up the app state, and 'initialized_layout' was resolved before the layout was restored.

Bad code:

@injectable()
export class MyCustomFrontendApplication extends FrontendApplication {

    protected async initializeLayout(): Promise<void> {
       /*no return here!!!*/ super.initializeLayout().then(() => {
            // Do some custom things here
        });
    }

}

Good code:

@injectable()
export class MyCustomFrontendApplication extends FrontendApplication {

    protected async initializeLayout(): Promise<void> {
        return super.initializeLayout().then(() => {
            // Do some custom things here
        });
    }

}

Sorry for the noise, with the fix, it works as expected.

[akosyakov]

So then we keep this error message. It seems to be helpful :)

[kittaakos]

It seems to be helpful :)

It is 👍