fix: add an internal debounce to setOutline + move code to OutlineView

[aminya]

setOutline was being called multiple times because of having different observers that were calling it.

[aminya]

Not sure why, but the jasmine fails to await inside beforeEach.

@UziTech

[UziTech]

I added some console.log statements and it looks like it is awaiting in beforeEach. I'm not sure what is wrong.

[aminya]

I added some console.log statements and it looks like it is awaiting in beforeEach. I'm not sure what is wrong.

I am using setTimeout. Does Jasmine do anything with those?

[aminya]

Another simpler approach is to not care about when this function is resolved, and use a sleep function in the tests. I actually started with that. But jasmine wasn't awaiting the sleep function either.

function sleep(ms = 1000) {
	return new Promise((resolve) => {
		setTimeout(resolve, ms)
	})
}

[aminya]

One other thing is to make a timer using a while loop. I haven't tried that though

  function sleep(delay) {
    const start = new Date().getTime();
    while (new Date().getTime() < start + delay) {
    	// do nothing
    };
  }

[UziTech]

If secondary calls return here the timeout never gets cleared and reset below.

[aminya]

But this.isRendering becomes false inside the setTimeout callback. 🤔

[UziTech]

Yes so the workflow goes like this:

1. Call setOutline; this.isRendering is set to true; timer is created.
2. Call setoutline; this.isRendering is true so returns early; timer is not changed.

The second call should reset the timer before returning. Otherwise the clearTimeout(this.setOutlineTimeout) is redundant because it will only be called after the timeout has already completed and this.isRendering is set to false.

[aminya]

The main reason I created this PR is that we have three observers:

• When the active text editor changes
• When the text changes
• When a provider is detected

In the beginning, these three might happen together resulting in three calls to getOutline. We may be able to handle this better than debouncing the calls.

For example, what if an active text editor is opened, but its provider is called late? The first call would return immediately due to a missing provider, but the second call actually has useful data.

[UziTech]

Maybe this a good opportunity for a memoized function instead of a debounced function. Essentially, cache the input and results and given the same input as before return the cached results instead of recalculating.