Rhythm 2.0 Specifications

Appearance

CAP-MBR-MEM-020Tell other applications when membership changes

Markdown

CAP-MBR-MEM-020

Tell other applications when membership changes

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationPartially observed

Planning

Feature
FEAT-MBR-MEM-07
Exercised by
FAS-MBR-MEM-07-01, FAS-MBR-MEM-07-03
Key concepts
CON-MBR-MEM-006, CON-MBR-MEM-002
Actors
ACT-MBR-012, ACT-MBR-011
Related
CAP-MBR-MEM-003, CAP-MBR-MEM-007, CAP-MBR-MEM-008
Open questions
OQ-MBR-MEM-005, OQ-MBR-MEM-006
Proved by
ATS-MBR-MEM-020

Implementation

Executable suites
TST-MBR-MEM-014, TST-MBR-MEM-015, TST-MBR-MEM-016, TST-MBR-MEM-035, TST-MBR-MEM-239

KindCapabilityProduct areaMembershipModuleMemberships, Applications and Membership BillingRevision1

Read atservices-membership 5994c270react-console baf6dae3

Tell other applications when membership changes ​

Purpose ​

Other applications act on membership. Committees ends a person's appointments when their membership ends, and others will follow. They must hear of each change reliably, without reading Membership's records themselves.

How It Works ​

Whenever Membership commits a change that matters to others, it states a business event in the same step. The changes are a term committed, restated, ended or cancelled, a chapter tie started or ended, a membership suspended or restored, and a unit moved in the tree. Each event names the membership, its program, its holder, its origin, and who made the change and how. A termination says the last day of rights and the first day without. A lapse found overnight is reported as a termination ending on the term's own last day. A minute-by-minute dispatcher delivers events at least once, unordered, each with a stable identifier. Committees is handed terminations only. A failed delivery is retried, and after five failures it is set aside with an alarm. Events are kept as Membership's own record. Imports and some automatic trims state no event. This behaviour was built after Andrew's acceptance of Membership and uses a delivery mechanism that differs from Rhythm's integration catalogue, so its intent is proposed. The product should also move memberships when CRM merges two people; today a merged-away person's memberships stay on the deleted record.

Relationships ​

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Committees can end a person's appointments when their membership ends.Any application can follow membership without reading Membership's records.
Surfaces
job
Constraints
An event's content is at most 8 KB.

Controls

34 controls apply, from the corpus control catalogue.

TC-AVL-002 TC-AVL-003 TC-AVL-004 TC-AZ-001 TC-AZ-003 TC-AZ-004 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-007 TC-IAM-006 TC-LOG-002 TC-LOG-003 TC-LOG-005 TC-MON-001 TC-MON-002 TC-MON-004 TC-PI-001 TC-PI-002 TC-PI-004 TC-PRV-001 TC-PRV-002 TC-SEC-001 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003

Business Rules

11 rules, 8 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Membership states nine business events (a term committed, restated, terminated or cancelled; an affiliation started or ended; a membership suspended or restored; a unit moved in the tree), each in the transaction of the write it describes, so an operation that rolls back states nothing and none is stated outside a transaction.
proved by ATS-MBR-MEM-004-07, ATS-MBR-MEM-006-19, ATS-MBR-MEM-014-16, ATS-MBR-MEM-020-01, ATS-MBR-MEM-020-09, ATS-MBR-MEM-020-11, ATS-MBR-MEM-020-12, ATS-MBR-MEM-020-13, ATS-MBR-MEM-020-17, TST-MBR-MEM-014
invariantservice, databasetest
services-membership:modules/events/tests/integration/business-events.integration.spec.ts#leaves no event when the operation that stated it rolls back
02must prove
Proposed
Every membership event names the membership, its program, whether a person or an organization holds it (the person only for a person's), its origin and parent, and the person, operation and source of the change.
proved by ATS-MBR-MEM-020-02, TST-MBR-MEM-014, TST-MBR-MEM-035
policyservicetest
services-membership:modules/memberships/tests/unit/membership-business-events.spec.ts#names an organization’s membership by its organization and no contact_id, whoever its primary contact is
03must prove
Proposed
A termination gives the last day of rights, the first day without and the reason; a lapse found by the nightly sweep is stated once as a termination ending on the term's own last day.
proved by ATS-MBR-MEM-003-13, ATS-MBR-MEM-005-12, ATS-MBR-MEM-013-17, ATS-MBR-MEM-020-03, ATS-MBR-MEM-020-08, ATS-MBR-MEM-020-10, ATS-MBR-MEM-020-16, TST-MBR-MEM-014, TST-MBR-MEM-035
calculationservicetest
services-membership:modules/events/tests/integration/business-events.integration.spec.ts#states membership.term.terminated once when the midnight sweep finds a term lapsed, with the term’s last day
04must prove
Proposed
A cancellation says whether it removed the membership along with the term.
proved by ATS-MBR-MEM-009-20, ATS-MBR-MEM-010-13, ATS-MBR-MEM-020-04, ATS-MBR-MEM-020-14, ATS-MBR-MEM-020-15
policyservicetest
services-membership:modules/memberships/tests/unit/membership-business-events.spec.ts#says whether a cancellation removed the membership
05must prove
Proposed
Each event's content is strict and versioned: an undeclared field, a date that is not a local date, an overlong id or a termination without its last day is refused.
proved by ATS-MBR-MEM-020-05, TST-MBR-MEM-016
validationservice, databasetest
services-membership:modules/events/tests/unit/business-event-schemas.spec.ts#refuses a termination that names no last day
06must prove
Proposed
Events are delivered at least once and in no guaranteed order, each with its own stable identifier; Committees is handed terminations alone, and other events are settled without calling it.
proved by ATS-MBR-MEM-020-06, TST-MBR-MEM-015, TST-MBR-MEM-239
policyservicetest
services-membership:modules/events/tests/integration/change-events-dispatch.integration.spec.ts#gives Committees the business event’s own id, so a redelivery names the same event
07must prove
Proposed
A delivery a receiver fails is retried, and after five failed attempts it is set aside for operators with an alarm.
proved by ATS-MBR-MEM-020-07, TST-MBR-MEM-015
lifecycleservicetest
services-membership:modules/events/tests/integration/change-events-dispatch.integration.spec.ts#reports a failure on the queue’s last receive too, which moves the message to the dead-letter queue
08
Proposed
When an environment names no Committees receiver, events are kept as Membership's record but delivered to no one.
policyservicetest
services-membership:modules/events/tests/unit/change-event-registry.spec.ts#registers no handler without the ARN, so the stream’s events are deleted as they are claimed
09
Proposed
Bulk imports, the trimming of affiliations to a corrected term, and the void of a never-committed term state no event.
policyservicedocumented
services-membership:docs/migrations/events/README.md#What could not be done as specified, and why
10must prove
Proposed
The product should move a merged-away contact's or organization's memberships to the surviving record when CRM merges two records.
no proof recorded yet
policyserviceunknown
FND-MBR-MEM-064
11
Proposed
Membership reads CRM's people, Accounting's products and prices and Platform's workspaces, users and number seeds directly from their owners' tables.
policydatabaseobserved
services-membership:modules/memberships/services/persistence/crm-people.ts

Scenarios

IdGivenWhenThenProvenance
01Dana's term is terminated by staff with a last day of 30 September 2026.The dispatcher and consumer run.Committees receives exactly one termination naming Dana and 30 September, attributed to the termination.test
services-membership:tests/e2e/business-events.e2e.spec.ts#states exactly one membership.term.terminated, with Dana’s contact_id and the last day of rights

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software