refactor(sessions): rename to RedisSessionMemoryService (0.0.8)#21
Merged
Conversation
Rename the session service to match the managed Redis Agent Memory "session memory" terminology and ADK's <Backend>SessionService convention: - RedisWorkingMemorySessionService -> RedisSessionMemoryService - RedisWorkingMemorySessionServiceConfig -> RedisSessionMemoryServiceConfig - module sessions/working_memory.py -> sessions/session_memory.py The old names remain as deprecated aliases that emit a DeprecationWarning and will be removed in 0.1.0. RedisLongTermMemoryService is unchanged. Docs, examples, and tests move to the new names. Bump version to 0.0.8 and add CHANGELOG entries.
There was a problem hiding this comment.
Pull request overview
Refactors the session service naming to align with Redis Agent Memory "session memory" terminology and ADK’s <Backend>SessionService convention, while keeping the old class names as deprecated aliases and updating the repository’s docs, examples, and tests accordingly.
Changes:
- Renamed
RedisWorkingMemorySessionServiceand config toRedisSessionMemoryServiceand config, and moved implementation toadk_redis.sessions.session_memory. - Added deprecated alias classes that emit
DeprecationWarning, and updated re-exports via package__init__modules. - Updated docs, examples, tests, version, and changelog for the rename and deprecation plan.
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_imports.py | Updates import smoke tests for new names and adds coverage for deprecated aliases. |
| tests/sessions/test_session_memory.py | Renames tests and imports to validate behavior under the new session service names. |
| tests/integration/test_memory_backends_end_to_end.py | Updates integration test usage to the renamed session service/config. |
| src/adk_redis/sessions/session_memory.py | Renames the primary session service/config and adds deprecated alias subclasses emitting warnings. |
| src/adk_redis/sessions/init.py | Updates session service re-exports to new names and keeps deprecated aliases re-exported. |
| src/adk_redis/init.py | Updates top-level package docs and re-exports to include new session service names (plus deprecated aliases). |
| SKILL.md | Updates documentation snippets to the renamed session service/config. |
| README.md | Updates README usage examples to the renamed session service/config. |
| pyproject.toml | Bumps package version to 0.0.8. |
| examples/travel_agent_memory_hybrid/travel_agent/agent.py | Updates example narrative text to the renamed session service. |
| examples/travel_agent_memory_hybrid/travel_agent/init.py | Updates example package docs to the renamed session service. |
| examples/travel_agent_memory_hybrid/README.md | Updates example README references and snippets to the renamed session service. |
| examples/travel_agent_memory_hybrid/main.py | Updates example wiring/factory code to the renamed session service/config. |
| examples/simple_redis_memory/README.md | Updates example README references to the renamed session service. |
| examples/simple_redis_memory/main.py | Updates example wiring/factory code to the renamed session service/config. |
| examples/README.md | Updates examples index guidance to the renamed session service. |
| examples/managed_memory_quickstart/README.md | Updates quickstart README references to the renamed session service. |
| examples/managed_memory_quickstart/main.py | Updates quickstart wiring/factory code to the renamed session service/config. |
| docs/user_guide/how_to_guides/session_service.md | Updates user guide to reference the renamed session service/config. |
| docs/user_guide/how_to_guides/redis_setup.md | Updates setup guide to reference the renamed session service. |
| docs/user_guide/how_to_guides/memory_service.md | Updates memory service guide examples to reference the renamed session service/config. |
| docs/user_guide/how_to_guides/managed_memory_setup.md | Updates managed setup guide examples to reference the renamed session service/config. |
| docs/user_guide/01_integration.md | Updates integration guide examples to reference the renamed session service/config. |
| docs/specs/redis-agent-memory-default.md | Updates spec references to the renamed public session service class. |
| docs/specs/examples-memory-coverage-handover.md | Updates spec/handover doc references to the renamed module and service. |
| docs/llms.txt | Updates doc index references to the renamed session service/config. |
| docs/for-ais-only/REPOSITORY_MAP.md | Updates repository map paths and descriptions for the renamed sessions module/service. |
| docs/for-ais-only/FAILURE_MODES.md | Updates failure mode guidance to reference the renamed session service. |
| docs/for-ais-only/BUILD_AND_TEST.md | Updates test invocation example to the renamed sessions test module. |
| docs/examples/index.md | Updates examples listing to reference the renamed session service. |
| docs/concepts/sessions.md | Updates concepts docs and examples to reference the renamed session service/config. |
| docs/concepts/adk_overview.md | Updates ADK overview mapping to reference the renamed session service implementation. |
| CHANGELOG.md | Adds 0.0.8 release entry documenting the rename and deprecation plan. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5c5839eba4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address PR review feedback: - Add a compatibility shim at adk_redis/sessions/working_memory.py that re-exports the session classes and emits a DeprecationWarning on import, so `from adk_redis.sessions.working_memory import ...` keeps working until 0.1.0. - Cover the legacy module path in tests/test_imports.py. - Move the `warnings` import (and importlib/sys helpers) to module scope in the test, per the no-inline-imports project standard. - Note the module-path shim in the CHANGELOG Deprecated section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the session service to align with the managed Redis Agent Memory "session memory" terminology and ADK's
<Backend>SessionServiceconvention.RedisWorkingMemorySessionService→RedisSessionMemoryServiceRedisWorkingMemorySessionServiceConfig→RedisSessionMemoryServiceConfigadk_redis.sessions.working_memory→adk_redis.sessions.session_memoryRedisLongTermMemoryServiceis unchanged ("long-term memory" stays long-term memory).Backward compatibility
The old names remain as deprecated aliases that subclass the new classes and emit a
DeprecationWarning. They are scheduled for removal in0.1.0. Existing code keeps working with a warning.Scope
__init__re-exports and__all__.0.0.7→0.0.8withCHANGELOGChanged + Deprecated entries.Testing
make checkpasses: format, lint, type-check, and 116 unit tests (10 live-backend integration tests skipped). Added a test covering the deprecated aliases (import, subclassing, andDeprecationWarning).