-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3833 from FlowFuse/3828-snapshots-api
Snapshots api
- Loading branch information
Showing
13 changed files
with
1,088 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| module.exports = { | ||
| /** | ||
| * Get a snapshot by ID | ||
| * @param {*} app - app instance | ||
| * @param {*} snapshotId | ||
| */ | ||
| async getSnapshot (app, snapshotId) { | ||
| return await app.db.models.Snapshot.byId(snapshotId) | ||
| }, | ||
|
|
||
| /** | ||
| * Export specific snapshot. | ||
| * @param {*} app - app instance | ||
| * @param {*} owner project/device-originator of this snapshot | ||
| * @param {*} snapshot snapshot object to export | ||
| * @param {Object} options | ||
| * @param {String} [options.credentialSecret] secret to encrypt credentials with. | ||
| * @param {Object} [options.credentials] (Optional) credentials to export. If omitted, credentials of the current owner will be re-encrypted with the provided `credentialSecret`. | ||
| * @param {Object} [options.owner] (Optional) The owner project or device. If omitted, the snapshot's owner will be obtained from the database. | ||
| */ | ||
| exportSnapshot: async function (app, snapshot, options) { | ||
| if (!options.credentialSecret) { | ||
| return null | ||
| } | ||
|
|
||
| let owner = options.owner | ||
| if (!owner) { | ||
| if (snapshot.ownerType === 'device') { | ||
| owner = await snapshot.getDevice() | ||
| } else if (snapshot.ownerType === 'instance') { | ||
| owner = await snapshot.getProject() | ||
| } else { | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| // ensure the owner is of the correct model type | ||
| if (snapshot.ownerType === 'device' && owner?.constructor.name !== 'Device') { | ||
| return null | ||
| } | ||
| if (snapshot.ownerType === 'instance' && owner?.constructor.name !== 'Project') { | ||
| return null | ||
| } | ||
|
|
||
| // ensure the snapshot has the User association loaded | ||
| if (snapshot.UserId && !snapshot.User) { | ||
| await snapshot.reload({ include: [app.db.models.User] }) | ||
| } | ||
|
|
||
| const result = { | ||
| ...snapshot.toJSON() | ||
| } | ||
|
|
||
| // loop keys of result.settings.env and remove any that match FF_* | ||
| Object.keys(result.settings.env).forEach((key) => { | ||
| if (key.startsWith('FF_')) { | ||
| delete result.settings.env[key] | ||
| } | ||
| }) | ||
|
|
||
| // use the secret stored in the snapshot, if available... | ||
| const currentSecret = result.credentialSecret || owner.credentialSecret || (owner.getCredentialSecret && await owner.getCredentialSecret()) | ||
| const credentials = options.credentials ? options.credentials : result.flows.credentials | ||
|
|
||
| // if provided credentials already encrypted: "exportCredentials" will just return the same credentials | ||
| // if provided credentials are raw: "exportCredentials" will encrypt them with the secret provided | ||
| // if credentials are not provided: project's flows credentials will be used, they will be encrypted with the provided secret | ||
| const keyToDecrypt = (options.credentials && options.credentials.$) ? options.credentialSecret : currentSecret | ||
| result.flows.credentials = app.db.controllers.Project.exportCredentials(credentials || {}, keyToDecrypt, options.credentialSecret) | ||
|
|
||
| return result | ||
| }, | ||
|
|
||
| /** | ||
| * Delete a snapshot | ||
| * @param {*} app - app instance | ||
| * @param {*} snapshot - snapshot object | ||
| */ | ||
| async deleteSnapshot (app, snapshot) { | ||
| let owner | ||
|
|
||
| if (snapshot.ownerType === 'device') { | ||
| owner = await snapshot.getDevice() | ||
| } else if (snapshot.ownerType === 'instance') { | ||
| owner = await snapshot.getProject() | ||
| } else { | ||
| return false | ||
| } | ||
|
|
||
| const deviceSettings = await owner.getSetting('deviceSettings') || { | ||
| targetSnapshot: null | ||
| } | ||
| if (deviceSettings.targetSnapshot === snapshot.id) { | ||
| // We're about to delete the active snapshot for this device | ||
| await owner.updateSetting('deviceSettings', { | ||
| targetSnapshot: null | ||
| }) | ||
| // The cascade relationship will ensure owner.targetSnapshotId is cleared | ||
| if (app.comms) { | ||
| const team = await owner.getTeam() | ||
| app.comms.devices.sendCommandToProjectDevices(team.hashid, owner.id, 'update', { | ||
| snapshot: null | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| await snapshot.destroy() | ||
| return true | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.