HCK-9607: browser support

api/fe.js

@@ -0,0 +1,7 @@
+const { generateScript } = require('../forward_engineering/generateScript');
+const { generateContainerScript } = require('../forward_engineering/generateContainerScript');
+
+module.exports = {
+	generateScript,
+	generateContainerScript,
+};

esbuild.package.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const esbuild = require('esbuild');
 const { clean } = require('esbuild-plugin-clean');
+const { copy } = require('esbuild-plugin-copy');
 const { copyFolderFiles, addReleaseFlag } = require('@hackolade/hck-esbuild-plugins-pack');
 const { EXCLUDED_EXTENSIONS, EXCLUDED_FILES, DEFAULT_RELEASE_FOLDER_PATH } = require('./buildConstants');
 
@@ -11,6 +12,7 @@ const RELEASE_FOLDER_PATH = path.join(DEFAULT_RELEASE_FOLDER_PATH, `${packageDat
 esbuild
 	.build({
 		entryPoints: [
+			path.resolve(__dirname, 'api', 'fe.js'),
 			path.resolve(__dirname, 'forward_engineering', 'api.js'),
 			path.resolve(__dirname, 'reverse_engineering', 'api.js'),
 		],
@@ -21,10 +23,17 @@ esbuild
 		outdir: RELEASE_FOLDER_PATH,
 		minify: true,
 		logLevel: 'info',
+		external: ['lodash'],
 		plugins: [
 			clean({
 				patterns: [DEFAULT_RELEASE_FOLDER_PATH],
 			}),
+			copy({
+				assets: {
+					from: [path.join('node_modules', 'lodash', '**', '*')],
+					to: [path.join('node_modules', 'lodash')],
+				},
+			}),
 			copyFolderFiles({
 				fromPath: __dirname,
 				targetFolderPath: RELEASE_FOLDER_PATH,

forward_engineering/api.js

@@ -1,142 +1,10 @@
-const applyToInstanceHelper = require('./applyToInstance');
-const getIndexPolicyScript = require('./helpers/getIndexPolicyScript');
-const { getUniqueKeyPolicyScript } = require('./helpers/getUniqueKeyPolicyScript');
-const { buildAzureCLIScript } = require('./helpers/azureCLIScriptHelpers/buildAzureCLIScript');
-const getPartitionKey = require('./helpers/getPartitionKey');
+const { generateScript } = require('./generateScript');
+const { generateContainerScript } = require('./generateContainerScript');
+const { applyToInstance, testConnection } = require('./applyToInstance');
 
 module.exports = {
-	generateContainerScript(data, logger, callback, app) {
-		try {
-			const _ = app.require('lodash');
-			const insertSamplesOption =
-				_.get(data, 'options.additionalOptions', []).find(option => option.id === 'INCLUDE_SAMPLES') || {};
-			const withSamples = data.options.origin !== 'ui';
-			const samples = data.entities.map(entityId =>
-				updateSample(
-					JSON.parse(data.jsonData[entityId]),
-					data.containerData[0],
-					(data.entityData[entityId] || [])[0] || {},
-				),
-			);
-			if (data.options?.targetScriptOptions?.keyword === 'containerSettingsJson') {
-				const uniqueKeys = _.get(data.containerData, '[0].uniqueKey', []);
-				const scriptData = {
-					partitionKey: getPartitionKey(_)(data.containerData),
-					...(uniqueKeys.length && getUniqueKeyPolicyScript(uniqueKeys)),
-					indexingPolicy: getIndexPolicyScript(_)(data.containerData),
-					...(withSamples && { sample: samples }),
-					...addItems(_)(data.containerData),
-				};
-				const script = JSON.stringify(scriptData, null, 2);
-				if (withSamples || !insertSamplesOption.value) {
-					return callback(null, script);
-				}
-
-				return callback(null, [
-					{ title: 'CosmosDB script', script },
-					{ title: 'Sample data', script: JSON.stringify(samples, null, 2) },
-				]);
-			}
-
-			const script = buildAzureCLIScript(_)({
-				...data,
-			});
-
-			if (withSamples || !insertSamplesOption.value) {
-				return callback(null, script);
-			}
-
-			return callback(null, [
-				{ title: 'Azure CLI script', script },
-				{ title: 'Sample data', script: JSON.stringify(samples, null, 2) },
-			]);
-		} catch (e) {
-			const error = { message: e.message, stack: e.stack };
-			logger.log('error', error, 'CosmosDB w\\ SQL API forward engineering error');
-			callback(error);
-		}
-	},
-	generateScript(data, logger, callback, app) {
-		try {
-			const _ = app.require('lodash');
-			const uniqueKeys = _.get(data.containerData, '[0].uniqueKey', []);
-
-			const script = {
-				partitionKey: getPartitionKey(_)(data.containerData),
-				indexingPolicy: getIndexPolicyScript(_)(data.containerData),
-				...(uniqueKeys.length && getUniqueKeyPolicyScript(uniqueKeys)),
-				sample: updateSample(JSON.parse(data.jsonData), data.containerData[0], data.entityData[0]),
-				...addItems(_)(data.containerData),
-			};
-			return callback(null, JSON.stringify(script, null, 2));
-		} catch (e) {
-			const error = { message: e.message, stack: e.stack };
-			logger.log('error', error, 'CosmosDB w\\ SQL API forward engineering error');
-			callback(error);
-		}
-	},
-	applyToInstance: applyToInstanceHelper.applyToInstance,
-
-	testConnection: applyToInstanceHelper.testConnection,
-};
-
-const updateSample = (sample, containerData, entityData) => {
-	const docType = containerData?.docTypeName;
-
-	if (!docType) {
-		return sample;
-	}
-
-	return {
-		...sample,
-		[docType]: entityData.code || entityData.collectionName,
-	};
-};
-
-const add = (key, items, mapper) => script => {
-	if (!items.length) {
-		return script;
-	}
-
-	return {
-		...script,
-		[key]: mapper(items),
-	};
-};
-
-const addItems = _ => containerData => {
-	return _.flow(
-		add('Stored Procedures', _.get(containerData, '[2].storedProcs', []), mapStoredProcs),
-		add('User Defined Functions', _.get(containerData, '[4].udfs', []), mapUDFs),
-		add('Triggers', _.get(containerData, '[3].triggers', []), mapTriggers),
-	)();
-};
-
-const mapUDFs = udfs => {
-	return udfs.map(udf => {
-		return {
-			id: udf.udfID,
-			body: udf.udfFunction,
-		};
-	});
-};
-
-const mapTriggers = triggers => {
-	return triggers.map(trigger => {
-		return {
-			id: trigger.triggerID,
-			body: trigger.triggerFunction,
-			triggerOperation: trigger.triggerOperation,
-			triggerType: trigger.prePostTrigger === 'Pre-Trigger' ? 'Pre' : 'Post',
-		};
-	});
-};
-
-const mapStoredProcs = storedProcs => {
-	return storedProcs.map(proc => {
-		return {
-			id: proc.storedProcID,
-			body: proc.storedProcFunction,
-		};
-	});
+	generateScript,
+	generateContainerScript,
+	applyToInstance,
+	testConnection,
 };

forward_engineering/applyToInstance/applyToInstanceHelper.js

@@ -1,8 +1,7 @@
 const { StoredProcedure, UserDefinedFunction, Trigger } = require('@azure/cosmos');
 const setUpDocumentClient = require('../../reverse_engineering/helpers/setUpDocumentClient');
-const { TTL_ON_DEFAULT, TTL_ON, TTL_OFF } = require('../../shared/constants');
 
-const applyToInstanceHelper = _ => ({
+const applyToInstanceHelper = {
 	setUpDocumentClient(connectionInfo) {
 		return setUpDocumentClient(connectionInfo);
 	},
@@ -57,28 +56,6 @@ const applyToInstanceHelper = _ => ({
 			}
 		}, Promise.resolve());
 	},
-
-	getTTL(containerData) {
-		switch (containerData?.TTL) {
-			case TTL_ON_DEFAULT:
-				return -1;
-			case TTL_ON:
-				return _.parseInt(containerData?.TTLseconds) || -1;
-			case TTL_OFF:
-			default:
-				return 0;
-		}
-	},
-
-	getContainerThroughputProps(containerData) {
-		if (containerData?.capacityMode === 'Serverless') {
-			return {};
-		}
-		if (containerData?.autopilot) {
-			return { maxThroughput: containerData.throughput || 4000 };
-		}
-		return { throughput: containerData?.throughput || 400 };
-	},
-});
+};
 
 module.exports = applyToInstanceHelper;

forward_engineering/applyToInstance/index.js

@@ -1,7 +1,10 @@
+const _ = require('lodash');
 const reApi = require('../../reverse_engineering/api');
-const executeWithTimeout = require('../../reverse_engineering/helpers/executeWithTimeout');
-const { TTL_ON, TTL_ON_DEFAULT } = require('../../shared/constants');
 const applyToInstanceHelper = require('./applyToInstanceHelper');
+const { executeWithTimeout } = require('../../shared/executeWithTimeout');
+const { TTL_ON, TTL_ON_DEFAULT } = require('../../shared/constants');
+const { getTTL } = require('../helpers/getTtl');
+const { getContainerThroughputProps } = require('../helpers/getContainerThroughputProps');
 
 const createOrUpdate = async (sample, container) => {
 	try {
@@ -62,14 +65,13 @@ const updateIndexingPolicy = indexes => {
 
 module.exports = {
 	testConnection: reApi.testConnection,
+
 	async applyToInstance(connectionInfo, logger, callback, app) {
-		const _ = app.require('lodash');
 		try {
-			const helper = applyToInstanceHelper(_);
 			logger.progress = logger.progress || (() => {});
 			logger.clear();
 			logger.log('info', connectionInfo, 'Apply to instance connection settings', connectionInfo.hiddenKeys);
-			const client = helper.setUpDocumentClient(connectionInfo);
+			const client = applyToInstanceHelper.setUpDocumentClient(connectionInfo);
 			const script = parseScript(connectionInfo.script);
 			const containerData = _.get(connectionInfo, 'containerData[0]');
 			const databaseId = _.get(containerData, 'dbId');
@@ -93,9 +95,9 @@ module.exports = {
 			const { container, resource: containerDef } = await database.containers.createIfNotExists({
 				id: containerId,
 				partitionKey: script.partitionKey,
-				...(shouldIncludeTtl && { defaultTtl: helper.getTTL(containerData) }),
+				...(shouldIncludeTtl && { defaultTtl: getTTL(containerData) }),
 				...(script.uniqueKeyPolicy && { uniqueKeyPolicy: script.uniqueKeyPolicy }),
-				...helper.getContainerThroughputProps(containerData),
+				...getContainerThroughputProps(containerData),
 			});
 
 			progress('Add sample documents ...');
@@ -119,19 +121,19 @@ module.exports = {
 			const storedProcs = _.get(script, 'Stored Procedures', []);
 			if (storedProcs.length) {
 				progress('Upload stored procs ...');
-				await helper.createStoredProcs(storedProcs, container);
+				await applyToInstanceHelper.createStoredProcs(storedProcs, container);
 			}
 
 			const udfs = _.get(script, 'User Defined Functions', []);
 			if (udfs.length) {
 				progress('Upload user defined functions ...');
-				await helper.createUDFs(udfs, container);
+				await applyToInstanceHelper.createUDFs(udfs, container);
 			}
 
 			const triggers = _.get(script, 'Triggers', []);
 			if (triggers.length) {
 				progress('Upload triggers ...');
-				await helper.createTriggers(triggers, container);
+				await applyToInstanceHelper.createTriggers(triggers, container);
 			}
 
 			progress('Applying to instance finished');

forward_engineering/generateContainerScript.js

@@ -0,0 +1,62 @@
+const _ = require('lodash');
+const { getIndexPolicyScript } = require('./helpers/getIndexPolicyScript');
+const { getPartitionKey } = require('./helpers/getPartitionKey');
+const { buildAzureCLIScript } = require('./helpers/azureCLIScriptHelpers/buildAzureCLIScript');
+const { getUniqueKeyPolicyScript } = require('./helpers/getUniqueKeyPolicyScript');
+const { updateSample } = require('./helpers/updateSample');
+const { addItems } = require('./helpers/addItems');
+
+const generateContainerScript = (data, logger, callback, app) => {
+	try {
+		const insertSamplesOption =
+			_.get(data, 'options.additionalOptions', []).find(option => option.id === 'INCLUDE_SAMPLES') || {};
+		const withSamples = data.options.origin !== 'ui';
+		const samples = data.entities.map(entityId =>
+			updateSample(
+				JSON.parse(data.jsonData[entityId]),
+				data.containerData[0],
+				(data.entityData[entityId] || [])[0] || {},
+			),
+		);
+		if (data.options?.targetScriptOptions?.keyword === 'containerSettingsJson') {
+			const uniqueKeys = _.get(data.containerData, '[0].uniqueKey', []);
+			const scriptData = {
+				partitionKey: getPartitionKey(data.containerData),
+				...(uniqueKeys.length && getUniqueKeyPolicyScript(uniqueKeys)),
+				indexingPolicy: getIndexPolicyScript(data.containerData),
+				...(withSamples && { sample: samples }),
+				...addItems(data.containerData),
+			};
+			const script = JSON.stringify(scriptData, null, 2);
+			if (withSamples || !insertSamplesOption.value) {
+				return callback(null, script);
+			}
+
+			return callback(null, [
+				{ title: 'CosmosDB script', script },
+				{ title: 'Sample data', script: JSON.stringify(samples, null, 2) },
+			]);
+		}
+
+		const script = buildAzureCLIScript({
+			...data,
+		});
+
+		if (withSamples || !insertSamplesOption.value) {
+			return callback(null, script);
+		}
+
+		return callback(null, [
+			{ title: 'Azure CLI script', script },
+			{ title: 'Sample data', script: JSON.stringify(samples, null, 2) },
+		]);
+	} catch (e) {
+		const error = { message: e.message, stack: e.stack };
+		logger.log('error', error, 'CosmosDB w\\ SQL API forward engineering error');
+		callback(error);
+	}
+};
+
+module.exports = {
+	generateContainerScript,
+};

forward_engineering/generateScript.js

@@ -0,0 +1,29 @@
+const _ = require('lodash');
+const { getIndexPolicyScript } = require('./helpers/getIndexPolicyScript');
+const { getPartitionKey } = require('./helpers/getPartitionKey');
+const { addItems } = require('./helpers/addItems');
+const { getUniqueKeyPolicyScript } = require('./helpers/getUniqueKeyPolicyScript');
+const { updateSample } = require('./helpers/updateSample');
+
+const generateScript = (data, logger, callback, app) => {
+	try {
+		const uniqueKeys = _.get(data.containerData, '[0].uniqueKey', []);
+
+		const script = {
+			partitionKey: getPartitionKey(data.containerData),
+			indexingPolicy: getIndexPolicyScript(data.containerData),
+			...(uniqueKeys.length && getUniqueKeyPolicyScript(uniqueKeys)),
+			sample: updateSample(JSON.parse(data.jsonData), data.containerData[0], data.entityData[0]),
+			...addItems(data.containerData),
+		};
+		return callback(null, JSON.stringify(script, null, 2));
+	} catch (e) {
+		const error = { message: e.message, stack: e.stack };
+		logger.log('error', error, 'CosmosDB w\\ SQL API forward engineering error');
+		callback(error);
+	}
+};
+
+module.exports = {
+	generateScript,
+};