GRPC and Dev environment Configuration

.github/workflows/mobile.yml

@@ -19,13 +19,13 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-java@v1
         with:
-          java-version: "12.x"
+          java-version: "8.x"
       - uses: subosito/flutter-action@v1
       - uses: abelfodil/protoc-action@v1
         with:
           enable-dart: true
 
-      - run: protoc --proto_path=protos protos/* --dart_out=mobile/lib/protos
+      - run: protoc --proto_path=protos protos/* --dart_out=grpc:mobile/lib/protos
         working-directory: .
 
       - run: flutter pub get

.github/workflows/web.yml

@@ -15,7 +15,9 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
       - uses: abelfodil/protoc-action@v1
-      - run: protoc --proto_path=protos protos/* --js_out=web/src/protos
+        with:
+          enable-grpc-web: true
+      - run: protoc protos/* --js_out=import_style=commonjs:web/src --grpc-web_out=import_style=commonjs,mode=grpcwebtext:web/src
       - run: yarn --cwd web install
       - run: yarn --cwd web build
       - uses: actions/upload-artifact@v2

.vscode/.prettierrc.yaml → .prettierrc.yaml

@@ -1,4 +1,4 @@
-trailingComma: 'all'
+trailingComma: "all"
 tabWidth: 2
 semi: true
 singleQuote: true

README.md

@@ -9,7 +9,7 @@ This projects aims to offer a comprehensive guide to **record polysomnographic E
 - Install `gRPC` package from your distribution's package manager
 - Install `protoc` compiler
 
-### Yarn
+### Web
 
 - Install Yarn package manager
 - `yarn global add protoc-gen-grpc-web`
@@ -18,7 +18,9 @@ This projects aims to offer a comprehensive guide to **record polysomnographic E
 ### Python
 
 - Install Python 3 and pip
-- Run `pip install -r requirements.txt`
+- Consider using `venv` to create a virtual environment
+- Install gRPC using a package manager or by compiling the [source code](https://github.com/grpc/grpc)
+- Create a simlink named `protoc-gen-grpc_python` to `grpc_python_plugin` using `ln -nsf $(which grpc_python_plugin) /some/where/in/your/path/protoc-gen-grpc_python`
 
 ### Flutter
 
@@ -33,7 +35,13 @@ This projects aims to offer a comprehensive guide to **record polysomnographic E
 
 ## Dev workflow
 
-- Open root folder on VS Code
+- Open workspace `polydodo.code-workspace`
 - Install node modules by running `yarn install --cwd web`
 - Fetch Flutter dependencies through the `Flutter` extension
 - Compile all protos through `proto3` extension
+
+## Running the server locally
+
+- [Login](https://docs.github.com/en/free-pro-team@latest/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages#authenticating-with-a-personal-access-token) to Github Docker registry
+- `docker pull docker.pkg.github.com/polycortex/polydodo/backend:latest`
+- `docker run -p 8080:8080 docker.pkg.github.com/polycortex/polydodo/backend:latest`

backend/.gitignore

@@ -1 +1,3 @@
-.venv/
+.venv/
+.vscode/
+__pycache__/

backend/Dockerfile

@@ -2,10 +2,17 @@ FROM namely/protoc-all as generator
 WORKDIR /
 COPY protos protos
 COPY backend backend
-RUN protoc --proto_path=protos protos/* --python_out=backend/protos 
+RUN ln $(which grpc_python_plugin) /usr/bin/protoc-gen-grpc_python
+RUN protoc protos/* --python_out=backend --grpc_python_out=backend
 
-FROM python
+FROM envoyproxy/envoy:v1.15-latest
+RUN apt-get update \
+  && apt-get -y install python3-pip \
+  && apt-get autoremove -y \
+  && apt-get clean \
+  && rm -rf /tmp/* /var/tmp/* \
+  && rm -rf /var/lib/apt/lists/*
 COPY --from=generator /backend /backend
 WORKDIR /backend
-RUN pip install -r requirements.txt --no-cache-dir
-ENTRYPOINT ["python", "app.py"]
+RUN pip3 install -r requirements.txt --no-cache-dir
+CMD "./start.sh"

backend/app.py

@@ -1,46 +1,40 @@
-from flask import Flask, render_template, url_for, request, redirect
-import os
-from resampling import convert_csv_to_raw 
-from werkzeug.utils import secure_filename
-
-ALLOWED_EXTENSIONS = {'csv'}
-
-def allowed_filename(filename):
-    if not '.' in filename:
-        print('No extension in filename')
-        return False
-
-    ext = filename.rsplit('.', 1)[1]
-    if ext.lower() in ALLOWED_EXTENSIONS:
-        return True
-    else:
-        print('That file extension is not allowed')
-        return False 
-
-
-app = Flask(__name__)
-
-@app.route('/')
-def index():
-    return render_template('index.html')
-
-@app.route('/upload-csv', methods =['GET','POST'])
-def upload_csv():
-    if request.method == 'POST':
-        if request.files:
-            csv = request.files['csv']
-
-            if csv.filename =='':
-                print('No filename or no selected file')
-                return redirect(request.url)
-
-            if allowed_filename(csv.filename):
-                filename = secure_filename(csv.filename) #useless si on save pas le fichier je crois
-                print(csv)
-                convert_csv_to_raw(csv)
-                return redirect(request.url)
-
-    return render_template('upload_csv.html')
+# Copyright 2015 gRPC authors.
+#
+# 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.
+"""The Python implementation of the GRPC helloworld.Greeter server."""
+
+from concurrent import futures
+import logging
+
+import grpc
+
+from protos import helloworld_pb2
+from protos import helloworld_pb2_grpc
+
+
+class Greeter(helloworld_pb2_grpc.GreeterServicer):
+    def SayHello(self, request, context):
+        return helloworld_pb2.HelloReply(message='Hello, %s!' % request.name)
+
+
+def serve():
+    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
+    helloworld_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
+    server.add_insecure_port('[::]:9090')
+    server.start()
+    server.wait_for_termination()
+
 
 if __name__ == '__main__':
-    app.run(host='0.0.0.0', debug=True)
+    logging.basicConfig()
+    serve()

backend/envoy.yaml

@@ -0,0 +1,40 @@
+# Taken from https://github.com/grpc/grpc-web/tree/master/net/grpc/gateway/examples/helloworld
+static_resources:
+  listeners:
+    - name: listener_0
+      address:
+        socket_address: { address: 0.0.0.0, port_value: 8080 }
+      filter_chains:
+        - filters:
+            - name: envoy.http_connection_manager
+              config:
+                codec_type: auto
+                stat_prefix: ingress_http
+                route_config:
+                  name: local_route
+                  virtual_hosts:
+                    - name: local_service
+                      domains: ["*"]
+                      routes:
+                        - match: { prefix: "/" }
+                          route:
+                            cluster: greeter_service
+                            max_grpc_timeout: 0s
+                      cors:
+                        allow_origin_string_match:
+                          - prefix: "*"
+                        allow_methods: GET, PUT, DELETE, POST, OPTIONS
+                        allow_headers: keep-alive,user-agent,cache-control,content-type,content-transfer-encoding,custom-header-1,x-accept-content-transfer-encoding,x-accept-response-streaming,x-user-agent,x-grpc-web,grpc-timeout
+                        max_age: "1728000"
+                        expose_headers: custom-header-1,grpc-status,grpc-message
+                http_filters:
+                  - name: envoy.grpc_web
+                  - name: envoy.cors
+                  - name: envoy.router
+  clusters:
+    - name: greeter_service
+      connect_timeout: 0.25s
+      type: logical_dns
+      http2_protocol_options: {}
+      lb_policy: round_robin
+      hosts: [{ socket_address: { address: 0.0.0.0, port_value: 9090 } }]

backend/readme.md

@@ -0,0 +1,20 @@
+# Backend
+
+This backend holds a GRPC server that classify OpenBCI raw EEG data into sleep stages.
+
+## How to run
+
+I you are running the front-end, you'll need to build the dockerfile to get the Envoy proxy.
+
+> docker build -t polydodo-web .
+
+> docker run -d -p 8080:8080 -p 9090:9090 --network=host polydodo-web
+
+To start the server:
+
+> python backend/app.py
+
+## Get requirements:
+
+> python -m venv .venv
+> python -m pip install -r requirements.txt 

backend/requirements.txt

@@ -1,17 +1,2 @@
-click==7.1.1
-Flask==1.1.1
-Flask-SQLAlchemy==2.4.1
-itsdangerous==1.1.0
-Jinja2==2.11.1
-MarkupSafe==1.1.1
-mne==0.19.2
-numpy==1.18.2
-pandas==1.0.3
-pandas-schema==0.3.5
-python-dateutil==2.8.1
-pytz==2019.3
-scipy==1.4.1
-six==1.14.0
-SQLAlchemy==1.3.15
-Werkzeug==1.0.0
+grpcio==1.32.0
 protobuf==3.13.0