Feature/more prometheus metrics

.github/workflows/comment_wrong_branch.yml

@@ -0,0 +1,49 @@
+name: Wrong Branch Warning
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened]
+    branches:
+      - "main"
+
+jobs:
+  comment_warning:
+    if: ${{ github.event.pull_request.base.repo.clone_url != github.event.pull_request.head.repo.clone_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment warning about the wrong branch selected for PR
+        id: comment_docker_image
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const output = `
+            Warning: we only accept PRs to the \`dev\` branch. It looks like you've created a PR to the \`main\` branch. Please edit this PR and select the \`dev\` branch as the target branch instead. If this was intentional please ignore this message.
+            `;
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: output
+            })
+
+  comment_warning_internal_pr:
+    if: ${{ github.event.pull_request.head.ref != 'dev' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment warning about the wrong branch selected for PR
+        id: comment_docker_image
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const output = `
+            Warning: we only accept PRs to main from the \`dev\` branch. It looks like you've created a PR from a different branch. Please edit this PR and select the \`dev\` branch as the source branch instead. If this was intentional please ignore this message.
+            `;
+
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: output
+            })

docker/Dockerfile

@@ -1,5 +1,5 @@
 # Specify our base image
-FROM python:3.10-bullseye
+FROM python:3.12-bullseye
 LABEL maintainer="Jaimyn Mayer ([email protected])"
 LABEL description="Base Dockerfile for the MemberMatters software."
 
@@ -11,7 +11,7 @@ RUN mkdir -p /usr/src/app/frontend && mkdir /usr/src/logs && mkdir /usr/src/data
 RUN apt-get update -y && apt-get install -y nginx curl daphne
 
 # Install Node
-ENV NODE_VERSION=18.16.0
+ENV NODE_VERSION=22.2.0
 SHELL ["/bin/bash", "--login", "-c"]
 
 RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash

memberportal/access/admin.py

@@ -4,7 +4,7 @@
 
 
 @admin.register(AccessControlledDeviceAPIKey)
-class AccessControlledDeviceAPIKey(APIKeyModelAdmin):
+class AccessControlledDeviceAPIKeyAdmin(APIKeyModelAdmin):
     pass
 
 

memberportal/access/migrations/0016_auto_20240523_1550.py

@@ -0,0 +1,41 @@
+# Generated by Django 3.2.25 on 2024-05-23 05:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("access", "0015_alter_accesscontrolleddevice_ip_address"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="memberbucksdevice",
+            options={
+                "verbose_name": "Memberbucks Device",
+                "verbose_name_plural": "Memberbucks Devices",
+            },
+        ),
+        migrations.AddField(
+            model_name="memberbucksdevice",
+            name="supports_credits",
+            field=models.BooleanField(
+                default=False, verbose_name="Supports the MM simple credits API."
+            ),
+        ),
+        migrations.AddField(
+            model_name="memberbucksdevice",
+            name="supports_debits",
+            field=models.BooleanField(
+                default=False, verbose_name="Supports the MM simple debits API."
+            ),
+        ),
+        migrations.AddField(
+            model_name="memberbucksdevice",
+            name="supports_products",
+            field=models.BooleanField(
+                default=False, verbose_name="Supports the mm products API."
+            ),
+        ),
+    ]

memberportal/access/migrations/0017_auto_20240523_1604.py

@@ -0,0 +1,42 @@
+# Generated by Django 3.2.25 on 2024-05-23 06:04
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("access", "0016_auto_20240523_1550"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="accesscontrolleddevice",
+            name="play_theme",
+            field=models.BooleanField(
+                default=False, verbose_name="Play theme on successful swipe"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="accesscontrolleddevice",
+            name="post_to_discord",
+            field=models.BooleanField(
+                default=True, verbose_name="Post to discord on swipe"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="accesscontrolleddevice",
+            name="report_online_status",
+            field=models.BooleanField(
+                default=True,
+                verbose_name="Report the online status of this device and fail the uptime check if it's offline.",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="memberbucksdevice",
+            name="supports_products",
+            field=models.BooleanField(
+                default=False, verbose_name="Supports the MM products API."
+            ),
+        ),
+    ]

memberportal/access/migrations/0018_auto_20240525_0016.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.25 on 2024-05-24 14:16
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("access", "0017_auto_20240523_1604"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="memberbucksdevice",
+            name="supports_credits",
+        ),
+        migrations.RemoveField(
+            model_name="memberbucksdevice",
+            name="supports_debits",
+        ),
+        migrations.RemoveField(
+            model_name="memberbucksdevice",
+            name="supports_products",
+        ),
+    ]

memberportal/access/models.py

@@ -15,8 +15,10 @@
 from rest_framework_api_key.permissions import BaseHasAPIKey, AbstractAPIKey
 from constance import config
 import hashlib
+from django.core.validators import URLValidator
+from django_prometheus.models import ExportModelOperationsMixin
 
-logger = logging.getLogger("app")
+logger = logging.getLogger("access")
 User = auth.get_user_model()
 utc = pytz.UTC
 
@@ -25,8 +27,7 @@ class AccessControlledDeviceAPIKey(AbstractAPIKey):
     class Meta:
         # Add verbose name
         verbose_name = "API Key For Access Controlled Device"
-
-    pass
+        app_label = "access"
 
 
 class HasAccessControlledDeviceAPIKey(BaseHasAPIKey):
@@ -45,7 +46,9 @@ class HasExternalAccessControlAPIKey(BaseHasAPIKey):
     model = ExternalAccessControlAPIKey
 
 
-class AccessControlledDevice(models.Model):
+class AccessControlledDevice(
+    ExportModelOperationsMixin("access-controlled-device"), models.Model
+):
     id = models.AutoField(primary_key=True)
     authorised = models.BooleanField(
         "Is this device authorised to access the system?", default=False
@@ -61,13 +64,14 @@ class AccessControlledDevice(models.Model):
     last_seen = models.DateTimeField(null=True, blank=True)
     all_members = models.BooleanField("Members have access by default", default=False)
     locked_out = models.BooleanField("Maintenance lockout enabled", default=False)
-    play_theme = models.BooleanField("Play theme on door swipe", default=False)
-    post_to_discord = models.BooleanField("Post to discord on door swipe", default=True)
+    play_theme = models.BooleanField("Play theme on successful swipe", default=False)
+    post_to_discord = models.BooleanField("Post to discord on swipe", default=True)
     exempt_signin = models.BooleanField(
         "Exempt this device from requiring a sign in", default=False
     )
     report_online_status = models.BooleanField(
-        "Report the online status of this device.", default=True
+        "Report the online status of this device and fail the uptime check if it's offline.",
+        default=True,
     )
     hidden = models.BooleanField(
         "Hidden from members in their access permissions screen", default=False
@@ -246,12 +250,18 @@ def get_tags(self):
         )
 
 
-class MemberbucksDevice(AccessControlledDevice):
+class MemberbucksDevice(
+    ExportModelOperationsMixin("memberbucks-device"), AccessControlledDevice
+):
     all_members = True
     type = "memberbucks"
 
+    class Meta:
+        verbose_name = "Memberbucks Device"
+        verbose_name_plural = "Memberbucks Devices"
+
 
-class Doors(AccessControlledDevice):
+class Doors(ExportModelOperationsMixin("door"), AccessControlledDevice):
     type = "door"
 
     class Meta:
@@ -318,7 +328,7 @@ def log_access(self, member_id, success=True):
         return door_log
 
 
-class Interlock(AccessControlledDevice):
+class Interlock(ExportModelOperationsMixin("interlock"), AccessControlledDevice):
     type = "interlock"
 
     cost_per_session = models.IntegerField(
@@ -386,18 +396,18 @@ def log_access(self, user, type="activated"):
         return True
 
 
-class DoorLog(models.Model):
+class DoorLog(ExportModelOperationsMixin("door-log"), models.Model):
     id = models.AutoField(primary_key=True)
     user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
     door = models.ForeignKey(Doors, on_delete=models.CASCADE)
     date = models.DateTimeField(default=timezone.now)
     success = models.BooleanField(default=True)
 
     def __str__(self):
-        return f"{self.user.get_full_name()} ({self.user.profile.screen_name}) swiped at {self.door.name} {'successfully' if self.success else 'unsuccessfully'} at {self.date.date()}"
+        return f"{self.user.get_full_name()} ({self.user.profile.screen_name}) swiped at {self.door.name} {'successfully' if self.success else 'unsuccessfully'} on {self.date.date()}"
 
 
-class InterlockLog(models.Model):
+class InterlockLog(ExportModelOperationsMixin("interlock-log"), models.Model):
     id = models.UUIDField(default=uuid.uuid4, primary_key=True)
     interlock = models.ForeignKey(Interlock, on_delete=models.CASCADE)
     user_started = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
@@ -420,7 +430,7 @@ class InterlockLog(models.Model):
     total_cost = models.FloatField(default=None, blank=True, null=True)
 
     def __str__(self):
-        return f"{self.user_started.get_full_name()} ({self.user_started.profile.screen_name}) swiped at {self.interlock.name} {'successfully' if self.success else 'unsuccessfully'} for {self.total_time.total_seconds()/60} mins at {self.date_started.date()}"
+        return f"{self.user_started.get_full_name()} ({self.user_started.profile.screen_name}) swiped at {self.interlock.name} {'successfully' if self.success else 'unsuccessfully'} for {round(self.total_time.total_seconds()/60)} mins at {self.date_started.date()}"
 
     def calculate_cost(self):
         total_cost = self.interlock.cost_per_session