Skip to content

feat: replace dataclasses-json with Pydantic v2 models#277

Open
layertwo wants to merge 1 commit intomainlinefrom
feat/pydantic-models
Open

feat: replace dataclasses-json with Pydantic v2 models#277
layertwo wants to merge 1 commit intomainlinefrom
feat/pydantic-models

Conversation

@layertwo
Copy link
Copy Markdown
Owner

@layertwo layertwo commented Mar 5, 2026

Summary

  • Migrate all route responses to Pydantic v2 output models (BSOOutput, ModifiedOutput, BatchResultOutput, AccountCreateOutput, ProfileOutput, TokenOutput, etc.) across 21 routes
  • Replace dataclasses-json DataClassJsonMixin with Pydantic BaseModel for DynamoDB models (BasicStorageObject, CollectionData, UserRecord) via a DynamoModel base class that handles Decimal/datetime coercion
  • Add to_item() methods on DynamoDB models for complete item serialization (replaces _encode_* methods in StorageManager/UserManager)
  • Remove dataclasses-json dependency and all dead helpers (DecimalEncoder, json_dumps, datetime_encoder/decoder, float_to_decimal, validate_sortindex, validate_ttl)
  • Enable Powertools enable_validation=True on all API routers with RequestValidationError/ResponseValidationError handlers

Test plan

  • All 993 tests pass with 100% coverage
  • black, isort, flake8, mypy all pass
  • dataclasses-json fully removed from dependencies (+ transitive marshmallow, typing-inspect)
  • Deploy to dev and verify Firefox Sync end-to-end (bookmarks, tabs, history)

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 5, 2026

Diff for stage: DefaultStage

Warning

3 Destructive Changes

Diff for stack: GitHubOidcStack - 0 to add, 1 to update, 0 to destroy 🟡

Details
Resources
[~] Custom::AWSCDKOpenIdConnectProvider GitHubOidcProvider7EBF861F
 ├─ [~] CodeHash
 │   ├─ [-] 62fa02efcaa700e1c247e1d3cc2aa0cd07a0808a9a3e3d2230e51f57a02233fb
 │   └─ [+] d75c48c9f82cde63e9bf414df335e84e8ac24f11eb34889be255b702aec71e50
 └─ [~] RejectUnauthorized
[~] AWS::Lambda::Function CustomAWSCDKOpenIdConnectProviderCustomResourceProviderHandlerF2C543E0
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] 62fa02efcaa700e1c247e1d3cc2aa0cd07a0808a9a3e3d2230e51f57a02233fb.zip
 │       └─ [+] d75c48c9f82cde63e9bf414df335e84e8ac24f11eb34889be255b702aec71e50.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.62fa02efcaa700e1c247e1d3cc2aa0cd07a0808a9a3e3d2230e51f57a02233fb
         └─ [+] asset.d75c48c9f82cde63e9bf414df335e84e8ac24f11eb34889be255b702aec71e50

Diff for stack: Service-prod - 3 to add, 3 to update, 3 to destroy

Details

[!WARNING]
Destructive Changes ‼️
Stack: Service-prod - Resource: AuthApiDeploymentB62B2E46e6df84b588a887363a13ab29adc3623c - Impact: WILL_DESTROY

Stack: Service-prod - Resource: TokenApiDeploymentB896C219b16a73c2bacf13dff150a851137e236c - Impact: WILL_DESTROY

Stack: Service-prod - Resource: ProfileApiDeployment84A54415e0158c62574d24c31b8dbd21e82873c4 - Impact: WILL_DESTROY

Resources
[-] AWS::ApiGateway::Deployment AuthApiDeploymentB62B2E46e6df84b588a887363a13ab29adc3623c destroy
[-] AWS::ApiGateway::Deployment TokenApiDeploymentB896C219b16a73c2bacf13dff150a851137e236c destroy
[-] AWS::ApiGateway::Deployment ProfileApiDeployment84A54415e0158c62574d24c31b8dbd21e82873c4 destroy
[+] AWS::ApiGateway::Deployment AuthApiDeploymentB62B2E46b5c04cfbd7bd117a1ee4f8acc7bb74f8
[+] AWS::ApiGateway::Deployment TokenApiDeploymentB896C2197f4fd8f40928d8ff6b65325e6f60c797
[+] AWS::ApiGateway::Deployment ProfileApiDeployment84A54415afa95090416ea0bbd4b1d2aac5a9241c
[~] AWS::Lambda::Function AuthApiHandlerED50ACFA
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] 1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147.zip
 │       └─ [+] ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147
         └─ [+] asset.ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713
[~] AWS::Lambda::Function TokenApiHandler2E66DB25
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] 1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147.zip
 │       └─ [+] ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147
         └─ [+] asset.ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713
[~] AWS::Lambda::Function ProfileApiHandler9B65A298
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] 1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147.zip
 │       └─ [+] ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147
         └─ [+] asset.ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713
[~] AWS::Lambda::Function ApiHandler5E7490E8
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] 1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147.zip
 │       └─ [+] ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.1527c534dc3ec24d621d57e297d669e22dc2ace57cbcae6d6da540d42832a147
         └─ [+] asset.ed7e87e2db39c0e074698ca2e241fe8d0a8ada3082e574bdaf594fc154f83713
[~] AWS::ApiGateway::Stage AuthApiDeploymentStageprodB0E4172A
 └─ [~] DeploymentId
     └─ [~] .Ref:
         ├─ [-] AuthApiDeploymentB62B2E46e6df84b588a887363a13ab29adc3623c
         └─ [+] AuthApiDeploymentB62B2E46b5c04cfbd7bd117a1ee4f8acc7bb74f8
[~] AWS::ApiGateway::Stage TokenApiDeploymentStageprod11035AE4
 └─ [~] DeploymentId
     └─ [~] .Ref:
         ├─ [-] TokenApiDeploymentB896C219b16a73c2bacf13dff150a851137e236c
         └─ [+] TokenApiDeploymentB896C2197f4fd8f40928d8ff6b65325e6f60c797
[~] AWS::ApiGateway::Stage ProfileApiDeploymentStageprodF609D968
 └─ [~] DeploymentId
     └─ [~] .Ref:
         ├─ [-] ProfileApiDeployment84A54415e0158c62574d24c31b8dbd21e82873c4
         └─ [+] ProfileApiDeployment84A54415afa95090416ea0bbd4b1d2aac5a9241c
[~] AWS::Lambda::Function ChannelApiHandler02759D57
 ├─ [~] Code
 │   └─ [~] .S3Key:
 │       ├─ [-] ca37232fdfd500adbaa06e972c23a68046efd788f7781db21a059050cda4a508.zip
 │       └─ [+] ed67903b2562365ca62b76f3b5597b8c1504a33bbd1a7d90af8f896eda82859c.zip
 └─ [~] Metadata
     └─ [~] .aws:asset:path:
         ├─ [-] asset.ca37232fdfd500adbaa06e972c23a68046efd788f7781db21a059050cda4a508
         └─ [+] asset.ed67903b2562365ca62b76f3b5597b8c1504a33bbd1a7d90af8f896eda82859c

No Changes for stack: Frontend-prod ✅
No Changes for stack: Monitoring-prod ✅

Generated for commit 768bca2 at 2026-03-06T04:55:51.406Z

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 5, 2026

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  lambda/src/environment
  service_provider.py
  lambda/src/routes/auth
  account_attached_clients.py
  account_create.py
  account_devices.py
  account_login.py
  oauth_token.py
  scoped_key_data.py
  session_status.py
  lambda/src/routes/bso
  delete.py
  read.py
  update.py
  lambda/src/routes/collections
  create.py
  delete.py
  list.py
  read.py
  update.py
  lambda/src/routes/info
  read_collections.py
  read_counts.py
  lambda/src/routes/profile
  get_profile.py
  lambda/src/routes/storage
  delete_all.py
  delete_root.py
  lambda/src/services
  api_router.py
  storage_manager.py
  user_manager.py
  lambda/src/shared
  models.py
Project Total  

The report is truncated to 25 files out of 38. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action

@layertwo layertwo force-pushed the feat/pydantic-models branch 3 times, most recently from b8622d5 to d3f99af Compare March 6, 2026 04:33
@layertwo layertwo force-pushed the feat/pydantic-models branch from d3f99af to 768bca2 Compare March 6, 2026 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant