Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PM-13166] Rename Client* to *Client #27

Merged
merged 9 commits into from
Dec 18, 2024

Conversation

tangowithfoxtrot
Copy link
Contributor

@tangowithfoxtrot tangowithfoxtrot commented Nov 8, 2024

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-13166

📔 Objective

Use more intuitive naming by updating Client<_> to <_>Client.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link
Contributor

github-actions bot commented Nov 8, 2024

Logo
Checkmarx One – Scan Summary & Detailsc4858ee8-e7e9-4aa2-aec0-fc327e9c94fb

No New Or Fixed Issues Found

@tangowithfoxtrot tangowithfoxtrot force-pushed the pm-13166-rename-sdk-client branch from a3cbf02 to d1024de Compare November 8, 2024 17:02
@tangowithfoxtrot tangowithfoxtrot changed the title chore: rename Client* to *Client [PM-13166] rename Client* to *Client Nov 8, 2024
@tangowithfoxtrot tangowithfoxtrot changed the title [PM-13166] rename Client* to *Client [PM-13166] Rename Client* to *Client Nov 8, 2024
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

Attention: Patch coverage is 18.75000% with 26 lines in your changes missing coverage. Please review.

Project coverage is 64.45%. Comparing base (a89b588) to head (77c3247).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
crates/bitwarden-uniffi/src/lib.rs 0.00% 14 Missing ⚠️
crates/bitwarden-wasm-internal/src/client.rs 0.00% 4 Missing ⚠️
...tes/bitwarden-core/src/platform/platform_client.rs 0.00% 2 Missing ⚠️
crates/bitwarden-exporters/src/exporter_client.rs 0.00% 2 Missing ⚠️
...rates/bitwarden-generators/src/generator_client.rs 0.00% 2 Missing ⚠️
crates/bitwarden-send/src/send_client.rs 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
+ Coverage   64.43%   64.45%   +0.02%     
==========================================
  Files         188      188              
  Lines       13832    13832              
==========================================
+ Hits         8912     8915       +3     
+ Misses       4920     4917       -3     

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

@tangowithfoxtrot tangowithfoxtrot marked this pull request as ready for review November 18, 2024 22:58
coroiu
coroiu previously approved these changes Nov 19, 2024
Copy link
Contributor

@coroiu coroiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, thanks for taking this on!

crates/bitwarden-core/src/auth/client_auth.rs Outdated Show resolved Hide resolved
crates/bitwarden-exporters/src/client_exporter.rs Outdated Show resolved Hide resolved
Hinton
Hinton previously approved these changes Nov 21, 2024
Copy link
Member

@Hinton Hinton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a breaking change for our clients, would be good to make the mobile team aware of this so they can update.

coroiu
coroiu previously approved these changes Nov 26, 2024
Copy link
Contributor

@coroiu coroiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch by Oscar! Make sure to let Oscar know when this has been merged so that he can publish the Swift lib.

Btw @tangowithfoxtrot did you test opening and building the test swift project in crates/bitwarden-uniffi/swift/iOS/App.xcodeproj ?

@Hinton
Copy link
Member

Hinton commented Nov 28, 2024

We also have the android project ...

@tangowithfoxtrot
Copy link
Contributor Author

@Hinton and @coroiu, I was able to build and run the Android project without needing to change anything in bitwarden/android. However, I haven't been able to get the iOS project to build at all. Is there something beyond what's written in the contributing docs to get it to build?

@Hinton
Copy link
Member

Hinton commented Dec 4, 2024

The project's we're referencing exists in this repository under https://github.com/bitwarden/sdk-internal/tree/main/crates/bitwarden-uniffi.

@Hinton
Copy link
Member

Hinton commented Dec 4, 2024

Android seems fine, but the iOS sample has some build errors. (You should update the branch first though since there are 2 errors that are fixed on main now).

@tangowithfoxtrot tangowithfoxtrot dismissed stale reviews from Hinton and coroiu via 8e64c21 December 16, 2024 18:19
@tangowithfoxtrot
Copy link
Contributor Author

Alright. I merged the updates from main and was able to build the example Swift and Kotlin applications successfully. The Swift app required updating the symbol names, while the Kotlin app did not.

@tangowithfoxtrot tangowithfoxtrot merged commit 2c22c4f into main Dec 18, 2024
39 checks passed
@tangowithfoxtrot tangowithfoxtrot deleted the pm-13166-rename-sdk-client branch December 18, 2024 15:45
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.

3 participants