refactor: use ox option instead of capability

Author: kulmann

packages/web-app-files/src/composables/openXchange/useOpenXchangeContacts.ts

@@ -1,20 +1,20 @@
-import { useCapabilityStore, useClientService } from '@opencloud-eu/web-pkg'
+import { useClientService, useConfigStore } from '@opencloud-eu/web-pkg'
 import { CollaboratorAutoCompleteItem, ShareTypes } from '@opencloud-eu/web-client'
 
 /**
  * Searches the Open-Xchange addressbook for contacts and maps them to share
- * recipients of type "contact". Only active when the `open_xchange.enabled`
+ * recipients of type "contact". Only active when the `config.options.oxAppSuite.enabled`
  * capability is set.
  */
 export const useOpenXchangeContacts = () => {
   const clientService = useClientService()
-  const capabilityStore = useCapabilityStore()
+  const configStore = useConfigStore()
 
   const searchContacts = async (
     query: string,
     signal?: AbortSignal
   ): Promise<CollaboratorAutoCompleteItem[]> => {
-    if (!capabilityStore.openXchangeEnabled) {
+    if (!configStore.options.oxAppSuite?.enabled) {
       return []
     }
 

packages/web-app-files/tests/unit/components/SideBar/Shares/Collaborators/InviteCollaborator/InviteCollaboratorForm.spec.ts

@@ -301,8 +301,7 @@ function getWrapper({
   mocks.$clientService.ox.autocompleteContacts.mockResolvedValue(openXchangeContacts)
 
   const capabilities = {
-    files_sharing: { federation: { incoming: true, outgoing: true } },
-    open_xchange: { enabled: openXchange, api_url: openXchange ? 'https://ox.example.com/api' : '' }
+    files_sharing: { federation: { incoming: true, outgoing: true } }
   }
 
   return {
@@ -314,7 +313,15 @@ function getWrapper({
             piniaOptions: {
               userState: { user },
               capabilityState: { capabilities },
-              configState: { options: { concurrentRequests: { shares: { create: 1 } } } },
+              configState: {
+                options: {
+                  concurrentRequests: { shares: { create: 1 } },
+                  oxAppSuite: {
+                    enabled: openXchange,
+                    apiUrl: openXchange ? 'https://ox.example.com/api' : ''
+                  }
+                }
+              },
               sharesState: {
                 collaboratorShares: existingCollaborators
               }

packages/web-app-files/tests/unit/composables/openXchange/useOpenXchangeContacts.spec.ts

@@ -1,11 +1,10 @@
 import { Contact } from '@opencloud-eu/web-client/ox'
 import { ShareTypes } from '@opencloud-eu/web-client'
 import { defaultComponentMocks, getComposableWrapper } from '@opencloud-eu/web-test-helpers'
-import { useCapabilityStore } from '@opencloud-eu/web-pkg'
 import { useOpenXchangeContacts } from '../../../../src/composables/openXchange/useOpenXchangeContacts'
 
 describe('useOpenXchangeContacts', () => {
-  it('returns an empty list and does not call the api when the capability is disabled', async () => {
+  it('returns an empty list and does not call the api when the config option is disabled', async () => {
     const { instance, mocks } = getWrapper({ enabled: false })
     const result = await instance.searchContacts('jane')
     expect(result).toEqual([])
@@ -63,11 +62,15 @@ function getWrapper({
   let instance: ReturnType<typeof useOpenXchangeContacts>
   const wrapper = getComposableWrapper(
     () => {
-      const capabilityStore = useCapabilityStore()
-      vi.mocked(capabilityStore).openXchangeEnabled = enabled
       instance = useOpenXchangeContacts()
     },
-    { mocks, provide: mocks }
+    {
+      mocks,
+      provide: mocks,
+      pluginOptions: {
+        piniaOptions: { configState: { options: { oxAppSuite: { enabled } } } }
+      }
+    }
   )
 
   return { wrapper, instance, mocks }

packages/web-client/src/ocs/capabilities.ts

@@ -178,10 +178,6 @@ export interface Capabilities {
     groupware?: {
       enabled?: boolean
     }
-    open_xchange?: {
-      enabled?: boolean
-      api_url?: string
-    }
   }
   version: {
     edition?: string

packages/web-client/src/ox/index.ts

@@ -33,7 +33,7 @@ export interface OX {
  * Client for the Open-Xchange middleware HTTP API.
  *
  * The base url is resolved lazily through `getApiUrl` because it originates from
- * a server capability that is only available after the app has bootstrapped.
+ * a config option that is only available after the app has bootstrapped.
  */
 export const ox = (axiosClient: AxiosInstance, getApiUrl: () => string | undefined): OX => {
   return {

packages/web-pkg/src/composables/piniaStores/capabilities.ts

@@ -60,10 +60,6 @@ const defaultValues = {
     enabled: false,
     max_quota: 0,
     projects: false
-  },
-  open_xchange: {
-    enabled: false,
-    api_url: ''
   }
 } satisfies Partial<Capabilities['capabilities']>
 
@@ -142,9 +138,6 @@ export const useCapabilityStore = defineStore('capabilities', () => {
   const searchMediaType = computed(() => unref(capabilities).search.property?.mediatype)
   const searchContent = computed(() => unref(capabilities).search.property?.content)
 
-  const openXchangeEnabled = computed(() => unref(capabilities).open_xchange.enabled)
-  const openXchangeApiUrl = computed(() => unref(capabilities).open_xchange.api_url)
-
   return {
     isInitialized,
     capabilities,
@@ -188,9 +181,7 @@ export const useCapabilityStore = defineStore('capabilities', () => {
     passwordPolicy,
     searchLastMofifiedDate,
     searchMediaType,
-    searchContent,
-    openXchangeEnabled,
-    openXchangeApiUrl
+    searchContent
   }
 })
 

packages/web-pkg/src/composables/piniaStores/config/config.ts

@@ -31,7 +31,11 @@ const defaultOptions = {
   },
   tokenStorageLocal: true,
   userListRequiresFilter: false,
-  hideLogo: false
+  hideLogo: false,
+  oxAppSuite: {
+    enabled: false,
+    apiUrl: ''
+  }
 } satisfies Partial<OptionsConfig>
 
 export const useConfigStore = defineStore('config', () => {

packages/web-pkg/src/composables/piniaStores/config/types.ts

@@ -104,7 +104,13 @@ const OptionsConfigSchema = z.object({
     })
     .optional(),
   userListRequiresFilter: z.boolean().optional(),
-  hideLogo: z.boolean().optional()
+  hideLogo: z.boolean().optional(),
+  oxAppSuite: z
+    .object({
+      enabled: z.boolean().optional(),
+      apiUrl: z.string().optional()
+    })
+    .optional()
 })
 
 export type OptionsConfig = z.infer<typeof OptionsConfigSchema>

packages/web-pkg/src/services/client/client.ts

@@ -10,7 +10,7 @@ import { WebDAV } from '@opencloud-eu/web-client/webdav'
 import { Language } from 'vue3-gettext'
 import { FetchEventSourceInit } from '@microsoft/fetch-event-source'
 import { sse } from '@opencloud-eu/web-client/sse'
-import { AuthStore, CapabilityStore, ConfigStore } from '../../composables'
+import { AuthStore, ConfigStore } from '../../composables'
 import { createVaultWebDav } from './vaultWebDav'
 
 const createFetchOptions = (authParams: AuthParameters, language: string): FetchEventSourceInit => {
@@ -28,14 +28,12 @@ export interface ClientServiceOptions {
   configStore: ConfigStore
   language: Language
   authStore: AuthStore
-  capabilityStore: CapabilityStore
 }
 
 export class ClientService {
   private configStore: ConfigStore
   private language: Language
   private authStore: AuthStore
-  private capabilityStore: CapabilityStore
 
   private httpAuthenticatedClient: HttpClient
   private httpUnAuthenticatedClient: HttpClient
@@ -56,7 +54,6 @@ export class ClientService {
     this.configStore = options.configStore
     this.language = options.language
     this.authStore = options.authStore
-    this.capabilityStore = options.capabilityStore
 
     this.initGraphClient()
     this.initOcsClient()
@@ -145,7 +142,7 @@ export class ClientService {
       Object.assign(config.headers, this.getDynamicHeaders())
       return config
     })
-    this.oxClient = ox(axiosClient, () => this.capabilityStore.openXchangeApiUrl)
+    this.oxClient = ox(axiosClient, () => this.configStore.options.oxAppSuite?.apiUrl)
   }
 
   private initWebDavClient() {

packages/web-pkg/tests/unit/composables/piniaStores/capabilities.spec.ts

@@ -42,32 +42,6 @@ describe('useCapabilityStore', () => {
       })
     })
   })
-
-  describe('open-xchange getters', () => {
-    it('default to disabled with an empty api url', () => {
-      getWrapper({
-        setup: (instance) => {
-          expect(instance.openXchangeEnabled).toBe(false)
-          expect(instance.openXchangeApiUrl).toBe('')
-        }
-      })
-    })
-    it('reflect the values set via "setCapabilities"', () => {
-      getWrapper({
-        setup: (instance) => {
-          const data = {
-            capabilities: {
-              open_xchange: { enabled: true, api_url: 'https://ox.example.com/api' }
-            }
-          } as Capabilities
-          instance.setCapabilities(data)
-
-          expect(instance.openXchangeEnabled).toBe(true)
-          expect(instance.openXchangeApiUrl).toBe('https://ox.example.com/api')
-        }
-      })
-    })
-  })
 })
 
 function getWrapper({