activity_notification 2.4.1 → 2.5.0

data/ai-curated-specs/issues/188/design.md

@@ -1,227 +0,0 @@
-# Design Document
-
-## Overview
-
-This design outlines the approach for upgrading activity_notification's Dynamoid dependency from v3.1.0 to v3.11.0. The upgrade involves updating namespace references, method signatures, and class hierarchies that have changed between these versions, while maintaining backward compatibility and preparing useful enhancements for upstream contribution to Dynamoid.
-
-## Architecture
-
-### Current Architecture
-- **Dynamoid Extension**: `lib/activity_notification/orm/dynamoid/extension.rb` contains monkey patches extending Dynamoid v3.1.0
-- **ORM Integration**: `lib/activity_notification/orm/dynamoid.rb` provides ActivityNotification-specific query methods
-- **Dependency Management**: Gemspec pins Dynamoid to exactly v3.1.0
-
-### Target Architecture
-- **Updated Extension**: Refactored extension file compatible with Dynamoid v3.11.0 namespaces
-- **Backward Compatibility**: Maintained API surface for existing applications
-- **Upstream Preparation**: Clean, well-documented code ready for Dynamoid contribution
-- **Flexible Dependency**: Version range allowing v3.11.0+ while preventing breaking v4.0 changes
-
-## Components and Interfaces
-
-### 1. Gemspec Update
-**File**: `activity_notification.gemspec`
-**Changes**:
-- Update Dynamoid dependency from development dependency `'3.1.0'` to runtime dependency `'>= 3.11.0', '< 4.0'`
-- Change dependency type from `add_development_dependency` to `add_dependency` for production use
-- Ensure compatibility with Rails version constraints
-
-### 2. Extension Module Refactoring
-**File**: `lib/activity_notification/orm/dynamoid/extension.rb`
-
-#### 2.1 Critical Namespace Changes
-Based on analysis of Dynamoid v3.1.0 vs v3.11.0:
-
-**Query and Scan Class Locations**:
-- **v3.1.0**: `Dynamoid::AdapterPlugin::Query` and `Dynamoid::AdapterPlugin::Scan`
-- **v3.11.0**: `Dynamoid::AdapterPlugin::AwsSdkV3::Query` and `Dynamoid::AdapterPlugin::AwsSdkV3::Scan`
-
-**Method Signature Changes**:
-- **v3.1.0**: `Query.new(client, table, opts = {})`
-- **v3.11.0**: `Query.new(client, table, key_conditions, non_key_conditions, options)`
-
-#### 2.2 Removed Constants and Methods
-**Constants removed in v3.11.0**:
-- `FIELD_MAP` - Used for condition mapping
-- `RANGE_MAP` - Used for range condition mapping
-- `attribute_value_list()` method - No longer exists
-
-**New Architecture in v3.11.0**:
-- Uses `FilterExpressionConvertor` for building filter expressions
-- Uses expression attribute names and values instead of legacy condition format
-- Middleware pattern for handling backoff, limits, and pagination
-
-#### 2.3 Class Hierarchy Updates Required
-- Update inheritance from `::Dynamoid::AdapterPlugin::Query` to `::Dynamoid::AdapterPlugin::AwsSdkV3::Query`
-- Update inheritance from `::Dynamoid::AdapterPlugin::Scan` to `::Dynamoid::AdapterPlugin::AwsSdkV3::Scan`
-- Remove references to `FIELD_MAP`, `RANGE_MAP`, and `attribute_value_list()`
-- Adapt to new filter expression format
-
-### 3. Core Functionality Preservation
-**Methods to Maintain**:
-- `none()` - Returns empty result set
-- `limit()` - Aliases to `record_limit()`
-- `exists?()` - Checks if records exist
-- `update_all()` - Batch update operations
-- `serializable_hash()` - Array serialization
-- Null/not_null operators for query filtering
-- Uniqueness validation support
-
-### 4. Upstream Contribution Preparation
-**Target Methods for Contribution**:
-- `Chain#none` - Useful empty result pattern
-- `Chain#limit` - More intuitive alias for `record_limit`
-- `Chain#exists?` - Common query pattern
-- `Chain#update_all` - Batch operations
-- Null operator extensions - Enhanced query capabilities
-- Uniqueness validator - Common validation need
-
-## Data Models
-
-### Extension Points
-```ruby
-# Current structure (v3.1.0)
-module Dynamoid
-  module Criteria
-    class Chain
-      # Extension methods work with @query hash
-    end
-  end
-  
-  module AdapterPlugin
-    class AwsSdkV3
-      class Query < ::Dynamoid::AdapterPlugin::Query
-        # Uses FIELD_MAP, RANGE_MAP, attribute_value_list
-        def query_filter
-          # Legacy condition format
-        end
-      end
-    end
-  end
-end
-
-# Target structure (v3.11.0) - CONFIRMED
-module Dynamoid
-  module Criteria
-    class Chain
-      # Extension methods work with @where_conditions object
-      # Uses KeyFieldsDetector and WhereConditions classes
-    end
-  end
-  
-  module AdapterPlugin
-    class AwsSdkV3
-      class Query < ::Dynamoid::AdapterPlugin::AwsSdkV3::Query  # CHANGED NAMESPACE
-        # Uses FilterExpressionConvertor instead of FIELD_MAP
-        # No more query_filter method - uses filter_expression
-        def initialize(client, table, key_conditions, non_key_conditions, options)
-          # CHANGED SIGNATURE
-        end
-      end
-    end
-  end
-end
-```
-
-### Critical Breaking Changes
-1. **Query/Scan inheritance path changed**: `::Dynamoid::AdapterPlugin::Query` → `::Dynamoid::AdapterPlugin::AwsSdkV3::Query`
-2. **Constructor signature changed**: Single options hash → separate key/non-key conditions + options
-3. **Filter building changed**: `FIELD_MAP`/`RANGE_MAP` → `FilterExpressionConvertor`
-4. **Method removal**: `attribute_value_list()`, `query_filter()`, `scan_filter()` methods removed
-
-### Configuration Changes
-- No breaking changes to ActivityNotification configuration
-- Maintain existing API for `acts_as_notification_target`, `acts_as_notifiable`, etc.
-- Preserve all existing query method signatures
-
-## Error Handling
-
-### Migration Strategy
-1. **Gradual Rollout**: Support version range to allow gradual adoption
-2. **Fallback Mechanisms**: Detect Dynamoid version and use appropriate code paths if needed
-3. **Clear Error Messages**: Provide helpful errors if incompatible versions are used
-
-### Exception Handling
-- **NameError**: Handle missing classes/modules gracefully
-- **NoMethodError**: Provide fallbacks for changed method signatures
-- **ArgumentError**: Handle parameter changes in Dynamoid methods
-
-### Validation
-- Runtime checks for critical Dynamoid functionality
-- Test coverage for all supported Dynamoid versions
-- Integration tests with real DynamoDB operations
-
-## Testing Strategy
-
-### Unit Tests
-- Test all extension methods with Dynamoid v3.11.0
-- Verify namespace resolution works correctly
-- Test error handling for edge cases
-
-### Integration Tests
-- Full ActivityNotification workflow with DynamoDB
-- Performance regression testing
-- Memory usage validation
-
-### Compatibility Tests
-- Test with multiple Dynamoid versions in range
-- Verify no breaking changes for existing applications
-- Test upgrade path from v3.1.0 to v3.11.0
-
-### Upstream Preparation Tests
-- Isolated tests for each method proposed for contribution
-- Documentation examples that work standalone
-- Performance benchmarks for contributed methods
-
-## Implementation Phases
-
-### Phase 1: Research and Analysis ✅ COMPLETED
-- ✅ Compare Dynamoid v3.1.0 vs v3.11.0 source code
-- ✅ Identify all namespace and method signature changes
-- ✅ Create compatibility matrix
-
-**Key Findings**:
-- Query/Scan classes moved from `AdapterPlugin::` to `AdapterPlugin::AwsSdkV3::`
-- Constructor signatures completely changed
-- FIELD_MAP/RANGE_MAP constants removed
-- Filter building now uses FilterExpressionConvertor
-- Legacy query_filter/scan_filter methods removed
-
-### Phase 2: Core Updates
-- Update gemspec dependency
-- Refactor extension.rb for new namespaces
-- Maintain existing functionality
-
-### Phase 3: Testing and Validation
-- Update test suite for new Dynamoid version
-- Run comprehensive integration tests using `AN_ORM=dynamoid bundle exec rspec`
-- Fix failing tests to ensure all Dynamoid-related functionality works
-- Performance validation
-- Verify all existing test scenarios pass with new Dynamoid version
-
-### Phase 4: Upstream Preparation
-- Extract reusable methods into separate modules
-- Create documentation and examples
-- Prepare pull requests for Dynamoid project
-
-### Phase 5: Documentation and Release
-- Update CHANGELOG with breaking changes
-- Update README with version requirements
-- Release new version with proper semantic versioning
-
-## Risk Mitigation
-
-### Breaking Changes
-- Use version range to prevent automatic v4.0 adoption
-- Provide clear upgrade documentation
-- Maintain backward compatibility where possible
-
-### Performance Impact
-- Benchmark critical query operations
-- Monitor memory usage changes
-- Test with large datasets
-
-### Upstream Contribution Risks
-- Prepare contributions as optional enhancements
-- Ensure activity_notification works without upstream acceptance
-- Maintain local implementations as fallbacks

data/ai-curated-specs/issues/188/requirements.md

@@ -1,78 +0,0 @@
-# Requirements Document
-
-## Introduction
-
-This feature involves upgrading the activity_notification gem's Dynamoid dependency from the outdated v3.1.0 to the latest v3.11.0. The upgrade requires updating namespace references and method calls that have changed between these versions, while maintaining backward compatibility and ensuring all existing functionality continues to work correctly.
-
-## Requirements
-
-### Requirement 1
-
-**User Story:** As a developer using activity_notification with DynamoDB, I want the gem to support the latest Dynamoid version so that I can benefit from bug fixes, performance improvements, and security updates.
-
-#### Acceptance Criteria
-
-1. WHEN the gemspec is updated THEN the Dynamoid dependency SHALL be changed from development dependency '3.1.0' to runtime dependency '>= 3.11.0', '< 4.0'
-2. WHEN the gem is installed THEN it SHALL successfully resolve dependencies with Dynamoid v3.11.0
-3. WHEN existing applications upgrade THEN they SHALL continue to work without breaking changes
-
-### Requirement 2
-
-**User Story:** As a maintainer of activity_notification, I want to update the Dynamoid extension code to use the correct namespaces and method signatures so that the gem works with the latest Dynamoid version.
-
-#### Acceptance Criteria
-
-1. WHEN the extension file is updated THEN all namespace references SHALL match Dynamoid v3.11.0 structure
-2. WHEN Dynamoid classes are referenced THEN they SHALL use the correct module paths from v3.11.0
-3. WHEN adapter plugin classes are extended THEN they SHALL use the updated class hierarchy from v3.11.0
-4. WHEN the code is executed THEN it SHALL not raise any NameError or NoMethodError exceptions
-
-### Requirement 3
-
-**User Story:** As a developer using activity_notification with DynamoDB, I want all existing functionality to continue working after the Dynamoid upgrade so that my application remains stable.
-
-#### Acceptance Criteria
-
-1. WHEN the none() method is called THEN it SHALL return an empty result set as before
-2. WHEN the limit() method is called THEN it SHALL properly limit query results
-3. WHEN the exists?() method is called THEN it SHALL correctly determine if records exist
-4. WHEN the update_all() method is called THEN it SHALL update all matching records
-5. WHEN null and not_null operators are used THEN they SHALL filter records correctly
-6. WHEN uniqueness validation is performed THEN it SHALL prevent duplicate records
-
-### Requirement 4
-
-**User Story:** As a developer running tests for activity_notification, I want all existing tests to pass with the new Dynamoid version so that I can be confident the upgrade doesn't break functionality.
-
-#### Acceptance Criteria
-
-1. WHEN the test suite is run THEN all Dynamoid-related tests SHALL pass
-2. WHEN integration tests are executed THEN they SHALL work with the new Dynamoid version
-3. WHEN edge cases are tested THEN they SHALL behave consistently with the previous version
-4. WHEN performance tests are run THEN they SHALL show no significant regression
-
-### Requirement 5
-
-**User Story:** As a maintainer of activity_notification, I want to contribute useful enhancements back to the Dynamoid upstream project so that the broader community can benefit from the improvements we've developed.
-
-#### Acceptance Criteria
-
-1. WHEN extension methods are identified as generally useful THEN they SHALL be prepared for upstream contribution
-2. WHEN the none() method implementation is stable THEN it SHALL be proposed as a pull request to Dynamoid
-3. WHEN the limit() method enhancement is validated THEN it SHALL be contributed to Dynamoid upstream
-4. WHEN the exists?() method is proven useful THEN it SHALL be submitted to Dynamoid for inclusion
-5. WHEN the update_all() method is optimized THEN it SHALL be offered as a contribution to Dynamoid
-6. WHEN null/not_null operators are refined THEN they SHALL be proposed for Dynamoid core
-7. WHEN uniqueness validator improvements are made THEN they SHALL be contributed upstream
-
-### Requirement 6
-
-**User Story:** As a developer upgrading activity_notification, I want clear documentation about the Dynamoid version change so that I can understand any potential impacts on my application.
-
-#### Acceptance Criteria
-
-1. WHEN the CHANGELOG is updated THEN it SHALL document the Dynamoid version upgrade
-2. WHEN breaking changes exist THEN they SHALL be clearly documented with migration instructions
-3. WHEN new features are available THEN they SHALL be documented with usage examples
-4. WHEN version compatibility is checked THEN the supported Dynamoid versions SHALL be clearly stated
-5. WHEN upstream contributions are made THEN they SHALL be documented with links to pull requests

data/ai-curated-specs/issues/188/tasks.md

@@ -1,203 +0,0 @@
-# Implementation Plan
-
-## Source Code References
-
-**Important Context**: The following source code locations are available for reference during implementation:
-
-- **Dynamoid v3.1.0 source**: `pkg/gems/gems/dynamoid-3.1.0/`
-- **Dynamoid v3.11.0 source**: `pkg/gems/gems/dynamoid-3.11.0/`
-
-These directories contain the complete source code for both versions and should be referenced when:
-- Understanding breaking changes between versions
-- Implementing compatibility fixes
-- Verifying method signatures and class hierarchies
-- Debugging namespace and inheritance issues
-
-## Implementation Tasks
-
-- [x] 1. Update Dynamoid dependency in gemspec
-  - Change dependency from development dependency `'3.1.0'` to runtime dependency `'>= 3.11.0', '< 4.0'` in activity_notification.gemspec
-  - Change from `add_development_dependency` to `add_dependency` for production use
-  - Ensure compatibility with existing Rails version constraints
-  - _Requirements: 1.1, 1.2_
-
-- [x] 2. Fix namespace references in extension file
-  - [x] 2.1 Update Query class inheritance
-    - Change `class Query < ::Dynamoid::AdapterPlugin::Query` to `class Query < ::Dynamoid::AdapterPlugin::AwsSdkV3::Query`
-    - Update require statement to use new path structure
-    - _Requirements: 2.1, 2.2_
-  
-  - [x] 2.2 Update Scan class inheritance
-    - Change `class Scan < ::Dynamoid::AdapterPlugin::Scan` to `class Scan < ::Dynamoid::AdapterPlugin::AwsSdkV3::Scan`
-    - Update require statement to use new path structure
-    - _Requirements: 2.1, 2.2_
-
-- [x] 3. Remove deprecated constants and methods
-  - [x] 3.1 Remove FIELD_MAP references
-    - Remove usage of `AwsSdkV3::FIELD_MAP` in query_filter and scan_filter methods
-    - Replace with new filter expression approach compatible with v3.11.0
-    - _Requirements: 2.2, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6_
-  
-  - [x] 3.2 Remove RANGE_MAP references
-    - Remove usage of `AwsSdkV3::RANGE_MAP` in query_filter method
-    - Update range condition handling for new Dynamoid version
-    - _Requirements: 2.2, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6_
-  
-  - [x] 3.3 Remove attribute_value_list method calls
-    - Replace `AwsSdkV3.attribute_value_list()` calls with v3.11.0 compatible approach
-    - Update condition building to work with new filter expression system
-    - _Requirements: 2.2, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6_
-
-- [x] 4. Adapt to new filter expression system
-  - [x] 4.1 Update null operator extensions
-    - Modify NullOperatorExtension to work with new FilterExpressionConvertor
-    - Ensure 'null' and 'not_null' conditions work with v3.11.0
-    - _Requirements: 2.2, 3.5, 3.6_
-  
-  - [x] 4.2 Update query_filter method implementation
-    - Replace legacy query_filter implementation with v3.11.0 compatible version
-    - Ensure NULL_OPERATOR_FIELD_MAP works with new expression system
-    - _Requirements: 2.2, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6_
-  
-  - [x] 4.3 Update scan_filter method implementation
-    - Replace legacy scan_filter implementation with v3.11.0 compatible version
-    - Maintain null operator functionality in scan operations
-    - _Requirements: 2.2, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6_
-
-- [x] 5. Update Criteria Chain extensions
-  - [x] 5.1 Verify none() method compatibility
-    - Test that none() method works with new Chain structure using @where_conditions
-    - Ensure None class works with new Criteria system
-    - _Requirements: 3.1, 4.1, 4.2, 4.3_
-  
-  - [x] 5.2 Verify limit() method compatibility
-    - Ensure limit() alias to record_limit() still works in v3.11.0
-    - Test limit functionality with new query system
-    - _Requirements: 3.2, 4.1, 4.2, 4.3_
-  
-  - [x] 5.3 Verify exists?() method compatibility
-    - Test exists?() method works with new Chain and query system
-    - Ensure record_limit(1).count > 0 logic still works
-    - _Requirements: 3.3, 4.1, 4.2, 4.3_
-  
-  - [x] 5.4 Verify update_all() method compatibility
-    - Test batch update operations work with new Dynamoid version
-    - Ensure each/update_attributes pattern still functions
-    - _Requirements: 3.4, 4.1, 4.2, 4.3_
-  
-  - [x] 5.5 Verify serializable_hash() method compatibility
-    - Test array serialization works with new Chain structure
-    - Ensure all.to_a.map pattern still functions correctly
-    - _Requirements: 3.6, 4.1, 4.2, 4.3_
-
-- [x] 6. Update uniqueness validator
-  - [x] 6.1 Adapt validator to new Chain structure
-    - Update UniquenessValidator to work with @where_conditions instead of @query
-    - Ensure create_criteria and filter_criteria methods work with v3.11.0
-    - _Requirements: 3.6, 4.1, 4.2, 4.3_
-  
-  - [x] 6.2 Test null condition handling in validator
-    - Verify "#{attribute}.null" => true conditions work with new system
-    - Test scope validation with new Criteria structure
-    - _Requirements: 3.6, 4.1, 4.2, 4.3_
-
-- [x] 7. Run and fix Dynamoid test suite
-  - [x] 7.1 Execute Dynamoid-specific tests
-    - Run `AN_ORM=dynamoid bundle exec rspec` to identify failing tests
-    - Document all test failures and their root causes
-    - _Requirements: 4.1, 4.2, 4.3, 4.4_
-  
-  - [x] 7.2 Fix extension-related test failures
-    - Fix tests that fail due to namespace changes in extension.rb
-    - Update test expectations for new Dynamoid behavior
-    - _Requirements: 4.1, 4.2, 4.3, 4.4_
-  
-  - [x] 7.3 Fix query and scan related test failures
-    - Fixed tests that fail due to Query/Scan class changes
-    - Updated mocks and stubs for new class hierarchy
-    - _Requirements: 4.1, 4.2, 4.3, 4.4_
-  
-  - [x] 7.4 Verify all tests pass
-    - **ALL TESTS PASSING**: `AN_ORM=dynamoid bundle exec rspec` runs with 1655 examples, 0 failures, 0 skipped 🎉
-    - Validated that all existing functionality works correctly
-    - **Successfully resolved previously problematic API destroy_all tests**
-    - Perfect 100% test success rate achieved
-    - _Requirements: 4.1, 4.2, 4.3, 4.4_
-
-- [x] 8. Prepare upstream contributions
-  - [x] 8.1 Extract reusable none() method
-    - Create standalone implementation of none() method for Dynamoid contribution
-    - Write documentation and tests for upstream submission
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-  
-  - [x] 8.2 Extract reusable limit() method
-    - Create standalone implementation of limit() alias for Dynamoid contribution
-    - Document the benefit of more intuitive method name
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-  
-  - [x] 8.3 Extract reusable exists?() method
-    - Create standalone implementation of exists?() method for Dynamoid contribution
-    - Provide performance benchmarks and usage examples
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-  
-  - [x] 8.4 Extract reusable update_all() method
-    - Create standalone implementation of update_all() method for Dynamoid contribution
-    - Document batch operation benefits and usage patterns
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-  
-  - [x] 8.5 Extract null operator extensions
-    - Create standalone implementation of null/not_null operators for Dynamoid contribution
-    - Provide comprehensive test coverage and documentation
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-  
-  - [x] 8.6 Extract uniqueness validator
-    - Create standalone implementation of UniquenessValidator for Dynamoid contribution
-    - Document validation patterns and provide usage examples
-    - _Requirements: 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7_
-
-- [x] 9. Update documentation and release
-  - [x] 9.1 Update CHANGELOG
-    - Document Dynamoid version upgrade from v3.1.0 to v3.11.0+
-    - List any breaking changes and migration instructions
-    - Document upstream contribution efforts
-    - _Requirements: 6.1, 6.2, 6.3, 6.4, 6.5_
-  
-  - [x] 9.2 Update README and documentation
-    - Update supported Dynamoid version requirements
-    - Add any new configuration or usage instructions
-    - Document upstream contribution status
-    - _Requirements: 6.1, 6.2, 6.3, 6.4, 6.5_
-
-
-## Project Status
-
-**Current Phase**: Completed ✅  
-**Overall Progress**: 100% Complete  
-**Final Status**: Successfully upgraded from Dynamoid v3.1.0 to v3.11.0+
-
-### Summary
-- ✅ All core functionality working
-- ✅ **ALL 1655 tests passing (0 failures, 0 skipped)** 🎉
-- ✅ **Perfect 100% test success rate** (24 failures → 0 failures)
-- ✅ **Previously problematic API destroy_all tests now working**
-- ✅ Documentation updated
-- ✅ Upstream contributions documented
-- ✅ Ready for production use
-
-### Key Achievements
-1. **Enhanced Query Chain State Management** - Fixed complex query handling
-2. **Improved Group Owner Functionality** - Proper reload support implemented
-3. **Better FactoryBot Integration** - Seamless test factory support
-4. **Controller Compatibility** - Added find_by! method support
-5. **Optimized Deletion Processing** - Static array processing for remove_from_group
-6. **Comprehensive Upstream Contributions** - 6 reusable improvements documented
-
-### Upstream Contribution Status
-- ✅ none() method implementation documented
-- ✅ limit() method implementation documented  
-- ✅ exists?() method implementation documented
-- ✅ update_all() method implementation documented
-- ✅ null operator extensions documented
-- ✅ UniquenessValidator implementation documented
-
-**Project successfully completed! ActivityNotification now runs stably on Dynamoid v3.11.0+**