Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Add storage.deleteData plugin helper

Chocobozzz8354c9610a97
diff --git a/packages/models/src/plugins/server/managers/plugin-storage-manager.model.ts b/packages/models/src/plugins/server/managers/plugin-storage-manager.model.ts
index 51567044a6..195c04135c 100644
--- a/packages/models/src/plugins/server/managers/plugin-storage-manager.model.ts
+++ b/packages/models/src/plugins/server/managers/plugin-storage-manager.model.ts
@@ -2,4 +2,6 @@ export interface PluginStorageManager {
getData: (key: string) => Promise<string>
storeData: (key: string, data: any) => Promise<any>
+
+ deleteData: (key: string) => Promise<any>
}
diff --git a/packages/tests/fixtures/peertube-plugin-test-six/main.js b/packages/tests/fixtures/peertube-plugin-test-six/main.js
index 243b041e78..e01d743cf0 100644
--- a/packages/tests/fixtures/peertube-plugin-test-six/main.js
+++ b/packages/tests/fixtures/peertube-plugin-test-six/main.js
@@ -13,12 +13,26 @@ async function register ({
await storageManager.storeData('anotherkey', { value: 'toto2' })
await storageManager.storeData('storedArrayKey', ['toto', 'toto2'])
- const result = await storageManager.getData('superkey')
- logger.info('superkey stored value is %s', result.value)
-
- const storedArrayValue = await storageManager.getData('storedArrayKey')
- logger.info('storedArrayKey isArray is %s', Array.isArray(storedArrayValue) ? 'true' : 'false')
- logger.info('storedArrayKey stored value is %s', storedArrayValue.join(', '))
+ {
+ const result = await storageManager.getData('superkey')
+ logger.info('superkey stored value is %s', result.value)
+ }
+
+ {
+ const storedArrayValue = await storageManager.getData('storedArrayKey')
+ logger.info('storedArrayKey isArray is %s', Array.isArray(storedArrayValue) ? 'true' : 'false')
+ logger.info('storedArrayKey stored value is %s', storedArrayValue.join(', '))
+ }
+
+
+ {
+ await storageManager.deleteData('superkey')
+
+ const result = await storageManager.getData('superkey')
+ if (!result) {
+ logger.info('superkey has been deleted')
+ }
+ }
}
{
diff --git a/packages/tests/src/plugins/plugin-storage.ts b/packages/tests/src/plugins/plugin-storage.ts
index 8baa6eaebe..97068276fe 100644
--- a/packages/tests/src/plugins/plugin-storage.ts
+++ b/packages/tests/src/plugins/plugin-storage.ts
@@ -35,6 +35,10 @@ describe('Test plugin storage', function () {
await server.servers.waitUntilLog('storedArrayKey isArray is true')
await server.servers.waitUntilLog('storedArrayKey stored value is toto, toto2')
})
+
+ it('Should correctly delete a key', async function () {
+ await server.servers.waitUntilLog('superkey has been deleted')
+ })
})
describe('Disk storage', function () {
diff --git a/server/core/lib/plugins/register-helpers.ts b/server/core/lib/plugins/register-helpers.ts
index 0ec4ebfc39..1d8ba1f0e8 100644
--- a/server/core/lib/plugins/register-helpers.ts
+++ b/server/core/lib/plugins/register-helpers.ts
@@ -28,7 +28,7 @@ import { buildPluginHelpers } from './plugin-helpers-builder.js'
export class RegisterHelpers {
private readonly transcodingProfiles: {
- [ npmName: string ]: {
+ [npmName: string]: {
type: 'vod' | 'live'
encoder: string
profile: string
@@ -36,7 +36,7 @@ export class RegisterHelpers {
} = {}
private readonly transcodingEncoders: {
- [ npmName: string ]: {
+ [npmName: string]: {
type: 'vod' | 'live'
streamType: 'audio' | 'video'
encoder: string
@@ -286,7 +286,9 @@ export class RegisterHelpers {
return {
getData: (key: string) => PluginModel.getData(this.plugin.name, this.plugin.type, key),
- storeData: (key: string, data: any) => PluginModel.storeData(this.plugin.name, this.plugin.type, key, data)
+ storeData: (key: string, data: any) => PluginModel.storeData(this.plugin.name, this.plugin.type, key, data),
+
+ deleteData: (key: string) => PluginModel.deleteData(this.plugin.name, this.plugin.type, key)
}
}
diff --git a/server/core/models/server/plugin.ts b/server/core/models/server/plugin.ts
index 08d5d07a25..37ab0a7462 100644
--- a/server/core/models/server/plugin.ts
+++ b/server/core/models/server/plugin.ts
@@ -229,6 +229,19 @@ export class PluginModel extends SequelizeModel<PluginModel> {
.then(() => undefined)
}
+ static deleteData (pluginName: string, pluginType: PluginType_Type, key: string) {
+ const query = 'UPDATE "plugin" SET "storage" = "storage" - :key ' +
+ 'WHERE "name" = :pluginName AND "type" = :pluginType'
+
+ const options = {
+ replacements: { pluginName, pluginType, key },
+ type: QueryTypes.UPDATE
+ }
+
+ return PluginModel.sequelize.query(query, options)
+ .then(() => undefined)
+ }
+
static listForApi (options: {
pluginType?: PluginType_Type
uninstalled?: boolean