[PM-8301] Invert crates relationship #798

Hinton · 2024-05-24T11:06:48Z

Type of change

- [ ] Bug fix
- [ ] New feature development
- [x] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other

Objective

This PR inverts the relationship between most crates in an effort to make the code base easier to maintain.

Moves most of the logic into bitwarden-core.
bitwarden provides re-exports from the various crates.
Moved ClientFeature structs to the various crates, and introduced ClientFeatureExt which exposes it on Client. This now becomes the typical way to use functionality.
Created InternalClient which contains the internal functionality for hooking up logic between the various crates.

Before you submit

Please add unit tests where it makes sense to do so

github-actions · 2024-05-24T11:11:39Z

Checkmarx One – Scan Summary & Details – 41cc7888-b4dd-4aa1-889d-542d89ab3176

No New Or Fixed Issues Found

# Conflicts: # Cargo.lock # crates/bitwarden-core/src/client/client.rs # crates/bitwarden-core/src/client/test_accounts.rs # crates/bitwarden-core/src/error.rs # crates/bitwarden-core/src/mobile/vault/client_sends.rs # crates/bitwarden-core/src/mobile/vault/client_vault.rs # crates/bitwarden-core/src/platform/domain.rs # crates/bitwarden-core/src/platform/fido2/crypto.rs # crates/bitwarden-core/src/platform/fido2/types.rs # crates/bitwarden-core/src/platform/sync.rs # crates/bitwarden-core/src/tool/mod.rs # crates/bitwarden-core/src/tool/send.rs # crates/bitwarden-core/src/vault/client_vault.rs # crates/bitwarden-core/src/vault/domain.rs # crates/bitwarden-core/src/vault/send.rs # crates/bitwarden-core/src/vault/sync.rs # crates/bitwarden/Cargo.toml # crates/bitwarden/src/lib.rs # crates/bitwarden/src/mobile/tool/client_sends.rs # crates/bitwarden/src/mobile/vault/client_sends.rs # crates/bitwarden/src/platform/domain.rs # crates/bitwarden/src/platform/sync.rs # crates/bitwarden/src/vault/send.rs

# Conflicts: # Cargo.lock # crates/bitwarden-core/Cargo.toml # crates/bitwarden-core/src/error.rs # crates/bitwarden-core/src/lib.rs # crates/bitwarden-core/src/uniffi_support.rs # crates/bitwarden-exporters/src/models.rs # crates/bitwarden-send/src/send.rs # crates/bitwarden-sm/src/projects/delete.rs # crates/bitwarden-sm/src/projects/project_response.rs # crates/bitwarden-sm/src/secrets/delete.rs # crates/bitwarden-sm/src/secrets/list.rs # crates/bitwarden-sm/src/secrets/secret_response.rs # crates/bitwarden-sm/src/secrets/sync.rs # crates/bitwarden/Cargo.toml

# Conflicts: # Cargo.lock # Cargo.toml # crates/bitwarden-core/src/auth/auth_request.rs # crates/bitwarden-core/src/auth/client_auth.rs # crates/bitwarden-core/src/auth/password/validate.rs # crates/bitwarden-core/src/client/internal.rs # crates/bitwarden-core/src/lib.rs # crates/bitwarden-core/src/mobile/crypto.rs # crates/bitwarden-core/src/mobile/vault/client_attachments.rs # crates/bitwarden-core/src/mobile/vault/client_ciphers.rs # crates/bitwarden-core/src/vault/cipher/attachment.rs # crates/bitwarden-core/src/vault/cipher/card.rs # crates/bitwarden-core/src/vault/cipher/cipher.rs # crates/bitwarden-core/src/vault/cipher/field.rs # crates/bitwarden-core/src/vault/cipher/identity.rs # crates/bitwarden-core/src/vault/cipher/linked_id.rs # crates/bitwarden-core/src/vault/cipher/local_data.rs # crates/bitwarden-core/src/vault/cipher/login.rs # crates/bitwarden-core/src/vault/cipher/mod.rs # crates/bitwarden-core/src/vault/cipher/secure_note.rs # crates/bitwarden-core/src/vault/collection.rs # crates/bitwarden-core/src/vault/domain.rs # crates/bitwarden-core/src/vault/folder.rs # crates/bitwarden-core/src/vault/password_history.rs # crates/bitwarden-core/src/vault/sync.rs # crates/bitwarden-core/src/vault/totp.rs # crates/bitwarden-exporters/src/models.rs # crates/bitwarden-sm/src/projects/create.rs # crates/bitwarden-sm/src/projects/update.rs # crates/bitwarden-sm/src/secrets/create.rs # crates/bitwarden-sm/src/secrets/update.rs # crates/bitwarden-vault/src/cipher/attachment.rs # crates/bitwarden-vault/src/cipher/card.rs # crates/bitwarden-vault/src/cipher/cipher.rs # crates/bitwarden-vault/src/cipher/field.rs # crates/bitwarden-vault/src/cipher/identity.rs # crates/bitwarden-vault/src/cipher/linked_id.rs # crates/bitwarden-vault/src/cipher/local_data.rs # crates/bitwarden-vault/src/cipher/login.rs # crates/bitwarden-vault/src/cipher/mod.rs # crates/bitwarden-vault/src/cipher/secure_note.rs # crates/bitwarden-vault/src/collection.rs # crates/bitwarden-vault/src/domain.rs # crates/bitwarden-vault/src/folder.rs # crates/bitwarden-vault/src/password_history.rs # crates/bitwarden-vault/src/totp.rs # crates/bitwarden/Cargo.toml # crates/bitwarden/src/error.rs # crates/bitwarden/src/tool/exporters/client_exporter.rs # crates/bitwarden/src/vault/cipher/attachment.rs # crates/bitwarden/src/vault/cipher/card.rs # crates/bitwarden/src/vault/cipher/cipher.rs # crates/bitwarden/src/vault/cipher/field.rs # crates/bitwarden/src/vault/cipher/identity.rs # crates/bitwarden/src/vault/cipher/linked_id.rs # crates/bitwarden/src/vault/cipher/local_data.rs # crates/bitwarden/src/vault/cipher/login.rs # crates/bitwarden/src/vault/cipher/mod.rs # crates/bitwarden/src/vault/cipher/secure_note.rs # crates/bitwarden/src/vault/collection.rs # crates/bitwarden/src/vault/domain.rs # crates/bitwarden/src/vault/folder.rs # crates/bitwarden/src/vault/password_history.rs # crates/bitwarden/src/vault/totp.rs

In preparation for #798 we need to flip the relationship between vault and exporters. Due to exporters in the future getting a `client_exporters` which means they need to be able to access the vault models to properly model it.

# Conflicts: # crates/bitwarden-core/src/auth/password/validate.rs # crates/bitwarden-core/src/auth/register.rs # crates/bitwarden-core/src/auth/renew.rs # crates/bitwarden-core/src/client/encryption_settings.rs # crates/bitwarden-core/src/mobile/crypto.rs # crates/bitwarden-core/src/platform/client_platform.rs # crates/bitwarden-core/src/platform/fido2/authenticator.rs # crates/bitwarden-core/src/platform/get_user_api_key.rs # crates/bitwarden-exporters/Cargo.toml # crates/bitwarden-exporters/src/lib.rs # crates/bitwarden-exporters/src/models.rs # crates/bitwarden-generators/src/client_generator.rs # crates/bitwarden-send/src/client_sends.rs # crates/bitwarden-sm/src/projects/create.rs # crates/bitwarden-sm/src/projects/update.rs # crates/bitwarden-sm/src/secrets/create.rs # crates/bitwarden-sm/src/secrets/update.rs # crates/bitwarden-uniffi/src/platform/mod.rs # crates/bitwarden-uniffi/src/tool/mod.rs # crates/bitwarden-uniffi/src/vault/ciphers.rs # crates/bitwarden-uniffi/src/vault/mod.rs # crates/bitwarden-vault/src/lib.rs # crates/bitwarden-vault/src/mobile/client_attachments.rs # crates/bitwarden-vault/src/mobile/client_ciphers.rs # crates/bitwarden-vault/src/mobile/client_collection.rs # crates/bitwarden-vault/src/mobile/client_folders.rs # crates/bitwarden-vault/src/mobile/client_password_history.rs # crates/bitwarden-vault/src/sync.rs # crates/bitwarden/src/client/client.rs # crates/bitwarden/src/error.rs # crates/bitwarden/src/tool/exporters/client_exporter.rs # crates/bitwarden/src/tool/exporters/mod.rs # crates/bitwarden/src/vault/client_vault.rs

# Conflicts: # Cargo.lock # Cargo.toml # crates/bitwarden-core/src/platform/client_fido.rs # crates/bitwarden-core/src/platform/client_platform.rs # crates/bitwarden-core/src/platform/fido2/authenticator.rs # crates/bitwarden-core/src/platform/fido2/client.rs # crates/bitwarden-core/src/platform/fido2/crypto.rs # crates/bitwarden-core/src/platform/fido2/mod.rs # crates/bitwarden-core/src/platform/fido2/traits.rs # crates/bitwarden-core/src/platform/fido2/types.rs # crates/bitwarden-fido/src/authenticator.rs # crates/bitwarden-fido/src/client.rs # crates/bitwarden-fido/src/crypto.rs # crates/bitwarden-fido/src/lib.rs # crates/bitwarden-fido/src/traits.rs # crates/bitwarden-fido/src/types.rs # crates/bitwarden-json/src/client.rs # crates/bitwarden-send/Cargo.toml # crates/bitwarden-send/src/lib.rs # crates/bitwarden-send/src/send.rs # crates/bitwarden-send/src/uniffi_support.rs # crates/bitwarden-uniffi/src/vault/ciphers.rs # crates/bitwarden/Cargo.toml # crates/bitwarden/src/error.rs # crates/bitwarden/src/platform/fido2/authenticator.rs # crates/bitwarden/src/platform/fido2/client.rs # crates/bitwarden/src/platform/fido2/crypto.rs # crates/bitwarden/src/platform/fido2/mod.rs # crates/bitwarden/src/platform/fido2/traits.rs # crates/bitwarden/src/platform/fido2/types.rs # crates/bitwarden/src/secrets_manager/client_projects.rs # crates/bitwarden/src/secrets_manager/client_secrets.rs # crates/bitwarden/src/tool/mod.rs

crates/bitwarden-core/src/auth/password/validate.rs

crates/bitwarden-core/src/client/internal.rs

# Conflicts: # crates/bitwarden-core/README.md # crates/bitwarden-json/src/client.rs # crates/bitwarden-vault/src/cipher/cipher.rs # crates/bw/src/main.rs

# Conflicts: # Cargo.lock # crates/bitwarden-core/src/platform/mod.rs # crates/bitwarden-fido/src/authenticator.rs # crates/bitwarden-fido/src/client_fido.rs # crates/bitwarden-fido/src/lib.rs # crates/bitwarden-uniffi/src/platform/fido2.rs # crates/bitwarden/Cargo.toml

Currently auth requests uses the password generator to generate a 25 character password. Since we're shuffling around code for #798 this won't be possible much longer. This PR adds a `generate_random_alphanumeric` to the `bitwarden_crypto` crate which generates a cryptographically secure random alphanumerical string that can be used instead.

# Conflicts: # crates/bitwarden-core/src/auth/auth_request.rs # crates/bws/src/main.rs

codecov · 2024-06-24T10:48:12Z

Codecov Report

Attention: Patch coverage is 33.53941% with 430 lines in your changes missing coverage. Please review.

Project coverage is 55.96%. Comparing base (72dd93b) to head (0059e79).
Report is 2 commits behind head on main.

Files	Patch %	Lines
crates/bitwarden-sm/src/client_secrets.rs	0.00%	39 Missing ⚠️
crates/bitwarden-exporters/src/export.rs	0.00%	29 Missing ⚠️
...ates/bitwarden-core/src/auth/login/access_token.rs	0.00%	26 Missing ⚠️
crates/bitwarden-core/src/error.rs	0.00%	24 Missing ⚠️
crates/bitwarden-sm/src/client_projects.rs	0.00%	24 Missing ⚠️
crates/bitwarden-uniffi/src/tool/mod.rs	0.00%	23 Missing ⚠️
crates/bitwarden-core/src/client/internal.rs	29.03%	22 Missing ⚠️
crates/bitwarden-fido/src/authenticator.rs	0.00%	19 Missing ⚠️
crates/bitwarden-send/src/client_sends.rs	0.00%	17 Missing ⚠️
crates/bitwarden-core/src/auth/login/api_key.rs	0.00%	13 Missing ⚠️
... and 42 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #798      +/-   ##
==========================================
- Coverage   59.20%   55.96%   -3.24%     
==========================================
  Files         192      193       +1     
  Lines       12581    12614      +33     
==========================================
- Hits         7449     7060     -389     
- Misses       5132     5554     +422

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dani-garcia

Overall looks good to me, but some imports in the Kotlin demo need to be updated, and there's a commented test

dani-garcia · 2024-06-25T13:06:04Z

crates/bitwarden-core/src/auth/client_auth.rs

@@ -169,6 +165,7 @@ impl<'a> Client {
    }
 }

+/*


This test is commented, should this be fixed or moved somewhere else?

It's more of an integration test. I'm thinking we could move them to the bitwarden crate under a separate test directory.

In #798 we accidentally moved the bitwarden crate changelog. Moving it back.

Rename bitwarden crate to bitwarden-core

17c9957

Hinton changed the title ~~Rename bitwarden crate to bitwarden-core~~ Explore new structure May 24, 2024

Hinton force-pushed the ps/core branch 2 times, most recently from 36d02d2 to ab15ba3 Compare May 24, 2024 12:20

Expose new Bitwarden crate with wrappers

677ba47

Hinton force-pushed the ps/core branch from ab15ba3 to 677ba47 Compare May 24, 2024 12:23

Move secrets manager to separate crate

83818b9

Hinton force-pushed the ps/core branch from 4252875 to d921392 Compare May 27, 2024 09:53

Use a client wrapper

fba8dd8

Hinton force-pushed the ps/core branch from d921392 to fba8dd8 Compare May 27, 2024 09:54

Hinton added 6 commits June 4, 2024 18:05

Create bitwarden-send crate

66d191d

Refactor exporters to depend on core not the inverse

15abebb

Move client methods to InternalClient

90ec269

fmt

3c996db

Hinton mentioned this pull request Jun 10, 2024

Explore using a internal namespace #804

Closed

Hinton mentioned this pull request Jun 11, 2024

Flip the dependency between exporters and vault #833

Merged

Hinton added 4 commits June 14, 2024 10:15

Fix merge issues

7a42a36

Resolve more merge issues

a2928e4

github-advanced-security bot found potential problems Jun 17, 2024

View reviewed changes

Hinton added 4 commits June 17, 2024 13:38

Merge branch 'main' of github.com:bitwarden/sdk into ps/core

a6faee8

# Conflicts: # crates/bitwarden-core/README.md # crates/bitwarden-json/src/client.rs # crates/bitwarden-vault/src/cipher/cipher.rs # crates/bw/src/main.rs

Undo some moves

54d97cd

Fix clippy

7be9217

Cleanup readmes

da2e0dd

Hinton added 6 commits June 17, 2024 14:19

Simplify errors

ecab942

Remove comment

214cad3

Bring back async for get_api_configurations

4336a0a

Fix renew token

5b4487e

Cleanup unnecessary code

606d6d6

Remove unecessary bitwarden-core/internal for secrets

4650642

Hinton mentioned this pull request Jun 18, 2024

Change access code generation to use alphanumerical #853

Merged

Hinton added 3 commits June 18, 2024 18:49

Fix platform-verifier rustls missmatch due to conflict

69d45dd

Undo changes to core/uniffi

148110d

Merge branch 'main' of github.com:bitwarden/sdk into ps/core

1c2451f

# Conflicts: # crates/bitwarden-core/src/auth/auth_request.rs # crates/bws/src/main.rs

Fix compile errors

0b934ee

Hinton changed the title ~~Explore new structure~~ Invert crates relationship Jun 24, 2024

Hinton added 5 commits June 24, 2024 16:15

fmt

3121b97

Fix readme

5bb63ef

Remove wasm-bindgen feature

bc59e32

Fix tests

a3e2e18

Cleanup cargo files

b1ef717

Hinton marked this pull request as ready for review June 24, 2024 16:29

Hinton requested a review from dani-garcia June 24, 2024 16:29

Hinton changed the title ~~Invert crates relationship~~ [PM-8301] Invert crates relationship Jun 24, 2024

dani-garcia reviewed Jun 25, 2024

View reviewed changes

Fix android

0059e79

dani-garcia approved these changes Jun 26, 2024

View reviewed changes

Hinton merged commit 47cf3cc into main Jun 26, 2024
105 checks passed

Hinton deleted the ps/core branch June 26, 2024 15:18

Hinton mentioned this pull request Jul 5, 2024

Move back changelog #877

Merged

Hinton added a commit that referenced this pull request Jul 8, 2024

Move back changelog (#877)

990937e

In #798 we accidentally moved the bitwarden crate changelog. Moving it back.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PM-8301] Invert crates relationship #798

[PM-8301] Invert crates relationship #798

Hinton commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

codecov bot commented Jun 24, 2024 •

edited

Loading

dani-garcia left a comment

dani-garcia Jun 25, 2024

Hinton Jun 25, 2024

@@ @@ -169,6 +165,7 @@ impl<'a> Client { @@
                   }
               }
+              /*

[PM-8301] Invert crates relationship #798

[PM-8301] Invert crates relationship #798

Conversation

Hinton commented May 24, 2024 • edited Loading

Type of change

Objective

Before you submit

github-actions bot commented May 24, 2024 • edited Loading

No New Or Fixed Issues Found

codecov bot commented Jun 24, 2024 • edited Loading

Codecov Report

dani-garcia left a comment

Choose a reason for hiding this comment

dani-garcia Jun 25, 2024

Choose a reason for hiding this comment

Hinton Jun 25, 2024

Choose a reason for hiding this comment

Hinton commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

codecov bot commented Jun 24, 2024 •

edited

Loading