Upgrade Instructions

This page describes any necessary changes when upgrading to the latest version of Packet Viewer. Please find the section that applies to your environment. If you do not see your upgrade path, please contact QA Cafe Support.

Any version before 1.5.0

Packet Viewer 1.5.0 improved the import path of the CSS file. Please update your import statement:

-import "@qacafe/pv-react/dist/main.css";
+import "@qacafe/pv-react/style.css";

Upgrading from 1.0

When upgrading from Packet Viewer 1.0 to anything newer, there are some breaking changes that must be addressed. There is no automatic migration at this time. Please observe the following changes:

1. Remove old React props

Remove the following props from your <PacketViewer> component instantiation if you had been using them:

  • enabledAnalysis: Additional analysis tools will be provided in future Views
  • enableProfileSwitching: The profile switcher is no longer optional
  • hideTitle: A title showing the file name is no longer part of the component
  • onClose: The component does not manage its own hide/show state anymore. Please control this from your application code

2. Add the new Stylesheet

Packet Viewer 1.1 and above ships with a separate CSS Stylesheet which needs to be imported into your applications environment. Packet Viewer will not render correctly without this addition. Packet Viewer 1.5 changed the name from dist/main.css to style.css.

import "@qacafe/pv-react/style.css";

If you’d like to further modify the style, please refer to the CSS variable reference for more information.

3. Deploy the updated service Docker

Packet Viewer v1.5.0 needs to connect to a Docker service version 1.5.0 or newer. Please update the backend service before upgrading the UI package. Version 1.5.0 and earlier require both the front-end and back-end to be on the same version.

Logging was upgraded in Packet Viewer v1.1 to output JSON structured logs to STDERR. View our logging documentation for more information and tips for viewing these logs.

4. Update your Health Check

Packet Viewer 1.1 and later has a new /api/health endpoint which should be used to monitor application health. Update any monitoring to point here instead of the previously recommended /api/docs endpoint.

The expected response is: 200 OK.