upgrade to headless v3.40

[bblaisATcoveo]

Upgrade to v3.39, Full regression tests to be performed since this is a major version upgrade

[Garneauma]

@bblaisATcoveo Pourrais-tu expliquer chaque changement dans connector.js? Il n'y en a pas beaucoup, mais étant nouveau au projet, je ne comprends pas pourquoi la plupart des changements ont été faits. Tu peux simplement ajouter à ton commentaire de PR une liste des changements et la raison associée. Merci!

[Garneauma]

@bblaisATcoveo Also, for next time, please include the headless file version in the header of the file. Thanks!

[bblaisATcoveo]

1- The latest version of headless does not require a call to getOrganizationEndpoints, and that method was removed from the framework completely. API Endpoints addresses are calculated inside the framework.
2- Endpoint addresses can still be overridden using a slightly different JSON config structure which was updated.
3- The requestContent.actionsHistory was now undefined some of the time and we had to address that issue in the preprocessRequest function

[BeraJosh]

Approved

[cfoss-coveo]

@GormFrank @Garneauma Replying here to this comment:

Salut Bertrand,

J'aimerais revenir à la PR suivante pour une question (le Headless) : upgrade to headless v3.40 by bblaisATcoveo · Pull Request #69 · ServiceCanada/search-ui

Je sais que M-A t'a demandé d'expliquer les changements au connector.js, mais au final la raison pourquoi il demande ça et ce qui est important pour nous de savoir, c'est s'il y a des breaking changes, c'est à dire des changements qui nous obligeraient d'aller modifier le HTML de nos pages de recherches dans AEM pour s'assurer qu'il n'y aura pas d'arrêt de fonctionnalité lors du déploiement.

Donc, crois-tu qu'il y a un breaking change? Par exemple, je vois le changement de endpoint, mais sur Canada.ca on spécifie le endpoint à travers le data-gc-search (regarde le view source de notre basic search page exemple : Basic search - Canada.ca); est-ce qu'il faut s'attendre à avoir à faire des changements ? On utilise pas le endpoints dans les pages d'exemples sur GitHub...
upgrade to headless v3.40 by bblaisATcoveo · Pull Request #69 · ServiceCanada/search-ui
Upgrade to v3.39, Full regression tests to be performed since this is a major version upgrade

The endpoint parameter for the top right Query Suggestion config is different that the endpoints (with an s) parameter updated here. endpoints is for full search pages and accepts and object, not a string.

You can keep the endpoint as-is. This doesn't affect it.

From what I can tell, the endpoints parameter is new, but to be safe you should double-check it's not configured in AEM .

If it is, you need to provide it with an object with this shape:

{
   ...,
   endpoints: {
      search: "....",
      analytics: "..."
   },
   ...
}

The endpoint.search and endpoint.analytics values are mapped to the corresponding proxyBaseUrl value when the Headless engine is initiated. This is documented on the Headless v2 to v3 upgrade guide:
https://docs.coveo.com/en/headless/latest/reference/documents/upgrade/v2-to-v3.html#organization-endpoints

So..., the long answer is you should be safe, but you should double check endpoints (with an s) is not in any of your AEM configurations. If it is, just make sure you're using the format above.

CC @bblaisATcoveo