feat: add new safety onboarding

__tests__/core/findUserAddress.spec.js

+const xml2js = require('xml2js')
+const { errors } = require('cozy-konnector-libs')
+const { findUserAddress } = require('../../src/core/findUserAddress')
+
+const mockSoapRequest = jest.fn()
+jest.mock('easy-soap-request', () => async () => mockSoapRequest())
+
+jest.spyOn(xml2js, 'parseStringPromise').mockResolvedValue({
+  Envelope: {
+    Body: {
+      Fault: { detail: { erreur: { resultat: { $: { code: 401 } } } } },
+      faultstring: 'Mock error',
+    },
+  },
+})
+
+const mockParseUserPdl = jest.fn()
+jest.mock('../../src/helpers/parsing', () => ({
+  parseUserPdl: () => mockParseUserPdl(),
+}))
+
+const responseMock = {
+  response: {
+    body: 'mockedBody',
+  },
+}
+
+describe('findUserAddress', () => {
+  it('should throw LOGIN_FAIL if soapRequest fails', async () => {
+    mockSoapRequest.mockRejectedValueOnce('reject')
+    try {
+      await findUserAddress()
+      expect(true).toBe(false)
+    } catch (error) {
+      expect(error).toBe(errors.VENDOR_DOWN)
+    }
+  })
+
+  it('should return a correct pdl number', async () => {
+    mockSoapRequest.mockResolvedValue(responseMock)
+    mockParseUserPdl.mockResolvedValue('12345')
+
+    try {
+      await findUserAddress()
+      expect(true).toBe(false)
+    } catch (error) {
+      expect(error).toBe(errors.NOT_EXISTING_DIRECTORY)
+    }
+  })
+})

__tests__/core/findUserPdl.spec.js

@@ -26,12 +26,8 @@ const responseMock = {
 }
 
 describe('recherchePoint', () => {
-  it('should throw LOGIN_FAILED for too many responses', async () => {
-    mockSoapRequest.mockResolvedValue(responseMock)
-    mockParseUserPdl.mockImplementationOnce(() => {
-      throw new Error('Error')
-    })
-
+  it('should throw LOGIN_FAIL if soapRequest fails', async () => {
+    mockSoapRequest.mockRejectedValueOnce('reject')
     try {
       await findUserPdl()
       expect(true).toBe(false)
@@ -40,8 +36,17 @@ describe('recherchePoint', () => {
     }
   })
 
-  it('should throw LOGIN_FAIL if soapRequest fails', async () => {
-    mockSoapRequest.mockRejectedValueOnce('reject')
+  it('should return a correct pdl number', async () => {
+    mockSoapRequest.mockResolvedValueOnce(responseMock)
+    mockParseUserPdl.mockResolvedValueOnce('12345')
+
+    expect(await findUserPdl()).toBe('12345')
+  })
+
+  it('should handle issue on parsing', async () => {
+    mockSoapRequest.mockResolvedValueOnce(responseMock)
+    mockParseUserPdl.mockRejectedValue(new Error('Async error'))
+
     try {
       await findUserPdl()
       expect(true).toBe(false)
@@ -49,11 +54,4 @@ describe('recherchePoint', () => {
       expect(error).toBe(errors.LOGIN_FAILED)
     }
   })
-
-  it('should return a correct pdl number', async () => {
-    mockSoapRequest.mockResolvedValue(responseMock)
-    mockParseUserPdl.mockResolvedValue('12345')
-
-    expect(await findUserPdl()).toBe('12345')
-  })
 })

src/core/findUserAddress.js

+// @ts-check
+const { log, errors } = require('cozy-konnector-libs')
+const soapRequest = require('easy-soap-request')
+const {
+  parseTags,
+  parseValue,
+  parseUserAddress,
+} = require('../helpers/parsing')
+const xml2js = require('xml2js')
+const { consulterDonneesTechniquesContractuelles } = require('../requests/sge')
+
+/**
+ * Get user contract start date
+ * @param {string} url
+ * @param {string} apiAuthKey
+ * @param {string} userLogin
+ * @param {number} pointId
+ * @returns {Promise<Address>}
+ */
+async function findUserAddress(url, apiAuthKey, userLogin, pointId) {
+  log('info', 'Fetching user address')
+  const sgeHeaders = {
+    'Content-Type': 'text/xml;charset=UTF-8',
+    apikey: apiAuthKey,
+  }
+
+  const { response } = await soapRequest({
+    url: `${url}/enedis_SGE_ConsultationDonneesTechniquesContractuelles/1.0`,
+    headers: sgeHeaders,
+    xml: consulterDonneesTechniquesContractuelles(pointId, userLogin, false),
+  }).catch(err => {
+    log('error', 'Error while fetching user : ' + err)
+    throw errors.VENDOR_DOWN
+  })
+
+  const result = await xml2js.parseStringPromise(response.body, {
+    tagNameProcessors: [parseTags],
+    valueProcessors: [parseValue],
+    explicitArray: false,
+  })
+
+  try {
+    return parseUserAddress(result)
+  } catch (error) {
+    log('error', 'Error while processing user address: ' + error)
+    log(
+      'error',
+      `Enedis issue ${result.Envelope.Body.Fault.detail.erreur.resultat.$.code}: ${result.Envelope.Body.Fault.faultstring}`
+    )
+    throw errors.NOT_EXISTING_DIRECTORY
+  }
+}
+
+module.exports = { findUserAddress }

src/core/findUserPdl.js

@@ -22,7 +22,8 @@ async function findUserPdl(
   name,
   address,
   postalCode,
-  inseeCode
+  inseeCode,
+  escalierEtEtageEtAppartement = ''
 ) {
   log('info', 'Fetching user data')
   const sgeHeaders = {
@@ -33,7 +34,14 @@ async function findUserPdl(
   const { response } = await soapRequest({
     url: url,
     headers: sgeHeaders,
-    xml: rechercherPoint(appLogin, name, postalCode, inseeCode, address),
+    xml: rechercherPoint(
+      appLogin,
+      name,
+      postalCode,
+      inseeCode,
+      address,
+      escalierEtEtageEtAppartement
+    ),
   }).catch(err => {
     log('error', 'rechercherPointResponse')
     log('error', err)
@@ -50,13 +58,13 @@ async function findUserPdl(
     return parseUserPdl(parsedReply)
   } catch (error) {
     log('error', 'Error while parsing user PDL: ' + error)
+    console.log(error)
     if (parsedReply.Envelope.Body.Fault) {
       log(
         'error',
         `Enedis issue ${parsedReply.Envelope.Body.Fault.detail.erreur.resultat.$.code}: ${parsedReply.Envelope.Body.Fault.faultstring}`
       )
     }
-    throw errors.LOGIN_FAILED
   }
 }
 

src/core/index.js

@@ -4,6 +4,7 @@ const { terminateContract } = require('./contractTermination')
 const { verifyContract } = require('./contractVerification')
 const { findUserPdl } = require('./findUserPdl')
 const { verifyUserIdentity } = require('./verifyUserIdentity')
+const { findUserAddress } = require('./findUserAddress')
 
 module.exports = {
   activateContract,
@@ -12,4 +13,5 @@ module.exports = {
   verifyContract,
   findUserPdl,
   verifyUserIdentity,
+  findUserAddress,
 }

src/core/types/types.js

@@ -87,3 +87,19 @@
  * @property {number} consentId
  * @property {string} inseeCode
  */
+
+/**
+ * Address definition
+ * @typedef {object} Address
+ * @property {string} escalierEtEtageEtAppartement
+ * @property {string} numeroEtNomVoie
+ * @property {string} codePostal
+ * @property {Commune} commune
+ */
+
+/**
+ * Commune definition
+ * @typedef {object} Commune
+ * @property {{code: string}} $
+ * @property {string} libelle
+ */

src/core/verifyUserIdentity.js

@@ -2,6 +2,11 @@
 const { log, errors } = require('cozy-konnector-libs')
 const { findUserPdl } = require('./findUserPdl')
 const { getInseeCode } = require('../requests/insee')
+const { findUserAddress } = require('./findUserAddress')
+const {
+  removeMultipleSpaces,
+  removeAddressnumber,
+} = require('../helpers/parsing')
 
 /**
  * Verify user identity
@@ -26,7 +31,8 @@ async function verifyUserIdentity(
     inseeCode = await getInseeCode(fields.postalCode, fields.city)
   }
 
-  const pdl = await findUserPdl(
+  // First try with user adresse
+  let pdl = await findUserPdl(
     `${baseUrl}/enedis_SDE_recherche-point/1.0`,
     apiAuthKey,
     loginUtilisateur,
@@ -36,8 +42,50 @@ async function verifyUserIdentity(
     inseeCode
   )
 
+  if (!pdl) {
+    log('warn', 'Second change for sge onboarding')
+    // Backup verification
+    const userAddress = await findUserAddress(
+      baseUrl,
+      apiAuthKey,
+      loginUtilisateur,
+      fields.pointId
+    )
+
+    const escalierEtEtageEtAppartement = userAddress.escalierEtEtageEtAppartement
+      ? removeMultipleSpaces(userAddress.escalierEtEtageEtAppartement)
+      : ''
+
+    pdl = await findUserPdl(
+      `${baseUrl}/enedis_SDE_recherche-point/1.0`,
+      apiAuthKey,
+      loginUtilisateur,
+      fields.lastname,
+      removeMultipleSpaces(userAddress.numeroEtNomVoie),
+      userAddress.codePostal,
+      userAddress.commune.$.code,
+      escalierEtEtageEtAppartement
+    )
+
+    // Third try, remove address number because it's buggy on SGE side
+    if (!pdl) {
+      log('warn', 'Lastchance onboarding for sge')
+      pdl = await findUserPdl(
+        `${baseUrl}/enedis_SDE_recherche-point/1.0`,
+        apiAuthKey,
+        loginUtilisateur,
+        fields.lastname,
+        removeMultipleSpaces(removeAddressnumber(userAddress.numeroEtNomVoie)),
+        userAddress.codePostal,
+        userAddress.commune.$.code,
+        escalierEtEtageEtAppartement
+      )
+    }
+  }
+
   if (fields.pointId != pdl) {
     log('error', 'PointId does not match')
+
     if (isAlternateStart) {
       throw errors.TERMS_VERSION_MISMATCH
     } else {

src/helpers/parsing.js

@@ -29,6 +29,18 @@ function parseContractStartDate(result) {
     'dateDerniereModificationFormuleTarifaireAcheminement'
   ]
 }
+/**
+ * Return User address
+ * @param {string} result
+ * @returns {Address}
+ */
+function parseUserAddress(result) {
+  log('info', 'Parsing user Address')
+  const json = JSON.stringify(result)
+  return JSON.parse(json)['Envelope']['Body'][
+    'consulterDonneesTechniquesContractuellesResponse'
+  ]['point']['donneesGenerales']['adresseInstallation']
+}
 
 /**
  * Return User contract start date
@@ -127,6 +139,24 @@ function parseValue(value, name) {
   return value
 }
 
+/**
+ * Remove SGE useless multiple white spaces
+ * @param {string} str
+ * @returns {string}
+ */
+function removeMultipleSpaces(str) {
+  return str.replace(/  +/g, ' ')
+}
+
+/**
+ * Remove SGE useless multiple white spaces
+ * @param {string} str
+ * @returns {string}
+ */
+function removeAddressnumber(str) {
+  return str.replace(/[0-9]|b |B |T |t /g, '')
+}
+
 module.exports = {
   parseSgeXmlData,
   formateDataForDoctype,
@@ -136,5 +166,8 @@ module.exports = {
   parseContracts,
   parseContractStartDate,
   parseServiceId,
+  parseUserAddress,
   checkContractExists,
+  removeMultipleSpaces,
+  removeAddressnumber,
 }

src/requests/sge.js

@@ -102,7 +102,11 @@ function consultationMesuresDetailleesMaxPower(
  * @param {string} appLogin
  * @returns {string}
  */
-function consulterDonneesTechniquesContractuelles(pointId, appLogin) {
+function consulterDonneesTechniquesContractuelles(
+  pointId,
+  appLogin,
+  consent = true
+) {
   log('info', `Query consulterDonneesTechniquesContractuelles`)
   return `<?xml version='1.0' encoding='utf-8'?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
@@ -113,7 +117,7 @@ function consulterDonneesTechniquesContractuelles(pointId, appLogin) {
         <v2:consulterDonneesTechniquesContractuelles>
            <pointId>${pointId}</pointId>
            <loginUtilisateur>${appLogin}</loginUtilisateur>
-           <autorisationClient>true</autorisationClient>
+           <autorisationClient>${consent}</autorisationClient>
         </v2:consulterDonneesTechniquesContractuelles>
      </soapenv:Body>
   </soapenv:Envelope>
@@ -125,14 +129,45 @@ function consulterDonneesTechniquesContractuelles(pointId, appLogin) {
  * @param {string} name
  * @param {string} postalCode
  * @param {string} inseeCode
- * @param {string} [address]
+ * @param {string} address
+ * @param {string} [escalierEtEtageEtAppartement]
  * @returns {string} PDL
  */
-function rechercherPoint(appLogin, name, postalCode, inseeCode, address) {
+function rechercherPoint(
+  appLogin,
+  name,
+  postalCode,
+  inseeCode,
+  address,
+  escalierEtEtageEtAppartement
+) {
   log(
     'info',
     `Query rechercherPoint - postal code / insee code: ${postalCode} / ${inseeCode}`
   )
+  if (escalierEtEtageEtAppartement) {
+    return `<?xml version='1.0' encoding='utf-8'?>
+    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+       xmlns:v2="http://www.enedis.fr/sge/b2b/services/rechercherpoint/v2.0"
+       xmlns:v1="http://www.enedis.fr/sge/b2b/technique/v1.0">
+       <soapenv:Header/>
+       <soapenv:Body>
+          <v2:rechercherPoint>
+             <criteres>
+                <adresseInstallation>
+                   <escalierEtEtageEtAppartement>${escalierEtEtageEtAppartement}</escalierEtEtageEtAppartement>
+                   <numeroEtNomVoie>${address}</numeroEtNomVoie>
+                   <codePostal>${postalCode}</codePostal>
+                   <codeInseeCommune>${inseeCode}</codeInseeCommune>
+                </adresseInstallation>
+                <nomClientFinalOuDenominationSociale>${name}</nomClientFinalOuDenominationSociale>
+                <rechercheHorsPerimetre>true</rechercheHorsPerimetre>
+             </criteres>
+             <loginUtilisateur>${appLogin}</loginUtilisateur>
+          </v2:rechercherPoint>
+       </soapenv:Body>
+    </soapenv:Envelope>`
+  }
   return `<?xml version='1.0' encoding='utf-8'?>
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
      xmlns:v2="http://www.enedis.fr/sge/b2b/services/rechercherpoint/v2.0"