🚀 Enhanced Testing Infrastructure & Security Features

[samjcombs]

🚀 Enhanced Testing Infrastructure & Security Features

Overview

This PR upgrades end-to-end testing, logging, and security for sensitive data management.

Key Changes

1. End-to-End Testing Infrastructure

• Cypress E2E Testing: Leveraged InstantMock to mock Apollo API responses.
• Test Modes (Record/Play/Test): e2e-record, e2e-play, and e2e-test NODE_ENV modes unlocked for easy creation of e2e fixtures with npm run e2e:record and easy e2e testing with npm run e2e:test
• CI Pipeline: Automated E2E tests on branch pushes

2. Enhanced Logging System

• Pino Integration: Much prettier logs unlocked (pretty, colored output in dev, and JSON logging on prod for easy ingestion into cloud logging platforms)

3. Security Enhancements

• AES-256-GCM Encryption: Encrypt sensitive data with AES-256-GCM.
  • Algorithm: AES-256-GCM
  • Key Size: 256 bits
  • IV Size: 96 bits

4. Documentation & Code Quality

• Enhanced Type Safety and modular structure improvements

Testing

• Local Commands: "e2e:record": "ts-node scripts/run-e2e-tests.ts record", "e2e:test": "ts-node scripts/run-e2e-tests.ts test".

Security Considerations

• Sensitive Data: Proper encryption and management of keys.

Related Documentation

• Security: docs/security/encryption.md

Breaking Changes

• New Variable: ENCRYPTION_KEY required for apollo api key persistence across restarts/servers
• Schema Update: Encrypted API key storage.

Next Steps

• Documentation: Migrate to Docusaurus or MkDocs.
• Test Coverage: Expand unit testing coverage of all utitlities. Expand E2E testing with more user journeys -- now we support just one, the main one ;)
• Monitoring: Add structured logging for observability.
• Updated ReadME: A well needed refresh to the readme is in flight!