Autocomplete usernames when inviting students and teachers #6032

jpelay · 2024-12-10T00:17:42Z

Adds autocomplete functionality for searching usernames when adding a student or a second teacher.

It does so by matching the usernames in the database with the user's query, so if search for: user, it'll show me: user1, user2, user3, etc.

In the process of doing this I wanted to use a bit more of the power of Dynamo, instead of relying on filtering the data trhough python. To this end I added 2 extra Dynamo conditions: one for checking if a set exits, and another for checking if an element is not in a container.

I also updated HTMX and Tailwind, but maybe I can update those in a different PR?

I tried to improve the code a little bit also by avoiding duplication where I could, so instead of having 2 function for adding teachers and students I merged them together since they were mostly the same.

Fixes #4689

How to test

Log is as a teacher.
Go to the class page
Click on Add student and then on invite by username
Search and check that a) no students that are already in the class show up.
Select a few and send invitations. Check that they were sent
Now click on Invite second teacher. Check that: a) only users that are teachers are shown, b) only teachers that aren't already second teacher's in the class show.
Send invitations and see if they are added correctly.

jpelay · 2024-12-10T00:19:49Z

This is how we are going so far, still a bit of work to be done, but the search is already there

2024-12-09.20-18-46.mp4

rix0rrr · 2024-12-10T07:41:51Z

website/database.py

@@ -109,7 +109,8 @@ def __init__(self):
                                  }),
                                  indexes=[
                                      dynamo.Index('email'),
-                                      dynamo.Index('epoch', sort_key='created')
+                                      dynamo.Index('epoch', sort_key='created'),
+                                      dynamo.Index('username', sort_key='epoch', keys_only=True)


No please.

Suggested change

dynamo.Index('username', sort_key='epoch', keys_only=True)

dynamo.Index('epoch', sort_key='username', keys_only=True)

Also, putting a Condition on a PK doesn't make sense. A partition must always be matched with full key equality. If the DynamoDB layer allowed you to formulate the query below, something is wrong ☹️

EDIT: There was a bug that would only manifest for tables with only a partition key and not a sort key. In that case, the protection that should give you an error when trying to put a condition onto the PK wouldn't work. I fixed it in the linked PR.

Oh I see, the abstraction layer complains if you use the same partition key multiple times so you were forced to reverse the keys to get it to do anything at all.

That restriction is not strictly necessary. It's not enforced by Dynamo, but by our abstraction layer for the convenience of identifying which index to query. Let me see what I can do about that.

Here is a PR you will need to merge before you can set up the indexes the way you need them: #6034. Unfortunately, this will also require you to annotate all existing epoch queries to indicate what index to use. I know at least one of them in the admin interface, and there aren't any tests on those, so do have a good look around.

The motivation for the design decisions is in the linked PR.

(BTW I created the necessary (epoch, username) indexes in the actual DDB tables already, so you don't need to do anything there anymore)

Oh I see, the abstraction layer complains if you use the same partition key multiple times so you were forced to reverse the keys to get it to do anything at all.

That restriction is not strictly necessary. It's not enforced by Dynamo, but by our abstraction layer for the convenience of identifying which index to query. Let me see what I can do about that.

Yes, so I thought I was making a mistake. Thanks for pointing it out and fixing it.

(BTW I created the necessary (epoch, username) indexes in the actual DDB tables already, so you don't need to do anything there anymore)

Neat!

rix0rrr · 2024-12-10T07:56:23Z

app.py

+@app.route('/search_students', methods=['GET'])
+def filter_usernames():
+    search = request.args.get('search', '')
+    results = DATABASE.get_users_that_starts_with(search)


Probably you want to only do an actual search once you've gotten at least one character.

Otherwise the first query will always return the same first 10 items from the users table ["000_test", "4242 i like kittens", "aaron a. aaronson", ...]. Not useful, and people will get tired of it.

Just return an empty list otherwise.

Oh for sure! I was thinking about that yesterday, I'm only going to look data if I there's more than one character.

jpelay · 2025-02-06T05:59:19Z

I have to deal with the conflicts, but this is done :) Sorry it took so long!

jpelay · 2025-02-07T02:23:11Z

Fixed the tests, but still gotta update the ones for the invites.

…to search_usernames

boryanagoncharenko

When I try to invite students and I fill in a username which just yields to search results, I get a message "There are no students in this class". But this is not true - I have a person in my class. Not sure what this message means? That no invites will be sent via this dialogue?

boryanagoncharenko · 2025-02-23T14:26:09Z

static/js/modal.ts

@@ -161,6 +162,31 @@ class Modal {
    });
  }

+  public search(message: string, confirmCb: (...args: any[]) => void, declineCb: () => void = function(){}, args: any[]) {
+    console.log(message, confirmCb, declineCb)


the console.log() is probably not intentional

boryanagoncharenko · 2025-02-23T14:26:37Z

static/js/teachers.ts

@@ -9,6 +9,7 @@ import { autoSave } from './autosave';
 import { HedySelect } from './custom-elements';
 import { Chart } from 'chart.js';
 import { setLoadingVisibility } from './loading';
+// import { postJson } from './comm';


probably we can get rid of this?

boryanagoncharenko · 2025-02-23T14:29:08Z

templates/modal/htmx_search_results_list.html

@@ -0,0 +1,12 @@
+{% if usernames|length == 0 %}


Definitely something minor: the rest of the files have names separated with dashes but this one uses underscores. Is this intentional?

boryanagoncharenko · 2025-02-23T14:43:21Z

website/classes.py

+        usernames = sorted(usernames)
+        return render_template('modal/htmx_search_results_list.html', usernames=usernames)
+
+    @route("/invite", methods=["POST"])
    @requires_teacher
    def invite_student(self, user):


Now that this endpoint is called /invite and used for both student and teachers, perhaps we should change the name too

boryanagoncharenko · 2025-02-23T14:44:38Z

website/classes.py

+            self.db.add_class_invite(data)
+
+        invites = []
+        for invite in self.db.get_class_invitations(Class["id"]):


This exact snippet appears also in for-teachers.py. Do you think we can make it reusable?

boryanagoncharenko · 2025-02-23T14:50:43Z

website/dynamo.py

+        self.item = item
+
+    def to_dynamo_expression(self, field_name):
+        return f"not (contains(#{field_name}, :{field_name}_prefix))"


I find the _prefix suffix confusing. It makes sense in the BeginsWith condition but why is it here?

AnneliesVlaar · 2025-02-24T09:41:09Z

 I like it that the invited accounts appears as a block with a cross to delete them from the invitation list. Although I was afraid that the invitations would be send right away when I click 'invite', maybe we can change 'invite' to 'add' and 'ok' to 'invite'?
 
 

When I invite a teacher and the suggestion list is empty I also get the message “there are no students in this class”  .

If invitation is already send, but not accepted, the username still appears in the list as if the invitation was not send. This might be confusing, especially in the current UI where the invitations are out of sight at the bottom. Can we maybe change the 'invite button' to a disabled button with 'already invited' or something similar in these cases? Or don't show them in the list?

I noticed that the username Teacher3 for example starts with a capital if you check the profile name at the top right, but the search only finds them if you use a small letter. Can the search be indifferent for capitals?

 If a student is in another class it doesn’t show up in the list. I think this is good behavior since students can’t be in two classes at the same time. @MarleenGilsing we should be clear about this in the teacher manual.   
 

jpelay added 3 commits December 9, 2024 20:03

add search endpoint

a723cf8

undo unwated change

d2d25fe

improe ui a bit

b4f6348

rix0rrr requested changes Dec 10, 2024

View reviewed changes

rix0rrr reviewed Dec 10, 2024

View reviewed changes

jpelay added 18 commits December 10, 2024 10:54

Merge branch 'main' into search_usernames

7873c27

update events

edda8d4

focus on input field after htmx requets completes

0f3c014

add list of students

789af85

send empty array on empty strng

021fee9

use grid instead of flex make width bigger

7ffb480

Merge branch 'main' into search_usernames

c7230df

merge from main

7e7c031

add filter to check if a set is emtpy or is not within a record

ca1a443

fix sort key in users table and add query

95105aa

delete search students route from app.py

98a9c87

add new search modal

663d913

add functions in teachers to search usernames

64c7570

modify templates to include new modal

4583954

add new dynamo condition

d6b97ed

add function to search and add invitations on classes py

33f1af8

search functions

7c0de85

automatically generated files

f59758d

jpelay marked this pull request as ready for review February 6, 2025 05:58

jpelay and others added 4 commits February 6, 2025 05:59

🤖 Automatically update generated files

7699527

Merge branch 'main' into search_usernames

f51a50a

🤖 Automatically update generated files

6196fbe

fixing prompt modal

9b71abf

jpelay and others added 2 commits February 6, 2025 22:20

fix query that gets all users

e86309f

🤖 Automatically update generated files

266c548

jpelay mentioned this pull request Feb 7, 2025

🪲 Wrong error message when inviting students to class with username #6167

Open

jpelay and others added 18 commits February 13, 2025 00:01

restructure functions around using HTMX

d43c232

modify modal to clean up upon hitting ok or cancel

fff9674

use use htmx when obtaining inviting the list of usernames

6a92120

Merge branch 'search_usernames' of https://github.com/hedyorg/hedy in…

6b4631d

…to search_usernames

🤖 Automatically update generated files

600356f

add babel label

ad41ee1

Merge branch 'search_usernames' of https://github.com/hedyorg/hedy in…

76aec99

…to search_usernames

automatically generated files

c4d28c3

🤖 Automatically update generated files

a13c024

Merge branch 'main' into search_usernames

1571862

fix merge

416cf3c

Merge branch 'search_usernames' of https://github.com/hedyorg/hedy in…

f7dc9fe

…to search_usernames

🤖 Automatically update generated files

75c9df1

fix tests... again

af827cf

Merge branch 'search_usernames' of https://github.com/hedyorg/hedy in…

7d046fd

…to search_usernames

add labels

5535cd6

Merge branch 'main' into search_usernames

3c7bdc4

update autogenerated files

3672693

jpelay requested a review from boryanagoncharenko February 14, 2025 14:45

boryanagoncharenko reviewed Feb 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Autocomplete usernames when inviting students and teachers #6032

Autocomplete usernames when inviting students and teachers #6032

jpelay commented Dec 10, 2024 •

edited

Loading

jpelay commented Dec 10, 2024

rix0rrr Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading

jpelay Dec 10, 2024

rix0rrr Dec 10, 2024 •

edited

Loading

jpelay Dec 10, 2024

jpelay commented Feb 6, 2025

jpelay commented Feb 7, 2025

boryanagoncharenko left a comment

boryanagoncharenko Feb 23, 2025

boryanagoncharenko Feb 23, 2025

boryanagoncharenko Feb 23, 2025

boryanagoncharenko Feb 23, 2025

boryanagoncharenko Feb 23, 2025

boryanagoncharenko Feb 23, 2025

AnneliesVlaar commented Feb 24, 2025

	dynamo.Index('username', sort_key='epoch', keys_only=True)
	dynamo.Index('epoch', sort_key='username', keys_only=True)

Autocomplete usernames when inviting students and teachers #6032

Are you sure you want to change the base?

Autocomplete usernames when inviting students and teachers #6032

Conversation

jpelay commented Dec 10, 2024 • edited Loading

jpelay commented Dec 10, 2024

rix0rrr Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

rix0rrr Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

rix0rrr Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rix0rrr Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jpelay commented Feb 6, 2025

jpelay commented Feb 7, 2025

boryanagoncharenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AnneliesVlaar commented Feb 24, 2025

jpelay commented Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading

rix0rrr Dec 10, 2024 •

edited

Loading