mirror of
https://github.com/bitechdev/ResolveSpec.git
synced 2026-02-12 03:26:08 +00:00
chore: 📝 Refactored documentation and added better sqlite support.
Some checks failed
Build , Vet Test, and Lint / Run Vet Tests (1.24.x) (push) Successful in -26m14s
Build , Vet Test, and Lint / Run Vet Tests (1.23.x) (push) Successful in -25m40s
Build , Vet Test, and Lint / Lint Code (push) Successful in -25m41s
Build , Vet Test, and Lint / Build (push) Successful in -25m55s
Tests / Unit Tests (push) Successful in -26m19s
Tests / Integration Tests (push) Failing after -26m35s
Some checks failed
Build , Vet Test, and Lint / Run Vet Tests (1.24.x) (push) Successful in -26m14s
Build , Vet Test, and Lint / Run Vet Tests (1.23.x) (push) Successful in -25m40s
Build , Vet Test, and Lint / Lint Code (push) Successful in -25m41s
Build , Vet Test, and Lint / Build (push) Successful in -25m55s
Tests / Unit Tests (push) Successful in -26m19s
Tests / Integration Tests (push) Failing after -26m35s
restructure server configuration for multiple instances - Change server configuration to support multiple instances. - Introduce new fields for tracing and error tracking. - Update example configuration to reflect new structure. - Remove deprecated OpenAPI specification file. - Enhance database adapter to handle SQLite schema translation.
This commit is contained in:
114
todo.md
114
todo.md
@@ -2,36 +2,98 @@
|
||||
|
||||
This document tracks incomplete features and improvements for the ResolveSpec project.
|
||||
|
||||
## In Progress
|
||||
|
||||
### Database Layer
|
||||
|
||||
- [x] SQLite schema translation (schema.table → schema_table)
|
||||
- [x] Driver name normalization across adapters
|
||||
- [x] Database Connection Manager (dbmanager) package
|
||||
|
||||
### Documentation
|
||||
- Ensure all new features are documented in README.md
|
||||
- Update examples to showcase new functionality
|
||||
- Add migration notes if any breaking changes are introduced
|
||||
|
||||
- [x] Add dbmanager to README
|
||||
- [x] Add WebSocketSpec to top-level intro
|
||||
- [x] Add MQTTSpec to top-level intro
|
||||
- [x] Remove migration sections from README
|
||||
- [ ] Complete API reference documentation
|
||||
- [ ] Add examples for all supported databases
|
||||
|
||||
### 8.
|
||||
## Planned Features
|
||||
|
||||
1. **Test Coverage**: Increase from 20% to 70%+
|
||||
- Add integration tests for CRUD operations
|
||||
- Add unit tests for security providers
|
||||
- Add concurrency tests for model registry
|
||||
### ResolveSpec JS Client Implementation & Testing
|
||||
|
||||
1. **ResolveSpec Client API (resolvespec-js)**
|
||||
- [x] Core API implementation (read, create, update, delete, getMetadata)
|
||||
- [ ] Unit tests for API functions
|
||||
- [ ] Integration tests with server
|
||||
- [ ] Error handling and edge cases
|
||||
|
||||
2. **HeaderSpec Client API (resolvespec-js)**
|
||||
- [ ] Client API implementation
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests with server
|
||||
|
||||
3. **FunctionSpec Client API (resolvespec-js)**
|
||||
- [ ] Client API implementation
|
||||
- [ ] Unit tests
|
||||
- [ ] Integration tests with server
|
||||
|
||||
4. **WebSocketSpec Client API (resolvespec-js)**
|
||||
- [x] WebSocketClient class implementation (read, create, update, delete, meta, subscribe, unsubscribe)
|
||||
- [ ] Unit tests for WebSocketClient
|
||||
- [ ] Connection handling tests
|
||||
- [ ] Subscription tests
|
||||
- [ ] Integration tests with server
|
||||
|
||||
5. **resolvespec-js Testing Infrastructure**
|
||||
- [ ] Set up test framework (Jest or Vitest)
|
||||
- [ ] Configure test coverage reporting
|
||||
- [ ] Add test utilities and mocks
|
||||
- [ ] Create test documentation
|
||||
|
||||
### ResolveSpec Python Client Implementation & Testing
|
||||
|
||||
See [`resolvespec-python/todo.md`](./resolvespec-python/todo.md) for detailed Python client implementation tasks.
|
||||
|
||||
### Core Functionality
|
||||
|
||||
1. **Enhanced Preload Filtering**
|
||||
- [ ] Column selection for nested preloads
|
||||
- [ ] Advanced filtering conditions for relations
|
||||
- [ ] Performance optimization for deep nesting
|
||||
|
||||
2. **Advanced Query Features**
|
||||
- [ ] Custom SQL join support
|
||||
- [ ] Computed column improvements
|
||||
- [ ] Recursive query support
|
||||
|
||||
3. **Testing & Quality**
|
||||
- [ ] Increase test coverage to 70%+
|
||||
- [ ] Add integration tests for all ORMs
|
||||
- [ ] Add concurrency tests for thread safety
|
||||
- [ ] Performance benchmarks
|
||||
|
||||
### Infrastructure
|
||||
|
||||
- [ ] Improved error handling and reporting
|
||||
- [ ] Enhanced logging capabilities
|
||||
- [ ] Additional monitoring metrics
|
||||
- [ ] Performance profiling tools
|
||||
|
||||
## Documentation Tasks
|
||||
|
||||
- [ ] Complete API reference
|
||||
- [ ] Add troubleshooting guides
|
||||
- [ ] Create architecture diagrams
|
||||
- [ ] Expand database adapter documentation
|
||||
|
||||
## Known Issues
|
||||
|
||||
- [ ] Long preload alias names may exceed PostgreSQL identifier limit
|
||||
- [ ] Some edge cases in computed column handling
|
||||
|
||||
---
|
||||
|
||||
## Priority Ranking
|
||||
|
||||
1. **High Priority**
|
||||
- Column Selection and Filtering for Preloads (#1)
|
||||
- Proper Condition Handling for Bun Preloads (#4)
|
||||
|
||||
2. **Medium Priority**
|
||||
- Custom SQL Join Support (#3)
|
||||
- Recursive JSON Cleaning (#2)
|
||||
|
||||
3. **Low Priority**
|
||||
- Modernize Go Type Declarations (#5)
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
**Last Updated:** 2025-12-09
|
||||
**Last Updated:** 2026-02-07
|
||||
**Updated:** Added resolvespec-js client testing and implementation tasks
|
||||
|
||||
Reference in New Issue
Block a user