Skip to content

chore: pre-2.0 polish - storage-neutral wording and README gaps - #43

Merged
paullla merged 1 commit into
Locastic:masterfrom
paullla:chore/pre-2.0-polish
Jul 3, 2026
Merged

chore: pre-2.0 polish - storage-neutral wording and README gaps#43
paullla merged 1 commit into
Locastic:masterfrom
paullla:chore/pre-2.0-polish

Conversation

@paullla

@paullla paullla commented Jul 3, 2026

Copy link
Copy Markdown
Member
Q A
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Issues -
License MIT

Problem

Three small gaps left before tagging 2.0.0, all surfaced while validating the storage abstraction (#40) with a relational backend:

  1. locastic:activity-logs:create-loggable-indexes prints "Creating ... activity_log index" even when the aliased storage creates database tables
  2. The README system requirements omit Doctrine ORM 3.4+ / DoctrineBundle, required by composer.json since 1.2.0 (decision: the constraint stays; ORM 2 apps should upgrade)
  3. Nothing warns that maker-generated remove*() methods null the owning side, which makes LoggableChildInterface::logTo() return null during orphan removal, so the removal is silently never logged. This bit the demo app with stock generated code

Changes

  • Storage-neutral command output ("Creating ... activity log storage" / "Already exists, skipping."); the command name is unchanged
  • README system requirements list Doctrine ORM 3.4+ with DoctrineBundle 2.8+/3.x
  • README "Handling relations" section gains a warning with the exact maker-generated pattern to avoid and why
  • Genericized a stale "populate currentTracker data to elastic" docblock on the populate command

Verification

  • Full PHPUnit suite (25 tests, 55 assertions) green against Elasticsearch 9.0; PHPStan clean; PHP-CS-Fixer clean
  • Both demo commands (full flow + 13 edge-case checks) pass with this branch on Elasticsearch and on a Postgres storage adapter

- create-loggable-indexes output no longer says "index" (the storage
  may be a database table); command name unchanged
- README system requirements now list Doctrine ORM 3.4+ and
  DoctrineBundle, which composer.json has required since 1.2.0
- README warns that maker-generated remove methods null the owning
  side, which makes LoggableChildInterface::logTo() return null during
  orphan removal and silently drops the removal log
@paullla
paullla merged commit c6e722a into Locastic:master Jul 3, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant