tywalch / electrodb / 220

pending completion

Build # 220

Build Type

Pull #79

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/tywalch/electrodb/commit/<a class=hub.com/tywalch/electrodb/commit/a0da3d7679c40741163430e874bf881f6e6821a1">a0da3d767<a href="https://github.com/tywalch/electrodb/commit/a0da3d7679c40741163430e874bf881f6e6821a1">">Merge </a><a class="double-link" href="https://github.com/tywalch/electrodb/commit/<a class="double-link" href="https://github.com/tywalch/electrodb/commit/fa4032d1c9614787319e4b9665b01411f63289fc">fa4032d1c</a>">fa4032d1c</a><a href="https://github.com/tywalch/electrodb/commit/a0da3d7679c40741163430e874bf881f6e6821a1"> into de2fee884">de2fee884</a>

Pull Request Pull Request #79: Improvements for existing table support

Run Details

1383 of 1753 branches covered (78.89%)

Branch coverage included in aggregate %.

162 of 162 new or added lines in 8 files covered. (100.0%)

2520 of 2754 relevant lines covered (91.5%)

1324.08 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.92

/src/entity.js

"use strict";
const { Schema } = require("./schema");
const { KeyCasing, TableIndex, FormatToReturnValues, ReturnValues, EntityVersions, ItemOperations, UnprocessedTypes, Pager, ElectroInstance, KeyTypes, QueryTypes, MethodTypes, Comparisons, ExpressionTypes, ModelVersions, ElectroInstanceTypes, MaxBatchItems } = require("./types");
const { FilterFactory } = require("./filters");
const { FilterOperations } = require("./operations");
const { WhereFactory } = require("./where");
const { clauses, ChainState } = require("./clauses");
const validations = require("./validations");
const utilities = require("./util");
const e = require("./errors");

class Entity {
        constructor(model, config = {}) {
                this._validateModel(model);
                this.version = EntityVersions.v1;
                this.config = config;
                this.client = config.client;
                this.model = this._parseModel(model, config);
                /** start beta/v1 condition **/
                this.config.table = config.table || model.table;
                /** end beta/v1 condition **/
                this._filterBuilder = new FilterFactory(this.model.schema.attributes, FilterOperations);
                this._whereBuilder = new WhereFactory(this.model.schema.attributes, FilterOperations);
                this._clausesWithFilters = this._filterBuilder.injectFilterClauses(clauses, this.model.filters);
                this._clausesWithFilters = this._whereBuilder.injectWhereClauses(this._clausesWithFilters);
                this.scan = this._makeChain(TableIndex, this._clausesWithFilters, clauses.index).scan();
                this.query = {};
                for (let accessPattern in this.model.indexes) {
                        let index = this.model.indexes[accessPattern].index;
                        this.query[accessPattern] = (...values) => {
                                return this._makeChain(index, this._clausesWithFilters, clauses.index).query(...values);
                        };
                }
                this.config.identifiers = config.identifiers || {};
                this.identifiers = {
                        entity: this.config.identifiers.entity || "__edb_e__",
                        version: this.config.identifiers.version || "__edb_v__",
                };
                this._instance = ElectroInstance.entity;
                this._instanceType = ElectroInstanceTypes.entity;
                this.schema = model;
        }

        setIdentifier(type = "", identifier = "") {
                if (!this.identifiers[type]) {
                        throw new e.ElectroError(e.ErrorCodes.InvalidIdentifier, `Invalid identifier type: "${type}". Valid identifiers include: ${utilities.commaSeparatedString(Object.keys(this.identifiers))}`);
                } else {
                        this.identifiers[type] = identifier;
                }
        }

        getName() {
                return this.model.entity;
        }

        getVersion() {
                return this.model.version;
        }

        ownsItem(item) {
                return (
                        item &&
                        this.getName() === item[this.identifiers.entity] &&
                        this.getVersion() === item[this.identifiers.version] &&
                        validations.isStringHasLength(item[this.identifiers.entity]) &&
                        validations.isStringHasLength(item[this.identifiers.version])
                )
        }

        ownsLastEvaluatedKey(key = {}) {
                let {pk, sk} = this.model.prefixes[TableIndex];
                let hasSK = this.model.lookup.indexHasSortKeys[TableIndex];
                let pkMatch = typeof key[pk.field] === "string" && key[pk.field].startsWith(pk.prefix);
                if (pkMatch && hasSK) {
                        return typeof key[sk.field] === "string" && key[sk.field].startsWith(sk.prefix);
                }
                return pkMatch;
        }

        ownsPager(pager, index) {
                if (pager === null) {
                        return false;
                }
                let tableIndex = TableIndex;
                let tableIndexFacets = this.model.facets.byIndex[tableIndex];
                let indexFacets = this.model.facets.byIndex[tableIndex];

                // Unknown index
                if (tableIndexFacets === undefined || indexFacets === undefined) {
                        return false;
                }

                // Should match all primary index facets
                let matchesTableIndex = tableIndexFacets.all.every((facet) => {
                        return pager[facet.name] !== undefined;
                });

                // If the pager doesnt match the table index, exit early
                if (!matchesTableIndex) {
                        return false;
                }

                return indexFacets.all.every((facet) => {
                        return pager[facet.name] !== undefined;
                });
        }

        match(facets = {}) {
                let match = this._findBestIndexKeyMatch(facets);
                if (match.shouldScan) {
                        return this._makeChain(TableIndex, this._clausesWithFilters, clauses.index)
                                .scan()
                                .filter(attr => {
                                        let eqFilters = [];
                                        for (let facet of Object.keys(facets)) {
                                                if (attr[facet] !== undefined && facets[facet] !== undefined) {
                                                        eqFilters.push(attr[facet].eq(facets[facet]));
                                                }
                                        }
                                return eqFilters.join(" AND ");
                        });
                } else {
                        return this._makeChain(match.index, this._clausesWithFilters, clauses.index)
                                .query(facets)
                                .filter(attr => {
                                        let eqFilters = [];
                                        for (let facet of Object.keys(facets)) {
                                                if (attr[facet] !== undefined && facets[facet] !== undefined) {
                                                        eqFilters.push(attr[facet].eq(facets[facet]));
                                                }
                                        }
                                        return eqFilters.join(" AND ");
                                });
                }
        }

        find(facets = {}) {
                let match = this._findBestIndexKeyMatch(facets);
                if (match.shouldScan) {
                        return this._makeChain(TableIndex, this._clausesWithFilters, clauses.index).scan();
                } else {
                        return this._makeChain(match.index, this._clausesWithFilters, clauses.index).query(facets);
                }
        }

        collection(collection = "", clauses = {}, facets = {}, {expressions = {}, parse} = {}) {
                let options = {
                        parse,
                        expressions: {
                                names: expressions.names || {},
                                values: expressions.values || {},
                                expression: expressions.expression || ""
                        }
                };

                let index = this.model.translations.collections.fromCollectionToIndex[collection];
                if (index === undefined) {
                        throw new Error(`Invalid collection: ${collection}`);
                }
                return this._makeChain(index, clauses, clauses.index, options).collection(
                        collection,
                        facets
                );
        }

        _validateModel(model) {
                return validations.model(model);
        }

        get(facets = {}) {
                let index = TableIndex;
                if (Array.isArray(facets)) {
                        return this._makeChain(index, this._clausesWithFilters, clauses.index).batchGet(facets);
                } else {
                        return this._makeChain(index, clauses, clauses.index).get(facets);
                }
        }


        delete(facets = {}) {
                let index = TableIndex;
                if (Array.isArray(facets)) {
                        return this._makeChain(index, this._clausesWithFilters, clauses.index).batchDelete(facets);
                } else {
                        return this._makeChain(index, this._clausesWithFilters, clauses.index).delete(facets);
                }
        }

        put(attributes = {}) {
                let index = TableIndex;
                if (Array.isArray(attributes)) {
                        return this._makeChain(index, this._clausesWithFilters, clauses.index).batchPut(attributes);
                } else {
                        return this._makeChain(index, this._clausesWithFilters, clauses.index).put(attributes);
                }
        }

        create(attributes = {}) {
                let index = TableIndex;
                let options = {
                        params: {
                                ConditionExpression: this._makeItemDoesntExistConditions(index)
                        }
                };
                return this._makeChain(index, this._clausesWithFilters, clauses.index, options).create(attributes);
        }

        update(facets = {}) {
                let index = TableIndex;
                return this._makeChain(index, this._clausesWithFilters, clauses.index).update(facets);
        }

        patch(facets = {}) {
                let index = TableIndex;
                let options = {
                        params: {
                                ConditionExpression: this._makeItemExistsConditions(index)
                        }
                };
                return this._makeChain(index, this._clausesWithFilters, clauses.index, options).patch(facets);
        }

        remove(facets = {}) {
                let index = TableIndex;
                let options = {
                        params: {
                                ConditionExpression: this._makeItemExistsConditions(index)
                        }
                };
                return this._makeChain(index, this._clausesWithFilters, clauses.index, options).remove(facets);
        }

        async go(method, parameters = {}, config = {}) {
                let stackTrace;
                if (!config.originalErr) {
                        stackTrace = new e.ElectroError(e.ErrorCodes.AWSError);
                }
                try {
                        switch (method) {
                                case MethodTypes.batchWrite:
                                        return await this.executeBulkWrite(parameters, config);
                                case MethodTypes.batchGet:
                                        return await this.executeBulkGet(parameters, config);
                                default:
                                        return await this.executeQuery(method, parameters, config);
                        }
                } catch (err) {
                        if (config.originalErr || stackTrace === undefined) {
                                return Promise.reject(err);
                        } else {
                                if (err.__isAWSError) {
                                        stackTrace.message = new e.ElectroError(e.ErrorCodes.AWSError, err.message).message;
                                        return Promise.reject(stackTrace);
                                } else if (err.isElectroError) {
                                        return Promise.reject(err);
                                } else {
                                        stackTrace.message = new e.ElectroError(e.ErrorCodes.UnknownError, err.message).message;
                                        return Promise.reject(stackTrace);
                                }
                        }
                }
        }

        async _exec(method, parameters) {
                return this.client[method](parameters).promise()
                        .catch(err => {
                                err.__isAWSError = true;
                                throw err;
                        });
        }

        async executeBulkWrite(parameters, config) {
                if (!Array.isArray(parameters)) {
                        parameters = [parameters];
                }
                let results = [];
                let concurrent = this._normalizeConcurrencyValue(config.concurrent)
                let concurrentOperations = utilities.batchItems(parameters, concurrent);
                for (let operation of concurrentOperations) {
                        await Promise.all(operation.map(async params => {
                                let response = await this._exec(MethodTypes.batchWrite, params);
                                if (validations.isFunction(config.parse)) {
                                        let parsed = await config.parse(config, response);
                                        if (parsed) {
                                                results.push(parsed);
                                        }
                                        return;
                                }
                                let unprocessed = this.formatBulkWriteResponse(response, config);
                                for (let u of unprocessed) {
                                        results.push(u);
                                }
                        }));
                }

                return results;
        }

        async executeBulkGet(parameters, config) {
                if (!Array.isArray(parameters)) {
                        parameters = [parameters];
                }
                let concurrent = this._normalizeConcurrencyValue(config.concurrent)
                let concurrentOperations = utilities.batchItems(parameters, concurrent);

                let resultsAll = [];
                let unprocessedAll = [];
                for (let operation of concurrentOperations) {
                        await Promise.all(operation.map(async params => {
                                let response = await this._exec(MethodTypes.batchGet, params);
                                if (validations.isFunction(config.parse)) {
                                        resultsAll.push(await config.parse(config, response));
                                        return;
                                }
                                let [results, unprocessed] = this.formatBulkGetResponse(response, config);
                                for (let r of results) {
                                        resultsAll.push(r);
                                }
                                for (let u of unprocessed) {
                                        unprocessedAll.push(u);
                                }
                        }));
                }
                return [resultsAll, unprocessedAll];
        }

        async executeQuery(method, parameters, config) {
                let response = await this._exec(method, parameters);
                if (validations.isFunction(config.parse)) {
                        return config.parse(config, response);
                }
                switch (parameters.ReturnValues) {
                        case FormatToReturnValues.none:
                                return null;
                        case FormatToReturnValues.all_new:
                        case FormatToReturnValues.all_old:
                        case FormatToReturnValues.updated_new:
                        case FormatToReturnValues.updated_old:
                                return this.formatResponse(response, parameters.IndexName, config);
                        case FormatToReturnValues.default:
                        default:
                                return this._formatDefaultResponse(method, parameters.IndexName, parameters, config, response);
                }
        }

        _formatDefaultResponse(method, index, parameters, config = {}, response) {
                switch (method) {
                        case MethodTypes.put:
                        case MethodTypes.create:
                                return this.formatResponse(parameters, index, config);
                        case MethodTypes.update:
                        case MethodTypes.patch:
                        case MethodTypes.delete:
                        case MethodTypes.remove:
                                return this.formatResponse(response, index, {...config, _objectOnEmpty: true});
                        default:
                                return this.formatResponse(response, index, config);
                }
        }

        cleanseRetrievedData(item = {}, options = {}) {
                let { includeKeys } = options;
                let data = {};
                let names = this.model.schema.translationForRetrieval;
                for (let [attr, value] of Object.entries(item)) {
                        let name = names[attr];
                        if (name) {
                                data[name] = value;
                        } else if (includeKeys) {
                                data[attr] = value;
                        }
                }
                return data;
        }

        formatBulkWriteResponse(response = {}, config = {}) {
                if (!response || !response.UnprocessedItems) {
                        return response;
                }
                const table = config.table || this._getTableName();
                const index = TableIndex;
                let unprocessed = response.UnprocessedItems[table];
                if (Array.isArray(unprocessed) && unprocessed.length) {
                        return unprocessed.map(request => {
                                if (request.PutRequest) {
                                        return this.formatResponse(request.PutRequest, index, config);
                                } else if (request.DeleteRequest) {
                                        if (config.unprocessed === UnprocessedTypes.raw) {
                                                return request.DeleteRequest.Key;
                                        } else {
                                                return this._formatKeysToItem(index, request.DeleteRequest.Key);
                                        }
                                } else {
                                        throw new Error("Unknown response format");
                                }
                        })
                } else {
                        return []
                }
        }

        formatBulkGetResponse(response = {}, config = {}) {
                let unprocessed = [];
                let results = [];
                const table = config.table || this._getTableName();
                const index = TableIndex;
                if (!response.UnprocessedKeys || !response.Responses) {
                        throw new Error("Unknown response format");
                }
                if (response.UnprocessedKeys[table] && response.UnprocessedKeys[table].Keys && Array.isArray(response.UnprocessedKeys[table].Keys)) {
                        for (let value of response.UnprocessedKeys[table].Keys) {
                                if (config && config.unprocessed === UnprocessedTypes.raw) {
                                        unprocessed.push(value);
                                } else {
                                        unprocessed.push(
                                                this._formatKeysToItem(index, value)
                                        );
                                }
                        }
                }

                if (response.Responses[table] && Array.isArray(response.Responses[table])) {
                        results = this.formatResponse({Items: response.Responses[table]}, index, config);
                }

                return [results, unprocessed];
        }

        formatResponse(response, index, config = {}) {
                let stackTrace;
                if (!config.originalErr) {
                        stackTrace = new e.ElectroError(e.ErrorCodes.AWSError);
                }
                try {
                        let results = {};
                        if (config.raw && !config._isPagination) {
                                if (response.TableName) {
                                        results = {};
                                } else {
                                        results = response;
                                }
                        } else if (config.raw && (config._isPagination || config.lastEvaluatedKeyRaw)) {
                                return [response.LastEvaluatedKey || null, response];
                        } else {
                                if (response.Item) {
                                        if (config.ignoreOwnership || this.ownsItem(response.Item)) {
                                                results = this.model.schema.formatItemForRetrieval(response.Item, config);
                                                if (Object.keys(results).length === 0) {
                                                        results = null;
                                                }
                                        }
                                } else if (response.Items) {
                                        results = [];
                                        for (let item of response.Items) {
                                                if (config.ignoreOwnership || this.ownsItem(item)) {
                                                        let record = this.model.schema.formatItemForRetrieval(item, config);
                                                        if (Object.keys(record).length > 0) {
                                                                results.push(record);
                                                        }
                                                }
                                        }
                                } else if (response.Attributes) {
                                        results = this.model.schema.formatItemForRetrieval(response.Attributes, config);
                                        if (Object.keys(results).length === 0) {
                                                results = null;
                                        }
                                } else if (config._objectOnEmpty) {
                                        return {};
                                } else {
                                        results = null;
                                }
                        }

                        if (config._isPagination) {
                                let nextPage = this._formatReturnPager(config, index, response.LastEvaluatedKey, results[results.length - 1]);
                                results = [nextPage, results];
                        }

                        return results;

                } catch (err) {
                        if (config.originalErr || stackTrace === undefined) {
                                throw err;
                        } else {
                                stackTrace.message = err.message;
                                throw stackTrace;
                        }
                }
        }


        parse(item, options = {}) {
                if (item === undefined || item === null) {
                        return null;
                }
                const config = {
                        ...(options || {}),
                        ignoreOwnership: true
                }
                return this.formatResponse(item, TableIndex, config);
        }

        _formatReturnPager(config, index, lastEvaluatedKey, lastReturned) {
                let page = lastEvaluatedKey || null;
                if (config.pager !== Pager.raw) {
                        page = this._formatKeysToItem(index, page, lastReturned);
                        if (page && config.pager === Pager.named) {
                                page[this.identifiers.entity] = this.getName();
                                page[this.identifiers.version] = this.getVersion();
                        }
                }
                return page;
        }

        _getTableName() {
                return this.config.table;
        }

        _setTableName(table) {
                this.config.table = table;
        }

        _setClient(client) {
                if (client) {
                        this.client = client;
                }
        }

        _chain(state, clauses, clause) {
                let current = {};
                for (let child of clause.children) {
                        current[child] = (...args) => {
                                state.prev = state.self;
                                state.self = child;
                                let results = clauses[child].action(this, state, ...args);
                                if (clauses[child].children.length) {
                                        return this._chain(results, clauses, clauses[child]);
                                } else {
                                        return results;
                                }
                        };
                }
                return current;
        }
        /* istanbul ignore next */
        _makeChain(index = TableIndex, clauses, rootClause, options = {}) {
                let state = new ChainState({
                        index,
                        options,
                        attributes: this.model.schema.attributes,
                        hasSortKey: this.model.lookup.indexHasSortKeys[index],
                        compositeAttributes: this.model.facets.byIndex[index]
                });
                return state.init(this, clauses, rootClause);
        }

        _regexpEscape(string) {
                return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
        }

        _normalizeConcurrencyValue(value = 1) {
                value = parseInt(value);
                if (isNaN(value) || value < 1) {
                        throw new e.ElectroError(e.ErrorCodes.InvalidConcurrencyOption, "Query option 'concurrency' must be of type 'number' and greater than zero.");
                }
                return value;
        }

        _deconstructKeys(index, keyType, key, backupFacets = {}) {
                if (typeof key !== "string" || key.length === 0) {
                        return null;
                }
                
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
                let {prefix, isCustom} = this.model.prefixes[index][keyType];
                let {facets} = this.model.indexes[accessPattern][keyType];
                let names = [];
                let types = [];
                let pattern = `^${this._regexpEscape(prefix)}`;
                let labels = this.model.facets.labels[index][keyType] || [];
                for (let {name, label} of labels) {
                        let { type } = this.model.schema.attributes[name];
                        if (isCustom) {
                                pattern += `${this._regexpEscape(label === undefined ? "" : label)}(.+)`;
                        } else {
                                pattern += `#${this._regexpEscape(label === undefined ? name : label)}_(.+)`;
                        }
                        names.push(name);
                        types.push(type);
                }
                pattern += "$";
                let regex = RegExp(pattern);
                let match = key.match(regex);
                let results = {};
                if (match) {
                        for (let i = 0; i < names.length; i++) {
                                let key = names[i];
                                let value = match[i+1];
                                let type = types[i];
                                switch (type) {
                                        case "number":
                                                value = parseFloat(value);
                                                break;
                                        case "boolean":
                                                value = value === "true";
                                                break;
                                }
                                results[key] = value;
                        }
                } else {
                        if (Object.keys(backupFacets || {}).length === 0) {
                                // this can occur when a scan is performed but returns no results given the current filters or record timing
                                return {};
                        }
                        for (let facet of facets) {
                                if (backupFacets[facet] === undefined) {
                                        throw new e.ElectroError(e.ErrorCodes.LastEvaluatedKey, 'LastEvaluatedKey contains entity that does not match the entity used to query. Use {pager: "raw"} query option.');
                                } else {
                                        results[facet] = backupFacets[facet];
                                }
                        }
                }
                return results;
        }



        _deconstructIndex(index = TableIndex, lastEvaluated, lastReturned) {
                let pkName = this.model.translations.keys[index].pk;
                let skName = this.model.translations.keys[index].sk;
                let pkFacets = this._deconstructKeys(index, KeyTypes.pk, lastEvaluated[pkName], lastReturned);
                let skFacets = this._deconstructKeys(index, KeyTypes.sk, lastEvaluated[skName], lastReturned);
                let facets = {...pkFacets};
                if (skFacets && Object.keys(skFacets).length) {
                        facets = {...skFacets, ...pkFacets};
                }
                return facets;
        }

        _formatKeysToItem(index = TableIndex, lastEvaluated, lastReturned) {
                if (lastEvaluated === null || typeof lastEvaluated !== "object" || Object.keys(lastEvaluated).length === 0) {
                        return lastEvaluated;
                }
                let tableIndex = TableIndex;
                let pager = this._deconstructIndex(index, lastEvaluated, lastReturned);
                // lastEvaluatedKeys from query calls include the index pk/sk as well as the table index's pk/sk
                if (index !== tableIndex) {
                        pager = {...pager, ...this._deconstructIndex(tableIndex, lastEvaluated, lastReturned)};
                }
                let pagerIsEmpty = Object.keys(pager).length === 0;
                let pagerIsIncomplete = this.model.facets.byIndex[tableIndex].all.find(facet => pager[facet.name] === undefined);
                if (pagerIsEmpty || pagerIsIncomplete) {
                        // In this case no suitable record could be found be the deconstructed pager.
                        // This can be valid in cases where a scan is performed but returns no results.
                        return null;
                }

                return pager;
        }

        _constructPagerIndex(index = TableIndex, item) {
                let pk = this._expectFacets(item, this.model.facets.byIndex[index].pk);
                let sk = this._expectFacets(item, this.model.facets.byIndex[index].sk);
                let keys = this._makeIndexKeys(index, pk, sk);
                return this._makeParameterKey(index, keys.pk, ...keys.sk);
        }

        _formatSuppliedPager(index = TableIndex, item) {
                if (typeof item !== "object" || Object.keys(item).length === 0) {
                        return item;
                }
                let tableIndex = TableIndex;
                let pager = this._constructPagerIndex(index, item);
                if (index !== tableIndex) {
                        pager = {...pager, ...this._constructPagerIndex(tableIndex, item)}
                }
                return pager
        }

        _applyParameterOptions(params, ...options) {
                let config = {
                        includeKeys: false,
                        originalErr: false,
                        raw: false,
                        params: {},
                        page: {},
                        lastEvaluatedKeyRaw: false,
                        table: undefined,
                        concurrent: undefined,
                        parse: undefined,
                        pager: Pager.named,
                        unprocessed: UnprocessedTypes.item,
                        response: 'default',
                        ignoreOwnership: false,
                        _isPagination: false,
                };

                config = options.reduce((config, option) => {
                        if (typeof option.response === 'string' && option.response.length) {
                                const format =         ReturnValues[option.response];
                                if (format === undefined) {
                                        throw new e.ElectroError(e.ErrorCodes.InvalidOptions, `Invalid value for query option "format" provided: "${option.format}". Allowed values include ${utilities.commaSeparatedString(Object.keys(ReturnValues))}.`);
                                }
                                config.response = format;
                                config.params.ReturnValues = FormatToReturnValues[format];
                        }

                        if (option.includeKeys === true) {
                                config.includeKeys = true;
                        }

                        if (option.originalErr === true) {
                                config.originalErr = true;
                        }

                        if (option.raw === true) {
                                config.raw = true;
                        }

                        if (option._isPagination) {
                                config._isPagination = true;
                        }

                        if (option.lastEvaluatedKeyRaw === true) {
                                config.lastEvaluatedKeyRaw = true;
                                config.pager = Pager.raw;
                                config.unprocessed = UnprocessedTypes.raw;
                        }

                        if (!isNaN(option.limit)) {
                                config.params.Limit = option.limit;
                        }

                        if (validations.isStringHasLength(option.table)) {
                                config.params.TableName = option.table;
                        }

                        if (option.concurrent !== undefined) {
                                config.concurrent = option.concurrent;
                        }

                        if (validations.isFunction(option.parse)) {
                                config.parse = option.parse;
                        }

                        if (typeof option.pager === "string") {
                                if (typeof Pager[option.pager] === "string") {
                                        config.pager = option.pager;
                                } else {
                                        throw new e.ElectroError(e.ErrorCodes.InvalidOptions, `Invalid value for option "pager" provided: "${option.pager}". Allowed values include ${utilities.commaSeparatedString(Object.keys(Pager))}.`);
                                }
                        }

                        if (typeof option.unprocessed === "string") {
                                if (typeof UnprocessedTypes[option.unprocessed] === "string") {
                                        config.unproessed = UnprocessedTypes[option.unprocessed];
                                } else {
                                        throw new e.ElectroError(e.ErrorCodes.InvalidOptions, `Invalid value for option "unprocessed" provided: "${option.unprocessed}". Allowed values include ${utilities.commaSeparatedString(Object.keys(UnprocessedTypes))}.`);
                                }
                        }

                        if (option.ignoreOwnership) {
                                config.ignoreOwnership = option.ignoreOwnership;
                        }

                        config.page = Object.assign({}, config.page, option.page);
                        config.params = Object.assign({}, config.params, option.params);
                        return config;
                }, config);

                let parameters = Object.assign({}, params);

                for (let customParameter of Object.keys(config.params)) {
                        if (config.params[customParameter] !== undefined) {
                                parameters[customParameter] = config.params[customParameter];
                        }
                }

                if (Object.keys(config.page || {}).length) {
                        if (config.raw || config.pager === Pager.raw) {
                                parameters.ExclusiveStartKey = config.page;
                        } else {
                                parameters.ExclusiveStartKey = this._formatSuppliedPager(params.IndexName, config.page);
                        }
                }

                return {parameters, config};
        }

        _makeItemDoesntExistConditions(index) {
                let hasSortKey = this.model.lookup.indexHasSortKeys[index];
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
                let pkField = this.model.indexes[accessPattern].pk.field;
                let filter = [`attribute_not_exists(${pkField})`];
                if (hasSortKey) {
                        let skField = this.model.indexes[accessPattern].sk.field;
                        filter.push(`attribute_not_exists(${skField})`);
                }
                return filter.join(" AND ");
        }

        _makeItemExistsConditions(index) {
                let hasSortKey = this.model.lookup.indexHasSortKeys[index];
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
                let pkField = this.model.indexes[accessPattern].pk.field;

                let filter = [`attribute_exists(${pkField})`];
                if (hasSortKey) {
                        let skField = this.model.indexes[accessPattern].sk.field;
                        filter.push(`attribute_exists(${skField})`);
                }
                return filter.join(" AND ");
        }

        _applyParameterExpressionTypes(params, filter) {
                const conditions = filter[ExpressionTypes.ConditionExpression];
                if (conditions.build().length > 0) {
                        if (typeof params[ExpressionTypes.ConditionExpression] === "string" && params[ExpressionTypes.ConditionExpression].length > 0) {
                                params[ExpressionTypes.ConditionExpression] = `${params[ExpressionTypes.ConditionExpression]} AND ${conditions.build()}`
                        } else {
                                params[ExpressionTypes.ConditionExpression] = conditions.build();
                        }
                        if (Object.keys(conditions.getNames()).length > 0) {
                                params.ExpressionAttributeNames = params.ExpressionAttributeNames || {};
                                params.ExpressionAttributeNames = Object.assign({}, conditions.getNames(), params.ExpressionAttributeNames);
                        }
                        if (Object.keys(conditions.getValues()).length > 0) {
                                params.ExpressionAttributeValues = params.ExpressionAttributeValues || {};
                                params.ExpressionAttributeValues = Object.assign({}, conditions.getValues(), params.ExpressionAttributeValues);
                        }
                }
                return params;
        }
        /* istanbul ignore next */
        _params(state, config = {}) {
                let { keys = {}, method = "", put = {}, update = {}, filter = {}, options = {} } = state.query;
                let consolidatedQueryFacets = this._consolidateQueryFacets(keys.sk);
                let params = {};
                switch (method) {
                        case MethodTypes.get:
                        case MethodTypes.delete:
                        case MethodTypes.remove:
                                params = this._makeSimpleIndexParams(keys.pk, ...consolidatedQueryFacets);
                                break;
                        case MethodTypes.put:
                        case MethodTypes.create:
                                params = this._makePutParams(put, keys.pk, ...keys.sk);
                                break;
                        case MethodTypes.update:
                        case MethodTypes.patch:
                                params = this._makeUpdateParams(
                                        update,
                                        keys.pk,
                                        ...consolidatedQueryFacets,
                                );
                                break;
                        case MethodTypes.scan:
                                params = this._makeScanParam(filter[ExpressionTypes.FilterExpression]);
                                break;
                        /* istanbul ignore next */
                        default:
                                throw new Error(`Invalid method: ${method}`);
                }
                let applied = this._applyParameterOptions(params, options, config);
                return this._applyParameterExpressionTypes(applied.parameters, filter);
        }

        _batchGetParams(state, config = {}) {
                let table = config.table || this._getTableName();
                let userDefinedParams = config.params || {};
                let records = [];
                for (let itemState of state.subStates) {
                        let method = itemState.query.method;
                        let params = this._params(itemState, config);
                        if (method === MethodTypes.get) {
                                let {Key} = params;
                                records.push(Key);
                        }
                }
                let batches = utilities.batchItems(records, MaxBatchItems.batchGet);
                return batches.map(batch => {
                        return {
                                RequestItems: {
                                        [table]: {
                                                ...userDefinedParams,
                                                Keys: batch
                                        }
                                }
                        }
                });
        }

        _batchWriteParams(state, config = {}) {
                let table = config.table || this._getTableName();
                let records = [];
                for (let itemState of state.subStates) {
                        let method = itemState.query.method;
                        let params = this._params(itemState, config);
                        switch (method) {
                                case MethodTypes.put:
                                        let {Item} = params;
                                        records.push({PutRequest: {Item}});
                                        break;
                                case MethodTypes.delete:
                                        let {Key} = params;
                                        records.push({DeleteRequest: {Key}});
                                        break;
                                /* istanbul ignore next */
                                default:
                                        throw new Error("Invalid method type");
                        }
                }
                let batches = utilities.batchItems(records, MaxBatchItems.batchWrite);
                return batches.map(batch => {
                        return {
                                RequestItems: {
                                        [table]: batch
                                }
                        }
                });
        }

        _makeParameterKey(index, pk, sk) {
                let hasSortKey = this.model.lookup.indexHasSortKeys[index];
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
                let pkField = this.model.indexes[accessPattern].pk.field;
                let key = {
                        [pkField]: pk,
                };
                if (hasSortKey && sk !== undefined) {
                        let skField = this.model.indexes[accessPattern].sk.field;
                        key[skField] = sk;
                }
                return key;
        }

        getIdentifierExpressions(alias = this.getName()) {
                let name = this.getName();
                let version = this.getVersion();
                return {
                        names: {
                                [`#${this.identifiers.entity}_${alias}`]: this.identifiers.entity,
                                [`#${this.identifiers.version}_${alias}`]: this.identifiers.version,
                        },
                        values: {
                                [`:${this.identifiers.entity}_${alias}`]: name,
                                [`:${this.identifiers.version}_${alias}`]: version,
                        },
                        expression: `(#${this.identifiers.entity}_${alias} = :${this.identifiers.entity}_${alias} AND #${this.identifiers.version}_${alias} = :${this.identifiers.version}_${alias})`
                }
        }

        /* istanbul ignore next */
        _makeScanParam(filter = {}) {
                let indexBase = TableIndex;
                let hasSortKey = this.model.lookup.indexHasSortKeys[indexBase];
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[indexBase];
                let pkField = this.model.indexes[accessPattern].pk.field;
                let {pk, sk} = this._makeIndexKeys(indexBase);
                let keys = this._makeParameterKey(indexBase, pk, ...sk);
                let keyExpressions = this._expressionAttributeBuilder(keys);
                let params = {
                        TableName: this._getTableName(),
                        ExpressionAttributeNames: this._mergeExpressionsAttributes(
                                filter.getNames(),
                                keyExpressions.ExpressionAttributeNames
                        ),
                        ExpressionAttributeValues: this._mergeExpressionsAttributes(
                                filter.getValues(),
                                keyExpressions.ExpressionAttributeValues,
                        ),
                        FilterExpression: `begins_with(#${pkField}, :${pkField})`,
                };
                params.ExpressionAttributeNames["#" + this.identifiers.entity] = this.identifiers.entity;
                params.ExpressionAttributeNames["#" + this.identifiers.version] = this.identifiers.version;
                params.ExpressionAttributeValues[":" + this.identifiers.entity] = this.getName();
                params.ExpressionAttributeValues[":" + this.identifiers.version] = this.getVersion();
                params.FilterExpression = `${params.FilterExpression} AND #${this.identifiers.entity} = :${this.identifiers.entity} AND #${this.identifiers.version} = :${this.identifiers.version}`;
                if (hasSortKey) {
                        let skField = this.model.indexes[accessPattern].sk.field;
                        params.FilterExpression = `${params.FilterExpression} AND begins_with(#${skField}, :${skField})`;
                }
                if (filter.build()) {
                        params.FilterExpression = `${params.FilterExpression} AND ${filter.build()}`;
                }
                return params;
        }

        _makeSimpleIndexParams(partition, sort) {
                let index = TableIndex;
                let keys = this._makeIndexKeys(index, partition, sort);
                let Key = this._makeParameterKey(index, keys.pk, ...keys.sk);
                let TableName = this._getTableName();
                return {Key, TableName};
        }

        _removeAttributes(item, keys) {
                let copy = {...item};
                for (let key of (Object.keys(keys))) {
                        delete copy[key];
                }
                return copy;
        }

        _makeUpdateParams(update = {}, pk = {}, sk = {}) {
                let modifiedAttributeValues = {};
                let modifiedAttributeNames = {};
                for (const path of Object.keys(update.paths)) {
                        const {value, name} = update.paths[path];
                        modifiedAttributeValues[path] = value;
                        modifiedAttributeNames[path] = name;
                }
                const removed = {};
                for (const name in update.impacted) {
                        if (update.impacted[name] === ItemOperations.remove) {
                                removed[name] = name;
                        }
                }
                modifiedAttributeValues = this._removeAttributes(modifiedAttributeValues, {...pk, ...sk, ...this.model.schema.getReadOnly()});
                const preparedUpdateValues = this.model.schema.applyAttributeSetters(modifiedAttributeValues);
                // We need to remove the pk/sk facets from before applying the Attribute setters because these values didnt
                // change, and we also don't want to trigger the setters of any attributes watching these facets because that
                // should only happen when an attribute is changed.
                const { indexKey, updatedKeys, deletedKeys = [] } = this._getUpdatedKeys(pk, sk, preparedUpdateValues, removed);
                const accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[TableIndex];

                for (const path of Object.keys(preparedUpdateValues)) {
                        if (modifiedAttributeNames[path] !== undefined && preparedUpdateValues[path] !== undefined) {
                                update.updateValue(modifiedAttributeNames[path], preparedUpdateValues[path]);
                        } else if (preparedUpdateValues[path] !== undefined) {
                                update.set(path, preparedUpdateValues[path]);
                        }
                }

                for (const indexKey of Object.keys(updatedKeys)) {
                        const isNotTablePK = indexKey !== this.model.indexes[accessPattern].pk.field;
                        const isNotTableSK = indexKey !== this.model.indexes[accessPattern].sk.field;
                        const wasNotAlreadyModified = modifiedAttributeNames[indexKey] === undefined;
                        if (isNotTablePK && isNotTableSK && wasNotAlreadyModified) {
                                update.set(indexKey, updatedKeys[indexKey]);
                        }
                }

                for (const indexKey of deletedKeys) {
                        const isNotTablePK = indexKey !== this.model.indexes[accessPattern].pk.field;
                        const isNotTableSK = indexKey !== this.model.indexes[accessPattern].sk.field;
                        const wasNotAlreadyModified = modifiedAttributeNames[indexKey] === undefined;
                        if (isNotTablePK && isNotTableSK && wasNotAlreadyModified) {
                                update.remove(indexKey);
                        }
                }

                return {
                        UpdateExpression: update.build(),
                        ExpressionAttributeNames: update.getNames(),
                        ExpressionAttributeValues: update.getValues(),
                        TableName: this._getTableName(),
                        Key: indexKey,
                };
        }

        /* istanbul ignore next */
        _makePutParams({ data } = {}, pk, sk) {
                let { updatedKeys, setAttributes } = this._getPutKeys(pk, sk && sk.facets, data);
                let translatedFields = this.model.schema.translateToFields(setAttributes);

                return {
                        Item: {
                                ...translatedFields,
                                ...updatedKeys,
                                [this.identifiers.entity]: this.getName(),
                                [this.identifiers.version]: this.getVersion(),
                        },
                        TableName: this._getTableName(),
                };
        }

        _updateExpressionBuilder(data) {
                let accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[TableIndex]
                let skip = [
                        // Removing readOnly from here because this should have been validated earlier in the process. Not checking
                        // readOnly here also allows `watch` properties to circumnavigate the readOnly check for attributes that
                        // should be calculated but not updatable by the user.
                        // ...this.model.schema.getReadOnly(),

                        // ...this.model.facets.fields,
                        this.model.indexes[accessPattern].pk.field,
                        this.model.indexes[accessPattern].sk.field
                ];
                return this._expressionAttributeBuilder(data, ItemOperations.set, { skip });
        }

        _queryKeyExpressionAttributeBuilder(index, pk, ...sks) {
                let translate = { ...this.model.translations.keys[index] };
                let restrict = ["pk"];
                let keys = { pk };
                sks = sks.filter(sk => sk !== undefined);
                for (let i = 0; i < sks.length; i++) {
                        let id = `sk${i + 1}`;
                        keys[id] = sks[i];
                        restrict.push(id);
                        translate[id] = translate["sk"];
                }
                let keyExpressions = this._expressionAttributeBuilder(keys, ItemOperations.set, {
                        translate,
                        restrict,
                });

                return {
                        ExpressionAttributeNames: Object.assign({}, keyExpressions.ExpressionAttributeNames),
                        ExpressionAttributeValues: Object.assign({}, keyExpressions.ExpressionAttributeValues),
                };
        }

        /* istanbul ignore next */
        _expressionAttributeBuilder(item = {}, operation = "", options = {}) {
                let {
                        require = [],
                        reject = [],
                        restrict = [],
                        skip = [],
                        translate = {},
                } = options;
                /*
        In order of execution:
        require   - if all elements in require are not present as attributes, it throws.
        reject    - if an attribute on item is present in "reject", it throws.
        restrict  - if an attribute on item is not present in "restrict", it throws.
        skip      - if an attribute matches an element in "skip", it is skipped.
        translate - if an attribute in item matches a property in "translate", use the value in "translate".
    */
                let expressions = {
                        UpdateExpression: [],
                        ExpressionAttributeNames: {},
                        ExpressionAttributeValues: {},
                };

                if (require.length) {
                        let props = Object.keys(item);
                        let missing = require.filter((prop) => !props.includes(prop));
                        if (!missing) {
                                throw new e.ElectroError(e.ErrorCodes.MissingAttribute, `Item is missing attributes: ${utilities.commaSeparatedString(missing)}`);
                        }
                }

                for (let prop in item) {
                        if (reject.includes(prop)) {
                                throw new Error(`Invalid attribute ${prop}`);
                        }
                        if (restrict.length && !restrict.includes(prop)) {
                                throw new Error(`${prop} is not a valid attribute: ${utilities.commaSeparatedString(restrict)}`);
                        }
                        if (prop === undefined || skip.includes(prop)) {
                                continue;
                        }

                        let name = prop;
                        let value = item[prop];
                        let nameProp = `#${prop}`;
                        let valProp = `:${prop}`;

                        if (translate[prop]) {
                                name = translate[prop];
                        }

                        expressions.UpdateExpression.push(`${nameProp} = ${valProp}`);
                        expressions.ExpressionAttributeNames[nameProp] = name;
                        expressions.ExpressionAttributeValues[valProp] = value;
                }
                expressions.UpdateExpression = `${operation.toUpperCase()} ${expressions.UpdateExpression.join(
                        ", ",
                )}`;
                return expressions;
        }

        /* istanbul ignore next */
        _queryParams(state = {}, options = {}) {
                let consolidatedQueryFacets = this._consolidateQueryFacets(
                        state.query.keys.sk,
                );
                let indexKeys;
                if (state.query.type === QueryTypes.is) {
                        indexKeys = this._makeIndexKeys(state.query.index, state.query.keys.pk, ...consolidatedQueryFacets);
                } else {
                        indexKeys = this._makeIndexKeysWithoutTail(state.query.index, state.query.keys.pk, ...consolidatedQueryFacets);
                }
                let parameters = {};
                switch (state.query.type) {
                        case QueryTypes.is:
                        case QueryTypes.begins:
                                parameters = this._makeBeginsWithQueryParams(
                                        state.query.options,
                                        state.query.index,
                                        state.query.filter[ExpressionTypes.FilterExpression],
                                        indexKeys.pk,
                                        ...indexKeys.sk,
                                );
                                break;
                        case QueryTypes.collection:
                                parameters = this._makeBeginsWithQueryParams(
                                        state.query.options,
                                        state.query.index,
                                        state.query.filter[ExpressionTypes.FilterExpression],
                                        indexKeys.pk,
                                        this._getCollectionSk(state.query.collection),
                                );
                                break;
                        case QueryTypes.between:
                                parameters = this._makeBetweenQueryParams(
                                        state.query.index,
                                        state.query.filter[ExpressionTypes.FilterExpression],
                                        indexKeys.pk,
                                        ...indexKeys.sk,
                                );
                                break;
                        case QueryTypes.gte:
                        case QueryTypes.gt:
                        case QueryTypes.lte:
                        case QueryTypes.lt:
                                parameters = this._makeComparisonQueryParams(
                                        state.query.index,
                                        state.query.type,
                                        state.query.filter[ExpressionTypes.FilterExpression],
                                        indexKeys.pk,
                                        ...indexKeys.sk,
                                );
                                break;
                        default:
                                throw new Error(`Invalid query type: ${state.query.type}`);
                }
                let applied = this._applyParameterOptions(parameters, state.query.options, options);
                return applied.parameters;
        }

        _makeBetweenQueryParams(index, filter, pk, ...sk) {
                let keyExpressions = this._queryKeyExpressionAttributeBuilder(
                        index,
                        pk,
                        ...sk,
                );
                delete keyExpressions.ExpressionAttributeNames["#sk2"];
                let params = {
                        TableName: this._getTableName(),
                        ExpressionAttributeNames: this._mergeExpressionsAttributes(
                                filter.getNames(),
                                keyExpressions.ExpressionAttributeNames,
                        ),
                        ExpressionAttributeValues: this._mergeExpressionsAttributes(
                                filter.getValues(),
                                keyExpressions.ExpressionAttributeValues,
                        ),
                        KeyConditionExpression: `#pk = :pk and #sk1 BETWEEN :sk1 AND :sk2`,
                };
                if (index) {
                        params["IndexName"] = index;
                }
                if (filter.build()) {
                        params.FilterExpression = filter.build();
                }
                return params;
        }

        _makeBeginsWithQueryParams(options, index, filter, pk, sk) {
                let keyExpressions = this._queryKeyExpressionAttributeBuilder(index, pk, sk);
                let KeyConditionExpression = "#pk = :pk";

                if (this.model.lookup.indexHasSortKeys[index] && typeof keyExpressions.ExpressionAttributeValues[":sk1"] === "string" && keyExpressions.ExpressionAttributeValues[":sk1"].length > 0) {
                        KeyConditionExpression = `${KeyConditionExpression} and begins_with(#sk1, :sk1)`;
                } else {
                        delete keyExpressions.ExpressionAttributeNames["#sk1"];
                        delete keyExpressions.ExpressionAttributeValues[":sk1"];
                }

                let customExpressions = {
                        names: (options.expressions && options.expressions.names) || {},
                        values: (options.expressions && options.expressions.values) || {},
                        expression: (options.expressions && options.expressions.expression) || ""
                };

                let params = {
                        KeyConditionExpression,
                        TableName: this._getTableName(),
                        ExpressionAttributeNames: this._mergeExpressionsAttributes(filter.getNames(), keyExpressions.ExpressionAttributeNames, customExpressions.names),
                        ExpressionAttributeValues: this._mergeExpressionsAttributes(filter.getValues(), keyExpressions.ExpressionAttributeValues, customExpressions.values),
                };

                if (index) {
                        params["IndexName"] = index;
                }

                let expressions = [customExpressions.expression, filter.build()].filter(Boolean).join(" AND ");

                if (expressions.length) {
                        params.FilterExpression = expressions;
                }

                return params;
        }

        _mergeExpressionsAttributes(...expressionAttributes) {
                let merged = {};
                for (let obj of expressionAttributes) {
                        if (obj) {
                                merged = { ...merged, ...obj };
                        }
                }
                return merged;
        }

        /* istanbul ignore next */
        _makeComparisonQueryParams(index = TableIndex, comparison = "", filter = {}, pk = {}, sk = {}) {
                let operator = Comparisons[comparison];
                if (!operator) {
                        throw new Error(`Unexpected comparison operator "${comparison}", expected ${utilities.commaSeparatedString(Object.values(Comparisons))}`);
                }
                let keyExpressions = this._queryKeyExpressionAttributeBuilder(
                        index,
                        pk,
                        sk,
                );
                let params = {
                        TableName: this._getTableName(),
                        ExpressionAttributeNames: this._mergeExpressionsAttributes(
                                filter.getNames(),
                                keyExpressions.ExpressionAttributeNames,
                        ),
                        ExpressionAttributeValues: this._mergeExpressionsAttributes(
                                filter.getValues(),
                                keyExpressions.ExpressionAttributeValues,
                        ),
                        KeyConditionExpression: `#pk = :pk and #sk1 ${operator} :sk1`,
                };
                if (index) {
                        params["IndexName"] = index;
                }
                if (filter.build()) {
                        params.FilterExpression = filter.build();
                }
                return params;
        }

        _expectIndexFacets(attributes, facets) {
                let [isIncomplete, { incomplete, complete }] = this._getIndexImpact(
                        attributes,
                        facets,
                );
                if (isIncomplete) {
                        let incompleteAccessPatterns = incomplete.map(({index}) => this.model.translations.indexes.fromIndexToAccessPattern[index]);
                        let missingFacets = incomplete.reduce((result, { missing }) => [...result, ...missing], []);
                        throw new e.ElectroError(e.ErrorCodes.IncompleteCompositeAttributes,
                                `Incomplete composite attributes: Without the composite attributes ${utilities.commaSeparatedString(missingFacets)} the following access patterns cannot be updated: ${utilities.commaSeparatedString(incompleteAccessPatterns.filter((val) => val !== undefined))} `,
                        );
                }
                return complete;
        }

        _makeKeysFromAttributes(indexes, attributes) {
                let indexKeys = {};
                for (let [index, keyTypes] of Object.entries(indexes)) {
                        let keys = this._makeIndexKeys(index, attributes, attributes);
                        if (keyTypes.pk || keyTypes.sk) {
                                indexKeys[index] = {};
                        }

                        if (keyTypes.pk && keys.pk) {
                                indexKeys[index].pk = keys.pk
                        }

                        if (keyTypes.sk && keys.sk) {
                                indexKeys[index].sk = keys.sk
                        } else {
                                // at least return the same datatype (array)
                                indexKeys[index].sk = []
                        }
                }
                return indexKeys;
        }

        _makePutKeysFromAttributes(indexes, attributes) {
                let indexKeys = {};
                for (let index of indexes) {
                        indexKeys[index] = this._makeIndexKeys(index, attributes, attributes);
                }
                return indexKeys;
        }

        _getPutKeys(pk, sk, set) {
                let setAttributes = this.model.schema.applyAttributeSetters(set);
                let updateIndex = TableIndex;
                let keyTranslations = this.model.translations.keys;
                let keyAttributes = { ...sk, ...pk };
                let completeFacets = this._expectIndexFacets(
                        { ...set },
                        { ...keyAttributes },
                );

                // complete facets, only includes impacted facets which likely does not include the updateIndex which then needs to be added here.
                if (!completeFacets.indexes.includes(updateIndex)) {
                        completeFacets.indexes.push(updateIndex);
                }
                let composedKeys = this._makePutKeysFromAttributes(completeFacets.indexes, { ...keyAttributes, ...setAttributes });
                let updatedKeys = {};
                let indexKey = {};
                for (let [index, keys] of Object.entries(composedKeys)) {
                        let { pk, sk } = keyTranslations[index];
                        if (index === updateIndex) {
                                indexKey[pk] = keys.pk;
                                if (sk) {
                                        indexKey[sk] = keys.sk[0];
                                }
                        }
                        updatedKeys[pk] = keys.pk;
                        if (sk) {
                                updatedKeys[sk] = keys.sk[0];
                        }
                }

                return { indexKey, updatedKeys, setAttributes };
        }

        _getUpdatedKeys(pk, sk, set, removed) {
                let updateIndex = TableIndex;
                let keyTranslations = this.model.translations.keys;
                let keyAttributes = { ...sk, ...pk };
                let completeFacets = this._expectIndexFacets(
                        { ...set },
                        { ...keyAttributes },
                );
                const removedKeyImpact = this._expectIndexFacets(
                        {...removed},
                        {...keyAttributes}
                )

                // complete facets, only includes impacted facets which likely does not include the updateIndex which then needs to be added here.
                if (completeFacets.impactedIndexTypes[updateIndex] === undefined) {
                        completeFacets.impactedIndexTypes[updateIndex] = {
                                pk: "pk",
                                sk: "sk"
                        }
                }
                let composedKeys = this._makeKeysFromAttributes(completeFacets.impactedIndexTypes,{ ...set, ...keyAttributes });
                let updatedKeys = {};
                let deletedKeys = [];
                let indexKey = {};
                for (const keys of Object.values(removedKeyImpact.impactedIndexTypes)) {
                        deletedKeys = deletedKeys.concat(Object.values(keys));
                }
                for (let [index, keys] of Object.entries(composedKeys)) {
                        let { pk, sk } = keyTranslations[index];
                        if (index === updateIndex) {
                                indexKey[pk] = keys.pk;
                                if (sk) {
                                        indexKey[sk] = keys.sk[0];
                                }
                        } else {
                                // This block is for when Sort Keys used in sparse indexes never get made because they don't actually
                                // have any composite attributes. Without this the PK would be made for the GSI but the SK would always
                                // be blank, and therefore, not queryable.
                                let noImpactSk = Array.isArray(keys.sk) && keys.sk.length === 0;
                                let indexHasSk = this.model.lookup.indexHasSortKeys[index];
                                let noAttributeSk = indexHasSk && this.model.facets.byIndex[index].sk.length === 0;
                                let hasPrefix = indexHasSk && this.model.prefixes[index].sk.prefix !== undefined;
                                if (noImpactSk && noAttributeSk && hasPrefix) {
                                        keys.sk.push(this.model.prefixes[index].sk.prefix);
                                }
                        }

                        if (keys.pk) {
                                updatedKeys[pk] = keys.pk;
                        }

                        if (sk && keys.sk[0]) {
                                updatedKeys[sk] = keys.sk[0];
                        }
                }
                return { indexKey, updatedKeys, deletedKeys };
        }

        /* istanbul ignore next */
        _getIndexImpact(attributes = {}, included = {}) {
                let includedFacets = Object.keys(included);
                let impactedIndexes = {};
                let impactedIndexTypes = {}
                let completedIndexes = [];
                let facets = {};
                for (let [attribute, indexes] of Object.entries(this.model.facets.byAttr)) {
                        if (attributes[attribute] !== undefined) {
                                facets[attribute] = attributes[attribute];
                                indexes.forEach(({ index, type }) => {
                                        impactedIndexes[index] = impactedIndexes[index] || {};
                                        impactedIndexes[index][type] = impactedIndexes[index][type] || [];
                                        impactedIndexes[index][type].push(attribute);
                                        impactedIndexTypes[index] = impactedIndexTypes[index] || {};
                                        impactedIndexTypes[index][type] = this.model.translations.keys[index][type];
                                });
                        }
                }

                let incomplete = Object.entries(this.model.facets.byIndex)
                        .map(([index, { pk, sk }]) => {
                                let impacted = impactedIndexes[index];
                                let impact = { index, missing: [] };
                                if (impacted) {
                                        let missingPk = impacted[KeyTypes.pk] && impacted[KeyTypes.pk].length !== pk.length;
                                        let missingSk = impacted[KeyTypes.sk] && impacted[KeyTypes.sk].length !== sk.length;
                                        if (missingPk) {
                                                impact.missing = [
                                                        ...impact.missing,
                                                        ...pk.filter((attr) => {
                                                                return !impacted[KeyTypes.pk].includes(attr) && !includedFacets.includes(attr)
                                                        }),
                                                ];
                                        }
                                        if (missingSk) {
                                                impact.missing = [
                                                        ...impact.missing,
                                                        ...sk.filter(
                                                                (attr) =>
                                                                        !impacted[KeyTypes.sk].includes(attr) &&
                                                                        !includedFacets.includes(attr),
                                                        ),
                                                ];
                                        }
                                        if (!missingPk && !missingSk) {
                                                completedIndexes.push(index);
                                        }
                                }
                                return impact;
                        })
                        .filter(({ missing }) => missing.length)

                let isIncomplete = !!incomplete.length;
                let complete = {facets, indexes: completedIndexes, impactedIndexTypes};
                return [isIncomplete, { incomplete, complete }];
        }

        _consolidateQueryFacets(queryFacets) {
                let sk1 = {};
                let sk2 = {};
                for (let { type, facets } of queryFacets) {
                        if (type === QueryTypes.between) {
                                sk1 = { ...sk1, ...facets };
                        } else if (type === QueryTypes.and) {
                                sk2 = { ...sk2, ...facets };
                        } else {
                                sk1 = { ...sk1, ...facets };
                                sk2 = { ...sk2, ...facets };
                        }
                }
                return [sk1, sk2];
        }

        _buildQueryFacets(facets, skFacets) {
                let queryFacets = this._findProperties(facets, skFacets).reduce(
                        (result, [name, value]) => {
                                if (value) {
                                        result[name] = value;
                                }
                                return result;
                        },
                        {},
                );
                return { ...queryFacets };
        }

        /* istanbul ignore next */
        _expectFacets(obj = {}, properties = [], type = "key composite attributes") {
                let [incompletePk, missing, matching] = this._expectProperties(obj, properties);
                if (incompletePk) {
                        throw new e.ElectroError(e.ErrorCodes.IncompleteCompositeAttributes, `Incomplete or invalid ${type} supplied. Missing properties: ${utilities.commaSeparatedString(missing)}`);
                } else {
                        return matching;
                }
        }

        _findProperties(obj, properties) {
                return properties.map((name) => [name, obj[name]]);
        }

        _expectProperties(obj, properties) {
                let missing = [];
                let matching = {};
                this._findProperties(obj, properties).forEach(([name, value]) => {
                        if (value === undefined) {
                                missing.push(name);
                        } else {
                                matching[name] = value;
                        }
                });
                return [!!missing.length, missing, matching];
        }

        _makeKeyPrefixes(service, entity, version = "1", tableIndex, modelVersion) {
                /*
                        Collections will prefix the sort key so they can be queried with
                        a "begins_with" operator when crossing entities. It is also possible
                        that the user defined a custom key on either the PK or SK. In the case
                        of a customKey AND a collection, the collection is ignored to favor
                        the custom key.
                */

                let keys = {
                        pk: {
                                prefix: "",
                                field: tableIndex.pk.field,
                                casing: tableIndex.pk.casing,
                                isCustom: tableIndex.customFacets.pk,
                        },
                        sk: {
                                prefix: "",
                                casing: tableIndex.sk.casing,
                                isCustom: tableIndex.customFacets.sk,
                                field: tableIndex.sk ? tableIndex.sk.field : undefined,
                        }
                };

                let pk = `$${service}`;
                let sk = "";

                // If the index is in a collections, prepend the sk;
                let collectionPrefix = this._makeCollectionPrefix(tableIndex.collection);
                if (validations.isStringHasLength(collectionPrefix)) {
                        sk = `${collectionPrefix}#${entity}`;
                } else {
                        sk = `$${entity}`;
                }

                /** start beta/v1 condition **/
                if (modelVersion === ModelVersions.beta) {
                        pk = `${pk}_${version}`;
                } else {
                        sk = `${sk}_${version}`;
                }
                /** end beta/v1 condition **/

                // If no sk, append the sk properties to the pk
                if (Object.keys(tableIndex.sk).length === 0) {
                        pk += sk;
                }

                // If keys arent custom, set the prefixes
                if (!keys.pk.isCustom) {
                        keys.pk.prefix = utilities.formatKeyCasing(pk, tableIndex.pk.casing);
                }
                if (!keys.sk.isCustom) {
                        keys.sk.prefix = utilities.formatKeyCasing(sk, tableIndex.sk.casing);
                }

                return keys;
        }

        _formatKeyCasing(accessPattern, key) {
                const casing = this.model.indexes[accessPattern] !== undefined
                        ? this.model.indexes[accessPattern].sk.casing
                        : undefined;

                return utilities.formatKeyCasing(key, casing);
        }

        _validateIndex(index) {
                if (!this.model.facets.byIndex[index]) {
                        throw new Error(`Invalid index: ${index}`);
                }
        }

        _getCollectionSk(collection = "") {
                const subCollections = this.model.subCollections[collection];
                const index = this.model.translations.collections.fromCollectionToIndex[collection];
                const accessPattern = this.model.translations.indexes.fromIndexToAccessPattern[index];
                const prefix = this._makeCollectionPrefix(subCollections);
                return this._formatKeyCasing(accessPattern, prefix);
        }

        _makeCollectionPrefix(collection = []) {
                let prefix = "";
                if (validations.isArrayHasLength(collection)) {
                        for (let i = 0; i < collection.length; i++) {
                                let subCollection = collection[i];
                                if (i === 0) {
                                        prefix += `$${subCollection}`;
                                } else {
                                        prefix += `#${subCollection}`;
                                }
                        }
                } else if (validations.isStringHasLength(collection)) {
                        prefix = `$${collection}`;
                }
                return prefix;
        }

        /* istanbul ignore next */
        _makeIndexKeysWithoutTail(index = TableIndex, pkFacets = {}, ...skFacets) {
                this._validateIndex(index);
                if (!skFacets.length) {
                        skFacets.push({});
                }
                let facets = this.model.facets.byIndex[index];
                let prefixes = this.model.prefixes[index];
                if (!prefixes) {
                        throw new Error(`Invalid index: ${index}`);
                }
                let pk = this._makeKey(prefixes.pk, facets.pk, pkFacets, this.model.facets.labels[index].pk, {excludeLabelTail: true});
                let sk = [];
                if (this.model.lookup.indexHasSortKeys[index]) {
                        for (let skFacet of skFacets) {
                                let hasLabels = this.model.facets.labels[index] && Array.isArray(this.model.facets.labels[index].sk);
                                let labels = hasLabels
                                        ? this.model.facets.labels[index].sk
                                        : []
                                let sortKey = this._makeKey(prefixes.sk, facets.sk, skFacet, labels, {excludeLabelTail: true});
                                if (sortKey !== undefined) {
                                        sk.push(sortKey);
                                }
                        }
                }
                return { pk, sk };
        }

        /* istanbul ignore next */
        _makeIndexKeys(index = TableIndex, pkFacets = {}, ...skFacets) {
                this._validateIndex(index);
                if (!skFacets.length) {
                        skFacets.push({});
                }
                let facets = this.model.facets.byIndex[index];
                let prefixes = this.model.prefixes[index];
                if (!prefixes) {
                        throw new Error(`Invalid index: ${index}`);
                }
                let pk = this._makeKey(prefixes.pk, facets.pk, pkFacets, this.model.facets.labels[index].pk);
                let sk = [];
                if (this.model.lookup.indexHasSortKeys[index]) {
                        for (let skFacet of skFacets) {
                                let hasLabels = this.model.facets.labels[index] && Array.isArray(this.model.facets.labels[index].sk);
                                let labels = hasLabels
                                        ? this.model.facets.labels[index].sk
                                        : []
                                let sortKey = this._makeKey(prefixes.sk, facets.sk, skFacet, labels);
                                if (sortKey !== undefined) {
                                        sk.push(sortKey);
                                }
                        }
                }
                return { pk, sk };
        }

        _isNumericKey(isCustom, facets = [], labels = []) {
                let attribute = this.model.schema.attributes[facets[0]];
                let isSingleComposite = facets.length === 1;
                let hasNoLabels = isCustom && labels.every(({label}) => !label);
                let facetIsNonStringPrimitive = attribute && attribute.type === "number";
                return isCustom && isSingleComposite && hasNoLabels && facetIsNonStringPrimitive
        }

        /* istanbul ignore next */
        _makeKey({prefix, isCustom, casing} = {}, facets = [], supplied = {}, labels = [], {excludeLabelTail} = {}) {
                if (this._isNumericKey(isCustom, facets, labels)) {
                        return supplied[facets[0]];
                }
                let key = prefix;
                for (let i = 0; i < labels.length; i++) {
                        let {name, label} = labels[i];

                        if (supplied[name] === undefined && excludeLabelTail) {
                                break;
                        }

                        if (isCustom) {
                                key = `${key}${label}`;
                        } else {
                                key = `${key}#${label}_`;
                        }
                        // Undefined facet value means we cant build any more of the key
                        if (supplied[name] === undefined) {
                                break;
                        }

                        key = `${key}${supplied[name]}`;
                }

                return utilities.formatKeyCasing(key, casing);
        }

        _findBestIndexKeyMatch(attributes) {
                let candidates = this.model.facets.bySlot.map((val, i) => i);
                let facets = this.model.facets.bySlot;
                let match;
                let keys = {};
                for (let i = 0; i < facets.length; i++) {
                        let currentMatches = [];
                        let nextMatches = [];
                        for (let j = 0; j < candidates.length; j++) {
                                let slot = candidates[j];
                                if (!facets[i][slot]) {
                                        continue;
                                }
                                let name = facets[i][slot].name;
                                let next = facets[i][slot].next;
                                let index = facets[i][slot].index;
                                let type = facets[i][slot].type;
                                let match = !!attributes[name];
                                let matchNext = !!attributes[next];
                                if (match) {
                                        keys[index] = keys[index] || [];
                                        keys[index].push({ name, type });
                                        currentMatches.push(slot);
                                        if (matchNext) {
                                                nextMatches.push(slot);
                                        }
                                }
                        }
                        if (currentMatches.length) {
                                if (nextMatches.length) {
                                        candidates = [...nextMatches];
                                        continue;
                                } else {
                                        match = facets[i][currentMatches[0]].index;
                                        break;
                                }
                        } else if (i === 0) {
                                break;
                        } else {
                                match = (candidates[0] !== undefined && facets[i][candidates[0]].index) || TableIndex;
                                break;
                        }
                }
                return {
                        keys: keys[match] || [],
                        index: match || TableIndex,
                        shouldScan: match === undefined
                };
        }

        /* istanbul ignore next */
        _parseComposedKey(key = TableIndex) {
                let attributes = {};
                let names = key.match(/:[A-Z1-9]+/gi);
                if (!names) {
                        throw new e.ElectroError(e.ErrorCodes.InvalidKeyCompositeAttributeTemplate, `Invalid key composite attribute template. No composite attributes provided, expected at least one composite attribute with the format ":attributeName". Received: ${key}`);
                }
                let labels = key.split(/:[A-Z1-9]+/gi);
                for (let i = 0; i < names.length; i++) {
                        let name = names[i].replace(":", "");
                        let label = labels[i];
                        if (name !== "") {
                                attributes[name] = attributes[name] || [];
                                attributes[name].push(label);
                        }
                }
                return attributes;
        }

        _parseTemplateKey(template = "") {
                let attributes = [];
                let current = {
                        label: "",
                        name: ""
                };
                let type = "label";
                for (let i = 0; i < template.length; i++) {
                        let char = template[i];
                        let last = template[i - 1];
                        let next = template[i + 1];
                        if (char === "{" && last === "$" && type === "label") {
                                type = "name";
                        } else if (char === "}" && type === "name") {
                                if (current.name.match(/^\s*$/)) {
                                        throw new e.ElectroError(e.ErrorCodes.InvalidKeyCompositeAttributeTemplate, `Invalid key composite attribute template. Empty expression "\${${current.name}" provided. Expected attribute name.`);
                                }
                                attributes.push({name: current.name, label: current.label});
                                current.name = "";
                                current.label = "";
                                type = "label";
                        } else if (char === "$" && next === "{" && type === "label") {
                                continue;
                        } else {
                                current[type] += char;
                        }
                }
                if (current.name.length > 0 || current.label.length > 0) {
                        attributes.push({name: current.name, label: current.label});
                }

                return attributes;
        }

        _parseFacets(facets) {
                let isCustom = !Array.isArray(facets) && typeof facets === "string";
                if (isCustom && facets.length > 0) {
                        let labels = this._parseComposedKey(facets);
                        return {
                                isCustom,
                                labels: [],
                                attributes: Object.keys(attributes),
                        }
                } else if (isCustom && facets.length === 0) {
                        // treat like empty array sk
                        return {
                                isCustom: false,
                                labels: [],
                                attributes: []
                        }
                } else {
                        return {
                                isCustom,
                                labels: [],
                                attributes: Object.keys(facets),
                        };
                }
        }

        _parseTemplateAttributes(composite = []) {
                let isCustom = !Array.isArray(composite) && typeof composite === "string";
                if (isCustom && composite.length > 0) {
                        let labels = this._parseTemplateKey(composite);
                        return {
                                isCustom,
                                labels,
                                attributes: labels.map(({name}) => name).filter(name => !!name)
                        }
                } else if (isCustom && composite.length === 0) {
                        // treat like empty array sk
                        return {
                                isCustom: false,
                                labels: [],
                                attributes: []
                        }
                } else {
                        return {
                                isCustom,
                                labels: composite.map(name => ({name})),
                                attributes: composite,
                        };
                }
        }

        _compositeTemplateAreCompatible(parsedAttributes, composite) {
                if (!Array.isArray(composite) || !parsedAttributes || !parsedAttributes.isCustom) {
                        // not beholden to compatibility constraints
                        return true;
                }

                return validations.stringArrayMatch(composite, parsedAttributes.attributes);
        }

        _optimizeIndexKey(keyDefinition) {
                const hasTemplate = typeof keyDefinition.template === "string";
                const hasSingleItemComposite = Array.isArray(keyDefinition.facets) && keyDefinition.facets.length === 1 && keyDefinition.facets[0] === keyDefinition.field;
                if (!hasTemplate && hasSingleItemComposite) {
                        keyDefinition.facets = "${" + keyDefinition.field + "}";
                }
                return keyDefinition;
        }

        _optimizeMatchingKeyAttributes(model = {}) {
                const attributeFields = [];
                for (const name of Object.keys(model.attributes)) {
                        const {field} = model.attributes[name];
                        attributeFields.push(field || name);
                }
                for (const accessPattern of Object.keys(model.indexes)) {
                        let {pk, sk} = model.indexes[accessPattern];
                        if (attributeFields.includes(pk.field)) {
                                model.indexes[accessPattern].pk = this._optimizeIndexKey(pk);
                        }
                        if (sk && attributeFields.includes(sk.field)) {
                                model.indexes[accessPattern].sk = this._optimizeIndexKey(sk);
                        }
                }
                return model;
        }

        _normalizeIndexes(indexes) {
                let normalized = {};
                let indexFieldTranslation = {};
                let indexHasSortKeys = {};
                let indexHasSubCollections = {};
                let indexAccessPatternTransaction = {
                        fromAccessPatternToIndex: {},
                        fromIndexToAccessPattern: {},
                };
                let collectionIndexTranslation = {
                        fromCollectionToIndex: {},
                        fromIndexToCollection: {},
                };
                let subCollections = {};
                let collections = {};
                let facets = {
                        byIndex: {},
                        byField: {},
                        byFacet: {},
                        byAttr: {},
                        byType: {},
                        bySlot: [],
                        fields: [],
                        attributes: [],
                        labels: {},
                };
                let seenIndexes = {};
                let seenIndexFields = {};

                let accessPatterns = Object.keys(indexes);

                for (let i in accessPatterns) {
                        let accessPattern = accessPatterns[i];
                        let index = indexes[accessPattern];
                        let indexName = index.index || TableIndex;
                        if (seenIndexes[indexName] !== undefined) {
                                if (indexName === TableIndex) {
                                        throw new e.ElectroError(e.ErrorCodes.DuplicateIndexes, `Duplicate index defined in model found in Access Pattern '${accessPattern}': '${utilities.formatIndexNameForDisplay(indexName)}'. This could be because you forgot to specify the index name of a secondary index defined in your model.`);
                                } else {
                                        throw new e.ElectroError(e.ErrorCodes.DuplicateIndexes, `Duplicate index defined in model found in Access Pattern '${accessPattern}': '${indexName}'`);
                                }
                        }
                        seenIndexes[indexName] = indexName;
                        let hasSk = !!index.sk;
                        let inCollection = !!index.collection;
                        if (!hasSk && inCollection) {
                                throw new e.ElectroError(e.ErrorCodes.CollectionNoSK, `Invalid Access pattern definition for '${accessPattern}': '${utilities.formatIndexNameForDisplay(indexName)}', contains a collection definition without a defined SK. Collections can only be defined on indexes with a defined SK.`);
                        }
                        let collection = index.collection || "";
                        let customFacets = {
                                pk: false,
                                sk: false,
                        };
                        const pkCasing = KeyCasing[index.pk.casing] === undefined
                                ? KeyCasing.default
                                : index.pk.casing;
                        let skCasing = KeyCasing.default;
                        if (hasSk && KeyCasing[index.sk.casing] !== undefined) {
                                skCasing = index.sk.casing;
                        }
                        indexHasSortKeys[indexName] = hasSk;
                        let parsedPKAttributes = this._parseTemplateAttributes(index.pk.facets);
                        customFacets.pk = parsedPKAttributes.isCustom;
                        // labels can be set via the attribute definition or as part of the facetTemplate.
                        facets.labels[indexName] = facets.labels[indexName] || {};
                        facets.labels[indexName]["pk"] = facets.labels[indexName]["pk"] || parsedPKAttributes;
                        facets.labels[indexName]["sk"] = facets.labels[indexName]["sk"] || this._parseTemplateAttributes();
                        let pk = {
                                inCollection,
                                accessPattern,
                                index: indexName,
                                casing: pkCasing,
                                type: KeyTypes.pk,
                                field: index.pk.field || "",
                                facets: parsedPKAttributes.attributes,
                                isCustom: parsedPKAttributes.isCustom,
                                facetLabels: parsedPKAttributes.labels,
                        };
                        let sk = {};
                        let parsedSKAttributes = {};
                        if (hasSk) {
                                parsedSKAttributes = this._parseTemplateAttributes(index.sk.facets);
                                customFacets.sk = parsedSKAttributes.isCustom;
                                facets.labels[indexName]["sk"] = parsedSKAttributes;
                                sk = {
                                        inCollection,
                                        accessPattern,
                                        index: indexName,
                                        casing: skCasing,
                                        type: KeyTypes.sk,
                                        field: index.sk.field || "",
                                        facets: parsedSKAttributes.attributes,
                                        isCustom: parsedSKAttributes.isCustom,
                                        facetLabels: parsedSKAttributes.labels,
                                };
                                facets.fields.push(sk.field);
                        }

                        if (seenIndexFields[pk.field] !== undefined) {
                                throw new e.ElectroError(e.ErrorCodes.DuplicateIndexFields, `Partition Key (pk) on Access Pattern '${accessPattern}' references the field '${pk.field}' which is already referenced by the Access Pattern '${seenIndexFields[pk.field]}'. Fields used for indexes need to be unique to avoid conflicts.`);
                        } else {
                                seenIndexFields[pk.field] = accessPattern;
                        }

                        if (sk.field) {
                                if (sk.field === pk.field) {
                                        throw new e.ElectroError(e.ErrorCodes.DuplicateIndexFields, `The Access Pattern '${accessPattern}' references the field '${sk.field}' as the field name for both the PK and SK. Fields used for indexes need to be unique to avoid conflicts.`);
                                } else if (seenIndexFields[sk.field] !== undefined) {
                                        throw new e.ElectroError(e.ErrorCodes.DuplicateIndexFields, `Sort Key (sk) on Access Pattern '${accessPattern}' references the field '${sk.field}' which is already referenced by the Access Pattern '${seenIndexFields[sk.field]}'. Fields used for indexes need to be unique to avoid conflicts.`);
                                }else {
                                        seenIndexFields[sk.field] = accessPattern;
                                }
                        }

                        if (Array.isArray(sk.facets)) {
                                let duplicates = pk.facets.filter(facet => sk.facets.includes(facet));
                                if (duplicates.length !== 0) {
                                        throw new e.ElectroError(e.ErrorCodes.DuplicateIndexCompositeAttributes, `The Access Pattern '${accessPattern}' contains duplicate references the composite attribute(s): ${utilities.commaSeparatedString(duplicates)}. Composite attributes may only be used once within an index. If this leaves the Sort Key (sk) without any composite attributes simply set this to be an empty array.`);
                                }
                        }

                        let definition = {
                                pk,
                                sk,
                                collection,
                                customFacets,
                                index: indexName,
                        };

                        indexHasSubCollections[indexName] = inCollection && Array.isArray(collection);

                        if (inCollection) {
                                let collectionArray = this._toSubCollectionArray(collection);

                                for (let collectionName of collectionArray) {
                                        if (collections[collectionName] !== undefined) {
                                                throw new e.ElectroError(e.ErrorCodes.DuplicateCollections, `Duplicate collection, "${collectionName}" is defined across multiple indexes "${collections[collectionName]}" and "${accessPattern}". Collections must be unique names across indexes for an Entity.`,);
                                        } else {
                                                collections[collectionName] = accessPattern;
                                        }
                                        collectionIndexTranslation.fromCollectionToIndex[collectionName] = indexName;
                                        collectionIndexTranslation.fromIndexToCollection[indexName] = collectionIndexTranslation.fromIndexToCollection[indexName] || [];
                                        collectionIndexTranslation.fromIndexToCollection[indexName].push(collection);
                                }
                                subCollections = {
                                        ...subCollections,
                                        ...this._normalizeSubCollections(collectionArray)
                                };
                        }

                        let attributes = [
                                ...pk.facets.map((name) => ({
                                        name,
                                        index: indexName,
                                        type: KeyTypes.pk,
                                })),
                                ...(sk.facets || []).map((name) => ({
                                        name,
                                        index: indexName,
                                        type: KeyTypes.sk,
                                })),
                        ];

                        normalized[accessPattern] = definition;

                        indexAccessPatternTransaction.fromAccessPatternToIndex[
                                accessPattern
                        ] = indexName;
                        indexAccessPatternTransaction.fromIndexToAccessPattern[
                                indexName
                        ] = accessPattern;

                        indexFieldTranslation[indexName] = {
                                pk: pk.field,
                                sk: sk.field || "",
                        };

                        facets.attributes = [...facets.attributes, ...attributes];

                        facets.fields.push(pk.field);

                        facets.byIndex[indexName] = {
                                customFacets,
                                pk: pk.facets,
                                sk: sk.facets,
                                all: attributes,
                                collection: index.collection,
                                hasSortKeys: !!indexHasSortKeys[indexName],
                                hasSubCollections: !!indexHasSubCollections[indexName],
                                casing: {
                                        pk: pkCasing,
                                        sk: skCasing
                                }
                        };

                        facets.byField = facets.byField || {};
                        facets.byField[pk.field] = facets.byField[pk.field] || {};
                        facets.byField[pk.field][indexName] = pk;
                        if (sk.field) {
                                facets.byField[sk.field] = facets.byField[sk.field] || {};
                                facets.byField[sk.field][indexName] = sk;
                        }


                        attributes.forEach(({index, type, name}, j) => {
                                let next = attributes[j + 1] !== undefined ? attributes[j + 1].name : "";
                                let facet = { index, name, type, next };
                                facets.byAttr[name] = facets.byAttr[name] || [];
                                facets.byAttr[name].push(facet);
                                facets.byType[type] = facets.byType[type] || [];
                                facets.byType[type].push(facet);
                                facets.byFacet[name] = facets.byFacet[name] || [];
                                facets.byFacet[name][j] = facets.byFacet[name][j] || [];
                                facets.byFacet[name][j].push(facet);
                                facets.bySlot[j] = facets.bySlot[j] || [];
                                facets.bySlot[j][i] = facet;
                        });

                        let pkTemplateIsCompatible = this._compositeTemplateAreCompatible(parsedPKAttributes, index.pk.composite);
                        if (!pkTemplateIsCompatible) {
                                throw new e.ElectroError(e.ErrorCodes.IncompatibleKeyCompositeAttributeTemplate, `Incompatible PK 'template' and 'composite' properties for defined on index "${utilities.formatIndexNameForDisplay(indexName)}". PK "template" string is defined as having composite attributes ${utilities.commaSeparatedString(parsedPKAttributes.attributes)} while PK "composite" array is defined with composite attributes ${utilities.commaSeparatedString(index.pk.composite)}`);
                        }

                        if (index.sk !== undefined && Array.isArray(index.sk.composite) && typeof index.sk.template === "string") {
                                let skTemplateIsCompatible = this._compositeTemplateAreCompatible(parsedSKAttributes, index.sk.composite);
                                if (!skTemplateIsCompatible) {
                                        throw new e.ElectroError(e.ErrorCodes.IncompatibleKeyCompositeAttributeTemplate, `Incompatible SK 'template' and 'composite' properties for defined on index "${utilities.formatIndexNameForDisplay(indexName)}". SK "template" string is defined as having composite attributes ${utilities.commaSeparatedString(parsedSKAttributes.attributes)} while SK "composite" array is defined with composite attributes ${utilities.commaSeparatedString(index.sk.composite)}`);
                                }
                        }
                }

                if (facets.byIndex[TableIndex] === undefined) {
                        throw new e.ElectroError(e.ErrorCodes.MissingPrimaryIndex, "Schema is missing an index definition for the table's main index. Please update the schema to include an index without a specified name to define the table's natural index");
                }

                return {
                        facets,
                        subCollections,
                        indexHasSortKeys,
                        indexHasSubCollections,
                        indexes: normalized,
                        indexField: indexFieldTranslation,
                        indexAccessPattern: indexAccessPatternTransaction,
                        indexCollection: collectionIndexTranslation,
                        collections: Object.keys(collections),
                };
        }

        _normalizeFilters(filters = {}) {
                let normalized = {};
                let invalidFilterNames = ["go", "params", "filter", "where", "set"];

                for (let [name, fn] of Object.entries(filters)) {
                        if (invalidFilterNames.includes(name)) {
                                throw new e.ElectroError(e.ErrorCodes.InvalidFilter, `Invalid filter name: ${name}. Filter cannot be named ${utilities.commaSeparatedString(invalidFilterNames)}`);
                        } else {
                                normalized[name] = fn;
                        }
                }

                return normalized;
        }

        _normalizePrefixes(service, entity, version, indexes, modelVersion) {
                let prefixes = {};
                for (let accessPattern of Object.keys(indexes)) {
                        let item = indexes[accessPattern];
                        prefixes[item.index] = this._makeKeyPrefixes(service, entity, version, item, modelVersion);
                }
                return prefixes;
        }

        _normalizeSubCollections(collections = []) {
                let lookup = {};
                for (let i = collections.length -1; i >= 0; i--) {
                        let subCollection = collections[i];
                        lookup[subCollection] = lookup[subCollection] || [];
                        for (let j = 0; j <= i; j++) {
                                lookup[subCollection].push(collections[j]);
                        }
                }
                return lookup;
        }

        _toSubCollectionArray(collection) {
                let collectionArray = [];
                if (Array.isArray(collection) && collection.every(col => validations.isStringHasLength(col))) {
                        collectionArray = collection;
                } else if (validations.isStringHasLength(collection)) {
                        collectionArray.push(collection);
                } else {
                        throw new Error("Invalid collection definition");
                }
                return collectionArray;
        }

        _applyCompositeToFacetConversion(model) {
                for (let accessPattern of Object.keys(model.indexes)) {
                        let index = model.indexes[accessPattern];
                        let invalidPK = index.pk.facets === undefined && index.pk.composite === undefined && index.pk.template === undefined;
                        let invalidSK = index.sk && (index.sk.facets === undefined && index.sk.composite === undefined && index.sk.template === undefined);
                        if (invalidPK) {
                                throw new Error("Missing Index Composite Attributes!");
                        } else if (invalidSK) {
                                throw new Error("Missing Index Composite Attributes!");
                        }


                        if (Array.isArray(index.pk.composite)) {
                                index.pk = {
                                        ...index.pk,
                                        facets: index.pk.composite
                                }
                        }

                        if (typeof index.pk.template === "string") {
                                index.pk = {
                                        ...index.pk,
                                        facets: index.pk.template
                                }
                    }

                        // SK may not exist on index
                        if (index.sk && Array.isArray(index.sk.composite)) {
                                index.sk = {
                                        ...index.sk,
                                        facets: index.sk.composite
                                }
                        }

                        if (index.sk && typeof index.sk.template === "string") {
                                index.sk = {
                                        ...index.sk,
                                        facets: index.sk.template
                                }
                        }

                        model.indexes[accessPattern] = index;
                }
                return model;
        }

        _mergeKeyDefinitions(fromIndex, fromModel) {
                let definitions = {};
                for (let indexName of Object.keys(fromIndex)) {
                        let pk = fromIndex[indexName].pk;
                        let sk = fromIndex[indexName].sk || {labels: []};
                        definitions[indexName] = {
                                pk: [],
                                sk: []
                        };
                        for (let {name, label} of pk.labels) {
                                if (pk.isCustom) {
                                        definitions[indexName].pk.push({name, label});
                                } else {
                                        definitions[indexName].pk.push({name, label: fromModel[name] || name});
                                }
                        }
                        for (let {name, label} of sk.labels) {
                                if (sk.isCustom) {
                                        definitions[indexName].sk.push({name, label});
                                } else {
                                        definitions[indexName].sk.push({name, label: fromModel[name] || name});
                                }
                        }
                }

                return definitions;
        }

        _parseModel(model, config = {}) {
                /** start beta/v1 condition **/
                const {client} = config;
                let modelVersion = utilities.getModelVersion(model);
                let service, entity, version, table, name;
                switch(modelVersion) {
                        case ModelVersions.beta:
                                service = model.service;
                                entity = model.entity;
                                version = model.version;
                                table = config.table || model.table;
                                name = entity;
                                break;
                        case ModelVersions.v1:
                                service = model.model && model.model.service;
                                entity = model.model && model.model.entity;
                                version = model.model && model.model.version;
                                table = config.table || model.table;
                                name = entity;
                                break;
                        default:
                                throw new Error("Invalid model");
                }

                model = this._applyCompositeToFacetConversion(model);

                // _optimizeMatchingKeyAttributes abides by the design compromises made by _applyCompositeToFacetConversion :\
                model = this._optimizeMatchingKeyAttributes(model);
                /** end beta/v1 condition **/

                let {
                        facets,
                        indexes,
                        indexField,
                        collections,
                        subCollections,
                        indexCollection,
                        indexHasSortKeys,
                        indexAccessPattern,
                        indexHasSubCollections,
                } = this._normalizeIndexes(model.indexes);
                let schema = new Schema(model.attributes, facets, {client});
                let filters = this._normalizeFilters(model.filters);
                let prefixes = this._normalizePrefixes(service, entity, version, indexes, modelVersion);

                // apply model defined labels
                let schemaDefinedLabels = schema.getLabels();
                facets.labels = this._mergeKeyDefinitions(facets.labels, schemaDefinedLabels);
                for (let indexName of Object.keys(facets.labels)) {
                        indexes[indexAccessPattern.fromIndexToAccessPattern[indexName]].pk.labels = facets.labels[indexName].pk;
                        indexes[indexAccessPattern.fromIndexToAccessPattern[indexName]].sk.labels = facets.labels[indexName].sk;
                }

                return {
                        name,
                        table,
                        schema,
                        facets,
                        entity,
                        service,
                        indexes,
                        version,
                        filters,
                        prefixes,
                        collections,
                        modelVersion,
                        subCollections,
                        lookup: {
                                indexHasSortKeys,
                                indexHasSubCollections
                        },
                        translations: {
                                keys: indexField,
                                indexes: indexAccessPattern,
                                collections: indexCollection,
                        },
                        original: model,
                };
        }
}

module.exports = {
        Entity,
        clauses,
};

tywalch / electrodb / 220

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous