Update plugin to use uuid for id, update example plugin with taskmanager and socketauthority test

2026-02-02 16:29:39 +00:00 · 2024-12-21 14:54:43 -06:00 · 2024-12-21 14:54:43 -06:00 · fc17a74865
commit fc17a74865
parent cfe3deff3b
11 changed files with 138 additions and 105 deletions
--- a/test/server/managers/plugins/Example/index.js
+++ b/test/server/managers/plugins/Example/index.js
@ -1,54 +1,84 @@
-class ExamplePlugin {
-  constructor() {
-    this.name = 'Example'
-  }
+/**
+ * Called on initialization of the plugin
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ */
+module.exports.init = async (context) => {
+  context.Logger.info('[ExamplePlugin] Example plugin initialized')

-  /**
-   *
-   * @param {import('../../server/managers/PluginManager').PluginContext} context
-   */
-  async init(context) {
-    context.Logger.info('[ExamplePlugin] Example plugin loaded successfully')
+  context.Database.mediaProgressModel.addHook('afterSave', (instance, options) => {
+    context.Logger.debug(`[ExamplePlugin] mediaProgressModel afterSave hook for mediaProgress ${instance.id}`)
+    handleMediaProgressUpdate(context, instance)
+  })

-    context.Database.mediaProgressModel.addHook('afterSave', (instance, options) => {
-      context.Logger.debug(`[ExamplePlugin] mediaProgressModel afterSave hook for mediaProgress ${instance.id}`)
-      this.handleMediaProgressUpdate(context, instance)
-    })
-  }
+  sendAdminMessageToast(context)
+}

-  /**
-   * @param {import('../../server/managers/PluginManager').PluginContext} context
-   * @param {import('../../server/models/MediaProgress')} mediaProgress
-   */
-  async handleMediaProgressUpdate(context, mediaProgress) {
-    const mediaItem = await mediaProgress.getMediaItem()
-    if (!mediaItem) {
-      context.Logger.error(`[ExamplePlugin] Media item not found for mediaProgress ${mediaProgress.id}`)
-    } else {
-      const mediaProgressDuration = mediaProgress.duration
-      const progressPercent = mediaProgressDuration > 0 ? (mediaProgress.currentTime / mediaProgressDuration) * 100 : 0
-      context.Logger.info(`[ExamplePlugin] Media progress update for "${mediaItem.title}" ${Math.round(progressPercent)}%`)
-    }
-  }
+/**
+ * Called when an extension action is triggered
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ * @param {string} actionName
+ * @param {string} target
+ * @param {*} data
+ */
+module.exports.onAction = async (context, actionName, target, data) => {
+  context.Logger.info('[ExamplePlugin] Example plugin onAction', actionName, target, data)
+}

-  /**
-   *
-   * @param {import('../../server/managers/PluginManager').PluginContext} context
-   * @param {string} actionName
-   * @param {string} target
-   * @param {*} data
-   */
-  async onAction(context, actionName, target, data) {
-    context.Logger.info('[ExamplePlugin] Example plugin onAction', actionName, target, data)
-  }
+/**
+ * Called when the plugin config page is saved
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ * @param {*} config
+ */
+module.exports.onConfigSave = async (context, config) => {
+  context.Logger.info('[ExamplePlugin] Example plugin onConfigSave', config)

-  /**
-   *
-   * @param {import('../../server/managers/PluginManager').PluginContext} context
-   * @param {*} config
-   */
-  async onConfigSave(context, config) {
-    context.Logger.info('[ExamplePlugin] Example plugin onConfigSave', config)
+  createTask(context)
+}
+
+//
+// Helper functions
+//
+
+/**
+ * Scrobble media progress update
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ * @param {import('../../../server/models/MediaProgress')} mediaProgress
+ */
+async function handleMediaProgressUpdate(context, mediaProgress) {
+  const mediaItem = await mediaProgress.getMediaItem()
+  if (!mediaItem) {
+    context.Logger.error(`[ExamplePlugin] Media item not found for mediaProgress ${mediaProgress.id}`)
+  } else {
+    const mediaProgressDuration = mediaProgress.duration
+    const progressPercent = mediaProgressDuration > 0 ? (mediaProgress.currentTime / mediaProgressDuration) * 100 : 0
+    context.Logger.info(`[ExamplePlugin] Media progress update for "${mediaItem.title}" ${Math.round(progressPercent)}%`)
  }
 }
-module.exports = new ExamplePlugin()
+
+/**
+ * Test socket authority
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ */
+async function sendAdminMessageToast(context) {
+  setTimeout(() => {
+    context.SocketAuthority.adminEmitter('admin_message', 'Hello from ExamplePlugin!')
+  }, 10000)
+}
+
+/**
+ * Test task manager
+ *
+ * @param {import('../../../server/managers/PluginManager').PluginContext} context
+ */
+async function createTask(context) {
+  const task = context.TaskManager.createAndAddTask('example_action', { text: 'Example Task' }, { text: 'This is an example task' }, true)
+  setTimeout(() => {
+    task.setFinished({ text: 'Example Task Finished' })
+    context.TaskManager.taskFinished(task)
+  }, 5000)
+}