Library Releases and Versions

Yottaa ships new releases of its libraries when the libraries have key updates and when the numbered release of a library type progresses from one version to the next.

  • Library types: Monitor, Optimize, Protect, Service Worker

  • Library versions: Latest, Next, Untagged

Release Version Numbering

When a library is created, Yottaa assigns a new version number appropriate to the scope of the change being introduced.

Yottaa uses semantic versioning (SemVer) to guide the release number assignment. In this scheme, risk and functionality are the measures of significance. Breaking changes are indicated by increasing the major number (high risk); new, non-breaking features increment the minor number (medium risk); and all other non-breaking changes increment the patch number (lowest risk).

The release numbering scheme follows this pattern: Major.Minor.Patch.

Yottaa changes the major release number for:

  • Added market-noteworthy functionality

  • Rewrite of core library code

  • Updates to a substantial number of customer rule configurations

  • Removal of in-use functionality

  • Beta, or early adopter, program dependency

  • Any API changes that are not backward compatible

  • Example: 9.0.0

Yottaa changes the minor release number for:

  • Added features that support the current product offering

  • Removal of functionality that is not in use

  • Collection of new data points via RUM

  • API changes that are backward compatible

  • Example: 9.1.0

Yottaa changes the Patch release number for:

  • Bug patch that has very limited side effects

  • Security vulnerability fix

  • Example: 9.0.1

See the following sections for more information on numbered library releases, library types, and library versions.

For each new release, Yottaa publishes an updated JavaScript file for each library type that has updates. This action makes the new release features available to customers.

Some releases include updates to all the library types. Other releases might include updates for only one or two library types.

For example, release 7.5.4 has updates for the Optimize and Protect libraries, but not a new release of the Monitor library type. That's because the new features in 7.5.4 provide optimization and protection capabilities that are not supported for the Monitor library type.

Each library has both a type and a version.

The library type you use controls which Yottaa features are available. The types are Monitor, Optimize, Protect, and Service Worker.

Monitor Library

The Monitor library provides site data and analytics including an audit of third parties, performance metrics, core web vitals, violations, and anomalies. The Monitor tracks but does not optimize your site's performance.
Optimize Library

In addition to everything in the Monitor Library, this library offers performance optimization and application sequencing capabilities. It also contains APIs that allow developers to sequence applications based on time, element visibility, user events, and other criteria.
Protect Library

In addition to everything in the Optimize Library, this library provides security capabilities through Service Blocker and Rapid JavaScript Library. \

Yottaa transitioned the Journey Shield feature to End of Service status on April 1, 2024. Extension monitoring and blocking stopped on this date and the Journey Shield dashboard and configuration are no longer available.
Service Worker Library This library supports Yottaa's browser Cache Experience capability. If you have opted in to using Cache Experience on your site, the Service Worker Library appears in an additional section in the Library Management Slider.

The library version tells you where the library is in the library release progression. Sites can enroll to stay on a given version automatically with the automatic library version update feature.

Latest The Latestversion is generally available for broad customer use.
Next The Nextversion includes early access to upcoming features and functionality.
Untagged From time to time, Yottaa may release a library with no tag value, to provide custom functionality or access to experimental features.

As a Yottaa customer, you are signed up to run one of Yottaa's library types: Monitor, Optimize, or Protect. If you have opted in to using Cache Experience on your site, the Service Worker Library appears in an additional section in the Library Management Slider.

Manual Library Update

Updating your Yottaa library manually is similar to installing Yottaa for the first time. For details, see Installing or Updating Yottaa.

Automatic Library Upgrade

If you sign up for Automatic Library Upgrade, then each time Yottaa sends a new release to production with a designated version, Yottaa automatically updates your library to the version (Latest, Next, or Custom) that you normally run.

The table below lists the recent numbered Yottaa library releases with the key updates introduced in each release. Each release includes the features and functionality from the previous releases.

Yottaa sets the following standards for communicating with customers about library updates.

If a library version or tag value is changing:

  • Customers enrolled in automatic library upgrades will receive the latest release number and will be notified according to the major/minor/patch customer communication plan timeline in the table below.

  • Customers will receive additional details on automatic upgrades and engineering-related process.

If a new library is an untagged version (does not have a Latest or Next designation):

  • Yottaa Product Managers will tailor the communications to fit customers' information needs for that specific untagged library.

Yottaa will announce new library releases with:

  • In-product announcements

  • Email to customers

  • Updates to product documentation on library versions and releases

Best Practice: When a new library becomes live and available, Yottaa recommends that customers first test and validate it in a development environment (if available) prior to changing production sites.

Before Yottaa promotes a library from one version tag to the upcoming version tag, Yottaa ensures that the library meets the following standards.

The table below outlines the standards for promoting a library from one tag version to another.

Tag Version Change Release Version Change

Customer Notification Standard

From Next to Latest

Major

14 days

 

Minor

7 days

 

Patch

3 days

From Untagged to Next

Major

14 days

 

Minor

7 days

 

Patch

3 days

After Yottaa releases a library, engineering will only patch a previously released library if it has been tagged.

For example, 9.1.0 is tagged as Latest and 9.2.0 is tagged as Next. If a minor patch is needed, then the new versions will be 9.1.1 for Latest and 9.2.1 for Next.

Yottaa will support a library for 12 months. At the time of release, Yottaa will determine the End of Life (EOL) date. When a library is approaching EOL, a minimum of three months beforehand, Yottaa will begin communicating with customers about the upcoming EOL of the library.

The EOL of a library will be “soft”. At EOL, Yottaa will hide the library in the portal so that customers can no longer select it. Customer Support will encourage customers to upgrade to achieve better performance, more insights, and the other advantages that come with keeping your library current.

Yottaa has been reevaluating our product offerings and decided to discontinue Edge Acceleration Platform services, including our CDN, security, and proxy optimization tools, effective February 28, 2025. As part of this change, we are partnering with Fastly to provide continued CDN, WAF, and Image Optimization service. All sites currently using Edge Acceleration Platform, with a contract end date after February 28, 2025, will be migrated to Fastly’s network.We will ensure a smooth transition and coordinate migration plans with you if your contracted services extend beyond the end-of-service date.

For more information, please refer to Edge End-of-Service Date Is February 28, 2025 which includes a FAQ, or contact your Yottaa Account Manager.

The section below lists each library release, its date, and its major features, from the most recent back to the advent of libraries in November 2022.

Library Release

Release Date

 Description

8.2.4

September 2024

Key update in 8.2.4:

A patch update to improve Yottaa’s Revenue Tracking. Additional formats to the revenue field are now supported when GA4 is the data source. Previously, orders and revenue were not always counted when the format of revenue varied (for example, by using periods instead of commas).

8.2.1

July 2024

Key update in 8.2.1:

Automatic Shopify Checkout Extensibility Detection - Yottaa now automatically detects Shopify Checkout Extensibility and captures Yottaa’s RUM solution for Shopify Storefronts that have implemented Shopify's new checkout flow. This includes the ability to capture all RUM data, violations, and conversion related data that have previously been captured. After you update to the 8.2.1 library, you no longer need to a JavaScript snippet via Yottaa’s JavaScript injection rules, However, you do still need to create a custom pixel within Shopify Admin. RUM data collection will automatically when the custom pixel is activated. To learn more on this functionality, please contact support@yottaa.com.

8.1.0

May 2024

Key updates for 8.1.0:

Shopify Checkout Extensibility - Shopify Checkout Extensibility is now supported for Yottaa’s RUM solution. This includes the ability to utilize all RUM data, violations, and Revenue Insights that have previously been provided. Implementation includes creating a custom pixel within Shopify Admin and adding a JavaScript snippet via Yottaa’s JavaScript injection rules. In a future release, Yottaa’s JavaScript injection will be fully automated.

Cache Experience Data Layer Support - Cache Experience has the ability leverage data layers to dictate which pages should be placed in cache. This is especially helpful if a given site does not have a predictable URL structure for product listing and product detail pages.

Other items in this release include tracking service worker versions via Yottaa’s RUM call, better handling of multiple cache management calls when leveraging Cache Experience, enhanced caching for Cache Experience’s Cart Readiness, and code updates to support Journey Shield end of life.

8.0.3

April 2024

Note​​ Releases 8.0.3 and 8.0.2 are being released together as 8.0.3.

Key updates in 8.0.3:

Improved revenue tracking with Google Analytics and Adobe.

Bug fixes.

Key Updates for Monitor, Optimize, and Protect Libraries

These updates to 8.0.2 build on updates added in 8.0.0 and 8.0.1.

  • Improved revenue tracking with Google Analytics data layer and a fix to include the currency variable for Adobe Analytics data layer.

Bug Fixes

  • A bug has been fixed that was impacting menu functionality on mobile devices for a small number of sites.

  • A bug has been fixed in the Cache Experience feature that occurred when specifying versions of the Journey Cache object in a Journey Caching or Custom Cache rule.

  • A bug was fixed to improve the accuracy of Cumulative Layout Shift (CLS) and Time To Interactive (TTI) data for Single Page Applications (SPA) sites that are using release 8.0.1.

8.0.1

February 2024

No changes to the Monitor Library.

Key Updates for Optimize and Protect Libraries -

  • Cache Experience UI - You can now enable or disable Cache Experience, create caches, and manage caches in the Yottaa portal.

  • Navigation Interaction Cache Management Enhancement – Ability to match on full URL including query parameters for cache management purposes when leveraging the Total Experience Caching (TEC) API.

  • Adjusted Cache Experience Installation API – The Service Worker location you supply in the portal can now be a full URL, with or without a preceding slash.

It is important to update the Rapid+JS Client Library to work with the new Cache Experience portal and its supporting Service Worker Library APIs. If the Rapid+JS library is not updated, then the portal configuration options for Cache Experience will not work as intended.

Minor Updates

  • Bug fixes.

8.0.0

January 2024

Monitor Library -

  • Revenue Tracking – Collects revenue data to analyze the impact of site speed on revenue-related metrics.

Optimize Library -

Key Updates

  • Revenue Tracking – Collects revenue data to analyze the impact of site speed on revenue-related metrics.

  • Webworker for Images — Frees the main thread of images, to improve Core Web Vitals, by leveraging a webworker to load images called using createElement or Image browser objects..

  • Capturing HTMLImageElement.setAttribute Images — Provides the ability to capture and sequence images inserted using HTMLImageElement objects.

  • Yo.utils.console — New debugging tool available in the developer console that provides easy-to-use diagnostics that summarize the specific Yottaa optimizations that were executed and the performance data that was gathered for the current site page.

  • Prefetch Service Worker Support — In conjunction with our new Cache Experience product, this capability allows for easy management, within the web application, of service worker functionality such as install/uninstall, cache creation, and cache management. There is no need to interface directly with the service worker since this library has an API bridge.

Minor Updates

  • DelayObject for Cookie Optimization Testing – Helps with testing of XHR and DOM rules locally via yo-aftershock-config cookie.

  • Including Total Experience Caching (TEC) Library – The TEC library is the API layer between RapidJS and the Cache Experience service worker. By default, the TEC library will be included in the RapidJS library.

Protect Library -

  • Does not include a new release of the Protect library type.

7.5.4

October 2023

Monitor Library -

  • Does not include a new release of the Monitor library type.

Optimize Library -

  • Updates for Cache Experience capability.

  • Improvements to chaining and event sequencing.

  • Bug fixes.

Protect Library -

  • Updates for Cache Experience capability.

  • Improvements to chaining and event sequencing.

  • Bug fixes

Note Please contact Customer Support to use the 7.5.4 release of any library type.

7.5.3

September 2023

Monitor Library -

  • Integration of the DNS beacon endpoint with the upgraded DNS network.

  • Bug fixes.

Optimize Library -

  • Support for the Cache Experience capability.

  • Full support of Fetch API for sequencing and data requests.

  • Packaged Service Worker APIs.

  • Bug fixes.

Protect Library -

  • Support for the Cache Experience capability.

  • Full support of Fetch API for sequencing and data requests.

  • Packaged Service Worker APIs.

  • Bug fixes.

Note​​ The 7.5.3 library includes additional RUM metrics for the Prefetch feature, which is not fully supported in 7.5.3. Please contact Customer Support to use the 7.5.3 release of any library type.

7.5.0

August 2023

Monitor Library - Note​​ The 7.5.0 Monitor library includes additional RUM metrics for the Prefetch feature, which is not fully supported.

Optimize Library - Support for Prefetch, sequencing enhancements, and additional RUM metrics.

Protect Library - Support for Prefetch, sequencing enhancements, and additional RUM metrics.

Note​​ Please contact Customer Support to use any version of the 7.5.0 library.

7.2.9

June 2023

Monitor Library - General browser extension detection improvements and updates to detect the Capitol One browser extension.

Optimize Library - General browser extension detection improvements and updates to detect the Capitol One browser extension.

Protect Library - The Form Lock feature is now available. Form Lock secures form fields site-wide with a click of a button. General browser extension detection improvements and updates to detect the Capitol One browser extension.

7.2.8

April 2023

Monitor Library - No changes.

Optimize Library - Enhanced A/B testing provides the ability to persist the optimization state across sessions.

Protect Library - Enhanced A/B testing provides the ability to persist the optimization state across sessions.

7.2.7

March 2023

Monitor Library - Added support for the Amazon Assistant browser extension.

Optimize Library - No changes.

Protect Library - No changes.
7.2.6

February 2023

Monitor Library - Improved reporting on browser extensions and general. Bug fixes.

Optimize Library - No changes.

Protect Library - No changes.

7.2.5

February 2023

Monitor Library - Improved reporting on browser extensions. Bug fixes for collecting extension data.

Optimize Library - Introducing browser extension detection and blocking through Journey Shield on the Optimize library. Contact Customer Support to get started. General security improvements and bug fixes for collecting browser extension data.

Yottaa transitioned the Journey Shield feature to End of Service status on April 1, 2024. Extension monitoring and blocking stopped on this date and the Journey Shield dashboard and configuration are no longer available.

Protect Library - Bug fixes for collecting browser extension data.

7.1.4

November 2022

Monitor Library - Introducing browser extension detection through Journey Shield on the Monitor library.

Optimize Library - Improvements to application sequencing so third parties load more smoothly. Introducing advanced sequencing capabilities available through API.

Protect Library - Journey Shield now supports the detection of browser extensions on Safari. Same updates as Optimize library.

Check the following sections to see what is available and coming soon for your library type.

The table below summarizes the available versions and key updates if you use the Monitor library.

Library Release Library Version Release Notes

8.0.3

 

Latest

 

Note​​ Releases 8.0.3 and 8.0.2 are being released together as 8.0.3.

Key updates in the 8.0.3 Monitor library:

Improved revenue tracking with Google Analytics and Adobe.

Bug fixes.

The 8.0.2 Monitor library includes these changes:

These updates to 8.0.2 build on updates added in 8.0.0 and 8.0.1.

  • Improved revenue tracking with Google Analytics data layer and a fix to include the currency variable for Adobe Analytics data layer.

Bug Fixes

  • A bug has been fixed that was impacting menu functionality on mobile devices for a small number of sites.

  • A bug has been fixed in the Cache Experience feature that occurred when specifying versions of the Journey Cache object in a Journey Caching or Custom Cache rule.

  • A bug was fixed to improve the accuracy of Cumulative Layout Shift (CLS) and Time To Interactive (TTI) data for Single Page Applications (SPA) sites that are using release 8.0.1.

8.0.1

NA

No changes in the 8.0.1 Monitor Library.

8.0.0

NA

Monitor Library -

  • Revenue Tracking – Collects revenue data to analyze the impact of site speed on revenue-related metrics.

7.5.4

NA

Monitor Library -

  • Does not include a new release of the Monitor library type.
7.5.3 NA

The 7.5.3 Monitor library includes:

  • Integration of the DNS beacon endpoint with the upgraded DNS network.

  • Bug fixes.

Note​​ The 7.5.3 Monitor library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use the 7.5.3 release of the Monitor library.
7.5.0 NA Note​​ The 7.5.0 Monitor library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use this release of the Monitor library.

7.2.9

NA

General browser extension detection improvements and updates to detect the Capitol One browser extension.
7.2.6 Not available (legacy but still supported for existing customers) Improved reporting on browser extensions and general. Bug fixes.

The table below summarizes the available versions and key updates if you use the Optimize library.

Library Release Library Version Release Notes

8.0.3

 

Custom

 

Note​​ Releases 8.0.3 and 8.0.2 are being released together as 8.0.3.

Key updates in the 8.0.3 Optimize library:

Improved revenue tracking with Google Analytics and Adobe.

Bug fixes.

The 8.0.2 Optimize library includes these changes:

These updates to 8.0.2 build on updates added in 8.0.0 and 8.0.1.

  • Improved revenue tracking with Google Analytics data layer and a fix to include the currency variable for Adobe Analytics data layer.

Bug Fixes

  • A bug has been fixed that was impacting menu functionality on mobile devices for a small number of sites.

  • A bug has been fixed in the Cache Experience feature that occurred when specifying versions of the Journey Cache object in a Journey Caching or Custom Cache rule.

  • A bug was fixed to improve the accuracy of Cumulative Layout Shift (CLS) and Time To Interactive (TTI) data for Single Page Applications (SPA) sites that are using release 8.0.1.

8.0.1

Latest version as of March 4, 2024

The 8.0.1 Optimize Library includes these changes -

Key Updates

  • Cache Experience UI - You can now enable or disable Cache Experience, create caches, and manage caches in the Yottaa portal.

  • Navigation Interaction Cache Management Enhancement – Ability to match on full URL including query parameters for cache management purposes when leveraging the Total Experience Caching (TEC) API.

  • Adjusted Cache Experience Installation API – The Service Worker location you supply in the portal can now be a full URL, with or without a preceding slash.

It is important to update the Rapid+JS Client Library to work with the new Cache Experience portal and its supporting Service Worker Library APIs. If the Rapid+JS library is not updated, then the portal configuration options for Cache Experience will not work as intended.

Minor Updates

  • Bug fixes.

8.0.0

NA

The 8.0.0 Optimize Library includes:

Key Updates

  • Revenue Tracking – Collects revenue data to analyze the impact of site speed on revenue-related metrics.

  • Webworker for Images — Frees the main thread of images, to improve Core Web Vitals, by leveraging a webworker to load images called using createElement or Image browser objects..

  • Capturing HTMLImageElement.setAttribute Images — Provides the ability to capture and sequence images inserted using HTMLImageElement objects.

  • Yo.utils.console — New debugging tool available in the developer console that provides easy-to-use diagnostics that summarize the specific Yottaa optimizations that were executed and the performance data that was gathered for the current site page.

  • Prefetch Service Worker Support — In conjunction with our new Cache Experience product, this capability allows for easy management, within the web application, of service worker functionality such as install/uninstall, cache creation, and cache management. There is no need to interface directly with the service worker since this library has an API bridge.

Minor Updates

  • DelayObject for Cookie Optimization Testing – Added delayObject to help with testing of XHR and DOM rules locally.

  • Including TEC Library – By default the TEC Library (the API layer between RapidJS and the service worker) will be included in the RapidJS library.

  • Revenue Tracking – Collects revenue data to analyze the impact of site speed on revenue-related metrics.

7.5.4

NA

The 7.5.4 Optimize library includes:

  • Updates for Caching and Prefetch capability.

  • Improvements to chaining and event sequencing.

  • Bug fixes.

Note Please contact Customer Support to use the 7.5.4 release of the Optimize library.

7.5.3

NA

The 7.5.3 Optimize library includes:

  • Support for the Caching and Prefetch capability.

  • Full support of Fetch API for sequencing and data requests.

  • Packaged Service Worker APIs.

  • Bug fixes.

Note​​ The 7.5.3 Optimize library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use the 7.5.3 release of the Optimize library.
7.5.0 NA Note​​ The 7.5.3 Optimize Library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use this release of the Optimize library.

7.2.9

Next

General improvements to browser extension detection.

7.2.8

Custom

Enhanced A/B testing provides the ability to persist the optimization state across sessions.
7.2.5 Latest

Introducing browser extension detection and blocking through Journey Shield on the Optimize library. Contact Customer Support to get started. General security improvements and bug fixes for collecting browser extension data.

Yottaa transitioned the Journey Shield feature to End of Service status on April 1, 2024. Extension monitoring and blocking stopped on this date and the Journey Shield dashboard and configuration are no longer available.
7.1.4 Legacy but still available and supported. Improvements to application sequencing so third parties load more smoothly. Introducing advanced sequencing capabilities available through API.

The table below summarizes the available versions and key updates if you use the Protect library.

Library Release Library Version Release Notes

8.0.3

Custom

Note​​ Releases 8.0.3 and 8.0.2 are being released together as 8.0.3.

Key updates in the 8.0.3 Protect library:

Improved revenue tracking with Google Analytics and Adobe.

Bug fixes.

The 8.0.2 Protect library includes these changes:

These updates to 8.0.2 build on updates added in 8.0.0 and 8.0.1.

  • Improved revenue tracking with Google Analytics data layer and a fix to include the currency variable for Adobe Analytics data layer.

Bug Fixes

  • A bug has been fixed that was impacting menu functionality on mobile devices for a small number of sites.

  • A bug has been fixed in the Cache Experience feature that occurred when specifying versions of the Journey Cache object in a Journey Caching or Custom Cache rule.

  • A bug was fixed to improve the accuracy of Cumulative Layout Shift (CLS) and Time To Interactive (TTI) data for Single Page Applications (SPA) sites that are using release 8.0.1.

8.0.1

Latest version as of March 4, 2024

The 8.0.1 Protect Library includes these changes -

Key Updates

  • Cache Experience UI - You can now enable or disable Cache Experience, create caches, and manage caches in the Yottaa portal.

  • Navigation Interaction Cache Management Enhancement – Ability to match on full URL including query parameters for cache management purposes when leveraging the Total Experience Caching (TEC) API.

  • Adjusted Cache Experience Installation API – The Service Worker location you supply in the portal can now be a full URL, with or without a preceding slash.

It is important to update the Rapid+JS Client Library to work with the new Cache Experience portal and its supporting Service Worker Library APIs. If the Rapid+JS library is not updated, then the portal configuration options for Cache Experience will not work as intended.

Minor Updates

  • Bug fixes.

8.0.0

NA

Protect Library -

  • 8.0.0 does not include a new release of the Protect library type.

7.5.4

NA

The 7.5.4 Protect Library includes:

  • Updates for Caching and Prefetch capability.

  • Improvements to chaining and event sequencing.

  • Bug fixes.

Note Please contact Customer Support to use the 7.5.4 release of the Protect library.

7.5.3

NA

The 7.5.3 Protect library includes:

  • Support for the Caching and Prefetch capability.

  • Full support of Fetch API for sequencing and data requests.

  • Packaged Service Worker APIs.

  • Bug fixes.

Note​​ The 7.5.3 library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use the 7.5.3 release of the Protect library.
7.5.0 NA Note​​ The 7.5.0 Protect library includes additional RUM metrics for the Prefetch feature, which is not fully supported. Please contact Customer Support to use this release of the Protect library.
7.2.9 Next The Form Lock feature is now available. Form Lock secures form fields site-wide with a click of a button. General browser extension detection improvements and updates to detect the Capitol One browser extension.
7.2.8 Custom Enhanced A/B testing provides the ability to persist the optimization state across sessions.
7.2.5 Latest Bug fixes for collecting browser extension data.
7.1.4 Legacy but still available and supported.

Journey Shield now supports the detection of browser extensions on Safari. Improvements to application sequencing so third parties load more smoothly. Introducing advanced sequencing capabilities available through API.

Yottaa transitioned the Journey Shield feature to End of Service status on April 1, 2024. Extension monitoring and blocking stopped on this date and the Journey Shield dashboard and configuration are no longer available.

Holiday Code Freeze

Yottaa suspends all library releases during the holiday code freeze, which typically begins in late October and continues through early January. The specific dates are chosen each year depending on conditions at the time. Yottaa may publish a portal release in December if changes to the UI are necessary to keep the Yottaa portal current with evolving security requirements.