mongoose-data-seed

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../../"> <title data-ice="title">src/lib/core/md-seed-runner.js | mongoose-data-seed</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="Seed mongodb with data using mongoose models"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="mongoose-data-seed"><meta property="twitter:description" content="Seed mongodb with data using mongoose models"></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/sharvit/mongoose-data-seed"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib">lib</a>V<a href="variable/index.html#static-variable-config">config</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-configFilename">configFilename</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultUserGeneratorConfig">defaultUserGeneratorConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemConfigTemplate">systemConfigTemplate</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemSeederTemplate">systemSeederTemplate</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands">lib/commands</a>F<a href="function/index.html#static-function-aliasToCommand">aliasToCommand</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-commandToFunction">commandToFunction</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getCommandAndArgvFromCli">getCommandAndArgvFromCli</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isAlias">isAlias</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runCommand">runCommand</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-aliases">aliases</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-availableCommandsList">availableCommandsList</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commands">commands</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commandsMap">commandsMap</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultCommand">defaultCommand</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-generate">lib/commands/generate</a>F<a href="function/index.html#static-function-generateSeeder">generateSeeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateOptions">validateOptions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-help">lib/commands/help</a>F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-init">lib/commands/init</a>C<a href="class/src/lib/commands/init/installer-logger.js~InstallerLogger.html">InstallerLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-promptMissingOptions">promptMissingOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runinstaller">runinstaller</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-run">lib/commands/run</a>C<a href="class/src/lib/commands/run/run-logger.js~RunLogger.html">RunLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-run">run</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-core">lib/core</a>C<a href="class/src/lib/core/installer-error.js~InstallerError.html">InstallerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/installer.js~Installer.html">Installer</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner-error.js~MdSeedRunnerError.html">MdSeedRunnerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner.js~MdSeedRunner.html">MdSeedRunner</a></li> <li data-ice="doc">C<a href="class/src/lib/core/seeder-generator.js~SeederGenerator.html">SeederGenerator</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-InstallerConfig">InstallerConfig</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-utils">lib/utils</a>C<a href="class/src/lib/utils/base-logger.js~BaseLogger.html">BaseLogger</a></li> <li data-ice="doc">C<a href="class/src/lib/utils/seeder.js~Seeder.html">Seeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-exit">exit</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getFolderNameFromPath">getFolderNameFromPath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getObjectWithSelectedKeys">getObjectWithSelectedKeys</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederFileName">normalizeSeederFileName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederName">normalizeSeederName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeederTemplatePath">validateSeederTemplatePath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeedersFolderName">validateSeedersFolderName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateUserConfig">validateUserConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-ExitCodes">ExitCodes</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/lib/core/md-seed-runner.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import { Subject } from 'rxjs'; import { getObjectWithSelectedKeys, normalizeSeederName, } from '../utils/helpers'; import MdSeedRunnerError from './md-seed-runner-error'; /** * mongoose-data-seed runner */ export default class MdSeedRunner { /** * MdSeedRunner operations constants * @type {Object} * @property {string} START MdSeedRunner starts. * @property {string} SUCCESS MdSeedRunner succeed. * @property {string} ERROR MdSeedRunner finished with an error. */ static operations = { START: 'START', SUCCESS: 'SUCCESS', ERROR: 'ERROR', MONGOOSE_CONNECT_START: 'MONGOOSE_CONNECT_START', MONGOOSE_CONNECT_SUCCESS: 'MONGOOSE_CONNECT_SUCCESS', MONGOOSE_CONNECT_ERROR: 'MONGOOSE_CONNECT_ERROR', MONGOOSE_DROP_START: 'MONGOOSE_DROP_START', MONGOOSE_DROP_SUCCESS: 'MONGOOSE_DROP_SUCCESS', MONGOOSE_DROP_ERROR: 'MONGOOSE_DROP_ERROR', ALL_SEEDERS_START: 'ALL_SEEDERS_START', ALL_SEEDERS_FINISH: 'ALL_SEEDERS_FINISH', SEEDER_START: 'SEEDER_START', SEEDER_SUCCESS: 'SEEDER_SUCCESS', SEEDER_ERROR: 'SEEDER_ERROR', }; /** * Creates MdSeedRunner * @param {Function<Promise>} connect Connect to mongodb implementation * @param {Function<Promise>} dropdb Drop/Clear the database implementation * @param {Map<string, Function>} seedersList key=Seeder name | value=Seeder implementation */ constructor({ connect, dropdb, seedersList }) { this.connect = connect; this.dropdb = dropdb; this.seedersList = seedersList; this._subject = new Subject(); } run({ selectedSeeders = [], dropDatabase = false } = {}) { this._run({ selectedSeeders, dropDatabase }); return this._subject.asObservable(); } /* Private methods */ async _run({ selectedSeeders, dropDatabase }) { const { START, SUCCESS, ERROR } = MdSeedRunner.operations; try { this._subject.next({ type: START, payload: { selectedSeeders, dropDatabase }, }); await this._connectToMongodb(); if (dropDatabase) { await this._dropDatabase(); } await this._runSeeders(selectedSeeders); this._subject.next({ type: SUCCESS, payload: { selectedSeeders, dropDatabase }, }); this._subject.complete(); } catch (error) { const { type = ERROR, payload = { error } } = error; this._subject.error({ type, payload }); } } async _connectToMongodb() { const { MONGOOSE_CONNECT_START, MONGOOSE_CONNECT_SUCCESS, MONGOOSE_CONNECT_ERROR, } = MdSeedRunner.operations; try { this._subject.next({ type: MONGOOSE_CONNECT_START }); await this.connect(); this._subject.next({ type: MONGOOSE_CONNECT_SUCCESS }); } catch (error) { throw new MdSeedRunnerError({ type: MONGOOSE_CONNECT_ERROR, error }); } } async _dropDatabase() { const { MONGOOSE_DROP_START, MONGOOSE_DROP_SUCCESS, MONGOOSE_DROP_ERROR, } = MdSeedRunner.operations; try { this._subject.next({ type: MONGOOSE_DROP_START }); await this.dropdb(); this._subject.next({ type: MONGOOSE_DROP_SUCCESS }); } catch (error) { throw new MdSeedRunnerError({ type: MONGOOSE_DROP_ERROR, error }); } } async _runSeeders(selectedSeeders) { const { ALL_SEEDERS_START, ALL_SEEDERS_FINISH } = MdSeedRunner.operations; const seeders = this._loadSelectedSeeders(selectedSeeders); this._subject.next({ type: ALL_SEEDERS_START, payload: { seeders: Object.keys(seeders) }, }); for (const [name, Seeder] of Object.entries(seeders)) { await this._runSeeder({ name, Seeder }); } this._subject.next({ type: ALL_SEEDERS_FINISH, payload: { seeders: Object.keys(seeders) }, }); } async _runSeeder({ Seeder, name }) { const { SEEDER_START, SEEDER_SUCCESS, SEEDER_ERROR, } = MdSeedRunner.operations; try { this._subject.next({ type: SEEDER_START, payload: { name }, }); const seeder = new Seeder(); const results = await seeder.seed(); this._subject.next({ type: SEEDER_SUCCESS, payload: { name, results } }); } catch (error) { throw new MdSeedRunnerError({ type: SEEDER_ERROR, payload: { name }, error, }); } } _loadSelectedSeeders(selectedSeeders) { if (selectedSeeders && selectedSeeders.length > 0) { return getObjectWithSelectedKeys( this.seedersList, selectedSeeders.map(name => normalizeSeederName(name)) ); } return this.seedersList; } } </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>