Skip to content

InMemoryBackingStore restores detached child values after replacement or clear #901

Open

Description

Environment

  • Python 3.10.12, Linux
  • microsoft-kiota-abstractions 1.18.0, also reproduced from current main at 37b270459f391768df698142c741945365cd3191

Describe the bug

InMemoryBackingStore keeps subscriptions to nested models after their value is replaced or the store is cleared. A later edit to the detached model can restore the old object into the parent store. The replacement model is not subscribed when the property key already exists, so its edits do not mark the parent property changed after initialization is completed.

List replacement/removal has a related stale-subscription problem: removed items can mark their former parent property changed, and an item from a replaced list can restore the previous list.

To reproduce

from dataclasses import dataclass, field
from kiota_abstractions.store import BackedModel, InMemoryBackingStore

@dataclass
class Child(BackedModel):
    backing_store: InMemoryBackingStore = field(default_factory=InMemoryBackingStore)
    name: str = ''

store = InMemoryBackingStore()
old = Child(name='old')
current = Child(name='current')
store.set('child', old)
store.set('child', current)
store.is_initialization_completed = True
store.return_only_changed_values = True
current.name = 'current edited'
print('current child is tracked:', store.get('child') is current)
store.return_only_changed_values = False
old.name = 'detached edited'
print('detached child restored:', store.get('child') is old)
store.clear()
old.name = 'edited after clear'
print('clear remains empty:', store.enumerate_() == [])

Actual output on main:

current child is tracked: False
detached child restored: True
clear remains empty: False

Expected output:

current child is tracked: True
detached child restored: False
clear remains empty: True

The first result concerns the backing store's changed-value query, not an asserted HTTP serialization outcome. The second and third results also occur with return_only_changed_values=False.

Cause and candidate fix

The direct-model subscription is created only when the property key is absent, and its callback closes over the original model. List subscriptions have a stable parent/property ID, but subscriptions on removed child stores are never detached. clear() only clears the parent's values.

I have a local candidate that tracks child-store subscriptions per property, detaches obsolete subscriptions on replacement/clear, and checks the current value when a child notifies. It preserves subscriptions when a child is shared by two parents or by two keys.

Validation

  • Unmodified main's abstractions suite: 264 passed.
  • Added 18 focused cases: 16 fail on main and two pass as controls.
  • Candidate: all 282 abstractions tests pass, including replacement by a model/scalar/None/list, clear, removed list items, shared children, and repeated assignments.
  • mypy kiota_abstractions: passes for all 48 source files; changed production file passes configured pylint with warnings and an existing unsupported configuration-option diagnostic disabled; yapf and git diff --check pass.
  • Linux/Python 3.10 only. The four existing date-utils deprecation warnings remain. No claim that other Python versions or the full monorepo suites were run.

This is separate from #802's duplicate list subscriptions and stale list-size fixes; those changes are already present on the tested main. I also checked #800 and #139. Would a focused PR covering subscription replacement and cleanup be welcome?

Investigation and candidate fix developed with AI assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Needs Triage 🔍

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions