Merge pull request #18 from Worth-NL/PatchingUp

Patching up

Author: pgaetani

app/__init__.py

@@ -308,22 +308,6 @@ def register_v2_blueprints(application):
 
 
 def init_app(app):
-    from opencensus.ext.azure.trace_exporter import AzureExporter
-    from opencensus.ext.flask.flask_middleware import FlaskMiddleware
-    from opencensus.trace.samplers import ProbabilitySampler
-
-    def callback_function(envelope):
-        envelope.tags["ai.cloud.role"] = "api"
-
-    azure_exporter = AzureExporter()
-    azure_exporter.add_telemetry_processor(callback_function)
-
-    FlaskMiddleware(
-        app,
-        exporter=azure_exporter,
-        sampler=ProbabilitySampler(rate=1.0),
-    )
-
     @app.before_request
     def record_request_details():
         CONCURRENT_REQUESTS.inc()

docs/instructions.md

@@ -4,29 +4,31 @@ This file contains all the instructions required to run the `api` locally. In ad
 
 ## Prerequisites
 
-* Docker Desktop ([instructions for Mac](https://docs.docker.com/desktop/install/mac-install/))
-* PostgreSQL 11 (for Mac, run in a terminal `$ brew install postgresql@11`)
-* pgAdmin4 ([link for Mac](https://www.pgadmin.org/download/pgadmin-4-macos/))
-* AWS CLI (for Mac, run in a terminal `$ brew install awscli`)
-* Python 3.9 (if you want/need to run the api not in Docker)
+- Docker Desktop ([instructions for Mac](https://docs.docker.com/desktop/install/mac-install/))
+- PostgreSQL 11 (for Mac, run in a terminal `$ brew install postgresql@11`)
+- pgAdmin4 ([link for Mac](https://www.pgadmin.org/download/pgadmin-4-macos/))
+- AWS CLI (for Mac, run in a terminal `$ brew install awscli`)
+- Python 3.9 (if you want/need to run the api not in Docker)
 
 ## AWS configuration
 
 Current implementation of the notifications app makes use of several AWS resources. These were created in an AWS account which belongs to Ernout.
 
 The following resources were created:
 
-* SES
-* S3 buckets
+- SES
+- S3 buckets
 
 If a new sandbox (non-production) AWS SES is to be setup, the following is most likely necessary:
+
 > "You need to set up the email address you want to mail to in amazon - I don't know why. So I authorized emailing to my email address through amazon's web ui." - Ernout
 
 For application to be able to communicate with AWS APIs, it needs API keys. Ask your fellow teammates for the keys and do the following:
 
 1. In the home directory create `.aws` folder.
 1. In `~/.aws/` create file “credentials” (no extension)
 1. Place the following two rows in the file
+
 ```
 aws_access_key_id=<KEY_ID_YOU_GOT>
 aws_secret_access_key=<ACCESS_KEY_YOU_GOT>
@@ -44,13 +46,13 @@ aws_secret_access_key=<ACCESS_KEY_YOU_GOT>
 
 The following changes must be made to the database:
 
-| Table  | Column  | Row  | New value  | Comment  |
-|---|---|---|---|---|
-| `services`  | `email_from`  |   | `noreply`  | necessary for emails sending. `noreply` is the part of email address before `@`  |
-| `domain`  | `domain`  |  | `worth.systems`  | if you want to create account using `worth.systems` email address. For `organisation_id` use an existing one in `organisation` table or create a new organisation  |
-| `provider_details`  | `support_international`  | `Firetext`  | `true`  | necessary for sms sending  |
-| `provider_details`  | `active` | `mmg` | `false` | necessary for sms sending |
-| `service_sms_senders` | `sms_sender` | all rows | `NotifyNL` | necessary for sms sending. This one is important not to miss. If `GOVUK` is used as `sms_sender`, app will get blocked from being able to send sms |
+| Table                 | Column                  | Row        | New value       | Comment                                                                                                                                                           |
+| --------------------- | ----------------------- | ---------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `services`            | `email_from`            |            | `noreply`       | necessary for emails sending. `noreply` is the part of email address before `@`                                                                                   |
+| `domain`              | `domain`                |            | `worth.systems` | if you want to create account using `worth.systems` email address. For `organisation_id` use an existing one in `organisation` table or create a new organisation |
+| `provider_details`    | `support_international` | `Firetext` | `true`          | necessary for sms sending                                                                                                                                         |
+| `provider_details`    | `active`                | `mmg`      | `false`         | necessary for sms sending                                                                                                                                         |
+| `service_sms_senders` | `sms_sender`            | all rows   | `NotifyNL`      | necessary for sms sending. This one is important not to miss. If `GOVUK` is used as `sms_sender`, app will get blocked from being able to send sms                |
 
 ## Running app
 
@@ -60,6 +62,7 @@ Follow the following steps to get the `Api` running locally in a Docker containe
 1. Start PostgreSQL 11
 1. Ask your fellow teammates for `FIRETEXT_API_KEY` and `FIRETEXT_INTERNATIONAL_API_KEY`
 1. In the root of the repo create `environment.sh` with the following content
+
 ```
 export NOTIFY_ENVIRONMENT='development'
 
@@ -73,18 +76,14 @@ export NOTIFICATION_QUEUE_PREFIX='YOUR_OWN_PREFIX'
 export FLASK_APP=application.py
 export FLASK_DEBUG=1
 export WERKZEUG_DEBUG_PIN=off
-
-export APPLICATIONINSIGHTS_ENABLED=1
-export APPLICATIONINSIGHTS_CONNECTION_STRING=<InstrumentationKey>
 ```
-1. Ask your team for correct `<InstrumentationKey>`
+
 1. Open a terminal in the root of the repo and run `$ make bootstrap-with-docker` to create the docker image
 1. Run `$ make run-migrations-with-docker` to run migrations for the database
 1. Run `$ make run-flask-with-docker`
 1. Open another terminal and run `$ make run-celery-with-docker`. This worker will handle the notifications
 1. The `api` is now available at `localhost:6011`
 
-
 ## Troubleshooting
 
 ### `$ make run-migrations-with-docker` fails with Error 1
@@ -93,4 +92,4 @@ Make sure you added AWS credentials. See [AWS configuration](#aws-configuration)
 
 ### `too many verify codes created` error
 
-Empty the `verify_code` table in the database.
+Empty the `verify_code` table in the database.

requirements.in

@@ -34,6 +34,3 @@ prometheus-client==0.14.1
 git+https://github.com/alphagov/gds_metrics_python.git@6f1840a57b6fb1ee40b7e84f2f18ec229de8aa72
 
 sentry-sdk[flask,celery,sqlalchemy]>=1.0.0,<2.0.0
-
-opencensus-ext-azure
-opencensus-ext-flask

requirements.txt

@@ -18,12 +18,6 @@ awscli==1.29.5
     # via awscli-cwlogs
 awscli-cwlogs==1.4.6
     # via -r requirements.in
-azure-core==1.29.3
-    # via
-    #   azure-identity
-    #   opencensus-ext-azure
-azure-identity==1.14.0
-    # via opencensus-ext-azure
 bcrypt==4.0.0
     # via flask-bcrypt
 beautifulsoup4==4.11.1
@@ -47,7 +41,6 @@ botocore==1.31.5
 cachetools==5.2.0
     # via
     #   -r requirements.in
-    #   google-auth
     #   notifications-utils
 celery[sqs]==5.2.7
     # via
@@ -59,9 +52,7 @@ certifi==2023.7.22
     #   requests
     #   sentry-sdk
 cffi==1.15.1
-    # via
-    #   -r requirements.in
-    #   cryptography
+    # via -r requirements.in
 charset-normalizer==2.1.1
     # via requests
 click==8.1.3
@@ -82,11 +73,6 @@ click-repl==0.2.0
     # via celery
 colorama==0.4.4
     # via awscli
-cryptography==41.0.3
-    # via
-    #   azure-identity
-    #   msal
-    #   pyjwt
 dnspython==2.2.1
     # via eventlet
 docopt==0.6.2
@@ -105,7 +91,6 @@ flask==2.3.2
     #   flask-sqlalchemy
     #   gds-metrics
     #   notifications-utils
-    #   opencensus-ext-flask
     #   sentry-sdk
 flask-bcrypt==1.0.1
     # via -r requirements.in
@@ -125,12 +110,6 @@ gds-metrics @ git+https://github.com/alphagov/gds_metrics_python.git@6f1840a57b6
     # via -r requirements.in
 geojson==2.5.0
     # via notifications-utils
-google-api-core==2.11.1
-    # via opencensus
-google-auth==2.22.0
-    # via google-api-core
-googleapis-common-protos==1.60.0
-    # via google-api-core
 govuk-bank-holidays==0.11
     # via notifications-utils
 greenlet==1.1.3
@@ -186,26 +165,10 @@ marshmallow-sqlalchemy==0.28.1
     # via -r requirements.in
 mistune==0.8.4
     # via notifications-utils
-msal==1.23.0
-    # via
-    #   azure-identity
-    #   msal-extensions
-msal-extensions==1.0.0
-    # via azure-identity
 notifications-python-client==8.0.1
     # via -r requirements.in
 notifications-utils @ git+https://github.com/Worth-NL/[email protected]
     # via -r requirements.in
-opencensus==0.11.2
-    # via
-    #   opencensus-ext-azure
-    #   opencensus-ext-flask
-opencensus-context==0.1.3
-    # via opencensus
-opencensus-ext-azure==1.1.9
-    # via -r requirements.in
-opencensus-ext-flask==0.8.2
-    # via -r requirements.in
 orderedset==2.0.3
     # via notifications-utils
 packaging==21.3
@@ -215,36 +178,23 @@ packaging==21.3
     #   marshmallow-sqlalchemy
 phonenumbers==8.13.18
     # via notifications-utils
-portalocker==2.7.0
-    # via msal-extensions
 prometheus-client==0.14.1
     # via
     #   -r requirements.in
     #   gds-metrics
 prompt-toolkit==3.0.31
     # via click-repl
-protobuf==4.24.1
-    # via
-    #   google-api-core
-    #   googleapis-common-protos
-psutil==5.9.5
-    # via opencensus-ext-azure
 psycopg2-binary==2.9.3
     # via -r requirements.in
 pyasn1==0.4.8
-    # via
-    #   pyasn1-modules
-    #   rsa
-pyasn1-modules==0.3.0
-    # via google-auth
+    # via rsa
 pycparser==2.21
     # via cffi
 pycurl==7.44.1
     # via kombu
-pyjwt[crypto]==2.5.0
+pyjwt==2.5.0
     # via
     #   -r requirements.in
-    #   msal
     #   notifications-python-client
 pyparsing==3.0.9
     # via packaging
@@ -274,21 +224,15 @@ redis==4.5.4
 requests==2.31.0
     # via
     #   awscli-cwlogs
-    #   azure-core
-    #   google-api-core
     #   govuk-bank-holidays
-    #   msal
     #   notifications-python-client
     #   notifications-utils
-    #   opencensus-ext-azure
 rfc3339-validator==0.1.4
     # via jsonschema
 rfc3987==1.3.8
     # via jsonschema
 rsa==4.7.2
-    # via
-    #   awscli
-    #   google-auth
+    # via awscli
 s3transfer==0.6.0
     # via
     #   awscli
@@ -302,11 +246,9 @@ shapely==1.8.4
 six==1.16.0
     # via
     #   awscli-cwlogs
-    #   azure-core
     #   click-repl
     #   eventlet
     #   flask-marshmallow
-    #   google-auth
     #   python-dateutil
     #   rfc3339-validator
 smartypants==2.0.1
@@ -322,18 +264,13 @@ sqlalchemy==1.4.41
     #   sentry-sdk
 statsd==3.3.0
     # via notifications-utils
-types-cryptography==3.3.23.2
-    # via pyjwt
 typing-extensions==4.7.1
-    # via
-    #   azure-core
-    #   pypdf
+    # via pypdf
 uri-template==1.2.0
     # via jsonschema
 urllib3==1.26.12
     # via
     #   botocore
-    #   google-auth
     #   kombu
     #   requests
     #   sentry-sdk

scripts/run_locally_with_docker.sh

@@ -37,8 +37,6 @@ docker run -it --rm \
   -e FLASK_APP=$FLASK_APP \
   -e FLASK_DEBUG=$FLASK_DEBUG \
   -e WERKZEUG_DEBUG_PIN=$WERKZEUG_DEBUG_PIN \
-  -e APPLICATIONINSIGHTS_ENABLED=$APPLICATIONINSIGHTS_ENABLED \
-  -e APPLICATIONINSIGHTS_CONNECTION_STRING=$APPLICATIONINSIGHTS_CONNECTION_STRING \
   ${EXPOSED_PORTS} \
   -v $(pwd):/home/vcap/app \
   ${DOCKER_IMAGE_NAME} \