Create APIs and add info to reports

apps/meteor/app/api/server/v1/misc.ts

@@ -1,13 +1,14 @@
 import crypto from 'crypto';
 
 import type { IUser } from '@rocket.chat/core-typings';
-import { Users } from '@rocket.chat/models';
+import { Settings, Users } from '@rocket.chat/models';
 import {
 	isShieldSvgProps,
 	isSpotlightProps,
 	isDirectoryProps,
 	isMethodCallProps,
 	isMethodCallAnonProps,
+	isFingerprintProps,
 	isMeteorCall,
 	validateParamsPwGetPolicyRest,
 } from '@rocket.chat/rest-typings';
@@ -16,6 +17,7 @@ import EJSON from 'ejson';
 import { check } from 'meteor/check';
 import { DDPRateLimiter } from 'meteor/ddp-rate-limiter';
 import { Meteor } from 'meteor/meteor';
+import { v4 as uuidv4 } from 'uuid';
 
 import { i18n } from '../../../../server/lib/i18n';
 import { SystemLogger } from '../../../../server/lib/logger/system';
@@ -643,3 +645,75 @@ API.v1.addRoute(
 		},
 	},
 );
+
+/**
+ * @openapi
+ *  /api/v1/fingerprint:
+ *    post:
+ *      description: Update Fingerprint definition as a new workspace or update of configuration
+ *      security:
+ *        $ref: '#/security/authenticated'
+ *      requestBody:
+ *        content:
+ *          application/json:
+ *            schema:
+ *              type: object
+ *              properties:
+ *                setDeploymentAs:
+ *                  type: string
+ *            example: |
+ *              {
+ *                 "setDeploymentAs": "new-workspace"
+ *              }
+ *      responses:
+ *        200:
+ *          description: Workspace successfully configured
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: '#/components/schemas/ApiSuccessV1'
+ *        default:
+ *          description: Unexpected error
+ *          content:
+ *            application/json:
+ *              schema:
+ *                $ref: '#/components/schemas/ApiFailureV1'
+ */
+API.v1.addRoute(
+	'fingerprint',
+	{
+		authRequired: true,
+		validateParams: isFingerprintProps,
+	},
+	{
+		async post() {
+			check(this.bodyParams, {
+				setDeploymentAs: String,
+			});
+
+			if (this.bodyParams.setDeploymentAs === 'new-workspace') {
+				await Promise.all([
+					Settings.resetValueById('uniqueID', process.env.DEPLOYMENT_ID || uuidv4()),
+					// Settings.resetValueById('Cloud_Url'),
+					Settings.resetValueById('Cloud_Service_Agree_PrivacyTerms'),
+					Settings.resetValueById('Cloud_Workspace_Id'),
+					Settings.resetValueById('Cloud_Workspace_Name'),
+					Settings.resetValueById('Cloud_Workspace_Client_Id'),
+					Settings.resetValueById('Cloud_Workspace_Client_Secret'),
+					Settings.resetValueById('Cloud_Workspace_Client_Secret_Expires_At'),
+					Settings.resetValueById('Cloud_Workspace_Registration_Client_Uri'),
+					Settings.resetValueById('Cloud_Workspace_PublicKey'),
+					Settings.resetValueById('Cloud_Workspace_License'),
+					Settings.resetValueById('Cloud_Workspace_Had_Trial'),
+					Settings.resetValueById('Cloud_Workspace_Access_Token'),
+					Settings.resetValueById('Cloud_Workspace_Access_Token_Expires_At', new Date(0)),
+					Settings.resetValueById('Cloud_Workspace_Registration_State'),
+				]);
+			}
+
+			await Settings.updateValueById('Deployment_FingerPrint_Verified', true);
+
+			return API.v1.success({});
+		},
+	},
+);

apps/meteor/app/cloud/server/functions/buildRegistrationData.ts

@@ -45,6 +45,8 @@ export async function buildWorkspaceRegistrationData<T extends string | undefine
 	const npsEnabled = settings.get('NPS_survey_enabled');
 	const agreePrivacyTerms = settings.get('Cloud_Service_Agree_PrivacyTerms');
 	const setupWizardState = settings.get('Show_Setup_Wizard');
+	const deploymentFingerprintHash = settings.get('Deployment_FingerPrint_Hash');
+	const deploymentFingerprintVerified = settings.get('Deployment_FingerPrint_Verified');
 
 	const firstUser = await Users.getOldest({ projection: { name: 1, emails: 1 } });
 	const contactName = firstUser?.name || '';
@@ -54,6 +56,8 @@ export async function buildWorkspaceRegistrationData<T extends string | undefine
 
 	return {
 		uniqueId: stats.uniqueId,
+		deploymentFingerprintHash
+		deploymentFingerprintVerified
 		workspaceId,
 		address,
 		contactName,

apps/meteor/app/statistics/server/lib/statistics.ts

@@ -89,6 +89,9 @@ export const statistics = {
 			statistics.installedAt = uniqueID.createdAt.toISOString();
 		}
 
+		statistics.deploymentFingerprintHash = settings.get('Deployment_FingerPrint_Hash');
+		statistics.deploymentFingerprintVerified = settings.get('Deployment_FingerPrint_Verified');
+
 		if (Info) {
 			statistics.version = Info.version;
 			statistics.tag = Info.tag;

apps/meteor/client/startup/rootUrlChange.ts

@@ -83,15 +83,16 @@ Meteor.startup(() => {
 
 		const updateWorkspace = (): void => {
 			imperativeModal.close();
-			console.log('updateWorkspace');
+			void sdk.rest.post('/v1/fingerprint', { setDeploymentAs: 'updated-configuration' }).then(() => {
+				dispatchToastMessage({ type: 'success', message: t('Saved') });
+			});
 		};
 
 		const setNewWorkspace = (): void => {
 			imperativeModal.close();
-			console.log('setNewWorkspace');
-			// void sdk.call('saveSetting', 'Site_Url', currentUrl).then(() => {
-			// 	dispatchToastMessage({ type: 'success', message: t('Saved') });
-			// });
+			void sdk.rest.post('/v1/fingerprint', { setDeploymentAs: 'new-workspace' }).then(() => {
+				dispatchToastMessage({ type: 'success', message: t('Saved') });
+			});
 		};
 
 		const openModal = (): void => {

apps/meteor/server/models/raw/Settings.ts

@@ -69,6 +69,25 @@ export class SettingsRaw extends BaseRaw<ISetting> implements ISettingsModel {
 		return this.updateOne(query, update);
 	}
 
+	async resetValueById(
+		_id: string,
+		value?: (ISetting['value'] extends undefined ? never : ISetting['value']) | null,
+	): Promise<Document | UpdateResult | undefined> {
+		if (value == null) {
+			const record = await this.findOneById(_id);
+			if (record) {
+				const prop = record.valueSource || 'packageValue';
+				value = record[prop];
+			}
+		}
+
+		if (value == null) {
+			return;
+		}
+
+		return this.updateValueById(_id, value);
+	}
+
 	async incrementValueById(_id: ISetting['_id'], value = 1): Promise<Document | UpdateResult> {
 		return this.updateOne(
 			{

apps/meteor/server/settings/misc.ts

@@ -1,62 +1,34 @@
 import crypto from 'crypto';
 
-// import { MongoInternals } from 'meteor/mongo';
 import { Logger } from '@rocket.chat/logger';
 import { Settings } from '@rocket.chat/models';
 import { v4 as uuidv4 } from 'uuid';
 
 import { settingsRegistry, settings } from '../../app/settings/server';
 
-interface Fingerprint {
-	site_url: string;
-	db_connection_string: string;
-}
-
-// TODO:
-// Apis to set as new deploy or update
-// On update list variables to re generate / cleanup
-// Modal to request action
-// Process on site_url change
-
 const logger = new Logger('FingerPrint');
 
 const generateFingerprint = function () {
 	const siteUrl = settings.get('Site_Url');
 	const dbConnectionString = process.env.MONGO_URL;
 
 	const fingerprint = `${siteUrl}${dbConnectionString}`;
-	console.log(fingerprint);
 	return crypto.createHash('sha256').update(fingerprint).digest('base64');
 };
 
 const updateFingerprint = async function (fingerprint: string, verified: boolean) {
-	await Settings.updateOne(
-		{ _id: 'Deployment_FingerPrint_Hash' },
-		{
-			$set: {
-				value: fingerprint,
-			},
-		},
-	);
-
-	await Settings.updateOne(
-		{ _id: 'Deployment_FingerPrint_Verified' },
-		{
-			$set: {
-				value: verified,
-			},
-		},
-	);
+	await Settings.updateValueById('Deployment_FingerPrint_Hash', fingerprint);
+
+	await Settings.updateValueById('Deployment_FingerPrint_Verified', verified);
 };
 
 const verifyFingerPrint = async function () {
 	const DeploymentFingerPrintRecordHash = await Settings.getValueById('Deployment_FingerPrint_Hash');
 
 	const fingerprint = generateFingerprint();
 
-	console.log(DeploymentFingerPrintRecordHash);
 	if (!DeploymentFingerPrintRecordHash) {
-		logger.info('Generating fingerprint for the first time');
+		logger.info('Generating fingerprint for the first time', fingerprint);
 		await updateFingerprint(fingerprint, true);
 		return;
 	}
@@ -86,16 +58,13 @@ export const createMiscSettings = async () => {
 
 	await settingsRegistry.add('Deployment_FingerPrint_Hash', '', {
 		public: false,
-		blocked: true,
-		// hidden: true,
-		// secret: true,
+		readonly: true,
 	});
 
 	await settingsRegistry.add('Deployment_FingerPrint_Verified', false, {
 		type: 'boolean',
 		public: true,
-		blocked: true,
-		// hidden: true,
+		readonly: true,
 	});
 
 	await verifyFingerPrint();

packages/core-typings/src/ISetting.ts

@@ -72,7 +72,7 @@ export interface ISettingBase {
 	hidden?: boolean;
 	modules?: Array<string>;
 	invalidValue?: SettingValue;
-	valueSource?: string;
+	valueSource?: 'packageValue' | 'processEnvValue';
 	secret?: boolean;
 	i18nDescription?: string;
 	autocomplete?: boolean;

packages/core-typings/src/IStats.ts

@@ -8,6 +8,8 @@ export interface IStats {
 	_id: string;
 	wizard: Record<string, unknown>;
 	uniqueId: string;
+	deploymentFingerprintHash: string;
+	deploymentFingerprintVerified: boolean;
 	installedAt?: string;
 	version?: string;
 	tag?: string;

packages/model-typings/src/models/ISettingsModel.ts

@@ -17,6 +17,11 @@ export interface ISettingsModel extends IBaseModel<ISetting> {
 		value: (ISetting['value'] extends undefined ? never : ISetting['value']) | null,
 	): Promise<Document | UpdateResult>;
 
+	resetValueById(
+		_id: string,
+		value?: (ISetting['value'] extends undefined ? never : ISetting['value']) | null,
+	): Promise<Document | UpdateResult | undefined>;
+
 	incrementValueById(_id: ISetting['_id'], value?: number): Promise<Document | UpdateResult>;
 
 	updateOptionsById<T extends ISetting = ISetting>(

packages/rest-typings/src/v1/misc.ts

@@ -164,6 +164,22 @@ const MethodCallAnonSchema = {
 
 export const isMethodCallAnonProps = ajv.compile<MethodCallAnon>(MethodCallAnonSchema);
 
+type Fingerprint = { setDeploymentAs: 'new-workspace' | 'updated-configuration' };
+
+const FingerprintSchema = {
+	type: 'object',
+	properties: {
+		setDeploymentAs: {
+			type: 'string',
+			enum: ['new-workspace', 'updated-configuration'],
+		},
+	},
+	required: ['setDeploymentAs'],
+	additionalProperties: false,
+};
+
+export const isFingerprintProps = ajv.compile<Fingerprint>(FingerprintSchema);
+
 type PwGetPolicyReset = { token: string };
 
 const PwGetPolicyResetSchema = {
@@ -229,6 +245,12 @@ export type MiscEndpoints = {
 		};
 	};
 
+	'/v1/fingerprint': {
+		POST: (params: Fingerprint) => {
+			success: boolean;
+		};
+	};
+
 	'/v1/smtp.check': {
 		GET: () => {
 			isSMTPConfigured: boolean;