HCK-9252: keys from secondary indexes

forward_engineering/api.js

@@ -21,13 +21,13 @@ const {
 	GENERATING_CONTAINER_SCRIPT,
 	GENERATING_ENTITY_SCRIPT,
 	CREATING_A_BUCKET,
-} = require('../shared/enums/static-messages');
+} = require('../shared/enums/staticMessages');
 const {
 	getCheckBucketExistsMessage,
 	getCreatingBucketMessage,
 	getSuccessfullyCreatedBucketMessage,
-} = require('../shared/enums/dynamic-messages');
-const { HTTP_ERROR_CODES } = require('../shared/enums/http');
+} = require('../shared/enums/dynamicMessages');
+const { HTTP_ERROR_CODES } = require('../shared/enums/httpCodes');
 
 const { applyScript, logApplyScriptAttempt } = require('./services/applyToInstanceService');
 const ForwardEngineeringScriptBuilder = require('./services/forwardEngineeringScriptBuilder');

forward_engineering/services/applyToInstanceService.js

@@ -9,13 +9,13 @@ const {
 	SCRIPT_SUCCESSFULLY_APPLIED,
 	SUCCESSFULLY_APPLIED,
 	ERROR_HAS_BEEN_THROWN_WHILE_APPLYING_SCRIPT_TO_COUCHBASE_INSTANCE,
-} = require('../../shared/enums/static-messages');
+} = require('../../shared/enums/staticMessages');
 const {
 	getApplyingScriptPercentMessage,
 	getRetryAttemptNumberMessage,
 	getApplyingScriptToBucketWithAttemptNumberMessage,
 	getApplyingScriptMessage,
-} = require('../../shared/enums/dynamic-messages');
+} = require('../../shared/enums/dynamicMessages');
 const { COUCHBASE_ERROR_CODE } = require('../../shared/constants');
 
 const MAX_APPLY_ATTEMPTS = 5;

forward_engineering/services/statements/indexesStatements.js

@@ -1,7 +1,7 @@
 const { filter, get, isEmpty } = require('lodash');
 const { getIndexKeyIdToKeyNameMap, injectKeysNamesIntoIndexKeys } = require('../../utils/indexes');
 const { wrapWithBackticks, getKeySpaceReference, joinStatements } = require('./commonStatements');
-const { INDEX_TYPE } = require('../../../shared/enums/n1ql');
+const { INDEX_TYPE } = require('../../../shared/enums/indexType');
 
 /**
  *
@@ -85,7 +85,7 @@ const getKeys = index => {
 	switch (index.indxType) {
 		case INDEX_TYPE.primary:
 			return { script: '', canHaveIndex: true };
-		case INDEX_TYPE.secondary:
+		case INDEX_TYPE.secondary: {
 			const keys = index.indxKey?.map(key => ({ ...key, name: wrapWithBackticks(key.name) }));
 
 			const keysNames = joinStatements({
@@ -96,6 +96,7 @@ const getKeys = index => {
 			});
 
 			return { script: `(${keysNames})`, canHaveIndex: Boolean(keysNames.length) };
+		}
 		case INDEX_TYPE.array:
 			return { script: `(${index.arrayExpr})`, canHaveIndex: true };
 		case INDEX_TYPE.metadata:
@@ -148,13 +149,19 @@ const getWhereClause = index => {
  */
 const getWithClause = index => {
 	const deferBuild = get(index, 'withOptions.defer_build') ? `"defer_build":true` : '';
+
 	const numReplica = !isEmpty(get(index, 'withOptions.num_replica'))
 		? `"num_replica":${index.withOptions.num_replica}`
 		: '';
-	const nodes = get(index, 'withOptions.nodes', []).length
-		? `"nodes":[${joinStatements({ statements: index.withOptions.nodes.map(node => `"${node.nodeName}"`), separator: ',' })}]`
-		: '';
+
+	const nodeStatement = joinStatements({
+		statements: index.withOptions?.nodes?.map(node => `"${node.nodeName}"`),
+		separator: ',',
+	});
+	const nodes = get(index, 'withOptions.nodes', []).length ? `"nodes":[${nodeStatement}]` : '';
+
 	const hasWithClosure = deferBuild || numReplica || nodes;
+
 	const withClosure = joinStatements({ statements: [deferBuild, numReplica, nodes], separator: ',' });
 
 	return hasWithClosure ? `WITH{${withClosure}}` : '';
@@ -190,13 +197,14 @@ const getOrder = order => {
  */
 const getPartitionByHashClause = index => {
 	switch (index.partitionByHash) {
-		case 'Keys':
+		case 'Keys': {
 			const keysNames = joinStatements({
 				statements: index.partitionByHashKeys.map(key => wrapWithBackticks(key.name)),
 				separator: ',',
 			});
 
 			return `PARTITION BY HASH(${keysNames})`;
+		}
 		case 'Expression':
 			return `PARTITION BY HASH(${index.partitionByHashExpr})`;
 		default:
@@ -209,8 +217,13 @@ const getPartitionByHashClause = index => {
  * @param {string} statement
  * @returns {string}
  */
-const commentStatement = statement =>
-	`/*\n${joinStatements({ statements: statement.split('\n').map(line => ` * ${line}`), separator: '\n' })}\n */`;
+const commentStatement = statement => {
+	const joinedStatement = joinStatements({
+		statements: statement.split('\n').map(line => ` * ${line}`),
+		separator: '\n',
+	});
+	return `/*\n${joinedStatement}\n */`;
+};
 
 module.exports = {
 	getIndexesScript,

reverse_engineering/api.js

@@ -144,7 +144,7 @@ const getDbCollectionsData = async (data, appLogger, callback, app) => {
 	});
 
 	try {
-		const connectionInfo = data.connectionInfo;
+		const connectionInfo = data;
 		const includeEmptyCollection = data.includeEmptyCollection;
 		const bucketName = data.database;
 		const collections = data.collectionData.collections;

reverse_engineering/helpers/indexHelper.js

@@ -3,6 +3,7 @@ const restApiHelper = require('./restApiHelper');
 const clusterHelper = require('../../shared/helpers/clusterHelper');
 const parserHelper = require('./parserHelper');
 const { GET_META_REGEXP, GET_PARTITION_HASH_REGEXP, DEFAULT_NAME } = require('../../shared/constants');
+const { INDEX_TYPE } = require('../../shared/enums/indexType');
 
 const handleIndex = index => {
 	const indexData = getHackoladeCompatibleIndex(index);
@@ -13,21 +14,21 @@ const getHackoladeCompatibleIndex = index => {
 	if (index.is_primary) {
 		return {
 			indxName: index.name,
-			indxType: 'Primary',
+			indxType: INDEX_TYPE.primary,
 			usingGSI: index.using === 'gsi',
 		};
 	} else if (checkArrayIndex(index)) {
 		return {
 			indxName: index.name,
-			indxType: 'Array',
+			indxType: INDEX_TYPE.array,
 			usingGSI: index.using === 'gsi',
 			arrayExpr: index.index_key.map(getExpression).join(','),
 			whereClause: getWhereCondition(index),
 		};
 	} else if (checkMetaIndex(index)) {
 		return {
 			indxName: index.name,
-			indxType: 'Metadata',
+			indxType: INDEX_TYPE.metadata,
 			metadataExpr: index.index_key.map(getExpression).join(','),
 		};
 	} else {
@@ -36,7 +37,7 @@ const getHackoladeCompatibleIndex = index => {
 
 		return {
 			indxName: index.name,
-			indxType: 'Secondary',
+			indxType: INDEX_TYPE.secondary,
 			usingGSI: index.using === 'gsi',
 			indxKey: keys,
 			functionExpr: expression,

reverse_engineering/helpers/queryHelper.js

@@ -1,4 +1,6 @@
+const { isEmpty } = require('lodash');
 const { NUM_SAMPLE_VALUES } = require('../../shared/constants');
+const { INDEX_TYPE } = require('../../shared/enums/indexType');
 
 /**
  * @param {{ bucketName: string; scopeName: string; collectionName: string; limit: number }} param0
@@ -18,11 +20,41 @@ const getSelectBucketDocumentsQuery = ({ bucketName, limit, offset }) => {
 };
 
 /**
- * @param {{ bucketName: string; scopeName: string; collectionName: string; limit: number; offset: number }} param0
+ * @param {{ collectionIndexes: object[] }} param0
  * @returns {string}
  */
-const getSelectCollectionDocumentsQuery = ({ bucketName, scopeName, collectionName, limit, offset }) => {
-	const query = `SELECT *, META().id AS docid FROM \`${bucketName}\`.\`${scopeName}\`.\`${collectionName}\` AS \`${bucketName}\``;
+const getWhereClauseFromIndexes = ({ collectionIndexes }) => {
+	// primary index allows to `select` the document id without extra WHERE clause
+	const primaryIndex = collectionIndexes.find(index => index.indxType === INDEX_TYPE.primary);
+
+	if (isEmpty(collectionIndexes) || primaryIndex) {
+		return '';
+	}
+
+	return `WHERE ${collectionIndexes[0].indxKey[0].name} LIKE '%'`;
+};
+
+/**
+ * @param {{
+ * bucketName: string;
+ * scopeName: string;
+ * collectionName: string;
+ * collectionIndexes: object[];
+ * limit: number;
+ * offset: number
+ * }} param0
+ * @returns {string}
+ */
+const getSelectCollectionDocumentsQuery = ({
+	bucketName,
+	scopeName,
+	collectionName,
+	collectionIndexes,
+	limit,
+	offset,
+}) => {
+	const whereClause = getWhereClauseFromIndexes({ collectionIndexes });
+	const query = `SELECT *, META().id AS docid FROM \`${bucketName}\`.\`${scopeName}\`.\`${collectionName}\` AS \`${bucketName}\` ${whereClause}`;
 	return getQueryOptions({ query, limit, offset });
 };
 

reverse_engineering/helpers/restApiHelper.js

@@ -49,8 +49,8 @@ class CouchbaseRestApiService {
 					Authorization: `Basic ${encodedCredentials}`,
 				},
 			};
-
-			return hckFetch(uri, options);
+			const response = await hckFetch(uri, options);
+			return await response.json();
 		} catch (error) {
 			throw new CustomError({
 				message: error.statusText || error.message,

shared/constants.js

@@ -57,7 +57,7 @@ const COUCHBASE_DEFAULT_KV_CONNECTION_PORT = 11210;
 const DISABLED_TOOLTIP = 'Something went wrong. Please, check logs for more details';
 
 const GET_META_REGEXP = /\(meta\(\)\.(.*?)\)/;
-const GET_NODES_REGEXP = /"nodes":(\[.*?\])/;
+const GET_NODES_REGEXP = /"nodes":(\[.*?])/;
 const GET_PARTITION_HASH_REGEXP = /(HASH|hash)\((.*?)\)$/;
 
 /**

shared/helpers/clusterHelper.js

@@ -285,7 +285,12 @@ const getDbCollectionData = async ({
 			logger,
 		});
 		const options = { limit, pagination: data.pagination, bucketName, scopeName, collectionName };
-		const query = queryHelper.getSelectCollectionDocumentsQuery({ bucketName, scopeName, collectionName });
+		const query = queryHelper.getSelectCollectionDocumentsQuery({
+			bucketName,
+			scopeName,
+			collectionName,
+			collectionIndexes,
+		});
 		const documents = await getPaginatedQuery({ cluster, options, query, logger });
 		const standardDocument = await getCollectionDocumentByDocumentId({
 			cluster,