Merge branch 'develop'

leon-ai · May 1, 2023 · 9c5d2ea · 9c5d2ea
2 parents cb2db41 + b7a4f69
commit 9c5d2ea
Show file tree

Hide file tree

Showing 313 changed files with 11,583 additions and 43,562 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.dockerignore b/.dockerignore
@@ -1,2 +1,9 @@
-node_modules/
-bridges/python/.venv/*
+__pycache__/
+**/dist/*
+**/build/
+**/node_modules/
+**/tmp/*
+**/src/.venv/*
+logs/*
+*.pyc
+.DS_Store
diff --git a/.env.sample b/.env.sample
@@ -31,24 +31,15 @@ LEON_HTTP_API_KEY=
 # Language used for the HTTP API
 LEON_HTTP_API_LANG=en-US
 
-# Enable/disable collaborative logger
-LEON_LOGGER=true
+# Enable/disable telemetry
+LEON_TELEMETRY=true
 
 # Python TCP server
 LEON_PY_TCP_SERVER_HOST=0.0.0.0
 LEON_PY_TCP_SERVER_PORT=1342
 
 # Path to the Pipfile
-PIPENV_PIPFILE=bridges/python/Pipfile
+PIPENV_PIPFILE=bridges/python/src/Pipfile
 
 # Path to the virtual env in .venv/
 PIPENV_VENV_IN_PROJECT=true
-
-# Fix https://click.palletsprojects.com/en/7.x/python3/#python-3-surrogate-handling
-# If Leon replies you something like "Sorry, it seems I have a problem with the ... skill" but
-# still gives you the right answer, then:
-## 1. Run `locale -a`
-## 2. Pick a locale
-## 3. Replace the LC_ALL and LANG values with the needed locale
-LC_ALL=C.UTF-8
-LANG=C.UTF-8
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,47 +1,77 @@
 {
-  "extends": "airbnb-base",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "prettier"
+  ],
+  "settings": {
+    "import/resolver": {
+      "typescript": true,
+      "node": true
+    }
+  },
+  "parser": "@typescript-eslint/parser",
   "env": {
     "node": true,
-    "browser": true,
-    "jest/globals": true
+    "browser": true
   },
   "parserOptions": {
     "ecmaVersion": 2021
   },
   "globals": {
     "io": true
   },
-  "plugins": [
-    "import",
-    "jest"
-  ],
-  "settings": {
-    "import/resolver": {
-      "babel-module": {
-        "alias": {
-          "@@": ".",
-          "@": "./server/src"
-        }
-      }
-    }
-  },
+  "plugins": ["@typescript-eslint", "unicorn", "import"],
+  "ignorePatterns": "*.spec.js",
   "rules": {
-    "no-multi-assign": "off",
-    "no-trailing-spaces": "off",
-    "linebreak-style": "off",
-    "indent": "off",
-    "strict": "off",
-    "no-console": "off",
-    "no-param-reassign": "off",
-    "no-shadow": "off",
-    "import/no-extraneous-dependencies": "off",
-    "import/no-dynamic-require": "off",
-    "prefer-promise-reject-errors": ["off"],
+    "@typescript-eslint/no-non-null-assertion": ["off"],
     "no-async-promise-executor": ["off"],
     "no-underscore-dangle": ["error", { "allowAfterThis": true }],
-    "space-before-function-paren": ["error", "always"],
-    "prefer-destructuring": ["error", { "array": true, "object": true }],
+    "prefer-destructuring": ["error"],
     "comma-dangle": ["error", "never"],
-    "semi": ["error", "never"]
-  }
+    "semi": ["error", "never"],
+    "object-curly-spacing": ["error", "always"],
+    "unicorn/prefer-node-protocol": "error",
+    "@typescript-eslint/member-delimiter-style": [
+      "error",
+      {
+        "multiline": {
+          "delimiter": "none",
+          "requireLast": true
+        },
+        "singleline": {
+          "delimiter": "comma",
+          "requireLast": false
+        }
+      }
+    ],
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/consistent-type-definitions": "error",
+    "import/no-named-as-default": "off",
+    "import/no-named-as-default-member": "off",
+    "import/order": [
+      "error",
+      {
+        "groups": [
+          "builtin",
+          "external",
+          "internal",
+          "parent",
+          "sibling",
+          "index"
+        ],
+        "newlines-between": "always"
+      }
+    ]
+  },
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "rules": {
+        "@typescript-eslint/explicit-function-return-type": "error"
+      }
+    }
+  ]
 }
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -19,10 +19,9 @@ Here are few examples about how you could help on Leon, by:
 - [Improving the documentation](https://github.com/leon-ai/docs.getleon.ai) (translations, typos, better writing, etc.).
 - [Sponsoring Leon](http://sponsor.getleon.ai).
 
-
 ## Pull Requests
 
-**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
+**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
 - **Please first discuss** the change you wish to make via [issue](https://github.com/leon-ai/leon/issues),
   email, or any other method with the owners of this repository before making a change.
@@ -32,18 +31,18 @@ Here are few examples about how you could help on Leon, by:
   against the `master` branch**.
 
 - Ensure your code **respect our coding standards** (cf. [.eslintrc.json](https://github.com/leon-ai/leon/blob/develop/.eslintrc.json)).
-To do so, you can run:
+  To do so, you can run:
 
   ```sh
   npm run lint
   ```
-  
+
 - Make sure your **code passes the tests**. You can run the tests via the following command:
-  
+
   ```sh
   npm test
   ```
-  
+
   If you're adding new features to Leon, please include tests.
 
 ## Development Setup
@@ -52,7 +51,7 @@ Choose the setup method you want to go for.
 
 ### Single-Click
 
-Gitpod will automatically setup an environment and run an instance for you.
+Gitpod will automatically set up an environment and run an instance for you.
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/leon-ai/leon)
 
@@ -106,27 +105,32 @@ The commit message guideline is adapted from the [AngularJS Git Commit Guideline
 
 Types define which kind of changes you made to the project.
 
-| Types         | Description |
-| ------------- |-------------|
-| BREAKING      | Changes including breaking changes. |
-| build         | New build version. |
-| chore         | Changes to the build process or auxiliary tools such as changelog generation. No production code change. |
-| ci            | Changes related to continuous integration only (GitHub Actions, CircleCI, etc.). |
-| docs          | Documentation only changes. |
-| feat          | A new feature. |
-| fix           | A bug fix. |
-| perf          | A code change that improves performance. |
-| refactor      | A code change that neither fixes a bug nor adds a feature. |
-| style         | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.). |
-| test          | Adding missing or correcting existing tests. |
+| Types    | Description                                                                                              |
+| -------- | -------------------------------------------------------------------------------------------------------- |
+| BREAKING | Changes including breaking changes.                                                                      |
+| build    | New build version.                                                                                       |
+| chore    | Changes to the build process or auxiliary tools such as changelog generation. No production code change. |
+| ci       | Changes related to continuous integration only (GitHub Actions, CircleCI, etc.).                         |
+| docs     | Documentation only changes.                                                                              |
+| feat     | A new feature.                                                                                           |
+| fix      | A bug fix.                                                                                               |
+| perf     | A code change that improves performance.                                                                 |
+| refactor | A code change that neither fixes a bug nor adds a feature.                                               |
+| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.). |
+| test     | Adding missing or correcting existing tests.                                                             |
 
 ### Scopes
 
 Scopes define high-level nodes of Leon.
 
-- web app
-- server
+- bridge/python
+- bridge/nodejs
+- docker
 - hotword
+- scripts
+- server
+- tcp server
+- web app
 - skill/skill_name
 
 ### Examples
@@ -148,6 +152,77 @@ By sponsoring the project you make the project sustainable and faster to develop
 
 The focus is not only limited to the activity you see on GitHub but also a lot of thinking about the direction of the project. Which is naturally related to the overall design, architecture, vision, learning process and so on...
 
+## Contributing to the Python Bridge or TCP HttpServer
+
+Leon makes use of two binaries, the Python bridge and the TCP server. These binaries are compiled from Python sources.
+
+The Python bridge is used to communicate between the core and skills made with Python.
+
+The TCP server is used to communicate between the core and third-party nodes, such as spaCy.
+
+### Set Up the Python Environment
+
+To contribute to these parts, you need to set up a Python environment running with a specific Python version and a specific Pipenv version.
+
+It is recommended to use Pyenv to manage your Python versions.
+
+If you are on GNU/Linux Ubuntu, you can run the following to install Pyenv, otherwise, please refer to the [Pyenv documentation to install it](https://github.com/pyenv/pyenv#installation):
+
+```bash
+# Update registry
+sudo apt-get update
+
+# Install Pyenv deps
+sudo apt-get install make build-essential libssl-dev zlib1g-dev \
+libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
+libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
+
+# Install Pyenv
+curl https://pyenv.run | bash
+
+# Add output lines to .bashrc
+
+# Restart shell
+exec "$SHELL"
+```
+
+Once Pyenv installed, run:
+
+```bash
+# Install Python
+pyenv install 3.9.10 --force
+pyenv global 3.9.10
+
+# Install Pipenv
+pip install pipenv==2022.7.24
+```
+
+Your Python environment should be ready now. So now you can set up the respective environments according to what you are going to contribute to and build them:
+
+```bash
+# Set up the Python bridge environment
+npm run setup:python-bridge
+
+# Set up the TCP server environment
+npm run setup:tcp-server
+# If you are in China, you can run this to download models faster:
+npm run setup:tcp-server cn
+
+# Once your code changes are done, you can build via:
+
+# Build the Python bridge
+npm run build:python-bridge
+
+# Build the TCP server
+npm run build:tcp-server
+
+# Run the Python bridge
+./bridges/python/dist/{OS-CPU_ARCH}/leon-python-bridge server/src/intent-object.sample.json
+
+# Run the TCP server
+./tcp_server/dist/{OS-CPU_ARCH}/leon-tcp-server en
+```
+
 ## Spread the Word
 
-Use [#LeonAI](https://twitter.com/search?f=live&q=%23LeonAI%20(from%3Agrenlouis%20OR%20from%3Alouistiti_fr)&src=typed_query) if you tweet about Leon and/or mention [@grenlouis](https://twitter.com/grenlouis).
+Use [#LeonAI](<https://twitter.com/search?f=live&q=%23LeonAI%20(from%3Agrenlouis%20OR%20from%3Alouistiti_fr)&src=typed_query>) if you tweet about Leon and/or mention [@grenlouis](https://twitter.com/grenlouis).
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/DOCS.md b/.github/ISSUE_TEMPLATE/DOCS.md
@@ -12,6 +12,7 @@ Please place an x (no spaces - [x]) in all [ ] that apply.
 -->
 
 ### Documentation Is:
+
 - [ ] Missing
 - [ ] Needed
 - [ ] Confusing