Merge pull request #3537 from hotosm/develop

4.1.7 release

Author: willemarcel

.circleci/config.yml

@@ -171,7 +171,7 @@ jobs:
     - run:
         name: Set Environment Variables
         command: |
-          echo "export JSON_CONFIG='{\"GitSha\":\"$CIRCLE_SHA1\", \"NetworkEnvironment\":\"<< parameters.environment_name >>\", \"AutoscalingPolicy\":\"<< parameters.autoscaling_policy >>\", \"DBSnapshot\":\"\", \"DatabaseDump\":\"\", \"NewRelicLicense\":\"${<< parameters.new_relic_license >>}\", \"PostgresDB\":\"${<< parameters.postgres_db >>}\", \"PostgresEndpoint\":\"\", \"PostgresPassword\":\"${<< parameters.postgres_password >>}\", \"PostgresUser\":\"${<< parameters.postgres_user >>}\", \"DatabaseSize\":\"${<< parameters.db_size >>}\",\"ELBSubnets\":\"${<< parameters.elb_subnets >>}\", \"SSLCertificateIdentifier\":\"${<< parameters.ssl_cert >>}\", \"TaskingManagerLogDirectory\":\"${<< parameters.log_dir >>}\", \"TaskingManagerConsumerKey\":\"${<< parameters.consumer_key >>}\",\"TaskingManagerConsumerSecret\":\"${<< parameters.consumer_secret >>}\",\"TaskingManagerSecret\":\"${<< parameters.tm_secret >>}\",\"TaskingManagerLogLevel\":\"<< parameters.log_level >>\",\"TaskingManagerImageUploadAPIURL\":\"${<< parameters.upload_api_url >>}\", \"TaskingManagerImageUploadAPIKey\":\"${<< parameters.upload_api_key >>}\",\"TaskingManagerURL\":\"${<< parameters.app_url >>}\", \"TaskingManagerEmailContactAddress\":\"${<< parameters.email_contact_address >>}\"}'" >> $BASH_ENV
+          echo "export JSON_CONFIG='{\"GitSha\":\"$CIRCLE_SHA1\", \"NetworkEnvironment\":\"<< parameters.environment_name >>\", \"AutoscalingPolicy\":\"<< parameters.autoscaling_policy >>\", \"DBSnapshot\":\"\", \"DatabaseDump\":\"\", \"NewRelicLicense\":\"${<< parameters.new_relic_license >>}\", \"PostgresDB\":\"${<< parameters.postgres_db >>}\", \"PostgresEndpoint\":\"\", \"PostgresPassword\":\"${<< parameters.postgres_password >>}\", \"PostgresUser\":\"${<< parameters.postgres_user >>}\", \"DatabaseSize\":\"${<< parameters.db_size >>}\",\"ELBSubnets\":\"${<< parameters.elb_subnets >>}\", \"SSLCertificateIdentifier\":\"${<< parameters.ssl_cert >>}\", \"TaskingManagerLogDirectory\":\"${<< parameters.log_dir >>}\", \"TaskingManagerConsumerKey\":\"${<< parameters.consumer_key >>}\",\"TaskingManagerConsumerSecret\":\"${<< parameters.consumer_secret >>}\",\"TaskingManagerSecret\":\"${<< parameters.tm_secret >>}\",\"TaskingManagerLogLevel\":\"<< parameters.log_level >>\",\"TaskingManagerImageUploadAPIURL\":\"${<< parameters.upload_api_url >>}\", \"TaskingManagerImageUploadAPIKey\":\"${<< parameters.upload_api_key >>}\",\"TaskingManagerURL\":\"${<< parameters.app_url >>}\", \"TaskingManagerOrgName\":\"${<< parameters.org_name >>}\", \"TaskingManagerOrgCode\":\"${<< parameters.org_code >>}\", \"TaskingManagerEmailContactAddress\":\"${<< parameters.email_contact_address >>}\"}'" >> $BASH_ENV
     - run:
         name: Install modules
         command: |

.github/workflows/label.yml

@@ -6,7 +6,8 @@
 # https://github.com/actions/labeler
 
 name: Labeler
-on: [pull_request]
+on:
+- pull_request_target
 
 jobs:
   label:

backend/__init__.py

@@ -2,7 +2,7 @@
 import os
 from logging.handlers import RotatingFileHandler
 
-from flask import Flask, render_template, send_from_directory
+from flask import Flask, redirect
 from flask_cors import CORS
 from flask_migrate import Migrate
 from flask_oauthlib.client import OAuth
@@ -34,11 +34,7 @@ def create_app(env=None):
     :return: Initialised Flask app
     """
 
-    app = Flask(
-        __name__,
-        static_folder="../frontend/build/static",
-        template_folder="../frontend/build",
-    )
+    app = Flask(__name__,)
 
     # Load configuration options from environment
     app.config.from_object("backend.config.EnvironmentConfig")
@@ -52,25 +48,11 @@ def create_app(env=None):
     db.init_app(app)
     migrate.init_app(app, db)
 
-    app.logger.debug("Initialising frontend routes")
+    app.logger.debug("Add root redirect route")
 
-    # Main route to frontend
     @app.route("/")
-    def index():
-        return render_template("index.html")
-
-    @app.route("/<path:text>")
-    def assets(text):
-        if "service-worker.js" in text:
-            return send_from_directory(app.template_folder, text)
-        elif "precache-manifest" in text:
-            return send_from_directory(app.template_folder, text)
-        elif "manifest.json" in text:
-            return send_from_directory(app.template_folder, text)
-        elif "favicon" in text:
-            return send_from_directory(app.template_folder, text)
-        else:
-            return render_template("index.html")
+    def index_redirect():
+        return redirect(format_url("system/heartbeat/"), code=302)
 
     # Add paths to API endpoints
     add_api_endpoints(app)
@@ -225,7 +207,11 @@ def add_api_endpoints(app):
 
     # Teams API endpoint
     from backend.api.teams.resources import TeamsRestAPI, TeamsAllAPI
-    from backend.api.teams.actions import TeamsActionsJoinAPI, TeamsActionsLeaveAPI
+    from backend.api.teams.actions import (
+        TeamsActionsJoinAPI,
+        TeamsActionsLeaveAPI,
+        TeamsActionsMessageMembersAPI,
+    )
 
     # Notifications API endpoint
     from backend.api.notifications.resources import (
@@ -641,6 +627,10 @@ def add_api_endpoints(app):
         endpoint="leave_team",
         methods=["POST"],
     )
+    api.add_resource(
+        TeamsActionsMessageMembersAPI,
+        format_url("teams/<int:team_id>/actions/message-members/"),
+    )
 
     # Campaigns REST endpoints
     api.add_resource(

backend/api/projects/actions.py

@@ -96,7 +96,7 @@ def post(self, project_id):
             - in: body
               name: body
               required: true
-              description: JSON object for creating draft project
+              description: JSON object for creating message
               schema:
                 properties:
                     subject:

backend/api/teams/actions.py

@@ -1,6 +1,8 @@
 from flask_restful import Resource, request, current_app
 from schematics.exceptions import DataError
+import threading
 
+from backend.models.dtos.message_dto import MessageDTO
 from backend.services.team_service import TeamService, NotFound, TeamJoinNotAllowed
 from backend.services.users.authentication_service import token_auth, tm
 from backend.models.postgis.user import User
@@ -234,3 +236,90 @@ def post(self, team_id):
             error_msg = f"TeamMembers DELETE - unhandled error: {str(e)}"
             current_app.logger.critical(error_msg)
             return {"Error": error_msg}, 500
+
+
+class TeamsActionsMessageMembersAPI(Resource):
+    @token_auth.login_required
+    def post(self, team_id):
+        """
+        Message all team members
+        ---
+        tags:
+          - teams
+        produces:
+          - application/json
+        parameters:
+            - in: header
+              name: Authorization
+              description: Base64 encoded session token
+              required: true
+              type: string
+              default: Token sessionTokenHere==
+            - name: team_id
+              in: path
+              description: Unique team ID
+              required: true
+              type: integer
+              default: 1
+            - in: body
+              name: body
+              required: true
+              description: JSON object for creating message
+              schema:
+                properties:
+                    subject:
+                        type: string
+                        default: Thanks
+                        required: true
+                    message:
+                        type: string
+                        default: Thanks for your contribution
+                        required: true
+        responses:
+            200:
+                description: Message sent successfully
+            401:
+                description: Unauthorized - Invalid credentials
+            403:
+                description: Forbidden
+            500:
+                description: Internal Server Error
+        """
+        try:
+            authenticated_user_id = token_auth.current_user()
+            team_id = request.view_args["team_id"]
+            message_dto = MessageDTO(request.get_json())
+            # Validate if team is present
+            try:
+                team = TeamService.get_team_by_id(team_id)
+            except NotFound:
+                return {"Error": "Team not found"}, 404
+
+            is_manager = TeamService.is_user_team_manager(
+                team_id, authenticated_user_id
+            )
+            if not is_manager:
+                raise ValueError
+            message_dto.from_user_id = authenticated_user_id
+            message_dto.validate()
+            if not message_dto.message.strip() or not message_dto.subject.strip():
+                raise DataError({"Validation": "Empty message not allowed"})
+        except DataError as e:
+            current_app.logger.error(f"Error validating request: {str(e)}")
+            return {"Error": "Request payload did not match validation"}, 400
+        except ValueError:
+            return {"Error": "Unauthorised to send message to team members"}, 403
+
+        try:
+            threading.Thread(
+                target=TeamService.send_message_to_all_team_members,
+                args=(team_id, team.name, message_dto),
+            ).start()
+
+            return {"Success": "Message sent successfully"}, 200
+        except ValueError as e:
+            return {"Error": str(e)}, 403
+        except Exception as e:
+            error_msg = f"Send message all - unhandled error: {str(e)}"
+            current_app.logger.critical(error_msg)
+            return {"Error": "Unable to send messages to team members"}, 500

backend/models/dtos/message_dto.py

@@ -8,8 +8,18 @@ class MessageDTO(Model):
     """ DTO used to define a message that will be sent to a user """
 
     message_id = IntType(serialized_name="messageId")
-    subject = StringType(required=True)
-    message = StringType(required=True, serialize_when_none=False)
+    subject = StringType(
+        serialized_name="subject",
+        required=True,
+        serialize_when_none=False,
+        min_length=1,
+    )
+    message = StringType(
+        serialized_name="message",
+        required=True,
+        serialize_when_none=False,
+        min_length=1,
+    )
     from_user_id = IntType(required=True, serialize_when_none=False)
     from_username = StringType(serialized_name="fromUsername", default="")
     project_id = IntType(serialized_name="projectId")

backend/models/dtos/user_dto.py

@@ -74,6 +74,7 @@ class UserDTO(Model):
     comments_notifications = BooleanType(serialized_name="commentsNotifications")
     projects_notifications = BooleanType(serialized_name="projectsNotifications")
     tasks_notifications = BooleanType(serialized_name="tasksNotifications")
+    teams_notifications = BooleanType(serialized_name="teamsNotifications")
 
     # these are read only
     missing_maps_profile = StringType(serialized_name="missingMapsProfile")

backend/models/postgis/message.py

@@ -25,6 +25,7 @@ class MessageType(Enum):
     TASK_COMMENT_NOTIFICATION = 8
     PROJECT_CHAT_NOTIFICATION = 9
     PROJECT_ACTIVITY_NOTIFICATION = 10
+    TEAM_BROADCAST = 11  # Broadcast message from a team manager
 
 
 class Message(db.Model):

backend/models/postgis/user.py

@@ -58,6 +58,7 @@ class User(db.Model):
     comments_notifications = db.Column(db.Boolean, default=False, nullable=False)
     projects_notifications = db.Column(db.Boolean, default=True, nullable=False)
     tasks_notifications = db.Column(db.Boolean, default=True, nullable=False)
+    teams_notifications = db.Column(db.Boolean, default=True, nullable=False)
     date_registered = db.Column(db.DateTime, default=timestamp)
     # Represents the date the user last had one of their tasks validated
     last_validation_date = db.Column(db.DateTime, default=timestamp)
@@ -369,6 +370,7 @@ def as_dto(self, logged_in_username: str) -> UserDTO:
         user_dto.projects_notifications = self.projects_notifications
         user_dto.comments_notifications = self.comments_notifications
         user_dto.tasks_notifications = self.tasks_notifications
+        user_dto.teams_notifications = self.teams_notifications
         gender = None
         if self.gender is not None:
             gender = UserGender(self.gender).name

backend/services/messaging/message_service.py

@@ -6,6 +6,7 @@
 from typing import List
 from flask import current_app
 from sqlalchemy import text, func
+from markdown import markdown
 
 from backend import create_app, db
 from backend.models.dtos.message_dto import MessageDTO, MessagesDTO
@@ -114,12 +115,10 @@ def send_message_to_all_contributors(project_id: int, message_dto: MessageDTO):
 
         with app.app_context():
             contributors = Message.get_all_contributors(project_id)
-
-            project_link = MessageService.get_project_link(project_id)
-
-            message_dto.message = (
-                f"{project_link}<br/><br/>" + message_dto.message
-            )  # Append project link to end of message
+            message_dto.message = "A message from {} managers:<br/><br/>{}".format(
+                MessageService.get_project_link(project_id),
+                markdown(message_dto.message, output_format="html"),
+            )
 
             messages = []
             for contributor in contributors:
@@ -157,6 +156,12 @@ def _push_messages(messages):
                 and obj.message_type == MessageType.BROADCAST.value
             ):
                 continue
+            if (
+                user.teams_notifications is False
+                and obj.message_type == MessageType.TEAM_BROADCAST.value
+            ):
+                messages_objs.append(obj)
+                continue
             if user.comments_notifications is False and obj.message_type in (
                 MessageType.TASK_COMMENT_NOTIFICATION.value,
                 MessageType.PROJECT_CHAT_NOTIFICATION.value,
@@ -365,7 +370,7 @@ def send_message_after_chat(chat_from: int, chat: str, project_id: int):
         if len(usernames) == 0:
             return  # Nobody @'d so return
 
-        link = MessageService.get_project_link(project_id)
+        link = MessageService.get_project_link(project_id, include_chat_section=True)
 
         messages = []
         for username in usernames:
@@ -394,7 +399,9 @@ def send_message_after_chat(chat_from: int, chat: str, project_id: int):
         favorited_users = [r[0] for r in result]
 
         if len(favorited_users) != 0:
-            project_link = MessageService.get_project_link(project_id)
+            project_link = MessageService.get_project_link(
+                project_id, include_chat_section=True
+            )
             # project_title = ProjectService.get_project_title(project_id)
             messages = []
             for user_id in favorited_users:
@@ -642,12 +649,18 @@ def get_task_link(project_id: int, task_id: int, base_url=None) -> str:
         return f'<a href="{base_url}/projects/{project_id}/tasks/?search={task_id}">Task {task_id}</a>'
 
     @staticmethod
-    def get_project_link(project_id: int, base_url=None) -> str:
+    def get_project_link(
+        project_id: int, base_url=None, include_chat_section=False
+    ) -> str:
         """ Helper method to generate a link to project chat"""
         if not base_url:
             base_url = current_app.config["APP_BASE_URL"]
+        if include_chat_section:
+            section = "#questionsAndComments"
+        else:
+            section = ""
 
-        return f'<a href="{base_url}/projects/{project_id}#questionsAndComments">Project {project_id}</a>'
+        return f'<a href="{base_url}/projects/{project_id}{section}">Project {project_id}</a>'
 
     @staticmethod
     def get_user_profile_link(user_name: str, base_url=None) -> str:

backend/services/messaging/smtp_service.py

@@ -136,7 +136,7 @@ def _generate_email_verification_url(email_address: str, user_name: str):
         entropy = current_app.secret_key if current_app.secret_key else "un1testingmode"
 
         serializer = URLSafeTimedSerializer(entropy)
-        token = serializer.dumps(email_address.lower())
+        token = serializer.dumps(email_address)
 
         base_url = current_app.config["APP_BASE_URL"]