diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..3fc5d32d1e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.origintrail_noderc_example b/.origintrail_noderc_example index 3a8d67e5cf..0c855bc790 100644 --- a/.origintrail_noderc_example +++ b/.origintrail_noderc_example @@ -7,7 +7,6 @@ "https://rpc-mumbai.maticvigil.com/", "https://matic-mumbai.chainstacklabs.com", "https://rpc-mumbai.matic.today", - "https://matic-testnet-archive-rpc.bwarelabs.com" ], "publicKey": "...", "privateKey": "..." diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..d5c07be46a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +tech@origin-trail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..67b323fc2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing + +## Rules + +There are a few basic ground-rules for contributors (including the maintainer(s) of the project): + +- **No `--force` pushes** or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo. +- **All modifications** must be made in a **pull-request** to solicit feedback from other contributors. + +### Reviewing pull requests + +When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in: + +- Buggy behavior. +- Undue maintenance burden. +- Breaking with house coding style. +- Pessimization (i.e. reduction of speed as measured in the projects benchmarks). +- Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on). +- Uselessness (i.e. it does not strictly add a feature or fix a known issue). + +### Reviews may not be used as an effective veto for a PR because + +- There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix. +- It does not fit well with some other contributors' longer-term vision for the project. + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer(s). + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. + +## Heritage + +These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..de7917b877 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 OriginTrail + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/config/config.json b/config/config.json index 05b08ee8fd..582f5908a1 100644 --- a/config/config.json +++ b/config/config.json @@ -20,6 +20,23 @@ "config": {} } } + }, + "repository": { + "enabled": false, + "implementation": { + "sequelize-repository": { + "package": "./repository/implementation/sequelize/sequelize-repository", + "config": { + "database": "operationaldb", + "user": "root", + "password": "password", + "port": "3306", + "host": "localhost", + "dialect": "mysql", + "logging": false + } + } + } } }, "appDataPath": "data", @@ -81,6 +98,23 @@ "config": {} } } + }, + "repository": { + "enabled": false, + "implementation": { + "sequelize-repository": { + "package": "./repository/implementation/sequelize/sequelize-repository", + "config": { + "database": "operationaldb", + "user": "root", + "password": "password", + "port": "3306", + "host": "localhost", + "dialect": "mysql", + "logging": false + } + } + } } }, "appDataPath": "data", @@ -137,6 +171,23 @@ "config": {} } } + }, + "repository": { + "enabled": false, + "implementation": { + "sequelize-repository": { + "package": "./repository/implementation/sequelize/sequelize-repository", + "config": { + "database": "operationaldb", + "user": "root", + "password": "password", + "port": "3306", + "host": "localhost", + "dialect": "mysql", + "logging": false + } + } + } } }, "appDataPath": "data", @@ -202,6 +253,23 @@ "config": {} } } + }, + "repository": { + "enabled": false, + "implementation": { + "sequelize-repository": { + "package": "./repository/implementation/sequelize/sequelize-repository", + "config": { + "database": "operationaldb", + "user": "root", + "password": "password", + "port": "3306", + "host": "localhost", + "dialect": "mysql", + "logging": false + } + } + } } }, "appDataPath": "data", diff --git a/installer/README.md b/installer/README.md index 29d7d0ebe9..b940c3d76a 100644 --- a/installer/README.md +++ b/installer/README.md @@ -1,23 +1,10 @@ Installs the V6 Beta Stage 1 Node -1. Visit [this link](https://www.ontotext.com/products/graphdb/graphdb-free/) and create an account. They will email you a link to download GraphDB. Look for the sentence (with the download link) that says: - -> "If you have issues running executable files on your machine, you may also try GraphDB as a stand-alone distributive." - -Click the link that says **GraphDB as a stand-alone distributive** in this sentence and download the file. - -Get this file into the /root directory on the server. Just leave it as a zip file. The installer script will unzip it and install it as part of the process. - 2. Login to the server as root. You __cannot__ use sudo and run this script. The command "npm install" __will__ fail. -3. Execute **one** of the following commands depending on if you have cloned the ot-node repo: +3. Execute the following command: -**If the repo is not cloned yet:** ``` -apt install git -y && cd /root && git clone https://github.com/OriginTrail/ot-node && cd ot-node && git checkout v6/release/testnet && installer/installer.sh +apt install git -y && cd /root && wget https://raw.githubusercontent.com/OriginTrail/ot-node/v6/develop/installer/installer.sh && chmod +x installer.sh && . installer.sh ``` -**If you have already cloned the ot-node repo:** -``` -/root/ot-node/installer/installer.sh -``` diff --git a/installer/installer.sh b/installer/installer.sh index 8ec01618b1..d363037241 100755 --- a/installer/installer.sh +++ b/installer/installer.sh @@ -1,8 +1,10 @@ #!/bin/bash -ARCHIVE_REPOSITORY_URL="github.com/OriginTrail/ot-node/archive/" +ARCHIVE_REPOSITORY_URL="github.com/OriginTrail/ot-node/archive" BRANCH="v6/release/testnet" -OTNODE_DIR="/root/ot-node/" +BRANCH_DIR="/root/ot-node-6-release-testnet" +OTNODE_DIR="/root/ot-node" +FUSEKI_VER="apache-jena-fuseki-4.5.0" N1=$'\n' GREEN='\033[0;32m' RED='\033[0;31m' @@ -78,9 +80,6 @@ else echo -e "${GREEN}SUCCESS${NC}" fi -mkdir $OTNODE_DIR -cd $OTNODE_DIR - echo -n "Downloading ot-node: " OUTPUT=$(wget https://$ARCHIVE_REPOSITORY_URL/$BRANCH.zip 2>&1) @@ -99,15 +98,20 @@ rm *.zip #Download new version .zip file #Unpack to init folder -OTNODE_VERSION=$(jq -r '.version' ot-node*/package.json) +OTNODE_VERSION=$(jq -r '.version' $BRANCH_DIR/package.json) -mv ot-node* $OTNODE_VERSION +mkdir $OTNODE_DIR -ln -sfn $OTNODE_VERSION current +mkdir $OTNODE_DIR/$OTNODE_VERSION -OTNODE_DIR=$OTNODE_DIR/current +OUTPUT=$(mv $BRANCH_DIR/* $OTNODE_DIR/$OTNODE_VERSION/ 2>&1) +OUTPUT=$(mv $BRANCH_DIR/.* $OTNODE_DIR/$OTNODE_VERSION/ 2>&1) -cd /root +rm -r $BRANCH_DIR + +ln -sfn $OTNODE_DIR/$OTNODE_VERSION $OTNODE_DIR/current + +OTNODE_DIR=$OTNODE_DIR/current while true; do read -p "Please select the database you would like to use: [1]Fuseki [2]Blazegraph [E]xit: " choice @@ -123,7 +127,7 @@ if [[ $DATABASE = "fuseki" ]]; then echo -n "Downloading Apache Jena Fuseki: " - OUTPUT=$(wget https://dlcdn.apache.org/jena/binaries/apache-jena-fuseki-4.4.0.zip 2>&1) + OUTPUT=$(wget https://dlcdn.apache.org/jena/binaries/$FUSEKI_VER.zip 2>&1) if [[ $? -ne 0 ]]; then echo -e "${RED}FAILED${NC}" @@ -135,7 +139,7 @@ if [[ $DATABASE = "fuseki" ]]; then fi echo -n "Unzipping Fuseki .zip file: " - OUTPUT=$(unzip apache-jena-fuseki-4.4.0.zip 2>&1) + OUTPUT=$(unzip $FUSEKI_VER.zip 2>&1) if [[ $? -ne 0 ]]; then echo -e "${RED}FAILED${NC}" @@ -148,11 +152,12 @@ if [[ $DATABASE = "fuseki" ]]; then echo -n "Setting up fuseki folder in /root/fuseki: " - OUTPUT=$(rm /root/apache-jena-fuseki-4.4.0.zip && + OUTPUT=$(rm /root/$FUSEKI_VER.zip && mkdir /root/fuseki && mkdir /root/fuseki/tdb && - cp /root/apache-jena-fuseki-4.4.0/fuseki-server.jar /root/fuseki/ && - cp -r /root/apache-jena-fuseki-4.4.0/webapp/ /root/fuseki/ 2>&1) + cp /root/$FUSEKI_VER/fuseki-server.jar /root/fuseki/ && + cp -r /root/$FUSEKI_VER/webapp/ /root/fuseki/ && + rm -r /root/$FUSEKI_VER 2>&1) if [[ $? -ne 0 ]]; then echo -e "${RED}FAILED${NC}" @@ -331,7 +336,7 @@ fi echo -n "Installing node.js: " - OUTPUT=$(apt-get install node.js -y 2>&1) + OUTPUT=$(apt-get install nodejs -y 2>&1) if [[ $? -ne 0 ]]; then echo -e "${RED}FAILED${NC}" echo "There was an error installing node.js." diff --git a/package.json b/package.json index e1a93b7c8a..24ce413f2d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "origintrail_node", - "version": "6.0.0-beta.1.37", + "version": "6.0.0-beta.1.38", "description": "OTNode v6 Beta 1", "main": "index.js", "scripts": { diff --git a/src/modules/auto-updater/implementation/ot-auto-updater.js b/src/modules/auto-updater/implementation/ot-auto-updater.js index f46d445795..86391f485a 100644 --- a/src/modules/auto-updater/implementation/ot-auto-updater.js +++ b/src/modules/auto-updater/implementation/ot-auto-updater.js @@ -11,7 +11,7 @@ const REPOSITORY_URL = 'https://github.com/OriginTrail/ot-node'; const ARCHIVE_REPOSITORY_URL = 'github.com/OriginTrail/ot-node/archive/'; class OTAutoUpdater { - initialize(config, logger) { + async initialize(config, logger) { this.config = config; this.logger = logger; if (!this.config) throw Error('You must pass a config object to AutoUpdater.'); diff --git a/src/modules/base-module-manager.js b/src/modules/base-module-manager.js index 8e29a12834..05292e4685 100644 --- a/src/modules/base-module-manager.js +++ b/src/modules/base-module-manager.js @@ -6,7 +6,7 @@ class BaseModuleManager { this.logger = ctx.logger; } - initialize() { + async initialize() { try { const moduleConfig = this.config.modules[this.getName()]; if (!moduleConfig || !moduleConfig.enabled) { @@ -35,7 +35,8 @@ class BaseModuleManager { // eslint-disable-next-line global-require,import/no-dynamic-require const ModuleClass = require(implementationConfig.package); const module = new ModuleClass(); - module.initialize(implementationConfig.config, this.logger); + // eslint-disable-next-line no-await-in-loop + await module.initialize(implementationConfig.config, this.logger); this.logger.info( `${this.getName()} module initialized with implementation: ${implementationName}`, ); diff --git a/src/modules/http-client/implementation/express-http-client.js b/src/modules/http-client/implementation/express-http-client.js index 82ae46da7d..02f7769e58 100644 --- a/src/modules/http-client/implementation/express-http-client.js +++ b/src/modules/http-client/implementation/express-http-client.js @@ -1,7 +1,7 @@ const express = require('express'); class ExpressHttpClient { - initialize() { + async initialize() { this.app = express(); } diff --git a/src/modules/repository/implementation/sequelize/config/sequelizeConfig.js b/src/modules/repository/implementation/sequelize/config/sequelizeConfig.js new file mode 100644 index 0000000000..1974a9717e --- /dev/null +++ b/src/modules/repository/implementation/sequelize/config/sequelizeConfig.js @@ -0,0 +1,15 @@ +module.exports = { + username: process.env.SEQUELIZE_REPOSITORY_USER, + password: process.env.SEQUELIZE_REPOSITORY_PASSWORD, + database: process.env.SEQUELIZE_REPOSITORY_DATABASE, + dialect: process.env.SEQUELIZE_REPOSITORY_DIALECT, + host: process.env.SEQUELIZE_REPOSITORY_HOST, + port: process.env.SEQUELIZE_REPOSITORY_PORT, + migrationStorageTableName: 'sequelize_meta', + logging: false, + operatorsAliases: '0', + define: { + underscored: true, + timestamps: true, + }, +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20211117005500-create-commands.js b/src/modules/repository/implementation/sequelize/migrations/20211117005500-create-commands.js new file mode 100644 index 0000000000..faaeb2c1a6 --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20211117005500-create-commands.js @@ -0,0 +1,76 @@ +module.exports = { + up: async (queryInterface, Sequelize) => { + await queryInterface.createTable('commands', { + id: { + allowNull: false, + primaryKey: true, + type: Sequelize.STRING, + }, + name: { + type: Sequelize.STRING, + allowNull: false, + }, + data: { + type: Sequelize.JSON, + allowNull: false, + }, + sequence: { + type: Sequelize.JSON, + allowNull: true, + }, + ready_at: { + type: Sequelize.INTEGER, + allowNull: false, + }, + delay: { + type: Sequelize.INTEGER, + allowNull: false, + }, + started_at: { + type: Sequelize.INTEGER, + allowNull: true, + }, + deadline_at: { + type: Sequelize.INTEGER, + allowNull: true, + }, + period: { + type: Sequelize.INTEGER, + allowNull: true, + }, + status: { + type: Sequelize.STRING, + allowNull: false, + }, + message: { + type: Sequelize.STRING, + allowNull: true, + }, + parent_id: { + type: Sequelize.STRING, + allowNull: true, + }, + retries: { + type: Sequelize.INTEGER, + allowNull: true, + }, + transactional: { + type: Sequelize.INTEGER, + allowNull: false, + }, + created_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + updated_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + }); + }, + down: async (queryInterface, Sequelize) => { + await queryInterface.dropTable('commands'); + }, +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20211117005501-create-assertions.js b/src/modules/repository/implementation/sequelize/migrations/20211117005501-create-assertions.js new file mode 100644 index 0000000000..63b19534bb --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20211117005501-create-assertions.js @@ -0,0 +1,33 @@ +module.exports = { + up: async (queryInterface, Sequelize) => { + await queryInterface.createTable('assertions', { + hash: { + type: Sequelize.STRING, + primaryKey: true, + allowNull: false, + }, + owner: { + type: Sequelize.STRING, + }, + signature: { + type: Sequelize.TEXT, + }, + topics: { + type: Sequelize.STRING, + }, + created_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + updated_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + }); + }, + down: async (queryInterface, Sequelize) => { + await queryInterface.dropTable('assertions'); + }, +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20211117005502-create-jobs.js b/src/modules/repository/implementation/sequelize/migrations/20211117005502-create-jobs.js new file mode 100644 index 0000000000..8550dcd60b --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20211117005502-create-jobs.js @@ -0,0 +1,42 @@ +module.exports = { + up: async (queryInterface, Sequelize) => { + await queryInterface.createTable('jobs', { + id: { + allowNull: false, + primaryKey: true, + type: Sequelize.STRING, + }, + publisher: { + type: Sequelize.STRING, + }, + assertion_hash: { + type: Sequelize.STRING, + }, + tx_hash: { + type: Sequelize.STRING, + }, + signature: { + type: Sequelize.TEXT, + }, + blockchain_id: { + type: Sequelize.STRING, + }, + published_to: { + type: Sequelize.TEXT, + }, + created_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + updated_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + }); + }, + down: async (queryInterface, Sequelize) => { + await queryInterface.dropTable('jobs'); + }, +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20211117005504-create-handler_ids.js b/src/modules/repository/implementation/sequelize/migrations/20211117005504-create-handler_ids.js new file mode 100644 index 0000000000..9f717910fb --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20211117005504-create-handler_ids.js @@ -0,0 +1,31 @@ +module.exports = { + up: (queryInterface, Sequelize) => queryInterface.createTable('handler_ids', { + handler_id: { + allowNull: false, + primaryKey: true, + type: Sequelize.STRING, + }, + data: { + allowNull: true, + type: Sequelize.TEXT, + }, + status: { + allowNull: false, + type: Sequelize.STRING, + }, + timestamp: { + type: Sequelize.BIGINT, + }, + created_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + updated_at: { + allowNull: false, + type: Sequelize.DATE, + defaultValue: Sequelize.literal('NOW()'), + }, + }), + down: (queryInterface, Sequelize) => queryInterface.dropTable('handler_ids'), +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20211117005505-update-handler_ids.js b/src/modules/repository/implementation/sequelize/migrations/20211117005505-update-handler_ids.js new file mode 100644 index 0000000000..c8496e81aa --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20211117005505-update-handler_ids.js @@ -0,0 +1,18 @@ +module.exports = { + up: (queryInterface, Sequelize) => queryInterface.changeColumn( + 'handler_ids', + 'data', + { + type: Sequelize.TEXT('long'), + allowNull: true, + }, + ), + down: (queryInterface, Sequelize) => queryInterface.changeColumn( + 'handler_ids', + 'data', + { + type: Sequelize.TEXT, + allowNull: true, + }, + ), +}; diff --git a/src/modules/repository/implementation/sequelize/migrations/20220406102807-update-assertions.js b/src/modules/repository/implementation/sequelize/migrations/20220406102807-update-assertions.js new file mode 100644 index 0000000000..cb867e9ffc --- /dev/null +++ b/src/modules/repository/implementation/sequelize/migrations/20220406102807-update-assertions.js @@ -0,0 +1,29 @@ +module.exports = { + up: (queryInterface, Sequelize) => { + return Promise.all([queryInterface.addColumn( + 'assertions', + 'triple_store', + { + type: Sequelize.STRING, + allowNull: true, + } + ), + queryInterface.addColumn( + 'assertions', + 'status', + { + type: Sequelize.STRING, + allowNull: true, + } + )])}, + + down: (queryInterface, Sequelize) => { + return Promise.all([queryInterface.removeColumn( + 'assertions', + 'triple_store', + ), + queryInterface.removeColumn( + 'assertions', + 'status', + )])} +}; diff --git a/src/modules/repository/implementation/sequelize/models/assertion.js b/src/modules/repository/implementation/sequelize/models/assertion.js new file mode 100644 index 0000000000..c256609520 --- /dev/null +++ b/src/modules/repository/implementation/sequelize/models/assertion.js @@ -0,0 +1,34 @@ +const { Model } = require('sequelize'); + +module.exports = (sequelize, DataTypes) => { + class assertions extends Model { + static associate(models) { + assertions._models = models; + // define association here + } + } + assertions.init({ + hash: { + type: DataTypes.STRING, + primaryKey: true, + allowNull: false, + }, + owner: DataTypes.STRING, + signature: DataTypes.TEXT, + topics: DataTypes.STRING, + created_at: DataTypes.DATE, + updated_at: DataTypes.DATE, + triple_store: { + type: DataTypes.STRING, + allowNull: true, + }, + status: { + type: DataTypes.STRING, + allowNull: true, + }, + }, { + sequelize, + modelName: 'assertions', + }); + return assertions; +}; diff --git a/src/modules/repository/implementation/sequelize/models/commands.js b/src/modules/repository/implementation/sequelize/models/commands.js new file mode 100644 index 0000000000..3ded96ca2d --- /dev/null +++ b/src/modules/repository/implementation/sequelize/models/commands.js @@ -0,0 +1,41 @@ +const { Model } = require('sequelize'); +const uuid = require('uuid'); + +module.exports = (sequelize, DataTypes) => { + class commands extends Model { + static associate(models) { + commands._models = models; + // define association here + } + } + commands.init({ + id: { + type: DataTypes.UUID, + primaryKey: true, + defaultValue: () => uuid.v4(), + }, + name: DataTypes.STRING, + data: DataTypes.JSON, + sequence: DataTypes.JSON, + ready_at: DataTypes.INTEGER, + delay: DataTypes.INTEGER, + started_at: DataTypes.INTEGER, + deadline_at: DataTypes.INTEGER, + period: DataTypes.INTEGER, + status: DataTypes.STRING, + message: DataTypes.STRING, + parent_id: DataTypes.UUID, + transactional: DataTypes.BOOLEAN, + retries: { + type: DataTypes.INTEGER, + defaultValue: 0, + }, + created_at: DataTypes.DATE, + updated_at: DataTypes.DATE, + }, { + sequelize, + modelName: 'commands', + timestamps: false, + }); + return commands; +}; diff --git a/src/modules/repository/implementation/sequelize/models/handler_ids.js b/src/modules/repository/implementation/sequelize/models/handler_ids.js new file mode 100644 index 0000000000..ae3cca0115 --- /dev/null +++ b/src/modules/repository/implementation/sequelize/models/handler_ids.js @@ -0,0 +1,23 @@ +const { v4: uuidv4 } = require('uuid'); + +module.exports = (sequelize, DataTypes) => { + const handler_ids = sequelize.define('handler_ids', { + handler_id: { + type: DataTypes.UUID, + primaryKey: true, + defaultValue: () => uuidv4(), + }, + data: DataTypes.TEXT, + status: DataTypes.STRING, + timestamp: { + type: DataTypes.BIGINT, + defaultValue: () => Date.now(), + }, + created_at: DataTypes.DATE, + updated_at: DataTypes.DATE, + }, {}); + handler_ids.associate = (models) => { + // associations can be defined here + }; + return handler_ids; +}; diff --git a/src/modules/repository/implementation/sequelize/models/jobs.js b/src/modules/repository/implementation/sequelize/models/jobs.js new file mode 100644 index 0000000000..c5c4a3294f --- /dev/null +++ b/src/modules/repository/implementation/sequelize/models/jobs.js @@ -0,0 +1,30 @@ +const { Model } = require('sequelize'); +const uuid = require('uuid'); + +module.exports = (sequelize, DataTypes) => { + class jobs extends Model { + static associate(models) { + jobs._models = models; + // define association here + } + } + jobs.init({ + id: { + type: DataTypes.UUID, + primaryKey: true, + defaultValue: () => uuid.v4(), + }, + publisher: DataTypes.STRING, + assertion_hash: DataTypes.STRING, + tx_hash: DataTypes.STRING, + signature: DataTypes.TEXT, + blockchain_id: DataTypes.STRING, + published_to: DataTypes.TEXT, + created_at: DataTypes.DATE, + updated_at: DataTypes.DATE, + }, { + sequelize, + modelName: 'jobs', + }); + return jobs; +}; diff --git a/src/modules/repository/implementation/sequelize/sequelize-repository.js b/src/modules/repository/implementation/sequelize/sequelize-repository.js new file mode 100644 index 0000000000..29a03e34d2 --- /dev/null +++ b/src/modules/repository/implementation/sequelize/sequelize-repository.js @@ -0,0 +1,93 @@ +const mysql = require('mysql2'); +const { exec } = require('child_process'); +const path = require('path'); +const fs = require('fs'); +const Sequelize = require('sequelize'); + +class SequelizeRepository { + async initialize(config, logger) { + this.config = config; + this.logger = logger; + + this.setEnvParameters(); + await this.createDatabaseIfNotExists(); + await this.runMigrations(); + this.models = await this.loadModels(); + } + + setEnvParameters() { + process.env.SEQUELIZE_REPOSITORY_USER = this.config.user; + process.env.SEQUELIZE_REPOSITORY_PASSWORD = this.config.password; + process.env.SEQUELIZE_REPOSITORY_DATABASE = this.config.database; + process.env.SEQUELIZE_REPOSITORY_HOST = this.config.host; + process.env.SEQUELIZE_REPOSITORY_PORT = this.config.port; + process.env.SEQUELIZE_REPOSITORY_DIALECT = this.config.dialect; + } + + async createDatabaseIfNotExists() { + const connection = mysql.createConnection({ + host: this.config.host, + port: this.config.port, + user: this.config.user, + password: this.config.password, + }); + connection.query(`CREATE DATABASE IF NOT EXISTS \`${this.config.database}\`;`); + } + + async runMigrations() { + return new Promise((resolve, reject) => { + const configurationPath = path.join(__dirname, 'config', 'sequelizeConfig.js'); + const migrate = exec( + `npx sequelize --config=${configurationPath} db:migrate`, + { env: process.env }, + (err) => (err ? reject(err) : resolve()), + ); + if (this.config.logging) { + // Forward stdout+stderr to this process + migrate.stdout.pipe(process.stdout); + migrate.stderr.pipe(process.stderr); + } + }); + } + + async loadModels() { + const modelsDirectory = path.join(__dirname, 'models'); + // disable automatic timestamps + this.config.define = { + timestamps: false, + }; + const sequelize = new Sequelize( + this.config.database, + this.config.user, + this.config.password, + this.config, + ); + const models = {}; + fs.readdirSync(modelsDirectory) + .filter((file) => file.indexOf('.') !== 0 && file.slice(-3) === '.js') + .forEach((file) => { + // eslint-disable-next-line global-require,import/no-dynamic-require + const model = require(path.join(modelsDirectory, file))( + sequelize, + Sequelize.DataTypes, + ); + models[model.name] = model; + }); + + Object.keys(models).forEach((modelName) => { + if (models[modelName].associate) { + models[modelName].associate(models); + } + }); + models.sequelize = sequelize; + models.Sequelize = Sequelize; + + return models; + } + + async createHandlerIdRecord(handlerData) { + await this.models.handler_ids.create(handlerData); + } +} + +module.exports = SequelizeRepository; diff --git a/src/modules/repository/repository-module-manager.js b/src/modules/repository/repository-module-manager.js new file mode 100644 index 0000000000..5ed749a9d0 --- /dev/null +++ b/src/modules/repository/repository-module-manager.js @@ -0,0 +1,15 @@ +const BaseModuleManager = require('../base-module-manager'); + +class RepositoryModuleManager extends BaseModuleManager { + getName() { + return 'repository'; + } + + async createHandlerIdRecord(handlerData) { + if (this.initialized) { + return this.getImplementation().module.createHandlerIdRecord(handlerData); + } + } +} + +module.exports = RepositoryModuleManager;