Migration

5 min

Services OIP mis à jour :

fasstech/oip-headless v1.1.0

Bibliothèques OIP mises à jour :

@fasstech/oip-core v4.1.0

@fasstech/oip-starter-utils v4.1.0

@fasstech/oip-tools v4.1.0

Bien que ces nouvelles versions n'introduisent pas de changements structurels, il est nécessaire de prendre connaissance des points ci-dessous.

Mise à jour des dépendances

Mettre à jour les dépendances OIP dans le fichier package.json de votre projet :

{
  "dependencies": {
    "@fasstech/oip-core": "4.1.0",
    "@fasstech/oip-starter-utils": "4.1.0"
  },
  "devDependencies": {
    "@fasstech/oip-tools": "4.1.0"
  }
}

Développement local - configuration de vite JS

Dans le fichier de configuration vite de votre projet, propriété de configuration server.proxy, assurez-vous de remplacer l'URL de l'entrée /graphqlwsurl par /ws-config :

import { defineConfig } from 'vite';

export default defineConfig(() => {
  // ...

  return {
    server: {
      proxy: {
        // before - /graphqlwsurl
        '/ws-config': {
          target: `http://localhost:${env.PORT}`,
          changeOrigin: true
        },
      },
    },
  };
});

Nouveaux headers X-Fasst-Project-ID et X-Fasst-Client-ID

La version v4.1.0 de la bibliothèque OIP Starter Utils introduit un nouvel header X-Fasst-Client-ID. Par ailleurs, le header HTTP fasst-oip-project-id est renommé X-Fasst-Project-ID. À noter que le header fasst-oip-project-id reste actif pour des raisons de rétrocompatibilité.

Cependant, afin d'éviter des erreurs éventuelles de type UNAUTHORIZED lors de la communication entre le serveur et l'application client, assurez-vous de prendre ces changements en compte selon les spécificités de votre projet et d'adapter toute logique personnalisée qui consomme directement ces headers.

Si vous utilisez l'option corsOptions.allowedHeaders de la fonction start de l'API serveur, assurez-vous d'ajouter les headers X-Fasst-Client-ID et X-Fasst-Project-ID à la liste.

Changement du schéma de l'objet de session

La version v4.1.0 de la bibliothèque OIP Starter Utils introduit un changement au niveau du schéma de l'objet sauvegardé en base de données qui représente la session utilisateur.

Après la mise à jour de la bibliothèque, il se peut que des erreurs de type UNAUTHORIZED se produisent lors de la communication entre le serveur et l'application client si des sessions ont persisté en base de données.

Afin d'éviter ces erreurs éventuelles, lors de la mise à jour de votre projet, il est recommandé de purger toutes les sessions utilisateur existantes en base de données.

[!TIP] Pour connaître le nom de la base de données utilisée pour la sauvegarde des sessions de votre projet, vous pouvez vous référer à la variable d'environnement SESSION_STORE_URL (table sessions par défaut).

Fichiers docker-compose.yml et les environnements Portainer (dev, recette, prod, etc.)

Mettre à jour le tag de l'image du service oip-headless-api en v1.1.0 :

services:
  oip-headless-api:
    image: fasstech/oip-headless:1.1.0
    # ...