Disable/Enable Routes Should Use ID (Fixes #932) (#933)

* Add some basic table searching

* Update /enable/ and /disable/ to use id instead of email

* Clean up unused imports

* Use case insensitive matching for filters

Author: MelissaAutumn

backend/src/appointment/routes/subscriber.py

@@ -47,12 +47,12 @@ def get_all_subscriber(
     )
 
 
-@router.put('/disable/{email}')
+@router.put('/disable/{id}')
 def disable_subscriber(
-    email: str, db: Session = Depends(get_db), subscriber: Subscriber = Depends(get_admin_subscriber)
+    id: str, db: Session = Depends(get_db), subscriber: Subscriber = Depends(get_admin_subscriber)
 ):
-    """endpoint to mark a subscriber deleted by email, needs admin permissions"""
-    subscriber_to_delete = repo.subscriber.get_by_email(db, email)
+    """endpoint to mark a subscriber deleted by id, needs admin permissions"""
+    subscriber_to_delete = repo.subscriber.get(db, int(id))
     if not subscriber_to_delete:
         raise validation.SubscriberNotFoundException()
     if subscriber_to_delete.is_deleted:
@@ -64,10 +64,10 @@ def disable_subscriber(
     return repo.subscriber.disable(db, subscriber_to_delete)
 
 
-@router.put('/enable/{email}')
-def enable_subscriber(email: str, db: Session = Depends(get_db), _: Subscriber = Depends(get_admin_subscriber)):
-    """endpoint to enable a subscriber by email, needs admin permissions"""
-    subscriber_to_enable = repo.subscriber.get_by_email(db, email)
+@router.put('/enable/{id}')
+def enable_subscriber(id: str, db: Session = Depends(get_db), _: Subscriber = Depends(get_admin_subscriber)):
+    """endpoint to enable a subscriber by id, needs admin permissions"""
+    subscriber_to_enable = repo.subscriber.get(db, int(id))
     if not subscriber_to_enable:
         raise validation.SubscriberNotFoundException()
     if not subscriber_to_enable.is_deleted:

backend/test/integration/test_subscriber.py

@@ -189,7 +189,7 @@ def test_disable_enable_subscriber(self, with_client, make_basic_subscriber):
         assert new_subscriber.time_deleted is None
 
         # disable our new subscriber and verify
-        response = with_client.put(f'/subscriber/disable/{new_subscriber.email}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/disable/{new_subscriber.id}', headers=auth_headers)
 
         assert response.status_code == 200, response.text
         response = with_client.post('/subscriber', json={'page': 1}, headers=auth_headers)
@@ -204,14 +204,14 @@ def test_disable_enable_subscriber(self, with_client, make_basic_subscriber):
         assert date_deleted == today
 
         # attempt to disable same subscriber again, expect fail
-        response = with_client.put(f'/subscriber/disable/{new_subscriber.email}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/disable/{new_subscriber.id}', headers=auth_headers)
 
         assert response.status_code == 400, response.text
         data = response.json()
         assert data['detail']['id'] == 'SUBSCRIBER_ALREADY_DELETED'
 
         # now enable the deleted subscriber and verify
-        response = with_client.put(f'/subscriber/enable/{new_subscriber.email}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/enable/{new_subscriber.id}', headers=auth_headers)
 
         assert response.status_code == 200, response.text
         response = with_client.post('/subscriber', json={'page': 1}, headers=auth_headers)
@@ -222,7 +222,7 @@ def test_disable_enable_subscriber(self, with_client, make_basic_subscriber):
         assert subscriber_ret['time_deleted'] is None
 
         # attempt to enable the same subscriber again, expect fail
-        response = with_client.put(f'/subscriber/enable/{new_subscriber.email}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/enable/{new_subscriber.id}', headers=auth_headers)
 
         assert response.status_code == 400, response.text
         data = response.json()
@@ -233,7 +233,7 @@ def test_disable_subscriber_self_delete_failure(self, with_client):
         os.environ['APP_ADMIN_ALLOW_LIST'] = '@example.org'
 
         # disable our current subscriber and verify
-        response = with_client.put(f'/subscriber/disable/{os.getenv('TEST_USER_EMAIL')}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/disable/{TEST_USER_ID}', headers=auth_headers)
 
         assert response.status_code == 403, response.text
         data = response.json()
@@ -244,7 +244,7 @@ def test_disable_subscriber_not_found(self, with_client, make_basic_subscriber):
         os.environ['APP_ADMIN_ALLOW_LIST'] = '@example.org'
 
         # disable a subscriber that doesn't exist
-        response = with_client.put('/subscriber/disable/[email protected]', headers=auth_headers)
+        response = with_client.put('/subscriber/disable/999999999999', headers=auth_headers)
 
         assert response.status_code == 404, response.text
         data = response.json()
@@ -254,7 +254,7 @@ def test_disable_subscriber_no_admin(self, with_client):
         # ensure our current subscriber is not admin
         os.environ['APP_ADMIN_ALLOW_LIST'] = '@notexample.org'
 
-        response = with_client.put(f'/subscriber/disable/{os.getenv('TEST_USER_EMAIL')}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/disable/{TEST_USER_ID}', headers=auth_headers)
 
         assert response.status_code == 401, response.text
         data = response.json()
@@ -265,7 +265,7 @@ def test_enable_subscriber_not_found(self, with_client, make_basic_subscriber):
         os.environ['APP_ADMIN_ALLOW_LIST'] = '@example.org'
 
         # disable a subscriber that doesn't exist
-        response = with_client.put('/subscriber/enable/[email protected]', headers=auth_headers)
+        response = with_client.put('/subscriber/enable/8888888888888888888', headers=auth_headers)
 
         assert response.status_code == 404, response.text
         data = response.json()
@@ -275,7 +275,7 @@ def test_enable_subscriber_no_admin(self, with_client):
         # ensure our current subscriber is not admin
         os.environ['APP_ADMIN_ALLOW_LIST'] = '@notexample.org'
 
-        response = with_client.put(f'/subscriber/enable/{os.getenv('TEST_USER_EMAIL')}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/enable/{TEST_USER_ID}', headers=auth_headers)
 
         assert response.status_code == 401, response.text
         data = response.json()
@@ -324,7 +324,7 @@ def test_hard_delete_subscriber(
         steves_schedule = make_schedule(calendar_id=steves_calendar.id)
 
         # disable steves account
-        response = with_client.put(f'/subscriber/disable/{steve.email}', headers=auth_headers)
+        response = with_client.put(f'/subscriber/disable/{steve.id}', headers=auth_headers)
 
         assert response.status_code == 200, response.json()
 

frontend/src/views/admin/InviteCodePanelView.vue

@@ -3,20 +3,20 @@ import {
   computed, inject, onMounted, ref,
 } from 'vue';
 import { useI18n } from 'vue-i18n';
-import {
-  AlertSchemes, TableDataButtonType, TableDataType, InviteStatus,
-} from '@/definitions';
 import { useRouter } from 'vue-router';
 import { IconSend } from '@tabler/icons-vue';
-import {
-  Invite, InviteListResponse, BooleanResponse, Exception, TableDataRow, TableDataColumn, TableFilter, Alert,
-} from '@/models';
-import { dayjsKey, callKey } from '@/keys';
 import DataTable from '@/components/DataTable.vue';
 import LoadingSpinner from '@/elements/LoadingSpinner.vue';
 import PrimaryButton from '@/elements/PrimaryButton.vue';
 import AlertBox from '@/elements/AlertBox.vue';
 import AdminNav from '@/elements/admin/AdminNav.vue';
+import { dayjsKey, callKey } from '@/keys';
+import {
+  Invite, InviteListResponse, BooleanResponse, Exception, TableDataRow, TableDataColumn, TableFilter, Alert,
+} from '@/models';
+import {
+  AlertSchemes, TableDataButtonType, TableDataType, InviteStatus,
+} from '@/definitions';
 import { staggerRetrieve } from '@/utils';
 
 const router = useRouter();
@@ -31,8 +31,15 @@ const generateCodeAmount = ref(null);
 const loading = ref(true);
 const pageError = ref<Alert>(null);
 const pageNotification = ref<Alert>(null);
+const codeFilter = ref<string>(null);
+const inviteList = computed(() => {
+  if (codeFilter.value) {
+    return invites.value.filter((invite) => invite.code.match(new RegExp(codeFilter.value, 'gi')));
+  }
+  return invites.value;
+});
 
-const filteredInvites = computed(() => invites.value.map((invite) => ({
+const filteredInvites = computed(() => inviteList.value.map((invite) => ({
   code: {
     type: TableDataType.Code,
     value: invite.code,
@@ -148,7 +155,7 @@ const getInvites = async () => {
 
   invites.value = await staggerRetrieve(
     (payload: object) => call('invite/').post(payload).json(),
-    50,
+    250,
     pageError,
   );
 };
@@ -253,27 +260,41 @@ onMounted(async () => {
       @field-click="(_key, field) => revokeInvite(field.code.value)"
     >
       <template v-slot:footer>
-        <div class="flex w-1/3 flex-col gap-4 text-center md:w-full md:flex-row md:text-left">
-          <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
-            <span>{{ t('label.amountOfCodes') }}</span>
-            <input
-              class="mx-4 w-60 rounded-md text-sm"
-              type="number"
-              v-model="generateCodeAmount"
+        <div class="flex w-full justify-between">
+          <div class="flex w-1/3 flex-col gap-4 text-center md:w-full md:flex-row md:text-left">
+            <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
+              <span>{{ t('label.amountOfCodes') }}</span>
+              <input
+                class="mx-4 w-60 rounded-md text-sm"
+                type="number"
+                v-model="generateCodeAmount"
+                :disabled="loading"
+                enterkeyhint="done"
+                @keyup.enter="generateInvites"
+              />
+            </label>
+            <primary-button
+              class="btn-generate"
               :disabled="loading"
-              enterkeyhint="done"
-              @keyup.enter="generateInvites"
-            />
-          </label>
-          <primary-button
-            class="btn-generate"
-            :disabled="loading"
-            @click="generateInvites"
-            :title="t('label.generate')"
-          >
-            <icon-send/>
-            {{ t('label.generate') }}
-          </primary-button>
+              @click="generateInvites"
+              :title="t('label.generate')"
+            >
+              <icon-send/>
+              {{ t('label.generate') }}
+            </primary-button>
+          </div>
+          <div class="flex flex-col items-end gap-4">
+            <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
+              <span>{{ t('label.search') }}</span>
+              <input
+                class="mx-4 w-60 rounded-md text-sm"
+                type="text"
+                v-model="codeFilter"
+                :disabled="loading"
+                enterkeyhint="search"
+              />
+            </label>
+          </div>
         </div>
       </template>
 

frontend/src/views/admin/SubscriberPanelView.vue

@@ -1,23 +1,23 @@
 <script setup lang="ts">
-import { AlertSchemes, TableDataButtonType, TableDataType } from '@/definitions';
 import {
   computed, inject, onMounted, ref,
 } from 'vue';
 import { IconSend } from '@tabler/icons-vue';
 import { useI18n } from 'vue-i18n';
 import { useRouter } from 'vue-router';
-import { useUserStore } from '@/stores/user-store';
-import {
-  Subscriber, SubscriberListResponse, BooleanResponse, Exception, TableDataRow, TableDataColumn, TableFilter, Alert,
-} from '@/models';
-import { dayjsKey, callKey } from '@/keys';
 import AdminNav from '@/elements/admin/AdminNav.vue';
 import AlertBox from '@/elements/AlertBox.vue';
 import DataTable from '@/components/DataTable.vue';
 import LoadingSpinner from '@/elements/LoadingSpinner.vue';
 import PrimaryButton from '@/elements/PrimaryButton.vue';
 import ConfirmationModal from '@/components/ConfirmationModal.vue';
-import { sleep, staggerRetrieve } from '@/utils';
+import { dayjsKey, callKey } from '@/keys';
+import {
+  Subscriber, BooleanResponse, Exception, TableDataRow, TableDataColumn, TableFilter, Alert,
+} from '@/models';
+import { useUserStore } from '@/stores/user-store';
+import { AlertSchemes, TableDataButtonType, TableDataType } from '@/definitions';
+import { staggerRetrieve } from '@/utils';
 
 const user = useUserStore();
 
@@ -35,8 +35,15 @@ const pageError = ref<Alert>(null);
 const pageNotification = ref<Alert>(null);
 const hardDeleteModalOpen = ref<boolean>(false);
 const hardDeleteModalContext = ref<Subscriber>(null);
+const emailFilter = ref<string>(null);
+const subscriberList = computed(() => {
+  if (emailFilter.value) {
+    return subscribers.value.filter((sub) => sub.email.match(new RegExp(emailFilter.value, 'gi')));
+  }
+  return subscribers.value;
+});
 
-const filteredSubscribers = computed(() => subscribers.value.map((subscriber) => ({
+const filteredSubscribers = computed(() => subscriberList.value.map((subscriber) => ({
   id: {
     type: TableDataType.Text,
     value: subscriber.id,
@@ -154,7 +161,7 @@ const getSubscribers = async () => {
 
   subscribers.value = await staggerRetrieve(
     (payload: object) => call('subscriber/').post(payload).json(),
-    50,
+    250,
     pageError,
   );
 };
@@ -294,23 +301,37 @@ onMounted(async () => {
       @field-click="onFieldClick"
     >
       <template v-slot:footer>
-        <div class="flex w-1/3 flex-col gap-4 text-center md:w-full md:flex-row md:text-left">
-          <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
-            <span>{{ t('label.enterEmailToInvite') }}</span>
-            <input
-              class="mx-4 w-60 rounded-md text-sm"
-              type="email"
-              placeholder="e.g. [email protected]"
-              v-model="inviteEmail"
-              :disabled="loading"
-              enterkeyhint="send"
-              @keyup.enter="sendInvite"
-            />
-          </label>
-          <primary-button class="btn-send" :disabled="loading" @click="sendInvite" :title="t('label.send')">
-            <icon-send />
-            {{ t('label.send') }}
-          </primary-button>
+        <div class="flex w-full justify-between">
+          <div class="flex w-1/3 flex-col gap-4 text-center md:w-full md:flex-row md:text-left">
+            <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
+              <span>{{ t('label.enterEmailToInvite') }}</span>
+              <input
+                class="mx-4 w-60 rounded-md text-sm"
+                type="email"
+                placeholder="e.g. [email protected]"
+                v-model="inviteEmail"
+                :disabled="loading"
+                enterkeyhint="send"
+                @keyup.enter="sendInvite"
+              />
+            </label>
+            <primary-button class="btn-send" :disabled="loading" @click="sendInvite" :title="t('label.send')">
+              <icon-send/>
+              {{ t('label.send') }}
+            </primary-button>
+          </div>
+          <div class="flex flex-col items-end gap-4">
+            <label class="flex flex-col gap-4 md:flex-row md:items-center md:gap-0">
+              <span>{{ t('label.search') }}</span>
+              <input
+                class="mx-4 w-60 rounded-md text-sm"
+                type="text"
+                v-model="emailFilter"
+                :disabled="loading"
+                enterkeyhint="search"
+              />
+            </label>
+          </div>
         </div>
       </template>