Skip to content
This repository was archived by the owner on Aug 27, 2024. It is now read-only.

Commit 5ac9302

Browse files
VentheVenthe
committed
#18 Implement debounce with proper async support
1 parent 1f0893c commit 5ac9302

5 files changed

+181
-75
lines changed

‎src/FauxpilotCompletionProvider.ts

+33-52
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
11
import { Configuration, CreateCompletionRequestPrompt, CreateCompletionResponse, OpenAIApi } from 'openai';
22
import { CancellationToken, InlineCompletionContext, InlineCompletionItem, InlineCompletionItemProvider, InlineCompletionList, Position, ProviderResult, Range, TextDocument, workspace, StatusBarItem } from 'vscode';
33
import { AxiosResponse } from 'axios';
4-
import { nextId } from './Uuid';
4+
import { debounce } from './utilities';
55

66
export class FauxpilotCompletionProvider implements InlineCompletionItemProvider {
7-
cachedPrompts: Map<string, number> = new Map<string, number>();
8-
7+
// TODO: Make dynamic
8+
// AFAIK VSCode creates provider once. As such, token will never be updated
99
private configuration: Configuration = new Configuration({
1010
apiKey: workspace.getConfiguration('fauxpilot').get("token")
1111
});
12+
// TODO: Make dynamic
13+
// AFAIK VSCode creates provider once. As such, server address will never be updated
1214
private openai: OpenAIApi = new OpenAIApi(this.configuration, `${workspace.getConfiguration('fauxpilot').get("server")}/${workspace.getConfiguration('fauxpilot').get("engine")}`);
13-
private requestStatus: string = "done";
14-
private statusBar: StatusBarItem;
15-
16-
constructor(statusBar: StatusBarItem){
17-
this.statusBar = statusBar;
15+
private readonly debouncedApiCall: any = debounce(
16+
// TODO: Extract to method.
17+
// I absolutely forgot how to handle 'this' context in JS. Simple extraction makes this
18+
// undefined. How to bind it?
19+
(prompt: string, position: Position) => {
20+
return new Promise(resolve => {
21+
console.debug("Requesting completion after debounce period");
22+
this.statusBar.tooltip = "Fauxpilot - Working";
23+
this.statusBar.text = "$(loading~spin)";
24+
this.callOpenAi(prompt).then((response) => {
25+
this.statusBar.text = "$(light-bulb)";
26+
resolve(this.toInlineCompletions(response.data, position));
27+
}).catch((error) => {
28+
this.statusBar.text = "$(alert)";
29+
console.error(error);
30+
resolve(([] as InlineCompletionItem[]));
31+
});
32+
});
33+
}, { timeout: workspace.getConfiguration('fauxpilot').get("suggestionDelay") as number, defaultReturn: [] });
34+
35+
constructor(private statusBar: StatusBarItem, private testCompletion?: any) {
1836
}
1937

2038
//@ts-ignore
@@ -26,46 +44,14 @@ export class FauxpilotCompletionProvider implements InlineCompletionItemProvider
2644
}
2745

2846
const prompt = this.getPrompt(document, position);
29-
console.debug("Requesting completion for prompt", prompt);
3047

3148
if (this.isNil(prompt)) {
3249
console.debug("Prompt is empty, skipping");
3350
return Promise.resolve(([] as InlineCompletionItem[]));
3451
}
3552

36-
const currentTimestamp = Date.now();
37-
const currentId = nextId();
38-
this.cachedPrompts.set(currentId, currentTimestamp);
39-
40-
// check there is no newer request util this.request_status is done
41-
while (this.requestStatus === "pending") {
42-
await this.sleep(200);
43-
console.debug("current id = ", currentId, " request status = ", this.requestStatus);
44-
if (this.newestTimestamp() > currentTimestamp) {
45-
console.debug("newest timestamp=", this.newestTimestamp(), "current timestamp=", currentTimestamp);
46-
console.debug("Newer request is pending, skipping");
47-
this.cachedPrompts.delete(currentId);
48-
return Promise.resolve(([] as InlineCompletionItem[]));
49-
}
50-
}
51-
52-
console.debug("current id = ", currentId, "set request status to pending");
53-
this.requestStatus = "pending";
54-
this.statusBar.tooltip = "Fauxpilot - Working";
55-
this.statusBar.text = "$(loading~spin)";
56-
57-
return this.callOpenAi(prompt as String).then((response) => {
58-
this.statusBar.text = "$(light-bulb)";
59-
return this.toInlineCompletions(response.data, position);
60-
}).catch((error) => {
61-
console.error(error);
62-
this.statusBar.text = "$(alert)";
63-
return ([] as InlineCompletionItem[]);
64-
}).finally(() => {
65-
console.debug("current id = ", currentId, "set request status to done");
66-
this.requestStatus = "done";
67-
this.cachedPrompts.delete(currentId);
68-
});
53+
console.debug("Requesting completion for prompt", prompt);
54+
return this.debouncedApiCall(prompt, position);
6955
}
7056

7157
private getPrompt(document: TextDocument, position: Position): String | undefined {
@@ -80,21 +66,16 @@ export class FauxpilotCompletionProvider implements InlineCompletionItemProvider
8066
return value === undefined || value === null || value.length === 0;
8167
}
8268

83-
private newestTimestamp() {
84-
return Array.from(this.cachedPrompts.values()).reduce((a, b) => Math.max(a, b));
85-
}
86-
87-
private sleep(milliseconds: number) {
88-
return new Promise(r => setTimeout(r, milliseconds));
89-
};
90-
9169
private callOpenAi(prompt: String): Promise<AxiosResponse<CreateCompletionResponse, any>> {
9270
console.debug("Calling OpenAi", prompt);
9371

94-
//check if inline completion is enabled
72+
// FIXME: I do not understand my own comment below. To verify
73+
// check if inline completion is enabled
9574
const stopWords = workspace.getConfiguration('fauxpilot').get("inlineCompletion") ? ["\n"] : [];
9675
console.debug("Calling OpenAi with stop words = ", stopWords);
97-
return this.openai.createCompletion({
76+
// FIXME: how to mock in mocha?
77+
// Current implementation works by injecting alternative provider via constructor
78+
return (this.testCompletion ?? this.openai).createCompletion({
9879
model: workspace.getConfiguration('fauxpilot').get("model") ?? "<<UNSET>>",
9980
prompt: prompt as CreateCompletionRequestPrompt,
10081
/* eslint-disable-next-line @typescript-eslint/naming-convention */

‎src/Uuid.ts

-8
This file was deleted.

‎src/test/suite/fauxpilot-completion-provider.test.ts

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
import assert = require("assert");
2+
import { FauxpilotCompletionProvider } from "../../FauxpilotCompletionProvider";
3+
import { CancellationToken, InlineCompletionContext, InlineCompletionItem, InlineCompletionItemProvider, InlineCompletionList, Position, ProviderResult, Range, TextDocument, workspace, StatusBarItem } from 'vscode';
4+
import { AxiosResponse } from 'axios';
5+
import { CreateCompletionResponse } from "openai";
6+
7+
suite('provideInlineCompletionItems', () => {
8+
test('Normal completion', async () => {
9+
const provider = new FauxpilotCompletionProvider(statusBarStub(), testCompletion([{ text: "Example response" }]));
10+
const result = await provider.provideInlineCompletionItems(
11+
documentStub("Example prompt"),
12+
positionStub(),
13+
null as any,
14+
null as any
15+
);
16+
assert.equal((result as any)[0].insertText, "Example response");
17+
});
18+
test('Debounced completion', async () => {
19+
// Rewrite as before/after each
20+
let output: any[] = [];
21+
const originalLog = console.log;
22+
const originalDebug = console.debug;
23+
console.log = (message?: any, ...optional: any[]) => {
24+
output.push([message, ...optional]);
25+
originalLog(message, ...optional);
26+
};
27+
console.debug = (message?: any, ...optional: any[]) => {
28+
output.push([message, ...optional]);
29+
originalDebug(message, ...optional);
30+
};
31+
32+
const provider = new FauxpilotCompletionProvider(statusBarStub(), testCompletion([{ text: "Example response" }]));
33+
(provider.provideInlineCompletionItems(
34+
documentStub("Example prompt 1"),
35+
positionStub(),
36+
null as any,
37+
null as any
38+
) as Promise<any>).then(console.debug);
39+
const result = await provider.provideInlineCompletionItems(
40+
documentStub("Example prompt 2"),
41+
positionStub(),
42+
null as any,
43+
null as any
44+
);
45+
46+
console.debug = originalDebug;
47+
console.log = originalLog;
48+
49+
assert.equal((result as any)[0].insertText, "Example response");
50+
assert.deepEqual(output, [
51+
[
52+
"Requesting completion for prompt",
53+
"Example prompt 1"
54+
],
55+
[
56+
"Requesting completion for prompt",
57+
"Example prompt 2"
58+
],
59+
[
60+
"Resolved previous debounce with defaults"
61+
],
62+
[
63+
[]
64+
],
65+
[
66+
"Resolved debounce"
67+
],
68+
[
69+
"Requesting completion after debounce period"
70+
],
71+
[
72+
"Calling OpenAi",
73+
"Example prompt 2"
74+
],
75+
[
76+
"Calling OpenAi with stop words = ",
77+
["\n"]
78+
]
79+
]);
80+
});
81+
});
82+
83+
function positionStub(): Position {
84+
return {
85+
line: 0,
86+
character: 0
87+
} as any;
88+
}
89+
90+
function documentStub(out?: any): TextDocument {
91+
return {
92+
getText: () => out
93+
} as any;
94+
}
95+
96+
function statusBarStub(): StatusBarItem {
97+
return {
98+
tooltip: "",
99+
text: ""
100+
} as any
101+
}
102+
103+
function testCompletion(choices: { text: string }[]) {
104+
return {
105+
createCompletion: async (params: any): Promise<AxiosResponse<CreateCompletionResponse, any>> => {
106+
console.warn("DEBUG COMPLETION", params);
107+
const result: CreateCompletionResponse = {
108+
choices
109+
};
110+
return {
111+
data: result
112+
} as AxiosResponse;
113+
}
114+
};
115+
}

‎src/test/suite/uuid.test.ts

-15
This file was deleted.

‎src/utilities.ts

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
export function debounce<T>(fn: (ths: any, ...args: any[]) => Promise<T>,
2+
{ timeout = 300, defaultReturn }: { timeout: number, defaultReturn?: T }) {
3+
let timer: NodeJS.Timeout;
4+
let previousPromise: any;
5+
return async (...args: any[]) => {
6+
// Resolve any previous pending promises, so that we will never leave
7+
// them dangling
8+
// TODO: Extract debug logging wrapper
9+
previousPromise?.((() => {
10+
console.debug("Resolved previous debounce with defaults");
11+
return defaultReturn;
12+
})());
13+
clearTimeout(timer);
14+
return new Promise(resolve => {
15+
// Add previous promise, so that we can resolve it with empty upon the
16+
// next (debounced) call
17+
previousPromise = resolve;
18+
timer = setTimeout(() => {
19+
// TODO: Extract debug logging wrapper
20+
resolve((() => {
21+
console.debug("Resolved debounce");
22+
// Because we are actually calling the API, we must resolved
23+
// all previous debounced calls with empty, so we ensure that
24+
// there is no dangling resolved promise that would be called
25+
// during the next debounced call
26+
previousPromise = undefined;
27+
// @ts-ignore
28+
return fn.apply(this, args);
29+
})());
30+
}, timeout);
31+
});
32+
};
33+
}

0 commit comments

Comments
 (0)