Fix loading message

rokucommunity · Oct 27, 2023 · 9702b2f · 9702b2f
1 parent 79385fa
commit 9702b2f
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 12 deletions.
diff --git a/src/DebugConfigurationProvider.ts b/src/DebugConfigurationProvider.ts
@@ -17,6 +17,7 @@ import { fileUtils } from 'roku-debug';
 import { util } from './util';
 import type { TelemetryManager } from './managers/TelemetryManager';
 import type { ActiveDeviceManager, RokuDeviceDetails } from './ActiveDeviceManager';
+import { debounce } from 'debounce';
 
 export class BrightScriptDebugConfigurationProvider implements DebugConfigurationProvider {
 
@@ -437,6 +438,7 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
      */
     private async promptForHost() {
         const deferred = new Deferred<string>();
+        const disposables: Array<() => any> = [];
 
         const discoveryTime = 5_000;
         const manualLabel = 'Enter manually';
@@ -454,8 +456,11 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
         //create a text-based spinner factory for use in the "loading ..." label
         const generateSpinnerText = util.createTextSpinner(3);
 
-        const refreshList = () => {
-            let itemsRefreshed: Array<QuickPickItem & { device?: RokuDeviceDetails }> = this.activeDeviceManager.getActiveDevices().map(device => ({
+        const refreshListDebounced = debounce(() => refreshList(true), 400);
+
+        const refreshList = (updateSpinnerText = false) => {
+            const devices = this.activeDeviceManager.getActiveDevices();
+            let itemsRefreshed: Array<QuickPickItem & { device?: RokuDeviceDetails }> = devices.map(device => ({
                 label: `${device.ip} | ${device.deviceInfo['user-device-name']} - ${device.deviceInfo['serial-number']} - ${device.deviceInfo['model-number']}`,
                 device: device
             }));
@@ -479,15 +484,13 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
             }
 
             if (this.activeDeviceManager.timeSinceLastDiscoveredDevice < discoveryTime) {
-                devicesLabel.label += ` (searching ${generateSpinnerText()})`;
-                setTimeout(() => {
-                    refreshList();
-                }, 500);
+                devicesLabel.label += ` (searching ${generateSpinnerText(updateSpinnerText)})`;
+                refreshListDebounced();
             }
 
             // allow user to manually type an IP address
             itemsRefreshed.push(
-                { label: '', kind: vscode.QuickPickItemKind.Separator },
+                { label: ' ', kind: vscode.QuickPickItemKind.Separator },
                 { label: manualLabel, device: { id: Number.MAX_SAFE_INTEGER } } as any
             );
 
@@ -503,8 +506,11 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
         };
 
         //anytime the device picker adds/removes a device, update the list
-        this.activeDeviceManager.on('device-found', refreshList);
-        this.activeDeviceManager.on('device-expire', refreshList);
+        disposables.push(
+            this.activeDeviceManager.on('device-found', () => refreshList()),
+            this.activeDeviceManager.on('device-expire', () => refreshList())
+        );
+
         quickPick.onDidHide(() => {
             deferred.reject(new Error('No host was selected'));
             quickPick.dispose();
@@ -531,6 +537,9 @@ export class BrightScriptDebugConfigurationProvider implements DebugConfiguratio
         refreshList();
         const result = await deferred.promise;
         quickPick.dispose();
+        for (const disposable of disposables) {
+            disposable();
+        }
         return result;
     }
 

diff --git a/src/util.spec.ts b/src/util.spec.ts
@@ -339,5 +339,27 @@ describe('Util', () => {
             expect(spin()).to.eql('-*-');
             expect(spin()).to.eql('*--');
         });
+
+        it('returns same value when passed false', () => {
+            const spin = util.createTextSpinner(3, '-', '*');
+            expect(spin()).to.eql('--*');
+            expect(spin(false)).to.eql('--*');
+
+            expect(spin()).to.eql('-*-');
+            expect(spin(false)).to.eql('-*-');
+
+            expect(spin()).to.eql('*--');
+            expect(spin(false)).to.eql('*--');
+
+            expect(spin()).to.eql('--*');
+            expect(spin(false)).to.eql('--*');
+
+            expect(spin()).to.eql('-*-');
+            expect(spin(false)).to.eql('-*-');
+
+            expect(spin()).to.eql('*--');
+            expect(spin(false)).to.eql('*--');
+
+        });
     });
 });
diff --git a/src/util.ts b/src/util.ts
@@ -390,14 +390,18 @@ class Util {
      * @returns function that generates loading strings
      */
     public createTextSpinner(max: number, offChar = '◦', onChar = '•') {
-        let current = 0;
+        let current = 2;
         const fullText = offChar.repeat(max).split('');
         /**
          * Generate the next text
+         * @param increment if false, will return the same value as last time
          */
-        return function spinner() {
+        return function spinner(increment = true) {
             const text = [...fullText];
-            text[current++ % max] = onChar;
+            if (increment) {
+                current++;
+            }
+            text[current % max] = onChar;
             return text.reverse().join('');
         };
     }