mpt-extension-contrib-due-date

Shared order processing due-date helpers for SoftwareONE MPT extensions built on the Extension SDK. The library sets a maximum date by which an order must be processed and fails the order once that date passes, so orders never hang in processing forever.

It replaces the per-extension due-date logic previously re-implemented in the Adobe and FinOps extensions.

See AGENTS.md for the module documentation map.

Install

pip install mpt-extension-contrib-due-date

Requires the Extension SDK (mpt-extension-sdk >= 6.3, < 7), which is pulled in as a dependency.

Public API

mpt_extension_contrib.due_date exposes three pipeline steps and one settings contract:

Usage

Expose the due-date parameter external id in the extension settings:

from dataclasses import dataclass
from typing import Self, override

from mpt_extension_sdk.settings.extension import BaseExtensionSettings

from mpt_extension_contrib.due_date import DueDateSettings


@dataclass(frozen=True)
class ExtensionSettings(BaseExtensionSettings, DueDateSettings):
    due_date_parameter: str = "dueDate"

    @override
    @classmethod
    def load(cls) -> Self:
        return cls()

Add the steps to an order pipeline:

from mpt_extension_sdk.pipeline import BasePipeline, BaseStep

from mpt_extension_contrib.due_date import EnforceDueDate, ResetDueDate, SetDueDate


class PurchasePipeline(BasePipeline):
    @property
    def steps(self) -> list[BaseStep]:
        return [
            SetDueDate(days=14),  # assign the deadline on first run
            EnforceDueDate(),  # fail the order once the deadline passes
            # ... order processing steps ...
            ResetDueDate(),  # clear the deadline before completing
        ]

The steps read the parameter external id from context.ext_settings.due_date_parameter and the deadline length from SetDueDate(days=...).

EnforceDueDate does not fail the order itself: it records the intent on context.order_state.action and raises DueDateReachedError (a StopStepError subclass). Following the SDK pipeline-hooks contract, the order is failed by the extension's pipeline in an on_step_stopped / on_step_failed hook:

from mpt_extension_sdk.errors.step import StopStepError
from mpt_extension_sdk.pipeline import BasePipeline, OrderStatusActionType

from mpt_extension_contrib.due_date import DueDateReachedError


class OrderPipeline(BasePipeline):
    async def on_step_stopped(self, step, ctx, error: StopStepError) -> None:
        await super().on_step_stopped(step, ctx, error)
        action = ctx.order_state.action
        if action and not ctx.order_state.handled:
            if action.target_status == OrderStatusActionType.FAIL:
                await ctx.mpt_api_service.orders.fail(ctx.order_id, action.status_notes)
            ctx.order_state.handled = True

The hook above applies any declared action generically. When you need due-date-specific handling (a notification, a metric, a distinct status note), identify it by the exception type — isinstance(error, DueDateReachedError) — since several steps may raise StopStepError in the same pipeline.

Documentation

• Architecture
• Contributing
• Testing
• Releases