HCK-13303: script generation options - add browser endpoint

api/fe.js

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

esbuild.package.js

@@ -12,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, 'forward_engineering', 'ddlProvider.js'),
 			path.resolve(__dirname, 'forward_engineering', 'dbtProvider.js'),

forward_engineering/api.js

@@ -1,89 +1,17 @@
-const _ = require('lodash');
-const { commentDropStatements } = require('./helpers/commentHelpers/commentDropStatements.js');
-const { DROP_STATEMENTS } = require('./helpers/constants.js');
-const { getAlterScript } = require('./helpers/alterScriptFromDeltaHelper.js');
-const { applyToInstance } = require('./helpers/applyToInstanceHelper.js');
-const reApi = require('../reverse_engineering/api.js');
-const { handleError } = require('./helpers/handleError.js');
+const { generateScript } = require('./api/generateScript');
+const { generateViewScript } = require('./api/generateViewScript');
+const { generateContainerScript } = require('./api/generateContainerScript');
+const { isDropInStatements } = require('./api/isDropInStatements');
+const { applyToInstance } = require('./api/applyToInstance');
+const { getExternalBrowserUrl } = require('./api/getExternalBrowserUrl');
+const { testConnection } = require('./api/testConnection');
 
 module.exports = {
-	generateScript(data, logger, callback, app) {
-		try {
-			const ddlProvider = require('./ddlProvider')(_, data.options, app);
-
-			const collection = JSON.parse(data.jsonSchema);
-
-			if (!collection) {
-				throw new Error(
-					'"comparisonModelCollection" is not found. Alter script can be generated only from Delta model',
-				);
-			}
-
-			const scriptFormat = _.get(data, 'options.targetScriptOptions.keyword');
-			const script = getAlterScript({ scriptFormat, collection, ddlProvider, app });
-
-			const applyDropStatements = data.options?.additionalOptions?.some(
-				option => option.id === 'applyDropStatements' && option.value,
-			);
-
-			callback(null, applyDropStatements ? script : commentDropStatements(script));
-		} catch (error) {
-			logger.log('error', { message: error.message, stack: error.stack }, 'Snowflake Forward-Engineering Error');
-
-			callback({ message: error.message, stack: error.stack });
-		}
-	},
-
-	generateContainerScript(data, logger, callback, app) {
-		try {
-			data.jsonSchema = data.collections[0];
-			this.generateScript(data, logger, callback, app);
-		} catch (error) {
-			logger.log('error', { message: error.message, stack: error.stack }, 'Snowflake Forward-Engineering Error');
-
-			callback({ message: error.message, stack: error.stack });
-		}
-	},
-
-	applyToInstance(connectionInfo, logger, callback, app) {
-		logger.clear();
-		logger.log(
-			'info',
-			_.omit(connectionInfo, 'script', 'containerData'),
-			'connectionInfo',
-			connectionInfo.hiddenKeys,
-		);
-
-		applyToInstance(connectionInfo, logger, app)
-			.then(result => {
-				callback(null, result);
-			})
-			.catch(error => handleError(logger, error, callback));
-	},
-
-	async getExternalBrowserUrl(connectionInfo, logger, cb, app) {
-		reApi.getExternalBrowserUrl(connectionInfo, logger, cb, app);
-	},
-
-	testConnection(connectionInfo, logger, callback, app) {
-		reApi.testConnection(connectionInfo, logger, callback, app);
-	},
-
-	isDropInStatements(data, logger, callback, app) {
-		try {
-			const cb = (error, script = '') =>
-				callback(
-					error,
-					DROP_STATEMENTS.some(statement => script.includes(statement)),
-				);
-
-			if (data.level === 'container') {
-				this.generateContainerScript(data, logger, cb, app);
-			} else {
-				this.generateScript(data, logger, cb, app);
-			}
-		} catch (e) {
-			callback({ message: e.message, stack: e.stack });
-		}
-	},
+	generateScript,
+	generateViewScript,
+	generateContainerScript,
+	applyToInstance,
+	getExternalBrowserUrl,
+	testConnection,
+	isDropInStatements,
 };

forward_engineering/api/applyToInstance.js

@@ -0,0 +1,18 @@
+const _ = require('lodash');
+const { applyToInstance: applyToInstanceHelper } = require('../helpers/applyToInstanceHelper.js');
+const { handleError } = require('../helpers/handleError.js');
+
+function applyToInstance(connectionInfo, logger, callback, app) {
+	logger.clear();
+	logger.log('info', _.omit(connectionInfo, 'script', 'containerData'), 'connectionInfo', connectionInfo.hiddenKeys);
+
+	applyToInstanceHelper(connectionInfo, logger)
+		.then(result => {
+			callback(null, result);
+		})
+		.catch(error => handleError(logger, error, callback));
+}
+
+module.exports = {
+	applyToInstance,
+};

forward_engineering/api/generateContainerScript.js

@@ -0,0 +1,16 @@
+const { generateScript } = require('./generateScript');
+
+function generateContainerScript(data, logger, callback, app) {
+	try {
+		data.jsonSchema = data.collections[0];
+		generateScript(data, logger, callback, app);
+	} catch (error) {
+		logger.log('error', { message: error.message, stack: error.stack }, 'Snowflake Forward-Engineering Error');
+
+		callback({ message: error.message, stack: error.stack });
+	}
+}
+
+module.exports = {
+	generateContainerScript,
+};

forward_engineering/api/generateScript.js

@@ -0,0 +1,34 @@
+const _ = require('lodash');
+const { commentDropStatements } = require('../helpers/commentHelpers/commentDropStatements.js');
+const { getAlterScript } = require('../helpers/alterScriptFromDeltaHelper.js');
+
+function generateScript(data, logger, callback, app) {
+	try {
+		const ddlProvider = require('../ddlProvider')(_, data.options, app);
+
+		const collection = JSON.parse(data.jsonSchema);
+
+		if (!collection) {
+			throw new Error(
+				'"comparisonModelCollection" is not found. Alter script can be generated only from Delta model',
+			);
+		}
+
+		const scriptFormat = _.get(data, 'options.targetScriptOptions.keyword');
+		const script = getAlterScript({ scriptFormat, collection, ddlProvider, app });
+
+		const applyDropStatements = data.options?.additionalOptions?.some(
+			option => option.id === 'applyDropStatements' && option.value,
+		);
+
+		callback(null, applyDropStatements ? script : commentDropStatements(script));
+	} catch (error) {
+		logger.log('error', { message: error.message, stack: error.stack }, 'Snowflake Forward-Engineering Error');
+
+		callback({ message: error.message, stack: error.stack });
+	}
+}
+
+module.exports = {
+	generateScript,
+};

forward_engineering/api/generateViewScript.js

@@ -0,0 +1,7 @@
+function generateViewScript(data, logger, callback, app) {
+	callback(new Error('Forward-Engineering of delta model on view level is not supported'));
+}
+
+module.exports = {
+	generateViewScript,
+};

forward_engineering/api/getExternalBrowserUrl.js

@@ -0,0 +1,9 @@
+const reApi = require('../../reverse_engineering/api.js');
+
+async function getExternalBrowserUrl(connectionInfo, logger, cb, app) {
+	reApi.getExternalBrowserUrl(connectionInfo, logger, cb, app);
+}
+
+module.exports = {
+	getExternalBrowserUrl,
+};

forward_engineering/api/isDropInStatements.js

@@ -0,0 +1,25 @@
+const { DROP_STATEMENTS } = require('../helpers/constants.js');
+const { generateScript } = require('./generateScript');
+const { generateContainerScript } = require('./generateContainerScript');
+
+function isDropInStatements(data, logger, callback, app) {
+	try {
+		const cb = (error, script = '') =>
+			callback(
+				error,
+				DROP_STATEMENTS.some(statement => script.includes(statement)),
+			);
+
+		if (data.level === 'container') {
+			generateContainerScript(data, logger, cb, app);
+		} else {
+			generateScript(data, logger, cb, app);
+		}
+	} catch (e) {
+		callback({ message: e.message, stack: e.stack });
+	}
+}
+
+module.exports = {
+	isDropInStatements,
+};

forward_engineering/api/testConnection.js

@@ -0,0 +1,9 @@
+const reApi = require('../../reverse_engineering/api.js');
+
+function testConnection(connectionInfo, logger, callback, app) {
+	reApi.testConnection(connectionInfo, logger, callback, app);
+}
+
+module.exports = {
+	testConnection,
+};