mirror of
https://github.com/bitechdev/ResolveSpec.git
synced 2025-12-29 15:54:26 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ceaa251301 | ||
|
|
faafe5abea | ||
|
|
3eb17666bf | ||
|
|
c8704c07dd | ||
|
|
fc82a9bc50 | ||
|
|
c26ea3cd61 | ||
|
|
a5d97cc07b | ||
|
|
0899ba5029 |
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Warky Devs Pty Ltd
|
||||
Copyright (c) 2025
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
390
README.md
390
README.md
@@ -1,9 +1,16 @@
|
||||
# 📜 ResolveSpec 📜
|
||||
|
||||
ResolveSpec is a flexible and powerful REST API specification and implementation that provides GraphQL-like capabilities while maintaining REST simplicity. It allows for dynamic data querying, relationship preloading, and complex filtering through a clean, URL-based interface.
|
||||
ResolveSpec is a flexible and powerful REST API specification and implementation that provides GraphQL-like capabilities while maintaining REST simplicity. It offers **two complementary approaches**:
|
||||
|
||||
1. **ResolveSpec** - Body-based API with JSON request options
|
||||
2. **RestHeadSpec** - Header-based API where query options are passed via HTTP headers
|
||||
|
||||
Both share the same core architecture and provide dynamic data querying, relationship preloading, and complex filtering.
|
||||
|
||||
**🆕 New in v2.0**: Database-agnostic architecture with support for GORM, Bun, and other ORMs. Router-flexible design works with Gorilla Mux, Gin, Echo, and more.
|
||||
|
||||
**🆕 New in v2.1**: RestHeadSpec (HeaderSpec) - Header-based REST API with lifecycle hooks, cursor pagination, and advanced filtering.
|
||||
|
||||

|
||||
|
||||
## Table of Contents
|
||||
@@ -11,30 +18,46 @@ ResolveSpec is a flexible and powerful REST API specification and implementation
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Quick Start](#quick-start)
|
||||
- [ResolveSpec (Body-Based API)](#resolvespec-body-based-api)
|
||||
- [RestHeadSpec (Header-Based API)](#restheadspec-header-based-api)
|
||||
- [Existing Code (Backward Compatible)](#option-1-existing-code-backward-compatible)
|
||||
- [New Database-Agnostic API](#option-2-new-database-agnostic-api)
|
||||
- [Router Integration](#router-integration)
|
||||
- [Migration from v1.x](#migration-from-v1x)
|
||||
- [Architecture](#architecture)
|
||||
- [API Structure](#api-structure)
|
||||
- [RestHeadSpec: Header-Based API](#restheadspec-header-based-api-1)
|
||||
- [Lifecycle Hooks](#lifecycle-hooks)
|
||||
- [Cursor Pagination](#cursor-pagination)
|
||||
- [Example Usage](#example-usage)
|
||||
- [Testing](#testing)
|
||||
- [What's New in v2.0](#whats-new-in-v20)
|
||||
|
||||
## Features
|
||||
|
||||
### Core Features
|
||||
- **Dynamic Data Querying**: Select specific columns and relationships to return
|
||||
- **Relationship Preloading**: Load related entities with custom column selection and filters
|
||||
- **Complex Filtering**: Apply multiple filters with various operators
|
||||
- **Sorting**: Multi-column sort support
|
||||
- **Pagination**: Built-in limit and offset support
|
||||
- **Pagination**: Built-in limit/offset and cursor-based pagination
|
||||
- **Computed Columns**: Define virtual columns for complex calculations
|
||||
- **Custom Operators**: Add custom SQL conditions when needed
|
||||
|
||||
### Architecture (v2.0+)
|
||||
- **🆕 Database Agnostic**: Works with GORM, Bun, or any database layer through adapters
|
||||
- **🆕 Router Flexible**: Integrates with Gorilla Mux, Gin, Echo, or custom routers
|
||||
- **🆕 Backward Compatible**: Existing code works without changes
|
||||
- **🆕 Better Testing**: Mockable interfaces for easy unit testing
|
||||
|
||||
### RestHeadSpec (v2.1+)
|
||||
- **🆕 Header-Based API**: All query options passed via HTTP headers instead of request body
|
||||
- **🆕 Lifecycle Hooks**: Before/after hooks for create, read, update, and delete operations
|
||||
- **🆕 Cursor Pagination**: Efficient cursor-based pagination with complex sort support
|
||||
- **🆕 Multiple Response Formats**: Simple, detailed, and Syncfusion-compatible formats
|
||||
- **🆕 Advanced Filtering**: Field filters, search operators, AND/OR logic, and custom SQL
|
||||
- **🆕 Base64 Encoding**: Support for base64-encoded header values
|
||||
|
||||
## API Structure
|
||||
|
||||
### URL Patterns
|
||||
@@ -66,6 +89,216 @@ ResolveSpec is a flexible and powerful REST API specification and implementation
|
||||
}
|
||||
```
|
||||
|
||||
## RestHeadSpec: Header-Based API
|
||||
|
||||
RestHeadSpec provides an alternative REST API approach where all query options are passed via HTTP headers instead of the request body. This provides cleaner separation between data and metadata.
|
||||
|
||||
### Quick Example
|
||||
|
||||
```http
|
||||
GET /public/users HTTP/1.1
|
||||
Host: api.example.com
|
||||
X-Select-Fields: id,name,email,department_id
|
||||
X-Preload: department:id,name
|
||||
X-FieldFilter-Status: active
|
||||
X-SearchOp-Gte-Age: 18
|
||||
X-Sort: -created_at,+name
|
||||
X-Limit: 50
|
||||
X-DetailApi: true
|
||||
```
|
||||
|
||||
### Setup with GORM
|
||||
|
||||
```go
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
import "github.com/gorilla/mux"
|
||||
|
||||
// Create handler
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Register models using schema.table format
|
||||
handler.Registry.RegisterModel("public.users", &User{})
|
||||
handler.Registry.RegisterModel("public.posts", &Post{})
|
||||
|
||||
// Setup routes
|
||||
router := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
|
||||
// Start server
|
||||
http.ListenAndServe(":8080", router)
|
||||
```
|
||||
|
||||
### Setup with Bun ORM
|
||||
|
||||
```go
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
import "github.com/uptrace/bun"
|
||||
|
||||
// Create handler with Bun
|
||||
handler := restheadspec.NewHandlerWithBun(bunDB)
|
||||
|
||||
// Register models
|
||||
handler.Registry.RegisterModel("public.users", &User{})
|
||||
|
||||
// Setup routes (same as GORM)
|
||||
router := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
```
|
||||
|
||||
### Common Headers
|
||||
|
||||
| Header | Description | Example |
|
||||
|--------|-------------|---------|
|
||||
| `X-Select-Fields` | Columns to include | `id,name,email` |
|
||||
| `X-Not-Select-Fields` | Columns to exclude | `password,internal_notes` |
|
||||
| `X-FieldFilter-{col}` | Exact match filter | `X-FieldFilter-Status: active` |
|
||||
| `X-SearchFilter-{col}` | Fuzzy search (ILIKE) | `X-SearchFilter-Name: john` |
|
||||
| `X-SearchOp-{op}-{col}` | Filter with operator | `X-SearchOp-Gte-Age: 18` |
|
||||
| `X-Preload` | Preload relations | `posts:id,title` |
|
||||
| `X-Sort` | Sort columns | `-created_at,+name` |
|
||||
| `X-Limit` | Limit results | `50` |
|
||||
| `X-Offset` | Offset for pagination | `100` |
|
||||
| `X-Clean-JSON` | Remove null/empty fields | `true` |
|
||||
|
||||
**Available Operators**: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startswith`, `endswith`, `between`, `betweeninclusive`, `in`, `empty`, `notempty`
|
||||
|
||||
For complete header documentation, see [pkg/restheadspec/HEADERS.md](pkg/restheadspec/HEADERS.md).
|
||||
|
||||
### Lifecycle Hooks
|
||||
|
||||
RestHeadSpec supports lifecycle hooks for all CRUD operations:
|
||||
|
||||
```go
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
|
||||
// Create handler
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Register a before-read hook (e.g., for authorization)
|
||||
handler.Hooks.Register(restheadspec.BeforeRead, func(ctx *restheadspec.HookContext) error {
|
||||
// Check permissions
|
||||
if !userHasPermission(ctx.Context, ctx.Entity) {
|
||||
return fmt.Errorf("unauthorized access to %s", ctx.Entity)
|
||||
}
|
||||
|
||||
// Modify query options
|
||||
ctx.Options.Limit = ptr(100) // Enforce max limit
|
||||
|
||||
return nil
|
||||
})
|
||||
|
||||
// Register an after-read hook (e.g., for data transformation)
|
||||
handler.Hooks.Register(restheadspec.AfterRead, func(ctx *restheadspec.HookContext) error {
|
||||
// Transform or filter results
|
||||
if users, ok := ctx.Result.([]User); ok {
|
||||
for i := range users {
|
||||
users[i].Email = maskEmail(users[i].Email)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
})
|
||||
|
||||
// Register a before-create hook (e.g., for validation)
|
||||
handler.Hooks.Register(restheadspec.BeforeCreate, func(ctx *restheadspec.HookContext) error {
|
||||
// Validate data
|
||||
if user, ok := ctx.Data.(*User); ok {
|
||||
if user.Email == "" {
|
||||
return fmt.Errorf("email is required")
|
||||
}
|
||||
// Add timestamps
|
||||
user.CreatedAt = time.Now()
|
||||
}
|
||||
return nil
|
||||
})
|
||||
```
|
||||
|
||||
**Available Hook Types**:
|
||||
- `BeforeRead`, `AfterRead`
|
||||
- `BeforeCreate`, `AfterCreate`
|
||||
- `BeforeUpdate`, `AfterUpdate`
|
||||
- `BeforeDelete`, `AfterDelete`
|
||||
|
||||
**HookContext** provides:
|
||||
- `Context`: Request context
|
||||
- `Handler`: Access to handler, database, and registry
|
||||
- `Schema`, `Entity`, `TableName`: Request info
|
||||
- `Model`: The registered model type
|
||||
- `Options`: Parsed request options (filters, sorting, etc.)
|
||||
- `ID`: Record ID (for single-record operations)
|
||||
- `Data`: Request data (for create/update)
|
||||
- `Result`: Operation result (for after hooks)
|
||||
- `Writer`: Response writer (allows hooks to modify response)
|
||||
|
||||
### Cursor Pagination
|
||||
|
||||
RestHeadSpec supports efficient cursor-based pagination for large datasets:
|
||||
|
||||
```http
|
||||
GET /public/posts HTTP/1.1
|
||||
X-Sort: -created_at,+id
|
||||
X-Limit: 50
|
||||
X-Cursor-Forward: <cursor_token>
|
||||
```
|
||||
|
||||
**How it works**:
|
||||
1. First request returns results + cursor token in response
|
||||
2. Subsequent requests use `X-Cursor-Forward` or `X-Cursor-Backward`
|
||||
3. Cursor maintains consistent ordering even with data changes
|
||||
4. Supports complex multi-column sorting
|
||||
|
||||
**Benefits over offset pagination**:
|
||||
- Consistent results when data changes
|
||||
- Better performance for large offsets
|
||||
- Prevents "skipped" or duplicate records
|
||||
- Works with complex sort expressions
|
||||
|
||||
**Example with hooks**:
|
||||
|
||||
```go
|
||||
// Enable cursor pagination in a hook
|
||||
handler.Hooks.Register(restheadspec.BeforeRead, func(ctx *restheadspec.HookContext) error {
|
||||
// For large tables, enforce cursor pagination
|
||||
if ctx.Entity == "posts" && ctx.Options.Offset != nil && *ctx.Options.Offset > 1000 {
|
||||
return fmt.Errorf("use cursor pagination for large offsets")
|
||||
}
|
||||
return nil
|
||||
})
|
||||
```
|
||||
|
||||
### Response Formats
|
||||
|
||||
RestHeadSpec supports multiple response formats:
|
||||
|
||||
**1. Simple Format** (`X-SimpleApi: true`):
|
||||
```json
|
||||
[
|
||||
{ "id": 1, "name": "John" },
|
||||
{ "id": 2, "name": "Jane" }
|
||||
]
|
||||
```
|
||||
|
||||
**2. Detail Format** (`X-DetailApi: true`, default):
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": [...],
|
||||
"metadata": {
|
||||
"total": 100,
|
||||
"filtered": 100,
|
||||
"limit": 50,
|
||||
"offset": 0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**3. Syncfusion Format** (`X-Syncfusion: true`):
|
||||
```json
|
||||
{
|
||||
"result": [...],
|
||||
"count": 100
|
||||
}
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
|
||||
### Reading Data with Related Entities
|
||||
@@ -110,17 +343,73 @@ POST /core/users
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get github.com/Warky-Devs/ResolveSpec
|
||||
go get github.com/bitechdev/ResolveSpec
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### ResolveSpec (Body-Based API)
|
||||
|
||||
ResolveSpec uses JSON request bodies to specify query options:
|
||||
|
||||
```go
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
|
||||
// Create handler
|
||||
handler := resolvespec.NewAPIHandler(gormDB)
|
||||
handler.RegisterModel("core", "users", &User{})
|
||||
|
||||
// Setup routes
|
||||
router := mux.NewRouter()
|
||||
resolvespec.SetupRoutes(router, handler)
|
||||
|
||||
// Client makes POST request with body:
|
||||
// POST /core/users
|
||||
// {
|
||||
// "operation": "read",
|
||||
// "options": {
|
||||
// "columns": ["id", "name", "email"],
|
||||
// "filters": [{"column": "status", "operator": "eq", "value": "active"}],
|
||||
// "limit": 10
|
||||
// }
|
||||
// }
|
||||
```
|
||||
|
||||
### RestHeadSpec (Header-Based API)
|
||||
|
||||
RestHeadSpec uses HTTP headers for query options instead of request body:
|
||||
|
||||
```go
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
|
||||
// Create handler with GORM
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Register models (schema.table format)
|
||||
handler.Registry.RegisterModel("public.users", &User{})
|
||||
handler.Registry.RegisterModel("public.posts", &Post{})
|
||||
|
||||
// Setup routes with Mux
|
||||
muxRouter := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(muxRouter, handler)
|
||||
|
||||
// Client makes GET request with headers:
|
||||
// GET /public/users
|
||||
// X-Select-Fields: id,name,email
|
||||
// X-FieldFilter-Status: active
|
||||
// X-Limit: 10
|
||||
// X-Sort: -created_at
|
||||
// X-Preload: posts:id,title
|
||||
```
|
||||
|
||||
See [RestHeadSpec: Header-Based API](#restheadspec-header-based-api-1) for complete header documentation.
|
||||
|
||||
### Option 1: Existing Code (Backward Compatible)
|
||||
|
||||
Your existing code continues to work without any changes:
|
||||
|
||||
```go
|
||||
import "github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
|
||||
// This still works exactly as before
|
||||
handler := resolvespec.NewAPIHandler(gormDB)
|
||||
@@ -131,12 +420,36 @@ handler.RegisterModel("core", "users", &User{})
|
||||
|
||||
ResolveSpec v2.0 introduces a new database and router abstraction layer while maintaining **100% backward compatibility**. Your existing code will continue to work without any changes.
|
||||
|
||||
### Repository Path Migration
|
||||
|
||||
**IMPORTANT**: The repository has moved from `github.com/Warky-Devs/ResolveSpec` to `github.com/bitechdev/ResolveSpec`.
|
||||
|
||||
To update your imports:
|
||||
|
||||
```bash
|
||||
# Update go.mod
|
||||
go mod edit -replace github.com/Warky-Devs/ResolveSpec=github.com/bitechdev/ResolveSpec@latest
|
||||
go mod tidy
|
||||
|
||||
# Or update imports manually in your code
|
||||
# Old: import "github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
# New: import "github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
```
|
||||
|
||||
Alternatively, use find and replace in your project:
|
||||
|
||||
```bash
|
||||
find . -type f -name "*.go" -exec sed -i 's|github.com/Warky-Devs/ResolveSpec|github.com/bitechdev/ResolveSpec|g' {} +
|
||||
go mod tidy
|
||||
```
|
||||
|
||||
### Migration Timeline
|
||||
|
||||
1. **Phase 1**: Continue using existing API (no changes needed)
|
||||
2. **Phase 2**: Gradually adopt new constructors when convenient
|
||||
3. **Phase 3**: Switch to interface-based approach for new features
|
||||
4. **Phase 4**: Optionally switch database backends
|
||||
1. **Phase 1**: Update repository path (see above)
|
||||
2. **Phase 2**: Continue using existing API (no changes needed)
|
||||
3. **Phase 3**: Gradually adopt new constructors when convenient
|
||||
4. **Phase 4**: Switch to interface-based approach for new features
|
||||
5. **Phase 5**: Optionally switch database backends or try RestHeadSpec
|
||||
|
||||
### Detailed Migration Guide
|
||||
|
||||
@@ -144,12 +457,34 @@ For detailed migration instructions, examples, and best practices, see [MIGRATIO
|
||||
|
||||
## Architecture
|
||||
|
||||
### Two Complementary APIs
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ ResolveSpec Framework │
|
||||
├─────────────────────┬───────────────────────────────┤
|
||||
│ ResolveSpec │ RestHeadSpec │
|
||||
│ (Body-based) │ (Header-based) │
|
||||
├─────────────────────┴───────────────────────────────┤
|
||||
│ Common Core Components │
|
||||
│ • Model Registry • Filters • Preloading │
|
||||
│ • Sorting • Pagination • Type System │
|
||||
└──────────────────────┬──────────────────────────────┘
|
||||
↓
|
||||
┌──────────────────────────────┐
|
||||
│ Database Abstraction │
|
||||
│ [GORM] [Bun] [Custom] │
|
||||
└──────────────────────────────┘
|
||||
```
|
||||
|
||||
### Database Abstraction Layer
|
||||
|
||||
```
|
||||
Your Application Code
|
||||
↓
|
||||
Handler (Business Logic)
|
||||
Handler (Business Logic)
|
||||
↓
|
||||
[Hooks & Middleware] (RestHeadSpec only)
|
||||
↓
|
||||
Database Interface
|
||||
↓
|
||||
@@ -176,7 +511,7 @@ Your Application Code
|
||||
|
||||
#### With GORM (Recommended Migration Path)
|
||||
```go
|
||||
import "github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
|
||||
// Create database adapter
|
||||
dbAdapter := resolvespec.NewGormAdapter(gormDB)
|
||||
@@ -192,7 +527,7 @@ handler := resolvespec.NewHandler(dbAdapter, registry)
|
||||
|
||||
#### With Bun ORM
|
||||
```go
|
||||
import "github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
import "github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
import "github.com/uptrace/bun"
|
||||
|
||||
// Create Bun adapter (Bun dependency already included)
|
||||
@@ -415,12 +750,32 @@ func TestHandler(t *testing.T) {
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## What's New in v2.0
|
||||
## What's New
|
||||
|
||||
### Breaking Changes
|
||||
### v2.1 (Latest)
|
||||
|
||||
**RestHeadSpec - Header-Based REST API**:
|
||||
- **Header-Based Querying**: All query options via HTTP headers instead of request body
|
||||
- **Lifecycle Hooks**: Before/after hooks for create, read, update, delete operations
|
||||
- **Cursor Pagination**: Efficient cursor-based pagination with complex sorting
|
||||
- **Advanced Filtering**: Field filters, search operators, AND/OR logic
|
||||
- **Multiple Response Formats**: Simple, detailed, and Syncfusion-compatible responses
|
||||
- **Base64 Support**: Base64-encoded header values for complex queries
|
||||
- **Type-Aware Filtering**: Automatic type detection and conversion for filters
|
||||
|
||||
**Core Improvements**:
|
||||
- Better model registry with schema.table format support
|
||||
- Enhanced validation and error handling
|
||||
- Improved reflection safety
|
||||
- Fixed COUNT query issues with table aliasing
|
||||
- Better pointer handling throughout the codebase
|
||||
|
||||
### v2.0
|
||||
|
||||
**Breaking Changes**:
|
||||
- **None!** Full backward compatibility maintained
|
||||
|
||||
### New Features
|
||||
**New Features**:
|
||||
- **Database Abstraction**: Support for GORM, Bun, and custom ORMs
|
||||
- **Router Flexibility**: Works with any HTTP router through adapters
|
||||
- **BunRouter Integration**: Built-in support for uptrace/bunrouter
|
||||
@@ -428,7 +783,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
- **Enhanced Testing**: Mockable interfaces for comprehensive testing
|
||||
- **Migration Guide**: Step-by-step migration instructions
|
||||
|
||||
### Performance Improvements
|
||||
**Performance Improvements**:
|
||||
- More efficient query building through interface design
|
||||
- Reduced coupling between components
|
||||
- Better memory management with interface boundaries
|
||||
@@ -436,8 +791,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
## Acknowledgments
|
||||
|
||||
- Inspired by REST, OData, and GraphQL's flexibility
|
||||
- **Header-based approach**: Inspired by REST best practices and clean API design
|
||||
- **Database Support**: [GORM](https://gorm.io) and [Bun](https://bun.uptrace.dev/)
|
||||
- **Router Support**: Gorilla Mux (built-in), Gin, Echo, and others through adapters
|
||||
- **Router Support**: Gorilla Mux (built-in), BunRouter, Gin, Echo, and others through adapters
|
||||
- Slogan generated using DALL-E
|
||||
- AI used for documentation checking and correction
|
||||
- Community feedback and contributions that made v2.0 possible
|
||||
- Community feedback and contributions that made v2.0 and v2.1 possible
|
||||
@@ -1,138 +0,0 @@
|
||||
# Schema and Table Name Handling
|
||||
|
||||
This document explains how the handlers properly separate and handle schema and table names.
|
||||
|
||||
## Implementation
|
||||
|
||||
Both `resolvespec` and `restheadspec` handlers now properly handle schema and table name separation through the following functions:
|
||||
|
||||
- `parseTableName(fullTableName)` - Splits "schema.table" into separate components
|
||||
- `getSchemaAndTable(defaultSchema, entity, model)` - Returns schema and table separately
|
||||
- `getTableName(schema, entity, model)` - Returns the full "schema.table" format
|
||||
|
||||
## Priority Order
|
||||
|
||||
When determining the schema and table name, the following priority is used:
|
||||
|
||||
1. **If `TableName()` contains a schema** (e.g., "myschema.mytable"), that schema takes precedence
|
||||
2. **If model implements `SchemaProvider`**, use that schema
|
||||
3. **Otherwise**, use the `defaultSchema` parameter from the URL/request
|
||||
|
||||
## Scenarios
|
||||
|
||||
### Scenario 1: Simple table name, default schema
|
||||
```go
|
||||
type User struct {
|
||||
ID string
|
||||
Name string
|
||||
}
|
||||
|
||||
func (User) TableName() string {
|
||||
return "users"
|
||||
}
|
||||
```
|
||||
- Request URL: `/api/public/users`
|
||||
- Result: `schema="public"`, `table="users"`, `fullName="public.users"`
|
||||
|
||||
### Scenario 2: Table name includes schema
|
||||
```go
|
||||
type User struct {
|
||||
ID string
|
||||
Name string
|
||||
}
|
||||
|
||||
func (User) TableName() string {
|
||||
return "auth.users" // Schema included!
|
||||
}
|
||||
```
|
||||
- Request URL: `/api/public/users` (public is ignored)
|
||||
- Result: `schema="auth"`, `table="users"`, `fullName="auth.users"`
|
||||
- **Note**: The schema from `TableName()` takes precedence over the URL schema
|
||||
|
||||
### Scenario 3: Using SchemaProvider
|
||||
```go
|
||||
type User struct {
|
||||
ID string
|
||||
Name string
|
||||
}
|
||||
|
||||
func (User) TableName() string {
|
||||
return "users"
|
||||
}
|
||||
|
||||
func (User) SchemaName() string {
|
||||
return "auth"
|
||||
}
|
||||
```
|
||||
- Request URL: `/api/public/users` (public is ignored)
|
||||
- Result: `schema="auth"`, `table="users"`, `fullName="auth.users"`
|
||||
|
||||
### Scenario 4: Table name includes schema AND SchemaProvider
|
||||
```go
|
||||
type User struct {
|
||||
ID string
|
||||
Name string
|
||||
}
|
||||
|
||||
func (User) TableName() string {
|
||||
return "core.users" // This wins!
|
||||
}
|
||||
|
||||
func (User) SchemaName() string {
|
||||
return "auth" // This is ignored
|
||||
}
|
||||
```
|
||||
- Request URL: `/api/public/users`
|
||||
- Result: `schema="core"`, `table="users"`, `fullName="core.users"`
|
||||
- **Note**: Schema from `TableName()` takes highest precedence
|
||||
|
||||
### Scenario 5: No providers at all
|
||||
```go
|
||||
type User struct {
|
||||
ID string
|
||||
Name string
|
||||
}
|
||||
// No TableName() or SchemaName()
|
||||
```
|
||||
- Request URL: `/api/public/users`
|
||||
- Result: `schema="public"`, `table="users"`, `fullName="public.users"`
|
||||
- Uses URL schema and entity name
|
||||
|
||||
## Key Features
|
||||
|
||||
1. **Automatic detection**: The code automatically detects if `TableName()` includes a schema by checking for "."
|
||||
2. **Backward compatible**: Existing code continues to work
|
||||
3. **Flexible**: Supports multiple ways to specify schema and table
|
||||
4. **Debug logging**: Logs when schema is detected in `TableName()` for debugging
|
||||
|
||||
## Code Locations
|
||||
|
||||
### Handlers
|
||||
- `/pkg/resolvespec/handler.go:472-531`
|
||||
- `/pkg/restheadspec/handler.go:534-593`
|
||||
|
||||
### Database Adapters
|
||||
- `/pkg/common/adapters/database/utils.go` - Shared `parseTableName()` function
|
||||
- `/pkg/common/adapters/database/bun.go` - Bun adapter with separated schema/table
|
||||
- `/pkg/common/adapters/database/gorm.go` - GORM adapter with separated schema/table
|
||||
|
||||
## Adapter Implementation
|
||||
|
||||
Both Bun and GORM adapters now properly separate schema and table name:
|
||||
|
||||
```go
|
||||
// BunSelectQuery/GormSelectQuery now have separated fields:
|
||||
type BunSelectQuery struct {
|
||||
query *bun.SelectQuery
|
||||
schema string // Separated schema name
|
||||
tableName string // Just the table name, without schema
|
||||
tableAlias string
|
||||
}
|
||||
```
|
||||
|
||||
When `Model()` or `Table()` is called:
|
||||
1. The full table name (which may include schema) is parsed
|
||||
2. Schema and table name are stored separately
|
||||
3. When building joins, the already-separated table name is used directly
|
||||
|
||||
This ensures consistent handling of schema-qualified table names throughout the codebase.
|
||||
@@ -1,17 +1,16 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/testmodels"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/testmodels"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
"github.com/gorilla/mux"
|
||||
|
||||
"github.com/glebarez/sqlite"
|
||||
@@ -21,8 +20,8 @@ import (
|
||||
|
||||
func main() {
|
||||
// Initialize logger
|
||||
fmt.Println("ResolveSpec test server starting")
|
||||
logger.Init(true)
|
||||
logger.Info("ResolveSpec test server starting")
|
||||
|
||||
// Initialize database
|
||||
db, err := initDB()
|
||||
|
||||
6
go.mod
6
go.mod
@@ -1,4 +1,4 @@
|
||||
module github.com/Warky-Devs/ResolveSpec
|
||||
module github.com/bitechdev/ResolveSpec
|
||||
|
||||
go 1.23.0
|
||||
|
||||
@@ -24,6 +24,10 @@ require (
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
github.com/puzpuzpuz/xsync/v3 v3.5.1 // indirect
|
||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
||||
github.com/tidwall/gjson v1.18.0 // indirect
|
||||
github.com/tidwall/match v1.1.1 // indirect
|
||||
github.com/tidwall/pretty v1.2.0 // indirect
|
||||
github.com/tidwall/sjson v1.2.5 // indirect
|
||||
github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc // indirect
|
||||
github.com/uptrace/bunrouter v1.0.23 // indirect
|
||||
github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
|
||||
|
||||
9
go.sum
9
go.sum
@@ -37,6 +37,15 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
|
||||
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
|
||||
github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=
|
||||
github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
|
||||
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
|
||||
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
|
||||
github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
|
||||
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
|
||||
github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
|
||||
github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
|
||||
github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc h1:9lRDQMhESg+zvGYmW5DyG0UqvY96Bu5QYsTLvCHdrgo=
|
||||
github.com/tmthrgd/go-hex v0.0.0-20190904060850-447a3041c3bc/go.mod h1:bciPuU6GHm1iF1pBvUfxfsH0Wmnc2VbpgvbI9ZWuIRs=
|
||||
github.com/uptrace/bun v1.2.15 h1:Ut68XRBLDgp9qG9QBMa9ELWaZOmzHNdczHQdrOZbEFE=
|
||||
|
||||
@@ -6,7 +6,7 @@ import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/uptrace/bun"
|
||||
)
|
||||
|
||||
@@ -192,7 +192,7 @@ func (b *BunSelectQuery) LeftJoin(query string, args ...interface{}) common.Sele
|
||||
}
|
||||
}
|
||||
|
||||
b.query = b.query.Join("LEFT JOIN " + joinClause, sqlArgs...)
|
||||
b.query = b.query.Join("LEFT JOIN "+joinClause, sqlArgs...)
|
||||
return b
|
||||
}
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
|
||||
@@ -1,10 +1,13 @@
|
||||
package database
|
||||
|
||||
import "strings"
|
||||
import (
|
||||
"strings"
|
||||
)
|
||||
|
||||
// parseTableName splits a table name that may contain schema into separate schema and table
|
||||
// For example: "public.users" -> ("public", "users")
|
||||
// "users" -> ("", "users")
|
||||
//
|
||||
// "users" -> ("", "users")
|
||||
func parseTableName(fullTableName string) (schema, table string) {
|
||||
if idx := strings.LastIndex(fullTableName, "."); idx != -1 {
|
||||
return fullTableName[:idx], fullTableName[idx+1:]
|
||||
|
||||
@@ -3,7 +3,7 @@ package router
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/uptrace/bunrouter"
|
||||
)
|
||||
|
||||
@@ -190,4 +190,3 @@ func DefaultBunRouterConfig() *BunRouterConfig {
|
||||
HandleOPTIONS: true,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/gorilla/mux"
|
||||
)
|
||||
|
||||
|
||||
@@ -131,6 +131,11 @@ type TableNameProvider interface {
|
||||
TableName() string
|
||||
}
|
||||
|
||||
// PrimaryKeyNameProvider interface for models that provide primary key column names
|
||||
type PrimaryKeyNameProvider interface {
|
||||
GetIDName() string
|
||||
}
|
||||
|
||||
// SchemaProvider interface for models that provide schema names
|
||||
type SchemaProvider interface {
|
||||
SchemaName() string
|
||||
|
||||
13
pkg/common/reflection_utils.go
Normal file
13
pkg/common/reflection_utils.go
Normal file
@@ -0,0 +1,13 @@
|
||||
package common
|
||||
|
||||
import "reflect"
|
||||
|
||||
func Len(v any) int {
|
||||
val := reflect.ValueOf(v)
|
||||
switch val.Kind() {
|
||||
case reflect.Slice, reflect.Array, reflect.Map, reflect.String, reflect.Chan:
|
||||
return val.Len()
|
||||
default:
|
||||
return 0
|
||||
}
|
||||
}
|
||||
@@ -18,6 +18,11 @@ type RequestOptions struct {
|
||||
CustomOperators []CustomOperator `json:"customOperators"`
|
||||
ComputedColumns []ComputedColumn `json:"computedColumns"`
|
||||
Parameters []Parameter `json:"parameters"`
|
||||
|
||||
// Cursor pagination
|
||||
CursorForward string `json:"cursor_forward"`
|
||||
CursorBackward string `json:"cursor_backward"`
|
||||
FetchRowNumber *string `json:"fetch_row_number"`
|
||||
}
|
||||
|
||||
type Parameter struct {
|
||||
@@ -37,9 +42,10 @@ type PreloadOption struct {
|
||||
}
|
||||
|
||||
type FilterOption struct {
|
||||
Column string `json:"column"`
|
||||
Operator string `json:"operator"`
|
||||
Value interface{} `json:"value"`
|
||||
Column string `json:"column"`
|
||||
Operator string `json:"operator"`
|
||||
Value interface{} `json:"value"`
|
||||
LogicOperator string `json:"logic_operator"` // "AND" or "OR" - how this filter combines with previous filters
|
||||
}
|
||||
|
||||
type SortOption struct {
|
||||
@@ -66,10 +72,12 @@ type Response struct {
|
||||
}
|
||||
|
||||
type Metadata struct {
|
||||
Total int64 `json:"total"`
|
||||
Filtered int64 `json:"filtered"`
|
||||
Limit int `json:"limit"`
|
||||
Offset int `json:"offset"`
|
||||
Total int64 `json:"total"`
|
||||
Count int64 `json:"count"`
|
||||
Filtered int64 `json:"filtered"`
|
||||
Limit int `json:"limit"`
|
||||
Offset int `json:"offset"`
|
||||
RowNumber *int64 `json:"row_number,omitempty"`
|
||||
}
|
||||
|
||||
type APIError struct {
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// ColumnValidator validates column names against a model's fields
|
||||
|
||||
@@ -4,6 +4,7 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"runtime/debug"
|
||||
|
||||
"go.uber.org/zap"
|
||||
)
|
||||
@@ -70,3 +71,35 @@ func Debug(template string, args ...interface{}) {
|
||||
}
|
||||
Logger.Debugw(fmt.Sprintf(template, args...), "process_id", os.Getpid())
|
||||
}
|
||||
|
||||
// CatchPanic - Handle panic
|
||||
func CatchPanicCallback(location string, cb func(err any)) {
|
||||
if err := recover(); err != nil {
|
||||
//callstack := debug.Stack()
|
||||
|
||||
if Logger != nil {
|
||||
Error("Panic in %s : %v", location, err)
|
||||
} else {
|
||||
fmt.Printf("%s:PANIC->%+v", location, err)
|
||||
debug.PrintStack()
|
||||
}
|
||||
|
||||
//push to sentry
|
||||
// hub := sentry.CurrentHub()
|
||||
// if hub != nil {
|
||||
// evtID := hub.Recover(err)
|
||||
// if evtID != nil {
|
||||
// sentry.Flush(time.Second * 2)
|
||||
// }
|
||||
// }
|
||||
|
||||
if cb != nil {
|
||||
cb(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// CatchPanic - Handle panic
|
||||
func CatchPanic(location string) {
|
||||
CatchPanicCallback(location, nil)
|
||||
}
|
||||
|
||||
100
pkg/reflection/generic_model.go
Normal file
100
pkg/reflection/generic_model.go
Normal file
@@ -0,0 +1,100 @@
|
||||
package reflection
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
type ModelFieldDetail struct {
|
||||
Name string `json:"name"`
|
||||
DataType string `json:"datatype"`
|
||||
SQLName string `json:"sqlname"`
|
||||
SQLDataType string `json:"sqldatatype"`
|
||||
SQLKey string `json:"sqlkey"`
|
||||
Nullable bool `json:"nullable"`
|
||||
FieldValue reflect.Value `json:"-"`
|
||||
}
|
||||
|
||||
// GetModelColumnDetail - Get a list of columns in the SQL declaration of the model
|
||||
func GetModelColumnDetail(record reflect.Value) []ModelFieldDetail {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
logger.Error("Panic in GetModelColumnDetail : %v", r)
|
||||
}
|
||||
}()
|
||||
|
||||
var lst []ModelFieldDetail
|
||||
lst = make([]ModelFieldDetail, 0)
|
||||
|
||||
if !record.IsValid() {
|
||||
return lst
|
||||
}
|
||||
if record.Kind() == reflect.Pointer || record.Kind() == reflect.Interface {
|
||||
record = record.Elem()
|
||||
}
|
||||
if record.Kind() != reflect.Struct {
|
||||
return lst
|
||||
}
|
||||
modeltype := record.Type()
|
||||
|
||||
for i := 0; i < modeltype.NumField(); i++ {
|
||||
fieldtype := modeltype.Field(i)
|
||||
gormdetail := fieldtype.Tag.Get("gorm")
|
||||
gormdetail = strings.Trim(gormdetail, " ")
|
||||
fielddetail := ModelFieldDetail{}
|
||||
fielddetail.FieldValue = record.Field(i)
|
||||
fielddetail.Name = fieldtype.Name
|
||||
fielddetail.DataType = fieldtype.Type.Name()
|
||||
fielddetail.SQLName = fnFindKeyVal(gormdetail, "column:")
|
||||
fielddetail.SQLDataType = fnFindKeyVal(gormdetail, "type:")
|
||||
if strings.Index(strings.ToLower(gormdetail), "identity") > 0 ||
|
||||
strings.Index(strings.ToLower(gormdetail), "primary_key") > 0 {
|
||||
fielddetail.SQLKey = "primary_key"
|
||||
} else if strings.Contains(strings.ToLower(gormdetail), "unique") {
|
||||
fielddetail.SQLKey = "unique"
|
||||
} else if strings.Contains(strings.ToLower(gormdetail), "uniqueindex") {
|
||||
fielddetail.SQLKey = "uniqueindex"
|
||||
}
|
||||
|
||||
if strings.Contains(strings.ToLower(gormdetail), "nullable") {
|
||||
fielddetail.Nullable = true
|
||||
} else if strings.Contains(strings.ToLower(gormdetail), "null") {
|
||||
fielddetail.Nullable = true
|
||||
}
|
||||
if strings.Contains(strings.ToLower(gormdetail), "not null") {
|
||||
fielddetail.Nullable = false
|
||||
}
|
||||
|
||||
if strings.Contains(strings.ToLower(gormdetail), "foreignkey:") {
|
||||
fielddetail.SQLKey = "foreign_key"
|
||||
ik := strings.Index(strings.ToLower(gormdetail), "foreignkey:")
|
||||
ie := strings.Index(gormdetail[ik:], ";")
|
||||
if ie > ik && ik > 0 {
|
||||
fielddetail.SQLName = strings.ToLower(gormdetail)[ik+11 : ik+ie]
|
||||
//fmt.Printf("\r\nforeignkey: %v", fielddetail)
|
||||
}
|
||||
|
||||
}
|
||||
//";foreignkey:rid_parent;association_foreignkey:id_atevent;save_associations:false;association_autocreate:false;"
|
||||
|
||||
lst = append(lst, fielddetail)
|
||||
|
||||
}
|
||||
return lst
|
||||
}
|
||||
|
||||
func fnFindKeyVal(src, key string) string {
|
||||
icolStart := strings.Index(strings.ToLower(src), strings.ToLower(key))
|
||||
val := ""
|
||||
if icolStart >= 0 {
|
||||
val = src[icolStart+len(key):]
|
||||
icolend := strings.Index(val, ";")
|
||||
if icolend > 0 {
|
||||
val = val[:icolend]
|
||||
}
|
||||
return val
|
||||
}
|
||||
return ""
|
||||
}
|
||||
162
pkg/reflection/model_utils.go
Normal file
162
pkg/reflection/model_utils.go
Normal file
@@ -0,0 +1,162 @@
|
||||
package reflection
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"strings"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
)
|
||||
|
||||
// GetPrimaryKeyName extracts the primary key column name from a model
|
||||
// It first checks if the model implements PrimaryKeyNameProvider (GetIDName method)
|
||||
// Falls back to reflection to find bun:",pk" tag, then gorm:"primaryKey" tag
|
||||
func GetPrimaryKeyName(model any) string {
|
||||
// Check if model implements PrimaryKeyNameProvider
|
||||
if provider, ok := model.(common.PrimaryKeyNameProvider); ok {
|
||||
return provider.GetIDName()
|
||||
}
|
||||
|
||||
// Try Bun tag first
|
||||
if pkName := getPrimaryKeyFromReflection(model, "bun"); pkName != "" {
|
||||
return pkName
|
||||
}
|
||||
|
||||
// Fall back to GORM tag
|
||||
return getPrimaryKeyFromReflection(model, "gorm")
|
||||
}
|
||||
|
||||
// GetModelColumns extracts all column names from a model using reflection
|
||||
// It checks bun tags first, then gorm tags, then json tags, and finally falls back to lowercase field names
|
||||
func GetModelColumns(model any) []string {
|
||||
var columns []string
|
||||
|
||||
modelType := reflect.TypeOf(model)
|
||||
|
||||
// Unwrap pointers, slices, and arrays to get to the base struct type
|
||||
for modelType != nil && (modelType.Kind() == reflect.Pointer || modelType.Kind() == reflect.Slice || modelType.Kind() == reflect.Array) {
|
||||
modelType = modelType.Elem()
|
||||
}
|
||||
|
||||
// Validate that we have a struct type
|
||||
if modelType == nil || modelType.Kind() != reflect.Struct {
|
||||
return columns
|
||||
}
|
||||
|
||||
for i := 0; i < modelType.NumField(); i++ {
|
||||
field := modelType.Field(i)
|
||||
|
||||
// Get column name using the same logic as primary key extraction
|
||||
columnName := getColumnNameFromField(field)
|
||||
|
||||
if columnName != "" {
|
||||
columns = append(columns, columnName)
|
||||
}
|
||||
}
|
||||
|
||||
return columns
|
||||
}
|
||||
|
||||
// getColumnNameFromField extracts the column name from a struct field
|
||||
// Priority: bun tag -> gorm tag -> json tag -> lowercase field name
|
||||
func getColumnNameFromField(field reflect.StructField) string {
|
||||
// Try bun tag first
|
||||
bunTag := field.Tag.Get("bun")
|
||||
if bunTag != "" && bunTag != "-" {
|
||||
if colName := ExtractColumnFromBunTag(bunTag); colName != "" {
|
||||
return colName
|
||||
}
|
||||
}
|
||||
|
||||
// Try gorm tag
|
||||
gormTag := field.Tag.Get("gorm")
|
||||
if gormTag != "" && gormTag != "-" {
|
||||
if colName := ExtractColumnFromGormTag(gormTag); colName != "" {
|
||||
return colName
|
||||
}
|
||||
}
|
||||
|
||||
// Fall back to json tag
|
||||
jsonTag := field.Tag.Get("json")
|
||||
if jsonTag != "" && jsonTag != "-" {
|
||||
// Extract just the field name before any options
|
||||
parts := strings.Split(jsonTag, ",")
|
||||
if len(parts) > 0 && parts[0] != "" {
|
||||
return parts[0]
|
||||
}
|
||||
}
|
||||
|
||||
// Last resort: use field name in lowercase
|
||||
return strings.ToLower(field.Name)
|
||||
}
|
||||
|
||||
// getPrimaryKeyFromReflection uses reflection to find the primary key field
|
||||
func getPrimaryKeyFromReflection(model any, ormType string) string {
|
||||
val := reflect.ValueOf(model)
|
||||
if val.Kind() == reflect.Pointer {
|
||||
val = val.Elem()
|
||||
}
|
||||
|
||||
if val.Kind() != reflect.Struct {
|
||||
return ""
|
||||
}
|
||||
|
||||
typ := val.Type()
|
||||
for i := 0; i < typ.NumField(); i++ {
|
||||
field := typ.Field(i)
|
||||
|
||||
switch ormType {
|
||||
case "gorm":
|
||||
// Check for gorm tag with primaryKey
|
||||
gormTag := field.Tag.Get("gorm")
|
||||
if strings.Contains(gormTag, "primaryKey") {
|
||||
// Try to extract column name from gorm tag
|
||||
if colName := ExtractColumnFromGormTag(gormTag); colName != "" {
|
||||
return colName
|
||||
}
|
||||
// Fall back to json tag
|
||||
if jsonTag := field.Tag.Get("json"); jsonTag != "" {
|
||||
return strings.Split(jsonTag, ",")[0]
|
||||
}
|
||||
}
|
||||
case "bun":
|
||||
// Check for bun tag with pk flag
|
||||
bunTag := field.Tag.Get("bun")
|
||||
if strings.Contains(bunTag, "pk") {
|
||||
// Extract column name from bun tag
|
||||
if colName := ExtractColumnFromBunTag(bunTag); colName != "" {
|
||||
return colName
|
||||
}
|
||||
// Fall back to json tag
|
||||
if jsonTag := field.Tag.Get("json"); jsonTag != "" {
|
||||
return strings.Split(jsonTag, ",")[0]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return ""
|
||||
}
|
||||
|
||||
// ExtractColumnFromGormTag extracts the column name from a gorm tag
|
||||
// Example: "column:id;primaryKey" -> "id"
|
||||
func ExtractColumnFromGormTag(tag string) string {
|
||||
parts := strings.Split(tag, ";")
|
||||
for _, part := range parts {
|
||||
part = strings.TrimSpace(part)
|
||||
if colName, found := strings.CutPrefix(part, "column:"); found {
|
||||
return colName
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// ExtractColumnFromBunTag extracts the column name from a bun tag
|
||||
// Example: "id,pk" -> "id"
|
||||
// Example: ",pk" -> "" (will fall back to json tag)
|
||||
func ExtractColumnFromBunTag(tag string) string {
|
||||
parts := strings.Split(tag, ",")
|
||||
if len(parts) > 0 && parts[0] != "" {
|
||||
return parts[0]
|
||||
}
|
||||
return ""
|
||||
}
|
||||
233
pkg/reflection/model_utils_test.go
Normal file
233
pkg/reflection/model_utils_test.go
Normal file
@@ -0,0 +1,233 @@
|
||||
package reflection
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Test models for GORM
|
||||
type GormModelWithGetIDName struct {
|
||||
ID int `gorm:"column:rid_test;primaryKey" json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
func (m GormModelWithGetIDName) GetIDName() string {
|
||||
return "rid_test"
|
||||
}
|
||||
|
||||
type GormModelWithColumnTag struct {
|
||||
ID int `gorm:"column:custom_id;primaryKey" json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
type GormModelWithJSONFallback struct {
|
||||
ID int `gorm:"primaryKey" json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// Test models for Bun
|
||||
type BunModelWithGetIDName struct {
|
||||
ID int `bun:"rid_test,pk" json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
func (m BunModelWithGetIDName) GetIDName() string {
|
||||
return "rid_test"
|
||||
}
|
||||
|
||||
type BunModelWithColumnTag struct {
|
||||
ID int `bun:"custom_id,pk" json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
type BunModelWithJSONFallback struct {
|
||||
ID int `bun:",pk" json:"user_id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
func TestGetPrimaryKeyName(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
model any
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "GORM model with GetIDName method",
|
||||
model: GormModelWithGetIDName{},
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "GORM model with column tag",
|
||||
model: GormModelWithColumnTag{},
|
||||
expected: "custom_id",
|
||||
},
|
||||
{
|
||||
name: "GORM model with JSON fallback",
|
||||
model: GormModelWithJSONFallback{},
|
||||
expected: "user_id",
|
||||
},
|
||||
{
|
||||
name: "GORM model pointer with GetIDName",
|
||||
model: &GormModelWithGetIDName{},
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "GORM model pointer with column tag",
|
||||
model: &GormModelWithColumnTag{},
|
||||
expected: "custom_id",
|
||||
},
|
||||
{
|
||||
name: "Bun model with GetIDName method",
|
||||
model: BunModelWithGetIDName{},
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "Bun model with column tag",
|
||||
model: BunModelWithColumnTag{},
|
||||
expected: "custom_id",
|
||||
},
|
||||
{
|
||||
name: "Bun model with JSON fallback",
|
||||
model: BunModelWithJSONFallback{},
|
||||
expected: "user_id",
|
||||
},
|
||||
{
|
||||
name: "Bun model pointer with GetIDName",
|
||||
model: &BunModelWithGetIDName{},
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "Bun model pointer with column tag",
|
||||
model: &BunModelWithColumnTag{},
|
||||
expected: "custom_id",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := GetPrimaryKeyName(tt.model)
|
||||
if result != tt.expected {
|
||||
t.Errorf("GetPrimaryKeyName() = %v, want %v", result, tt.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtractColumnFromGormTag(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
tag string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "column tag with primaryKey",
|
||||
tag: "column:rid_test;primaryKey",
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "column tag with spaces",
|
||||
tag: "column:user_id ; primaryKey ; autoIncrement",
|
||||
expected: "user_id",
|
||||
},
|
||||
{
|
||||
name: "no column tag",
|
||||
tag: "primaryKey;autoIncrement",
|
||||
expected: "",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := ExtractColumnFromGormTag(tt.tag)
|
||||
if result != tt.expected {
|
||||
t.Errorf("ExtractColumnFromGormTag() = %v, want %v", result, tt.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtractColumnFromBunTag(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
tag string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "column name with pk flag",
|
||||
tag: "rid_test,pk",
|
||||
expected: "rid_test",
|
||||
},
|
||||
{
|
||||
name: "only pk flag",
|
||||
tag: ",pk",
|
||||
expected: "",
|
||||
},
|
||||
{
|
||||
name: "column with multiple flags",
|
||||
tag: "user_id,pk,autoincrement",
|
||||
expected: "user_id",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := ExtractColumnFromBunTag(tt.tag)
|
||||
if result != tt.expected {
|
||||
t.Errorf("ExtractColumnFromBunTag() = %v, want %v", result, tt.expected)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestGetModelColumns(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
model any
|
||||
expected []string
|
||||
}{
|
||||
{
|
||||
name: "Bun model with multiple columns",
|
||||
model: BunModelWithColumnTag{},
|
||||
expected: []string{"custom_id", "name"},
|
||||
},
|
||||
{
|
||||
name: "GORM model with multiple columns",
|
||||
model: GormModelWithColumnTag{},
|
||||
expected: []string{"custom_id", "name"},
|
||||
},
|
||||
{
|
||||
name: "Bun model pointer",
|
||||
model: &BunModelWithColumnTag{},
|
||||
expected: []string{"custom_id", "name"},
|
||||
},
|
||||
{
|
||||
name: "GORM model pointer",
|
||||
model: &GormModelWithColumnTag{},
|
||||
expected: []string{"custom_id", "name"},
|
||||
},
|
||||
{
|
||||
name: "Bun model with JSON fallback",
|
||||
model: BunModelWithJSONFallback{},
|
||||
expected: []string{"user_id", "name"},
|
||||
},
|
||||
{
|
||||
name: "GORM model with JSON fallback",
|
||||
model: GormModelWithJSONFallback{},
|
||||
expected: []string{"user_id", "name"},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
result := GetModelColumns(tt.model)
|
||||
if len(result) != len(tt.expected) {
|
||||
t.Errorf("GetModelColumns() returned %d columns, want %d", len(result), len(tt.expected))
|
||||
return
|
||||
}
|
||||
for i, col := range result {
|
||||
if col != tt.expected[i] {
|
||||
t.Errorf("GetModelColumns()[%d] = %v, want %v", i, col, tt.expected[i])
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -9,8 +9,8 @@ import (
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// Handler handles API requests using database and model abstractions
|
||||
@@ -175,11 +175,14 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
sliceType := reflect.SliceOf(reflect.PointerTo(modelType))
|
||||
modelPtr := reflect.New(sliceType).Interface()
|
||||
|
||||
// Start with Model() to avoid "Model(nil)" errors in Count()
|
||||
query := h.db.NewSelect().Model(model)
|
||||
// Start with Model() using the slice pointer to avoid "Model(nil)" errors in Count()
|
||||
// Bun's Model() accepts both single pointers and slice pointers
|
||||
query := h.db.NewSelect().Model(modelPtr)
|
||||
|
||||
// Only set Table() if the model doesn't provide a table name
|
||||
if provider, ok := model.(common.TableNameProvider); !ok || provider.TableName() == "" {
|
||||
// Only set Table() if the model doesn't provide a table name via the underlying type
|
||||
// Create a temporary instance to check for TableNameProvider
|
||||
tempInstance := reflect.New(modelType).Interface()
|
||||
if provider, ok := tempInstance.(common.TableNameProvider); !ok || provider.TableName() == "" {
|
||||
query = query.Table(tableName)
|
||||
}
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@ package resolvespec
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common/adapters/database"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common/adapters/router"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common/adapters/database"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common/adapters/router"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/gorilla/mux"
|
||||
"github.com/uptrace/bun"
|
||||
"github.com/uptrace/bunrouter"
|
||||
|
||||
226
pkg/restheadspec/cursor.go
Normal file
226
pkg/restheadspec/cursor.go
Normal file
@@ -0,0 +1,226 @@
|
||||
package restheadspec
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// CursorDirection defines pagination direction
|
||||
type CursorDirection int
|
||||
|
||||
const (
|
||||
CursorForward CursorDirection = 1
|
||||
CursorBackward CursorDirection = -1
|
||||
)
|
||||
|
||||
// GetCursorFilter generates a SQL `EXISTS` subquery for cursor-based pagination.
|
||||
// It uses the current request's sort, cursor, joins (via Expand), and CQL (via ComputedQL).
|
||||
//
|
||||
// Parameters:
|
||||
// - tableName: name of the main table (e.g. "post")
|
||||
// - pkName: primary key column (e.g. "id")
|
||||
// - modelColumns: optional list of valid main-table columns (for validation). Pass nil to skip.
|
||||
// - expandJoins: optional map[alias]string of JOIN clauses (e.g. "user": "LEFT JOIN user ON ...")
|
||||
//
|
||||
// Returns SQL snippet to embed in WHERE clause.
|
||||
func (opts *ExtendedRequestOptions) GetCursorFilter(
|
||||
tableName string,
|
||||
pkName string,
|
||||
modelColumns []string, // optional: for validation
|
||||
expandJoins map[string]string, // optional: alias → JOIN SQL
|
||||
) (string, error) {
|
||||
if strings.Contains(tableName, ".") {
|
||||
tableName = strings.SplitN(tableName, ".", 2)[1]
|
||||
}
|
||||
// --------------------------------------------------------------------- //
|
||||
// 1. Determine active cursor
|
||||
// --------------------------------------------------------------------- //
|
||||
cursorID, direction := opts.getActiveCursor()
|
||||
if cursorID == "" {
|
||||
return "", fmt.Errorf("no cursor provided for table %s", tableName)
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------- //
|
||||
// 2. Extract sort columns
|
||||
// --------------------------------------------------------------------- //
|
||||
sortItems := opts.getSortColumns()
|
||||
if len(sortItems) == 0 {
|
||||
return "", fmt.Errorf("no sort columns defined")
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------- //
|
||||
// 3. Prepare
|
||||
// --------------------------------------------------------------------- //
|
||||
var whereClauses []string
|
||||
joinSQL := ""
|
||||
reverse := direction < 0
|
||||
|
||||
// --------------------------------------------------------------------- //
|
||||
// 4. Process each sort column
|
||||
// --------------------------------------------------------------------- //
|
||||
for _, s := range sortItems {
|
||||
col := strings.TrimSpace(s.Column)
|
||||
if col == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
// Parse: "user.name desc nulls last"
|
||||
parts := strings.Split(col, ".")
|
||||
field := strings.TrimSpace(parts[len(parts)-1])
|
||||
prefix := strings.Join(parts[:len(parts)-1], ".")
|
||||
|
||||
// Direction from struct or string
|
||||
desc := strings.EqualFold(s.Direction, "desc") ||
|
||||
strings.Contains(strings.ToLower(field), "desc")
|
||||
field = opts.cleanSortField(field)
|
||||
|
||||
if reverse {
|
||||
desc = !desc
|
||||
}
|
||||
|
||||
// Resolve column
|
||||
cursorCol, targetCol, isJoin, err := opts.resolveColumn(
|
||||
field, prefix, tableName, modelColumns,
|
||||
)
|
||||
if err != nil {
|
||||
logger.Warn("Skipping invalid sort column %q: %v", col, err)
|
||||
continue
|
||||
}
|
||||
|
||||
// Handle joins
|
||||
if isJoin && expandJoins != nil {
|
||||
if joinClause, ok := expandJoins[prefix]; ok {
|
||||
jSQL, cRef := rewriteJoin(joinClause, tableName, prefix)
|
||||
joinSQL = jSQL
|
||||
cursorCol = cRef + "." + field
|
||||
targetCol = prefix + "." + field
|
||||
}
|
||||
}
|
||||
|
||||
// Build inequality
|
||||
op := "<"
|
||||
if desc {
|
||||
op = ">"
|
||||
}
|
||||
whereClauses = append(whereClauses, fmt.Sprintf("%s %s %s", cursorCol, op, targetCol))
|
||||
}
|
||||
|
||||
if len(whereClauses) == 0 {
|
||||
return "", fmt.Errorf("no valid sort columns after filtering")
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------- //
|
||||
// 5. Build priority OR-AND chain
|
||||
// --------------------------------------------------------------------- //
|
||||
orSQL := buildPriorityChain(whereClauses)
|
||||
|
||||
// --------------------------------------------------------------------- //
|
||||
// 6. Final EXISTS subquery
|
||||
// --------------------------------------------------------------------- //
|
||||
query := fmt.Sprintf(`EXISTS (
|
||||
SELECT 1
|
||||
FROM %s cursor_select
|
||||
%s
|
||||
WHERE cursor_select.%s = %s
|
||||
AND (%s)
|
||||
)`,
|
||||
tableName,
|
||||
joinSQL,
|
||||
pkName,
|
||||
cursorID,
|
||||
orSQL,
|
||||
)
|
||||
|
||||
return query, nil
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------- //
|
||||
// Helper: get active cursor (forward or backward)
|
||||
func (opts *ExtendedRequestOptions) getActiveCursor() (id string, direction CursorDirection) {
|
||||
if opts.RequestOptions.CursorForward != "" {
|
||||
return opts.RequestOptions.CursorForward, CursorForward
|
||||
}
|
||||
if opts.RequestOptions.CursorBackward != "" {
|
||||
return opts.RequestOptions.CursorBackward, CursorBackward
|
||||
}
|
||||
return "", 0
|
||||
}
|
||||
|
||||
// Helper: extract sort columns
|
||||
func (opts *ExtendedRequestOptions) getSortColumns() []common.SortOption {
|
||||
if opts.RequestOptions.Sort != nil {
|
||||
return opts.RequestOptions.Sort
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Helper: clean sort field (remove desc, asc, nulls)
|
||||
func (opts *ExtendedRequestOptions) cleanSortField(field string) string {
|
||||
f := strings.ToLower(field)
|
||||
for _, token := range []string{"desc", "asc", "nulls last", "nulls first"} {
|
||||
f = strings.ReplaceAll(f, token, "")
|
||||
}
|
||||
return strings.TrimSpace(f)
|
||||
}
|
||||
|
||||
// Helper: resolve column (main, JSON, CQL, join)
|
||||
func (opts *ExtendedRequestOptions) resolveColumn(
|
||||
field, prefix, tableName string,
|
||||
modelColumns []string,
|
||||
) (cursorCol, targetCol string, isJoin bool, err error) {
|
||||
|
||||
// JSON field
|
||||
if strings.Contains(field, "->") {
|
||||
return "cursor_select." + field, tableName + "." + field, false, nil
|
||||
}
|
||||
|
||||
// CQL via ComputedQL
|
||||
if strings.Contains(strings.ToLower(field), "cql") && opts.ComputedQL != nil {
|
||||
if expr, ok := opts.ComputedQL[field]; ok {
|
||||
return "cursor_select." + expr, expr, false, nil
|
||||
}
|
||||
}
|
||||
|
||||
// Main table column
|
||||
if modelColumns != nil {
|
||||
for _, col := range modelColumns {
|
||||
if strings.EqualFold(col, field) {
|
||||
return "cursor_select." + field, tableName + "." + field, false, nil
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// No validation → allow all main-table fields
|
||||
return "cursor_select." + field, tableName + "." + field, false, nil
|
||||
}
|
||||
|
||||
// Joined column
|
||||
if prefix != "" && prefix != tableName {
|
||||
return "", "", true, nil
|
||||
}
|
||||
|
||||
return "", "", false, fmt.Errorf("invalid column: %s", field)
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------- //
|
||||
// Helper: rewrite JOIN clause for cursor subquery
|
||||
func rewriteJoin(joinClause, mainTable, alias string) (joinSQL, cursorAlias string) {
|
||||
joinSQL = strings.ReplaceAll(joinClause, mainTable+".", "cursor_select.")
|
||||
cursorAlias = "cursor_select_" + alias
|
||||
joinSQL = strings.ReplaceAll(joinSQL, " "+alias+" ", " "+cursorAlias+" ")
|
||||
joinSQL = strings.ReplaceAll(joinSQL, " "+alias+".", " "+cursorAlias+".")
|
||||
return joinSQL, cursorAlias
|
||||
}
|
||||
|
||||
// ------------------------------------------------------------------------- //
|
||||
// Helper: build OR-AND priority chain
|
||||
func buildPriorityChain(clauses []string) string {
|
||||
var or []string
|
||||
for i := 0; i < len(clauses); i++ {
|
||||
and := strings.Join(clauses[:i+1], "\n AND ")
|
||||
or = append(or, "("+and+")")
|
||||
}
|
||||
return strings.Join(or, "\n OR ")
|
||||
}
|
||||
@@ -9,8 +9,9 @@ import (
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/reflection"
|
||||
)
|
||||
|
||||
// Handler handles API requests using database and model abstractions
|
||||
@@ -18,6 +19,7 @@ import (
|
||||
type Handler struct {
|
||||
db common.Database
|
||||
registry common.ModelRegistry
|
||||
hooks *HookRegistry
|
||||
}
|
||||
|
||||
// NewHandler creates a new API handler with database and registry abstractions
|
||||
@@ -25,9 +27,16 @@ func NewHandler(db common.Database, registry common.ModelRegistry) *Handler {
|
||||
return &Handler{
|
||||
db: db,
|
||||
registry: registry,
|
||||
hooks: NewHookRegistry(),
|
||||
}
|
||||
}
|
||||
|
||||
// Hooks returns the hook registry for this handler
|
||||
// Use this to register custom hooks for operations
|
||||
func (h *Handler) Hooks() *HookRegistry {
|
||||
return h.hooks
|
||||
}
|
||||
|
||||
// handlePanic is a helper function to handle panics with stack traces
|
||||
func (h *Handler) handlePanic(w common.ResponseWriter, method string, err interface{}) {
|
||||
stack := debug.Stack()
|
||||
@@ -184,6 +193,25 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
tableName := GetTableName(ctx)
|
||||
model := GetModel(ctx)
|
||||
|
||||
// Execute BeforeRead hooks
|
||||
hookCtx := &HookContext{
|
||||
Context: ctx,
|
||||
Handler: h,
|
||||
Schema: schema,
|
||||
Entity: entity,
|
||||
TableName: tableName,
|
||||
Model: model,
|
||||
Options: options,
|
||||
ID: id,
|
||||
Writer: w,
|
||||
}
|
||||
|
||||
if err := h.hooks.Execute(BeforeRead, hookCtx); err != nil {
|
||||
logger.Error("BeforeRead hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Validate and unwrap model type to get base struct
|
||||
modelType := reflect.TypeOf(model)
|
||||
for modelType != nil && (modelType.Kind() == reflect.Ptr || modelType.Kind() == reflect.Slice || modelType.Kind() == reflect.Array) {
|
||||
@@ -201,11 +229,14 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
|
||||
logger.Info("Reading records from %s.%s", schema, entity)
|
||||
|
||||
// Start with Model() to avoid "Model(nil)" errors in Count()
|
||||
query := h.db.NewSelect().Model(model)
|
||||
// Start with Model() using the slice pointer to avoid "Model(nil)" errors in Count()
|
||||
// Bun's Model() accepts both single pointers and slice pointers
|
||||
query := h.db.NewSelect().Model(modelPtr)
|
||||
|
||||
// Only set Table() if the model doesn't provide a table name
|
||||
if provider, ok := model.(common.TableNameProvider); !ok || provider.TableName() == "" {
|
||||
// Only set Table() if the model doesn't provide a table name via the underlying type
|
||||
// Create a temporary instance to check for TableNameProvider
|
||||
tempInstance := reflect.New(modelType).Interface()
|
||||
if provider, ok := tempInstance.(common.TableNameProvider); !ok || provider.TableName() == "" {
|
||||
query = query.Table(tableName)
|
||||
}
|
||||
|
||||
@@ -236,10 +267,21 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
// This may need to be handled differently per database adapter
|
||||
}
|
||||
|
||||
// Apply filters
|
||||
for _, filter := range options.Filters {
|
||||
logger.Debug("Applying filter: %s %s %v", filter.Column, filter.Operator, filter.Value)
|
||||
query = h.applyFilter(query, filter)
|
||||
// Apply filters - validate and adjust for column types first
|
||||
for i := range options.Filters {
|
||||
filter := &options.Filters[i]
|
||||
|
||||
// Validate and adjust filter based on column type
|
||||
castInfo := h.ValidateAndAdjustFilterForColumnType(filter, model)
|
||||
|
||||
// Default to AND if LogicOperator is not set
|
||||
logicOp := filter.LogicOperator
|
||||
if logicOp == "" {
|
||||
logicOp = "AND"
|
||||
}
|
||||
|
||||
logger.Debug("Applying filter: %s %s %v (needsCast=%v, logic=%s)", filter.Column, filter.Operator, filter.Value, castInfo.NeedsCast, logicOp)
|
||||
query = h.applyFilter(query, *filter, tableName, castInfo.NeedsCast, logicOp)
|
||||
}
|
||||
|
||||
// Apply custom SQL WHERE clause (AND condition)
|
||||
@@ -296,6 +338,52 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
query = query.Offset(*options.Offset)
|
||||
}
|
||||
|
||||
// Apply cursor-based pagination
|
||||
if len(options.RequestOptions.CursorForward) > 0 || len(options.RequestOptions.CursorBackward) > 0 {
|
||||
logger.Debug("Applying cursor pagination")
|
||||
|
||||
// Get primary key name
|
||||
pkName := reflection.GetPrimaryKeyName(model)
|
||||
|
||||
// Extract model columns for validation using the generic database function
|
||||
modelColumns := reflection.GetModelColumns(model)
|
||||
|
||||
// Build expand joins map (if needed in future)
|
||||
var expandJoins map[string]string
|
||||
if len(options.Expand) > 0 {
|
||||
expandJoins = make(map[string]string)
|
||||
// TODO: Build actual JOIN SQL for each expand relation
|
||||
// For now, pass empty map as joins are handled via Preload
|
||||
}
|
||||
|
||||
// Get cursor filter SQL
|
||||
cursorFilter, err := options.GetCursorFilter(tableName, pkName, modelColumns, expandJoins)
|
||||
if err != nil {
|
||||
logger.Error("Error building cursor filter: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "cursor_error", "Invalid cursor pagination", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Apply cursor filter to query
|
||||
if cursorFilter != "" {
|
||||
logger.Debug("Applying cursor filter: %s", cursorFilter)
|
||||
query = query.Where(cursorFilter)
|
||||
}
|
||||
}
|
||||
|
||||
// Execute BeforeScan hooks - pass query chain so hooks can modify it
|
||||
hookCtx.Query = query
|
||||
if err := h.hooks.Execute(BeforeScan, hookCtx); err != nil {
|
||||
logger.Error("BeforeScan hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified query from hook context
|
||||
if modifiedQuery, ok := hookCtx.Query.(common.SelectQuery); ok {
|
||||
query = modifiedQuery
|
||||
}
|
||||
|
||||
// Execute query - modelPtr was already created earlier
|
||||
if err := query.Scan(ctx, modelPtr); err != nil {
|
||||
logger.Error("Error executing query: %v", err)
|
||||
@@ -312,13 +400,44 @@ func (h *Handler) handleRead(ctx context.Context, w common.ResponseWriter, id st
|
||||
offset = *options.Offset
|
||||
}
|
||||
|
||||
// Set row numbers on each record if the model has a RowNumber field
|
||||
h.setRowNumbersOnRecords(modelPtr, offset)
|
||||
|
||||
metadata := &common.Metadata{
|
||||
Total: int64(total),
|
||||
Count: int64(common.Len(modelPtr)),
|
||||
Filtered: int64(total),
|
||||
Limit: limit,
|
||||
Offset: offset,
|
||||
}
|
||||
|
||||
// Fetch row number for a specific record if requested
|
||||
if options.RequestOptions.FetchRowNumber != nil && *options.RequestOptions.FetchRowNumber != "" {
|
||||
pkName := reflection.GetPrimaryKeyName(model)
|
||||
pkValue := *options.RequestOptions.FetchRowNumber
|
||||
|
||||
logger.Debug("Fetching row number for specific PK %s = %s", pkName, pkValue)
|
||||
|
||||
rowNum, err := h.FetchRowNumber(ctx, tableName, pkName, pkValue, options, model)
|
||||
if err != nil {
|
||||
logger.Warn("Failed to fetch row number: %v", err)
|
||||
// Don't fail the entire request, just log the warning
|
||||
} else {
|
||||
metadata.RowNumber = &rowNum
|
||||
logger.Debug("Row number for PK %s: %d", pkValue, rowNum)
|
||||
}
|
||||
}
|
||||
|
||||
// Execute AfterRead hooks
|
||||
hookCtx.Result = modelPtr
|
||||
hookCtx.Error = nil
|
||||
|
||||
if err := h.hooks.Execute(AfterRead, hookCtx); err != nil {
|
||||
logger.Error("AfterRead hook failed: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
h.sendFormattedResponse(w, modelPtr, metadata, options)
|
||||
}
|
||||
|
||||
@@ -337,6 +456,28 @@ func (h *Handler) handleCreate(ctx context.Context, w common.ResponseWriter, dat
|
||||
|
||||
logger.Info("Creating record in %s.%s", schema, entity)
|
||||
|
||||
// Execute BeforeCreate hooks
|
||||
hookCtx := &HookContext{
|
||||
Context: ctx,
|
||||
Handler: h,
|
||||
Schema: schema,
|
||||
Entity: entity,
|
||||
TableName: tableName,
|
||||
Model: model,
|
||||
Options: options,
|
||||
Data: data,
|
||||
Writer: w,
|
||||
}
|
||||
|
||||
if err := h.hooks.Execute(BeforeCreate, hookCtx); err != nil {
|
||||
logger.Error("BeforeCreate hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified data from hook context
|
||||
data = hookCtx.Data
|
||||
|
||||
// Handle batch creation
|
||||
dataValue := reflect.ValueOf(data)
|
||||
if dataValue.Kind() == reflect.Slice || dataValue.Kind() == reflect.Array {
|
||||
@@ -358,6 +499,29 @@ func (h *Handler) handleCreate(ctx context.Context, w common.ResponseWriter, dat
|
||||
}
|
||||
|
||||
query := tx.NewInsert().Model(modelValue).Table(tableName)
|
||||
|
||||
// Execute BeforeScan hooks - pass query chain so hooks can modify it
|
||||
batchHookCtx := &HookContext{
|
||||
Context: ctx,
|
||||
Handler: h,
|
||||
Schema: schema,
|
||||
Entity: entity,
|
||||
TableName: tableName,
|
||||
Model: model,
|
||||
Options: options,
|
||||
Data: modelValue,
|
||||
Writer: w,
|
||||
Query: query,
|
||||
}
|
||||
if err := h.hooks.Execute(BeforeScan, batchHookCtx); err != nil {
|
||||
return fmt.Errorf("BeforeScan hook failed: %w", err)
|
||||
}
|
||||
|
||||
// Use potentially modified query from hook context
|
||||
if modifiedQuery, ok := batchHookCtx.Query.(common.InsertQuery); ok {
|
||||
query = modifiedQuery
|
||||
}
|
||||
|
||||
if _, err := query.Exec(ctx); err != nil {
|
||||
return fmt.Errorf("failed to insert record: %w", err)
|
||||
}
|
||||
@@ -371,6 +535,16 @@ func (h *Handler) handleCreate(ctx context.Context, w common.ResponseWriter, dat
|
||||
return
|
||||
}
|
||||
|
||||
// Execute AfterCreate hooks for batch creation
|
||||
hookCtx.Result = map[string]interface{}{"created": dataValue.Len()}
|
||||
hookCtx.Error = nil
|
||||
|
||||
if err := h.hooks.Execute(AfterCreate, hookCtx); err != nil {
|
||||
logger.Error("AfterCreate hook failed: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, map[string]interface{}{"created": dataValue.Len()}, nil)
|
||||
return
|
||||
}
|
||||
@@ -390,12 +564,37 @@ func (h *Handler) handleCreate(ctx context.Context, w common.ResponseWriter, dat
|
||||
}
|
||||
|
||||
query := h.db.NewInsert().Model(modelValue).Table(tableName)
|
||||
|
||||
// Execute BeforeScan hooks - pass query chain so hooks can modify it
|
||||
hookCtx.Data = modelValue
|
||||
hookCtx.Query = query
|
||||
if err := h.hooks.Execute(BeforeScan, hookCtx); err != nil {
|
||||
logger.Error("BeforeScan hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified query from hook context
|
||||
if modifiedQuery, ok := hookCtx.Query.(common.InsertQuery); ok {
|
||||
query = modifiedQuery
|
||||
}
|
||||
|
||||
if _, err := query.Exec(ctx); err != nil {
|
||||
logger.Error("Error creating record: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "create_error", "Error creating record", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Execute AfterCreate hooks for single record creation
|
||||
hookCtx.Result = modelValue
|
||||
hookCtx.Error = nil
|
||||
|
||||
if err := h.hooks.Execute(AfterCreate, hookCtx); err != nil {
|
||||
logger.Error("AfterCreate hook failed: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, modelValue, nil)
|
||||
}
|
||||
|
||||
@@ -410,9 +609,33 @@ func (h *Handler) handleUpdate(ctx context.Context, w common.ResponseWriter, id
|
||||
schema := GetSchema(ctx)
|
||||
entity := GetEntity(ctx)
|
||||
tableName := GetTableName(ctx)
|
||||
model := GetModel(ctx)
|
||||
|
||||
logger.Info("Updating record in %s.%s", schema, entity)
|
||||
|
||||
// Execute BeforeUpdate hooks
|
||||
hookCtx := &HookContext{
|
||||
Context: ctx,
|
||||
Handler: h,
|
||||
Schema: schema,
|
||||
Entity: entity,
|
||||
TableName: tableName,
|
||||
Model: model,
|
||||
Options: options,
|
||||
ID: id,
|
||||
Data: data,
|
||||
Writer: w,
|
||||
}
|
||||
|
||||
if err := h.hooks.Execute(BeforeUpdate, hookCtx); err != nil {
|
||||
logger.Error("BeforeUpdate hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified data from hook context
|
||||
data = hookCtx.Data
|
||||
|
||||
// Convert data to map
|
||||
dataMap, ok := data.(map[string]interface{})
|
||||
if !ok {
|
||||
@@ -441,6 +664,19 @@ func (h *Handler) handleUpdate(ctx context.Context, w common.ResponseWriter, id
|
||||
return
|
||||
}
|
||||
|
||||
// Execute BeforeScan hooks - pass query chain so hooks can modify it
|
||||
hookCtx.Query = query
|
||||
if err := h.hooks.Execute(BeforeScan, hookCtx); err != nil {
|
||||
logger.Error("BeforeScan hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified query from hook context
|
||||
if modifiedQuery, ok := hookCtx.Query.(common.UpdateQuery); ok {
|
||||
query = modifiedQuery
|
||||
}
|
||||
|
||||
result, err := query.Exec(ctx)
|
||||
if err != nil {
|
||||
logger.Error("Error updating record: %v", err)
|
||||
@@ -448,9 +684,20 @@ func (h *Handler) handleUpdate(ctx context.Context, w common.ResponseWriter, id
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, map[string]interface{}{
|
||||
// Execute AfterUpdate hooks
|
||||
responseData := map[string]interface{}{
|
||||
"updated": result.RowsAffected(),
|
||||
}, nil)
|
||||
}
|
||||
hookCtx.Result = responseData
|
||||
hookCtx.Error = nil
|
||||
|
||||
if err := h.hooks.Execute(AfterUpdate, hookCtx); err != nil {
|
||||
logger.Error("AfterUpdate hook failed: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, responseData, nil)
|
||||
}
|
||||
|
||||
func (h *Handler) handleDelete(ctx context.Context, w common.ResponseWriter, id string) {
|
||||
@@ -464,9 +711,28 @@ func (h *Handler) handleDelete(ctx context.Context, w common.ResponseWriter, id
|
||||
schema := GetSchema(ctx)
|
||||
entity := GetEntity(ctx)
|
||||
tableName := GetTableName(ctx)
|
||||
model := GetModel(ctx)
|
||||
|
||||
logger.Info("Deleting record from %s.%s", schema, entity)
|
||||
|
||||
// Execute BeforeDelete hooks
|
||||
hookCtx := &HookContext{
|
||||
Context: ctx,
|
||||
Handler: h,
|
||||
Schema: schema,
|
||||
Entity: entity,
|
||||
TableName: tableName,
|
||||
Model: model,
|
||||
ID: id,
|
||||
Writer: w,
|
||||
}
|
||||
|
||||
if err := h.hooks.Execute(BeforeDelete, hookCtx); err != nil {
|
||||
logger.Error("BeforeDelete hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
query := h.db.NewDelete().Table(tableName)
|
||||
|
||||
if id == "" {
|
||||
@@ -476,6 +742,19 @@ func (h *Handler) handleDelete(ctx context.Context, w common.ResponseWriter, id
|
||||
|
||||
query = query.Where("id = ?", id)
|
||||
|
||||
// Execute BeforeScan hooks - pass query chain so hooks can modify it
|
||||
hookCtx.Query = query
|
||||
if err := h.hooks.Execute(BeforeScan, hookCtx); err != nil {
|
||||
logger.Error("BeforeScan hook failed: %v", err)
|
||||
h.sendError(w, http.StatusBadRequest, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Use potentially modified query from hook context
|
||||
if modifiedQuery, ok := hookCtx.Query.(common.DeleteQuery); ok {
|
||||
query = modifiedQuery
|
||||
}
|
||||
|
||||
result, err := query.Exec(ctx)
|
||||
if err != nil {
|
||||
logger.Error("Error deleting record: %v", err)
|
||||
@@ -483,60 +762,112 @@ func (h *Handler) handleDelete(ctx context.Context, w common.ResponseWriter, id
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, map[string]interface{}{
|
||||
// Execute AfterDelete hooks
|
||||
responseData := map[string]interface{}{
|
||||
"deleted": result.RowsAffected(),
|
||||
}, nil)
|
||||
}
|
||||
hookCtx.Result = responseData
|
||||
hookCtx.Error = nil
|
||||
|
||||
if err := h.hooks.Execute(AfterDelete, hookCtx); err != nil {
|
||||
logger.Error("AfterDelete hook failed: %v", err)
|
||||
h.sendError(w, http.StatusInternalServerError, "hook_error", "Hook execution failed", err)
|
||||
return
|
||||
}
|
||||
|
||||
h.sendResponse(w, responseData, nil)
|
||||
}
|
||||
|
||||
func (h *Handler) applyFilter(query common.SelectQuery, filter common.FilterOption) common.SelectQuery {
|
||||
// qualifyColumnName ensures column name is fully qualified with table name if not already
|
||||
func (h *Handler) qualifyColumnName(columnName, fullTableName string) string {
|
||||
// Check if column already has a table/schema prefix (contains a dot)
|
||||
if strings.Contains(columnName, ".") {
|
||||
return columnName
|
||||
}
|
||||
|
||||
// If no table name provided, return column as-is
|
||||
if fullTableName == "" {
|
||||
return columnName
|
||||
}
|
||||
|
||||
// Extract just the table name from "schema.table" format
|
||||
// Only use the table name part, not the schema
|
||||
tableOnly := fullTableName
|
||||
if idx := strings.LastIndex(fullTableName, "."); idx != -1 {
|
||||
tableOnly = fullTableName[idx+1:]
|
||||
}
|
||||
|
||||
// Return column qualified with just the table name
|
||||
return fmt.Sprintf("%s.%s", tableOnly, columnName)
|
||||
}
|
||||
|
||||
func (h *Handler) applyFilter(query common.SelectQuery, filter common.FilterOption, tableName string, needsCast bool, logicOp string) common.SelectQuery {
|
||||
// Qualify the column name with table name if not already qualified
|
||||
qualifiedColumn := h.qualifyColumnName(filter.Column, tableName)
|
||||
|
||||
// Apply casting to text if needed for non-numeric columns or non-numeric values
|
||||
if needsCast {
|
||||
qualifiedColumn = fmt.Sprintf("CAST(%s AS TEXT)", qualifiedColumn)
|
||||
}
|
||||
|
||||
// Helper function to apply the correct Where method based on logic operator
|
||||
applyWhere := func(condition string, args ...interface{}) common.SelectQuery {
|
||||
if logicOp == "OR" {
|
||||
return query.WhereOr(condition, args...)
|
||||
}
|
||||
return query.Where(condition, args...)
|
||||
}
|
||||
|
||||
switch strings.ToLower(filter.Operator) {
|
||||
case "eq", "equals":
|
||||
return query.Where(fmt.Sprintf("%s = ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s = ?", qualifiedColumn), filter.Value)
|
||||
case "neq", "not_equals", "ne":
|
||||
return query.Where(fmt.Sprintf("%s != ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s != ?", qualifiedColumn), filter.Value)
|
||||
case "gt", "greater_than":
|
||||
return query.Where(fmt.Sprintf("%s > ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s > ?", qualifiedColumn), filter.Value)
|
||||
case "gte", "greater_than_equals", "ge":
|
||||
return query.Where(fmt.Sprintf("%s >= ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s >= ?", qualifiedColumn), filter.Value)
|
||||
case "lt", "less_than":
|
||||
return query.Where(fmt.Sprintf("%s < ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s < ?", qualifiedColumn), filter.Value)
|
||||
case "lte", "less_than_equals", "le":
|
||||
return query.Where(fmt.Sprintf("%s <= ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s <= ?", qualifiedColumn), filter.Value)
|
||||
case "like":
|
||||
return query.Where(fmt.Sprintf("%s LIKE ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s LIKE ?", qualifiedColumn), filter.Value)
|
||||
case "ilike":
|
||||
// Use ILIKE for case-insensitive search (PostgreSQL)
|
||||
// For other databases, cast to citext or use LOWER()
|
||||
return query.Where(fmt.Sprintf("CAST(%s AS TEXT) ILIKE ?", filter.Column), filter.Value)
|
||||
// Column is already cast to TEXT if needed
|
||||
return applyWhere(fmt.Sprintf("%s ILIKE ?", qualifiedColumn), filter.Value)
|
||||
case "in":
|
||||
return query.Where(fmt.Sprintf("%s IN (?)", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s IN (?)", qualifiedColumn), filter.Value)
|
||||
case "between":
|
||||
// Handle between operator - exclusive (> val1 AND < val2)
|
||||
if values, ok := filter.Value.([]interface{}); ok && len(values) == 2 {
|
||||
return query.Where(fmt.Sprintf("%s > ? AND %s < ?", filter.Column, filter.Column), values[0], values[1])
|
||||
return applyWhere(fmt.Sprintf("%s > ? AND %s < ?", qualifiedColumn, qualifiedColumn), values[0], values[1])
|
||||
} else if values, ok := filter.Value.([]string); ok && len(values) == 2 {
|
||||
return query.Where(fmt.Sprintf("%s > ? AND %s < ?", filter.Column, filter.Column), values[0], values[1])
|
||||
return applyWhere(fmt.Sprintf("%s > ? AND %s < ?", qualifiedColumn, qualifiedColumn), values[0], values[1])
|
||||
}
|
||||
logger.Warn("Invalid BETWEEN filter value format")
|
||||
return query
|
||||
case "between_inclusive":
|
||||
// Handle between inclusive operator - inclusive (>= val1 AND <= val2)
|
||||
if values, ok := filter.Value.([]interface{}); ok && len(values) == 2 {
|
||||
return query.Where(fmt.Sprintf("%s >= ? AND %s <= ?", filter.Column, filter.Column), values[0], values[1])
|
||||
return applyWhere(fmt.Sprintf("%s >= ? AND %s <= ?", qualifiedColumn, qualifiedColumn), values[0], values[1])
|
||||
} else if values, ok := filter.Value.([]string); ok && len(values) == 2 {
|
||||
return query.Where(fmt.Sprintf("%s >= ? AND %s <= ?", filter.Column, filter.Column), values[0], values[1])
|
||||
return applyWhere(fmt.Sprintf("%s >= ? AND %s <= ?", qualifiedColumn, qualifiedColumn), values[0], values[1])
|
||||
}
|
||||
logger.Warn("Invalid BETWEEN INCLUSIVE filter value format")
|
||||
return query
|
||||
case "is_null", "isnull":
|
||||
// Check for NULL values
|
||||
return query.Where(fmt.Sprintf("(%s IS NULL OR %s = '')", filter.Column, filter.Column))
|
||||
// Check for NULL values - don't use cast for NULL checks
|
||||
colName := h.qualifyColumnName(filter.Column, tableName)
|
||||
return applyWhere(fmt.Sprintf("(%s IS NULL OR %s = '')", colName, colName))
|
||||
case "is_not_null", "isnotnull":
|
||||
// Check for NOT NULL values
|
||||
return query.Where(fmt.Sprintf("(%s IS NOT NULL AND %s != '')", filter.Column, filter.Column))
|
||||
// Check for NOT NULL values - don't use cast for NULL checks
|
||||
colName := h.qualifyColumnName(filter.Column, tableName)
|
||||
return applyWhere(fmt.Sprintf("(%s IS NOT NULL AND %s != '')", colName, colName))
|
||||
default:
|
||||
logger.Warn("Unknown filter operator: %s, defaulting to equals", filter.Operator)
|
||||
return query.Where(fmt.Sprintf("%s = ?", filter.Column), filter.Value)
|
||||
return applyWhere(fmt.Sprintf("%s = ?", qualifiedColumn), filter.Value)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -704,7 +1035,12 @@ func (h *Handler) sendFormattedResponse(w common.ResponseWriter, data interface{
|
||||
if options.CleanJSON {
|
||||
data = h.cleanJSON(data)
|
||||
}
|
||||
|
||||
w.SetHeader("Content-Type", "application/json")
|
||||
w.SetHeader("Content-Range", fmt.Sprintf("%d-%d/%d", metadata.Offset, int64(metadata.Offset)+metadata.Count, metadata.Filtered))
|
||||
w.SetHeader("X-Api-Range-Total", fmt.Sprintf("%d", metadata.Filtered))
|
||||
w.SetHeader("X-Api-Range-Size", fmt.Sprintf("%d", metadata.Count))
|
||||
|
||||
// Format response based on response format option
|
||||
switch options.ResponseFormat {
|
||||
case "simple":
|
||||
@@ -760,6 +1096,191 @@ func (h *Handler) sendError(w common.ResponseWriter, statusCode int, code, messa
|
||||
w.WriteJSON(response)
|
||||
}
|
||||
|
||||
// FetchRowNumber calculates the row number of a specific record based on sorting and filtering
|
||||
// Returns the 1-based row number of the record with the given primary key value
|
||||
func (h *Handler) FetchRowNumber(ctx context.Context, tableName string, pkName string, pkValue string, options ExtendedRequestOptions, model any) (int64, error) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
logger.Error("Panic during FetchRowNumber: %v", r)
|
||||
}
|
||||
}()
|
||||
|
||||
// Build the sort order SQL
|
||||
sortSQL := ""
|
||||
if len(options.Sort) > 0 {
|
||||
sortParts := make([]string, 0, len(options.Sort))
|
||||
for _, sort := range options.Sort {
|
||||
direction := "ASC"
|
||||
if strings.ToLower(sort.Direction) == "desc" {
|
||||
direction = "DESC"
|
||||
}
|
||||
sortParts = append(sortParts, fmt.Sprintf("%s.%s %s", tableName, sort.Column, direction))
|
||||
}
|
||||
sortSQL = strings.Join(sortParts, ", ")
|
||||
} else {
|
||||
// Default sort by primary key
|
||||
sortSQL = fmt.Sprintf("%s.%s ASC", tableName, pkName)
|
||||
}
|
||||
|
||||
// Build WHERE clauses from filters
|
||||
whereClauses := make([]string, 0)
|
||||
for i := range options.Filters {
|
||||
filter := &options.Filters[i]
|
||||
whereClause := h.buildFilterSQL(filter, tableName)
|
||||
if whereClause != "" {
|
||||
whereClauses = append(whereClauses, fmt.Sprintf("(%s)", whereClause))
|
||||
}
|
||||
}
|
||||
|
||||
// Combine WHERE clauses
|
||||
whereSQL := ""
|
||||
if len(whereClauses) > 0 {
|
||||
whereSQL = "WHERE " + strings.Join(whereClauses, " AND ")
|
||||
}
|
||||
|
||||
// Add custom SQL WHERE if provided
|
||||
if options.CustomSQLWhere != "" {
|
||||
if whereSQL == "" {
|
||||
whereSQL = "WHERE " + options.CustomSQLWhere
|
||||
} else {
|
||||
whereSQL += " AND (" + options.CustomSQLWhere + ")"
|
||||
}
|
||||
}
|
||||
|
||||
// Build JOIN clauses from Expand options
|
||||
joinSQL := ""
|
||||
if len(options.Expand) > 0 {
|
||||
joinParts := make([]string, 0, len(options.Expand))
|
||||
for _, expand := range options.Expand {
|
||||
// Note: This is a simplified join - in production you'd need proper FK mapping
|
||||
joinParts = append(joinParts, fmt.Sprintf("LEFT JOIN %s ON %s.%s_id = %s.id",
|
||||
expand.Relation, tableName, expand.Relation, expand.Relation))
|
||||
}
|
||||
joinSQL = strings.Join(joinParts, "\n")
|
||||
}
|
||||
|
||||
// Build the final query with parameterized PK value
|
||||
queryStr := fmt.Sprintf(`
|
||||
SELECT search.rn
|
||||
FROM (
|
||||
SELECT %[1]s.%[2]s,
|
||||
ROW_NUMBER() OVER(ORDER BY %[3]s) AS rn
|
||||
FROM %[1]s
|
||||
%[5]s
|
||||
%[4]s
|
||||
) search
|
||||
WHERE search.%[2]s = ?
|
||||
`,
|
||||
tableName, // [1] - table name
|
||||
pkName, // [2] - primary key column name
|
||||
sortSQL, // [3] - sort order SQL
|
||||
whereSQL, // [4] - WHERE clause
|
||||
joinSQL, // [5] - JOIN clauses
|
||||
)
|
||||
|
||||
logger.Debug("FetchRowNumber query: %s, pkValue: %s", queryStr, pkValue)
|
||||
|
||||
// Execute the raw query with parameterized PK value
|
||||
var result []struct {
|
||||
RN int64 `bun:"rn"`
|
||||
}
|
||||
err := h.db.Query(ctx, &result, queryStr, pkValue)
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("failed to fetch row number: %w", err)
|
||||
}
|
||||
|
||||
if len(result) == 0 {
|
||||
return 0, fmt.Errorf("no row found for primary key %s", pkValue)
|
||||
}
|
||||
|
||||
return result[0].RN, nil
|
||||
}
|
||||
|
||||
// buildFilterSQL converts a filter to SQL WHERE clause string
|
||||
func (h *Handler) buildFilterSQL(filter *common.FilterOption, tableName string) string {
|
||||
qualifiedColumn := h.qualifyColumnName(filter.Column, tableName)
|
||||
|
||||
switch strings.ToLower(filter.Operator) {
|
||||
case "eq", "equals":
|
||||
return fmt.Sprintf("%s = '%v'", qualifiedColumn, filter.Value)
|
||||
case "neq", "not_equals", "ne":
|
||||
return fmt.Sprintf("%s != '%v'", qualifiedColumn, filter.Value)
|
||||
case "gt", "greater_than":
|
||||
return fmt.Sprintf("%s > '%v'", qualifiedColumn, filter.Value)
|
||||
case "gte", "greater_than_equals", "ge":
|
||||
return fmt.Sprintf("%s >= '%v'", qualifiedColumn, filter.Value)
|
||||
case "lt", "less_than":
|
||||
return fmt.Sprintf("%s < '%v'", qualifiedColumn, filter.Value)
|
||||
case "lte", "less_than_equals", "le":
|
||||
return fmt.Sprintf("%s <= '%v'", qualifiedColumn, filter.Value)
|
||||
case "like":
|
||||
return fmt.Sprintf("%s LIKE '%v'", qualifiedColumn, filter.Value)
|
||||
case "ilike":
|
||||
return fmt.Sprintf("%s ILIKE '%v'", qualifiedColumn, filter.Value)
|
||||
case "in":
|
||||
if values, ok := filter.Value.([]any); ok {
|
||||
valueStrs := make([]string, len(values))
|
||||
for i, v := range values {
|
||||
valueStrs[i] = fmt.Sprintf("'%v'", v)
|
||||
}
|
||||
return fmt.Sprintf("%s IN (%s)", qualifiedColumn, strings.Join(valueStrs, ", "))
|
||||
}
|
||||
return ""
|
||||
case "is_null", "isnull":
|
||||
return fmt.Sprintf("(%s IS NULL OR %s = '')", qualifiedColumn, qualifiedColumn)
|
||||
case "is_not_null", "isnotnull":
|
||||
return fmt.Sprintf("(%s IS NOT NULL AND %s != '')", qualifiedColumn, qualifiedColumn)
|
||||
default:
|
||||
logger.Warn("Unknown filter operator in buildFilterSQL: %s", filter.Operator)
|
||||
return ""
|
||||
}
|
||||
}
|
||||
|
||||
// setRowNumbersOnRecords sets the RowNumber field on each record if it exists
|
||||
// The row number is calculated as offset + index + 1 (1-based)
|
||||
func (h *Handler) setRowNumbersOnRecords(records any, offset int) {
|
||||
// Get the reflect value of the records
|
||||
recordsValue := reflect.ValueOf(records)
|
||||
if recordsValue.Kind() == reflect.Ptr {
|
||||
recordsValue = recordsValue.Elem()
|
||||
}
|
||||
|
||||
// Ensure it's a slice
|
||||
if recordsValue.Kind() != reflect.Slice {
|
||||
logger.Debug("setRowNumbersOnRecords: records is not a slice, skipping")
|
||||
return
|
||||
}
|
||||
|
||||
// Iterate through each record
|
||||
for i := 0; i < recordsValue.Len(); i++ {
|
||||
record := recordsValue.Index(i)
|
||||
|
||||
// Dereference if it's a pointer
|
||||
if record.Kind() == reflect.Ptr {
|
||||
if record.IsNil() {
|
||||
continue
|
||||
}
|
||||
record = record.Elem()
|
||||
}
|
||||
|
||||
// Ensure it's a struct
|
||||
if record.Kind() != reflect.Struct {
|
||||
continue
|
||||
}
|
||||
|
||||
// Try to find and set the RowNumber field
|
||||
rowNumberField := record.FieldByName("RowNumber")
|
||||
if rowNumberField.IsValid() && rowNumberField.CanSet() {
|
||||
// Check if the field is of type int64
|
||||
if rowNumberField.Kind() == reflect.Int64 {
|
||||
rowNum := int64(offset + i + 1)
|
||||
rowNumberField.SetInt(rowNum)
|
||||
logger.Debug("Set RowNumber=%d on record %d", rowNum, i)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// filterExtendedOptions filters all column references, removing invalid ones and logging warnings
|
||||
func filterExtendedOptions(validator *common.ColumnValidator, options ExtendedRequestOptions) ExtendedRequestOptions {
|
||||
filtered := options
|
||||
|
||||
@@ -4,11 +4,12 @@ import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"reflect"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// ExtendedRequestOptions extends common.RequestOptions with additional features
|
||||
@@ -27,23 +28,18 @@ type ExtendedRequestOptions struct {
|
||||
Expand []ExpandOption
|
||||
|
||||
// Advanced features
|
||||
AdvancedSQL map[string]string // Column -> SQL expression
|
||||
ComputedQL map[string]string // Column -> CQL expression
|
||||
Distinct bool
|
||||
SkipCount bool
|
||||
SkipCache bool
|
||||
FetchRowNumber *string
|
||||
PKRow *string
|
||||
AdvancedSQL map[string]string // Column -> SQL expression
|
||||
ComputedQL map[string]string // Column -> CQL expression
|
||||
Distinct bool
|
||||
SkipCount bool
|
||||
SkipCache bool
|
||||
PKRow *string
|
||||
|
||||
// Response format
|
||||
ResponseFormat string // "simple", "detail", "syncfusion"
|
||||
|
||||
// Transaction
|
||||
AtomicTransaction bool
|
||||
|
||||
// Cursor pagination
|
||||
CursorForward string
|
||||
CursorBackward string
|
||||
}
|
||||
|
||||
// ExpandOption represents a relation expansion configuration
|
||||
@@ -170,9 +166,9 @@ func (h *Handler) parseOptionsFromHeaders(r common.Request) ExtendedRequestOptio
|
||||
options.Offset = &offset
|
||||
}
|
||||
case strings.HasPrefix(normalizedKey, "x-cursor-forward"):
|
||||
options.CursorForward = decodedValue
|
||||
options.RequestOptions.CursorForward = decodedValue
|
||||
case strings.HasPrefix(normalizedKey, "x-cursor-backward"):
|
||||
options.CursorBackward = decodedValue
|
||||
options.RequestOptions.CursorBackward = decodedValue
|
||||
|
||||
// Advanced Features
|
||||
case strings.HasPrefix(normalizedKey, "x-advsql-"):
|
||||
@@ -188,7 +184,7 @@ func (h *Handler) parseOptionsFromHeaders(r common.Request) ExtendedRequestOptio
|
||||
case strings.HasPrefix(normalizedKey, "x-skipcache"):
|
||||
options.SkipCache = strings.ToLower(decodedValue) == "true"
|
||||
case strings.HasPrefix(normalizedKey, "x-fetch-rownumber"):
|
||||
options.FetchRowNumber = &decodedValue
|
||||
options.RequestOptions.FetchRowNumber = &decodedValue
|
||||
case strings.HasPrefix(normalizedKey, "x-pkrow"):
|
||||
options.PKRow = &decodedValue
|
||||
|
||||
@@ -235,9 +231,10 @@ func (h *Handler) parseNotSelectFields(options *ExtendedRequestOptions, value st
|
||||
func (h *Handler) parseFieldFilter(options *ExtendedRequestOptions, headerKey, value string) {
|
||||
colName := strings.TrimPrefix(headerKey, "x-fieldfilter-")
|
||||
options.Filters = append(options.Filters, common.FilterOption{
|
||||
Column: colName,
|
||||
Operator: "eq",
|
||||
Value: value,
|
||||
Column: colName,
|
||||
Operator: "eq",
|
||||
Value: value,
|
||||
LogicOperator: "AND", // Default to AND
|
||||
})
|
||||
}
|
||||
|
||||
@@ -246,9 +243,10 @@ func (h *Handler) parseSearchFilter(options *ExtendedRequestOptions, headerKey,
|
||||
colName := strings.TrimPrefix(headerKey, "x-searchfilter-")
|
||||
// Use ILIKE for fuzzy search
|
||||
options.Filters = append(options.Filters, common.FilterOption{
|
||||
Column: colName,
|
||||
Operator: "ilike",
|
||||
Value: "%" + value + "%",
|
||||
Column: colName,
|
||||
Operator: "ilike",
|
||||
Value: "%" + value + "%",
|
||||
LogicOperator: "AND", // Default to AND
|
||||
})
|
||||
}
|
||||
|
||||
@@ -277,70 +275,68 @@ func (h *Handler) parseSearchOp(options *ExtendedRequestOptions, headerKey, valu
|
||||
colName := parts[1]
|
||||
|
||||
// Map operator names to filter operators
|
||||
filterOp := h.mapSearchOperator(operator, value)
|
||||
filterOp := h.mapSearchOperator(colName, operator, value)
|
||||
|
||||
// Set the logic operator (AND or OR)
|
||||
filterOp.LogicOperator = logicOp
|
||||
|
||||
options.Filters = append(options.Filters, filterOp)
|
||||
|
||||
// Note: OR logic would need special handling in query builder
|
||||
// For now, we'll add a comment to indicate OR logic
|
||||
if logicOp == "OR" {
|
||||
// TODO: Implement OR logic in query builder
|
||||
logger.Debug("OR logic filter: %s %s %v", colName, filterOp.Operator, filterOp.Value)
|
||||
}
|
||||
logger.Debug("%s logic filter: %s %s %v", logicOp, colName, filterOp.Operator, filterOp.Value)
|
||||
}
|
||||
|
||||
// mapSearchOperator maps search operator names to filter operators
|
||||
func (h *Handler) mapSearchOperator(operator, value string) common.FilterOption {
|
||||
func (h *Handler) mapSearchOperator(colName, operator, value string) common.FilterOption {
|
||||
operator = strings.ToLower(operator)
|
||||
|
||||
switch operator {
|
||||
case "contains":
|
||||
return common.FilterOption{Operator: "ilike", Value: "%" + value + "%"}
|
||||
case "contains", "contain", "like":
|
||||
return common.FilterOption{Column: colName, Operator: "ilike", Value: "%" + value + "%"}
|
||||
case "beginswith", "startswith":
|
||||
return common.FilterOption{Operator: "ilike", Value: value + "%"}
|
||||
return common.FilterOption{Column: colName, Operator: "ilike", Value: value + "%"}
|
||||
case "endswith":
|
||||
return common.FilterOption{Operator: "ilike", Value: "%" + value}
|
||||
case "equals", "eq":
|
||||
return common.FilterOption{Operator: "eq", Value: value}
|
||||
case "notequals", "neq", "ne":
|
||||
return common.FilterOption{Operator: "neq", Value: value}
|
||||
case "greaterthan", "gt":
|
||||
return common.FilterOption{Operator: "gt", Value: value}
|
||||
case "lessthan", "lt":
|
||||
return common.FilterOption{Operator: "lt", Value: value}
|
||||
case "greaterthanorequal", "gte", "ge":
|
||||
return common.FilterOption{Operator: "gte", Value: value}
|
||||
case "lessthanorequal", "lte", "le":
|
||||
return common.FilterOption{Operator: "lte", Value: value}
|
||||
return common.FilterOption{Column: colName, Operator: "ilike", Value: "%" + value}
|
||||
case "equals", "eq", "=":
|
||||
return common.FilterOption{Column: colName, Operator: "eq", Value: value}
|
||||
case "notequals", "neq", "ne", "!=", "<>":
|
||||
return common.FilterOption{Column: colName, Operator: "neq", Value: value}
|
||||
case "greaterthan", "gt", ">":
|
||||
return common.FilterOption{Column: colName, Operator: "gt", Value: value}
|
||||
case "lessthan", "lt", "<":
|
||||
return common.FilterOption{Column: colName, Operator: "lt", Value: value}
|
||||
case "greaterthanorequal", "gte", "ge", ">=":
|
||||
return common.FilterOption{Column: colName, Operator: "gte", Value: value}
|
||||
case "lessthanorequal", "lte", "le", "<=":
|
||||
return common.FilterOption{Column: colName, Operator: "lte", Value: value}
|
||||
case "between":
|
||||
// Parse between values (format: "value1,value2")
|
||||
// Between is exclusive (> value1 AND < value2)
|
||||
parts := strings.Split(value, ",")
|
||||
if len(parts) == 2 {
|
||||
return common.FilterOption{Operator: "between", Value: parts}
|
||||
return common.FilterOption{Column: colName, Operator: "between", Value: parts}
|
||||
}
|
||||
return common.FilterOption{Operator: "eq", Value: value}
|
||||
return common.FilterOption{Column: colName, Operator: "eq", Value: value}
|
||||
case "betweeninclusive":
|
||||
// Parse between values (format: "value1,value2")
|
||||
// Between inclusive is >= value1 AND <= value2
|
||||
parts := strings.Split(value, ",")
|
||||
if len(parts) == 2 {
|
||||
return common.FilterOption{Operator: "between_inclusive", Value: parts}
|
||||
return common.FilterOption{Column: colName, Operator: "between_inclusive", Value: parts}
|
||||
}
|
||||
return common.FilterOption{Operator: "eq", Value: value}
|
||||
return common.FilterOption{Column: colName, Operator: "eq", Value: value}
|
||||
case "in":
|
||||
// Parse IN values (format: "value1,value2,value3")
|
||||
values := strings.Split(value, ",")
|
||||
return common.FilterOption{Operator: "in", Value: values}
|
||||
return common.FilterOption{Column: colName, Operator: "in", Value: values}
|
||||
case "empty", "isnull", "null":
|
||||
// Check for NULL or empty string
|
||||
return common.FilterOption{Operator: "is_null", Value: nil}
|
||||
return common.FilterOption{Column: colName, Operator: "is_null", Value: nil}
|
||||
case "notempty", "isnotnull", "notnull":
|
||||
// Check for NOT NULL
|
||||
return common.FilterOption{Operator: "is_not_null", Value: nil}
|
||||
return common.FilterOption{Column: colName, Operator: "is_not_null", Value: nil}
|
||||
default:
|
||||
logger.Warn("Unknown search operator: %s, defaulting to equals", operator)
|
||||
return common.FilterOption{Operator: "eq", Value: value}
|
||||
return common.FilterOption{Column: colName, Operator: "eq", Value: value}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -427,10 +423,16 @@ func (h *Handler) parseSorting(options *ExtendedRequestOptions, value string) {
|
||||
} else if strings.HasPrefix(field, "+") {
|
||||
direction = "ASC"
|
||||
colName = strings.TrimPrefix(field, "+")
|
||||
} else if strings.HasSuffix(field, " desc") {
|
||||
direction = "DESC"
|
||||
colName = strings.TrimSuffix(field, "desc")
|
||||
} else if strings.HasSuffix(field, " asc") {
|
||||
direction = "ASC"
|
||||
colName = strings.TrimSuffix(field, "asc")
|
||||
}
|
||||
|
||||
options.Sort = append(options.Sort, common.SortOption{
|
||||
Column: colName,
|
||||
Column: strings.Trim(colName, " "),
|
||||
Direction: direction,
|
||||
})
|
||||
}
|
||||
@@ -462,3 +464,235 @@ func (h *Handler) parseJSONHeader(value string) (map[string]interface{}, error)
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// getColumnTypeFromModel uses reflection to determine the Go type of a column in a model
|
||||
func (h *Handler) getColumnTypeFromModel(model interface{}, colName string) reflect.Kind {
|
||||
if model == nil {
|
||||
return reflect.Invalid
|
||||
}
|
||||
|
||||
modelType := reflect.TypeOf(model)
|
||||
// Dereference pointer if needed
|
||||
if modelType.Kind() == reflect.Ptr {
|
||||
modelType = modelType.Elem()
|
||||
}
|
||||
|
||||
// Ensure it's a struct
|
||||
if modelType.Kind() != reflect.Struct {
|
||||
return reflect.Invalid
|
||||
}
|
||||
|
||||
// Find the field by JSON tag or field name
|
||||
for i := 0; i < modelType.NumField(); i++ {
|
||||
field := modelType.Field(i)
|
||||
|
||||
// Check JSON tag
|
||||
jsonTag := field.Tag.Get("json")
|
||||
if jsonTag != "" {
|
||||
// Parse JSON tag (format: "name,omitempty")
|
||||
parts := strings.Split(jsonTag, ",")
|
||||
if parts[0] == colName {
|
||||
return field.Type.Kind()
|
||||
}
|
||||
}
|
||||
|
||||
// Check field name (case-insensitive)
|
||||
if strings.EqualFold(field.Name, colName) {
|
||||
return field.Type.Kind()
|
||||
}
|
||||
|
||||
// Check snake_case conversion
|
||||
snakeCaseName := toSnakeCase(field.Name)
|
||||
if snakeCaseName == colName {
|
||||
return field.Type.Kind()
|
||||
}
|
||||
}
|
||||
|
||||
return reflect.Invalid
|
||||
}
|
||||
|
||||
// toSnakeCase converts a string from CamelCase to snake_case
|
||||
func toSnakeCase(s string) string {
|
||||
var result strings.Builder
|
||||
for i, r := range s {
|
||||
if i > 0 && r >= 'A' && r <= 'Z' {
|
||||
result.WriteRune('_')
|
||||
}
|
||||
result.WriteRune(r)
|
||||
}
|
||||
return strings.ToLower(result.String())
|
||||
}
|
||||
|
||||
// isNumericType checks if a reflect.Kind is a numeric type
|
||||
func isNumericType(kind reflect.Kind) bool {
|
||||
return kind == reflect.Int || kind == reflect.Int8 || kind == reflect.Int16 ||
|
||||
kind == reflect.Int32 || kind == reflect.Int64 || kind == reflect.Uint ||
|
||||
kind == reflect.Uint8 || kind == reflect.Uint16 || kind == reflect.Uint32 ||
|
||||
kind == reflect.Uint64 || kind == reflect.Float32 || kind == reflect.Float64
|
||||
}
|
||||
|
||||
// isStringType checks if a reflect.Kind is a string type
|
||||
func isStringType(kind reflect.Kind) bool {
|
||||
return kind == reflect.String
|
||||
}
|
||||
|
||||
// isBoolType checks if a reflect.Kind is a boolean type
|
||||
func isBoolType(kind reflect.Kind) bool {
|
||||
return kind == reflect.Bool
|
||||
}
|
||||
|
||||
// convertToNumericType converts a string value to the appropriate numeric type
|
||||
func convertToNumericType(value string, kind reflect.Kind) (interface{}, error) {
|
||||
value = strings.TrimSpace(value)
|
||||
|
||||
switch kind {
|
||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||
// Parse as integer
|
||||
bitSize := 64
|
||||
switch kind {
|
||||
case reflect.Int8:
|
||||
bitSize = 8
|
||||
case reflect.Int16:
|
||||
bitSize = 16
|
||||
case reflect.Int32:
|
||||
bitSize = 32
|
||||
}
|
||||
|
||||
intVal, err := strconv.ParseInt(value, 10, bitSize)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid integer value: %w", err)
|
||||
}
|
||||
|
||||
// Return the appropriate type
|
||||
switch kind {
|
||||
case reflect.Int:
|
||||
return int(intVal), nil
|
||||
case reflect.Int8:
|
||||
return int8(intVal), nil
|
||||
case reflect.Int16:
|
||||
return int16(intVal), nil
|
||||
case reflect.Int32:
|
||||
return int32(intVal), nil
|
||||
case reflect.Int64:
|
||||
return intVal, nil
|
||||
}
|
||||
|
||||
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
|
||||
// Parse as unsigned integer
|
||||
bitSize := 64
|
||||
switch kind {
|
||||
case reflect.Uint8:
|
||||
bitSize = 8
|
||||
case reflect.Uint16:
|
||||
bitSize = 16
|
||||
case reflect.Uint32:
|
||||
bitSize = 32
|
||||
}
|
||||
|
||||
uintVal, err := strconv.ParseUint(value, 10, bitSize)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid unsigned integer value: %w", err)
|
||||
}
|
||||
|
||||
// Return the appropriate type
|
||||
switch kind {
|
||||
case reflect.Uint:
|
||||
return uint(uintVal), nil
|
||||
case reflect.Uint8:
|
||||
return uint8(uintVal), nil
|
||||
case reflect.Uint16:
|
||||
return uint16(uintVal), nil
|
||||
case reflect.Uint32:
|
||||
return uint32(uintVal), nil
|
||||
case reflect.Uint64:
|
||||
return uintVal, nil
|
||||
}
|
||||
|
||||
case reflect.Float32, reflect.Float64:
|
||||
// Parse as float
|
||||
bitSize := 64
|
||||
if kind == reflect.Float32 {
|
||||
bitSize = 32
|
||||
}
|
||||
|
||||
floatVal, err := strconv.ParseFloat(value, bitSize)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid float value: %w", err)
|
||||
}
|
||||
|
||||
if kind == reflect.Float32 {
|
||||
return float32(floatVal), nil
|
||||
}
|
||||
return floatVal, nil
|
||||
}
|
||||
|
||||
return nil, fmt.Errorf("unsupported numeric type: %v", kind)
|
||||
}
|
||||
|
||||
// isNumericValue checks if a string value can be parsed as a number
|
||||
func isNumericValue(value string) bool {
|
||||
value = strings.TrimSpace(value)
|
||||
_, err := strconv.ParseFloat(value, 64)
|
||||
return err == nil
|
||||
}
|
||||
|
||||
// ColumnCastInfo holds information about whether a column needs casting
|
||||
type ColumnCastInfo struct {
|
||||
NeedsCast bool
|
||||
IsNumericType bool
|
||||
}
|
||||
|
||||
// ValidateAndAdjustFilterForColumnType validates and adjusts a filter based on column type
|
||||
// Returns ColumnCastInfo indicating whether the column should be cast to text in SQL
|
||||
func (h *Handler) ValidateAndAdjustFilterForColumnType(filter *common.FilterOption, model interface{}) ColumnCastInfo {
|
||||
if filter == nil || model == nil {
|
||||
return ColumnCastInfo{NeedsCast: false, IsNumericType: false}
|
||||
}
|
||||
|
||||
colType := h.getColumnTypeFromModel(model, filter.Column)
|
||||
if colType == reflect.Invalid {
|
||||
// Column not found in model, no casting needed
|
||||
logger.Debug("Column %s not found in model, skipping type validation", filter.Column)
|
||||
return ColumnCastInfo{NeedsCast: false, IsNumericType: false}
|
||||
}
|
||||
|
||||
// Check if the input value is numeric
|
||||
valueIsNumeric := false
|
||||
if strVal, ok := filter.Value.(string); ok {
|
||||
strVal = strings.Trim(strVal, "%")
|
||||
valueIsNumeric = isNumericValue(strVal)
|
||||
}
|
||||
|
||||
// Adjust based on column type
|
||||
switch {
|
||||
case isNumericType(colType):
|
||||
// Column is numeric
|
||||
if valueIsNumeric {
|
||||
// Value is numeric - try to convert it
|
||||
if strVal, ok := filter.Value.(string); ok {
|
||||
strVal = strings.Trim(strVal, "%")
|
||||
numericVal, err := convertToNumericType(strVal, colType)
|
||||
if err != nil {
|
||||
logger.Debug("Failed to convert value '%s' to numeric type for column %s, will use text cast", strVal, filter.Column)
|
||||
return ColumnCastInfo{NeedsCast: true, IsNumericType: true}
|
||||
}
|
||||
filter.Value = numericVal
|
||||
}
|
||||
// No cast needed - numeric column with numeric value
|
||||
return ColumnCastInfo{NeedsCast: false, IsNumericType: true}
|
||||
} else {
|
||||
// Value is not numeric - cast column to text for comparison
|
||||
logger.Debug("Non-numeric value for numeric column %s, will cast to text", filter.Column)
|
||||
return ColumnCastInfo{NeedsCast: true, IsNumericType: true}
|
||||
}
|
||||
|
||||
case isStringType(colType):
|
||||
// String columns don't need casting
|
||||
return ColumnCastInfo{NeedsCast: false, IsNumericType: false}
|
||||
|
||||
default:
|
||||
// For bool, time.Time, and other complex types - cast to text
|
||||
logger.Debug("Complex type column %s, will cast to text", filter.Column)
|
||||
return ColumnCastInfo{NeedsCast: true, IsNumericType: false}
|
||||
}
|
||||
}
|
||||
|
||||
147
pkg/restheadspec/hooks.go
Normal file
147
pkg/restheadspec/hooks.go
Normal file
@@ -0,0 +1,147 @@
|
||||
package restheadspec
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// HookType defines the type of hook to execute
|
||||
type HookType string
|
||||
|
||||
const (
|
||||
// Read operation hooks
|
||||
BeforeRead HookType = "before_read"
|
||||
AfterRead HookType = "after_read"
|
||||
|
||||
// Create operation hooks
|
||||
BeforeCreate HookType = "before_create"
|
||||
AfterCreate HookType = "after_create"
|
||||
|
||||
// Update operation hooks
|
||||
BeforeUpdate HookType = "before_update"
|
||||
AfterUpdate HookType = "after_update"
|
||||
|
||||
// Delete operation hooks
|
||||
BeforeDelete HookType = "before_delete"
|
||||
AfterDelete HookType = "after_delete"
|
||||
|
||||
// Scan/Execute operation hooks
|
||||
BeforeScan HookType = "before_scan"
|
||||
)
|
||||
|
||||
// HookContext contains all the data available to a hook
|
||||
type HookContext struct {
|
||||
Context context.Context
|
||||
Handler *Handler // Reference to the handler for accessing database, registry, etc.
|
||||
Schema string
|
||||
Entity string
|
||||
TableName string
|
||||
Model interface{}
|
||||
Options ExtendedRequestOptions
|
||||
|
||||
// Operation-specific fields
|
||||
ID string
|
||||
Data interface{} // For create/update operations
|
||||
Result interface{} // For after hooks
|
||||
Error error // For after hooks
|
||||
QueryFilter string // For read operations
|
||||
|
||||
// Query chain - allows hooks to modify the query before execution
|
||||
// Can be SelectQuery, InsertQuery, UpdateQuery, or DeleteQuery
|
||||
Query interface{}
|
||||
|
||||
// Response writer - allows hooks to modify response
|
||||
Writer common.ResponseWriter
|
||||
}
|
||||
|
||||
// HookFunc is the signature for hook functions
|
||||
// It receives a HookContext and can modify it or return an error
|
||||
// If an error is returned, the operation will be aborted
|
||||
type HookFunc func(*HookContext) error
|
||||
|
||||
// HookRegistry manages all registered hooks
|
||||
type HookRegistry struct {
|
||||
hooks map[HookType][]HookFunc
|
||||
}
|
||||
|
||||
// NewHookRegistry creates a new hook registry
|
||||
func NewHookRegistry() *HookRegistry {
|
||||
return &HookRegistry{
|
||||
hooks: make(map[HookType][]HookFunc),
|
||||
}
|
||||
}
|
||||
|
||||
// Register adds a new hook for the specified hook type
|
||||
func (r *HookRegistry) Register(hookType HookType, hook HookFunc) {
|
||||
if r.hooks == nil {
|
||||
r.hooks = make(map[HookType][]HookFunc)
|
||||
}
|
||||
r.hooks[hookType] = append(r.hooks[hookType], hook)
|
||||
logger.Info("Registered hook for %s (total: %d)", hookType, len(r.hooks[hookType]))
|
||||
}
|
||||
|
||||
// RegisterMultiple registers a hook for multiple hook types
|
||||
func (r *HookRegistry) RegisterMultiple(hookTypes []HookType, hook HookFunc) {
|
||||
for _, hookType := range hookTypes {
|
||||
r.Register(hookType, hook)
|
||||
}
|
||||
}
|
||||
|
||||
// Execute runs all hooks for the specified type in order
|
||||
// If any hook returns an error, execution stops and the error is returned
|
||||
func (r *HookRegistry) Execute(hookType HookType, ctx *HookContext) error {
|
||||
hooks, exists := r.hooks[hookType]
|
||||
if !exists || len(hooks) == 0 {
|
||||
logger.Debug("No hooks registered for %s", hookType)
|
||||
return nil
|
||||
}
|
||||
|
||||
logger.Debug("Executing %d hook(s) for %s", len(hooks), hookType)
|
||||
|
||||
for i, hook := range hooks {
|
||||
if err := hook(ctx); err != nil {
|
||||
logger.Error("Hook %d for %s failed: %v", i+1, hookType, err)
|
||||
return fmt.Errorf("hook execution failed: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
logger.Debug("All hooks for %s executed successfully", hookType)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Clear removes all hooks for the specified type
|
||||
func (r *HookRegistry) Clear(hookType HookType) {
|
||||
delete(r.hooks, hookType)
|
||||
logger.Info("Cleared all hooks for %s", hookType)
|
||||
}
|
||||
|
||||
// ClearAll removes all registered hooks
|
||||
func (r *HookRegistry) ClearAll() {
|
||||
r.hooks = make(map[HookType][]HookFunc)
|
||||
logger.Info("Cleared all hooks")
|
||||
}
|
||||
|
||||
// Count returns the number of hooks registered for a specific type
|
||||
func (r *HookRegistry) Count(hookType HookType) int {
|
||||
if hooks, exists := r.hooks[hookType]; exists {
|
||||
return len(hooks)
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// HasHooks returns true if there are any hooks registered for the specified type
|
||||
func (r *HookRegistry) HasHooks(hookType HookType) bool {
|
||||
return r.Count(hookType) > 0
|
||||
}
|
||||
|
||||
// GetAllHookTypes returns all hook types that have registered hooks
|
||||
func (r *HookRegistry) GetAllHookTypes() []HookType {
|
||||
types := make([]HookType, 0, len(r.hooks))
|
||||
for hookType := range r.hooks {
|
||||
types = append(types, hookType)
|
||||
}
|
||||
return types
|
||||
}
|
||||
197
pkg/restheadspec/hooks_example.go
Normal file
197
pkg/restheadspec/hooks_example.go
Normal file
@@ -0,0 +1,197 @@
|
||||
package restheadspec
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// This file contains example implementations showing how to use hooks
|
||||
// These are just examples - you can implement hooks as needed for your application
|
||||
|
||||
// ExampleLoggingHook logs before and after operations
|
||||
func ExampleLoggingHook(hookType HookType) HookFunc {
|
||||
return func(ctx *HookContext) error {
|
||||
logger.Info("[%s] Operation: %s.%s, ID: %s", hookType, ctx.Schema, ctx.Entity, ctx.ID)
|
||||
if ctx.Data != nil {
|
||||
logger.Debug("[%s] Data: %+v", hookType, ctx.Data)
|
||||
}
|
||||
if ctx.Result != nil {
|
||||
logger.Debug("[%s] Result: %+v", hookType, ctx.Result)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// ExampleValidationHook validates data before create/update operations
|
||||
func ExampleValidationHook(ctx *HookContext) error {
|
||||
// Example: Ensure certain fields are present
|
||||
if dataMap, ok := ctx.Data.(map[string]interface{}); ok {
|
||||
// Check for required fields
|
||||
requiredFields := []string{"name"} // Add your required fields here
|
||||
for _, field := range requiredFields {
|
||||
if _, exists := dataMap[field]; !exists {
|
||||
return fmt.Errorf("required field missing: %s", field)
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExampleAuthorizationHook checks if the user has permission to perform the operation
|
||||
func ExampleAuthorizationHook(ctx *HookContext) error {
|
||||
// Example: Check user permissions from context
|
||||
// userID, ok := ctx.Context.Value("user_id").(string)
|
||||
// if !ok {
|
||||
// return fmt.Errorf("unauthorized: no user in context")
|
||||
// }
|
||||
|
||||
// You can access the handler's database or registry if needed
|
||||
// For example, to check permissions in the database:
|
||||
// query := ctx.Handler.db.NewSelect().Table("permissions")...
|
||||
|
||||
// Add your authorization logic here
|
||||
logger.Debug("Authorization check for %s.%s", ctx.Schema, ctx.Entity)
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExampleDataTransformHook modifies data before create/update
|
||||
func ExampleDataTransformHook(ctx *HookContext) error {
|
||||
if dataMap, ok := ctx.Data.(map[string]interface{}); ok {
|
||||
// Example: Add a timestamp or user ID
|
||||
// dataMap["updated_at"] = time.Now()
|
||||
// dataMap["updated_by"] = ctx.Context.Value("user_id")
|
||||
|
||||
// Update the context with modified data
|
||||
ctx.Data = dataMap
|
||||
logger.Debug("Data transformed for %s.%s", ctx.Schema, ctx.Entity)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExampleAuditLogHook creates audit log entries for operations
|
||||
func ExampleAuditLogHook(hookType HookType) HookFunc {
|
||||
return func(ctx *HookContext) error {
|
||||
// Example: Log to audit system
|
||||
auditEntry := map[string]interface{}{
|
||||
"operation": hookType,
|
||||
"schema": ctx.Schema,
|
||||
"entity": ctx.Entity,
|
||||
"table_name": ctx.TableName,
|
||||
"id": ctx.ID,
|
||||
}
|
||||
|
||||
if ctx.Error != nil {
|
||||
auditEntry["error"] = ctx.Error.Error()
|
||||
}
|
||||
|
||||
logger.Info("Audit log: %+v", auditEntry)
|
||||
|
||||
// In a real application, you would save this to a database using the handler
|
||||
// Example:
|
||||
// query := ctx.Handler.db.NewInsert().Table("audit_logs").Model(&auditEntry)
|
||||
// if _, err := query.Exec(ctx.Context); err != nil {
|
||||
// logger.Error("Failed to save audit log: %v", err)
|
||||
// }
|
||||
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// ExampleCacheInvalidationHook invalidates cache after create/update/delete
|
||||
func ExampleCacheInvalidationHook(ctx *HookContext) error {
|
||||
// Example: Invalidate cache for the entity
|
||||
cacheKey := fmt.Sprintf("%s.%s", ctx.Schema, ctx.Entity)
|
||||
logger.Info("Invalidating cache for: %s", cacheKey)
|
||||
|
||||
// Add your cache invalidation logic here
|
||||
// cache.Delete(cacheKey)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExampleFilterSensitiveDataHook removes sensitive data from responses
|
||||
func ExampleFilterSensitiveDataHook(ctx *HookContext) error {
|
||||
// Example: Remove password fields from results
|
||||
// This would be called in AfterRead hooks
|
||||
logger.Debug("Filtering sensitive data for %s.%s", ctx.Schema, ctx.Entity)
|
||||
|
||||
// Add your data filtering logic here
|
||||
// You would iterate through ctx.Result and remove sensitive fields
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ExampleRelatedDataHook fetches related data using the handler's database
|
||||
func ExampleRelatedDataHook(ctx *HookContext) error {
|
||||
// Example: Fetch related data after reading the main entity
|
||||
// This hook demonstrates using ctx.Handler to access the database
|
||||
|
||||
if ctx.Entity == "users" && ctx.Result != nil {
|
||||
// Example: Fetch user's recent activity
|
||||
// userID := ... extract from ctx.Result
|
||||
|
||||
// Use the handler's database to query related data
|
||||
// query := ctx.Handler.db.NewSelect().Table("user_activity").Where("user_id = ?", userID)
|
||||
// var activities []Activity
|
||||
// if err := query.Scan(ctx.Context, &activities); err != nil {
|
||||
// logger.Error("Failed to fetch user activities: %v", err)
|
||||
// return err
|
||||
// }
|
||||
|
||||
// Optionally modify the result to include the related data
|
||||
// if resultMap, ok := ctx.Result.(map[string]interface{}); ok {
|
||||
// resultMap["recent_activities"] = activities
|
||||
// }
|
||||
|
||||
logger.Debug("Fetched related data for user entity")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// SetupExampleHooks demonstrates how to register hooks on a handler
|
||||
func SetupExampleHooks(handler *Handler) {
|
||||
hooks := handler.Hooks()
|
||||
|
||||
// Register logging hooks for all operations
|
||||
hooks.Register(BeforeRead, ExampleLoggingHook(BeforeRead))
|
||||
hooks.Register(AfterRead, ExampleLoggingHook(AfterRead))
|
||||
hooks.Register(BeforeCreate, ExampleLoggingHook(BeforeCreate))
|
||||
hooks.Register(AfterCreate, ExampleLoggingHook(AfterCreate))
|
||||
hooks.Register(BeforeUpdate, ExampleLoggingHook(BeforeUpdate))
|
||||
hooks.Register(AfterUpdate, ExampleLoggingHook(AfterUpdate))
|
||||
hooks.Register(BeforeDelete, ExampleLoggingHook(BeforeDelete))
|
||||
hooks.Register(AfterDelete, ExampleLoggingHook(AfterDelete))
|
||||
|
||||
// Register validation hooks for create/update
|
||||
hooks.Register(BeforeCreate, ExampleValidationHook)
|
||||
hooks.Register(BeforeUpdate, ExampleValidationHook)
|
||||
|
||||
// Register authorization hooks for all operations
|
||||
hooks.RegisterMultiple([]HookType{
|
||||
BeforeRead, BeforeCreate, BeforeUpdate, BeforeDelete,
|
||||
}, ExampleAuthorizationHook)
|
||||
|
||||
// Register data transform hook for create/update
|
||||
hooks.Register(BeforeCreate, ExampleDataTransformHook)
|
||||
hooks.Register(BeforeUpdate, ExampleDataTransformHook)
|
||||
|
||||
// Register audit log hooks for after operations
|
||||
hooks.Register(AfterCreate, ExampleAuditLogHook(AfterCreate))
|
||||
hooks.Register(AfterUpdate, ExampleAuditLogHook(AfterUpdate))
|
||||
hooks.Register(AfterDelete, ExampleAuditLogHook(AfterDelete))
|
||||
|
||||
// Register cache invalidation for after operations
|
||||
hooks.Register(AfterCreate, ExampleCacheInvalidationHook)
|
||||
hooks.Register(AfterUpdate, ExampleCacheInvalidationHook)
|
||||
hooks.Register(AfterDelete, ExampleCacheInvalidationHook)
|
||||
|
||||
// Register sensitive data filtering for read operations
|
||||
hooks.Register(AfterRead, ExampleFilterSensitiveDataHook)
|
||||
|
||||
// Register related data fetching for read operations
|
||||
hooks.Register(AfterRead, ExampleRelatedDataHook)
|
||||
|
||||
logger.Info("Example hooks registered successfully")
|
||||
}
|
||||
347
pkg/restheadspec/hooks_test.go
Normal file
347
pkg/restheadspec/hooks_test.go
Normal file
@@ -0,0 +1,347 @@
|
||||
package restheadspec
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestHookRegistry tests the hook registry functionality
|
||||
func TestHookRegistry(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
// Test registering a hook
|
||||
called := false
|
||||
hook := func(ctx *HookContext) error {
|
||||
called = true
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
|
||||
if registry.Count(BeforeRead) != 1 {
|
||||
t.Errorf("Expected 1 hook, got %d", registry.Count(BeforeRead))
|
||||
}
|
||||
|
||||
// Test executing a hook
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
}
|
||||
|
||||
err := registry.Execute(BeforeRead, ctx)
|
||||
if err != nil {
|
||||
t.Errorf("Hook execution failed: %v", err)
|
||||
}
|
||||
|
||||
if !called {
|
||||
t.Error("Hook was not called")
|
||||
}
|
||||
}
|
||||
|
||||
// TestHookExecution tests hook execution order
|
||||
func TestHookExecutionOrder(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
order := []int{}
|
||||
|
||||
hook1 := func(ctx *HookContext) error {
|
||||
order = append(order, 1)
|
||||
return nil
|
||||
}
|
||||
|
||||
hook2 := func(ctx *HookContext) error {
|
||||
order = append(order, 2)
|
||||
return nil
|
||||
}
|
||||
|
||||
hook3 := func(ctx *HookContext) error {
|
||||
order = append(order, 3)
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeCreate, hook1)
|
||||
registry.Register(BeforeCreate, hook2)
|
||||
registry.Register(BeforeCreate, hook3)
|
||||
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
}
|
||||
|
||||
err := registry.Execute(BeforeCreate, ctx)
|
||||
if err != nil {
|
||||
t.Errorf("Hook execution failed: %v", err)
|
||||
}
|
||||
|
||||
if len(order) != 3 {
|
||||
t.Errorf("Expected 3 hooks to be called, got %d", len(order))
|
||||
}
|
||||
|
||||
if order[0] != 1 || order[1] != 2 || order[2] != 3 {
|
||||
t.Errorf("Hooks executed in wrong order: %v", order)
|
||||
}
|
||||
}
|
||||
|
||||
// TestHookError tests hook error handling
|
||||
func TestHookError(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
executed := []string{}
|
||||
|
||||
hook1 := func(ctx *HookContext) error {
|
||||
executed = append(executed, "hook1")
|
||||
return nil
|
||||
}
|
||||
|
||||
hook2 := func(ctx *HookContext) error {
|
||||
executed = append(executed, "hook2")
|
||||
return fmt.Errorf("hook2 error")
|
||||
}
|
||||
|
||||
hook3 := func(ctx *HookContext) error {
|
||||
executed = append(executed, "hook3")
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeUpdate, hook1)
|
||||
registry.Register(BeforeUpdate, hook2)
|
||||
registry.Register(BeforeUpdate, hook3)
|
||||
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
}
|
||||
|
||||
err := registry.Execute(BeforeUpdate, ctx)
|
||||
if err == nil {
|
||||
t.Error("Expected error from hook execution")
|
||||
}
|
||||
|
||||
if len(executed) != 2 {
|
||||
t.Errorf("Expected only 2 hooks to be executed, got %d", len(executed))
|
||||
}
|
||||
|
||||
if executed[0] != "hook1" || executed[1] != "hook2" {
|
||||
t.Errorf("Unexpected execution order: %v", executed)
|
||||
}
|
||||
}
|
||||
|
||||
// TestHookDataModification tests modifying data in hooks
|
||||
func TestHookDataModification(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
modifyHook := func(ctx *HookContext) error {
|
||||
if dataMap, ok := ctx.Data.(map[string]interface{}); ok {
|
||||
dataMap["modified"] = true
|
||||
ctx.Data = dataMap
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeCreate, modifyHook)
|
||||
|
||||
data := map[string]interface{}{
|
||||
"name": "test",
|
||||
}
|
||||
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
Data: data,
|
||||
}
|
||||
|
||||
err := registry.Execute(BeforeCreate, ctx)
|
||||
if err != nil {
|
||||
t.Errorf("Hook execution failed: %v", err)
|
||||
}
|
||||
|
||||
modifiedData := ctx.Data.(map[string]interface{})
|
||||
if !modifiedData["modified"].(bool) {
|
||||
t.Error("Data was not modified by hook")
|
||||
}
|
||||
}
|
||||
|
||||
// TestRegisterMultiple tests registering a hook for multiple types
|
||||
func TestRegisterMultiple(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
called := 0
|
||||
hook := func(ctx *HookContext) error {
|
||||
called++
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.RegisterMultiple([]HookType{
|
||||
BeforeRead,
|
||||
BeforeCreate,
|
||||
BeforeUpdate,
|
||||
}, hook)
|
||||
|
||||
if registry.Count(BeforeRead) != 1 {
|
||||
t.Error("Hook not registered for BeforeRead")
|
||||
}
|
||||
if registry.Count(BeforeCreate) != 1 {
|
||||
t.Error("Hook not registered for BeforeCreate")
|
||||
}
|
||||
if registry.Count(BeforeUpdate) != 1 {
|
||||
t.Error("Hook not registered for BeforeUpdate")
|
||||
}
|
||||
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
}
|
||||
|
||||
registry.Execute(BeforeRead, ctx)
|
||||
registry.Execute(BeforeCreate, ctx)
|
||||
registry.Execute(BeforeUpdate, ctx)
|
||||
|
||||
if called != 3 {
|
||||
t.Errorf("Expected hook to be called 3 times, got %d", called)
|
||||
}
|
||||
}
|
||||
|
||||
// TestClearHooks tests clearing hooks
|
||||
func TestClearHooks(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
hook := func(ctx *HookContext) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
registry.Register(BeforeCreate, hook)
|
||||
|
||||
if registry.Count(BeforeRead) != 1 {
|
||||
t.Error("Hook not registered")
|
||||
}
|
||||
|
||||
registry.Clear(BeforeRead)
|
||||
|
||||
if registry.Count(BeforeRead) != 0 {
|
||||
t.Error("Hook not cleared")
|
||||
}
|
||||
|
||||
if registry.Count(BeforeCreate) != 1 {
|
||||
t.Error("Wrong hook was cleared")
|
||||
}
|
||||
}
|
||||
|
||||
// TestClearAllHooks tests clearing all hooks
|
||||
func TestClearAllHooks(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
hook := func(ctx *HookContext) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
registry.Register(BeforeCreate, hook)
|
||||
registry.Register(BeforeUpdate, hook)
|
||||
|
||||
registry.ClearAll()
|
||||
|
||||
if registry.Count(BeforeRead) != 0 || registry.Count(BeforeCreate) != 0 || registry.Count(BeforeUpdate) != 0 {
|
||||
t.Error("Not all hooks were cleared")
|
||||
}
|
||||
}
|
||||
|
||||
// TestHasHooks tests checking if hooks exist
|
||||
func TestHasHooks(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
if registry.HasHooks(BeforeRead) {
|
||||
t.Error("Should not have hooks initially")
|
||||
}
|
||||
|
||||
hook := func(ctx *HookContext) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
|
||||
if !registry.HasHooks(BeforeRead) {
|
||||
t.Error("Should have hooks after registration")
|
||||
}
|
||||
}
|
||||
|
||||
// TestGetAllHookTypes tests getting all registered hook types
|
||||
func TestGetAllHookTypes(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
hook := func(ctx *HookContext) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
registry.Register(BeforeCreate, hook)
|
||||
registry.Register(AfterUpdate, hook)
|
||||
|
||||
types := registry.GetAllHookTypes()
|
||||
|
||||
if len(types) != 3 {
|
||||
t.Errorf("Expected 3 hook types, got %d", len(types))
|
||||
}
|
||||
|
||||
// Verify all expected types are present
|
||||
expectedTypes := map[HookType]bool{
|
||||
BeforeRead: true,
|
||||
BeforeCreate: true,
|
||||
AfterUpdate: true,
|
||||
}
|
||||
|
||||
for _, hookType := range types {
|
||||
if !expectedTypes[hookType] {
|
||||
t.Errorf("Unexpected hook type: %s", hookType)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestHookContextHandler tests that hooks can access the handler
|
||||
func TestHookContextHandler(t *testing.T) {
|
||||
registry := NewHookRegistry()
|
||||
|
||||
var capturedHandler *Handler
|
||||
|
||||
hook := func(ctx *HookContext) error {
|
||||
// Verify that the handler is accessible from the context
|
||||
if ctx.Handler == nil {
|
||||
return fmt.Errorf("handler is nil in hook context")
|
||||
}
|
||||
capturedHandler = ctx.Handler
|
||||
return nil
|
||||
}
|
||||
|
||||
registry.Register(BeforeRead, hook)
|
||||
|
||||
// Create a mock handler
|
||||
handler := &Handler{
|
||||
hooks: registry,
|
||||
}
|
||||
|
||||
ctx := &HookContext{
|
||||
Context: context.Background(),
|
||||
Handler: handler,
|
||||
Schema: "test",
|
||||
Entity: "users",
|
||||
}
|
||||
|
||||
err := registry.Execute(BeforeRead, ctx)
|
||||
if err != nil {
|
||||
t.Errorf("Hook execution failed: %v", err)
|
||||
}
|
||||
|
||||
if capturedHandler == nil {
|
||||
t.Error("Handler was not captured from hook context")
|
||||
}
|
||||
|
||||
if capturedHandler != handler {
|
||||
t.Error("Captured handler does not match original handler")
|
||||
}
|
||||
}
|
||||
@@ -55,9 +55,9 @@ package restheadspec
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common/adapters/database"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/common/adapters/router"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common/adapters/database"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/common/adapters/router"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/gorilla/mux"
|
||||
"github.com/uptrace/bun"
|
||||
"github.com/uptrace/bunrouter"
|
||||
|
||||
203
pkg/restheadspec/rownumber_test.go
Normal file
203
pkg/restheadspec/rownumber_test.go
Normal file
@@ -0,0 +1,203 @@
|
||||
package restheadspec
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
// TestModel represents a typical model with RowNumber field (like DBAdhocBuffer)
|
||||
type TestModel struct {
|
||||
ID int64 `json:"id" bun:"id,pk"`
|
||||
Name string `json:"name" bun:"name"`
|
||||
RowNumber int64 `json:"_rownumber,omitempty" gorm:"-" bun:"-"`
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
records any
|
||||
offset int
|
||||
expected []int64
|
||||
}{
|
||||
{
|
||||
name: "Set row numbers on slice of pointers",
|
||||
records: []*TestModel{
|
||||
{ID: 1, Name: "First"},
|
||||
{ID: 2, Name: "Second"},
|
||||
{ID: 3, Name: "Third"},
|
||||
},
|
||||
offset: 0,
|
||||
expected: []int64{1, 2, 3},
|
||||
},
|
||||
{
|
||||
name: "Set row numbers with offset",
|
||||
records: []*TestModel{
|
||||
{ID: 11, Name: "Eleventh"},
|
||||
{ID: 12, Name: "Twelfth"},
|
||||
},
|
||||
offset: 10,
|
||||
expected: []int64{11, 12},
|
||||
},
|
||||
{
|
||||
name: "Set row numbers on slice of values",
|
||||
records: []TestModel{
|
||||
{ID: 1, Name: "First"},
|
||||
{ID: 2, Name: "Second"},
|
||||
},
|
||||
offset: 5,
|
||||
expected: []int64{6, 7},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
handler.setRowNumbersOnRecords(tt.records, tt.offset)
|
||||
|
||||
// Verify row numbers were set correctly
|
||||
switch records := tt.records.(type) {
|
||||
case []*TestModel:
|
||||
assert.Equal(t, len(tt.expected), len(records))
|
||||
for i, record := range records {
|
||||
assert.Equal(t, tt.expected[i], record.RowNumber,
|
||||
"Record %d should have RowNumber=%d", i, tt.expected[i])
|
||||
}
|
||||
case []TestModel:
|
||||
assert.Equal(t, len(tt.expected), len(records))
|
||||
for i, record := range records {
|
||||
assert.Equal(t, tt.expected[i], record.RowNumber,
|
||||
"Record %d should have RowNumber=%d", i, tt.expected[i])
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords_NoRowNumberField(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
// Model without RowNumber field
|
||||
type SimpleModel struct {
|
||||
ID int64 `json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
records := []*SimpleModel{
|
||||
{ID: 1, Name: "First"},
|
||||
{ID: 2, Name: "Second"},
|
||||
}
|
||||
|
||||
// Should not panic when model doesn't have RowNumber field
|
||||
assert.NotPanics(t, func() {
|
||||
handler.setRowNumbersOnRecords(records, 0)
|
||||
})
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords_NilRecords(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
records := []*TestModel{
|
||||
{ID: 1, Name: "First"},
|
||||
nil, // Nil record
|
||||
{ID: 3, Name: "Third"},
|
||||
}
|
||||
|
||||
// Should not panic with nil records
|
||||
assert.NotPanics(t, func() {
|
||||
handler.setRowNumbersOnRecords(records, 0)
|
||||
})
|
||||
|
||||
// Verify non-nil records were set
|
||||
assert.Equal(t, int64(1), records[0].RowNumber)
|
||||
assert.Equal(t, int64(3), records[2].RowNumber)
|
||||
}
|
||||
|
||||
// DBAdhocBuffer simulates the actual DBAdhocBuffer from db package
|
||||
type DBAdhocBuffer struct {
|
||||
CQL1 string `json:"cql1,omitempty" gorm:"->" bun:"-"`
|
||||
RowNumber int64 `json:"_rownumber,omitempty" gorm:"-" bun:"-"`
|
||||
}
|
||||
|
||||
// ModelWithEmbeddedBuffer simulates a real model like ModelPublicConsultant
|
||||
type ModelWithEmbeddedBuffer struct {
|
||||
ID int64 `json:"id" bun:"id,pk"`
|
||||
Name string `json:"name" bun:"name"`
|
||||
|
||||
DBAdhocBuffer `json:",omitempty"` // Embedded struct containing RowNumber
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords_EmbeddedBuffer(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
// Test with embedded DBAdhocBuffer (like real models)
|
||||
records := []*ModelWithEmbeddedBuffer{
|
||||
{ID: 1, Name: "First"},
|
||||
{ID: 2, Name: "Second"},
|
||||
{ID: 3, Name: "Third"},
|
||||
}
|
||||
|
||||
handler.setRowNumbersOnRecords(records, 10)
|
||||
|
||||
// Verify row numbers were set on embedded field
|
||||
assert.Equal(t, int64(11), records[0].RowNumber, "First record should have RowNumber=11")
|
||||
assert.Equal(t, int64(12), records[1].RowNumber, "Second record should have RowNumber=12")
|
||||
assert.Equal(t, int64(13), records[2].RowNumber, "Third record should have RowNumber=13")
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords_EmbeddedBuffer_SliceOfValues(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
// Test with slice of values (not pointers)
|
||||
records := []ModelWithEmbeddedBuffer{
|
||||
{ID: 1, Name: "First"},
|
||||
{ID: 2, Name: "Second"},
|
||||
}
|
||||
|
||||
handler.setRowNumbersOnRecords(records, 0)
|
||||
|
||||
// Verify row numbers were set on embedded field
|
||||
assert.Equal(t, int64(1), records[0].RowNumber, "First record should have RowNumber=1")
|
||||
assert.Equal(t, int64(2), records[1].RowNumber, "Second record should have RowNumber=2")
|
||||
}
|
||||
|
||||
// Simulate the exact structure from user's code
|
||||
type MockDBAdhocBuffer struct {
|
||||
CQL1 string `json:"cql1,omitempty" gorm:"->" bun:"-"`
|
||||
CQL2 string `json:"cql2,omitempty" gorm:"->" bun:"-"`
|
||||
RowNumber int64 `json:"_rownumber,omitempty" gorm:"-" bun:"-"`
|
||||
Request string `json:"_request,omitempty" gorm:"-" bun:"-"`
|
||||
}
|
||||
|
||||
// Exact structure like ModelPublicConsultant
|
||||
type ModelPublicConsultant struct {
|
||||
Consultant string `json:"consultant" bun:"consultant,type:citext,pk"`
|
||||
Ridconsultant int32 `json:"rid_consultant" bun:"rid_consultant,type:integer,pk"`
|
||||
Updatecnt int64 `json:"updatecnt" bun:"updatecnt,type:integer,default:0"`
|
||||
|
||||
MockDBAdhocBuffer `json:",omitempty"` // Embedded - RowNumber is here!
|
||||
}
|
||||
|
||||
func TestSetRowNumbersOnRecords_RealModelStructure(t *testing.T) {
|
||||
handler := &Handler{}
|
||||
|
||||
// Test with exact structure from user's ModelPublicConsultant
|
||||
records := []*ModelPublicConsultant{
|
||||
{Consultant: "John Doe", Ridconsultant: 1, Updatecnt: 0},
|
||||
{Consultant: "Jane Smith", Ridconsultant: 2, Updatecnt: 0},
|
||||
{Consultant: "Bob Johnson", Ridconsultant: 3, Updatecnt: 0},
|
||||
}
|
||||
|
||||
handler.setRowNumbersOnRecords(records, 100)
|
||||
|
||||
// Verify row numbers were set correctly in the embedded DBAdhocBuffer
|
||||
assert.Equal(t, int64(101), records[0].RowNumber, "First consultant should have RowNumber=101")
|
||||
assert.Equal(t, int64(102), records[1].RowNumber, "Second consultant should have RowNumber=102")
|
||||
assert.Equal(t, int64(103), records[2].RowNumber, "Third consultant should have RowNumber=103")
|
||||
|
||||
t.Logf("✓ RowNumber correctly set in embedded MockDBAdhocBuffer")
|
||||
t.Logf(" Record 0: Consultant=%s, RowNumber=%d", records[0].Consultant, records[0].RowNumber)
|
||||
t.Logf(" Record 1: Consultant=%s, RowNumber=%d", records[1].Consultant, records[1].RowNumber)
|
||||
t.Logf(" Record 2: Consultant=%s, RowNumber=%d", records[2].Consultant, records[2].RowNumber)
|
||||
}
|
||||
662
pkg/security/CALLBACKS_GUIDE.md
Normal file
662
pkg/security/CALLBACKS_GUIDE.md
Normal file
@@ -0,0 +1,662 @@
|
||||
# Security Provider Callbacks Guide
|
||||
|
||||
## Overview
|
||||
|
||||
The ResolveSpec security provider uses a **callback-based architecture** that requires you to implement three functions:
|
||||
|
||||
1. **AuthenticateCallback** - Extract user credentials from HTTP requests
|
||||
2. **LoadColumnSecurityCallback** - Load column security rules for masking/hiding
|
||||
3. **LoadRowSecurityCallback** - Load row security filters (WHERE clauses)
|
||||
|
||||
This design allows you to integrate the security provider with **any** authentication system and database schema.
|
||||
|
||||
---
|
||||
|
||||
## Why Callbacks?
|
||||
|
||||
The callback-based design provides:
|
||||
|
||||
✅ **Flexibility** - Works with any auth system (JWT, session, OAuth, custom)
|
||||
✅ **Database Agnostic** - No assumptions about your security table schema
|
||||
✅ **Testability** - Easy to mock for unit tests
|
||||
✅ **Extensibility** - Add custom logic without modifying core code
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Step 1: Implement the Three Callbacks
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/security"
|
||||
)
|
||||
|
||||
// 1. Authentication: Extract user from request
|
||||
func myAuthFunction(r *http.Request) (userID int, roles string, err error) {
|
||||
// Your auth logic here (JWT, session, header, etc.)
|
||||
token := r.Header.Get("Authorization")
|
||||
userID, roles, err = validateToken(token)
|
||||
return userID, roles, err
|
||||
}
|
||||
|
||||
// 2. Column Security: Load column masking rules
|
||||
func myLoadColumnSecurity(userID int, schema, tablename string) ([]security.ColumnSecurity, error) {
|
||||
// Your database query or config lookup here
|
||||
return loadColumnRulesFromDatabase(userID, schema, tablename)
|
||||
}
|
||||
|
||||
// 3. Row Security: Load row filtering rules
|
||||
func myLoadRowSecurity(userID int, schema, tablename string) (security.RowSecurity, error) {
|
||||
// Your database query or config lookup here
|
||||
return loadRowRulesFromDatabase(userID, schema, tablename)
|
||||
}
|
||||
```
|
||||
|
||||
### Step 2: Configure the Callbacks
|
||||
|
||||
```go
|
||||
func main() {
|
||||
db := setupDatabase()
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Configure callbacks BEFORE SetupSecurityProvider
|
||||
security.GlobalSecurity.AuthenticateCallback = myAuthFunction
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = myLoadColumnSecurity
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = myLoadRowSecurity
|
||||
|
||||
// Setup security provider (validates callbacks are set)
|
||||
if err := security.SetupSecurityProvider(handler, &security.GlobalSecurity); err != nil {
|
||||
log.Fatal(err) // Fails if callbacks not configured
|
||||
}
|
||||
|
||||
// Apply middleware
|
||||
router := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
router.Use(mux.MiddlewareFunc(security.AuthMiddleware))
|
||||
router.Use(mux.MiddlewareFunc(security.SetSecurityMiddleware))
|
||||
|
||||
http.ListenAndServe(":8080", router)
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Callback 1: AuthenticateCallback
|
||||
|
||||
### Function Signature
|
||||
|
||||
```go
|
||||
func(r *http.Request) (userID int, roles string, err error)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
- `r *http.Request` - The incoming HTTP request
|
||||
|
||||
### Returns
|
||||
- `userID int` - The authenticated user's ID
|
||||
- `roles string` - User's roles (comma-separated, e.g., "admin,manager")
|
||||
- `err error` - Return error to reject the request (HTTP 401)
|
||||
|
||||
### Example Implementations
|
||||
|
||||
#### Simple Header-Based Auth
|
||||
```go
|
||||
func authenticateFromHeader(r *http.Request) (int, string, error) {
|
||||
userIDStr := r.Header.Get("X-User-ID")
|
||||
if userIDStr == "" {
|
||||
return 0, "", fmt.Errorf("X-User-ID header required")
|
||||
}
|
||||
|
||||
userID, err := strconv.Atoi(userIDStr)
|
||||
if err != nil {
|
||||
return 0, "", fmt.Errorf("invalid user ID")
|
||||
}
|
||||
|
||||
roles := r.Header.Get("X-User-Roles") // Optional
|
||||
return userID, roles, nil
|
||||
}
|
||||
```
|
||||
|
||||
#### JWT Token Auth
|
||||
```go
|
||||
import "github.com/golang-jwt/jwt/v5"
|
||||
|
||||
func authenticateFromJWT(r *http.Request) (int, string, error) {
|
||||
authHeader := r.Header.Get("Authorization")
|
||||
tokenString := strings.TrimPrefix(authHeader, "Bearer ")
|
||||
|
||||
token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
|
||||
return []byte(os.Getenv("JWT_SECRET")), nil
|
||||
})
|
||||
|
||||
if err != nil || !token.Valid {
|
||||
return 0, "", fmt.Errorf("invalid token")
|
||||
}
|
||||
|
||||
claims := token.Claims.(jwt.MapClaims)
|
||||
userID := int(claims["user_id"].(float64))
|
||||
roles := claims["roles"].(string)
|
||||
|
||||
return userID, roles, nil
|
||||
}
|
||||
```
|
||||
|
||||
#### Session Cookie Auth
|
||||
```go
|
||||
func authenticateFromSession(r *http.Request) (int, string, error) {
|
||||
cookie, err := r.Cookie("session_id")
|
||||
if err != nil {
|
||||
return 0, "", fmt.Errorf("no session cookie")
|
||||
}
|
||||
|
||||
session, err := sessionStore.Get(cookie.Value)
|
||||
if err != nil {
|
||||
return 0, "", fmt.Errorf("invalid session")
|
||||
}
|
||||
|
||||
return session.UserID, session.Roles, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Callback 2: LoadColumnSecurityCallback
|
||||
|
||||
### Function Signature
|
||||
|
||||
```go
|
||||
func(pUserID int, pSchema, pTablename string) ([]ColumnSecurity, error)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
- `pUserID int` - The authenticated user's ID
|
||||
- `pSchema string` - Database schema (e.g., "public")
|
||||
- `pTablename string` - Table name (e.g., "employees")
|
||||
|
||||
### Returns
|
||||
- `[]ColumnSecurity` - List of column security rules
|
||||
- `error` - Return error if loading fails
|
||||
|
||||
### ColumnSecurity Structure
|
||||
|
||||
```go
|
||||
type ColumnSecurity struct {
|
||||
Schema string // "public"
|
||||
Tablename string // "employees"
|
||||
Path []string // ["ssn"] or ["address", "street"]
|
||||
Accesstype string // "mask" or "hide"
|
||||
|
||||
// Masking configuration (for Accesstype = "mask")
|
||||
MaskStart int // Mask first N characters
|
||||
MaskEnd int // Mask last N characters
|
||||
MaskInvert bool // true = mask middle, false = mask edges
|
||||
MaskChar string // Character to use for masking (default "*")
|
||||
|
||||
// Optional fields
|
||||
ExtraFilters map[string]string
|
||||
Control string
|
||||
ID int
|
||||
UserID int
|
||||
}
|
||||
```
|
||||
|
||||
### Example Implementations
|
||||
|
||||
#### Load from Database
|
||||
```go
|
||||
func loadColumnSecurityFromDB(userID int, schema, tablename string) ([]security.ColumnSecurity, error) {
|
||||
var rules []security.ColumnSecurity
|
||||
|
||||
query := `
|
||||
SELECT control, accesstype, jsonvalue
|
||||
FROM core.secacces
|
||||
WHERE rid_hub IN (
|
||||
SELECT rid_hub_parent FROM core.hub_link
|
||||
WHERE rid_hub_child = ? AND parent_hubtype = 'secgroup'
|
||||
)
|
||||
AND control ILIKE ?
|
||||
`
|
||||
|
||||
rows, err := db.Query(query, userID, fmt.Sprintf("%s.%s%%", schema, tablename))
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer rows.Close()
|
||||
|
||||
for rows.Next() {
|
||||
var control, accesstype, jsonValue string
|
||||
rows.Scan(&control, &accesstype, &jsonValue)
|
||||
|
||||
// Parse control: "schema.table.column"
|
||||
parts := strings.Split(control, ".")
|
||||
if len(parts) < 3 {
|
||||
continue
|
||||
}
|
||||
|
||||
rule := security.ColumnSecurity{
|
||||
Schema: schema,
|
||||
Tablename: tablename,
|
||||
Path: parts[2:],
|
||||
Accesstype: accesstype,
|
||||
}
|
||||
|
||||
// Parse JSON configuration
|
||||
var config map[string]interface{}
|
||||
json.Unmarshal([]byte(jsonValue), &config)
|
||||
if start, ok := config["start"].(float64); ok {
|
||||
rule.MaskStart = int(start)
|
||||
}
|
||||
if end, ok := config["end"].(float64); ok {
|
||||
rule.MaskEnd = int(end)
|
||||
}
|
||||
if char, ok := config["char"].(string); ok {
|
||||
rule.MaskChar = char
|
||||
}
|
||||
|
||||
rules = append(rules, rule)
|
||||
}
|
||||
|
||||
return rules, nil
|
||||
}
|
||||
```
|
||||
|
||||
#### Load from Static Config
|
||||
```go
|
||||
func loadColumnSecurityFromConfig(userID int, schema, tablename string) ([]security.ColumnSecurity, error) {
|
||||
// Define security rules in code
|
||||
allRules := map[string][]security.ColumnSecurity{
|
||||
"public.employees": {
|
||||
{
|
||||
Schema: "public",
|
||||
Tablename: "employees",
|
||||
Path: []string{"ssn"},
|
||||
Accesstype: "mask",
|
||||
MaskStart: 5,
|
||||
MaskChar: "*",
|
||||
},
|
||||
{
|
||||
Schema: "public",
|
||||
Tablename: "employees",
|
||||
Path: []string{"salary"},
|
||||
Accesstype: "hide",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
key := fmt.Sprintf("%s.%s", schema, tablename)
|
||||
rules, ok := allRules[key]
|
||||
if !ok {
|
||||
return []security.ColumnSecurity{}, nil // No rules
|
||||
}
|
||||
|
||||
return rules, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Column Security Examples
|
||||
|
||||
**Mask SSN (show last 4 digits):**
|
||||
```go
|
||||
ColumnSecurity{
|
||||
Path: []string{"ssn"},
|
||||
Accesstype: "mask",
|
||||
MaskStart: 5, // Mask first 5 characters
|
||||
MaskEnd: 0, // Keep last 4 visible
|
||||
MaskChar: "*",
|
||||
}
|
||||
// Result: "123-45-6789" → "*****6789"
|
||||
```
|
||||
|
||||
**Hide entire field:**
|
||||
```go
|
||||
ColumnSecurity{
|
||||
Path: []string{"salary"},
|
||||
Accesstype: "hide",
|
||||
}
|
||||
// Result: salary field returns 0 or empty
|
||||
```
|
||||
|
||||
**Mask credit card (show last 4 digits):**
|
||||
```go
|
||||
ColumnSecurity{
|
||||
Path: []string{"credit_card"},
|
||||
Accesstype: "mask",
|
||||
MaskStart: 12,
|
||||
MaskChar: "*",
|
||||
}
|
||||
// Result: "1234-5678-9012-3456" → "************3456"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Callback 3: LoadRowSecurityCallback
|
||||
|
||||
### Function Signature
|
||||
|
||||
```go
|
||||
func(pUserID int, pSchema, pTablename string) (RowSecurity, error)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
- `pUserID int` - The authenticated user's ID
|
||||
- `pSchema string` - Database schema
|
||||
- `pTablename string` - Table name
|
||||
|
||||
### Returns
|
||||
- `RowSecurity` - Row security configuration
|
||||
- `error` - Return error if loading fails
|
||||
|
||||
### RowSecurity Structure
|
||||
|
||||
```go
|
||||
type RowSecurity struct {
|
||||
Schema string // "public"
|
||||
Tablename string // "orders"
|
||||
UserID int // Current user ID
|
||||
Template string // WHERE clause template (e.g., "user_id = {UserID}")
|
||||
HasBlock bool // If true, block ALL access to this table
|
||||
}
|
||||
```
|
||||
|
||||
### Template Variables
|
||||
|
||||
You can use these placeholders in the `Template` string:
|
||||
- `{UserID}` - Current user's ID
|
||||
- `{PrimaryKeyName}` - Primary key column name
|
||||
- `{TableName}` - Table name
|
||||
- `{SchemaName}` - Schema name
|
||||
|
||||
### Example Implementations
|
||||
|
||||
#### Load from Database Function
|
||||
```go
|
||||
func loadRowSecurityFromDB(userID int, schema, tablename string) (security.RowSecurity, error) {
|
||||
var record security.RowSecurity
|
||||
|
||||
query := `
|
||||
SELECT p_template, p_block
|
||||
FROM core.api_sec_rowtemplate(?, ?, ?)
|
||||
`
|
||||
|
||||
row := db.QueryRow(query, schema, tablename, userID)
|
||||
err := row.Scan(&record.Template, &record.HasBlock)
|
||||
if err != nil {
|
||||
return security.RowSecurity{}, err
|
||||
}
|
||||
|
||||
record.Schema = schema
|
||||
record.Tablename = tablename
|
||||
record.UserID = userID
|
||||
|
||||
return record, nil
|
||||
}
|
||||
```
|
||||
|
||||
#### Load from Static Config
|
||||
```go
|
||||
func loadRowSecurityFromConfig(userID int, schema, tablename string) (security.RowSecurity, error) {
|
||||
key := fmt.Sprintf("%s.%s", schema, tablename)
|
||||
|
||||
// Define templates for each table
|
||||
templates := map[string]string{
|
||||
"public.orders": "user_id = {UserID}",
|
||||
"public.documents": "user_id = {UserID} OR is_public = true",
|
||||
}
|
||||
|
||||
// Define blocked tables
|
||||
blocked := map[string]bool{
|
||||
"public.admin_logs": true,
|
||||
}
|
||||
|
||||
if blocked[key] {
|
||||
return security.RowSecurity{
|
||||
Schema: schema,
|
||||
Tablename: tablename,
|
||||
UserID: userID,
|
||||
HasBlock: true,
|
||||
}, nil
|
||||
}
|
||||
|
||||
template, ok := templates[key]
|
||||
if !ok {
|
||||
// No row security - allow all rows
|
||||
return security.RowSecurity{
|
||||
Schema: schema,
|
||||
Tablename: tablename,
|
||||
UserID: userID,
|
||||
Template: "",
|
||||
HasBlock: false,
|
||||
}, nil
|
||||
}
|
||||
|
||||
return security.RowSecurity{
|
||||
Schema: schema,
|
||||
Tablename: tablename,
|
||||
UserID: userID,
|
||||
Template: template,
|
||||
HasBlock: false,
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Row Security Examples
|
||||
|
||||
**Users see only their own records:**
|
||||
```go
|
||||
RowSecurity{
|
||||
Template: "user_id = {UserID}",
|
||||
}
|
||||
// Query: SELECT * FROM orders WHERE user_id = 123
|
||||
```
|
||||
|
||||
**Users see their records OR public records:**
|
||||
```go
|
||||
RowSecurity{
|
||||
Template: "user_id = {UserID} OR is_public = true",
|
||||
}
|
||||
```
|
||||
|
||||
**Complex filter with subquery:**
|
||||
```go
|
||||
RowSecurity{
|
||||
Template: "department_id IN (SELECT department_id FROM user_departments WHERE user_id = {UserID})",
|
||||
}
|
||||
```
|
||||
|
||||
**Block all access:**
|
||||
```go
|
||||
RowSecurity{
|
||||
HasBlock: true,
|
||||
}
|
||||
// All queries to this table will be rejected
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Complete Integration Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"strconv"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/security"
|
||||
"github.com/gorilla/mux"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
func main() {
|
||||
db := setupDatabase()
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
handler.RegisterModel("public", "orders", Order{})
|
||||
|
||||
// ===== CONFIGURE CALLBACKS =====
|
||||
security.GlobalSecurity.AuthenticateCallback = authenticateUser
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = loadColumnSec
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = loadRowSec
|
||||
|
||||
// ===== SETUP SECURITY =====
|
||||
if err := security.SetupSecurityProvider(handler, &security.GlobalSecurity); err != nil {
|
||||
log.Fatal("Security setup failed:", err)
|
||||
}
|
||||
|
||||
// ===== SETUP ROUTES =====
|
||||
router := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
router.Use(mux.MiddlewareFunc(security.AuthMiddleware))
|
||||
router.Use(mux.MiddlewareFunc(security.SetSecurityMiddleware))
|
||||
|
||||
log.Println("Server starting on :8080")
|
||||
http.ListenAndServe(":8080", router)
|
||||
}
|
||||
|
||||
// Callback implementations
|
||||
func authenticateUser(r *http.Request) (int, string, error) {
|
||||
userIDStr := r.Header.Get("X-User-ID")
|
||||
if userIDStr == "" {
|
||||
return 0, "", fmt.Errorf("authentication required")
|
||||
}
|
||||
userID, err := strconv.Atoi(userIDStr)
|
||||
return userID, "", err
|
||||
}
|
||||
|
||||
func loadColumnSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
// Your implementation here
|
||||
return []security.ColumnSecurity{}, nil
|
||||
}
|
||||
|
||||
func loadRowSec(userID int, schema, table string) (security.RowSecurity, error) {
|
||||
return security.RowSecurity{
|
||||
Schema: schema,
|
||||
Tablename: table,
|
||||
UserID: userID,
|
||||
Template: "user_id = " + strconv.Itoa(userID),
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Testing Your Callbacks
|
||||
|
||||
### Unit Test Example
|
||||
|
||||
```go
|
||||
func TestAuthCallback(t *testing.T) {
|
||||
req := httptest.NewRequest("GET", "/api/orders", nil)
|
||||
req.Header.Set("X-User-ID", "123")
|
||||
|
||||
userID, roles, err := myAuthFunction(req)
|
||||
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, 123, userID)
|
||||
}
|
||||
|
||||
func TestColumnSecurityCallback(t *testing.T) {
|
||||
rules, err := myLoadColumnSecurity(123, "public", "employees")
|
||||
|
||||
assert.Nil(t, err)
|
||||
assert.Greater(t, len(rules), 0)
|
||||
assert.Equal(t, "mask", rules[0].Accesstype)
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Pattern 1: Role-Based Security
|
||||
|
||||
```go
|
||||
func loadColumnSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
roles := getUserRoles(userID)
|
||||
|
||||
if contains(roles, "admin") {
|
||||
// Admins see everything
|
||||
return []security.ColumnSecurity{}, nil
|
||||
}
|
||||
|
||||
// Non-admins have restrictions
|
||||
return []security.ColumnSecurity{
|
||||
{Path: []string{"ssn"}, Accesstype: "mask"},
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 2: Tenant Isolation
|
||||
|
||||
```go
|
||||
func loadRowSec(userID int, schema, table string) (security.RowSecurity, error) {
|
||||
tenantID := getUserTenant(userID)
|
||||
|
||||
return security.RowSecurity{
|
||||
Template: fmt.Sprintf("tenant_id = %d", tenantID),
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 3: Caching Security Rules
|
||||
|
||||
```go
|
||||
var securityCache = cache.New(5*time.Minute, 10*time.Minute)
|
||||
|
||||
func loadColumnSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
cacheKey := fmt.Sprintf("%d:%s.%s", userID, schema, table)
|
||||
|
||||
if cached, found := securityCache.Get(cacheKey); found {
|
||||
return cached.([]security.ColumnSecurity), nil
|
||||
}
|
||||
|
||||
rules := loadFromDatabase(userID, schema, table)
|
||||
securityCache.Set(cacheKey, rules, cache.DefaultExpiration)
|
||||
|
||||
return rules, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error: "AuthenticateCallback not set"
|
||||
**Solution:** Configure all three callbacks before calling `SetupSecurityProvider`:
|
||||
```go
|
||||
security.GlobalSecurity.AuthenticateCallback = myAuthFunc
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = myColSecFunc
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = myRowSecFunc
|
||||
```
|
||||
|
||||
### Error: "Authentication failed"
|
||||
**Solution:** Check your `AuthenticateCallback` implementation. Ensure it returns valid user ID or proper error.
|
||||
|
||||
### Security rules not applying
|
||||
**Solution:**
|
||||
1. Check callbacks are returning data
|
||||
2. Enable debug logging
|
||||
3. Verify database queries return results
|
||||
4. Check user has security groups assigned
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Implement the three callbacks for your system
|
||||
2. ✅ Configure `GlobalSecurity` with your callbacks
|
||||
3. ✅ Call `SetupSecurityProvider`
|
||||
4. ✅ Test with different users and verify isolation
|
||||
5. ✅ Review `callbacks_example.go` for more examples
|
||||
|
||||
For complete working examples, see:
|
||||
- `pkg/security/callbacks_example.go` - 7 example implementations
|
||||
- `examples/secure_server/main.go` - Full server example
|
||||
- `pkg/security/README.md` - Comprehensive documentation
|
||||
402
pkg/security/QUICK_REFERENCE.md
Normal file
402
pkg/security/QUICK_REFERENCE.md
Normal file
@@ -0,0 +1,402 @@
|
||||
# Security Provider - Quick Reference
|
||||
|
||||
## 3-Step Setup
|
||||
|
||||
```go
|
||||
// Step 1: Implement callbacks
|
||||
func myAuth(r *http.Request) (int, string, error) { /* ... */ }
|
||||
func myColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) { /* ... */ }
|
||||
func myRowSec(userID int, schema, table string) (security.RowSecurity, error) { /* ... */ }
|
||||
|
||||
// Step 2: Configure callbacks
|
||||
security.GlobalSecurity.AuthenticateCallback = myAuth
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = myColSec
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = myRowSec
|
||||
|
||||
// Step 3: Setup and apply middleware
|
||||
security.SetupSecurityProvider(handler, &security.GlobalSecurity)
|
||||
router.Use(mux.MiddlewareFunc(security.AuthMiddleware))
|
||||
router.Use(mux.MiddlewareFunc(security.SetSecurityMiddleware))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Callback Signatures
|
||||
|
||||
```go
|
||||
// 1. Authentication
|
||||
func(r *http.Request) (userID int, roles string, err error)
|
||||
|
||||
// 2. Column Security
|
||||
func(userID int, schema, tablename string) ([]ColumnSecurity, error)
|
||||
|
||||
// 3. Row Security
|
||||
func(userID int, schema, tablename string) (RowSecurity, error)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ColumnSecurity Structure
|
||||
|
||||
```go
|
||||
security.ColumnSecurity{
|
||||
Path: []string{"column_name"}, // ["ssn"] or ["address", "street"]
|
||||
Accesstype: "mask", // "mask" or "hide"
|
||||
MaskStart: 5, // Mask first N chars
|
||||
MaskEnd: 0, // Mask last N chars
|
||||
MaskChar: "*", // Masking character
|
||||
MaskInvert: false, // true = mask middle
|
||||
}
|
||||
```
|
||||
|
||||
### Common Examples
|
||||
|
||||
```go
|
||||
// Hide entire field
|
||||
{Path: []string{"salary"}, Accesstype: "hide"}
|
||||
|
||||
// Mask SSN (show last 4)
|
||||
{Path: []string{"ssn"}, Accesstype: "mask", MaskStart: 5}
|
||||
|
||||
// Mask credit card (show last 4)
|
||||
{Path: []string{"credit_card"}, Accesstype: "mask", MaskStart: 12}
|
||||
|
||||
// Mask email (j***@example.com)
|
||||
{Path: []string{"email"}, Accesstype: "mask", MaskStart: 1, MaskEnd: 0}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## RowSecurity Structure
|
||||
|
||||
```go
|
||||
security.RowSecurity{
|
||||
Schema: "public",
|
||||
Tablename: "orders",
|
||||
UserID: 123,
|
||||
Template: "user_id = {UserID}", // WHERE clause
|
||||
HasBlock: false, // true = block all access
|
||||
}
|
||||
```
|
||||
|
||||
### Template Variables
|
||||
|
||||
- `{UserID}` - Current user ID
|
||||
- `{PrimaryKeyName}` - Primary key column
|
||||
- `{TableName}` - Table name
|
||||
- `{SchemaName}` - Schema name
|
||||
|
||||
### Common Examples
|
||||
|
||||
```go
|
||||
// Users see only their records
|
||||
Template: "user_id = {UserID}"
|
||||
|
||||
// Users see their records OR public ones
|
||||
Template: "user_id = {UserID} OR is_public = true"
|
||||
|
||||
// Tenant isolation
|
||||
Template: "tenant_id = 5 AND user_id = {UserID}"
|
||||
|
||||
// Complex with subquery
|
||||
Template: "dept_id IN (SELECT dept_id FROM user_depts WHERE user_id = {UserID})"
|
||||
|
||||
// Block all access
|
||||
HasBlock: true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Example Implementations
|
||||
|
||||
### Simple Header Auth
|
||||
|
||||
```go
|
||||
func authFromHeader(r *http.Request) (int, string, error) {
|
||||
userIDStr := r.Header.Get("X-User-ID")
|
||||
if userIDStr == "" {
|
||||
return 0, "", fmt.Errorf("X-User-ID required")
|
||||
}
|
||||
userID, err := strconv.Atoi(userIDStr)
|
||||
return userID, "", err
|
||||
}
|
||||
```
|
||||
|
||||
### JWT Auth
|
||||
|
||||
```go
|
||||
func authFromJWT(r *http.Request) (int, string, error) {
|
||||
token := strings.TrimPrefix(r.Header.Get("Authorization"), "Bearer ")
|
||||
claims, err := jwt.Parse(token, secret)
|
||||
if err != nil {
|
||||
return 0, "", err
|
||||
}
|
||||
return claims.UserID, claims.Roles, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Static Column Security
|
||||
|
||||
```go
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
if table == "employees" {
|
||||
return []security.ColumnSecurity{
|
||||
{Path: []string{"ssn"}, Accesstype: "mask", MaskStart: 5},
|
||||
{Path: []string{"salary"}, Accesstype: "hide"},
|
||||
}, nil
|
||||
}
|
||||
return []security.ColumnSecurity{}, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Database Column Security
|
||||
|
||||
```go
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
rows, err := db.Query(`
|
||||
SELECT control, accesstype, jsonvalue
|
||||
FROM core.secacces
|
||||
WHERE rid_hub IN (...)
|
||||
AND control ILIKE ?
|
||||
`, fmt.Sprintf("%s.%s%%", schema, table))
|
||||
// ... parse and return
|
||||
}
|
||||
```
|
||||
|
||||
### Static Row Security
|
||||
|
||||
```go
|
||||
func loadRowSec(userID int, schema, table string) (security.RowSecurity, error) {
|
||||
templates := map[string]string{
|
||||
"orders": "user_id = {UserID}",
|
||||
"documents": "user_id = {UserID} OR is_public = true",
|
||||
}
|
||||
return security.RowSecurity{
|
||||
Template: templates[table],
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
```go
|
||||
// Test auth callback
|
||||
req := httptest.NewRequest("GET", "/", nil)
|
||||
req.Header.Set("X-User-ID", "123")
|
||||
userID, roles, err := myAuth(req)
|
||||
assert.Equal(t, 123, userID)
|
||||
|
||||
// Test column security callback
|
||||
rules, err := myColSec(123, "public", "employees")
|
||||
assert.Equal(t, "mask", rules[0].Accesstype)
|
||||
|
||||
// Test row security callback
|
||||
rowSec, err := myRowSec(123, "public", "orders")
|
||||
assert.Equal(t, "user_id = {UserID}", rowSec.Template)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Request Flow
|
||||
|
||||
```
|
||||
HTTP Request
|
||||
↓
|
||||
AuthMiddleware → calls AuthenticateCallback
|
||||
↓ (adds userID to context)
|
||||
SetSecurityMiddleware → adds GlobalSecurity to context
|
||||
↓
|
||||
Handler.Handle()
|
||||
↓
|
||||
BeforeRead Hook → calls LoadColumnSecurityCallback + LoadRowSecurityCallback
|
||||
↓
|
||||
BeforeScan Hook → applies row security (WHERE clause)
|
||||
↓
|
||||
Database Query
|
||||
↓
|
||||
AfterRead Hook → applies column security (masking)
|
||||
↓
|
||||
HTTP Response
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Role-Based Security
|
||||
|
||||
```go
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
if isAdmin(userID) {
|
||||
return []security.ColumnSecurity{}, nil // No restrictions
|
||||
}
|
||||
return loadRestrictions(userID, schema, table), nil
|
||||
}
|
||||
```
|
||||
|
||||
### Tenant Isolation
|
||||
|
||||
```go
|
||||
func loadRowSec(userID int, schema, table string) (security.RowSecurity, error) {
|
||||
tenantID := getUserTenant(userID)
|
||||
return security.RowSecurity{
|
||||
Template: fmt.Sprintf("tenant_id = %d", tenantID),
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
|
||||
### Caching
|
||||
|
||||
```go
|
||||
var cache = make(map[string][]security.ColumnSecurity)
|
||||
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
key := fmt.Sprintf("%d:%s.%s", userID, schema, table)
|
||||
if cached, ok := cache[key]; ok {
|
||||
return cached, nil
|
||||
}
|
||||
rules := loadFromDB(userID, schema, table)
|
||||
cache[key] = rules
|
||||
return rules, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Error Handling
|
||||
|
||||
```go
|
||||
// Setup will fail if callbacks not configured
|
||||
if err := security.SetupSecurityProvider(handler, &security.GlobalSecurity); err != nil {
|
||||
log.Fatal("Security setup failed:", err)
|
||||
}
|
||||
|
||||
// Auth middleware rejects if callback returns error
|
||||
func myAuth(r *http.Request) (int, string, error) {
|
||||
if invalid {
|
||||
return 0, "", fmt.Errorf("invalid credentials") // Returns HTTP 401
|
||||
}
|
||||
return userID, roles, nil
|
||||
}
|
||||
|
||||
// Security loading can fail gracefully
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
rules, err := db.Load(...)
|
||||
if err != nil {
|
||||
log.Printf("Failed to load security: %v", err)
|
||||
return []security.ColumnSecurity{}, nil // No rules = no restrictions
|
||||
}
|
||||
return rules, nil
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Debugging
|
||||
|
||||
```go
|
||||
// Enable debug logging
|
||||
import "github.com/bitechdev/GoCore/pkg/cfg"
|
||||
cfg.SetLogLevel("DEBUG")
|
||||
|
||||
// Log in callbacks
|
||||
func myAuth(r *http.Request) (int, string, error) {
|
||||
token := r.Header.Get("Authorization")
|
||||
log.Printf("Auth: token=%s", token)
|
||||
// ...
|
||||
}
|
||||
|
||||
// Check if callbacks are called
|
||||
func loadColSec(userID int, schema, table string) ([]security.ColumnSecurity, error) {
|
||||
log.Printf("Loading column security: user=%d, schema=%s, table=%s", userID, schema, table)
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Complete Minimal Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/security"
|
||||
"github.com/gorilla/mux"
|
||||
)
|
||||
|
||||
func main() {
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Configure callbacks
|
||||
security.GlobalSecurity.AuthenticateCallback = func(r *http.Request) (int, string, error) {
|
||||
id, _ := strconv.Atoi(r.Header.Get("X-User-ID"))
|
||||
return id, "", nil
|
||||
}
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = func(u int, s, t string) ([]security.ColumnSecurity, error) {
|
||||
return []security.ColumnSecurity{}, nil
|
||||
}
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = func(u int, s, t string) (security.RowSecurity, error) {
|
||||
return security.RowSecurity{Template: fmt.Sprintf("user_id = %d", u)}, nil
|
||||
}
|
||||
|
||||
// Setup
|
||||
security.SetupSecurityProvider(handler, &security.GlobalSecurity)
|
||||
|
||||
// Middleware
|
||||
router := mux.NewRouter()
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
router.Use(mux.MiddlewareFunc(security.AuthMiddleware))
|
||||
router.Use(mux.MiddlewareFunc(security.SetSecurityMiddleware))
|
||||
|
||||
http.ListenAndServe(":8080", router)
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `CALLBACKS_GUIDE.md` | **Start here** - Complete implementation guide |
|
||||
| `callbacks_example.go` | 7 working examples to copy |
|
||||
| `CALLBACKS_SUMMARY.md` | Architecture overview |
|
||||
| `README.md` | Full documentation |
|
||||
| `setup_example.go` | Integration examples |
|
||||
|
||||
---
|
||||
|
||||
## Cheat Sheet
|
||||
|
||||
```go
|
||||
// ===== REQUIRED SETUP =====
|
||||
security.GlobalSecurity.AuthenticateCallback = myAuthFunc
|
||||
security.GlobalSecurity.LoadColumnSecurityCallback = myColFunc
|
||||
security.GlobalSecurity.LoadRowSecurityCallback = myRowFunc
|
||||
security.SetupSecurityProvider(handler, &security.GlobalSecurity)
|
||||
|
||||
// ===== CALLBACK SIGNATURES =====
|
||||
func(r *http.Request) (int, string, error) // Auth
|
||||
func(int, string, string) ([]security.ColumnSecurity, error) // Column
|
||||
func(int, string, string) (security.RowSecurity, error) // Row
|
||||
|
||||
// ===== QUICK EXAMPLES =====
|
||||
// Header auth
|
||||
func(r *http.Request) (int, string, error) {
|
||||
id, _ := strconv.Atoi(r.Header.Get("X-User-ID"))
|
||||
return id, "", nil
|
||||
}
|
||||
|
||||
// Mask SSN
|
||||
{Path: []string{"ssn"}, Accesstype: "mask", MaskStart: 5}
|
||||
|
||||
// User isolation
|
||||
{Template: "user_id = {UserID}"}
|
||||
```
|
||||
418
pkg/security/callbacks_example.go
Normal file
418
pkg/security/callbacks_example.go
Normal file
@@ -0,0 +1,418 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
DBM "github.com/bitechdev/GoCore/pkg/models"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
)
|
||||
|
||||
// This file provides example implementations of the required security callbacks.
|
||||
// Copy these functions and modify them to match your authentication and database schema.
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 1: Simple Header-Based Authentication
|
||||
// =============================================================================
|
||||
|
||||
// ExampleAuthenticateFromHeader extracts user ID from X-User-ID header
|
||||
func ExampleAuthenticateFromHeader(r *http.Request) (userID int, roles string, err error) {
|
||||
userIDStr := r.Header.Get("X-User-ID")
|
||||
if userIDStr == "" {
|
||||
return 0, "", fmt.Errorf("X-User-ID header not provided")
|
||||
}
|
||||
|
||||
userID, err = strconv.Atoi(userIDStr)
|
||||
if err != nil {
|
||||
return 0, "", fmt.Errorf("invalid user ID format: %v", err)
|
||||
}
|
||||
|
||||
// Optionally extract roles
|
||||
roles = r.Header.Get("X-User-Roles") // comma-separated: "admin,manager"
|
||||
|
||||
return userID, roles, nil
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 2: JWT Token Authentication
|
||||
// =============================================================================
|
||||
|
||||
// ExampleAuthenticateFromJWT parses a JWT token and extracts user info
|
||||
// You'll need to import a JWT library like github.com/golang-jwt/jwt/v5
|
||||
func ExampleAuthenticateFromJWT(r *http.Request) (userID int, roles string, err error) {
|
||||
authHeader := r.Header.Get("Authorization")
|
||||
if authHeader == "" {
|
||||
return 0, "", fmt.Errorf("authorization header not provided")
|
||||
}
|
||||
|
||||
// Extract Bearer token
|
||||
tokenString := strings.TrimPrefix(authHeader, "Bearer ")
|
||||
if tokenString == authHeader {
|
||||
return 0, "", fmt.Errorf("invalid authorization header format")
|
||||
}
|
||||
|
||||
// TODO: Parse and validate JWT token
|
||||
// Example using github.com/golang-jwt/jwt/v5:
|
||||
//
|
||||
// token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
|
||||
// return []byte(os.Getenv("JWT_SECRET")), nil
|
||||
// })
|
||||
//
|
||||
// if err != nil || !token.Valid {
|
||||
// return 0, "", fmt.Errorf("invalid token: %v", err)
|
||||
// }
|
||||
//
|
||||
// claims := token.Claims.(jwt.MapClaims)
|
||||
// userID = int(claims["user_id"].(float64))
|
||||
// roles = claims["roles"].(string)
|
||||
|
||||
return 0, "", fmt.Errorf("JWT parsing not implemented - see example above")
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 3: Session Cookie Authentication
|
||||
// =============================================================================
|
||||
|
||||
// ExampleAuthenticateFromSession validates a session cookie
|
||||
func ExampleAuthenticateFromSession(r *http.Request) (userID int, roles string, err error) {
|
||||
sessionCookie, err := r.Cookie("session_id")
|
||||
if err != nil {
|
||||
return 0, "", fmt.Errorf("session cookie not found")
|
||||
}
|
||||
|
||||
// TODO: Validate session against your session store (Redis, database, etc.)
|
||||
// Example:
|
||||
//
|
||||
// session, err := sessionStore.Get(sessionCookie.Value)
|
||||
// if err != nil {
|
||||
// return 0, "", fmt.Errorf("invalid session")
|
||||
// }
|
||||
//
|
||||
// userID = session.UserID
|
||||
// roles = session.Roles
|
||||
|
||||
_ = sessionCookie // Suppress unused warning until implemented
|
||||
return 0, "", fmt.Errorf("session validation not implemented - see example above")
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 4: Column Security - Database Implementation
|
||||
// =============================================================================
|
||||
|
||||
// ExampleLoadColumnSecurityFromDatabase loads column security rules from database
|
||||
// This implementation assumes the following database schema:
|
||||
//
|
||||
// CREATE TABLE core.secacces (
|
||||
// rid_secacces SERIAL PRIMARY KEY,
|
||||
// rid_hub INTEGER,
|
||||
// control TEXT, -- Format: "schema.table.column"
|
||||
// accesstype TEXT, -- "mask" or "hide"
|
||||
// jsonvalue JSONB -- Masking configuration
|
||||
// );
|
||||
//
|
||||
// CREATE TABLE core.hub_link (
|
||||
// rid_hub_parent INTEGER, -- Security group ID
|
||||
// rid_hub_child INTEGER, -- User ID
|
||||
// parent_hubtype TEXT -- 'secgroup'
|
||||
// );
|
||||
func ExampleLoadColumnSecurityFromDatabase(pUserID int, pSchema, pTablename string) ([]ColumnSecurity, error) {
|
||||
colSecList := make([]ColumnSecurity, 0)
|
||||
|
||||
getExtraFilters := func(pStr string) map[string]string {
|
||||
mp := make(map[string]string, 0)
|
||||
for i, val := range strings.Split(pStr, ",") {
|
||||
if i <= 1 {
|
||||
continue
|
||||
}
|
||||
vals := strings.Split(val, ":")
|
||||
if len(vals) > 1 {
|
||||
mp[vals[0]] = vals[1]
|
||||
}
|
||||
}
|
||||
return mp
|
||||
}
|
||||
|
||||
rows, err := DBM.DBConn.Raw(fmt.Sprintf(`
|
||||
SELECT a.rid_secacces, a.control, a.accesstype, a.jsonvalue
|
||||
FROM core.secacces a
|
||||
WHERE a.rid_hub IN (
|
||||
SELECT l.rid_hub_parent
|
||||
FROM core.hub_link l
|
||||
WHERE l.parent_hubtype = 'secgroup'
|
||||
AND l.rid_hub_child = ?
|
||||
)
|
||||
AND control ILIKE '%s.%s%%'
|
||||
`, pSchema, pTablename), pUserID).Rows()
|
||||
|
||||
defer func() {
|
||||
if rows != nil {
|
||||
rows.Close()
|
||||
}
|
||||
}()
|
||||
|
||||
if err != nil {
|
||||
return colSecList, fmt.Errorf("failed to fetch column security from SQL: %v", err)
|
||||
}
|
||||
|
||||
for rows.Next() {
|
||||
var rid int
|
||||
var jsondata []byte
|
||||
var control, accesstype string
|
||||
|
||||
err = rows.Scan(&rid, &control, &accesstype, &jsondata)
|
||||
if err != nil {
|
||||
return colSecList, fmt.Errorf("failed to scan column security: %v", err)
|
||||
}
|
||||
|
||||
parts := strings.Split(control, ",")
|
||||
ids := strings.Split(parts[0], ".")
|
||||
if len(ids) < 3 {
|
||||
continue
|
||||
}
|
||||
|
||||
jsonvalue := make(map[string]interface{})
|
||||
if len(jsondata) > 1 {
|
||||
err = json.Unmarshal(jsondata, &jsonvalue)
|
||||
if err != nil {
|
||||
logger.Error("Failed to parse json: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
colsec := ColumnSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
Path: ids[2:],
|
||||
ExtraFilters: getExtraFilters(control),
|
||||
Accesstype: accesstype,
|
||||
Control: control,
|
||||
ID: int(rid),
|
||||
}
|
||||
|
||||
// Parse masking configuration from JSON
|
||||
if v, ok := jsonvalue["start"]; ok {
|
||||
if value, ok := v.(float64); ok {
|
||||
colsec.MaskStart = int(value)
|
||||
}
|
||||
}
|
||||
|
||||
if v, ok := jsonvalue["end"]; ok {
|
||||
if value, ok := v.(float64); ok {
|
||||
colsec.MaskEnd = int(value)
|
||||
}
|
||||
}
|
||||
|
||||
if v, ok := jsonvalue["invert"]; ok {
|
||||
if value, ok := v.(bool); ok {
|
||||
colsec.MaskInvert = value
|
||||
}
|
||||
}
|
||||
|
||||
if v, ok := jsonvalue["char"]; ok {
|
||||
if value, ok := v.(string); ok {
|
||||
colsec.MaskChar = value
|
||||
}
|
||||
}
|
||||
|
||||
colSecList = append(colSecList, colsec)
|
||||
}
|
||||
|
||||
return colSecList, nil
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 5: Column Security - In-Memory/Static Configuration
|
||||
// =============================================================================
|
||||
|
||||
// ExampleLoadColumnSecurityFromConfig loads column security from static config
|
||||
func ExampleLoadColumnSecurityFromConfig(pUserID int, pSchema, pTablename string) ([]ColumnSecurity, error) {
|
||||
// Example: Define security rules in code or load from config file
|
||||
securityRules := map[string][]ColumnSecurity{
|
||||
"public.employees": {
|
||||
{
|
||||
Schema: "public",
|
||||
Tablename: "employees",
|
||||
Path: []string{"ssn"},
|
||||
Accesstype: "mask",
|
||||
MaskStart: 5,
|
||||
MaskEnd: 0,
|
||||
MaskChar: "*",
|
||||
},
|
||||
{
|
||||
Schema: "public",
|
||||
Tablename: "employees",
|
||||
Path: []string{"salary"},
|
||||
Accesstype: "hide",
|
||||
},
|
||||
},
|
||||
"public.customers": {
|
||||
{
|
||||
Schema: "public",
|
||||
Tablename: "customers",
|
||||
Path: []string{"credit_card"},
|
||||
Accesstype: "mask",
|
||||
MaskStart: 12,
|
||||
MaskEnd: 0,
|
||||
MaskChar: "*",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
key := fmt.Sprintf("%s.%s", pSchema, pTablename)
|
||||
rules, ok := securityRules[key]
|
||||
if !ok {
|
||||
return []ColumnSecurity{}, nil // No rules for this table
|
||||
}
|
||||
|
||||
// Filter by user ID if needed
|
||||
// For this example, all rules apply to all users
|
||||
return rules, nil
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 6: Row Security - Database Implementation
|
||||
// =============================================================================
|
||||
|
||||
// ExampleLoadRowSecurityFromDatabase loads row security rules from database
|
||||
// This implementation assumes a PostgreSQL function:
|
||||
//
|
||||
// CREATE FUNCTION core.api_sec_rowtemplate(
|
||||
// p_schema TEXT,
|
||||
// p_table TEXT,
|
||||
// p_userid INTEGER
|
||||
// ) RETURNS TABLE (
|
||||
// p_retval INTEGER,
|
||||
// p_errmsg TEXT,
|
||||
// p_template TEXT,
|
||||
// p_block BOOLEAN
|
||||
// );
|
||||
func ExampleLoadRowSecurityFromDatabase(pUserID int, pSchema, pTablename string) (RowSecurity, error) {
|
||||
record := RowSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
}
|
||||
|
||||
rows, err := DBM.DBConn.Raw(`
|
||||
SELECT r.p_retval, r.p_errmsg, r.p_template, r.p_block
|
||||
FROM core.api_sec_rowtemplate(?, ?, ?) r
|
||||
`, pSchema, pTablename, pUserID).Rows()
|
||||
|
||||
defer func() {
|
||||
if rows != nil {
|
||||
rows.Close()
|
||||
}
|
||||
}()
|
||||
|
||||
if err != nil {
|
||||
return record, fmt.Errorf("failed to fetch row security from SQL: %v", err)
|
||||
}
|
||||
|
||||
for rows.Next() {
|
||||
var retval int
|
||||
var errmsg string
|
||||
|
||||
err = rows.Scan(&retval, &errmsg, &record.Template, &record.HasBlock)
|
||||
if err != nil {
|
||||
return record, fmt.Errorf("failed to scan row security: %v", err)
|
||||
}
|
||||
|
||||
if retval != 0 {
|
||||
return RowSecurity{}, fmt.Errorf("api_sec_rowtemplate error: %s", errmsg)
|
||||
}
|
||||
}
|
||||
|
||||
return record, nil
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// EXAMPLE 7: Row Security - Static Configuration
|
||||
// =============================================================================
|
||||
|
||||
// ExampleLoadRowSecurityFromConfig loads row security from static config
|
||||
func ExampleLoadRowSecurityFromConfig(pUserID int, pSchema, pTablename string) (RowSecurity, error) {
|
||||
// Define row security templates based on entity
|
||||
templates := map[string]string{
|
||||
"public.orders": "user_id = {UserID}", // Users see only their orders
|
||||
"public.documents": "user_id = {UserID} OR is_public = true", // Users see their docs + public docs
|
||||
"public.employees": "department_id IN (SELECT department_id FROM user_departments WHERE user_id = {UserID})", // Complex filter
|
||||
}
|
||||
|
||||
// Define blocked entities (no access at all)
|
||||
blockedEntities := map[string][]int{
|
||||
"public.admin_logs": {}, // All users blocked (empty list = block all)
|
||||
"public.audit_logs": {1, 2, 3}, // Block users 1, 2, 3
|
||||
}
|
||||
|
||||
key := fmt.Sprintf("%s.%s", pSchema, pTablename)
|
||||
|
||||
// Check if entity is blocked for this user
|
||||
if blockedUsers, ok := blockedEntities[key]; ok {
|
||||
if len(blockedUsers) == 0 {
|
||||
// Block all users
|
||||
return RowSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
HasBlock: true,
|
||||
}, nil
|
||||
}
|
||||
// Check if specific user is blocked
|
||||
for _, blockedUserID := range blockedUsers {
|
||||
if blockedUserID == pUserID {
|
||||
return RowSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
HasBlock: true,
|
||||
}, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Get template for this entity
|
||||
template, ok := templates[key]
|
||||
if !ok {
|
||||
// No row security defined - allow all rows
|
||||
return RowSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
Template: "",
|
||||
HasBlock: false,
|
||||
}, nil
|
||||
}
|
||||
|
||||
return RowSecurity{
|
||||
Schema: pSchema,
|
||||
Tablename: pTablename,
|
||||
UserID: pUserID,
|
||||
Template: template,
|
||||
HasBlock: false,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// =============================================================================
|
||||
// SETUP HELPER: Configure All Callbacks
|
||||
// =============================================================================
|
||||
|
||||
// SetupCallbacksExample shows how to configure all callbacks
|
||||
func SetupCallbacksExample() {
|
||||
// Option 1: Use database-backed security (production)
|
||||
GlobalSecurity.AuthenticateCallback = ExampleAuthenticateFromJWT
|
||||
GlobalSecurity.LoadColumnSecurityCallback = ExampleLoadColumnSecurityFromDatabase
|
||||
GlobalSecurity.LoadRowSecurityCallback = ExampleLoadRowSecurityFromDatabase
|
||||
|
||||
// Option 2: Use static configuration (development/testing)
|
||||
// GlobalSecurity.AuthenticateCallback = ExampleAuthenticateFromHeader
|
||||
// GlobalSecurity.LoadColumnSecurityCallback = ExampleLoadColumnSecurityFromConfig
|
||||
// GlobalSecurity.LoadRowSecurityCallback = ExampleLoadRowSecurityFromConfig
|
||||
|
||||
// Option 3: Mix and match
|
||||
// GlobalSecurity.AuthenticateCallback = ExampleAuthenticateFromJWT
|
||||
// GlobalSecurity.LoadColumnSecurityCallback = ExampleLoadColumnSecurityFromConfig
|
||||
// GlobalSecurity.LoadRowSecurityCallback = ExampleLoadRowSecurityFromDatabase
|
||||
}
|
||||
244
pkg/security/hooks.go
Normal file
244
pkg/security/hooks.go
Normal file
@@ -0,0 +1,244 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
)
|
||||
|
||||
// RegisterSecurityHooks registers all security-related hooks with the handler
|
||||
func RegisterSecurityHooks(handler *restheadspec.Handler, securityList *SecurityList) {
|
||||
|
||||
// Hook 1: BeforeRead - Load security rules
|
||||
handler.Hooks().Register(restheadspec.BeforeRead, func(hookCtx *restheadspec.HookContext) error {
|
||||
return loadSecurityRules(hookCtx, securityList)
|
||||
})
|
||||
|
||||
// Hook 2: BeforeScan - Apply row-level security filters
|
||||
handler.Hooks().Register(restheadspec.BeforeScan, func(hookCtx *restheadspec.HookContext) error {
|
||||
return applyRowSecurity(hookCtx, securityList)
|
||||
})
|
||||
|
||||
// Hook 3: AfterRead - Apply column-level security (masking)
|
||||
handler.Hooks().Register(restheadspec.AfterRead, func(hookCtx *restheadspec.HookContext) error {
|
||||
return applyColumnSecurity(hookCtx, securityList)
|
||||
})
|
||||
|
||||
// Hook 4 (Optional): Audit logging
|
||||
handler.Hooks().Register(restheadspec.AfterRead, func(hookCtx *restheadspec.HookContext) error {
|
||||
return logDataAccess(hookCtx)
|
||||
})
|
||||
}
|
||||
|
||||
// loadSecurityRules loads security configuration for the user and entity
|
||||
func loadSecurityRules(hookCtx *restheadspec.HookContext, securityList *SecurityList) error {
|
||||
// Extract user ID from context
|
||||
userID, ok := GetUserID(hookCtx.Context)
|
||||
if !ok {
|
||||
logger.Warn("No user ID in context for security check")
|
||||
return fmt.Errorf("authentication required")
|
||||
}
|
||||
|
||||
schema := hookCtx.Schema
|
||||
tablename := hookCtx.Entity
|
||||
|
||||
logger.Debug("Loading security rules for user=%d, schema=%s, table=%s", userID, schema, tablename)
|
||||
|
||||
// Load column security rules from database
|
||||
err := securityList.LoadColumnSecurity(userID, schema, tablename, false)
|
||||
if err != nil {
|
||||
logger.Warn("Failed to load column security: %v", err)
|
||||
// Don't fail the request if no security rules exist
|
||||
// return err
|
||||
}
|
||||
|
||||
// Load row security rules from database
|
||||
_, err = securityList.LoadRowSecurity(userID, schema, tablename, false)
|
||||
if err != nil {
|
||||
logger.Warn("Failed to load row security: %v", err)
|
||||
// Don't fail the request if no security rules exist
|
||||
// return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// applyRowSecurity applies row-level security filters to the query
|
||||
func applyRowSecurity(hookCtx *restheadspec.HookContext, securityList *SecurityList) error {
|
||||
userID, ok := GetUserID(hookCtx.Context)
|
||||
if !ok {
|
||||
return nil // No user context, skip
|
||||
}
|
||||
|
||||
schema := hookCtx.Schema
|
||||
tablename := hookCtx.Entity
|
||||
|
||||
// Get row security template
|
||||
rowSec, err := securityList.GetRowSecurityTemplate(userID, schema, tablename)
|
||||
if err != nil {
|
||||
// No row security defined, allow query to proceed
|
||||
logger.Debug("No row security for %s.%s@%d: %v", schema, tablename, userID, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Check if user has a blocking rule
|
||||
if rowSec.HasBlock {
|
||||
logger.Warn("User %d blocked from accessing %s.%s", userID, schema, tablename)
|
||||
return fmt.Errorf("access denied to %s", tablename)
|
||||
}
|
||||
|
||||
// If there's a security template, apply it as a WHERE clause
|
||||
if rowSec.Template != "" {
|
||||
// Get primary key name from model
|
||||
modelType := reflect.TypeOf(hookCtx.Model)
|
||||
if modelType.Kind() == reflect.Ptr {
|
||||
modelType = modelType.Elem()
|
||||
}
|
||||
|
||||
// Find primary key field
|
||||
pkName := "id" // default
|
||||
for i := 0; i < modelType.NumField(); i++ {
|
||||
field := modelType.Field(i)
|
||||
if tag := field.Tag.Get("bun"); tag != "" {
|
||||
// Check for primary key tag
|
||||
if contains(tag, "pk") || contains(tag, "primary_key") {
|
||||
if sqlName := extractSQLName(tag); sqlName != "" {
|
||||
pkName = sqlName
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Generate the WHERE clause from template
|
||||
whereClause := rowSec.GetTemplate(pkName, modelType)
|
||||
|
||||
logger.Info("Applying row security filter for user %d on %s.%s: %s",
|
||||
userID, schema, tablename, whereClause)
|
||||
|
||||
// Apply the WHERE clause to the query
|
||||
// The query is in hookCtx.Query
|
||||
if selectQuery, ok := hookCtx.Query.(interface {
|
||||
Where(string, ...interface{}) interface{}
|
||||
}); ok {
|
||||
hookCtx.Query = selectQuery.Where(whereClause)
|
||||
} else {
|
||||
logger.Error("Unable to apply WHERE clause - query doesn't support Where method")
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// applyColumnSecurity applies column-level security (masking/hiding) to results
|
||||
func applyColumnSecurity(hookCtx *restheadspec.HookContext, securityList *SecurityList) error {
|
||||
userID, ok := GetUserID(hookCtx.Context)
|
||||
if !ok {
|
||||
return nil // No user context, skip
|
||||
}
|
||||
|
||||
schema := hookCtx.Schema
|
||||
tablename := hookCtx.Entity
|
||||
|
||||
// Get result data
|
||||
result := hookCtx.Result
|
||||
if result == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
logger.Debug("Applying column security for user=%d, schema=%s, table=%s", userID, schema, tablename)
|
||||
|
||||
// Get model type
|
||||
modelType := reflect.TypeOf(hookCtx.Model)
|
||||
if modelType.Kind() == reflect.Ptr {
|
||||
modelType = modelType.Elem()
|
||||
}
|
||||
|
||||
// Apply column security masking
|
||||
resultValue := reflect.ValueOf(result)
|
||||
if resultValue.Kind() == reflect.Ptr {
|
||||
resultValue = resultValue.Elem()
|
||||
}
|
||||
|
||||
err, maskedResult := securityList.ApplyColumnSecurity(resultValue, modelType, userID, schema, tablename)
|
||||
if err != nil {
|
||||
logger.Warn("Column security error: %v", err)
|
||||
// Don't fail the request, just log the issue
|
||||
return nil
|
||||
}
|
||||
|
||||
// Update the result with masked data
|
||||
if maskedResult.IsValid() && maskedResult.CanInterface() {
|
||||
hookCtx.Result = maskedResult.Interface()
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// logDataAccess logs all data access for audit purposes
|
||||
func logDataAccess(hookCtx *restheadspec.HookContext) error {
|
||||
userID, _ := GetUserID(hookCtx.Context)
|
||||
|
||||
logger.Info("AUDIT: User %d accessed %s.%s with filters: %+v",
|
||||
userID,
|
||||
hookCtx.Schema,
|
||||
hookCtx.Entity,
|
||||
hookCtx.Options.Filters,
|
||||
)
|
||||
|
||||
// TODO: Write to audit log table or external audit service
|
||||
// auditLog := AuditLog{
|
||||
// UserID: userID,
|
||||
// Schema: hookCtx.Schema,
|
||||
// Entity: hookCtx.Entity,
|
||||
// Action: "READ",
|
||||
// Timestamp: time.Now(),
|
||||
// Filters: hookCtx.Options.Filters,
|
||||
// }
|
||||
// db.Create(&auditLog)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Helper functions
|
||||
|
||||
func contains(s, substr string) bool {
|
||||
return len(s) >= len(substr) && s[:len(substr)] == substr ||
|
||||
len(s) > len(substr) && s[len(s)-len(substr):] == substr
|
||||
}
|
||||
|
||||
func extractSQLName(tag string) string {
|
||||
// Simple parser for "column:name" or just "name"
|
||||
// This is a simplified version
|
||||
parts := splitTag(tag, ',')
|
||||
for _, part := range parts {
|
||||
if part != "" && !contains(part, ":") {
|
||||
return part
|
||||
}
|
||||
if contains(part, "column:") {
|
||||
return part[7:] // Skip "column:"
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func splitTag(tag string, sep rune) []string {
|
||||
var parts []string
|
||||
var current string
|
||||
for _, ch := range tag {
|
||||
if ch == sep {
|
||||
if current != "" {
|
||||
parts = append(parts, current)
|
||||
current = ""
|
||||
}
|
||||
} else {
|
||||
current += string(ch)
|
||||
}
|
||||
}
|
||||
if current != "" {
|
||||
parts = append(parts, current)
|
||||
}
|
||||
return parts
|
||||
}
|
||||
54
pkg/security/middleware.go
Normal file
54
pkg/security/middleware.go
Normal file
@@ -0,0 +1,54 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
const (
|
||||
// Context keys for user information
|
||||
UserIDKey = "user_id"
|
||||
UserRolesKey = "user_roles"
|
||||
UserTokenKey = "user_token"
|
||||
)
|
||||
|
||||
// AuthMiddleware extracts user authentication from request and adds to context
|
||||
// This should be applied before the ResolveSpec handler
|
||||
// Uses GlobalSecurity.AuthenticateCallback if set, otherwise returns error
|
||||
func AuthMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// Check if callback is set
|
||||
if GlobalSecurity.AuthenticateCallback == nil {
|
||||
http.Error(w, "AuthenticateCallback not set - you must provide an authentication callback", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
// Call the user-provided authentication callback
|
||||
userID, roles, err := GlobalSecurity.AuthenticateCallback(r)
|
||||
if err != nil {
|
||||
http.Error(w, "Authentication failed: "+err.Error(), http.StatusUnauthorized)
|
||||
return
|
||||
}
|
||||
|
||||
// Add user information to context
|
||||
ctx := context.WithValue(r.Context(), UserIDKey, userID)
|
||||
if roles != "" {
|
||||
ctx = context.WithValue(ctx, UserRolesKey, roles)
|
||||
}
|
||||
|
||||
// Continue with authenticated context
|
||||
next.ServeHTTP(w, r.WithContext(ctx))
|
||||
})
|
||||
}
|
||||
|
||||
// GetUserID extracts the user ID from context
|
||||
func GetUserID(ctx context.Context) (int, bool) {
|
||||
userID, ok := ctx.Value(UserIDKey).(int)
|
||||
return userID, ok
|
||||
}
|
||||
|
||||
// GetUserRoles extracts user roles from context
|
||||
func GetUserRoles(ctx context.Context) (string, bool) {
|
||||
roles, ok := ctx.Value(UserRolesKey).(string)
|
||||
return roles, ok
|
||||
}
|
||||
460
pkg/security/provider.go
Normal file
460
pkg/security/provider.go
Normal file
@@ -0,0 +1,460 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"reflect"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/reflection"
|
||||
|
||||
"github.com/tidwall/gjson"
|
||||
"github.com/tidwall/sjson"
|
||||
)
|
||||
|
||||
type ColumnSecurity struct {
|
||||
Schema string
|
||||
Tablename string
|
||||
Path []string
|
||||
ExtraFilters map[string]string
|
||||
UserID int
|
||||
Accesstype string `json:"accesstype"`
|
||||
MaskStart int
|
||||
MaskEnd int
|
||||
MaskInvert bool
|
||||
MaskChar string
|
||||
Control string `json:"control"`
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
type RowSecurity struct {
|
||||
Schema string
|
||||
Tablename string
|
||||
Template string
|
||||
HasBlock bool
|
||||
UserID int
|
||||
}
|
||||
|
||||
func (m *RowSecurity) GetTemplate(pPrimaryKeyName string, pModelType reflect.Type) string {
|
||||
str := m.Template
|
||||
str = strings.ReplaceAll(str, "{PrimaryKeyName}", pPrimaryKeyName)
|
||||
str = strings.ReplaceAll(str, "{TableName}", m.Tablename)
|
||||
str = strings.ReplaceAll(str, "{SchemaName}", m.Schema)
|
||||
str = strings.ReplaceAll(str, "{UserID}", fmt.Sprintf("%d", m.UserID))
|
||||
return str
|
||||
}
|
||||
|
||||
// Callback function types for customizing security behavior
|
||||
type (
|
||||
// AuthenticateFunc extracts user ID and roles from HTTP request
|
||||
// Return userID, roles, error. If error is not nil, request will be rejected.
|
||||
AuthenticateFunc func(r *http.Request) (userID int, roles string, err error)
|
||||
|
||||
// LoadColumnSecurityFunc loads column security rules for a user and entity
|
||||
// Override this to customize how column security is loaded from your data source
|
||||
LoadColumnSecurityFunc func(pUserID int, pSchema, pTablename string) ([]ColumnSecurity, error)
|
||||
|
||||
// LoadRowSecurityFunc loads row security rules for a user and entity
|
||||
// Override this to customize how row security is loaded from your data source
|
||||
LoadRowSecurityFunc func(pUserID int, pSchema, pTablename string) (RowSecurity, error)
|
||||
)
|
||||
|
||||
type SecurityList struct {
|
||||
ColumnSecurityMutex sync.RWMutex
|
||||
ColumnSecurity map[string][]ColumnSecurity
|
||||
RowSecurityMutex sync.RWMutex
|
||||
RowSecurity map[string]RowSecurity
|
||||
|
||||
// Overridable callbacks
|
||||
AuthenticateCallback AuthenticateFunc
|
||||
LoadColumnSecurityCallback LoadColumnSecurityFunc
|
||||
LoadRowSecurityCallback LoadRowSecurityFunc
|
||||
}
|
||||
|
||||
const SECURITY_CONTEXT_KEY = "SecurityList"
|
||||
|
||||
var GlobalSecurity SecurityList
|
||||
|
||||
// SetSecurityMiddleware adds security context to requests
|
||||
func SetSecurityMiddleware(next http.Handler) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
ctx := context.WithValue(r.Context(), SECURITY_CONTEXT_KEY, &GlobalSecurity)
|
||||
next.ServeHTTP(w, r.WithContext(ctx))
|
||||
})
|
||||
}
|
||||
|
||||
func maskString(pString string, maskStart, maskEnd int, maskChar string, invert bool) string {
|
||||
strLen := len(pString)
|
||||
middleIndex := (strLen / 2)
|
||||
newStr := ""
|
||||
if maskStart == 0 && maskEnd == 0 {
|
||||
maskStart = strLen
|
||||
maskEnd = strLen
|
||||
}
|
||||
if maskEnd > strLen {
|
||||
maskEnd = strLen
|
||||
}
|
||||
if maskStart > strLen {
|
||||
maskStart = strLen
|
||||
}
|
||||
if maskChar == "" {
|
||||
maskChar = "*"
|
||||
}
|
||||
for index, char := range pString {
|
||||
if invert && index >= middleIndex-maskStart && index <= middleIndex {
|
||||
newStr = newStr + maskChar
|
||||
continue
|
||||
}
|
||||
if invert && index <= middleIndex+maskEnd && index >= middleIndex {
|
||||
newStr = newStr + maskChar
|
||||
continue
|
||||
}
|
||||
if !invert && index <= maskStart {
|
||||
newStr = newStr + maskChar
|
||||
continue
|
||||
}
|
||||
if !invert && index >= strLen-1-maskEnd {
|
||||
newStr = newStr + maskChar
|
||||
continue
|
||||
}
|
||||
newStr = newStr + string(char)
|
||||
}
|
||||
|
||||
return newStr
|
||||
}
|
||||
|
||||
func (m *SecurityList) ColumSecurityApplyOnRecord(prevRecord reflect.Value, newRecord reflect.Value, modelType reflect.Type, pUserID int, pSchema, pTablename string) ([]string, error) {
|
||||
cols := make([]string, 0)
|
||||
if m.ColumnSecurity == nil {
|
||||
return cols, fmt.Errorf("security not initialized")
|
||||
}
|
||||
|
||||
if prevRecord.Type() != newRecord.Type() {
|
||||
logger.Error("prev:%s and new:%s record type mismatch", prevRecord.Type(), newRecord.Type())
|
||||
return cols, fmt.Errorf("prev and new record type mismatch")
|
||||
}
|
||||
|
||||
m.ColumnSecurityMutex.RLock()
|
||||
defer m.ColumnSecurityMutex.RUnlock()
|
||||
|
||||
colsecList, ok := m.ColumnSecurity[fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)]
|
||||
if !ok || colsecList == nil {
|
||||
return cols, fmt.Errorf("no security data")
|
||||
}
|
||||
|
||||
for _, colsec := range colsecList {
|
||||
if !(strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide")) {
|
||||
continue
|
||||
}
|
||||
lastRecords := interateStruct(prevRecord)
|
||||
newRecords := interateStruct(newRecord)
|
||||
var lastLoopField, lastLoopNewField reflect.Value
|
||||
pathLen := len(colsec.Path)
|
||||
for i, path := range colsec.Path {
|
||||
var nameType, fieldName string
|
||||
if len(newRecords) == 0 {
|
||||
if lastLoopNewField.IsValid() && lastLoopField.IsValid() && i < pathLen-1 {
|
||||
lastLoopNewField.Set(lastLoopField)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
for ri := range newRecords {
|
||||
if !newRecords[ri].IsValid() || !lastRecords[ri].IsValid() {
|
||||
break
|
||||
}
|
||||
var field, oldField reflect.Value
|
||||
|
||||
columnData := reflection.GetModelColumnDetail(newRecords[ri])
|
||||
lastColumnData := reflection.GetModelColumnDetail(lastRecords[ri])
|
||||
for i, cols := range columnData {
|
||||
if cols.SQLName != "" && strings.EqualFold(cols.SQLName, path) {
|
||||
nameType = "sql"
|
||||
fieldName = cols.SQLName
|
||||
field = cols.FieldValue
|
||||
oldField = lastColumnData[i].FieldValue
|
||||
break
|
||||
}
|
||||
if cols.Name != "" && strings.EqualFold(cols.Name, path) {
|
||||
nameType = "struct"
|
||||
fieldName = cols.Name
|
||||
field = cols.FieldValue
|
||||
oldField = lastColumnData[i].FieldValue
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !field.IsValid() || !oldField.IsValid() {
|
||||
break
|
||||
}
|
||||
lastLoopField = oldField
|
||||
lastLoopNewField = field
|
||||
|
||||
if i == pathLen-1 {
|
||||
if strings.Contains(strings.ToLower(fieldName), "json") {
|
||||
prevSrc := oldField.Bytes()
|
||||
newSrc := field.Bytes()
|
||||
pathstr := strings.Join(colsec.Path, ".")
|
||||
prevPathValue := gjson.GetBytes(prevSrc, pathstr)
|
||||
newBytes, err := sjson.SetBytes(newSrc, pathstr, prevPathValue.Str)
|
||||
if err == nil {
|
||||
if field.CanSet() {
|
||||
field.SetBytes(newBytes)
|
||||
} else {
|
||||
logger.Warn("Value not settable: %v", field)
|
||||
cols = append(cols, pathstr)
|
||||
}
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
if nameType == "sql" {
|
||||
if strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide") {
|
||||
field.Set(oldField)
|
||||
cols = append(cols, strings.Join(colsec.Path, "."))
|
||||
}
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
lastRecords = interateStruct(field)
|
||||
newRecords = interateStruct(oldField)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return cols, nil
|
||||
}
|
||||
|
||||
func interateStruct(val reflect.Value) []reflect.Value {
|
||||
list := make([]reflect.Value, 0)
|
||||
|
||||
switch val.Kind() {
|
||||
case reflect.Pointer, reflect.Interface:
|
||||
elem := val.Elem()
|
||||
if elem.IsValid() {
|
||||
list = append(list, interateStruct(elem)...)
|
||||
}
|
||||
return list
|
||||
case reflect.Array, reflect.Slice:
|
||||
for i := 0; i < val.Len(); i++ {
|
||||
elem := val.Index(i)
|
||||
if !elem.IsValid() {
|
||||
continue
|
||||
}
|
||||
list = append(list, interateStruct(elem)...)
|
||||
}
|
||||
return list
|
||||
case reflect.Struct:
|
||||
list = append(list, val)
|
||||
return list
|
||||
default:
|
||||
return list
|
||||
}
|
||||
}
|
||||
|
||||
func setColSecValue(fieldsrc reflect.Value, colsec ColumnSecurity, fieldTypeName string) (int, reflect.Value) {
|
||||
fieldval := fieldsrc
|
||||
if fieldsrc.Kind() == reflect.Pointer || fieldsrc.Kind() == reflect.Interface {
|
||||
fieldval = fieldval.Elem()
|
||||
}
|
||||
|
||||
if strings.Contains(strings.ToLower(fieldval.Kind().String()), "int") &&
|
||||
(strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide")) {
|
||||
if fieldval.CanInt() && fieldval.CanSet() {
|
||||
fieldval.SetInt(0)
|
||||
}
|
||||
} else if (strings.Contains(strings.ToLower(fieldval.Kind().String()), "time") ||
|
||||
strings.Contains(strings.ToLower(fieldval.Kind().String()), "date")) &&
|
||||
(strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide")) {
|
||||
fieldval.SetZero()
|
||||
} else if strings.Contains(strings.ToLower(fieldval.Kind().String()), "string") {
|
||||
strVal := fieldval.String()
|
||||
if strings.EqualFold(colsec.Accesstype, "mask") {
|
||||
fieldval.SetString(maskString(strVal, colsec.MaskStart, colsec.MaskEnd, colsec.MaskChar, colsec.MaskInvert))
|
||||
} else if strings.EqualFold(colsec.Accesstype, "hide") {
|
||||
fieldval.SetString("")
|
||||
}
|
||||
} else if strings.Contains(fieldTypeName, "json") &&
|
||||
(strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide")) {
|
||||
if len(colsec.Path) < 2 {
|
||||
return 1, fieldval
|
||||
}
|
||||
pathstr := strings.Join(colsec.Path, ".")
|
||||
src := fieldval.Bytes()
|
||||
pathValue := gjson.GetBytes(src, pathstr)
|
||||
strValue := pathValue.String()
|
||||
if strings.EqualFold(colsec.Accesstype, "mask") {
|
||||
strValue = maskString(strValue, colsec.MaskStart, colsec.MaskEnd, colsec.MaskChar, colsec.MaskInvert)
|
||||
} else if strings.EqualFold(colsec.Accesstype, "hide") {
|
||||
strValue = ""
|
||||
}
|
||||
newBytes, err := sjson.SetBytes(src, pathstr, strValue)
|
||||
if err == nil {
|
||||
fieldval.SetBytes(newBytes)
|
||||
}
|
||||
}
|
||||
return 0, fieldsrc
|
||||
}
|
||||
|
||||
func (m *SecurityList) ApplyColumnSecurity(records reflect.Value, modelType reflect.Type, pUserID int, pSchema, pTablename string) (error, reflect.Value) {
|
||||
defer logger.CatchPanic("ApplyColumnSecurity")
|
||||
|
||||
if m.ColumnSecurity == nil {
|
||||
return fmt.Errorf("security not initialized"), records
|
||||
}
|
||||
|
||||
m.ColumnSecurityMutex.RLock()
|
||||
defer m.ColumnSecurityMutex.RUnlock()
|
||||
|
||||
colsecList, ok := m.ColumnSecurity[fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)]
|
||||
if !ok || colsecList == nil {
|
||||
return fmt.Errorf("no security data"), records
|
||||
}
|
||||
|
||||
for _, colsec := range colsecList {
|
||||
if !(strings.EqualFold(colsec.Accesstype, "mask") || strings.EqualFold(colsec.Accesstype, "hide")) {
|
||||
continue
|
||||
}
|
||||
|
||||
if records.Kind() == reflect.Array || records.Kind() == reflect.Slice {
|
||||
for i := 0; i < records.Len(); i++ {
|
||||
record := records.Index(i)
|
||||
if !record.IsValid() {
|
||||
continue
|
||||
}
|
||||
|
||||
lastRecord := interateStruct(record)
|
||||
pathLen := len(colsec.Path)
|
||||
for i, path := range colsec.Path {
|
||||
var field reflect.Value
|
||||
var nameType, fieldName string
|
||||
if len(lastRecord) == 0 {
|
||||
break
|
||||
}
|
||||
columnData := reflection.GetModelColumnDetail(lastRecord[0])
|
||||
for _, cols := range columnData {
|
||||
if cols.SQLName != "" && strings.EqualFold(cols.SQLName, path) {
|
||||
nameType = "sql"
|
||||
fieldName = cols.SQLName
|
||||
field = cols.FieldValue
|
||||
break
|
||||
}
|
||||
if cols.Name != "" && strings.EqualFold(cols.Name, path) {
|
||||
nameType = "struct"
|
||||
fieldName = cols.Name
|
||||
field = cols.FieldValue
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if i == pathLen-1 {
|
||||
if nameType == "sql" || nameType == "struct" {
|
||||
setColSecValue(field, colsec, fieldName)
|
||||
}
|
||||
break
|
||||
}
|
||||
if field.IsValid() {
|
||||
lastRecord = interateStruct(field)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil, records
|
||||
}
|
||||
|
||||
func (m *SecurityList) LoadColumnSecurity(pUserID int, pSchema, pTablename string, pOverwrite bool) error {
|
||||
// Use the callback if provided
|
||||
if m.LoadColumnSecurityCallback == nil {
|
||||
return fmt.Errorf("LoadColumnSecurityCallback not set - you must provide a callback function")
|
||||
}
|
||||
|
||||
m.ColumnSecurityMutex.Lock()
|
||||
defer m.ColumnSecurityMutex.Unlock()
|
||||
|
||||
if m.ColumnSecurity == nil {
|
||||
m.ColumnSecurity = make(map[string][]ColumnSecurity, 0)
|
||||
}
|
||||
secKey := fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)
|
||||
|
||||
if pOverwrite || m.ColumnSecurity[secKey] == nil {
|
||||
m.ColumnSecurity[secKey] = make([]ColumnSecurity, 0)
|
||||
}
|
||||
|
||||
// Call the user-provided callback to load security rules
|
||||
colSecList, err := m.LoadColumnSecurityCallback(pUserID, pSchema, pTablename)
|
||||
if err != nil {
|
||||
return fmt.Errorf("LoadColumnSecurityCallback failed: %v", err)
|
||||
}
|
||||
|
||||
m.ColumnSecurity[secKey] = colSecList
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *SecurityList) ClearSecurity(pUserID int, pSchema, pTablename string) error {
|
||||
var filtered []ColumnSecurity
|
||||
m.ColumnSecurityMutex.Lock()
|
||||
defer m.ColumnSecurityMutex.Unlock()
|
||||
|
||||
secKey := fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)
|
||||
list, ok := m.ColumnSecurity[secKey]
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
|
||||
for _, cs := range list {
|
||||
if !(cs.Schema == pSchema && cs.Tablename == pTablename && cs.UserID == pUserID) {
|
||||
filtered = append(filtered, cs)
|
||||
}
|
||||
}
|
||||
|
||||
m.ColumnSecurity[secKey] = filtered
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *SecurityList) LoadRowSecurity(pUserID int, pSchema, pTablename string, pOverwrite bool) (RowSecurity, error) {
|
||||
// Use the callback if provided
|
||||
if m.LoadRowSecurityCallback == nil {
|
||||
return RowSecurity{}, fmt.Errorf("LoadRowSecurityCallback not set - you must provide a callback function")
|
||||
}
|
||||
|
||||
m.RowSecurityMutex.Lock()
|
||||
defer m.RowSecurityMutex.Unlock()
|
||||
|
||||
if m.RowSecurity == nil {
|
||||
m.RowSecurity = make(map[string]RowSecurity, 0)
|
||||
}
|
||||
secKey := fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)
|
||||
|
||||
// Call the user-provided callback to load security rules
|
||||
record, err := m.LoadRowSecurityCallback(pUserID, pSchema, pTablename)
|
||||
if err != nil {
|
||||
return RowSecurity{}, fmt.Errorf("LoadRowSecurityCallback failed: %v", err)
|
||||
}
|
||||
|
||||
m.RowSecurity[secKey] = record
|
||||
return record, nil
|
||||
}
|
||||
|
||||
func (m *SecurityList) GetRowSecurityTemplate(pUserID int, pSchema, pTablename string) (RowSecurity, error) {
|
||||
defer logger.CatchPanic("GetRowSecurityTemplate")
|
||||
|
||||
if m.RowSecurity == nil {
|
||||
return RowSecurity{}, fmt.Errorf("security not initialized")
|
||||
}
|
||||
|
||||
m.RowSecurityMutex.RLock()
|
||||
defer m.RowSecurityMutex.RUnlock()
|
||||
|
||||
rowSec, ok := m.RowSecurity[fmt.Sprintf("%s.%s@%d", pSchema, pTablename, pUserID)]
|
||||
if !ok {
|
||||
return RowSecurity{}, fmt.Errorf("no security data")
|
||||
}
|
||||
|
||||
return rowSec, nil
|
||||
}
|
||||
155
pkg/security/setup_example.go
Normal file
155
pkg/security/setup_example.go
Normal file
@@ -0,0 +1,155 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
|
||||
"github.com/bitechdev/ResolveSpec/pkg/restheadspec"
|
||||
"github.com/gorilla/mux"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
// SetupSecurityProvider initializes and configures the security provider
|
||||
// This should be called when setting up your HTTP server
|
||||
//
|
||||
// IMPORTANT: You MUST configure the callbacks before calling this function:
|
||||
// - GlobalSecurity.AuthenticateCallback
|
||||
// - GlobalSecurity.LoadColumnSecurityCallback
|
||||
// - GlobalSecurity.LoadRowSecurityCallback
|
||||
//
|
||||
// Example usage in your main.go or server setup:
|
||||
//
|
||||
// // Step 1: Configure callbacks (REQUIRED)
|
||||
// security.GlobalSecurity.AuthenticateCallback = myAuthFunction
|
||||
// security.GlobalSecurity.LoadColumnSecurityCallback = myLoadColumnSecurityFunction
|
||||
// security.GlobalSecurity.LoadRowSecurityCallback = myLoadRowSecurityFunction
|
||||
//
|
||||
// // Step 2: Setup security provider
|
||||
// handler := restheadspec.NewHandlerWithGORM(db)
|
||||
// security.SetupSecurityProvider(handler, &security.GlobalSecurity)
|
||||
//
|
||||
// // Step 3: Apply middleware
|
||||
// router.Use(mux.MiddlewareFunc(security.AuthMiddleware))
|
||||
// router.Use(mux.MiddlewareFunc(security.SetSecurityMiddleware))
|
||||
//
|
||||
func SetupSecurityProvider(handler *restheadspec.Handler, securityList *SecurityList) error {
|
||||
// Validate that required callbacks are configured
|
||||
if securityList.AuthenticateCallback == nil {
|
||||
return fmt.Errorf("AuthenticateCallback must be set before calling SetupSecurityProvider")
|
||||
}
|
||||
if securityList.LoadColumnSecurityCallback == nil {
|
||||
return fmt.Errorf("LoadColumnSecurityCallback must be set before calling SetupSecurityProvider")
|
||||
}
|
||||
if securityList.LoadRowSecurityCallback == nil {
|
||||
return fmt.Errorf("LoadRowSecurityCallback must be set before calling SetupSecurityProvider")
|
||||
}
|
||||
|
||||
// Initialize security maps if needed
|
||||
if securityList.ColumnSecurity == nil {
|
||||
securityList.ColumnSecurity = make(map[string][]ColumnSecurity)
|
||||
}
|
||||
if securityList.RowSecurity == nil {
|
||||
securityList.RowSecurity = make(map[string]RowSecurity)
|
||||
}
|
||||
|
||||
// Register all security hooks
|
||||
RegisterSecurityHooks(handler, securityList)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Chain creates a middleware chain
|
||||
func Chain(middlewares ...func(http.Handler) http.Handler) func(http.Handler) http.Handler {
|
||||
return func(final http.Handler) http.Handler {
|
||||
for i := len(middlewares) - 1; i >= 0; i-- {
|
||||
final = middlewares[i](final)
|
||||
}
|
||||
return final
|
||||
}
|
||||
}
|
||||
|
||||
// CompleteExample shows a full integration example with Gorilla Mux
|
||||
func CompleteExample(db *gorm.DB) (http.Handler, error) {
|
||||
// Step 1: Create the ResolveSpec handler
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// Step 2: Register your models
|
||||
// handler.RegisterModel("public", "users", User{})
|
||||
// handler.RegisterModel("public", "orders", Order{})
|
||||
|
||||
// Step 3: Configure security callbacks (REQUIRED!)
|
||||
// See callbacks_example.go for example implementations
|
||||
GlobalSecurity.AuthenticateCallback = ExampleAuthenticateFromHeader
|
||||
GlobalSecurity.LoadColumnSecurityCallback = ExampleLoadColumnSecurityFromDatabase
|
||||
GlobalSecurity.LoadRowSecurityCallback = ExampleLoadRowSecurityFromDatabase
|
||||
|
||||
// Step 4: Setup security provider
|
||||
if err := SetupSecurityProvider(handler, &GlobalSecurity); err != nil {
|
||||
return nil, fmt.Errorf("failed to setup security: %v", err)
|
||||
}
|
||||
|
||||
// Step 5: Create Mux router and setup routes
|
||||
router := mux.NewRouter()
|
||||
|
||||
// The routes are set up by restheadspec, which handles the conversion
|
||||
// from http.Request to the internal request format
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
|
||||
// Step 6: Apply middleware to the entire router
|
||||
secureRouter := Chain(
|
||||
AuthMiddleware, // Extract user from token
|
||||
SetSecurityMiddleware, // Add security context
|
||||
)(router)
|
||||
|
||||
return secureRouter, nil
|
||||
}
|
||||
|
||||
// ExampleWithMux shows a simpler integration with Mux
|
||||
func ExampleWithMux(db *gorm.DB) (*mux.Router, error) {
|
||||
handler := restheadspec.NewHandlerWithGORM(db)
|
||||
|
||||
// IMPORTANT: Configure callbacks BEFORE SetupSecurityProvider
|
||||
GlobalSecurity.AuthenticateCallback = ExampleAuthenticateFromHeader
|
||||
GlobalSecurity.LoadColumnSecurityCallback = ExampleLoadColumnSecurityFromConfig
|
||||
GlobalSecurity.LoadRowSecurityCallback = ExampleLoadRowSecurityFromConfig
|
||||
|
||||
if err := SetupSecurityProvider(handler, &GlobalSecurity); err != nil {
|
||||
return nil, fmt.Errorf("failed to setup security: %v", err)
|
||||
}
|
||||
|
||||
router := mux.NewRouter()
|
||||
|
||||
// Setup API routes
|
||||
restheadspec.SetupMuxRoutes(router, handler)
|
||||
|
||||
// Apply middleware to router
|
||||
router.Use(mux.MiddlewareFunc(AuthMiddleware))
|
||||
router.Use(mux.MiddlewareFunc(SetSecurityMiddleware))
|
||||
|
||||
return router, nil
|
||||
}
|
||||
|
||||
// Example with Gin
|
||||
// import "github.com/gin-gonic/gin"
|
||||
//
|
||||
// func ExampleWithGin(db *gorm.DB) *gin.Engine {
|
||||
// handler := restheadspec.NewHandlerWithGORM(db)
|
||||
// SetupSecurityProvider(handler, &GlobalSecurity)
|
||||
//
|
||||
// router := gin.Default()
|
||||
//
|
||||
// // Convert middleware to Gin middleware
|
||||
// router.Use(func(c *gin.Context) {
|
||||
// AuthMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
// c.Request = r
|
||||
// c.Next()
|
||||
// })).ServeHTTP(c.Writer, c.Request)
|
||||
// })
|
||||
//
|
||||
// // Setup routes
|
||||
// api := router.Group("/api")
|
||||
// api.Any("/:schema/:entity", gin.WrapH(http.HandlerFunc(handler.Handle)))
|
||||
// api.Any("/:schema/:entity/:id", gin.WrapH(http.HandlerFunc(handler.Handle)))
|
||||
//
|
||||
// return router
|
||||
// }
|
||||
@@ -3,7 +3,7 @@ package testmodels
|
||||
import (
|
||||
"time"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/modelregistry"
|
||||
)
|
||||
|
||||
// Department represents a company department
|
||||
|
||||
@@ -1,71 +1,70 @@
|
||||
{
|
||||
"name": "@warkypublic/resolvespec-js",
|
||||
"version": "1.0.0",
|
||||
"description": "Client side library for the ResolveSpec API",
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
"module": "./src/index.ts",
|
||||
"types": "./src/index.ts",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"main": "./dist/index.js",
|
||||
"module": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"bin",
|
||||
"README.md"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "vite build",
|
||||
"clean": "rm -rf dist",
|
||||
"prepublishOnly": "npm run build",
|
||||
"test": "vitest run",
|
||||
"lint": "eslint src"
|
||||
},
|
||||
"keywords": [
|
||||
"string",
|
||||
"blob",
|
||||
"dependencies",
|
||||
"workspace",
|
||||
"package",
|
||||
"cli",
|
||||
"tools",
|
||||
"npm",
|
||||
"yarn",
|
||||
"pnpm"
|
||||
],
|
||||
"author": "Hein (Warkanum) Puth",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"semver": "^7.6.3",
|
||||
"uuid": "^11.0.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@changesets/cli": "^2.27.10",
|
||||
"@eslint/js": "^9.16.0",
|
||||
"@types/jsdom": "^21.1.7",
|
||||
"eslint": "^9.16.0",
|
||||
"globals": "^15.13.0",
|
||||
"jsdom": "^25.0.1",
|
||||
"typescript": "^5.7.2",
|
||||
"typescript-eslint": "^8.17.0",
|
||||
"vite": "^6.0.2",
|
||||
"vite-plugin-dts": "^4.3.0",
|
||||
"vitest": "^2.1.8"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.16"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/Warky-Devs/ResolveSpec"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/Warky-Devs/ResolveSpec/issues"
|
||||
},
|
||||
"homepage": "https://github.com/Warky-Devs/ResolveSpec#readme",
|
||||
"packageManager": "pnpm@9.6.0+sha512.38dc6fba8dba35b39340b9700112c2fe1e12f10b17134715a4aa98ccf7bb035e76fd981cf0bb384dfa98f8d6af5481c2bef2f4266a24bfa20c34eb7147ce0b5e"
|
||||
}
|
||||
|
||||
"name": "@warkypublic/resolvespec-js",
|
||||
"version": "1.0.0",
|
||||
"description": "Client side library for the ResolveSpec API",
|
||||
"type": "module",
|
||||
"main": "./src/index.ts",
|
||||
"module": "./src/index.ts",
|
||||
"types": "./src/index.ts",
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"main": "./dist/index.js",
|
||||
"module": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"bin",
|
||||
"README.md"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "vite build",
|
||||
"clean": "rm -rf dist",
|
||||
"prepublishOnly": "npm run build",
|
||||
"test": "vitest run",
|
||||
"lint": "eslint src"
|
||||
},
|
||||
"keywords": [
|
||||
"string",
|
||||
"blob",
|
||||
"dependencies",
|
||||
"workspace",
|
||||
"package",
|
||||
"cli",
|
||||
"tools",
|
||||
"npm",
|
||||
"yarn",
|
||||
"pnpm"
|
||||
],
|
||||
"author": "Hein (Warkanum) Puth",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"semver": "^7.6.3",
|
||||
"uuid": "^11.0.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@changesets/cli": "^2.27.10",
|
||||
"@eslint/js": "^9.16.0",
|
||||
"@types/jsdom": "^21.1.7",
|
||||
"eslint": "^9.16.0",
|
||||
"globals": "^15.13.0",
|
||||
"jsdom": "^25.0.1",
|
||||
"typescript": "^5.7.2",
|
||||
"typescript-eslint": "^8.17.0",
|
||||
"vite": "^6.0.2",
|
||||
"vite-plugin-dts": "^4.3.0",
|
||||
"vitest": "^2.1.8"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=14.16"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/bitechdev/ResolveSpec"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/bitechdev/ResolveSpec/issues"
|
||||
},
|
||||
"homepage": "https://github.com/bitechdev/ResolveSpec#readme",
|
||||
"packageManager": "pnpm@9.6.0+sha512.38dc6fba8dba35b39340b9700112c2fe1e12f10b17134715a4aa98ccf7bb035e76fd981cf0bb384dfa98f8d6af5481c2bef2f4266a24bfa20c34eb7147ce0b5e"
|
||||
}
|
||||
@@ -10,10 +10,10 @@ import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/logger"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/resolvespec"
|
||||
"github.com/Warky-Devs/ResolveSpec/pkg/testmodels"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/logger"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/modelregistry"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/resolvespec"
|
||||
"github.com/bitechdev/ResolveSpec/pkg/testmodels"
|
||||
"github.com/glebarez/sqlite"
|
||||
"github.com/gorilla/mux"
|
||||
"github.com/stretchr/testify/assert"
|
||||
@@ -83,7 +83,7 @@ func TestSetup(m *testing.M) int {
|
||||
router := setupTestRouter(testDB)
|
||||
testServer = httptest.NewServer(router)
|
||||
|
||||
fmt.Printf("ResolveSpec test server starting on %s\n", testServer.URL)
|
||||
logger.Info("ResolveSpec test server starting on %s", testServer.URL)
|
||||
testServerURL = testServer.URL
|
||||
|
||||
defer testServer.Close()
|
||||
|
||||
159
todo.md
Normal file
159
todo.md
Normal file
@@ -0,0 +1,159 @@
|
||||
# ResolveSpec - TODO List
|
||||
|
||||
This document tracks incomplete features and improvements for the ResolveSpec project.
|
||||
|
||||
## Core Features to Implement
|
||||
|
||||
### 1. Column Selection and Filtering for Preloads
|
||||
**Location:** `pkg/resolvespec/handler.go:730`
|
||||
**Status:** Not Implemented
|
||||
**Description:** Currently, preloads are applied without any column selection or filtering. This feature would allow clients to:
|
||||
- Select specific columns for preloaded relationships
|
||||
- Apply filters to preloaded data
|
||||
- Reduce payload size and improve performance
|
||||
|
||||
**Current Limitation:**
|
||||
```go
|
||||
// For now, we'll preload without conditions
|
||||
// TODO: Implement column selection and filtering for preloads
|
||||
// This requires a more sophisticated approach with callbacks or query builders
|
||||
query = query.Preload(relationFieldName)
|
||||
```
|
||||
|
||||
**Required Implementation:**
|
||||
- Add support for column selection in preloaded relationships
|
||||
- Implement filtering conditions for preloaded data
|
||||
- Design a callback or query builder approach that works across different ORMs
|
||||
|
||||
---
|
||||
|
||||
### 2. Recursive JSON Cleaning
|
||||
**Location:** `pkg/restheadspec/handler.go:796`
|
||||
**Status:** Partially Implemented (Simplified)
|
||||
**Description:** The current `cleanJSON` function returns data as-is without recursively removing null and empty fields from nested structures.
|
||||
|
||||
**Current Limitation:**
|
||||
```go
|
||||
// This is a simplified implementation
|
||||
// A full implementation would recursively clean nested structures
|
||||
// For now, we'll return the data as-is
|
||||
// TODO: Implement recursive cleaning
|
||||
return data
|
||||
```
|
||||
|
||||
**Required Implementation:**
|
||||
- Recursively traverse nested structures (maps, slices, structs)
|
||||
- Remove null values
|
||||
- Remove empty objects and arrays
|
||||
- Handle edge cases (circular references, pointers, etc.)
|
||||
|
||||
---
|
||||
|
||||
### 3. Custom SQL Join Support
|
||||
**Location:** `pkg/restheadspec/headers.go:159`
|
||||
**Status:** Not Implemented
|
||||
**Description:** Support for custom SQL joins via the `X-Custom-SQL-Join` header is currently logged but not executed.
|
||||
|
||||
**Current Limitation:**
|
||||
```go
|
||||
case strings.HasPrefix(normalizedKey, "x-custom-sql-join"):
|
||||
// TODO: Implement custom SQL join
|
||||
logger.Debug("Custom SQL join not yet implemented: %s", decodedValue)
|
||||
```
|
||||
|
||||
**Required Implementation:**
|
||||
- Parse custom SQL join expressions from headers
|
||||
- Apply joins to the query builder
|
||||
- Ensure security (SQL injection prevention)
|
||||
- Support for different join types (INNER, LEFT, RIGHT, FULL)
|
||||
- Works across different database adapters (GORM, Bun)
|
||||
|
||||
---
|
||||
|
||||
### 4. Proper Condition Handling for Bun Preloads
|
||||
**Location:** `pkg/common/adapters/database/bun.go:202`
|
||||
**Status:** Partially Implemented
|
||||
**Description:** The Bun adapter's `Preload` method currently ignores conditions passed to it.
|
||||
|
||||
**Current Limitation:**
|
||||
```go
|
||||
func (b *BunSelectQuery) Preload(relation string, conditions ...interface{}) common.SelectQuery {
|
||||
// Bun uses Relation() method for preloading
|
||||
// For now, we'll just pass the relation name without conditions
|
||||
// TODO: Implement proper condition handling for Bun
|
||||
b.query = b.query.Relation(relation)
|
||||
return b
|
||||
}
|
||||
```
|
||||
|
||||
**Required Implementation:**
|
||||
- Properly handle condition parameters in Bun's Relation() method
|
||||
- Support filtering on preloaded relationships
|
||||
- Ensure compatibility with GORM's condition syntax where possible
|
||||
- Test with various condition types
|
||||
|
||||
---
|
||||
|
||||
## Code Quality Improvements
|
||||
|
||||
### 5. Modernize Go Type Declarations
|
||||
**Location:** `pkg/common/types.go:5, 42, 64, 79`
|
||||
**Status:** Pending
|
||||
**Priority:** Low
|
||||
**Description:** Replace legacy `interface{}` with modern `any` type alias (Go 1.18+).
|
||||
|
||||
**Affected Lines:**
|
||||
- Line 5: Function parameter or return type
|
||||
- Line 42: Function parameter or return type
|
||||
- Line 64: Function parameter or return type
|
||||
- Line 79: Function parameter or return type
|
||||
|
||||
**Benefits:**
|
||||
- More modern and idiomatic Go code
|
||||
- Better readability
|
||||
- Aligns with current Go best practices
|
||||
|
||||
---
|
||||
|
||||
### 6. Pre / Post select/update/delete query in transaction.
|
||||
- This will allow us to set a user before doing a select
|
||||
- When making changes, we can have the trigger fire with the correct user.
|
||||
- Maybe wrap the handleRead,Update,Create,Delete handlers in a transaction with context that can abort when the request is cancelled or a configurable timeout is reached.
|
||||
|
||||
### 7.
|
||||
|
||||
## Additional Considerations
|
||||
|
||||
### 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
|
||||
|
||||
### Testing
|
||||
- Add unit tests for each new feature
|
||||
- Add integration tests for database adapter compatibility
|
||||
- Ensure backward compatibility is maintained
|
||||
|
||||
### Performance
|
||||
- Profile preload performance with column selection and filtering
|
||||
- Optimize recursive JSON cleaning for large payloads
|
||||
- Benchmark custom SQL join performance
|
||||
|
||||
---
|
||||
|
||||
## 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-11-07
|
||||
Reference in New Issue
Block a user