Upgrade 3.1.1-1-12561 to 3.2.0-beta1 => datamodel compilation issue with TeemIP

[Nicolas GRIMLER]

Hello all :)

I've tried to upgrade my currently running iTop 3.1.1-1-12561 (with a bunch of extensions from iTopHub) to the new v3.2.0-beta1 but face a lot of errors that makes iTop unusable (backend & portal).
Few basic pages are working (dashboards, users accounts list (but not profiles list), OQL query book ) but nearly all others are crashing with the following stack trace:

2024-07-05 20:03:09 | Error   | 4     | Uncaught TypeError: MetaModel::GetHilightClass(): Return value must be of type string, null returned in /var/www/html/deployment/iTop-3.2/core/metamodel.c
lass.php:3718
Stack trace:
#0 /var/www/html/deployment/iTop-3.2/sources/Controller/AjaxRenderController.php(120): MetaModel::GetHilightClass()
#1 /var/www/html/deployment/iTop-3.2/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php(619): Combodo\iTop\Controller\AjaxRenderController::GetDataForTable()
#2 /var/www/html/deployment/iTop-3.2/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php(80): Combodo\iTop\Application\UI\Base\Component\DataTable\DataTableUIBlockFactory
::MakeForRendering()
#3 /var/www/html/deployment/iTop-3.2/application/displayblock.class.inc.php(1453): Combodo\iTop\Application\UI\Base\Component\DataTable\DataTableUIBlockFactory::MakeForResult()
#4 /var/www/html/deployment/iTop-3.2/application/displayblock.class.inc.php(770): DisplayBlock->RenderList()
#5 /var/www/html/deployment/iTop-3.2/application/displayblock.class.inc.php(560): DisplayBlock->GetRenderContent()
#6 /var/www/html/deployment/iTop-3.2/pages/UI.php(193): DisplayBlock->GetDisplay()
#7 /var/www/html/deployment/iTop-3.2/pages/UI.php(540): DisplaySearchSet()
#8 {main}
  thrown | IssueLog |||
array (
  'type' => 1,
  'file' => '/var/www/html/deployment/iTop-3.2/core/metamodel.class.php',
  'line' => 3718,
)

Update of the installation was done following manual upgrade procedure (cleanup directories except config/, data/, env-production/, etc...) keeping the same database from 3.1.1-1-12561. Setup does not complains about anything and update correctly the datamodel & database accordingly.
For the reference, I deploy a Full ITIL setup for service providers.

I also tried different paths with different results:
From scratch :

• Empty database & only .zip content without extensions => OK everything works with demo data
• Installing the same extensions at the same time from iTopHub => KO compiling datamodel, setup complains about TeemIP network management extended:

Error loading module "teemip-network-mgmt-extended": /itop_design/classes/class[PhysicalInterface]/presentation/details/items/item[col:col1] at line 347: could not be found or marked as removed - Loaded modules: dictionaries:1.0, core:1.0, application:1.0, authent-cas:3.2.0, authent-external:3.2.0, authent-ldap:3.2.0, authent-local:3.2.0, combodo-autoclose-ticket:1.0.1, combodo-backoffice-darkmoon-theme:3.2.0, combodo-backoffice-fullmoon-high-contrast-theme:3.2.0, combodo-backoffice-fullmoon-protanopia-deuteranopia-theme:3.2.0, combodo-backoffice-fullmoon-tritanopia-theme:3.2.0, combodo-password-expiration:1.0.1, combodo-workflow-graphical-view:1.1.1, itop-attachments:3.2.0, itop-backup:3.2.0, itop-config:3.2.0, itop-data-collector-ldap:1.1.0, itop-data-collector-vsphere:1.2.0, itop-files-information:3.2.0, itop-object-copier:1.4.4, itop-portal-base:3.2.0, itop-portal:3.2.0, itop-profiles-itil:3.2.0, itop-sla-computation:3.2.0, itop-stencils:1.0.7, itop-structure:3.2.0, itop-themes-compat:3.2.0, itop-tickets:3.2.0, itop-welcome-itil:3.2.0, molkobain-fontawesome5-pack:1.5.1, molkobain-handy-framework:1.10.2, molkobain-newsroom-provider:1.5.0, authent-token:2.1.5, combodo-archive-manual:1.0.3, combodo-db-tools:3.2.0, combodo-webhook-integration:1.4.0, email-reply:1.4.4, itop-config-mgmt:3.2.0, itop-core-update:3.2.0, itop-datacenter-mgmt:3.2.0, itop-endusers-devices:3.2.0, itop-faq-light:3.2.0, itop-hub-connector:3.2.0, itop-incident-mgmt-itil:3.2.0, itop-knownerror-mgmt:3.2.0, itop-legacy-search-base:1.1.2, itop-oauth-client:3.2.0, itop-problem-mgmt:3.2.0, itop-request-mgmt-itil:3.2.0, itop-service-mgmt-provider:3.2.0, itop-storage-mgmt:3.2.0, itop-synchro-dashboard:1.2.2, itop-virtualization-mgmt:3.2.0, molkobain-console-tooltips:1.3.0, molkobain-datacenter-view:1.13.0, teemip-framework:3.1.4, teemip-network-mgmt:3.1.1, combodo-saml:1.1.4, combodo-sla-computation:2.4.2, itop-bridge-cmdb-services:3.2.0, itop-bridge-cmdb-ticket:3.2.0, itop-bridge-datacenter-mgmt-services:3.2.0, itop-bridge-endusers-devices-services:3.2.0, itop-bridge-storage-mgmt-services:3.2.0, itop-bridge-virtualization-mgmt-services:3.2.0, itop-bridge-virtualization-storage:3.2.0, itop-change-mgmt-itil:3.2.0, itop-communications:1.3.2, itop-full-itil:3.2.0, teemip-ip-mgmt:3.1.2, teemip-ipv6-mgmt:3.1.2, teemip-macaddress-lookup:3.1.1, teemip-webservices:3.0.0, teemip-zone-mgmt:3.1.1, combodo-coverage-windows-computation:2.1.1, teemip-network-mgmt-extended:3.1.2

• Installing all extensions except TeemIP related extensions => OK
• Adding TeemIP extensions one at a time => OK including network management extended !

Partial scratch:

• Database from 3.1.1-1-12561 with only .zip content and no extensions => complains about unknown classes (IPv4Address) at compilation

Partial scratch 2:

• Installing with an empty database (no demo data) and then deploying extensions one at a time => OK
• Restoring backup from 3.1.1-1-12561 and rerun setup to upgrade database schema to 3.2 => KO without error during setup but with errors on pages like the first upgrade attempt.

It seems that there is an issue in how the datamodel updates are processed for TeemIP that does not play well with the new datamodel.
From tests I've done, the workaround for the issue with TeemIP extensions installation is to install first [ IPAM + Zone management + MAC lookup ] and after [ Network management extended + cable management ] but all 5 extensions at the same time didn't work (compilation error on cable management). But this is only for a new iTop install, not the update as uninstalling extension is not really possible at this time (or I'm missing something??)

Updating right now is not possible, too bad as it would be much more easy to find issues with a "real" dataset 😜

Hope this will help 😜

If you need more details on my setup, feel free to ask !

Best Regards,
Nicolas.

[Nicolas GRIMLER]

If it can help @Combodo, here is the current 3.1 instance configuration:

===== begin =====
  iTopVersion: 3.1.1-1
  iTopBuild: 12561
  iTopBuildDate: 2023-12-19 10:53:23
  MySQLVersion: 10.11.5-MariaDB-1:10.11.5+maria~deb11
  PHPVersion: 8.1.28
  OSVersion: Linux
  WebServerVersion: Apache
  PHPModules: Core, date, libxml, openssl, pcre, zlib, filter, hash, json, Reflection, SPL, session, standard, cgi-fcgi, bcmath, bz2, calendar, ctype, curl, dom, mbstring, fileinfo, ftp, gd, gettext, iconv, imap, intl, ldap, exif, mysqlnd, PDO, pgsql, Phar, posix, shmop, SimpleXML, soap, sockets, sqlite3, sysvmsg, sysvsem, sysvshm, tokenizer, xml, xmlwriter, xsl, mcrypt, mysqli, pdo_mysql, pdo_pgsql, pdo_sqlite, xmlreader, xmlrpc, zip, apcu, imagick, mongodb, Zend OPcache
  ItopSetting/cron_max_execution_time: 600
  ItopSetting/timezone: Europe/Paris
  PHPSetting/memory_limit: 256M
  PHPSetting/max_execution_time: 120
  PHPSetting/upload_max_filesize: 48M
  PHPSetting/post_max_size: 49M
  MySQLSetting/max_allowed_packet: 268435456
  MySQLSetting/key_buffer_size: 134217728
  MySQLSetting/query_cache_size: 1048576
  MySQLStatus/Key_read_requests: 0
  MySQLStatus/Key_reads: 0
  InstallDate: 2024-06-15 18:12:20
  InstallPath: /var/www/html/deployment/iTop-3.1/
  ---- Installation choices ----
  InstalledExtension/itop-config-mgmt-core/3.1.1-1
  InstalledExtension/itop-config-mgmt-datacenter/3.1.1-1
  InstalledExtension/itop-config-mgmt-end-user/3.1.1-1
  InstalledExtension/itop-config-mgmt-storage/3.1.1-1
  InstalledExtension/itop-config-mgmt-virtualization/3.1.1-1
  InstalledExtension/itop-service-mgmt-service-provider/3.1.1-1
  InstalledExtension/itop-ticket-mgmt-itil-user-request/3.1.1-1
  InstalledExtension/itop-ticket-mgmt-itil-incident/3.1.1-1
  InstalledExtension/itop-ticket-mgmt-itil-enhanced-portal/3.1.1-1
  InstalledExtension/itop-ticket-mgmt-itil/3.1.1-1
  InstalledExtension/itop-change-mgmt-itil/3.1.1-1
  InstalledExtension/itop-kown-error-mgmt/3.1.1-1
  InstalledExtension/itop-problem-mgmt/3.1.1-1
  InstalledExtension/itop-data-collector-base/1.3.0 (Extension)
  InstalledExtension/itop-data-collector-vsphere/1.1.0 (Extension)
  InstalledExtension/combodo-saml/1.1.4 (iTop Hub)
  InstalledExtension/teemip-zone-mgmt/3.1.1 (iTop Hub)
  InstalledExtension/teemip-core-ip-mgmt/3.1.4 (iTop Hub)
  InstalledExtension/combodo-workflow-graphical-view/1.1.1 (iTop Hub)
  InstalledExtension/combodo-user-actions-configurator/1.4.4 (iTop Hub)
  InstalledExtension/teemip-macaddress-lookup/3.1.1 (iTop Hub)
  InstalledExtension/itop-communications/1.3.2 (iTop Hub)
  InstalledExtension/ldap-data-collector/1.3.0 (iTop Hub)
  InstalledExtension/combodo-archive-manual/1.0.3 (iTop Hub)
  InstalledExtension/combodo-data-synchronization-dashboard/1.2.2 (iTop Hub)
  InstalledExtension/combodo-configurator-for-automatic-object-creation/1.2.3 (iTop Hub)
  InstalledExtension/teemip-network-mgmt-extended/3.1.2 (iTop Hub)
  InstalledExtension/combodo-sla-considering-business-hours/2.3.2 (iTop Hub)
  InstalledExtension/combodo-data-collector-for-vsphere/1.2.0 (iTop Hub)
  InstalledExtension/molkobain-datacenter-view/1.13.0 (iTop Hub)
  InstalledExtension/teemip-cable-mgmt/1.2.0 (iTop Hub)
  InstalledExtension/combodo-send-updates-by-email/1.4.4 (iTop Hub)
  InstalledExtension/combodo-autoclose-ticket/1.0.1 (iTop Hub)
  ---- Actual modules installed ----
  InstalledModule/authent-cas: 3.1.1
  InstalledModule/authent-external: 3.1.1
  InstalledModule/authent-ldap: 3.1.1
  InstalledModule/authent-local: 3.1.1
  InstalledModule/combodo-autoclose-ticket: 1.0.1
  InstalledModule/combodo-backoffice-darkmoon-theme: 3.1.1
  InstalledModule/combodo-password-expiration: 1.0.1
  InstalledModule/combodo-workflow-graphical-view: 1.1.1
  InstalledModule/itop-attachments: 3.1.1
  InstalledModule/itop-backup: 3.1.1
  InstalledModule/itop-config: 3.1.1
  InstalledModule/itop-data-collector-ldap: 1.1.0
  InstalledModule/itop-data-collector-proxmox: 1.0.0
  InstalledModule/itop-data-collector-vsphere: 1.2.0
  InstalledModule/itop-files-information: 3.1.1
  InstalledModule/itop-object-copier: 1.4.4
  InstalledModule/itop-portal-base: 3.1.1
  InstalledModule/itop-portal: 3.1.1
  InstalledModule/itop-profiles-itil: 3.1.1
  InstalledModule/itop-sla-computation: 3.1.1
  InstalledModule/itop-stencils: 1.0.7
  InstalledModule/itop-structure: 3.1.1
  InstalledModule/itop-themes-compat: 3.1.1
  InstalledModule/itop-tickets: 3.1.1
  InstalledModule/itop-welcome-itil: 3.1.1
  InstalledModule/molkobain-fontawesome5-pack: 1.5.1
  InstalledModule/molkobain-handy-framework: 1.10.2
  InstalledModule/molkobain-newsroom-provider: 1.5.0
  InstalledModule/authent-token: 2.1.3
  InstalledModule/combodo-archive-manual: 1.0.3
  InstalledModule/combodo-db-tools: 3.1.1
  InstalledModule/email-reply: 1.4.4
  InstalledModule/itop-config-mgmt: 3.1.1
  InstalledModule/itop-core-update: 3.1.1
  InstalledModule/itop-datacenter-mgmt: 3.1.1
  InstalledModule/itop-endusers-devices: 3.1.1
  InstalledModule/itop-faq-light: 3.1.1
  InstalledModule/itop-hub-connector: 3.1.1
  InstalledModule/itop-incident-mgmt-itil: 3.1.1
  InstalledModule/itop-knownerror-mgmt: 3.1.1
  InstalledModule/itop-legacy-search-base: 1.1.2
  InstalledModule/itop-oauth-client: 3.1.1
  InstalledModule/itop-problem-mgmt: 3.1.1
  InstalledModule/itop-request-mgmt-itil: 3.1.1
  InstalledModule/itop-service-mgmt-provider: 3.1.1
  InstalledModule/itop-storage-mgmt: 3.1.1
  InstalledModule/itop-synchro-dashboard: 1.2.2
  InstalledModule/itop-virtualization-mgmt: 3.1.1
  InstalledModule/molkobain-console-tooltips: 1.3.0
  InstalledModule/molkobain-datacenter-view: 1.13.0
  InstalledModule/teemip-framework: 3.1.4
  InstalledModule/teemip-network-mgmt: 3.1.1
  InstalledModule/combodo-saml: 1.1.4
  InstalledModule/combodo-sla-computation: 2.4.2
  InstalledModule/combodo-webhook-integration: 1.3.2
  InstalledModule/itop-bridge-cmdb-services: 3.1.1
  InstalledModule/itop-bridge-cmdb-ticket: 3.1.1
  InstalledModule/itop-bridge-datacenter-mgmt-services: 3.1.1
  InstalledModule/itop-bridge-endusers-devices-services: 3.1.1
  InstalledModule/itop-bridge-storage-mgmt-services: 3.1.1
  InstalledModule/itop-bridge-virtualization-mgmt-services: 3.1.1
  InstalledModule/itop-bridge-virtualization-storage: 3.1.1
  InstalledModule/itop-change-mgmt-itil: 3.1.1
  InstalledModule/itop-communications: 1.3.2
  InstalledModule/itop-full-itil: 3.1.1
  InstalledModule/teemip-ip-mgmt: 3.1.2
  InstalledModule/teemip-ipv6-mgmt: 3.1.2
  InstalledModule/teemip-macaddress-lookup: 3.1.1
  InstalledModule/teemip-newsroom-provider: 1.1.2
  InstalledModule/teemip-webservices: 3.0.0
  InstalledModule/teemip-zone-mgmt: 3.1.1
  InstalledModule/combodo-coverage-windows-computation: 2.1.1
  InstalledModule/teemip-config-mgmt-adaptor: 3.1.1
  InstalledModule/teemip-datacenter-mgmt-adaptor: 3.1.1
  InstalledModule/teemip-endusers-devices-adaptor: 3.1.0
  InstalledModule/teemip-network-mgmt-extended: 3.1.2
  InstalledModule/teemip-storage-mgmt-adaptor: 3.1.0
  InstalledModule/teemip-virtualization-mgmt-adaptor: 3.1.2
  InstalledModule/teemip-bridge-virtualization-network-extended: 3.0.1
  InstalledModule/teemip-cable-mgmt: 1.2.0
  InstalledModule/teemip-bridge-datacenter-view-extended-cable: 1.1.0
  InstalledModule/teemip-bridge-network-extended-cable: 1.1.0
  ===== end =====

The 3.2 is on the same machine under a different apache vhost, so same php-fpm version, extensions are deployed from iTopHub for both instances (3.2 instance ID: 16E10)

[BenGrenoble]

Hello,

There is currently no version of TeemIP compatible with iTop 3.2 beta.
Also some of your extensions may not be compatible yet.

[Guillaume Lajarige]

Hello Nicolas,

FYI, you can find the list of compatible extensions so far on this page. :)