Update modify secrets api v2 so that fields are optional

backend/src/ee/helpers/secret.ts

@@ -1,11 +1,11 @@
 import { Types } from 'mongoose';
 import * as Sentry from '@sentry/node';
 import {
-    Secret,
+	Secret,
 	ISecret
 } from '../../models';
 import {
-    SecretSnapshot,
+	SecretSnapshot,
 	SecretVersion,
 	ISecretVersion
 } from '../models';
@@ -18,24 +18,24 @@ import {
  * @param {String} obj.workspaceId
  * @returns {SecretSnapshot} secretSnapshot - new secret snapshot
  */
- const takeSecretSnapshotHelper = async ({
+const takeSecretSnapshotHelper = async ({
 	workspaceId
 }: {
 	workspaceId: string;
 }) => {
-	
+
 	let secretSnapshot;
 	try {
 		const secretIds = (await Secret.find({
 			workspace: workspaceId
 		}, '_id')).map((s) => s._id);
-		
+
 		const latestSecretVersions = (await SecretVersion.aggregate([
 			{
-				$match: { 
-					secret: { 
-						$in: secretIds 
-					} 
+				$match: {
+					secret: {
+						$in: secretIds
+					}
 				}
 			},
 			{
@@ -48,14 +48,14 @@ import {
 			{
 				$sort: { version: -1 }
 			}
-			])
+		])
 			.exec())
 			.map((s) => s.versionId);
-			
+
 		const latestSecretSnapshot = await SecretSnapshot.findOne({
 			workspace: workspaceId
 		}).sort({ version: -1 });
-		
+
 		secretSnapshot = await new SecretSnapshot({
 			workspace: workspaceId,
 			version: latestSecretSnapshot ? latestSecretSnapshot.version + 1 : 1,
@@ -66,7 +66,7 @@ import {
 		Sentry.captureException(err);
 		throw new Error('Failed to take a secret snapshot');
 	}
-	
+
 	return secretSnapshot;
 }
 
@@ -87,9 +87,9 @@ const addSecretVersionsHelper = async ({
 	} catch (err) {
 		Sentry.setUser(null);
 		Sentry.captureException(err);
-		throw new Error('Failed to add secret versions');
+		throw new Error(`Failed to add secret versions [err=${err}]`);
 	}
-	
+
 	return newSecretVersions;
 }
 
@@ -120,39 +120,39 @@ const markDeletedSecretVersionsHelper = async ({
 const initSecretVersioningHelper = async () => {
 	try {
 
-		await Secret.updateMany( 
+		await Secret.updateMany(
 			{ version: { $exists: false } },
 			{ $set: { version: 1 } }
 		);
-		
-        const unversionedSecrets: ISecret[] = await Secret.aggregate([
-            {
-                $lookup: {
-                from: 'secretversions',
-                localField: '_id',
-                foreignField: 'secret',
-                as: 'versions',
-                },
-            },
-            {
-                $match: {
-                versions: { $size: 0 },
-                },
-            },
-        ]);
-        
-        if (unversionedSecrets.length > 0) {
-            await addSecretVersionsHelper({
-                secretVersions: unversionedSecrets.map((s, idx) => ({
-                    ...s,
-                    secret: s._id,
-                    version: s.version ? s.version : 1,
-                    isDeleted: false,
-                    workspace: s.workspace,
-                    environment: s.environment
-                }))
-            });
-        }
+
+		const unversionedSecrets: ISecret[] = await Secret.aggregate([
+			{
+				$lookup: {
+					from: 'secretversions',
+					localField: '_id',
+					foreignField: 'secret',
+					as: 'versions',
+				},
+			},
+			{
+				$match: {
+					versions: { $size: 0 },
+				},
+			},
+		]);
+
+		if (unversionedSecrets.length > 0) {
+			await addSecretVersionsHelper({
+				secretVersions: unversionedSecrets.map((s, idx) => ({
+					...s,
+					secret: s._id,
+					version: s.version ? s.version : 1,
+					isDeleted: false,
+					workspace: s.workspace,
+					environment: s.environment
+				}))
+			});
+		}
 
 	} catch (err) {
 		Sentry.setUser(null);
@@ -162,7 +162,7 @@ const initSecretVersioningHelper = async () => {
 }
 
 export {
-    takeSecretSnapshotHelper,
+	takeSecretSnapshotHelper,
 	addSecretVersionsHelper,
 	markDeletedSecretVersionsHelper,
 	initSecretVersioningHelper

backend/src/ee/models/secretVersion.ts

@@ -10,14 +10,14 @@ import {
 
 export interface ISecretVersion {
 	_id: Types.ObjectId;
-    secret: Types.ObjectId;
-    version: number;
+	secret: Types.ObjectId;
+	version: number;
 	workspace: Types.ObjectId; // new
 	type: string; // new
 	user: Types.ObjectId; // new
 	environment: string; // new
-    isDeleted: boolean;
-    secretKeyCiphertext: string;
+	isDeleted: boolean;
+	secretKeyCiphertext: string;
 	secretKeyIV: string;
 	secretKeyTag: string;
 	secretKeyHash: string;
@@ -28,17 +28,17 @@ export interface ISecretVersion {
 }
 
 const secretVersionSchema = new Schema<ISecretVersion>(
-    {
-        secret: { // could be deleted
-            type: Schema.Types.ObjectId,
-            ref: 'Secret',
-            required: true
-        },
-        version: {
-            type: Number,
-            default: 1,
-            required: true
-        },
+	{
+		secret: { // could be deleted
+			type: Schema.Types.ObjectId,
+			ref: 'Secret',
+			required: true
+		},
+		version: {
+			type: Number,
+			default: 1,
+			required: true
+		},
 		workspace: {
 			type: Schema.Types.ObjectId,
 			ref: 'Workspace',
@@ -59,12 +59,12 @@ const secretVersionSchema = new Schema<ISecretVersion>(
 			enum: [ENV_DEV, ENV_TESTING, ENV_STAGING, ENV_PROD],
 			required: true
 		},
-        isDeleted: { // consider removing field
-            type: Boolean,
-            default: false,
-            required: true
-        },
-        secretKeyCiphertext: {
+		isDeleted: { // consider removing field
+			type: Boolean,
+			default: false,
+			required: true
+		},
+		secretKeyCiphertext: {
 			type: String,
 			required: true
 		},
@@ -94,10 +94,10 @@ const secretVersionSchema = new Schema<ISecretVersion>(
 		secretValueHash: {
 			type: String
 		}
-    },
-    {
-        timestamps: true
-    }
+	},
+	{
+		timestamps: true
+	}
 );
 
 const SecretVersion = model<ISecretVersion>('SecretVersion', secretVersionSchema);