[PM-12606] Move Vault Timeout and Vault Timeout Settings to KM #13405

jlf0dev · 2025-02-14T14:36:32Z

🎟️ Tracking

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

📔 Objective

Attempt 2 at moving Vault Timeout and Vault Timeout Settings to Key Management. This time keeping everything in common. Tested web, extension, desktop, and CLI.

This is mostly pure moves, only real change was exporting VaultTimeoutService as DefaultVaultTimeoutService and VaultTimeoutSettingsService as DefaultVaultTimeoutSettingsService. This meant renaming in consuming files.

📸 Screenshots

⏰ 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

codecov · 2025-02-14T14:38:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.76%. Comparing base (d9dc3f3) to head (6cc8f90).
Report is 8 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (d9dc3f3) and HEAD (6cc8f90). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (d9dc3f3) HEAD (6cc8f90)

2 1

Additional details and impacted files

@@             Coverage Diff             @@
##             main   #13405       +/-   ##
===========================================
- Coverage   35.33%   15.76%   -19.58%     
===========================================
  Files        3130       27     -3103     
  Lines       92592     1884    -90708     
  Branches    16809        0    -16809     
===========================================
- Hits        32720      297    -32423     
+ Misses      57431     1587    -55844     
+ Partials     2441        0     -2441

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

github-actions · 2025-02-14T14:41:25Z

Checkmarx One – Scan Summary & Details – 19344344-eca7-4573-a714-748d7a97f55d

Great job, no security vulnerabilities found in this Pull Request

sonarqubecloud · 2025-02-14T19:37:21Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

mzieniukbw

We should use relative imports when referencing the module we are in.
https://bitwarden.atlassian.net/wiki/spaces/EN/pages/1472626735/KM+Library+Strategy#Within-the-same-package

mzieniukbw · 2025-02-14T20:44:38Z

apps/browser/src/background/main.background.ts

@@ -251,6 +253,7 @@ import AutofillService from "../autofill/services/autofill.service";
 import { InlineMenuFieldQualificationService } from "../autofill/services/inline-menu-field-qualification.service";
 import { SafariApp } from "../browser/safariApp";
 import { BackgroundBrowserBiometricsService } from "../key-management/biometrics/background-browser-biometrics.service";
+import VaultTimeoutService from "../key-management/vault-timeout/vault-timeout.service";


Suggested change

import VaultTimeoutService from "../key-management/vault-timeout/vault-timeout.service";

import { VaultTimeoutService } from "../key-management/vault-timeout/vault-timeout.service";

mzieniukbw · 2025-02-14T20:47:45Z

libs/common/src/auth/services/token.service.spec.ts

+  VaultTimeout,
+  VaultTimeoutAction,
+  VaultTimeoutStringType,
+} from "@bitwarden/common/key-management/vault-timeout";


Suggested change

} from "@bitwarden/common/key-management/vault-timeout";

} from "../../key-management/vault-timeout";

mzieniukbw · 2025-02-14T20:47:59Z

libs/common/src/auth/services/token.service.ts

+  VaultTimeout,
+  VaultTimeoutAction,
+  VaultTimeoutStringType,
+} from "@bitwarden/common/key-management/vault-timeout";


Suggested change

} from "@bitwarden/common/key-management/vault-timeout";

} from "../../key-management/vault-timeout";

mzieniukbw · 2025-02-14T20:48:15Z

libs/common/src/auth/services/user-verification/user-verification.service.spec.ts

@@ -7,6 +7,7 @@ import {
  UserDecryptionOptions,
  UserDecryptionOptionsServiceAbstraction,
 } from "@bitwarden/auth/common";
+import { VaultTimeoutSettingsService } from "@bitwarden/common/key-management/vault-timeout";


Suggested change

import { VaultTimeoutSettingsService } from "@bitwarden/common/key-management/vault-timeout";

import { VaultTimeoutSettingsService } from "../../key-management/vault-timeout";

mzieniukbw · 2025-02-14T20:48:27Z

libs/common/src/key-management/services/default-process-reload.service.ts

+import {
+  VaultTimeoutAction,
+  VaultTimeoutSettingsService,
+} from "@bitwarden/common/key-management/vault-timeout";


Suggested change

} from "@bitwarden/common/key-management/vault-timeout";

} from "../../key-management/vault-timeout";

mzieniukbw · 2025-02-14T21:17:36Z

libs/common/src/key-management/vault-timeout/services/vault-timeout-settings.service.spec.ts

+import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
+import { Policy } from "@bitwarden/common/admin-console/models/domain/policy";
+import { TokenService } from "@bitwarden/common/auth/abstractions/token.service";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+import { Utils } from "@bitwarden/common/platform/misc/utils";
+import {
+  FakeAccountService,
+  mockAccountServiceWith,
+  FakeStateProvider,
+} from "@bitwarden/common/spec";
+import { UserId } from "@bitwarden/common/types/guid";


we should use relative imports

mzieniukbw · 2025-02-14T21:17:47Z

libs/common/src/key-management/vault-timeout/services/vault-timeout-settings.service.ts

+import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
+import { PolicyType } from "@bitwarden/common/admin-console/enums";
+import { Policy } from "@bitwarden/common/admin-console/models/domain/policy";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { TokenService } from "@bitwarden/common/auth/abstractions/token.service";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+import { StateProvider } from "@bitwarden/common/platform/state";
+import { UserId } from "@bitwarden/common/types/guid";


relative imports

mzieniukbw · 2025-02-14T21:18:19Z

libs/common/src/key-management/vault-timeout/services/vault-timeout-settings.state.ts

+import {
+  UserKeyDefinition,
+  VAULT_TIMEOUT_SETTINGS_DISK_LOCAL,
+} from "@bitwarden/common/platform/state";


Suggested change

} from "@bitwarden/common/platform/state";

} from "../../../platform/state";

mzieniukbw · 2025-02-14T21:18:34Z

libs/common/src/key-management/vault-timeout/services/vault-timeout.service.spec.ts

+import { SearchService } from "@bitwarden/common/abstractions/search.service";
+import { AccountInfo } from "@bitwarden/common/auth/abstractions/account.service";
+import { AuthService } from "@bitwarden/common/auth/abstractions/auth.service";
+import { AuthenticationStatus } from "@bitwarden/common/auth/enums/authentication-status";
+import { FakeMasterPasswordService } from "@bitwarden/common/auth/services/master-password/fake-master-password.service";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
+import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
+import { StateService } from "@bitwarden/common/platform/abstractions/state.service";
+import { Utils } from "@bitwarden/common/platform/misc/utils";
+import { TaskSchedulerService } from "@bitwarden/common/platform/scheduling";
+import { StateEventRunnerService } from "@bitwarden/common/platform/state";
+import { FakeAccountService, mockAccountServiceWith } from "@bitwarden/common/spec";
+import { UserId } from "@bitwarden/common/types/guid";
+import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
+import { FolderService } from "@bitwarden/common/vault/abstractions/folder/folder.service.abstraction";


relative import

mzieniukbw · 2025-02-14T21:19:19Z

libs/common/src/key-management/vault-timeout/services/vault-timeout.service.ts

+import { SearchService } from "@bitwarden/common/abstractions/search.service";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { AuthService } from "@bitwarden/common/auth/abstractions/auth.service";
+import { InternalMasterPasswordServiceAbstraction } from "@bitwarden/common/auth/abstractions/master-password.service.abstraction";
+import { AuthenticationStatus } from "@bitwarden/common/auth/enums/authentication-status";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
+import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
+import { StateService } from "@bitwarden/common/platform/abstractions/state.service";
+import { TaskSchedulerService, ScheduledTaskNames } from "@bitwarden/common/platform/scheduling";
+import { StateEventRunnerService } from "@bitwarden/common/platform/state";
+import { UserId } from "@bitwarden/common/types/guid";
+import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
+import { FolderService } from "@bitwarden/common/vault/abstractions/folder/folder.service.abstraction";


relative import

jlf0dev added 2 commits February 14, 2025 09:23

move vault timeout and vault timeout settings to km

84ca0e8

move browser vault timeout service to km

02e519c

jlf0dev changed the title ~~[PM-12606] Move Vault Timeout to KM~~ [PM-12606] Move Vault Timeout and Vault Timeout Settings to KM Feb 14, 2025

jlf0dev added 2 commits February 14, 2025 09:47

fix cli import

cd7f78c

fix imports

2a62272

jlf0dev marked this pull request as ready for review February 14, 2025 19:21

jlf0dev requested review from a team as code owners February 14, 2025 19:21

jlf0dev requested review from willmartian, coroiu, BTreston and rr-bw February 14, 2025 19:21

fix some relative imports

6cc8f90

willmartian approved these changes Feb 14, 2025

View reviewed changes

jprusik approved these changes Feb 14, 2025

View reviewed changes

mzieniukbw requested changes Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PM-12606] Move Vault Timeout and Vault Timeout Settings to KM #13405

[PM-12606] Move Vault Timeout and Vault Timeout Settings to KM #13405

jlf0dev commented Feb 14, 2025 •

edited

Loading

codecov bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

sonarqubecloud bot commented Feb 14, 2025

mzieniukbw left a comment

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

mzieniukbw Feb 14, 2025

	import VaultTimeoutService from "../key-management/vault-timeout/vault-timeout.service";
	import { VaultTimeoutService } from "../key-management/vault-timeout/vault-timeout.service";

	} from "@bitwarden/common/key-management/vault-timeout";
	} from "../../key-management/vault-timeout";

	import { VaultTimeoutSettingsService } from "@bitwarden/common/key-management/vault-timeout";
	import { VaultTimeoutSettingsService } from "../../key-management/vault-timeout";

	} from "@bitwarden/common/platform/state";
	} from "../../../platform/state";

[PM-12606] Move Vault Timeout and Vault Timeout Settings to KM #13405

Are you sure you want to change the base?

[PM-12606] Move Vault Timeout and Vault Timeout Settings to KM #13405

Conversation

jlf0dev commented Feb 14, 2025 • edited Loading

🎟️ Tracking

📔 Objective

📸 Screenshots

⏰ Reminders before review

🦮 Reviewer guidelines

codecov bot commented Feb 14, 2025 • edited Loading

Codecov Report

github-actions bot commented Feb 14, 2025 • edited Loading

Great job, no security vulnerabilities found in this Pull Request

sonarqubecloud bot commented Feb 14, 2025

Quality Gate passed

mzieniukbw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlf0dev commented Feb 14, 2025 •

edited

Loading

codecov bot commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading