Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

suggestions : utilisation de RxJS pour limiter les appels #86

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"rollup": "^2.3.4",
"rollup-plugin-svelte": "^5.0.1",
"rollup-plugin-terser": "^5.3.0",
"rxjs": "6.6.x",
"postcss": "8.0.3",
"postcss-cli": "7.1.2",
"tailwindcss": "1.8.10"
Expand Down
57 changes: 51 additions & 6 deletions frontend/src/components/SearchSuggestInput.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import { onMount, onDestroy } from 'svelte';
import { userData } from './stores.js';
import { httpClient, USER_API } from './utils.js';
import { BehaviorSubject, of } from 'rxjs'
import { debounceTime, distinctUntilChanged, filter, share, switchMap, take, tap } from 'rxjs/operators'

export let innerHtml = '';
export let style = '';
Expand All @@ -11,10 +13,12 @@

const http = httpClient();

// constantes
const inputId = "suggest-" + Math.floor(Math.random() * 1000);
const minCharactersToSuggest = 4;
const valueFieldName = 'text';
const labelFieldName = 'text';
const inputDelayMs = 250;

// méthodes qui permettent de synchroniser le champ 'value' et le texte du champ <input />
let onSuggestionInput;
Expand All @@ -40,25 +44,66 @@
*/
const keywordsFunction = (/* suggestion */) => value || '';

// RxJS ------------------------------------------------------------- START

/** équivalent d'un store 'writable' (sans valeur initiale) */
const searchTrigger = new BehaviorSubject();

/**
* fonction asynchrone de recherche des suggestions.
* équivalent d'un store 'readable', fournit les suggestions.
*
* besoin :
* éviter de mitrailler le serveur si l'utilisateur tape plusieurs caractères rapidement
*
* Toute la 'magie' vient des opérateurs du pipe (doc conseillée) :
* - filter : ne laisse pas passer null ou undefined
* - distinctUntilChanged : une seule émission pour 2 valeurs successives identiques
* - debounceTime : garde une valeur s'il se passe un temps suffisant avant la prochaine
* - switchMap : permet ici de se désinscrire de l'ancien observable avant de transformer le nouveau
* + couplé à un appel passant par 'fromFetch' pour pouvoir annuler les anciennes requêtes
* - share : évite de lancer une requête par souscription
*/
const searchObservable = searchTrigger.asObservable().pipe(
filter(v => v !== null && v !== undefined),
distinctUntilChanged(),
debounceTime(inputDelayMs),
switchMap(v => searchSuggestions(v)),
share()
);

/**
* fonction "asynchrone" (RxJS) de recherche des suggestions.
* Le serveur n'est appelé qu'à partir d'une certaine longueur de chaîne.
*
* note : on n'utilise pas l'option 'minCharactersToSearch' car elle fonctionne mal avec la validation sur 'Enter',
* en effet la première valeur de la dernière liste de suggestions est utilisée, ce n'est pas ce qu'on veut.
*
* @return observable contenant les suggestions
*/
const searchFunction = async (inputText) => {
const searchSuggestions = (inputText) => {
console.debug('MAJ des suggestions');
return !inputText || inputText.length < minCharactersToSuggest
? []
: await http.fetchJson(`${USER_API}/suggest`, {
? of([])
: http.rxjs.fetchJson(`${USER_API}/suggest`, {
method: 'POST',
body: JSON.stringify({
index_name: $userData.index_name,
content: inputText,
}),
});
})
})
};

/**
* fonction asynchrone de recherche des suggestions.
* Crée une Promise contenant la prochaine valeur de l'observable, puis provoque la recherche.
*/
const searchFunction = async (inputText) => {
const deferred = searchObservable.pipe(take(1)).toPromise();
searchTrigger.next(inputText);
return deferred;
};

// RxJS --------------------------------------------------------------- END
</script>

<div class={style}>
Expand Down
30 changes: 29 additions & 1 deletion frontend/src/components/utils.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import { user as userStore } from './stores.js';
import { fromFetch } from 'rxjs/fetch'
import { from, of } from 'rxjs'
import { catchError, flatMap, switchMap } from 'rxjs/operators'

export const USER_API = '/api/user';

Expand Down Expand Up @@ -93,7 +96,32 @@ function httpClient() {
const res = await fetchRaw(url, requestInit);
return await res.json();
}
return { fetch: fetchRaw, fetchJson };

const fetchRawRxjs = (url, requestInit = defaultInit) =>
fromFetch(url, { headers: buildHeaders(), ...requestInit })
.pipe(
switchMap(res => {
if (!res.ok) {
console.log(`L'appel à "${url}" a échoué`)
return of({ error: true, message: `L'appel à "${url}" a échoué: ${res.status}` });
}
console.debug(`L'appel à "${url}" a réussi`);
return of(res);
}),
catchError(err => of({ error: true, message: err.message })),
);

const fetchJsonRxjs = (url, requestInit = defaultInit) =>
fetchRawRxjs(url, requestInit).pipe(flatMap(res => from(res.json())));

return {
fetch: fetchRaw,
fetchJson,
rxjs: {
fetch: fetchRawRxjs,
fetchJson: fetchJsonRxjs
}
};
}

async function files(method, baseDir,file = {'name': ""}) {
Expand Down