feat: new way to create processing + can change owner (#38)

* fix: don't return owner facets without showAll

* feat: use stepper to create new processing

* fix: prevent undefined pluginIcon

* fix: vjsf didn't save config on change

* feat: add metadata for plugins

* fix: send plugin metadata

* chore: title in primary color

* feat: select category

* chore: update packages

* fix: plugins are never unlocked

* chore: fetch less icons

* fix: send config only when it is valid

* feat: add a placeholder to autocomplete vjsf component

* feat: change owner of a processing

* feat: add tests to change owner

* chore: don't show actions if not permissions to execute or admin the processing

* chore: add a warning to change owner

Author: BatLeDev

api/config/custom-environment-variables.cjs

@@ -5,6 +5,10 @@ module.exports = {
     processingsSeconds: 'DEFAULT_LIMITS_PROCESSINGS_SECONDS'
   },
   mongoUrl: 'MONGO_URL',
+  pluginCategories: {
+    __name: 'PLUGIN_CATEGORIES',
+    __format: 'json'
+  },
   port: 'PORT',
   privateDirectoryUrl: 'PRIVATE_DIRECTORY_URL',
   secretKeys: {

api/config/default.cjs

@@ -6,6 +6,7 @@ module.exports = {
     // -1 for unlimited storage
     processingsSeconds: -1
   },
+  pluginCategories: ['Essentiels', 'Mes plugins', 'Données de références', 'Tests'],
   privateDirectoryUrl: 'http://simple-directory:8080',
   secretKeys: {
     limits: null

api/config/type/schema.json

@@ -14,6 +14,7 @@
     "dataDir",
     "privateDirectoryUrl",
     "mongoUrl",
+    "pluginCategories",
     "port",
     "observer",
     "secretKeys"
@@ -36,6 +37,12 @@
     "mongoUrl": {
       "type": "string"
     },
+    "pluginCategories": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
     "port": {
       "type": "number"
     },

api/src/config.ts

@@ -11,6 +11,7 @@ config.util.makeImmutable(apiConfig)
 
 export default apiConfig as ApiConfig
 
-export type UiConfig = {}
-
-export const uiConfig: UiConfig = {}
+export const uiConfig = {
+  pluginCategories: apiConfig.pluginCategories,
+}
+export type UiConfig = typeof uiConfig

api/src/routers/plugins.ts

@@ -31,32 +31,47 @@ fs.ensureDirSync(tmpDir)
 
 tmp.setGracefulCleanup()
 
-/**
- * For compatibility with old plugins
- */
-const injectPluginNameConfig = (plugin: Plugin): Plugin => {
-  if (!plugin.pluginConfigSchema.properties?.pluginName) {
-    const version = plugin.distTag === 'latest' ? plugin.version : `${plugin.distTag} - ${plugin.version}`
-    const defaultName = plugin.name.replace('@data-fair/processing-', '') + ' (' + version + ')'
-    plugin.pluginConfigSchema.properties = plugin.pluginConfigSchema.properties || {}
-    plugin.pluginConfigSchema.properties.pluginName = {
+const pluginMetadataSchema = {
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    name: {
       type: 'string',
       title: 'Nom du plugin',
-      description: 'Nom du plugin affiché dans les traitements',
-      default: defaultName
+      layout: {
+        cols: 4
+      }
+    },
+    category: {
+      type: 'string',
+      title: 'Catégorie',
+      enum: config.pluginCategories,
+      layout: {
+        cols: 4
+      }
+    },
+    icon: {
+      type: 'object',
+      title: 'Icon',
+      layout: {
+        getItems: {
+          url: 'https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25',
+          itemsResults: 'data.results',
+          itemTitle: 'item.name',
+          itemIcon: 'item.svg',
+          itemKey: 'item.name'
+        },
+        cols: 4
+      }
+    },
+    description: {
+      type: 'string',
+      title: 'Description du plugin'
     }
   }
-  return plugin
-}
-
-const preparePluginInfo = async (pluginInfo: Plugin): Promise<Plugin> => {
-  pluginInfo = injectPluginNameConfig(pluginInfo)
-  const pluginConfigPath = path.join(pluginsDir, pluginInfo.id + '-config.json')
-  let customName = await fs.pathExists(pluginConfigPath) ? (await fs.readJson(pluginConfigPath)).pluginName : pluginInfo.pluginConfigSchema.properties.pluginName.default
-  if (!customName) customName = pluginInfo.name.replace('@data-fair/processing-', '') + ' (' + pluginInfo.distTag + ' - ' + pluginInfo.version + ')'
-  return { ...pluginInfo, customName }
 }
 
+// Install a new plugin or update an existing one
 router.post('/', permissions.isSuperAdmin, async (req, res) => {
   const { body } = (await import('#doc/plugin/post-req/index.ts')).returnValid(req)
   const plugin = body as Record<string, any>
@@ -86,6 +101,8 @@ router.post('/', permissions.isSuperAdmin, async (req, res) => {
 
     plugin.pluginConfigSchema = await fs.readJson(path.join(dir.path, 'src', 'plugin-config-schema.json'))
     plugin.processingConfigSchema = await fs.readJson(path.join(dir.path, 'src', 'processing-config-schema.json'))
+
+    // static metadata for the plugin
     await fs.writeFile(path.join(dir.path, 'plugin.json'), JSON.stringify(plugin, null, 2))
     await fs.move(dir.path, pluginDir, { overwrite: true })
   } finally {
@@ -96,14 +113,20 @@ router.post('/', permissions.isSuperAdmin, async (req, res) => {
     }
   }
 
-  const installedPlugin: Plugin = await preparePluginInfo(plugin as Plugin)
-  installedPlugin.access = { public: false, privateAccess: [] }
-  const accessFilePath = path.join(pluginsDir, installedPlugin.id + '-access.json')
-  if (!await fs.pathExists(accessFilePath)) await fs.writeJson(accessFilePath, installedPlugin.access)
-  const pluginConfigPath = path.join(pluginsDir, installedPlugin.id + '-config.json')
-  if (await fs.pathExists(pluginConfigPath)) installedPlugin.config = await fs.readJson(pluginConfigPath)
+  // set defaults access (don't overwrite if already exists (after an update))
+  plugin.access = { public: false, privateAccess: [] }
+  const accessFilePath = path.join(pluginsDir, plugin.id + '-access.json')
+  if (!await fs.pathExists(accessFilePath)) await fs.writeJson(accessFilePath, plugin.access)
+
+  // return the existing config if it exists
+  const pluginConfigPath = path.join(pluginsDir, plugin.id + '-config.json')
+  if (await fs.pathExists(pluginConfigPath)) plugin.config = await fs.readJson(pluginConfigPath)
+
+  // return the existing metadata if it exists
+  const pluginMetadataPath = path.join(pluginsDir, plugin.id + '-metadata.json')
+  if (await fs.pathExists(pluginMetadataPath)) plugin.metadata = await fs.readJson(pluginMetadataPath)
 
-  res.send(installedPlugin)
+  res.send(plugin)
 })
 
 // List installed plugins (optional: privateAccess=[type]:[id])
@@ -136,7 +159,17 @@ router.get('/', async (req, res) => {
     } else {
       return res.status(400).send('privateAccess filter is required')
     }
-    results.push(await preparePluginInfo(pluginInfo))
+
+    const pluginMetadataPath = path.join(pluginsDir, dir + '-metadata.json')
+    const version = pluginInfo.distTag === 'latest' ? pluginInfo.version : `${pluginInfo.distTag} - ${pluginInfo.version}`
+    pluginInfo.metadata = {
+      name: pluginInfo.name.replace('@data-fair/processing-', '') + ' (' + version + ')',
+      description: pluginInfo.description,
+      ...(await fs.pathExists(pluginMetadataPath) ? await fs.readJson(pluginMetadataPath) : {})
+    }
+    pluginInfo.pluginMetadataSchema = pluginMetadataSchema
+
+    results.push(pluginInfo)
   }
 
   const aggregationResult = (
@@ -160,7 +193,14 @@ router.get('/:id', async (req, res) => {
   await session.reqAuthenticated(req)
   try {
     const pluginInfo: Plugin = await fs.readJson(resolvePath(pluginsDir, path.join(req.params.id, 'plugin.json')))
-    res.send(await preparePluginInfo(pluginInfo))
+    const pluginMetadataPath = path.join(pluginsDir, req.params.id + '-metadata.json')
+    const version = pluginInfo.distTag === 'latest' ? pluginInfo.version : `${pluginInfo.distTag} - ${pluginInfo.version}`
+    pluginInfo.metadata = {
+      name: pluginInfo.name.replace('@data-fair/processing-', '') + ' (' + version + ')',
+      description: pluginInfo.description,
+      ...(await fs.pathExists(pluginMetadataPath) ? await fs.readJson(pluginMetadataPath) : {})
+    }
+    res.send(pluginInfo)
   } catch (e: any) {
     if (e.code === 'ENOENT') res.status(404).send('Plugin not found')
     else throw e
@@ -183,6 +223,14 @@ router.put('/:id/config', permissions.isSuperAdmin, async (req, res) => {
   res.send(req.body)
 })
 
+router.put('/:id/metadata', permissions.isSuperAdmin, async (req, res) => {
+  const validate = ajv.compile(pluginMetadataSchema)
+  const valid = validate(req.body)
+  if (!valid) return res.status(400).send(validate.errors)
+  await fs.writeJson(path.join(pluginsDir, req.params.id + '-metadata.json'), req.body)
+  res.send(req.body)
+})
+
 router.put('/:id/access', permissions.isSuperAdmin, async (req, res) => {
   await fs.writeJson(path.join(pluginsDir, req.params.id + '-access.json'), req.body)
   res.send(req.body)

api/src/routers/processings.ts

@@ -262,9 +262,21 @@ router.patch('/:id', async (req, res) => {
 
   // Restrict the parts of the processing that can be edited by API
   const acceptedParts = Object.keys(processingSchema.properties)
-    .filter(k => sessionState.user.adminMode || !(processingSchema.properties)[k].readOnly)
+    .filter(k => sessionState.user.adminMode || !(processingSchema.properties)[k].readOnly || 'owner')
   for (const key in req.body) {
     if (!acceptedParts.includes(key)) return res.status(400).send('Unsupported patch part ' + key)
+    if (key === 'owner') {
+      // check if the user has the right to change to this owner
+      const isAdmin =
+        (req.body.owner.type === 'user' && sessionState.user.id === req.body.owner.id) ||
+        sessionState.user.organizations.some(o =>
+          o.id === req.body.owner.id && (!o.department || o.department === req.body.owner.department) && o.role === 'admin'
+        )
+
+      if (!isAdmin) {
+        return res.status(403).send('No permission to change the owner to ' + req.body.owner)
+      }
+    }
   }
   req.body.updated = {
     id: sessionState.user.id,

api/types/plugin/schema.js

@@ -9,21 +9,19 @@ export default {
   additionalProperties: false,
   required: [
     'name',
-    'customName',
     'description',
     'version',
     'distTag',
     'id',
+    'metadata',
     'pluginConfigSchema',
+    'pluginMetadataSchema',
     'processingConfigSchema'
   ],
   properties: {
     name: {
       type: 'string'
     },
-    customName: {
-      type: 'string'
-    },
     description: {
       type: 'string'
     },
@@ -37,25 +35,10 @@ export default {
       type: 'string'
     },
     pluginConfigSchema: {
-      type: 'object',
-      required: ['properties'],
-      properties: {
-        properties: {
-          type: 'object',
-          required: ['pluginName'],
-          properties: {
-            pluginName: {
-              type: 'object',
-              required: ['default'],
-              properties: {
-                default: {
-                  type: 'string'
-                }
-              }
-            },
-          }
-        }
-      }
+      type: 'object'
+    },
+    pluginMetadataSchema: {
+      type: 'object'
     },
     processingConfigSchema: {
       type: 'object'
@@ -87,6 +70,25 @@ export default {
           }
         }
       }
+    },
+    metadata: {
+      type: 'object',
+      additionalProperties: false,
+      required: ['name', 'description', 'category', 'icon'],
+      properties: {
+        name: {
+          type: 'string'
+        },
+        description: {
+          type: 'string'
+        },
+        category: {
+          type: 'string'
+        },
+        icon: {
+          type: 'string'
+        }
+      }
     }
   }
 }