Skip to content

[PM-16908] Make WASM BitwardenClient API async #173

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

dani-garcia
Copy link
Member

@dani-garcia dani-garcia commented Feb 28, 2025

🎟️ Tracking

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

📔 Objective

Created a script that marks any functions from BitwardenClient or it's subclients as async in the .d.ts file. This is needed for the work in bitwarden/clients#13539, that exposes the BitwardenClient API remotely through IPC.

Note that the script also stores all the functions that return a subclient and saves that in the JS/TS files, for the client code to use it. This is because the clients will need to differenciate between functions that return subclients, and functions that actually need to call into the SDK.

As this is only applied to BitwardenClient and any subclients reachable from it, it won't affect separate clients like PureCrypto

I've created a separate temporary PR with some of the test functions I've used on the SDK here, including some subclients and callbacks: #174

⏰ 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 Feb 28, 2025

Logo
Checkmarx One – Scan Summary & Details03ba318f-6d35-45fd-bd6d-92edfbda4601

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.38%. Comparing base (c2434ae) to head (d512503).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #173   +/-   ##
=======================================
  Coverage   66.38%   66.38%           
=======================================
  Files         210      210           
  Lines       16136    16136           
=======================================
  Hits        10712    10712           
  Misses       5424     5424           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dani-garcia dani-garcia changed the title [PM-16908] Validate WASM BitwardenClient API is async [PM-16908] Make WASM BitwardenClient API async Apr 8, 2025
@dani-garcia dani-garcia marked this pull request as ready for review April 8, 2025 14:27
@dani-garcia dani-garcia requested a review from a team as a code owner April 8, 2025 14:27
@dani-garcia dani-garcia requested a review from addisonbeck April 8, 2025 14:27
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.

2 participants