From 236b9cf8f263e4b18fa00d7fd87da4de8b97db56 Mon Sep 17 00:00:00 2001 From: Debora Crescenzo Date: Thu, 12 Feb 2026 15:27:41 +0000 Subject: [PATCH] MT#64432 Refactor Subscriber Phonebook Our nightly tests flagged the fact that the feature was unstable and unrealiable. Changes: * Extract subscriber phonebook api and state * Change direct use of http in the sub-phonebook method to use the relevant method in common.js * Simplify logic to PATCH single properties with a unique PUT in the Phonebook entry form * Amend getList, handleResponseError and put to allow use with API v2 endpoints * Amend translations and methods to replace "phonebook" with "phonebook entry" where necessary Change-Id: I189d45fe426a1ded400a251d7efdfa72f76f9061 (cherry picked from commit ff40864da0b46aa7e4b0525a98e0a335160022e5) --- src/api/common.js | 42 ++++++++- src/api/subscriber-phonebook.js | 60 +++++++++++++ src/api/subscriber.js | 82 +++-------------- src/i18n/de.json | 4 +- src/i18n/en.json | 4 +- src/i18n/es.json | 4 +- src/i18n/fr.json | 4 +- src/i18n/it.json | 4 +- src/pages/CscPageConversations.vue | 2 +- src/pages/CscPageSubscriberPhonebook.vue | 68 ++++++-------- src/pages/CscPageSubscriberPhonebookAdd.vue | 18 ++-- .../CscPageSubscriberPhonebookDetails.vue | 56 +++++------- src/store/index.js | 4 +- src/store/subscriber-phonebook.js | 90 +++++++++++++++++++ src/store/user.js | 69 ++------------ 15 files changed, 280 insertions(+), 231 deletions(-) create mode 100644 src/api/subscriber-phonebook.js create mode 100644 src/store/subscriber-phonebook.js diff --git a/src/api/common.js b/src/api/common.js index e6c5df0d..96da240a 100644 --- a/src/api/common.js +++ b/src/api/common.js @@ -6,7 +6,7 @@ import { getJsonBody } from 'src/api/utils' import { getJwt, hasJwt } from 'src/auth' import { PATH_CHANGE_PASSWORD } from 'src/router/routes' export const LIST_DEFAULT_PAGE = 1 -export const LIST_DEFAULT_ROWS = 24 +export const LIST_DEFAULT_ROWS = 20 export const LIST_ALL_ROWS = 1000 export const API_REQUEST_DEFAULT_TIMEOUT = 30000 @@ -128,7 +128,12 @@ export async function getList (options) { if (lastPage === 0) { lastPage = null } - let items = _.get(body, requestConfig.root, []) + + let items = requestConfig.root + // This gets the results for the API V1 which has the list in the root of the response, and if not found it tries to get it from the API V2 response format + ? _.get(body, requestConfig.root, []) + // This gets the results for the API V2 which has the list in the data field, and if not found it tries to get it from the root of the response (for backward compatibility with API V1) + : _.get(body, 'data', []) if (!Array.isArray(items)) { items = [items] } @@ -142,17 +147,45 @@ export async function getList (options) { } } +function extractMessages (messageArray) { + const messages = [] + if (Array.isArray(messageArray)) { + messageArray.forEach((item) => { + Object.keys(item).forEach((fieldName) => { + const fieldErrors = item[fieldName] + if (Array.isArray(fieldErrors)) { + fieldErrors.forEach((errorObject) => { + Object.values(errorObject).forEach((errorMsg) => { + messages.push(errorMsg) + }) + }) + } + }) + }) + } + return messages.join(', ') +} + function handleResponseError (err) { - const code = _.get(err, 'response.data.code', null) + let code = _.get(err, 'response.data.code', null) let message = _.get(err, 'response.data.message', null) + if (code === 403 && message === 'Invalid license') { message = i18n.global.t('Contact your administrator to activate this functionality') } + if (code === 403 && message === 'Password expired') { message = i18n.global.t('Password Expired') return this.$router?.push({ path: PATH_CHANGE_PASSWORD }) } + // API V2 returns an array of messages rather than a string + // and the code is available in the response status + if (Array.isArray(message)) { + message = extractMessages(message) + code = _.get(err, 'response.status', null) + } + if (code !== null && message !== null) { throw new ApiResponseError(code, message) } @@ -289,7 +322,8 @@ export async function put (options) { path = `api/${requestConfig.resource}/${requestConfig.resourceId}` } try { - const res = await httpApi.put(path, requestConfig.body, { + const payload = requestConfig.body || requestConfig.data + const res = await httpApi.put(path, payload, { headers: requestConfig.headers }) if (requestConfig.headers.Prefer === Prefer.representation) { diff --git a/src/api/subscriber-phonebook.js b/src/api/subscriber-phonebook.js new file mode 100644 index 00000000..79a50dae --- /dev/null +++ b/src/api/subscriber-phonebook.js @@ -0,0 +1,60 @@ +import { + del, + get, + getList, + patchReplace, + post, + putMinimal +} from 'src/api/common' + +export async function createPhonebook (data) { + const payload = { + name: data.name, + number: data.number, + shared: data.shared, + subscriber_id: Number(data.subscriber_id) + } + return post({ + path: `api/v2/subscribers/${data.subscriber_id}/phonebook`, + body: payload + }) +} + +export async function deleteEntry (subscriberId, entryId) { + return del({ + path: `api/v2/subscribers/${subscriberId}/phonebook/${entryId}` + }) +} + +export async function getEntryById (subscriberId, id) { + return get({ + path: `api/v2/subscribers/${subscriberId}/phonebook/${id}` + }) +} + +export async function getPhonebook (options) { + return getList({ + path: `api/v2/subscribers/${options.subscriber_id}/phonebook`, + params: options + }) +} + +export function setSharedValue (subscriberId, phonebookId, value) { + return patchReplace({ + path: `api/v2/subscribers/${subscriberId}/phonebook/${phonebookId}`, + fieldPath: 'shared', + value + }) +} + +export async function updateEntry (data) { + return putMinimal({ + path: `api/v2/subscribers/${data.subscriberId}/phonebook/${data.id}`, + body: { + number: data.number, + shared: data.shared, + name: data.name, + subscriber_id: Number(data.subscriberId) + } + }) +} diff --git a/src/api/subscriber.js b/src/api/subscriber.js index d8445296..a6986d4d 100644 --- a/src/api/subscriber.js +++ b/src/api/subscriber.js @@ -66,19 +66,6 @@ export async function setPreferenceCallBlocking (id, field, value) { await addPreference(id, field, value) } -export async function setPreferencePhonebook (id, field, value) { - if (value === undefined || value === null || value === '' || (Array.isArray(value) && !value.length)) { - await removePreferencePhonebook(id, field) - } else { - try { - await replacePreferencePhonebook(id, field, value) - } catch (err) { - if (err) { - throw err - } - } - } -} export async function setPreferencePhonebookCustomer (id, field, value) { if (value === undefined || value === null || value === '' || (Array.isArray(value) && !value.length)) { await removePreferencePhonebookCustomer(id, field) @@ -92,6 +79,7 @@ export async function setPreferencePhonebookCustomer (id, field, value) { } } } + export function getNcosLevels (options) { return new Promise((resolve, reject) => { const mergedOptions = _.merge(options || {}, { @@ -124,12 +112,7 @@ export async function removePreference (id, field) { fieldPath: field }) } -export async function removePreferencePhonebook (id, field) { - return await patchRemove({ - path: `api/subscriberphonebookentries/${id}`, - fieldPath: field - }) -} + export async function removePreferencePhonebookCustomer (id, field) { return await patchRemove({ path: `api/customerphonebookentries/${id}`, @@ -176,19 +159,7 @@ export function replacePreference (id, field, value) { }) }) } -export function replacePreferencePhonebook (id, field, value) { - return new Promise((resolve, reject) => { - patchReplace({ - path: `api/subscriberphonebookentries/${id}`, - fieldPath: field, - value - }).then(() => { - resolve() - }).catch((err) => { - reject(err) - }) - }) -} + export function replacePreferencePhonebookCustomer (id, field, value) { return new Promise((resolve, reject) => { patchReplace({ @@ -772,25 +743,7 @@ export async function getSubscriberRegistrations (options) { }) return list } -export async function getSubscriberPhonebook (options) { - let all = false - if (options.rows === 0) { - delete options.rows - delete options.page - all = true - } - if (!options.order_by) { - delete options.order_by - delete options.order_by_direction - } - options.include = 'all' - const list = await getList({ - resource: 'subscriberphonebookentries', - all, - params: options - }) - return list -} + export async function getCustomerPhonebook (options) { let all = false if (options.rows === 0) { @@ -809,14 +762,7 @@ export async function getCustomerPhonebook (options) { }) return list } -export async function createPhonebook (data) { - const payLoad = { - name: data.name, - number: data.number, - shared: data.shared - } - return await httpApi.post('api/subscriberphonebookentries/', payLoad) -} + export async function createCustomerPhonebook (data) { const payLoad = { name: data.name, @@ -837,20 +783,12 @@ export async function uploadCsv (context, formData) { config }) } -export function setValueShared (id, value) { - return setPreferencePhonebook(id, 'shared', value) -} -export function setValueName (id, value) { - return setPreferencePhonebook(id, 'name', value) +export function setValueNameCustomer (customerId, phonebookId, value) { + return setPreferencePhonebookCustomer(customerId, phonebookId, 'name', value) } -export function setValueNameCustomer (id, value) { - return setPreferencePhonebookCustomer(id, 'name', value) -} -export function setValueNumber (id, value) { - return setPreferencePhonebook(id, 'number', value) -} -export function setValueNumberCustomer (id, value) { - return setPreferencePhonebookCustomer(id, 'number', value) + +export function setValueNumberCustomer (customerId, phonebookId, value) { + return setPreferencePhonebookCustomer(customerId, phonebookId, 'number', value) } export async function getRecordingStream (fileId) { return await getAsBlob({ diff --git a/src/i18n/de.json b/src/i18n/de.json index a2ee9747..8c67de48 100644 --- a/src/i18n/de.json +++ b/src/i18n/de.json @@ -159,7 +159,7 @@ "Delete recording": "Aufnahme löschen", "Delete registered device": "Registriertes Gerät löschen", "Delete slot?": "Eintrag löschen?", - "Delete subscriber phonebook": "Telefonbuch des Teilnehmers löschen", + "Delete subscriber phonebook entry": "Telefonbucheintrag des Teilnehmers löschen", "Delete voicemail after email notification is delivered": "Voicemail nach dem Senden der E-Mail-Benachrichtigung löschen", "Deliver Incoming Faxes": "Eingehende Faxe zustellen", "Deliver Outgoing Faxes": "Ausgehende Faxe zustellen", @@ -623,7 +623,7 @@ "You are about to delete slot {slot}": "Sie sind dabei, den Eintrag {slot} zu löschen.", "You are about to delete this destination": "Sie sind dabei, dieses Ziel zu löschen.", "You are about to delete this forwarding": "Sie sind dabei, diese Weiterleitung zu löschen.", - "You are about to delete this phonebook": "Sie sind dabei, dieses Telefonbuch zu löschen.", + "You are about to delete this phonebook entry": "Sie sind dabei, diesen Telefonbucheintrag zu löschen.", "You are about to delete this registered device": "Sie sind dabei, dieses registrierte Gerät zu löschen.", "You are about to delete time range \"{from} - {to}\"": "Sie sind dabei, den Zeitraum „{from} - {to}“ zu entfernen.", "You are about to remove ACL: From email <{from_email}>": "Sie sind dabei, die ACL-Regel für die E-Mail-Adresse <{from_email}> zu entfernen.", diff --git a/src/i18n/en.json b/src/i18n/en.json index 29ab9593..337f9a3a 100644 --- a/src/i18n/en.json +++ b/src/i18n/en.json @@ -156,7 +156,7 @@ "Delete recording": "Delete recording", "Delete registered device": "Delete registered device", "Delete slot?": "Delete slot?", - "Delete subscriber phonebook": "Delete subscriber phonebook", + "Delete subscriber phonebook entry": "Delete subscriber phonebook entry", "Delete voicemail after email notification is delivered": "Delete voicemail after email notification is delivered", "Deliver Incoming Faxes": "Deliver Incoming Faxes", "Deliver Outgoing Faxes": "Deliver Outgoing Faxes", @@ -605,7 +605,7 @@ "You are about to delete slot {slot}": "You are about to delete slot {slot}", "You are about to delete this destination": "You are about to delete this destination", "You are about to delete this forwarding": "You are about to delete this forwarding", - "You are about to delete this phonebook": "You are about to delete this phonebook", + "You are about to delete this phonebook entry": "You are about to delete this phonebook entry", "You are about to delete this registered device": "You are about to delete this registered device", "You are about to delete time range \"{from} - {to}\"": "You are about to delete time range \"{from} - {to}\"", "You are about to remove ACL: From email <{from_email}>": "You are about to remove ACL: From email <{from_email}>", diff --git a/src/i18n/es.json b/src/i18n/es.json index 520aea32..e59f02ef 100644 --- a/src/i18n/es.json +++ b/src/i18n/es.json @@ -159,7 +159,7 @@ "Delete recording": "Eliminar grabación", "Delete registered device": "Eliminar dispositivo registrado", "Delete slot?": "¿Eliminar ranura?", - "Delete subscriber phonebook": "Eliminar agenda del suscriptor", + "Delete subscriber phonebook entry": "Eliminar la entrada de la agenda del abonado", "Delete voicemail after email notification is delivered": "Eliminar el correo de voz después de enviar la notificación por correo electrónico", "Deliver Incoming Faxes": "Entregar faxes entrantes", "Deliver Outgoing Faxes": "Entregar faxes salientes", @@ -627,7 +627,7 @@ "You are about to delete slot {slot}": "Está a punto de eliminar la ranura {slot}", "You are about to delete this destination": "Está a punto de eliminar este destino", "You are about to delete this forwarding": "Está a punto de eliminar este reenvío", - "You are about to delete this phonebook": "Está a punto de eliminar esta agenda", + "You are about to delete this phonebook entry": "Está a punto de eliminar esta entrada de la agenda", "You are about to delete this registered device": "Está a punto de eliminar este dispositivo registrado", "You are about to delete time range \"{from} - {to}\"": "Está a punto de borrar el rango de tiempo \"{from} - {to}\"", "You are about to remove ACL: From email <{from_email}>": "Está a punto de eliminar la ACL: Del correo electrónico <{from_email}>", diff --git a/src/i18n/fr.json b/src/i18n/fr.json index 73dae020..37608411 100644 --- a/src/i18n/fr.json +++ b/src/i18n/fr.json @@ -159,7 +159,7 @@ "Delete recording": "Supprimer l'enregistrement", "Delete registered device": "Supprimer l'appareil enregistré", "Delete slot?": "Supprimer emplacement ?", - "Delete subscriber phonebook": "Supprimer le répertoire de l'abonné", + "Delete subscriber phonebook entry": "Supprimer l’entrée du répertoire de l’abonné", "Delete voicemail after email notification is delivered": "Supprimer le message vocal une fois la notification e-mail délivrée", "Deliver Incoming Faxes": "Transmission des fax entrants", "Deliver Outgoing Faxes": "Livrer des fax sortants", @@ -623,7 +623,7 @@ "You are about to delete slot {slot}": "Vous êtes sur le point de supprimer l'emplacement {slot}", "You are about to delete this destination": "Vous êtes sur le point de supprimer cette destination", "You are about to delete this forwarding": "Vous êtes sur le point de supprimer cette redirection", - "You are about to delete this phonebook": "Vous êtes sur le point de supprimer ce répertoire téléphonique", + "You are about to delete this phonebook entry": "Vous êtes sur le point de supprimer cette entrée du répertoire", "You are about to delete this registered device": "Vous êtes sur le point de supprimer cet appareil enregistré", "You are about to delete time range \"{from} - {to}\"": "Vous êtes sur le point de supprimer la plage horaire \"{from} - {to}\"", "You are about to remove ACL: From email <{from_email}>": "Vous êtes sur le point de supprimer l'ACL : De l'e-mail <{from_email}>", diff --git a/src/i18n/it.json b/src/i18n/it.json index ce63c2ca..06be7338 100644 --- a/src/i18n/it.json +++ b/src/i18n/it.json @@ -157,7 +157,7 @@ "Delete recording": "Elimina registrazione", "Delete registered device": "Elimina dispositivo registrato", "Delete slot?": "Eliminare slot?", - "Delete subscriber phonebook": "Elimina rubrica abbonato", + "Delete subscriber phonebook entry": "Eliminare la voce della rubrica dell’abbonato", "Delete voicemail after email notification is delivered": "Cancella il messaggio vocale dopo l'invio della notifica email", "Deliver Incoming Faxes": "Consegna fax in arrivo", "Deliver Outgoing Faxes": "Consegna fax in uscita", @@ -613,7 +613,7 @@ "You are about to delete slot {slot}": "Stai per eliminare la postazione {slot}", "You are about to delete this destination": "Stai per eliminare questa destinazione", "You are about to delete this forwarding": "Stai per eliminare questo inoltro", - "You are about to delete this phonebook": "Stai per eliminare questa rubrica", + "You are about to delete this phonebook entry": "Stai per eliminare questa voce della rubrica", "You are about to delete this registered device": "Stai per eliminare questo dispositivo registrato", "You are about to delete time range \"{from} - {to}\"": "Stai per eliminare l'intervallo di tempo \"{from} - {to}\"", "You are about to remove ACL: From email <{from_email}>": "Stai per rimuovere ACL: Dall'email <{from_email}>", diff --git a/src/pages/CscPageConversations.vue b/src/pages/CscPageConversations.vue index 5ed5e895..2ae55c00 100644 --- a/src/pages/CscPageConversations.vue +++ b/src/pages/CscPageConversations.vue @@ -439,7 +439,7 @@ export default { await this.getVoicemailTranscript(voicemailId) }, addToPhonebookAction (number) { - this.$store.commit('user/setPhonebookNumber', number) + this.$store.commit('subscriber-phonebook/setNumber', number) this.$router.push('subscriber-phonebook/create') } } diff --git a/src/pages/CscPageSubscriberPhonebook.vue b/src/pages/CscPageSubscriberPhonebook.vue index a65f997e..594c9e59 100644 --- a/src/pages/CscPageSubscriberPhonebook.vue +++ b/src/pages/CscPageSubscriberPhonebook.vue @@ -64,8 +64,8 @@ v-model:pagination="pagination" class="no-shadow" :columns="columns" - :rows="subscriberPhonebook" - :loading="$wait.is('loadSubscriberPhonebook')" + :rows="phonebookRows" + :loading="$wait.is('loadPhonebook')" row-key="id" @request="fetchPaginatedRegistrations" > @@ -115,7 +115,7 @@ :label="$t('Delete')" data-cy="csc-phonebook-entry-delete" :disable="isLevelEntry(row.id)" - @click="deleteRow(row)" + @click="deleteRow(row.id)" /> { - await this.removeSubscriberPhonebook(row) + await this.removeEntry({ id: rowId, subscriberId: this.getSubscriberId }) await this.refresh() }) }, async toggleShared (row) { - await this.updateValueShared(row) + await this.updateSharedValue(row) }, isLevelEntry (id) { // Entries with composite Ids are considered "level entries", must not be modified (no edit or delete allowed) @@ -286,7 +277,7 @@ export default { openSeatTable () { this.$router.push('/user/seats') }, - applyFilter (filters) { + async applyFilter (filters) { this.filters = filters // Add wildcards to make search more extensive if (filters?.name) { @@ -296,14 +287,13 @@ export default { this.filters.number = `*${filters.number}*` } - this.pagination.page = 1 // Reset to first page on filter change - this.$scrollTo(this.$parent.$el) - const payload = this.filters - payload.page = 1 - payload.subscriber_id = this.getSubscriberId - - this.loadSubscriberPhonebook(payload) + await this.loadPhonebook({ + ...this.filters, + page: 1, + rows: this.pagination.rowsPerPage, + subscriber_id: this.getSubscriberId + }) }, closeFilters () { this.showFilters = false @@ -312,10 +302,10 @@ export default { openSearchFilters () { this.showFilters = true }, - resetFilters () { + async resetFilters () { if (this.hasFilters) { this.filters = {} - this.loadSubscriberPhonebook({ + await this.loadPhonebook({ page: this.pagination.page, rows: this.pagination.rowsPerPage, order_by: this.pagination.sortBy, diff --git a/src/pages/CscPageSubscriberPhonebookAdd.vue b/src/pages/CscPageSubscriberPhonebookAdd.vue index d67f384d..0b262fe7 100644 --- a/src/pages/CscPageSubscriberPhonebookAdd.vue +++ b/src/pages/CscPageSubscriberPhonebookAdd.vue @@ -107,7 +107,10 @@ export default { }, computed: { ...mapGetters('user', [ - 'prefilledNumber' + 'getSubscriberId' + ]), + ...mapGetters('subscriber-phonebook', [ + 'getPrefilledNumber' ]), nameErrorMessage () { const errorsTab = this.v$.formData.name.$errors @@ -120,14 +123,14 @@ export default { } }, mounted () { - if (this.prefilledNumber) { - this.formData.number = this.prefilledNumber - this.$store.commit('user/setPhonebookNumber', '') + if (this.getPrefilledNumber) { + this.formData.number = this.getPrefilledNumber + this.$store.commit('subscriber-phonebook/setNumber', '') } }, methods: { - ...mapWaitingActions('user', { - createPhonebookSubscriber: 'createPhonebookSubscriber' + ...mapWaitingActions('subscriber-phonebook', { + createPhonebook: 'createPhonebook' }), getDefaultFormData () { return { @@ -158,7 +161,8 @@ export default { }, async confirm () { try { - await this.createPhonebookSubscriber(this.formData) + this.formData.subscriber_id = this.getSubscriberId + await this.createPhonebook(this.formData) await this.$router.push('/user/subscriber-phonebook/') } catch (error) { if (error.response && error.response.status === 422) { diff --git a/src/pages/CscPageSubscriberPhonebookDetails.vue b/src/pages/CscPageSubscriberPhonebookDetails.vue index d9beb751..f21d740b 100644 --- a/src/pages/CscPageSubscriberPhonebookDetails.vue +++ b/src/pages/CscPageSubscriberPhonebookDetails.vue @@ -75,6 +75,7 @@