Compare commits
96 Commits
imagemagic
...
units-mock
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
886baa8bea | ||
|
|
aee53242a0 | ||
|
|
4829582584 | ||
|
|
6cf5183371 | ||
|
|
75ddea4071 | ||
|
|
5aceab434f | ||
|
|
fca4bf5d16 | ||
|
|
e2c812a5a6 | ||
|
|
ee35719cd5 | ||
|
|
e74eff0c09 | ||
|
|
552002b9a2 | ||
|
|
4391cb2881 | ||
| 0b9c243969 | |||
|
|
6afe1c4c13 | ||
|
|
5fc362ad4b | ||
|
|
d7733e4c41 | ||
|
|
51b8a0b0a8 | ||
|
|
2d17bfd3b4 | ||
|
|
963ff9234f | ||
|
|
80aecbcbbc | ||
|
|
8336d9d6bd | ||
|
|
ae0601281b | ||
|
|
7b31ea0143 | ||
|
|
d5786e5131 | ||
|
|
d663c52f2d | ||
|
|
8db07465ed | ||
|
|
9de6ebbf69 | ||
|
|
612c0b51cc | ||
|
|
ce107fba52 | ||
|
|
4422c82c08 | ||
|
|
fbcd3a50ca | ||
|
|
a37fb51876 | ||
|
|
8386804bbd | ||
|
|
618b822c8b | ||
|
|
e73b00572a | ||
| 22c495595f | |||
| 7d73e09de7 | |||
| fe08db1e95 | |||
| 3aaea9c829 | |||
| c80ded9e6d | |||
|
|
1666e77aa5 | ||
|
|
f31eb5f6c9 | ||
|
|
9f976f011a | ||
|
|
e733089bad | ||
|
|
3c44dc0921 | ||
|
|
1211b87f4e | ||
|
|
76c94bbe08 | ||
|
|
63e1738d87 | ||
|
|
1a06dea491 | ||
|
|
ab23d49145 | ||
|
|
86e9aa75c1 | ||
|
|
8724f8bbe0 | ||
|
|
c3424e3137 | ||
|
|
9384f0083a | ||
|
|
bc1214e9db | ||
|
|
d39e21394c | ||
| b138f5cdaf | |||
| e6ce71362a | |||
| 01b2f9e8c1 | |||
| b43ff58b71 | |||
| 016e849d3e | |||
|
|
cdf5fbdfc6 | ||
| cf44ec1a1d | |||
|
|
f85c190557 | ||
|
|
bc9d3cdda5 | ||
| 1a03dbb24c | |||
| dc8a897004 | |||
| 404fa0e78f | |||
|
|
5f417aeabd | ||
|
|
1542c7bb75 | ||
|
|
68c0459533 | ||
|
|
b761088839 | ||
|
|
e15f540292 | ||
|
|
23b4460376 | ||
|
|
41c243e9f1 | ||
|
|
9196081f34 | ||
|
|
49bf13021f | ||
|
|
2b6a2d3612 | ||
|
|
934e18f728 | ||
|
|
ceb63e3e61 | ||
|
|
7379b25bf7 | ||
|
|
8e0b339095 | ||
|
|
6302147907 | ||
|
|
da887b2e7f | ||
|
|
adcfaa0ca4 | ||
|
|
bbbff348fb | ||
|
|
34df849398 | ||
|
|
4ee26a0074 | ||
|
|
551f09a743 | ||
|
|
0d72d6422e | ||
|
|
8916243c32 | ||
|
|
f808565c82 | ||
|
|
00a0ec4aa7 | ||
|
|
a8ca13ad6d | ||
|
|
2d14493b8c | ||
|
|
97fd73b74f |
@@ -2,14 +2,16 @@
|
|||||||
|
|
||||||
## ADR-XXXX-YY-ZZ: [Short Title]
|
## ADR-XXXX-YY-ZZ: [Short Title]
|
||||||
|
|
||||||
**Date:** YYYY-MM-DD
|
**Date:** YYYY-MM-DD
|
||||||
**Status:** [PROPOSED | ACCEPTED | REJECTED | DEPRECATED | SUPERSEDED]
|
**Status:** [PROPOSED | ACCEPTED | REJECTED | DEPRECATED | SUPERSEDED]
|
||||||
**Deciders:** [List of decision makers]
|
**Deciders:** [List of decision makers]
|
||||||
**Technical Story:** [Link to issue/PR if applicable]
|
**Technical Story:** [Link to issue/PR if applicable]
|
||||||
|
|
||||||
## Context
|
## Context
|
||||||
|
|
||||||
[Describe the forces at play, including technological, political, social, and project local. These forces are probably in tension, and should be called out as such. The language in this section is value-neutral. It is simply describing facts.]
|
[Describe the forces at play, including technological, political, social, and
|
||||||
|
project local. These forces are probably in tension, and should be called out as
|
||||||
|
such. The language in this section is value-neutral. It is simply describing facts.]
|
||||||
|
|
||||||
## Decision
|
## Decision
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
---
|
---
|
||||||
description:
|
description: when you need to understand the system architecture or make changes that impact the system architecture
|
||||||
globs:
|
alwaysApply: false
|
||||||
alwaysApply: true
|
|
||||||
---
|
---
|
||||||
# TimeSafari Cross-Platform Architecture Guide
|
# TimeSafari Cross-Platform Architecture Guide
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Architecture guidelines
|
||||||
|
|
||||||
## 1. Platform Support Matrix
|
## 1. Platform Support Matrix
|
||||||
|
|
||||||
| Feature | Web (PWA) | Capacitor (Mobile) | Electron (Desktop) |
|
| Feature | Web (PWA) | Capacitor (Mobile) | Electron (Desktop) |
|
||||||
@@ -15,11 +18,10 @@ alwaysApply: true
|
|||||||
| Camera Access | MediaDevices API | Capacitor Camera | Not Implemented |
|
| Camera Access | MediaDevices API | Capacitor Camera | Not Implemented |
|
||||||
| Platform Detection | Web APIs | Capacitor.isNativePlatform() | process.env checks |
|
| Platform Detection | Web APIs | Capacitor.isNativePlatform() | process.env checks |
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Project Structure
|
## 2. Project Structure
|
||||||
|
|
||||||
### Core Directories
|
### Core Directories
|
||||||
|
|
||||||
```
|
```
|
||||||
src/
|
src/
|
||||||
├── components/ # Vue components
|
├── components/ # Vue components
|
||||||
@@ -38,14 +40,13 @@ src/
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Entry Points
|
### Entry Points
|
||||||
|
|
||||||
- `main.ts` → Base entry
|
- `main.ts` → Base entry
|
||||||
- `main.common.ts` → Shared init
|
- `main.common.ts` → Shared init
|
||||||
- `main.capacitor.ts` → Mobile entry
|
- `main.capacitor.ts` → Mobile entry
|
||||||
- `main.electron.ts` → Electron entry
|
- `main.electron.ts` → Electron entry
|
||||||
- `main.web.ts` → Web entry
|
- `main.web.ts` → Web entry
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Service Architecture
|
## 3. Service Architecture
|
||||||
|
|
||||||
### Service Organization
|
### Service Organization
|
||||||
@@ -64,28 +65,30 @@ services/
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Factory Pattern
|
### Factory Pattern
|
||||||
Use a **singleton factory** to select platform services via `process.env.VITE_PLATFORM`.
|
|
||||||
|
|
||||||
---
|
Use a **singleton factory** to select platform services via
|
||||||
|
`process.env.VITE_PLATFORM`.
|
||||||
|
|
||||||
## 4. Feature Guidelines
|
## 4. Feature Guidelines
|
||||||
|
|
||||||
### QR Code Scanning
|
### QR Code Scanning
|
||||||
|
|
||||||
- Define `QRScannerService` interface.
|
- Define `QRScannerService` interface.
|
||||||
- Implement platform-specific classes (`WebInlineQRScanner`, Capacitor, etc).
|
- Implement platform-specific classes (`WebInlineQRScanner`, Capacitor,
|
||||||
|
etc).
|
||||||
- Provide `addListener` and `onStream` hooks for composability.
|
- Provide `addListener` and `onStream` hooks for composability.
|
||||||
|
|
||||||
### Deep Linking
|
### Deep Linking
|
||||||
- URL format: `timesafari://<route>[/<param>][?query=value]`
|
|
||||||
- Web: `router.beforeEach` → parse query
|
|
||||||
- Capacitor: `App.addListener("appUrlOpen", …)`
|
|
||||||
|
|
||||||
---
|
- URL format: `timesafari://<route>[/<param>][?query=value]`
|
||||||
|
- Web: `router.beforeEach` → parse query
|
||||||
|
- Capacitor: `App.addListener("appUrlOpen", …)`
|
||||||
|
|
||||||
## 5. Build Process
|
## 5. Build Process
|
||||||
|
|
||||||
- `vite.config.common.mts` → shared config
|
- `vite.config.common.mts` → shared config
|
||||||
- Platform configs: `vite.config.web.mts`, `.capacitor.mts`, `.electron.mts`
|
- Platform configs: `vite.config.web.mts`, `.capacitor.mts`,
|
||||||
|
`.electron.mts`
|
||||||
- Use `process.env.VITE_PLATFORM` for conditional loading.
|
- Use `process.env.VITE_PLATFORM` for conditional loading.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -94,78 +97,255 @@ npm run build:capacitor
|
|||||||
npm run build:electron
|
npm run build:electron
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Testing Strategy
|
## 6. Testing Strategy
|
||||||
|
|
||||||
- **Unit tests** for services.
|
- **Unit tests** for services.
|
||||||
- **Playwright** for Web + Capacitor:
|
- **Playwright** for Web + Capacitor:
|
||||||
- `playwright.config-local.ts` includes web + Pixel 5.
|
- `playwright.config-local.ts` includes web + Pixel 5.
|
||||||
- **Electron tests**: add `spectron` or Playwright-Electron.
|
- **Electron tests**: add `spectron` or Playwright-Electron.
|
||||||
- Mark tests with platform tags:
|
- Mark tests with platform tags:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
test.skip(!process.env.MOBILE_TEST, "Mobile-only test");
|
test.skip(!process.env.MOBILE_TEST, "Mobile-only test");
|
||||||
```
|
```
|
||||||
|
|
||||||
> 🔗 **Human Hook:** Before merging new tests, hold a short sync (≤15 min) with QA to align on coverage and flaky test risks.
|
> 🔗 **Human Hook:** Before merging new tests, hold a short sync (≤15
|
||||||
|
> min) with QA to align on coverage and flaky test risks.
|
||||||
---
|
|
||||||
|
|
||||||
## 7. Error Handling
|
## 7. Error Handling
|
||||||
|
|
||||||
- Global Vue error handler → logs with component name.
|
- Global Vue error handler → logs with component name.
|
||||||
- Platform-specific wrappers log API errors with platform prefix (`[Capacitor API Error]`, etc).
|
- Platform-specific wrappers log API errors with platform prefix
|
||||||
|
(`[Capacitor API Error]`, etc).
|
||||||
- Use structured logging (not `console.log`).
|
- Use structured logging (not `console.log`).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 8. Best Practices
|
## 8. Best Practices
|
||||||
|
|
||||||
- Keep platform code **isolated** in `platforms/`.
|
- Keep platform code **isolated** in `platforms/`.
|
||||||
- Always define a **shared interface** first.
|
- Always define a **shared interface** first.
|
||||||
- Use feature detection, not platform detection, when possible.
|
- Use feature detection, not platform detection, when possible.
|
||||||
- Dependency injection for services → improves testability.
|
- Dependency injection for services → improves testability.
|
||||||
- Maintain **Competence Hooks** in PRs (2–3 prompts for dev discussion).
|
- Maintain **Competence Hooks** in PRs (2–3 prompts for dev
|
||||||
|
discussion).
|
||||||
---
|
|
||||||
|
|
||||||
## 9. Dependency Management
|
## 9. Dependency Management
|
||||||
|
|
||||||
- Key deps: `@capacitor/core`, `electron`, `vue`.
|
- Key deps: `@capacitor/core`, `electron`, `vue`.
|
||||||
- Use conditional `import()` for platform-specific libs.
|
- Use conditional `import()` for platform-specific libs.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 10. Security Considerations
|
## 10. Security Considerations
|
||||||
|
|
||||||
- **Permissions**: Always check + request gracefully.
|
- **Permissions**: Always check + request gracefully.
|
||||||
- **Storage**: Secure storage for sensitive data; encrypt when possible.
|
- **Storage**: Secure storage for sensitive data; encrypt when possible.
|
||||||
- **Audits**: Schedule quarterly security reviews.
|
- **Audits**: Schedule quarterly security reviews.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 11. ADR Process
|
## 11. ADR Process
|
||||||
|
|
||||||
- All major architecture choices → log in `doc/adr/`.
|
- All major architecture choices → log in `doc/adr/`.
|
||||||
- Use ADR template with Context, Decision, Consequences, Status.
|
- Use ADR template with Context, Decision, Consequences, Status.
|
||||||
- Link related ADRs in PR descriptions.
|
- Link related ADRs in PR descriptions.
|
||||||
|
|
||||||
> 🔗 **Human Hook:** When proposing a new ADR, schedule a 30-min design sync for discussion, not just async review.
|
> 🔗 **Human Hook:** When proposing a new ADR, schedule a 30-min
|
||||||
|
> design sync for discussion, not just async review.
|
||||||
---
|
|
||||||
|
|
||||||
## 12. Collaboration Hooks
|
## 12. Collaboration Hooks
|
||||||
|
|
||||||
- **QR features**: Sync with Security before merging → permissions & privacy.
|
- **QR features**: Sync with Security before merging → permissions &
|
||||||
- **New platform builds**: Demo in team meeting → confirm UX differences.
|
privacy.
|
||||||
- **Critical ADRs**: Present in guild or architecture review.
|
- **New platform builds**: Demo in team meeting → confirm UX
|
||||||
|
differences.
|
||||||
|
- **Critical ADRs**: Present in guild or architecture review.
|
||||||
|
|
||||||
|
## Self-Check
|
||||||
|
|
||||||
|
- [ ] Does this feature implement a shared interface?
|
||||||
|
- [ ] Are fallbacks + errors handled gracefully?
|
||||||
|
- [ ] Have relevant ADRs been updated/linked?
|
||||||
|
- [ ] Did I add competence hooks or prompts for the team?
|
||||||
|
- [ ] Was human interaction (sync/review/demo) scheduled?
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Self-Check
|
**Status**: Active architecture guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: Vue 3, Capacitor, Electron, Vite
|
||||||
|
**Stakeholders**: Development team, Architecture team
|
||||||
|
|
||||||
|
- [ ] Are fallbacks + errors handled gracefully?
|
||||||
|
- [ ] Have relevant ADRs been updated/linked?
|
||||||
|
- [ ] Did I add competence hooks or prompts for the team?
|
||||||
|
- [ ] Was human interaction (sync/review/demo) scheduled?
|
||||||
|
# TimeSafari Cross-Platform Architecture Guide
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Architecture guidelines
|
||||||
|
|
||||||
|
## 1. Platform Support Matrix
|
||||||
|
|
||||||
|
| Feature | Web (PWA) | Capacitor (Mobile) | Electron (Desktop) |
|
||||||
|
|---------|-----------|--------------------|-------------------|
|
||||||
|
| QR Code Scanning | WebInlineQRScanner | @capacitor-mlkit/barcode-scanning | Not Implemented |
|
||||||
|
| Deep Linking | URL Parameters | App URL Open Events | Not Implemented |
|
||||||
|
| File System | Limited (Browser API) | Capacitor Filesystem | Electron fs |
|
||||||
|
| Camera Access | MediaDevices API | Capacitor Camera | Not Implemented |
|
||||||
|
| Platform Detection | Web APIs | Capacitor.isNativePlatform() | process.env checks |
|
||||||
|
|
||||||
|
## 2. Project Structure
|
||||||
|
|
||||||
|
### Core Directories
|
||||||
|
|
||||||
|
```
|
||||||
|
src/
|
||||||
|
├── components/ # Vue components
|
||||||
|
├── services/ # Platform services and business logic
|
||||||
|
├── views/ # Page components
|
||||||
|
├── router/ # Vue router configuration
|
||||||
|
├── types/ # TypeScript type definitions
|
||||||
|
├── utils/ # Utility functions
|
||||||
|
├── lib/ # Core libraries
|
||||||
|
├── platforms/ # Platform-specific implementations
|
||||||
|
├── electron/ # Electron-specific code
|
||||||
|
├── constants/ # Application constants
|
||||||
|
├── db/ # Database related code
|
||||||
|
├── interfaces/ # TypeScript interfaces
|
||||||
|
└── assets/ # Static assets
|
||||||
|
```
|
||||||
|
|
||||||
|
### Entry Points
|
||||||
|
|
||||||
|
- `main.ts` → Base entry
|
||||||
|
- `main.common.ts` → Shared init
|
||||||
|
- `main.capacitor.ts` → Mobile entry
|
||||||
|
- `main.electron.ts` → Electron entry
|
||||||
|
- `main.web.ts` → Web entry
|
||||||
|
|
||||||
|
## 3. Service Architecture
|
||||||
|
|
||||||
|
### Service Organization
|
||||||
|
|
||||||
|
```tree
|
||||||
|
services/
|
||||||
|
├── QRScanner/
|
||||||
|
│ ├── WebInlineQRScanner.ts
|
||||||
|
│ └── interfaces.ts
|
||||||
|
├── platforms/
|
||||||
|
│ ├── WebPlatformService.ts
|
||||||
|
│ ├── CapacitorPlatformService.ts
|
||||||
|
│ └── ElectronPlatformService.ts
|
||||||
|
└── factory/
|
||||||
|
└── PlatformServiceFactory.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
### Factory Pattern
|
||||||
|
|
||||||
|
Use a **singleton factory** to select platform services via
|
||||||
|
`process.env.VITE_PLATFORM`.
|
||||||
|
|
||||||
|
## 4. Feature Guidelines
|
||||||
|
|
||||||
|
### QR Code Scanning
|
||||||
|
|
||||||
|
- Define `QRScannerService` interface.
|
||||||
|
- Implement platform-specific classes (`WebInlineQRScanner`, Capacitor,
|
||||||
|
etc).
|
||||||
|
- Provide `addListener` and `onStream` hooks for composability.
|
||||||
|
|
||||||
|
### Deep Linking
|
||||||
|
|
||||||
|
- URL format: `timesafari://<route>[/<param>][?query=value]`
|
||||||
|
- Web: `router.beforeEach` → parse query
|
||||||
|
- Capacitor: `App.addListener("appUrlOpen", …)`
|
||||||
|
|
||||||
|
## 5. Build Process
|
||||||
|
|
||||||
|
- `vite.config.common.mts` → shared config
|
||||||
|
- Platform configs: `vite.config.web.mts`, `.capacitor.mts`,
|
||||||
|
`.electron.mts`
|
||||||
|
- Use `process.env.VITE_PLATFORM` for conditional loading.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build:web
|
||||||
|
npm run build:capacitor
|
||||||
|
npm run build:electron
|
||||||
|
```
|
||||||
|
|
||||||
|
## 6. Testing Strategy
|
||||||
|
|
||||||
|
- **Unit tests** for services.
|
||||||
|
- **Playwright** for Web + Capacitor:
|
||||||
|
- `playwright.config-local.ts` includes web + Pixel 5.
|
||||||
|
- **Electron tests**: add `spectron` or Playwright-Electron.
|
||||||
|
- Mark tests with platform tags:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
test.skip(!process.env.MOBILE_TEST, "Mobile-only test");
|
||||||
|
```
|
||||||
|
|
||||||
|
> 🔗 **Human Hook:** Before merging new tests, hold a short sync (≤15
|
||||||
|
> min) with QA to align on coverage and flaky test risks.
|
||||||
|
|
||||||
|
## 7. Error Handling
|
||||||
|
|
||||||
|
- Global Vue error handler → logs with component name.
|
||||||
|
- Platform-specific wrappers log API errors with platform prefix
|
||||||
|
(`[Capacitor API Error]`, etc).
|
||||||
|
- Use structured logging (not `console.log`).
|
||||||
|
|
||||||
|
## 8. Best Practices
|
||||||
|
|
||||||
|
- Keep platform code **isolated** in `platforms/`.
|
||||||
|
- Always define a **shared interface** first.
|
||||||
|
- Use feature detection, not platform detection, when possible.
|
||||||
|
- Dependency injection for services → improves testability.
|
||||||
|
- Maintain **Competence Hooks** in PRs (2–3 prompts for dev
|
||||||
|
discussion).
|
||||||
|
|
||||||
|
## 9. Dependency Management
|
||||||
|
|
||||||
|
- Key deps: `@capacitor/core`, `electron`, `vue`.
|
||||||
|
- Use conditional `import()` for platform-specific libs.
|
||||||
|
|
||||||
|
## 10. Security Considerations
|
||||||
|
|
||||||
|
- **Permissions**: Always check + request gracefully.
|
||||||
|
- **Storage**: Secure storage for sensitive data; encrypt when possible.
|
||||||
|
- **Audits**: Schedule quarterly security reviews.
|
||||||
|
|
||||||
|
## 11. ADR Process
|
||||||
|
|
||||||
|
- All major architecture choices → log in `doc/adr/`.
|
||||||
|
- Use ADR template with Context, Decision, Consequences, Status.
|
||||||
|
- Link related ADRs in PR descriptions.
|
||||||
|
|
||||||
|
> 🔗 **Human Hook:** When proposing a new ADR, schedule a 30-min
|
||||||
|
> design sync for discussion, not just async review.
|
||||||
|
|
||||||
|
## 12. Collaboration Hooks
|
||||||
|
|
||||||
|
- **QR features**: Sync with Security before merging → permissions &
|
||||||
|
privacy.
|
||||||
|
- **New platform builds**: Demo in team meeting → confirm UX
|
||||||
|
differences.
|
||||||
|
- **Critical ADRs**: Present in guild or architecture review.
|
||||||
|
|
||||||
|
## Self-Check
|
||||||
|
|
||||||
|
- [ ] Does this feature implement a shared interface?
|
||||||
|
- [ ] Are fallbacks + errors handled gracefully?
|
||||||
|
- [ ] Have relevant ADRs been updated/linked?
|
||||||
|
- [ ] Did I add competence hooks or prompts for the team?
|
||||||
|
- [ ] Was human interaction (sync/review/demo) scheduled?
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active architecture guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: Vue 3, Capacitor, Electron, Vite
|
||||||
|
**Stakeholders**: Development team, Architecture team
|
||||||
|
|
||||||
- [ ] Does this feature implement a shared interface?
|
|
||||||
- [ ] Are fallbacks + errors handled gracefully?
|
- [ ] Are fallbacks + errors handled gracefully?
|
||||||
- [ ] Have relevant ADRs been updated/linked?
|
- [ ] Have relevant ADRs been updated/linked?
|
||||||
- [ ] Did I add competence hooks or prompts for the team?
|
- [ ] Did I add competence hooks or prompts for the team?
|
||||||
|
|||||||
@@ -1,316 +1,181 @@
|
|||||||
---
|
|
||||||
description:
|
|
||||||
globs:
|
|
||||||
alwaysApply: true
|
|
||||||
---
|
|
||||||
# Time Safari Context
|
# Time Safari Context
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Core application context
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
Time Safari is an application designed to foster community building through gifts,
|
Time Safari is an application designed to foster community building through
|
||||||
gratitude, and collaborative projects. The app should make it extremely easy and
|
gifts, gratitude, and collaborative projects. The app makes it easy and
|
||||||
intuitive for users of any age and capability to recognize contributions, build
|
intuitive for users of any age and capability to recognize contributions,
|
||||||
trust networks, and organize collective action. It is built on services that
|
build trust networks, and organize collective action. It is built on services
|
||||||
preserve privacy and data sovereignty.
|
that preserve privacy and data sovereignty.
|
||||||
|
|
||||||
The ultimate goals of Time Safari are two-fold:
|
## Core Goals
|
||||||
|
|
||||||
1. **Connect** Make it easy, rewarding, and non-threatening for people to
|
1. **Connect**: Make it easy, rewarding, and non-threatening for people to
|
||||||
connect with others who have similar interests, and to initiate activities
|
connect with others who have similar interests, and to initiate activities
|
||||||
together. This helps people accomplish and learn from other individuals in
|
together.
|
||||||
less-structured environments; moreover, it helps them discover who they want
|
|
||||||
to continue to support and with whom they want to maintain relationships.
|
|
||||||
|
|
||||||
2. **Reveal** Widely advertise the great support and rewards that are being
|
|
||||||
given and accepted freely, especially non-monetary ones. Using visuals and text,
|
|
||||||
display the kind of impact that gifts are making in the lives of others. Also
|
|
||||||
show useful and engaging reports of project statistics and personal accomplishments.
|
|
||||||
|
|
||||||
|
|
||||||
## Core Approaches
|
|
||||||
|
|
||||||
Time Safari should help everyday users build meaningful connections and organize
|
|
||||||
collective efforts by:
|
|
||||||
|
|
||||||
1. **Recognizing Contributions**: Creating permanent, verifiable records of gifts
|
|
||||||
and contributions people give to each other and their communities.
|
|
||||||
|
|
||||||
2. **Facilitating Collaboration**: Making it ridiculously easy for people to ask
|
|
||||||
for or propose help on projects and interests that matter to them.
|
|
||||||
|
|
||||||
3. **Building Trust Networks**: Enabling users to maintain their network and activity
|
|
||||||
visibility. Developing reputation through verified contributions and references,
|
|
||||||
which can be selectively shown to others outside the network.
|
|
||||||
|
|
||||||
4. **Preserving Privacy**: Ensuring personal identifiers are only shared with
|
|
||||||
explicitly authorized contacts, allowing private individuals including children
|
|
||||||
to participate safely.
|
|
||||||
|
|
||||||
5. **Engaging Content**: Displaying people's records in compelling stories, and
|
|
||||||
highlighting those projects that are lifting people's lives long-term, both in
|
|
||||||
physical support and in emotional-spiritual-creative thriving.
|
|
||||||
|
|
||||||
|
2. **Reveal**: Widely advertise the great support and rewards that are being
|
||||||
|
given and accepted freely, especially non-monetary ones, showing the impact
|
||||||
|
gifts make in people's lives.
|
||||||
|
|
||||||
## Technical Foundation
|
## Technical Foundation
|
||||||
|
|
||||||
This application is built on a privacy-preserving claims architecture (via
|
### Architecture
|
||||||
endorser.ch) with these key characteristics:
|
|
||||||
|
|
||||||
- **Decentralized Identifiers (DIDs)**: User identities are based on public/private
|
- **Privacy-preserving claims architecture** via endorser.ch
|
||||||
key pairs stored on their devices
|
- **Decentralized Identifiers (DIDs)**: User identities based on
|
||||||
|
public/private key pairs stored on devices
|
||||||
- **Cryptographic Verification**: All claims and confirmations are
|
- **Cryptographic Verification**: All claims and confirmations are
|
||||||
cryptographically signed
|
cryptographically signed
|
||||||
- **User-Controlled Visibility**: Users explicitly control who can see their
|
- **User-Controlled Visibility**: Users explicitly control who can see their
|
||||||
identifiers and data
|
identifiers and data
|
||||||
- **Merkle-Chained Claims**: Claims are cryptographically chained for verification
|
- **Cross-Platform**: Web (PWA), Mobile (Capacitor), Desktop (Electron)
|
||||||
and integrity
|
|
||||||
- **Native and Web App**: Works on Capacitor (iOS, Android), Desktop (Electron
|
|
||||||
and CEFPython), and web browsers
|
|
||||||
|
|
||||||
## User Journey
|
### Current Database State
|
||||||
|
|
||||||
The typical progression of usage follows these stages:
|
- **Database**: SQLite via Absurd SQL (browser) and native SQLite
|
||||||
|
(mobile/desktop)
|
||||||
|
- **Legacy Support**: IndexedDB (Dexie) for backward compatibility
|
||||||
|
- **Status**: Modern database architecture fully implemented
|
||||||
|
|
||||||
1. **Gratitude & Recognition**: Users begin by expressing and recording gratitude
|
### Core Technologies
|
||||||
for gifts received, building a foundation of acknowledgment.
|
|
||||||
|
|
||||||
2. **Project Proposals**: Users propose projects and ideas, reaching out to connect
|
- **Frontend**: Vue 3 + TypeScript + vue-facing-decorator
|
||||||
with others who share similar interests.
|
- **Styling**: TailwindCSS
|
||||||
|
- **Build**: Vite with platform-specific configs
|
||||||
|
- **Testing**: Playwright E2E, Jest unit tests
|
||||||
|
- **Database**: SQLite (Absurd SQL in browser), IndexedDB (legacy)
|
||||||
|
- **State**: Pinia stores
|
||||||
|
- **Platform Services**: Abstracted behind interfaces with factory pattern
|
||||||
|
|
||||||
3. **Action Triggers**: Offers of help serve as triggers and motivations to execute
|
## Development Principles
|
||||||
proposed projects, moving from ideas to action.
|
|
||||||
|
|
||||||
## Context for LLM Development
|
### Code Organization
|
||||||
|
|
||||||
When developing new functionality for Time Safari, consider these design principles:
|
- **Platform Services**: Abstract platform-specific code behind interfaces
|
||||||
|
- **Service Factory**: Use `PlatformServiceFactory` for platform selection
|
||||||
|
- **Type Safety**: Strict TypeScript, no `any` types, use type guards
|
||||||
|
- **Modern Architecture**: Use current platform service patterns
|
||||||
|
|
||||||
1. **Accessibility First**: Features should be usable by non-technical users with
|
### Architecture Patterns
|
||||||
minimal learning curve.
|
|
||||||
|
|
||||||
2. **Privacy by Design**: All features must respect user privacy and data sovereignty.
|
- **Dependency Injection**: Services injected via mixins and factory pattern
|
||||||
|
- **Interface Segregation**: Small, focused interfaces over large ones
|
||||||
|
- **Composition over Inheritance**: Prefer mixins and composition
|
||||||
|
- **Single Responsibility**: Each component/service has one clear purpose
|
||||||
|
|
||||||
3. **Progressive Enhancement**: Core functionality should work across all devices,
|
### Testing Strategy
|
||||||
with richer experiences where supported.
|
|
||||||
|
|
||||||
4. **Voluntary Collaboration**: The system should enable but never coerce participation.
|
- **E2E**: Playwright for critical user journeys
|
||||||
|
- **Unit**: Jest with F.I.R.S.T. principles
|
||||||
|
- **Platform Coverage**: Web + Capacitor (Pixel 5) in CI
|
||||||
|
- **Quality Assurance**: Comprehensive testing and validation
|
||||||
|
|
||||||
5. **Trust Building**: Features should help build verifiable trust between users.
|
## Current Development Focus
|
||||||
|
|
||||||
6. **Network Effects**: Consider how features scale as more users join the platform.
|
### Active Development
|
||||||
|
|
||||||
7. **Low Resource Requirements**: The system should be lightweight enough to run
|
- **Feature Development**: Build new functionality using modern platform
|
||||||
on inexpensive devices users already own.
|
services
|
||||||
|
- **Performance Optimization**: Improve app performance and user experience
|
||||||
|
- **Platform Enhancement**: Leverage platform-specific capabilities
|
||||||
|
- **Code Quality**: Maintain high standards and best practices
|
||||||
|
|
||||||
|
### Development Metrics
|
||||||
|
|
||||||
|
- **Code Quality**: High standards maintained across all platforms
|
||||||
|
- **Performance**: Optimized for all target devices
|
||||||
|
- **Testing**: Comprehensive coverage maintained
|
||||||
|
- **User Experience**: Focus on intuitive, accessible interfaces
|
||||||
|
|
||||||
|
## Platform-Specific Considerations
|
||||||
|
|
||||||
|
### Web (PWA)
|
||||||
|
|
||||||
|
- **QR Scanning**: WebInlineQRScanner
|
||||||
|
- **Deep Linking**: URL parameters
|
||||||
|
- **File System**: Limited browser APIs
|
||||||
|
- **Build**: `npm run build:web` (development build)
|
||||||
|
|
||||||
|
### Mobile (Capacitor)
|
||||||
|
|
||||||
|
- **QR Scanning**: @capacitor-mlkit/barcode-scanning
|
||||||
|
- **Deep Linking**: App URL open events
|
||||||
|
- **File System**: Capacitor Filesystem
|
||||||
|
- **Build**: `npm run build:capacitor`
|
||||||
|
|
||||||
|
### Desktop (Electron)
|
||||||
|
|
||||||
|
- **File System**: Node.js fs
|
||||||
|
- **Build**: `npm run build:electron`
|
||||||
|
- **Distribution**: AppImage, DEB, DMG packages
|
||||||
|
|
||||||
|
## Development Workflow
|
||||||
|
|
||||||
|
### Build Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Web (development)
|
||||||
|
npm run build:web
|
||||||
|
|
||||||
|
# Mobile
|
||||||
|
npm run build:capacitor
|
||||||
|
npm run build:native
|
||||||
|
|
||||||
|
# Desktop
|
||||||
|
npm run build:electron
|
||||||
|
npm run build:electron:appimage
|
||||||
|
npm run build:electron:deb
|
||||||
|
npm run build:electron:dmg
|
||||||
|
```
|
||||||
|
|
||||||
|
### Testing Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Web E2E
|
||||||
|
npm run test:web
|
||||||
|
|
||||||
|
# Mobile
|
||||||
|
npm run test:mobile
|
||||||
|
npm run test:android
|
||||||
|
npm run test:ios
|
||||||
|
|
||||||
|
# Type checking
|
||||||
|
npm run type-check
|
||||||
|
npm run lint-fix
|
||||||
|
```
|
||||||
|
|
||||||
|
## Key Constraints
|
||||||
|
|
||||||
|
1. **Privacy First**: User identifiers remain private except when explicitly
|
||||||
|
shared
|
||||||
|
2. **Platform Compatibility**: Features must work across all target platforms
|
||||||
|
3. **Performance**: Must remain performant on older/simpler devices
|
||||||
|
4. **Modern Architecture**: New features should use current platform services
|
||||||
|
5. **Offline Capability**: Key functionality should work offline when feasible
|
||||||
|
|
||||||
## Use Cases to Support
|
## Use Cases to Support
|
||||||
|
|
||||||
LLM development should focus on enhancing these key use cases:
|
1. **Community Building**: Tools for finding others with shared interests
|
||||||
|
2. **Project Coordination**: Easy proposal and collaboration on projects
|
||||||
|
3. **Reputation Building**: Showcasing contributions and reliability
|
||||||
|
4. **Governance**: Facilitating decision-making and collective governance
|
||||||
|
|
||||||
1. **Community Building**: Tools that help people find others with shared
|
## Resources
|
||||||
interests and values.
|
|
||||||
|
|
||||||
2. **Project Coordination**: Features that make it easy to propose collaborative
|
- **Testing**: `docs/migration-testing/`
|
||||||
projects and to submit suggestions and offers to existing ones.
|
- **Architecture**: `docs/architecture-decisions.md`
|
||||||
|
- **Build Context**: `docs/build-modernization-context.md`
|
||||||
|
|
||||||
3. **Reputation Building**: Methods for users to showcase their contributions
|
---
|
||||||
and reliability, in contexts where they explicitly reveal that information.
|
|
||||||
|
|
||||||
4. **Governance Experimentation**: Features that facilitate decision-making and
|
## Status: Active application context
|
||||||
collective governance.
|
|
||||||
|
|
||||||
## Constraints
|
- **Priority**: Critical
|
||||||
|
- **Estimated Effort**: Ongoing reference
|
||||||
When developing new features, be mindful of these constraints:
|
- **Dependencies**: Vue 3, TypeScript, SQLite, Capacitor, Electron
|
||||||
|
- **Stakeholders**: Development team, Product team
|
||||||
1. **Privacy Preservation**: User identifiers must remain private except when
|
|
||||||
explicitly shared.
|
|
||||||
|
|
||||||
2. **Platform Limitations**: Features must work within the constraints of the target
|
|
||||||
app platforms, while aiming to leverage the best platform technology available.
|
|
||||||
|
|
||||||
3. **Endorser API Limitations**: Backend features are constrained by the endorser.ch
|
|
||||||
API capabilities.
|
|
||||||
|
|
||||||
4. **Performance on Low-End Devices**: The application should remain performant
|
|
||||||
on older/simpler devices.
|
|
||||||
|
|
||||||
5. **Offline-First When Possible**: Key functionality should work offline when feasible.
|
|
||||||
|
|
||||||
## Project Technologies
|
|
||||||
|
|
||||||
- Typescript using ES6 classes using vue-facing-decorator
|
|
||||||
- TailwindCSS
|
|
||||||
- Vite Build Tool
|
|
||||||
- Playwright E2E testing
|
|
||||||
- IndexDB
|
|
||||||
- Camera, Image uploads, QR Code reader, ...
|
|
||||||
|
|
||||||
## Mobile Features
|
|
||||||
|
|
||||||
- Deep Linking
|
|
||||||
- Local Notifications via a custom Capacitor plugin
|
|
||||||
|
|
||||||
## Project Architecture
|
|
||||||
|
|
||||||
- The application must work on web browser, PWA (Progressive Web Application),
|
|
||||||
desktop via Electron, and mobile via Capacitor
|
|
||||||
- Building for each platform is managed via Vite
|
|
||||||
|
|
||||||
## Core Development Principles
|
|
||||||
|
|
||||||
### DRY development
|
|
||||||
|
|
||||||
- **Code Reuse**
|
|
||||||
- Extract common functionality into utility functions
|
|
||||||
- Create reusable components for UI patterns
|
|
||||||
- Implement service classes for shared business logic
|
|
||||||
- Use mixins for cross-cutting concerns
|
|
||||||
- Leverage TypeScript interfaces for shared type definitions
|
|
||||||
|
|
||||||
- **Component Patterns**
|
|
||||||
- Create base components for common UI elements
|
|
||||||
- Implement higher-order components for shared behavior
|
|
||||||
- Use slot patterns for flexible component composition
|
|
||||||
- Create composable services for business logic
|
|
||||||
- Implement factory patterns for component creation
|
|
||||||
|
|
||||||
- **State Management**
|
|
||||||
- Centralize state in Pinia stores
|
|
||||||
- Use computed properties for derived state
|
|
||||||
- Implement shared state selectors
|
|
||||||
- Create reusable state mutations
|
|
||||||
- Use action creators for common operations
|
|
||||||
|
|
||||||
- **Error Handling**
|
|
||||||
- Implement centralized error handling
|
|
||||||
- Create reusable error components
|
|
||||||
- Use error boundary components
|
|
||||||
- Implement consistent error logging
|
|
||||||
- Create error type definitions
|
|
||||||
|
|
||||||
- **Type Definitions**
|
|
||||||
- Create shared interfaces for common data structures
|
|
||||||
- Use type aliases for complex types
|
|
||||||
- Implement generic types for reusable components
|
|
||||||
- Create utility types for common patterns
|
|
||||||
- Use discriminated unions for state management
|
|
||||||
|
|
||||||
- **API Integration**
|
|
||||||
- Create reusable API client classes
|
|
||||||
- Implement request/response interceptors
|
|
||||||
- Use consistent error handling patterns
|
|
||||||
- Create type-safe API endpoints
|
|
||||||
- Implement caching strategies
|
|
||||||
|
|
||||||
- **Platform Services**
|
|
||||||
- Abstract platform-specific code behind interfaces
|
|
||||||
- Create platform-agnostic service layers
|
|
||||||
- Implement feature detection
|
|
||||||
- Use dependency injection for services
|
|
||||||
- Create service factories
|
|
||||||
|
|
||||||
- **Testing**
|
|
||||||
- Create reusable test utilities
|
|
||||||
- Implement test factories
|
|
||||||
- Use shared test configurations
|
|
||||||
- Create reusable test helpers
|
|
||||||
- Implement consistent test patterns
|
|
||||||
- F.I.R.S.T. (for Unit Tests)
|
|
||||||
F – Fast
|
|
||||||
I – Independent
|
|
||||||
R – Repeatable
|
|
||||||
S – Self-validating
|
|
||||||
T – Timely
|
|
||||||
|
|
||||||
### SOLID Principles
|
|
||||||
|
|
||||||
- **Single Responsibility**: Each class/component should have only one reason to
|
|
||||||
change
|
|
||||||
- Components should focus on one specific feature (e.g., QR scanning, DID management)
|
|
||||||
- Services should handle one type of functionality (e.g., platform services,
|
|
||||||
crypto services)
|
|
||||||
- Utilities should provide focused helper functions
|
|
||||||
|
|
||||||
- **Open/Closed**: Software entities should be open for extension but closed for
|
|
||||||
modification
|
|
||||||
- Use interfaces for service definitions
|
|
||||||
- Implement plugin architecture for platform-specific features
|
|
||||||
- Allow component behavior extension through props and events
|
|
||||||
|
|
||||||
- **Liskov Substitution**: Objects should be replaceable with their subtypes
|
|
||||||
- Platform services should work consistently across web/mobile
|
|
||||||
- Authentication providers should be interchangeable
|
|
||||||
- Storage implementations should be swappable
|
|
||||||
|
|
||||||
- **Interface Segregation**: Clients shouldn't depend on interfaces they don't use
|
|
||||||
- Break down large service interfaces into smaller, focused ones
|
|
||||||
- Component props should be minimal and purposeful
|
|
||||||
- Event emissions should be specific and targeted
|
|
||||||
|
|
||||||
- **Dependency Inversion**: High-level modules shouldn't depend on low-level modules
|
|
||||||
- Use dependency injection for services
|
|
||||||
- Abstract platform-specific code behind interfaces
|
|
||||||
- Implement factory patterns for component creation
|
|
||||||
|
|
||||||
### Law of Demeter
|
|
||||||
|
|
||||||
- Components should only communicate with immediate dependencies
|
|
||||||
- Avoid chaining method calls (e.g., `this.service.getUser().getProfile().getName()`)
|
|
||||||
- Use mediator patterns for complex component interactions
|
|
||||||
- Implement facade patterns for subsystem access
|
|
||||||
- Keep component communication through defined events and props
|
|
||||||
|
|
||||||
### Composition over Inheritance
|
|
||||||
|
|
||||||
- Prefer building components through composition
|
|
||||||
- Use mixins for shared functionality
|
|
||||||
- Implement feature toggles through props
|
|
||||||
- Create higher-order components for common patterns
|
|
||||||
- Use service composition for complex features
|
|
||||||
|
|
||||||
### Interface Segregation
|
|
||||||
|
|
||||||
- Define clear interfaces for services
|
|
||||||
- Keep component APIs minimal and focused
|
|
||||||
- Split large interfaces into smaller, specific ones
|
|
||||||
- Use TypeScript interfaces for type definitions
|
|
||||||
- Implement role-based interfaces for different use cases
|
|
||||||
|
|
||||||
### Fail Fast
|
|
||||||
|
|
||||||
- Validate inputs early in the process
|
|
||||||
- Use TypeScript strict mode
|
|
||||||
- Implement comprehensive error handling
|
|
||||||
- Add runtime checks for critical operations
|
|
||||||
- Use assertions for development-time validation
|
|
||||||
|
|
||||||
### Principle of Least Astonishment
|
|
||||||
|
|
||||||
- Follow Vue.js conventions consistently
|
|
||||||
- Use familiar naming patterns
|
|
||||||
- Implement predictable component behaviors
|
|
||||||
- Maintain consistent error handling
|
|
||||||
- Keep UI interactions intuitive
|
|
||||||
|
|
||||||
### Information Hiding
|
|
||||||
|
|
||||||
- Encapsulate implementation details
|
|
||||||
- Use private class members
|
|
||||||
- Implement proper access modifiers
|
|
||||||
- Hide complex logic behind simple interfaces
|
|
||||||
- Use TypeScript's access modifiers effectively
|
|
||||||
|
|
||||||
### Single Source of Truth
|
|
||||||
|
|
||||||
- Use Pinia for state management
|
|
||||||
- Maintain one source for user data
|
|
||||||
- Centralize configuration management
|
|
||||||
- Use computed properties for derived state
|
|
||||||
- Implement proper state synchronization
|
|
||||||
|
|
||||||
### Principle of Least Privilege
|
|
||||||
|
|
||||||
- Implement proper access control
|
|
||||||
- Use minimal required permissions
|
|
||||||
- Follow privacy-by-design principles
|
|
||||||
- Restrict component access to necessary data
|
|
||||||
- Implement proper authentication/authorization
|
|
||||||
|
|||||||
75
.cursor/rules/architecture/README.md
Normal file
75
.cursor/rules/architecture/README.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# Architecture Rules Directory
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-20
|
||||||
|
**Status**: 🎯 **ACTIVE** - Architecture protection guidelines
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This directory contains MDC (Model Directive Configuration) rules that protect
|
||||||
|
critical architectural components of the TimeSafari project. These rules ensure
|
||||||
|
that changes to system architecture follow proper review, testing, and
|
||||||
|
documentation procedures.
|
||||||
|
|
||||||
|
## Available Rules
|
||||||
|
|
||||||
|
### Build Architecture Guard (`build_architecture_guard.mdc`)
|
||||||
|
|
||||||
|
Protects the multi-platform build system including:
|
||||||
|
|
||||||
|
- Vite configuration files
|
||||||
|
- Build scripts and automation
|
||||||
|
- Platform-specific configurations (iOS, Android, Electron, Web)
|
||||||
|
- Docker and deployment infrastructure
|
||||||
|
- CI/CD pipeline components
|
||||||
|
|
||||||
|
**When to use**: Any time you're modifying build scripts, configuration files,
|
||||||
|
or deployment processes.
|
||||||
|
|
||||||
|
**Authorization levels**:
|
||||||
|
|
||||||
|
- **Level 1**: Minor changes (review required)
|
||||||
|
- **Level 2**: Moderate changes (testing required)
|
||||||
|
- **Level 3**: Major changes (ADR required)
|
||||||
|
|
||||||
|
## Usage Guidelines
|
||||||
|
|
||||||
|
### For Developers
|
||||||
|
|
||||||
|
1. **Check the rule**: Before making architectural changes, review the relevant
|
||||||
|
rule
|
||||||
|
2. **Follow the process**: Use the appropriate authorization level
|
||||||
|
3. **Complete validation**: Run through the required checklist
|
||||||
|
4. **Update documentation**: Keep BUILDING.md and related docs current
|
||||||
|
|
||||||
|
### For Reviewers
|
||||||
|
|
||||||
|
1. **Verify authorization**: Ensure changes match the required level
|
||||||
|
2. **Check testing**: Confirm appropriate testing has been completed
|
||||||
|
3. **Validate documentation**: Ensure BUILDING.md reflects changes
|
||||||
|
4. **Assess risk**: Consider impact on other platforms and systems
|
||||||
|
|
||||||
|
## Integration with Other Rules
|
||||||
|
|
||||||
|
- **Version Control**: Works with `workflow/version_control.mdc`
|
||||||
|
- **Research & Diagnostic**: Supports `research_diagnostic.mdc` for
|
||||||
|
investigations
|
||||||
|
- **Software Development**: Aligns with development best practices
|
||||||
|
- **Markdown Automation**: Integrates with `docs/markdown-automation.mdc` for
|
||||||
|
consistent documentation formatting
|
||||||
|
|
||||||
|
## Emergency Procedures
|
||||||
|
|
||||||
|
If architectural changes cause system failures:
|
||||||
|
|
||||||
|
1. **Immediate rollback** to last known working state
|
||||||
|
2. **Document the failure** with full error details
|
||||||
|
3. **Investigate root cause** using diagnostic workflows
|
||||||
|
4. **Update procedures** to prevent future failures
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active architecture protection
|
||||||
|
**Priority**: Critical
|
||||||
|
**Maintainer**: Development team
|
||||||
|
**Next Review**: 2025-09-20
|
||||||
295
.cursor/rules/architecture/build_architecture_guard.mdc
Normal file
295
.cursor/rules/architecture/build_architecture_guard.mdc
Normal file
@@ -0,0 +1,295 @@
|
|||||||
|
---
|
||||||
|
description: Guards against unauthorized changes to the TimeSafari building
|
||||||
|
architecture
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
|
||||||
|
# Build Architecture Guard Directive
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-20
|
||||||
|
**Status**: 🎯 **ACTIVE** - Build system protection guidelines
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Protect the TimeSafari building architecture from unauthorized changes that
|
||||||
|
could break the multi-platform build pipeline, deployment processes, or
|
||||||
|
development workflow. This directive ensures all build system modifications
|
||||||
|
follow proper review, testing, and documentation procedures.
|
||||||
|
|
||||||
|
## Protected Architecture Components
|
||||||
|
|
||||||
|
### Core Build Infrastructure
|
||||||
|
|
||||||
|
- **Vite Configuration Files**: `vite.config.*.mts` files
|
||||||
|
- **Build Scripts**: All scripts in `scripts/` directory
|
||||||
|
- **Package Scripts**: `package.json` build-related scripts
|
||||||
|
- **Platform Configs**: `capacitor.config.ts`, `electron/`, `android/`,
|
||||||
|
`ios/`
|
||||||
|
- **Docker Configuration**: `Dockerfile`, `docker-compose.yml`
|
||||||
|
- **Environment Files**: `.env.*`, `.nvmrc`, `.node-version`
|
||||||
|
|
||||||
|
### Critical Build Dependencies
|
||||||
|
|
||||||
|
- **Build Tools**: Vite, Capacitor, Electron, Android SDK, Xcode
|
||||||
|
- **Asset Management**: `capacitor-assets.config.json`, asset scripts
|
||||||
|
- **Testing Infrastructure**: Playwright, Jest, mobile test scripts
|
||||||
|
- **CI/CD Pipeline**: GitHub Actions, build validation scripts
|
||||||
|
- **Service Worker Assembly**: `sw_scripts/`, `sw_combine.js`, WASM copy steps
|
||||||
|
|
||||||
|
## Change Authorization Requirements
|
||||||
|
|
||||||
|
### Level 1: Minor Changes (Requires Review)
|
||||||
|
|
||||||
|
- Documentation updates to `BUILDING.md`
|
||||||
|
- Non-breaking script improvements
|
||||||
|
- Test additions or improvements
|
||||||
|
- Asset configuration updates
|
||||||
|
|
||||||
|
**Process**: Code review + basic testing
|
||||||
|
|
||||||
|
### Level 2: Moderate Changes (Requires Testing)
|
||||||
|
|
||||||
|
- New build script additions
|
||||||
|
- Environment variable changes
|
||||||
|
- Dependency version updates
|
||||||
|
- Platform-specific optimizations
|
||||||
|
|
||||||
|
**Process**: Code review + platform testing + documentation update
|
||||||
|
|
||||||
|
### Level 3: Major Changes (Requires ADR)
|
||||||
|
|
||||||
|
- Build system architecture changes
|
||||||
|
- New platform support
|
||||||
|
- Breaking changes to build scripts
|
||||||
|
- Major dependency migrations
|
||||||
|
|
||||||
|
**Process**: ADR creation + comprehensive testing + team review
|
||||||
|
|
||||||
|
## Prohibited Actions
|
||||||
|
|
||||||
|
### ❌ Never Allow Without ADR
|
||||||
|
|
||||||
|
- **Delete or rename** core build scripts
|
||||||
|
- **Modify** `package.json` build script names
|
||||||
|
- **Change** Vite configuration structure
|
||||||
|
- **Remove** platform-specific build targets
|
||||||
|
- **Alter** Docker build process
|
||||||
|
- **Modify** CI/CD pipeline without testing
|
||||||
|
|
||||||
|
### ❌ Never Allow Without Testing
|
||||||
|
|
||||||
|
- **Update** build dependencies
|
||||||
|
- **Change** environment configurations
|
||||||
|
- **Modify** asset generation scripts
|
||||||
|
- **Alter** test infrastructure
|
||||||
|
- **Update** platform SDK versions
|
||||||
|
|
||||||
|
## Required Validation Checklist
|
||||||
|
|
||||||
|
### Before Any Build System Change
|
||||||
|
|
||||||
|
- [ ] **Impact Assessment**: Which platforms are affected?
|
||||||
|
- [ ] **Testing Plan**: How will this be tested across platforms?
|
||||||
|
- [ ] **Rollback Plan**: How can this be reverted if it breaks?
|
||||||
|
- [ ] **Documentation**: Will `BUILDING.md` need updates?
|
||||||
|
- [ ] **Dependencies**: Are all required tools available?
|
||||||
|
|
||||||
|
### After Build System Change
|
||||||
|
|
||||||
|
- [ ] **Web Platform**: Does `npm run build:web:dev` work?
|
||||||
|
- [ ] **Mobile Platforms**: Do iOS/Android builds succeed?
|
||||||
|
- [ ] **Desktop Platform**: Does Electron build and run?
|
||||||
|
- [ ] **Tests Pass**: Do all build-related tests pass?
|
||||||
|
- [ ] **Documentation Updated**: Is `BUILDING.md` current?
|
||||||
|
|
||||||
|
## Specific Test Commands (Minimum Required)
|
||||||
|
|
||||||
|
### Web Platform
|
||||||
|
|
||||||
|
- **Development**: `npm run build:web:dev` - serve and load app
|
||||||
|
- **Production**: `npm run build:web:prod` - verify SW and WASM present
|
||||||
|
|
||||||
|
### Mobile Platforms
|
||||||
|
|
||||||
|
- **Android**: `npm run build:android:test` or `:prod` - confirm assets copied
|
||||||
|
- **iOS**: `npm run build:ios:test` or `:prod` - verify build succeeds
|
||||||
|
|
||||||
|
### Desktop Platform
|
||||||
|
|
||||||
|
- **Electron**: `npm run build:electron:dev` and packaging for target OS
|
||||||
|
- **Verify**: Single-instance behavior and app boot
|
||||||
|
|
||||||
|
### Auto-run (if affected)
|
||||||
|
|
||||||
|
- **Test Mode**: `npm run auto-run:test` and platform variants
|
||||||
|
- **Production Mode**: `npm run auto-run:prod` and platform variants
|
||||||
|
|
||||||
|
### Clean and Rebuild
|
||||||
|
|
||||||
|
- Run relevant `clean:*` scripts and ensure re-build works
|
||||||
|
|
||||||
|
## Emergency Procedures
|
||||||
|
|
||||||
|
### Build System Broken
|
||||||
|
|
||||||
|
1. **Immediate**: Revert to last known working commit
|
||||||
|
2. **Investigation**: Create issue with full error details
|
||||||
|
3. **Testing**: Verify all platforms work after revert
|
||||||
|
4. **Documentation**: Update `BUILDING.md` with failure notes
|
||||||
|
|
||||||
|
### Platform-Specific Failure
|
||||||
|
|
||||||
|
1. **Isolate**: Identify which platform is affected
|
||||||
|
2. **Test Others**: Verify other platforms still work
|
||||||
|
3. **Rollback**: Revert platform-specific changes
|
||||||
|
4. **Investigation**: Debug in isolated environment
|
||||||
|
|
||||||
|
## Integration Points
|
||||||
|
|
||||||
|
### With Version Control
|
||||||
|
|
||||||
|
- **Branch Protection**: Require reviews for build script changes
|
||||||
|
- **Commit Messages**: Must reference ADR for major changes
|
||||||
|
- **Testing**: All build changes must pass CI/CD pipeline
|
||||||
|
|
||||||
|
### With Documentation
|
||||||
|
|
||||||
|
- **BUILDING.md**: Must be updated for any script changes
|
||||||
|
- **README.md**: Must reflect new build requirements
|
||||||
|
- **CHANGELOG.md**: Must document breaking build changes
|
||||||
|
|
||||||
|
### With Testing
|
||||||
|
|
||||||
|
- **Pre-commit**: Run basic build validation
|
||||||
|
- **CI/CD**: Full platform build testing
|
||||||
|
- **Manual Testing**: Human verification of critical paths
|
||||||
|
|
||||||
|
## Risk Matrix & Required Validation
|
||||||
|
|
||||||
|
### Environment Handling
|
||||||
|
|
||||||
|
- **Trigger**: Change to `.env.*` loading / variable names
|
||||||
|
- **Validation**: Prove `dev/test/prod` builds; show environment echo in logs
|
||||||
|
|
||||||
|
### Script Flow
|
||||||
|
|
||||||
|
- **Trigger**: Reorder steps (prebuild → build → package), new flags
|
||||||
|
- **Validation**: Dry-run + normal run, show exit codes & timing
|
||||||
|
|
||||||
|
### Platform Packaging
|
||||||
|
|
||||||
|
- **Trigger**: Electron NSIS/DMG/AppImage, Android/iOS bundle
|
||||||
|
- **Validation**: Produce installer/artifact and open it; verify single-instance,
|
||||||
|
icons, signing
|
||||||
|
|
||||||
|
### Service Worker / WASM
|
||||||
|
|
||||||
|
- **Trigger**: `sw_combine.js`, WASM copy path
|
||||||
|
- **Validation**: Verify combined SW exists and is injected; page loads offline;
|
||||||
|
WASM present
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
- **Trigger**: New base image, build args
|
||||||
|
- **Validation**: Build image locally; run container; list produced `/dist`
|
||||||
|
|
||||||
|
### Signing/Notarization
|
||||||
|
|
||||||
|
- **Trigger**: Cert path/profiles
|
||||||
|
- **Validation**: Show signing logs + verify on target OS
|
||||||
|
|
||||||
|
## PR Template (Paste into Description)
|
||||||
|
|
||||||
|
- [ ] **Level**: L1 / L2 / L3 + justification
|
||||||
|
- [ ] **Files & platforms touched**:
|
||||||
|
- [ ] **Risk triggers & mitigations**:
|
||||||
|
- [ ] **Commands run (paste logs)**:
|
||||||
|
- [ ] **Artifacts (names + sha256)**:
|
||||||
|
- [ ] **Docs updated (sections/links)**:
|
||||||
|
- [ ] **Rollback steps verified**:
|
||||||
|
- [ ] **CI**: Jobs passing and artifacts uploaded
|
||||||
|
|
||||||
|
## Rollback Playbook
|
||||||
|
|
||||||
|
### Immediate Rollback
|
||||||
|
|
||||||
|
1. `git revert` or `git reset --hard <prev>`; restore prior `scripts/` or config
|
||||||
|
files
|
||||||
|
2. Rebuild affected targets; verify old behavior returns
|
||||||
|
3. Post-mortem notes → update this guard and `BUILDING.md` if gaps found
|
||||||
|
|
||||||
|
### Rollback Verification
|
||||||
|
|
||||||
|
- **Web**: `npm run build:web:dev` and `npm run build:web:prod`
|
||||||
|
- **Mobile**: `npm run build:android:test` and `npm run build:ios:test`
|
||||||
|
- **Desktop**: `npm run build:electron:dev` and packaging commands
|
||||||
|
- **Clean**: Run relevant `clean:*` scripts and verify re-build works
|
||||||
|
|
||||||
|
## ADR Trigger List
|
||||||
|
|
||||||
|
Raise an ADR when you propose any of:
|
||||||
|
|
||||||
|
- **New build stage** or reorder of canonical stages
|
||||||
|
- **Replacement of packager** / packaging format
|
||||||
|
- **New environment model** or secure secret handling scheme
|
||||||
|
- **New service worker assembly** strategy or cache policy
|
||||||
|
- **New Docker base** or multi-stage pipeline
|
||||||
|
- **Relocation of build outputs** or directory conventions
|
||||||
|
|
||||||
|
**ADR must include**: motivation, alternatives, risks, validation plan, rollback,
|
||||||
|
doc diffs.
|
||||||
|
|
||||||
|
## Competence Hooks
|
||||||
|
|
||||||
|
### Why This Works
|
||||||
|
|
||||||
|
- **Prevents Build Failures**: Catches issues before they reach production
|
||||||
|
- **Maintains Consistency**: Ensures all platforms build identically
|
||||||
|
- **Reduces Debugging Time**: Prevents build system regressions
|
||||||
|
|
||||||
|
### Common Pitfalls
|
||||||
|
|
||||||
|
- **Silent Failures**: Changes that work on one platform but break others
|
||||||
|
- **Dependency Conflicts**: Updates that create version incompatibilities
|
||||||
|
- **Documentation Drift**: Build scripts that don't match documentation
|
||||||
|
|
||||||
|
### Next Skill Unlock
|
||||||
|
|
||||||
|
- Learn to test build changes across all platforms simultaneously
|
||||||
|
|
||||||
|
### Teach-back
|
||||||
|
|
||||||
|
- "What three platforms must I test before committing a build script change?"
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
|
||||||
|
### Team Review Requirements
|
||||||
|
|
||||||
|
- **Platform Owners**: iOS, Android, Electron, Web specialists
|
||||||
|
- **DevOps**: CI/CD pipeline maintainers
|
||||||
|
- **QA**: Testing infrastructure owners
|
||||||
|
|
||||||
|
### Discussion Prompts
|
||||||
|
|
||||||
|
- "Which platforms will be affected by this build change?"
|
||||||
|
- "How can we test this change without breaking existing builds?"
|
||||||
|
- "What's our rollback plan if this change fails?"
|
||||||
|
|
||||||
|
## Self-Check (Before Allowing Changes)
|
||||||
|
|
||||||
|
- [ ] **Authorization Level**: Is this change appropriate for the level?
|
||||||
|
- [ ] **Testing Plan**: Is there a comprehensive testing strategy?
|
||||||
|
- [ ] **Documentation**: Will BUILDING.md be updated?
|
||||||
|
- [ ] **Rollback**: Is there a safe rollback mechanism?
|
||||||
|
- [ ] **Team Review**: Have appropriate stakeholders been consulted?
|
||||||
|
- [ ] **CI/CD**: Will this pass the build pipeline?
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active build system protection
|
||||||
|
**Priority**: Critical
|
||||||
|
**Estimated Effort**: Ongoing vigilance
|
||||||
|
**Dependencies**: All build system components
|
||||||
|
**Stakeholders**: Development team, DevOps, Platform owners
|
||||||
|
**Next Review**: 2025-09-20
|
||||||
@@ -1,32 +1,61 @@
|
|||||||
---
|
---
|
||||||
alwaysApply: true
|
description: when doing anything with capacitor assets
|
||||||
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Asset Configuration Directive
|
# Asset Configuration Directive
|
||||||
*Scope: Assets Only (icons, splashes, image pipelines) — not overall build orchestration*
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Asset management guidelines
|
||||||
|
|
||||||
|
*Scope: Assets Only (icons, splashes, image pipelines) — not overall build
|
||||||
|
orchestration*
|
||||||
|
|
||||||
## Intent
|
## Intent
|
||||||
|
|
||||||
- Version **asset configuration files** (optionally dev-time generated).
|
- Version **asset configuration files** (optionally dev-time generated).
|
||||||
- **Do not** version platform asset outputs (Android/iOS/Electron); generate them **at build-time** with standard tools.
|
- **Do not** version platform asset outputs (Android/iOS/Electron); generate
|
||||||
|
them **at build-time** with standard tools.
|
||||||
- Keep existing per-platform build scripts unchanged.
|
- Keep existing per-platform build scripts unchanged.
|
||||||
|
|
||||||
## Source of Truth
|
## Source of Truth
|
||||||
|
|
||||||
- **Preferred (Capacitor default):** `resources/` as the single master source.
|
- **Preferred (Capacitor default):** `resources/` as the single master source.
|
||||||
- **Alternative:** `assets/` is acceptable **only** if `capacitor-assets` is explicitly configured to read from it.
|
- **Alternative:** `assets/` is acceptable **only** if `capacitor-assets` is
|
||||||
- **Never** maintain both `resources/` and `assets/` as parallel sources. Migrate and delete the redundant folder.
|
explicitly configured to read from it.
|
||||||
|
- **Never** maintain both `resources/` and `assets/` as parallel sources.
|
||||||
|
Migrate and delete the redundant folder.
|
||||||
|
|
||||||
## Config Files
|
## Config Files
|
||||||
|
|
||||||
- Live under: `config/assets/` (committed).
|
- Live under: `config/assets/` (committed).
|
||||||
- Examples:
|
- Examples:
|
||||||
- `config/assets/capacitor-assets.config.json` (or the path the tool expects)
|
- `config/assets/capacitor-assets.config.json` (or the path the tool
|
||||||
|
expects)
|
||||||
- `config/assets/android.assets.json`
|
- `config/assets/android.assets.json`
|
||||||
- `config/assets/ios.assets.json`
|
- `config/assets/ios.assets.json`
|
||||||
- `config/assets/common.assets.yaml` (optional shared layer)
|
- `config/assets/common.assets.yaml` (optional shared layer)
|
||||||
- **Dev-time generation allowed** for these configs; **build-time generation is forbidden**.
|
- **Dev-time generation allowed** for these configs; **build-time
|
||||||
|
generation is forbidden**.
|
||||||
|
|
||||||
## Build-Time Behavior
|
## Build-Time Behavior
|
||||||
|
|
||||||
- Build generates platform assets (not configs) using the standard chain:
|
- Build generates platform assets (not configs) using the standard chain:
|
||||||
```bash
|
|
||||||
npm run build:capacitor # web build via Vite (.mts)
|
```bash
|
||||||
npx cap sync
|
npm run build:capacitor # web build via Vite (.mts)
|
||||||
|
npx cap sync
|
||||||
|
npx capacitor-assets generate # produces platform assets; not committed
|
||||||
|
# then platform-specific build steps
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active asset management directive
|
||||||
|
**Priority**: Medium
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: capacitor-assets toolchain
|
||||||
|
**Stakeholders**: Development team, Build team
|
||||||
|
|
||||||
npx capacitor-assets generate # produces platform assets; not committed
|
npx capacitor-assets generate # produces platform assets; not committed
|
||||||
# then platform-specific build steps
|
# then platform-specific build steps
|
||||||
|
|||||||
@@ -1,3 +1,6 @@
|
|||||||
|
---
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"coaching_level": "standard",
|
"coaching_level": "standard",
|
||||||
@@ -10,7 +13,12 @@
|
|||||||
|
|
||||||
# Base Context — Human Competence First
|
# Base Context — Human Competence First
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Core interaction guidelines
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
All interactions must *increase the human's competence over time* while
|
All interactions must *increase the human's competence over time* while
|
||||||
completing the task efficiently. The model may handle menial work and memory
|
completing the task efficiently. The model may handle menial work and memory
|
||||||
extension, but must also promote learning, autonomy, and healthy work habits.
|
extension, but must also promote learning, autonomy, and healthy work habits.
|
||||||
@@ -21,57 +29,79 @@ machine-driven steps.
|
|||||||
|
|
||||||
## Principles
|
## Principles
|
||||||
|
|
||||||
1) Competence over convenience: finish the task *and* leave the human more
|
1. Competence over convenience: finish the task *and* leave the human more
|
||||||
capable next time.
|
capable next time.
|
||||||
2) Mentorship, not lectures: be concise, concrete, and immediately applicable.
|
2. Mentorship, not lectures: be concise, concrete, and immediately applicable.
|
||||||
3) Transparency: show assumptions, limits, and uncertainty; cite when non-obvious.
|
3. Transparency: show assumptions, limits, and uncertainty; cite when
|
||||||
4) Optional scaffolding: include small, skimmable learning hooks that do not
|
non-obvious.
|
||||||
|
4. Optional scaffolding: include small, skimmable learning hooks that do not
|
||||||
bloat output.
|
bloat output.
|
||||||
5) Time respect: default to **lean output**; offer opt-in depth via toggles.
|
5. Time respect: default to **lean output**; offer opt-in depth via toggles.
|
||||||
6) Psychological safety: encourage, never condescend; no medical/clinical advice.
|
6. Psychological safety: encourage, never condescend; no medical/clinical
|
||||||
No censorship!
|
advice. No censorship!
|
||||||
7) Reusability: structure outputs so they can be saved, searched, reused, and repurposed.
|
7. Reusability: structure outputs so they can be saved, searched, reused, and
|
||||||
8) **Collaborative Bias**: Favor solutions that invite human review, discussion,
|
repurposed.
|
||||||
and iteration. When in doubt, ask "Who should this be shown to?" or "Which human
|
8. **Collaborative Bias**: Favor solutions that invite human review,
|
||||||
input would improve this?"
|
discussion, and iteration. When in doubt, ask "Who should this be shown
|
||||||
|
to?" or "Which human input would improve this?"
|
||||||
|
|
||||||
## Toggle Definitions
|
## Toggle Definitions
|
||||||
|
|
||||||
### coaching_level
|
### coaching_level
|
||||||
|
|
||||||
Determines the depth of learning support: `light` (short hooks), `standard`
|
Determines the depth of learning support: `light` (short hooks),
|
||||||
(balanced), `deep` (detailed).
|
`standard` (balanced), `deep` (detailed).
|
||||||
|
|
||||||
### socratic_max_questions
|
### socratic_max_questions
|
||||||
|
|
||||||
The number of clarifying questions the model may ask before proceeding.
|
The number of clarifying questions the model may ask before proceeding.
|
||||||
If >0, questions should be targeted, minimal, and followed by reasonable assumptions if unanswered.
|
If >0, questions should be targeted, minimal, and followed by reasonable
|
||||||
|
assumptions if unanswered.
|
||||||
|
|
||||||
### verbosity
|
### verbosity
|
||||||
'terse' (just a sentence), `concise` (minimum commentary), `normal` (balanced explanation), or other project-defined levels.
|
|
||||||
|
'terse' (just a sentence), `concise` (minimum commentary), `normal`
|
||||||
|
(balanced explanation), or other project-defined levels.
|
||||||
|
|
||||||
### timebox_minutes
|
### timebox_minutes
|
||||||
*integer or null* — When set to a positive integer (e.g., `5`), this acts as a **time budget** guiding the model to prioritize delivering the most essential parts of the task within that constraint.
|
|
||||||
|
*integer or null* — When set to a positive integer (e.g., `5`), this acts
|
||||||
|
as a **time budget** guiding the model to prioritize delivering the most
|
||||||
|
essential parts of the task within that constraint.
|
||||||
|
|
||||||
Behavior when set:
|
Behavior when set:
|
||||||
1. **Prioritize Core Output** — Deliver the minimum viable solution or result first.
|
|
||||||
2. **Limit Commentary** — Competence Hooks and Collaboration Hooks must be shorter than normal.
|
1. **Prioritize Core Output** — Deliver the minimum viable solution or
|
||||||
3. **Signal Skipped Depth** — Omitted details should be listed under *Deferred for depth*.
|
result first.
|
||||||
4. **Order by Value** — Start with blocking or high-value items, then proceed to nice-to-haves if budget allows.
|
2. **Limit Commentary** — Competence Hooks and Collaboration Hooks must be
|
||||||
If `null`, there is no timebox — the model can produce full-depth responses.
|
shorter than normal.
|
||||||
|
3. **Signal Skipped Depth** — Omitted details should be listed under
|
||||||
|
*Deferred for depth*.
|
||||||
|
4. **Order by Value** — Start with blocking or high-value items, then
|
||||||
|
proceed to nice-to-haves if budget allows.
|
||||||
|
|
||||||
|
If `null`, there is no timebox — the model can produce full-depth
|
||||||
|
responses.
|
||||||
|
|
||||||
### format_enforcement
|
### format_enforcement
|
||||||
`strict` (reject outputs with format drift) or `relaxed` (minor deviations acceptable).
|
|
||||||
|
`strict` (reject outputs with format drift) or `relaxed` (minor deviations
|
||||||
|
acceptable).
|
||||||
|
|
||||||
## Modes (select or combine)
|
## Modes (select or combine)
|
||||||
|
|
||||||
- **Doer**: produce the artifact fast, minimal commentary.
|
- **Doer**: produce the artifact fast, minimal commentary.
|
||||||
- **Mentor**: add short "why/how" notes + next-step pointers.
|
- **Mentor**: add short "why/how" notes + next-step pointers.
|
||||||
- **Socratic**: ask up to N targeted questions when requirements are ambiguous.
|
- **Socratic**: ask up to N targeted questions when requirements are
|
||||||
|
ambiguous.
|
||||||
- **Pair-Programmer/Pair-Writer**: explain tradeoffs as you implement.
|
- **Pair-Programmer/Pair-Writer**: explain tradeoffs as you implement.
|
||||||
- **Facilitator**: structure output to be reviewable, commentable, and ready for group discussion.
|
- **Facilitator**: structure output to be reviewable, commentable, and
|
||||||
|
ready for group discussion.
|
||||||
|
|
||||||
Default: Doer + short Mentor notes.
|
Default: Doer + short Mentor notes.
|
||||||
|
|
||||||
## Competence & Collaboration Levers (keep lightweight)
|
## Competence & Collaboration Levers (keep lightweight)
|
||||||
|
|
||||||
- "Why this works" (≤3 bullets)
|
- "Why this works" (≤3 bullets)
|
||||||
- "Common pitfalls" (≤3 bullets)
|
- "Common pitfalls" (≤3 bullets)
|
||||||
- "Next skill unlock" (1 tiny action or reading)
|
- "Next skill unlock" (1 tiny action or reading)
|
||||||
@@ -79,6 +109,7 @@ Default: Doer + short Mentor notes.
|
|||||||
- "Discussion prompts" (≤2 short questions for peers/stakeholders)
|
- "Discussion prompts" (≤2 short questions for peers/stakeholders)
|
||||||
|
|
||||||
## Output Contract (apply to every deliverable)
|
## Output Contract (apply to every deliverable)
|
||||||
|
|
||||||
- Clear **Objective** (1 line)
|
- Clear **Objective** (1 line)
|
||||||
- **Result** (artifact/code/answer)
|
- **Result** (artifact/code/answer)
|
||||||
- **Use/Run** (how to apply/test)
|
- **Use/Run** (how to apply/test)
|
||||||
@@ -88,8 +119,10 @@ Default: Doer + short Mentor notes.
|
|||||||
- **References** (if used; links or titles)
|
- **References** (if used; links or titles)
|
||||||
|
|
||||||
## Do-Not
|
## Do-Not
|
||||||
|
|
||||||
- No filler, hedging, or moralizing.
|
- No filler, hedging, or moralizing.
|
||||||
- No medical/mental-health advice; keep "healthy habits" to general work practices.
|
- No medical/mental-health advice; keep "healthy habits" to general work
|
||||||
|
practices.
|
||||||
- No invented facts; mark uncertainty plainly.
|
- No invented facts; mark uncertainty plainly.
|
||||||
- No censorship.
|
- No censorship.
|
||||||
- Avoid outputs that bypass human review when such review is valuable.
|
- Avoid outputs that bypass human review when such review is valuable.
|
||||||
@@ -100,11 +133,22 @@ Default: Doer + short Mentor notes.
|
|||||||
- **research_diagnostic.mdc**: For investigation and research workflows
|
- **research_diagnostic.mdc**: For investigation and research workflows
|
||||||
|
|
||||||
## Self-Check (model, before responding)
|
## Self-Check (model, before responding)
|
||||||
- [ ] Task done *and* at least one competence lever included (≤120 words total).
|
|
||||||
|
- [ ] Task done *and* at least one competence lever included (≤120 words
|
||||||
|
total).
|
||||||
- [ ] At least one collaboration/discussion hook present.
|
- [ ] At least one collaboration/discussion hook present.
|
||||||
- [ ] Output follows the **Output Contract** sections.
|
- [ ] Output follows the **Output Contract** sections.
|
||||||
- [ ] Toggles respected; verbosity remains concise.
|
- [ ] Toggles respected; verbosity remains concise.
|
||||||
- [ ] Uncertainties/assumptions surfaced.
|
- [ ] Uncertainties/assumptions surfaced.
|
||||||
- [ ] No disallowed content.
|
- [ ] No disallowed content.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active core guidelines
|
||||||
|
**Priority**: Critical
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: None (base ruleset)
|
||||||
|
**Stakeholders**: All AI interactions
|
||||||
|
|
||||||
- [ ] Uncertainties/assumptions surfaced.
|
- [ ] Uncertainties/assumptions surfaced.
|
||||||
- [ ] No disallowed content.
|
- [ ] No disallowed content.
|
||||||
|
|||||||
@@ -1,13 +1,23 @@
|
|||||||
---
|
---
|
||||||
globs: **/db/databaseUtil.ts, **/interfaces/absurd-sql.d.ts, **/src/registerSQLWorker.js, **/services/AbsurdSqlDatabaseService.ts
|
globs: **/db/databaseUtil.ts, **/interfaces/absurd-sql.d.ts, **/src/registerSQLWorker.js, **/
|
||||||
|
services/AbsurdSqlDatabaseService.ts
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Absurd SQL - Cursor Development Guide
|
# Absurd SQL - Cursor Development Guide
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Database development guidelines
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
Absurd SQL is a backend implementation for sql.js that enables persistent SQLite databases in the browser by using IndexedDB as a block storage system. This guide provides rules and best practices for developing with this project in Cursor.
|
|
||||||
|
Absurd SQL is a backend implementation for sql.js that enables persistent
|
||||||
|
SQLite databases in the browser by using IndexedDB as a block storage system.
|
||||||
|
This guide provides rules and best practices for developing with this project
|
||||||
|
in Cursor.
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
absurd-sql/
|
absurd-sql/
|
||||||
├── src/ # Source code
|
├── src/ # Source code
|
||||||
@@ -20,36 +30,45 @@ absurd-sql/
|
|||||||
## Development Rules
|
## Development Rules
|
||||||
|
|
||||||
### 1. Worker Thread Requirements
|
### 1. Worker Thread Requirements
|
||||||
|
|
||||||
- All SQL operations MUST be performed in a worker thread
|
- All SQL operations MUST be performed in a worker thread
|
||||||
- Main thread should only handle worker initialization and communication
|
- Main thread should only handle worker initialization and communication
|
||||||
- Never block the main thread with database operations
|
- Never block the main thread with database operations
|
||||||
|
|
||||||
### 2. Code Organization
|
### 2. Code Organization
|
||||||
|
|
||||||
- Keep worker code in separate files (e.g., `*.worker.js`)
|
- Keep worker code in separate files (e.g., `*.worker.js`)
|
||||||
- Use ES modules for imports/exports
|
- Use ES modules for imports/exports
|
||||||
- Follow the project's existing module structure
|
- Follow the project's existing module structure
|
||||||
|
|
||||||
### 3. Required Headers
|
### 3. Required Headers
|
||||||
|
|
||||||
When developing locally or deploying, ensure these headers are set:
|
When developing locally or deploying, ensure these headers are set:
|
||||||
|
|
||||||
```
|
```
|
||||||
Cross-Origin-Opener-Policy: same-origin
|
Cross-Origin-Opener-Policy: same-origin
|
||||||
Cross-Origin-Embedder-Policy: require-corp
|
Cross-Origin-Embedder-Policy: require-corp
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Browser Compatibility
|
### 4. Browser Compatibility
|
||||||
|
|
||||||
- Primary target: Modern browsers with SharedArrayBuffer support
|
- Primary target: Modern browsers with SharedArrayBuffer support
|
||||||
- Fallback mode: Safari (with limitations)
|
- Fallback mode: Safari (with limitations)
|
||||||
- Always test in both modes
|
- Always test in both modes
|
||||||
|
|
||||||
### 5. Database Configuration
|
### 5. Database Configuration
|
||||||
|
|
||||||
Recommended database settings:
|
Recommended database settings:
|
||||||
|
|
||||||
```sql
|
```sql
|
||||||
PRAGMA journal_mode=MEMORY;
|
PRAGMA journal_mode=MEMORY;
|
||||||
PRAGMA page_size=8192; -- Optional, but recommended
|
PRAGMA page_size=8192; -- Optional, but recommended
|
||||||
```
|
```
|
||||||
|
|
||||||
### 6. Development Workflow
|
### 6. Development Workflow
|
||||||
|
|
||||||
1. Install dependencies:
|
1. Install dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn add @jlongster/sql.js absurd-sql
|
yarn add @jlongster/sql.js absurd-sql
|
||||||
```
|
```
|
||||||
@@ -60,17 +79,20 @@ PRAGMA page_size=8192; -- Optional, but recommended
|
|||||||
- `yarn serve` - Start development server
|
- `yarn serve` - Start development server
|
||||||
|
|
||||||
### 7. Testing Guidelines
|
### 7. Testing Guidelines
|
||||||
|
|
||||||
- Write tests for both SharedArrayBuffer and fallback modes
|
- Write tests for both SharedArrayBuffer and fallback modes
|
||||||
- Use Jest for testing
|
- Use Jest for testing
|
||||||
- Include performance benchmarks for critical operations
|
- Include performance benchmarks for critical operations
|
||||||
|
|
||||||
### 8. Performance Considerations
|
### 8. Performance Considerations
|
||||||
|
|
||||||
- Use bulk operations when possible
|
- Use bulk operations when possible
|
||||||
- Monitor read/write performance
|
- Monitor read/write performance
|
||||||
- Consider using transactions for multiple operations
|
- Consider using transactions for multiple operations
|
||||||
- Avoid unnecessary database connections
|
- Avoid unnecessary database connections
|
||||||
|
|
||||||
### 9. Error Handling
|
### 9. Error Handling
|
||||||
|
|
||||||
- Implement proper error handling for:
|
- Implement proper error handling for:
|
||||||
- Worker initialization failures
|
- Worker initialization failures
|
||||||
- Database connection issues
|
- Database connection issues
|
||||||
@@ -78,18 +100,21 @@ PRAGMA page_size=8192; -- Optional, but recommended
|
|||||||
- Storage quota exceeded scenarios
|
- Storage quota exceeded scenarios
|
||||||
|
|
||||||
### 10. Security Best Practices
|
### 10. Security Best Practices
|
||||||
|
|
||||||
- Never expose database operations directly to the client
|
- Never expose database operations directly to the client
|
||||||
- Validate all SQL queries
|
- Validate all SQL queries
|
||||||
- Implement proper access controls
|
- Implement proper access controls
|
||||||
- Handle sensitive data appropriately
|
- Handle sensitive data appropriately
|
||||||
|
|
||||||
### 11. Code Style
|
### 11. Code Style
|
||||||
|
|
||||||
- Follow ESLint configuration
|
- Follow ESLint configuration
|
||||||
- Use async/await for asynchronous operations
|
- Use async/await for asynchronous operations
|
||||||
- Document complex database operations
|
- Document complex database operations
|
||||||
- Include comments for non-obvious optimizations
|
- Include comments for non-obvious optimizations
|
||||||
|
|
||||||
### 12. Debugging
|
### 12. Debugging
|
||||||
|
|
||||||
- Use `jest-debug` for debugging tests
|
- Use `jest-debug` for debugging tests
|
||||||
- Monitor IndexedDB usage in browser dev tools
|
- Monitor IndexedDB usage in browser dev tools
|
||||||
- Check worker communication in console
|
- Check worker communication in console
|
||||||
@@ -98,6 +123,7 @@ PRAGMA page_size=8192; -- Optional, but recommended
|
|||||||
## Common Patterns
|
## Common Patterns
|
||||||
|
|
||||||
### Worker Initialization
|
### Worker Initialization
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// Main thread
|
// Main thread
|
||||||
import { initBackend } from 'absurd-sql/dist/indexeddb-main-thread';
|
import { initBackend } from 'absurd-sql/dist/indexeddb-main-thread';
|
||||||
@@ -109,6 +135,7 @@ function init() {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Database Setup
|
### Database Setup
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// Worker thread
|
// Worker thread
|
||||||
import initSqlJs from '@jlongster/sql.js';
|
import initSqlJs from '@jlongster/sql.js';
|
||||||
@@ -130,6 +157,7 @@ async function setupDatabase() {
|
|||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
1. SharedArrayBuffer not available
|
1. SharedArrayBuffer not available
|
||||||
- Check COOP/COEP headers
|
- Check COOP/COEP headers
|
||||||
- Verify browser support
|
- Verify browser support
|
||||||
@@ -146,7 +174,20 @@ async function setupDatabase() {
|
|||||||
- Verify transaction usage
|
- Verify transaction usage
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
- [Project Demo](https://priceless-keller-d097e5.netlify.app/)
|
- [Project Demo](https://priceless-keller-d097e5.netlify.app/)
|
||||||
- [Example Project](https://github.com/jlongster/absurd-example-project)
|
- [Example Project](https://github.com/jlongster/absurd-example-project)
|
||||||
- [Blog Post](https://jlongster.com/future-sql-web)
|
- [Blog Post](https://jlongster.com/future-sql-web)
|
||||||
- [SQL.js Documentation](https://github.com/sql-js/sql.js/)
|
- [SQL.js Documentation](https://github.com/sql-js/sql.js/)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active database development guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: Absurd SQL, SQL.js, IndexedDB
|
||||||
|
**Stakeholders**: Development team, Database team
|
||||||
|
- [Project Demo](https://priceless-keller-d097e5.netlify.app/)
|
||||||
|
- [Example Project](https://github.com/jlongster/absurd-example-project)
|
||||||
|
- [Blog Post](https://jlongster.com/future-sql-web)
|
||||||
|
- [SQL.js Documentation](https://github.com/sql-js/sql.js/)
|
||||||
|
|||||||
@@ -2,4 +2,7 @@
|
|||||||
globs: **/databaseUtil.ts,**/AccountViewView.vue,**/ContactsView.vue,**/DatabaseMigration.vue,**/NewIdentifierView.vue
|
globs: **/databaseUtil.ts,**/AccountViewView.vue,**/ContactsView.vue,**/DatabaseMigration.vue,**/NewIdentifierView.vue
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
All references in the codebase to Dexie apply only to migration from IndexedDb to Sqlite and will be deprecated in future versions.
|
# What to do with Dexie
|
||||||
|
|
||||||
|
All references in the codebase to Dexie apply only to migration from IndexedDb to
|
||||||
|
Sqlite and will be deprecated in future versions.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
globs: **/src/**/*,**/scripts/**/*,**/electron/**/*
|
description: when dealing with types and Typesript
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
```json
|
```json
|
||||||
@@ -15,8 +15,8 @@ alwaysApply: false
|
|||||||
# TypeScript Type Safety Guidelines
|
# TypeScript Type Safety Guidelines
|
||||||
|
|
||||||
**Author**: Matthew Raymer
|
**Author**: Matthew Raymer
|
||||||
**Date**: 2025-08-16
|
**Date**: 2025-08-19
|
||||||
**Status**: 🎯 **ACTIVE**
|
**Status**: 🎯 **ACTIVE** - Type safety enforcement
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -28,7 +28,8 @@ Practical rules to keep TypeScript strict and predictable. Minimize exceptions.
|
|||||||
- Use explicit types. If unknown, use `unknown` and **narrow** via guards.
|
- Use explicit types. If unknown, use `unknown` and **narrow** via guards.
|
||||||
|
|
||||||
2. **Error handling uses guards**
|
2. **Error handling uses guards**
|
||||||
- Reuse guards from `src/interfaces/**` (e.g., `isDatabaseError`, `isApiError`).
|
- Reuse guards from `src/interfaces/**` (e.g., `isDatabaseError`,
|
||||||
|
`isApiError`).
|
||||||
- Catch with `unknown`; never cast to `any`.
|
- Catch with `unknown`; never cast to `any`.
|
||||||
|
|
||||||
3. **Dynamic property access is type‑safe**
|
3. **Dynamic property access is type‑safe**
|
||||||
@@ -40,12 +41,30 @@ Practical rules to keep TypeScript strict and predictable. Minimize exceptions.
|
|||||||
|
|
||||||
- Avoid `(obj as any)[k]`.
|
- Avoid `(obj as any)[k]`.
|
||||||
|
|
||||||
|
## Type Safety Enforcement
|
||||||
|
|
||||||
|
### Core Type Safety Rules
|
||||||
|
|
||||||
|
- **No `any` Types**: Use explicit types or `unknown` with proper type guards
|
||||||
|
- **Error Handling Uses Guards**: Implement and reuse type guards from `src/interfaces/**`
|
||||||
|
- **Dynamic Property Access**: Use `keyof` + `in` checks for type-safe property access
|
||||||
|
|
||||||
|
### Type Guard Patterns
|
||||||
|
- **API Errors**: Use `isApiError(error)` guards for API error handling
|
||||||
|
- **Database Errors**: Use `isDatabaseError(error)` guards for database operations
|
||||||
|
- **Axios Errors**: Implement `isAxiosError(error)` guards for HTTP error handling
|
||||||
|
|
||||||
|
### Implementation Guidelines
|
||||||
|
- **Avoid Type Assertions**: Replace `as any` with proper type guards and interfaces
|
||||||
|
- **Narrow Types Properly**: Use type guards to narrow `unknown` types safely
|
||||||
|
- **Document Type Decisions**: Explain complex type structures and their purpose
|
||||||
|
|
||||||
## Minimal Special Cases (document in PR when used)
|
## Minimal Special Cases (document in PR when used)
|
||||||
|
|
||||||
- **Vue refs / instances**: Use `ComponentPublicInstance` or specific component
|
- **Vue refs / instances**: Use `ComponentPublicInstance` or specific
|
||||||
types for dynamic refs.
|
component types for dynamic refs.
|
||||||
- **3rd‑party libs without types**: Narrow immediately to a **known interface**;
|
- **3rd‑party libs without types**: Narrow immediately to a **known
|
||||||
do not leave `any` hanging.
|
interface**; do not leave `any` hanging.
|
||||||
|
|
||||||
## Patterns (short)
|
## Patterns (short)
|
||||||
|
|
||||||
@@ -106,3 +125,15 @@ const keys = Object.keys(newSettings).filter(
|
|||||||
- TS Handbook — https://www.typescriptlang.org/docs/
|
- TS Handbook — https://www.typescriptlang.org/docs/
|
||||||
- TS‑ESLint — https://typescript-eslint.io/rules/
|
- TS‑ESLint — https://typescript-eslint.io/rules/
|
||||||
- Vue 3 + TS — https://vuejs.org/guide/typescript/
|
- Vue 3 + TS — https://vuejs.org/guide/typescript/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active type safety guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: TypeScript, ESLint, Vue 3
|
||||||
|
**Stakeholders**: Development team
|
||||||
|
|
||||||
|
- TS Handbook — https://www.typescriptlang.org/docs/
|
||||||
|
- TS‑ESLint — https://typescript-eslint.io/rules/
|
||||||
|
- Vue 3 + TS — https://vuejs.org/guide/typescript/
|
||||||
|
|||||||
79
.cursor/rules/docs/markdown-automation.mdc
Normal file
79
.cursor/rules/docs/markdown-automation.mdc
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Markdown Automation System
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-20
|
||||||
|
**Status**: 🎯 **ACTIVE** - Markdown formatting automation
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The Markdown Automation System ensures your markdown formatting standards are
|
||||||
|
followed **during content generation** by AI agents, not just applied after the
|
||||||
|
fact.
|
||||||
|
|
||||||
|
## AI-First Approach
|
||||||
|
|
||||||
|
### **Primary Method**: AI Agent Compliance
|
||||||
|
|
||||||
|
- **AI agents follow markdown rules** while generating content
|
||||||
|
- **No post-generation fixes needed** - content is compliant from creation
|
||||||
|
- **Consistent formatting** across all generated documentation
|
||||||
|
|
||||||
|
### **Secondary Method**: Automated Validation
|
||||||
|
|
||||||
|
- **Pre-commit hooks** catch any remaining issues
|
||||||
|
- **GitHub Actions** validate formatting before merge
|
||||||
|
- **Manual tools** for bulk fixes when needed
|
||||||
|
|
||||||
|
## How It Works
|
||||||
|
|
||||||
|
### 1. **AI Agent Compliance** (Primary)
|
||||||
|
|
||||||
|
- **When**: Every time AI generates markdown content
|
||||||
|
- **What**: AI follows markdown rules during generation
|
||||||
|
- **Result**: Content is properly formatted from creation
|
||||||
|
|
||||||
|
### 2. **Pre-commit Hooks** (Backup)
|
||||||
|
|
||||||
|
- **When**: Every time you commit
|
||||||
|
- **What**: Catches any remaining formatting issues
|
||||||
|
- **Result**: Clean, properly formatted markdown files
|
||||||
|
|
||||||
|
### 3. **GitHub Actions** (Pre-merge)
|
||||||
|
|
||||||
|
- **When**: Every pull request
|
||||||
|
- **What**: Validates markdown formatting across all files
|
||||||
|
- **Result**: Blocks merge if formatting issues exist
|
||||||
|
|
||||||
|
## AI Agent Rules Integration
|
||||||
|
|
||||||
|
The AI agent follows markdown rules defined in `.cursor/rules/docs/markdown.mdc`:
|
||||||
|
|
||||||
|
- **alwaysApply: true** - Rules are enforced during generation
|
||||||
|
- **Line Length**: AI never generates lines > 80 characters
|
||||||
|
- **Blank Lines**: AI adds proper spacing around all elements
|
||||||
|
- **Structure**: AI uses established templates and patterns
|
||||||
|
|
||||||
|
## Available Commands
|
||||||
|
|
||||||
|
### NPM Scripts
|
||||||
|
|
||||||
|
- **`npm run markdown:setup`** - Install the automation system
|
||||||
|
- **`npm run markdown:fix`** - Fix formatting in all markdown files
|
||||||
|
- **`npm run markdown:check`** - Validate formatting without fixing
|
||||||
|
|
||||||
|
## Benefits
|
||||||
|
|
||||||
|
- **No more manual fixes** - AI generates compliant content from start
|
||||||
|
- **Consistent style** - All files follow same standards
|
||||||
|
- **Faster development** - No need to fix formatting manually
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active automation system
|
||||||
|
**Priority**: High
|
||||||
|
**Maintainer**: Development team
|
||||||
|
**Next Review**: 2025-09-20
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
globs: *.md
|
globs: ["*.md", "*.mdc"]
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Cursor Markdown Ruleset for TimeSafari Documentation
|
# Cursor Markdown Ruleset for TimeSafari Documentation
|
||||||
@@ -10,6 +10,36 @@ This ruleset enforces consistent markdown formatting standards across all projec
|
|||||||
documentation, ensuring readability, maintainability, and compliance with
|
documentation, ensuring readability, maintainability, and compliance with
|
||||||
markdownlint best practices.
|
markdownlint best practices.
|
||||||
|
|
||||||
|
**⚠️ CRITICAL FOR AI AGENTS**: These rules must be followed DURING content
|
||||||
|
generation, not applied after the fact. Always generate markdown that complies
|
||||||
|
with these standards from the start.
|
||||||
|
|
||||||
|
## AI Generation Guidelines
|
||||||
|
|
||||||
|
### **MANDATORY**: Follow These Rules While Writing
|
||||||
|
|
||||||
|
When generating markdown content, you MUST:
|
||||||
|
|
||||||
|
1. **Line Length**: Never exceed 80 characters per line
|
||||||
|
2. **Blank Lines**: Always add blank lines around headings, lists, and code
|
||||||
|
blocks
|
||||||
|
3. **Structure**: Use proper heading hierarchy and document templates
|
||||||
|
4. **Formatting**: Apply consistent formatting patterns immediately
|
||||||
|
|
||||||
|
### **DO NOT**: Generate content that violates these rules
|
||||||
|
|
||||||
|
- ❌ Generate long lines that need breaking
|
||||||
|
- ❌ Create content without proper blank line spacing
|
||||||
|
- ❌ Use inconsistent formatting patterns
|
||||||
|
- ❌ Assume post-processing will fix violations
|
||||||
|
|
||||||
|
### **DO**: Generate compliant content from the start
|
||||||
|
|
||||||
|
- ✅ Write within 80-character limits
|
||||||
|
- ✅ Add blank lines around all structural elements
|
||||||
|
- ✅ Use established templates and patterns
|
||||||
|
- ✅ Apply formatting standards immediately
|
||||||
|
|
||||||
## General Formatting Standards
|
## General Formatting Standards
|
||||||
|
|
||||||
### Line Length
|
### Line Length
|
||||||
@@ -326,6 +356,10 @@ Description of current situation or problem.
|
|||||||
### Authentication
|
### Authentication
|
||||||
### Authorization
|
### Authorization
|
||||||
|
|
||||||
|
## Features ❌ (Duplicate heading)
|
||||||
|
### Security
|
||||||
|
### Performance
|
||||||
|
```
|
||||||
## Features ❌ (Duplicate heading)
|
## Features ❌ (Duplicate heading)
|
||||||
### Security
|
### Security
|
||||||
### Performance
|
### Performance
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
---
|
---
|
||||||
description:
|
description: when dealing with cameras in the application
|
||||||
globs:
|
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Camera Implementation Documentation
|
# Camera Implementation Documentation
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This document describes how camera functionality is implemented across the TimeSafari application. The application uses cameras for two main purposes:
|
This document describes how camera functionality is implemented across the
|
||||||
|
TimeSafari application. The application uses cameras for two main purposes:
|
||||||
|
|
||||||
1. QR Code scanning
|
1. QR Code scanning
|
||||||
2. Photo capture
|
2. Photo capture
|
||||||
@@ -219,4 +219,4 @@ Desktop implementation (currently unimplemented).
|
|||||||
- Multiple browsers
|
- Multiple browsers
|
||||||
- iOS and Android devices
|
- iOS and Android devices
|
||||||
- Desktop platforms
|
- Desktop platforms
|
||||||
- Various network conditions
|
- Various network conditions
|
||||||
|
|||||||
207
.cursor/rules/harbor_pilot_universal.mdc
Normal file
207
.cursor/rules/harbor_pilot_universal.mdc
Normal file
@@ -0,0 +1,207 @@
|
|||||||
|
---
|
||||||
|
alwaysApply: true
|
||||||
|
inherits: base_context.mdc
|
||||||
|
---
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"coaching_level": "standard",
|
||||||
|
"socratic_max_questions": 2,
|
||||||
|
"verbosity": "concise",
|
||||||
|
"timebox_minutes": 10,
|
||||||
|
"format_enforcement": "strict"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# Harbor Pilot — Universal Directive for Human-Facing Technical Guides
|
||||||
|
|
||||||
|
**Author**: System/Shared
|
||||||
|
**Date**: 2025-08-21 (UTC)
|
||||||
|
**Status**: 🚢 ACTIVE — General ruleset extending *Base Context — Human Competence First*
|
||||||
|
|
||||||
|
> **Alignment with Base Context**
|
||||||
|
> - **Purpose fit**: Prioritizes human competence and collaboration while delivering reproducible artifacts.
|
||||||
|
> - **Output Contract**: This directive **adds universal constraints** for any technical topic while **inheriting** the Base Context contract sections.
|
||||||
|
> - **Toggles honored**: Uses the same toggle semantics; defaults above can be overridden by the caller.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
Produce a **developer-grade, reproducible guide** for any technical topic that onboards a competent practitioner **without meta narration** and **with evidence-backed steps**.
|
||||||
|
|
||||||
|
## Scope & Constraints
|
||||||
|
- **One Markdown document** as the deliverable.
|
||||||
|
- Use **absolute dates** in **UTC** (e.g., `2025-08-21T14:22Z`) — avoid “today/yesterday”.
|
||||||
|
- Include at least **one diagram** (Mermaid preferred). Choose the most fitting type:
|
||||||
|
- `sequenceDiagram` (protocols/flows), `flowchart`, `stateDiagram`, `gantt` (timelines), or `classDiagram` (schemas).
|
||||||
|
- Provide runnable examples where applicable:
|
||||||
|
- **APIs**: `curl` + one client library (e.g., `httpx` for Python).
|
||||||
|
- **CLIs**: literal command blocks and expected output snippets.
|
||||||
|
- **Code**: minimal, self-contained samples (language appropriate).
|
||||||
|
- Cite **evidence** for *Works/Doesn’t* items (timestamps, filenames, line numbers, IDs/status codes, or logs).
|
||||||
|
- If something is unknown, output `TODO:<missing>` — **never invent**.
|
||||||
|
|
||||||
|
## Required Sections (extends Base Output Contract)
|
||||||
|
Follow this exact order **after** the Base Contract’s **Objective → Result → Use/Run** headers:
|
||||||
|
|
||||||
|
1. **Context & Scope**
|
||||||
|
- Problem statement, audience, in/out-of-scope bullets.
|
||||||
|
2. **Artifacts & Links**
|
||||||
|
- Repos/PRs, design docs, datasets/HARs/pcaps, scripts/tools, dashboards.
|
||||||
|
3. **Environment & Preconditions**
|
||||||
|
- OS/runtime, versions/build IDs, services/endpoints/URLs, credentials/auth mode (describe acquisition, do not expose secrets).
|
||||||
|
4. **Architecture / Process Overview**
|
||||||
|
- Short prose + **one diagram** selected from the list above.
|
||||||
|
5. **Interfaces & Contracts (choose one)**
|
||||||
|
- **API-based**: Endpoint table (*Step, Method, Path/URL, Auth, Key Headers/Params, Sample Req/Resp ref*).
|
||||||
|
- **Data/Files**: I/O contract table (*Source, Format, Schema/Columns, Size, Validation rules*).
|
||||||
|
- **Systems/Hardware**: Interfaces table (*Port/Bus, Protocol, Voltage/Timing, Constraints*).
|
||||||
|
6. **Repro: End-to-End Procedure**
|
||||||
|
- Minimal copy-paste steps with code/commands and **expected outputs**.
|
||||||
|
7. **What Works (with Evidence)**
|
||||||
|
- Each item: **Time (UTC)** • **Artifact/Req IDs** • **Status/Result** • **Where to verify**.
|
||||||
|
8. **What Doesn’t (Evidence & Hypotheses)**
|
||||||
|
- Each failure: locus (file/endpoint/module), evidence snippet; short hypothesis and **next probe**.
|
||||||
|
9. **Risks, Limits, Assumptions**
|
||||||
|
- SLOs/limits, rate/size caps, security boundaries (CORS/CSRF/ACLs), retries/backoff/idempotency patterns.
|
||||||
|
10. **Next Steps (Owner • Exit Criteria • Target Date)**
|
||||||
|
- Actionable, assigned, and time-bound.
|
||||||
|
11. **References**
|
||||||
|
- Canonical docs, specs, tickets, prior analyses.
|
||||||
|
|
||||||
|
> **Competence Hooks (per Base Context; keep lightweight):**
|
||||||
|
> - *Why this works* (≤3 bullets) — core invariants or guarantees.
|
||||||
|
> - *Common pitfalls* (≤3 bullets) — the traps we saw in evidence.
|
||||||
|
> - *Next skill unlock* (1 line) — the next capability to implement/learn.
|
||||||
|
> - *Teach-back* (1 line) — prompt the reader to restate the flow/architecture.
|
||||||
|
|
||||||
|
> **Collaboration Hooks (per Base Context):**
|
||||||
|
> - Name reviewers for **Interfaces & Contracts** and the **diagram**.
|
||||||
|
> - Short **sign-off checklist** before merging/publishing the guide.
|
||||||
|
|
||||||
|
## Do / Don’t (Base-aligned)
|
||||||
|
- **Do** quantify progress only against a defined scope with acceptance criteria.
|
||||||
|
- **Do** include minimal sample payloads/headers or I/O schemas; redact sensitive values.
|
||||||
|
- **Do** keep commentary lean; if timeboxed, move depth to **Deferred for depth**.
|
||||||
|
- **Don’t** use marketing language or meta narration (“Perfect!”, “tool called”, “new chat”).
|
||||||
|
- **Don’t** include IDE-specific chatter or internal rules unrelated to the task.
|
||||||
|
|
||||||
|
## Validation Checklist (self-check before returning)
|
||||||
|
- [ ] All Required Sections present and ordered.
|
||||||
|
- [ ] Diagram compiles (basic Mermaid syntax) and fits the problem.
|
||||||
|
- [ ] If API-based, **Auth** and **Key Headers/Params** are listed for each endpoint.
|
||||||
|
- [ ] Repro section includes commands/code **and expected outputs**.
|
||||||
|
- [ ] Every Works/Doesn’t item has **UTC timestamp**, **status/result**, and **verifiable evidence**.
|
||||||
|
- [ ] Next Steps include **Owner**, **Exit Criteria**, **Target Date**.
|
||||||
|
- [ ] Unknowns are `TODO:<missing>` — no fabrication.
|
||||||
|
- [ ] Base **Output Contract** sections satisfied (Objective/Result/Use/Run/Competence/Collaboration/Assumptions/References).
|
||||||
|
|
||||||
|
## Universal Template (fill-in)
|
||||||
|
```markdown
|
||||||
|
# <Title> — Working Notes (As of YYYY-MM-DDTHH:MMZ)
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
<one line>
|
||||||
|
|
||||||
|
## Result
|
||||||
|
<link to the produced guide file or say “this document”>
|
||||||
|
|
||||||
|
## Use/Run
|
||||||
|
<how to apply/test and where to run samples>
|
||||||
|
|
||||||
|
## Context & Scope
|
||||||
|
- Audience: <role(s)>
|
||||||
|
- In scope: <bullets>
|
||||||
|
- Out of scope: <bullets>
|
||||||
|
|
||||||
|
## Artifacts & Links
|
||||||
|
- Repo/PR: <link>
|
||||||
|
- Data/Logs: <paths or links>
|
||||||
|
- Scripts/Tools: <paths>
|
||||||
|
- Dashboards: <links>
|
||||||
|
|
||||||
|
## Environment & Preconditions
|
||||||
|
- OS/Runtime: <details>
|
||||||
|
- Versions/Builds: <list>
|
||||||
|
- Services/Endpoints: <list>
|
||||||
|
- Auth mode: <Bearer/Session/Keys + how acquired>
|
||||||
|
|
||||||
|
## Architecture / Process Overview
|
||||||
|
<short prose>
|
||||||
|
```mermaid
|
||||||
|
<one suitable diagram: sequenceDiagram | flowchart | stateDiagram | gantt | classDiagram>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Interfaces & Contracts
|
||||||
|
### If API-based
|
||||||
|
| Step | Method | Path/URL | Auth | Key Headers/Params | Sample |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| <…> | <…> | <…> | <…> | <…> | below |
|
||||||
|
|
||||||
|
### If Data/Files
|
||||||
|
| Source | Format | Schema/Columns | Size | Validation |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| <…> | <…> | <…> | <…> | <…> |
|
||||||
|
|
||||||
|
### If Systems/Hardware
|
||||||
|
| Interface | Protocol | Timing/Voltage | Constraints | Notes |
|
||||||
|
|---|---|---|---|---|
|
||||||
|
| <…> | <…> | <…> | <…> | <…> |
|
||||||
|
|
||||||
|
## Repro: End-to-End Procedure
|
||||||
|
```bash
|
||||||
|
# commands / curl examples (redacted where necessary)
|
||||||
|
```
|
||||||
|
```python
|
||||||
|
# minimal client library example (language appropriate)
|
||||||
|
```
|
||||||
|
> Expected output: <snippet/checks>
|
||||||
|
|
||||||
|
## What Works (Evidence)
|
||||||
|
- ✅ <short statement>
|
||||||
|
- **Time**: <YYYY-MM-DDTHH:MMZ>
|
||||||
|
- **Evidence**: file/line/log or request id/status
|
||||||
|
- **Verify at**: <where>
|
||||||
|
|
||||||
|
## What Doesn’t (Evidence & Hypotheses)
|
||||||
|
- ❌ <short failure> at `<component/endpoint/file>`
|
||||||
|
- **Time**: <YYYY-MM-DDTHH:MMZ>
|
||||||
|
- **Evidence**: <snippet/id/status>
|
||||||
|
- **Hypothesis**: <short>
|
||||||
|
- **Next probe**: <short>
|
||||||
|
|
||||||
|
## Risks, Limits, Assumptions
|
||||||
|
<bullets: limits, security boundaries, retries/backoff, idempotency, SLOs>
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
| Owner | Task | Exit Criteria | Target Date (UTC) |
|
||||||
|
|---|---|---|---|
|
||||||
|
| <name> | <action> | <measurable outcome> | <YYYY-MM-DD> |
|
||||||
|
|
||||||
|
## References
|
||||||
|
<links/titles>
|
||||||
|
|
||||||
|
## Competence Hooks
|
||||||
|
- *Why this works*: <≤3 bullets>
|
||||||
|
- *Common pitfalls*: <≤3 bullets>
|
||||||
|
- *Next skill unlock*: <1 line>
|
||||||
|
- *Teach-back*: <1 line>
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
- Reviewers: <names/roles>
|
||||||
|
- Sign-off checklist: <≤5 checks>
|
||||||
|
|
||||||
|
## Assumptions & Limits
|
||||||
|
<bullets>
|
||||||
|
|
||||||
|
## Deferred for depth
|
||||||
|
<park deeper material here to respect timeboxing>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Notes for Implementers:**
|
||||||
|
- Respect Base *Do-Not* (no filler, no invented facts, no censorship).
|
||||||
|
- Prefer clarity over completeness when timeboxed; capture unknowns explicitly.
|
||||||
|
- Apply historical comment management rules (see `.cursor/rules/historical_comment_management.mdc`)
|
||||||
|
- Apply realistic time estimation rules (see `.cursor/rules/realistic_time_estimation.mdc`)
|
||||||
|
- Apply Playwright test investigation rules (see `.cursor/rules/playwright_test_investigation.mdc`)
|
||||||
236
.cursor/rules/historical_comment_management.mdc
Normal file
236
.cursor/rules/historical_comment_management.mdc
Normal file
@@ -0,0 +1,236 @@
|
|||||||
|
---
|
||||||
|
description: when comments are generated by the model
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
# Historical Comment Management — Harbor Pilot Directive
|
||||||
|
|
||||||
|
> **Agent role**: When encountering historical comments about removed methods, deprecated patterns, or architectural changes, apply these guidelines to maintain code clarity and developer guidance.
|
||||||
|
|
||||||
|
## 🎯 Purpose
|
||||||
|
|
||||||
|
Historical comments should either be **removed entirely** or **transformed into actionable guidance** for future developers. Avoid keeping comments that merely state what was removed without explaining why or what to do instead.
|
||||||
|
|
||||||
|
## 📋 Decision Framework
|
||||||
|
|
||||||
|
### Remove Historical Comments When:
|
||||||
|
- **Obsolete Information**: Comment describes functionality that no longer exists
|
||||||
|
- **No Action Required**: Comment doesn't help future developers make decisions
|
||||||
|
- **Outdated Context**: Comment refers to old patterns that are no longer relevant
|
||||||
|
- **Self-Evident**: The current code clearly shows the current approach
|
||||||
|
|
||||||
|
### Transform Historical Comments When:
|
||||||
|
- **Architectural Context**: The change represents a significant pattern shift
|
||||||
|
- **Migration Guidance**: Future developers might need to understand the evolution
|
||||||
|
- **Decision Rationale**: The "why" behind the change is still relevant
|
||||||
|
- **Alternative Approaches**: The comment can guide future implementation choices
|
||||||
|
|
||||||
|
## 🔄 Transformation Patterns
|
||||||
|
|
||||||
|
### 1. From Removal Notice to Migration Note
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// turnOffNotifyingFlags method removed - notification state is now managed by NotificationSection component
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: Notification state management has been migrated to NotificationSection component
|
||||||
|
// which handles its own lifecycle and persistence via PlatformServiceMixin
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. From Deprecation Notice to Implementation Guide
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// This will be handled by the NewComponent now
|
||||||
|
// No need to call oldMethod() as it's no longer needed
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: This functionality has been migrated to NewComponent
|
||||||
|
// which provides better separation of concerns and testability
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. From Historical Note to Architectural Context
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// Old approach: used direct database calls
|
||||||
|
// New approach: uses service layer
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: Database access has been abstracted through service layer
|
||||||
|
// for better testability and platform independence
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚫 Anti-Patterns to Remove
|
||||||
|
|
||||||
|
- Comments that only state what was removed
|
||||||
|
- Comments that don't explain the current approach
|
||||||
|
- Comments that reference non-existent methods
|
||||||
|
- Comments that are self-evident from the code
|
||||||
|
- Comments that don't help future decision-making
|
||||||
|
|
||||||
|
## ✅ Best Practices
|
||||||
|
|
||||||
|
### When Keeping Historical Context:
|
||||||
|
1. **Explain the "Why"**: Why was the change made?
|
||||||
|
2. **Describe the "What"**: What is the current approach?
|
||||||
|
3. **Provide Context**: When might this information be useful?
|
||||||
|
4. **Use Actionable Language**: Guide future decisions, not just document history
|
||||||
|
|
||||||
|
### When Removing Historical Context:
|
||||||
|
1. **Verify Obsoleteness**: Ensure the information is truly outdated
|
||||||
|
2. **Check for Dependencies**: Ensure no other code references the old approach
|
||||||
|
3. **Update Related Docs**: If removing from code, consider adding to documentation
|
||||||
|
4. **Preserve in Git History**: The change is preserved in version control
|
||||||
|
|
||||||
|
## 🔍 Implementation Checklist
|
||||||
|
|
||||||
|
- [ ] Identify historical comments about removed/deprecated functionality
|
||||||
|
- [ ] Determine if comment provides actionable guidance
|
||||||
|
- [ ] Transform useful comments into migration notes or architectural context
|
||||||
|
- [ ] Remove comments that are purely historical without guidance value
|
||||||
|
- [ ] Ensure remaining comments explain current approach and rationale
|
||||||
|
- [ ] Update related documentation if significant context is removed
|
||||||
|
|
||||||
|
## 📚 Examples
|
||||||
|
|
||||||
|
### Good Historical Comment (Keep & Transform)
|
||||||
|
```typescript
|
||||||
|
// Note: Database access has been migrated from direct IndexedDB calls to PlatformServiceMixin
|
||||||
|
// This provides better platform abstraction and consistent error handling across web/mobile/desktop
|
||||||
|
// When adding new database operations, use this.$getContact(), this.$saveSettings(), etc.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Bad Historical Comment (Remove)
|
||||||
|
```typescript
|
||||||
|
// Old method getContactFromDB() removed - now handled by PlatformServiceMixin
|
||||||
|
// No need to call the old method anymore
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎯 Integration with Harbor Pilot
|
||||||
|
|
||||||
|
This rule works in conjunction with:
|
||||||
|
- **Component Creation Ideals**: Maintains architectural consistency
|
||||||
|
- **Migration Patterns**: Documents evolution of patterns
|
||||||
|
- **Code Review Guidelines**: Ensures comments provide value
|
||||||
|
|
||||||
|
## 📝 Version History
|
||||||
|
|
||||||
|
### v1.0.0 (2025-08-21)
|
||||||
|
- Initial creation based on notification system cleanup
|
||||||
|
- Established decision framework for historical comment management
|
||||||
|
- Added transformation patterns and anti-patterns
|
||||||
|
- Integrated with existing Harbor Pilot architecture rules
|
||||||
|
# Historical Comment Management — Harbor Pilot Directive
|
||||||
|
|
||||||
|
> **Agent role**: When encountering historical comments about removed methods, deprecated patterns, or architectural changes, apply these guidelines to maintain code clarity and developer guidance.
|
||||||
|
|
||||||
|
## 🎯 Purpose
|
||||||
|
|
||||||
|
Historical comments should either be **removed entirely** or **transformed into actionable guidance** for future developers. Avoid keeping comments that merely state what was removed without explaining why or what to do instead.
|
||||||
|
|
||||||
|
## 📋 Decision Framework
|
||||||
|
|
||||||
|
### Remove Historical Comments When:
|
||||||
|
- **Obsolete Information**: Comment describes functionality that no longer exists
|
||||||
|
- **No Action Required**: Comment doesn't help future developers make decisions
|
||||||
|
- **Outdated Context**: Comment refers to old patterns that are no longer relevant
|
||||||
|
- **Self-Evident**: The current code clearly shows the current approach
|
||||||
|
|
||||||
|
### Transform Historical Comments When:
|
||||||
|
- **Architectural Context**: The change represents a significant pattern shift
|
||||||
|
- **Migration Guidance**: Future developers might need to understand the evolution
|
||||||
|
- **Decision Rationale**: The "why" behind the change is still relevant
|
||||||
|
- **Alternative Approaches**: The comment can guide future implementation choices
|
||||||
|
|
||||||
|
## 🔄 Transformation Patterns
|
||||||
|
|
||||||
|
### 1. From Removal Notice to Migration Note
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// turnOffNotifyingFlags method removed - notification state is now managed by NotificationSection component
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: Notification state management has been migrated to NotificationSection component
|
||||||
|
// which handles its own lifecycle and persistence via PlatformServiceMixin
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. From Deprecation Notice to Implementation Guide
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// This will be handled by the NewComponent now
|
||||||
|
// No need to call oldMethod() as it's no longer needed
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: This functionality has been migrated to NewComponent
|
||||||
|
// which provides better separation of concerns and testability
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. From Historical Note to Architectural Context
|
||||||
|
```typescript
|
||||||
|
// ❌ REMOVE THIS
|
||||||
|
// Old approach: used direct database calls
|
||||||
|
// New approach: uses service layer
|
||||||
|
|
||||||
|
// ✅ TRANSFORM TO THIS
|
||||||
|
// Note: Database access has been abstracted through service layer
|
||||||
|
// for better testability and platform independence
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚫 Anti-Patterns to Remove
|
||||||
|
|
||||||
|
- Comments that only state what was removed
|
||||||
|
- Comments that don't explain the current approach
|
||||||
|
- Comments that reference non-existent methods
|
||||||
|
- Comments that are self-evident from the code
|
||||||
|
- Comments that don't help future decision-making
|
||||||
|
|
||||||
|
## ✅ Best Practices
|
||||||
|
|
||||||
|
### When Keeping Historical Context:
|
||||||
|
1. **Explain the "Why"**: Why was the change made?
|
||||||
|
2. **Describe the "What"**: What is the current approach?
|
||||||
|
3. **Provide Context**: When might this information be useful?
|
||||||
|
4. **Use Actionable Language**: Guide future decisions, not just document history
|
||||||
|
|
||||||
|
### When Removing Historical Context:
|
||||||
|
1. **Verify Obsoleteness**: Ensure the information is truly outdated
|
||||||
|
2. **Check for Dependencies**: Ensure no other code references the old approach
|
||||||
|
3. **Update Related Docs**: If removing from code, consider adding to documentation
|
||||||
|
4. **Preserve in Git History**: The change is preserved in version control
|
||||||
|
|
||||||
|
## 🔍 Implementation Checklist
|
||||||
|
|
||||||
|
- [ ] Identify historical comments about removed/deprecated functionality
|
||||||
|
- [ ] Determine if comment provides actionable guidance
|
||||||
|
- [ ] Transform useful comments into migration notes or architectural context
|
||||||
|
- [ ] Remove comments that are purely historical without guidance value
|
||||||
|
- [ ] Ensure remaining comments explain current approach and rationale
|
||||||
|
- [ ] Update related documentation if significant context is removed
|
||||||
|
|
||||||
|
## 📚 Examples
|
||||||
|
|
||||||
|
### Good Historical Comment (Keep & Transform)
|
||||||
|
```typescript
|
||||||
|
// Note: Database access has been migrated from direct IndexedDB calls to PlatformServiceMixin
|
||||||
|
// This provides better platform abstraction and consistent error handling across web/mobile/desktop
|
||||||
|
// When adding new database operations, use this.$getContact(), this.$saveSettings(), etc.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Bad Historical Comment (Remove)
|
||||||
|
```typescript
|
||||||
|
// Old method getContactFromDB() removed - now handled by PlatformServiceMixin
|
||||||
|
// No need to call the old method anymore
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎯 Integration with Harbor Pilot
|
||||||
|
|
||||||
|
This rule works in conjunction with:
|
||||||
|
- **Component Creation Ideals**: Maintains architectural consistency
|
||||||
|
- **Migration Patterns**: Documents evolution of patterns
|
||||||
|
- **Code Review Guidelines**: Ensures comments provide value
|
||||||
|
|
||||||
|
## 📝 Version History
|
||||||
|
|
||||||
|
### v1.0.0 (2025-08-21)
|
||||||
|
- Initial creation based on notification system cleanup
|
||||||
|
- Established decision framework for historical comment management
|
||||||
|
- Added transformation patterns and anti-patterns
|
||||||
|
- Integrated with existing Harbor Pilot architecture rules
|
||||||
@@ -1,76 +1,117 @@
|
|||||||
# Investigation Report Example
|
# Investigation Report Example
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Investigation methodology example
|
||||||
|
|
||||||
## Investigation — Registration Dialog Test Flakiness
|
## Investigation — Registration Dialog Test Flakiness
|
||||||
|
|
||||||
## Objective
|
## Objective
|
||||||
Identify root cause of flaky tests related to registration dialogs in contact import scenarios.
|
|
||||||
|
Identify root cause of flaky tests related to registration dialogs in contact
|
||||||
|
import scenarios.
|
||||||
|
|
||||||
## System Map
|
## System Map
|
||||||
- User action → ContactInputForm → ContactsView.addContact() → handleRegistrationPrompt()
|
|
||||||
|
- User action → ContactInputForm → ContactsView.addContact() →
|
||||||
|
handleRegistrationPrompt()
|
||||||
- setTimeout(1000ms) → Modal dialog → User response → Registration API call
|
- setTimeout(1000ms) → Modal dialog → User response → Registration API call
|
||||||
- Test execution → Wait for dialog → Assert dialog content → Click response button
|
- Test execution → Wait for dialog → Assert dialog content → Click response
|
||||||
|
button
|
||||||
|
|
||||||
## Findings (Evidence)
|
## Findings (Evidence)
|
||||||
- **1-second timeout causes flakiness** — evidence: `src/views/ContactsView.vue:971-1000`; setTimeout(..., 1000) in handleRegistrationPrompt()
|
|
||||||
- **Import flow bypasses dialogs** — evidence: `src/views/ContactImportView.vue:500-520`; importContacts() calls $insertContact() directly, no handleRegistrationPrompt()
|
- **1-second timeout causes flakiness** — evidence:
|
||||||
- **Dialog only appears in direct add flow** — evidence: `src/views/ContactsView.vue:774-800`; addContact() calls handleRegistrationPrompt() after database insert
|
`src/views/ContactsView.vue:971-1000`; setTimeout(..., 1000) in
|
||||||
|
handleRegistrationPrompt()
|
||||||
|
- **Import flow bypasses dialogs** — evidence:
|
||||||
|
`src/views/ContactImportView.vue:500-520`; importContacts() calls
|
||||||
|
$insertContact() directly, no handleRegistrationPrompt()
|
||||||
|
- **Dialog only appears in direct add flow** — evidence:
|
||||||
|
`src/views/ContactsView.vue:774-800`; addContact() calls
|
||||||
|
handleRegistrationPrompt() after database insert
|
||||||
|
|
||||||
## Hypotheses & Failure Modes
|
## Hypotheses & Failure Modes
|
||||||
- H1: 1-second timeout makes dialog appearance unpredictable; would fail when tests run faster than 1000ms
|
|
||||||
- H2: Test environment timing differs from development; watch for CI vs local test differences
|
- H1: 1-second timeout makes dialog appearance unpredictable; would fail when
|
||||||
|
tests run faster than 1000ms
|
||||||
|
- H2: Test environment timing differs from development; watch for CI vs local
|
||||||
|
test differences
|
||||||
|
|
||||||
## Corrections
|
## Corrections
|
||||||
- Updated: "Multiple dialogs interfere with imports" → "Import flow never triggers dialogs - they only appear in direct contact addition"
|
|
||||||
- Updated: "Complex batch registration needed" → "Simple timeout removal and test mode flag sufficient"
|
- Updated: "Multiple dialogs interfere with imports" → "Import flow never
|
||||||
|
triggers dialogs - they only appear in direct contact addition"
|
||||||
|
- Updated: "Complex batch registration needed" → "Simple timeout removal and
|
||||||
|
test mode flag sufficient"
|
||||||
|
|
||||||
## Diagnostics (Next Checks)
|
## Diagnostics (Next Checks)
|
||||||
|
|
||||||
- [ ] Repro on CI environment vs local
|
- [ ] Repro on CI environment vs local
|
||||||
- [ ] Measure actual dialog appearance timing
|
- [ ] Measure actual dialog appearance timing
|
||||||
- [ ] Test with setTimeout removed
|
- [ ] Test with setTimeout removed
|
||||||
- [ ] Verify import flow doesn't call handleRegistrationPrompt
|
- [ ] Verify import flow doesn't call handleRegistrationPrompt
|
||||||
|
|
||||||
## Risks & Scope
|
## Risks & Scope
|
||||||
- Impacted: Contact addition tests, registration workflow tests; Data: None; Users: Test suite reliability
|
|
||||||
|
- Impacted: Contact addition tests, registration workflow tests; Data: None;
|
||||||
|
Users: Test suite reliability
|
||||||
|
|
||||||
## Decision / Next Steps
|
## Decision / Next Steps
|
||||||
|
|
||||||
- Owner: Development Team; By: 2025-01-28
|
- Owner: Development Team; By: 2025-01-28
|
||||||
- Action: Remove 1-second timeout + add test mode flag; Exit criteria: Tests pass consistently
|
- Action: Remove 1-second timeout + add test mode flag; Exit criteria: Tests
|
||||||
|
pass consistently
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- `src/views/ContactsView.vue:971-1000`
|
- `src/views/ContactsView.vue:971-1000`
|
||||||
- `src/views/ContactImportView.vue:500-520`
|
- `src/views/ContactImportView.vue:500-520`
|
||||||
- `src/views/ContactsView.vue:774-800`
|
- `src/views/ContactsView.vue:774-800`
|
||||||
|
|
||||||
## Competence Hooks
|
## Competence Hooks
|
||||||
- Why this works: Code path tracing revealed separate execution flows, evidence disproved initial assumptions
|
|
||||||
- Common pitfalls: Assuming related functionality without tracing execution paths, over-engineering solutions to imaginary problems
|
|
||||||
- Next skill: Learn to trace code execution before proposing architectural changes
|
|
||||||
- Teach-back: "What evidence shows that contact imports bypass registration dialogs?"
|
|
||||||
|
|
||||||
---
|
- Why this works: Code path tracing revealed separate execution flows,
|
||||||
|
evidence disproved initial assumptions
|
||||||
|
- Common pitfalls: Assuming related functionality without tracing execution
|
||||||
|
paths, over-engineering solutions to imaginary problems
|
||||||
|
- Next skill: Learn to trace code execution before proposing architectural
|
||||||
|
changes
|
||||||
|
- Teach-back: "What evidence shows that contact imports bypass registration
|
||||||
|
dialogs?"
|
||||||
|
|
||||||
## Key Learning Points
|
## Key Learning Points
|
||||||
|
|
||||||
### Evidence-First Approach
|
### Evidence-First Approach
|
||||||
|
|
||||||
This investigation demonstrates the importance of:
|
This investigation demonstrates the importance of:
|
||||||
|
|
||||||
1. **Tracing actual code execution** rather than making assumptions
|
1. **Tracing actual code execution** rather than making assumptions
|
||||||
2. **Citing specific evidence** with file:line references
|
2. **Citing specific evidence** with file:line references
|
||||||
3. **Validating problem scope** before proposing solutions
|
3. **Validating problem scope** before proposing solutions
|
||||||
4. **Considering simpler alternatives** before complex architectural changes
|
4. **Considering simpler alternatives** before complex architectural changes
|
||||||
|
|
||||||
### Code Path Tracing Value
|
### Code Path Tracing Value
|
||||||
|
|
||||||
By tracing the execution paths, we discovered:
|
By tracing the execution paths, we discovered:
|
||||||
|
|
||||||
- Import flow and direct add flow are completely separate
|
- Import flow and direct add flow are completely separate
|
||||||
- The "multiple dialog interference" problem didn't exist
|
- The "multiple dialog interference" problem didn't exist
|
||||||
- A simple timeout removal would solve the actual issue
|
- A simple timeout removal would solve the actual issue
|
||||||
|
|
||||||
### Prevention of Over-Engineering
|
### Prevention of Over-Engineering
|
||||||
|
|
||||||
The investigation prevented:
|
The investigation prevented:
|
||||||
|
|
||||||
- Unnecessary database schema changes
|
- Unnecessary database schema changes
|
||||||
- Complex batch registration systems
|
- Complex batch registration systems
|
||||||
- Migration scripts for non-existent problems
|
- Migration scripts for non-existent problems
|
||||||
- Architectural changes based on assumptions
|
- Architectural changes based on assumptions
|
||||||
description:
|
|
||||||
globs:
|
|
||||||
alwaysApply: false
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
**Status**: Active investigation methodology
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: software_development.mdc
|
||||||
|
**Stakeholders**: Development team, QA team
|
||||||
|
|||||||
222
.cursor/rules/logging_standards.mdc
Normal file
222
.cursor/rules/logging_standards.mdc
Normal file
@@ -0,0 +1,222 @@
|
|||||||
|
# Agent Contract — TimeSafari Logging (Unified, MANDATORY)
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Mandatory logging standards
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This document defines unified logging standards for the TimeSafari project,
|
||||||
|
ensuring consistent, rest-parameter logging style using the project logger.
|
||||||
|
No `console.*` methods are allowed in production code.
|
||||||
|
|
||||||
|
## Scope and Goals
|
||||||
|
|
||||||
|
**Scope**: Applies to all diffs and generated code in this workspace unless
|
||||||
|
explicitly exempted below.
|
||||||
|
|
||||||
|
**Goal**: One consistent, rest-parameter logging style using the project
|
||||||
|
logger; no `console.*` in production code.
|
||||||
|
|
||||||
|
## Non‑Negotiables (DO THIS)
|
||||||
|
|
||||||
|
- You **MUST** use the project logger; **DO NOT** use any `console.*`
|
||||||
|
methods.
|
||||||
|
- Import exactly as:
|
||||||
|
- `import { logger } from '@/utils/logger'`
|
||||||
|
- If `@` alias is unavailable, compute the correct relative path (do not
|
||||||
|
fail).
|
||||||
|
- Call signatures use **rest parameters**: `logger.info(message, ...args)`
|
||||||
|
- Prefer primitives/IDs and small objects in `...args`; **never build a
|
||||||
|
throwaway object** just to "wrap context".
|
||||||
|
- Production defaults: Web = `warn+`, Electron = `error`, Dev/Capacitor =
|
||||||
|
`info+` (override via `VITE_LOG_LEVEL`).
|
||||||
|
- **Database persistence**: `info|warn|error` are persisted; `debug` is not.
|
||||||
|
Use `logger.toDb(msg, level?)` for DB-only.
|
||||||
|
|
||||||
|
## Available Logger API (Authoritative)
|
||||||
|
|
||||||
|
- `logger.debug(message, ...args)` — verbose internals, timings, input/output
|
||||||
|
shapes
|
||||||
|
- `logger.log(message, ...args)` — synonym of `info` for general info
|
||||||
|
- `logger.info(message, ...args)` — lifecycle, state changes, success paths
|
||||||
|
- `logger.warn(message, ...args)` — recoverable issues, retries, degraded mode
|
||||||
|
- `logger.error(message, ...args)` — failures, thrown exceptions, aborts
|
||||||
|
- `logger.toDb(message, level?)` — DB-only entry (default level = `info`)
|
||||||
|
- `logger.toConsoleAndDb(message, isError)` — console + DB (use sparingly)
|
||||||
|
- `logger.withContext(componentName)` — returns a scoped logger
|
||||||
|
|
||||||
|
## Level Guidelines (Use These Heuristics)
|
||||||
|
|
||||||
|
### DEBUG
|
||||||
|
|
||||||
|
Use for method entry/exit, computed values, filters, loops, retries, and
|
||||||
|
external call payload sizes.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
logger.debug('[HomeView] reloadFeedOnChange() called');
|
||||||
|
logger.debug('[HomeView] Current filter settings',
|
||||||
|
settings.filterFeedByVisible,
|
||||||
|
settings.filterFeedByNearby,
|
||||||
|
settings.searchBoxes?.length ?? 0);
|
||||||
|
logger.debug('[FeedFilters] Toggling nearby filter',
|
||||||
|
this.isNearby, this.settingChanged, this.activeDid);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Avoid**: Vague messages (`'Processing data'`).
|
||||||
|
|
||||||
|
### INFO
|
||||||
|
|
||||||
|
Use for user-visible lifecycle and completed operations.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
logger.info('[StartView] Component mounted', process.env.VITE_PLATFORM);
|
||||||
|
logger.info('[StartView] User selected new seed generation');
|
||||||
|
logger.info('[SearchAreaView] Search box stored',
|
||||||
|
searchBox.name, searchBox.bbox);
|
||||||
|
logger.info('[ContactQRScanShowView] Contact registration OK',
|
||||||
|
contact.did);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Avoid**: Diagnostic details that belong in `debug`.
|
||||||
|
|
||||||
|
### WARN
|
||||||
|
|
||||||
|
Use for recoverable issues, fallbacks, unexpected-but-handled conditions.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
logger.warn('[ContactQRScanShowView] Invalid scan result – no value',
|
||||||
|
resultType);
|
||||||
|
logger.warn('[ContactQRScanShowView] Invalid QR format – no JWT in URL');
|
||||||
|
logger.warn('[ContactQRScanShowView] JWT missing "own" field');
|
||||||
|
```
|
||||||
|
|
||||||
|
**Avoid**: Hard failures (those are `error`).
|
||||||
|
|
||||||
|
### ERROR
|
||||||
|
|
||||||
|
Use for unrecoverable failures, data integrity issues, and thrown
|
||||||
|
exceptions.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
logger.error('[HomeView Settings] initializeIdentity() failed', err);
|
||||||
|
logger.error('[StartView] Failed to load initialization data', error);
|
||||||
|
logger.error('[ContactQRScanShowView] Error processing contact QR',
|
||||||
|
error, rawValue);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Avoid**: Expected user cancels (use `info`/`debug`).
|
||||||
|
|
||||||
|
## Context Hygiene (Consistent, Minimal, Helpful)
|
||||||
|
|
||||||
|
- **Component context**: Prefer scoped logger.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const log = logger.withContext('UserService');
|
||||||
|
log.info('User created', userId);
|
||||||
|
log.error('Failed to create user', error);
|
||||||
|
```
|
||||||
|
|
||||||
|
If not using `withContext`, prefix message with `[ComponentName]`.
|
||||||
|
|
||||||
|
- **Emojis**: Optional and minimal for visual scanning. Recommended set:
|
||||||
|
- Start/finish: 🚀 / ✅
|
||||||
|
- Retry/loop: 🔄
|
||||||
|
- External call: 📡
|
||||||
|
- Data/metrics: 📊
|
||||||
|
- Inspection: 🔍
|
||||||
|
|
||||||
|
- **Sensitive data**: Never log secrets (tokens, keys, passwords) or
|
||||||
|
payloads >10KB. Prefer IDs over objects; redact/hash when needed.
|
||||||
|
|
||||||
|
## Migration — Auto‑Rewrites (Apply Every Time)
|
||||||
|
|
||||||
|
- Exact transforms:
|
||||||
|
- `console.debug(...)` → `logger.debug(...)`
|
||||||
|
- `console.log(...)` → `logger.log(...)` (or `logger.info(...)` when
|
||||||
|
clearly stateful)
|
||||||
|
- `console.info(...)` → `logger.info(...)`
|
||||||
|
- `console.warn(...)` → `logger.warn(...)`
|
||||||
|
- `console.error(...)` → `logger.error(...)`
|
||||||
|
|
||||||
|
- Multi-arg handling:
|
||||||
|
- First arg becomes `message` (stringify safely if non-string).
|
||||||
|
- Remaining args map 1:1 to `...args`:
|
||||||
|
`console.info(msg, a, b)` → `logger.info(String(msg), a, b)`
|
||||||
|
|
||||||
|
- Sole `Error`:
|
||||||
|
- `console.error(err)` → `logger.error(err.message, err)`
|
||||||
|
|
||||||
|
- **Object-wrapping cleanup**: Replace `{{ userId, meta }}` wrappers with
|
||||||
|
separate args:
|
||||||
|
`logger.info('User signed in', userId, meta)`
|
||||||
|
|
||||||
|
## DB Logging Rules
|
||||||
|
|
||||||
|
- `debug` **never** persists automatically.
|
||||||
|
- `info|warn|error` persist automatically.
|
||||||
|
- For DB-only events (no console), call `logger.toDb('Message',
|
||||||
|
'info'|'warn'|'error')`.
|
||||||
|
|
||||||
|
## Exceptions (Tightly Scoped)
|
||||||
|
|
||||||
|
Allowed paths (still prefer logger):
|
||||||
|
|
||||||
|
- `**/*.test.*`, `**/*.spec.*`
|
||||||
|
- `scripts/dev/**`, `scripts/migrate/**`
|
||||||
|
|
||||||
|
To intentionally keep `console.*`, add a pragma on the previous line:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// cursor:allow-console reason="short justification"
|
||||||
|
console.log('temporary output');
|
||||||
|
```
|
||||||
|
|
||||||
|
Without the pragma, rewrite to `logger.*`.
|
||||||
|
|
||||||
|
## CI & Diff Enforcement
|
||||||
|
|
||||||
|
- Do not introduce `console.*` anywhere outside allowed, pragma'd spots.
|
||||||
|
- If an import is missing, insert it and resolve alias/relative path
|
||||||
|
correctly.
|
||||||
|
- Enforce rest-parameter call shape in reviews; replace object-wrapped
|
||||||
|
context.
|
||||||
|
- Ensure environment log level rules remain intact (`VITE_LOG_LEVEL`
|
||||||
|
respected).
|
||||||
|
|
||||||
|
## Quick Before/After
|
||||||
|
|
||||||
|
### **Before**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log('User signed in', user.id, meta);
|
||||||
|
console.error('Failed to update profile', err);
|
||||||
|
console.info('Filter toggled', this.hasVisibleDid);
|
||||||
|
```
|
||||||
|
|
||||||
|
### **After**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { logger } from '@/utils/logger';
|
||||||
|
|
||||||
|
logger.info('User signed in', user.id, meta);
|
||||||
|
logger.error('Failed to update profile', err);
|
||||||
|
logger.debug('[FeedFilters] Filter toggled', this.hasVisibleDid);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checklist (for every PR)
|
||||||
|
|
||||||
|
- [ ] No `console.*` (or properly pragma'd in the allowed locations)
|
||||||
|
- [ ] Correct import path for `logger`
|
||||||
|
- [ ] Rest-parameter call shape (`message, ...args`)
|
||||||
|
- [ ] Right level chosen (debug/info/warn/error)
|
||||||
|
- [ ] No secrets / oversized payloads / throwaway context objects
|
||||||
|
- [ ] Component context provided (scoped logger or `[Component]` prefix)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active and enforced
|
||||||
|
**Priority**: Critical
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: TimeSafari logger utility
|
||||||
|
**Stakeholders**: Development team, Code review team
|
||||||
356
.cursor/rules/playwright-test-investigation.mdc
Normal file
356
.cursor/rules/playwright-test-investigation.mdc
Normal file
@@ -0,0 +1,356 @@
|
|||||||
|
---
|
||||||
|
description: when working with playwright tests either generating them or using them to test code
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
# Playwright Test Investigation — Harbor Pilot Directive
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-21T14:22Z
|
||||||
|
**Status**: 🎯 **ACTIVE** - Playwright test debugging guidelines
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
Provide systematic approach for investigating Playwright test failures with focus on UI element conflicts, timing issues, and selector ambiguity.
|
||||||
|
|
||||||
|
## Context & Scope
|
||||||
|
- **Audience**: Developers debugging Playwright test failures
|
||||||
|
- **In scope**: Test failure analysis, selector conflicts, UI state investigation, timing issues
|
||||||
|
- **Out of scope**: Test writing best practices, CI/CD configuration
|
||||||
|
|
||||||
|
## Artifacts & Links
|
||||||
|
- Test results: `test-results/` directory
|
||||||
|
- Error context: `error-context.md` files with page snapshots
|
||||||
|
- Trace files: `trace.zip` files for failed tests
|
||||||
|
- HTML reports: Interactive test reports with screenshots
|
||||||
|
|
||||||
|
## Environment & Preconditions
|
||||||
|
- OS/Runtime: Linux/Windows/macOS with Node.js
|
||||||
|
- Versions: Playwright test framework, browser drivers
|
||||||
|
- Services: Local test server (localhost:8080), test data setup
|
||||||
|
- Auth mode: None required for test investigation
|
||||||
|
|
||||||
|
## Architecture / Process Overview
|
||||||
|
Playwright test investigation follows a systematic diagnostic workflow that leverages built-in debugging tools and error context analysis.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TD
|
||||||
|
A[Test Failure] --> B[Check Error Context]
|
||||||
|
B --> C[Analyze Page Snapshot]
|
||||||
|
C --> D[Identify UI Conflicts]
|
||||||
|
D --> E[Check Trace Files]
|
||||||
|
E --> F[Verify Selector Uniqueness]
|
||||||
|
F --> G[Test Selector Fixes]
|
||||||
|
G --> H[Document Root Cause]
|
||||||
|
|
||||||
|
B --> I[Check Test Results Directory]
|
||||||
|
I --> J[Locate Failed Test Results]
|
||||||
|
J --> K[Extract Error Details]
|
||||||
|
|
||||||
|
D --> L[Multiple Alerts?]
|
||||||
|
L --> M[Button Text Conflicts?]
|
||||||
|
M --> N[Timing Issues?]
|
||||||
|
|
||||||
|
E --> O[Use Trace Viewer]
|
||||||
|
O --> P[Analyze Action Sequence]
|
||||||
|
P --> Q[Identify Failure Point]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Interfaces & Contracts
|
||||||
|
|
||||||
|
### Test Results Structure
|
||||||
|
| Component | Format | Content | Validation |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Error Context | Markdown | Page snapshot in YAML | Verify DOM state matches test expectations |
|
||||||
|
| Trace Files | ZIP archive | Detailed execution trace | Use `npx playwright show-trace` |
|
||||||
|
| HTML Reports | Interactive HTML | Screenshots, traces, logs | Check browser for full report |
|
||||||
|
| JSON Results | JSON | Machine-readable results | Parse for automated analysis |
|
||||||
|
|
||||||
|
### Investigation Commands
|
||||||
|
| Step | Command | Expected Output | Notes |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Locate failed tests | `find test-results -name "*test-name*"` | Test result directories | Use exact test name patterns |
|
||||||
|
| Check error context | `cat test-results/*/error-context.md` | Page snapshots | Look for UI state conflicts |
|
||||||
|
| View traces | `npx playwright show-trace trace.zip` | Interactive trace viewer | Analyze exact failure sequence |
|
||||||
|
|
||||||
|
## Repro: End-to-End Investigation Procedure
|
||||||
|
|
||||||
|
### 1. Locate Failed Test Results
|
||||||
|
```bash
|
||||||
|
# Find all results for a specific test
|
||||||
|
find test-results -name "*test-name*" -type d
|
||||||
|
|
||||||
|
# Check for error context files
|
||||||
|
find test-results -name "error-context.md" | head -5
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Analyze Error Context
|
||||||
|
```bash
|
||||||
|
# Read error context for specific test
|
||||||
|
cat test-results/test-name-test-description-browser/error-context.md
|
||||||
|
|
||||||
|
# Look for UI conflicts in page snapshot
|
||||||
|
grep -A 10 -B 5 "button.*Yes\|button.*No" test-results/*/error-context.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Check Trace Files
|
||||||
|
```bash
|
||||||
|
# List available trace files
|
||||||
|
find test-results -name "*.zip" | grep trace
|
||||||
|
|
||||||
|
# View trace in browser
|
||||||
|
npx playwright show-trace test-results/test-name/trace.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Investigate Selector Issues
|
||||||
|
```typescript
|
||||||
|
// Check for multiple elements with same text
|
||||||
|
await page.locator('button:has-text("Yes")').count(); // Should be 1
|
||||||
|
|
||||||
|
// Use more specific selectors
|
||||||
|
await page.locator('div[role="alert"]:has-text("Register") button:has-text("Yes")').click();
|
||||||
|
```
|
||||||
|
|
||||||
|
## What Works (Evidence)
|
||||||
|
- ✅ **Error context files** provide page snapshots showing exact DOM state at failure
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `test-results/60-new-activity-New-offers-for-another-user-chromium/error-context.md` shows both alerts visible
|
||||||
|
- **Verify at**: Error context files in test results directory
|
||||||
|
|
||||||
|
- ✅ **Trace files** capture detailed execution sequence for failed tests
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `trace.zip` files available for all failed tests
|
||||||
|
- **Verify at**: Use `npx playwright show-trace <filename>`
|
||||||
|
|
||||||
|
- ✅ **Page snapshots** reveal UI conflicts like multiple alerts with duplicate button text
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: YAML snapshots show registration + export alerts simultaneously
|
||||||
|
- **Verify at**: Error context markdown files
|
||||||
|
|
||||||
|
## What Doesn't (Evidence & Hypotheses)
|
||||||
|
- ❌ **Generic selectors** fail with multiple similar elements at `test-playwright/testUtils.ts:161`
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `button:has-text("Yes")` matches both "Yes" and "Yes, Export Data"
|
||||||
|
- **Hypothesis**: Selector ambiguity due to multiple alerts with conflicting button text
|
||||||
|
- **Next probe**: Use more specific selectors or dismiss alerts sequentially
|
||||||
|
|
||||||
|
- ❌ **Timing-dependent tests** fail due to alert stacking at `src/views/ContactsView.vue:860,1283`
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: Both alerts use identical 1000ms delays, ensuring simultaneous display
|
||||||
|
- **Hypothesis**: Race condition between alert displays creates UI conflicts
|
||||||
|
- **Next probe**: Implement alert queuing or prevent overlapping alerts
|
||||||
|
|
||||||
|
## Risks, Limits, Assumptions
|
||||||
|
- **Trace file size**: Large trace files may impact storage and analysis time
|
||||||
|
- **Browser compatibility**: Trace viewer requires specific browser support
|
||||||
|
- **Test isolation**: Shared state between tests may affect investigation results
|
||||||
|
- **Timing sensitivity**: Tests may pass/fail based on system performance
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
| Owner | Task | Exit Criteria | Target Date (UTC) |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Development Team | Fix test selectors for multiple alerts | All tests pass consistently | 2025-08-22 |
|
||||||
|
| Development Team | Implement alert queuing system | No overlapping alerts with conflicting buttons | 2025-08-25 |
|
||||||
|
| Development Team | Add test IDs to alert buttons | Unique selectors for all UI elements | 2025-08-28 |
|
||||||
|
|
||||||
|
## References
|
||||||
|
- [Playwright Trace Viewer Documentation](https://playwright.dev/docs/trace-viewer)
|
||||||
|
- [Playwright Test Results](https://playwright.dev/docs/test-reporters)
|
||||||
|
- [Test Investigation Workflow](./research_diagnostic.mdc)
|
||||||
|
|
||||||
|
## Competence Hooks
|
||||||
|
- **Why this works**: Systematic investigation leverages Playwright's built-in debugging tools to identify root causes
|
||||||
|
- **Common pitfalls**: Generic selectors fail with multiple similar elements; timing issues create race conditions; alert stacking causes UI conflicts
|
||||||
|
- **Next skill unlock**: Implement unique test IDs and handle alert dismissal order in test flows
|
||||||
|
- **Teach-back**: "How would you investigate a Playwright test failure using error context, trace files, and page snapshots?"
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
- **Reviewers**: QA team, test automation engineers
|
||||||
|
- **Sign-off checklist**: Error context analyzed, trace files reviewed, root cause identified, fix implemented and tested
|
||||||
|
|
||||||
|
## Assumptions & Limits
|
||||||
|
- Test results directory structure follows Playwright conventions
|
||||||
|
- Trace files are enabled in configuration (`trace: "retain-on-failure"`)
|
||||||
|
- Error context files contain valid YAML page snapshots
|
||||||
|
- Browser environment supports trace viewer functionality
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active investigation directive
|
||||||
|
**Priority**: High
|
||||||
|
**Maintainer**: Development team
|
||||||
|
**Next Review**: 2025-09-21
|
||||||
|
# Playwright Test Investigation — Harbor Pilot Directive
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-21T14:22Z
|
||||||
|
**Status**: 🎯 **ACTIVE** - Playwright test debugging guidelines
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
Provide systematic approach for investigating Playwright test failures with focus on UI element conflicts, timing issues, and selector ambiguity.
|
||||||
|
|
||||||
|
## Context & Scope
|
||||||
|
- **Audience**: Developers debugging Playwright test failures
|
||||||
|
- **In scope**: Test failure analysis, selector conflicts, UI state investigation, timing issues
|
||||||
|
- **Out of scope**: Test writing best practices, CI/CD configuration
|
||||||
|
|
||||||
|
## Artifacts & Links
|
||||||
|
- Test results: `test-results/` directory
|
||||||
|
- Error context: `error-context.md` files with page snapshots
|
||||||
|
- Trace files: `trace.zip` files for failed tests
|
||||||
|
- HTML reports: Interactive test reports with screenshots
|
||||||
|
|
||||||
|
## Environment & Preconditions
|
||||||
|
- OS/Runtime: Linux/Windows/macOS with Node.js
|
||||||
|
- Versions: Playwright test framework, browser drivers
|
||||||
|
- Services: Local test server (localhost:8080), test data setup
|
||||||
|
- Auth mode: None required for test investigation
|
||||||
|
|
||||||
|
## Architecture / Process Overview
|
||||||
|
Playwright test investigation follows a systematic diagnostic workflow that leverages built-in debugging tools and error context analysis.
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
flowchart TD
|
||||||
|
A[Test Failure] --> B[Check Error Context]
|
||||||
|
B --> C[Analyze Page Snapshot]
|
||||||
|
C --> D[Identify UI Conflicts]
|
||||||
|
D --> E[Check Trace Files]
|
||||||
|
E --> F[Verify Selector Uniqueness]
|
||||||
|
F --> G[Test Selector Fixes]
|
||||||
|
G --> H[Document Root Cause]
|
||||||
|
|
||||||
|
B --> I[Check Test Results Directory]
|
||||||
|
I --> J[Locate Failed Test Results]
|
||||||
|
J --> K[Extract Error Details]
|
||||||
|
|
||||||
|
D --> L[Multiple Alerts?]
|
||||||
|
L --> M[Button Text Conflicts?]
|
||||||
|
M --> N[Timing Issues?]
|
||||||
|
|
||||||
|
E --> O[Use Trace Viewer]
|
||||||
|
O --> P[Analyze Action Sequence]
|
||||||
|
P --> Q[Identify Failure Point]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Interfaces & Contracts
|
||||||
|
|
||||||
|
### Test Results Structure
|
||||||
|
| Component | Format | Content | Validation |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Error Context | Markdown | Page snapshot in YAML | Verify DOM state matches test expectations |
|
||||||
|
| Trace Files | ZIP archive | Detailed execution trace | Use `npx playwright show-trace` |
|
||||||
|
| HTML Reports | Interactive HTML | Screenshots, traces, logs | Check browser for full report |
|
||||||
|
| JSON Results | JSON | Machine-readable results | Parse for automated analysis |
|
||||||
|
|
||||||
|
### Investigation Commands
|
||||||
|
| Step | Command | Expected Output | Notes |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Locate failed tests | `find test-results -name "*test-name*"` | Test result directories | Use exact test name patterns |
|
||||||
|
| Check error context | `cat test-results/*/error-context.md` | Page snapshots | Look for UI state conflicts |
|
||||||
|
| View traces | `npx playwright show-trace trace.zip` | Interactive trace viewer | Analyze exact failure sequence |
|
||||||
|
|
||||||
|
## Repro: End-to-End Investigation Procedure
|
||||||
|
|
||||||
|
### 1. Locate Failed Test Results
|
||||||
|
```bash
|
||||||
|
# Find all results for a specific test
|
||||||
|
find test-results -name "*test-name*" -type d
|
||||||
|
|
||||||
|
# Check for error context files
|
||||||
|
find test-results -name "error-context.md" | head -5
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Analyze Error Context
|
||||||
|
```bash
|
||||||
|
# Read error context for specific test
|
||||||
|
cat test-results/test-name-test-description-browser/error-context.md
|
||||||
|
|
||||||
|
# Look for UI conflicts in page snapshot
|
||||||
|
grep -A 10 -B 5 "button.*Yes\|button.*No" test-results/*/error-context.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Check Trace Files
|
||||||
|
```bash
|
||||||
|
# List available trace files
|
||||||
|
find test-results -name "*.zip" | grep trace
|
||||||
|
|
||||||
|
# View trace in browser
|
||||||
|
npx playwright show-trace test-results/test-name/trace.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Investigate Selector Issues
|
||||||
|
```typescript
|
||||||
|
// Check for multiple elements with same text
|
||||||
|
await page.locator('button:has-text("Yes")').count(); // Should be 1
|
||||||
|
|
||||||
|
// Use more specific selectors
|
||||||
|
await page.locator('div[role="alert"]:has-text("Register") button:has-text("Yes")').click();
|
||||||
|
```
|
||||||
|
|
||||||
|
## What Works (Evidence)
|
||||||
|
- ✅ **Error context files** provide page snapshots showing exact DOM state at failure
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `test-results/60-new-activity-New-offers-for-another-user-chromium/error-context.md` shows both alerts visible
|
||||||
|
- **Verify at**: Error context files in test results directory
|
||||||
|
|
||||||
|
- ✅ **Trace files** capture detailed execution sequence for failed tests
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `trace.zip` files available for all failed tests
|
||||||
|
- **Verify at**: Use `npx playwright show-trace <filename>`
|
||||||
|
|
||||||
|
- ✅ **Page snapshots** reveal UI conflicts like multiple alerts with duplicate button text
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: YAML snapshots show registration + export alerts simultaneously
|
||||||
|
- **Verify at**: Error context markdown files
|
||||||
|
|
||||||
|
## What Doesn't (Evidence & Hypotheses)
|
||||||
|
- ❌ **Generic selectors** fail with multiple similar elements at `test-playwright/testUtils.ts:161`
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: `button:has-text("Yes")` matches both "Yes" and "Yes, Export Data"
|
||||||
|
- **Hypothesis**: Selector ambiguity due to multiple alerts with conflicting button text
|
||||||
|
- **Next probe**: Use more specific selectors or dismiss alerts sequentially
|
||||||
|
|
||||||
|
- ❌ **Timing-dependent tests** fail due to alert stacking at `src/views/ContactsView.vue:860,1283`
|
||||||
|
- **Time**: 2025-08-21T14:22Z
|
||||||
|
- **Evidence**: Both alerts use identical 1000ms delays, ensuring simultaneous display
|
||||||
|
- **Hypothesis**: Race condition between alert displays creates UI conflicts
|
||||||
|
- **Next probe**: Implement alert queuing or prevent overlapping alerts
|
||||||
|
|
||||||
|
## Risks, Limits, Assumptions
|
||||||
|
- **Trace file size**: Large trace files may impact storage and analysis time
|
||||||
|
- **Browser compatibility**: Trace viewer requires specific browser support
|
||||||
|
- **Test isolation**: Shared state between tests may affect investigation results
|
||||||
|
- **Timing sensitivity**: Tests may pass/fail based on system performance
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
| Owner | Task | Exit Criteria | Target Date (UTC) |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Development Team | Fix test selectors for multiple alerts | All tests pass consistently | 2025-08-22 |
|
||||||
|
| Development Team | Implement alert queuing system | No overlapping alerts with conflicting buttons | 2025-08-25 |
|
||||||
|
| Development Team | Add test IDs to alert buttons | Unique selectors for all UI elements | 2025-08-28 |
|
||||||
|
|
||||||
|
## References
|
||||||
|
- [Playwright Trace Viewer Documentation](https://playwright.dev/docs/trace-viewer)
|
||||||
|
- [Playwright Test Results](https://playwright.dev/docs/test-reporters)
|
||||||
|
- [Test Investigation Workflow](./research_diagnostic.mdc)
|
||||||
|
|
||||||
|
## Competence Hooks
|
||||||
|
- **Why this works**: Systematic investigation leverages Playwright's built-in debugging tools to identify root causes
|
||||||
|
- **Common pitfalls**: Generic selectors fail with multiple similar elements; timing issues create race conditions; alert stacking causes UI conflicts
|
||||||
|
- **Next skill unlock**: Implement unique test IDs and handle alert dismissal order in test flows
|
||||||
|
- **Teach-back**: "How would you investigate a Playwright test failure using error context, trace files, and page snapshots?"
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
- **Reviewers**: QA team, test automation engineers
|
||||||
|
- **Sign-off checklist**: Error context analyzed, trace files reviewed, root cause identified, fix implemented and tested
|
||||||
|
|
||||||
|
## Assumptions & Limits
|
||||||
|
- Test results directory structure follows Playwright conventions
|
||||||
|
- Trace files are enabled in configuration (`trace: "retain-on-failure"`)
|
||||||
|
- Error context files contain valid YAML page snapshots
|
||||||
|
- Browser environment supports trace viewer functionality
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active investigation directive
|
||||||
|
**Priority**: High
|
||||||
|
**Maintainer**: Development team
|
||||||
|
**Next Review**: 2025-09-21
|
||||||
348
.cursor/rules/realistic_time_estimation.mdc
Normal file
348
.cursor/rules/realistic_time_estimation.mdc
Normal file
@@ -0,0 +1,348 @@
|
|||||||
|
---
|
||||||
|
description: when generating text that has project task work estimates
|
||||||
|
alwaysApply: false
|
||||||
|
---
|
||||||
|
# No Time Estimates — Harbor Pilot Directive
|
||||||
|
|
||||||
|
> **Agent role**: **DO NOT MAKE TIME ESTIMATES**. Instead, use phases, milestones, and complexity levels. Time estimates are consistently wrong and create unrealistic expectations.
|
||||||
|
|
||||||
|
## 🎯 Purpose
|
||||||
|
|
||||||
|
Development time estimates are consistently wrong and create unrealistic expectations. This rule ensures we focus on phases, milestones, and complexity rather than trying to predict specific timeframes.
|
||||||
|
|
||||||
|
## 🚨 Critical Rule
|
||||||
|
|
||||||
|
**DO NOT MAKE TIME ESTIMATES**
|
||||||
|
- **Never provide specific time estimates** - they are always wrong
|
||||||
|
- **Use phases and milestones** instead of days/weeks
|
||||||
|
- **Focus on complexity and dependencies** rather than time
|
||||||
|
- **Set expectations based on progress, not deadlines**
|
||||||
|
|
||||||
|
## 📊 Planning Framework (Not Time Estimates)
|
||||||
|
|
||||||
|
### **Complexity Categories**
|
||||||
|
- **Simple**: Text changes, styling updates, minor bug fixes
|
||||||
|
- **Medium**: New features, refactoring, component updates
|
||||||
|
- **Complex**: Architecture changes, integrations, cross-platform work
|
||||||
|
- **Unknown**: New technologies, APIs, or approaches
|
||||||
|
|
||||||
|
### **Platform Complexity**
|
||||||
|
- **Single platform**: Web-only or mobile-only changes
|
||||||
|
- **Two platforms**: Web + mobile or web + desktop
|
||||||
|
- **Three platforms**: Web + mobile + desktop
|
||||||
|
- **Cross-platform consistency**: Ensuring behavior matches across all platforms
|
||||||
|
|
||||||
|
### **Testing Complexity**
|
||||||
|
- **Basic**: Unit tests for new functionality
|
||||||
|
- **Comprehensive**: Integration tests, cross-platform testing
|
||||||
|
- **User acceptance**: User testing, feedback integration
|
||||||
|
|
||||||
|
## 🔍 Planning Process (No Time Estimates)
|
||||||
|
|
||||||
|
### **Step 1: Break Down the Work**
|
||||||
|
- Identify all subtasks and dependencies
|
||||||
|
- Group related work into logical phases
|
||||||
|
- Identify critical path and blockers
|
||||||
|
|
||||||
|
### **Step 2: Define Phases and Milestones**
|
||||||
|
- **Phase 1**: Foundation work (basic fixes, core functionality)
|
||||||
|
- **Phase 2**: Enhancement work (new features, integrations)
|
||||||
|
- **Phase 3**: Polish work (testing, user experience, edge cases)
|
||||||
|
|
||||||
|
### **Step 3: Identify Dependencies**
|
||||||
|
- **Technical dependencies**: What must be built first
|
||||||
|
- **Platform dependencies**: What works on which platforms
|
||||||
|
- **Testing dependencies**: What can be tested when
|
||||||
|
|
||||||
|
### **Step 4: Set Progress Milestones**
|
||||||
|
- **Milestone 1**: Basic functionality working
|
||||||
|
- **Milestone 2**: All platforms supported
|
||||||
|
- **Milestone 3**: Fully tested and polished
|
||||||
|
|
||||||
|
## 📋 Planning Checklist (No Time Estimates)
|
||||||
|
|
||||||
|
- [ ] Work broken down into logical phases
|
||||||
|
- [ ] Dependencies identified and mapped
|
||||||
|
- [ ] Milestones defined with clear criteria
|
||||||
|
- [ ] Complexity levels assigned to each phase
|
||||||
|
- [ ] Platform requirements identified
|
||||||
|
- [ ] Testing strategy planned
|
||||||
|
- [ ] Risk factors identified
|
||||||
|
- [ ] Success criteria defined
|
||||||
|
|
||||||
|
## 🎯 Example Planning (No Time Estimates)
|
||||||
|
|
||||||
|
### **Example 1: Simple Feature**
|
||||||
|
```
|
||||||
|
Phase 1: Core implementation
|
||||||
|
- Basic functionality
|
||||||
|
- Single platform support
|
||||||
|
- Unit tests
|
||||||
|
|
||||||
|
Phase 2: Platform expansion
|
||||||
|
- Multi-platform support
|
||||||
|
- Integration tests
|
||||||
|
|
||||||
|
Phase 3: Polish
|
||||||
|
- User testing
|
||||||
|
- Edge case handling
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Example 2: Complex Cross-Platform Feature**
|
||||||
|
```
|
||||||
|
Phase 1: Foundation
|
||||||
|
- Architecture design
|
||||||
|
- Core service implementation
|
||||||
|
- Basic web platform support
|
||||||
|
|
||||||
|
Phase 2: Platform Integration
|
||||||
|
- Mobile platform support
|
||||||
|
- Desktop platform support
|
||||||
|
- Cross-platform consistency
|
||||||
|
|
||||||
|
Phase 3: Testing & Polish
|
||||||
|
- Comprehensive testing
|
||||||
|
- Error handling
|
||||||
|
- User experience refinement
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚫 Anti-Patterns to Avoid
|
||||||
|
|
||||||
|
- **"This should take X days"** - Red flag for time estimation
|
||||||
|
- **"Just a few hours"** - Ignores complexity and testing
|
||||||
|
- **"Similar to X"** - Without considering differences
|
||||||
|
- **"Quick fix"** - Nothing is ever quick in software
|
||||||
|
- **"No testing needed"** - Testing always takes effort
|
||||||
|
|
||||||
|
## ✅ Best Practices
|
||||||
|
|
||||||
|
### **When Planning:**
|
||||||
|
1. **Break down everything** - no work is too small to plan
|
||||||
|
2. **Consider all platforms** - web, mobile, desktop differences
|
||||||
|
3. **Include testing strategy** - unit, integration, and user testing
|
||||||
|
4. **Account for unknowns** - there are always surprises
|
||||||
|
5. **Focus on dependencies** - what blocks what
|
||||||
|
|
||||||
|
### **When Presenting Plans:**
|
||||||
|
1. **Show the phases** - explain the logical progression
|
||||||
|
2. **Highlight dependencies** - what could block progress
|
||||||
|
3. **Define milestones** - clear success criteria
|
||||||
|
4. **Identify risks** - what could go wrong
|
||||||
|
5. **Suggest alternatives** - ways to reduce scope or complexity
|
||||||
|
|
||||||
|
## 🔄 Continuous Improvement
|
||||||
|
|
||||||
|
### **Track Progress**
|
||||||
|
- Record planned vs. actual phases completed
|
||||||
|
- Identify what took longer than expected
|
||||||
|
- Learn from complexity misjudgments
|
||||||
|
- Adjust planning process based on experience
|
||||||
|
|
||||||
|
### **Learn from Experience**
|
||||||
|
- **Underestimated complexity**: Increase complexity categories
|
||||||
|
- **Missed dependencies**: Improve dependency mapping
|
||||||
|
- **Platform surprises**: Better platform research upfront
|
||||||
|
|
||||||
|
## 🎯 Integration with Harbor Pilot
|
||||||
|
|
||||||
|
This rule works in conjunction with:
|
||||||
|
- **Project Planning**: Focuses on phases and milestones
|
||||||
|
- **Resource Allocation**: Based on complexity, not time
|
||||||
|
- **Risk Management**: Identifies blockers and dependencies
|
||||||
|
- **Stakeholder Communication**: Sets progress-based expectations
|
||||||
|
|
||||||
|
## 📝 Version History
|
||||||
|
|
||||||
|
### v2.0.0 (2025-08-21)
|
||||||
|
- **Major Change**: Completely removed time estimation approach
|
||||||
|
- **New Focus**: Phases, milestones, and complexity-based planning
|
||||||
|
- **Eliminated**: All time multipliers, estimates, and calculations
|
||||||
|
- **Added**: Dependency mapping and progress milestone framework
|
||||||
|
|
||||||
|
### v1.0.0 (2025-08-21)
|
||||||
|
- Initial creation based on user feedback about estimation accuracy
|
||||||
|
- ~~Established realistic estimation multipliers and process~~
|
||||||
|
- ~~Added comprehensive estimation checklist and examples~~
|
||||||
|
- Integrated with Harbor Pilot planning and risk management
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚨 Remember
|
||||||
|
|
||||||
|
**DO NOT MAKE TIME ESTIMATES. Use phases, milestones, and complexity instead. Focus on progress, not deadlines.**
|
||||||
|
|
||||||
|
## 🚨 Remember
|
||||||
|
|
||||||
|
**Your first estimate is wrong. Your second estimate is probably still wrong. Focus on progress, not deadlines.**
|
||||||
|
# No Time Estimates — Harbor Pilot Directive
|
||||||
|
|
||||||
|
> **Agent role**: **DO NOT MAKE TIME ESTIMATES**. Instead, use phases, milestones, and complexity levels. Time estimates are consistently wrong and create unrealistic expectations.
|
||||||
|
|
||||||
|
## 🎯 Purpose
|
||||||
|
|
||||||
|
Development time estimates are consistently wrong and create unrealistic expectations. This rule ensures we focus on phases, milestones, and complexity rather than trying to predict specific timeframes.
|
||||||
|
|
||||||
|
## 🚨 Critical Rule
|
||||||
|
|
||||||
|
**DO NOT MAKE TIME ESTIMATES**
|
||||||
|
- **Never provide specific time estimates** - they are always wrong
|
||||||
|
- **Use phases and milestones** instead of days/weeks
|
||||||
|
- **Focus on complexity and dependencies** rather than time
|
||||||
|
- **Set expectations based on progress, not deadlines**
|
||||||
|
|
||||||
|
## 📊 Planning Framework (Not Time Estimates)
|
||||||
|
|
||||||
|
### **Complexity Categories**
|
||||||
|
- **Simple**: Text changes, styling updates, minor bug fixes
|
||||||
|
- **Medium**: New features, refactoring, component updates
|
||||||
|
- **Complex**: Architecture changes, integrations, cross-platform work
|
||||||
|
- **Unknown**: New technologies, APIs, or approaches
|
||||||
|
|
||||||
|
### **Platform Complexity**
|
||||||
|
- **Single platform**: Web-only or mobile-only changes
|
||||||
|
- **Two platforms**: Web + mobile or web + desktop
|
||||||
|
- **Three platforms**: Web + mobile + desktop
|
||||||
|
- **Cross-platform consistency**: Ensuring behavior matches across all platforms
|
||||||
|
|
||||||
|
### **Testing Complexity**
|
||||||
|
- **Basic**: Unit tests for new functionality
|
||||||
|
- **Comprehensive**: Integration tests, cross-platform testing
|
||||||
|
- **User acceptance**: User testing, feedback integration
|
||||||
|
|
||||||
|
## 🔍 Planning Process (No Time Estimates)
|
||||||
|
|
||||||
|
### **Step 1: Break Down the Work**
|
||||||
|
- Identify all subtasks and dependencies
|
||||||
|
- Group related work into logical phases
|
||||||
|
- Identify critical path and blockers
|
||||||
|
|
||||||
|
### **Step 2: Define Phases and Milestones**
|
||||||
|
- **Phase 1**: Foundation work (basic fixes, core functionality)
|
||||||
|
- **Phase 2**: Enhancement work (new features, integrations)
|
||||||
|
- **Phase 3**: Polish work (testing, user experience, edge cases)
|
||||||
|
|
||||||
|
### **Step 3: Identify Dependencies**
|
||||||
|
- **Technical dependencies**: What must be built first
|
||||||
|
- **Platform dependencies**: What works on which platforms
|
||||||
|
- **Testing dependencies**: What can be tested when
|
||||||
|
|
||||||
|
### **Step 4: Set Progress Milestones**
|
||||||
|
- **Milestone 1**: Basic functionality working
|
||||||
|
- **Milestone 2**: All platforms supported
|
||||||
|
- **Milestone 3**: Fully tested and polished
|
||||||
|
|
||||||
|
## 📋 Planning Checklist (No Time Estimates)
|
||||||
|
|
||||||
|
- [ ] Work broken down into logical phases
|
||||||
|
- [ ] Dependencies identified and mapped
|
||||||
|
- [ ] Milestones defined with clear criteria
|
||||||
|
- [ ] Complexity levels assigned to each phase
|
||||||
|
- [ ] Platform requirements identified
|
||||||
|
- [ ] Testing strategy planned
|
||||||
|
- [ ] Risk factors identified
|
||||||
|
- [ ] Success criteria defined
|
||||||
|
|
||||||
|
## 🎯 Example Planning (No Time Estimates)
|
||||||
|
|
||||||
|
### **Example 1: Simple Feature**
|
||||||
|
```
|
||||||
|
Phase 1: Core implementation
|
||||||
|
- Basic functionality
|
||||||
|
- Single platform support
|
||||||
|
- Unit tests
|
||||||
|
|
||||||
|
Phase 2: Platform expansion
|
||||||
|
- Multi-platform support
|
||||||
|
- Integration tests
|
||||||
|
|
||||||
|
Phase 3: Polish
|
||||||
|
- User testing
|
||||||
|
- Edge case handling
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Example 2: Complex Cross-Platform Feature**
|
||||||
|
```
|
||||||
|
Phase 1: Foundation
|
||||||
|
- Architecture design
|
||||||
|
- Core service implementation
|
||||||
|
- Basic web platform support
|
||||||
|
|
||||||
|
Phase 2: Platform Integration
|
||||||
|
- Mobile platform support
|
||||||
|
- Desktop platform support
|
||||||
|
- Cross-platform consistency
|
||||||
|
|
||||||
|
Phase 3: Testing & Polish
|
||||||
|
- Comprehensive testing
|
||||||
|
- Error handling
|
||||||
|
- User experience refinement
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚫 Anti-Patterns to Avoid
|
||||||
|
|
||||||
|
- **"This should take X days"** - Red flag for time estimation
|
||||||
|
- **"Just a few hours"** - Ignores complexity and testing
|
||||||
|
- **"Similar to X"** - Without considering differences
|
||||||
|
- **"Quick fix"** - Nothing is ever quick in software
|
||||||
|
- **"No testing needed"** - Testing always takes effort
|
||||||
|
|
||||||
|
## ✅ Best Practices
|
||||||
|
|
||||||
|
### **When Planning:**
|
||||||
|
1. **Break down everything** - no work is too small to plan
|
||||||
|
2. **Consider all platforms** - web, mobile, desktop differences
|
||||||
|
3. **Include testing strategy** - unit, integration, and user testing
|
||||||
|
4. **Account for unknowns** - there are always surprises
|
||||||
|
5. **Focus on dependencies** - what blocks what
|
||||||
|
|
||||||
|
### **When Presenting Plans:**
|
||||||
|
1. **Show the phases** - explain the logical progression
|
||||||
|
2. **Highlight dependencies** - what could block progress
|
||||||
|
3. **Define milestones** - clear success criteria
|
||||||
|
4. **Identify risks** - what could go wrong
|
||||||
|
5. **Suggest alternatives** - ways to reduce scope or complexity
|
||||||
|
|
||||||
|
## 🔄 Continuous Improvement
|
||||||
|
|
||||||
|
### **Track Progress**
|
||||||
|
- Record planned vs. actual phases completed
|
||||||
|
- Identify what took longer than expected
|
||||||
|
- Learn from complexity misjudgments
|
||||||
|
- Adjust planning process based on experience
|
||||||
|
|
||||||
|
### **Learn from Experience**
|
||||||
|
- **Underestimated complexity**: Increase complexity categories
|
||||||
|
- **Missed dependencies**: Improve dependency mapping
|
||||||
|
- **Platform surprises**: Better platform research upfront
|
||||||
|
|
||||||
|
## 🎯 Integration with Harbor Pilot
|
||||||
|
|
||||||
|
This rule works in conjunction with:
|
||||||
|
- **Project Planning**: Focuses on phases and milestones
|
||||||
|
- **Resource Allocation**: Based on complexity, not time
|
||||||
|
- **Risk Management**: Identifies blockers and dependencies
|
||||||
|
- **Stakeholder Communication**: Sets progress-based expectations
|
||||||
|
|
||||||
|
## 📝 Version History
|
||||||
|
|
||||||
|
### v2.0.0 (2025-08-21)
|
||||||
|
- **Major Change**: Completely removed time estimation approach
|
||||||
|
- **New Focus**: Phases, milestones, and complexity-based planning
|
||||||
|
- **Eliminated**: All time multipliers, estimates, and calculations
|
||||||
|
- **Added**: Dependency mapping and progress milestone framework
|
||||||
|
|
||||||
|
### v1.0.0 (2025-08-21)
|
||||||
|
- Initial creation based on user feedback about estimation accuracy
|
||||||
|
- ~~Established realistic estimation multipliers and process~~
|
||||||
|
- ~~Added comprehensive estimation checklist and examples~~
|
||||||
|
- Integrated with Harbor Pilot planning and risk management
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚨 Remember
|
||||||
|
|
||||||
|
**DO NOT MAKE TIME ESTIMATES. Use phases, milestones, and complexity instead. Focus on progress, not deadlines.**
|
||||||
|
|
||||||
|
## 🚨 Remember
|
||||||
|
|
||||||
|
**Your first estimate is wrong. Your second estimate is probably still wrong. Focus on progress, not deadlines.**
|
||||||
@@ -31,6 +31,7 @@ steps—**not** code changes.
|
|||||||
## Enhanced with Software Development Ruleset
|
## Enhanced with Software Development Ruleset
|
||||||
|
|
||||||
When investigating software issues, also apply:
|
When investigating software issues, also apply:
|
||||||
|
|
||||||
- **Code Path Tracing**: Required for technical investigations
|
- **Code Path Tracing**: Required for technical investigations
|
||||||
- **Evidence Validation**: Ensure claims are code-backed
|
- **Evidence Validation**: Ensure claims are code-backed
|
||||||
- **Solution Complexity Assessment**: Justify architectural changes
|
- **Solution Complexity Assessment**: Justify architectural changes
|
||||||
@@ -117,6 +118,7 @@ Copy/paste and fill:
|
|||||||
## Code Path Tracing (Required for Software Investigations)
|
## Code Path Tracing (Required for Software Investigations)
|
||||||
|
|
||||||
Before proposing solutions, trace the actual execution path:
|
Before proposing solutions, trace the actual execution path:
|
||||||
|
|
||||||
- [ ] **Entry Points**: Identify where the flow begins (user action, API call, etc.)
|
- [ ] **Entry Points**: Identify where the flow begins (user action, API call, etc.)
|
||||||
- [ ] **Component Flow**: Map which components/methods are involved
|
- [ ] **Component Flow**: Map which components/methods are involved
|
||||||
- [ ] **Data Path**: Track how data moves through the system
|
- [ ] **Data Path**: Track how data moves through the system
|
||||||
@@ -136,11 +138,13 @@ Before proposing solutions, trace the actual execution path:
|
|||||||
## Integration with Other Rulesets
|
## Integration with Other Rulesets
|
||||||
|
|
||||||
### With software_development.mdc
|
### With software_development.mdc
|
||||||
|
|
||||||
- **Enhanced Evidence Validation**: Use code path tracing for technical investigations
|
- **Enhanced Evidence Validation**: Use code path tracing for technical investigations
|
||||||
- **Architecture Assessment**: Apply complexity justification to proposed solutions
|
- **Architecture Assessment**: Apply complexity justification to proposed solutions
|
||||||
- **Impact Analysis**: Assess effects on existing systems before recommendations
|
- **Impact Analysis**: Assess effects on existing systems before recommendations
|
||||||
|
|
||||||
### With base_context.mdc
|
### With base_context.mdc
|
||||||
|
|
||||||
- **Competence Building**: Focus on technical investigation skills
|
- **Competence Building**: Focus on technical investigation skills
|
||||||
- **Collaboration**: Structure outputs for team review and discussion
|
- **Collaboration**: Structure outputs for team review and discussion
|
||||||
|
|
||||||
|
|||||||
@@ -1,69 +1,144 @@
|
|||||||
---
|
|
||||||
alwaysApply: true
|
|
||||||
---
|
|
||||||
|
|
||||||
# Software Development Ruleset
|
# Software Development Ruleset
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Core development guidelines
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
Specialized guidelines for software development tasks including code review, debugging, architecture decisions, and testing.
|
|
||||||
|
Specialized guidelines for software development tasks including code review,
|
||||||
|
debugging, architecture decisions, and testing.
|
||||||
|
|
||||||
## Core Principles
|
## Core Principles
|
||||||
|
|
||||||
### 1. Evidence-First Development
|
### 1. Evidence-First Development
|
||||||
- **Code Citations Required**: Always cite specific file:line references when making claims
|
|
||||||
- **Execution Path Tracing**: Trace actual code execution before proposing architectural changes
|
- **Code Citations Required**: Always cite specific file:line references when
|
||||||
|
making claims
|
||||||
|
- **Execution Path Tracing**: Trace actual code execution before proposing
|
||||||
|
architectural changes
|
||||||
- **Assumption Validation**: Flag assumptions as "assumed" vs "evidence-based"
|
- **Assumption Validation**: Flag assumptions as "assumed" vs "evidence-based"
|
||||||
|
|
||||||
### 2. Code Review Standards
|
### 2. Code Review Standards
|
||||||
- **Trace Before Proposing**: Always trace execution paths before suggesting changes
|
|
||||||
|
- **Trace Before Proposing**: Always trace execution paths before suggesting
|
||||||
|
changes
|
||||||
- **Evidence Over Inference**: Prefer code citations over logical deductions
|
- **Evidence Over Inference**: Prefer code citations over logical deductions
|
||||||
- **Scope Validation**: Confirm the actual scope of problems before proposing solutions
|
- **Scope Validation**: Confirm the actual scope of problems before proposing
|
||||||
|
solutions
|
||||||
|
|
||||||
### 3. Problem-Solution Validation
|
### 3. Problem-Solution Validation
|
||||||
|
|
||||||
- **Problem Scope**: Does the solution address the actual problem?
|
- **Problem Scope**: Does the solution address the actual problem?
|
||||||
- **Evidence Alignment**: Does the solution match the evidence?
|
- **Evidence Alignment**: Does the solution match the evidence?
|
||||||
- **Complexity Justification**: Is added complexity justified by real needs?
|
- **Complexity Justification**: Is added complexity justified by real needs?
|
||||||
- **Alternative Analysis**: What simpler solutions were considered?
|
- **Alternative Analysis**: What simpler solutions were considered?
|
||||||
|
|
||||||
|
### 4. Dependency Management & Environment Validation
|
||||||
|
|
||||||
|
- **Pre-build Validation**: Always validate critical dependencies before executing
|
||||||
|
build scripts
|
||||||
|
- **Environment Consistency**: Ensure team members have identical development
|
||||||
|
environments
|
||||||
|
- **Dependency Verification**: Check that required packages are installed and
|
||||||
|
accessible
|
||||||
|
- **Path Resolution**: Use `npx` for local dependencies to avoid PATH issues
|
||||||
|
|
||||||
## Required Workflows
|
## Required Workflows
|
||||||
|
|
||||||
### Before Proposing Changes
|
### Before Proposing Changes
|
||||||
|
|
||||||
- [ ] **Code Path Tracing**: Map execution flow from entry to exit
|
- [ ] **Code Path Tracing**: Map execution flow from entry to exit
|
||||||
- [ ] **Evidence Collection**: Gather specific code citations and logs
|
- [ ] **Evidence Collection**: Gather specific code citations and logs
|
||||||
- [ ] **Assumption Surfacing**: Identify what's proven vs. inferred
|
- [ ] **Assumption Surfacing**: Identify what's proven vs. inferred
|
||||||
- [ ] **Scope Validation**: Confirm the actual extent of the problem
|
- [ ] **Scope Validation**: Confirm the actual extent of the problem
|
||||||
|
- [ ] **Dependency Validation**: Verify all required dependencies are available
|
||||||
|
and accessible
|
||||||
|
|
||||||
### During Solution Design
|
### During Solution Design
|
||||||
|
|
||||||
- [ ] **Evidence Alignment**: Ensure solution addresses proven problems
|
- [ ] **Evidence Alignment**: Ensure solution addresses proven problems
|
||||||
- [ ] **Complexity Assessment**: Justify any added complexity
|
- [ ] **Complexity Assessment**: Justify any added complexity
|
||||||
- [ ] **Alternative Evaluation**: Consider simpler approaches first
|
- [ ] **Alternative Evaluation**: Consider simpler approaches first
|
||||||
- [ ] **Impact Analysis**: Assess effects on existing systems
|
- [ ] **Impact Analysis**: Assess effects on existing systems
|
||||||
|
- [ ] **Environment Impact**: Assess how changes affect team member setups
|
||||||
|
|
||||||
## Software-Specific Competence Hooks
|
## Software-Specific Competence Hooks
|
||||||
|
|
||||||
### Evidence Validation
|
### Evidence Validation
|
||||||
|
|
||||||
- **"What code path proves this claim?"**
|
- **"What code path proves this claim?"**
|
||||||
- **"How does data actually flow through the system?"**
|
- **"How does data actually flow through the system?"**
|
||||||
- **"What am I assuming vs. what can I prove?"**
|
- **"What am I assuming vs. what can I prove?"**
|
||||||
|
|
||||||
### Code Tracing
|
### Code Tracing
|
||||||
|
|
||||||
- **"What's the execution path from user action to system response?"**
|
- **"What's the execution path from user action to system response?"**
|
||||||
- **"Which components actually interact in this scenario?"**
|
- **"Which components actually interact in this scenario?"**
|
||||||
- **"Where does the data originate and where does it end up?"**
|
- **"Where does the data originate and where does it end up?"**
|
||||||
|
|
||||||
### Architecture Decisions
|
### Architecture Decisions
|
||||||
|
|
||||||
- **"What evidence shows this change is necessary?"**
|
- **"What evidence shows this change is necessary?"**
|
||||||
- **"What simpler solution could achieve the same goal?"**
|
- **"What simpler solution could achieve the same goal?"**
|
||||||
- **"How does this change affect the existing system architecture?"**
|
- **"How does this change affect the existing system architecture?"**
|
||||||
|
|
||||||
|
### Dependency & Environment Management
|
||||||
|
|
||||||
|
- **"What dependencies does this feature require and are they properly
|
||||||
|
declared?"**
|
||||||
|
- **"How will this change affect team member development environments?"**
|
||||||
|
- **"What validation can we add to catch dependency issues early?"**
|
||||||
|
|
||||||
|
## Dependency Management Best Practices
|
||||||
|
|
||||||
|
### Pre-build Validation
|
||||||
|
|
||||||
|
- **Check Critical Dependencies**: Validate essential tools before executing build
|
||||||
|
scripts
|
||||||
|
- **Use npx for Local Dependencies**: Prefer `npx tsx` over direct `tsx` to
|
||||||
|
avoid PATH issues
|
||||||
|
- **Environment Consistency**: Ensure all team members have identical dependency
|
||||||
|
versions
|
||||||
|
|
||||||
|
### Common Pitfalls
|
||||||
|
|
||||||
|
- **Missing npm install**: Team members cloning without running `npm install`
|
||||||
|
- **PATH Issues**: Direct command execution vs. npm script execution differences
|
||||||
|
- **Version Mismatches**: Different Node.js/npm versions across team members
|
||||||
|
|
||||||
|
### Validation Strategies
|
||||||
|
|
||||||
|
- **Dependency Check Scripts**: Implement pre-build validation for critical
|
||||||
|
dependencies
|
||||||
|
- **Environment Requirements**: Document and enforce minimum Node.js/npm versions
|
||||||
|
- **Onboarding Checklist**: Standardize team member setup procedures
|
||||||
|
|
||||||
|
### Error Messages and Guidance
|
||||||
|
|
||||||
|
- **Specific Error Context**: Provide clear guidance when dependency issues occur
|
||||||
|
- **Actionable Solutions**: Direct users to specific commands (`npm install`,
|
||||||
|
`npm run check:dependencies`)
|
||||||
|
- **Environment Diagnostics**: Implement comprehensive environment validation
|
||||||
|
tools
|
||||||
|
|
||||||
|
### Build Script Enhancements
|
||||||
|
|
||||||
|
- **Early Validation**: Check dependencies before starting build processes
|
||||||
|
- **Graceful Degradation**: Continue builds when possible but warn about issues
|
||||||
|
- **Helpful Tips**: Remind users about dependency management best practices
|
||||||
|
|
||||||
## Integration with Other Rulesets
|
## Integration with Other Rulesets
|
||||||
|
|
||||||
### With base_context.mdc
|
### With base_context.mdc
|
||||||
|
|
||||||
- Inherits generic competence principles
|
- Inherits generic competence principles
|
||||||
- Adds software-specific evidence requirements
|
- Adds software-specific evidence requirements
|
||||||
- Maintains collaboration and learning focus
|
- Maintains collaboration and learning focus
|
||||||
|
|
||||||
### With research_diagnostic.mdc
|
### With research_diagnostic.mdc
|
||||||
|
|
||||||
- Enhances investigation with code path tracing
|
- Enhances investigation with code path tracing
|
||||||
- Adds evidence validation to diagnostic workflow
|
- Adds evidence validation to diagnostic workflow
|
||||||
- Strengthens problem identification accuracy
|
- Strengthens problem identification accuracy
|
||||||
@@ -71,6 +146,7 @@ Specialized guidelines for software development tasks including code review, deb
|
|||||||
## Usage Guidelines
|
## Usage Guidelines
|
||||||
|
|
||||||
### When to Use This Ruleset
|
### When to Use This Ruleset
|
||||||
|
|
||||||
- Code reviews and architectural decisions
|
- Code reviews and architectural decisions
|
||||||
- Bug investigation and debugging
|
- Bug investigation and debugging
|
||||||
- Performance optimization
|
- Performance optimization
|
||||||
@@ -78,101 +154,72 @@ Specialized guidelines for software development tasks including code review, deb
|
|||||||
- Testing strategy development
|
- Testing strategy development
|
||||||
|
|
||||||
### When to Combine with Others
|
### When to Combine with Others
|
||||||
|
|
||||||
- **base_context + software_development**: General development tasks
|
- **base_context + software_development**: General development tasks
|
||||||
- **research_diagnostic + software_development**: Technical investigations
|
- **research_diagnostic + software_development**: Technical investigations
|
||||||
- **All three**: Complex architectural decisions or major refactoring
|
- **All three**: Complex architectural decisions or major refactoring
|
||||||
|
|
||||||
## Self-Check (model, before responding)
|
## Self-Check (model, before responding)
|
||||||
|
|
||||||
- [ ] Code path traced and documented
|
- [ ] Code path traced and documented
|
||||||
- [ ] Evidence cited with specific file:line references
|
- [ ] Evidence cited with specific file:line references
|
||||||
- [ ] Assumptions clearly flagged as proven vs. inferred
|
- [ ] Assumptions clearly flagged as proven vs. inferred
|
||||||
- [ ] Solution complexity justified by evidence
|
- [ ] Solution complexity justified by evidence
|
||||||
- [ ] Simpler alternatives considered and documented
|
- [ ] Simpler alternatives considered and documented
|
||||||
- [ ] Impact on existing systems assessed
|
- [ ] Impact on existing systems assessed
|
||||||
# Software Development Ruleset
|
- [ ] Dependencies validated and accessible
|
||||||
|
- [ ] Environment impact assessed for team members
|
||||||
|
- [ ] Pre-build validation implemented where appropriate
|
||||||
|
|
||||||
## Purpose
|
## Additional Core Principles
|
||||||
Specialized guidelines for software development tasks including code review, debugging, architecture decisions, and testing.
|
|
||||||
|
|
||||||
## Core Principles
|
### 4. Dependency Management & Environment Validation
|
||||||
|
- **Pre-build Validation**: Always validate critical dependencies before executing build scripts
|
||||||
|
- **Environment Consistency**: Ensure team members have identical development environments
|
||||||
|
- **Dependency Verification**: Check that required packages are installed and accessible
|
||||||
|
- **Path Resolution**: Use `npx` for local dependencies to avoid PATH issues
|
||||||
|
|
||||||
### 1. Evidence-First Development
|
## Additional Required Workflows
|
||||||
- **Code Citations Required**: Always cite specific file:line references when making claims
|
|
||||||
- **Execution Path Tracing**: Trace actual code execution before proposing architectural changes
|
|
||||||
- **Assumption Validation**: Flag assumptions as "assumed" vs "evidence-based"
|
|
||||||
|
|
||||||
### 2. Code Review Standards
|
### Dependency Validation (Before Proposing Changes)
|
||||||
- **Trace Before Proposing**: Always trace execution paths before suggesting changes
|
- [ ] **Dependency Validation**: Verify all required dependencies are available and accessible
|
||||||
- **Evidence Over Inference**: Prefer code citations over logical deductions
|
|
||||||
- **Scope Validation**: Confirm the actual scope of problems before proposing solutions
|
|
||||||
|
|
||||||
### 3. Problem-Solution Validation
|
### Environment Impact Assessment (During Solution Design)
|
||||||
- **Problem Scope**: Does the solution address the actual problem?
|
- [ ] **Environment Impact**: Assess how changes affect team member setups
|
||||||
- **Evidence Alignment**: Does the solution match the evidence?
|
|
||||||
- **Complexity Justification**: Is added complexity justified by real needs?
|
|
||||||
- **Alternative Analysis**: What simpler solutions were considered?
|
|
||||||
|
|
||||||
## Required Workflows
|
## Additional Competence Hooks
|
||||||
|
|
||||||
### Before Proposing Changes
|
### Dependency & Environment Management
|
||||||
- [ ] **Code Path Tracing**: Map execution flow from entry to exit
|
- **"What dependencies does this feature require and are they properly declared?"**
|
||||||
- [ ] **Evidence Collection**: Gather specific code citations and logs
|
- **"How will this change affect team member development environments?"**
|
||||||
- [ ] **Assumption Surfacing**: Identify what's proven vs. inferred
|
- **"What validation can we add to catch dependency issues early?"**
|
||||||
- [ ] **Scope Validation**: Confirm the actual extent of the problem
|
|
||||||
|
|
||||||
### During Solution Design
|
## Dependency Management Best Practices
|
||||||
- [ ] **Evidence Alignment**: Ensure solution addresses proven problems
|
|
||||||
- [ ] **Complexity Assessment**: Justify any added complexity
|
|
||||||
- [ ] **Alternative Evaluation**: Consider simpler approaches first
|
|
||||||
- [ ] **Impact Analysis**: Assess effects on existing systems
|
|
||||||
|
|
||||||
## Software-Specific Competence Hooks
|
### Pre-build Validation
|
||||||
|
- **Check Critical Dependencies**: Validate essential tools before executing build scripts
|
||||||
|
- **Use npx for Local Dependencies**: Prefer `npx tsx` over direct `tsx` to avoid PATH issues
|
||||||
|
- **Environment Consistency**: Ensure all team members have identical dependency versions
|
||||||
|
|
||||||
### Evidence Validation
|
### Common Pitfalls
|
||||||
- **"What code path proves this claim?"**
|
- **Missing npm install**: Team members cloning without running `npm install`
|
||||||
- **"How does data actually flow through the system?"**
|
- **PATH Issues**: Direct command execution vs. npm script execution differences
|
||||||
- **"What am I assuming vs. what can I prove?"**
|
- **Version Mismatches**: Different Node.js/npm versions across team members
|
||||||
|
|
||||||
### Code Tracing
|
### Validation Strategies
|
||||||
- **"What's the execution path from user action to system response?"**
|
- **Dependency Check Scripts**: Implement pre-build validation for critical dependencies
|
||||||
- **"Which components actually interact in this scenario?"**
|
- **Environment Requirements**: Document and enforce minimum Node.js/npm versions
|
||||||
- **"Where does the data originate and where does it end up?"**
|
- **Onboarding Checklist**: Standardize team member setup procedures
|
||||||
|
|
||||||
### Architecture Decisions
|
### Error Messages and Guidance
|
||||||
- **"What evidence shows this change is necessary?"**
|
- **Specific Error Context**: Provide clear guidance when dependency issues occur
|
||||||
- **"What simpler solution could achieve the same goal?"**
|
- **Actionable Solutions**: Direct users to specific commands (`npm install`, `npm run check:dependencies`)
|
||||||
- **"How does this change affect the existing system architecture?"**
|
- **Environment Diagnostics**: Implement comprehensive environment validation tools
|
||||||
|
|
||||||
## Integration with Other Rulesets
|
### Build Script Enhancements
|
||||||
|
- **Early Validation**: Check dependencies before starting build processes
|
||||||
|
- **Graceful Degradation**: Continue builds when possible but warn about issues
|
||||||
|
- **Helpful Tips**: Remind users about dependency management best practices
|
||||||
|
|
||||||
### With base_context.mdc
|
- **Narrow Types Properly**: Use type guards to narrow `unknown` types safely
|
||||||
- Inherits generic competence principles
|
- **Document Type Decisions**: Explain complex type structures and their purpose
|
||||||
- Adds software-specific evidence requirements
|
|
||||||
- Maintains collaboration and learning focus
|
|
||||||
|
|
||||||
### With research_diagnostic.mdc
|
|
||||||
- Enhances investigation with code path tracing
|
|
||||||
- Adds evidence validation to diagnostic workflow
|
|
||||||
- Strengthens problem identification accuracy
|
|
||||||
|
|
||||||
## Usage Guidelines
|
|
||||||
|
|
||||||
### When to Use This Ruleset
|
|
||||||
- Code reviews and architectural decisions
|
|
||||||
- Bug investigation and debugging
|
|
||||||
- Performance optimization
|
|
||||||
- Feature implementation planning
|
|
||||||
- Testing strategy development
|
|
||||||
|
|
||||||
### When to Combine with Others
|
|
||||||
- **base_context + software_development**: General development tasks
|
|
||||||
- **research_diagnostic + software_development**: Technical investigations
|
|
||||||
- **All three**: Complex architectural decisions or major refactoring
|
|
||||||
|
|
||||||
## Self-Check (model, before responding)
|
|
||||||
- [ ] Code path traced and documented
|
|
||||||
- [ ] Evidence cited with specific file:line references
|
|
||||||
- [ ] Assumptions clearly flagged as proven vs. inferred
|
|
||||||
- [ ] Solution complexity justified by evidence
|
|
||||||
- [ ] Simpler alternatives considered and documented
|
|
||||||
- [ ] Impact on existing systems assessed
|
|
||||||
|
|||||||
329
.cursor/rules/time.mdc
Normal file
329
.cursor/rules/time.mdc
Normal file
@@ -0,0 +1,329 @@
|
|||||||
|
---
|
||||||
|
alwaysApply: true
|
||||||
|
---
|
||||||
|
# Time Handling in Development Workflow
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-17
|
||||||
|
**Status**: 🎯 **ACTIVE** - Production Ready
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This guide establishes **how time should be referenced and used** across the
|
||||||
|
development workflow. It is not tied to any one project, but applies to **all
|
||||||
|
feature development, issue investigations, ADRs, and documentation**.
|
||||||
|
|
||||||
|
## General Principles
|
||||||
|
|
||||||
|
- **Explicit over relative**: Always prefer absolute dates (`2025-08-17`) over
|
||||||
|
relative references like "last week."
|
||||||
|
- **ISO 8601 Standard**: Use `YYYY-MM-DD` format for all date references in
|
||||||
|
docs, issues, ADRs, and commits.
|
||||||
|
- **Time zones**: Default to **UTC** unless explicitly tied to user-facing
|
||||||
|
behavior.
|
||||||
|
- **Precision**: Only specify as much precision as needed (date vs. datetime vs.
|
||||||
|
timestamp).
|
||||||
|
- **Consistency**: Align time references across ADRs, commits, and investigation
|
||||||
|
reports.
|
||||||
|
|
||||||
|
## In Documentation & ADRs
|
||||||
|
|
||||||
|
- Record decision dates using **absolute ISO dates**.
|
||||||
|
- For ongoing timelines, state start and end explicitly (e.g., `2025-08-01` →
|
||||||
|
`2025-08-17`).
|
||||||
|
- Avoid ambiguous terms like *recently*, *last month*, or *soon*.
|
||||||
|
- For time-based experiments (e.g., A/B tests), always include:
|
||||||
|
|
||||||
|
- Start date
|
||||||
|
- Expected duration
|
||||||
|
- Review date checkpoint
|
||||||
|
|
||||||
|
## In Code & Commits
|
||||||
|
|
||||||
|
- Use **UTC timestamps** in logs, DB migrations, and serialized formats.
|
||||||
|
- In commits, link changes to **date-bound ADRs or investigation docs**.
|
||||||
|
- For migrations, include both **applied date** and **intended version window**.
|
||||||
|
- Use constants for known fixed dates; avoid hardcoding arbitrary strings.
|
||||||
|
|
||||||
|
## In Investigations & Research
|
||||||
|
|
||||||
|
- Capture **when** an issue occurred (absolute time or version tag).
|
||||||
|
- When describing failures: note whether they are **time-sensitive** (e.g., after
|
||||||
|
migrations, cache expirations).
|
||||||
|
- Record diagnostic timelines in ISO format (not relative).
|
||||||
|
- For performance regressions, annotate both **baseline timeframe** and
|
||||||
|
**measurement timeframe**.
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
|
||||||
|
- During reviews, verify **time references are clear, absolute, and
|
||||||
|
standardized**.
|
||||||
|
- In syncs, reframe relative terms ("this week") into shared absolute
|
||||||
|
references.
|
||||||
|
- Tag ADRs with both **date created** and **review by** checkpoints.
|
||||||
|
|
||||||
|
## Self-Check Before Submitting
|
||||||
|
|
||||||
|
- [ ] Did I check the time using the **developer's actual system time and
|
||||||
|
timezone**?
|
||||||
|
- [ ] Am I using absolute ISO dates?
|
||||||
|
- [ ] Is UTC assumed unless specified otherwise?
|
||||||
|
- [ ] Did I avoid ambiguous relative terms?
|
||||||
|
- [ ] If duration matters, did I specify both start and end?
|
||||||
|
- [ ] For future work, did I include a review/revisit date?
|
||||||
|
|
||||||
|
## Real-Time Context in Developer Interactions
|
||||||
|
|
||||||
|
- The model must always resolve **"current time"** using the **developer's
|
||||||
|
actual system time and timezone**.
|
||||||
|
- When generating timestamps (e.g., in investigation logs, ADRs, or examples),
|
||||||
|
the model should:
|
||||||
|
|
||||||
|
- Use the **developer's current local time** by default.
|
||||||
|
- Indicate the timezone explicitly (e.g., `2025-08-17T10:32-05:00`).
|
||||||
|
- Optionally provide UTC alongside if context requires cross-team clarity.
|
||||||
|
|
||||||
|
- When interpreting relative terms like *now*, *today*, *last week*:
|
||||||
|
|
||||||
|
- Resolve them against the **developer's current time**.
|
||||||
|
- Convert them into **absolute ISO-8601 values** in the output.
|
||||||
|
|
||||||
|
## LLM Time Checking Instructions
|
||||||
|
|
||||||
|
**CRITICAL**: The LLM must actively query the system for current time rather
|
||||||
|
than assuming or inventing times.
|
||||||
|
|
||||||
|
### How to Check Current Time
|
||||||
|
|
||||||
|
#### 1. **Query System Time (Required)**
|
||||||
|
|
||||||
|
- **Always start** by querying the current system time using available tools
|
||||||
|
- **Never assume** what the current time is
|
||||||
|
- **Never use** placeholder values like "current time" or "now"
|
||||||
|
|
||||||
|
#### 2. **Available Time Query Methods**
|
||||||
|
|
||||||
|
- **System Clock**: Use `date` command or equivalent system time function
|
||||||
|
- **Programming Language**: Use language-specific time functions (e.g.,
|
||||||
|
`Date.now()`, `datetime.now()`)
|
||||||
|
- **Environment Variables**: Check for time-related environment variables
|
||||||
|
- **API Calls**: Use time service APIs if available
|
||||||
|
|
||||||
|
#### 3. **Required Time Information**
|
||||||
|
|
||||||
|
When querying time, always obtain:
|
||||||
|
|
||||||
|
- **Current Date**: YYYY-MM-DD format
|
||||||
|
- **Current Time**: HH:MM:SS format (24-hour)
|
||||||
|
- **Timezone**: Current system timezone or UTC offset
|
||||||
|
- **UTC Equivalent**: Convert local time to UTC for cross-team clarity
|
||||||
|
|
||||||
|
#### 4. **Time Query Examples**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Example: Query system time
|
||||||
|
$ date
|
||||||
|
# Expected output: Mon Aug 17 10:32:45 EDT 2025
|
||||||
|
|
||||||
|
# Example: Query UTC time
|
||||||
|
$ date -u
|
||||||
|
# Expected output: Mon Aug 17 14:32:45 UTC 2025
|
||||||
|
```
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Example: Python time query
|
||||||
|
import datetime
|
||||||
|
current_time = datetime.datetime.now()
|
||||||
|
utc_time = datetime.datetime.utcnow()
|
||||||
|
print(f"Local: {current_time}")
|
||||||
|
print(f"UTC: {utc_time}")
|
||||||
|
```
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
// Example: JavaScript time query
|
||||||
|
const now = new Date();
|
||||||
|
const utc = new Date().toISOString();
|
||||||
|
console.log(`Local: ${now}`);
|
||||||
|
console.log(`UTC: ${utc}`);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 5. **LLM Time Checking Workflow**
|
||||||
|
|
||||||
|
1. **Query**: Actively query system for current time
|
||||||
|
2. **Validate**: Confirm time data is reasonable and current
|
||||||
|
3. **Format**: Convert to ISO 8601 format
|
||||||
|
4. **Context**: Provide both local and UTC times when helpful
|
||||||
|
5. **Document**: Show the source of time information
|
||||||
|
|
||||||
|
#### 6. **Error Handling for Time Queries**
|
||||||
|
|
||||||
|
- **If time query fails**: Ask user for current time or use "unknown time"
|
||||||
|
with explanation
|
||||||
|
- **If timezone unclear**: Default to UTC and ask for clarification
|
||||||
|
- **If time seems wrong**: Verify with user before proceeding
|
||||||
|
- **Always log**: Record when and how time was obtained
|
||||||
|
|
||||||
|
#### 7. **Time Query Verification**
|
||||||
|
|
||||||
|
Before using queried time, verify:
|
||||||
|
|
||||||
|
- [ ] Time is recent (within last few minutes)
|
||||||
|
- [ ] Timezone information is available
|
||||||
|
- [ ] UTC conversion is accurate
|
||||||
|
- [ ] Format follows ISO 8601 standard
|
||||||
|
|
||||||
|
## Model Behavior Rules
|
||||||
|
|
||||||
|
- **Never invent a "fake now"**: All "current time" references must come from
|
||||||
|
the real system clock available at runtime.
|
||||||
|
- **Check developer time zone**: If ambiguous, ask for clarification (e.g.,
|
||||||
|
"Should I use UTC or your local timezone?").
|
||||||
|
- **Format for clarity**:
|
||||||
|
|
||||||
|
- Local time: `YYYY-MM-DDTHH:mm±hh:mm`
|
||||||
|
- UTC equivalent (if needed): `YYYY-MM-DDTHH:mmZ`
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Good
|
||||||
|
|
||||||
|
- "Feature flag rollout started on `2025-08-01` and will be reviewed on
|
||||||
|
`2025-08-21`."
|
||||||
|
- "Migration applied on `2025-07-15T14:00Z`."
|
||||||
|
- "Issue reproduced on `2025-08-17T09:00-05:00 (local)` /
|
||||||
|
`2025-08-17T14:00Z (UTC)`."
|
||||||
|
|
||||||
|
### Bad
|
||||||
|
|
||||||
|
- "Feature flag rolled out last week."
|
||||||
|
- "Migration applied recently."
|
||||||
|
- "Now is August, so we assume this was last month."
|
||||||
|
|
||||||
|
### More Examples
|
||||||
|
|
||||||
|
#### Issue Reports
|
||||||
|
|
||||||
|
- ✅ **Good**: "User reported login failure at `2025-08-17T14:30:00Z`. Issue
|
||||||
|
persisted until `2025-08-17T15:45:00Z`."
|
||||||
|
- ❌ **Bad**: "User reported login failure earlier today. Issue lasted for a
|
||||||
|
while."
|
||||||
|
|
||||||
|
#### Release Planning
|
||||||
|
|
||||||
|
- ✅ **Good**: "Feature X scheduled for release on `2025-08-25`. Testing
|
||||||
|
window: `2025-08-20` to `2025-08-24`."
|
||||||
|
- ❌ **Bad**: "Feature X will be released next week after testing."
|
||||||
|
|
||||||
|
#### Performance Monitoring
|
||||||
|
|
||||||
|
- ✅ **Good**: "Baseline performance measured on `2025-08-10T09:00:00Z`.
|
||||||
|
Regression detected on `2025-08-15T14:00:00Z`."
|
||||||
|
- ❌ **Bad**: "Performance was good last week but got worse this week."
|
||||||
|
|
||||||
|
## Technical Implementation Notes
|
||||||
|
|
||||||
|
### UTC Storage Principle
|
||||||
|
|
||||||
|
- **Store all timestamps in UTC** in databases, logs, and serialized formats
|
||||||
|
- **Convert to local time only for user display**
|
||||||
|
- **Use ISO 8601 format** for all storage: `YYYY-MM-DDTHH:mm:ss.sssZ`
|
||||||
|
|
||||||
|
### Common Implementation Patterns
|
||||||
|
|
||||||
|
#### Database Storage
|
||||||
|
|
||||||
|
```sql
|
||||||
|
-- ✅ Good: Store in UTC
|
||||||
|
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
|
||||||
|
|
||||||
|
-- ❌ Bad: Store in local time
|
||||||
|
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
|
||||||
|
```
|
||||||
|
|
||||||
|
#### API Responses
|
||||||
|
|
||||||
|
```json
|
||||||
|
// ✅ Good: Include both UTC and local time
|
||||||
|
{
|
||||||
|
"eventTime": "2025-08-17T14:00:00Z",
|
||||||
|
"localTime": "2025-08-17T10:00:00-04:00",
|
||||||
|
"timezone": "America/New_York"
|
||||||
|
}
|
||||||
|
|
||||||
|
// ❌ Bad: Only local time
|
||||||
|
{
|
||||||
|
"eventTime": "2025-08-17T10:00:00-04:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Logging
|
||||||
|
|
||||||
|
```python
|
||||||
|
# ✅ Good: Log in UTC with timezone info
|
||||||
|
logger.info(f"User action at {datetime.utcnow().isoformat()}Z (UTC)")
|
||||||
|
|
||||||
|
# ❌ Bad: Log in local time
|
||||||
|
logger.info(f"User action at {datetime.now()}")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Timezone Handling Best Practices
|
||||||
|
|
||||||
|
#### 1. Always Store Timezone Information
|
||||||
|
|
||||||
|
- Include IANA timezone identifier (e.g., `America/New_York`)
|
||||||
|
- Store UTC offset at time of creation
|
||||||
|
- Handle daylight saving time transitions automatically
|
||||||
|
|
||||||
|
#### 2. User Display Considerations
|
||||||
|
|
||||||
|
- Convert UTC to user's preferred timezone
|
||||||
|
- Show timezone abbreviation when helpful
|
||||||
|
- Use relative time for recent events ("2 hours ago")
|
||||||
|
|
||||||
|
#### 3. Edge Case Handling
|
||||||
|
|
||||||
|
- **Daylight Saving Time**: Use timezone-aware libraries
|
||||||
|
- **Leap Seconds**: Handle gracefully (rare but important)
|
||||||
|
- **Invalid Times**: Validate before processing
|
||||||
|
|
||||||
|
### Common Mistakes to Avoid
|
||||||
|
|
||||||
|
#### 1. Timezone Confusion
|
||||||
|
|
||||||
|
- ❌ **Don't**: Assume server timezone is user timezone
|
||||||
|
- ✅ **Do**: Always convert UTC to user's local time for display
|
||||||
|
|
||||||
|
#### 2. Format Inconsistency
|
||||||
|
|
||||||
|
- ❌ **Don't**: Mix different time formats in the same system
|
||||||
|
- ✅ **Do**: Standardize on ISO 8601 for all storage
|
||||||
|
|
||||||
|
#### 3. Relative Time References
|
||||||
|
|
||||||
|
- ❌ **Don't**: Use relative terms in persistent storage
|
||||||
|
- ✅ **Do**: Convert relative terms to absolute timestamps immediately
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
- [ISO 8601 Date and Time Standard](https://en.wikipedia.org/wiki/ISO_8601)
|
||||||
|
- [IANA Timezone Database](https://www.iana.org/time-zones)
|
||||||
|
- [ADR Template](./adr_template.md)
|
||||||
|
- [Research & Diagnostic Workflow](./research_diagnostic.mdc)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Rule of Thumb**: Every time reference in development artifacts should be
|
||||||
|
**clear in 6 months without context**, and aligned to the **developer's actual
|
||||||
|
current time**.
|
||||||
|
|
||||||
|
**Technical Rule of Thumb**: **Store in UTC, display in local time, always
|
||||||
|
include timezone context.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active
|
||||||
|
**Version**: 1.0
|
||||||
|
**Maintainer**: Matthew Raymer
|
||||||
|
**Next Review**: 2025-09-17
|
||||||
714
.cursor/rules/unit_testing_mocks.mdc
Normal file
714
.cursor/rules/unit_testing_mocks.mdc
Normal file
@@ -0,0 +1,714 @@
|
|||||||
|
```json
|
||||||
|
{
|
||||||
|
"coaching_level": "standard",
|
||||||
|
"socratic_max_questions": 2,
|
||||||
|
"verbosity": "normal",
|
||||||
|
"timebox_minutes": null,
|
||||||
|
"format_enforcement": "strict"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# Unit Testing & Mocks — Universal Development Guide
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-21T09:40Z
|
||||||
|
**Status**: 🎯 **ACTIVE** - Comprehensive testing standards
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This guide establishes **unified unit testing and mocking standards** for Vue
|
||||||
|
and React projects, ensuring consistent, maintainable test patterns using
|
||||||
|
Vitest, JSDOM, and component testing utilities. All tests follow F.I.R.S.T.
|
||||||
|
principles with comprehensive mock implementations.
|
||||||
|
|
||||||
|
## Scope and Goals
|
||||||
|
|
||||||
|
**Scope**: Applies to all unit tests, mock implementations, and testing
|
||||||
|
infrastructure in any project workspace.
|
||||||
|
|
||||||
|
**Goal**: One consistent testing approach with comprehensive mock coverage,
|
||||||
|
100% test coverage for simple components, and maintainable test patterns.
|
||||||
|
|
||||||
|
## Non‑Negotiables (DO THIS)
|
||||||
|
|
||||||
|
- **MUST** use Vitest + JSDOM for unit testing; **DO NOT** use Jest or other
|
||||||
|
frameworks
|
||||||
|
- **MUST** implement comprehensive mock levels (Simple, Standard, Complex) for
|
||||||
|
all components
|
||||||
|
- **MUST** achieve 100% line coverage for simple components (<100 lines)
|
||||||
|
- **MUST** follow F.I.R.S.T. principles: Fast, Independent, Repeatable,
|
||||||
|
Self-validating, Timely
|
||||||
|
- **MUST** use centralized test utilities from `src/test/utils/`
|
||||||
|
|
||||||
|
## Testing Infrastructure
|
||||||
|
|
||||||
|
### **Core Technologies**
|
||||||
|
|
||||||
|
- **Vitest**: Fast unit testing framework with Vue/React support
|
||||||
|
- **JSDOM**: Browser-like environment for Node.js testing
|
||||||
|
- **@vue/test-utils**: Vue component testing utilities
|
||||||
|
- **TypeScript**: Full type safety for tests and mocks
|
||||||
|
|
||||||
|
### **Configuration Files**
|
||||||
|
|
||||||
|
- `vitest.config.ts` - Vitest configuration with JSDOM environment
|
||||||
|
- `src/test/setup.ts` - Global test configuration and mocks
|
||||||
|
- `src/test/utils/` - Centralized testing utilities
|
||||||
|
|
||||||
|
### **Global Mocks**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Required browser API mocks
|
||||||
|
ResizeObserver, IntersectionObserver, localStorage, sessionStorage,
|
||||||
|
matchMedia, console methods (reduced noise)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Mock Implementation Standards
|
||||||
|
|
||||||
|
### **Mock Architecture Levels**
|
||||||
|
|
||||||
|
#### **1. Simple Mock (Basic Testing)**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Minimal interface compliance
|
||||||
|
class ComponentSimpleMock {
|
||||||
|
// Essential props and methods only
|
||||||
|
// Basic computed properties
|
||||||
|
// No complex behavior
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **2. Standard Mock (Integration Testing)**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Full interface compliance
|
||||||
|
class ComponentStandardMock {
|
||||||
|
// All props, methods, computed properties
|
||||||
|
// Realistic behavior simulation
|
||||||
|
// Helper methods for test scenarios
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **3. Complex Mock (Advanced Testing)**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Enhanced testing capabilities
|
||||||
|
class ComponentComplexMock extends ComponentStandardMock {
|
||||||
|
// Mock event listeners
|
||||||
|
// Performance testing hooks
|
||||||
|
// Error scenario simulation
|
||||||
|
// Accessibility testing support
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Mock Component Structure**
|
||||||
|
|
||||||
|
Each mock component provides:
|
||||||
|
|
||||||
|
- Same interface as original component
|
||||||
|
- Simplified behavior for testing
|
||||||
|
- Helper methods for test scenarios
|
||||||
|
- Computed properties for state validation
|
||||||
|
|
||||||
|
### **Enhanced Mock Architecture Validation** ✅ **NEW**
|
||||||
|
|
||||||
|
The three-tier mock architecture (Simple/Standard/Complex) has been successfully
|
||||||
|
validated through real-world implementation:
|
||||||
|
|
||||||
|
#### **Tier 1: Simple Mock**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class ComponentSimpleMock {
|
||||||
|
// Basic interface compliance
|
||||||
|
// Minimal implementation for simple tests
|
||||||
|
// Fast execution for high-volume testing
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Tier 2: Standard Mock**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class ComponentStandardMock {
|
||||||
|
// Full interface implementation
|
||||||
|
// Realistic behavior simulation
|
||||||
|
// Helper methods for common scenarios
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Tier 3: Complex Mock**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class ComponentComplexMock {
|
||||||
|
// Enhanced testing capabilities
|
||||||
|
// Validation and error simulation
|
||||||
|
// Advanced state management
|
||||||
|
// Performance testing support
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Factory Function Pattern**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Specialized factory functions for common use cases
|
||||||
|
export const createComponentMock = () =>
|
||||||
|
new ComponentStandardMock({ type: 'default' })
|
||||||
|
|
||||||
|
export const createSpecializedMock = () =>
|
||||||
|
new ComponentComplexMock({
|
||||||
|
options: { filter: 'active', sort: 'name' }
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Mock Usage Examples**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export default class ComponentMock {
|
||||||
|
// Props simulation
|
||||||
|
props: ComponentProps
|
||||||
|
|
||||||
|
// Computed properties
|
||||||
|
get computedProp(): boolean {
|
||||||
|
return this.props.condition
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mock methods
|
||||||
|
mockMethod(): void {
|
||||||
|
// Simulate behavior
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper methods
|
||||||
|
getCssClasses(): string[] {
|
||||||
|
return ['base-class', 'conditional-class']
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test Patterns
|
||||||
|
|
||||||
|
### **Component Testing Template**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { mount } from '@vue/test-utils'
|
||||||
|
import { createComponentWrapper } from '@/test/utils/componentTestUtils'
|
||||||
|
|
||||||
|
describe('ComponentName', () => {
|
||||||
|
let wrapper: VueWrapper<any>
|
||||||
|
|
||||||
|
const mountComponent = (props = {}) => {
|
||||||
|
return mount(ComponentName, {
|
||||||
|
props: { ...defaultProps, ...props }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
wrapper = mountComponent()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
wrapper?.unmount()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Component Rendering', () => {
|
||||||
|
it('should render correctly', () => {
|
||||||
|
expect(wrapper.exists()).toBe(true)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Mock Integration Testing**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import ComponentMock from '@/test/__mocks__/Component.mock'
|
||||||
|
|
||||||
|
it('should work with mock component', () => {
|
||||||
|
const mock = new ComponentMock()
|
||||||
|
expect(mock.shouldShow).toBe(true)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Event Testing**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
it('should emit event when triggered', async () => {
|
||||||
|
await wrapper.find('button').trigger('click')
|
||||||
|
expect(wrapper.emitted('event-name')).toBeTruthy()
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Prop Validation**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
it('should accept all required props', () => {
|
||||||
|
wrapper = mountComponent()
|
||||||
|
expect(wrapper.vm.propName).toBeDefined()
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test Categories
|
||||||
|
|
||||||
|
### **Required Coverage Areas**
|
||||||
|
|
||||||
|
1. **Component Rendering** - Existence, structure, conditional rendering
|
||||||
|
2. **Component Styling** - CSS classes, responsive design, framework
|
||||||
|
integration
|
||||||
|
3. **Component Props** - Required/optional prop handling, type validation
|
||||||
|
4. **User Interactions** - Click events, form inputs, keyboard navigation
|
||||||
|
5. **Component Methods** - Method existence, functionality, return values
|
||||||
|
6. **Edge Cases** - Empty/null props, rapid interactions, state changes
|
||||||
|
7. **Error Handling** - Invalid props, malformed data, graceful degradation
|
||||||
|
8. **Accessibility** - Semantic HTML, ARIA attributes, keyboard navigation
|
||||||
|
9. **Performance** - Render time, memory leaks, rapid re-renders
|
||||||
|
10. **Integration** - Parent-child interaction, dependency injection
|
||||||
|
|
||||||
|
### **Error Handling Testing**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const invalidPropCombinations = [
|
||||||
|
null, undefined, 'invalid', 0, -1, {}, [],
|
||||||
|
() => {}, NaN, Infinity
|
||||||
|
]
|
||||||
|
|
||||||
|
invalidPropCombinations.forEach(invalidProp => {
|
||||||
|
it(`should handle invalid prop: ${invalidProp}`, () => {
|
||||||
|
wrapper = mountComponent({ prop: invalidProp })
|
||||||
|
expect(wrapper.exists()).toBe(true)
|
||||||
|
// Verify graceful handling
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Centralized Test Utilities
|
||||||
|
|
||||||
|
### **Component Testing Utilities**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
createComponentWrapper,
|
||||||
|
createTestDataFactory,
|
||||||
|
testLifecycleEvents,
|
||||||
|
testComputedProperties,
|
||||||
|
testWatchers,
|
||||||
|
testPerformance,
|
||||||
|
testAccessibility,
|
||||||
|
testErrorHandling
|
||||||
|
} from '@/test/utils/componentTestUtils'
|
||||||
|
|
||||||
|
// Component wrapper factory
|
||||||
|
const wrapperFactory = createComponentWrapper(
|
||||||
|
Component,
|
||||||
|
defaultProps,
|
||||||
|
globalOptions
|
||||||
|
)
|
||||||
|
|
||||||
|
// Test data factory
|
||||||
|
const createTestProps = createTestDataFactory({
|
||||||
|
prop1: 'default',
|
||||||
|
prop2: true
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Test Data Factories**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
createMockContact,
|
||||||
|
createMockProject,
|
||||||
|
createMockUser
|
||||||
|
} from '@/test/factories/contactFactory'
|
||||||
|
|
||||||
|
const testContact = createMockContact({
|
||||||
|
id: 'test-1',
|
||||||
|
name: 'Test User'
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Coverage Standards
|
||||||
|
|
||||||
|
### **Coverage Standards by Component Complexity**
|
||||||
|
|
||||||
|
| Component Complexity | Line Coverage | Branch Coverage | Function Coverage |
|
||||||
|
|---------------------|---------------|-----------------|-------------------|
|
||||||
|
| **Simple (<100 lines)** | 100% | 100% | 100% |
|
||||||
|
| **Medium (100-300 lines)** | 95% | 90% | 100% |
|
||||||
|
| **Complex (300+ lines)** | 90% | 85% | 100% |
|
||||||
|
|
||||||
|
### **Current Coverage Status**
|
||||||
|
|
||||||
|
- **Simple Components**: Ready for implementation
|
||||||
|
- **Medium Components**: Ready for expansion
|
||||||
|
- **Complex Components**: Ready for expansion
|
||||||
|
- **Overall Coverage**: Varies by project implementation
|
||||||
|
|
||||||
|
### **Test Infrastructure Requirements**
|
||||||
|
|
||||||
|
- **Test Framework**: Vitest + JSDOM recommended
|
||||||
|
- **Component Testing**: Vue Test Utils integration
|
||||||
|
- **Mock Architecture**: Three-tier system (Simple/Standard/Complex)
|
||||||
|
- **Test Categories**: 10 comprehensive categories
|
||||||
|
- **Coverage Goals**: 100% for simple components, 90%+ for complex
|
||||||
|
|
||||||
|
## Testing Philosophy
|
||||||
|
|
||||||
|
### **Defensive Programming Validation**
|
||||||
|
|
||||||
|
- **Real-world edge case protection** against invalid API responses
|
||||||
|
- **System stability assurance** preventing cascading failures
|
||||||
|
- **Production readiness** ensuring graceful error handling
|
||||||
|
|
||||||
|
### **Comprehensive Error Scenarios**
|
||||||
|
|
||||||
|
- **Invalid input testing** with 10+ different invalid prop combinations
|
||||||
|
- **Malformed data testing** with various corrupted data structures
|
||||||
|
- **Extreme value testing** with boundary conditions and edge cases
|
||||||
|
- **Concurrent error testing** with rapid state changes
|
||||||
|
|
||||||
|
### **Benefits Beyond Coverage**
|
||||||
|
|
||||||
|
1. **Defensive Programming Validation** - Components handle unexpected data
|
||||||
|
gracefully
|
||||||
|
2. **Real-World Resilience** - Tested against actual failure scenarios
|
||||||
|
3. **Developer Confidence** - Safe to refactor and extend components
|
||||||
|
4. **Production Stability** - Reduced support tickets and user complaints
|
||||||
|
|
||||||
|
## Advanced Testing Patterns
|
||||||
|
|
||||||
|
### **Performance Testing** ✅ **NEW**
|
||||||
|
|
||||||
|
- Render time benchmarks
|
||||||
|
- Memory leak detection
|
||||||
|
- Rapid re-render efficiency
|
||||||
|
- Component cleanup validation
|
||||||
|
|
||||||
|
#### **Advanced Performance Testing Patterns**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Memory leak detection
|
||||||
|
it('should not cause memory leaks during prop changes', async () => {
|
||||||
|
const initialMemory = (performance as any).memory?.usedJSHeapSize || 0
|
||||||
|
|
||||||
|
for (let i = 0; i < 100; i++) {
|
||||||
|
await wrapper.setProps({
|
||||||
|
queryParams: { iteration: i.toString() }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const finalMemory = (performance as any).memory?.usedJSHeapSize || 0
|
||||||
|
const memoryIncrease = finalMemory - initialMemory
|
||||||
|
|
||||||
|
// Memory increase should be reasonable (less than 10MB)
|
||||||
|
expect(memoryIncrease).toBeLessThan(10 * 1024 * 1024)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Rapid re-render efficiency
|
||||||
|
it('should handle rapid re-renders efficiently', async () => {
|
||||||
|
const start = performance.now()
|
||||||
|
|
||||||
|
for (let i = 0; i < 50; i++) {
|
||||||
|
await wrapper.setProps({
|
||||||
|
entityType: i % 2 === 0 ? 'type1' : 'type2',
|
||||||
|
queryParams: { index: i.toString() }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const end = performance.now()
|
||||||
|
expect(end - start).toBeLessThan(500) // 500ms threshold for 50 updates
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Snapshot Testing** ✅ **NEW**
|
||||||
|
|
||||||
|
- DOM structure validation
|
||||||
|
- CSS class regression detection
|
||||||
|
- Accessibility attribute consistency
|
||||||
|
- Visual structure verification
|
||||||
|
|
||||||
|
#### **Snapshot Testing Implementation**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
describe('Snapshot Testing', () => {
|
||||||
|
it('should maintain consistent DOM structure', () => {
|
||||||
|
expect(wrapper.html()).toMatchSnapshot()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should maintain consistent structure with different props', () => {
|
||||||
|
wrapper = mountComponent({ type: 'alternative' })
|
||||||
|
expect(wrapper.html()).toMatchSnapshot()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should maintain consistent structure with query params', () => {
|
||||||
|
wrapper = mountComponent({
|
||||||
|
queryParams: { filter: 'active', sort: 'name' }
|
||||||
|
})
|
||||||
|
expect(wrapper.html()).toMatchSnapshot()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Mock Integration Testing** ✅ **NEW**
|
||||||
|
|
||||||
|
- Mock component validation
|
||||||
|
- Factory function testing
|
||||||
|
- Mock behavior verification
|
||||||
|
- Integration with testing utilities
|
||||||
|
|
||||||
|
#### **Mock Integration Testing Patterns**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
describe('Mock Integration Testing', () => {
|
||||||
|
it('should work with simple mock', () => {
|
||||||
|
const mock = new ComponentSimpleMock()
|
||||||
|
expect(mock.navigationRoute).toEqual({
|
||||||
|
name: 'default',
|
||||||
|
query: {}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with standard mock', () => {
|
||||||
|
const mock = new ComponentStandardMock({
|
||||||
|
type: 'special',
|
||||||
|
name: 'test'
|
||||||
|
})
|
||||||
|
expect(mock.getType()).toBe('special')
|
||||||
|
expect(mock.getName()).toBe('test')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with complex mock', () => {
|
||||||
|
const mock = new ComponentComplexMock({
|
||||||
|
type: 'advanced',
|
||||||
|
options: { filter: 'active' }
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(mock.isValidState()).toBe(true)
|
||||||
|
expect(mock.getValidationErrors()).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with factory functions', () => {
|
||||||
|
const defaultMock = createComponentMock()
|
||||||
|
const specializedMock = createSpecializedMock()
|
||||||
|
|
||||||
|
expect(defaultMock.getType()).toBe('default')
|
||||||
|
expect(specializedMock.getOptions()).toHaveProperty('filter')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Project Implementation Tracking
|
||||||
|
|
||||||
|
### **Setting Up Project-Specific Tracking**
|
||||||
|
|
||||||
|
Each project should maintain its own tracking file to monitor testing progress
|
||||||
|
and coverage metrics. This keeps the universal MDC clean while providing a
|
||||||
|
template for project implementation.
|
||||||
|
|
||||||
|
#### **Recommended Project Tracking Structure**
|
||||||
|
|
||||||
|
```tree
|
||||||
|
src/test/
|
||||||
|
├── README.md # Testing documentation
|
||||||
|
├── PROJECT_COVERAGE_TRACKING.md # Project-specific progress tracking
|
||||||
|
├── __mocks__/ # Mock implementations
|
||||||
|
├── utils/ # Test utilities
|
||||||
|
└── [test files]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Project Tracking File Template**
|
||||||
|
|
||||||
|
Create a `PROJECT_COVERAGE_TRACKING.md` file with:
|
||||||
|
|
||||||
|
- **Current Coverage Status**: Component-by-component breakdown
|
||||||
|
- **Implementation Progress**: Phase completion status
|
||||||
|
- **Test Infrastructure Status**: Framework setup and metrics
|
||||||
|
- **Next Steps**: Immediate priorities and long-term goals
|
||||||
|
- **Lessons Learned**: Project-specific insights and best practices
|
||||||
|
|
||||||
|
#### **Example Project Tracking Sections**
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# [Project Name] Testing Coverage Tracking
|
||||||
|
|
||||||
|
## Current Coverage Status
|
||||||
|
- Simple Components: X/Y at 100% coverage
|
||||||
|
- Medium Components: X/Y ready for expansion
|
||||||
|
- Complex Components: X/Y planned
|
||||||
|
|
||||||
|
## Implementation Progress
|
||||||
|
- Phase 1: Simple Components ✅ COMPLETE
|
||||||
|
- Phase 2: Medium Components 🔄 IN PROGRESS
|
||||||
|
- Phase 3: Complex Components 🔄 PLANNED
|
||||||
|
|
||||||
|
## Test Infrastructure Status
|
||||||
|
- Total Tests: X tests passing
|
||||||
|
- Test Files: X files
|
||||||
|
- Mock Files: X implementations
|
||||||
|
- Overall Coverage: X% (focused on simple components)
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Integration with Universal MDC**
|
||||||
|
|
||||||
|
- **MDC provides**: Testing patterns, mock architecture, best practices
|
||||||
|
- **Project tracking provides**: Implementation status, coverage metrics,
|
||||||
|
progress
|
||||||
|
- **Separation ensures**: MDC remains reusable, project data stays local
|
||||||
|
- **Template approach**: Other projects can copy and adapt the structure
|
||||||
|
|
||||||
|
### **Benefits of This Approach**
|
||||||
|
|
||||||
|
1. **Universal Reusability**: MDC works for any project
|
||||||
|
2. **Project Visibility**: Clear tracking of implementation progress
|
||||||
|
3. **Template Reuse**: Easy to set up tracking in new projects
|
||||||
|
4. **Clean Separation**: No project data polluting universal guidance
|
||||||
|
5. **Scalability**: Multiple projects can use the same MDC
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
### **Test Organization**
|
||||||
|
|
||||||
|
1. **Group related tests** using `describe` blocks
|
||||||
|
2. **Use descriptive test names** that explain the scenario
|
||||||
|
3. **Keep tests focused** on one specific behavior
|
||||||
|
4. **Use helper functions** for common setup
|
||||||
|
|
||||||
|
### **Mock Design**
|
||||||
|
|
||||||
|
1. **Maintain interface compatibility** with original components
|
||||||
|
2. **Provide helper methods** for common test scenarios
|
||||||
|
3. **Include computed properties** for state validation
|
||||||
|
4. **Document mock behavior** clearly
|
||||||
|
|
||||||
|
### **Coverage Goals**
|
||||||
|
|
||||||
|
1. **100% line coverage** for simple components
|
||||||
|
2. **100% branch coverage** for conditional logic
|
||||||
|
3. **100% function coverage** for all methods
|
||||||
|
4. **Edge case coverage** for error scenarios
|
||||||
|
|
||||||
|
### **Lessons Learned from Implementation** ✅ **NEW**
|
||||||
|
|
||||||
|
#### **1. Performance Testing Best Practices**
|
||||||
|
|
||||||
|
- **Memory leak detection**: Use `performance.memory.usedJSHeapSize` for
|
||||||
|
memory profiling
|
||||||
|
- **Render time benchmarking**: Set realistic thresholds (100ms for single
|
||||||
|
render, 500ms for 50 updates)
|
||||||
|
- **Rapid re-render testing**: Test with 50+ prop changes to ensure
|
||||||
|
stability
|
||||||
|
|
||||||
|
#### **2. Snapshot Testing Implementation**
|
||||||
|
|
||||||
|
- **DOM structure validation**: Use `toMatchSnapshot()` for consistent
|
||||||
|
structure verification
|
||||||
|
- **Prop variation testing**: Test snapshots with different prop combinations
|
||||||
|
- **Regression prevention**: Snapshots catch unexpected DOM changes
|
||||||
|
|
||||||
|
#### **3. Mock Integration Validation**
|
||||||
|
|
||||||
|
- **Mock self-testing**: Test that mocks work correctly with testing
|
||||||
|
utilities
|
||||||
|
- **Factory function testing**: Validate specialized factory functions
|
||||||
|
- **Mock behavior verification**: Ensure mocks simulate real component
|
||||||
|
behavior
|
||||||
|
|
||||||
|
#### **4. Edge Case Coverage**
|
||||||
|
|
||||||
|
- **Null/undefined handling**: Test with `null as any` and `undefined`
|
||||||
|
props
|
||||||
|
- **Extreme values**: Test with very long strings and large numbers
|
||||||
|
- **Rapid changes**: Test with rapid prop changes to ensure stability
|
||||||
|
|
||||||
|
#### **5. Accessibility Testing**
|
||||||
|
|
||||||
|
- **Semantic structure**: Verify proper HTML elements and hierarchy
|
||||||
|
- **Component attributes**: Check component-specific attributes
|
||||||
|
- **Text content**: Validate text content and trimming
|
||||||
|
|
||||||
|
## Future Improvements
|
||||||
|
|
||||||
|
### **Implemented Enhancements**
|
||||||
|
|
||||||
|
1. ✅ **Error handling** - Component error states and exception handling
|
||||||
|
2. ✅ **Performance testing** - Render time benchmarks and memory leak
|
||||||
|
detection
|
||||||
|
3. ✅ **Integration testing** - Parent-child component interaction and
|
||||||
|
dependency injection
|
||||||
|
4. ✅ **Snapshot testing** - DOM structure validation and CSS class
|
||||||
|
regression detection
|
||||||
|
5. ✅ **Accessibility compliance** - ARIA attributes and semantic structure
|
||||||
|
validation
|
||||||
|
|
||||||
|
### **Future Enhancements**
|
||||||
|
|
||||||
|
1. **Visual regression testing** - Automated UI consistency checks
|
||||||
|
2. **Cross-browser compatibility** testing
|
||||||
|
3. **Service layer integration** testing
|
||||||
|
4. **End-to-end component** testing
|
||||||
|
5. **Advanced performance** profiling
|
||||||
|
|
||||||
|
### **Coverage Expansion**
|
||||||
|
|
||||||
|
1. **Medium complexity components** (100-300 lines)
|
||||||
|
2. **Complex components** (300+ lines)
|
||||||
|
3. **Service layer testing**
|
||||||
|
4. **Utility function testing**
|
||||||
|
5. **API integration testing**
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### **Common Issues**
|
||||||
|
|
||||||
|
1. **Import errors**: Check path aliases in `vitest.config.ts`
|
||||||
|
2. **Mock not found**: Verify mock file exists and exports correctly
|
||||||
|
3. **Test failures**: Check for timing issues with async operations
|
||||||
|
4. **Coverage gaps**: Add tests for uncovered code paths
|
||||||
|
|
||||||
|
### **Debug Tips**
|
||||||
|
|
||||||
|
1. **Use `console.log`** in tests for debugging
|
||||||
|
2. **Check test output** for detailed error messages
|
||||||
|
3. **Verify component props** are being passed correctly
|
||||||
|
4. **Test one assertion at a time** to isolate issues
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active testing standards
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: Vitest, JSDOM, Vue Test Utils
|
||||||
|
**Stakeholders**: Development team, QA team
|
||||||
|
|
||||||
|
## Competence Hooks
|
||||||
|
|
||||||
|
- *Why this works*: Three-tier mock architecture provides flexibility,
|
||||||
|
comprehensive test categories ensure thorough coverage, performance testing
|
||||||
|
catches real-world issues early
|
||||||
|
- *Common pitfalls*: Not testing mocks themselves, missing edge case
|
||||||
|
coverage, ignoring performance implications
|
||||||
|
- *Next skill unlock*: Implement medium complexity component testing with
|
||||||
|
established patterns
|
||||||
|
- *Teach-back*: Explain how the three-tier mock architecture supports
|
||||||
|
different testing needs
|
||||||
|
|
||||||
|
## Collaboration Hooks
|
||||||
|
|
||||||
|
- **Reviewers**: Testing team, component developers, architecture team
|
||||||
|
- **Sign-off checklist**: All simple components at 100% coverage, mock
|
||||||
|
utilities documented, test patterns established, coverage expansion plan
|
||||||
|
approved
|
||||||
|
|
||||||
|
## Assumptions & Limits
|
||||||
|
|
||||||
|
- Assumes Vue/React component architecture
|
||||||
|
- Requires Vitest + JSDOM testing environment
|
||||||
|
- Mock complexity scales with component complexity
|
||||||
|
- Performance testing requires browser-like environment
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
- [Vitest Documentation](https://vitest.dev/)
|
||||||
|
- [Vue Test Utils](https://test-utils.vuejs.org/)
|
||||||
|
- [JSDOM](https://github.com/jsdom/jsdom)
|
||||||
|
- [Testing Best Practices](https://testing-library.com/docs/guiding-principles)
|
||||||
|
|
||||||
|
- **Sign-off checklist**: All simple components at 100% coverage, mock
|
||||||
|
utilities documented, test patterns established, coverage expansion plan
|
||||||
|
approved
|
||||||
@@ -1,102 +1,143 @@
|
|||||||
---
|
---
|
||||||
alwaysApply: true
|
description: interacting with git
|
||||||
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Directive: Peaceful Co-Existence with Developers
|
# Directive: Peaceful Co-Existence with Developers
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-19
|
||||||
|
**Status**: 🎯 **ACTIVE** - Version control guidelines
|
||||||
|
|
||||||
## 1) Version-Control Ownership
|
## 1) Version-Control Ownership
|
||||||
|
|
||||||
* **MUST NOT** run `git add`, `git commit`, or any write action.
|
- **MUST NOT** run `git add`, `git commit`, or any write action.
|
||||||
* **MUST** leave staging/committing to the developer.
|
- **MUST** leave staging/committing to the developer.
|
||||||
|
|
||||||
## 2) Source of Truth for Commit Text
|
## 2) Source of Truth for Commit Text
|
||||||
|
|
||||||
* **MUST** derive messages **only** from:
|
- **MUST** derive messages **only** from:
|
||||||
|
- files **staged** for commit (primary), and
|
||||||
* files **staged** for commit (primary), and
|
- files **awaiting staging** (context).
|
||||||
* files **awaiting staging** (context).
|
- **MUST** use the **diffs** to inform content.
|
||||||
* **MUST** use the **diffs** to inform content.
|
- **MUST NOT** invent changes or imply work not present in diffs.
|
||||||
* **MUST NOT** invent changes or imply work not present in diffs.
|
|
||||||
|
|
||||||
## 3) Mandatory Preview Flow
|
## 3) Mandatory Preview Flow
|
||||||
|
|
||||||
* **ALWAYS** present, before any real commit:
|
- **ALWAYS** present, before any real commit:
|
||||||
|
- file list + brief per-file notes,
|
||||||
|
- a **draft commit message** (copy-paste ready),
|
||||||
|
- nothing auto-applied.
|
||||||
|
|
||||||
* file list + brief per-file notes,
|
## 4) Version Synchronization Requirements
|
||||||
* a **draft commit message** (copy-paste ready),
|
|
||||||
* nothing auto-applied.
|
|
||||||
|
|
||||||
---
|
- **MUST** check for version changes in `package.json` before committing
|
||||||
|
- **MUST** ensure `CHANGELOG.md` is updated when `package.json` version
|
||||||
|
changes
|
||||||
|
- **MUST** validate version format consistency between both files
|
||||||
|
- **MUST** include version bump commits in changelog with proper semantic
|
||||||
|
versioning
|
||||||
|
|
||||||
# Commit Message Format (Normative)
|
### Version Sync Checklist (Before Commit)
|
||||||
|
|
||||||
## A. Subject Line (required)
|
- [ ] `package.json` version matches latest `CHANGELOG.md` entry
|
||||||
|
- [ ] New version follows semantic versioning
|
||||||
|
(MAJOR.MINOR.PATCH[-PRERELEASE])
|
||||||
|
- [ ] Changelog entry includes all significant changes since last version
|
||||||
|
- [ ] Version bump commit message follows `build(version): bump to X.Y.Z`
|
||||||
|
format
|
||||||
|
- [ ] Breaking changes properly documented with migration notes
|
||||||
|
- [ ] Alert developer in chat message that version has been updated
|
||||||
|
|
||||||
|
### Version Change Detection
|
||||||
|
|
||||||
|
- **Check for version changes** in staged/unstaged `package.json`
|
||||||
|
- **Alert developer** if version changed but changelog not updated
|
||||||
|
- **Suggest changelog update** with proper format and content
|
||||||
|
- **Validate semantic versioning** compliance
|
||||||
|
|
||||||
|
### Implementation Notes
|
||||||
|
|
||||||
|
- **Version Detection**: Compare `package.json` version field with latest
|
||||||
|
changelog entry
|
||||||
|
- **Semantic Validation**: Ensure version follows `X.Y.Z[-PRERELEASE]`
|
||||||
|
format
|
||||||
|
- **Changelog Format**: Follow [Keep a Changelog](https://keepachangelog.com/)
|
||||||
|
standards
|
||||||
|
- **Breaking Changes**: Use `!` in commit message and `BREAKING CHANGE:`
|
||||||
|
in changelog
|
||||||
|
- **Pre-release Versions**: Include beta/alpha/rc suffixes in both files
|
||||||
|
consistently
|
||||||
|
|
||||||
|
## Commit Message Format (Normative)
|
||||||
|
|
||||||
|
### A. Subject Line (required)
|
||||||
|
|
||||||
```
|
```
|
||||||
<type>(<scope>)<!>: <summary>
|
<type>(<scope>)<!>: <summary>
|
||||||
```
|
```
|
||||||
|
|
||||||
* **type** (lowercase, Conventional Commits): `feat|fix|refactor|perf|docs|test|build|chore|ci|revert`
|
- **type** (lowercase, Conventional Commits):
|
||||||
* **scope**: optional module/package/area (e.g., `api`, `ui/login`, `db`)
|
`feat|fix|refactor|perf|docs|test|build|chore|ci|revert`
|
||||||
* **!**: include when a breaking change is introduced
|
- **scope**: optional module/package/area (e.g., `api`, `ui/login`, `db`)
|
||||||
* **summary**: imperative mood, ≤ 72 chars, no trailing period
|
- **!**: include when a breaking change is introduced
|
||||||
|
- **summary**: imperative mood, ≤ 72 chars, no trailing period
|
||||||
|
|
||||||
**Examples**
|
**Examples**
|
||||||
|
|
||||||
* `fix(api): handle null token in refresh path`
|
- `fix(api): handle null token in refresh path`
|
||||||
* `feat(ui/login)!: require OTP after 3 failed attempts`
|
- `feat(ui/login)!: require OTP after 3 failed attempts`
|
||||||
|
|
||||||
## B. Body (optional, when it adds non-obvious value)
|
### B. Body (optional, when it adds non-obvious value)
|
||||||
|
|
||||||
* One blank line after subject.
|
- One blank line after subject.
|
||||||
* Wrap at \~72 chars.
|
- Wrap at ~72 chars.
|
||||||
* Explain **what** and **why**, not line-by-line “how”.
|
- Explain **what** and **why**, not line-by-line "how".
|
||||||
* Include brief notes like tests passing or TS/lint issues resolved **only if material**.
|
- Include brief notes like tests passing or TS/lint issues resolved
|
||||||
|
**only if material**.
|
||||||
|
|
||||||
**Body checklist**
|
**Body checklist**
|
||||||
|
|
||||||
* [ ] Problem/symptom being addressed
|
- [ ] Problem/symptom being addressed
|
||||||
* [ ] High-level approach or rationale
|
- [ ] High-level approach or rationale
|
||||||
* [ ] Risks, tradeoffs, or follow-ups (if any)
|
- [ ] Risks, tradeoffs, or follow-ups (if any)
|
||||||
|
|
||||||
## C. Footer (optional)
|
### C. Footer (optional)
|
||||||
|
|
||||||
* Issue refs: `Closes #123`, `Refs #456`
|
- Issue refs: `Closes #123`, `Refs #456`
|
||||||
* Breaking change (alternative to `!`):
|
- Breaking change (alternative to `!`):
|
||||||
`BREAKING CHANGE: <impact + migration note>`
|
`BREAKING CHANGE: <impact + migration note>`
|
||||||
* Authors: `Co-authored-by: Name <email>`
|
- Authors: `Co-authored-by: Name <email>`
|
||||||
* Security: `CVE-XXXX-YYYY: <short note>` (if applicable)
|
- Security: `CVE-XXXX-YYYY: <short note>` (if applicable)
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Content Guidance
|
## Content Guidance
|
||||||
|
|
||||||
### Include (when relevant)
|
### Include (when relevant)
|
||||||
|
|
||||||
* Specific fixes/features delivered
|
- Specific fixes/features delivered
|
||||||
* Symptoms/problems fixed
|
- Symptoms/problems fixed
|
||||||
* Brief note that tests passed or TS/lint errors resolved
|
- Brief note that tests passed or TS/lint errors resolved
|
||||||
|
|
||||||
### Avoid
|
### Avoid
|
||||||
|
|
||||||
* Vague: *improved, enhanced, better*
|
- Vague: *improved, enhanced, better*
|
||||||
* Trivialities: tiny docs, one-liners, pure lint cleanups (separate, focused commits if needed)
|
- Trivialities: tiny docs, one-liners, pure lint cleanups (separate,
|
||||||
* Redundancy: generic blurbs repeated across files
|
focused commits if needed)
|
||||||
* Multi-purpose dumps: keep commits **narrow and focused**
|
- Redundancy: generic blurbs repeated across files
|
||||||
* Long explanations that good inline code comments already cover
|
- Multi-purpose dumps: keep commits **narrow and focused**
|
||||||
|
- Long explanations that good inline code comments already cover
|
||||||
|
|
||||||
**Guiding Principle:** Let code and inline docs speak. Use commits to highlight what isn’t obvious.
|
**Guiding Principle:** Let code and inline docs speak. Use commits to
|
||||||
|
highlight what isn't obvious.
|
||||||
|
|
||||||
---
|
## Copy-Paste Templates
|
||||||
|
|
||||||
# Copy-Paste Templates
|
### Minimal (no body)
|
||||||
|
|
||||||
## Minimal (no body)
|
|
||||||
|
|
||||||
```text
|
```text
|
||||||
<type>(<scope>): <summary>
|
<type>(<scope>): <summary>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Standard (with body & footer)
|
### Standard (with body & footer)
|
||||||
|
|
||||||
```text
|
```text
|
||||||
<type>(<scope>)<!>: <summary>
|
<type>(<scope>)<!>: <summary>
|
||||||
@@ -110,13 +151,185 @@ BREAKING CHANGE: <impact + migration>
|
|||||||
Co-authored-by: <Name> <email>
|
Co-authored-by: <Name> <email>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Assistant Output Checklist (before showing the draft)
|
||||||
|
|
||||||
|
- [ ] List changed files + 1–2 line notes per file
|
||||||
|
- [ ] Provide **one** focused draft message (subject/body/footer)
|
||||||
|
- [ ] Subject ≤ 72 chars, imperative mood, correct `type(scope)!` syntax
|
||||||
|
- [ ] Body only if it adds non-obvious value
|
||||||
|
- [ ] No invented changes; aligns strictly with diffs
|
||||||
|
- [ ] Render as a single copy-paste block for the developer
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Assistant Output Checklist (before showing the draft)
|
**Status**: Active version control guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: git, package.json, CHANGELOG.md
|
||||||
|
**Stakeholders**: Development team, AI assistants
|
||||||
|
|
||||||
|
- [ ] No invented changes; aligns strictly with diffs
|
||||||
|
- [ ] Render as a single copy-paste block for the developer
|
||||||
|
|
||||||
|
## 1) Version-Control Ownership
|
||||||
|
|
||||||
|
- **MUST NOT** run `git add`, `git commit`, or any write action.
|
||||||
|
- **MUST** leave staging/committing to the developer.
|
||||||
|
|
||||||
|
## 2) Source of Truth for Commit Text
|
||||||
|
|
||||||
|
- **MUST** derive messages **only** from:
|
||||||
|
- files **staged** for commit (primary), and
|
||||||
|
- files **awaiting staging** (context).
|
||||||
|
- **MUST** use the **diffs** to inform content.
|
||||||
|
- **MUST NOT** invent changes or imply work not present in diffs.
|
||||||
|
|
||||||
|
## 3) Mandatory Preview Flow
|
||||||
|
|
||||||
|
- **ALWAYS** present, before any real commit:
|
||||||
|
- file list + brief per-file notes,
|
||||||
|
- a **draft commit message** (copy-paste ready),
|
||||||
|
- nothing auto-applied.
|
||||||
|
|
||||||
|
## 4) Version Synchronization Requirements
|
||||||
|
|
||||||
|
- **MUST** check for version changes in `package.json` before committing
|
||||||
|
- **MUST** ensure `CHANGELOG.md` is updated when `package.json` version
|
||||||
|
changes
|
||||||
|
- **MUST** validate version format consistency between both files
|
||||||
|
- **MUST** include version bump commits in changelog with proper semantic
|
||||||
|
versioning
|
||||||
|
|
||||||
|
### Version Sync Checklist (Before Commit)
|
||||||
|
|
||||||
|
- [ ] `package.json` version matches latest `CHANGELOG.md` entry
|
||||||
|
- [ ] New version follows semantic versioning
|
||||||
|
(MAJOR.MINOR.PATCH[-PRERELEASE])
|
||||||
|
- [ ] Changelog entry includes all significant changes since last version
|
||||||
|
- [ ] Version bump commit message follows `build(version): bump to X.Y.Z`
|
||||||
|
format
|
||||||
|
- [ ] Breaking changes properly documented with migration notes
|
||||||
|
- [ ] Alert developer in chat message that version has been updated
|
||||||
|
|
||||||
|
### Version Change Detection
|
||||||
|
|
||||||
|
- **Check for version changes** in staged/unstaged `package.json`
|
||||||
|
- **Alert developer** if version changed but changelog not updated
|
||||||
|
- **Suggest changelog update** with proper format and content
|
||||||
|
- **Validate semantic versioning** compliance
|
||||||
|
|
||||||
|
### Implementation Notes
|
||||||
|
|
||||||
|
- **Version Detection**: Compare `package.json` version field with latest
|
||||||
|
changelog entry
|
||||||
|
- **Semantic Validation**: Ensure version follows `X.Y.Z[-PRERELEASE]`
|
||||||
|
format
|
||||||
|
- **Changelog Format**: Follow [Keep a Changelog](https://keepachangelog.com/)
|
||||||
|
standards
|
||||||
|
- **Breaking Changes**: Use `!` in commit message and `BREAKING CHANGE:`
|
||||||
|
in changelog
|
||||||
|
- **Pre-release Versions**: Include beta/alpha/rc suffixes in both files
|
||||||
|
consistently
|
||||||
|
|
||||||
|
## Commit Message Format (Normative)
|
||||||
|
|
||||||
|
### A. Subject Line (required)
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>(<scope>)<!>: <summary>
|
||||||
|
```
|
||||||
|
|
||||||
|
- **type** (lowercase, Conventional Commits):
|
||||||
|
`feat|fix|refactor|perf|docs|test|build|chore|ci|revert`
|
||||||
|
- **scope**: optional module/package/area (e.g., `api`, `ui/login`, `db`)
|
||||||
|
- **!**: include when a breaking change is introduced
|
||||||
|
- **summary**: imperative mood, ≤ 72 chars, no trailing period
|
||||||
|
|
||||||
|
**Examples**
|
||||||
|
|
||||||
|
- `fix(api): handle null token in refresh path`
|
||||||
|
- `feat(ui/login)!: require OTP after 3 failed attempts`
|
||||||
|
|
||||||
|
### B. Body (optional, when it adds non-obvious value)
|
||||||
|
|
||||||
|
- One blank line after subject.
|
||||||
|
- Wrap at ~72 chars.
|
||||||
|
- Explain **what** and **why**, not line-by-line "how".
|
||||||
|
- Include brief notes like tests passing or TS/lint issues resolved
|
||||||
|
**only if material**.
|
||||||
|
|
||||||
|
**Body checklist**
|
||||||
|
|
||||||
|
- [ ] Problem/symptom being addressed
|
||||||
|
- [ ] High-level approach or rationale
|
||||||
|
- [ ] Risks, tradeoffs, or follow-ups (if any)
|
||||||
|
|
||||||
|
### C. Footer (optional)
|
||||||
|
|
||||||
|
- Issue refs: `Closes #123`, `Refs #456`
|
||||||
|
- Breaking change (alternative to `!`):
|
||||||
|
`BREAKING CHANGE: <impact + migration note>`
|
||||||
|
- Authors: `Co-authored-by: Name <email>`
|
||||||
|
- Security: `CVE-XXXX-YYYY: <short note>` (if applicable)
|
||||||
|
|
||||||
|
## Content Guidance
|
||||||
|
|
||||||
|
### Include (when relevant)
|
||||||
|
|
||||||
|
- Specific fixes/features delivered
|
||||||
|
- Symptoms/problems fixed
|
||||||
|
- Brief note that tests passed or TS/lint errors resolved
|
||||||
|
|
||||||
|
### Avoid
|
||||||
|
|
||||||
|
- Vague: *improved, enhanced, better*
|
||||||
|
- Trivialities: tiny docs, one-liners, pure lint cleanups (separate,
|
||||||
|
focused commits if needed)
|
||||||
|
- Redundancy: generic blurbs repeated across files
|
||||||
|
- Multi-purpose dumps: keep commits **narrow and focused**
|
||||||
|
- Long explanations that good inline code comments already cover
|
||||||
|
|
||||||
|
**Guiding Principle:** Let code and inline docs speak. Use commits to
|
||||||
|
highlight what isn't obvious.
|
||||||
|
|
||||||
|
## Copy-Paste Templates
|
||||||
|
|
||||||
|
### Minimal (no body)
|
||||||
|
|
||||||
|
```text
|
||||||
|
<type>(<scope>): <summary>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Standard (with body & footer)
|
||||||
|
|
||||||
|
```text
|
||||||
|
<type>(<scope>)<!>: <summary>
|
||||||
|
|
||||||
|
<why-this-change?>
|
||||||
|
<what-it-does?>
|
||||||
|
<risks-or-follow-ups?>
|
||||||
|
|
||||||
|
Closes #<id>
|
||||||
|
BREAKING CHANGE: <impact + migration>
|
||||||
|
Co-authored-by: <Name> <email>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Assistant Output Checklist (before showing the draft)
|
||||||
|
|
||||||
|
- [ ] List changed files + 1–2 line notes per file
|
||||||
|
- [ ] Provide **one** focused draft message (subject/body/footer)
|
||||||
|
- [ ] Subject ≤ 72 chars, imperative mood, correct `type(scope)!` syntax
|
||||||
|
- [ ] Body only if it adds non-obvious value
|
||||||
|
- [ ] No invented changes; aligns strictly with diffs
|
||||||
|
- [ ] Render as a single copy-paste block for the developer
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active version control guidelines
|
||||||
|
**Priority**: High
|
||||||
|
**Estimated Effort**: Ongoing reference
|
||||||
|
**Dependencies**: git, package.json, CHANGELOG.md
|
||||||
|
**Stakeholders**: Development team, AI assistants
|
||||||
|
|
||||||
* [ ] List changed files + 1–2 line notes per file
|
|
||||||
* [ ] Provide **one** focused draft message (subject/body/footer)
|
|
||||||
* [ ] Subject ≤ 72 chars, imperative mood, correct `type(scope)!` syntax
|
|
||||||
* [ ] Body only if it adds non-obvious value
|
|
||||||
* [ ] No invented changes; aligns strictly with diffs
|
* [ ] No invented changes; aligns strictly with diffs
|
||||||
* [ ] Render as a single copy-paste block for the developer
|
* [ ] Render as a single copy-paste block for the developer
|
||||||
|
|||||||
@@ -140,7 +140,7 @@ docker-compose*
|
|||||||
.dockerignore
|
.dockerignore
|
||||||
|
|
||||||
# CI/CD files
|
# CI/CD files
|
||||||
.github
|
|
||||||
.gitlab-ci.yml
|
.gitlab-ci.yml
|
||||||
.travis.yml
|
.travis.yml
|
||||||
.circleci
|
.circleci
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ VITE_LOG_LEVEL=info
|
|||||||
TIME_SAFARI_APP_TITLE="TimeSafari_Test"
|
TIME_SAFARI_APP_TITLE="TimeSafari_Test"
|
||||||
VITE_APP_SERVER=https://test.timesafari.app
|
VITE_APP_SERVER=https://test.timesafari.app
|
||||||
# This is the claim ID for actions in the BVC project, with the JWT ID on this environment (not
|
# This is the claim ID for actions in the BVC project, with the JWT ID on this environment (not
|
||||||
production).
|
# This is the claim ID for actions in the BVC project, with the JWT ID on this environment (not production).
|
||||||
|
|
||||||
VITE_BVC_MEETUPS_PROJECT_CLAIM_ID=https://endorser.ch/entity/01HWE8FWHQ1YGP7GFZYYPS272F
|
VITE_BVC_MEETUPS_PROJECT_CLAIM_ID=https://endorser.ch/entity/01HWE8FWHQ1YGP7GFZYYPS272F
|
||||||
VITE_DEFAULT_ENDORSER_API_SERVER=https://test-api.endorser.ch
|
VITE_DEFAULT_ENDORSER_API_SERVER=https://test-api.endorser.ch
|
||||||
|
|||||||
142
.github/workflows/asset-validation.yml
vendored
142
.github/workflows/asset-validation.yml
vendored
@@ -1,142 +0,0 @@
|
|||||||
name: Asset Validation & CI Safeguards
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'resources/**'
|
|
||||||
- 'config/assets/**'
|
|
||||||
- 'capacitor-assets.config.json'
|
|
||||||
- 'capacitor.config.ts'
|
|
||||||
- 'capacitor.config.json'
|
|
||||||
push:
|
|
||||||
branches: [main, develop]
|
|
||||||
paths:
|
|
||||||
- 'resources/**'
|
|
||||||
- 'config/assets/**'
|
|
||||||
- 'capacitor-assets.config.json'
|
|
||||||
- 'capacitor.config.ts'
|
|
||||||
- 'capacitor.config.json'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
asset-validation:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: '.nvmrc'
|
|
||||||
cache: 'npm'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Validate asset configuration
|
|
||||||
run: npm run assets:validate
|
|
||||||
|
|
||||||
- name: Check for committed platform assets (Android)
|
|
||||||
run: |
|
|
||||||
if git ls-files -z android/app/src/main/res | grep -E '(AppIcon.*\.png|Splash.*\.png|mipmap-.*/ic_launcher.*\.png)' > /dev/null; then
|
|
||||||
echo "❌ Android platform assets found in VCS - these should be generated at build-time"
|
|
||||||
git ls-files -z android/app/src/main/res | grep -E '(AppIcon.*\.png|Splash.*\.png|mipmap-.*/ic_launcher.*\.png)'
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "✅ No Android platform assets committed"
|
|
||||||
|
|
||||||
- name: Check for committed platform assets (iOS)
|
|
||||||
run: |
|
|
||||||
if git ls-files -z ios/App/App/Assets.xcassets | grep -E '(AppIcon.*\.png|Splash.*\.png)' > /dev/null; then
|
|
||||||
echo "❌ iOS platform assets found in VCS - these should be generated at build-time"
|
|
||||||
git ls-files -z ios/App/App/Assets.xcassets | grep -E '(AppIcon.*\.png|Splash.*\.png)'
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "✅ No iOS platform assets committed"
|
|
||||||
|
|
||||||
- name: Test asset generation
|
|
||||||
run: |
|
|
||||||
echo "🧪 Testing asset generation workflow..."
|
|
||||||
npm run build:capacitor
|
|
||||||
npx cap sync
|
|
||||||
npx capacitor-assets generate --dry-run || npx capacitor-assets generate
|
|
||||||
echo "✅ Asset generation test completed"
|
|
||||||
|
|
||||||
- name: Verify clean tree after build
|
|
||||||
run: |
|
|
||||||
if [ -n "$(git status --porcelain)" ]; then
|
|
||||||
echo "❌ Dirty tree after build - asset configs were modified"
|
|
||||||
git status
|
|
||||||
git diff
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "✅ Build completed with clean tree"
|
|
||||||
|
|
||||||
schema-validation:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version-file: '.nvmrc'
|
|
||||||
cache: 'npm'
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Validate schema compliance
|
|
||||||
run: |
|
|
||||||
echo "🔍 Validating schema compliance..."
|
|
||||||
node -e "
|
|
||||||
const fs = require('fs');
|
|
||||||
const config = JSON.parse(fs.readFileSync('capacitor-assets.config.json', 'utf8'));
|
|
||||||
const schema = JSON.parse(fs.readFileSync('config/assets/schema.json', 'utf8'));
|
|
||||||
|
|
||||||
// Basic schema validation
|
|
||||||
if (!config.icon || !config.splash) {
|
|
||||||
throw new Error('Missing required sections: icon and splash');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!config.icon.source || !config.splash.source) {
|
|
||||||
throw new Error('Missing required source fields');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!/^resources\/.*\.(png|svg)$/.test(config.icon.source)) {
|
|
||||||
throw new Error('Icon source must be in resources/ directory');
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!/^resources\/.*\.(png|svg)$/.test(config.splash.source)) {
|
|
||||||
throw new Error('Splash source must be in resources/ directory');
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('✅ Schema validation passed');
|
|
||||||
"
|
|
||||||
|
|
||||||
- name: Check source file existence
|
|
||||||
run: |
|
|
||||||
echo "📁 Checking source file existence..."
|
|
||||||
node -e "
|
|
||||||
const fs = require('fs');
|
|
||||||
const config = JSON.parse(fs.readFileSync('capacitor-assets.config.json', 'utf8'));
|
|
||||||
|
|
||||||
const requiredFiles = [
|
|
||||||
config.icon.source,
|
|
||||||
config.splash.source
|
|
||||||
];
|
|
||||||
|
|
||||||
if (config.splash.darkSource) {
|
|
||||||
requiredFiles.push(config.splash.darkSource);
|
|
||||||
}
|
|
||||||
|
|
||||||
const missingFiles = requiredFiles.filter(file => !fs.existsSync(file));
|
|
||||||
|
|
||||||
if (missingFiles.length > 0) {
|
|
||||||
console.error('❌ Missing source files:', missingFiles);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log('✅ All source files exist');
|
|
||||||
"
|
|
||||||
27
.github/workflows/playwright.yml
vendored
27
.github/workflows/playwright.yml
vendored
@@ -1,27 +0,0 @@
|
|||||||
name: Playwright Tests
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [ main, master ]
|
|
||||||
pull_request:
|
|
||||||
branches: [ main, master ]
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
timeout-minutes: 60
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: lts/*
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
- name: Install Playwright Browsers
|
|
||||||
run: npx playwright install --with-deps
|
|
||||||
- name: Run Playwright tests
|
|
||||||
run: npx playwright test
|
|
||||||
- uses: actions/upload-artifact@v4
|
|
||||||
if: always()
|
|
||||||
with:
|
|
||||||
name: playwright-report
|
|
||||||
path: playwright-report/
|
|
||||||
retention-days: 30
|
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -140,4 +140,6 @@ electron/out/
|
|||||||
# Gradle cache files
|
# Gradle cache files
|
||||||
android/.gradle/file-system.probe
|
android/.gradle/file-system.probe
|
||||||
android/.gradle/caches/
|
android/.gradle/caches/
|
||||||
coverage
|
|
||||||
|
coverage/
|
||||||
|
.husky-enabled
|
||||||
|
|||||||
37
.husky/README.md
Normal file
37
.husky/README.md
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
# Husky Git Hooks - Optional Activation
|
||||||
|
|
||||||
|
## How to Enable Husky Locally
|
||||||
|
|
||||||
|
### Option 1: Environment Variable (Session Only)
|
||||||
|
```bash
|
||||||
|
export HUSKY_ENABLED=1
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option 2: Local File (Persistent)
|
||||||
|
```bash
|
||||||
|
touch .husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option 3: Global Configuration
|
||||||
|
```bash
|
||||||
|
git config --global husky.enabled true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Available Hooks
|
||||||
|
|
||||||
|
- **pre-commit**: Runs `npm run lint-fix` before commits
|
||||||
|
- **commit-msg**: Validates commit message format
|
||||||
|
|
||||||
|
## Disable Hooks
|
||||||
|
|
||||||
|
```bash
|
||||||
|
unset HUSKY_ENABLED
|
||||||
|
rm .husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why This Approach?
|
||||||
|
|
||||||
|
- Hooks are committed to git for consistency
|
||||||
|
- Hooks don't run unless explicitly enabled
|
||||||
|
- Each developer can choose to use them
|
||||||
|
- No automatic activation on other systems
|
||||||
48
.husky/_/husky.sh
Executable file
48
.husky/_/husky.sh
Executable file
@@ -0,0 +1,48 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
#
|
||||||
|
# Husky Helper Script - Conditional Activation
|
||||||
|
# This file is sourced by all Husky hooks
|
||||||
|
#
|
||||||
|
if [ -z "$husky_skip_init" ]; then
|
||||||
|
# Check if Husky is enabled for this user
|
||||||
|
if [ "$HUSKY_ENABLED" != "1" ] && [ ! -f .husky-enabled ]; then
|
||||||
|
echo "Husky is not enabled. To enable:"
|
||||||
|
echo " export HUSKY_ENABLED=1"
|
||||||
|
echo " or create .husky-enabled file"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
debug () {
|
||||||
|
if [ "$HUSKY_DEBUG" = "1" ]; then
|
||||||
|
echo "husky (debug) - $1"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
readonly hook_name="$(basename -- "$0")"
|
||||||
|
debug "starting $hook_name..."
|
||||||
|
|
||||||
|
if [ "$HUSKY" = "0" ]; then
|
||||||
|
debug "HUSKY env variable is set to 0, skipping hook"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -f ~/.huskyrc ]; then
|
||||||
|
debug "sourcing ~/.huskyrc"
|
||||||
|
. ~/.huskyrc
|
||||||
|
fi
|
||||||
|
|
||||||
|
readonly husky_skip_init=1
|
||||||
|
export husky_skip_init
|
||||||
|
sh -e "$0" "$@"
|
||||||
|
exitCode="$?"
|
||||||
|
|
||||||
|
if [ $exitCode != 0 ]; then
|
||||||
|
echo "husky - $hook_name hook exited with code $exitCode (error)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $exitCode = 127 ]; then
|
||||||
|
echo "husky - command not found in PATH=$PATH"
|
||||||
|
fi
|
||||||
|
|
||||||
|
exit $exitCode
|
||||||
|
fi
|
||||||
11
.husky/commit-msg
Executable file
11
.husky/commit-msg
Executable file
@@ -0,0 +1,11 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
. "$(dirname -- "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
# Only run if Husky is enabled
|
||||||
|
if [ "$HUSKY_ENABLED" = "1" ] || [ -f .husky-enabled ]; then
|
||||||
|
echo "Running commit-msg hooks..."
|
||||||
|
npx commitlint --edit "$1"
|
||||||
|
else
|
||||||
|
echo "Husky commit-msg hook skipped (not enabled)"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
11
.husky/pre-commit
Executable file
11
.husky/pre-commit
Executable file
@@ -0,0 +1,11 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
. "$(dirname -- "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
# Only run if Husky is enabled
|
||||||
|
if [ "$HUSKY_ENABLED" = "1" ] || [ -f .husky-enabled ]; then
|
||||||
|
echo "Running pre-commit hooks..."
|
||||||
|
npm run lint-fix
|
||||||
|
else
|
||||||
|
echo "Husky pre-commit hook skipped (not enabled)"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
27
.husky/pre-push
Executable file
27
.husky/pre-push
Executable file
@@ -0,0 +1,27 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Husky Pre-push Hook
|
||||||
|
# Runs Build Architecture Guard to check commits being pushed
|
||||||
|
#
|
||||||
|
. "$(dirname -- "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
echo "🔍 Running Build Architecture Guard (pre-push)..."
|
||||||
|
|
||||||
|
# Get the remote branch we're pushing to
|
||||||
|
REMOTE_BRANCH="origin/$(git rev-parse --abbrev-ref HEAD)"
|
||||||
|
|
||||||
|
# Check if remote branch exists
|
||||||
|
if git show-ref --verify --quiet "refs/remotes/$REMOTE_BRANCH"; then
|
||||||
|
RANGE="$REMOTE_BRANCH...HEAD"
|
||||||
|
else
|
||||||
|
# If remote branch doesn't exist, check last commit
|
||||||
|
RANGE="HEAD~1..HEAD"
|
||||||
|
fi
|
||||||
|
|
||||||
|
bash ./scripts/build-arch-guard.sh --range "$RANGE" || {
|
||||||
|
echo
|
||||||
|
echo "💡 To bypass this check for emergency pushes, use:"
|
||||||
|
echo " git push --no-verify"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
495
BUILDING.md
495
BUILDING.md
File diff suppressed because it is too large
Load Diff
53
CHANGELOG.md
53
CHANGELOG.md
@@ -5,72 +5,89 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [1.0.3] - 2025.07.12
|
## [1.0.7] - 2025.08.18
|
||||||
### Changed
|
|
||||||
- Photo is pinned to profile mode
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Deep link URLs (and other prod settings)
|
|
||||||
- Error in BVC begin view
|
- Deep link for onboard-meeting-members
|
||||||
|
|
||||||
## [1.0.6] - 2025.08.09
|
## [1.0.6] - 2025.08.09
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Deep link errors where none would validate
|
- Deep link errors where none would validate
|
||||||
|
|
||||||
|
|
||||||
## [1.0.5] - 2025.07.24
|
## [1.0.5] - 2025.07.24
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Export & import of contacts corrupted contact methods
|
- Export & import of contacts corrupted contact methods
|
||||||
|
|
||||||
|
|
||||||
## [1.0.4] - 2025.07.20 - 002f2407208d56cc59c0aa7c880535ae4cbace8b
|
## [1.0.4] - 2025.07.20 - 002f2407208d56cc59c0aa7c880535ae4cbace8b
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Deep link for invite-one-accept
|
- Deep link for invite-one-accept
|
||||||
|
|
||||||
|
|
||||||
## [1.0.3] - 2025.07.12 - a9a8ba217cd6015321911e98e6843e988dc2c4ae
|
## [1.0.3] - 2025.07.12 - a9a8ba217cd6015321911e98e6843e988dc2c4ae
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Photo is pinned to profile mode
|
- Photo is pinned to profile mode
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Deep link URLs (and other prod settings)
|
- Deep link URLs (and other prod settings)
|
||||||
- Error in BVC begin view
|
- Error in BVC begin view
|
||||||
|
|
||||||
|
|
||||||
## [1.0.2] - 2025.06.20 - 276e0a741bc327de3380c4e508cccb7fee58c06d
|
## [1.0.2] - 2025.06.20 - 276e0a741bc327de3380c4e508cccb7fee58c06d
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Version on feed title
|
- Version on feed title
|
||||||
|
|
||||||
|
|
||||||
## [1.0.1] - 2025.06.20
|
## [1.0.1] - 2025.06.20
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Allow a user to block someone else's content from view
|
- Allow a user to block someone else's content from view
|
||||||
|
|
||||||
|
|
||||||
## [1.0.0] - 2025.06.20 - 5aa693de6337e5dbb278bfddc6bd39094bc14f73
|
## [1.0.0] - 2025.06.20 - 5aa693de6337e5dbb278bfddc6bd39094bc14f73
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Web-oriented migration from IndexedDB to SQLite
|
- Web-oriented migration from IndexedDB to SQLite
|
||||||
|
|
||||||
|
|
||||||
## [0.5.8]
|
## [0.5.8]
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- /deep-link/ path for URLs that are shared with people
|
- /deep-link/ path for URLs that are shared with people
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- External links now go to /deep-link/...
|
- External links now go to /deep-link/...
|
||||||
- Feed visuals now have arrow imagery from giver to receiver
|
- Feed visuals now have arrow imagery from giver to receiver
|
||||||
|
|
||||||
|
|
||||||
## [0.4.7]
|
## [0.4.7]
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Cameras everywhere
|
- Cameras everywhere
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- IndexedDB -> SQLite
|
- IndexedDB -> SQLite
|
||||||
|
|
||||||
|
|
||||||
## [0.4.5] - 2025.02.23
|
## [0.4.5] - 2025.02.23
|
||||||
### Added
|
|
||||||
- Total amounts of gives on project page
|
|
||||||
### Changed in DB or environment
|
|
||||||
- Requires Endorser.ch version 4.2.6+
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Total amounts of gives on project page
|
||||||
|
|
||||||
|
### Changed in DB or environment
|
||||||
|
|
||||||
|
- Requires Endorser.ch version 4.2.6+
|
||||||
|
|
||||||
## [0.4.4] - 2025.02.17
|
## [0.4.4] - 2025.02.17
|
||||||
|
|
||||||
|
|||||||
290
README-BUILD-GUARD.md
Normal file
290
README-BUILD-GUARD.md
Normal file
@@ -0,0 +1,290 @@
|
|||||||
|
# Build Architecture Guard - Husky Implementation
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The Build Architecture Guard protects your build system by enforcing
|
||||||
|
documentation requirements through **Git hooks**. When you modify
|
||||||
|
build-critical files, the system automatically blocks commits/pushes
|
||||||
|
until you update `BUILDING.md`.
|
||||||
|
|
||||||
|
## 🎯 **Why Husky-Only?**
|
||||||
|
|
||||||
|
**Advantages:**
|
||||||
|
|
||||||
|
- ✅ **Immediate feedback** - Hooks run before commit/push
|
||||||
|
- ✅ **Works everywhere** - No server-side CI/CD required
|
||||||
|
- ✅ **Simple setup** - One tool, one configuration
|
||||||
|
- ✅ **Fast execution** - No network delays or server queues
|
||||||
|
- ✅ **Offline support** - Works without internet connection
|
||||||
|
|
||||||
|
**Trade-offs:**
|
||||||
|
|
||||||
|
- ⚠️ **Can be bypassed** - `git commit --no-verify` or `git push --no-verify`
|
||||||
|
- ⚠️ **Developer discipline** - Relies on team following the rules
|
||||||
|
|
||||||
|
## 🏗️ **Architecture**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Developer Workflow:
|
||||||
|
1. Modify build files (scripts/, vite.config.*, etc.)
|
||||||
|
2. Try to commit → Husky pre-commit hook runs
|
||||||
|
3. Guard script checks if BUILDING.md was updated
|
||||||
|
4. ✅ Commit succeeds if docs updated
|
||||||
|
5. ❌ Commit blocked if docs missing
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 **Quick Start**
|
||||||
|
|
||||||
|
### 1. Install Dependencies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm run prepare # Sets up Husky hooks
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Test the System
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Modify a build file without updating BUILDING.md
|
||||||
|
echo "# test" >> scripts/test.sh
|
||||||
|
|
||||||
|
# Try to commit (should be blocked)
|
||||||
|
git add scripts/test.sh
|
||||||
|
git commit -m "test: add build script"
|
||||||
|
# ❌ Hook blocks commit with helpful message
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Fix and Retry
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Update BUILDING.md with your changes
|
||||||
|
echo "## New Build Script" >> BUILDING.md
|
||||||
|
echo "Added test.sh for testing purposes" >> BUILDING.md
|
||||||
|
|
||||||
|
# Now commit should succeed
|
||||||
|
git add BUILDING.md
|
||||||
|
git commit -m "feat: add test build script with docs"
|
||||||
|
# ✅ Commit succeeds
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 **How It Works**
|
||||||
|
|
||||||
|
### Pre-commit Hook (`.husky/pre-commit`)
|
||||||
|
|
||||||
|
- **When**: Every `git commit`
|
||||||
|
- **What**: Runs `./scripts/build-arch-guard.sh --staged`
|
||||||
|
- **Result**: Blocks commit if build files changed without BUILDING.md update
|
||||||
|
|
||||||
|
### Pre-push Hook (`.husky/pre-push`)
|
||||||
|
|
||||||
|
- **When**: Every `git push`
|
||||||
|
- **What**: Runs `./scripts/build-arch-guard.sh --range`
|
||||||
|
- **Result**: Blocks push if commits contain undocumented build changes
|
||||||
|
|
||||||
|
### Guard Script (`scripts/build-arch-guard.sh`)
|
||||||
|
|
||||||
|
- **Detects**: Changes to build-sensitive file patterns
|
||||||
|
- **Validates**: BUILDING.md was updated alongside changes
|
||||||
|
- **Reports**: Clear error messages with guidance
|
||||||
|
|
||||||
|
## 📁 **Protected File Patterns**
|
||||||
|
|
||||||
|
The guard script monitors these paths for changes:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Build Configuration:
|
||||||
|
├── vite.config.* # Vite configuration
|
||||||
|
├── capacitor.config.ts # Capacitor configuration
|
||||||
|
├── package.json # Package configuration
|
||||||
|
├── package-lock.json # Lock files
|
||||||
|
├── yarn.lock
|
||||||
|
└── pnpm-lock.yaml
|
||||||
|
|
||||||
|
Build Scripts:
|
||||||
|
├── scripts/** # All build and automation scripts
|
||||||
|
├── electron/** # Electron build files
|
||||||
|
├── android/** # Android build configuration
|
||||||
|
├── ios/** # iOS build configuration
|
||||||
|
├── sw_scripts/** # Service worker scripts
|
||||||
|
└── sw_combine.js # Service worker combination
|
||||||
|
|
||||||
|
Deployment:
|
||||||
|
├── Dockerfile # Docker configuration
|
||||||
|
└── docker/** # Docker services
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎭 **Usage Scenarios**
|
||||||
|
|
||||||
|
### Scenario 1: Adding a New Build Script
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# ❌ This will be blocked
|
||||||
|
echo '#!/bin/bash' > scripts/new-build.sh
|
||||||
|
git add scripts/new-build.sh
|
||||||
|
git commit -m "feat: add new build script"
|
||||||
|
# Hook blocks: "Build-sensitive files changed but BUILDING.md not updated"
|
||||||
|
|
||||||
|
# ✅ This will succeed
|
||||||
|
echo '#!/bin/bash' > scripts/new-build.sh
|
||||||
|
echo '## New Build Script' >> BUILDING.md
|
||||||
|
echo 'Added new-build.sh for feature X' >> BUILDING.md
|
||||||
|
git add scripts/new-build.sh BUILDING.md
|
||||||
|
git commit -m "feat: add new build script with docs"
|
||||||
|
# ✅ Commit succeeds
|
||||||
|
```
|
||||||
|
|
||||||
|
### Scenario 2: Updating Vite Configuration
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# ❌ This will be blocked
|
||||||
|
echo 'export default { newOption: true }' >> vite.config.ts
|
||||||
|
git add vite.config.ts
|
||||||
|
git commit -m "config: add new vite option"
|
||||||
|
# Hook blocks: "Build-sensitive files changed but BUILDING.md not updated"
|
||||||
|
|
||||||
|
# ✅ This will succeed
|
||||||
|
echo 'export default { newOption: true }' >> vite.config.ts
|
||||||
|
echo '### New Vite Option' >> BUILDING.md
|
||||||
|
echo 'Added newOption for improved performance' >> BUILDING.md
|
||||||
|
git add vite.config.ts BUILDING.md
|
||||||
|
git commit -m "config: add new vite option with docs"
|
||||||
|
# ✅ Commit succeeds
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚨 **Emergency Bypass**
|
||||||
|
|
||||||
|
**⚠️ Use sparingly and only for emergencies:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Skip pre-commit hook
|
||||||
|
git commit -m "emergency: critical fix" --no-verify
|
||||||
|
|
||||||
|
# Skip pre-push hook
|
||||||
|
git push --no-verify
|
||||||
|
|
||||||
|
# Remember to update BUILDING.md later!
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔍 **Troubleshooting**
|
||||||
|
|
||||||
|
### Hooks Not Running
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Reinstall hooks
|
||||||
|
npm run prepare
|
||||||
|
|
||||||
|
# Check hook files exist and are executable
|
||||||
|
ls -la .husky/
|
||||||
|
chmod +x .husky/*
|
||||||
|
|
||||||
|
# Verify Git hooks path
|
||||||
|
git config core.hooksPath
|
||||||
|
# Should show: .husky
|
||||||
|
```
|
||||||
|
|
||||||
|
### Guard Script Issues
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Test guard script manually
|
||||||
|
./scripts/build-arch-guard.sh --help
|
||||||
|
|
||||||
|
# Check script permissions
|
||||||
|
chmod +x scripts/build-arch-guard.sh
|
||||||
|
|
||||||
|
# Test with specific files
|
||||||
|
./scripts/build-arch-guard.sh --staged
|
||||||
|
```
|
||||||
|
|
||||||
|
### False Positives
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# If guard blocks legitimate changes, check:
|
||||||
|
# 1. Are you modifying a protected file pattern?
|
||||||
|
# 2. Did you update BUILDING.md?
|
||||||
|
# 3. Is BUILDING.md staged for commit?
|
||||||
|
|
||||||
|
# View what the guard sees
|
||||||
|
git diff --name-only --cached
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 **Best Practices**
|
||||||
|
|
||||||
|
### For Developers
|
||||||
|
|
||||||
|
1. **Update BUILDING.md first** - Document changes before implementing
|
||||||
|
2. **Test locally** - Run `./scripts/build-arch-guard.sh --staged` before committing
|
||||||
|
3. **Use descriptive commits** - Include context about build changes
|
||||||
|
4. **Don't bypass lightly** - Only use `--no-verify` for true emergencies
|
||||||
|
|
||||||
|
### For Teams
|
||||||
|
|
||||||
|
1. **Document the system** - Ensure everyone understands the guard
|
||||||
|
2. **Review BUILDING.md updates** - Verify documentation quality
|
||||||
|
3. **Monitor bypass usage** - Track when hooks are skipped
|
||||||
|
4. **Regular audits** - Check that BUILDING.md stays current
|
||||||
|
|
||||||
|
### For Maintainers
|
||||||
|
|
||||||
|
1. **Update protected patterns** - Modify `scripts/build-arch-guard.sh` as needed
|
||||||
|
2. **Monitor effectiveness** - Track how often the guard catches issues
|
||||||
|
3. **Team training** - Help developers understand the system
|
||||||
|
4. **Continuous improvement** - Refine patterns and error messages
|
||||||
|
|
||||||
|
## 🔄 **Customization**
|
||||||
|
|
||||||
|
### Adding New Protected Paths
|
||||||
|
|
||||||
|
Edit `scripts/build-arch-guard.sh`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
SENSITIVE=(
|
||||||
|
# ... existing patterns ...
|
||||||
|
"new-pattern/**" # Add your new pattern
|
||||||
|
"*.config.js" # Add file extensions
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Modifying Error Messages
|
||||||
|
|
||||||
|
Edit the guard script to customize:
|
||||||
|
|
||||||
|
- Error message content
|
||||||
|
- File pattern matching
|
||||||
|
- Documentation requirements
|
||||||
|
- Bypass instructions
|
||||||
|
|
||||||
|
### Adding New Validation Rules
|
||||||
|
|
||||||
|
Extend the guard script to check for:
|
||||||
|
|
||||||
|
- Specific file content patterns
|
||||||
|
- Required documentation sections
|
||||||
|
- Commit message formats
|
||||||
|
- Branch naming conventions
|
||||||
|
|
||||||
|
## 📚 **Integration with PR Template**
|
||||||
|
|
||||||
|
The `pull_request_template.md` works with this system by:
|
||||||
|
|
||||||
|
- **Guiding developers** through required documentation
|
||||||
|
- **Ensuring consistency** across all build changes
|
||||||
|
- **Providing checklist** for comprehensive updates
|
||||||
|
- **Supporting L1/L2/L3** change classification
|
||||||
|
|
||||||
|
## 🎯 **Success Metrics**
|
||||||
|
|
||||||
|
Track the effectiveness of your Build Architecture Guard:
|
||||||
|
|
||||||
|
- **Hook execution rate** - How often hooks run successfully
|
||||||
|
- **Bypass frequency** - How often `--no-verify` is used
|
||||||
|
- **Documentation quality** - BUILDING.md stays current
|
||||||
|
- **Build failures** - Fewer issues from undocumented changes
|
||||||
|
- **Team adoption** - Developers follow the process
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active protection system
|
||||||
|
**Architecture**: Client-side Git hooks only
|
||||||
|
**Dependencies**: Husky, Git, Bash
|
||||||
|
**Maintainer**: Development team
|
||||||
|
**Related**: `pull_request_template.md`, `scripts/build-arch-guard.sh`
|
||||||
82
README-PR-TEMPLATE.md
Normal file
82
README-PR-TEMPLATE.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# Pull Request Template
|
||||||
|
|
||||||
|
## Location
|
||||||
|
|
||||||
|
The Build Architecture Guard PR template is located at:
|
||||||
|
|
||||||
|
- **`pull_request_template.md`** (root directory)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
When creating a pull request in Gitea, this template will automatically populate the PR description with the required checklist.
|
||||||
|
|
||||||
|
## Template Features
|
||||||
|
|
||||||
|
### Change Level Classification
|
||||||
|
|
||||||
|
- **L1**: Minor changes, documentation updates
|
||||||
|
- **L2**: Moderate changes, new features, environment changes
|
||||||
|
- **L3**: Major changes, architecture changes, new platforms
|
||||||
|
|
||||||
|
### Required Fields for All Levels
|
||||||
|
|
||||||
|
- Change level selection
|
||||||
|
- Scope and impact description
|
||||||
|
- Commands executed and their output
|
||||||
|
- Documentation updates (BUILDING.md)
|
||||||
|
- Rollback verification steps
|
||||||
|
|
||||||
|
### Additional Requirements for L3
|
||||||
|
|
||||||
|
- **ADR link**: Must provide URL to Architectural Decision Record
|
||||||
|
- **Artifacts with SHA256**: Must list artifacts with cryptographic hashes
|
||||||
|
|
||||||
|
## Integration
|
||||||
|
|
||||||
|
This template works with:
|
||||||
|
|
||||||
|
- **Gitea Actions**: `.gitea/workflows/build-guard.yml`
|
||||||
|
- **Client-side hooks**: `.husky/` pre-commit and pre-push hooks
|
||||||
|
- **Guard script**: `scripts/build-arch-guard.sh`
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
### Change Level
|
||||||
|
- [x] Level: **L2**
|
||||||
|
|
||||||
|
**Why:** Adding new build script for Docker deployment
|
||||||
|
|
||||||
|
### Scope & Impact
|
||||||
|
- [x] Files & platforms touched: scripts/build-docker.sh,
|
||||||
|
BUILDING.md
|
||||||
|
- [x] Risk triggers: Docker build process changes
|
||||||
|
- [x] Mitigations/validation done: Tested on local Docker environment
|
||||||
|
|
||||||
|
### Commands Run
|
||||||
|
- [x] Web: `npm run build:web:docker` ✅
|
||||||
|
- [x] Docker: `docker build -t test-image .` ✅
|
||||||
|
|
||||||
|
### Artifacts
|
||||||
|
- [x] Names + **sha256** of artifacts/installers:
|
||||||
|
|
||||||
|
Artifacts:
|
||||||
|
```text
|
||||||
|
test-image.tar a1b2c3d4e5f6...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docs
|
||||||
|
- [x] **BUILDING.md** updated (sections): Docker deployment
|
||||||
|
- [x] Troubleshooting updated: Added Docker troubleshooting section
|
||||||
|
|
||||||
|
### Rollback
|
||||||
|
- [x] Verified steps to restore previous behavior:
|
||||||
|
1. `git revert HEAD`
|
||||||
|
2. `docker rmi test-image`
|
||||||
|
3. Restore previous BUILDING.md
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Note**: This template is enforced by the Build Architecture Guard
|
||||||
|
system. Complete all required fields to ensure your PR can be merged.
|
||||||
299
README.md
299
README.md
@@ -1,243 +1,118 @@
|
|||||||
# TimeSafari.app - Crowd-Funder for Time - PWA
|
# Time Safari Application
|
||||||
|
|
||||||
[Time Safari](https://timesafari.org/) allows people to ease into collaboration: start with expressions of gratitude
|
**Author**: Matthew Raymer
|
||||||
and expand to crowd-fund with time & money, then record and see the impact of contributions.
|
**Version**: 1.0.8-beta
|
||||||
|
**Description**: Time Safari Application
|
||||||
|
|
||||||
## Roadmap
|
## 🛡️ Build Architecture Guard
|
||||||
|
|
||||||
See [ClickUp](https://sharing.clickup.com/9014278710/l/h/8cmnyhp-174/10573fec74e2ba0) for current priorities.
|
This project uses **Husky Git hooks** to protect the build system
|
||||||
|
architecture. When you modify build-critical files, the system
|
||||||
|
automatically blocks commits until you update `BUILDING.md`.
|
||||||
|
|
||||||
## Setup & Building
|
### Quick Setup
|
||||||
|
|
||||||
Quick start:
|
```bash
|
||||||
|
npm run guard:setup # Install and activate the guard
|
||||||
|
```
|
||||||
|
|
||||||
* For setup, we recommend [pkgx](https://pkgx.dev), which installs what you need (either automatically or with the `dev` command). Core dependencies are typescript & npm; when building for other platforms, you'll need other things such as those in the pkgx.yaml & BUILDING.md files.
|
### How It Works
|
||||||
|
|
||||||
|
- **Pre-commit**: Blocks commits if build files changed without
|
||||||
|
BUILDING.md updates
|
||||||
|
- **Pre-push**: Blocks pushes if commits contain undocumented build
|
||||||
|
changes
|
||||||
|
- **Protected paths**: `scripts/`, `vite.config.*`, `electron/`,
|
||||||
|
`android/`, `ios/`, etc.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Test the guard manually
|
||||||
|
npm run guard:test
|
||||||
|
|
||||||
|
# Emergency bypass (use sparingly)
|
||||||
|
git commit --no-verify
|
||||||
|
git push --no-verify
|
||||||
|
```
|
||||||
|
|
||||||
|
**📚 Full documentation**: See `README-BUILD-GUARD.md`
|
||||||
|
|
||||||
|
## 🚀 Quick Start
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Node.js 18+
|
||||||
|
- npm, yarn, or pnpm
|
||||||
|
- Git
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
npm run build:web:serve -- --test
|
npm run guard:setup # Sets up Build Architecture Guard
|
||||||
```
|
```
|
||||||
|
|
||||||
To be able to make submissions: go to "profile" (bottom left), go to the bottom and expand "Show Advanced Settings", go to the bottom and to the "Test Page", and finally "Become User 0" to see all the functionality.
|
### Development
|
||||||
|
|
||||||
See [BUILDING.md](BUILDING.md) for comprehensive build instructions for all platforms (Web, Electron, iOS, Android, Docker).
|
|
||||||
|
|
||||||
## Development Database Clearing
|
|
||||||
|
|
||||||
TimeSafari provides a simple script-based approach to clear the local database (not the claim server) for development purposes.
|
|
||||||
|
|
||||||
## Logging Configuration
|
|
||||||
|
|
||||||
TimeSafari supports configurable logging levels via the `VITE_LOG_LEVEL` environment variable. This allows developers to control console output verbosity without modifying code.
|
|
||||||
|
|
||||||
### Quick Usage
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Show only errors
|
npm run build:web:dev # Build web version
|
||||||
VITE_LOG_LEVEL=error npm run dev
|
npm run build:ios:test # Build iOS test version
|
||||||
|
npm run build:android:test # Build Android test version
|
||||||
# Show warnings and errors
|
npm run build:electron:dev # Build Electron dev version
|
||||||
VITE_LOG_LEVEL=warn npm run dev
|
|
||||||
|
|
||||||
# Show info, warnings, and errors (default)
|
|
||||||
VITE_LOG_LEVEL=info npm run dev
|
|
||||||
|
|
||||||
# Show all log levels including debug
|
|
||||||
VITE_LOG_LEVEL=debug npm run dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Available Levels
|
### Testing
|
||||||
|
|
||||||
- **`error`**: Critical errors only
|
|
||||||
- **`warn`**: Warnings and errors (default for production web)
|
|
||||||
- **`info`**: Info, warnings, and errors (default for development/capacitor)
|
|
||||||
- **`debug`**: All log levels including verbose debugging
|
|
||||||
|
|
||||||
See [Logging Configuration Guide](doc/logging-configuration.md) for complete details.
|
|
||||||
|
|
||||||
### Quick Usage
|
|
||||||
```bash
|
|
||||||
# Run the database clearing script
|
|
||||||
./scripts/clear-database.sh
|
|
||||||
|
|
||||||
# Then restart your development server
|
|
||||||
npm run build:electron:dev # For Electron
|
|
||||||
npm run build:web:dev # For Web
|
|
||||||
```
|
|
||||||
|
|
||||||
### What It Does
|
|
||||||
|
|
||||||
#### **Electron (Desktop App)**
|
|
||||||
- Automatically finds and clears the SQLite database files
|
|
||||||
- Works on Linux, macOS, and Windows
|
|
||||||
- Clears all data and forces fresh migrations on next startup
|
|
||||||
|
|
||||||
#### **Web Browser**
|
|
||||||
- Provides instructions for using custom browser data directories
|
|
||||||
- Shows manual clearing via browser DevTools
|
|
||||||
- Ensures reliable database clearing without browser complications
|
|
||||||
|
|
||||||
### Safety Features
|
|
||||||
- ✅ **Interactive Script**: Guides you through the process
|
|
||||||
- ✅ **Platform Detection**: Automatically detects your OS
|
|
||||||
- ✅ **Clear Instructions**: Step-by-step guidance for each platform
|
|
||||||
- ✅ **Safe Paths**: Only clears TimeSafari-specific data
|
|
||||||
|
|
||||||
### Manual Commands (if needed)
|
|
||||||
|
|
||||||
#### **Electron Database Location**
|
|
||||||
```bash
|
|
||||||
# Linux
|
|
||||||
rm -rf ~/.config/TimeSafari/*
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
rm -rf ~/Library/Application\ Support/TimeSafari/*
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
rmdir /s /q %APPDATA%\TimeSafari
|
|
||||||
```
|
|
||||||
|
|
||||||
#### **Web Browser (Custom Data Directory)**
|
|
||||||
```bash
|
|
||||||
# Create isolated browser profile
|
|
||||||
mkdir ~/timesafari-dev-data
|
|
||||||
```
|
|
||||||
|
|
||||||
## Domain Configuration
|
|
||||||
|
|
||||||
TimeSafari uses a centralized domain configuration system to ensure consistent
|
|
||||||
URL generation across all environments. This prevents localhost URLs from
|
|
||||||
appearing in shared links during development.
|
|
||||||
|
|
||||||
### Key Features
|
|
||||||
- ✅ **Production URLs for Sharing**: All copy link buttons use production domain
|
|
||||||
- ✅ **Environment-Specific Internal URLs**: Internal operations use appropriate
|
|
||||||
environment URLs
|
|
||||||
- ✅ **Single Point of Control**: Change domain in one place for entire app
|
|
||||||
- ✅ **Type-Safe Configuration**: Full TypeScript support
|
|
||||||
|
|
||||||
### Quick Reference
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// For sharing functionality (environment-specific)
|
|
||||||
import { APP_SERVER } from "@/constants/app";
|
|
||||||
const shareLink = `${APP_SERVER}/deep-link/claim/123`;
|
|
||||||
|
|
||||||
// For internal operations (environment-specific)
|
|
||||||
import { APP_SERVER } from "@/constants/app";
|
|
||||||
const apiUrl = `${APP_SERVER}/api/claim/123`;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
|
|
||||||
- [Constants and Configuration](src/constants/app.ts) - Core constants
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
See [TESTING.md](test-playwright/TESTING.md) for detailed test instructions.
|
|
||||||
|
|
||||||
## Asset Management
|
|
||||||
|
|
||||||
TimeSafari uses a standardized asset configuration system for consistent
|
|
||||||
icon and splash screen generation across all platforms.
|
|
||||||
|
|
||||||
### Asset Sources
|
|
||||||
|
|
||||||
- **Single source of truth**: `resources/` directory (Capacitor default)
|
|
||||||
- **Source files**: `icon.png`, `splash.png`, `splash_dark.png`
|
|
||||||
- **Format**: PNG or SVG files for optimal quality
|
|
||||||
|
|
||||||
### Asset Generation
|
|
||||||
|
|
||||||
- **Configuration**: `config/assets/capacitor-assets.config.json`
|
|
||||||
- **Schema validation**: `config/assets/schema.json`
|
|
||||||
- **Build-time generation**: Platform assets generated via `capacitor-assets`
|
|
||||||
- **No VCS commits**: Generated assets are never committed to version control
|
|
||||||
|
|
||||||
### Development Commands
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Generate/update asset configurations
|
npm run test:web # Run web tests
|
||||||
npm run assets:config
|
npm run test:mobile # Run mobile tests
|
||||||
|
npm run test:all # Run all tests
|
||||||
# Validate asset configurations
|
|
||||||
npm run assets:validate
|
|
||||||
|
|
||||||
# Clean generated platform assets (local dev only)
|
|
||||||
npm run assets:clean
|
|
||||||
|
|
||||||
# Build with asset generation
|
|
||||||
npm run build:native
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Platform Support
|
## 📁 Project Structure
|
||||||
|
|
||||||
- **Android**: Adaptive icons with foreground/background, monochrome support
|
```text
|
||||||
- **iOS**: LaunchScreen storyboard preferred, splash assets when needed
|
timesafari/
|
||||||
- **Web**: PWA icons generated during build to `dist/` (not committed)
|
├── 📁 src/ # Source code
|
||||||
|
├── 📁 scripts/ # Build and automation scripts
|
||||||
|
├── 📁 electron/ # Electron configuration
|
||||||
|
├── 📁 android/ # Android configuration
|
||||||
|
├── 📁 ios/ # iOS configuration
|
||||||
|
├── 📁 .husky/ # Git hooks (Build Architecture Guard)
|
||||||
|
├── 📄 BUILDING.md # Build system documentation
|
||||||
|
├── 📄 pull_request_template.md # PR template
|
||||||
|
└── 📄 README-BUILD-GUARD.md # Guard system documentation
|
||||||
|
```
|
||||||
|
|
||||||
### Font Awesome Icons
|
## 🔧 Build System
|
||||||
|
|
||||||
To add a Font Awesome icon, add to `fontawesome.ts` and reference with
|
This project supports multiple platforms:
|
||||||
`font-awesome` element and `icon` attribute with the hyphenated name.
|
|
||||||
|
|
||||||
## Other
|
- **Web**: Vite-based build with service worker support
|
||||||
|
- **Mobile**: Capacitor-based iOS and Android builds
|
||||||
|
- **Desktop**: Electron-based cross-platform desktop app
|
||||||
|
- **Docker**: Containerized deployment options
|
||||||
|
|
||||||
### Reference Material
|
## 📚 Documentation
|
||||||
|
|
||||||
* Notifications can be type of `toast` (self-dismiss), `info`, `success`, `warning`, and `danger`.
|
- **`BUILDING.md`** - Complete build system guide
|
||||||
They are done via [notiwind](https://www.npmjs.com/package/notiwind) and set up in App.vue.
|
- **`README-BUILD-GUARD.md`** - Build Architecture Guard documentation
|
||||||
|
- **`pull_request_template.md`** - PR template for build changes
|
||||||
|
|
||||||
* [Customize Vue configuration](https://cli.vuejs.org/config/).
|
## 🤝 Contributing
|
||||||
|
|
||||||
* If you are deploying in a subdirectory, add it to `publicPath` in vue.config.js, eg: `publicPath: "/app/time-tracker/",`
|
1. **Follow the Build Architecture Guard** - Update BUILDING.md when modifying build files
|
||||||
|
2. **Use the PR template** - Complete the checklist for build-related changes
|
||||||
|
3. **Test your changes** - Ensure builds work on affected platforms
|
||||||
|
4. **Document updates** - Keep BUILDING.md current and accurate
|
||||||
|
|
||||||
### Code Organization
|
## 📄 License
|
||||||
|
|
||||||
The project uses a centralized approach to type definitions and interfaces:
|
[Add your license information here]
|
||||||
|
|
||||||
* `src/interfaces/` - Contains all TypeScript interfaces and type definitions
|
---
|
||||||
* `deepLinks.ts` - Deep linking type system and Zod validation schemas
|
|
||||||
* `give.ts` - Give-related interfaces and type definitions
|
|
||||||
* `claims.ts` - Claim-related interfaces and verifiable credentials
|
|
||||||
* `common.ts` - Shared interfaces and utility types
|
|
||||||
* Other domain-specific interface files
|
|
||||||
|
|
||||||
Key principles:
|
**Note**: The Build Architecture Guard is active and will block
|
||||||
- All interfaces and types are defined in the interfaces folder
|
commits/pushes that modify build files without proper documentation
|
||||||
- Zod schemas are used for runtime validation and type generation
|
updates. See `README-BUILD-GUARD.md` for complete details.
|
||||||
- Domain-specific interfaces are separated into their own files
|
|
||||||
- Common interfaces are shared through `common.ts`
|
|
||||||
- Type definitions are generated from Zod schemas where possible
|
|
||||||
|
|
||||||
### Database Architecture
|
|
||||||
|
|
||||||
The application uses a platform-agnostic database layer with Vue mixins for service access:
|
|
||||||
|
|
||||||
* `src/services/PlatformService.ts` - Database interface definition
|
|
||||||
* `src/services/PlatformServiceFactory.ts` - Platform-specific service factory
|
|
||||||
* `src/services/AbsurdSqlDatabaseService.ts` - SQLite implementation
|
|
||||||
* `src/utils/PlatformServiceMixin.ts` - Vue mixin for database access with caching
|
|
||||||
* `src/db/` - Legacy Dexie database (migration in progress)
|
|
||||||
|
|
||||||
**Development Guidelines**:
|
|
||||||
|
|
||||||
- Always use `PlatformServiceMixin` for database operations in components
|
|
||||||
- Test with PlatformServiceMixin for new features
|
|
||||||
- Use migration tools for data transfer between systems
|
|
||||||
- Leverage mixin's ultra-concise methods: `$db()`, `$exec()`, `$one()`, `$contacts()`, `$settings()`
|
|
||||||
|
|
||||||
**Architecture Decision**: The project uses Vue mixins over Composition API composables for platform service access. See [Architecture Decisions](doc/architecture-decisions.md) for detailed rationale.
|
|
||||||
|
|
||||||
### Kudos
|
|
||||||
|
|
||||||
Gifts make the world go 'round!
|
|
||||||
|
|
||||||
* [WebStorm by JetBrains](https://www.jetbrains.com/webstorm/) for the free open-source license
|
|
||||||
* [Máximo Fernández](https://medium.com/@maxfarenas) for the 3D [code](https://github.com/maxfer03/vue-three-ns) and [explanatory post](https://medium.com/nicasource/building-an-interactive-web-portfolio-with-vue-three-js-part-three-implementing-three-js-452cb375ef80)
|
|
||||||
* [Many tools & libraries](https://gitea.anomalistdesign.com/trent_larson/crowd-funder-for-time-pwa/src/branch/master/package.json#L10) such as Nodejs.org, IntelliJ Idea, Veramo.io, Vuejs.org, threejs.org
|
|
||||||
* [Bush 3D model](https://sketchfab.com/3d-models/lupine-plant-bf30f1110c174d4baedda0ed63778439)
|
|
||||||
* [Forest floor image](https://www.goodfreephotos.com/albums/textures/leafy-autumn-forest-floor.jpg)
|
|
||||||
* Time Safari logo assisted by [DALL-E in ChatGPT](https://chat.openai.com/g/g-2fkFE8rbu-dall-e)
|
|
||||||
* [DiceBear](https://www.dicebear.com/licenses/) and [Avataaars](https://www.dicebear.com/styles/avataaars/#details) for human-looking identicons
|
|
||||||
* Some gratitude prompts thanks to [Develop Good Habits](https://www.developgoodhabits.com/gratitude-journal-prompts/)
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
|
|
||||||
# What to do about storage for native apps?
|
# What to do about storage for native apps?
|
||||||
|
|
||||||
|
|
||||||
## Problem
|
## Problem
|
||||||
|
|
||||||
We can't trust iOS IndexedDB to persist. I want to start delivering an app to people now, in preparation for presentations mid-June: Rotary on June 12 and Porcfest on June 17.
|
We can't trust iOS IndexedDB to persist. I want to start delivering an app to people now, in preparation for presentations mid-June: Rotary on June 12 and Porcfest on June 17.
|
||||||
@@ -14,7 +13,6 @@ We can't trust iOS IndexedDB to persist. I want to start delivering an app to pe
|
|||||||
|
|
||||||
Also, with sensitive data, the accounts info should be encrypted.
|
Also, with sensitive data, the accounts info should be encrypted.
|
||||||
|
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
|
|
||||||
* There is a community [SQLite plugin for Capacitor](https://github.com/capacitor-community/sqlite) with encryption by [SQLCipher](https://github.com/sqlcipher/sqlcipher).
|
* There is a community [SQLite plugin for Capacitor](https://github.com/capacitor-community/sqlite) with encryption by [SQLCipher](https://github.com/sqlcipher/sqlcipher).
|
||||||
@@ -29,16 +27,12 @@ Also, with sensitive data, the accounts info should be encrypted.
|
|||||||
|
|
||||||
* Not an option yet: Dexie may support SQLite in [a future version](https://dexie.org/roadmap/dexie5.0).
|
* Not an option yet: Dexie may support SQLite in [a future version](https://dexie.org/roadmap/dexie5.0).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Current Plan
|
# Current Plan
|
||||||
|
|
||||||
* Implement SQLite for Capacitor & web, with encryption. That will allow us to test quickly and keep the same interface for native & web, but we don't deal with migrations for current web users.
|
* Implement SQLite for Capacitor & web, with encryption. That will allow us to test quickly and keep the same interface for native & web, but we don't deal with migrations for current web users.
|
||||||
|
|
||||||
* After that is delivered, write a migration for current web users from IndexedDB to SQLite.
|
* After that is delivered, write a migration for current web users from IndexedDB to SQLite.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Current method calls
|
# Current method calls
|
||||||
|
|
||||||
... which is not 100% complete because the AI that generated thus claimed no usage of 'temp' DB.
|
... which is not 100% complete because the AI that generated thus claimed no usage of 'temp' DB.
|
||||||
@@ -80,5 +74,3 @@ Logs operations:
|
|||||||
db.logs.get(todayKey) - Gets logs for a specific day
|
db.logs.get(todayKey) - Gets logs for a specific day
|
||||||
db.logs.update(todayKey, { message: fullMessage }) - Updates logs
|
db.logs.update(todayKey, { message: fullMessage }) - Updates logs
|
||||||
db.logs.clear() - Clears all logs
|
db.logs.clear() - Clears all logs
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
184
TODO.md
Normal file
184
TODO.md
Normal file
@@ -0,0 +1,184 @@
|
|||||||
|
# Test Improvements TODO
|
||||||
|
|
||||||
|
## ImageViewer Mock Units - Completed ✅
|
||||||
|
- [x] Create comprehensive mock units for ImageViewer component
|
||||||
|
- [x] Implement 4 mock levels (Simple, Standard, Complex, Integration)
|
||||||
|
- [x] Fix template structure issues (Teleport/Transition complexity)
|
||||||
|
- [x] Resolve event simulation problems (SupportedEventInterface errors)
|
||||||
|
- [x] Fix platform detection logic (mobile vs desktop)
|
||||||
|
- [x] Implement analytics tracking in integration mock
|
||||||
|
- [x] Achieve 38/39 tests passing (97% success rate)
|
||||||
|
|
||||||
|
## Immediate Test Improvements Needed 🔧
|
||||||
|
|
||||||
|
### 1. Fix Remaining ImageViewer Test
|
||||||
|
- [ ] **Fix mobile share button test** - Vue reactivity issue with computed properties
|
||||||
|
- [ ] Investigate Vue 3 reactivity system for computed properties
|
||||||
|
- [ ] Try different approaches: `nextTick()`, `flushPromises()`, or reactive refs
|
||||||
|
- [ ] Consider using `shallowRef()` for userAgent to force reactivity
|
||||||
|
|
||||||
|
### 2. Event Simulation Improvements
|
||||||
|
- [ ] **Create global event simulation utilities**
|
||||||
|
- [ ] Build `triggerEvent()` helper that works with Vue Test Utils
|
||||||
|
- [ ] Handle `SupportedEventInterface` errors consistently
|
||||||
|
- [ ] Create fallback methods for problematic event types
|
||||||
|
- [ ] **Improve test environment setup**
|
||||||
|
- [ ] Configure proper DOM environment for event simulation
|
||||||
|
- [ ] Mock browser APIs more comprehensively
|
||||||
|
- [ ] Add global test utilities for common patterns
|
||||||
|
|
||||||
|
### 3. Mock Architecture Enhancements
|
||||||
|
- [ ] **Create reusable mock patterns**
|
||||||
|
- [ ] Extract common mock utilities (`createMockUserAgent`, etc.)
|
||||||
|
- [ ] Build mock factory patterns for other components
|
||||||
|
- [ ] Create mock validation helpers
|
||||||
|
- [ ] **Improve mock documentation**
|
||||||
|
- [ ] Add JSDoc comments to all mock functions
|
||||||
|
- [ ] Create usage examples for each mock level
|
||||||
|
- [ ] Document mock limitations and workarounds
|
||||||
|
|
||||||
|
## Component-Specific Test Improvements 🧪
|
||||||
|
|
||||||
|
### 4. Expand Mock Units to Other Components
|
||||||
|
- [ ] **QR Scanner Component**
|
||||||
|
- [ ] Create mock for `WebInlineQRScanner`
|
||||||
|
- [ ] Mock camera permissions and device detection
|
||||||
|
- [ ] Test platform-specific behavior (web vs mobile)
|
||||||
|
- [ ] **Platform Service Components**
|
||||||
|
- [ ] Mock `CapacitorPlatformService`
|
||||||
|
- [ ] Mock `WebPlatformService`
|
||||||
|
- [ ] Mock `ElectronPlatformService`
|
||||||
|
- [ ] **Database Components**
|
||||||
|
- [ ] Mock `AbsurdSqlDatabaseService`
|
||||||
|
- [ ] Test migration scenarios
|
||||||
|
- [ ] Mock IndexedDB operations
|
||||||
|
|
||||||
|
### 5. Integration Test Improvements
|
||||||
|
- [ ] **Cross-component communication**
|
||||||
|
- [ ] Test ImageViewer + QR Scanner integration
|
||||||
|
- [ ] Test platform service + component interactions
|
||||||
|
- [ ] Mock complex user workflows
|
||||||
|
- [ ] **End-to-end scenarios**
|
||||||
|
- [ ] Complete user journeys (scan → view → share)
|
||||||
|
- [ ] Error recovery flows
|
||||||
|
- [ ] Performance testing scenarios
|
||||||
|
|
||||||
|
## Test Infrastructure Improvements 🏗️
|
||||||
|
|
||||||
|
### 6. Test Environment Setup
|
||||||
|
- [ ] **Improve Vitest configuration**
|
||||||
|
- [ ] Add proper DOM environment setup
|
||||||
|
- [ ] Configure global mocks for browser APIs
|
||||||
|
- [ ] Add test utilities for common patterns
|
||||||
|
- [ ] **Create test helpers**
|
||||||
|
- [ ] `createComponentWrapper()` utility
|
||||||
|
- [ ] `mockPlatformService()` helper
|
||||||
|
- [ ] `simulateUserInteraction()` utilities
|
||||||
|
|
||||||
|
### 7. Performance Testing
|
||||||
|
- [ ] **Add performance benchmarks**
|
||||||
|
- [ ] Component render time testing
|
||||||
|
- [ ] Memory usage monitoring
|
||||||
|
- [ ] Image loading performance tests
|
||||||
|
- [ ] **Load testing scenarios**
|
||||||
|
- [ ] Multiple ImageViewer instances
|
||||||
|
- [ ] Large image handling
|
||||||
|
- [ ] Concurrent operations
|
||||||
|
|
||||||
|
## Quality Assurance Improvements 📊
|
||||||
|
|
||||||
|
### 8. Test Coverage Enhancement
|
||||||
|
- [ ] **Add missing test scenarios**
|
||||||
|
- [ ] Edge cases for image formats
|
||||||
|
- [ ] Network error handling
|
||||||
|
- [ ] Accessibility compliance tests
|
||||||
|
- [ ] **Mutation testing**
|
||||||
|
- [ ] Verify test quality with mutation testing
|
||||||
|
- [ ] Ensure tests catch actual bugs
|
||||||
|
- [ ] Improve test reliability
|
||||||
|
|
||||||
|
### 9. Test Documentation
|
||||||
|
- [ ] **Create test guidelines**
|
||||||
|
- [ ] Best practices for Vue component testing
|
||||||
|
- [ ] Mock unit design patterns
|
||||||
|
- [ ] Troubleshooting common test issues
|
||||||
|
- [ ] **Add test examples**
|
||||||
|
- [ ] Example test files for each component type
|
||||||
|
- [ ] Integration test examples
|
||||||
|
- [ ] Performance test examples
|
||||||
|
|
||||||
|
## Advanced Testing Features 🚀
|
||||||
|
|
||||||
|
### 10. Visual Regression Testing
|
||||||
|
- [ ] **Add visual testing**
|
||||||
|
- [ ] Screenshot comparison for ImageViewer
|
||||||
|
- [ ] Visual diff testing for UI changes
|
||||||
|
- [ ] Cross-platform visual consistency
|
||||||
|
- [ ] **Accessibility testing**
|
||||||
|
- [ ] Automated accessibility checks
|
||||||
|
- [ ] Screen reader compatibility tests
|
||||||
|
- [ ] Keyboard navigation testing
|
||||||
|
|
||||||
|
### 11. Contract Testing
|
||||||
|
- [ ] **API contract testing**
|
||||||
|
- [ ] Test component prop contracts
|
||||||
|
- [ ] Event emission contracts
|
||||||
|
- [ ] Service interface contracts
|
||||||
|
- [ ] **Mock contract validation**
|
||||||
|
- [ ] Ensure mocks match real component behavior
|
||||||
|
- [ ] Validate mock completeness
|
||||||
|
- [ ] Test mock accuracy
|
||||||
|
|
||||||
|
## Priority Levels 📋
|
||||||
|
|
||||||
|
### High Priority (Next Sprint)
|
||||||
|
1. Fix mobile share button test
|
||||||
|
2. Create global event simulation utilities
|
||||||
|
3. Expand mock units to QR Scanner component
|
||||||
|
4. Improve test environment setup
|
||||||
|
|
||||||
|
### Medium Priority (Next Month)
|
||||||
|
1. Create reusable mock patterns
|
||||||
|
2. Add performance testing
|
||||||
|
3. Improve test documentation
|
||||||
|
4. Add visual regression testing
|
||||||
|
|
||||||
|
### Low Priority (Future)
|
||||||
|
1. Advanced integration testing
|
||||||
|
2. Contract testing
|
||||||
|
3. Mutation testing
|
||||||
|
4. Cross-platform visual testing
|
||||||
|
|
||||||
|
## Success Metrics 📈
|
||||||
|
|
||||||
|
### Current Status
|
||||||
|
- ✅ **97% test pass rate** (38/39 tests)
|
||||||
|
- ✅ **4 mock levels** implemented
|
||||||
|
- ✅ **Comprehensive coverage** of ImageViewer functionality
|
||||||
|
- ✅ **Behavior-focused testing** approach working
|
||||||
|
|
||||||
|
### Target Metrics
|
||||||
|
- [ ] **100% test pass rate** (fix remaining test)
|
||||||
|
- [ ] **10+ components** with mock units
|
||||||
|
- [ ] **< 100ms** average test execution time
|
||||||
|
- [ ] **90%+ code coverage** for critical components
|
||||||
|
- [ ] **Zero flaky tests** in CI/CD pipeline
|
||||||
|
|
||||||
|
## Notes 📝
|
||||||
|
|
||||||
|
### Lessons Learned
|
||||||
|
- Vue 3 reactivity can be tricky with computed properties in tests
|
||||||
|
- Direct method calls work better than `trigger()` for complex events
|
||||||
|
- Mock levels provide excellent flexibility for different testing needs
|
||||||
|
- Behavior-focused testing is more maintainable than implementation-focused
|
||||||
|
|
||||||
|
### Technical Debt
|
||||||
|
- Some TypeScript linter errors in mock files (non-blocking)
|
||||||
|
- Event simulation needs better abstraction
|
||||||
|
- Test environment could be more robust
|
||||||
|
- Mock documentation could be more comprehensive
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Last updated: 2025-01-07*
|
||||||
|
*Status: Active development*
|
||||||
@@ -31,8 +31,8 @@ android {
|
|||||||
applicationId "app.timesafari.app"
|
applicationId "app.timesafari.app"
|
||||||
minSdkVersion rootProject.ext.minSdkVersion
|
minSdkVersion rootProject.ext.minSdkVersion
|
||||||
targetSdkVersion rootProject.ext.targetSdkVersion
|
targetSdkVersion rootProject.ext.targetSdkVersion
|
||||||
versionCode 39
|
versionCode 40
|
||||||
versionName "1.0.6"
|
versionName "1.0.7"
|
||||||
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
|
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
|
||||||
aaptOptions {
|
aaptOptions {
|
||||||
// Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
|
// Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ buildscript {
|
|||||||
mavenCentral()
|
mavenCentral()
|
||||||
}
|
}
|
||||||
dependencies {
|
dependencies {
|
||||||
classpath 'com.android.tools.build:gradle:8.12.0'
|
classpath 'com.android.tools.build:gradle:8.12.1'
|
||||||
classpath 'com.google.gms:google-services:4.4.0'
|
classpath 'com.google.gms:google-services:4.4.0'
|
||||||
|
|
||||||
// NOTE: Do not place your application dependencies here; they belong
|
// NOTE: Do not place your application dependencies here; they belong
|
||||||
|
|||||||
@@ -47,6 +47,7 @@ type ClaimParams = z.infer<typeof claimSchema>;
|
|||||||
### Type Safety Layers
|
### Type Safety Layers
|
||||||
|
|
||||||
1. **Schema Definition**
|
1. **Schema Definition**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// src/interfaces/deepLinks.ts
|
// src/interfaces/deepLinks.ts
|
||||||
export const deepLinkSchemas = {
|
export const deepLinkSchemas = {
|
||||||
@@ -59,6 +60,7 @@ type ClaimParams = z.infer<typeof claimSchema>;
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Type Generation**
|
2. **Type Generation**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Types are automatically generated from schemas
|
// Types are automatically generated from schemas
|
||||||
export type DeepLinkParams = {
|
export type DeepLinkParams = {
|
||||||
@@ -67,6 +69,7 @@ type ClaimParams = z.infer<typeof claimSchema>;
|
|||||||
```
|
```
|
||||||
|
|
||||||
3. **Runtime Validation**
|
3. **Runtime Validation**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// In DeepLinkHandler
|
// In DeepLinkHandler
|
||||||
const result = deepLinkSchemas.claim.safeParse(params);
|
const result = deepLinkSchemas.claim.safeParse(params);
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ This uses Pandoc and BasicTex (LaTeX) Installed through Homebrew.
|
|||||||
|
|
||||||
### Set Up
|
### Set Up
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew install pandoc
|
brew install pandoc
|
||||||
|
|
||||||
brew install basictex
|
brew install basictex
|
||||||
@@ -54,7 +54,7 @@ sudo tlmgr install sourceserifpro
|
|||||||
|
|
||||||
The following guide was adapted to this project except that we install with Brew and have a few more packages.
|
The following guide was adapted to this project except that we install with Brew and have a few more packages.
|
||||||
|
|
||||||
Guide: https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x
|
Guide: <https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x>
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
@@ -71,6 +71,7 @@ open usage-guide.pdf
|
|||||||
```
|
```
|
||||||
|
|
||||||
Or use this one-liner
|
Or use this one-liner
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pandoc usage-guide.md -o usage-guide.pdf && open usage-guide.pdf
|
pandoc usage-guide.md -o usage-guide.pdf && open usage-guide.pdf
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -122,4 +122,4 @@ export default class HomeView extends Vue {
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*This decision was made based on the current codebase architecture and team expertise. The mixin approach provides the best balance of performance, developer experience, and architectural consistency for the TimeSafari application.*
|
*This decision was made based on the current codebase architecture and team expertise. The mixin approach provides the best balance of performance, developer experience, and architectural consistency for the TimeSafari application.*
|
||||||
|
|||||||
@@ -103,6 +103,7 @@ scripts/
|
|||||||
### Configuration Schema
|
### Configuration Schema
|
||||||
|
|
||||||
The schema enforces:
|
The schema enforces:
|
||||||
|
|
||||||
- Source files must be in `resources/` directory
|
- Source files must be in `resources/` directory
|
||||||
- Required fields for icon and splash sections
|
- Required fields for icon and splash sections
|
||||||
- Android adaptive icon support (foreground/background/monochrome)
|
- Android adaptive icon support (foreground/background/monochrome)
|
||||||
|
|||||||
@@ -3,11 +3,13 @@
|
|||||||
**Author:** Matthew Raymer
|
**Author:** Matthew Raymer
|
||||||
|
|
||||||
## Motivation
|
## Motivation
|
||||||
|
|
||||||
- Eliminate manual hacks and post-build scripts for Electron builds
|
- Eliminate manual hacks and post-build scripts for Electron builds
|
||||||
- Ensure maintainability, reproducibility, and security of build outputs
|
- Ensure maintainability, reproducibility, and security of build outputs
|
||||||
- Unify build, test, and deployment scripts for developer experience and CI/CD
|
- Unify build, test, and deployment scripts for developer experience and CI/CD
|
||||||
|
|
||||||
## Key Technical Decisions
|
## Key Technical Decisions
|
||||||
|
|
||||||
- **Vite is the single source of truth for build output**
|
- **Vite is the single source of truth for build output**
|
||||||
- All Electron build output (main process, preload, renderer HTML/CSS/JS) is managed by `vite.config.electron.mts`
|
- All Electron build output (main process, preload, renderer HTML/CSS/JS) is managed by `vite.config.electron.mts`
|
||||||
- **CSS injection for Electron is handled by a Vite plugin**
|
- **CSS injection for Electron is handled by a Vite plugin**
|
||||||
@@ -21,6 +23,7 @@
|
|||||||
- Renderer assets: `dist-electron/www/` (HTML, CSS, JS)
|
- Renderer assets: `dist-electron/www/` (HTML, CSS, JS)
|
||||||
|
|
||||||
## Security & Maintenance Checklist
|
## Security & Maintenance Checklist
|
||||||
|
|
||||||
- [x] All scripts and configs are committed and documented
|
- [x] All scripts and configs are committed and documented
|
||||||
- [x] No manual file hacks remain
|
- [x] No manual file hacks remain
|
||||||
- [x] All build output is deterministic and reproducible
|
- [x] All build output is deterministic and reproducible
|
||||||
@@ -28,24 +31,29 @@
|
|||||||
- [x] Documentation (`BUILDING.md`) is up to date
|
- [x] Documentation (`BUILDING.md`) is up to date
|
||||||
|
|
||||||
## How to Build Electron
|
## How to Build Electron
|
||||||
|
|
||||||
1. Run:
|
1. Run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/build-electron.sh
|
./scripts/build-electron.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Output will be in `dist-electron/`:
|
2. Output will be in `dist-electron/`:
|
||||||
- `main.js`, `preload.js` in root
|
- `main.js`, `preload.js` in root
|
||||||
- `www/` contains all renderer assets
|
- `www/` contains all renderer assets
|
||||||
3. No manual post-processing is required
|
3. No manual post-processing is required
|
||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
|
|
||||||
- **Vite config:** All build output and asset handling is controlled in `vite.config.electron.mts`
|
- **Vite config:** All build output and asset handling is controlled in `vite.config.electron.mts`
|
||||||
- **CSS/HTML injection:** Use Vite plugins (see `electron-css-injection` in the config) for further customization
|
- **CSS/HTML injection:** Use Vite plugins (see `electron-css-injection` in the config) for further customization
|
||||||
- **Build scripts:** All orchestration is in `scripts/` and documented in `BUILDING.md`
|
- **Build scripts:** All orchestration is in `scripts/` and documented in `BUILDING.md`
|
||||||
|
|
||||||
## For Future Developers
|
## For Future Developers
|
||||||
|
|
||||||
- Always use Vite plugins/config for build output changes
|
- Always use Vite plugins/config for build output changes
|
||||||
- Never manually edit built files or inject assets post-build
|
- Never manually edit built files or inject assets post-build
|
||||||
- Keep documentation and scripts in sync with the build process
|
- Keep documentation and scripts in sync with the build process
|
||||||
|
|
||||||
---
|
---
|
||||||
This file documents the context and rationale for the build modernization and should be included in the repository for onboarding and future reference.
|
This file documents the context and rationale for the build modernization and should be included in the repository for onboarding and future reference.
|
||||||
|
|||||||
@@ -13,27 +13,31 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
### 🔍 **Resolved Dependency Patterns**
|
### 🔍 **Resolved Dependency Patterns**
|
||||||
|
|
||||||
#### 1. **Logger → PlatformServiceFactory → Logger** (RESOLVED)
|
#### 1. **Logger → PlatformServiceFactory → Logger** (RESOLVED)
|
||||||
|
|
||||||
- **Status**: ✅ **RESOLVED**
|
- **Status**: ✅ **RESOLVED**
|
||||||
- **Previous Issue**: Logger imported `logToDb` from databaseUtil, which imported logger
|
- **Previous Issue**: Logger imported `logToDb` from databaseUtil, which imported logger
|
||||||
- **Solution**: Logger now uses direct database access via PlatformServiceFactory
|
- **Solution**: Logger now uses direct database access via PlatformServiceFactory
|
||||||
- **Implementation**: Self-contained `logToDatabase()` function in logger.ts
|
- **Implementation**: Self-contained `logToDatabase()` function in logger.ts
|
||||||
|
|
||||||
#### 2. **PlatformServiceMixin → databaseUtil → logger → PlatformServiceMixin** (RESOLVED)
|
#### 2. **PlatformServiceMixin → databaseUtil → logger → PlatformServiceMixin** (RESOLVED)
|
||||||
|
|
||||||
- **Status**: ✅ **RESOLVED**
|
- **Status**: ✅ **RESOLVED**
|
||||||
- **Previous Issue**: PlatformServiceMixin imported `memoryLogs` from databaseUtil
|
- **Previous Issue**: PlatformServiceMixin imported `memoryLogs` from databaseUtil
|
||||||
- **Solution**: Created self-contained `_memoryLogs` array in PlatformServiceMixin
|
- **Solution**: Created self-contained `_memoryLogs` array in PlatformServiceMixin
|
||||||
- **Implementation**: Self-contained memory logs implementation
|
- **Implementation**: Self-contained memory logs implementation
|
||||||
|
|
||||||
#### 3. **databaseUtil → logger → PlatformServiceFactory → databaseUtil** (RESOLVED)
|
#### 3. **databaseUtil → logger → PlatformServiceFactory → databaseUtil** (RESOLVED)
|
||||||
|
|
||||||
- **Status**: ✅ **RESOLVED**
|
- **Status**: ✅ **RESOLVED**
|
||||||
- **Previous Issue**: databaseUtil imported logger, which could create loops
|
- **Previous Issue**: databaseUtil imported logger, which could create loops
|
||||||
- **Solution**: Logger is now self-contained and doesn't import from databaseUtil
|
- **Solution**: Logger is now self-contained and doesn't import from databaseUtil
|
||||||
|
|
||||||
#### 4. **Utility Files → databaseUtil → PlatformServiceMixin** (RESOLVED)
|
#### 4. **Utility Files → databaseUtil → PlatformServiceMixin** (RESOLVED)
|
||||||
|
|
||||||
- **Status**: ✅ **RESOLVED**
|
- **Status**: ✅ **RESOLVED**
|
||||||
- **Previous Issue**: `src/libs/util.ts` and `src/services/deepLinks.ts` imported from databaseUtil
|
- **Previous Issue**: `src/libs/util.ts` and `src/services/deepLinks.ts` imported from databaseUtil
|
||||||
- **Solution**: Replaced with self-contained implementations and PlatformServiceFactory usage
|
- **Solution**: Replaced with self-contained implementations and PlatformServiceFactory usage
|
||||||
- **Implementation**:
|
- **Implementation**:
|
||||||
- Self-contained `parseJsonField()` and `mapQueryResultToValues()` functions
|
- Self-contained `parseJsonField()` and `mapQueryResultToValues()` functions
|
||||||
- Direct PlatformServiceFactory usage for database operations
|
- Direct PlatformServiceFactory usage for database operations
|
||||||
- Console logging instead of databaseUtil logging functions
|
- Console logging instead of databaseUtil logging functions
|
||||||
@@ -43,18 +47,21 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
### ✅ **All Critical Dependencies Resolved**
|
### ✅ **All Critical Dependencies Resolved**
|
||||||
|
|
||||||
#### PlatformServiceMixin Independence
|
#### PlatformServiceMixin Independence
|
||||||
|
|
||||||
- **Status**: ✅ **COMPLETE**
|
- **Status**: ✅ **COMPLETE**
|
||||||
- **Achievement**: PlatformServiceMixin has no external dependencies on databaseUtil
|
- **Achievement**: PlatformServiceMixin has no external dependencies on databaseUtil
|
||||||
- **Implementation**: Self-contained memory logs and utility functions
|
- **Implementation**: Self-contained memory logs and utility functions
|
||||||
- **Impact**: Enables complete migration of databaseUtil functions to PlatformServiceMixin
|
- **Impact**: Enables complete migration of databaseUtil functions to PlatformServiceMixin
|
||||||
|
|
||||||
#### Logger Independence
|
#### Logger Independence
|
||||||
|
|
||||||
- **Status**: ✅ **COMPLETE**
|
- **Status**: ✅ **COMPLETE**
|
||||||
- **Achievement**: Logger is completely self-contained
|
- **Achievement**: Logger is completely self-contained
|
||||||
- **Implementation**: Direct database access via PlatformServiceFactory
|
- **Implementation**: Direct database access via PlatformServiceFactory
|
||||||
- **Impact**: Eliminates all circular dependency risks
|
- **Impact**: Eliminates all circular dependency risks
|
||||||
|
|
||||||
#### Utility Files Independence
|
#### Utility Files Independence
|
||||||
|
|
||||||
- **Status**: ✅ **COMPLETE**
|
- **Status**: ✅ **COMPLETE**
|
||||||
- **Achievement**: All utility files no longer depend on databaseUtil
|
- **Achievement**: All utility files no longer depend on databaseUtil
|
||||||
- **Implementation**: Self-contained functions and direct platform service access
|
- **Implementation**: Self-contained functions and direct platform service access
|
||||||
@@ -63,6 +70,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
### 🎯 **Migration Readiness Status**
|
### 🎯 **Migration Readiness Status**
|
||||||
|
|
||||||
#### Files Ready for Migration (52 files)
|
#### Files Ready for Migration (52 files)
|
||||||
|
|
||||||
1. **Components** (15 files):
|
1. **Components** (15 files):
|
||||||
- `PhotoDialog.vue`
|
- `PhotoDialog.vue`
|
||||||
- `FeedFilters.vue`
|
- `FeedFilters.vue`
|
||||||
@@ -98,6 +106,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
### 🟢 **Healthy Dependencies**
|
### 🟢 **Healthy Dependencies**
|
||||||
|
|
||||||
#### Logger Usage (80+ files)
|
#### Logger Usage (80+ files)
|
||||||
|
|
||||||
- **Status**: ✅ **HEALTHY**
|
- **Status**: ✅ **HEALTHY**
|
||||||
- **Pattern**: All files import logger from `@/utils/logger`
|
- **Pattern**: All files import logger from `@/utils/logger`
|
||||||
- **Impact**: No circular dependencies, logger is self-contained
|
- **Impact**: No circular dependencies, logger is self-contained
|
||||||
@@ -106,21 +115,25 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
## Resolution Strategy - COMPLETED
|
## Resolution Strategy - COMPLETED
|
||||||
|
|
||||||
### ✅ **Phase 1: Complete PlatformServiceMixin Independence (COMPLETE)**
|
### ✅ **Phase 1: Complete PlatformServiceMixin Independence (COMPLETE)**
|
||||||
|
|
||||||
1. **Removed memoryLogs import** from PlatformServiceMixin ✅
|
1. **Removed memoryLogs import** from PlatformServiceMixin ✅
|
||||||
2. **Created self-contained memoryLogs** implementation ✅
|
2. **Created self-contained memoryLogs** implementation ✅
|
||||||
3. **Added missing utility methods** to PlatformServiceMixin ✅
|
3. **Added missing utility methods** to PlatformServiceMixin ✅
|
||||||
|
|
||||||
### ✅ **Phase 2: Utility Files Migration (COMPLETE)**
|
### ✅ **Phase 2: Utility Files Migration (COMPLETE)**
|
||||||
|
|
||||||
1. **Migrated deepLinks.ts** - Replaced databaseUtil logging with console logging ✅
|
1. **Migrated deepLinks.ts** - Replaced databaseUtil logging with console logging ✅
|
||||||
2. **Migrated util.ts** - Replaced databaseUtil functions with self-contained implementations ✅
|
2. **Migrated util.ts** - Replaced databaseUtil functions with self-contained implementations ✅
|
||||||
3. **Updated all PlatformServiceFactory calls** to use async pattern ✅
|
3. **Updated all PlatformServiceFactory calls** to use async pattern ✅
|
||||||
|
|
||||||
### 🎯 **Phase 3: File-by-File Migration (READY TO START)**
|
### 🎯 **Phase 3: File-by-File Migration (READY TO START)**
|
||||||
|
|
||||||
1. **High-usage files first** (views, core components)
|
1. **High-usage files first** (views, core components)
|
||||||
2. **Replace databaseUtil imports** with PlatformServiceMixin
|
2. **Replace databaseUtil imports** with PlatformServiceMixin
|
||||||
3. **Update function calls** to use mixin methods
|
3. **Update function calls** to use mixin methods
|
||||||
|
|
||||||
### 🎯 **Phase 4: Cleanup (FUTURE)**
|
### 🎯 **Phase 4: Cleanup (FUTURE)**
|
||||||
|
|
||||||
1. **Remove unused databaseUtil functions**
|
1. **Remove unused databaseUtil functions**
|
||||||
2. **Update TypeScript interfaces**
|
2. **Update TypeScript interfaces**
|
||||||
3. **Remove databaseUtil imports** from all files
|
3. **Remove databaseUtil imports** from all files
|
||||||
@@ -128,6 +141,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
## Current Status Summary
|
## Current Status Summary
|
||||||
|
|
||||||
### ✅ **Resolved Issues**
|
### ✅ **Resolved Issues**
|
||||||
|
|
||||||
1. **Logger circular dependency** - Fixed with self-contained implementation
|
1. **Logger circular dependency** - Fixed with self-contained implementation
|
||||||
2. **PlatformServiceMixin circular dependency** - Fixed with self-contained memoryLogs
|
2. **PlatformServiceMixin circular dependency** - Fixed with self-contained memoryLogs
|
||||||
3. **Utility files circular dependency** - Fixed with self-contained implementations
|
3. **Utility files circular dependency** - Fixed with self-contained implementations
|
||||||
@@ -135,6 +149,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
5. **Runtime stability** - No circular dependency crashes
|
5. **Runtime stability** - No circular dependency crashes
|
||||||
|
|
||||||
### 🎯 **Ready for Next Phase**
|
### 🎯 **Ready for Next Phase**
|
||||||
|
|
||||||
1. **52 files** ready for databaseUtil migration
|
1. **52 files** ready for databaseUtil migration
|
||||||
2. **PlatformServiceMixin** fully independent and functional
|
2. **PlatformServiceMixin** fully independent and functional
|
||||||
3. **Clear migration path** - Well-defined targets and strategy
|
3. **Clear migration path** - Well-defined targets and strategy
|
||||||
@@ -142,6 +157,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
## Benefits of Current State
|
## Benefits of Current State
|
||||||
|
|
||||||
### ✅ **Achieved**
|
### ✅ **Achieved**
|
||||||
|
|
||||||
1. **No runtime circular dependencies** - Application runs without crashes
|
1. **No runtime circular dependencies** - Application runs without crashes
|
||||||
2. **Self-contained logger** - No more logger/databaseUtil loops
|
2. **Self-contained logger** - No more logger/databaseUtil loops
|
||||||
3. **PlatformServiceMixin ready** - All methods implemented and independent
|
3. **PlatformServiceMixin ready** - All methods implemented and independent
|
||||||
@@ -149,6 +165,7 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
5. **Clear migration path** - Well-defined targets and strategy
|
5. **Clear migration path** - Well-defined targets and strategy
|
||||||
|
|
||||||
### 🎯 **Expected After Migration**
|
### 🎯 **Expected After Migration**
|
||||||
|
|
||||||
1. **Complete databaseUtil migration** - Single source of truth
|
1. **Complete databaseUtil migration** - Single source of truth
|
||||||
2. **Eliminated circular dependencies** - Clean architecture
|
2. **Eliminated circular dependencies** - Clean architecture
|
||||||
3. **Improved performance** - Caching and optimization
|
3. **Improved performance** - Caching and optimization
|
||||||
@@ -160,4 +177,4 @@ The codebase currently has **no active circular dependencies** that are causing
|
|||||||
**Created**: 2025-07-05
|
**Created**: 2025-07-05
|
||||||
**Status**: ✅ **COMPLETE - All Circular Dependencies Resolved**
|
**Status**: ✅ **COMPLETE - All Circular Dependencies Resolved**
|
||||||
**Last Updated**: 2025-01-06
|
**Last Updated**: 2025-01-06
|
||||||
**Note**: PlatformServiceMixin circular dependency completely resolved. Ready for Phase 2: File-by-File Migration
|
**Note**: PlatformServiceMixin circular dependency completely resolved. Ready for Phase 2: File-by-File Migration
|
||||||
|
|||||||
@@ -93,6 +93,7 @@ export default class FormComponent extends Vue {
|
|||||||
When generating component templates, follow these patterns:
|
When generating component templates, follow these patterns:
|
||||||
|
|
||||||
#### Function Props Template
|
#### Function Props Template
|
||||||
|
|
||||||
```vue
|
```vue
|
||||||
<template>
|
<template>
|
||||||
<div class="component-name">
|
<div class="component-name">
|
||||||
@@ -124,6 +125,7 @@ export default class ComponentName extends Vue {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### $emit Template (for DOM events)
|
#### $emit Template (for DOM events)
|
||||||
|
|
||||||
```vue
|
```vue
|
||||||
<template>
|
<template>
|
||||||
<div class="component-name">
|
<div class="component-name">
|
||||||
@@ -155,12 +157,14 @@ export default class ComponentName extends Vue {
|
|||||||
### Code Generation Rules
|
### Code Generation Rules
|
||||||
|
|
||||||
#### 1. Function Props for Business Logic
|
#### 1. Function Props for Business Logic
|
||||||
|
|
||||||
- **Data operations**: Save, delete, update, validate
|
- **Data operations**: Save, delete, update, validate
|
||||||
- **Navigation**: Route changes, modal opening/closing
|
- **Navigation**: Route changes, modal opening/closing
|
||||||
- **State management**: Store actions, state updates
|
- **State management**: Store actions, state updates
|
||||||
- **API calls**: Data fetching, form submissions
|
- **API calls**: Data fetching, form submissions
|
||||||
|
|
||||||
#### 2. $emit for User Interactions
|
#### 2. $emit for User Interactions
|
||||||
|
|
||||||
- **Click events**: Button clicks, link navigation
|
- **Click events**: Button clicks, link navigation
|
||||||
- **Form events**: Input changes, form submissions
|
- **Form events**: Input changes, form submissions
|
||||||
- **Lifecycle events**: Component mounting, unmounting
|
- **Lifecycle events**: Component mounting, unmounting
|
||||||
@@ -169,6 +173,7 @@ export default class ComponentName extends Vue {
|
|||||||
#### 3. Naming Conventions
|
#### 3. Naming Conventions
|
||||||
|
|
||||||
**Function Props:**
|
**Function Props:**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Action-oriented names
|
// Action-oriented names
|
||||||
onSave: (data: SaveData) => Promise<void>
|
onSave: (data: SaveData) => Promise<void>
|
||||||
@@ -179,6 +184,7 @@ onNavigate: (route: string) => void
|
|||||||
```
|
```
|
||||||
|
|
||||||
**$emit Events:**
|
**$emit Events:**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Event-oriented names
|
// Event-oriented names
|
||||||
@click: (event: MouseEvent) => void
|
@click: (event: MouseEvent) => void
|
||||||
@@ -191,6 +197,7 @@ onNavigate: (route: string) => void
|
|||||||
### TypeScript Integration
|
### TypeScript Integration
|
||||||
|
|
||||||
#### Function Prop Types
|
#### Function Prop Types
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Define reusable function types
|
// Define reusable function types
|
||||||
interface SaveHandler {
|
interface SaveHandler {
|
||||||
@@ -207,6 +214,7 @@ interface ValidationHandler {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Event Types
|
#### Event Types
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Define event payload types
|
// Define event payload types
|
||||||
interface ClickEvent {
|
interface ClickEvent {
|
||||||
@@ -226,6 +234,7 @@ handleClick(): ClickEvent {
|
|||||||
## Testing Guidelines
|
## Testing Guidelines
|
||||||
|
|
||||||
### Function Props Testing
|
### Function Props Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Easy to mock and test
|
// Easy to mock and test
|
||||||
const mockOnSave = jest.fn();
|
const mockOnSave = jest.fn();
|
||||||
@@ -240,6 +249,7 @@ expect(mockOnSave).toHaveBeenCalledWith(expectedData);
|
|||||||
```
|
```
|
||||||
|
|
||||||
### $emit Testing
|
### $emit Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Requires event simulation
|
// Requires event simulation
|
||||||
const wrapper = mount(MyComponent);
|
const wrapper = mount(MyComponent);
|
||||||
@@ -260,6 +270,7 @@ expect(wrapper.emitted('click')).toBeTruthy();
|
|||||||
### Example Migration
|
### Example Migration
|
||||||
|
|
||||||
**Before ($emit):**
|
**Before ($emit):**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@Emit("save")
|
@Emit("save")
|
||||||
handleSave() {
|
handleSave() {
|
||||||
@@ -268,6 +279,7 @@ handleSave() {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**After (Function Props):**
|
**After (Function Props):**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@Prop({ required: true }) onSave!: (data: FormData) => void;
|
@Prop({ required: true }) onSave!: (data: FormData) => void;
|
||||||
|
|
||||||
@@ -288,6 +300,7 @@ handleSave() {
|
|||||||
## Code Generation Templates
|
## Code Generation Templates
|
||||||
|
|
||||||
### Component Generator Input
|
### Component Generator Input
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface ComponentSpec {
|
interface ComponentSpec {
|
||||||
name: string;
|
name: string;
|
||||||
@@ -306,9 +319,10 @@ interface ComponentSpec {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Generated Output
|
### Generated Output
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Generator should automatically choose function props vs $emit
|
// Generator should automatically choose function props vs $emit
|
||||||
// based on the nature of the interaction (business logic vs DOM event)
|
// based on the nature of the interaction (business logic vs DOM event)
|
||||||
```
|
```
|
||||||
|
|
||||||
This guide ensures consistent, maintainable component communication patterns across the application.
|
This guide ensures consistent, maintainable component communication patterns across the application.
|
||||||
|
|||||||
@@ -7,10 +7,12 @@ CORS headers have been **disabled** to support Time Safari's core mission: enabl
|
|||||||
## What Changed
|
## What Changed
|
||||||
|
|
||||||
### ❌ Removed CORS Headers
|
### ❌ Removed CORS Headers
|
||||||
|
|
||||||
- `Cross-Origin-Opener-Policy: same-origin`
|
- `Cross-Origin-Opener-Policy: same-origin`
|
||||||
- `Cross-Origin-Embedder-Policy: require-corp`
|
- `Cross-Origin-Embedder-Policy: require-corp`
|
||||||
|
|
||||||
### ✅ Results
|
### ✅ Results
|
||||||
|
|
||||||
- Images from **any domain** now work in development and production
|
- Images from **any domain** now work in development and production
|
||||||
- No proxy configuration needed
|
- No proxy configuration needed
|
||||||
- No whitelist of supported image hosts
|
- No whitelist of supported image hosts
|
||||||
@@ -19,11 +21,13 @@ CORS headers have been **disabled** to support Time Safari's core mission: enabl
|
|||||||
## Technical Tradeoffs
|
## Technical Tradeoffs
|
||||||
|
|
||||||
### 🔻 Lost: SharedArrayBuffer Performance
|
### 🔻 Lost: SharedArrayBuffer Performance
|
||||||
|
|
||||||
- **Before**: Fast SQLite operations via SharedArrayBuffer
|
- **Before**: Fast SQLite operations via SharedArrayBuffer
|
||||||
- **After**: Slightly slower IndexedDB fallback mode
|
- **After**: Slightly slower IndexedDB fallback mode
|
||||||
- **Impact**: Minimal for typical usage - absurd-sql automatically falls back
|
- **Impact**: Minimal for typical usage - absurd-sql automatically falls back
|
||||||
|
|
||||||
### 🔺 Gained: Universal Image Support
|
### 🔺 Gained: Universal Image Support
|
||||||
|
|
||||||
- **Before**: Only specific domains worked (TimeSafari, Flickr, Imgur, etc.)
|
- **Before**: Only specific domains worked (TimeSafari, Flickr, Imgur, etc.)
|
||||||
- **After**: Any image URL works immediately
|
- **After**: Any image URL works immediately
|
||||||
- **Impact**: Massive improvement for user experience
|
- **Impact**: Massive improvement for user experience
|
||||||
@@ -31,6 +35,7 @@ CORS headers have been **disabled** to support Time Safari's core mission: enabl
|
|||||||
## Architecture Impact
|
## Architecture Impact
|
||||||
|
|
||||||
### Database Operations
|
### Database Operations
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// absurd-sql automatically detects SharedArrayBuffer availability
|
// absurd-sql automatically detects SharedArrayBuffer availability
|
||||||
if (typeof SharedArrayBuffer === "undefined") {
|
if (typeof SharedArrayBuffer === "undefined") {
|
||||||
@@ -43,6 +48,7 @@ if (typeof SharedArrayBuffer === "undefined") {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Image Loading
|
### Image Loading
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// All images load directly now
|
// All images load directly now
|
||||||
export function transformImageUrlForCors(imageUrl: string): string {
|
export function transformImageUrlForCors(imageUrl: string): string {
|
||||||
@@ -53,11 +59,13 @@ export function transformImageUrlForCors(imageUrl: string): string {
|
|||||||
## Why This Was The Right Choice
|
## Why This Was The Right Choice
|
||||||
|
|
||||||
### Time Safari's Use Case
|
### Time Safari's Use Case
|
||||||
|
|
||||||
- **Community platform** where users share content from anywhere
|
- **Community platform** where users share content from anywhere
|
||||||
- **User-generated content** includes images from arbitrary websites
|
- **User-generated content** includes images from arbitrary websites
|
||||||
- **Flexibility** is more important than marginal performance gains
|
- **Flexibility** is more important than marginal performance gains
|
||||||
|
|
||||||
### Alternative Would Require
|
### Alternative Would Require
|
||||||
|
|
||||||
- Pre-configuring proxies for every possible image hosting service
|
- Pre-configuring proxies for every possible image hosting service
|
||||||
- Constantly updating proxy list as users find new sources
|
- Constantly updating proxy list as users find new sources
|
||||||
- Poor user experience when images fail to load
|
- Poor user experience when images fail to load
|
||||||
@@ -66,11 +74,13 @@ export function transformImageUrlForCors(imageUrl: string): string {
|
|||||||
## Performance Comparison
|
## Performance Comparison
|
||||||
|
|
||||||
### Database Operations
|
### Database Operations
|
||||||
|
|
||||||
- **SharedArrayBuffer**: ~2x faster for large operations
|
- **SharedArrayBuffer**: ~2x faster for large operations
|
||||||
- **IndexedDB**: Still very fast for typical Time Safari usage
|
- **IndexedDB**: Still very fast for typical Time Safari usage
|
||||||
- **Real Impact**: Negligible for typical user operations
|
- **Real Impact**: Negligible for typical user operations
|
||||||
|
|
||||||
### Image Loading
|
### Image Loading
|
||||||
|
|
||||||
- **With CORS**: Many images failed to load in development
|
- **With CORS**: Many images failed to load in development
|
||||||
- **Without CORS**: All images load immediately
|
- **Without CORS**: All images load immediately
|
||||||
- **Real Impact**: Massive improvement in user experience
|
- **Real Impact**: Massive improvement in user experience
|
||||||
@@ -87,11 +97,13 @@ export function transformImageUrlForCors(imageUrl: string): string {
|
|||||||
## Migration Notes
|
## Migration Notes
|
||||||
|
|
||||||
### For Developers
|
### For Developers
|
||||||
|
|
||||||
- No code changes needed
|
- No code changes needed
|
||||||
- `transformImageUrlForCors()` still exists but returns original URL
|
- `transformImageUrlForCors()` still exists but returns original URL
|
||||||
- All existing image references work without modification
|
- All existing image references work without modification
|
||||||
|
|
||||||
### For Users
|
### For Users
|
||||||
|
|
||||||
- Images from any website now work immediately
|
- Images from any website now work immediately
|
||||||
- No more "image failed to load" issues in development
|
- No more "image failed to load" issues in development
|
||||||
- Consistent behavior between development and production
|
- Consistent behavior between development and production
|
||||||
@@ -99,12 +111,14 @@ export function transformImageUrlForCors(imageUrl: string): string {
|
|||||||
## Future Considerations
|
## Future Considerations
|
||||||
|
|
||||||
### If Performance Becomes Critical
|
### If Performance Becomes Critical
|
||||||
|
|
||||||
1. **Selective CORS**: Enable only for specific operations
|
1. **Selective CORS**: Enable only for specific operations
|
||||||
2. **Service Worker**: Handle image proxying at service worker level
|
2. **Service Worker**: Handle image proxying at service worker level
|
||||||
3. **Build-time Processing**: Pre-process images during build
|
3. **Build-time Processing**: Pre-process images during build
|
||||||
4. **User Education**: Guide users toward optimized image hosting
|
4. **User Education**: Guide users toward optimized image hosting
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
|
||||||
- Track database operation performance
|
- Track database operation performance
|
||||||
- Monitor for any user-reported slowness
|
- Monitor for any user-reported slowness
|
||||||
- Consider re-enabling SharedArrayBuffer if usage patterns change
|
- Consider re-enabling SharedArrayBuffer if usage patterns change
|
||||||
@@ -113,4 +127,4 @@ export function transformImageUrlForCors(imageUrl: string): string {
|
|||||||
|
|
||||||
This change prioritizes **user experience** and **community functionality** over marginal performance gains. The database still works efficiently via IndexedDB, while images now work universally without configuration.
|
This change prioritizes **user experience** and **community functionality** over marginal performance gains. The database still works efficiently via IndexedDB, while images now work universally without configuration.
|
||||||
|
|
||||||
For a community platform like Time Safari, the ability to share images from any domain is fundamental to the user experience and mission.
|
For a community platform like Time Safari, the ability to share images from any domain is fundamental to the user experience and mission.
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This document describes the implementation of a comprehensive image loading solu
|
|||||||
## Problem Statement
|
## Problem Statement
|
||||||
|
|
||||||
When using SharedArrayBuffer (required for absurd-sql), browsers enforce a cross-origin isolated environment with these headers:
|
When using SharedArrayBuffer (required for absurd-sql), browsers enforce a cross-origin isolated environment with these headers:
|
||||||
|
|
||||||
- `Cross-Origin-Opener-Policy: same-origin`
|
- `Cross-Origin-Opener-Policy: same-origin`
|
||||||
- `Cross-Origin-Embedder-Policy: require-corp`
|
- `Cross-Origin-Embedder-Policy: require-corp`
|
||||||
|
|
||||||
@@ -19,6 +20,7 @@ This isolation prevents loading external resources (including images) unless the
|
|||||||
The solution uses a multi-tier approach to handle images from various sources:
|
The solution uses a multi-tier approach to handle images from various sources:
|
||||||
|
|
||||||
#### Tier 1: Specific Domain Proxies (Development Only)
|
#### Tier 1: Specific Domain Proxies (Development Only)
|
||||||
|
|
||||||
- **TimeSafari Images**: `/image-proxy/` → `https://image.timesafari.app/`
|
- **TimeSafari Images**: `/image-proxy/` → `https://image.timesafari.app/`
|
||||||
- **Flickr Images**: `/flickr-proxy/` → `https://live.staticflickr.com/`
|
- **Flickr Images**: `/flickr-proxy/` → `https://live.staticflickr.com/`
|
||||||
- **Imgur Images**: `/imgur-proxy/` → `https://i.imgur.com/`
|
- **Imgur Images**: `/imgur-proxy/` → `https://i.imgur.com/`
|
||||||
@@ -26,14 +28,17 @@ The solution uses a multi-tier approach to handle images from various sources:
|
|||||||
- **Unsplash**: `/unsplash-proxy/` → `https://images.unsplash.com/`
|
- **Unsplash**: `/unsplash-proxy/` → `https://images.unsplash.com/`
|
||||||
|
|
||||||
#### Tier 2: Universal CORS Proxy (Development Only)
|
#### Tier 2: Universal CORS Proxy (Development Only)
|
||||||
|
|
||||||
- **Any External Domain**: Uses `https://api.allorigins.win/raw?url=` for arbitrary domains
|
- **Any External Domain**: Uses `https://api.allorigins.win/raw?url=` for arbitrary domains
|
||||||
|
|
||||||
#### Tier 3: Direct Loading (Production)
|
#### Tier 3: Direct Loading (Production)
|
||||||
|
|
||||||
- **Production Mode**: All images load directly without proxying
|
- **Production Mode**: All images load directly without proxying
|
||||||
|
|
||||||
### 2. Smart URL Transformation
|
### 2. Smart URL Transformation
|
||||||
|
|
||||||
The `transformImageUrlForCors` function automatically:
|
The `transformImageUrlForCors` function automatically:
|
||||||
|
|
||||||
- Detects the image source domain
|
- Detects the image source domain
|
||||||
- Routes through appropriate proxy in development
|
- Routes through appropriate proxy in development
|
||||||
- Preserves original URLs in production
|
- Preserves original URLs in production
|
||||||
@@ -44,6 +49,7 @@ The `transformImageUrlForCors` function automatically:
|
|||||||
### Configuration Files
|
### Configuration Files
|
||||||
|
|
||||||
#### `vite.config.common.mts`
|
#### `vite.config.common.mts`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
server: {
|
server: {
|
||||||
headers: {
|
headers: {
|
||||||
@@ -63,6 +69,7 @@ server: {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### `src/libs/util.ts`
|
#### `src/libs/util.ts`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
export function transformImageUrlForCors(imageUrl: string): string {
|
export function transformImageUrlForCors(imageUrl: string): string {
|
||||||
// Development mode: Transform URLs to use proxies
|
// Development mode: Transform URLs to use proxies
|
||||||
@@ -93,21 +100,25 @@ const imageUrl = transformImageUrlForCors(originalImageUrl);
|
|||||||
## Benefits
|
## Benefits
|
||||||
|
|
||||||
### ✅ SharedArrayBuffer Support
|
### ✅ SharedArrayBuffer Support
|
||||||
|
|
||||||
- Maintains cross-origin isolation required for SharedArrayBuffer
|
- Maintains cross-origin isolation required for SharedArrayBuffer
|
||||||
- Enables fast SQLite database operations via absurd-sql
|
- Enables fast SQLite database operations via absurd-sql
|
||||||
- Provides better performance than IndexedDB fallback
|
- Provides better performance than IndexedDB fallback
|
||||||
|
|
||||||
### ✅ Universal Image Support
|
### ✅ Universal Image Support
|
||||||
|
|
||||||
- Handles images from any domain
|
- Handles images from any domain
|
||||||
- No need to pre-configure every possible image source
|
- No need to pre-configure every possible image source
|
||||||
- Graceful fallback for unknown domains
|
- Graceful fallback for unknown domains
|
||||||
|
|
||||||
### ✅ Development/Production Flexibility
|
### ✅ Development/Production Flexibility
|
||||||
|
|
||||||
- Proxy system only active in development
|
- Proxy system only active in development
|
||||||
- Production uses direct URLs for maximum performance
|
- Production uses direct URLs for maximum performance
|
||||||
- No proxy server required in production
|
- No proxy server required in production
|
||||||
|
|
||||||
### ✅ Automatic Detection
|
### ✅ Automatic Detection
|
||||||
|
|
||||||
- Smart URL transformation based on domain patterns
|
- Smart URL transformation based on domain patterns
|
||||||
- Preserves relative URLs and data URLs
|
- Preserves relative URLs and data URLs
|
||||||
- Handles edge cases gracefully
|
- Handles edge cases gracefully
|
||||||
@@ -115,6 +126,7 @@ const imageUrl = transformImageUrlForCors(originalImageUrl);
|
|||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
### Automated Testing
|
### Automated Testing
|
||||||
|
|
||||||
Run the test suite to verify URL transformation:
|
Run the test suite to verify URL transformation:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -125,6 +137,7 @@ testCorsImageTransformation();
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Visual Testing
|
### Visual Testing
|
||||||
|
|
||||||
Create test image elements to verify loading:
|
Create test image elements to verify loading:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -135,6 +148,7 @@ createTestImageElements();
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Manual Testing
|
### Manual Testing
|
||||||
|
|
||||||
1. Start development server: `npm run dev`
|
1. Start development server: `npm run dev`
|
||||||
2. Open browser console to see transformation logs
|
2. Open browser console to see transformation logs
|
||||||
3. Check Network tab for proxy requests
|
3. Check Network tab for proxy requests
|
||||||
@@ -143,16 +157,19 @@ createTestImageElements();
|
|||||||
## Security Considerations
|
## Security Considerations
|
||||||
|
|
||||||
### Development Environment
|
### Development Environment
|
||||||
|
|
||||||
- CORS proxies are only used in development
|
- CORS proxies are only used in development
|
||||||
- External proxy services (allorigins.win) are used for testing
|
- External proxy services (allorigins.win) are used for testing
|
||||||
- No sensitive data is exposed through proxies
|
- No sensitive data is exposed through proxies
|
||||||
|
|
||||||
### Production Environment
|
### Production Environment
|
||||||
|
|
||||||
- All images load directly without proxying
|
- All images load directly without proxying
|
||||||
- No dependency on external proxy services
|
- No dependency on external proxy services
|
||||||
- Original security model maintained
|
- Original security model maintained
|
||||||
|
|
||||||
### Privacy
|
### Privacy
|
||||||
|
|
||||||
- Image URLs are not logged or stored by proxy services
|
- Image URLs are not logged or stored by proxy services
|
||||||
- Proxy requests are only made during development
|
- Proxy requests are only made during development
|
||||||
- No tracking or analytics in proxy chain
|
- No tracking or analytics in proxy chain
|
||||||
@@ -160,11 +177,13 @@ createTestImageElements();
|
|||||||
## Performance Impact
|
## Performance Impact
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
- Slight latency from proxy requests
|
- Slight latency from proxy requests
|
||||||
- Additional network hops for external domains
|
- Additional network hops for external domains
|
||||||
- More verbose logging for debugging
|
- More verbose logging for debugging
|
||||||
|
|
||||||
### Production
|
### Production
|
||||||
|
|
||||||
- No performance impact
|
- No performance impact
|
||||||
- Direct image loading as before
|
- Direct image loading as before
|
||||||
- No proxy overhead
|
- No proxy overhead
|
||||||
@@ -174,17 +193,20 @@ createTestImageElements();
|
|||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
#### Images Not Loading in Development
|
#### Images Not Loading in Development
|
||||||
|
|
||||||
1. Check console for proxy errors
|
1. Check console for proxy errors
|
||||||
2. Verify CORS headers are set
|
2. Verify CORS headers are set
|
||||||
3. Test with different image URLs
|
3. Test with different image URLs
|
||||||
4. Check network connectivity to proxy services
|
4. Check network connectivity to proxy services
|
||||||
|
|
||||||
#### SharedArrayBuffer Not Available
|
#### SharedArrayBuffer Not Available
|
||||||
|
|
||||||
1. Verify CORS headers are set in server configuration
|
1. Verify CORS headers are set in server configuration
|
||||||
2. Check that site is served over HTTPS (or localhost)
|
2. Check that site is served over HTTPS (or localhost)
|
||||||
3. Ensure browser supports SharedArrayBuffer
|
3. Ensure browser supports SharedArrayBuffer
|
||||||
|
|
||||||
#### Proxy Service Unavailable
|
#### Proxy Service Unavailable
|
||||||
|
|
||||||
1. Check if allorigins.win is accessible
|
1. Check if allorigins.win is accessible
|
||||||
2. Consider using alternative CORS proxy services
|
2. Consider using alternative CORS proxy services
|
||||||
3. Temporarily disable CORS headers for testing
|
3. Temporarily disable CORS headers for testing
|
||||||
@@ -207,12 +229,14 @@ testCorsImageTransformation();
|
|||||||
## Migration Guide
|
## Migration Guide
|
||||||
|
|
||||||
### From Previous Implementation
|
### From Previous Implementation
|
||||||
|
|
||||||
1. CORS headers are now required for SharedArrayBuffer
|
1. CORS headers are now required for SharedArrayBuffer
|
||||||
2. Image URLs automatically transformed in development
|
2. Image URLs automatically transformed in development
|
||||||
3. No changes needed to existing image loading code
|
3. No changes needed to existing image loading code
|
||||||
4. Test thoroughly in both development and production
|
4. Test thoroughly in both development and production
|
||||||
|
|
||||||
### Adding New Image Sources
|
### Adding New Image Sources
|
||||||
|
|
||||||
1. Add specific proxy for frequently used domains
|
1. Add specific proxy for frequently used domains
|
||||||
2. Update `transformImageUrlForCors` function
|
2. Update `transformImageUrlForCors` function
|
||||||
3. Add CORS headers to proxy configuration
|
3. Add CORS headers to proxy configuration
|
||||||
@@ -221,6 +245,7 @@ testCorsImageTransformation();
|
|||||||
## Future Enhancements
|
## Future Enhancements
|
||||||
|
|
||||||
### Possible Improvements
|
### Possible Improvements
|
||||||
|
|
||||||
1. **Local Proxy Server**: Run dedicated proxy server for development
|
1. **Local Proxy Server**: Run dedicated proxy server for development
|
||||||
2. **Caching**: Cache proxy responses for better performance
|
2. **Caching**: Cache proxy responses for better performance
|
||||||
3. **Fallback Chain**: Multiple proxy services for reliability
|
3. **Fallback Chain**: Multiple proxy services for reliability
|
||||||
@@ -228,6 +253,7 @@ testCorsImageTransformation();
|
|||||||
5. **Analytics**: Track image loading success/failure rates
|
5. **Analytics**: Track image loading success/failure rates
|
||||||
|
|
||||||
### Alternative Approaches
|
### Alternative Approaches
|
||||||
|
|
||||||
1. **Service Worker**: Intercept image requests at service worker level
|
1. **Service Worker**: Intercept image requests at service worker level
|
||||||
2. **Build-time Processing**: Pre-process images during build
|
2. **Build-time Processing**: Pre-process images during build
|
||||||
3. **CDN Integration**: Use CDN with proper CORS headers
|
3. **CDN Integration**: Use CDN with proper CORS headers
|
||||||
@@ -237,4 +263,4 @@ testCorsImageTransformation();
|
|||||||
|
|
||||||
This solution provides a robust, scalable approach to image loading in a cross-origin isolated environment while maintaining the benefits of SharedArrayBuffer support. The multi-tier proxy system ensures compatibility with any image source while optimizing for performance and security.
|
This solution provides a robust, scalable approach to image loading in a cross-origin isolated environment while maintaining the benefits of SharedArrayBuffer support. The multi-tier proxy system ensures compatibility with any image source while optimizing for performance and security.
|
||||||
|
|
||||||
For questions or issues, refer to the troubleshooting section or consult the development team.
|
For questions or issues, refer to the troubleshooting section or consult the development team.
|
||||||
|
|||||||
@@ -294,6 +294,7 @@ const result = await this.$db("SELECT * FROM contacts WHERE did = ?", [accountDi
|
|||||||
```
|
```
|
||||||
|
|
||||||
This provides:
|
This provides:
|
||||||
|
|
||||||
- **Caching**: Automatic caching for performance
|
- **Caching**: Automatic caching for performance
|
||||||
- **Error Handling**: Consistent error handling
|
- **Error Handling**: Consistent error handling
|
||||||
- **Type Safety**: Enhanced TypeScript integration
|
- **Type Safety**: Enhanced TypeScript integration
|
||||||
|
|||||||
187
doc/debug-hook-guide.md
Normal file
187
doc/debug-hook-guide.md
Normal file
@@ -0,0 +1,187 @@
|
|||||||
|
# TimeSafari Debug Hook Guide
|
||||||
|
|
||||||
|
**Complete Guide for Team Members**
|
||||||
|
|
||||||
|
**Date**: 2025-01-27
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Status**: ✅ **ACTIVE** - Ready for production use
|
||||||
|
|
||||||
|
## 🎯 Overview
|
||||||
|
|
||||||
|
A pre-commit hook that automatically detects and prevents debug code from reaching protected branches (master, main, production, release, stable). This ensures production code remains clean while allowing free development on feature branches.
|
||||||
|
|
||||||
|
## 🚀 Quick Installation
|
||||||
|
|
||||||
|
**From within the TimeSafari repository:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/install-debug-hook.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
This automatically installs, updates, and verifies the hook in your current
|
||||||
|
repository. **Note**: Hooks are not automatically installed - you must run this
|
||||||
|
script deliberately to enable debug code checking.
|
||||||
|
|
||||||
|
## 🔧 Manual Installation
|
||||||
|
|
||||||
|
**Copy files manually:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp scripts/git-hooks/pre-commit /path/to/your/repo/.git/hooks/
|
||||||
|
cp scripts/git-hooks/debug-checker.config /path/to/your/repo/.git/hooks/
|
||||||
|
chmod +x /path/to/your/repo/.git/hooks/pre-commit
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 What Gets Installed
|
||||||
|
|
||||||
|
- **`pre-commit`** - Main hook script (executable)
|
||||||
|
- **`debug-checker.config`** - Configuration file
|
||||||
|
- **`README.md`** - Documentation and troubleshooting
|
||||||
|
|
||||||
|
**Note**: Hooks are stored in `scripts/git-hooks/` and must be deliberately
|
||||||
|
installed by each developer. They are not automatically active.
|
||||||
|
|
||||||
|
## 🎯 How It Works
|
||||||
|
|
||||||
|
1. **Deliberate Installation**: Hooks must be explicitly installed by each
|
||||||
|
developer
|
||||||
|
2. **Branch Detection**: Only runs on protected branches
|
||||||
|
3. **File Filtering**: Automatically skips tests, scripts, and documentation
|
||||||
|
4. **Pattern Matching**: Detects debug code using regex patterns
|
||||||
|
5. **Commit Prevention**: Blocks commits containing debug code
|
||||||
|
|
||||||
|
## 🔒 Installation Philosophy
|
||||||
|
|
||||||
|
**Why deliberate installation?**
|
||||||
|
|
||||||
|
- **Developer choice**: Each developer decides whether to use the hook
|
||||||
|
- **No forced behavior**: Hooks don't interfere with existing workflows
|
||||||
|
- **Local control**: Hooks are installed locally, not globally
|
||||||
|
- **Easy removal**: Can be uninstalled at any time
|
||||||
|
- **Team flexibility**: Some developers may prefer different tools
|
||||||
|
|
||||||
|
## 🌿 Branch Behavior
|
||||||
|
|
||||||
|
- **Protected branches** (master, main, production, release, stable): Hook runs automatically
|
||||||
|
- **Feature branches**: Hook is skipped, allowing free development with debug code
|
||||||
|
|
||||||
|
## 🔍 Debug Patterns Detected
|
||||||
|
|
||||||
|
- **Console statements**: `console.log`, `console.debug`, `console.error`
|
||||||
|
- **Template debug**: `Debug:`, `debug:` in Vue templates
|
||||||
|
- **Debug constants**: `DEBUG_`, `debug_` variables
|
||||||
|
- **HTML debug**: `<!-- debug` comments
|
||||||
|
- **Debug attributes**: `debug="true"` attributes
|
||||||
|
- **Vue debug**: `v-if="debug"`, `v-show="debug"`
|
||||||
|
- **Debug TODOs**: `TODO debug`, `FIXME debug`
|
||||||
|
|
||||||
|
## 📁 Files Automatically Skipped
|
||||||
|
|
||||||
|
- Test files: `*.test.js`, `*.spec.ts`, `*.test.vue`
|
||||||
|
- Scripts: `scripts/` directory
|
||||||
|
- Test directories: `test-*` directories
|
||||||
|
- Documentation: `docs/`, `*.md`, `*.txt`
|
||||||
|
- Config files: `*.json`, `*.yml`, `*.yaml`
|
||||||
|
- IDE files: `.cursor/` directory
|
||||||
|
|
||||||
|
## ✅ Verification
|
||||||
|
|
||||||
|
**After installation, verify it's working:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check if files exist
|
||||||
|
ls -la .git/hooks/pre-commit
|
||||||
|
ls -la .git/hooks/debug-checker.config
|
||||||
|
|
||||||
|
# Test the hook manually
|
||||||
|
.git/hooks/pre-commit
|
||||||
|
|
||||||
|
# Test with actual commit
|
||||||
|
echo "console.log('test')" > test.vue
|
||||||
|
git add test.vue
|
||||||
|
git commit -m "test" # Should be blocked
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📊 Example Output
|
||||||
|
|
||||||
|
```
|
||||||
|
❌ Debug code detected in staged files!
|
||||||
|
Branch: master
|
||||||
|
Files checked: 1
|
||||||
|
Errors found: 3
|
||||||
|
|
||||||
|
🚨 AccountViewView.vue: Found debug pattern 'console\.'
|
||||||
|
🚨 AccountViewView.vue: Found debug pattern 'Debug:'
|
||||||
|
🚨 AccountViewView.vue: Found debug pattern 'DEBUG_'
|
||||||
|
|
||||||
|
💡 Please remove debug code before committing to master
|
||||||
|
```
|
||||||
|
|
||||||
|
## ⚙️ Configuration
|
||||||
|
|
||||||
|
Edit `.git/hooks/debug-checker.config` to customize:
|
||||||
|
|
||||||
|
- **Protected branches**: Add/remove branches as needed
|
||||||
|
- **Debug patterns**: Customize what gets detected
|
||||||
|
- **Skip patterns**: Adjust file filtering rules
|
||||||
|
|
||||||
|
## 🚨 Emergency Bypass
|
||||||
|
|
||||||
|
If you absolutely need to commit debug code to a protected branch:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git commit --no-verify -m "emergency: debug code needed"
|
||||||
|
```
|
||||||
|
|
||||||
|
⚠️ **Warning**: This bypasses all pre-commit hooks. Use sparingly.
|
||||||
|
|
||||||
|
## 🔄 Updates
|
||||||
|
|
||||||
|
When the hook is updated in the main repository:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/install-debug-hook.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚨 Troubleshooting
|
||||||
|
|
||||||
|
| Issue | Solution |
|
||||||
|
|-------|----------|
|
||||||
|
| Hook not running | Check if on protected branch, verify permissions |
|
||||||
|
| Permission denied | Run `chmod +x .git/hooks/pre-commit` |
|
||||||
|
| Files not found | Ensure you're copying from TimeSafari repo |
|
||||||
|
| False positives | Edit `debug-checker.config` to customize patterns |
|
||||||
|
|
||||||
|
## 🧪 Testing
|
||||||
|
|
||||||
|
A test script is available at `scripts/test-debug-hook.sh` to verify the hook works correctly.
|
||||||
|
|
||||||
|
## 💡 Best Practices
|
||||||
|
|
||||||
|
1. **Use feature branches** for development with debug code
|
||||||
|
2. **Use proper logging** instead of console statements (`logger.info`, `logger.debug`)
|
||||||
|
3. **Test thoroughly** before merging to protected branches
|
||||||
|
4. **Review commits** to ensure no debug code slips through
|
||||||
|
5. **Keep hooks updated** across all repositories
|
||||||
|
|
||||||
|
## 📚 Additional Resources
|
||||||
|
|
||||||
|
- **Hook documentation**: `scripts/git-hooks/README.md`
|
||||||
|
- **Configuration**: `scripts/git-hooks/debug-checker.config`
|
||||||
|
- **Test script**: `scripts/test-debug-hook.sh`
|
||||||
|
- **Installation script**: `scripts/install-debug-hook.sh`
|
||||||
|
|
||||||
|
## 🎯 Team Workflow
|
||||||
|
|
||||||
|
**Recommended setup:**
|
||||||
|
|
||||||
|
1. **Repository setup**: Include hook files in `.githooks/` directory
|
||||||
|
2. **Team onboarding**: Run installation script in each repo
|
||||||
|
3. **Updates**: Re-run installation script when hooks are updated
|
||||||
|
4. **Documentation**: Keep this guide updated
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Status**: Active and enforced
|
||||||
|
**Last Updated**: 2025-01-27
|
||||||
|
**Maintainer**: Matthew Raymer
|
||||||
@@ -7,18 +7,22 @@ This document summarizes the comprehensive cleanup and improvements made to the
|
|||||||
## Key Issues Resolved
|
## Key Issues Resolved
|
||||||
|
|
||||||
### 1. Platform Detection Problems
|
### 1. Platform Detection Problems
|
||||||
|
|
||||||
- **Before**: `PlatformServiceFactory` only supported "capacitor" and "web" platforms
|
- **Before**: `PlatformServiceFactory` only supported "capacitor" and "web" platforms
|
||||||
- **After**: Added proper "electron" platform support with dedicated `ElectronPlatformService`
|
- **After**: Added proper "electron" platform support with dedicated `ElectronPlatformService`
|
||||||
|
|
||||||
### 2. Build Configuration Confusion
|
### 2. Build Configuration Confusion
|
||||||
|
|
||||||
- **Before**: Electron builds used `VITE_PLATFORM=capacitor`, causing confusion
|
- **Before**: Electron builds used `VITE_PLATFORM=capacitor`, causing confusion
|
||||||
- **After**: Electron builds now properly use `VITE_PLATFORM=electron`
|
- **After**: Electron builds now properly use `VITE_PLATFORM=electron`
|
||||||
|
|
||||||
### 3. Missing Platform Service Methods
|
### 3. Missing Platform Service Methods
|
||||||
|
|
||||||
- **Before**: Platform services lacked proper `isElectron()`, `isCapacitor()`, `isWeb()` methods
|
- **Before**: Platform services lacked proper `isElectron()`, `isCapacitor()`, `isWeb()` methods
|
||||||
- **After**: All platform services implement complete interface with proper detection
|
- **After**: All platform services implement complete interface with proper detection
|
||||||
|
|
||||||
### 4. Inconsistent Build Scripts
|
### 4. Inconsistent Build Scripts
|
||||||
|
|
||||||
- **Before**: Mixed platform settings in build scripts
|
- **Before**: Mixed platform settings in build scripts
|
||||||
- **After**: Clean, consistent electron-specific build process
|
- **After**: Clean, consistent electron-specific build process
|
||||||
|
|
||||||
@@ -215,11 +219,13 @@ if (capabilities.hasFileDownload) {
|
|||||||
## File Structure Changes
|
## File Structure Changes
|
||||||
|
|
||||||
### New Files
|
### New Files
|
||||||
|
|
||||||
- `vite.config.electron.mts` - Electron-specific Vite configuration
|
- `vite.config.electron.mts` - Electron-specific Vite configuration
|
||||||
- `src/main.electron.ts` - Electron main entry point
|
- `src/main.electron.ts` - Electron main entry point
|
||||||
- `doc/electron-cleanup-summary.md` - This documentation
|
- `doc/electron-cleanup-summary.md` - This documentation
|
||||||
|
|
||||||
### Modified Files
|
### Modified Files
|
||||||
|
|
||||||
- `src/services/PlatformServiceFactory.ts` - Added electron platform support
|
- `src/services/PlatformServiceFactory.ts` - Added electron platform support
|
||||||
- `src/services/PlatformService.ts` - Added platform detection methods
|
- `src/services/PlatformService.ts` - Added platform detection methods
|
||||||
- `src/services/platforms/CapacitorPlatformService.ts` - Added missing interface methods
|
- `src/services/platforms/CapacitorPlatformService.ts` - Added missing interface methods
|
||||||
@@ -301,4 +307,4 @@ For developers working with the previous implementation:
|
|||||||
- [ ] Implement desktop-specific UI components
|
- [ ] Implement desktop-specific UI components
|
||||||
- [ ] Add Electron auto-updater integration
|
- [ ] Add Electron auto-updater integration
|
||||||
- [ ] Create platform-specific testing utilities
|
- [ ] Create platform-specific testing utilities
|
||||||
- [ ] Add desktop notification system integration
|
- [ ] Add desktop notification system integration
|
||||||
|
|||||||
@@ -7,18 +7,22 @@ This document summarizes the comprehensive changes made to reduce excessive cons
|
|||||||
## Issues Addressed
|
## Issues Addressed
|
||||||
|
|
||||||
### 1. Excessive Database Logging (Major Issue - 90% Reduction)
|
### 1. Excessive Database Logging (Major Issue - 90% Reduction)
|
||||||
|
|
||||||
**Problem:** Every database operation was logging detailed parameter information, creating hundreds of lines of console output.
|
**Problem:** Every database operation was logging detailed parameter information, creating hundreds of lines of console output.
|
||||||
|
|
||||||
**Solution:** Modified `src/services/platforms/CapacitorPlatformService.ts`:
|
**Solution:** Modified `src/services/platforms/CapacitorPlatformService.ts`:
|
||||||
|
|
||||||
- Changed `logger.warn` to `logger.debug` for routine SQL operations
|
- Changed `logger.warn` to `logger.debug` for routine SQL operations
|
||||||
- Reduced migration logging verbosity
|
- Reduced migration logging verbosity
|
||||||
- Made database integrity checks use debug-level logging
|
- Made database integrity checks use debug-level logging
|
||||||
- Kept error and completion messages at appropriate log levels
|
- Kept error and completion messages at appropriate log levels
|
||||||
|
|
||||||
### 2. Enhanced Logger Configuration
|
### 2. Enhanced Logger Configuration
|
||||||
|
|
||||||
**Problem:** No platform-specific logging controls, causing noise in Electron.
|
**Problem:** No platform-specific logging controls, causing noise in Electron.
|
||||||
|
|
||||||
**Solution:** Updated `src/utils/logger.ts`:
|
**Solution:** Updated `src/utils/logger.ts`:
|
||||||
|
|
||||||
- Added platform detection for Electron vs Web
|
- Added platform detection for Electron vs Web
|
||||||
- Suppressed debug and verbose logs for Electron
|
- Suppressed debug and verbose logs for Electron
|
||||||
- Filtered out routine database operations from database logging
|
- Filtered out routine database operations from database logging
|
||||||
@@ -26,28 +30,35 @@ This document summarizes the comprehensive changes made to reduce excessive cons
|
|||||||
- Added intelligent filtering for CapacitorPlatformService messages
|
- Added intelligent filtering for CapacitorPlatformService messages
|
||||||
|
|
||||||
### 3. API Configuration Issues (Major Fix)
|
### 3. API Configuration Issues (Major Fix)
|
||||||
|
|
||||||
**Problem:** Electron was trying to use local development endpoints (localhost:3000) from saved user settings, which don't exist in desktop environment, causing:
|
**Problem:** Electron was trying to use local development endpoints (localhost:3000) from saved user settings, which don't exist in desktop environment, causing:
|
||||||
|
|
||||||
- 400 status errors from missing local development servers
|
- 400 status errors from missing local development servers
|
||||||
- JSON parsing errors (HTML error pages instead of JSON responses)
|
- JSON parsing errors (HTML error pages instead of JSON responses)
|
||||||
|
|
||||||
**Solution:**
|
**Solution:**
|
||||||
|
|
||||||
- Updated `src/constants/app.ts` to provide Electron-specific API endpoints
|
- Updated `src/constants/app.ts` to provide Electron-specific API endpoints
|
||||||
- **Critical Fix:** Modified `src/db/databaseUtil.ts` in `retrieveSettingsForActiveAccount()` to force Electron to use production API endpoints regardless of saved user settings
|
- **Critical Fix:** Modified `src/db/databaseUtil.ts` in `retrieveSettingsForActiveAccount()` to force Electron to use production API endpoints regardless of saved user settings
|
||||||
- This ensures Electron never uses localhost development servers that users might have saved
|
- This ensures Electron never uses localhost development servers that users might have saved
|
||||||
|
|
||||||
### 4. SharedArrayBuffer Logging Noise
|
### 4. SharedArrayBuffer Logging Noise
|
||||||
|
|
||||||
**Problem:** Web-specific SharedArrayBuffer detection was running in Electron, creating unnecessary debug output.
|
**Problem:** Web-specific SharedArrayBuffer detection was running in Electron, creating unnecessary debug output.
|
||||||
|
|
||||||
**Solution:** Modified `src/main.web.ts`:
|
**Solution:** Modified `src/main.web.ts`:
|
||||||
|
|
||||||
- Made SharedArrayBuffer logging conditional on web platform only
|
- Made SharedArrayBuffer logging conditional on web platform only
|
||||||
- Converted console.log statements to logger.debug
|
- Converted console.log statements to logger.debug
|
||||||
- Only show in development mode for web platform
|
- Only show in development mode for web platform
|
||||||
- Reduced platform detection noise
|
- Reduced platform detection noise
|
||||||
|
|
||||||
### 5. Missing Source Maps Warnings
|
### 5. Missing Source Maps Warnings
|
||||||
|
|
||||||
**Problem:** Electron DevTools was complaining about missing source maps for external dependencies.
|
**Problem:** Electron DevTools was complaining about missing source maps for external dependencies.
|
||||||
|
|
||||||
**Solution:** Updated `vite.config.electron.mts`:
|
**Solution:** Updated `vite.config.electron.mts`:
|
||||||
|
|
||||||
- Disabled source maps for Electron builds (`sourcemap: false`)
|
- Disabled source maps for Electron builds (`sourcemap: false`)
|
||||||
- Added build configuration to suppress external dependency warnings
|
- Added build configuration to suppress external dependency warnings
|
||||||
- Prevents DevTools from looking for non-existent source map files
|
- Prevents DevTools from looking for non-existent source map files
|
||||||
@@ -87,14 +98,16 @@ This document summarizes the comprehensive changes made to reduce excessive cons
|
|||||||
|
|
||||||
## Impact
|
## Impact
|
||||||
|
|
||||||
### Before Cleanup:
|
### Before Cleanup
|
||||||
|
|
||||||
- 500+ lines of console output per minute
|
- 500+ lines of console output per minute
|
||||||
- Detailed SQL parameter logging for every operation
|
- Detailed SQL parameter logging for every operation
|
||||||
- API connection errors every few seconds (400 status, JSON parsing errors)
|
- API connection errors every few seconds (400 status, JSON parsing errors)
|
||||||
- SharedArrayBuffer warnings on every startup
|
- SharedArrayBuffer warnings on every startup
|
||||||
- DevTools source map warnings
|
- DevTools source map warnings
|
||||||
|
|
||||||
### After Cleanup:
|
### After Cleanup
|
||||||
|
|
||||||
- **~95% reduction** in console output
|
- **~95% reduction** in console output
|
||||||
- Only errors and important status messages visible
|
- Only errors and important status messages visible
|
||||||
- **No API connection errors** - Electron uses proper production endpoints
|
- **No API connection errors** - Electron uses proper production endpoints
|
||||||
@@ -106,6 +119,7 @@ This document summarizes the comprehensive changes made to reduce excessive cons
|
|||||||
## Technical Details
|
## Technical Details
|
||||||
|
|
||||||
### API Configuration Fix
|
### API Configuration Fix
|
||||||
|
|
||||||
The most critical fix was in `src/db/databaseUtil.ts` where we added:
|
The most critical fix was in `src/db/databaseUtil.ts` where we added:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -122,6 +136,7 @@ if (process.env.VITE_PLATFORM === "electron") {
|
|||||||
This ensures that even if users have localhost development endpoints saved in their settings, Electron will override them with production endpoints.
|
This ensures that even if users have localhost development endpoints saved in their settings, Electron will override them with production endpoints.
|
||||||
|
|
||||||
### Logger Enhancement
|
### Logger Enhancement
|
||||||
|
|
||||||
Enhanced the logger with platform-specific behavior:
|
Enhanced the logger with platform-specific behavior:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
@@ -135,6 +150,7 @@ if (!isElectron || !message.includes("[CapacitorPlatformService]")) {
|
|||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
The changes were tested with:
|
The changes were tested with:
|
||||||
|
|
||||||
- `npm run lint-fix` - 0 errors, warnings only (pre-existing)
|
- `npm run lint-fix` - 0 errors, warnings only (pre-existing)
|
||||||
- Electron development environment
|
- Electron development environment
|
||||||
- Web platform (unchanged functionality)
|
- Web platform (unchanged functionality)
|
||||||
@@ -150,6 +166,7 @@ The changes were tested with:
|
|||||||
## Backward Compatibility
|
## Backward Compatibility
|
||||||
|
|
||||||
All changes maintain backward compatibility:
|
All changes maintain backward compatibility:
|
||||||
|
|
||||||
- Web platform logging unchanged
|
- Web platform logging unchanged
|
||||||
- Capacitor platform logging unchanged
|
- Capacitor platform logging unchanged
|
||||||
- Error handling preserved
|
- Error handling preserved
|
||||||
@@ -185,4 +202,4 @@ Tests: lint passes, Web/Capacitor functionality preserved
|
|||||||
1. **Test the fixes** - Run `npm run electron:dev` to verify console noise is eliminated
|
1. **Test the fixes** - Run `npm run electron:dev` to verify console noise is eliminated
|
||||||
2. **Monitor for remaining issues** - Check for any other console noise sources
|
2. **Monitor for remaining issues** - Check for any other console noise sources
|
||||||
3. **Performance monitoring** - Verify the reduced logging doesn't impact functionality
|
3. **Performance monitoring** - Verify the reduced logging doesn't impact functionality
|
||||||
4. **Documentation updates** - Update any development guides that reference the old logging behavior
|
4. **Documentation updates** - Update any development guides that reference the old logging behavior
|
||||||
|
|||||||
@@ -5,9 +5,10 @@ This file tracks console errors observed during development for future investiga
|
|||||||
## 2025-07-07 08:56 UTC - ProjectsView.vue Migration Session
|
## 2025-07-07 08:56 UTC - ProjectsView.vue Migration Session
|
||||||
|
|
||||||
### Migration Context
|
### Migration Context
|
||||||
|
|
||||||
- **Current Work**: Completed ProjectsView.vue Triple Migration Pattern
|
- **Current Work**: Completed ProjectsView.vue Triple Migration Pattern
|
||||||
- **Migration Status**: 21 complete, 4 appropriately incomplete components
|
- **Migration Status**: 21 complete, 4 appropriately incomplete components
|
||||||
- **Recent Changes**:
|
- **Recent Changes**:
|
||||||
- ProjectsView.vue: databaseUtil → PlatformServiceMixin
|
- ProjectsView.vue: databaseUtil → PlatformServiceMixin
|
||||||
- Added notification constants and literal string extraction
|
- Added notification constants and literal string extraction
|
||||||
- Template logic streamlining with computed properties
|
- Template logic streamlining with computed properties
|
||||||
@@ -15,42 +16,50 @@ This file tracks console errors observed during development for future investiga
|
|||||||
### Observed Errors
|
### Observed Errors
|
||||||
|
|
||||||
#### 1. HomeView.vue API Rate Limit Errors
|
#### 1. HomeView.vue API Rate Limit Errors
|
||||||
|
|
||||||
```
|
```
|
||||||
GET https://api.endorser.ch/api/report/rateLimits 400 (Bad Request)
|
GET https://api.endorser.ch/api/report/rateLimits 400 (Bad Request)
|
||||||
Source: endorserServer.ts:1494, HomeView.vue:593, HomeView.vue:742
|
Source: endorserServer.ts:1494, HomeView.vue:593, HomeView.vue:742
|
||||||
```
|
```
|
||||||
|
|
||||||
**Analysis**:
|
**Analysis**:
|
||||||
|
|
||||||
- API server returning 400 for rate limit checks
|
- API server returning 400 for rate limit checks
|
||||||
- Occurs during identity initialization and registration status checks
|
- Occurs during identity initialization and registration status checks
|
||||||
- **Migration Impact**: None - HomeView.vue was migrated and tested earlier
|
- **Migration Impact**: None - HomeView.vue was migrated and tested earlier
|
||||||
- **Likely Cause**: Server-side authentication or API configuration issue
|
- **Likely Cause**: Server-side authentication or API configuration issue
|
||||||
|
|
||||||
**Action Items**:
|
**Action Items**:
|
||||||
|
|
||||||
- [ ] Check endorser.ch API documentation for rate limit endpoint changes
|
- [ ] Check endorser.ch API documentation for rate limit endpoint changes
|
||||||
- [ ] Verify authentication headers being sent correctly
|
- [ ] Verify authentication headers being sent correctly
|
||||||
- [ ] Consider fallback handling for rate limit API failures
|
- [ ] Consider fallback handling for rate limit API failures
|
||||||
|
|
||||||
#### 2. ProjectViewView.vue Project Not Found Error
|
#### 2. ProjectViewView.vue Project Not Found Error
|
||||||
|
|
||||||
```
|
```
|
||||||
GET https://api.endorser.ch/api/claim/byHandle/...01JY2Q5D90E8P267ABB963S71D 404 (Not Found)
|
GET https://api.endorser.ch/api/claim/byHandle/...01JY2Q5D90E8P267ABB963S71D 404 (Not Found)
|
||||||
Source: ProjectViewView.vue:830 loadProject() method
|
Source: ProjectViewView.vue:830 loadProject() method
|
||||||
```
|
```
|
||||||
|
|
||||||
**Analysis**:
|
**Analysis**:
|
||||||
|
|
||||||
- Attempting to load project ID: `01JY2Q5D90E8P267ABB963S71D`
|
- Attempting to load project ID: `01JY2Q5D90E8P267ABB963S71D`
|
||||||
- **Migration Impact**: None - error handling working correctly
|
- **Migration Impact**: None - error handling working correctly
|
||||||
- **Likely Cause**: User navigated to non-existent project or stale link
|
- **Likely Cause**: User navigated to non-existent project or stale link
|
||||||
|
|
||||||
**Action Items**:
|
**Action Items**:
|
||||||
|
|
||||||
- [ ] Consider adding better user messaging for missing projects
|
- [ ] Consider adding better user messaging for missing projects
|
||||||
- [ ] Investigate if project IDs are being generated/stored correctly
|
- [ ] Investigate if project IDs are being generated/stored correctly
|
||||||
- [ ] Add breadcrumb or "return to projects" option on 404s
|
- [ ] Add breadcrumb or "return to projects" option on 404s
|
||||||
|
|
||||||
#### 3. Axios Request Stack Traces
|
#### 3. Axios Request Stack Traces
|
||||||
|
|
||||||
Multiple stack traces showing Vue router navigation and component mounting cycles.
|
Multiple stack traces showing Vue router navigation and component mounting cycles.
|
||||||
|
|
||||||
**Analysis**:
|
**Analysis**:
|
||||||
|
|
||||||
- Normal Vue.js lifecycle and routing behavior
|
- Normal Vue.js lifecycle and routing behavior
|
||||||
- No obvious memory leaks or infinite loops
|
- No obvious memory leaks or infinite loops
|
||||||
- **Migration Impact**: None - expected framework behavior
|
- **Migration Impact**: None - expected framework behavior
|
||||||
@@ -58,26 +67,30 @@ Multiple stack traces showing Vue router navigation and component mounting cycle
|
|||||||
### System Health Indicators
|
### System Health Indicators
|
||||||
|
|
||||||
#### ✅ Working Correctly
|
#### ✅ Working Correctly
|
||||||
|
|
||||||
- Database migrations: `Migration process complete! Summary: 0 applied, 2 skipped`
|
- Database migrations: `Migration process complete! Summary: 0 applied, 2 skipped`
|
||||||
- Platform service factory initialization: `Creating singleton instance for platform: development`
|
- Platform service factory initialization: `Creating singleton instance for platform: development`
|
||||||
- SQL worker loading: `Worker loaded, ready to receive messages`
|
- SQL worker loading: `Worker loaded, ready to receive messages`
|
||||||
- Database connection: `Opened!`
|
- Database connection: `Opened!`
|
||||||
|
|
||||||
#### 🔄 For Investigation
|
#### 🔄 For Investigation
|
||||||
|
|
||||||
- API authentication/authorization with endorser.ch
|
- API authentication/authorization with endorser.ch
|
||||||
- Project ID validation and error handling
|
- Project ID validation and error handling
|
||||||
- Rate limiting strategy
|
- Rate limiting strategy
|
||||||
|
|
||||||
### Migration Validation
|
### Migration Validation
|
||||||
|
|
||||||
- **ProjectsView.vue**: Appropriately incomplete (3 helpers + 1 complex modal)
|
- **ProjectsView.vue**: Appropriately incomplete (3 helpers + 1 complex modal)
|
||||||
- **Error Handling**: Migrated components showing proper error handling
|
- **Error Handling**: Migrated components showing proper error handling
|
||||||
- **No Migration-Related Errors**: All errors appear to be infrastructure/data issues
|
- **No Migration-Related Errors**: All errors appear to be infrastructure/data issues
|
||||||
|
|
||||||
### Next Steps
|
### Next Steps
|
||||||
|
|
||||||
1. Continue migration slog with next component
|
1. Continue migration slog with next component
|
||||||
2. Monitor these same error patterns in future sessions
|
2. Monitor these same error patterns in future sessions
|
||||||
3. Address API/server issues in separate debugging session
|
3. Address API/server issues in separate debugging session
|
||||||
|
|
||||||
---
|
---
|
||||||
*Log Entry by: Migration Assistant*
|
*Log Entry by: Migration Assistant*
|
||||||
*Session: ProjectsView.vue Triple Migration Pattern*
|
*Session: ProjectsView.vue Triple Migration Pattern*
|
||||||
|
|||||||
381
doc/husky-conditional-activation.md
Normal file
381
doc/husky-conditional-activation.md
Normal file
@@ -0,0 +1,381 @@
|
|||||||
|
# Husky Conditional Activation System
|
||||||
|
|
||||||
|
**Author**: Matthew Raymer
|
||||||
|
**Date**: 2025-08-21T09:40Z
|
||||||
|
**Status**: 🎯 **ACTIVE** - Git hooks with optional activation
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This document describes the **conditional Husky activation system** implemented
|
||||||
|
in the TimeSafari project. The system provides standardized git hooks that are
|
||||||
|
committed to version control but only activate when explicitly enabled by
|
||||||
|
individual developers.
|
||||||
|
|
||||||
|
## Problem Statement
|
||||||
|
|
||||||
|
Traditional Husky implementations face several challenges:
|
||||||
|
|
||||||
|
1. **Automatic activation** on all systems can be disruptive
|
||||||
|
2. **Different environments** may have different requirements
|
||||||
|
3. **Team preferences** vary regarding git hook enforcement
|
||||||
|
4. **CI/CD systems** may not need or want git hooks
|
||||||
|
5. **New developers** may be surprised by unexpected hook behavior
|
||||||
|
|
||||||
|
## Solution: Conditional Activation
|
||||||
|
|
||||||
|
The conditional activation system solves these problems by:
|
||||||
|
|
||||||
|
- **Committing hooks to git** for consistency and version control
|
||||||
|
- **Making hooks optional** by default
|
||||||
|
- **Providing multiple activation methods** for flexibility
|
||||||
|
- **Ensuring hooks exit gracefully** when disabled
|
||||||
|
- **Maintaining team standards** without forcing compliance
|
||||||
|
|
||||||
|
## System Architecture
|
||||||
|
|
||||||
|
### **Core Components**
|
||||||
|
|
||||||
|
```
|
||||||
|
.husky/
|
||||||
|
├── _/husky.sh # Conditional activation logic
|
||||||
|
├── pre-commit # Pre-commit hook (linting)
|
||||||
|
├── commit-msg # Commit message validation
|
||||||
|
└── README.md # User activation instructions
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Activation Methods**
|
||||||
|
|
||||||
|
#### **Method 1: Environment Variable (Session Only)**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export HUSKY_ENABLED=1
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Scope**: Current terminal session only
|
||||||
|
- **Use case**: Temporary activation for testing
|
||||||
|
- **Reset**: `unset HUSKY_ENABLED`
|
||||||
|
|
||||||
|
#### **Method 2: Local File (Persistent)**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
touch .husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Scope**: Current repository, persistent
|
||||||
|
- **Use case**: Long-term activation for development
|
||||||
|
- **Reset**: `rm .husky-enabled`
|
||||||
|
|
||||||
|
#### **Method 3: Global Git Configuration**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git config --global husky.enabled true
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Scope**: All repositories for current user
|
||||||
|
- **Use case**: Developer preference across projects
|
||||||
|
- **Reset**: `git config --global --unset husky.enabled`
|
||||||
|
|
||||||
|
## Implementation Details
|
||||||
|
|
||||||
|
### **Conditional Activation Logic**
|
||||||
|
|
||||||
|
The core logic in `.husky/_/husky.sh`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check if Husky is enabled for this user
|
||||||
|
if [ "$HUSKY_ENABLED" != "1" ] && [ ! -f .husky-enabled ]; then
|
||||||
|
echo "Husky is not enabled. To enable:"
|
||||||
|
echo " export HUSKY_ENABLED=1"
|
||||||
|
echo " or create .husky-enabled file"
|
||||||
|
exit 0 # Graceful exit, not an error
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Hook Behavior**
|
||||||
|
|
||||||
|
When **disabled**:
|
||||||
|
|
||||||
|
- Hooks display helpful activation instructions
|
||||||
|
- Exit with code 0 (success, not error)
|
||||||
|
- No git operations are blocked
|
||||||
|
- No performance impact
|
||||||
|
|
||||||
|
When **enabled**:
|
||||||
|
|
||||||
|
- Hooks run normally with full functionality
|
||||||
|
- Standard Husky behavior applies
|
||||||
|
- Git operations may be blocked if hooks fail
|
||||||
|
|
||||||
|
## Available Hooks
|
||||||
|
|
||||||
|
### **Pre-commit Hook**
|
||||||
|
|
||||||
|
**File**: `.husky/pre-commit`
|
||||||
|
**Purpose**: Code quality enforcement before commits
|
||||||
|
**Action**: Runs `npm run lint-fix`
|
||||||
|
**When**: Before each commit
|
||||||
|
**Failure**: Prevents commit if linting fails
|
||||||
|
|
||||||
|
**Activation Check**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
if [ "$HUSKY_ENABLED" = "1" ] || [ -f .husky-enabled ]; then
|
||||||
|
echo "Running pre-commit hooks..."
|
||||||
|
npm run lint-fix
|
||||||
|
else
|
||||||
|
echo "Husky pre-commit hook skipped (not enabled)"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Commit-msg Hook**
|
||||||
|
|
||||||
|
**File**: `.husky/commit-msg`
|
||||||
|
**Purpose**: Commit message format validation
|
||||||
|
**Action**: Runs `npx commitlint --edit "$1"`
|
||||||
|
**When**: After commit message is written
|
||||||
|
**Failure**: Prevents commit if message format is invalid
|
||||||
|
|
||||||
|
**Activation Check**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
if [ "$HUSKY_ENABLED" = "1" ] || [ -f .husky-enabled ]; then
|
||||||
|
echo "Running commit-msg hooks..."
|
||||||
|
npx commitlint --edit "$1"
|
||||||
|
else
|
||||||
|
echo "Husky commit-msg hook skipped (not enabled)"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
## User Workflows
|
||||||
|
|
||||||
|
### **New Developer Setup**
|
||||||
|
|
||||||
|
1. **Clone repository**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone <repository-url>
|
||||||
|
cd <repository-name>
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Hooks are present but inactive**
|
||||||
|
- Pre-commit and commit-msg hooks exist
|
||||||
|
- No automatic activation
|
||||||
|
- Git operations work normally
|
||||||
|
|
||||||
|
3. **Optional: Enable hooks**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# For current session only
|
||||||
|
export HUSKY_ENABLED=1
|
||||||
|
|
||||||
|
# For persistent activation
|
||||||
|
touch .husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Daily Development**
|
||||||
|
|
||||||
|
#### **With Hooks Disabled**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "feat: add new feature"
|
||||||
|
# Hooks are skipped, commit proceeds normally
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **With Hooks Enabled**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m "feat: add new feature"
|
||||||
|
# Pre-commit hook runs linting
|
||||||
|
# Commit-msg hook validates message format
|
||||||
|
# Commit only proceeds if all hooks pass
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Troubleshooting**
|
||||||
|
|
||||||
|
#### **Hooks Not Running**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check if hooks are enabled
|
||||||
|
echo $HUSKY_ENABLED
|
||||||
|
ls -la .husky-enabled
|
||||||
|
|
||||||
|
# Enable hooks
|
||||||
|
export HUSKY_ENABLED=1
|
||||||
|
# or
|
||||||
|
touch .husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Hooks Running Unexpectedly**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Disable hooks
|
||||||
|
unset HUSKY_ENABLED
|
||||||
|
rm -f .husky-enabled
|
||||||
|
|
||||||
|
# Check global configuration
|
||||||
|
git config --global --get husky.enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration Files
|
||||||
|
|
||||||
|
### **`.gitignore` Entry**
|
||||||
|
|
||||||
|
```gitignore
|
||||||
|
# Husky activation file (user-specific)
|
||||||
|
.husky-enabled
|
||||||
|
```
|
||||||
|
|
||||||
|
This ensures that:
|
||||||
|
|
||||||
|
- Hooks are committed to git (team standard)
|
||||||
|
- Activation files are not committed (user preference)
|
||||||
|
- Each developer can control their own activation
|
||||||
|
|
||||||
|
### **Package.json Dependencies**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"devDependencies": {
|
||||||
|
"husky": "^9.0.11",
|
||||||
|
"@commitlint/cli": "^18.6.1",
|
||||||
|
"@commitlint/config-conventional": "^18.6.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Benefits
|
||||||
|
|
||||||
|
### **For Development Teams**
|
||||||
|
|
||||||
|
1. **Consistency**: All developers have the same hook configuration
|
||||||
|
2. **Flexibility**: Individual developers can choose activation
|
||||||
|
3. **Standards**: Team coding standards are enforced when enabled
|
||||||
|
4. **Version Control**: Hook configuration is tracked and versioned
|
||||||
|
5. **Onboarding**: New developers get standardized setup
|
||||||
|
|
||||||
|
### **For Individual Developers**
|
||||||
|
|
||||||
|
1. **Choice**: Control over when hooks are active
|
||||||
|
2. **Performance**: No unnecessary hook execution when disabled
|
||||||
|
3. **Learning**: Gradual adoption of git hook practices
|
||||||
|
4. **Debugging**: Easy to disable hooks for troubleshooting
|
||||||
|
5. **Environment**: Works across different development environments
|
||||||
|
|
||||||
|
### **For CI/CD Systems**
|
||||||
|
|
||||||
|
1. **No Interference**: Hooks don't run in automated environments
|
||||||
|
2. **Consistency**: Same hook logic available if needed
|
||||||
|
3. **Flexibility**: Can enable hooks in specific CI scenarios
|
||||||
|
4. **Reliability**: No unexpected hook failures in automation
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
### **Team Adoption**
|
||||||
|
|
||||||
|
1. **Start with disabled hooks** for new team members
|
||||||
|
2. **Encourage gradual adoption** of hook activation
|
||||||
|
3. **Document hook benefits** and usage patterns
|
||||||
|
4. **Provide training** on hook configuration
|
||||||
|
5. **Support troubleshooting** when hooks cause issues
|
||||||
|
|
||||||
|
### **Hook Development**
|
||||||
|
|
||||||
|
1. **Keep hooks lightweight** and fast
|
||||||
|
2. **Provide clear error messages** when hooks fail
|
||||||
|
3. **Include helpful activation instructions** in disabled state
|
||||||
|
4. **Test hooks in both enabled and disabled states**
|
||||||
|
5. **Document hook requirements** and dependencies
|
||||||
|
|
||||||
|
### **Configuration Management**
|
||||||
|
|
||||||
|
1. **Commit hook files** to version control
|
||||||
|
2. **Ignore activation files** in .gitignore
|
||||||
|
3. **Document activation methods** clearly
|
||||||
|
4. **Provide examples** for common use cases
|
||||||
|
5. **Maintain backward compatibility** when updating hooks
|
||||||
|
|
||||||
|
## Troubleshooting Guide
|
||||||
|
|
||||||
|
### **Common Issues**
|
||||||
|
|
||||||
|
#### **Hooks Running When Not Expected**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Check all activation methods
|
||||||
|
echo "Environment variable: $HUSKY_ENABLED"
|
||||||
|
echo "Local file exists: $([ -f .husky-enabled ] && echo "yes" || echo "no")"
|
||||||
|
echo "Global config: $(git config --global --get husky.enabled)"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Hooks Not Running When Expected**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Verify hook files exist and are executable
|
||||||
|
ls -la .husky/
|
||||||
|
chmod +x .husky/pre-commit
|
||||||
|
chmod +x .husky/commit-msg
|
||||||
|
```
|
||||||
|
|
||||||
|
#### **Permission Denied Errors**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Fix file permissions
|
||||||
|
chmod +x .husky/_/husky.sh
|
||||||
|
chmod +x .husky/pre-commit
|
||||||
|
chmod +x .husky/commit-msg
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Debug Mode**
|
||||||
|
|
||||||
|
Enable debug output to troubleshoot hook issues:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export HUSKY_DEBUG=1
|
||||||
|
export HUSKY_ENABLED=1
|
||||||
|
git commit -m "test: debug commit"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Future Enhancements
|
||||||
|
|
||||||
|
### **Planned Improvements**
|
||||||
|
|
||||||
|
1. **Hook Configuration File**: YAML/JSON configuration for hook behavior
|
||||||
|
2. **Selective Hook Activation**: Enable/disable specific hooks individually
|
||||||
|
3. **Hook Performance Metrics**: Track execution time and success rates
|
||||||
|
4. **Integration with IDEs**: IDE-specific activation methods
|
||||||
|
5. **Remote Configuration**: Team-wide hook settings via configuration
|
||||||
|
|
||||||
|
### **Extension Points**
|
||||||
|
|
||||||
|
1. **Custom Hook Scripts**: Easy addition of project-specific hooks
|
||||||
|
2. **Hook Templates**: Reusable hook patterns for common tasks
|
||||||
|
3. **Conditional Logic**: Complex activation rules based on context
|
||||||
|
4. **Notification System**: Hook status reporting and alerts
|
||||||
|
5. **Analytics**: Hook usage and effectiveness tracking
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
The conditional Husky activation system provides an elegant solution to the
|
||||||
|
challenges of git hook management in team environments. By committing
|
||||||
|
standardized hooks while making activation optional, it balances consistency
|
||||||
|
with flexibility, enabling teams to maintain coding standards without forcing compliance.
|
||||||
|
|
||||||
|
This approach supports gradual adoption, respects individual preferences, and
|
||||||
|
provides a solid foundation for git hook practices that can evolve with team needs
|
||||||
|
and project requirements.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Related Documents**:
|
||||||
|
|
||||||
|
- [Git Hooks Best Practices](./git-hooks-best-practices.md)
|
||||||
|
- [Code Quality Standards](./code-quality-standards.md)
|
||||||
|
- [Development Workflow](./development-workflow.md)
|
||||||
|
|
||||||
|
**Maintainer**: Development Team
|
||||||
|
**Review Schedule**: Quarterly
|
||||||
|
**Next Review**: 2025-11-21
|
||||||
@@ -25,6 +25,7 @@
|
|||||||
## Why This Happens
|
## Why This Happens
|
||||||
|
|
||||||
In development mode, we enable SharedArrayBuffer for fast SQLite operations, which requires:
|
In development mode, we enable SharedArrayBuffer for fast SQLite operations, which requires:
|
||||||
|
|
||||||
- `Cross-Origin-Opener-Policy: same-origin`
|
- `Cross-Origin-Opener-Policy: same-origin`
|
||||||
- `Cross-Origin-Embedder-Policy: require-corp`
|
- `Cross-Origin-Embedder-Policy: require-corp`
|
||||||
|
|
||||||
@@ -35,6 +36,7 @@ These headers create a **cross-origin isolated environment** that blocks resourc
|
|||||||
### 1. Use Supported Image Hosting Services
|
### 1. Use Supported Image Hosting Services
|
||||||
|
|
||||||
**Recommended services that work well:**
|
**Recommended services that work well:**
|
||||||
|
|
||||||
- **Imgur**: Free, no registration required, direct links
|
- **Imgur**: Free, no registration required, direct links
|
||||||
- **GitHub**: If you have images in repositories
|
- **GitHub**: If you have images in repositories
|
||||||
- **Unsplash**: For stock photos
|
- **Unsplash**: For stock photos
|
||||||
@@ -45,6 +47,7 @@ These headers create a **cross-origin isolated environment** that blocks resourc
|
|||||||
If you frequently use images from a specific domain, add a proxy:
|
If you frequently use images from a specific domain, add a proxy:
|
||||||
|
|
||||||
#### Step 1: Add Proxy to `vite.config.common.mts`
|
#### Step 1: Add Proxy to `vite.config.common.mts`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
'/yourservice-proxy': {
|
'/yourservice-proxy': {
|
||||||
target: 'https://yourservice.com',
|
target: 'https://yourservice.com',
|
||||||
@@ -63,6 +66,7 @@ If you frequently use images from a specific domain, add a proxy:
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Step 2: Update Transform Function in `src/libs/util.ts`
|
#### Step 2: Update Transform Function in `src/libs/util.ts`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Transform YourService URLs to use proxy
|
// Transform YourService URLs to use proxy
|
||||||
if (imageUrl.startsWith("https://yourservice.com/")) {
|
if (imageUrl.startsWith("https://yourservice.com/")) {
|
||||||
@@ -74,6 +78,7 @@ if (imageUrl.startsWith("https://yourservice.com/")) {
|
|||||||
### 3. Use Alternative Image Sources
|
### 3. Use Alternative Image Sources
|
||||||
|
|
||||||
For frequently failing domains, consider:
|
For frequently failing domains, consider:
|
||||||
|
|
||||||
- Upload images to Imgur or GitHub
|
- Upload images to Imgur or GitHub
|
||||||
- Use a CDN with proper CORS headers
|
- Use a CDN with proper CORS headers
|
||||||
- Host images on your own domain with CORS enabled
|
- Host images on your own domain with CORS enabled
|
||||||
@@ -81,11 +86,13 @@ For frequently failing domains, consider:
|
|||||||
## Development vs Production
|
## Development vs Production
|
||||||
|
|
||||||
### Development Mode
|
### Development Mode
|
||||||
|
|
||||||
- Images from supported services work through proxies
|
- Images from supported services work through proxies
|
||||||
- Unsupported images may fail to load
|
- Unsupported images may fail to load
|
||||||
- Console warnings show which images have issues
|
- Console warnings show which images have issues
|
||||||
|
|
||||||
### Production Mode
|
### Production Mode
|
||||||
|
|
||||||
- All images load directly without proxies
|
- All images load directly without proxies
|
||||||
- No CORS restrictions in production
|
- No CORS restrictions in production
|
||||||
- Better performance without proxy overhead
|
- Better performance without proxy overhead
|
||||||
@@ -93,6 +100,7 @@ For frequently failing domains, consider:
|
|||||||
## Testing Image Sources
|
## Testing Image Sources
|
||||||
|
|
||||||
### Check if an Image Source Works
|
### Check if an Image Source Works
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Test in browser console:
|
# Test in browser console:
|
||||||
fetch('https://example.com/image.jpg', { mode: 'cors' })
|
fetch('https://example.com/image.jpg', { mode: 'cors' })
|
||||||
@@ -101,6 +109,7 @@ fetch('https://example.com/image.jpg', { mode: 'cors' })
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Visual Testing
|
### Visual Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { createTestImageElements } from './libs/test-cors-images';
|
import { createTestImageElements } from './libs/test-cors-images';
|
||||||
createTestImageElements(); // Creates visual test panel
|
createTestImageElements(); // Creates visual test panel
|
||||||
@@ -109,30 +118,36 @@ createTestImageElements(); // Creates visual test panel
|
|||||||
## Common Error Messages
|
## Common Error Messages
|
||||||
|
|
||||||
### `ERR_BLOCKED_BY_RESPONSE.NotSameOriginAfterDefaultedToSameOriginByCoep`
|
### `ERR_BLOCKED_BY_RESPONSE.NotSameOriginAfterDefaultedToSameOriginByCoep`
|
||||||
|
|
||||||
**Cause**: Image source doesn't send required CORS headers
|
**Cause**: Image source doesn't send required CORS headers
|
||||||
**Solution**: Use a supported image hosting service or add a proxy
|
**Solution**: Use a supported image hosting service or add a proxy
|
||||||
|
|
||||||
### `ERR_NETWORK` or `ERR_INTERNET_DISCONNECTED`
|
### `ERR_NETWORK` or `ERR_INTERNET_DISCONNECTED`
|
||||||
|
|
||||||
**Cause**: Proxy service is unavailable
|
**Cause**: Proxy service is unavailable
|
||||||
**Solution**: Check internet connection or use alternative image source
|
**Solution**: Check internet connection or use alternative image source
|
||||||
|
|
||||||
### Images Load in Production but Not Development
|
### Images Load in Production but Not Development
|
||||||
|
|
||||||
**Cause**: Normal behavior - development has stricter CORS requirements
|
**Cause**: Normal behavior - development has stricter CORS requirements
|
||||||
**Solution**: Use supported image sources for development testing
|
**Solution**: Use supported image sources for development testing
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
### For New Projects
|
### For New Projects
|
||||||
|
|
||||||
1. Use supported image hosting services from the start
|
1. Use supported image hosting services from the start
|
||||||
2. Upload user images to Imgur or similar service
|
2. Upload user images to Imgur or similar service
|
||||||
3. Host critical images on your own domain with CORS enabled
|
3. Host critical images on your own domain with CORS enabled
|
||||||
|
|
||||||
### For Existing Projects
|
### For Existing Projects
|
||||||
|
|
||||||
1. Identify frequently used image domains in console warnings
|
1. Identify frequently used image domains in console warnings
|
||||||
2. Add proxies for the most common domains
|
2. Add proxies for the most common domains
|
||||||
3. Gradually migrate to supported image hosting services
|
3. Gradually migrate to supported image hosting services
|
||||||
|
|
||||||
### For User-Generated Content
|
### For User-Generated Content
|
||||||
|
|
||||||
1. Provide upload functionality to supported services
|
1. Provide upload functionality to supported services
|
||||||
2. Validate image URLs against supported domains
|
2. Validate image URLs against supported domains
|
||||||
3. Show helpful error messages for unsupported sources
|
3. Show helpful error messages for unsupported sources
|
||||||
@@ -140,17 +155,20 @@ createTestImageElements(); // Creates visual test panel
|
|||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### Image Not Loading?
|
### Image Not Loading?
|
||||||
|
|
||||||
1. Check browser console for error messages
|
1. Check browser console for error messages
|
||||||
2. Verify the domain is in the supported list
|
2. Verify the domain is in the supported list
|
||||||
3. Test if the image loads in production mode
|
3. Test if the image loads in production mode
|
||||||
4. Consider adding a proxy for that domain
|
4. Consider adding a proxy for that domain
|
||||||
|
|
||||||
### Proxy Not Working?
|
### Proxy Not Working?
|
||||||
|
|
||||||
1. Check if the target service allows proxying
|
1. Check if the target service allows proxying
|
||||||
2. Verify CORS headers are being set correctly
|
2. Verify CORS headers are being set correctly
|
||||||
3. Test with a simpler image URL from the same domain
|
3. Test with a simpler image URL from the same domain
|
||||||
|
|
||||||
### Performance Issues?
|
### Performance Issues?
|
||||||
|
|
||||||
1. Proxies add latency in development only
|
1. Proxies add latency in development only
|
||||||
2. Production uses direct image loading
|
2. Production uses direct image loading
|
||||||
3. Consider using a local image cache for development
|
3. Consider using a local image cache for development
|
||||||
@@ -158,6 +176,7 @@ createTestImageElements(); // Creates visual test panel
|
|||||||
## Quick Fixes
|
## Quick Fixes
|
||||||
|
|
||||||
### For Immediate Issues
|
### For Immediate Issues
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Temporary fallback: disable CORS headers for testing
|
// Temporary fallback: disable CORS headers for testing
|
||||||
// In vite.config.common.mts, comment out:
|
// In vite.config.common.mts, comment out:
|
||||||
@@ -166,9 +185,11 @@ createTestImageElements(); // Creates visual test panel
|
|||||||
// 'Cross-Origin-Embedder-Policy': 'require-corp'
|
// 'Cross-Origin-Embedder-Policy': 'require-corp'
|
||||||
// },
|
// },
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: This disables SharedArrayBuffer performance benefits.
|
**Note**: This disables SharedArrayBuffer performance benefits.
|
||||||
|
|
||||||
### For Long-term Solution
|
### For Long-term Solution
|
||||||
|
|
||||||
- Use supported image hosting services
|
- Use supported image hosting services
|
||||||
- Add proxies for frequently used domains
|
- Add proxies for frequently used domains
|
||||||
- Migrate critical images to your own CORS-enabled CDN
|
- Migrate critical images to your own CORS-enabled CDN
|
||||||
@@ -177,4 +198,4 @@ createTestImageElements(); // Creates visual test panel
|
|||||||
|
|
||||||
The cross-origin isolated environment is necessary for SharedArrayBuffer performance but requires careful image source management. Use the supported services, add proxies for common domains, and accept that some external images may not work in development mode.
|
The cross-origin isolated environment is necessary for SharedArrayBuffer performance but requires careful image source management. Use the supported services, add proxies for common domains, and accept that some external images may not work in development mode.
|
||||||
|
|
||||||
This is a development-only limitation - production deployments work with any image source.
|
This is a development-only limitation - production deployments work with any image source.
|
||||||
|
|||||||
@@ -101,6 +101,7 @@ Database logging continues to work regardless of console log level settings. All
|
|||||||
### No Logs Appearing
|
### No Logs Appearing
|
||||||
|
|
||||||
Check your `VITE_LOG_LEVEL` setting:
|
Check your `VITE_LOG_LEVEL` setting:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
echo $VITE_LOG_LEVEL
|
echo $VITE_LOG_LEVEL
|
||||||
```
|
```
|
||||||
@@ -108,6 +109,7 @@ echo $VITE_LOG_LEVEL
|
|||||||
### Too Many Logs
|
### Too Many Logs
|
||||||
|
|
||||||
Reduce verbosity by setting a lower log level:
|
Reduce verbosity by setting a lower log level:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
VITE_LOG_LEVEL=warn
|
VITE_LOG_LEVEL=warn
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ This document defines the **migration fence** - the boundary between the legacy
|
|||||||
## Current Migration Status
|
## Current Migration Status
|
||||||
|
|
||||||
### ✅ Completed Components
|
### ✅ Completed Components
|
||||||
|
|
||||||
- **SQLite Database Service**: Fully implemented with absurd-sql
|
- **SQLite Database Service**: Fully implemented with absurd-sql
|
||||||
- **Platform Service Layer**: Unified database interface across platforms
|
- **Platform Service Layer**: Unified database interface across platforms
|
||||||
- **PlatformServiceMixin**: Centralized database access with caching and utilities
|
- **PlatformServiceMixin**: Centralized database access with caching and utilities
|
||||||
@@ -17,12 +18,14 @@ This document defines the **migration fence** - the boundary between the legacy
|
|||||||
- **Data Export/Import**: Backup and restore functionality
|
- **Data Export/Import**: Backup and restore functionality
|
||||||
|
|
||||||
### 🔄 Active Migration Components
|
### 🔄 Active Migration Components
|
||||||
|
|
||||||
- **Settings Migration**: Core user settings transferred
|
- **Settings Migration**: Core user settings transferred
|
||||||
- **Account Migration**: Identity and key management
|
- **Account Migration**: Identity and key management
|
||||||
- **Contact Migration**: User contact data (via import interface)
|
- **Contact Migration**: User contact data (via import interface)
|
||||||
- **DatabaseUtil Migration**: Moving functions to PlatformServiceMixin
|
- **DatabaseUtil Migration**: Moving functions to PlatformServiceMixin
|
||||||
|
|
||||||
### ❌ Legacy Components (Fence Boundary)
|
### ❌ Legacy Components (Fence Boundary)
|
||||||
|
|
||||||
- **Dexie Database**: Legacy IndexedDB storage (disabled by default)
|
- **Dexie Database**: Legacy IndexedDB storage (disabled by default)
|
||||||
- **Dexie-Specific Code**: Direct database access patterns
|
- **Dexie-Specific Code**: Direct database access patterns
|
||||||
- **Legacy Migration Paths**: Old data transfer methods
|
- **Legacy Migration Paths**: Old data transfer methods
|
||||||
@@ -45,6 +48,7 @@ export const PlatformServiceMixin = {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Fence Rule**: All database operations must use:
|
**Fence Rule**: All database operations must use:
|
||||||
|
|
||||||
- `this.$db()` for read operations
|
- `this.$db()` for read operations
|
||||||
- `this.$exec()` for write operations
|
- `this.$exec()` for write operations
|
||||||
- `this.$settings()` for settings access
|
- `this.$settings()` for settings access
|
||||||
@@ -64,6 +68,7 @@ export class PlatformServiceFactory {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Fence Rule**: All database operations must use:
|
**Fence Rule**: All database operations must use:
|
||||||
|
|
||||||
- `PlatformService.dbQuery()` for read operations
|
- `PlatformService.dbQuery()` for read operations
|
||||||
- `PlatformService.dbExec()` for write operations
|
- `PlatformService.dbExec()` for write operations
|
||||||
- No direct `db.` or `accountsDBPromise` access in application code
|
- No direct `db.` or `accountsDBPromise` access in application code
|
||||||
@@ -71,6 +76,7 @@ export class PlatformServiceFactory {
|
|||||||
### 3. Data Access Patterns
|
### 3. Data Access Patterns
|
||||||
|
|
||||||
#### ✅ Allowed (Inside Fence)
|
#### ✅ Allowed (Inside Fence)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Use PlatformServiceMixin for all database operations
|
// Use PlatformServiceMixin for all database operations
|
||||||
const contacts = await this.$contacts();
|
const contacts = await this.$contacts();
|
||||||
@@ -79,6 +85,7 @@ const result = await this.$db("SELECT * FROM contacts WHERE did = ?", [accountDi
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### ❌ Forbidden (Outside Fence)
|
#### ❌ Forbidden (Outside Fence)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Direct Dexie access (legacy pattern)
|
// Direct Dexie access (legacy pattern)
|
||||||
const contacts = await db.contacts.where('did').equals(accountDid).toArray();
|
const contacts = await db.contacts.where('did').equals(accountDid).toArray();
|
||||||
@@ -98,6 +105,7 @@ export async function compareDatabases(): Promise<DataComparison> {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Fence Rule**: Migration tools are the exclusive interface between:
|
**Fence Rule**: Migration tools are the exclusive interface between:
|
||||||
|
|
||||||
- Legacy Dexie database
|
- Legacy Dexie database
|
||||||
- New SQLite database
|
- New SQLite database
|
||||||
- Data comparison and transfer operations
|
- Data comparison and transfer operations
|
||||||
@@ -107,11 +115,13 @@ export async function compareDatabases(): Promise<DataComparison> {
|
|||||||
### 1. Code Development Rules
|
### 1. Code Development Rules
|
||||||
|
|
||||||
#### New Feature Development
|
#### New Feature Development
|
||||||
|
|
||||||
- **Always** use `PlatformServiceMixin` for database operations
|
- **Always** use `PlatformServiceMixin` for database operations
|
||||||
- **Never** import or reference Dexie directly
|
- **Never** import or reference Dexie directly
|
||||||
- **Always** use mixin methods like `this.$settings()`, `this.$contacts()`
|
- **Always** use mixin methods like `this.$settings()`, `this.$contacts()`
|
||||||
|
|
||||||
#### Legacy Code Maintenance
|
#### Legacy Code Maintenance
|
||||||
|
|
||||||
- **Only** modify Dexie code for migration purposes
|
- **Only** modify Dexie code for migration purposes
|
||||||
- **Always** add migration tests for schema changes
|
- **Always** add migration tests for schema changes
|
||||||
- **Never** add new Dexie-specific features
|
- **Never** add new Dexie-specific features
|
||||||
@@ -119,11 +129,13 @@ export async function compareDatabases(): Promise<DataComparison> {
|
|||||||
### 2. Data Integrity Rules
|
### 2. Data Integrity Rules
|
||||||
|
|
||||||
#### Migration Safety
|
#### Migration Safety
|
||||||
|
|
||||||
- **Always** create backups before migration
|
- **Always** create backups before migration
|
||||||
- **Always** verify data integrity after migration
|
- **Always** verify data integrity after migration
|
||||||
- **Never** delete legacy data until verified
|
- **Never** delete legacy data until verified
|
||||||
|
|
||||||
#### Rollback Strategy
|
#### Rollback Strategy
|
||||||
|
|
||||||
- **Always** maintain ability to rollback to Dexie
|
- **Always** maintain ability to rollback to Dexie
|
||||||
- **Always** preserve migration logs
|
- **Always** preserve migration logs
|
||||||
- **Never** assume migration is irreversible
|
- **Never** assume migration is irreversible
|
||||||
@@ -131,6 +143,7 @@ export async function compareDatabases(): Promise<DataComparison> {
|
|||||||
### 3. Testing Requirements
|
### 3. Testing Requirements
|
||||||
|
|
||||||
#### Migration Testing
|
#### Migration Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Required test pattern for migration
|
// Required test pattern for migration
|
||||||
describe('Database Migration', () => {
|
describe('Database Migration', () => {
|
||||||
@@ -144,6 +157,7 @@ describe('Database Migration', () => {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Application Testing
|
#### Application Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Required test pattern for application features
|
// Required test pattern for application features
|
||||||
describe('Feature with Database', () => {
|
describe('Feature with Database', () => {
|
||||||
@@ -159,6 +173,7 @@ describe('Feature with Database', () => {
|
|||||||
### 1. Static Analysis
|
### 1. Static Analysis
|
||||||
|
|
||||||
#### ESLint Rules
|
#### ESLint Rules
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"rules": {
|
"rules": {
|
||||||
@@ -178,6 +193,7 @@ describe('Feature with Database', () => {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### TypeScript Rules
|
#### TypeScript Rules
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
@@ -190,6 +206,7 @@ describe('Feature with Database', () => {
|
|||||||
### 2. Runtime Checks
|
### 2. Runtime Checks
|
||||||
|
|
||||||
#### Development Mode Validation
|
#### Development Mode Validation
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Development-only fence validation
|
// Development-only fence validation
|
||||||
if (import.meta.env.DEV) {
|
if (import.meta.env.DEV) {
|
||||||
@@ -198,6 +215,7 @@ if (import.meta.env.DEV) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Production Safety
|
#### Production Safety
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Production fence enforcement
|
// Production fence enforcement
|
||||||
if (import.meta.env.PROD) {
|
if (import.meta.env.PROD) {
|
||||||
@@ -209,6 +227,7 @@ if (import.meta.env.PROD) {
|
|||||||
## Migration Status Checklist
|
## Migration Status Checklist
|
||||||
|
|
||||||
### ✅ Completed
|
### ✅ Completed
|
||||||
|
|
||||||
- [x] PlatformServiceMixin implementation
|
- [x] PlatformServiceMixin implementation
|
||||||
- [x] SQLite database service
|
- [x] SQLite database service
|
||||||
- [x] Migration tools
|
- [x] Migration tools
|
||||||
@@ -217,11 +236,13 @@ if (import.meta.env.PROD) {
|
|||||||
- [x] ActiveDid migration
|
- [x] ActiveDid migration
|
||||||
|
|
||||||
### 🔄 In Progress
|
### 🔄 In Progress
|
||||||
|
|
||||||
- [ ] Contact migration
|
- [ ] Contact migration
|
||||||
- [ ] DatabaseUtil to PlatformServiceMixin migration
|
- [ ] DatabaseUtil to PlatformServiceMixin migration
|
||||||
- [ ] File-by-file migration
|
- [ ] File-by-file migration
|
||||||
|
|
||||||
### ❌ Not Started
|
### ❌ Not Started
|
||||||
|
|
||||||
- [ ] Legacy Dexie removal
|
- [ ] Legacy Dexie removal
|
||||||
- [ ] Final cleanup and validation
|
- [ ] Final cleanup and validation
|
||||||
|
|
||||||
@@ -240,4 +261,4 @@ if (import.meta.env.PROD) {
|
|||||||
**Created**: 2025-07-05
|
**Created**: 2025-07-05
|
||||||
**Status**: Active Migration Phase
|
**Status**: Active Migration Phase
|
||||||
**Last Updated**: 2025-07-05
|
**Last Updated**: 2025-07-05
|
||||||
**Note**: Migration fence now implemented through PlatformServiceMixin instead of USE_DEXIE_DB constant
|
**Note**: Migration fence now implemented through PlatformServiceMixin instead of USE_DEXIE_DB constant
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
## Per-File Migration Workflow (MANDATORY)
|
## Per-File Migration Workflow (MANDATORY)
|
||||||
|
|
||||||
For each file migrated:
|
For each file migrated:
|
||||||
|
|
||||||
1. **First**, migrate to PlatformServiceMixin (replace all databaseUtil usage, etc.).
|
1. **First**, migrate to PlatformServiceMixin (replace all databaseUtil usage, etc.).
|
||||||
2. **Immediately after**, standardize notify helper usage (property + created() pattern) and fix any related linter/type errors.
|
2. **Immediately after**, standardize notify helper usage (property + created() pattern) and fix any related linter/type errors.
|
||||||
|
|
||||||
@@ -25,22 +26,26 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
## ✅ **DAY 1: PlatformServiceMixin Completion (COMPLETE)**
|
## ✅ **DAY 1: PlatformServiceMixin Completion (COMPLETE)**
|
||||||
|
|
||||||
### **Phase 1: Remove Circular Dependency (COMPLETE)**
|
### **Phase 1: Remove Circular Dependency (COMPLETE)**
|
||||||
|
|
||||||
**Status**: ✅ **COMPLETE**
|
**Status**: ✅ **COMPLETE**
|
||||||
**Issue**: PlatformServiceMixin imports `memoryLogs` from databaseUtil
|
**Issue**: PlatformServiceMixin imports `memoryLogs` from databaseUtil
|
||||||
**Solution**: Create self-contained memoryLogs implementation
|
**Solution**: Create self-contained memoryLogs implementation
|
||||||
|
|
||||||
#### **Tasks**:
|
#### **Tasks**
|
||||||
|
|
||||||
- [x] **Step 1.1**: Remove `memoryLogs` import from PlatformServiceMixin.ts ✅
|
- [x] **Step 1.1**: Remove `memoryLogs` import from PlatformServiceMixin.ts ✅
|
||||||
- [x] **Step 1.2**: Add self-contained `_memoryLogs` array to PlatformServiceMixin ✅
|
- [x] **Step 1.2**: Add self-contained `_memoryLogs` array to PlatformServiceMixin ✅
|
||||||
- [x] **Step 1.3**: Add `$appendToMemoryLogs()` method to PlatformServiceMixin ✅
|
- [x] **Step 1.3**: Add `$appendToMemoryLogs()` method to PlatformServiceMixin ✅
|
||||||
- [x] **Step 1.4**: Update logger.ts to use self-contained memoryLogs ✅
|
- [x] **Step 1.4**: Update logger.ts to use self-contained memoryLogs ✅
|
||||||
- [x] **Step 1.5**: Test memoryLogs functionality ✅
|
- [x] **Step 1.5**: Test memoryLogs functionality ✅
|
||||||
|
|
||||||
#### **Files Modified**:
|
#### **Files Modified**
|
||||||
|
|
||||||
- `src/utils/PlatformServiceMixin.ts` ✅
|
- `src/utils/PlatformServiceMixin.ts` ✅
|
||||||
- `src/utils/logger.ts` ✅
|
- `src/utils/logger.ts` ✅
|
||||||
|
|
||||||
#### **Validation**:
|
#### **Validation**
|
||||||
|
|
||||||
- [x] No circular dependency errors ✅
|
- [x] No circular dependency errors ✅
|
||||||
- [x] memoryLogs functionality works correctly ✅
|
- [x] memoryLogs functionality works correctly ✅
|
||||||
- [x] Linting passes ✅
|
- [x] Linting passes ✅
|
||||||
@@ -48,20 +53,24 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
---
|
---
|
||||||
|
|
||||||
### **Phase 2: Add Missing Utility Functions (COMPLETE)**
|
### **Phase 2: Add Missing Utility Functions (COMPLETE)**
|
||||||
|
|
||||||
**Status**: ✅ **COMPLETE**
|
**Status**: ✅ **COMPLETE**
|
||||||
**Missing Functions**: `generateInsertStatement`, `generateUpdateStatement`
|
**Missing Functions**: `generateInsertStatement`, `generateUpdateStatement`
|
||||||
|
|
||||||
#### **Tasks**:
|
#### **Tasks**
|
||||||
|
|
||||||
- [x] **Step 2.1**: Add `_generateInsertStatement()` private method to PlatformServiceMixin ✅
|
- [x] **Step 2.1**: Add `_generateInsertStatement()` private method to PlatformServiceMixin ✅
|
||||||
- [x] **Step 2.2**: Add `_generateUpdateStatement()` private method to PlatformServiceMixin ✅
|
- [x] **Step 2.2**: Add `_generateUpdateStatement()` private method to PlatformServiceMixin ✅
|
||||||
- [x] **Step 2.3**: Add `$generateInsertStatement()` public wrapper method ✅
|
- [x] **Step 2.3**: Add `$generateInsertStatement()` public wrapper method ✅
|
||||||
- [x] **Step 2.4**: Add `$generateUpdateStatement()` public wrapper method ✅
|
- [x] **Step 2.4**: Add `$generateUpdateStatement()` public wrapper method ✅
|
||||||
- [x] **Step 2.5**: Test both utility functions ✅
|
- [x] **Step 2.5**: Test both utility functions ✅
|
||||||
|
|
||||||
#### **Files Modified**:
|
#### **Files Modified**
|
||||||
|
|
||||||
- `src/utils/PlatformServiceMixin.ts` ✅
|
- `src/utils/PlatformServiceMixin.ts` ✅
|
||||||
|
|
||||||
#### **Validation**:
|
#### **Validation**
|
||||||
|
|
||||||
- [x] Both functions generate correct SQL ✅
|
- [x] Both functions generate correct SQL ✅
|
||||||
- [x] Parameter handling works correctly ✅
|
- [x] Parameter handling works correctly ✅
|
||||||
- [x] Type safety maintained ✅
|
- [x] Type safety maintained ✅
|
||||||
@@ -69,18 +78,22 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
---
|
---
|
||||||
|
|
||||||
### **Phase 3: Update Type Definitions (COMPLETE)**
|
### **Phase 3: Update Type Definitions (COMPLETE)**
|
||||||
|
|
||||||
**Status**: ✅ **COMPLETE**
|
**Status**: ✅ **COMPLETE**
|
||||||
**Goal**: Add new methods to TypeScript interfaces
|
**Goal**: Add new methods to TypeScript interfaces
|
||||||
|
|
||||||
#### **Tasks**:
|
#### **Tasks**
|
||||||
|
|
||||||
- [x] **Step 3.1**: Add new methods to `IPlatformServiceMixin` interface ✅
|
- [x] **Step 3.1**: Add new methods to `IPlatformServiceMixin` interface ✅
|
||||||
- [x] **Step 3.2**: Add new methods to `ComponentCustomProperties` interface ✅
|
- [x] **Step 3.2**: Add new methods to `ComponentCustomProperties` interface ✅
|
||||||
- [x] **Step 3.3**: Verify TypeScript compilation ✅
|
- [x] **Step 3.3**: Verify TypeScript compilation ✅
|
||||||
|
|
||||||
#### **Files Modified**:
|
#### **Files Modified**
|
||||||
|
|
||||||
- `src/utils/PlatformServiceMixin.ts` (interface definitions) ✅
|
- `src/utils/PlatformServiceMixin.ts` (interface definitions) ✅
|
||||||
|
|
||||||
#### **Validation**:
|
#### **Validation**
|
||||||
|
|
||||||
- [x] TypeScript compilation passes ✅
|
- [x] TypeScript compilation passes ✅
|
||||||
- [x] All new methods properly typed ✅
|
- [x] All new methods properly typed ✅
|
||||||
- [x] No type errors in existing code ✅
|
- [x] No type errors in existing code ✅
|
||||||
@@ -88,17 +101,20 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
---
|
---
|
||||||
|
|
||||||
### **Phase 4: Testing & Validation (COMPLETE)**
|
### **Phase 4: Testing & Validation (COMPLETE)**
|
||||||
|
|
||||||
**Status**: ✅ **COMPLETE**
|
**Status**: ✅ **COMPLETE**
|
||||||
**Goal**: Ensure PlatformServiceMixin is fully functional
|
**Goal**: Ensure PlatformServiceMixin is fully functional
|
||||||
|
|
||||||
#### **Tasks**:
|
#### **Tasks**
|
||||||
|
|
||||||
- [x] **Step 4.1**: Create test component to verify all methods ✅
|
- [x] **Step 4.1**: Create test component to verify all methods ✅
|
||||||
- [x] **Step 4.2**: Run comprehensive linting ✅
|
- [x] **Step 4.2**: Run comprehensive linting ✅
|
||||||
- [x] **Step 4.3**: Run TypeScript type checking ✅
|
- [x] **Step 4.3**: Run TypeScript type checking ✅
|
||||||
- [x] **Step 4.4**: Test caching functionality ✅
|
- [x] **Step 4.4**: Test caching functionality ✅
|
||||||
- [x] **Step 4.5**: Test database operations ✅
|
- [x] **Step 4.5**: Test database operations ✅
|
||||||
|
|
||||||
#### **Validation**:
|
#### **Validation**
|
||||||
|
|
||||||
- [x] All tests pass ✅
|
- [x] All tests pass ✅
|
||||||
- [x] No linting errors ✅
|
- [x] No linting errors ✅
|
||||||
- [x] No TypeScript errors ✅
|
- [x] No TypeScript errors ✅
|
||||||
@@ -108,10 +124,12 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
---
|
---
|
||||||
|
|
||||||
### **Phase 5: Utility Files Migration (COMPLETE)**
|
### **Phase 5: Utility Files Migration (COMPLETE)**
|
||||||
|
|
||||||
**Status**: ✅ **COMPLETE**
|
**Status**: ✅ **COMPLETE**
|
||||||
**Goal**: Remove all remaining databaseUtil imports from utility files
|
**Goal**: Remove all remaining databaseUtil imports from utility files
|
||||||
|
|
||||||
#### **Tasks**:
|
#### **Tasks**
|
||||||
|
|
||||||
- [x] **Step 5.1**: Migrate `src/services/deepLinks.ts` ✅
|
- [x] **Step 5.1**: Migrate `src/services/deepLinks.ts` ✅
|
||||||
- Replaced `logConsoleAndDb` with `console.error`
|
- Replaced `logConsoleAndDb` with `console.error`
|
||||||
- Removed databaseUtil import
|
- Removed databaseUtil import
|
||||||
@@ -121,7 +139,8 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
- Updated all async calls to use proper async pattern
|
- Updated all async calls to use proper async pattern
|
||||||
- [x] **Step 5.3**: Verify no remaining databaseUtil imports ✅
|
- [x] **Step 5.3**: Verify no remaining databaseUtil imports ✅
|
||||||
|
|
||||||
#### **Validation**:
|
#### **Validation**
|
||||||
|
|
||||||
- [x] No databaseUtil imports in any TypeScript files ✅
|
- [x] No databaseUtil imports in any TypeScript files ✅
|
||||||
- [x] No databaseUtil imports in any Vue files ✅
|
- [x] No databaseUtil imports in any Vue files ✅
|
||||||
- [x] All functions work correctly ✅
|
- [x] All functions work correctly ✅
|
||||||
@@ -131,13 +150,16 @@ This document tracks the progress of the 2-day sprint to complete PlatformServic
|
|||||||
## 🎯 **DAY 2: Migrate All 52 Files (READY TO START)**
|
## 🎯 **DAY 2: Migrate All 52 Files (READY TO START)**
|
||||||
|
|
||||||
### **Migration Strategy**
|
### **Migration Strategy**
|
||||||
|
|
||||||
**Priority Order**:
|
**Priority Order**:
|
||||||
|
|
||||||
1. **Views** (25 files) - User-facing components
|
1. **Views** (25 files) - User-facing components
|
||||||
2. **Components** (15 files) - Reusable UI components
|
2. **Components** (15 files) - Reusable UI components
|
||||||
3. **Services** (8 files) - Business logic
|
3. **Services** (8 files) - Business logic
|
||||||
4. **Utils** (4 files) - Utility functions
|
4. **Utils** (4 files) - Utility functions
|
||||||
|
|
||||||
### **Migration Pattern for Each File**
|
### **Migration Pattern for Each File**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// 1. Add PlatformServiceMixin
|
// 1. Add PlatformServiceMixin
|
||||||
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||||
@@ -155,6 +177,7 @@ export default class ComponentName extends Vue {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### **Common Replacements**
|
### **Common Replacements**
|
||||||
|
|
||||||
- `generateInsertStatement` → `this.$generateInsertStatement`
|
- `generateInsertStatement` → `this.$generateInsertStatement`
|
||||||
- `generateUpdateStatement` → `this.$generateUpdateStatement`
|
- `generateUpdateStatement` → `this.$generateUpdateStatement`
|
||||||
- `parseJsonField` → `this._parseJsonField`
|
- `parseJsonField` → `this._parseJsonField`
|
||||||
@@ -168,6 +191,7 @@ export default class ComponentName extends Vue {
|
|||||||
## 📋 **File Migration Checklist**
|
## 📋 **File Migration Checklist**
|
||||||
|
|
||||||
### **Views (25 files) - Priority 1**
|
### **Views (25 files) - Priority 1**
|
||||||
|
|
||||||
**Progress**: 6/25 (24%)
|
**Progress**: 6/25 (24%)
|
||||||
|
|
||||||
- [ ] QuickActionBvcEndView.vue
|
- [ ] QuickActionBvcEndView.vue
|
||||||
@@ -209,6 +233,7 @@ export default class ComponentName extends Vue {
|
|||||||
- [ ] UserProfileView.vue
|
- [ ] UserProfileView.vue
|
||||||
|
|
||||||
### **Components (15 files) - Priority 2**
|
### **Components (15 files) - Priority 2**
|
||||||
|
|
||||||
**Progress**: 9/15 (60%)
|
**Progress**: 9/15 (60%)
|
||||||
|
|
||||||
- [x] UserNameDialog.vue ✅ **MIGRATED**
|
- [x] UserNameDialog.vue ✅ **MIGRATED**
|
||||||
@@ -233,6 +258,7 @@ export default class ComponentName extends Vue {
|
|||||||
- [x] IconRenderer.vue ✅ MIGRATED & HUMAN TESTED 2024-12-19 (0 min, no migration needed - already compliant)
|
- [x] IconRenderer.vue ✅ MIGRATED & HUMAN TESTED 2024-12-19 (0 min, no migration needed - already compliant)
|
||||||
|
|
||||||
### **Services (8 files) - Priority 3**
|
### **Services (8 files) - Priority 3**
|
||||||
|
|
||||||
**Progress**: 2/8 (25%)
|
**Progress**: 2/8 (25%)
|
||||||
|
|
||||||
- [x] api.ts ✅ MIGRATED 2024-12-19 (0 min, no migration needed - already compliant)
|
- [x] api.ts ✅ MIGRATED 2024-12-19 (0 min, no migration needed - already compliant)
|
||||||
@@ -241,6 +267,7 @@ export default class ComponentName extends Vue {
|
|||||||
- [ ] deepLinks.ts
|
- [ ] deepLinks.ts
|
||||||
|
|
||||||
### **Utils (4 files) - Priority 4**
|
### **Utils (4 files) - Priority 4**
|
||||||
|
|
||||||
**Progress**: 1/4 (25%)
|
**Progress**: 1/4 (25%)
|
||||||
|
|
||||||
- [ ] LogCollector.ts
|
- [ ] LogCollector.ts
|
||||||
@@ -253,6 +280,7 @@ export default class ComponentName extends Vue {
|
|||||||
## 🛠️ **Migration Tools**
|
## 🛠️ **Migration Tools**
|
||||||
|
|
||||||
### **Migration Helper Script**
|
### **Migration Helper Script**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Track progress
|
# Track progress
|
||||||
./scripts/migration-helper.sh progress
|
./scripts/migration-helper.sh progress
|
||||||
@@ -277,6 +305,7 @@ export default class ComponentName extends Vue {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### **Validation Commands**
|
### **Validation Commands**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check for remaining databaseUtil imports
|
# Check for remaining databaseUtil imports
|
||||||
find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil"
|
find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil"
|
||||||
@@ -296,12 +325,14 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 📊 **Progress Tracking**
|
## 📊 **Progress Tracking**
|
||||||
|
|
||||||
### **Day 1 Progress**
|
### **Day 1 Progress**
|
||||||
|
|
||||||
- [ ] Phase 1: Circular dependency resolved
|
- [ ] Phase 1: Circular dependency resolved
|
||||||
- [ ] Phase 2: Utility functions added
|
- [ ] Phase 2: Utility functions added
|
||||||
- [ ] Phase 3: Type definitions updated
|
- [ ] Phase 3: Type definitions updated
|
||||||
- [ ] Phase 4: Testing completed
|
- [ ] Phase 4: Testing completed
|
||||||
|
|
||||||
### **Day 2 Progress**
|
### **Day 2 Progress**
|
||||||
|
|
||||||
- [ ] Views migrated (0/25)
|
- [ ] Views migrated (0/25)
|
||||||
- [ ] Components migrated (0/15)
|
- [ ] Components migrated (0/15)
|
||||||
- [ ] Services migrated (0/8)
|
- [ ] Services migrated (0/8)
|
||||||
@@ -309,6 +340,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
- [ ] Validation completed
|
- [ ] Validation completed
|
||||||
|
|
||||||
### **Overall Progress**
|
### **Overall Progress**
|
||||||
|
|
||||||
- **Total files to migrate**: 52
|
- **Total files to migrate**: 52
|
||||||
- **Files migrated**: 3
|
- **Files migrated**: 3
|
||||||
- **Progress**: 6%
|
- **Progress**: 6%
|
||||||
@@ -318,6 +350,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 🎯 **Success Criteria**
|
## 🎯 **Success Criteria**
|
||||||
|
|
||||||
### **Day 1 Success Criteria**
|
### **Day 1 Success Criteria**
|
||||||
|
|
||||||
- [ ] PlatformServiceMixin has no circular dependencies
|
- [ ] PlatformServiceMixin has no circular dependencies
|
||||||
- [ ] All utility functions implemented and tested
|
- [ ] All utility functions implemented and tested
|
||||||
- [ ] Type definitions complete and accurate
|
- [ ] Type definitions complete and accurate
|
||||||
@@ -325,6 +358,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
- [ ] TypeScript compilation passes
|
- [ ] TypeScript compilation passes
|
||||||
|
|
||||||
### **Day 2 Success Criteria**
|
### **Day 2 Success Criteria**
|
||||||
|
|
||||||
- [ ] 0 files importing databaseUtil
|
- [ ] 0 files importing databaseUtil
|
||||||
- [ ] All 52 files migrated to PlatformServiceMixin
|
- [ ] All 52 files migrated to PlatformServiceMixin
|
||||||
- [ ] No runtime errors in migrated components
|
- [ ] No runtime errors in migrated components
|
||||||
@@ -332,6 +366,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
- [ ] Performance maintained or improved
|
- [ ] Performance maintained or improved
|
||||||
|
|
||||||
### **Overall Success Criteria**
|
### **Overall Success Criteria**
|
||||||
|
|
||||||
- [ ] Complete elimination of databaseUtil dependency
|
- [ ] Complete elimination of databaseUtil dependency
|
||||||
- [ ] PlatformServiceMixin is the single source of truth for database operations
|
- [ ] PlatformServiceMixin is the single source of truth for database operations
|
||||||
- [ ] Migration fence is fully implemented
|
- [ ] Migration fence is fully implemented
|
||||||
@@ -354,14 +389,17 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 📝 **Notes & Issues**
|
## 📝 **Notes & Issues**
|
||||||
|
|
||||||
### **Current Issues**
|
### **Current Issues**
|
||||||
|
|
||||||
- None identified yet
|
- None identified yet
|
||||||
|
|
||||||
### **Decisions Made**
|
### **Decisions Made**
|
||||||
|
|
||||||
- PlatformServiceMixin approach chosen over USE_DEXIE_DB constant
|
- PlatformServiceMixin approach chosen over USE_DEXIE_DB constant
|
||||||
- Self-contained utility functions preferred over imports
|
- Self-contained utility functions preferred over imports
|
||||||
- Priority order: Views → Components → Services → Utils
|
- Priority order: Views → Components → Services → Utils
|
||||||
|
|
||||||
### **Lessons Learned**
|
### **Lessons Learned**
|
||||||
|
|
||||||
- To be filled as migration progresses
|
- To be filled as migration progresses
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -369,6 +407,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 🔄 **Daily Updates**
|
## 🔄 **Daily Updates**
|
||||||
|
|
||||||
### **Day 1 Updates**
|
### **Day 1 Updates**
|
||||||
|
|
||||||
- [ ] Start time: _____
|
- [ ] Start time: _____
|
||||||
- [ ] Phase 1 completion: _____
|
- [ ] Phase 1 completion: _____
|
||||||
- [ ] Phase 2 completion: _____
|
- [ ] Phase 2 completion: _____
|
||||||
@@ -377,6 +416,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
- [ ] End time: _____
|
- [ ] End time: _____
|
||||||
|
|
||||||
### **Day 2 Updates**
|
### **Day 2 Updates**
|
||||||
|
|
||||||
- [ ] Start time: _____
|
- [ ] Start time: _____
|
||||||
- [ ] Views migration completion: _____
|
- [ ] Views migration completion: _____
|
||||||
- [ ] Components migration completion: _____
|
- [ ] Components migration completion: _____
|
||||||
@@ -390,16 +430,19 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 🆘 **Contingency Plans**
|
## 🆘 **Contingency Plans**
|
||||||
|
|
||||||
### **If Day 1 Takes Longer**
|
### **If Day 1 Takes Longer**
|
||||||
|
|
||||||
- Focus on core functionality first
|
- Focus on core functionality first
|
||||||
- Defer advanced utility functions to Day 2
|
- Defer advanced utility functions to Day 2
|
||||||
- Prioritize circular dependency resolution
|
- Prioritize circular dependency resolution
|
||||||
|
|
||||||
### **If Day 2 Takes Longer**
|
### **If Day 2 Takes Longer**
|
||||||
|
|
||||||
- Focus on high-impact views first
|
- Focus on high-impact views first
|
||||||
- Batch similar components together
|
- Batch similar components together
|
||||||
- Use automated scripts for common patterns
|
- Use automated scripts for common patterns
|
||||||
|
|
||||||
### **If Issues Arise**
|
### **If Issues Arise**
|
||||||
|
|
||||||
- Document specific problems in Notes section
|
- Document specific problems in Notes section
|
||||||
- Create targeted fixes
|
- Create targeted fixes
|
||||||
- Maintain backward compatibility during transition
|
- Maintain backward compatibility during transition
|
||||||
@@ -421,4 +464,4 @@ These practices ensure maintainability, consistency, and type safety for all not
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: $(date)
|
**Last Updated**: $(date)
|
||||||
**Next Review**: After each phase completion
|
**Next Review**: After each phase completion
|
||||||
|
|||||||
@@ -63,6 +63,7 @@ export default class ComponentName extends Vue {
|
|||||||
## ✅ **Validation Checklist**
|
## ✅ **Validation Checklist**
|
||||||
|
|
||||||
After each file migration:
|
After each file migration:
|
||||||
|
|
||||||
- [ ] No databaseUtil imports
|
- [ ] No databaseUtil imports
|
||||||
- [ ] PlatformServiceMixin added
|
- [ ] PlatformServiceMixin added
|
||||||
- [ ] Method calls updated
|
- [ ] Method calls updated
|
||||||
@@ -91,4 +92,4 @@ npm run lint && npx tsc --noEmit
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: $(date)
|
**Last Updated**: $(date)
|
||||||
**Full Documentation**: `doc/migration-progress-tracker.md`
|
**Full Documentation**: `doc/migration-progress-tracker.md`
|
||||||
|
|||||||
@@ -11,11 +11,14 @@
|
|||||||
## 🎯 **Migration Overview**
|
## 🎯 **Migration Overview**
|
||||||
|
|
||||||
### **Goal**
|
### **Goal**
|
||||||
|
|
||||||
Complete the TimeSafari database migration from Dexie to SQLite by:
|
Complete the TimeSafari database migration from Dexie to SQLite by:
|
||||||
|
|
||||||
1. **Day 1**: Finish PlatformServiceMixin implementation (4-6 hours)
|
1. **Day 1**: Finish PlatformServiceMixin implementation (4-6 hours)
|
||||||
2. **Day 2**: Migrate all 52 files to PlatformServiceMixin (6-8 hours)
|
2. **Day 2**: Migrate all 52 files to PlatformServiceMixin (6-8 hours)
|
||||||
|
|
||||||
### **Current Status**
|
### **Current Status**
|
||||||
|
|
||||||
- ✅ **PlatformServiceMixin**: 95% complete (1,301 lines)
|
- ✅ **PlatformServiceMixin**: 95% complete (1,301 lines)
|
||||||
- ✅ **Migration Tools**: Ready and tested
|
- ✅ **Migration Tools**: Ready and tested
|
||||||
- ✅ **Documentation**: Complete and cross-machine accessible
|
- ✅ **Documentation**: Complete and cross-machine accessible
|
||||||
@@ -27,22 +30,30 @@ Complete the TimeSafari database migration from Dexie to SQLite by:
|
|||||||
## 📊 **File Breakdown**
|
## 📊 **File Breakdown**
|
||||||
|
|
||||||
### **Views (42 files) - Priority 1**
|
### **Views (42 files) - Priority 1**
|
||||||
|
|
||||||
User-facing components that need immediate attention:
|
User-facing components that need immediate attention:
|
||||||
|
|
||||||
- 25 files from original list
|
- 25 files from original list
|
||||||
- 17 additional files identified by migration helper
|
- 17 additional files identified by migration helper
|
||||||
|
|
||||||
### **Components (9 files) - Priority 2**
|
### **Components (9 files) - Priority 2**
|
||||||
|
|
||||||
Reusable UI components:
|
Reusable UI components:
|
||||||
|
|
||||||
- FeedFilters.vue, GiftedDialog.vue, GiftedPrompts.vue
|
- FeedFilters.vue, GiftedDialog.vue, GiftedPrompts.vue
|
||||||
- ImageMethodDialog.vue, OfferDialog.vue, OnboardingDialog.vue
|
- ImageMethodDialog.vue, OfferDialog.vue, OnboardingDialog.vue
|
||||||
- PhotoDialog.vue, PushNotificationPermission.vue, UserNameDialog.vue
|
- PhotoDialog.vue, PushNotificationPermission.vue, UserNameDialog.vue
|
||||||
|
|
||||||
### **Services (1 file) - Priority 3**
|
### **Services (1 file) - Priority 3**
|
||||||
|
|
||||||
Business logic:
|
Business logic:
|
||||||
|
|
||||||
- deepLinks.ts
|
- deepLinks.ts
|
||||||
|
|
||||||
### **Utils (3 files) - Priority 4**
|
### **Utils (3 files) - Priority 4**
|
||||||
|
|
||||||
Utility functions:
|
Utility functions:
|
||||||
|
|
||||||
- util.ts, test/index.ts, PlatformServiceMixin.ts (circular dependency fix)
|
- util.ts, test/index.ts, PlatformServiceMixin.ts (circular dependency fix)
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -50,17 +61,21 @@ Utility functions:
|
|||||||
## 🛠️ **Available Tools**
|
## 🛠️ **Available Tools**
|
||||||
|
|
||||||
### **Migration Helper Script**
|
### **Migration Helper Script**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/migration-helper.sh [command]
|
./scripts/migration-helper.sh [command]
|
||||||
```
|
```
|
||||||
|
|
||||||
**Commands**: progress, files, patterns, template, validate, next, all
|
**Commands**: progress, files, patterns, template, validate, next, all
|
||||||
|
|
||||||
### **Progress Tracking**
|
### **Progress Tracking**
|
||||||
|
|
||||||
- **Main Tracker**: `doc/migration-progress-tracker.md`
|
- **Main Tracker**: `doc/migration-progress-tracker.md`
|
||||||
- **Quick Reference**: `doc/migration-quick-reference.md`
|
- **Quick Reference**: `doc/migration-quick-reference.md`
|
||||||
- **Completion Plan**: `doc/platformservicemixin-completion-plan.md`
|
- **Completion Plan**: `doc/platformservicemixin-completion-plan.md`
|
||||||
|
|
||||||
### **Validation Commands**
|
### **Validation Commands**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check progress
|
# Check progress
|
||||||
./scripts/migration-helper.sh progress
|
./scripts/migration-helper.sh progress
|
||||||
@@ -77,6 +92,7 @@ find src -name "*.vue" -o -name "*.ts" | xargs grep -l "import.*databaseUtil" |
|
|||||||
## 🔄 **Migration Pattern**
|
## 🔄 **Migration Pattern**
|
||||||
|
|
||||||
### **Standard Template**
|
### **Standard Template**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// 1. Add import
|
// 1. Add import
|
||||||
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||||
@@ -94,6 +110,7 @@ export default class ComponentName extends Vue {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### **Common Replacements**
|
### **Common Replacements**
|
||||||
|
|
||||||
| Old | New |
|
| Old | New |
|
||||||
|-----|-----|
|
|-----|-----|
|
||||||
| `generateInsertStatement` | `this.$generateInsertStatement` |
|
| `generateInsertStatement` | `this.$generateInsertStatement` |
|
||||||
@@ -109,19 +126,23 @@ export default class ComponentName extends Vue {
|
|||||||
## 🎯 **Day 1 Plan: PlatformServiceMixin Completion**
|
## 🎯 **Day 1 Plan: PlatformServiceMixin Completion**
|
||||||
|
|
||||||
### **Phase 1: Remove Circular Dependency (30 min)**
|
### **Phase 1: Remove Circular Dependency (30 min)**
|
||||||
|
|
||||||
- Remove `memoryLogs` import from PlatformServiceMixin
|
- Remove `memoryLogs` import from PlatformServiceMixin
|
||||||
- Add self-contained memoryLogs implementation
|
- Add self-contained memoryLogs implementation
|
||||||
- Update logger.ts
|
- Update logger.ts
|
||||||
|
|
||||||
### **Phase 2: Add Missing Functions (1 hour)**
|
### **Phase 2: Add Missing Functions (1 hour)**
|
||||||
|
|
||||||
- Add `generateInsertStatement` and `generateUpdateStatement`
|
- Add `generateInsertStatement` and `generateUpdateStatement`
|
||||||
- Test both utility functions
|
- Test both utility functions
|
||||||
|
|
||||||
### **Phase 3: Update Types (30 min)**
|
### **Phase 3: Update Types (30 min)**
|
||||||
|
|
||||||
- Add new methods to TypeScript interfaces
|
- Add new methods to TypeScript interfaces
|
||||||
- Verify compilation
|
- Verify compilation
|
||||||
|
|
||||||
### **Phase 4: Testing (1 hour)**
|
### **Phase 4: Testing (1 hour)**
|
||||||
|
|
||||||
- Comprehensive testing and validation
|
- Comprehensive testing and validation
|
||||||
- Ensure no circular dependencies
|
- Ensure no circular dependencies
|
||||||
|
|
||||||
@@ -130,17 +151,20 @@ export default class ComponentName extends Vue {
|
|||||||
## 🎯 **Day 2 Plan: File Migration**
|
## 🎯 **Day 2 Plan: File Migration**
|
||||||
|
|
||||||
### **Strategy**
|
### **Strategy**
|
||||||
|
|
||||||
1. **Views First** (42 files) - High impact, user-facing
|
1. **Views First** (42 files) - High impact, user-facing
|
||||||
2. **Components** (9 files) - Reusable UI elements
|
2. **Components** (9 files) - Reusable UI elements
|
||||||
3. **Services** (1 file) - Business logic
|
3. **Services** (1 file) - Business logic
|
||||||
4. **Utils** (3 files) - Utility functions
|
4. **Utils** (3 files) - Utility functions
|
||||||
|
|
||||||
### **Batch Processing**
|
### **Batch Processing**
|
||||||
|
|
||||||
- Process similar files together
|
- Process similar files together
|
||||||
- Use automated scripts for common patterns
|
- Use automated scripts for common patterns
|
||||||
- Validate after each batch
|
- Validate after each batch
|
||||||
|
|
||||||
### **Success Criteria**
|
### **Success Criteria**
|
||||||
|
|
||||||
- 0 files importing databaseUtil
|
- 0 files importing databaseUtil
|
||||||
- All tests passing
|
- All tests passing
|
||||||
- No runtime errors
|
- No runtime errors
|
||||||
@@ -151,12 +175,14 @@ export default class ComponentName extends Vue {
|
|||||||
## 🚀 **Expected Benefits**
|
## 🚀 **Expected Benefits**
|
||||||
|
|
||||||
### **Immediate Benefits**
|
### **Immediate Benefits**
|
||||||
|
|
||||||
- **80% reduction** in database boilerplate code
|
- **80% reduction** in database boilerplate code
|
||||||
- **Eliminated circular dependencies**
|
- **Eliminated circular dependencies**
|
||||||
- **Centralized caching** for performance
|
- **Centralized caching** for performance
|
||||||
- **Type-safe** database operations
|
- **Type-safe** database operations
|
||||||
|
|
||||||
### **Long-term Benefits**
|
### **Long-term Benefits**
|
||||||
|
|
||||||
- **Simplified testing** with mockable mixin
|
- **Simplified testing** with mockable mixin
|
||||||
- **Consistent error handling** across components
|
- **Consistent error handling** across components
|
||||||
- **Ready for SQLite-only mode**
|
- **Ready for SQLite-only mode**
|
||||||
@@ -167,18 +193,21 @@ export default class ComponentName extends Vue {
|
|||||||
## 📋 **Pre-Migration Checklist**
|
## 📋 **Pre-Migration Checklist**
|
||||||
|
|
||||||
### **Environment Ready**
|
### **Environment Ready**
|
||||||
|
|
||||||
- [x] Migration helper script tested and working
|
- [x] Migration helper script tested and working
|
||||||
- [x] Progress tracking system operational
|
- [x] Progress tracking system operational
|
||||||
- [x] Documentation complete and accessible
|
- [x] Documentation complete and accessible
|
||||||
- [x] Validation commands working
|
- [x] Validation commands working
|
||||||
|
|
||||||
### **Tools Available**
|
### **Tools Available**
|
||||||
|
|
||||||
- [x] Automated progress tracking
|
- [x] Automated progress tracking
|
||||||
- [x] Migration pattern templates
|
- [x] Migration pattern templates
|
||||||
- [x] Validation scripts
|
- [x] Validation scripts
|
||||||
- [x] Cross-machine documentation
|
- [x] Cross-machine documentation
|
||||||
|
|
||||||
### **Knowledge Base**
|
### **Knowledge Base**
|
||||||
|
|
||||||
- [x] Common replacement patterns documented
|
- [x] Common replacement patterns documented
|
||||||
- [x] Migration templates ready
|
- [x] Migration templates ready
|
||||||
- [x] Troubleshooting guides available
|
- [x] Troubleshooting guides available
|
||||||
@@ -191,12 +220,14 @@ export default class ComponentName extends Vue {
|
|||||||
**All systems are ready for the 2-day migration sprint.**
|
**All systems are ready for the 2-day migration sprint.**
|
||||||
|
|
||||||
### **Next Steps**
|
### **Next Steps**
|
||||||
|
|
||||||
1. **Start Day 1**: Complete PlatformServiceMixin
|
1. **Start Day 1**: Complete PlatformServiceMixin
|
||||||
2. **Use tracking tools**: Monitor progress with helper script
|
2. **Use tracking tools**: Monitor progress with helper script
|
||||||
3. **Follow documentation**: Use provided templates and patterns
|
3. **Follow documentation**: Use provided templates and patterns
|
||||||
4. **Validate frequently**: Run checks after each phase
|
4. **Validate frequently**: Run checks after each phase
|
||||||
|
|
||||||
### **Success Metrics**
|
### **Success Metrics**
|
||||||
|
|
||||||
- **Day 1**: PlatformServiceMixin 100% complete, no circular dependencies
|
- **Day 1**: PlatformServiceMixin 100% complete, no circular dependencies
|
||||||
- **Day 2**: 0 files importing databaseUtil, all tests passing
|
- **Day 2**: 0 files importing databaseUtil, all tests passing
|
||||||
- **Overall**: Ready for Phase 3 cleanup and optimization
|
- **Overall**: Ready for Phase 3 cleanup and optimization
|
||||||
@@ -210,4 +241,4 @@ export default class ComponentName extends Vue {
|
|||||||
---
|
---
|
||||||
|
|
||||||
**Last Updated**: $(date)
|
**Last Updated**: $(date)
|
||||||
**Next Review**: After Day 1 completion
|
**Next Review**: After Day 1 completion
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This document outlines the immediate next steps for completing the TimeSafari da
|
|||||||
## Current Status Summary
|
## Current Status Summary
|
||||||
|
|
||||||
### ✅ **Completed Achievements**
|
### ✅ **Completed Achievements**
|
||||||
|
|
||||||
1. **Circular Dependencies Resolved** - No active circular dependencies blocking development
|
1. **Circular Dependencies Resolved** - No active circular dependencies blocking development
|
||||||
2. **PlatformServiceMixin Implemented** - Core functionality with caching and utilities
|
2. **PlatformServiceMixin Implemented** - Core functionality with caching and utilities
|
||||||
3. **Migration Tools Ready** - Data comparison and transfer utilities functional
|
3. **Migration Tools Ready** - Data comparison and transfer utilities functional
|
||||||
@@ -14,6 +15,7 @@ This document outlines the immediate next steps for completing the TimeSafari da
|
|||||||
5. **Documentation Updated** - All docs reflect current PlatformServiceMixin approach
|
5. **Documentation Updated** - All docs reflect current PlatformServiceMixin approach
|
||||||
|
|
||||||
### 🔄 **Current Phase: Phase 2 - Active Migration**
|
### 🔄 **Current Phase: Phase 2 - Active Migration**
|
||||||
|
|
||||||
- **DatabaseUtil Migration**: 52 files still importing databaseUtil
|
- **DatabaseUtil Migration**: 52 files still importing databaseUtil
|
||||||
- **Contact Migration**: Framework ready, implementation in progress
|
- **Contact Migration**: Framework ready, implementation in progress
|
||||||
- **File-by-File Migration**: Ready to begin systematic migration
|
- **File-by-File Migration**: Ready to begin systematic migration
|
||||||
@@ -23,6 +25,7 @@ This document outlines the immediate next steps for completing the TimeSafari da
|
|||||||
### 🔴 **Priority 1: Complete PlatformServiceMixin Independence**
|
### 🔴 **Priority 1: Complete PlatformServiceMixin Independence**
|
||||||
|
|
||||||
#### **Step 1.1: Remove memoryLogs Dependency**
|
#### **Step 1.1: Remove memoryLogs Dependency**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Current: PlatformServiceMixin imports from databaseUtil
|
// Current: PlatformServiceMixin imports from databaseUtil
|
||||||
import { memoryLogs } from "@/db/databaseUtil";
|
import { memoryLogs } from "@/db/databaseUtil";
|
||||||
@@ -32,12 +35,15 @@ const memoryLogs: string[] = [];
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Files to modify**:
|
**Files to modify**:
|
||||||
|
|
||||||
- `src/utils/PlatformServiceMixin.ts` - Remove import, add self-contained implementation
|
- `src/utils/PlatformServiceMixin.ts` - Remove import, add self-contained implementation
|
||||||
|
|
||||||
**Estimated time**: 30 minutes
|
**Estimated time**: 30 minutes
|
||||||
|
|
||||||
#### **Step 1.2: Add Missing Utility Methods**
|
#### **Step 1.2: Add Missing Utility Methods**
|
||||||
|
|
||||||
Add these methods to PlatformServiceMixin:
|
Add these methods to PlatformServiceMixin:
|
||||||
|
|
||||||
- `$parseJson()` - Self-contained JSON parsing
|
- `$parseJson()` - Self-contained JSON parsing
|
||||||
- `$generateInsertStatement()` - SQL generation
|
- `$generateInsertStatement()` - SQL generation
|
||||||
- `$generateUpdateStatement()` - SQL generation
|
- `$generateUpdateStatement()` - SQL generation
|
||||||
@@ -48,6 +54,7 @@ Add these methods to PlatformServiceMixin:
|
|||||||
### 🟡 **Priority 2: Start File-by-File Migration**
|
### 🟡 **Priority 2: Start File-by-File Migration**
|
||||||
|
|
||||||
#### **Step 2.1: Migrate Critical Files First**
|
#### **Step 2.1: Migrate Critical Files First**
|
||||||
|
|
||||||
Based on the migration plan, start with these high-priority files:
|
Based on the migration plan, start with these high-priority files:
|
||||||
|
|
||||||
1. **`src/App.vue`** - Main application (highest impact)
|
1. **`src/App.vue`** - Main application (highest impact)
|
||||||
@@ -57,6 +64,7 @@ Based on the migration plan, start with these high-priority files:
|
|||||||
5. **`src/services/deepLinks.ts`** - Service layer
|
5. **`src/services/deepLinks.ts`** - Service layer
|
||||||
|
|
||||||
**Migration pattern for each file**:
|
**Migration pattern for each file**:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// 1. Remove databaseUtil import
|
// 1. Remove databaseUtil import
|
||||||
// Remove: import * as databaseUtil from "../db/databaseUtil";
|
// Remove: import * as databaseUtil from "../db/databaseUtil";
|
||||||
@@ -82,7 +90,9 @@ Based on the migration plan, start with these high-priority files:
|
|||||||
### 🟡 **Priority 3: Systematic File Migration**
|
### 🟡 **Priority 3: Systematic File Migration**
|
||||||
|
|
||||||
#### **Step 3.1: Migrate High-Usage Components (15 files)**
|
#### **Step 3.1: Migrate High-Usage Components (15 files)**
|
||||||
|
|
||||||
Target components with databaseUtil imports:
|
Target components with databaseUtil imports:
|
||||||
|
|
||||||
- `PhotoDialog.vue`
|
- `PhotoDialog.vue`
|
||||||
- `FeedFilters.vue`
|
- `FeedFilters.vue`
|
||||||
- `UserNameDialog.vue`
|
- `UserNameDialog.vue`
|
||||||
@@ -97,7 +107,9 @@ Target components with databaseUtil imports:
|
|||||||
**Estimated time**: 15-30 hours
|
**Estimated time**: 15-30 hours
|
||||||
|
|
||||||
#### **Step 3.2: Migrate High-Usage Views (20 files)**
|
#### **Step 3.2: Migrate High-Usage Views (20 files)**
|
||||||
|
|
||||||
Target views with databaseUtil imports:
|
Target views with databaseUtil imports:
|
||||||
|
|
||||||
- `IdentitySwitcherView.vue`
|
- `IdentitySwitcherView.vue`
|
||||||
- `ContactEditView.vue`
|
- `ContactEditView.vue`
|
||||||
- `ContactGiftingView.vue`
|
- `ContactGiftingView.vue`
|
||||||
@@ -113,6 +125,7 @@ Target views with databaseUtil imports:
|
|||||||
**Estimated time**: 20-40 hours
|
**Estimated time**: 20-40 hours
|
||||||
|
|
||||||
#### **Step 3.3: Migrate Remaining Files (27 files)**
|
#### **Step 3.3: Migrate Remaining Files (27 files)**
|
||||||
|
|
||||||
Complete migration of all remaining files with databaseUtil imports.
|
Complete migration of all remaining files with databaseUtil imports.
|
||||||
|
|
||||||
**Estimated time**: 27-54 hours
|
**Estimated time**: 27-54 hours
|
||||||
@@ -120,6 +133,7 @@ Complete migration of all remaining files with databaseUtil imports.
|
|||||||
### 🟢 **Priority 4: Contact Migration Completion**
|
### 🟢 **Priority 4: Contact Migration Completion**
|
||||||
|
|
||||||
#### **Step 4.1: Complete Contact Migration Framework**
|
#### **Step 4.1: Complete Contact Migration Framework**
|
||||||
|
|
||||||
- Implement contact import/export functionality
|
- Implement contact import/export functionality
|
||||||
- Add contact validation and error handling
|
- Add contact validation and error handling
|
||||||
- Test contact migration with real data
|
- Test contact migration with real data
|
||||||
@@ -127,6 +141,7 @@ Complete migration of all remaining files with databaseUtil imports.
|
|||||||
**Estimated time**: 4-8 hours
|
**Estimated time**: 4-8 hours
|
||||||
|
|
||||||
#### **Step 4.2: User Testing and Validation**
|
#### **Step 4.2: User Testing and Validation**
|
||||||
|
|
||||||
- Test migration with various data scenarios
|
- Test migration with various data scenarios
|
||||||
- Validate data integrity after migration
|
- Validate data integrity after migration
|
||||||
- Performance testing with large datasets
|
- Performance testing with large datasets
|
||||||
@@ -138,7 +153,9 @@ Complete migration of all remaining files with databaseUtil imports.
|
|||||||
### 🔵 **Priority 5: Cleanup and Optimization**
|
### 🔵 **Priority 5: Cleanup and Optimization**
|
||||||
|
|
||||||
#### **Step 5.1: Remove Unused databaseUtil Functions**
|
#### **Step 5.1: Remove Unused databaseUtil Functions**
|
||||||
|
|
||||||
After all files are migrated:
|
After all files are migrated:
|
||||||
|
|
||||||
- Remove unused functions from databaseUtil.ts
|
- Remove unused functions from databaseUtil.ts
|
||||||
- Update TypeScript interfaces
|
- Update TypeScript interfaces
|
||||||
- Clean up legacy code
|
- Clean up legacy code
|
||||||
@@ -146,6 +163,7 @@ After all files are migrated:
|
|||||||
**Estimated time**: 4-8 hours
|
**Estimated time**: 4-8 hours
|
||||||
|
|
||||||
#### **Step 5.2: Performance Optimization**
|
#### **Step 5.2: Performance Optimization**
|
||||||
|
|
||||||
- Optimize PlatformServiceMixin caching
|
- Optimize PlatformServiceMixin caching
|
||||||
- Add performance monitoring
|
- Add performance monitoring
|
||||||
- Implement database query optimization
|
- Implement database query optimization
|
||||||
@@ -153,6 +171,7 @@ After all files are migrated:
|
|||||||
**Estimated time**: 8-16 hours
|
**Estimated time**: 8-16 hours
|
||||||
|
|
||||||
#### **Step 5.3: Legacy Dexie Removal**
|
#### **Step 5.3: Legacy Dexie Removal**
|
||||||
|
|
||||||
- Remove Dexie dependencies
|
- Remove Dexie dependencies
|
||||||
- Clean up migration tools
|
- Clean up migration tools
|
||||||
- Update build configurations
|
- Update build configurations
|
||||||
@@ -162,6 +181,7 @@ After all files are migrated:
|
|||||||
## Migration Commands and Tools
|
## Migration Commands and Tools
|
||||||
|
|
||||||
### **Automated Migration Script**
|
### **Automated Migration Script**
|
||||||
|
|
||||||
Create a script to help with bulk migrations:
|
Create a script to help with bulk migrations:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -193,6 +213,7 @@ echo "Please review and test the changes"
|
|||||||
```
|
```
|
||||||
|
|
||||||
### **Migration Testing Commands**
|
### **Migration Testing Commands**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Test individual file migration
|
# Test individual file migration
|
||||||
npm run test -- --grep "ComponentName"
|
npm run test -- --grep "ComponentName"
|
||||||
@@ -213,18 +234,21 @@ npx tsc --noEmit
|
|||||||
## Risk Mitigation
|
## Risk Mitigation
|
||||||
|
|
||||||
### **Incremental Migration Strategy**
|
### **Incremental Migration Strategy**
|
||||||
|
|
||||||
1. **One file at a time** - Minimize risk of breaking changes
|
1. **One file at a time** - Minimize risk of breaking changes
|
||||||
2. **Comprehensive testing** - Test each migration thoroughly
|
2. **Comprehensive testing** - Test each migration thoroughly
|
||||||
3. **Rollback capability** - Keep databaseUtil.ts until migration complete
|
3. **Rollback capability** - Keep databaseUtil.ts until migration complete
|
||||||
4. **Documentation updates** - Update docs as methods are migrated
|
4. **Documentation updates** - Update docs as methods are migrated
|
||||||
|
|
||||||
### **Testing Strategy**
|
### **Testing Strategy**
|
||||||
|
|
||||||
1. **Unit tests** - Test individual component functionality
|
1. **Unit tests** - Test individual component functionality
|
||||||
2. **Integration tests** - Test database operations
|
2. **Integration tests** - Test database operations
|
||||||
3. **End-to-end tests** - Test complete user workflows
|
3. **End-to-end tests** - Test complete user workflows
|
||||||
4. **Performance tests** - Ensure no performance regression
|
4. **Performance tests** - Ensure no performance regression
|
||||||
|
|
||||||
### **Rollback Plan**
|
### **Rollback Plan**
|
||||||
|
|
||||||
1. **Git branches** - Each migration in separate branch
|
1. **Git branches** - Each migration in separate branch
|
||||||
2. **Backup files** - Keep original files until migration verified
|
2. **Backup files** - Keep original files until migration verified
|
||||||
3. **Feature flags** - Ability to switch back to databaseUtil if needed
|
3. **Feature flags** - Ability to switch back to databaseUtil if needed
|
||||||
@@ -233,18 +257,21 @@ npx tsc --noEmit
|
|||||||
## Success Metrics
|
## Success Metrics
|
||||||
|
|
||||||
### **Short-Term (This Week)**
|
### **Short-Term (This Week)**
|
||||||
|
|
||||||
- [ ] PlatformServiceMixin completely independent
|
- [ ] PlatformServiceMixin completely independent
|
||||||
- [ ] 5 critical files migrated
|
- [ ] 5 critical files migrated
|
||||||
- [ ] No new circular dependencies
|
- [ ] No new circular dependencies
|
||||||
- [ ] All tests passing
|
- [ ] All tests passing
|
||||||
|
|
||||||
### **Medium-Term (Next 2 Weeks)**
|
### **Medium-Term (Next 2 Weeks)**
|
||||||
|
|
||||||
- [ ] 35+ files migrated (70% completion)
|
- [ ] 35+ files migrated (70% completion)
|
||||||
- [ ] Contact migration framework complete
|
- [ ] Contact migration framework complete
|
||||||
- [ ] Performance maintained or improved
|
- [ ] Performance maintained or improved
|
||||||
- [ ] User testing completed
|
- [ ] User testing completed
|
||||||
|
|
||||||
### **Long-Term (Next Month)**
|
### **Long-Term (Next Month)**
|
||||||
|
|
||||||
- [ ] All 52 files migrated (100% completion)
|
- [ ] All 52 files migrated (100% completion)
|
||||||
- [ ] databaseUtil.ts removed or minimal
|
- [ ] databaseUtil.ts removed or minimal
|
||||||
- [ ] Legacy Dexie code removed
|
- [ ] Legacy Dexie code removed
|
||||||
@@ -253,12 +280,14 @@ npx tsc --noEmit
|
|||||||
## Resource Requirements
|
## Resource Requirements
|
||||||
|
|
||||||
### **Development Time**
|
### **Development Time**
|
||||||
|
|
||||||
- **Immediate (This Week)**: 8-12 hours
|
- **Immediate (This Week)**: 8-12 hours
|
||||||
- **Medium-Term (Next 2 Weeks)**: 35-70 hours
|
- **Medium-Term (Next 2 Weeks)**: 35-70 hours
|
||||||
- **Long-Term (Next Month)**: 16-32 hours
|
- **Long-Term (Next Month)**: 16-32 hours
|
||||||
- **Total Estimated**: 59-114 hours
|
- **Total Estimated**: 59-114 hours
|
||||||
|
|
||||||
### **Testing Time**
|
### **Testing Time**
|
||||||
|
|
||||||
- **Unit Testing**: 20-30 hours
|
- **Unit Testing**: 20-30 hours
|
||||||
- **Integration Testing**: 10-15 hours
|
- **Integration Testing**: 10-15 hours
|
||||||
- **User Testing**: 8-12 hours
|
- **User Testing**: 8-12 hours
|
||||||
@@ -266,6 +295,7 @@ npx tsc --noEmit
|
|||||||
- **Total Testing**: 43-65 hours
|
- **Total Testing**: 43-65 hours
|
||||||
|
|
||||||
### **Total Project Time**
|
### **Total Project Time**
|
||||||
|
|
||||||
- **Development**: 59-114 hours
|
- **Development**: 59-114 hours
|
||||||
- **Testing**: 43-65 hours
|
- **Testing**: 43-65 hours
|
||||||
- **Documentation**: 5-10 hours
|
- **Documentation**: 5-10 hours
|
||||||
@@ -274,6 +304,7 @@ npx tsc --noEmit
|
|||||||
## Conclusion
|
## Conclusion
|
||||||
|
|
||||||
The migration is well-positioned for completion with:
|
The migration is well-positioned for completion with:
|
||||||
|
|
||||||
- ✅ **No blocking circular dependencies**
|
- ✅ **No blocking circular dependencies**
|
||||||
- ✅ **PlatformServiceMixin mostly complete**
|
- ✅ **PlatformServiceMixin mostly complete**
|
||||||
- ✅ **Clear migration path defined**
|
- ✅ **Clear migration path defined**
|
||||||
@@ -287,4 +318,4 @@ The next steps focus on systematic file-by-file migration with proper testing an
|
|||||||
**Created**: 2025-07-05
|
**Created**: 2025-07-05
|
||||||
**Status**: Active Planning
|
**Status**: Active Planning
|
||||||
**Last Updated**: 2025-07-05
|
**Last Updated**: 2025-07-05
|
||||||
**Note**: This roadmap is based on current codebase analysis and documented progress
|
**Note**: This roadmap is based on current codebase analysis and documented progress
|
||||||
|
|||||||
@@ -352,4 +352,4 @@ This security audit checklist ensures that the database migration maintains the
|
|||||||
|
|
||||||
**Reviewed By**: _______________
|
**Reviewed By**: _______________
|
||||||
|
|
||||||
**Approved By**: _______________
|
**Approved By**: _______________
|
||||||
|
|||||||
@@ -29,12 +29,15 @@ This document outlines the migration process from Dexie.js to absurd-sql for the
|
|||||||
## Migration Architecture
|
## Migration Architecture
|
||||||
|
|
||||||
### Migration Fence
|
### Migration Fence
|
||||||
|
|
||||||
The migration fence is now defined by the **PlatformServiceMixin** in `src/utils/PlatformServiceMixin.ts`:
|
The migration fence is now defined by the **PlatformServiceMixin** in `src/utils/PlatformServiceMixin.ts`:
|
||||||
|
|
||||||
- **PlatformServiceMixin**: Centralized database access with caching and utilities
|
- **PlatformServiceMixin**: Centralized database access with caching and utilities
|
||||||
- **Migration Tools**: Exclusive interface between legacy and new databases
|
- **Migration Tools**: Exclusive interface between legacy and new databases
|
||||||
- **Service Layer**: All database operations go through PlatformService
|
- **Service Layer**: All database operations go through PlatformService
|
||||||
|
|
||||||
### Migration Order
|
### Migration Order
|
||||||
|
|
||||||
The migration follows a specific order to maintain data integrity:
|
The migration follows a specific order to maintain data integrity:
|
||||||
|
|
||||||
1. **Accounts** (foundational - contains DIDs)
|
1. **Accounts** (foundational - contains DIDs)
|
||||||
@@ -45,9 +48,11 @@ The migration follows a specific order to maintain data integrity:
|
|||||||
## ActiveDid Migration ⭐ **NEW FEATURE**
|
## ActiveDid Migration ⭐ **NEW FEATURE**
|
||||||
|
|
||||||
### Problem Solved
|
### Problem Solved
|
||||||
|
|
||||||
Previously, the `activeDid` setting was not migrated from Dexie to SQLite, causing users to lose their active identity after migration.
|
Previously, the `activeDid` setting was not migrated from Dexie to SQLite, causing users to lose their active identity after migration.
|
||||||
|
|
||||||
### Solution Implemented
|
### Solution Implemented
|
||||||
|
|
||||||
The migration now includes a dedicated step for migrating the `activeDid`:
|
The migration now includes a dedicated step for migrating the `activeDid`:
|
||||||
|
|
||||||
1. **Detection**: Identifies the `activeDid` from Dexie master settings
|
1. **Detection**: Identifies the `activeDid` from Dexie master settings
|
||||||
@@ -58,6 +63,7 @@ The migration now includes a dedicated step for migrating the `activeDid`:
|
|||||||
### Implementation Details
|
### Implementation Details
|
||||||
|
|
||||||
#### New Function: `migrateActiveDid()`
|
#### New Function: `migrateActiveDid()`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
export async function migrateActiveDid(): Promise<MigrationResult> {
|
export async function migrateActiveDid(): Promise<MigrationResult> {
|
||||||
// 1. Get Dexie settings to find the activeDid
|
// 1. Get Dexie settings to find the activeDid
|
||||||
@@ -76,13 +82,17 @@ export async function migrateActiveDid(): Promise<MigrationResult> {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Enhanced `migrateSettings()` Function
|
#### Enhanced `migrateSettings()` Function
|
||||||
|
|
||||||
The settings migration now includes activeDid handling:
|
The settings migration now includes activeDid handling:
|
||||||
|
|
||||||
- Extracts `activeDid` from Dexie master settings
|
- Extracts `activeDid` from Dexie master settings
|
||||||
- Validates account existence in SQLite
|
- Validates account existence in SQLite
|
||||||
- Updates SQLite master settings with the `activeDid`
|
- Updates SQLite master settings with the `activeDid`
|
||||||
|
|
||||||
#### Updated `migrateAll()` Function
|
#### Updated `migrateAll()` Function
|
||||||
|
|
||||||
The complete migration now includes a dedicated step for activeDid:
|
The complete migration now includes a dedicated step for activeDid:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Step 3: Migrate ActiveDid (depends on accounts and settings)
|
// Step 3: Migrate ActiveDid (depends on accounts and settings)
|
||||||
logger.info("[MigrationService] Step 3: Migrating activeDid...");
|
logger.info("[MigrationService] Step 3: Migrating activeDid...");
|
||||||
@@ -90,6 +100,7 @@ const activeDidResult = await migrateActiveDid();
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Benefits
|
### Benefits
|
||||||
|
|
||||||
- ✅ **User Identity Preservation**: Users maintain their active identity
|
- ✅ **User Identity Preservation**: Users maintain their active identity
|
||||||
- ✅ **Seamless Experience**: No need to manually select identity after migration
|
- ✅ **Seamless Experience**: No need to manually select identity after migration
|
||||||
- ✅ **Data Consistency**: Ensures all identity-related settings are preserved
|
- ✅ **Data Consistency**: Ensures all identity-related settings are preserved
|
||||||
@@ -98,17 +109,20 @@ const activeDidResult = await migrateActiveDid();
|
|||||||
## Migration Process
|
## Migration Process
|
||||||
|
|
||||||
### Phase 1: Preparation ✅
|
### Phase 1: Preparation ✅
|
||||||
|
|
||||||
- [x] PlatformServiceMixin implementation
|
- [x] PlatformServiceMixin implementation
|
||||||
- [x] Implement data comparison tools
|
- [x] Implement data comparison tools
|
||||||
- [x] Create migration service structure
|
- [x] Create migration service structure
|
||||||
|
|
||||||
### Phase 2: Core Migration ✅
|
### Phase 2: Core Migration ✅
|
||||||
|
|
||||||
- [x] Account migration with `importFromMnemonic`
|
- [x] Account migration with `importFromMnemonic`
|
||||||
- [x] Settings migration (excluding activeDid)
|
- [x] Settings migration (excluding activeDid)
|
||||||
- [x] **ActiveDid migration** ⭐ **COMPLETED**
|
- [x] **ActiveDid migration** ⭐ **COMPLETED**
|
||||||
- [x] Contact migration framework
|
- [x] Contact migration framework
|
||||||
|
|
||||||
### Phase 3: Validation and Cleanup 🔄
|
### Phase 3: Validation and Cleanup 🔄
|
||||||
|
|
||||||
- [ ] Comprehensive data validation
|
- [ ] Comprehensive data validation
|
||||||
- [ ] Performance testing
|
- [ ] Performance testing
|
||||||
- [ ] User acceptance testing
|
- [ ] User acceptance testing
|
||||||
@@ -117,6 +131,7 @@ const activeDidResult = await migrateActiveDid();
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Manual Migration
|
### Manual Migration
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { migrateAll, migrateActiveDid } from '../services/indexedDBMigrationService';
|
import { migrateAll, migrateActiveDid } from '../services/indexedDBMigrationService';
|
||||||
|
|
||||||
@@ -128,6 +143,7 @@ const activeDidResult = await migrateActiveDid();
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Migration Verification
|
### Migration Verification
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { compareDatabases } from '../services/indexedDBMigrationService';
|
import { compareDatabases } from '../services/indexedDBMigrationService';
|
||||||
|
|
||||||
@@ -136,7 +152,9 @@ console.log('Migration differences:', comparison.differences);
|
|||||||
```
|
```
|
||||||
|
|
||||||
### PlatformServiceMixin Integration
|
### PlatformServiceMixin Integration
|
||||||
|
|
||||||
After migration, use the mixin for all database operations:
|
After migration, use the mixin for all database operations:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Use mixin methods for database access
|
// Use mixin methods for database access
|
||||||
const contacts = await this.$contacts();
|
const contacts = await this.$contacts();
|
||||||
@@ -147,11 +165,13 @@ const result = await this.$db("SELECT * FROM contacts WHERE did = ?", [accountDi
|
|||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
### ActiveDid Migration Errors
|
### ActiveDid Migration Errors
|
||||||
|
|
||||||
- **Missing Account**: If the `activeDid` from Dexie doesn't exist in SQLite accounts
|
- **Missing Account**: If the `activeDid` from Dexie doesn't exist in SQLite accounts
|
||||||
- **Database Errors**: Connection or query failures
|
- **Database Errors**: Connection or query failures
|
||||||
- **Settings Update Failures**: Issues updating SQLite master settings
|
- **Settings Update Failures**: Issues updating SQLite master settings
|
||||||
|
|
||||||
### Recovery Strategies
|
### Recovery Strategies
|
||||||
|
|
||||||
1. **Automatic Recovery**: Migration continues even if activeDid migration fails
|
1. **Automatic Recovery**: Migration continues even if activeDid migration fails
|
||||||
2. **Manual Recovery**: Users can manually select their identity after migration
|
2. **Manual Recovery**: Users can manually select their identity after migration
|
||||||
3. **Fallback**: System creates new identity if none exists
|
3. **Fallback**: System creates new identity if none exists
|
||||||
@@ -159,11 +179,13 @@ const result = await this.$db("SELECT * FROM contacts WHERE did = ?", [accountDi
|
|||||||
## Security Considerations
|
## Security Considerations
|
||||||
|
|
||||||
### Data Protection
|
### Data Protection
|
||||||
|
|
||||||
- All sensitive data (mnemonics, private keys) are encrypted
|
- All sensitive data (mnemonics, private keys) are encrypted
|
||||||
- Migration preserves encryption standards
|
- Migration preserves encryption standards
|
||||||
- No plaintext data exposure during migration
|
- No plaintext data exposure during migration
|
||||||
|
|
||||||
### Identity Verification
|
### Identity Verification
|
||||||
|
|
||||||
- ActiveDid migration validates account existence
|
- ActiveDid migration validates account existence
|
||||||
- Prevents setting non-existent identities as active
|
- Prevents setting non-existent identities as active
|
||||||
- Maintains cryptographic integrity
|
- Maintains cryptographic integrity
|
||||||
@@ -171,6 +193,7 @@ const result = await this.$db("SELECT * FROM contacts WHERE did = ?", [accountDi
|
|||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
### Migration Testing
|
### Migration Testing
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run migration
|
# Run migration
|
||||||
npm run migrate
|
npm run migrate
|
||||||
@@ -180,6 +203,7 @@ npm run test:migration
|
|||||||
```
|
```
|
||||||
|
|
||||||
### ActiveDid Testing
|
### ActiveDid Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Test activeDid migration specifically
|
// Test activeDid migration specifically
|
||||||
const result = await migrateActiveDid();
|
const result = await migrateActiveDid();
|
||||||
@@ -188,6 +212,7 @@ expect(result.warnings).toContain('Successfully migrated activeDid');
|
|||||||
```
|
```
|
||||||
|
|
||||||
### PlatformServiceMixin Testing
|
### PlatformServiceMixin Testing
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Test mixin integration
|
// Test mixin integration
|
||||||
describe('PlatformServiceMixin', () => {
|
describe('PlatformServiceMixin', () => {
|
||||||
@@ -224,6 +249,7 @@ describe('PlatformServiceMixin', () => {
|
|||||||
- Verify caching and error handling work correctly
|
- Verify caching and error handling work correctly
|
||||||
|
|
||||||
### Debugging
|
### Debugging
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Debug migration process
|
// Debug migration process
|
||||||
import { logger } from '../utils/logger';
|
import { logger } from '../utils/logger';
|
||||||
@@ -245,6 +271,7 @@ logger.debug('[Migration] Migration completed:', result);
|
|||||||
## Migration Status Checklist
|
## Migration Status Checklist
|
||||||
|
|
||||||
### ✅ Completed
|
### ✅ Completed
|
||||||
|
|
||||||
- [x] PlatformServiceMixin implementation
|
- [x] PlatformServiceMixin implementation
|
||||||
- [x] SQLite database service
|
- [x] SQLite database service
|
||||||
- [x] Migration tools
|
- [x] Migration tools
|
||||||
@@ -253,11 +280,13 @@ logger.debug('[Migration] Migration completed:', result);
|
|||||||
- [x] ActiveDid migration
|
- [x] ActiveDid migration
|
||||||
|
|
||||||
### 🔄 In Progress
|
### 🔄 In Progress
|
||||||
|
|
||||||
- [ ] Contact migration
|
- [ ] Contact migration
|
||||||
- [ ] DatabaseUtil to PlatformServiceMixin migration
|
- [ ] DatabaseUtil to PlatformServiceMixin migration
|
||||||
- [ ] File-by-file migration
|
- [ ] File-by-file migration
|
||||||
|
|
||||||
### ❌ Not Started
|
### ❌ Not Started
|
||||||
|
|
||||||
- [ ] Legacy Dexie removal
|
- [ ] Legacy Dexie removal
|
||||||
- [ ] Final cleanup and validation
|
- [ ] Final cleanup and validation
|
||||||
|
|
||||||
@@ -267,4 +296,4 @@ logger.debug('[Migration] Migration completed:', result);
|
|||||||
**Created**: 2025-07-05
|
**Created**: 2025-07-05
|
||||||
**Status**: Active Migration Phase
|
**Status**: Active Migration Phase
|
||||||
**Last Updated**: 2025-07-05
|
**Last Updated**: 2025-07-05
|
||||||
**Note**: Migration fence now implemented through PlatformServiceMixin instead of USE_DEXIE_DB constant
|
**Note**: Migration fence now implemented through PlatformServiceMixin instead of USE_DEXIE_DB constant
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This document outlines the complete plan to finish PlatformServiceMixin implemen
|
|||||||
## Current Status
|
## Current Status
|
||||||
|
|
||||||
### ✅ **PlatformServiceMixin - 95% Complete**
|
### ✅ **PlatformServiceMixin - 95% Complete**
|
||||||
|
|
||||||
- **Core functionality**: ✅ Implemented
|
- **Core functionality**: ✅ Implemented
|
||||||
- **Caching system**: ✅ Implemented
|
- **Caching system**: ✅ Implemented
|
||||||
- **Database methods**: ✅ Implemented
|
- **Database methods**: ✅ Implemented
|
||||||
@@ -14,6 +15,7 @@ This document outlines the complete plan to finish PlatformServiceMixin implemen
|
|||||||
- **Type definitions**: ✅ Implemented
|
- **Type definitions**: ✅ Implemented
|
||||||
|
|
||||||
### ⚠️ **Remaining Issues**
|
### ⚠️ **Remaining Issues**
|
||||||
|
|
||||||
1. **Single circular dependency**: `memoryLogs` import from databaseUtil
|
1. **Single circular dependency**: `memoryLogs` import from databaseUtil
|
||||||
2. **Missing utility functions**: `generateInsertStatement`, `generateUpdateStatement`
|
2. **Missing utility functions**: `generateInsertStatement`, `generateUpdateStatement`
|
||||||
3. **52 files** still importing databaseUtil
|
3. **52 files** still importing databaseUtil
|
||||||
@@ -25,6 +27,7 @@ This document outlines the complete plan to finish PlatformServiceMixin implemen
|
|||||||
### **Phase 1: Remove Circular Dependency (30 minutes)**
|
### **Phase 1: Remove Circular Dependency (30 minutes)**
|
||||||
|
|
||||||
#### **Step 1.1: Create Self-Contained memoryLogs**
|
#### **Step 1.1: Create Self-Contained memoryLogs**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// In PlatformServiceMixin.ts - Replace line 50:
|
// In PlatformServiceMixin.ts - Replace line 50:
|
||||||
// Remove: import { memoryLogs } from "@/db/databaseUtil";
|
// Remove: import { memoryLogs } from "@/db/databaseUtil";
|
||||||
@@ -48,6 +51,7 @@ $appendToMemoryLogs(message: string): void {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 1.2: Update logger.ts**
|
#### **Step 1.2: Update logger.ts**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// In logger.ts - Replace memoryLogs usage:
|
// In logger.ts - Replace memoryLogs usage:
|
||||||
// Remove: import { memoryLogs } from "@/db/databaseUtil";
|
// Remove: import { memoryLogs } from "@/db/databaseUtil";
|
||||||
@@ -70,6 +74,7 @@ export function getMemoryLogs(): string[] {
|
|||||||
### **Phase 2: Add Missing Utility Functions (1 hour)**
|
### **Phase 2: Add Missing Utility Functions (1 hour)**
|
||||||
|
|
||||||
#### **Step 2.1: Add generateInsertStatement to PlatformServiceMixin**
|
#### **Step 2.1: Add generateInsertStatement to PlatformServiceMixin**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to PlatformServiceMixin methods:
|
// Add to PlatformServiceMixin methods:
|
||||||
_generateInsertStatement(
|
_generateInsertStatement(
|
||||||
@@ -95,6 +100,7 @@ _generateInsertStatement(
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 2.2: Add generateUpdateStatement to PlatformServiceMixin**
|
#### **Step 2.2: Add generateUpdateStatement to PlatformServiceMixin**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to PlatformServiceMixin methods:
|
// Add to PlatformServiceMixin methods:
|
||||||
_generateUpdateStatement(
|
_generateUpdateStatement(
|
||||||
@@ -129,6 +135,7 @@ _generateUpdateStatement(
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 2.3: Add Public Wrapper Methods**
|
#### **Step 2.3: Add Public Wrapper Methods**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to PlatformServiceMixin methods:
|
// Add to PlatformServiceMixin methods:
|
||||||
$generateInsertStatement(
|
$generateInsertStatement(
|
||||||
@@ -151,6 +158,7 @@ $generateUpdateStatement(
|
|||||||
### **Phase 3: Update Type Definitions (30 minutes)**
|
### **Phase 3: Update Type Definitions (30 minutes)**
|
||||||
|
|
||||||
#### **Step 3.1: Update IPlatformServiceMixin Interface**
|
#### **Step 3.1: Update IPlatformServiceMixin Interface**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to IPlatformServiceMixin interface:
|
// Add to IPlatformServiceMixin interface:
|
||||||
$generateInsertStatement(
|
$generateInsertStatement(
|
||||||
@@ -167,6 +175,7 @@ $appendToMemoryLogs(message: string): void;
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 3.2: Update ComponentCustomProperties**
|
#### **Step 3.2: Update ComponentCustomProperties**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to ComponentCustomProperties interface:
|
// Add to ComponentCustomProperties interface:
|
||||||
$generateInsertStatement(
|
$generateInsertStatement(
|
||||||
@@ -185,12 +194,14 @@ $appendToMemoryLogs(message: string): void;
|
|||||||
### **Phase 4: Test PlatformServiceMixin (1 hour)**
|
### **Phase 4: Test PlatformServiceMixin (1 hour)**
|
||||||
|
|
||||||
#### **Step 4.1: Create Test Component**
|
#### **Step 4.1: Create Test Component**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Create test file: src/test/PlatformServiceMixin.test.ts
|
// Create test file: src/test/PlatformServiceMixin.test.ts
|
||||||
// Test all methods including new utility functions
|
// Test all methods including new utility functions
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Step 4.2: Run Linting and Type Checking**
|
#### **Step 4.2: Run Linting and Type Checking**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run lint
|
npm run lint
|
||||||
npx tsc --noEmit
|
npx tsc --noEmit
|
||||||
@@ -203,6 +214,7 @@ npx tsc --noEmit
|
|||||||
### **Migration Strategy**
|
### **Migration Strategy**
|
||||||
|
|
||||||
#### **Priority Order:**
|
#### **Priority Order:**
|
||||||
|
|
||||||
1. **Views** (25 files) - User-facing components
|
1. **Views** (25 files) - User-facing components
|
||||||
2. **Components** (15 files) - Reusable UI components
|
2. **Components** (15 files) - Reusable UI components
|
||||||
3. **Services** (8 files) - Business logic
|
3. **Services** (8 files) - Business logic
|
||||||
@@ -211,6 +223,7 @@ npx tsc --noEmit
|
|||||||
#### **Migration Pattern for Each File:**
|
#### **Migration Pattern for Each File:**
|
||||||
|
|
||||||
**Step 1: Add PlatformServiceMixin**
|
**Step 1: Add PlatformServiceMixin**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Add to component imports:
|
// Add to component imports:
|
||||||
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
import { PlatformServiceMixin } from "@/utils/PlatformServiceMixin";
|
||||||
@@ -223,6 +236,7 @@ export default class ComponentName extends Vue {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Step 2: Replace databaseUtil Imports**
|
**Step 2: Replace databaseUtil Imports**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Remove:
|
// Remove:
|
||||||
import {
|
import {
|
||||||
@@ -244,6 +258,7 @@ import {
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Step 3: Update Method Calls**
|
**Step 3: Update Method Calls**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before:
|
// Before:
|
||||||
const { sql, params } = generateInsertStatement(contact, 'contacts');
|
const { sql, params } = generateInsertStatement(contact, 'contacts');
|
||||||
@@ -255,6 +270,7 @@ const { sql, params } = this.$generateInsertStatement(contact, 'contacts');
|
|||||||
### **File Migration Checklist**
|
### **File Migration Checklist**
|
||||||
|
|
||||||
#### **Views (25 files) - Priority 1**
|
#### **Views (25 files) - Priority 1**
|
||||||
|
|
||||||
- [ ] QuickActionBvcEndView.vue
|
- [ ] QuickActionBvcEndView.vue
|
||||||
- [ ] ProjectsView.vue
|
- [ ] ProjectsView.vue
|
||||||
- [ ] ClaimReportCertificateView.vue
|
- [ ] ClaimReportCertificateView.vue
|
||||||
@@ -278,6 +294,7 @@ const { sql, params } = this.$generateInsertStatement(contact, 'contacts');
|
|||||||
- [ ] [5 more view files]
|
- [ ] [5 more view files]
|
||||||
|
|
||||||
#### **Components (15 files) - Priority 2**
|
#### **Components (15 files) - Priority 2**
|
||||||
|
|
||||||
- [ ] ActivityListItem.vue
|
- [ ] ActivityListItem.vue
|
||||||
- [ ] AmountInput.vue
|
- [ ] AmountInput.vue
|
||||||
- [ ] ChoiceButtonDialog.vue
|
- [ ] ChoiceButtonDialog.vue
|
||||||
@@ -295,18 +312,21 @@ const { sql, params } = this.$generateInsertStatement(contact, 'contacts');
|
|||||||
- [ ] IconRenderer.vue
|
- [ ] IconRenderer.vue
|
||||||
|
|
||||||
#### **Services (8 files) - Priority 3**
|
#### **Services (8 files) - Priority 3**
|
||||||
|
|
||||||
- [ ] api.ts
|
- [ ] api.ts
|
||||||
- [ ] endorserServer.ts
|
- [ ] endorserServer.ts
|
||||||
- [ ] partnerServer.ts
|
- [ ] partnerServer.ts
|
||||||
- [ ] [5 more service files]
|
- [ ] [5 more service files]
|
||||||
|
|
||||||
#### **Utils (4 files) - Priority 4**
|
#### **Utils (4 files) - Priority 4**
|
||||||
|
|
||||||
- [ ] LogCollector.ts
|
- [ ] LogCollector.ts
|
||||||
- [ ] [3 more util files]
|
- [ ] [3 more util files]
|
||||||
|
|
||||||
### **Migration Tools**
|
### **Migration Tools**
|
||||||
|
|
||||||
#### **Automated Script for Common Patterns**
|
#### **Automated Script for Common Patterns**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# migration-helper.sh
|
# migration-helper.sh
|
||||||
@@ -326,6 +346,7 @@ echo "logConsoleAndDb → this.\$logAndConsole"
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### **Validation Script**
|
#### **Validation Script**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# validate-migration.sh
|
# validate-migration.sh
|
||||||
@@ -350,6 +371,7 @@ echo "Migration validation complete!"
|
|||||||
## 🎯 **Success Criteria**
|
## 🎯 **Success Criteria**
|
||||||
|
|
||||||
### **Day 1 Success Criteria:**
|
### **Day 1 Success Criteria:**
|
||||||
|
|
||||||
- [ ] PlatformServiceMixin has no circular dependencies
|
- [ ] PlatformServiceMixin has no circular dependencies
|
||||||
- [ ] All utility functions implemented and tested
|
- [ ] All utility functions implemented and tested
|
||||||
- [ ] Type definitions complete and accurate
|
- [ ] Type definitions complete and accurate
|
||||||
@@ -357,6 +379,7 @@ echo "Migration validation complete!"
|
|||||||
- [ ] TypeScript compilation passes
|
- [ ] TypeScript compilation passes
|
||||||
|
|
||||||
### **Day 2 Success Criteria:**
|
### **Day 2 Success Criteria:**
|
||||||
|
|
||||||
- [ ] 0 files importing databaseUtil
|
- [ ] 0 files importing databaseUtil
|
||||||
- [ ] All 52 files migrated to PlatformServiceMixin
|
- [ ] All 52 files migrated to PlatformServiceMixin
|
||||||
- [ ] No runtime errors in migrated components
|
- [ ] No runtime errors in migrated components
|
||||||
@@ -364,6 +387,7 @@ echo "Migration validation complete!"
|
|||||||
- [ ] Performance maintained or improved
|
- [ ] Performance maintained or improved
|
||||||
|
|
||||||
### **Overall Success Criteria:**
|
### **Overall Success Criteria:**
|
||||||
|
|
||||||
- [ ] Complete elimination of databaseUtil dependency
|
- [ ] Complete elimination of databaseUtil dependency
|
||||||
- [ ] PlatformServiceMixin is the single source of truth for database operations
|
- [ ] PlatformServiceMixin is the single source of truth for database operations
|
||||||
- [ ] Migration fence is fully implemented
|
- [ ] Migration fence is fully implemented
|
||||||
@@ -386,12 +410,14 @@ echo "Migration validation complete!"
|
|||||||
## 📋 **Daily Progress Tracking**
|
## 📋 **Daily Progress Tracking**
|
||||||
|
|
||||||
### **Day 1 Progress:**
|
### **Day 1 Progress:**
|
||||||
|
|
||||||
- [ ] Phase 1: Circular dependency resolved
|
- [ ] Phase 1: Circular dependency resolved
|
||||||
- [ ] Phase 2: Utility functions added
|
- [ ] Phase 2: Utility functions added
|
||||||
- [ ] Phase 3: Type definitions updated
|
- [ ] Phase 3: Type definitions updated
|
||||||
- [ ] Phase 4: Testing completed
|
- [ ] Phase 4: Testing completed
|
||||||
|
|
||||||
### **Day 2 Progress:**
|
### **Day 2 Progress:**
|
||||||
|
|
||||||
- [ ] Views migrated (0/25)
|
- [ ] Views migrated (0/25)
|
||||||
- [ ] Components migrated (0/15)
|
- [ ] Components migrated (0/15)
|
||||||
- [ ] Services migrated (0/8)
|
- [ ] Services migrated (0/8)
|
||||||
@@ -403,16 +429,19 @@ echo "Migration validation complete!"
|
|||||||
## 🆘 **Contingency Plans**
|
## 🆘 **Contingency Plans**
|
||||||
|
|
||||||
### **If Day 1 Takes Longer:**
|
### **If Day 1 Takes Longer:**
|
||||||
|
|
||||||
- Focus on core functionality first
|
- Focus on core functionality first
|
||||||
- Defer advanced utility functions to Day 2
|
- Defer advanced utility functions to Day 2
|
||||||
- Prioritize circular dependency resolution
|
- Prioritize circular dependency resolution
|
||||||
|
|
||||||
### **If Day 2 Takes Longer:**
|
### **If Day 2 Takes Longer:**
|
||||||
|
|
||||||
- Focus on high-impact views first
|
- Focus on high-impact views first
|
||||||
- Batch similar components together
|
- Batch similar components together
|
||||||
- Use automated scripts for common patterns
|
- Use automated scripts for common patterns
|
||||||
|
|
||||||
### **If Issues Arise:**
|
### **If Issues Arise:**
|
||||||
|
|
||||||
- Document specific problems
|
- Document specific problems
|
||||||
- Create targeted fixes
|
- Create targeted fixes
|
||||||
- Maintain backward compatibility during transition
|
- Maintain backward compatibility during transition
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ This document describes the QR code scanning and generation implementation in th
|
|||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
### Directory Structure
|
### Directory Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
src/
|
src/
|
||||||
├── services/
|
├── services/
|
||||||
@@ -74,6 +75,7 @@ interface QRScannerOptions {
|
|||||||
### Platform-Specific Implementations
|
### Platform-Specific Implementations
|
||||||
|
|
||||||
#### Mobile (Capacitor)
|
#### Mobile (Capacitor)
|
||||||
|
|
||||||
- Uses `@capacitor-mlkit/barcode-scanning`
|
- Uses `@capacitor-mlkit/barcode-scanning`
|
||||||
- Native camera access through platform APIs
|
- Native camera access through platform APIs
|
||||||
- Optimized for mobile performance
|
- Optimized for mobile performance
|
||||||
@@ -82,6 +84,7 @@ interface QRScannerOptions {
|
|||||||
- Back camera preferred for scanning
|
- Back camera preferred for scanning
|
||||||
|
|
||||||
Configuration:
|
Configuration:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// capacitor.config.ts
|
// capacitor.config.ts
|
||||||
const config: CapacitorConfig = {
|
const config: CapacitorConfig = {
|
||||||
@@ -105,6 +108,7 @@ const config: CapacitorConfig = {
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Web
|
#### Web
|
||||||
|
|
||||||
- Uses browser's MediaDevices API
|
- Uses browser's MediaDevices API
|
||||||
- Vue.js components for UI
|
- Vue.js components for UI
|
||||||
- EventEmitter for stream management
|
- EventEmitter for stream management
|
||||||
@@ -116,6 +120,7 @@ const config: CapacitorConfig = {
|
|||||||
### View Components
|
### View Components
|
||||||
|
|
||||||
#### ContactQRScanView
|
#### ContactQRScanView
|
||||||
|
|
||||||
- Dedicated view for scanning QR codes
|
- Dedicated view for scanning QR codes
|
||||||
- Full-screen camera interface
|
- Full-screen camera interface
|
||||||
- Simple UI focused on scanning
|
- Simple UI focused on scanning
|
||||||
@@ -123,6 +128,7 @@ const config: CapacitorConfig = {
|
|||||||
- Streamlined scanning experience
|
- Streamlined scanning experience
|
||||||
|
|
||||||
#### ContactQRScanShowView
|
#### ContactQRScanShowView
|
||||||
|
|
||||||
- Combined view for QR code display and scanning
|
- Combined view for QR code display and scanning
|
||||||
- Shows user's own QR code
|
- Shows user's own QR code
|
||||||
- Handles user registration status
|
- Handles user registration status
|
||||||
@@ -160,6 +166,7 @@ const config: CapacitorConfig = {
|
|||||||
## Build Configuration
|
## Build Configuration
|
||||||
|
|
||||||
### Common Vite Configuration
|
### Common Vite Configuration
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// vite.config.common.mts
|
// vite.config.common.mts
|
||||||
export async function createBuildConfig(mode: string) {
|
export async function createBuildConfig(mode: string) {
|
||||||
@@ -183,6 +190,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Platform-Specific Builds
|
### Platform-Specific Builds
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -196,6 +204,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
### Common Error Scenarios
|
### Common Error Scenarios
|
||||||
|
|
||||||
1. No camera found
|
1. No camera found
|
||||||
2. Permission denied
|
2. Permission denied
|
||||||
3. Camera in use by another application
|
3. Camera in use by another application
|
||||||
@@ -207,6 +216,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
9. Network connectivity issues
|
9. Network connectivity issues
|
||||||
|
|
||||||
### Error Response
|
### Error Response
|
||||||
|
|
||||||
- User-friendly error messages
|
- User-friendly error messages
|
||||||
- Troubleshooting tips
|
- Troubleshooting tips
|
||||||
- Clear instructions for resolution
|
- Clear instructions for resolution
|
||||||
@@ -215,6 +225,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Security Considerations
|
## Security Considerations
|
||||||
|
|
||||||
### QR Code Security
|
### QR Code Security
|
||||||
|
|
||||||
- Encryption of contact data
|
- Encryption of contact data
|
||||||
- Timestamp validation
|
- Timestamp validation
|
||||||
- Version checking
|
- Version checking
|
||||||
@@ -222,6 +233,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
- Rate limiting for scans
|
- Rate limiting for scans
|
||||||
|
|
||||||
### Data Protection
|
### Data Protection
|
||||||
|
|
||||||
- Secure transmission of contact data
|
- Secure transmission of contact data
|
||||||
- Validation of QR code authenticity
|
- Validation of QR code authenticity
|
||||||
- Prevention of duplicate scans
|
- Prevention of duplicate scans
|
||||||
@@ -231,6 +243,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
### Camera Access
|
### Camera Access
|
||||||
|
|
||||||
1. Always check for camera availability
|
1. Always check for camera availability
|
||||||
2. Request permissions explicitly
|
2. Request permissions explicitly
|
||||||
3. Handle all error conditions
|
3. Handle all error conditions
|
||||||
@@ -238,6 +251,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
5. Implement proper cleanup
|
5. Implement proper cleanup
|
||||||
|
|
||||||
### Performance
|
### Performance
|
||||||
|
|
||||||
1. Optimize camera resolution
|
1. Optimize camera resolution
|
||||||
2. Implement proper resource cleanup
|
2. Implement proper resource cleanup
|
||||||
3. Handle camera switching efficiently
|
3. Handle camera switching efficiently
|
||||||
@@ -245,6 +259,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
5. Battery usage optimization
|
5. Battery usage optimization
|
||||||
|
|
||||||
### User Experience
|
### User Experience
|
||||||
|
|
||||||
1. Clear visual feedback
|
1. Clear visual feedback
|
||||||
2. Camera preview
|
2. Camera preview
|
||||||
3. Scanning status indicators
|
3. Scanning status indicators
|
||||||
@@ -257,6 +272,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
### Test Scenarios
|
### Test Scenarios
|
||||||
|
|
||||||
1. Permission handling
|
1. Permission handling
|
||||||
2. Camera switching
|
2. Camera switching
|
||||||
3. Error conditions
|
3. Error conditions
|
||||||
@@ -267,6 +283,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
8. Security validation
|
8. Security validation
|
||||||
|
|
||||||
### Test Environment
|
### Test Environment
|
||||||
|
|
||||||
- Multiple browsers
|
- Multiple browsers
|
||||||
- iOS and Android devices
|
- iOS and Android devices
|
||||||
- Various network conditions
|
- Various network conditions
|
||||||
@@ -275,6 +292,7 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
### Key Packages
|
### Key Packages
|
||||||
|
|
||||||
- `@capacitor-mlkit/barcode-scanning`
|
- `@capacitor-mlkit/barcode-scanning`
|
||||||
- `qrcode-stream`
|
- `qrcode-stream`
|
||||||
- `vue-qrcode-reader`
|
- `vue-qrcode-reader`
|
||||||
@@ -283,12 +301,14 @@ export async function createBuildConfig(mode: string) {
|
|||||||
## Maintenance
|
## Maintenance
|
||||||
|
|
||||||
### Regular Updates
|
### Regular Updates
|
||||||
|
|
||||||
- Keep dependencies updated
|
- Keep dependencies updated
|
||||||
- Monitor platform changes
|
- Monitor platform changes
|
||||||
- Update documentation
|
- Update documentation
|
||||||
- Review security patches
|
- Review security patches
|
||||||
|
|
||||||
### Performance Monitoring
|
### Performance Monitoring
|
||||||
|
|
||||||
- Track memory usage
|
- Track memory usage
|
||||||
- Monitor camera performance
|
- Monitor camera performance
|
||||||
- Check error rates
|
- Check error rates
|
||||||
@@ -436,6 +456,7 @@ The camera switching implementation includes comprehensive error handling:
|
|||||||
- Camera switch timeout
|
- Camera switch timeout
|
||||||
|
|
||||||
2. **Error Response**
|
2. **Error Response**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
private async handleCameraSwitch(deviceId: string): Promise<void> {
|
private async handleCameraSwitch(deviceId: string): Promise<void> {
|
||||||
try {
|
try {
|
||||||
@@ -460,6 +481,7 @@ The camera switching implementation includes comprehensive error handling:
|
|||||||
The camera system maintains several states:
|
The camera system maintains several states:
|
||||||
|
|
||||||
1. **Camera States**
|
1. **Camera States**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
type CameraState =
|
type CameraState =
|
||||||
| "initializing" // Camera is being initialized
|
| "initializing" // Camera is being initialized
|
||||||
@@ -529,6 +551,7 @@ The camera system maintains several states:
|
|||||||
#### MLKit Barcode Scanner Configuration
|
#### MLKit Barcode Scanner Configuration
|
||||||
|
|
||||||
1. **Plugin Setup**
|
1. **Plugin Setup**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// capacitor.config.ts
|
// capacitor.config.ts
|
||||||
const config: CapacitorConfig = {
|
const config: CapacitorConfig = {
|
||||||
@@ -552,6 +575,7 @@ The camera system maintains several states:
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Camera Management**
|
2. **Camera Management**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// CapacitorQRScanner.ts
|
// CapacitorQRScanner.ts
|
||||||
export class CapacitorQRScanner implements QRScannerService {
|
export class CapacitorQRScanner implements QRScannerService {
|
||||||
@@ -603,6 +627,7 @@ The camera system maintains several states:
|
|||||||
```
|
```
|
||||||
|
|
||||||
3. **Camera State Management**
|
3. **Camera State Management**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// CapacitorQRScanner.ts
|
// CapacitorQRScanner.ts
|
||||||
private async handleCameraState(): Promise<void> {
|
private async handleCameraState(): Promise<void> {
|
||||||
@@ -645,6 +670,7 @@ The camera system maintains several states:
|
|||||||
```
|
```
|
||||||
|
|
||||||
4. **Error Handling**
|
4. **Error Handling**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// CapacitorQRScanner.ts
|
// CapacitorQRScanner.ts
|
||||||
private async handleCameraError(error: Error): Promise<void> {
|
private async handleCameraError(error: Error): Promise<void> {
|
||||||
@@ -737,6 +763,7 @@ The camera system maintains several states:
|
|||||||
#### Performance Optimization
|
#### Performance Optimization
|
||||||
|
|
||||||
1. **Battery Usage**
|
1. **Battery Usage**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// CapacitorQRScanner.ts
|
// CapacitorQRScanner.ts
|
||||||
private optimizeBatteryUsage(): void {
|
private optimizeBatteryUsage(): void {
|
||||||
@@ -759,6 +786,7 @@ The camera system maintains several states:
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Memory Management**
|
2. **Memory Management**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// CapacitorQRScanner.ts
|
// CapacitorQRScanner.ts
|
||||||
private async cleanupResources(): Promise<void> {
|
private async cleanupResources(): Promise<void> {
|
||||||
@@ -802,4 +830,4 @@ The camera system maintains several states:
|
|||||||
- Camera switching speed
|
- Camera switching speed
|
||||||
- QR code detection speed
|
- QR code detection speed
|
||||||
- App responsiveness
|
- App responsiveness
|
||||||
- Background/foreground transitions
|
- Background/foreground transitions
|
||||||
|
|||||||
@@ -111,6 +111,7 @@ export class AbsurdSqlDatabaseService implements PlatformService {
|
|||||||
```
|
```
|
||||||
|
|
||||||
Key features:
|
Key features:
|
||||||
|
|
||||||
- Uses absurd-sql for SQLite in the browser
|
- Uses absurd-sql for SQLite in the browser
|
||||||
- Implements operation queuing for thread safety
|
- Implements operation queuing for thread safety
|
||||||
- Handles initialization and connection management
|
- Handles initialization and connection management
|
||||||
@@ -143,6 +144,7 @@ async function getAccount(did: string): Promise<Account | undefined> {
|
|||||||
When converting from Dexie.js to SQL-based implementation, follow these patterns:
|
When converting from Dexie.js to SQL-based implementation, follow these patterns:
|
||||||
|
|
||||||
1. **Database Access Pattern**
|
1. **Database Access Pattern**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
const result = await db.table.where("field").equals(value).first();
|
const result = await db.table.where("field").equals(value).first();
|
||||||
@@ -161,6 +163,7 @@ When converting from Dexie.js to SQL-based implementation, follow these patterns
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Update Operations**
|
2. **Update Operations**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
await db.table.where("id").equals(id).modify(changes);
|
await db.table.where("id").equals(id).modify(changes);
|
||||||
@@ -184,6 +187,7 @@ When converting from Dexie.js to SQL-based implementation, follow these patterns
|
|||||||
```
|
```
|
||||||
|
|
||||||
3. **Insert Operations**
|
3. **Insert Operations**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
await db.table.add(item);
|
await db.table.add(item);
|
||||||
@@ -202,6 +206,7 @@ When converting from Dexie.js to SQL-based implementation, follow these patterns
|
|||||||
```
|
```
|
||||||
|
|
||||||
4. **Delete Operations**
|
4. **Delete Operations**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
await db.table.where("id").equals(id).delete();
|
await db.table.where("id").equals(id).delete();
|
||||||
@@ -216,6 +221,7 @@ When converting from Dexie.js to SQL-based implementation, follow these patterns
|
|||||||
```
|
```
|
||||||
|
|
||||||
5. **Result Processing**
|
5. **Result Processing**
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
const items = await db.table.toArray();
|
const items = await db.table.toArray();
|
||||||
@@ -247,6 +253,7 @@ await databaseUtil.logConsoleAndDb(message, showInConsole);
|
|||||||
```
|
```
|
||||||
|
|
||||||
Key Considerations:
|
Key Considerations:
|
||||||
|
|
||||||
- Always use `databaseUtil.mapQueryResultToValues()` to process SQL query results
|
- Always use `databaseUtil.mapQueryResultToValues()` to process SQL query results
|
||||||
- Use utility methods from `db/index.ts` when available instead of direct SQL
|
- Use utility methods from `db/index.ts` when available instead of direct SQL
|
||||||
- Keep Dexie fallbacks wrapped in migration period checks
|
- Keep Dexie fallbacks wrapped in migration period checks
|
||||||
@@ -254,6 +261,7 @@ Key Considerations:
|
|||||||
- For updates/inserts/deletes, execute both SQL and Dexie operations during migration period
|
- For updates/inserts/deletes, execute both SQL and Dexie operations during migration period
|
||||||
|
|
||||||
Example Migration:
|
Example Migration:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Before (Dexie)
|
// Before (Dexie)
|
||||||
export async function updateSettings(settings: Settings): Promise<void> {
|
export async function updateSettings(settings: Settings): Promise<void> {
|
||||||
@@ -274,6 +282,7 @@ export async function updateSettings(settings: Settings): Promise<void> {
|
|||||||
```
|
```
|
||||||
|
|
||||||
Remember to:
|
Remember to:
|
||||||
|
|
||||||
- Create database access code to use the platform service, putting it in front of the Dexie version
|
- Create database access code to use the platform service, putting it in front of the Dexie version
|
||||||
- Instead of removing Dexie-specific code, keep it.
|
- Instead of removing Dexie-specific code, keep it.
|
||||||
|
|
||||||
@@ -330,4 +339,4 @@ it's during migration then use that result instead of the SQL code's result.
|
|||||||
4. **Documentation**
|
4. **Documentation**
|
||||||
- Add API documentation
|
- Add API documentation
|
||||||
- Create migration guides
|
- Create migration guides
|
||||||
- Document security measures
|
- Document security measures
|
||||||
|
|||||||
@@ -4,11 +4,13 @@
|
|||||||
## 1. Introduction to SharedArrayBuffer
|
## 1. Introduction to SharedArrayBuffer
|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
- `SharedArrayBuffer` is a JavaScript object that enables **shared memory** access between the main thread and Web Workers.
|
- `SharedArrayBuffer` is a JavaScript object that enables **shared memory** access between the main thread and Web Workers.
|
||||||
- Unlike `ArrayBuffer`, the memory is **not copied** between threads—allowing **true parallelism**.
|
- Unlike `ArrayBuffer`, the memory is **not copied** between threads—allowing **true parallelism**.
|
||||||
- Paired with `Atomics`, it allows low-level memory synchronization (e.g., locks, waits).
|
- Paired with `Atomics`, it allows low-level memory synchronization (e.g., locks, waits).
|
||||||
|
|
||||||
### Example Use
|
### Example Use
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const sab = new SharedArrayBuffer(1024);
|
const sab = new SharedArrayBuffer(1024);
|
||||||
const sharedArray = new Uint8Array(sab);
|
const sharedArray = new Uint8Array(sab);
|
||||||
@@ -18,6 +20,7 @@ sharedArray[0] = 42;
|
|||||||
## 2. Browser Security Requirements
|
## 2. Browser Security Requirements
|
||||||
|
|
||||||
### Security Headers Required to Use SharedArrayBuffer
|
### Security Headers Required to Use SharedArrayBuffer
|
||||||
|
|
||||||
Modern browsers **restrict access** to `SharedArrayBuffer` due to Spectre-class vulnerabilities.
|
Modern browsers **restrict access** to `SharedArrayBuffer` due to Spectre-class vulnerabilities.
|
||||||
|
|
||||||
The following **HTTP headers must be set** to enable it:
|
The following **HTTP headers must be set** to enable it:
|
||||||
@@ -28,23 +31,28 @@ Cross-Origin-Embedder-Policy: require-corp
|
|||||||
```
|
```
|
||||||
|
|
||||||
### HTTPS Requirement
|
### HTTPS Requirement
|
||||||
|
|
||||||
- Must be served over **HTTPS** (except `localhost` for dev).
|
- Must be served over **HTTPS** (except `localhost` for dev).
|
||||||
- These headers enforce **cross-origin isolation**.
|
- These headers enforce **cross-origin isolation**.
|
||||||
|
|
||||||
### Role of CORS
|
### Role of CORS
|
||||||
|
|
||||||
- CORS **alone is not sufficient**.
|
- CORS **alone is not sufficient**.
|
||||||
- However, embedded resources (like scripts and iframes) must still include proper CORS headers if they are to be loaded in a cross-origin isolated context.
|
- However, embedded resources (like scripts and iframes) must still include proper CORS headers if they are to be loaded in a cross-origin isolated context.
|
||||||
|
|
||||||
## 3. Spectre Vulnerability
|
## 3. Spectre Vulnerability
|
||||||
|
|
||||||
### What is Spectre?
|
### What is Spectre?
|
||||||
|
|
||||||
- A class of **side-channel attacks** exploiting **speculative execution** in CPUs.
|
- A class of **side-channel attacks** exploiting **speculative execution** in CPUs.
|
||||||
- Allows an attacker to read arbitrary memory from the same address space.
|
- Allows an attacker to read arbitrary memory from the same address space.
|
||||||
|
|
||||||
### Affected Architectures
|
### Affected Architectures
|
||||||
|
|
||||||
- Intel, AMD, ARM — essentially **all modern processors**.
|
- Intel, AMD, ARM — essentially **all modern processors**.
|
||||||
|
|
||||||
### Why It's Still a Concern
|
### Why It's Still a Concern
|
||||||
|
|
||||||
- It's a **hardware flaw**, not just a software bug.
|
- It's a **hardware flaw**, not just a software bug.
|
||||||
- Can't be fully fixed in software without performance penalties.
|
- Can't be fully fixed in software without performance penalties.
|
||||||
- New Spectre **variants** (e.g., v2, RSB, BranchScope) continue to emerge.
|
- New Spectre **variants** (e.g., v2, RSB, BranchScope) continue to emerge.
|
||||||
@@ -52,16 +60,19 @@ Cross-Origin-Embedder-Policy: require-corp
|
|||||||
## 4. Mitigations and Current Limitations
|
## 4. Mitigations and Current Limitations
|
||||||
|
|
||||||
### Browser Mitigations
|
### Browser Mitigations
|
||||||
|
|
||||||
- **Restricted precision** for `performance.now()`.
|
- **Restricted precision** for `performance.now()`.
|
||||||
- **Disabled or gated** access to `SharedArrayBuffer`.
|
- **Disabled or gated** access to `SharedArrayBuffer`.
|
||||||
- **Reduced or removed** fine-grained timers.
|
- **Reduced or removed** fine-grained timers.
|
||||||
|
|
||||||
### OS/Hardware Mitigations
|
### OS/Hardware Mitigations
|
||||||
|
|
||||||
- **Kernel Page Table Isolation (KPTI)**
|
- **Kernel Page Table Isolation (KPTI)**
|
||||||
- **Microcode updates**
|
- **Microcode updates**
|
||||||
- **Retpoline** compiler mitigations
|
- **Retpoline** compiler mitigations
|
||||||
|
|
||||||
### Developer Responsibilities
|
### Developer Responsibilities
|
||||||
|
|
||||||
- Avoid sharing sensitive data across threads unless necessary.
|
- Avoid sharing sensitive data across threads unless necessary.
|
||||||
- Use **constant-time cryptographic functions**.
|
- Use **constant-time cryptographic functions**.
|
||||||
- Assume timing attacks are **still possible**.
|
- Assume timing attacks are **still possible**.
|
||||||
@@ -70,10 +81,12 @@ Cross-Origin-Embedder-Policy: require-corp
|
|||||||
## 5. Practical Development Notes
|
## 5. Practical Development Notes
|
||||||
|
|
||||||
### Using SharedArrayBuffer Safely
|
### Using SharedArrayBuffer Safely
|
||||||
|
|
||||||
- Ensure the site is **cross-origin isolated**:
|
- Ensure the site is **cross-origin isolated**:
|
||||||
- Serve all resources with appropriate **CORS policies** (`Cross-Origin-Resource-Policy`, `Access-Control-Allow-Origin`)
|
- Serve all resources with appropriate **CORS policies** (`Cross-Origin-Resource-Policy`, `Access-Control-Allow-Origin`)
|
||||||
- Set the required **COOP/COEP headers**
|
- Set the required **COOP/COEP headers**
|
||||||
- Validate support using:
|
- Validate support using:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
if (window.crossOriginIsolated) {
|
if (window.crossOriginIsolated) {
|
||||||
// Safe to use SharedArrayBuffer
|
// Safe to use SharedArrayBuffer
|
||||||
@@ -81,6 +94,7 @@ if (window.crossOriginIsolated) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Testing and Fallback
|
### Testing and Fallback
|
||||||
|
|
||||||
- Provide fallbacks to `ArrayBuffer` if isolation is not available.
|
- Provide fallbacks to `ArrayBuffer` if isolation is not available.
|
||||||
- Document use cases clearly (e.g., high-performance WebAssembly applications or real-time audio/video processing).
|
- Document use cases clearly (e.g., high-performance WebAssembly applications or real-time audio/video processing).
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
## Core Services
|
## Core Services
|
||||||
|
|
||||||
### 1. Storage Service Layer
|
### 1. Storage Service Layer
|
||||||
|
|
||||||
- [x] Create base `PlatformService` interface
|
- [x] Create base `PlatformService` interface
|
||||||
- [x] Define common methods for all platforms
|
- [x] Define common methods for all platforms
|
||||||
- [x] Add platform-specific method signatures
|
- [x] Add platform-specific method signatures
|
||||||
@@ -25,6 +26,7 @@
|
|||||||
- [ ] File system access
|
- [ ] File system access
|
||||||
|
|
||||||
### 2. Migration Services
|
### 2. Migration Services
|
||||||
|
|
||||||
- [x] Implement basic migration support
|
- [x] Implement basic migration support
|
||||||
- [x] Dual-storage pattern (SQLite + Dexie)
|
- [x] Dual-storage pattern (SQLite + Dexie)
|
||||||
- [x] Basic data verification
|
- [x] Basic data verification
|
||||||
@@ -37,6 +39,7 @@
|
|||||||
- [ ] Manual triggers
|
- [ ] Manual triggers
|
||||||
|
|
||||||
### 3. Security Layer
|
### 3. Security Layer
|
||||||
|
|
||||||
- [x] Basic data integrity
|
- [x] Basic data integrity
|
||||||
- [ ] Implement `EncryptionService` (planned)
|
- [ ] Implement `EncryptionService` (planned)
|
||||||
- [ ] Key management
|
- [ ] Key management
|
||||||
@@ -50,14 +53,17 @@
|
|||||||
## Platform-Specific Implementation
|
## Platform-Specific Implementation
|
||||||
|
|
||||||
### Web Platform
|
### Web Platform
|
||||||
|
|
||||||
- [x] Setup absurd-sql
|
- [x] Setup absurd-sql
|
||||||
- [x] Install dependencies
|
- [x] Install dependencies
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"@jlongster/sql.js": "^1.8.0",
|
"@jlongster/sql.js": "^1.8.0",
|
||||||
"absurd-sql": "^1.8.0"
|
"absurd-sql": "^1.8.0"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- [x] Configure VFS with IndexedDB backend
|
- [x] Configure VFS with IndexedDB backend
|
||||||
- [x] Setup worker threads
|
- [x] Setup worker threads
|
||||||
- [x] Implement operation queuing
|
- [x] Implement operation queuing
|
||||||
@@ -83,6 +89,7 @@
|
|||||||
- [x] Implement atomic operations
|
- [x] Implement atomic operations
|
||||||
|
|
||||||
### iOS Platform (Planned)
|
### iOS Platform (Planned)
|
||||||
|
|
||||||
- [ ] Setup SQLCipher
|
- [ ] Setup SQLCipher
|
||||||
- [ ] Install pod dependencies
|
- [ ] Install pod dependencies
|
||||||
- [ ] Configure encryption
|
- [ ] Configure encryption
|
||||||
@@ -96,6 +103,7 @@
|
|||||||
- [ ] Setup app groups
|
- [ ] Setup app groups
|
||||||
|
|
||||||
### Android Platform (Planned)
|
### Android Platform (Planned)
|
||||||
|
|
||||||
- [ ] Setup SQLCipher
|
- [ ] Setup SQLCipher
|
||||||
- [ ] Add Gradle dependencies
|
- [ ] Add Gradle dependencies
|
||||||
- [ ] Configure encryption
|
- [ ] Configure encryption
|
||||||
@@ -109,6 +117,7 @@
|
|||||||
- [ ] Setup file provider
|
- [ ] Setup file provider
|
||||||
|
|
||||||
### Electron Platform (Planned)
|
### Electron Platform (Planned)
|
||||||
|
|
||||||
- [ ] Setup Node SQLite
|
- [ ] Setup Node SQLite
|
||||||
- [ ] Install dependencies
|
- [ ] Install dependencies
|
||||||
- [ ] Configure IPC
|
- [ ] Configure IPC
|
||||||
@@ -124,6 +133,7 @@
|
|||||||
## Data Models and Types
|
## Data Models and Types
|
||||||
|
|
||||||
### 1. Database Schema
|
### 1. Database Schema
|
||||||
|
|
||||||
- [x] Define tables
|
- [x] Define tables
|
||||||
|
|
||||||
```sql
|
```sql
|
||||||
@@ -166,6 +176,7 @@
|
|||||||
### 2. Type Definitions
|
### 2. Type Definitions
|
||||||
|
|
||||||
- [x] Create interfaces
|
- [x] Create interfaces
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface Account {
|
interface Account {
|
||||||
did: string;
|
did: string;
|
||||||
@@ -197,6 +208,7 @@
|
|||||||
## UI Components
|
## UI Components
|
||||||
|
|
||||||
### 1. Migration UI (Planned)
|
### 1. Migration UI (Planned)
|
||||||
|
|
||||||
- [ ] Create components
|
- [ ] Create components
|
||||||
- [ ] `MigrationProgress.vue`
|
- [ ] `MigrationProgress.vue`
|
||||||
- [ ] `MigrationError.vue`
|
- [ ] `MigrationError.vue`
|
||||||
@@ -204,6 +216,7 @@
|
|||||||
- [ ] `MigrationStatus.vue`
|
- [ ] `MigrationStatus.vue`
|
||||||
|
|
||||||
### 2. Settings UI (Planned)
|
### 2. Settings UI (Planned)
|
||||||
|
|
||||||
- [ ] Update components
|
- [ ] Update components
|
||||||
- [ ] Add storage settings
|
- [ ] Add storage settings
|
||||||
- [ ] Add migration controls
|
- [ ] Add migration controls
|
||||||
@@ -211,6 +224,7 @@
|
|||||||
- [ ] Add security settings
|
- [ ] Add security settings
|
||||||
|
|
||||||
### 3. Error Handling UI (Planned)
|
### 3. Error Handling UI (Planned)
|
||||||
|
|
||||||
- [ ] Create components
|
- [ ] Create components
|
||||||
- [ ] `StorageError.vue`
|
- [ ] `StorageError.vue`
|
||||||
- [ ] `QuotaExceeded.vue`
|
- [ ] `QuotaExceeded.vue`
|
||||||
@@ -220,6 +234,7 @@
|
|||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
### 1. Unit Tests
|
### 1. Unit Tests
|
||||||
|
|
||||||
- [x] Basic service tests
|
- [x] Basic service tests
|
||||||
- [x] Platform service tests
|
- [x] Platform service tests
|
||||||
- [x] Database operation tests
|
- [x] Database operation tests
|
||||||
@@ -227,6 +242,7 @@
|
|||||||
- [ ] Platform detection tests (planned)
|
- [ ] Platform detection tests (planned)
|
||||||
|
|
||||||
### 2. Integration Tests (Planned)
|
### 2. Integration Tests (Planned)
|
||||||
|
|
||||||
- [ ] Test migrations
|
- [ ] Test migrations
|
||||||
- [ ] Web platform tests
|
- [ ] Web platform tests
|
||||||
- [ ] iOS platform tests
|
- [ ] iOS platform tests
|
||||||
@@ -234,6 +250,7 @@
|
|||||||
- [ ] Electron platform tests
|
- [ ] Electron platform tests
|
||||||
|
|
||||||
### 3. E2E Tests (Planned)
|
### 3. E2E Tests (Planned)
|
||||||
|
|
||||||
- [ ] Test workflows
|
- [ ] Test workflows
|
||||||
- [ ] Account management
|
- [ ] Account management
|
||||||
- [ ] Settings management
|
- [ ] Settings management
|
||||||
@@ -243,12 +260,14 @@
|
|||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
### 1. Technical Documentation
|
### 1. Technical Documentation
|
||||||
|
|
||||||
- [x] Update architecture docs
|
- [x] Update architecture docs
|
||||||
- [x] Add API documentation
|
- [x] Add API documentation
|
||||||
- [ ] Create migration guides (planned)
|
- [ ] Create migration guides (planned)
|
||||||
- [ ] Document security measures (planned)
|
- [ ] Document security measures (planned)
|
||||||
|
|
||||||
### 2. User Documentation (Planned)
|
### 2. User Documentation (Planned)
|
||||||
|
|
||||||
- [ ] Update user guides
|
- [ ] Update user guides
|
||||||
- [ ] Add troubleshooting guides
|
- [ ] Add troubleshooting guides
|
||||||
- [ ] Create FAQ
|
- [ ] Create FAQ
|
||||||
@@ -257,12 +276,14 @@
|
|||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
### 1. Build Process
|
### 1. Build Process
|
||||||
|
|
||||||
- [x] Update build scripts
|
- [x] Update build scripts
|
||||||
- [x] Add platform-specific builds
|
- [x] Add platform-specific builds
|
||||||
- [ ] Configure CI/CD (planned)
|
- [ ] Configure CI/CD (planned)
|
||||||
- [ ] Setup automated testing (planned)
|
- [ ] Setup automated testing (planned)
|
||||||
|
|
||||||
### 2. Release Process (Planned)
|
### 2. Release Process (Planned)
|
||||||
|
|
||||||
- [ ] Create release checklist
|
- [ ] Create release checklist
|
||||||
- [ ] Add version management
|
- [ ] Add version management
|
||||||
- [ ] Setup rollback procedures
|
- [ ] Setup rollback procedures
|
||||||
@@ -271,12 +292,14 @@
|
|||||||
## Monitoring and Analytics (Planned)
|
## Monitoring and Analytics (Planned)
|
||||||
|
|
||||||
### 1. Error Tracking
|
### 1. Error Tracking
|
||||||
|
|
||||||
- [ ] Setup error logging
|
- [ ] Setup error logging
|
||||||
- [ ] Add performance monitoring
|
- [ ] Add performance monitoring
|
||||||
- [ ] Configure alerts
|
- [ ] Configure alerts
|
||||||
- [ ] Create dashboards
|
- [ ] Create dashboards
|
||||||
|
|
||||||
### 2. Usage Analytics
|
### 2. Usage Analytics
|
||||||
|
|
||||||
- [ ] Add storage metrics
|
- [ ] Add storage metrics
|
||||||
- [ ] Track migration success
|
- [ ] Track migration success
|
||||||
- [ ] Monitor performance
|
- [ ] Monitor performance
|
||||||
@@ -285,12 +308,14 @@
|
|||||||
## Security Audit (Planned)
|
## Security Audit (Planned)
|
||||||
|
|
||||||
### 1. Code Review
|
### 1. Code Review
|
||||||
|
|
||||||
- [ ] Review encryption
|
- [ ] Review encryption
|
||||||
- [ ] Check access controls
|
- [ ] Check access controls
|
||||||
- [ ] Verify data handling
|
- [ ] Verify data handling
|
||||||
- [ ] Audit dependencies
|
- [ ] Audit dependencies
|
||||||
|
|
||||||
### 2. Penetration Testing
|
### 2. Penetration Testing
|
||||||
|
|
||||||
- [ ] Test data access
|
- [ ] Test data access
|
||||||
- [ ] Verify encryption
|
- [ ] Verify encryption
|
||||||
- [ ] Check authentication
|
- [ ] Check authentication
|
||||||
@@ -299,6 +324,7 @@
|
|||||||
## Success Criteria
|
## Success Criteria
|
||||||
|
|
||||||
### 1. Performance
|
### 1. Performance
|
||||||
|
|
||||||
- [x] Query response time < 100ms
|
- [x] Query response time < 100ms
|
||||||
- [x] Operation queuing for thread safety
|
- [x] Operation queuing for thread safety
|
||||||
- [x] Proper initialization handling
|
- [x] Proper initialization handling
|
||||||
@@ -307,6 +333,7 @@
|
|||||||
- [ ] Memory usage < 50MB (planned)
|
- [ ] Memory usage < 50MB (planned)
|
||||||
|
|
||||||
### 2. Reliability
|
### 2. Reliability
|
||||||
|
|
||||||
- [x] Basic data integrity
|
- [x] Basic data integrity
|
||||||
- [x] Operation queuing
|
- [x] Operation queuing
|
||||||
- [ ] Automatic recovery (planned)
|
- [ ] Automatic recovery (planned)
|
||||||
@@ -315,6 +342,7 @@
|
|||||||
- [ ] Data consistency (planned)
|
- [ ] Data consistency (planned)
|
||||||
|
|
||||||
### 3. Security
|
### 3. Security
|
||||||
|
|
||||||
- [x] Basic data integrity
|
- [x] Basic data integrity
|
||||||
- [ ] AES-256 encryption (planned)
|
- [ ] AES-256 encryption (planned)
|
||||||
- [ ] Secure key storage (planned)
|
- [ ] Secure key storage (planned)
|
||||||
@@ -322,8 +350,9 @@
|
|||||||
- [ ] Audit logging (planned)
|
- [ ] Audit logging (planned)
|
||||||
|
|
||||||
### 4. User Experience
|
### 4. User Experience
|
||||||
|
|
||||||
- [x] Basic database operations
|
- [x] Basic database operations
|
||||||
- [ ] Smooth migration (planned)
|
- [ ] Smooth migration (planned)
|
||||||
- [ ] Clear error messages (planned)
|
- [ ] Clear error messages (planned)
|
||||||
- [ ] Progress indicators (planned)
|
- [ ] Progress indicators (planned)
|
||||||
- [ ] Recovery options (planned)
|
- [ ] Recovery options (planned)
|
||||||
|
|||||||
@@ -53,10 +53,9 @@ header-includes:
|
|||||||
|
|
||||||
\clearpage
|
\clearpage
|
||||||
|
|
||||||
|
|
||||||
# Purpose of Document
|
# Purpose of Document
|
||||||
|
|
||||||
Both end-users and development team members need to know how to use TimeSafari.
|
Both end-users and development team members need to know how to use TimeSafari.
|
||||||
This document serves to show how to use every feature of the TimeSafari platform.
|
This document serves to show how to use every feature of the TimeSafari platform.
|
||||||
|
|
||||||
Sections of this document are geared specifically for software developers and quality assurance
|
Sections of this document are geared specifically for software developers and quality assurance
|
||||||
@@ -64,7 +63,7 @@ team members.
|
|||||||
|
|
||||||
Companion videos will also describe end-to-end workflows for the end-user.
|
Companion videos will also describe end-to-end workflows for the end-user.
|
||||||
|
|
||||||
# TimeSafari
|
# TimeSafari
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -90,49 +89,51 @@ development environment. This section will guide you through the process.
|
|||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. Have the following installed on your local machine:
|
1. Have the following installed on your local machine:
|
||||||
- Node.js and NPM
|
|
||||||
- A web browser. For this guide, we will use Google Chrome.
|
- Node.js and NPM
|
||||||
- Git
|
- A web browser. For this guide, we will use Google Chrome.
|
||||||
- A code editor
|
- Git
|
||||||
|
- A code editor
|
||||||
|
|
||||||
2. Create an API key on Infura. This is necessary for the Endorser API to connect to the Ethereum
|
2. Create an API key on Infura. This is necessary for the Endorser API to connect to the Ethereum
|
||||||
blockchain.
|
blockchain.
|
||||||
- You can create an account on Infura [here](https://infura.io/).\
|
|
||||||
|
- You can create an account on Infura [here](https://infura.io/).\
|
||||||
Click "CREATE NEW API KEY" and label the key. Then click "API Keys" in the top menu bar to
|
Click "CREATE NEW API KEY" and label the key. Then click "API Keys" in the top menu bar to
|
||||||
be taken back to the list of keys.
|
be taken back to the list of keys.
|
||||||
|
|
||||||
Click "VIEW STATS" on the key you want to use.
|
Click "VIEW STATS" on the key you want to use.
|
||||||
|
|
||||||
{ width=550px }
|
{ width=550px }
|
||||||
|
|
||||||
- Go to the key detail page. Then click "MANAGE API KEY".
|
- Go to the key detail page. Then click "MANAGE API KEY".
|
||||||
|
|
||||||
{ width=550px }
|
{ width=550px }
|
||||||
|
|
||||||
- Click the copy and paste button next to the string of alphanumeric characters.\
|
- Click the copy and paste button next to the string of alphanumeric characters.\
|
||||||
This is your API, also known as your project ID.
|
This is your API, also known as your project ID.
|
||||||
|
|
||||||
{width=550px }
|
{width=550px }
|
||||||
|
|
||||||
- Save this for later during the Endorser API setup. This will go in your `INFURA_PROJECT_ID`
|
- Save this for later during the Endorser API setup. This will go in your `INFURA_PROJECT_ID`
|
||||||
environment variable.
|
environment variable.
|
||||||
|
|
||||||
|
|
||||||
## Setup steps
|
## Setup steps
|
||||||
|
|
||||||
### 1. Clone the following repositories from their respective Git hosts:
|
### 1. Clone the following repositories from their respective Git hosts
|
||||||
- [TimeSafari Frontend](https://gitea.anomalistdesign.com/trent_larson/crowd-funder-for-time-pwa)\
|
|
||||||
|
- [TimeSafari Frontend](https://gitea.anomalistdesign.com/trent_larson/crowd-funder-for-time-pwa)\
|
||||||
This is a Progressive Web App (PWA) built with VueJS and TypeScript.
|
This is a Progressive Web App (PWA) built with VueJS and TypeScript.
|
||||||
Note that the clone command here is different from the one you would use for GitHub.
|
Note that the clone command here is different from the one you would use for GitHub.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone git clone \
|
git clone git clone \
|
||||||
ssh://git@gitea.anomalistdesign.com:222/trent_larson/crowd-funder-for-time-pwa.git
|
ssh://git@gitea.anomalistdesign.com:222/trent_larson/crowd-funder-for-time-pwa.git
|
||||||
```
|
```
|
||||||
|
|
||||||
- [TimeSafari Backend - Endorser API](https://github.com/trentlarson/endorser-ch)\
|
- [TimeSafari Backend - Endorser API](https://github.com/trentlarson/endorser-ch)\
|
||||||
This is a NodeJS service providing the backend for TimeSafari.
|
This is a NodeJS service providing the backend for TimeSafari.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone git@github.com:trentlarson/endorser-ch.git
|
git clone git@github.com:trentlarson/endorser-ch.git
|
||||||
```
|
```
|
||||||
@@ -148,7 +149,7 @@ below to generate sample data. Then copy the test database, rename it to `-dev`
|
|||||||
`cp ../endorser-ch-test-local.sqlite3 ../endorser-ch-dev.sqlite3` \
|
`cp ../endorser-ch-test-local.sqlite3 ../endorser-ch-dev.sqlite3` \
|
||||||
and rerun `npm run dev` to give yourself user #0 and others from the ETHR_CRED_DATA in [the endorser.ch test util file](https://github.com/trentlarson/endorser-ch/blob/master/test/util.js#L90)
|
and rerun `npm run dev` to give yourself user #0 and others from the ETHR_CRED_DATA in [the endorser.ch test util file](https://github.com/trentlarson/endorser-ch/blob/master/test/util.js#L90)
|
||||||
|
|
||||||
#### Alternative 2 - boostrap single seed user
|
#### Alternative 2 - boostrap single seed user
|
||||||
|
|
||||||
In this method you will end up with two accounts in the database, one for the first boostrap user,
|
In this method you will end up with two accounts in the database, one for the first boostrap user,
|
||||||
and the second as the primary user you will use during testing. The first user will invite the
|
and the second as the primary user you will use during testing. The first user will invite the
|
||||||
@@ -157,26 +158,30 @@ second user to the app.
|
|||||||
1. Install dependencies and environment variables.\
|
1. Install dependencies and environment variables.\
|
||||||
In endorser-ch install dependencies and set up environment variables to allow starting it up in
|
In endorser-ch install dependencies and set up environment variables to allow starting it up in
|
||||||
development mode.
|
development mode.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd endorser-ch
|
cd endorser-ch
|
||||||
npm clean install # or npm ci
|
npm clean install # or npm ci
|
||||||
cp .env.local .env
|
cp .env.local .env
|
||||||
```
|
```
|
||||||
|
|
||||||
Edit the .env file's INFURA_PROJECT_ID with the value you saved earlier in the
|
Edit the .env file's INFURA_PROJECT_ID with the value you saved earlier in the
|
||||||
prerequisites.\
|
prerequisites.\
|
||||||
Then create the SQLite database by running `npm run flyway migrate` with environment variables
|
Then create the SQLite database by running `npm run flyway migrate` with environment variables
|
||||||
set correctly to select the default SQLite development user as follows.
|
set correctly to select the default SQLite development user as follows.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export NODE_ENV=dev
|
export NODE_ENV=dev
|
||||||
export DBUSER=sa
|
export DBUSER=sa
|
||||||
export DBPASS=sasa
|
export DBPASS=sasa
|
||||||
npm run flyway migrate
|
npm run flyway migrate
|
||||||
```
|
```
|
||||||
The first run of flyway migrate may take some time to complete because the entire Flyway
|
|
||||||
|
The first run of flyway migrate may take some time to complete because the entire Flyway
|
||||||
distribution must be downloaded prior to executing migrations.
|
distribution must be downloaded prior to executing migrations.
|
||||||
|
|
||||||
Successful output looks similar to the following:
|
Successful output looks similar to the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
Database: jdbc:sqlite:../endorser-ch-dev.sqlite3 (SQLite 3.41)
|
Database: jdbc:sqlite:../endorser-ch-dev.sqlite3 (SQLite 3.41)
|
||||||
Schema history table "main"."flyway_schema_history" does not exist yet
|
Schema history table "main"."flyway_schema_history" does not exist yet
|
||||||
@@ -202,23 +207,23 @@ A Flyway report has been generated here: /Users/kbull/code/timesafari/endorser-c
|
|||||||
2. Generate the first user in TimeSafari PWA and bootstrap that user in Endorser's database.\
|
2. Generate the first user in TimeSafari PWA and bootstrap that user in Endorser's database.\
|
||||||
As TimeSafari is an invite-only platform the first user must be manually bootstrapped since
|
As TimeSafari is an invite-only platform the first user must be manually bootstrapped since
|
||||||
no other users exist to be able to invite the first user. This first user must be added manually
|
no other users exist to be able to invite the first user. This first user must be added manually
|
||||||
to the SQLite database used by Endorser. In this setup you generate the first user from the PWA.
|
to the SQLite database used by Endorser. In this setup you generate the first user from the PWA.
|
||||||
|
|
||||||
This user is automatically generated on first usage of the TimeSafari PWA. Bootstrapping that
|
This user is automatically generated on first usage of the TimeSafari PWA. Bootstrapping that
|
||||||
user is required so that this first user can register other users.
|
user is required so that this first user can register other users.
|
||||||
- Change directories into `crowd-funder-for-time-pwa`
|
- Change directories into `crowd-funder-for-time-pwa`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd ..
|
cd ..
|
||||||
cd crowd-funder-for-time-pwa
|
cd crowd-funder-for-time-pwa
|
||||||
```
|
```
|
||||||
|
|
||||||
- Ensure the `.env.development` file exists and has the following values:
|
- Ensure the `.env.development` file exists and has the following values:
|
||||||
|
|
||||||
```env
|
```env
|
||||||
VITE_DEFAULT_ENDORSER_API_SERVER=http://127.0.0.1:3000
|
VITE_DEFAULT_ENDORSER_API_SERVER=http://127.0.0.1:3000
|
||||||
```
|
```
|
||||||
|
|
||||||
- Install dependencies and run in dev mode. For now don't worry about configuring the app. All we
|
- Install dependencies and run in dev mode. For now don't worry about configuring the app. All we
|
||||||
need is to generate the first root user and this happens automatically on app startup.
|
need is to generate the first root user and this happens automatically on app startup.
|
||||||
|
|
||||||
@@ -230,45 +235,45 @@ A Flyway report has been generated here: /Users/kbull/code/timesafari/endorser-c
|
|||||||
- Open the app in a browser and go to the developer tools. It is recommended to use a completely
|
- Open the app in a browser and go to the developer tools. It is recommended to use a completely
|
||||||
separate browser profile so you do not clear out your existing user account. We will be
|
separate browser profile so you do not clear out your existing user account. We will be
|
||||||
completely resetting the PWA app state prior to generating the first user.
|
completely resetting the PWA app state prior to generating the first user.
|
||||||
|
|
||||||
In the Developer Tools go to the Application tab.
|
In the Developer Tools go to the Application tab.
|
||||||
|
|
||||||
{width=350px}
|
{width=350px}
|
||||||
|
|
||||||
Click the "Clear site data" button and then refresh the page.
|
Click the "Clear site data" button and then refresh the page.
|
||||||
|
|
||||||
- Click the account button in the bottom right corner of the page.
|
- Click the account button in the bottom right corner of the page.
|
||||||
|
|
||||||
{width=150px}
|
{width=150px}
|
||||||
|
|
||||||
- This will take you to the account page titled "Your Identity" on which you can see your DID,
|
- This will take you to the account page titled "Your Identity" on which you can see your DID,
|
||||||
a `did:ethr` DID in this case.
|
a `did:ethr` DID in this case.
|
||||||
|
|
||||||
{width=350px}
|
{width=350px}
|
||||||
|
|
||||||
- Copy the DID by selecting it and copying it to the clipboard or by clicking the copy and paste
|
- Copy the DID by selecting it and copying it to the clipboard or by clicking the copy and paste
|
||||||
button as shown in the image.
|
button as shown in the image.
|
||||||
|
|
||||||
{width=200px}
|
{width=200px}
|
||||||
|
|
||||||
In our case this DID is:\
|
In our case this DID is:\
|
||||||
`did:ethr:0xe4B783c74c8B0e229524e44d0cD898D272E02CD6`
|
`did:ethr:0xe4B783c74c8B0e229524e44d0cD898D272E02CD6`
|
||||||
|
|
||||||
- Add that DID to the following echoed SQL statement where it says `YOUR_DID`
|
- Add that DID to the following echoed SQL statement where it says `YOUR_DID`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
echo "INSERT INTO registration (did, maxClaims, maxRegs, epoch)
|
echo "INSERT INTO registration (did, maxClaims, maxRegs, epoch)
|
||||||
VALUES ('YOUR_DID', 100, 10000, 1719348718092);"
|
VALUES ('YOUR_DID', 100, 10000, 1719348718092);"
|
||||||
| sqlite3 ./endorser-ch-dev.sqlite3
|
| sqlite3 ./endorser-ch-dev.sqlite3
|
||||||
```
|
```
|
||||||
|
|
||||||
and run this command in the parent directory just above the `endorser-ch` directory.
|
and run this command in the parent directory just above the `endorser-ch` directory.
|
||||||
|
|
||||||
It needs to be the parent directory of your `endorser-ch` repository because when
|
It needs to be the parent directory of your `endorser-ch` repository because when
|
||||||
`endorser-ch` creates the SQLite database it depends on it creates it in the parent directory
|
`endorser-ch` creates the SQLite database it depends on it creates it in the parent directory
|
||||||
of `endorser-ch`.
|
of `endorser-ch`.
|
||||||
|
|
||||||
- You can verify with an SQL browser tool that your record has been added to the `registration`
|
- You can verify with an SQL browser tool that your record has been added to the `registration`
|
||||||
table.
|
table.
|
||||||
|
|
||||||
{width=350px}
|
{width=350px}
|
||||||
@@ -285,14 +290,14 @@ A Flyway report has been generated here: /Users/kbull/code/timesafari/endorser-c
|
|||||||
4. Create the second user by opening up a separate browser profile or incognito session, opening the
|
4. Create the second user by opening up a separate browser profile or incognito session, opening the
|
||||||
TimeSafari PWA at `http://localhost:8080`. You will see the yellow banner stating "Someone must
|
TimeSafari PWA at `http://localhost:8080`. You will see the yellow banner stating "Someone must
|
||||||
register you before you can give or offer."
|
register you before you can give or offer."
|
||||||
|
|
||||||
{width=350px}
|
{width=350px}
|
||||||
|
|
||||||
- If you want to ensure you have a fresh user account then open the developer tools, clear the
|
- If you want to ensure you have a fresh user account then open the developer tools, clear the
|
||||||
Application data as before, and then refresh the page. This will generate a new user in the
|
Application data as before, and then refresh the page. This will generate a new user in the
|
||||||
browser's IndexedDB database.
|
browser's IndexedDB database.
|
||||||
5. Go to the second users' account page to copy the DID.
|
5. Go to the second users' account page to copy the DID.
|
||||||
|
|
||||||
{width=350px}
|
{width=350px}
|
||||||
|
|
||||||
6. Copy the DID and put it in the text bar on the "Your Contacts" page for the first account
|
6. Copy the DID and put it in the text bar on the "Your Contacts" page for the first account
|
||||||
|
|||||||
@@ -155,6 +155,7 @@ VITE_PASSKEYS_ENABLED=true
|
|||||||
## Build Modes
|
## Build Modes
|
||||||
|
|
||||||
### Development Mode
|
### Development Mode
|
||||||
|
|
||||||
- **Target**: `development`
|
- **Target**: `development`
|
||||||
- **Features**: Hot reloading, development server
|
- **Features**: Hot reloading, development server
|
||||||
- **Port**: 5173
|
- **Port**: 5173
|
||||||
@@ -168,6 +169,7 @@ docker build --target development -t timesafari:dev .
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Staging Mode
|
### Staging Mode
|
||||||
|
|
||||||
- **Target**: `staging`
|
- **Target**: `staging`
|
||||||
- **Features**: Production build with relaxed caching
|
- **Features**: Production build with relaxed caching
|
||||||
- **Port**: 8080 (mapped from 80)
|
- **Port**: 8080 (mapped from 80)
|
||||||
@@ -181,6 +183,7 @@ docker build --build-arg BUILD_MODE=staging -t timesafari:staging .
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Production Mode
|
### Production Mode
|
||||||
|
|
||||||
- **Target**: `production`
|
- **Target**: `production`
|
||||||
- **Features**: Optimized production build
|
- **Features**: Optimized production build
|
||||||
- **Port**: 80
|
- **Port**: 80
|
||||||
@@ -194,6 +197,7 @@ docker build -t timesafari:latest .
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Custom Mode
|
### Custom Mode
|
||||||
|
|
||||||
- **Target**: Configurable via `BUILD_TARGET`
|
- **Target**: Configurable via `BUILD_TARGET`
|
||||||
- **Features**: Fully configurable
|
- **Features**: Fully configurable
|
||||||
- **Port**: Configurable via `CUSTOM_PORT`
|
- **Port**: Configurable via `CUSTOM_PORT`
|
||||||
@@ -250,6 +254,7 @@ docker-compose up staging
|
|||||||
## Security Features
|
## Security Features
|
||||||
|
|
||||||
### Built-in Security
|
### Built-in Security
|
||||||
|
|
||||||
- **Non-root user execution**: All containers run as non-root users
|
- **Non-root user execution**: All containers run as non-root users
|
||||||
- **Security headers**: XSS protection, content type options, frame options
|
- **Security headers**: XSS protection, content type options, frame options
|
||||||
- **Rate limiting**: API request rate limiting
|
- **Rate limiting**: API request rate limiting
|
||||||
@@ -257,6 +262,7 @@ docker-compose up staging
|
|||||||
- **Minimal attack surface**: Alpine Linux base images
|
- **Minimal attack surface**: Alpine Linux base images
|
||||||
|
|
||||||
### Security Headers
|
### Security Headers
|
||||||
|
|
||||||
- `X-Frame-Options: SAMEORIGIN`
|
- `X-Frame-Options: SAMEORIGIN`
|
||||||
- `X-Content-Type-Options: nosniff`
|
- `X-Content-Type-Options: nosniff`
|
||||||
- `X-XSS-Protection: 1; mode=block`
|
- `X-XSS-Protection: 1; mode=block`
|
||||||
@@ -266,17 +272,20 @@ docker-compose up staging
|
|||||||
## Performance Optimizations
|
## Performance Optimizations
|
||||||
|
|
||||||
### Caching Strategy
|
### Caching Strategy
|
||||||
|
|
||||||
- **Static assets**: 1 year cache with immutable flag (production)
|
- **Static assets**: 1 year cache with immutable flag (production)
|
||||||
- **HTML files**: 1 hour cache (production) / no cache (staging)
|
- **HTML files**: 1 hour cache (production) / no cache (staging)
|
||||||
- **Service worker**: No cache
|
- **Service worker**: No cache
|
||||||
- **Manifest**: 1 day cache (production) / 1 hour cache (staging)
|
- **Manifest**: 1 day cache (production) / 1 hour cache (staging)
|
||||||
|
|
||||||
### Compression
|
### Compression
|
||||||
|
|
||||||
- **Gzip compression**: Enabled for text-based files
|
- **Gzip compression**: Enabled for text-based files
|
||||||
- **Compression level**: 6 (balanced)
|
- **Compression level**: 6 (balanced)
|
||||||
- **Minimum size**: 1024 bytes
|
- **Minimum size**: 1024 bytes
|
||||||
|
|
||||||
### Nginx Optimizations
|
### Nginx Optimizations
|
||||||
|
|
||||||
- **Sendfile**: Enabled for efficient file serving
|
- **Sendfile**: Enabled for efficient file serving
|
||||||
- **TCP optimizations**: nopush and nodelay enabled
|
- **TCP optimizations**: nopush and nodelay enabled
|
||||||
- **Keepalive**: 65 second timeout
|
- **Keepalive**: 65 second timeout
|
||||||
@@ -285,19 +294,23 @@ docker-compose up staging
|
|||||||
## Health Checks
|
## Health Checks
|
||||||
|
|
||||||
### Built-in Health Checks
|
### Built-in Health Checks
|
||||||
|
|
||||||
All services include health checks that:
|
All services include health checks that:
|
||||||
|
|
||||||
- Check every 30 seconds
|
- Check every 30 seconds
|
||||||
- Timeout after 10 seconds
|
- Timeout after 10 seconds
|
||||||
- Retry 3 times before marking unhealthy
|
- Retry 3 times before marking unhealthy
|
||||||
- Start checking after 40 seconds
|
- Start checking after 40 seconds
|
||||||
|
|
||||||
### Health Check Endpoints
|
### Health Check Endpoints
|
||||||
|
|
||||||
- **Production/Staging**: `http://localhost/health`
|
- **Production/Staging**: `http://localhost/health`
|
||||||
- **Development**: `http://localhost:5173`
|
- **Development**: `http://localhost:5173`
|
||||||
|
|
||||||
## SSL/HTTPS Setup
|
## SSL/HTTPS Setup
|
||||||
|
|
||||||
### SSL Certificates
|
### SSL Certificates
|
||||||
|
|
||||||
For SSL deployment, create an `ssl` directory with certificates:
|
For SSL deployment, create an `ssl` directory with certificates:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -308,6 +321,7 @@ cp your-key.pem ssl/
|
|||||||
```
|
```
|
||||||
|
|
||||||
### SSL Configuration
|
### SSL Configuration
|
||||||
|
|
||||||
Use the `production-ssl` service in docker-compose:
|
Use the `production-ssl` service in docker-compose:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -317,10 +331,12 @@ docker-compose up production-ssl
|
|||||||
## Monitoring and Logging
|
## Monitoring and Logging
|
||||||
|
|
||||||
### Log Locations
|
### Log Locations
|
||||||
|
|
||||||
- **Access logs**: `/var/log/nginx/access.log`
|
- **Access logs**: `/var/log/nginx/access.log`
|
||||||
- **Error logs**: `/var/log/nginx/error.log`
|
- **Error logs**: `/var/log/nginx/error.log`
|
||||||
|
|
||||||
### Log Format
|
### Log Format
|
||||||
|
|
||||||
```
|
```
|
||||||
$remote_addr - $remote_user [$time_local] "$request"
|
$remote_addr - $remote_user [$time_local] "$request"
|
||||||
$status $body_bytes_sent "$http_referer"
|
$status $body_bytes_sent "$http_referer"
|
||||||
@@ -328,6 +344,7 @@ $status $body_bytes_sent "$http_referer"
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Log Levels
|
### Log Levels
|
||||||
|
|
||||||
- **Production**: `warn` level
|
- **Production**: `warn` level
|
||||||
- **Staging**: `debug` level
|
- **Staging**: `debug` level
|
||||||
- **Development**: Full logging
|
- **Development**: Full logging
|
||||||
@@ -337,6 +354,7 @@ $status $body_bytes_sent "$http_referer"
|
|||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
#### Build Failures
|
#### Build Failures
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check build logs
|
# Check build logs
|
||||||
docker build -t timesafari:latest . 2>&1 | tee build.log
|
docker build -t timesafari:latest . 2>&1 | tee build.log
|
||||||
@@ -349,6 +367,7 @@ docker run --rm timesafari:latest npm list --depth=0
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Container Won't Start
|
#### Container Won't Start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check container logs
|
# Check container logs
|
||||||
docker logs <container_id>
|
docker logs <container_id>
|
||||||
@@ -361,6 +380,7 @@ netstat -tulpn | grep :80
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Environment Variables Not Set
|
#### Environment Variables Not Set
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check environment in container
|
# Check environment in container
|
||||||
docker exec <container_id> env | grep VITE_
|
docker exec <container_id> env | grep VITE_
|
||||||
@@ -373,6 +393,7 @@ cat .env.production
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Performance Issues
|
#### Performance Issues
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check container resources
|
# Check container resources
|
||||||
docker stats <container_id>
|
docker stats <container_id>
|
||||||
@@ -387,6 +408,7 @@ docker exec <container_id> tail -f /var/log/nginx/access.log
|
|||||||
### Debug Commands
|
### Debug Commands
|
||||||
|
|
||||||
#### Container Debugging
|
#### Container Debugging
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Enter running container
|
# Enter running container
|
||||||
docker exec -it <container_id> /bin/sh
|
docker exec -it <container_id> /bin/sh
|
||||||
@@ -399,6 +421,7 @@ docker exec <container_id> ls -la /usr/share/nginx/html
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Network Debugging
|
#### Network Debugging
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check container network
|
# Check container network
|
||||||
docker network inspect bridge
|
docker network inspect bridge
|
||||||
@@ -413,6 +436,7 @@ docker exec <container_id> nslookup google.com
|
|||||||
## Production Deployment
|
## Production Deployment
|
||||||
|
|
||||||
### Recommended Production Setup
|
### Recommended Production Setup
|
||||||
|
|
||||||
1. **Use specific version tags**: `timesafari:1.0.0`
|
1. **Use specific version tags**: `timesafari:1.0.0`
|
||||||
2. **Implement health checks**: Already included
|
2. **Implement health checks**: Already included
|
||||||
3. **Configure proper logging**: Use external log aggregation
|
3. **Configure proper logging**: Use external log aggregation
|
||||||
@@ -420,6 +444,7 @@ docker exec <container_id> nslookup google.com
|
|||||||
5. **Use Docker secrets**: For sensitive data
|
5. **Use Docker secrets**: For sensitive data
|
||||||
|
|
||||||
### Production Commands
|
### Production Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build with specific version
|
# Build with specific version
|
||||||
docker build -t timesafari:1.0.0 .
|
docker build -t timesafari:1.0.0 .
|
||||||
@@ -442,6 +467,7 @@ docker run -d --name timesafari -p 80:80 --restart unless-stopped --env-file .en
|
|||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
||||||
### Local Development
|
### Local Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Start development environment
|
# Start development environment
|
||||||
./docker/run.sh dev
|
./docker/run.sh dev
|
||||||
@@ -454,6 +480,7 @@ docker-compose down dev
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Testing Changes
|
### Testing Changes
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build and test staging
|
# Build and test staging
|
||||||
./docker/run.sh staging
|
./docker/run.sh staging
|
||||||
@@ -463,6 +490,7 @@ docker-compose down dev
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Continuous Integration
|
### Continuous Integration
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build and test in CI
|
# Build and test in CI
|
||||||
docker build -t timesafari:test .
|
docker build -t timesafari:test .
|
||||||
@@ -479,6 +507,7 @@ docker rm timesafari-test
|
|||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
- Always use non-root users
|
- Always use non-root users
|
||||||
- Keep base images updated
|
- Keep base images updated
|
||||||
- Scan images for vulnerabilities
|
- Scan images for vulnerabilities
|
||||||
@@ -486,6 +515,7 @@ docker rm timesafari-test
|
|||||||
- Implement proper access controls
|
- Implement proper access controls
|
||||||
|
|
||||||
### Performance
|
### Performance
|
||||||
|
|
||||||
- Use multi-stage builds
|
- Use multi-stage builds
|
||||||
- Optimize layer caching
|
- Optimize layer caching
|
||||||
- Minimize image size
|
- Minimize image size
|
||||||
@@ -493,6 +523,7 @@ docker rm timesafari-test
|
|||||||
- Implement proper caching
|
- Implement proper caching
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
|
||||||
- Use health checks
|
- Use health checks
|
||||||
- Monitor resource usage
|
- Monitor resource usage
|
||||||
- Set up log aggregation
|
- Set up log aggregation
|
||||||
@@ -500,8 +531,9 @@ docker rm timesafari-test
|
|||||||
- Use proper error handling
|
- Use proper error handling
|
||||||
|
|
||||||
### Maintenance
|
### Maintenance
|
||||||
|
|
||||||
- Regular security updates
|
- Regular security updates
|
||||||
- Monitor for vulnerabilities
|
- Monitor for vulnerabilities
|
||||||
- Keep dependencies updated
|
- Keep dependencies updated
|
||||||
- Document configuration changes
|
- Document configuration changes
|
||||||
- Test deployment procedures
|
- Test deployment procedures
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ This guide covers building and running the TimeSafari Electron application for d
|
|||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
### Development Mode
|
### Development Mode
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Start development server
|
# Start development server
|
||||||
npm run build:electron:dev
|
npm run build:electron:dev
|
||||||
@@ -28,6 +29,7 @@ npm run electron:start
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Production Builds
|
### Production Builds
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build for current platform
|
# Build for current platform
|
||||||
npm run build:electron:prod
|
npm run build:electron:prod
|
||||||
@@ -48,16 +50,19 @@ npm run build:electron:deb # Linux DEB package
|
|||||||
The Electron app enforces single instance operation to prevent database conflicts and resource contention:
|
The Electron app enforces single instance operation to prevent database conflicts and resource contention:
|
||||||
|
|
||||||
### Implementation
|
### Implementation
|
||||||
|
|
||||||
- Uses Electron's built-in `app.requestSingleInstanceLock()`
|
- Uses Electron's built-in `app.requestSingleInstanceLock()`
|
||||||
- Second instances exit immediately with user-friendly message
|
- Second instances exit immediately with user-friendly message
|
||||||
- Existing instance focuses and shows informational dialog
|
- Existing instance focuses and shows informational dialog
|
||||||
|
|
||||||
### Behavior
|
### Behavior
|
||||||
|
|
||||||
- **First instance**: Starts normally and acquires lock
|
- **First instance**: Starts normally and acquires lock
|
||||||
- **Second instance**: Detects existing instance, exits immediately
|
- **Second instance**: Detects existing instance, exits immediately
|
||||||
- **User experience**: Clear messaging about single instance requirement
|
- **User experience**: Clear messaging about single instance requirement
|
||||||
|
|
||||||
### Benefits
|
### Benefits
|
||||||
|
|
||||||
- Prevents database corruption from concurrent access
|
- Prevents database corruption from concurrent access
|
||||||
- Avoids resource conflicts
|
- Avoids resource conflicts
|
||||||
- Maintains data integrity
|
- Maintains data integrity
|
||||||
@@ -66,6 +71,7 @@ The Electron app enforces single instance operation to prevent database conflict
|
|||||||
## Build Configuration
|
## Build Configuration
|
||||||
|
|
||||||
### Environment Modes
|
### Environment Modes
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Development (default)
|
# Development (default)
|
||||||
npm run build:electron:dev
|
npm run build:electron:dev
|
||||||
@@ -78,6 +84,7 @@ npm run build:electron:prod
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Platform-Specific Builds
|
### Platform-Specific Builds
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Windows
|
# Windows
|
||||||
npm run build:electron:windows:dev
|
npm run build:electron:windows:dev
|
||||||
@@ -96,6 +103,7 @@ npm run build:electron:linux:prod
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Package Types
|
### Package Types
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Linux AppImage
|
# Linux AppImage
|
||||||
npm run build:electron:appimage:dev
|
npm run build:electron:appimage:dev
|
||||||
@@ -116,26 +124,31 @@ npm run build:electron:deb:prod
|
|||||||
## Platform-Specific Requirements
|
## Platform-Specific Requirements
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
- Windows 10+ (64-bit)
|
- Windows 10+ (64-bit)
|
||||||
- Visual Studio Build Tools (for native modules)
|
- Visual Studio Build Tools (for native modules)
|
||||||
|
|
||||||
### macOS
|
### macOS
|
||||||
|
|
||||||
- macOS 10.15+ (Catalina)
|
- macOS 10.15+ (Catalina)
|
||||||
- Xcode Command Line Tools
|
- Xcode Command Line Tools
|
||||||
- Code signing certificate (for distribution)
|
- Code signing certificate (for distribution)
|
||||||
|
|
||||||
### Linux
|
### Linux
|
||||||
|
|
||||||
- Ubuntu 18.04+ / Debian 10+ / CentOS 7+
|
- Ubuntu 18.04+ / Debian 10+ / CentOS 7+
|
||||||
- Development headers for native modules
|
- Development headers for native modules
|
||||||
|
|
||||||
## Database Configuration
|
## Database Configuration
|
||||||
|
|
||||||
### SQLite Integration
|
### SQLite Integration
|
||||||
|
|
||||||
- Uses native Node.js SQLite3 for Electron
|
- Uses native Node.js SQLite3 for Electron
|
||||||
- Database stored in user's app data directory
|
- Database stored in user's app data directory
|
||||||
- Automatic migration from IndexedDB (if applicable)
|
- Automatic migration from IndexedDB (if applicable)
|
||||||
|
|
||||||
### Single Instance Protection
|
### Single Instance Protection
|
||||||
|
|
||||||
- File-based locking prevents concurrent database access
|
- File-based locking prevents concurrent database access
|
||||||
- Automatic cleanup on app exit
|
- Automatic cleanup on app exit
|
||||||
- Graceful handling of lock conflicts
|
- Graceful handling of lock conflicts
|
||||||
@@ -143,11 +156,13 @@ npm run build:electron:deb:prod
|
|||||||
## Security Features
|
## Security Features
|
||||||
|
|
||||||
### Content Security Policy
|
### Content Security Policy
|
||||||
|
|
||||||
- Strict CSP in production builds
|
- Strict CSP in production builds
|
||||||
- Development mode allows localhost connections
|
- Development mode allows localhost connections
|
||||||
- Automatic configuration based on build mode
|
- Automatic configuration based on build mode
|
||||||
|
|
||||||
### Auto-Updater
|
### Auto-Updater
|
||||||
|
|
||||||
- Disabled in development mode
|
- Disabled in development mode
|
||||||
- Production builds check for updates automatically
|
- Production builds check for updates automatically
|
||||||
- AppImage builds skip update checks
|
- AppImage builds skip update checks
|
||||||
@@ -157,6 +172,7 @@ npm run build:electron:deb:prod
|
|||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
#### Build Failures
|
#### Build Failures
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clean and rebuild
|
# Clean and rebuild
|
||||||
npm run clean:electron
|
npm run clean:electron
|
||||||
@@ -164,6 +180,7 @@ npm run build:electron:dev
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Native Module Issues
|
#### Native Module Issues
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Rebuild native modules
|
# Rebuild native modules
|
||||||
cd electron
|
cd electron
|
||||||
@@ -171,16 +188,19 @@ npm run electron:rebuild
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Single Instance Conflicts
|
#### Single Instance Conflicts
|
||||||
|
|
||||||
- Ensure no other TimeSafari instances are running
|
- Ensure no other TimeSafari instances are running
|
||||||
- Check for orphaned processes: `ps aux | grep electron`
|
- Check for orphaned processes: `ps aux | grep electron`
|
||||||
- Restart system if necessary
|
- Restart system if necessary
|
||||||
|
|
||||||
#### Database Issues
|
#### Database Issues
|
||||||
|
|
||||||
- Check app data directory permissions
|
- Check app data directory permissions
|
||||||
- Verify SQLite database integrity
|
- Verify SQLite database integrity
|
||||||
- Clear app data if corrupted
|
- Clear app data if corrupted
|
||||||
|
|
||||||
### Debug Mode
|
### Debug Mode
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Enable debug logging
|
# Enable debug logging
|
||||||
DEBUG=* npm run build:electron:dev
|
DEBUG=* npm run build:electron:dev
|
||||||
@@ -203,6 +223,7 @@ electron/
|
|||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
||||||
1. **Start Development**
|
1. **Start Development**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build:electron:dev
|
npm run build:electron:dev
|
||||||
```
|
```
|
||||||
@@ -212,11 +233,13 @@ electron/
|
|||||||
- Changes auto-reload in development
|
- Changes auto-reload in development
|
||||||
|
|
||||||
3. **Test Build**
|
3. **Test Build**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build:electron:test
|
npm run build:electron:test
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Production Build**
|
4. **Production Build**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build:electron:prod
|
npm run build:electron:prod
|
||||||
```
|
```
|
||||||
@@ -224,16 +247,19 @@ electron/
|
|||||||
## Performance Considerations
|
## Performance Considerations
|
||||||
|
|
||||||
### Memory Usage
|
### Memory Usage
|
||||||
|
|
||||||
- Monitor renderer process memory
|
- Monitor renderer process memory
|
||||||
- Implement proper cleanup in components
|
- Implement proper cleanup in components
|
||||||
- Use efficient data structures
|
- Use efficient data structures
|
||||||
|
|
||||||
### Startup Time
|
### Startup Time
|
||||||
|
|
||||||
- Lazy load non-critical modules
|
- Lazy load non-critical modules
|
||||||
- Optimize database initialization
|
- Optimize database initialization
|
||||||
- Minimize synchronous operations
|
- Minimize synchronous operations
|
||||||
|
|
||||||
### Database Performance
|
### Database Performance
|
||||||
|
|
||||||
- Use transactions for bulk operations
|
- Use transactions for bulk operations
|
||||||
- Implement proper indexing
|
- Implement proper indexing
|
||||||
- Monitor query performance
|
- Monitor query performance
|
||||||
@@ -251,16 +277,19 @@ electron/
|
|||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
### Distribution
|
### Distribution
|
||||||
|
|
||||||
- Windows: `.exe` installer
|
- Windows: `.exe` installer
|
||||||
- macOS: `.dmg` disk image
|
- macOS: `.dmg` disk image
|
||||||
- Linux: `.AppImage` or `.deb` package
|
- Linux: `.AppImage` or `.deb` package
|
||||||
|
|
||||||
### Code Signing
|
### Code Signing
|
||||||
|
|
||||||
- Windows: Authenticode certificate
|
- Windows: Authenticode certificate
|
||||||
- macOS: Developer ID certificate
|
- macOS: Developer ID certificate
|
||||||
- Linux: GPG signing (optional)
|
- Linux: GPG signing (optional)
|
||||||
|
|
||||||
### Auto-Updates
|
### Auto-Updates
|
||||||
|
|
||||||
- Configured for production builds
|
- Configured for production builds
|
||||||
- Disabled for development and AppImage
|
- Disabled for development and AppImage
|
||||||
- Handles update failures gracefully
|
- Handles update failures gracefully
|
||||||
@@ -269,4 +298,4 @@ electron/
|
|||||||
|
|
||||||
**Last Updated**: 2025-07-11
|
**Last Updated**: 2025-07-11
|
||||||
**Version**: 1.0.3-beta
|
**Version**: 1.0.3-beta
|
||||||
**Status**: Production Ready
|
**Status**: Production Ready
|
||||||
|
|||||||
@@ -56,21 +56,25 @@ npm run build:electron:dmg:prod
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Stage 1: Web Build**
|
**Stage 1: Web Build**
|
||||||
|
|
||||||
- Vite builds web assets with Electron configuration
|
- Vite builds web assets with Electron configuration
|
||||||
- Environment variables loaded based on build mode
|
- Environment variables loaded based on build mode
|
||||||
- Assets optimized for desktop application
|
- Assets optimized for desktop application
|
||||||
|
|
||||||
**Stage 2: Capacitor Sync**
|
**Stage 2: Capacitor Sync**
|
||||||
|
|
||||||
- Copies web assets to Electron app directory
|
- Copies web assets to Electron app directory
|
||||||
- Syncs Capacitor configuration and plugins
|
- Syncs Capacitor configuration and plugins
|
||||||
- Prepares native module bindings
|
- Prepares native module bindings
|
||||||
|
|
||||||
**Stage 3: TypeScript Compile**
|
**Stage 3: TypeScript Compile**
|
||||||
|
|
||||||
- Compiles Electron main process TypeScript
|
- Compiles Electron main process TypeScript
|
||||||
- Rebuilds native modules for target platform
|
- Rebuilds native modules for target platform
|
||||||
- Generates production-ready JavaScript
|
- Generates production-ready JavaScript
|
||||||
|
|
||||||
**Stage 4: Package Creation**
|
**Stage 4: Package Creation**
|
||||||
|
|
||||||
- Creates platform-specific installers
|
- Creates platform-specific installers
|
||||||
- Generates distribution packages
|
- Generates distribution packages
|
||||||
- Signs applications (when configured)
|
- Signs applications (when configured)
|
||||||
@@ -82,6 +86,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Purpose**: Local development and testing
|
**Purpose**: Local development and testing
|
||||||
**Command**: `npm run build:electron:dev`
|
**Command**: `npm run build:electron:dev`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Hot reload enabled
|
- Hot reload enabled
|
||||||
- Debug tools available
|
- Debug tools available
|
||||||
- Development logging
|
- Development logging
|
||||||
@@ -92,6 +97,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Purpose**: Staging and testing environments
|
**Purpose**: Staging and testing environments
|
||||||
**Command**: `npm run build:electron -- --mode test`
|
**Command**: `npm run build:electron -- --mode test`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Test API endpoints
|
- Test API endpoints
|
||||||
- Staging configurations
|
- Staging configurations
|
||||||
- Optimized for testing
|
- Optimized for testing
|
||||||
@@ -102,6 +108,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Purpose**: Production deployment
|
**Purpose**: Production deployment
|
||||||
**Command**: `npm run build:electron -- --mode production`
|
**Command**: `npm run build:electron -- --mode production`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Production optimizations
|
- Production optimizations
|
||||||
- Code minification
|
- Code minification
|
||||||
- Security hardening
|
- Security hardening
|
||||||
@@ -116,6 +123,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Command**: `npm run build:electron:windows:prod`
|
**Command**: `npm run build:electron:windows:prod`
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- NSIS installer with custom options
|
- NSIS installer with custom options
|
||||||
- Desktop and Start Menu shortcuts
|
- Desktop and Start Menu shortcuts
|
||||||
- Elevation permissions for installation
|
- Elevation permissions for installation
|
||||||
@@ -128,6 +136,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Command**: `npm run build:electron:mac:prod`
|
**Command**: `npm run build:electron:mac:prod`
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Universal binary (x64 + arm64)
|
- Universal binary (x64 + arm64)
|
||||||
- DMG installer with custom branding
|
- DMG installer with custom branding
|
||||||
- App Store compliance (when configured)
|
- App Store compliance (when configured)
|
||||||
@@ -140,6 +149,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Command**: `npm run build:electron:linux:prod`
|
**Command**: `npm run build:electron:linux:prod`
|
||||||
|
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- AppImage for universal distribution
|
- AppImage for universal distribution
|
||||||
- DEB package for Debian-based systems
|
- DEB package for Debian-based systems
|
||||||
- RPM package for Red Hat-based systems
|
- RPM package for Red Hat-based systems
|
||||||
@@ -152,6 +162,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Format**: Self-contained Linux executable
|
**Format**: Self-contained Linux executable
|
||||||
**Command**: `npm run build:electron:appimage:prod`
|
**Command**: `npm run build:electron:appimage:prod`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Single file distribution
|
- Single file distribution
|
||||||
- No installation required
|
- No installation required
|
||||||
- Portable across Linux distributions
|
- Portable across Linux distributions
|
||||||
@@ -162,6 +173,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Format**: Debian package installer
|
**Format**: Debian package installer
|
||||||
**Command**: `npm run build:electron:deb:prod`
|
**Command**: `npm run build:electron:deb:prod`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Native package management
|
- Native package management
|
||||||
- Dependency resolution
|
- Dependency resolution
|
||||||
- System integration
|
- System integration
|
||||||
@@ -172,6 +184,7 @@ npm run build:electron:dmg:prod
|
|||||||
**Format**: macOS disk image
|
**Format**: macOS disk image
|
||||||
**Command**: `npm run build:electron:dmg:prod`
|
**Command**: `npm run build:electron:dmg:prod`
|
||||||
**Features**:
|
**Features**:
|
||||||
|
|
||||||
- Native macOS installer
|
- Native macOS installer
|
||||||
- Custom branding and layout
|
- Custom branding and layout
|
||||||
- Drag-and-drop installation
|
- Drag-and-drop installation
|
||||||
@@ -293,6 +306,7 @@ Local Electron scripts for building:
|
|||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
**Development**:
|
**Development**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
VITE_API_URL=http://localhost:3000
|
VITE_API_URL=http://localhost:3000
|
||||||
VITE_DEBUG=true
|
VITE_DEBUG=true
|
||||||
@@ -301,6 +315,7 @@ VITE_ENABLE_DEV_TOOLS=true
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Testing**:
|
**Testing**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
VITE_API_URL=https://test-api.timesafari.com
|
VITE_API_URL=https://test-api.timesafari.com
|
||||||
VITE_DEBUG=false
|
VITE_DEBUG=false
|
||||||
@@ -309,6 +324,7 @@ VITE_ENABLE_DEV_TOOLS=false
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Production**:
|
**Production**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
VITE_API_URL=https://api.timesafari.com
|
VITE_API_URL=https://api.timesafari.com
|
||||||
VITE_DEBUG=false
|
VITE_DEBUG=false
|
||||||
@@ -347,6 +363,7 @@ electron/
|
|||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
**TypeScript Compilation Errors**:
|
**TypeScript Compilation Errors**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clean and rebuild
|
# Clean and rebuild
|
||||||
npm run clean:electron
|
npm run clean:electron
|
||||||
@@ -354,18 +371,21 @@ cd electron && npm run build
|
|||||||
```
|
```
|
||||||
|
|
||||||
**Native Module Issues**:
|
**Native Module Issues**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Rebuild native modules
|
# Rebuild native modules
|
||||||
cd electron && npm run build
|
cd electron && npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
**Asset Copy Issues**:
|
**Asset Copy Issues**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Verify Capacitor sync
|
# Verify Capacitor sync
|
||||||
npx cap sync electron
|
npx cap sync electron
|
||||||
```
|
```
|
||||||
|
|
||||||
**Package Creation Failures**:
|
**Package Creation Failures**:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check electron-builder configuration
|
# Check electron-builder configuration
|
||||||
# Verify platform-specific requirements
|
# Verify platform-specific requirements
|
||||||
@@ -375,16 +395,19 @@ npx cap sync electron
|
|||||||
### Platform-Specific Issues
|
### Platform-Specific Issues
|
||||||
|
|
||||||
**Windows**:
|
**Windows**:
|
||||||
|
|
||||||
- Ensure Windows Build Tools installed
|
- Ensure Windows Build Tools installed
|
||||||
- Check NSIS installation
|
- Check NSIS installation
|
||||||
- Verify code signing certificates
|
- Verify code signing certificates
|
||||||
|
|
||||||
**macOS**:
|
**macOS**:
|
||||||
|
|
||||||
- Install Xcode Command Line Tools
|
- Install Xcode Command Line Tools
|
||||||
- Configure code signing certificates
|
- Configure code signing certificates
|
||||||
- Check app notarization requirements
|
- Check app notarization requirements
|
||||||
|
|
||||||
**Linux**:
|
**Linux**:
|
||||||
|
|
||||||
- Install required packages (rpm-tools, etc.)
|
- Install required packages (rpm-tools, etc.)
|
||||||
- Check AppImage dependencies
|
- Check AppImage dependencies
|
||||||
- Verify desktop integration
|
- Verify desktop integration
|
||||||
@@ -394,11 +417,13 @@ npx cap sync electron
|
|||||||
### Build Performance
|
### Build Performance
|
||||||
|
|
||||||
**Parallel Builds**:
|
**Parallel Builds**:
|
||||||
|
|
||||||
- Use concurrent TypeScript compilation
|
- Use concurrent TypeScript compilation
|
||||||
- Optimize asset copying
|
- Optimize asset copying
|
||||||
- Minimize file system operations
|
- Minimize file system operations
|
||||||
|
|
||||||
**Caching Strategies**:
|
**Caching Strategies**:
|
||||||
|
|
||||||
- Cache node_modules between builds
|
- Cache node_modules between builds
|
||||||
- Cache compiled TypeScript
|
- Cache compiled TypeScript
|
||||||
- Cache web assets when unchanged
|
- Cache web assets when unchanged
|
||||||
@@ -406,11 +431,13 @@ npx cap sync electron
|
|||||||
### Runtime Performance
|
### Runtime Performance
|
||||||
|
|
||||||
**Application Startup**:
|
**Application Startup**:
|
||||||
|
|
||||||
- Optimize main process initialization
|
- Optimize main process initialization
|
||||||
- Minimize startup dependencies
|
- Minimize startup dependencies
|
||||||
- Use lazy loading for features
|
- Use lazy loading for features
|
||||||
|
|
||||||
**Memory Management**:
|
**Memory Management**:
|
||||||
|
|
||||||
- Monitor memory usage
|
- Monitor memory usage
|
||||||
- Implement proper cleanup
|
- Implement proper cleanup
|
||||||
- Optimize asset loading
|
- Optimize asset loading
|
||||||
@@ -420,16 +447,19 @@ npx cap sync electron
|
|||||||
### Code Signing
|
### Code Signing
|
||||||
|
|
||||||
**Windows**:
|
**Windows**:
|
||||||
|
|
||||||
- Authenticode code signing
|
- Authenticode code signing
|
||||||
- EV certificate for SmartScreen
|
- EV certificate for SmartScreen
|
||||||
- Timestamp server configuration
|
- Timestamp server configuration
|
||||||
|
|
||||||
**macOS**:
|
**macOS**:
|
||||||
|
|
||||||
- Developer ID code signing
|
- Developer ID code signing
|
||||||
- App notarization
|
- App notarization
|
||||||
- Hardened runtime
|
- Hardened runtime
|
||||||
|
|
||||||
**Linux**:
|
**Linux**:
|
||||||
|
|
||||||
- GPG signing for packages
|
- GPG signing for packages
|
||||||
- AppImage signing
|
- AppImage signing
|
||||||
- Package verification
|
- Package verification
|
||||||
@@ -437,12 +467,14 @@ npx cap sync electron
|
|||||||
### Security Hardening
|
### Security Hardening
|
||||||
|
|
||||||
**Production Builds**:
|
**Production Builds**:
|
||||||
|
|
||||||
- Disable developer tools
|
- Disable developer tools
|
||||||
- Remove debug information
|
- Remove debug information
|
||||||
- Enable security policies
|
- Enable security policies
|
||||||
- Implement sandboxing
|
- Implement sandboxing
|
||||||
|
|
||||||
**Update Security**:
|
**Update Security**:
|
||||||
|
|
||||||
- Secure update channels
|
- Secure update channels
|
||||||
- Package integrity verification
|
- Package integrity verification
|
||||||
- Rollback capabilities
|
- Rollback capabilities
|
||||||
@@ -496,4 +528,4 @@ npx cap sync electron
|
|||||||
**Status**: Production ready
|
**Status**: Production ready
|
||||||
**Last Updated**: 2025-01-27
|
**Last Updated**: 2025-01-27
|
||||||
**Version**: 1.0
|
**Version**: 1.0
|
||||||
**Maintainer**: Matthew Raymer
|
**Maintainer**: Matthew Raymer
|
||||||
|
|||||||
@@ -11,6 +11,6 @@
|
|||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="app"></div>
|
<div id="app"></div>
|
||||||
<script type="module" src="/src/main.web.ts"></script>
|
<script type="module" src="/src/main.ts"></script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -403,7 +403,7 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 39;
|
CURRENT_PROJECT_VERSION = 40;
|
||||||
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
||||||
ENABLE_APP_SANDBOX = NO;
|
ENABLE_APP_SANDBOX = NO;
|
||||||
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
||||||
@@ -413,7 +413,7 @@
|
|||||||
"$(inherited)",
|
"$(inherited)",
|
||||||
"@executable_path/Frameworks",
|
"@executable_path/Frameworks",
|
||||||
);
|
);
|
||||||
MARKETING_VERSION = 1.0.6;
|
MARKETING_VERSION = 1.0.7;
|
||||||
OTHER_SWIFT_FLAGS = "$(inherited) \"-D\" \"COCOAPODS\" \"-DDEBUG\"";
|
OTHER_SWIFT_FLAGS = "$(inherited) \"-D\" \"COCOAPODS\" \"-DDEBUG\"";
|
||||||
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
||||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||||
@@ -430,7 +430,7 @@
|
|||||||
buildSettings = {
|
buildSettings = {
|
||||||
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
|
||||||
CODE_SIGN_STYLE = Automatic;
|
CODE_SIGN_STYLE = Automatic;
|
||||||
CURRENT_PROJECT_VERSION = 39;
|
CURRENT_PROJECT_VERSION = 40;
|
||||||
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
DEVELOPMENT_TEAM = GM3FS5JQPH;
|
||||||
ENABLE_APP_SANDBOX = NO;
|
ENABLE_APP_SANDBOX = NO;
|
||||||
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
ENABLE_USER_SCRIPT_SANDBOXING = NO;
|
||||||
@@ -440,7 +440,7 @@
|
|||||||
"$(inherited)",
|
"$(inherited)",
|
||||||
"@executable_path/Frameworks",
|
"@executable_path/Frameworks",
|
||||||
);
|
);
|
||||||
MARKETING_VERSION = 1.0.6;
|
MARKETING_VERSION = 1.0.7;
|
||||||
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
PRODUCT_BUNDLE_IDENTIFIER = app.timesafari;
|
||||||
PRODUCT_NAME = "$(TARGET_NAME)";
|
PRODUCT_NAME = "$(TARGET_NAME)";
|
||||||
SWIFT_ACTIVE_COMPILATION_CONDITIONS = "";
|
SWIFT_ACTIVE_COMPILATION_CONDITIONS = "";
|
||||||
|
|||||||
@@ -1,30 +1,38 @@
|
|||||||
## 1.4.1
|
## 1.4.1
|
||||||
|
|
||||||
- Fix macOS app re-signing issue.
|
- Fix macOS app re-signing issue.
|
||||||
- Automatically enable Hardened Runtime in macOS codesign.
|
- Automatically enable Hardened Runtime in macOS codesign.
|
||||||
- Add clean script.
|
- Add clean script.
|
||||||
|
|
||||||
## 1.4.0
|
## 1.4.0
|
||||||
|
|
||||||
- Support for macOS app ([#9](https://github.com/crasowas/app_privacy_manifest_fixer/issues/9)).
|
- Support for macOS app ([#9](https://github.com/crasowas/app_privacy_manifest_fixer/issues/9)).
|
||||||
|
|
||||||
## 1.3.11
|
## 1.3.11
|
||||||
|
|
||||||
- Fix install issue by skipping `PBXAggregateTarget` ([#4](https://github.com/crasowas/app_privacy_manifest_fixer/issues/4)).
|
- Fix install issue by skipping `PBXAggregateTarget` ([#4](https://github.com/crasowas/app_privacy_manifest_fixer/issues/4)).
|
||||||
|
|
||||||
## 1.3.10
|
## 1.3.10
|
||||||
|
|
||||||
- Fix app re-signing issue.
|
- Fix app re-signing issue.
|
||||||
- Enhance Build Phases script robustness.
|
- Enhance Build Phases script robustness.
|
||||||
|
|
||||||
## 1.3.9
|
## 1.3.9
|
||||||
|
|
||||||
- Add log file output.
|
- Add log file output.
|
||||||
|
|
||||||
## 1.3.8
|
## 1.3.8
|
||||||
|
|
||||||
- Add version info to privacy access report.
|
- Add version info to privacy access report.
|
||||||
- Remove empty tables from privacy access report.
|
- Remove empty tables from privacy access report.
|
||||||
|
|
||||||
## 1.3.7
|
## 1.3.7
|
||||||
|
|
||||||
- Enhance API symbols analysis with strings tool.
|
- Enhance API symbols analysis with strings tool.
|
||||||
- Improve performance of API usage analysis.
|
- Improve performance of API usage analysis.
|
||||||
|
|
||||||
## 1.3.5
|
## 1.3.5
|
||||||
|
|
||||||
- Fix issue with inaccurate privacy manifest search.
|
- Fix issue with inaccurate privacy manifest search.
|
||||||
- Disable dependency analysis to force the script to run on every build.
|
- Disable dependency analysis to force the script to run on every build.
|
||||||
- Add placeholder for privacy access report.
|
- Add placeholder for privacy access report.
|
||||||
@@ -32,27 +40,34 @@
|
|||||||
- Add examples for privacy access report.
|
- Add examples for privacy access report.
|
||||||
|
|
||||||
## 1.3.0
|
## 1.3.0
|
||||||
|
|
||||||
- Add privacy access report generation.
|
- Add privacy access report generation.
|
||||||
|
|
||||||
## 1.2.3
|
## 1.2.3
|
||||||
|
|
||||||
- Fix issue with relative path parameter.
|
- Fix issue with relative path parameter.
|
||||||
- Add support for all application targets.
|
- Add support for all application targets.
|
||||||
|
|
||||||
## 1.2.1
|
## 1.2.1
|
||||||
|
|
||||||
- Fix backup issue with empty user templates directory.
|
- Fix backup issue with empty user templates directory.
|
||||||
|
|
||||||
## 1.2.0
|
## 1.2.0
|
||||||
|
|
||||||
- Add uninstall script.
|
- Add uninstall script.
|
||||||
|
|
||||||
## 1.1.2
|
## 1.1.2
|
||||||
|
|
||||||
- Remove `Templates/.gitignore` to track `UserTemplates`.
|
- Remove `Templates/.gitignore` to track `UserTemplates`.
|
||||||
- Fix incorrect use of `App.xcprivacy` template in `App.framework`.
|
- Fix incorrect use of `App.xcprivacy` template in `App.framework`.
|
||||||
|
|
||||||
## 1.1.0
|
## 1.1.0
|
||||||
|
|
||||||
- Add logs for latest release fetch failure.
|
- Add logs for latest release fetch failure.
|
||||||
- Fix issue with converting published time to local time.
|
- Fix issue with converting published time to local time.
|
||||||
- Disable showing environment variables in the build log.
|
- Disable showing environment variables in the build log.
|
||||||
- Add `--install-builds-only` command line option.
|
- Add `--install-builds-only` command line option.
|
||||||
|
|
||||||
## 1.0.0
|
## 1.0.0
|
||||||
- Initial version.
|
|
||||||
|
- Initial version.
|
||||||
|
|||||||
@@ -150,6 +150,7 @@ The privacy manifest templates are stored in the [`Templates`](https://github.co
|
|||||||
### Template Types
|
### Template Types
|
||||||
|
|
||||||
The templates are categorized as follows:
|
The templates are categorized as follows:
|
||||||
|
|
||||||
- **AppTemplate.xcprivacy**: A privacy manifest template for the app.
|
- **AppTemplate.xcprivacy**: A privacy manifest template for the app.
|
||||||
- **FrameworkTemplate.xcprivacy**: A generic privacy manifest template for frameworks.
|
- **FrameworkTemplate.xcprivacy**: A generic privacy manifest template for frameworks.
|
||||||
- **FrameworkName.xcprivacy**: A privacy manifest template for a specific framework, available only in the `Templates/UserTemplates` directory.
|
- **FrameworkName.xcprivacy**: A privacy manifest template for a specific framework, available only in the `Templates/UserTemplates` directory.
|
||||||
@@ -157,20 +158,24 @@ The templates are categorized as follows:
|
|||||||
### Template Priority
|
### Template Priority
|
||||||
|
|
||||||
For an app, the priority of privacy manifest templates is as follows:
|
For an app, the priority of privacy manifest templates is as follows:
|
||||||
|
|
||||||
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
||||||
|
|
||||||
For a specific framework, the priority of privacy manifest templates is as follows:
|
For a specific framework, the priority of privacy manifest templates is as follows:
|
||||||
|
|
||||||
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
||||||
|
|
||||||
### Default Templates
|
### Default Templates
|
||||||
|
|
||||||
The default templates are located in the `Templates` root directory and currently include the following templates:
|
The default templates are located in the `Templates` root directory and currently include the following templates:
|
||||||
|
|
||||||
- `Templates/AppTemplate.xcprivacy`
|
- `Templates/AppTemplate.xcprivacy`
|
||||||
- `Templates/FrameworkTemplate.xcprivacy`
|
- `Templates/FrameworkTemplate.xcprivacy`
|
||||||
|
|
||||||
These templates will be modified based on the API usage analysis results, especially the `NSPrivacyAccessedAPIType` entries, to generate new privacy manifests for fixes, ensuring compliance with App Store requirements.
|
These templates will be modified based on the API usage analysis results, especially the `NSPrivacyAccessedAPIType` entries, to generate new privacy manifests for fixes, ensuring compliance with App Store requirements.
|
||||||
|
|
||||||
**If adjustments to the privacy manifest template are needed, such as in the following scenarios, avoid directly modifying the default templates. Instead, use a custom template. If a custom template with the same name exists, it will take precedence over the default template for fixes.**
|
**If adjustments to the privacy manifest template are needed, such as in the following scenarios, avoid directly modifying the default templates. Instead, use a custom template. If a custom template with the same name exists, it will take precedence over the default template for fixes.**
|
||||||
|
|
||||||
- Generating a non-compliant privacy manifest due to inaccurate API usage analysis.
|
- Generating a non-compliant privacy manifest due to inaccurate API usage analysis.
|
||||||
- Modifying the reason declared in the template.
|
- Modifying the reason declared in the template.
|
||||||
- Adding declarations for collected data.
|
- Adding declarations for collected data.
|
||||||
@@ -198,6 +203,7 @@ The privacy access API categories and their associated declared reasons in `Fram
|
|||||||
### Custom Templates
|
### Custom Templates
|
||||||
|
|
||||||
To create custom templates, place them in the `Templates/UserTemplates` directory with the following structure:
|
To create custom templates, place them in the `Templates/UserTemplates` directory with the following structure:
|
||||||
|
|
||||||
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
||||||
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
||||||
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
||||||
@@ -205,6 +211,7 @@ To create custom templates, place them in the `Templates/UserTemplates` director
|
|||||||
Among these templates, only `FrameworkTemplate.xcprivacy` will be modified based on the API usage analysis results to adjust the `NSPrivacyAccessedAPIType` entries, thereby generating a new privacy manifest for framework fixes. The other templates will remain unchanged and will be directly used for fixes.
|
Among these templates, only `FrameworkTemplate.xcprivacy` will be modified based on the API usage analysis results to adjust the `NSPrivacyAccessedAPIType` entries, thereby generating a new privacy manifest for framework fixes. The other templates will remain unchanged and will be directly used for fixes.
|
||||||
|
|
||||||
**Important Notes:**
|
**Important Notes:**
|
||||||
|
|
||||||
- The template for a specific framework must follow the naming convention `FrameworkName.xcprivacy`, where `FrameworkName` should match the name of the framework. For example, the template for `Flutter.framework` should be named `Flutter.xcprivacy`.
|
- The template for a specific framework must follow the naming convention `FrameworkName.xcprivacy`, where `FrameworkName` should match the name of the framework. For example, the template for `Flutter.framework` should be named `Flutter.xcprivacy`.
|
||||||
- For macOS frameworks, the naming convention should be `FrameworkName.Version.xcprivacy`, where the version name is added to distinguish different versions. For a single version macOS framework, the `Version` is typically `A`.
|
- For macOS frameworks, the naming convention should be `FrameworkName.Version.xcprivacy`, where the version name is added to distinguish different versions. For a single version macOS framework, the `Version` is typically `A`.
|
||||||
- The name of an SDK may not exactly match the name of the framework. To determine the correct framework name, check the `Frameworks` directory in the application bundle after building the project.
|
- The name of an SDK may not exactly match the name of the framework. To determine the correct framework name, check the `Frameworks` directory in the application bundle after building the project.
|
||||||
|
|||||||
@@ -40,7 +40,7 @@
|
|||||||
```shell
|
```shell
|
||||||
sh install.sh <project_path>
|
sh install.sh <project_path>
|
||||||
```
|
```
|
||||||
|
|
||||||
- 如果是 Flutter 项目,`project_path`应为 Flutter 项目中的`ios/macos`目录路径。
|
- 如果是 Flutter 项目,`project_path`应为 Flutter 项目中的`ios/macos`目录路径。
|
||||||
- 重复运行安装命令时,工具会先移除现有安装(如果有)。若需修改命令行选项,只需重新运行安装命令,无需先卸载。
|
- 重复运行安装命令时,工具会先移除现有安装(如果有)。若需修改命令行选项,只需重新运行安装命令,无需先卸载。
|
||||||
|
|
||||||
@@ -150,6 +150,7 @@ sh clean.sh
|
|||||||
### 模板类型
|
### 模板类型
|
||||||
|
|
||||||
模板分为以下几类:
|
模板分为以下几类:
|
||||||
|
|
||||||
- **AppTemplate.xcprivacy**:App 的隐私清单模板。
|
- **AppTemplate.xcprivacy**:App 的隐私清单模板。
|
||||||
- **FrameworkTemplate.xcprivacy**:通用的 Framework 隐私清单模板。
|
- **FrameworkTemplate.xcprivacy**:通用的 Framework 隐私清单模板。
|
||||||
- **FrameworkName.xcprivacy**:特定的 Framework 隐私清单模板,仅在`Templates/UserTemplates`目录有效。
|
- **FrameworkName.xcprivacy**:特定的 Framework 隐私清单模板,仅在`Templates/UserTemplates`目录有效。
|
||||||
@@ -157,20 +158,24 @@ sh clean.sh
|
|||||||
### 模板优先级
|
### 模板优先级
|
||||||
|
|
||||||
对于 App,隐私清单模板的优先级如下:
|
对于 App,隐私清单模板的优先级如下:
|
||||||
|
|
||||||
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
- `Templates/UserTemplates/AppTemplate.xcprivacy` > `Templates/AppTemplate.xcprivacy`
|
||||||
|
|
||||||
对于特定的 Framework,隐私清单模板的优先级如下:
|
对于特定的 Framework,隐私清单模板的优先级如下:
|
||||||
|
|
||||||
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
- `Templates/UserTemplates/FrameworkName.xcprivacy` > `Templates/UserTemplates/FrameworkTemplate.xcprivacy` > `Templates/FrameworkTemplate.xcprivacy`
|
||||||
|
|
||||||
### 默认模板
|
### 默认模板
|
||||||
|
|
||||||
默认模板位于`Templates`根目录,目前包括以下模板:
|
默认模板位于`Templates`根目录,目前包括以下模板:
|
||||||
|
|
||||||
- `Templates/AppTemplate.xcprivacy`
|
- `Templates/AppTemplate.xcprivacy`
|
||||||
- `Templates/FrameworkTemplate.xcprivacy`
|
- `Templates/FrameworkTemplate.xcprivacy`
|
||||||
|
|
||||||
这些模板将根据 API 使用分析结果进行修改,特别是`NSPrivacyAccessedAPIType`条目将被调整,以生成新的隐私清单用于修复,确保符合 App Store 要求。
|
这些模板将根据 API 使用分析结果进行修改,特别是`NSPrivacyAccessedAPIType`条目将被调整,以生成新的隐私清单用于修复,确保符合 App Store 要求。
|
||||||
|
|
||||||
**如果需要调整隐私清单模板,例如以下场景,请避免直接修改默认模板,而是使用自定义模板。如果存在相同名称的自定义模板,它将优先于默认模板用于修复。**
|
**如果需要调整隐私清单模板,例如以下场景,请避免直接修改默认模板,而是使用自定义模板。如果存在相同名称的自定义模板,它将优先于默认模板用于修复。**
|
||||||
|
|
||||||
- 由于 API 使用分析结果不准确,生成了不合规的隐私清单。
|
- 由于 API 使用分析结果不准确,生成了不合规的隐私清单。
|
||||||
- 需要修改模板中声明的理由。
|
- 需要修改模板中声明的理由。
|
||||||
- 需要声明收集的数据。
|
- 需要声明收集的数据。
|
||||||
@@ -198,6 +203,7 @@ sh clean.sh
|
|||||||
### 自定义模板
|
### 自定义模板
|
||||||
|
|
||||||
要创建自定义模板,请将其放在`Templates/UserTemplates`目录,结构如下:
|
要创建自定义模板,请将其放在`Templates/UserTemplates`目录,结构如下:
|
||||||
|
|
||||||
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
- `Templates/UserTemplates/AppTemplate.xcprivacy`
|
||||||
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
- `Templates/UserTemplates/FrameworkTemplate.xcprivacy`
|
||||||
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
- `Templates/UserTemplates/FrameworkName.xcprivacy`
|
||||||
@@ -205,6 +211,7 @@ sh clean.sh
|
|||||||
在这些模板中,只有`FrameworkTemplate.xcprivacy`会根据 API 使用分析结果对`NSPrivacyAccessedAPIType`条目进行调整,以生成新的隐私清单用于 Framework 修复。其他模板保持不变,将直接用于修复。
|
在这些模板中,只有`FrameworkTemplate.xcprivacy`会根据 API 使用分析结果对`NSPrivacyAccessedAPIType`条目进行调整,以生成新的隐私清单用于 Framework 修复。其他模板保持不变,将直接用于修复。
|
||||||
|
|
||||||
**重要说明:**
|
**重要说明:**
|
||||||
|
|
||||||
- 特定的 Framework 模板必须遵循命名规范`FrameworkName.xcprivacy`,其中`FrameworkName`需与 Framework 的名称匹配。例如`Flutter.framework`的模板应命名为`Flutter.xcprivacy`。
|
- 特定的 Framework 模板必须遵循命名规范`FrameworkName.xcprivacy`,其中`FrameworkName`需与 Framework 的名称匹配。例如`Flutter.framework`的模板应命名为`Flutter.xcprivacy`。
|
||||||
- 对于 macOS Framework,应遵循命名规范`FrameworkName.Version.xcprivacy`,额外增加版本名称用于区分不同的版本。对于单一版本的 macOS Framework,`Version`通常为`A`。
|
- 对于 macOS Framework,应遵循命名规范`FrameworkName.Version.xcprivacy`,额外增加版本名称用于区分不同的版本。对于单一版本的 macOS Framework,`Version`通常为`A`。
|
||||||
- SDK 的名称可能与 Framework 的名称不完全一致。要确定正确的 Framework 名称,请在构建项目后检查 App 包中的`Frameworks`目录。
|
- SDK 的名称可能与 Framework 的名称不完全一致。要确定正确的 Framework 名称,请在构建项目后检查 App 包中的`Frameworks`目录。
|
||||||
@@ -229,7 +236,7 @@ sh Report/report.sh <app_path> <report_output_path>
|
|||||||
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
|
||||||
|  |  |
|
|  |  |
|
||||||
|
|
||||||
## 💡 重要考量
|
## 💡 重要考量
|
||||||
|
|
||||||
- 如果最新版本的 SDK 支持隐私清单,请尽可能升级,以避免不必要的风险。
|
- 如果最新版本的 SDK 支持隐私清单,请尽可能升级,以避免不必要的风险。
|
||||||
- 此工具仅为临时解决方案,不应替代正确的 SDK 管理实践。
|
- 此工具仅为临时解决方案,不应替代正确的 SDK 管理实践。
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
module.exports = {
|
export default {
|
||||||
preset: 'ts-jest',
|
preset: 'ts-jest',
|
||||||
testEnvironment: 'node',
|
testEnvironment: 'node',
|
||||||
moduleFileExtensions: ['ts', 'js', 'json', 'vue'],
|
moduleFileExtensions: ['ts', 'js', 'json', 'vue'],
|
||||||
4856
package-lock.json
generated
4856
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
43
package.json
43
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "timesafari",
|
"name": "timesafari",
|
||||||
"version": "1.0.7-beta",
|
"version": "1.0.8-beta",
|
||||||
"description": "Time Safari Application",
|
"description": "Time Safari Application",
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Time Safari Team"
|
"name": "Time Safari Team"
|
||||||
@@ -12,6 +12,12 @@
|
|||||||
"type-check": "tsc --noEmit",
|
"type-check": "tsc --noEmit",
|
||||||
"prebuild": "eslint --ext .js,.ts,.vue --ignore-path .gitignore src && node sw_combine.js && node scripts/copy-wasm.js",
|
"prebuild": "eslint --ext .js,.ts,.vue --ignore-path .gitignore src && node sw_combine.js && node scripts/copy-wasm.js",
|
||||||
"test:prerequisites": "node scripts/check-prerequisites.js",
|
"test:prerequisites": "node scripts/check-prerequisites.js",
|
||||||
|
"test": "vitest",
|
||||||
|
"test:unit": "vitest --run",
|
||||||
|
"test:unit:watch": "vitest --watch",
|
||||||
|
"test:unit:coverage": "vitest --coverage --run",
|
||||||
|
"check:dependencies": "./scripts/check-dependencies.sh",
|
||||||
|
"test:all": "npm run lint && tsc && npm run test:web && npm run test:mobile && ./scripts/test-safety-check.sh && echo '\n\n\nGotta add the performance tests'",
|
||||||
"test:web": "npx playwright test -c playwright.config-local.ts --trace on",
|
"test:web": "npx playwright test -c playwright.config-local.ts --trace on",
|
||||||
"test:mobile": "./scripts/test-mobile.sh",
|
"test:mobile": "./scripts/test-mobile.sh",
|
||||||
"test:android": "node scripts/test-android.js",
|
"test:android": "node scripts/test-android.js",
|
||||||
@@ -27,8 +33,8 @@
|
|||||||
"build:capacitor": "VITE_GIT_HASH=`git log -1 --pretty=format:%h` vite build --mode capacitor --config vite.config.capacitor.mts",
|
"build:capacitor": "VITE_GIT_HASH=`git log -1 --pretty=format:%h` vite build --mode capacitor --config vite.config.capacitor.mts",
|
||||||
"build:capacitor:sync": "npm run build:capacitor && npx cap sync",
|
"build:capacitor:sync": "npm run build:capacitor && npx cap sync",
|
||||||
"build:native": "vite build && npx cap sync && npx capacitor-assets generate",
|
"build:native": "vite build && npx cap sync && npx capacitor-assets generate",
|
||||||
"assets:config": "tsx scripts/assets-config.ts",
|
"assets:config": "npx tsx scripts/assets-config.ts",
|
||||||
"assets:validate": "tsx scripts/assets-validator.ts",
|
"assets:validate": "npx tsx scripts/assets-validator.ts",
|
||||||
"assets:clean": "rimraf android/app/src/main/res/mipmap-* ios/App/App/Assets.xcassets/**/AppIcon*.png ios/App/App/Assets.xcassets/**/Splash*.png || true",
|
"assets:clean": "rimraf android/app/src/main/res/mipmap-* ios/App/App/Assets.xcassets/**/AppIcon*.png ios/App/App/Assets.xcassets/**/Splash*.png || true",
|
||||||
"build:ios": "./scripts/build-ios.sh",
|
"build:ios": "./scripts/build-ios.sh",
|
||||||
"build:ios:dev": "./scripts/build-ios.sh --dev",
|
"build:ios:dev": "./scripts/build-ios.sh --dev",
|
||||||
@@ -96,7 +102,14 @@
|
|||||||
"build:electron:dmg:dev": "./scripts/build-electron.sh --dev --dmg",
|
"build:electron:dmg:dev": "./scripts/build-electron.sh --dev --dmg",
|
||||||
"build:electron:dmg:test": "./scripts/build-electron.sh --test --dmg",
|
"build:electron:dmg:test": "./scripts/build-electron.sh --test --dmg",
|
||||||
"build:electron:dmg:prod": "./scripts/build-electron.sh --prod --dmg",
|
"build:electron:dmg:prod": "./scripts/build-electron.sh --prod --dmg",
|
||||||
"clean:android": "adb uninstall app.timesafari.app || true",
|
"markdown:fix": "./scripts/fix-markdown.sh",
|
||||||
|
"markdown:check": "./scripts/validate-markdown.sh",
|
||||||
|
"markdown:setup": "./scripts/setup-markdown-hooks.sh",
|
||||||
|
"prepare": "husky",
|
||||||
|
"guard": "bash ./scripts/build-arch-guard.sh",
|
||||||
|
"guard:test": "bash ./scripts/build-arch-guard.sh --staged",
|
||||||
|
"guard:setup": "npm run prepare && echo '✅ Build Architecture Guard is now active!'",
|
||||||
|
"clean:android": "./scripts/clean-android.sh",
|
||||||
"clean:ios": "rm -rf ios/App/build ios/App/Pods ios/App/output ios/App/App/public ios/DerivedData ios/capacitor-cordova-ios-plugins ios/App/App/capacitor.config.json ios/App/App/config.xml || true",
|
"clean:ios": "rm -rf ios/App/build ios/App/Pods ios/App/output ios/App/App/public ios/DerivedData ios/capacitor-cordova-ios-plugins ios/App/App/capacitor.config.json ios/App/App/config.xml || true",
|
||||||
"clean:electron": "./scripts/build-electron.sh --clean",
|
"clean:electron": "./scripts/build-electron.sh --clean",
|
||||||
"clean:all": "npm run clean:ios && npm run clean:android && npm run clean:electron",
|
"clean:all": "npm run clean:ios && npm run clean:android && npm run clean:electron",
|
||||||
@@ -122,6 +135,14 @@
|
|||||||
"build:android:dev:run:custom": "./scripts/build-android.sh --dev --api-ip --auto-run",
|
"build:android:dev:run:custom": "./scripts/build-android.sh --dev --api-ip --auto-run",
|
||||||
"build:android:test:run:custom": "./scripts/build-android.sh --test --api-ip --auto-run"
|
"build:android:test:run:custom": "./scripts/build-android.sh --test --api-ip --auto-run"
|
||||||
},
|
},
|
||||||
|
"lint-staged": {
|
||||||
|
"*.{js,ts,vue,css,md,json,yml,yaml}": "eslint --fix || true"
|
||||||
|
},
|
||||||
|
"commitlint": {
|
||||||
|
"extends": [
|
||||||
|
"@commitlint/config-conventional"
|
||||||
|
]
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@capacitor-community/electron": "^5.0.1",
|
"@capacitor-community/electron": "^5.0.1",
|
||||||
"@capacitor-community/sqlite": "6.0.2",
|
"@capacitor-community/sqlite": "6.0.2",
|
||||||
@@ -200,9 +221,9 @@
|
|||||||
"three": "^0.156.1",
|
"three": "^0.156.1",
|
||||||
"ua-parser-js": "^1.0.37",
|
"ua-parser-js": "^1.0.37",
|
||||||
"uint8arrays": "^5.0.0",
|
"uint8arrays": "^5.0.0",
|
||||||
"vue": "^3.5.13",
|
"vue": "3.5.13",
|
||||||
"vue-axios": "^3.5.2",
|
"vue-axios": "^3.5.2",
|
||||||
"vue-facing-decorator": "^3.0.4",
|
"vue-facing-decorator": "3.0.4",
|
||||||
"vue-picture-cropper": "^0.7.0",
|
"vue-picture-cropper": "^0.7.0",
|
||||||
"vue-qrcode-reader": "^5.5.3",
|
"vue-qrcode-reader": "^5.5.3",
|
||||||
"vue-router": "^4.5.0",
|
"vue-router": "^4.5.0",
|
||||||
@@ -211,6 +232,8 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@capacitor/assets": "^3.0.5",
|
"@capacitor/assets": "^3.0.5",
|
||||||
|
"@commitlint/cli": "^18.6.1",
|
||||||
|
"@commitlint/config-conventional": "^18.6.2",
|
||||||
"@playwright/test": "^1.54.2",
|
"@playwright/test": "^1.54.2",
|
||||||
"@types/dom-webcodecs": "^0.1.7",
|
"@types/dom-webcodecs": "^0.1.7",
|
||||||
"@types/jest": "^30.0.0",
|
"@types/jest": "^30.0.0",
|
||||||
@@ -226,7 +249,9 @@
|
|||||||
"@typescript-eslint/eslint-plugin": "^6.21.0",
|
"@typescript-eslint/eslint-plugin": "^6.21.0",
|
||||||
"@typescript-eslint/parser": "^6.21.0",
|
"@typescript-eslint/parser": "^6.21.0",
|
||||||
"@vitejs/plugin-vue": "^5.2.1",
|
"@vitejs/plugin-vue": "^5.2.1",
|
||||||
|
"@vitest/coverage-v8": "^2.1.9",
|
||||||
"@vue/eslint-config-typescript": "^11.0.3",
|
"@vue/eslint-config-typescript": "^11.0.3",
|
||||||
|
"@vue/test-utils": "^2.4.4",
|
||||||
"autoprefixer": "^10.4.19",
|
"autoprefixer": "^10.4.19",
|
||||||
"better-sqlite3-multiple-ciphers": "^12.1.1",
|
"better-sqlite3-multiple-ciphers": "^12.1.1",
|
||||||
"browserify-fs": "^1.0.0",
|
"browserify-fs": "^1.0.0",
|
||||||
@@ -238,7 +263,10 @@
|
|||||||
"eslint-plugin-prettier": "^5.2.1",
|
"eslint-plugin-prettier": "^5.2.1",
|
||||||
"eslint-plugin-vue": "^9.32.0",
|
"eslint-plugin-vue": "^9.32.0",
|
||||||
"fs-extra": "^11.3.0",
|
"fs-extra": "^11.3.0",
|
||||||
|
"husky": "^9.1.7",
|
||||||
"jest": "^30.0.4",
|
"jest": "^30.0.4",
|
||||||
|
"jsdom": "^24.0.0",
|
||||||
|
"lint-staged": "^15.2.2",
|
||||||
"markdownlint": "^0.37.4",
|
"markdownlint": "^0.37.4",
|
||||||
"markdownlint-cli": "^0.44.0",
|
"markdownlint-cli": "^0.44.0",
|
||||||
"npm-check-updates": "^17.1.13",
|
"npm-check-updates": "^17.1.13",
|
||||||
@@ -250,6 +278,7 @@
|
|||||||
"ts-jest": "^29.4.0",
|
"ts-jest": "^29.4.0",
|
||||||
"tsx": "^4.20.4",
|
"tsx": "^4.20.4",
|
||||||
"typescript": "~5.2.2",
|
"typescript": "~5.2.2",
|
||||||
"vite": "^5.2.0"
|
"vite": "^5.2.0",
|
||||||
|
"vitest": "^2.1.8"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ export default defineConfig({
|
|||||||
/* Retry on CI only */
|
/* Retry on CI only */
|
||||||
retries: process.env.CI ? 2 : 0,
|
retries: process.env.CI ? 2 : 0,
|
||||||
/* Opt out of parallel tests on CI. */
|
/* Opt out of parallel tests on CI. */
|
||||||
workers: isLinuxEnvironment() ? 4 : undefined,
|
workers: 1,
|
||||||
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
||||||
reporter: [
|
reporter: [
|
||||||
['list'],
|
['list'],
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
module.exports = {
|
export default {
|
||||||
plugins: {
|
plugins: {
|
||||||
tailwindcss: {},
|
tailwindcss: {},
|
||||||
autoprefixer: {},
|
autoprefixer: {},
|
||||||
47
pull_request_template.md
Normal file
47
pull_request_template.md
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# Build Architecture Guard PR Template
|
||||||
|
|
||||||
|
## Change Level
|
||||||
|
|
||||||
|
- [ ] Level: **L1** / **L2** / **L3** (pick one)
|
||||||
|
|
||||||
|
**Why:** …
|
||||||
|
|
||||||
|
## Scope & Impact
|
||||||
|
|
||||||
|
- [ ] Files & platforms touched: …
|
||||||
|
- [ ] Risk triggers (env / script flow / packaging / SW+WASM /
|
||||||
|
Docker / signing): …
|
||||||
|
- [ ] Mitigations/validation done: …
|
||||||
|
|
||||||
|
## Commands Run (paste exact logs/snips)
|
||||||
|
|
||||||
|
- [ ] Web: `npm run build:web` / `:prod`
|
||||||
|
- [ ] Electron: `npm run build:electron:dev` / package step
|
||||||
|
- [ ] Mobile: `npm run build:android:test` / iOS equivalent
|
||||||
|
- [ ] Clean/auto-run impacted scripts
|
||||||
|
|
||||||
|
## Artifacts
|
||||||
|
|
||||||
|
- [ ] Names + **sha256** of artifacts/installers:
|
||||||
|
|
||||||
|
Artifacts:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<name-1> <sha256-1>
|
||||||
|
<name-2> <sha256-2>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
|
||||||
|
- [ ] **BUILDING.md** updated (sections): …
|
||||||
|
- [ ] Troubleshooting updated (if applicable)
|
||||||
|
|
||||||
|
## Rollback
|
||||||
|
|
||||||
|
- [ ] Verified steps (1–3 cmds) to restore previous behavior
|
||||||
|
|
||||||
|
## L3 only
|
||||||
|
|
||||||
|
- [ ] ADR link:
|
||||||
|
|
||||||
|
ADR: https://…
|
||||||
@@ -27,12 +27,14 @@ resources/
|
|||||||
## Asset Requirements
|
## Asset Requirements
|
||||||
|
|
||||||
### Icon Requirements
|
### Icon Requirements
|
||||||
|
|
||||||
- **Format**: PNG
|
- **Format**: PNG
|
||||||
- **Size**: 1024x1024 pixels minimum
|
- **Size**: 1024x1024 pixels minimum
|
||||||
- **Background**: Transparent or solid color
|
- **Background**: Transparent or solid color
|
||||||
- **Content**: App logo/icon
|
- **Content**: App logo/icon
|
||||||
|
|
||||||
### Splash Screen Requirements
|
### Splash Screen Requirements
|
||||||
|
|
||||||
- **Format**: PNG
|
- **Format**: PNG
|
||||||
- **Size**: 1242x2688 pixels (iPhone 11 Pro Max size)
|
- **Size**: 1242x2688 pixels (iPhone 11 Pro Max size)
|
||||||
- **Background**: Solid color or gradient
|
- **Background**: Solid color or gradient
|
||||||
@@ -70,10 +72,11 @@ Asset generation is configured in `capacitor-assets.config.json` at the project
|
|||||||
## Build Integration
|
## Build Integration
|
||||||
|
|
||||||
Assets are automatically generated as part of the build process:
|
Assets are automatically generated as part of the build process:
|
||||||
|
|
||||||
- `npm run build:android` - Generates Android assets
|
- `npm run build:android` - Generates Android assets
|
||||||
- `npm run build:ios` - Generates iOS assets
|
- `npm run build:ios` - Generates iOS assets
|
||||||
- `npm run build:web` - Generates web assets
|
- `npm run build:web` - Generates web assets
|
||||||
|
|
||||||
**Author**: Matthew Raymer
|
**Author**: Matthew Raymer
|
||||||
**Date**: 2025-01-27
|
**Date**: 2025-01-27
|
||||||
**Status**: ✅ **ACTIVE** - Asset management system implemented
|
**Status**: ✅ **ACTIVE** - Asset management system implemented
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ All scripts automatically handle environment variables for different build types
|
|||||||
#### Automatic Environment Setup
|
#### Automatic Environment Setup
|
||||||
|
|
||||||
Each script automatically:
|
Each script automatically:
|
||||||
|
|
||||||
1. **Sets platform-specific variables** based on build type
|
1. **Sets platform-specific variables** based on build type
|
||||||
2. **Gets git hash** for versioning (`VITE_GIT_HASH`)
|
2. **Gets git hash** for versioning (`VITE_GIT_HASH`)
|
||||||
3. **Creates application directories** (`~/.local/share/TimeSafari/timesafari`)
|
3. **Creates application directories** (`~/.local/share/TimeSafari/timesafari`)
|
||||||
@@ -104,6 +105,7 @@ exit 0
|
|||||||
## Benefits of Unification
|
## Benefits of Unification
|
||||||
|
|
||||||
### Before (Redundant)
|
### Before (Redundant)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Each script had 50+ lines of duplicate code:
|
# Each script had 50+ lines of duplicate code:
|
||||||
readonly RED='\033[0;31m'
|
readonly RED='\033[0;31m'
|
||||||
@@ -121,6 +123,7 @@ export VITE_PWA_ENABLED=false
|
|||||||
```
|
```
|
||||||
|
|
||||||
### After (Unified)
|
### After (Unified)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Each script is now ~20 lines of focused logic:
|
# Each script is now ~20 lines of focused logic:
|
||||||
source "$(dirname "$0")/common.sh"
|
source "$(dirname "$0")/common.sh"
|
||||||
@@ -133,6 +136,7 @@ print_footer "Script Title"
|
|||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
### Running Tests
|
### Running Tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run all tests
|
# Run all tests
|
||||||
./scripts/test-all.sh
|
./scripts/test-all.sh
|
||||||
@@ -189,6 +193,7 @@ export NODE_ENV=production
|
|||||||
```
|
```
|
||||||
|
|
||||||
### .env File Support
|
### .env File Support
|
||||||
|
|
||||||
Scripts automatically load variables from `.env` files if they exist:
|
Scripts automatically load variables from `.env` files if they exist:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -199,6 +204,7 @@ CUSTOM_VAR=value
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Environment Validation
|
### Environment Validation
|
||||||
|
|
||||||
Required environment variables can be validated:
|
Required environment variables can be validated:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -207,6 +213,7 @@ validate_env_vars "VITE_API_URL" "VITE_DEBUG" || exit 1
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Environment Inspection
|
### Environment Inspection
|
||||||
|
|
||||||
View current environment variables with the `--env` flag:
|
View current environment variables with the `--env` flag:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -277,4 +284,4 @@ To verify the common utilities work correctly:
|
|||||||
- Timing information is automatically collected for all operations
|
- Timing information is automatically collected for all operations
|
||||||
- Build artifacts are cleaned up automatically
|
- Build artifacts are cleaned up automatically
|
||||||
- No redundant command execution or file operations
|
- No redundant command execution or file operations
|
||||||
- Environment variables are set efficiently with minimal overhead
|
- Environment variables are set efficiently with minimal overhead
|
||||||
|
|||||||
@@ -49,6 +49,31 @@ set -e
|
|||||||
# Source common utilities
|
# Source common utilities
|
||||||
source "$(dirname "$0")/common.sh"
|
source "$(dirname "$0")/common.sh"
|
||||||
|
|
||||||
|
# Function to validate critical dependencies
|
||||||
|
validate_dependencies() {
|
||||||
|
log_info "Validating critical dependencies..."
|
||||||
|
|
||||||
|
# Check if node_modules exists
|
||||||
|
if [ ! -d "node_modules" ]; then
|
||||||
|
log_error "node_modules directory not found. Please run 'npm install' first."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if tsx is available
|
||||||
|
if [ ! -f "node_modules/.bin/tsx" ]; then
|
||||||
|
log_error "tsx dependency not found. Please run 'npm install' first."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if capacitor-assets is available
|
||||||
|
if [ ! -f "node_modules/.bin/capacitor-assets" ]; then
|
||||||
|
log_error "capacitor-assets dependency not found. Please run 'npm install' first."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
log_success "All critical dependencies validated successfully"
|
||||||
|
}
|
||||||
|
|
||||||
# Default values
|
# Default values
|
||||||
BUILD_MODE="development"
|
BUILD_MODE="development"
|
||||||
BUILD_TYPE="debug"
|
BUILD_TYPE="debug"
|
||||||
@@ -179,6 +204,11 @@ parse_android_args "$@"
|
|||||||
|
|
||||||
# Print build header
|
# Print build header
|
||||||
print_header "TimeSafari Android Build Process"
|
print_header "TimeSafari Android Build Process"
|
||||||
|
|
||||||
|
# Validate dependencies before proceeding
|
||||||
|
validate_dependencies
|
||||||
|
|
||||||
|
# Log build start
|
||||||
log_info "Starting Android build process at $(date)"
|
log_info "Starting Android build process at $(date)"
|
||||||
log_info "Build mode: $BUILD_MODE"
|
log_info "Build mode: $BUILD_MODE"
|
||||||
log_info "Build type: $BUILD_TYPE"
|
log_info "Build type: $BUILD_TYPE"
|
||||||
@@ -257,6 +287,7 @@ fi
|
|||||||
# Step 1: Validate asset configuration
|
# Step 1: Validate asset configuration
|
||||||
safe_execute "Validating asset configuration" "npm run assets:validate" || {
|
safe_execute "Validating asset configuration" "npm run assets:validate" || {
|
||||||
log_warn "Asset validation found issues, but continuing with build..."
|
log_warn "Asset validation found issues, but continuing with build..."
|
||||||
|
log_info "If you encounter build failures, please run 'npm install' first to ensure all dependencies are available."
|
||||||
}
|
}
|
||||||
|
|
||||||
# Step 2: Clean Android app
|
# Step 2: Clean Android app
|
||||||
@@ -337,6 +368,9 @@ if [ "$OPEN_STUDIO" = true ]; then
|
|||||||
log_info "Android Studio: opened"
|
log_info "Android Studio: opened"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# Reminder about dependency management
|
||||||
|
log_info "💡 Tip: If you encounter dependency issues, run 'npm install' to ensure all packages are up to date."
|
||||||
|
|
||||||
print_footer "Android Build"
|
print_footer "Android Build"
|
||||||
|
|
||||||
# Exit with success
|
# Exit with success
|
||||||
|
|||||||
187
scripts/build-arch-guard.sh
Executable file
187
scripts/build-arch-guard.sh
Executable file
@@ -0,0 +1,187 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Build Architecture Guard Script
|
||||||
|
#
|
||||||
|
# Author: Matthew Raymer
|
||||||
|
# Date: 2025-08-20
|
||||||
|
# Purpose: Protects build-critical files by requiring BUILDING.md updates
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./scripts/build-arch-guard.sh --staged # Check staged files (pre-commit)
|
||||||
|
# ./scripts/build-arch-guard.sh --range # Check range (pre-push)
|
||||||
|
# ./scripts/build-arch-guard.sh # Check working directory
|
||||||
|
#
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
# Sensitive paths that require BUILDING.md updates when modified
|
||||||
|
SENSITIVE=(
|
||||||
|
"vite.config.*"
|
||||||
|
"scripts/**"
|
||||||
|
"electron/**"
|
||||||
|
"android/**"
|
||||||
|
"ios/**"
|
||||||
|
"sw_scripts/**"
|
||||||
|
"sw_combine.js"
|
||||||
|
"Dockerfile"
|
||||||
|
"docker/**"
|
||||||
|
"capacitor.config.ts"
|
||||||
|
"package.json"
|
||||||
|
"package-lock.json"
|
||||||
|
"yarn.lock"
|
||||||
|
"pnpm-lock.yaml"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Documentation files that must be updated alongside sensitive changes
|
||||||
|
DOCS_REQUIRED=("BUILDING.md")
|
||||||
|
|
||||||
|
# Colors for output
|
||||||
|
RED='\033[0;31m'
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
YELLOW='\033[1;33m'
|
||||||
|
BLUE='\033[0;34m'
|
||||||
|
NC='\033[0m' # No Color
|
||||||
|
|
||||||
|
log_info() {
|
||||||
|
echo -e "${BLUE}[guard]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
log_warn() {
|
||||||
|
echo -e "${YELLOW}[guard]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
log_error() {
|
||||||
|
echo -e "${RED}[guard]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
log_success() {
|
||||||
|
echo -e "${GREEN}[guard]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Collect files based on mode
|
||||||
|
collect_files() {
|
||||||
|
if [[ "${1:-}" == "--staged" ]]; then
|
||||||
|
# Pre-commit: check staged files
|
||||||
|
git diff --name-only --cached
|
||||||
|
elif [[ "${1:-}" == "--range" ]]; then
|
||||||
|
# Pre-push: check commits being pushed
|
||||||
|
RANGE="${2:-HEAD~1..HEAD}"
|
||||||
|
git diff --name-only "$RANGE"
|
||||||
|
else
|
||||||
|
# Default: check working directory changes
|
||||||
|
git diff --name-only HEAD
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if a file matches any sensitive pattern
|
||||||
|
matches_sensitive() {
|
||||||
|
local f="$1"
|
||||||
|
for pat in "${SENSITIVE[@]}"; do
|
||||||
|
# Convert glob pattern to regex
|
||||||
|
local rx="^${pat//\./\.}$"
|
||||||
|
rx="${rx//\*\*/.*}"
|
||||||
|
rx="${rx//\*/[^/]*}"
|
||||||
|
|
||||||
|
if [[ "$f" =~ $rx ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if documentation was updated
|
||||||
|
check_docs_updated() {
|
||||||
|
local changed_files=("$@")
|
||||||
|
|
||||||
|
for changed_file in "${changed_files[@]}"; do
|
||||||
|
for required_doc in "${DOCS_REQUIRED[@]}"; do
|
||||||
|
if [[ "$changed_file" == "$required_doc" ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Main guard logic
|
||||||
|
main() {
|
||||||
|
local mode="${1:-}"
|
||||||
|
local arg="${2:-}"
|
||||||
|
|
||||||
|
log_info "Running Build Architecture Guard..."
|
||||||
|
|
||||||
|
# Collect changed files
|
||||||
|
mapfile -t changed_files < <(collect_files "$mode" "$arg")
|
||||||
|
|
||||||
|
if [[ ${#changed_files[@]} -eq 0 ]]; then
|
||||||
|
log_info "No files changed, guard check passed"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
log_info "Checking ${#changed_files[@]} changed files..."
|
||||||
|
|
||||||
|
# Find sensitive files that were touched
|
||||||
|
sensitive_touched=()
|
||||||
|
for file in "${changed_files[@]}"; do
|
||||||
|
if matches_sensitive "$file"; then
|
||||||
|
sensitive_touched+=("$file")
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# If no sensitive files were touched, allow the change
|
||||||
|
if [[ ${#sensitive_touched[@]} -eq 0 ]]; then
|
||||||
|
log_success "No build-sensitive files changed, guard check passed"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Sensitive files were touched, log them
|
||||||
|
log_warn "Build-sensitive paths changed:"
|
||||||
|
for file in "${sensitive_touched[@]}"; do
|
||||||
|
echo " - $file"
|
||||||
|
done
|
||||||
|
|
||||||
|
# Check if required documentation was updated
|
||||||
|
if check_docs_updated "${changed_files[@]}"; then
|
||||||
|
log_success "BUILDING.md updated alongside build changes, guard check passed"
|
||||||
|
exit 0
|
||||||
|
else
|
||||||
|
log_error "Build-sensitive files changed but BUILDING.md was not updated!"
|
||||||
|
echo
|
||||||
|
echo "The following build-sensitive files were modified:"
|
||||||
|
for file in "${sensitive_touched[@]}"; do
|
||||||
|
echo " - $file"
|
||||||
|
done
|
||||||
|
echo
|
||||||
|
echo "When modifying build-critical files, you must also update BUILDING.md"
|
||||||
|
echo "to document any changes to the build process."
|
||||||
|
echo
|
||||||
|
echo "Please:"
|
||||||
|
echo " 1. Update BUILDING.md with relevant changes"
|
||||||
|
echo " 2. Stage the BUILDING.md changes: git add BUILDING.md"
|
||||||
|
echo " 3. Retry your commit/push"
|
||||||
|
echo
|
||||||
|
exit 2
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Handle help flag
|
||||||
|
if [[ "${1:-}" =~ ^(-h|--help)$ ]]; then
|
||||||
|
echo "Build Architecture Guard Script"
|
||||||
|
echo
|
||||||
|
echo "Usage:"
|
||||||
|
echo " $0 [--staged|--range [RANGE]]"
|
||||||
|
echo
|
||||||
|
echo "Options:"
|
||||||
|
echo " --staged Check staged files (for pre-commit hook)"
|
||||||
|
echo " --range [RANGE] Check git range (for pre-push hook)"
|
||||||
|
echo " Default range: HEAD~1..HEAD"
|
||||||
|
echo " (no args) Check working directory changes"
|
||||||
|
echo
|
||||||
|
echo "Examples:"
|
||||||
|
echo " $0 --staged # Pre-commit check"
|
||||||
|
echo " $0 --range origin/main..HEAD # Pre-push check"
|
||||||
|
echo " $0 # Working directory check"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
main "$@"
|
||||||
@@ -173,20 +173,20 @@ check_ios_resources() {
|
|||||||
|
|
||||||
# Check for required assets
|
# Check for required assets
|
||||||
if [ ! -f "assets/icon.png" ]; then
|
if [ ! -f "assets/icon.png" ]; then
|
||||||
log_warning "App icon not found at assets/icon.png"
|
log_warn "App icon not found at assets/icon.png"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ ! -f "assets/splash.png" ]; then
|
if [ ! -f "assets/splash.png" ]; then
|
||||||
log_warning "Splash screen not found at assets/splash.png"
|
log_warn "Splash screen not found at assets/splash.png"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Check for iOS-specific files
|
# Check for iOS-specific files
|
||||||
if [ ! -f "ios/App/App/Info.plist" ]; then
|
if [ ! -f "ios/App/App/Info.plist" ]; then
|
||||||
log_warning "Info.plist not found"
|
log_warn "Info.plist not found"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ ! -f "ios/App/App/AppDelegate.swift" ]; then
|
if [ ! -f "ios/App/App/AppDelegate.swift" ]; then
|
||||||
log_warning "AppDelegate.swift not found"
|
log_warn "AppDelegate.swift not found"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
log_success "iOS resource check completed"
|
log_success "iOS resource check completed"
|
||||||
|
|||||||
110
scripts/check-dependencies.sh
Executable file
110
scripts/check-dependencies.sh
Executable file
@@ -0,0 +1,110 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# check-dependencies.sh
|
||||||
|
# Author: Matthew Raymer
|
||||||
|
# Date: 2025-08-19
|
||||||
|
# Description: Dependency validation script for TimeSafari development environment
|
||||||
|
# This script checks for critical dependencies required for building the application.
|
||||||
|
|
||||||
|
# Exit on any error
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Source common utilities
|
||||||
|
source "$(dirname "$0")/common.sh"
|
||||||
|
|
||||||
|
print_header "TimeSafari Dependency Validation"
|
||||||
|
|
||||||
|
log_info "Checking development environment dependencies..."
|
||||||
|
|
||||||
|
# Check Node.js version
|
||||||
|
if command -v node &> /dev/null; then
|
||||||
|
NODE_VERSION=$(node --version)
|
||||||
|
log_info "Node.js version: $NODE_VERSION"
|
||||||
|
|
||||||
|
# Extract major version number
|
||||||
|
MAJOR_VERSION=$(echo $NODE_VERSION | sed 's/v\([0-9]*\)\..*/\1/')
|
||||||
|
if [ "$MAJOR_VERSION" -lt 18 ]; then
|
||||||
|
log_error "Node.js version $NODE_VERSION is too old. Please upgrade to Node.js 18 or later."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_error "Node.js is not installed. Please install Node.js 18 or later."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check npm version
|
||||||
|
if command -v npm &> /dev/null; then
|
||||||
|
NPM_VERSION=$(npm --version)
|
||||||
|
log_info "npm version: $NPM_VERSION"
|
||||||
|
else
|
||||||
|
log_error "npm is not installed. Please install npm."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if node_modules exists
|
||||||
|
if [ ! -d "node_modules" ]; then
|
||||||
|
log_error "node_modules directory not found."
|
||||||
|
log_info "Please run: npm install"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check critical dependencies
|
||||||
|
log_info "Validating critical packages..."
|
||||||
|
|
||||||
|
CRITICAL_DEPS=("tsx" "capacitor-assets" "vite")
|
||||||
|
|
||||||
|
for dep in "${CRITICAL_DEPS[@]}"; do
|
||||||
|
if [ -f "node_modules/.bin/$dep" ]; then
|
||||||
|
log_success "✓ $dep found"
|
||||||
|
else
|
||||||
|
log_error "✗ $dep not found in node_modules/.bin"
|
||||||
|
log_info "This usually means the package wasn't installed properly."
|
||||||
|
log_info "Try running: npm install"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Check TypeScript via npx
|
||||||
|
if npx tsc --version &> /dev/null; then
|
||||||
|
TSC_VERSION=$(npx tsc --version)
|
||||||
|
log_success "✓ TypeScript found: $TSC_VERSION"
|
||||||
|
else
|
||||||
|
log_error "✗ TypeScript not accessible via npx"
|
||||||
|
log_info "Try running: npm install"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check Capacitor CLI
|
||||||
|
if command -v npx &> /dev/null; then
|
||||||
|
if npx cap --version &> /dev/null; then
|
||||||
|
CAP_VERSION=$(npx cap --version)
|
||||||
|
log_success "✓ Capacitor CLI version: $CAP_VERSION"
|
||||||
|
else
|
||||||
|
log_error "✗ Capacitor CLI not accessible via npx"
|
||||||
|
log_info "Try running: npm install @capacitor/cli"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_error "npx is not available. Please ensure npm is properly installed."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check Android development tools
|
||||||
|
if command -v adb &> /dev/null; then
|
||||||
|
log_success "✓ Android Debug Bridge (adb) found"
|
||||||
|
else
|
||||||
|
log_warn "⚠ Android Debug Bridge (adb) not found"
|
||||||
|
log_info "This is only needed for Android development and testing."
|
||||||
|
fi
|
||||||
|
|
||||||
|
if command -v gradle &> /dev/null; then
|
||||||
|
GRADLE_VERSION=$(gradle --version | head -n 1)
|
||||||
|
log_success "✓ Gradle found: $GRADLE_VERSION"
|
||||||
|
else
|
||||||
|
log_warn "⚠ Gradle not found in PATH"
|
||||||
|
log_info "This is only needed if building outside of Android Studio."
|
||||||
|
fi
|
||||||
|
|
||||||
|
log_success "Dependency validation completed successfully!"
|
||||||
|
log_info "Your development environment is ready for TimeSafari development."
|
||||||
|
|
||||||
|
print_footer "Dependency Validation"
|
||||||
62
scripts/clean-android.sh
Executable file
62
scripts/clean-android.sh
Executable file
@@ -0,0 +1,62 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
# clean-android.sh
|
||||||
|
# Author: Matthew Raymer
|
||||||
|
# Date: 2025-08-19
|
||||||
|
# Description: Clean Android app with timeout protection to prevent hanging
|
||||||
|
# This script safely uninstalls the TimeSafari app from connected Android devices
|
||||||
|
# with a 30-second timeout to prevent indefinite hanging.
|
||||||
|
|
||||||
|
# Exit on any error
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Source common utilities
|
||||||
|
source "$(dirname "$0")/common.sh"
|
||||||
|
|
||||||
|
# Function to implement timeout for systems without timeout command
|
||||||
|
timeout_command() {
|
||||||
|
local timeout_seconds="$1"
|
||||||
|
shift
|
||||||
|
|
||||||
|
# Check if timeout command exists
|
||||||
|
if command -v timeout &> /dev/null; then
|
||||||
|
timeout "$timeout_seconds" "$@"
|
||||||
|
else
|
||||||
|
# Fallback for systems without timeout (like macOS)
|
||||||
|
# Use perl to implement timeout
|
||||||
|
perl -e '
|
||||||
|
eval {
|
||||||
|
local $SIG{ALRM} = sub { die "timeout" };
|
||||||
|
alarm shift;
|
||||||
|
system @ARGV;
|
||||||
|
alarm 0;
|
||||||
|
};
|
||||||
|
if ($@) { exit 1; }
|
||||||
|
' "$timeout_seconds" "$@"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
log_info "Starting Android cleanup process..."
|
||||||
|
|
||||||
|
# Check if adb is available
|
||||||
|
if ! command -v adb &> /dev/null; then
|
||||||
|
log_error "adb command not found. Please install Android SDK Platform Tools."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check for connected devices
|
||||||
|
log_info "Checking for connected Android devices..."
|
||||||
|
if adb devices | grep -q 'device$'; then
|
||||||
|
log_info "Android device(s) found. Attempting to uninstall app..."
|
||||||
|
|
||||||
|
# Try to uninstall with timeout
|
||||||
|
if timeout_command 30 adb uninstall app.timesafari.app; then
|
||||||
|
log_success "Successfully uninstalled TimeSafari app"
|
||||||
|
else
|
||||||
|
log_warn "Uninstall failed or timed out after 30 seconds"
|
||||||
|
log_info "This is normal if the app wasn't installed or device is unresponsive"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_info "No Android devices connected. Skipping uninstall."
|
||||||
|
fi
|
||||||
|
|
||||||
|
log_success "Android cleanup process completed"
|
||||||
19
scripts/fix-markdown.sh
Executable file
19
scripts/fix-markdown.sh
Executable file
@@ -0,0 +1,19 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
echo "🔧 Auto-fixing markdown formatting..."
|
||||||
|
|
||||||
|
# Check if markdownlint is available
|
||||||
|
if ! command -v npx &> /dev/null; then
|
||||||
|
echo "❌ npx not found. Please install Node.js and npm first."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run markdownlint with auto-fix on project markdown files (exclude node_modules)
|
||||||
|
echo "📝 Fixing project markdown files..."
|
||||||
|
npx markdownlint "*.md" "*.mdc" "scripts/**/*.md" "src/**/*.md" "test-playwright/**/*.md" "resources/**/*.md" --config .markdownlint.json --fix 2>/dev/null || {
|
||||||
|
echo "⚠️ Some issues could not be auto-fixed. Check manually."
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "✅ Markdown auto-fix complete!"
|
||||||
|
echo "💡 Run 'npm run markdown:check' to verify all issues are resolved."
|
||||||
124
scripts/git-hooks/README.md
Normal file
124
scripts/git-hooks/README.md
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
# TimeSafari Git Hooks
|
||||||
|
|
||||||
|
This directory contains custom Git hooks for the TimeSafari project.
|
||||||
|
|
||||||
|
## Debug Code Checker Hook
|
||||||
|
|
||||||
|
### Overview
|
||||||
|
|
||||||
|
The `pre-commit` hook automatically checks for debug code when committing to protected branches (master, main, production, release). This prevents debug statements from accidentally reaching production code.
|
||||||
|
|
||||||
|
### How It Works
|
||||||
|
|
||||||
|
1. **Branch Detection**: Only runs on protected branches (configurable)
|
||||||
|
2. **File Filtering**: Automatically skips test files, scripts, and documentation
|
||||||
|
3. **Pattern Matching**: Detects common debug patterns using regex
|
||||||
|
4. **Commit Prevention**: Blocks commits containing debug code
|
||||||
|
|
||||||
|
### Protected Branches (Default)
|
||||||
|
|
||||||
|
- `master`
|
||||||
|
- `main`
|
||||||
|
- `production`
|
||||||
|
- `release`
|
||||||
|
- `stable`
|
||||||
|
|
||||||
|
### Debug Patterns Detected
|
||||||
|
|
||||||
|
- **Console statements**: `console.log`, `console.debug`, `console.error`
|
||||||
|
- **Template debug**: `Debug:`, `debug:` in Vue templates
|
||||||
|
- **Debug constants**: `DEBUG_`, `debug_` variables
|
||||||
|
- **HTML debug**: `<!-- debug` comments
|
||||||
|
- **Debug attributes**: `debug="true"` attributes
|
||||||
|
- **Vue debug**: `v-if="debug"`, `v-show="debug"`
|
||||||
|
- **Debug TODOs**: `TODO debug`, `FIXME debug`
|
||||||
|
|
||||||
|
### Files Automatically Skipped
|
||||||
|
|
||||||
|
- Test files: `*.test.js`, `*.spec.ts`, `*.test.vue`
|
||||||
|
- Scripts: `scripts/` directory
|
||||||
|
- Test directories: `test-*` directories
|
||||||
|
- Documentation: `docs/`, `*.md`, `*.txt`
|
||||||
|
- Config files: `*.json`, `*.yml`, `*.yaml`
|
||||||
|
- IDE files: `.cursor/` directory
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
Edit `.git/hooks/debug-checker.config` to customize:
|
||||||
|
|
||||||
|
- Protected branches
|
||||||
|
- Debug patterns
|
||||||
|
- Skip patterns
|
||||||
|
- Logging level
|
||||||
|
|
||||||
|
### Testing the Hook
|
||||||
|
|
||||||
|
Run the test script to verify the hook works:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./scripts/test-debug-hook.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Manual Testing
|
||||||
|
|
||||||
|
1. Make changes to a file with debug code
|
||||||
|
2. Stage the file: `git add <filename>`
|
||||||
|
3. Try to commit: `git commit -m 'test'`
|
||||||
|
4. Hook should prevent commit if debug code is found
|
||||||
|
|
||||||
|
### Bypassing the Hook (Emergency)
|
||||||
|
|
||||||
|
If you absolutely need to commit debug code to a protected branch:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git commit --no-verify -m "emergency: debug code needed"
|
||||||
|
```
|
||||||
|
|
||||||
|
⚠️ **Warning**: This bypasses all pre-commit hooks. Use sparingly and only in emergencies.
|
||||||
|
|
||||||
|
### Troubleshooting
|
||||||
|
|
||||||
|
#### Hook not running
|
||||||
|
|
||||||
|
- Ensure the hook is executable: `chmod +x .git/hooks/pre-commit`
|
||||||
|
- Check if you're on a protected branch
|
||||||
|
- Verify the hook file exists and has correct permissions
|
||||||
|
|
||||||
|
#### False positives
|
||||||
|
|
||||||
|
- Add legitimate debug patterns to skip patterns in config
|
||||||
|
- Use proper logging levels (`logger.info`, `logger.debug`) instead of console
|
||||||
|
- Move debug code to feature branches first
|
||||||
|
|
||||||
|
#### Hook too strict
|
||||||
|
|
||||||
|
- Modify debug patterns in config file
|
||||||
|
- Add more file types to skip patterns
|
||||||
|
- Adjust protected branch list
|
||||||
|
|
||||||
|
### Best Practices
|
||||||
|
|
||||||
|
1. **Use feature branches** for development with debug code
|
||||||
|
2. **Use proper logging** instead of console statements
|
||||||
|
3. **Test thoroughly** before merging to protected branches
|
||||||
|
4. **Review commits** to ensure no debug code slips through
|
||||||
|
5. **Keep config updated** as project needs change
|
||||||
|
|
||||||
|
### Integration with CI/CD
|
||||||
|
|
||||||
|
This hook works locally. For CI/CD pipelines, consider:
|
||||||
|
|
||||||
|
- Running the same checks in your build process
|
||||||
|
- Adding ESLint rules for console statements
|
||||||
|
- Using TypeScript strict mode
|
||||||
|
- Adding debug code detection to PR checks
|
||||||
|
|
||||||
|
### Support
|
||||||
|
|
||||||
|
If you encounter issues:
|
||||||
|
|
||||||
|
1. Check the hook output for specific error messages
|
||||||
|
2. Verify your branch is in the protected list
|
||||||
|
3. Review the configuration file
|
||||||
|
4. Test with the provided test script
|
||||||
|
5. Check file permissions and git setup
|
||||||
86
scripts/git-hooks/debug-checker.config
Normal file
86
scripts/git-hooks/debug-checker.config
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
# TimeSafari Debug Checker Configuration
|
||||||
|
# Edit this file to customize protected branches and debug patterns
|
||||||
|
|
||||||
|
# Protected branches where debug code checking is enforced
|
||||||
|
# Add or remove branches as needed
|
||||||
|
PROTECTED_BRANCHES=(
|
||||||
|
"master"
|
||||||
|
"main"
|
||||||
|
"production"
|
||||||
|
"release"
|
||||||
|
"stable"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Debug patterns to detect (regex patterns)
|
||||||
|
# Add or remove patterns as needed
|
||||||
|
DEBUG_PATTERNS=(
|
||||||
|
# Console statements
|
||||||
|
"console\."
|
||||||
|
|
||||||
|
# Template debug text
|
||||||
|
"Debug:"
|
||||||
|
"debug:"
|
||||||
|
|
||||||
|
# Debug constants and variables
|
||||||
|
"DEBUG_"
|
||||||
|
"debug_"
|
||||||
|
|
||||||
|
# HTML debug comments
|
||||||
|
"<!-- debug"
|
||||||
|
|
||||||
|
# Debug attributes
|
||||||
|
"debug.*="
|
||||||
|
|
||||||
|
# Vue debug patterns
|
||||||
|
"v-if.*debug"
|
||||||
|
"v-show.*debug"
|
||||||
|
|
||||||
|
# Common debug text
|
||||||
|
"TODO.*debug"
|
||||||
|
"FIXME.*debug"
|
||||||
|
|
||||||
|
# Debug imports (uncomment if you want to catch these)
|
||||||
|
# "import.*debug"
|
||||||
|
# "require.*debug"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Files and directories to skip during checking
|
||||||
|
# Add patterns to exclude from debug checking
|
||||||
|
SKIP_PATTERNS=(
|
||||||
|
"\.(test|spec)\.(js|ts|vue)$" # Test files (must have .test. or .spec.)
|
||||||
|
"^scripts/" # Scripts directory
|
||||||
|
"^test-.*/" # Test directories (must end with /)
|
||||||
|
"^\.git/" # Git directory
|
||||||
|
"^node_modules/" # Dependencies
|
||||||
|
"^docs/" # Documentation
|
||||||
|
"^\.cursor/" # Cursor IDE files
|
||||||
|
"\.md$" # Markdown files
|
||||||
|
"\.txt$" # Text files
|
||||||
|
"\.json$" # JSON config files
|
||||||
|
"\.yml$" # YAML config files
|
||||||
|
"\.yaml$" # YAML config files
|
||||||
|
)
|
||||||
|
|
||||||
|
# Files that are whitelisted for console statements
|
||||||
|
# These files may contain intentional console.log statements that are
|
||||||
|
# properly whitelisted with eslint-disable-next-line no-console comments
|
||||||
|
WHITELIST_FILES=(
|
||||||
|
"src/services/platforms/WebPlatformService.ts" # Worker context logging
|
||||||
|
"src/services/platforms/CapacitorPlatformService.ts" # Platform-specific logging
|
||||||
|
"src/services/platforms/ElectronPlatformService.ts" # Electron-specific logging
|
||||||
|
"src/services/QRScanner/.*" # QR Scanner services
|
||||||
|
"src/utils/logger.ts" # Logger utility itself
|
||||||
|
"src/utils/LogCollector.ts" # Log collection utilities
|
||||||
|
"scripts/.*" # Build and utility scripts
|
||||||
|
"test-.*/.*" # Test directories
|
||||||
|
".*\.test\..*" # Test files
|
||||||
|
".*\.spec\..*" # Spec files
|
||||||
|
)
|
||||||
|
|
||||||
|
# Logging level (debug, info, warn, error)
|
||||||
|
LOG_LEVEL="info"
|
||||||
|
|
||||||
|
# Exit codes
|
||||||
|
EXIT_SUCCESS=0
|
||||||
|
EXIT_DEBUG_FOUND=1
|
||||||
|
EXIT_ERROR=2
|
||||||
252
scripts/git-hooks/pre-commit
Executable file
252
scripts/git-hooks/pre-commit
Executable file
@@ -0,0 +1,252 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# TimeSafari Pre-commit Hook - Debug Code Checker
|
||||||
|
# Only runs on master or specified branches to catch debug code before it reaches production
|
||||||
|
|
||||||
|
# Hook directory
|
||||||
|
HOOK_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
|
CONFIG_FILE="$HOOK_DIR/debug-checker.config"
|
||||||
|
|
||||||
|
# Default configuration (fallback if config file is missing)
|
||||||
|
DEFAULT_PROTECTED_BRANCHES=("master" "main" "production" "release")
|
||||||
|
DEFAULT_DEBUG_PATTERNS=(
|
||||||
|
"console\."
|
||||||
|
"Debug:"
|
||||||
|
"debug:"
|
||||||
|
"DEBUG_"
|
||||||
|
"debug_"
|
||||||
|
"<!-- debug"
|
||||||
|
"debug.*="
|
||||||
|
)
|
||||||
|
DEFAULT_WHITELIST_FILES=(
|
||||||
|
"src/services/platforms/WebPlatformService.ts"
|
||||||
|
"src/services/platforms/CapacitorPlatformService.ts"
|
||||||
|
"src/services/platforms/ElectronPlatformService.ts"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Load configuration from file if it exists
|
||||||
|
load_config() {
|
||||||
|
if [[ -f "$CONFIG_FILE" ]]; then
|
||||||
|
# Source the config file to load variables
|
||||||
|
# We'll use a safer approach by reading and parsing
|
||||||
|
PROTECTED_BRANCHES=()
|
||||||
|
DEBUG_PATTERNS=()
|
||||||
|
SKIP_PATTERNS=()
|
||||||
|
WHITELIST_FILES=()
|
||||||
|
|
||||||
|
# Read protected branches
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^PROTECTED_BRANCHES=\( ]]; then
|
||||||
|
# Start reading array
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^\)$ ]]; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
if [[ "$line" =~ \"([^\"]+)\" ]]; then
|
||||||
|
PROTECTED_BRANCHES+=("${BASH_REMATCH[1]}")
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
done < "$CONFIG_FILE"
|
||||||
|
|
||||||
|
# Read debug patterns
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^DEBUG_PATTERNS=\( ]]; then
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^\)$ ]]; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
if [[ "$line" =~ \"([^\"]+)\" ]]; then
|
||||||
|
DEBUG_PATTERNS+=("${BASH_REMATCH[1]}")
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
done < "$CONFIG_FILE"
|
||||||
|
|
||||||
|
# Read skip patterns
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^SKIP_PATTERNS=\( ]]; then
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^\)$ ]]; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
if [[ "$line" =~ \"([^\"]+)\" ]]; then
|
||||||
|
SKIP_PATTERNS+=("${BASH_REMATCH[1]}")
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
done < "$CONFIG_FILE"
|
||||||
|
|
||||||
|
# Read whitelist files
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^WHITELIST_FILES=\( ]]; then
|
||||||
|
while IFS= read -r line; do
|
||||||
|
if [[ "$line" =~ ^\)$ ]]; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
if [[ "$line" =~ \"([^\"]+)\" ]]; then
|
||||||
|
WHITELIST_FILES+=("${BASH_REMATCH[1]}")
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
done < "$CONFIG_FILE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use defaults if config loading failed
|
||||||
|
if [[ ${#PROTECTED_BRANCHES[@]} -eq 0 ]]; then
|
||||||
|
PROTECTED_BRANCHES=("${DEFAULT_PROTECTED_BRANCHES[@]}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${#DEBUG_PATTERNS[@]} -eq 0 ]]; then
|
||||||
|
DEBUG_PATTERNS=("${DEFAULT_DEBUG_PATTERNS[@]}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${#SKIP_PATTERNS[@]} -eq 0 ]]; then
|
||||||
|
SKIP_PATTERNS=("${DEFAULT_SKIP_PATTERNS[@]}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${#WHITELIST_FILES[@]} -eq 0 ]]; then
|
||||||
|
WHITELIST_FILES=("${DEFAULT_WHITELIST_FILES[@]}")
|
||||||
|
fi
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if current branch is protected
|
||||||
|
is_protected_branch() {
|
||||||
|
local branch="$1"
|
||||||
|
for protected in "${PROTECTED_BRANCHES[@]}"; do
|
||||||
|
if [[ "$branch" == "$protected" ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if file should be skipped
|
||||||
|
should_skip_file() {
|
||||||
|
local file="$1"
|
||||||
|
for pattern in "${SKIP_PATTERNS[@]}"; do
|
||||||
|
if [[ "$file" =~ $pattern ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if file is whitelisted for console statements
|
||||||
|
is_whitelisted_file() {
|
||||||
|
local file="$1"
|
||||||
|
for whitelisted in "${WHITELIST_FILES[@]}"; do
|
||||||
|
if [[ "$file" =~ $whitelisted ]]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Main execution
|
||||||
|
main() {
|
||||||
|
# Load configuration
|
||||||
|
load_config
|
||||||
|
|
||||||
|
# Get current branch name
|
||||||
|
CURRENT_BRANCH=$(git symbolic-ref --short HEAD 2>/dev/null)
|
||||||
|
|
||||||
|
if [[ -z "$CURRENT_BRANCH" ]]; then
|
||||||
|
echo "⚠️ Could not determine current branch, skipping debug check"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if we should run the hook
|
||||||
|
if ! is_protected_branch "$CURRENT_BRANCH"; then
|
||||||
|
echo "🔒 Pre-commit hook skipped - not on protected branch ($CURRENT_BRANCH)"
|
||||||
|
echo " Protected branches: ${PROTECTED_BRANCHES[*]}"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "🔍 Running debug code check on protected branch: $CURRENT_BRANCH"
|
||||||
|
echo " Using config: $CONFIG_FILE"
|
||||||
|
|
||||||
|
# Get all staged files (modified, added, copied, merged)
|
||||||
|
ALL_STAGED_FILES=$(git diff --cached --name-only)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
if [ -z "$ALL_STAGED_FILES" ]; then
|
||||||
|
echo "✅ No staged files to check"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Initialize error tracking
|
||||||
|
ERRORS_FOUND=0
|
||||||
|
ERROR_MESSAGES=()
|
||||||
|
FILES_CHECKED=0
|
||||||
|
|
||||||
|
# Check each staged file for debug patterns
|
||||||
|
for file in $ALL_STAGED_FILES; do
|
||||||
|
# Skip files that should be ignored
|
||||||
|
if should_skip_file "$file"; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
FILES_CHECKED=$((FILES_CHECKED + 1))
|
||||||
|
|
||||||
|
# Check for debug patterns in the file
|
||||||
|
for pattern in "${DEBUG_PATTERNS[@]}"; do
|
||||||
|
# Skip console pattern checks for whitelisted files
|
||||||
|
if [[ "$pattern" == "console\." ]] && is_whitelisted_file "$file"; then
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For new files, check the file content directly
|
||||||
|
# For modified files, check the staged diff
|
||||||
|
if [[ -f "$file" ]]; then
|
||||||
|
# New file - check content directly
|
||||||
|
if grep -E "$pattern" "$file" > /dev/null; then
|
||||||
|
ERRORS_FOUND=$((ERRORS_FOUND + 1))
|
||||||
|
ERROR_MESSAGES+=("🚨 $file: Found debug pattern '$pattern'")
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
# Modified file - check staged diff
|
||||||
|
if git diff --cached "$file" | grep -E "$pattern" > /dev/null; then
|
||||||
|
ERRORS_FOUND=$((ERRORS_FOUND + 1))
|
||||||
|
ERROR_MESSAGES+=("🚨 $file: Found debug pattern '$pattern'")
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
done
|
||||||
|
|
||||||
|
# Report results
|
||||||
|
if [ $ERRORS_FOUND -gt 0 ]; then
|
||||||
|
echo ""
|
||||||
|
echo "❌ Debug code detected in staged files!"
|
||||||
|
echo " Branch: $CURRENT_BRANCH"
|
||||||
|
echo " Files checked: $FILES_CHECKED"
|
||||||
|
echo " Errors found: $ERRORS_FOUND"
|
||||||
|
echo ""
|
||||||
|
for msg in "${ERROR_MESSAGES[@]}"; do
|
||||||
|
echo " $msg"
|
||||||
|
done
|
||||||
|
echo ""
|
||||||
|
echo "💡 Please remove debug code before committing to $CURRENT_BRANCH"
|
||||||
|
echo " Common debug patterns to check:"
|
||||||
|
echo " - console.log, console.debug, console.error"
|
||||||
|
echo " - Debug: or debug: in templates"
|
||||||
|
echo " - DEBUG_ constants"
|
||||||
|
echo " - HTML comments with debug"
|
||||||
|
echo ""
|
||||||
|
echo " If debug code is intentional, consider:"
|
||||||
|
echo " - Moving to a feature branch first"
|
||||||
|
echo " - Using proper logging levels (logger.info, logger.debug)"
|
||||||
|
echo " - Adding debug code to .gitignore or .debugignore"
|
||||||
|
echo ""
|
||||||
|
echo " Configuration file: $CONFIG_FILE"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "✅ No debug code found in $FILES_CHECKED staged files"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Run main function
|
||||||
|
main "$@"
|
||||||
171
scripts/install-debug-hook.sh
Executable file
171
scripts/install-debug-hook.sh
Executable file
@@ -0,0 +1,171 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# TimeSafari Debug Hook Installer
|
||||||
|
# Run this script in any repository to install the debug pre-commit hook
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
# Colors for output
|
||||||
|
RED='\033[0;31m'
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
YELLOW='\033[1;33m'
|
||||||
|
BLUE='\033[0;34m'
|
||||||
|
NC='\033[0m' # No Color
|
||||||
|
|
||||||
|
echo -e "${BLUE}🔧 TimeSafari Debug Hook Installer${NC}"
|
||||||
|
echo "============================================="
|
||||||
|
|
||||||
|
# Check if we're in a git repository
|
||||||
|
if ! git rev-parse --git-dir > /dev/null 2>&1; then
|
||||||
|
echo -e "${RED}❌ Error: Not in a git repository${NC}"
|
||||||
|
echo "Please run this script from within a git repository"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Get repository root
|
||||||
|
REPO_ROOT=$(git rev-parse --show-toplevel)
|
||||||
|
HOOKS_DIR="$REPO_ROOT/.git/hooks"
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
|
|
||||||
|
echo -e "${BLUE}Repository:${NC} $REPO_ROOT"
|
||||||
|
echo -e "${BLUE}Hooks directory:${NC} $HOOKS_DIR"
|
||||||
|
echo -e "${BLUE}Script directory:${NC} $SCRIPT_DIR"
|
||||||
|
|
||||||
|
# Check if hooks directory exists
|
||||||
|
if [[ ! -d "$HOOKS_DIR" ]]; then
|
||||||
|
echo -e "${RED}❌ Error: Hooks directory not found${NC}"
|
||||||
|
echo "This repository may not be properly initialized"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if we have the hook files in the repository
|
||||||
|
HOOK_SCRIPT="$SCRIPT_DIR/git-hooks/pre-commit"
|
||||||
|
CONFIG_FILE="$SCRIPT_DIR/git-hooks/debug-checker.config"
|
||||||
|
|
||||||
|
if [[ ! -f "$HOOK_SCRIPT" ]]; then
|
||||||
|
echo -e "${RED}❌ Error: Pre-commit hook script not found${NC}"
|
||||||
|
echo "Expected location: $HOOK_SCRIPT"
|
||||||
|
echo "Make sure you're running this from the TimeSafari repository"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ! -f "$CONFIG_FILE" ]]; then
|
||||||
|
echo -e "${RED}❌ Error: Debug checker config not found${NC}"
|
||||||
|
echo "Expected location: $CONFIG_FILE"
|
||||||
|
echo "Make sure you're running this from the TimeSafari repository"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if already installed
|
||||||
|
if [[ -f "$HOOKS_DIR/pre-commit" && -f "$HOOKS_DIR/debug-checker.config" ]]; then
|
||||||
|
echo -e "${YELLOW}⚠️ Debug hook already appears to be installed${NC}"
|
||||||
|
echo -e " Checking if update is needed..."
|
||||||
|
|
||||||
|
# Check if files are different
|
||||||
|
if diff "$HOOK_SCRIPT" "$HOOKS_DIR/pre-commit" > /dev/null 2>&1; then
|
||||||
|
echo -e " ${GREEN}✅${NC} Hook script is up to date"
|
||||||
|
HOOK_UP_TO_DATE=true
|
||||||
|
else
|
||||||
|
echo -e " ${YELLOW}⚠️ Hook script differs - will update${NC}"
|
||||||
|
HOOK_UP_TO_DATE=false
|
||||||
|
fi
|
||||||
|
|
||||||
|
if diff "$CONFIG_FILE" "$HOOKS_DIR/debug-checker.config" > /dev/null 2>&1; then
|
||||||
|
echo -e " ${GREEN}✅${NC} Config file is up to date"
|
||||||
|
CONFIG_UP_TO_DATE=true
|
||||||
|
else
|
||||||
|
echo -e " ${YELLOW}⚠️ Config file differs - will update${NC}"
|
||||||
|
CONFIG_UP_TO_DATE=false
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "$HOOK_UP_TO_DATE" == true && "$CONFIG_UP_TO_DATE" == true ]]; then
|
||||||
|
echo -e "\n${GREEN}✅ Debug hook is already up to date!${NC}"
|
||||||
|
echo -e " No installation needed"
|
||||||
|
else
|
||||||
|
echo -e "\n${BLUE}Updating existing installation...${NC}"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo -e "\n${BLUE}Installing debug hook...${NC}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Copy/update the hook script if needed
|
||||||
|
if [[ "$HOOK_UP_TO_DATE" != true ]]; then
|
||||||
|
cp "$HOOK_SCRIPT" "$HOOKS_DIR/pre-commit"
|
||||||
|
chmod +x "$HOOKS_DIR/pre-commit"
|
||||||
|
echo -e " ${GREEN}✅${NC} Pre-commit hook installed/updated"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Copy/update the config file if needed
|
||||||
|
if [[ "$CONFIG_UP_TO_DATE" != true ]]; then
|
||||||
|
cp "$CONFIG_FILE" "$HOOKS_DIR/debug-checker.config"
|
||||||
|
echo -e " ${GREEN}✅${NC} Configuration file installed/updated"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Copy/update the README if needed
|
||||||
|
README_FILE="$SCRIPT_DIR/git-hooks/README.md"
|
||||||
|
if [[ -f "$README_FILE" ]]; then
|
||||||
|
if [[ ! -f "$HOOKS_DIR/README.md" ]] || ! diff "$README_FILE" "$HOOKS_DIR/README.md" > /dev/null 2>&1; then
|
||||||
|
cp "$README_FILE" "$HOOKS_DIR/README.md"
|
||||||
|
echo -e " ${GREEN}✅${NC} Documentation installed/updated"
|
||||||
|
else
|
||||||
|
echo -e " ${GREEN}✅${NC} Documentation is up to date"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo -e "\n${GREEN}🎉 Debug hook installation complete!${NC}"
|
||||||
|
|
||||||
|
# Test the installation
|
||||||
|
echo -e "\n${BLUE}Testing installation...${NC}"
|
||||||
|
if [[ -x "$HOOKS_DIR/pre-commit" ]]; then
|
||||||
|
echo -e " ${GREEN}✅${NC} Hook is executable"
|
||||||
|
else
|
||||||
|
echo -e " ${RED}❌${NC} Hook is not executable"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -f "$HOOKS_DIR/debug-checker.config" ]]; then
|
||||||
|
echo -e " ${GREEN}✅${NC} Config file exists"
|
||||||
|
else
|
||||||
|
echo -e " ${RED}❌${NC} Config file missing"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Show current branch status
|
||||||
|
CURRENT_BRANCH=$(git symbolic-ref --short HEAD 2>/dev/null || echo "detached")
|
||||||
|
echo -e "\n${BLUE}Current branch:${NC} $CURRENT_BRANCH"
|
||||||
|
|
||||||
|
# Check if this is a protected branch
|
||||||
|
PROTECTED_BRANCHES=("master" "main" "production" "release" "stable")
|
||||||
|
IS_PROTECTED=false
|
||||||
|
|
||||||
|
for branch in "${PROTECTED_BRANCHES[@]}"; do
|
||||||
|
if [[ "$CURRENT_BRANCH" == "$branch" ]]; then
|
||||||
|
IS_PROTECTED=true
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [[ "$IS_PROTECTED" == true ]]; then
|
||||||
|
echo -e "${YELLOW}⚠️ You're on a protected branch ($CURRENT_BRANCH)${NC}"
|
||||||
|
echo -e " The debug hook will now run on all commits to this branch"
|
||||||
|
echo -e " Consider switching to a feature branch for development"
|
||||||
|
else
|
||||||
|
echo -e "${GREEN}✅ You're on a feature branch ($CURRENT_BRANCH)${NC}"
|
||||||
|
echo -e " The debug hook will be skipped on this branch"
|
||||||
|
echo -e " You can develop with debug code freely"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo -e "\n${BLUE}Next steps:${NC}"
|
||||||
|
echo "1. The hook will now run automatically on protected branches"
|
||||||
|
echo "2. Test it by trying to commit a file with debug code"
|
||||||
|
echo "3. Use feature branches for development with debug code"
|
||||||
|
echo "4. Check the README.md in .git/hooks/ for more information"
|
||||||
|
|
||||||
|
echo -e "\n${BLUE}To test the hook:${NC}"
|
||||||
|
echo "1. Create a test file with debug code (e.g., console.log('test'))"
|
||||||
|
echo "2. Stage it: git add <filename>"
|
||||||
|
echo "3. Try to commit: git commit -m 'test'"
|
||||||
|
echo "4. The hook should prevent the commit if debug code is found"
|
||||||
|
|
||||||
|
echo -e "\n${BLUE}To uninstall:${NC}"
|
||||||
|
echo "rm $HOOKS_DIR/pre-commit"
|
||||||
|
echo "rm $HOOKS_DIR/debug-checker.config"
|
||||||
|
echo "rm $HOOKS_DIR/README.md"
|
||||||
214
scripts/setup-markdown-hooks.sh
Normal file
214
scripts/setup-markdown-hooks.sh
Normal file
@@ -0,0 +1,214 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Setup Markdown Pre-commit Hooks
|
||||||
|
# This script installs pre-commit hooks that automatically fix markdown formatting
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "🔧 Setting up Markdown Pre-commit Hooks..."
|
||||||
|
|
||||||
|
# Check if pre-commit is installed
|
||||||
|
if ! command -v pre-commit &> /dev/null; then
|
||||||
|
echo "📦 Installing pre-commit..."
|
||||||
|
pip install pre-commit
|
||||||
|
else
|
||||||
|
echo "✅ pre-commit already installed"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create .pre-commit-config.yaml if it doesn't exist
|
||||||
|
if [ ! -f .pre-commit-config.yaml ]; then
|
||||||
|
echo "📝 Creating .pre-commit-config.yaml..."
|
||||||
|
cat > .pre-commit-config.yaml << 'EOF'
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/igorshubovych/markdownlint-cli
|
||||||
|
rev: v0.38.0
|
||||||
|
hooks:
|
||||||
|
- id: markdownlint
|
||||||
|
args: [--fix, --config, .markdownlint.json]
|
||||||
|
files: \.(md|mdc)$
|
||||||
|
description: "Auto-fix markdown formatting issues"
|
||||||
|
stages: [commit]
|
||||||
|
additional_dependencies: [markdownlint-cli]
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: markdown-format-check
|
||||||
|
name: Markdown Format Validation
|
||||||
|
entry: bash -c 'echo "Checking markdown files..." && npx markdownlint --config .markdownlint.json "$@"'
|
||||||
|
language: system
|
||||||
|
files: \.(md|mdc)$
|
||||||
|
stages: [commit]
|
||||||
|
description: "Validate markdown formatting"
|
||||||
|
pass_filenames: true
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: markdown-line-length
|
||||||
|
name: Markdown Line Length Check
|
||||||
|
entry: bash -c '
|
||||||
|
for file in "$@"; do
|
||||||
|
if [[ "$file" =~ \.(md|mdc)$ ]]; then
|
||||||
|
echo "Checking line length in $file..."
|
||||||
|
if grep -q ".\{81,\}" "$file"; then
|
||||||
|
echo "❌ Line length violations found in $file"
|
||||||
|
echo "Lines exceeding 80 characters:"
|
||||||
|
grep -n ".\{81,\}" "$file" | head -5
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
'
|
||||||
|
language: system
|
||||||
|
files: \.(md|mdc)$
|
||||||
|
stages: [commit]
|
||||||
|
description: "Check markdown line length (80 chars max)"
|
||||||
|
pass_filenames: true
|
||||||
|
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: markdown-blank-lines
|
||||||
|
name: Markdown Blank Line Validation
|
||||||
|
entry: bash -c '
|
||||||
|
for file in "$@"; do
|
||||||
|
if [[ "$file" =~ \.(md|mdc)$ ]]; then
|
||||||
|
echo "Checking blank lines in $file..."
|
||||||
|
# Check for multiple consecutive blank lines
|
||||||
|
if grep -q "^$" "$file" && grep -A1 "^$" "$file" | grep -q "^$"; then
|
||||||
|
echo "❌ Multiple consecutive blank lines found in $file"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
# Check for missing blank lines around headings
|
||||||
|
if grep -B1 "^##" "$file" | grep -v "^##" | grep -v "^$" | grep -v "^--"; then
|
||||||
|
echo "❌ Missing blank line before heading in $file"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
'
|
||||||
|
language: system
|
||||||
|
files: \.(md|mdc)$
|
||||||
|
stages: [commit]
|
||||||
|
description: "Validate markdown blank line formatting"
|
||||||
|
pass_filenames: true
|
||||||
|
EOF
|
||||||
|
echo "✅ Created .pre-commit-config.yaml"
|
||||||
|
else
|
||||||
|
echo "✅ .pre-commit-config.yaml already exists"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Install the pre-commit hooks
|
||||||
|
echo "🔗 Installing pre-commit hooks..."
|
||||||
|
pre-commit install
|
||||||
|
|
||||||
|
# Install markdownlint if not present
|
||||||
|
if ! command -v npx &> /dev/null; then
|
||||||
|
echo "📦 Installing Node.js dependencies..."
|
||||||
|
npm install --save-dev markdownlint-cli
|
||||||
|
else
|
||||||
|
if ! npx markdownlint --version &> /dev/null; then
|
||||||
|
echo "📦 Installing markdownlint-cli..."
|
||||||
|
npm install --save-dev markdownlint-cli
|
||||||
|
else
|
||||||
|
echo "✅ markdownlint-cli already available"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create a markdown auto-fix script
|
||||||
|
echo "📝 Creating markdown auto-fix script..."
|
||||||
|
cat > scripts/fix-markdown.sh << 'EOF'
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Auto-fix markdown formatting issues
|
||||||
|
# Usage: ./scripts/fix-markdown.sh [file_or_directory]
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
FIX_MARKDOWN() {
|
||||||
|
local target="$1"
|
||||||
|
|
||||||
|
if [ -f "$target" ]; then
|
||||||
|
# Fix single file
|
||||||
|
if [[ "$target" =~ \.(md|mdc)$ ]]; then
|
||||||
|
echo "🔧 Fixing markdown formatting in $target..."
|
||||||
|
npx markdownlint --fix "$target" || true
|
||||||
|
fi
|
||||||
|
elif [ -d "$target" ]; then
|
||||||
|
# Fix all markdown files in directory
|
||||||
|
echo "🔧 Fixing markdown formatting in $target..."
|
||||||
|
find "$target" -name "*.md" -o -name "*.mdc" | while read -r file; do
|
||||||
|
echo " Processing $file..."
|
||||||
|
npx markdownlint --fix "$file" || true
|
||||||
|
done
|
||||||
|
else
|
||||||
|
echo "❌ Target $target not found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Default to current directory if no target specified
|
||||||
|
TARGET="${1:-.}"
|
||||||
|
FIX_MARKDOWN "$TARGET"
|
||||||
|
|
||||||
|
echo "✅ Markdown formatting fixes applied!"
|
||||||
|
echo "💡 Run 'git diff' to see what was changed"
|
||||||
|
EOF
|
||||||
|
|
||||||
|
chmod +x scripts/fix-markdown.sh
|
||||||
|
|
||||||
|
# Create a markdown validation script
|
||||||
|
echo "📝 Creating markdown validation script..."
|
||||||
|
cat > scripts/validate-markdown.sh << 'EOF'
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Validate markdown formatting without auto-fixing
|
||||||
|
# Usage: ./scripts/validate-markdown.sh [file_or_directory]
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
VALIDATE_MARKDOWN() {
|
||||||
|
local target="$1"
|
||||||
|
|
||||||
|
if [ -f "$target" ]; then
|
||||||
|
# Validate single file
|
||||||
|
if [[ "$target" =~ \.(md|mdc)$ ]]; then
|
||||||
|
echo "🔍 Validating markdown formatting in $target..."
|
||||||
|
npx markdownlint "$target"
|
||||||
|
fi
|
||||||
|
elif [ -d "$target" ]; then
|
||||||
|
# Validate all markdown files in directory
|
||||||
|
echo "🔍 Validating markdown formatting in $target..."
|
||||||
|
find "$target" -name "*.md" -o -name "*.mdc" | while read -r file; do
|
||||||
|
echo " Checking $file..."
|
||||||
|
npx markdownlint "$file" || true
|
||||||
|
done
|
||||||
|
else
|
||||||
|
echo "❌ Target $target not found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Default to current directory if no target specified
|
||||||
|
TARGET="${1:-.}"
|
||||||
|
VALIDATE_MARKDOWN "$TARGET"
|
||||||
|
|
||||||
|
echo "✅ Markdown validation complete!"
|
||||||
|
EOF
|
||||||
|
|
||||||
|
chmod +x scripts/validate-markdown.sh
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "🎉 Markdown Pre-commit Hooks Setup Complete!"
|
||||||
|
echo ""
|
||||||
|
echo "📋 What was installed:"
|
||||||
|
echo " ✅ pre-commit hooks for automatic markdown formatting"
|
||||||
|
echo " ✅ .pre-commit-config.yaml with markdown rules"
|
||||||
|
echo " ✅ scripts/fix-markdown.sh for manual fixes"
|
||||||
|
echo " ✅ scripts/validate-markdown.sh for validation"
|
||||||
|
echo ""
|
||||||
|
echo "🚀 Usage:"
|
||||||
|
echo " • Hooks run automatically on commit"
|
||||||
|
echo " • Manual fix: ./scripts/fix-markdown.sh [file/dir]"
|
||||||
|
echo " • Manual check: ./scripts/validate-markdown.sh [file/dir]"
|
||||||
|
echo " • Test hooks: pre-commit run --all-files"
|
||||||
|
echo ""
|
||||||
|
echo "💡 The hooks will now automatically fix markdown issues before commits!"
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user