|
| 1 | +--- |
| 2 | +name: Bug Report |
| 3 | +about: Create a detailed bug report to help us improve the DuckDB GORM driver |
| 4 | +title: '[BUG] Brief description of the issue' |
| 5 | +labels: 'bug' |
| 6 | +assignees: '' |
| 7 | +--- |
| 8 | + |
| 9 | +# DuckDB GORM Driver Bug Report |
| 10 | + |
| 11 | +**Report Date:** <!-- Current date --> |
| 12 | +**Project:** <!-- Your project name --> |
| 13 | +**Driver Version:** `github.com/greysquirr3l/gorm-duckdb-driver vX.X.X` |
| 14 | +**Issue Type:** <!-- Critical/High/Medium/Low - Application Crash/Data Loss/Performance/Enhancement --> |
| 15 | +**Severity:** <!-- Blocker/Critical/Major/Minor --> |
| 16 | + |
| 17 | +## Summary |
| 18 | + |
| 19 | +<!-- Provide a clear and concise description of the bug --> |
| 20 | + |
| 21 | +## Environment |
| 22 | + |
| 23 | +### Software Versions |
| 24 | + |
| 25 | +- **Go Version:** <!-- e.g., 1.21.5 --> |
| 26 | +- **GORM Version:** <!-- e.g., v1.25.12 --> |
| 27 | +- **DuckDB Driver:** `github.com/greysquirr3l/gorm-duckdb-driver vX.X.X` |
| 28 | +- **DuckDB Bindings:** <!-- e.g., github.com/marcboeker/go-duckdb/v2 --> |
| 29 | +- **Operating System:** <!-- e.g., macOS 14.2, Ubuntu 22.04, Windows 11 --> |
| 30 | + |
| 31 | +### Dependencies |
| 32 | + |
| 33 | +```go |
| 34 | +// Include relevant go.mod entries |
| 35 | +require ( |
| 36 | + gorm.io/gorm vX.X.X |
| 37 | + gorm.io/driver/duckdb vX.X.X |
| 38 | +) |
| 39 | + |
| 40 | +// Include any replace directives |
| 41 | +replace gorm.io/driver/duckdb => github.com/greysquirr3l/gorm-duckdb-driver vX.X.X |
| 42 | +``` |
| 43 | + |
| 44 | +## Error Details |
| 45 | + |
| 46 | +### Stack Trace |
| 47 | + |
| 48 | +```plaintext |
| 49 | +<!-- Paste the complete stack trace here --> |
| 50 | +``` |
| 51 | + |
| 52 | +### Error Location |
| 53 | + |
| 54 | +```go |
| 55 | +// File: path/to/file.go:line |
| 56 | +// Include the relevant code snippet where the error occurs |
| 57 | +``` |
| 58 | + |
| 59 | +## Root Cause Analysis |
| 60 | + |
| 61 | +### Primary Issue |
| 62 | + |
| 63 | +<!-- Describe what you believe is causing the issue --> |
| 64 | + |
| 65 | +### Technical Details |
| 66 | + |
| 67 | +1. **Description of the problem:** |
| 68 | + - <!-- Step-by-step breakdown of what happens --> |
| 69 | + |
| 70 | +2. **Driver Failure Point:** |
| 71 | + - <!-- Where specifically the driver fails --> |
| 72 | + |
| 73 | +3. **Missing/Broken Implementation:** |
| 74 | + - <!-- What functionality is missing or broken --> |
| 75 | + |
| 76 | +## Models/Schemas Being Used |
| 77 | + |
| 78 | +### Model Definition |
| 79 | + |
| 80 | +```go |
| 81 | +type YourModel struct { |
| 82 | + // Include the complete model definition that causes the issue |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +## Impact Assessment |
| 87 | + |
| 88 | +### Severity: **[SEVERITY LEVEL]** |
| 89 | + |
| 90 | +- **Application Startup:** ✅/❌ <!-- Works/Fails --> |
| 91 | +- **Database Operations:** ✅/❌ <!-- Works/Fails --> |
| 92 | +- **Production Deployment:** ✅/❌ <!-- Possible/Impossible --> |
| 93 | +- **Development Testing:** ✅/❌ <!-- Works/Blocked --> |
| 94 | + |
| 95 | +### Business Impact |
| 96 | + |
| 97 | +- <!-- Describe the business impact of this issue --> |
| 98 | + |
| 99 | +## Reproduction Steps |
| 100 | + |
| 101 | +1. **Setup:** |
| 102 | + |
| 103 | + ```bash |
| 104 | + # Include setup commands |
| 105 | + ``` |
| 106 | + |
| 107 | +2. **Run:** |
| 108 | + |
| 109 | + ```bash |
| 110 | + # Include commands to reproduce |
| 111 | + ``` |
| 112 | + |
| 113 | +3. **Observe:** |
| 114 | + - <!-- What happens when you run the above --> |
| 115 | + |
| 116 | +4. **Minimal Reproduction Case:** |
| 117 | + |
| 118 | + ```go |
| 119 | + package main |
| 120 | + |
| 121 | + import ( |
| 122 | + "gorm.io/gorm" |
| 123 | + duckdb "gorm.io/driver/duckdb" |
| 124 | + ) |
| 125 | + |
| 126 | + func main() { |
| 127 | + // Minimal code that reproduces the issue |
| 128 | + } |
| 129 | + ``` |
| 130 | + |
| 131 | +## Expected Behavior |
| 132 | + |
| 133 | +<!-- Describe what you expected to happen --> |
| 134 | + |
| 135 | +### Required Functionality |
| 136 | + |
| 137 | +- **Feature 1:** <!-- What should work --> |
| 138 | +- **Feature 2:** <!-- What should work --> |
| 139 | + |
| 140 | +## Current Behavior |
| 141 | + |
| 142 | +<!-- Describe what actually happens --> |
| 143 | + |
| 144 | +## Workaround Attempts |
| 145 | + |
| 146 | +### 1. **Attempted Solution 1** ✅/❌ |
| 147 | + |
| 148 | +```go |
| 149 | +// Code for workaround |
| 150 | +``` |
| 151 | + |
| 152 | +**Result:** <!-- What happened --> |
| 153 | + |
| 154 | +### 2. **Attempted Solution 2** ✅/❌ |
| 155 | + |
| 156 | +```go |
| 157 | +// Code for workaround |
| 158 | +``` |
| 159 | + |
| 160 | +**Result:** <!-- What happened --> |
| 161 | + |
| 162 | +## Proposed Solutions |
| 163 | + |
| 164 | +### 1. **[Solution Name]** |
| 165 | + |
| 166 | +**Priority:** <!-- HIGH/MEDIUM/LOW --> |
| 167 | +**Effort:** <!-- High/Medium/Low --> |
| 168 | + |
| 169 | +```go |
| 170 | +// Proposed code changes or approach |
| 171 | +``` |
| 172 | + |
| 173 | +**Description:** <!-- Explain the solution --> |
| 174 | + |
| 175 | +### 2. **Alternative Approach** |
| 176 | + |
| 177 | +**Priority:** <!-- HIGH/MEDIUM/LOW --> |
| 178 | +**Effort:** <!-- High/Medium/Low --> |
| 179 | + |
| 180 | +<!-- Describe alternative solution --> |
| 181 | + |
| 182 | +## Additional Context |
| 183 | + |
| 184 | +### Configuration |
| 185 | + |
| 186 | +```go |
| 187 | +// Include any relevant configuration |
| 188 | +db, err := gorm.Open(duckdb.Open("database.db"), &gorm.Config{ |
| 189 | + // Your config |
| 190 | +}) |
| 191 | +``` |
| 192 | + |
| 193 | +### Extensions Used |
| 194 | + |
| 195 | +<!-- List any DuckDB extensions that are loaded --> |
| 196 | +- Extension 1 |
| 197 | +- Extension 2 |
| 198 | + |
| 199 | +### Performance Context |
| 200 | + |
| 201 | +<!-- If performance-related --> |
| 202 | +- **Data Size:** <!-- Amount of data involved --> |
| 203 | +- **Query Complexity:** <!-- Simple/Complex queries --> |
| 204 | +- **Concurrent Connections:** <!-- Number of connections --> |
| 205 | + |
| 206 | +## Testing Information |
| 207 | + |
| 208 | +### Test Case |
| 209 | + |
| 210 | +```go |
| 211 | +func TestReproduceBug(t *testing.T) { |
| 212 | + // Test case that reproduces the bug |
| 213 | +} |
| 214 | +``` |
| 215 | + |
| 216 | +### Expected Test Result |
| 217 | + |
| 218 | +<!-- What the test should do when the bug is fixed --> |
| 219 | + |
| 220 | +## Screenshots/Logs |
| 221 | + |
| 222 | +<!-- Include any relevant screenshots or additional log output --> |
| 223 | + |
| 224 | +## Checklist |
| 225 | + |
| 226 | +- [ ] I have searched existing issues for similar problems |
| 227 | +- [ ] I have provided a minimal reproduction case |
| 228 | +- [ ] I have included all relevant version information |
| 229 | +- [ ] I have described the expected behavior |
| 230 | +- [ ] I have included stack traces and error messages |
| 231 | +- [ ] I have attempted basic troubleshooting steps |
| 232 | + |
| 233 | +## Additional Information |
| 234 | + |
| 235 | +<!-- Any other information that might be relevant --> |
| 236 | + |
| 237 | +--- |
| 238 | + |
| 239 | +**Reporter:** <!-- Your name/handle --> |
| 240 | +**Contact:** <!-- Email or preferred contact method --> |
| 241 | +**Priority for Your Project:** <!-- High/Medium/Low --> |
| 242 | +**Willing to Contribute Fix:** <!-- Yes/No/Maybe --> |
0 commit comments