feat(front) : util httpExternal + autocomplete adresse BAN (ERP-66) (#52)
Auto Tag Develop / tag (push) Successful in 7s
Auto Tag Develop / tag (push) Successful in 7s
## ERP-66 — Utilitaires adresse/téléphone + autocomplétion BAN ### feat - **httpExternal** : client dédié aux API publiques externes (URL absolue, sans cookie de session, timeout). Seul point d'entrée autorisé pour un `$fetch` externe (règle frontend n°4). - **useAddressAutocomplete** : implémentation BAN (api-adresse.data.gouv.fr) — recherche ville (`type=municipality`) et adresse, mapping GeoJSON, throw en cas d'erreur/timeout (mode dégradé côté composant). La recherche d'adresse n'impose **pas** `type=housenumber` (sinon 0 résultat tant qu'aucun numéro n'est saisi) — spec-front mise à jour. - Tests Vitest : httpExternal, useAddressAutocomplete, cas limites `formatPhoneFR`. ### fix - **ClientAddressBlock** : la rue courante est toujours réinjectée dans les options de `MalioInputAutocomplete` (computed, miroir de `cityOptions`). Corrige le champ Adresse qui se vidait après validation / à l'édition d'une adresse existante (valeur pourtant persistée). Test de montage ajouté. - **useClientReferentials** : libellé des sites = numéro de département (2 premiers chiffres du code postal, déjà exposé par `/sites`) au lieu du nom. ### Vérifs - ESLint ✅ · Vitest 196/196 ✅ - Changements 100% frontend (+ doc spec). Reviewed-on: #52 Co-authored-by: tristan <tristan@yuno.malio.fr> Co-committed-by: tristan <tristan@yuno.malio.fr>
This commit was merged in pull request #52.
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
<template>
|
||||
<!--
|
||||
Placeholder generique « En cours de dev » pour les ecrans / onglets non
|
||||
encore implementes. Composant PARTAGE (shared/components) : auto-importe
|
||||
sans prefixe (`<ComingSoonPlaceholder>`) et reutilisable depuis n'importe
|
||||
quel module. Affiche un gif (asset local par defaut) + un message i18n.
|
||||
-->
|
||||
<div class="flex min-h-[240px] flex-col items-center justify-center gap-4 rounded-md bg-white py-10">
|
||||
<img
|
||||
v-if="!imageFailed"
|
||||
:src="src"
|
||||
:alt="resolvedTitle"
|
||||
class="max-h-[220px] w-auto rounded-md"
|
||||
@error="imageFailed = true"
|
||||
>
|
||||
<!-- Repli si le gif ne charge pas (offline, CSP, asset absent) :
|
||||
illustration emoji, le message reste affiche. -->
|
||||
<div v-else class="text-5xl" aria-hidden="true">🚧 👨💻 🚧</div>
|
||||
|
||||
<div class="text-center">
|
||||
<p class="text-xl font-bold text-black">{{ resolvedTitle }}</p>
|
||||
<p class="mt-1 text-black/60">{{ resolvedSubtitle }}</p>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
const props = withDefaults(
|
||||
defineProps<{
|
||||
/** Source de l'image/gif affichee. Defaut : asset local `/coming-soon.gif`. */
|
||||
src?: string
|
||||
/** Titre. Defaut : i18n `common.comingSoon.title`. */
|
||||
title?: string
|
||||
/** Sous-titre. Defaut : i18n `common.comingSoon.subtitle`. */
|
||||
subtitle?: string
|
||||
}>(),
|
||||
{
|
||||
src: '/coming-soon.gif',
|
||||
title: '',
|
||||
subtitle: '',
|
||||
},
|
||||
)
|
||||
|
||||
const { t } = useI18n()
|
||||
const imageFailed = ref(false)
|
||||
|
||||
// Les props priment sur les libelles i18n par defaut (permet a un module
|
||||
// d'override le texte sans toucher au composant).
|
||||
const resolvedTitle = computed(() => props.title || t('common.comingSoon.title'))
|
||||
const resolvedSubtitle = computed(() => props.subtitle || t('common.comingSoon.subtitle'))
|
||||
</script>
|
||||
@@ -0,0 +1,132 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import {
|
||||
useAddressAutocomplete,
|
||||
AddressAutocompleteUnavailableError,
|
||||
} from '../useAddressAutocomplete'
|
||||
|
||||
// On mocke le helper d'appel externe : aucun vrai appel reseau a la BAN.
|
||||
// vi.mock est hoiste par Vitest au-dessus des imports.
|
||||
const mockHttp = vi.hoisted(() => vi.fn())
|
||||
vi.mock('~/shared/utils/httpExternal', () => ({ httpExternal: mockHttp }))
|
||||
|
||||
const BAN_URL = 'https://api-adresse.data.gouv.fr/search/'
|
||||
|
||||
describe('useAddressAutocomplete', () => {
|
||||
beforeEach(() => {
|
||||
mockHttp.mockReset()
|
||||
})
|
||||
|
||||
describe('searchCity', () => {
|
||||
it('interroge la BAN en type=municipality et mappe { city, postalCode }', async () => {
|
||||
mockHttp.mockResolvedValueOnce({
|
||||
type: 'FeatureCollection',
|
||||
features: [
|
||||
{ properties: { city: 'Amiens', postcode: '80000', name: 'Amiens', type: 'municipality' } },
|
||||
{ properties: { city: 'Amiens', postcode: '80080', name: 'Amiens', type: 'municipality' } },
|
||||
],
|
||||
})
|
||||
|
||||
const { searchCity } = useAddressAutocomplete()
|
||||
const res = await searchCity('80000')
|
||||
|
||||
expect(mockHttp).toHaveBeenCalledWith(
|
||||
BAN_URL,
|
||||
expect.objectContaining({ query: { q: '80000', type: 'municipality' } }),
|
||||
)
|
||||
expect(res).toEqual([
|
||||
{ city: 'Amiens', postalCode: '80000' },
|
||||
{ city: 'Amiens', postalCode: '80080' },
|
||||
])
|
||||
})
|
||||
|
||||
it('throw une AddressAutocompleteUnavailableError sur erreur reseau / 5xx', async () => {
|
||||
mockHttp.mockRejectedValueOnce(new Error('500 Server Error'))
|
||||
|
||||
const { searchCity } = useAddressAutocomplete()
|
||||
|
||||
await expect(searchCity('80000')).rejects.toBeInstanceOf(AddressAutocompleteUnavailableError)
|
||||
})
|
||||
|
||||
it('throw une AddressAutocompleteUnavailableError sur timeout', async () => {
|
||||
mockHttp.mockRejectedValueOnce(new Error('The operation was aborted due to timeout'))
|
||||
|
||||
const { searchCity } = useAddressAutocomplete()
|
||||
|
||||
await expect(searchCity('80000')).rejects.toBeInstanceOf(AddressAutocompleteUnavailableError)
|
||||
})
|
||||
})
|
||||
|
||||
describe('searchAddress', () => {
|
||||
it('interroge la BAN avec postcode et mappe la suggestion', async () => {
|
||||
mockHttp.mockResolvedValueOnce({
|
||||
type: 'FeatureCollection',
|
||||
features: [
|
||||
{
|
||||
properties: {
|
||||
label: '8 Boulevard du Port 80000 Amiens',
|
||||
name: '8 Boulevard du Port',
|
||||
street: 'Boulevard du Port',
|
||||
postcode: '80000',
|
||||
city: 'Amiens',
|
||||
type: 'housenumber',
|
||||
},
|
||||
},
|
||||
],
|
||||
})
|
||||
|
||||
const { searchAddress } = useAddressAutocomplete()
|
||||
const res = await searchAddress('8 boulevard du port', '80000')
|
||||
|
||||
expect(mockHttp).toHaveBeenCalledWith(
|
||||
BAN_URL,
|
||||
expect.objectContaining({
|
||||
query: { q: '8 boulevard du port', postcode: '80000' },
|
||||
}),
|
||||
)
|
||||
expect(res).toEqual([
|
||||
{
|
||||
label: '8 Boulevard du Port 80000 Amiens',
|
||||
street: '8 Boulevard du Port',
|
||||
postalCode: '80000',
|
||||
city: 'Amiens',
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it('omet le parametre postcode quand aucun code postal n\'est fourni', async () => {
|
||||
mockHttp.mockResolvedValueOnce({ type: 'FeatureCollection', features: [] })
|
||||
|
||||
const { searchAddress } = useAddressAutocomplete()
|
||||
await searchAddress('8 boulevard du port')
|
||||
|
||||
expect(mockHttp).toHaveBeenCalledWith(
|
||||
BAN_URL,
|
||||
expect.objectContaining({
|
||||
query: { q: '8 boulevard du port' },
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('ne restreint PAS la recherche a type=housenumber (sinon la BAN ne renvoie rien tant qu\'aucun numero n\'est saisi)', async () => {
|
||||
// Regression : avec `type=housenumber`, une saisie de nom de rue sans
|
||||
// numero (ex: « boulevard du port ») renvoie 0 resultat cote BAN.
|
||||
mockHttp.mockResolvedValueOnce({ type: 'FeatureCollection', features: [] })
|
||||
|
||||
const { searchAddress } = useAddressAutocomplete()
|
||||
await searchAddress('boulevard du port', '80000')
|
||||
|
||||
const sentQuery = mockHttp.mock.calls[0]?.[1]?.query as Record<string, string>
|
||||
expect(sentQuery.type).toBeUndefined()
|
||||
})
|
||||
|
||||
it('throw une AddressAutocompleteUnavailableError sur erreur reseau', async () => {
|
||||
mockHttp.mockRejectedValueOnce(new Error('network down'))
|
||||
|
||||
const { searchAddress } = useAddressAutocomplete()
|
||||
|
||||
await expect(searchAddress('8 boulevard du port', '80000')).rejects.toBeInstanceOf(
|
||||
AddressAutocompleteUnavailableError,
|
||||
)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,27 +1,29 @@
|
||||
// STUB ERP-63 — remplacé par l'implémentation BAN d'ERP-66.
|
||||
import { httpExternal } from '~/shared/utils/httpExternal'
|
||||
|
||||
// Autocompletion d'adresse branchee sur la Base Adresse Nationale (BAN),
|
||||
// `api-adresse.data.gouv.fr` — service public francais, gratuit, CORS ouvert.
|
||||
//
|
||||
// Ce fichier appartient fonctionnellement à ERP-66 (#66). ERP-63 n'en livre
|
||||
// qu'un STUB pour ne pas se bloquer : la vraie implémentation (appels
|
||||
// api-adresse.data.gouv.fr) viendra remplacer le CORPS des deux méthodes SANS
|
||||
// changer leur signature ni l'usage côté composant.
|
||||
// Appel HTTP DIRECT depuis le front (pas de proxy back), conformement a la spec
|
||||
// M1 (§ API adresse postale). On passe par `httpExternal` et NON `useApi()` :
|
||||
// la BAN est un domaine externe, sans cookie de session ni enveloppe Hydra.
|
||||
//
|
||||
// Contrat figé par ERP-66 (c'est lui qui fait foi) :
|
||||
// Contrat (fige) :
|
||||
// searchCity(postalCode) -> liste { city, postalCode }
|
||||
// searchAddress(query, cp?) -> liste { label, street, postalCode, city }
|
||||
// En cas d'erreur/timeout, la méthode THROW. Le composant catch l'erreur,
|
||||
// affiche un toast d'avertissement et bascule en saisie libre (MalioInputText).
|
||||
//
|
||||
// Comportement du stub : les deux méthodes throw systématiquement → l'onglet
|
||||
// Adresse part directement en mode dégradé (Ville + Adresse en saisie libre,
|
||||
// Code postal saisi manuellement). Aucun appel réseau n'est émis ici.
|
||||
// En cas d'erreur/timeout, la methode THROW une AddressAutocompleteUnavailableError.
|
||||
// Le composant consommateur catch, affiche un toast d'avertissement et bascule
|
||||
// en saisie libre (MalioInputText).
|
||||
|
||||
/** Une suggestion de ville renvoyée à partir d'un code postal. */
|
||||
/** URL de l'endpoint de recherche BAN. */
|
||||
const BAN_SEARCH_URL = 'https://api-adresse.data.gouv.fr/search/'
|
||||
|
||||
/** Une suggestion de ville renvoyee a partir d'un code postal. */
|
||||
export interface CitySuggestion {
|
||||
city: string
|
||||
postalCode: string
|
||||
}
|
||||
|
||||
/** Une suggestion d'adresse complète (saisie assistée du champ « Adresse »). */
|
||||
/** Une suggestion d'adresse complete (saisie assistee du champ « Adresse »). */
|
||||
export interface AddressSuggestion {
|
||||
label: string
|
||||
street: string
|
||||
@@ -34,27 +36,82 @@ export interface AddressAutocomplete {
|
||||
searchAddress(query: string, postalCode?: string): Promise<AddressSuggestion[]>
|
||||
}
|
||||
|
||||
/** Erreur signalant que le service d'autocomplétion BAN n'est pas disponible. */
|
||||
/** Erreur signalant que le service d'autocompletion BAN n'est pas disponible. */
|
||||
export class AddressAutocompleteUnavailableError extends Error {
|
||||
constructor() {
|
||||
// Message technique (non affiché tel quel) : le composant remonte son
|
||||
// propre libellé i18n. Sert au debug / aux logs uniquement.
|
||||
super('Address autocomplete (BAN) is not available yet — ERP-66 stub.')
|
||||
// Message technique (non affiche tel quel) : le composant remonte son
|
||||
// propre libelle i18n. Sert au debug / aux logs uniquement.
|
||||
super('Address autocomplete (BAN) is not available.')
|
||||
this.name = 'AddressAutocompleteUnavailableError'
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* STUB : renvoie un composable conforme au contrat ERP-66 dont les méthodes
|
||||
* échouent toujours, forçant le mode dégradé côté onglet Adresse.
|
||||
*/
|
||||
/** Proprietes d'une « feature » GeoJSON renvoyee par la BAN (champs utilises). */
|
||||
interface BanFeatureProperties {
|
||||
label?: string
|
||||
name?: string
|
||||
street?: string
|
||||
postcode?: string
|
||||
city?: string
|
||||
}
|
||||
|
||||
/** Reponse GeoJSON FeatureCollection de la BAN. */
|
||||
interface BanResponse {
|
||||
features?: { properties?: BanFeatureProperties }[]
|
||||
}
|
||||
|
||||
export function useAddressAutocomplete(): AddressAutocomplete {
|
||||
return {
|
||||
async searchCity(_postalCode: string): Promise<CitySuggestion[]> {
|
||||
throw new AddressAutocompleteUnavailableError()
|
||||
async searchCity(postalCode: string): Promise<CitySuggestion[]> {
|
||||
let res: BanResponse
|
||||
try {
|
||||
res = await httpExternal<BanResponse>(BAN_SEARCH_URL, {
|
||||
query: { q: postalCode, type: 'municipality' },
|
||||
})
|
||||
} catch {
|
||||
// Reseau coupe, 5xx, timeout... -> mode degrade cote composant.
|
||||
throw new AddressAutocompleteUnavailableError()
|
||||
}
|
||||
|
||||
return (res.features ?? []).map((feature) => {
|
||||
const props = feature.properties ?? {}
|
||||
return {
|
||||
city: props.city ?? props.name ?? '',
|
||||
postalCode: props.postcode ?? '',
|
||||
}
|
||||
})
|
||||
},
|
||||
async searchAddress(_query: string, _postalCode?: string): Promise<AddressSuggestion[]> {
|
||||
throw new AddressAutocompleteUnavailableError()
|
||||
|
||||
async searchAddress(query: string, postalCode?: string): Promise<AddressSuggestion[]> {
|
||||
// IMPORTANT : pas de `type=housenumber` ici. La BAN ne renvoie un
|
||||
// resultat de ce type qu'une fois un numero saisi → une recherche par
|
||||
// nom de rue (« boulevard du port ») renverrait 0 resultat pendant
|
||||
// toute la frappe. Sans filtre `type`, la BAN classe rues + numeros
|
||||
// par pertinence (comportement d'autocompletion attendu).
|
||||
// On n'ajoute `postcode` que s'il est fourni (sinon recherche large).
|
||||
const banQuery: Record<string, string> = { q: query }
|
||||
if (postalCode) {
|
||||
banQuery.postcode = postalCode
|
||||
}
|
||||
|
||||
let res: BanResponse
|
||||
try {
|
||||
res = await httpExternal<BanResponse>(BAN_SEARCH_URL, { query: banQuery })
|
||||
} catch {
|
||||
throw new AddressAutocompleteUnavailableError()
|
||||
}
|
||||
|
||||
return (res.features ?? []).map((feature) => {
|
||||
const props = feature.properties ?? {}
|
||||
return {
|
||||
label: props.label ?? '',
|
||||
// `name` porte la ligne d'adresse complete (numero + voie) ;
|
||||
// `street` ne contient que la voie. On privilegie `name`.
|
||||
street: props.name ?? props.street ?? '',
|
||||
postalCode: props.postcode ?? '',
|
||||
city: props.city ?? '',
|
||||
}
|
||||
})
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
||||
import { httpExternal } from '../httpExternal'
|
||||
|
||||
// On mocke ofetch : httpExternal s'appuie sur $fetch sans jamais toucher le
|
||||
// reseau pendant les tests. vi.mock est hoiste par Vitest au-dessus des imports.
|
||||
const mockFetch = vi.hoisted(() => vi.fn())
|
||||
vi.mock('ofetch', () => ({ $fetch: mockFetch }))
|
||||
|
||||
describe('httpExternal', () => {
|
||||
beforeEach(() => {
|
||||
mockFetch.mockReset()
|
||||
})
|
||||
|
||||
it('retourne le JSON parse renvoye par $fetch', async () => {
|
||||
mockFetch.mockResolvedValueOnce({ ok: true })
|
||||
|
||||
const res = await httpExternal<{ ok: boolean }>('https://example.test/api')
|
||||
|
||||
expect(res).toEqual({ ok: true })
|
||||
})
|
||||
|
||||
it('transmet la query, coupe le cookie (credentials omit) et pose un timeout par defaut', async () => {
|
||||
mockFetch.mockResolvedValueOnce([])
|
||||
|
||||
await httpExternal('https://example.test/search', {
|
||||
query: { q: '80000', type: 'municipality' },
|
||||
})
|
||||
|
||||
expect(mockFetch).toHaveBeenCalledWith(
|
||||
'https://example.test/search',
|
||||
expect.objectContaining({
|
||||
query: { q: '80000', type: 'municipality' },
|
||||
credentials: 'omit',
|
||||
retry: 0,
|
||||
timeout: 5000,
|
||||
}),
|
||||
)
|
||||
})
|
||||
|
||||
it('permet de surcharger le timeout', async () => {
|
||||
mockFetch.mockResolvedValueOnce(null)
|
||||
|
||||
await httpExternal('https://example.test', { timeoutMs: 1000 })
|
||||
|
||||
expect(mockFetch).toHaveBeenCalledWith(
|
||||
'https://example.test',
|
||||
expect.objectContaining({ timeout: 1000 }),
|
||||
)
|
||||
})
|
||||
|
||||
it('propage l\'erreur reseau / timeout (throw)', async () => {
|
||||
mockFetch.mockRejectedValueOnce(new Error('network down'))
|
||||
|
||||
await expect(httpExternal('https://example.test')).rejects.toThrow('network down')
|
||||
})
|
||||
})
|
||||
@@ -20,4 +20,27 @@ describe('formatPhoneFR', () => {
|
||||
it('groupe par 2 meme un nombre impair de chiffres (dernier groupe seul)', () => {
|
||||
expect(formatPhoneFR('123')).toBe('12 3')
|
||||
})
|
||||
|
||||
it('formate une saisie courte (<= 4 chiffres) sans planter', () => {
|
||||
expect(formatPhoneFR('1')).toBe('1')
|
||||
expect(formatPhoneFR('12')).toBe('12')
|
||||
expect(formatPhoneFR('1234')).toBe('12 34')
|
||||
})
|
||||
|
||||
it('strip les caracteres non numeriques (lettres, espaces, ponctuation)', () => {
|
||||
expect(formatPhoneFR('abc')).toBe('')
|
||||
expect(formatPhoneFR('Tel : 06.12')).toBe('06 12')
|
||||
expect(formatPhoneFR(' 06 12 ')).toBe('06 12')
|
||||
})
|
||||
|
||||
it('conserve l\'indicatif international (+33) sans le transformer', () => {
|
||||
// Comportement fige : on retire seulement le `+`, on ne deduit pas le
|
||||
// prefixe pays. Le `+33...` est donc groupe brut par paquets de 2.
|
||||
expect(formatPhoneFR('+33612345678')).toBe('33 61 23 45 67 8')
|
||||
})
|
||||
|
||||
it('groupe sans tronquer une saisie plus longue que 10 chiffres', () => {
|
||||
// Aucune troncature silencieuse : on figure tous les chiffres groupes par 2.
|
||||
expect(formatPhoneFR('061234567899')).toBe('06 12 34 56 78 99')
|
||||
})
|
||||
})
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
import { $fetch } from 'ofetch'
|
||||
|
||||
/**
|
||||
* Options d'un appel HTTP externe.
|
||||
*/
|
||||
export interface HttpExternalOptions {
|
||||
/** Parametres de query string (encodes par ofetch). */
|
||||
query?: Record<string, string | number | undefined>
|
||||
/** Timeout en millisecondes avant abandon (defaut 5000). */
|
||||
timeoutMs?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Petit client HTTP pour les APIs PUBLIQUES EXTERNES (domaine tiers, hors `/api`).
|
||||
*
|
||||
* Pourquoi un helper dedie plutot que `useApi()` : `useApi()` est le client de
|
||||
* l'API interne Starseed (baseURL `/api`, cookie JWT `credentials: 'include'`,
|
||||
* parsing/erreurs Hydra, redirection `/login` sur 401, toasts i18n). Tout cela
|
||||
* est inadapte — voire indesirable — pour un endpoint public externe comme la
|
||||
* Base Adresse Nationale (`api-adresse.data.gouv.fr`).
|
||||
*
|
||||
* Ce helper est donc le SEUL point d'entree autorise pour un `$fetch` brut vers
|
||||
* l'externe (cf. regle frontend n°4 : pas de `$fetch` eparpille dans les
|
||||
* composants). Il :
|
||||
* - cible une URL absolue (pas de baseURL `/api`) ;
|
||||
* - n'envoie PAS le cookie de session (`credentials: 'omit'`) ;
|
||||
* - ne retente pas (`retry: 0`) et applique un timeout ;
|
||||
* - laisse remonter l'erreur (throw) — au consommateur de gerer le mode degrade.
|
||||
*/
|
||||
export async function httpExternal<T>(
|
||||
url: string,
|
||||
opts: HttpExternalOptions = {},
|
||||
): Promise<T> {
|
||||
return $fetch<T>(url, {
|
||||
query: opts.query,
|
||||
credentials: 'omit',
|
||||
retry: 0,
|
||||
timeout: opts.timeoutMs ?? 5000,
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user