@morscherlab/mint-sdk 1.1.0-beta.1 → 1.1.0-beta.10

package/src/__tests__/composables/usePluginClient.test.ts

@@ -22,12 +22,37 @@ import { AuthenticationRequiredError } from '../../composables/useApi'
 import { useAuthStore } from '../../stores/auth'
 
 const contract: PluginContract = {
-  schemaVersion: 1,
+  schemaVersion: 2,
   plugin: {
     routesPrefix: '/drp',
     apiPrefix: '/api/drp',
     type: 'analysis',
   },
+  settings: {
+    modelName: 'PluginSettings',
+    valueSchema: {
+      type: 'object',
+      properties: {
+        threshold: { type: 'number', default: 0.05 },
+      },
+    },
+    formSchema: {
+      groups: [
+        {
+          id: 'settings',
+          label: 'Settings',
+          fields: [
+            {
+              name: 'threshold',
+              label: 'Threshold',
+              type: 'number',
+              defaultValue: 0.05,
+            },
+          ],
+        },
+      ],
+    },
+  },
   endpoints: [],
   hash: 'sha256:test',
 }
@@ -687,7 +712,79 @@ describe('usePluginClient', () => {
     expect(requestConfigs).toHaveLength(0)
   })
 
-  it('loads and saves plugin settings through the integrated platform config endpoint', async () => {
+  it.each([
+    'platform',
+    undefined,
+  ] as const)(
+    'should use the integrated platform config facade when settings_api is %s',
+    async (settingsApi) => {
+      ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
+        isIntegrated: true,
+        theme: 'light',
+        platformApiUrl: '/api',
+        plugin: {
+          id: 'drp',
+          name: 'drp',
+          version: '1.0.0',
+          route_prefix: '/drp',
+          api_prefix: '/api/drp',
+          ...(settingsApi ? { settings_api: settingsApi } : {}),
+        },
+      }
+      nextGetData = {
+        plugin_name: 'drp',
+        config: {
+          nasBasePath: '/data',
+          allowed_experiment_types: ['metabolomics'],
+        },
+        revision: 'revision-1',
+      }
+      nextPatchData = {
+        plugin_name: 'drp',
+        config: {
+          nasBasePath: '/mnt',
+          allowed_experiment_types: ['metabolomics'],
+        },
+        revision: 'revision-2',
+      }
+
+      const settings = usePluginSettings<{ nasBasePath?: string }>({ pluginName: 'drp' })
+      await settings.load()
+
+      expect(requestConfigs[0]!.baseURL).toBe('/api')
+      expect(requestConfigs[0]!.url).toBe('/plugins/drp/config')
+      expect(settings.values.value).toEqual({
+        nasBasePath: '/data',
+        allowed_experiment_types: ['metabolomics'],
+      })
+      expect(settings.settings.value).toEqual({
+        nasBasePath: '/data',
+        allowed_experiment_types: ['metabolomics'],
+      })
+      expect(settings.isDirty.value).toBe(false)
+
+      settings.setValues({
+        nasBasePath: '/mnt',
+        allowed_experiment_types: ['metabolomics'],
+      })
+      expect(settings.isDirty.value).toBe(true)
+      const ok = await settings.save()
+
+      expect(ok).toBe(true)
+      expect(requestConfigs[1]!.baseURL).toBe('/api')
+      expect(requestConfigs[1]!.url).toBe('/plugins/drp/config')
+      expect(requestMethods[1]).toBe('patch')
+      expect(requestConfigs[1]!.headers).toBeUndefined()
+      expect(requestBodies[0]).toEqual({ config: { nasBasePath: '/mnt' } })
+      expect(settings.values.value).toEqual({
+        nasBasePath: '/mnt',
+        allowed_experiment_types: ['metabolomics'],
+      })
+      expect(settings.isDirty.value).toBe(false)
+    },
+  )
+
+  it('should use the plugin settings router for an integrated plugin capability', async () => {
     ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
       isIntegrated: true,
       theme: 'light',
@@ -698,35 +795,281 @@ describe('usePluginClient', () => {
         version: '1.0.0',
         route_prefix: '/drp',
         api_prefix: '/api/drp',
+        settings_api: 'plugin',
       },
     }
-    nextGetData = { plugin_name: 'drp', config: { nasBasePath: '/data' } }
-    nextPatchData = { plugin_name: 'drp', config: { nasBasePath: '/mnt' } }
+    nextGetData = {
+      settings: { threshold: 1 },
+      mode: 'integrated',
+      revision: 'revision-1',
+    }
+    nextPutData = {
+      settings: { threshold: 2 },
+      mode: 'integrated',
+      revision: 'revision-2',
+    }
 
-    const settings = usePluginSettings<{ nasBasePath?: string }>({ pluginName: 'drp' })
+    const settings = usePluginSettings<{ threshold?: number }>({ pluginName: 'drp' })
     await settings.load()
+    const saved = await settings.save({ threshold: 2 })
 
-    expect(requestConfigs[0]!.baseURL).toBe('/api')
-    expect(requestConfigs[0]!.url).toBe('/plugins/drp/config')
-    expect(settings.values.value).toEqual({ nasBasePath: '/data' })
-    expect(settings.settings.value).toEqual({ nasBasePath: '/data' })
-    expect(settings.isDirty.value).toBe(false)
+    expect({
+      saved,
+      methods: requestMethods,
+      requests: requestConfigs.map(({ baseURL, url, headers }) => ({
+        baseURL,
+        url,
+        headers,
+      })),
+      bodies: requestBodies,
+      values: settings.values.value,
+    }).toEqual({
+      saved: true,
+      methods: ['get', 'put'],
+      requests: [
+        {
+          baseURL: '/api/drp',
+          url: '/settings',
+          headers: undefined,
+        },
+        {
+          baseURL: '/api/drp',
+          url: '/settings',
+          headers: { 'If-Match': '"revision-1"' },
+        },
+      ],
+      bodies: [{ threshold: 2 }],
+      values: { threshold: 2 },
+    })
+  })
 
-    settings.setValues({ nasBasePath: '/mnt' })
-    expect(settings.isDirty.value).toBe(true)
-    const ok = await settings.save()
+  it('should preserve the contract v2 form schema in settingsConfig', () => {
+    const settings = usePluginSettings({
+      apiBaseUrl: '/api/drp',
+      loadOnMount: false,
+      schema: contract.settings.formSchema,
+    })
 
-    expect(ok).toBe(true)
-    expect(requestConfigs[1]!.baseURL).toBe('/api')
-    expect(requestConfigs[1]!.url).toBe('/plugins/drp/config')
-    expect(requestBodies[0]).toEqual({ config: { nasBasePath: '/mnt' } })
-    expect(settings.values.value).toEqual({ nasBasePath: '/mnt' })
-    expect(settings.isDirty.value).toBe(false)
+    expect(settings.settingsConfig.value.schema).toBe(contract.settings.formSchema)
+  })
+
+  it('should use the platform facade for an explicit different plugin name', async () => {
+    ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
+      isIntegrated: true,
+      theme: 'light',
+      platformApiUrl: '/api',
+      plugin: {
+        id: 'current-plugin',
+        name: 'current-plugin',
+        version: '1.0.0',
+        route_prefix: '/current-plugin',
+        api_prefix: '/api/current-plugin',
+        settings_api: 'plugin',
+      },
+    }
+    nextGetData = {
+      plugin_name: 'other-plugin',
+      config: { threshold: 1 },
+      revision: 'revision-1',
+    }
+
+    const settings = usePluginSettings<{ threshold?: number }>({
+      pluginName: 'other-plugin',
+    })
+    await settings.load()
+
+    expect({
+      method: requestMethods[0],
+      baseURL: requestConfigs[0]!.baseURL,
+      url: requestConfigs[0]!.url,
+      values: settings.values.value,
+    }).toEqual({
+      method: 'get',
+      baseURL: '/api',
+      url: '/plugins/other-plugin/config',
+      values: { threshold: 1 },
+    })
+  })
+
+  it('should split changed platform-owned settings from a versioned typed save', async () => {
+    ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
+      isIntegrated: true,
+      theme: 'light',
+      platformApiUrl: '/api',
+      plugin: {
+        id: 'drp',
+        name: 'drp',
+        version: '1.0.0',
+        route_prefix: '/drp',
+        api_prefix: '/api/drp',
+      },
+    }
+    nextGetData = {
+      plugin_name: 'drp',
+      config: {
+        threshold: 1,
+        allowed_experiment_types: ['metabolomics'],
+      },
+      revision: 'revision-1',
+    }
+    nextPatchData = {
+      plugin_name: 'drp',
+      config: {
+        threshold: 2,
+        allowed_experiment_types: ['proteomics'],
+      },
+      revision: 'untrusted-platform-revision',
+    }
+    const settings = usePluginSettings<{ threshold?: number }>({ pluginName: 'drp' })
+    await settings.load()
+    settings.setValues({
+      threshold: 2,
+      allowed_experiment_types: ['proteomics'],
+    })
+
+    const saved = await settings.save()
+    nextPatchData = {
+      plugin_name: 'drp',
+      config: {
+        threshold: 3,
+        allowed_experiment_types: ['proteomics'],
+      },
+      revision: 'revision-3',
+    }
+    settings.setValues({
+      threshold: 3,
+      allowed_experiment_types: ['proteomics'],
+    })
+    const savedAgain = await settings.save()
+
+    expect({
+      saved,
+      savedAgain,
+      methods: requestMethods,
+      bodies: requestBodies,
+      writeHeaders: requestConfigs.slice(1).map(config => config.headers),
+      values: settings.values.value,
+      isDirty: settings.isDirty.value,
+    }).toEqual({
+      saved: true,
+      savedAgain: true,
+      methods: ['get', 'patch', 'patch', 'patch'],
+      bodies: [
+        { config: { threshold: 2 } },
+        { config: { allowed_experiment_types: ['proteomics'] } },
+        { config: { threshold: 3 } },
+      ],
+      writeHeaders: [undefined, undefined, undefined],
+      values: {
+        threshold: 3,
+        allowed_experiment_types: ['proteomics'],
+      },
+      isDirty: false,
+    })
+  })
+
+  it('should avoid a typed PUT when only the platform-owned setting changes', async () => {
+    ;(window as unknown as { __MINT_PLATFORM__?: unknown }).__MINT_PLATFORM__ = {
+      isIntegrated: true,
+      theme: 'light',
+      platformApiUrl: '/api',
+      plugin: {
+        id: 'drp',
+        name: 'drp',
+        version: '1.0.0',
+        route_prefix: '/drp',
+        api_prefix: '/api/drp',
+      },
+    }
+    nextGetData = {
+      plugin_name: 'drp',
+      config: {
+        threshold: 1,
+        allowed_experiment_types: ['metabolomics'],
+      },
+      revision: 'revision-1',
+    }
+    nextPatchData = {
+      plugin_name: 'drp',
+      config: {
+        threshold: 1,
+        allowed_experiment_types: ['proteomics'],
+      },
+    }
+
+    const settings = usePluginSettings<{ threshold?: number }>({ pluginName: 'drp' })
+    await settings.load()
+    settings.setValues({
+      threshold: 1,
+      allowed_experiment_types: ['proteomics'],
+    })
+
+    const saved = await settings.save()
+
+    expect({
+      saved,
+      methods: requestMethods,
+      bodies: requestBodies,
+      values: settings.values.value,
+    }).toEqual({
+      saved: true,
+      methods: ['get', 'patch'],
+      bodies: [{ config: { allowed_experiment_types: ['proteomics'] } }],
+      values: {
+        threshold: 1,
+        allowed_experiment_types: ['proteomics'],
+      },
+    })
+  })
+
+  it('should detect nested settings edits and restore the saved JSON snapshot', async () => {
+    nextGetData = {
+      settings: {
+        rules: {
+          thresholds: [1, 2],
+        },
+      },
+      mode: 'standalone',
+    }
+
+    const settings = usePluginSettings<{
+      rules?: { thresholds: number[] }
+    }>({
+      apiBaseUrl: '/api/drp',
+      loadOnMount: false,
+    })
+    await settings.load()
+    settings.values.value.rules!.thresholds[0] = 9
+
+    const dirtyAfterMutation = settings.isDirty.value
+    settings.reset()
+
+    expect({
+      dirtyAfterMutation,
+      values: settings.values.value,
+      isDirty: settings.isDirty.value,
+    }).toEqual({
+      dirtyAfterMutation: true,
+      values: {
+        rules: {
+          thresholds: [1, 2],
+        },
+      },
+      isDirty: false,
+    })
   })
 
   it('loads and saves plugin settings through the standalone settings router', async () => {
-    nextGetData = { settings: { nas_base_path: '/data' }, mode: 'standalone' }
-    nextPutData = { settings: { nas_base_path: '/mnt' }, mode: 'standalone' }
+    nextGetData = {
+      settings: { nas_base_path: '/data' },
+      mode: 'standalone',
+      revision: 'revision-1',
+    }
+    nextPutData = {
+      settings: { nas_base_path: '/mnt' },
+      mode: 'standalone',
+      revision: 'revision-2',
+    }
 
     const settings = usePluginSettings<{ nas_base_path?: string }>({
       apiBaseUrl: '/api/drp',
@@ -740,6 +1083,7 @@ describe('usePluginClient', () => {
     expect(requestConfigs[0]!.url).toBe('/settings')
     expect(requestConfigs[1]!.baseURL).toBe('/api/drp')
     expect(requestConfigs[1]!.url).toBe('/settings')
+    expect(requestConfigs[1]!.headers).toEqual({ 'If-Match': '"revision-1"' })
     expect(requestBodies[0]).toEqual({ nas_base_path: '/mnt' })
     expect(settings.settingsConfig.value.values).toEqual({ nas_base_path: '/mnt' })
   })