Skip to content

Fail on Administration deprecations only in core's own tests

Fail on Administration deprecations only in core's own tests ​

INFO

This document represents an architecture decision record (ADR) and has been mirrored from the ADR section in our Shopware 6 repository. You can find the original version here

Context ​

Administration JavaScript deprecation guards are supposed to report every use of a deprecated Administration API through Shopware.Feature.triggerDeprecationOrThrow().

The Administration has deprecated usages it needs to fix on its own. Plugins get deprecations reported that they are not responsible for. If plugins have Jest tests, these fail and they need to wait for the Administration to fix them.

PR 21704 introduced a baseline, but existing setups need to migrate to the extension tooling's shared Jest setup underway in PR 21822.

Decision ​

Until core has migrated its own usages, a deprecation that is neither asserted, allowed, nor baselined fails a test only in the platform's own Jest run.

The console allow-list keeps its [Deprecation] entry until core is migrated.

Consequences ​

  • Extension Jest runs that reuse core's test setup no longer fail on deprecations that only core can fix. They also no longer fail on unasserted deprecations the extension could fix itself, although it should assert them. The running Administration, the @deprecated annotations, the release notes, and the upgrade notes still tell extension developers about them.
  • Extensions can still assert deprecations with toHaveTriggered() and test their own guards' throws with it.activeFeatureFlags().
  • Core's own Jest run is unchanged.

Exit plan ​

Once core's deprecation baseline is stable, remove isPlatformDeprecationRun(), its use in endDeprecationLog(), and the [Deprecation] entry of the console allow-list. Extension Jest runs then fail on unasserted deprecations too.

Extensions that cannot fix their deprecated uses yet will need to migrate to the new extension tooling and can baseline these deprecations explicitly then.

Was this page helpful?
UnsatisfiedSatisfied
Be the first to vote!
0.0 / 5  (0 votes)