feat: add sending user requests from UI (#1927)

* feat: add sending user requests from UI

* fix(web): view controller manager user client references

packages/services/src/Domain/User/UserClientInterface.ts

@@ -1,3 +1,4 @@
+import { UserRequestType } from '@standardnotes/common'
 import { DeinitSource } from '../Application/DeinitSource'
 
 export interface UserClientInterface {
@@ -6,4 +7,5 @@ export interface UserClientInterface {
     message?: string
   }>
   signOut(force?: boolean, source?: DeinitSource): Promise<void>
+  submitUserRequest(requestType: UserRequestType): Promise<boolean>
 }

packages/services/src/Domain/User/UserService.spec.ts

@@ -0,0 +1,92 @@
+import { UserApiServiceInterface } from '@standardnotes/api'
+import { UserRequestType } from '@standardnotes/common'
+import { EncryptionProviderInterface } from '@standardnotes/encryption'
+import { User } from '@standardnotes/responses'
+
+import {
+  AlertService,
+  ChallengeServiceInterface,
+  InternalEventBusInterface,
+  ItemManagerInterface,
+  ProtectionsClientInterface,
+} from '..'
+import { SessionsClientInterface } from '../Session/SessionsClientInterface'
+import { StorageServiceInterface } from '../Storage/StorageServiceInterface'
+import { SyncServiceInterface } from '../Sync/SyncServiceInterface'
+import { UserService } from './UserService'
+
+describe('UserService', () => {
+  let sessionManager: SessionsClientInterface
+  let syncService: SyncServiceInterface
+  let storageService: StorageServiceInterface
+  let itemManager: ItemManagerInterface
+  let protocolService: EncryptionProviderInterface
+  let alertService: AlertService
+  let challengeService: ChallengeServiceInterface
+  let protectionService: ProtectionsClientInterface
+  let userApiService: UserApiServiceInterface
+  let internalEventBus: InternalEventBusInterface
+
+  const createService = () =>
+    new UserService(
+      sessionManager,
+      syncService,
+      storageService,
+      itemManager,
+      protocolService,
+      alertService,
+      challengeService,
+      protectionService,
+      userApiService,
+      internalEventBus,
+    )
+
+  beforeEach(() => {
+    sessionManager = {} as jest.Mocked<SessionsClientInterface>
+    sessionManager.getSureUser = jest.fn().mockReturnValue({ uuid: '1-2-3' } as jest.Mocked<User>)
+
+    syncService = {} as jest.Mocked<SyncServiceInterface>
+
+    storageService = {} as jest.Mocked<StorageServiceInterface>
+
+    itemManager = {} as jest.Mocked<ItemManagerInterface>
+
+    protocolService = {} as jest.Mocked<EncryptionProviderInterface>
+
+    alertService = {} as jest.Mocked<AlertService>
+
+    challengeService = {} as jest.Mocked<ChallengeServiceInterface>
+
+    protectionService = {} as jest.Mocked<ProtectionsClientInterface>
+
+    userApiService = {} as jest.Mocked<UserApiServiceInterface>
+
+    internalEventBus = {} as jest.Mocked<InternalEventBusInterface>
+  })
+
+  it('should submit a user request to the server', async () => {
+    userApiService.submitUserRequest = jest.fn().mockReturnValue({ data: { success: true } })
+
+    expect(await createService().submitUserRequest(UserRequestType.ExitDiscount)).toBeTruthy()
+  })
+
+  it('should indicate error if submit a user request to the server fails', async () => {
+    userApiService.submitUserRequest = jest.fn().mockReturnValue({ data: { success: false } })
+
+    expect(await createService().submitUserRequest(UserRequestType.ExitDiscount)).toBeFalsy()
+  })
+
+  it('should indicate error if submit a user request to the server fails with an error on server side', async () => {
+    userApiService.submitUserRequest = jest.fn().mockReturnValue({ data: { error: { message: 'fail' } } })
+
+    expect(await createService().submitUserRequest(UserRequestType.ExitDiscount)).toBeFalsy()
+  })
+
+  it('should indicate error if submitting a user request throws an exception', async () => {
+    userApiService.submitUserRequest = jest.fn().mockImplementation(() => {
+      throw new Error('Oops')
+    })
+
+    expect(await createService().submitUserRequest(UserRequestType.ExitDiscount)).toBeFalsy()
+  })
+})

packages/services/src/Domain/User/UserService.ts

@@ -1,6 +1,6 @@
 import { EncryptionProviderInterface, SNRootKey, SNRootKeyParams } from '@standardnotes/encryption'
 import { HttpResponse, SignInResponse, User } from '@standardnotes/responses'
-import { KeyParamsOrigination } from '@standardnotes/common'
+import { KeyParamsOrigination, UserRequestType } from '@standardnotes/common'
 import { UuidGenerator } from '@standardnotes/utils'
 import { UserApiServiceInterface, UserRegistrationResponseBody } from '@standardnotes/api'
 
@@ -233,6 +233,24 @@ export class UserService extends AbstractService<AccountEvent, AccountEventData>
     }
   }
 
+  async submitUserRequest(requestType: UserRequestType): Promise<boolean> {
+    const userUuid = this.sessionManager.getSureUser().uuid
+    try {
+      const result = await this.userApiService.submitUserRequest({
+        userUuid,
+        requestType,
+      })
+
+      if (result.data.error) {
+        return false
+      }
+
+      return result.data.success
+    } catch (error) {
+      return false
+    }
+  }
+
   /**
    * A sign in request that occurs while the user was previously signed in, to correct
    * for missing keys or storage values. Unlike regular sign in, this doesn't worry about