Skip to content

v3.0.0

Latest
Latest

Choose a tag to compare

View all tags
@MayurBagwe MayurBagwe released this 28 Jul 13:22
· 78 commits to main since this release
v3.0.0
81194d9
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's Changed

Multi-event provider support

This release introduces support for multi-event providers. This enables multiple App Builder based Commerce extensions to connect to the same Adobe Commerce instance using isolated event providers. This isolation:

  • Prevents one application from overriding the event provider registered by another application.
  • Ensures that event subscriptions created by one application do not interfere with those created by another.

OpenTelemetry support

  • Integrate observability into App Builder actions.
  • Configure Grafana and New Relic with App Builder runtime actions.

Breaking Changes

  • The onboard script will no longer set the created event provider as the default; it will add it as a non-default event provider in the commerce instance.
  • The script now updates only the merchant_id, environment_id, and workspace_configuration in the commerce instance.
  • It also updates the .env file with BACKOFFICE_PROVIDER_ID and COMMERCE_PROVIDER_ID.
  • The EVENT_PREFIX environment variable needs to be updated.

Migration Guide

Users upgrading from v2.x should use the commerce-eventing 1.12.1 or higher

1. Code Changes

  • Added APIs to add and get event providers from the commerce instance in scripts/lib/commerce-eventing-api-client.js.
  • Enhanced the updateConfiguration API to update only merchant_id, environment_id, and workspace_configuration in the commerce instance. Previously, it also updated provider_id and instance_id, which is no longer supported.
  • Updated scripts/lib/event-subscribe.js to include EVENT_PREFIX and COMMERCE_PROVIDER_ID for each event during subscription.

2. Testing and Validation

  1. Event Testing

    • Test event generation and reception
    • Verify all subscribed events are being received
    • Check event payload structure matches expectations

  2. API Testing

    • Test all API endpoints used by your integration
    • Verify response formats and error handling
    • Test rate limiting and retry mechanisms

3. Rollback Plan

  1. Backup Configuration

    • Keep a backup of your current .env file
    • Save current API client configurations

  2. Rollback Steps

    • Revert to previous .env configuration
    • Revert to previous version v2.0.0 of integration-starter-kit

Support

If you encounter any issues during the migration:

  1. Check the documentation
  2. Review the updated README.md for new configuration options.
  3. Open an issue in the GitHub repository with detailed information about the problem
    For detailed migration instructions, please refer to the updated documentation in the README.md file.

Full Changelog: v2.0.0...v3.0.0

Assets 2
Loading