Store school email domains by PetarSimonovic · Pull Request #787 · RaspberryPiFoundation/editor-api

PetarSimonovic · 2026-04-21T11:05:33Z

Status

What's changed?

Add a school_email_domains table
Add a SchoolEmailDomain model
Add a SchoolEmailDomainValidator that normalises and checks domains
Update association on School
Add valid_domain? method on School
Add and update specs

Copilot

Pull request overview

Introduces first-class storage for school email domains by adding a dedicated table/model and wiring it into the School domain model, with accompanying specs.

Changes:

Added school_email_domains table with a composite unique index per school.
Added SchoolEmailDomain model with before_validation normalization (strip leading @, downcase).
Updated School to has_many :school_email_domains and added/updated model specs.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
spec/models/school_spec.rb	Adds association + dependent-destroy coverage for `school_email_domains`.
spec/models/school_email_domain_spec.rb	Adds model spec coverage for domain normalization behavior.
db/schema.rb	Reflects new `school_email_domains` table and foreign key.
db/migrate/20260420104937_create_school_email_domains.rb	Creates the new `school_email_domains` table and composite unique index.
app/models/school_email_domain.rb	Introduces the new model and domain normalization callback.
app/models/school.rb	Adds `has_many :school_email_domains, dependent: :destroy`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2026-04-21T12:50:56Z

Test coverage

91.13% line coverage reported by SimpleCov.
Run: https://github.com/RaspberryPiFoundation/editor-api/actions/runs/26042630378

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

fspeirs

Overall this looks like the right approach. I have one consideration about validating domains - I feel like it would be helpful to be stricter in checking that the user hasn't typo'ed their domain or misunderstood what we are asking for.

fspeirs

Directionally, quite correct. Just some sharpening of the normalisation approach in school_email_domain and a request for a testing method in school.rb. The lack of a testing method is non-blocking if it's coming in a separate PR.

peconia · 2026-04-30T16:00:01Z

The regex we use in profile side to validate is '^\\s*(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z]{2,63}\\s*$'

While it is similar, we would reject things that had a dash in the wrong place, like example.-wrong.edu, but that would be approved by this one. I also wonder about things that are domains but not email domains, like having www. or ftp. prefix to the domain. Maybe that will come down to making sure the UI is clear in what is expected, and the API level can validate some things too.

zetter-rpf

Nice one

Add a migration to create the school_email_domains table, storing a domain string against a school_id

Create the model and add initial specs

Removing leading @ symbols and lower case domains

Extract domain validation from school_email_domain model to module Call it from SchoolEmailDomain and School

This PR implements the back-end for class join codes — students join a class by entering an 8-character code in the format `CDDD-CDDD` (consonant + three digits, twice, separated by a hyphen). ## Core Logic The core logic for this work lives in `JoinController#create`, which determines what response the front-end gets based on the user who is trying to join. This method returns a `show.json.builder` with values that allow the front-end to determine what to show the user, or where to redirect them to based on their status. The status value is computed in `action_status`. Another feature of `JoinController#show` is that it may be called by unauthenticated users, so that we can destructure the join code into a school and class in order to show the user a school and class name before they're redirected to log in. There are modifications to `School` to allow that model to carry a join code and regenerate it. Conceptually, a join code is a globally unique code that represents both a class code and a school code. The other component of interest is the `JoinCodeGenerator` which produces the codes in the first place. ## Changes - Add `join_code` column with a unique index to `school_classes`, plus a backfill migration for existing classes. - Add `JoinCodeGenerator` with `.generate` and `.normalize` (canonicalises user input to the hyphenated form for DB lookup). - Auto-assign join codes on `SchoolClass` create/import with a uniqueness retry, plus a `regenerate_join_code!` helper. - Add `GET /api/join/:join_code` returning the prospective user's status. The full set of statuses is: - `unauthenticated` — no current user - `joinable` — the user can be enrolled as a student - `joinable_as_teacher` — the user already has a teacher role for this school and will be added to the class as a teacher - `owner` — the user owns this school; treated as already a member for redirect purposes - `already_member` — the user is already a member of this class - `wrong_school` — the user has a role in a different school - `domain_mismatch` — the user's email domain is not registered for this school - `not_a_student` — the user has a non-student role elsewhere - Add `POST /api/join/:join_code` to enrol the current user as a student (or teacher, if `joinable_as_teacher`) of the school and class. - Add `POST /api/schools/:school_id/classes/:id/regenerate_join_code` (nested under the existing `school_classes` resource). - Expose `join_code` on the school class JSON - Add `School#valid_email?` (built on #787's domain validation) for the `domain_mismatch` check. - Add `School#auto_join_enabled?` to allow the front end to prompt users correctly about the requirements for auto-join. - Update CanCan abilities so school owners and class teachers can `regenerate_join_code`. - Add specs covering the model, generator, controllers, and abilities. --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 21, 2026 11:05

cla-bot Bot added the cla-signed label Apr 21, 2026

Copilot started reviewing on behalf of PetarSimonovic April 21, 2026 11:05 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb

Comment thread spec/models/school_email_domain_spec.rb

Comment thread db/migrate/20260420104937_create_school_email_domains.rb

PetarSimonovic force-pushed the store-school-email-domains branch from 4740867 to aff003a Compare April 21, 2026 12:38

PetarSimonovic requested a review from Copilot April 21, 2026 13:31

Copilot started reviewing on behalf of PetarSimonovic April 21, 2026 13:31 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb

Comment thread spec/models/school_email_domain_spec.rb Outdated

PetarSimonovic commented Apr 21, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb Outdated

fspeirs requested changes Apr 22, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb Outdated

Comment thread spec/models/school_email_domain_spec.rb

PetarSimonovic requested a review from fspeirs April 22, 2026 10:31

fspeirs requested changes Apr 27, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb Outdated

Comment thread app/models/school.rb

PetarSimonovic temporarily deployed to editor-api-p-store-scho-3fgo5v April 30, 2026 16:15 Inactive

PetarSimonovic temporarily deployed to editor-api-p-store-scho-hfpxj9 April 30, 2026 16:32 Inactive

PetarSimonovic commented Apr 30, 2026

View reviewed changes

Comment thread spec/models/school_email_domain_spec.rb

PetarSimonovic commented Apr 30, 2026

View reviewed changes

Comment thread app/models/school_email_domain.rb Outdated

PetarSimonovic force-pushed the store-school-email-domains branch from 4fda047 to ead00de Compare April 30, 2026 16:42

PetarSimonovic temporarily deployed to editor-api-p-store-scho-okmdpg April 30, 2026 16:43 Inactive

PetarSimonovic force-pushed the store-school-email-domains branch from ead00de to 81f8ad5 Compare April 30, 2026 16:52

PetarSimonovic temporarily deployed to editor-api-p-store-scho-r7dl1t April 30, 2026 16:52 Inactive

PetarSimonovic temporarily deployed to editor-api-p-store-scho-vkoodl April 30, 2026 17:12 Inactive

PetarSimonovic temporarily deployed to editor-api-p-store-scho-vkoodl April 30, 2026 17:18 Inactive

PetarSimonovic force-pushed the store-school-email-domains branch from 00a63d5 to e5a847a Compare April 30, 2026 17:22

PetarSimonovic temporarily deployed to editor-api-p-store-scho-vkoodl April 30, 2026 17:22 Inactive

PetarSimonovic force-pushed the store-school-email-domains branch from e5a847a to f5eb365 Compare April 30, 2026 17:24

PetarSimonovic temporarily deployed to editor-api-p-store-scho-vkoodl April 30, 2026 17:24 Inactive

PetarSimonovic requested a review from fspeirs April 30, 2026 17:29

PetarSimonovic temporarily deployed to editor-api-p-store-scho-1bslx0 May 7, 2026 14:43 Inactive

PetarSimonovic temporarily deployed to editor-api-p-store-scho-xaov7e May 15, 2026 08:03 Inactive

PetarSimonovic force-pushed the store-school-email-domains branch from c5e1590 to 62a5acb Compare May 15, 2026 08:04

PetarSimonovic temporarily deployed to editor-api-p-store-scho-xaov7e May 15, 2026 08:04 Inactive

PetarSimonovic force-pushed the store-school-email-domains branch from 62a5acb to 1e8b16a Compare May 15, 2026 08:12

PetarSimonovic temporarily deployed to editor-api-p-store-scho-xaov7e May 15, 2026 08:13 Inactive

zetter-rpf approved these changes May 15, 2026

View reviewed changes

fspeirs mentioned this pull request May 18, 2026

Implement class join codes back-end #789

Merged

PetarSimonovic added 14 commits May 18, 2026 16:16

Create school_email_domains table

0880b4f

Add a migration to create the school_email_domains table, storing a domain string against a school_id

Add SchoolEmailDomain model

60e3fcb

Create the model and add initial specs

Format domains

76c7df5

Removing leading @ symbols and lower case domains

Add has_many association on School

f748dd1

Scope domain uniqueness to school_id

93805ea

Use type of error instead of string

878716c

Declare subject above other let statements

170e0be

Parse and return host when URI provided

d1933fa

Validate domains against Public Suffix List

5c64c31

Update validation and specs

1634375

Add email domain validation on School

20abcca

Align host validation with Profile

afaf941

Add SchoolEmailDomainValidator

fce88d3

Extract domain validation from school_email_domain model to module Call it from SchoolEmailDomain and School

Add explanatory comment for accounts_host_format regex

b789663

PetarSimonovic force-pushed the store-school-email-domains branch from 1e8b16a to b789663 Compare May 18, 2026 15:17

PetarSimonovic temporarily deployed to editor-api-p-store-scho-fles7a May 18, 2026 15:18 Inactive

fspeirs approved these changes May 19, 2026

View reviewed changes

PetarSimonovic merged commit 916c66a into main May 19, 2026
5 checks passed

PetarSimonovic deleted the store-school-email-domains branch May 19, 2026 08:01

Conversation

PetarSimonovic commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Status

What's changed?

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test coverage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fspeirs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fspeirs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

peconia commented Apr 30, 2026

Uh oh!

Uh oh!

Uh oh!

zetter-rpf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

PetarSimonovic commented Apr 21, 2026 •

edited

Loading

github-actions Bot commented Apr 21, 2026 •

edited

Loading