Janady13/missionmatch / internal/modules/recruiting/errors.go

1package recruiting 2 3import ( 4 "errors" 5 "fmt" 6 "strings" 7 8 "github.com/jackc/pgx/v5/pgconn" 9) 10 11var ( 12 ErrNoDatabase = errors.New("recruiting: no database configured") 13 ErrNotFound = errors.New("recruiting: not found") 14 // ErrConflict is an optimistic concurrency failure: the row moved after the caller read it. 15 ErrConflict = errors.New("recruiting: the record was changed by someone else") 16 ErrInvalid = errors.New("recruiting: invalid input") 17) 18 19// DuplicateError names the field that collided so the caller can point at the right input rather than 20// showing a generic failure. 21type DuplicateError struct{ Field string } 22 23func (e *DuplicateError) Error() string { return "recruiting: duplicate " + e.Field } 24 25// ValidationError carries a per field message. Returning the field lets the UI mark the offending input 26// instead of dropping one sentence at the top of a form. 27type ValidationError struct { 28 Field string 29 Message string 30} 31 32func (e *ValidationError) Error() string { return e.Field + ": " + e.Message } 33func (e *ValidationError) Unwrap() error { return ErrInvalid } 34 35// translatePG converts a Postgres integrity failure into a typed domain error. 36// 37// The database is the only place uniqueness can be checked without a race, so the service inserts and 38// interprets the result rather than pre checking with a SELECT and hoping nothing changes in between. 39// Doing it the other way round produces a 500 under concurrency, which is exactly the case that matters. 40// 41// The constraint NAMES are matched deliberately. They are declared in migrations 0047 and 0048 and 42// changing one without changing this mapping would silently turn a clean 409 back into a 500, so the 43// names are load bearing and the tests pin them. 44func translatePG(err error) error { 45 var pg *pgconn.PgError 46 if !errors.As(err, &pg) { 47 return err 48 } 49 switch pg.Code { 50 case "23505": // unique_violation 51 switch { 52 case strings.Contains(pg.ConstraintName, "uq_clients_org_name"): 53 return &DuplicateError{Field: "name"} 54 case strings.Contains(pg.ConstraintName, "uq_clients_org_uei"): 55 return &DuplicateError{Field: "uei"} 56 // The same candidate cannot be on one job order twice. Postgres names this constraint after its 57 // columns, and without this case the raw name reached the user as "that 58 // applications_organization_id_requisition_id_candidate_id_key is already in use". 59 case strings.Contains(pg.ConstraintName, "applications_organization_id_requisition_id_candidate"): 60 return &DuplicateError{Field: "candidate"} 61 case strings.Contains(pg.ConstraintName, "uq_client_contacts_primary"): 62 // Reached only if the demote and promote were not done in one transaction. The service does 63 // them together, so this is a guard against a future caller taking a shortcut. 64 return &DuplicateError{Field: "is_primary"} 65 default: 66 return &DuplicateError{Field: pg.ConstraintName} 67 } 68 case "23514": // check_violation 69 switch { 70 case strings.Contains(pg.ConstraintName, "clients_name_check"): 71 return &ValidationError{Field: "name", Message: "must be between 1 and 200 characters"} 72 // Rate ranges. Only one end of a range is often being changed, and the other end is whatever is 73 // already stored, so the database is the only place the pair can be compared. Naming the field 74 // turns an unactionable failure into one the form can mark. 75 case strings.Contains(pg.ConstraintName, "requisitions_bill_range_chk"): 76 return &ValidationError{Field: "bill_rate_min", Message: "cannot be greater than the maximum bill rate"} 77 case strings.Contains(pg.ConstraintName, "requisitions_pay_range_chk"): 78 return &ValidationError{Field: "pay_rate_min", Message: "cannot be greater than the maximum pay rate"} 79 case strings.Contains(pg.ConstraintName, "requisitions_salary_range_chk"): 80 return &ValidationError{Field: "salary_min", Message: "cannot be greater than the maximum salary"} 81 case strings.Contains(pg.ConstraintName, "requisitions_rates_nonneg_chk"): 82 return &ValidationError{Field: "bill_rate_min", Message: "rates cannot be negative"} 83 case strings.Contains(pg.ConstraintName, "requisitions_target_after_open_chk"): 84 return &ValidationError{Field: "target_fill_date", Message: "cannot be before the date the order was opened"} 85 case strings.Contains(pg.ConstraintName, "requisitions_title_check"): 86 return &ValidationError{Field: "title", Message: "must be between 1 and 300 characters"} 87 case strings.Contains(pg.ConstraintName, "requisitions_openings_check"): 88 return &ValidationError{Field: "openings", Message: "must be at least 1"} 89 // The two clock invariants from 0047 and 0052. Reaching either means the transition logic moved a 90 // status without moving the clock that status implies, which is a defect in this service rather 91 // than bad input, so it is reported as an internal failure and not blamed on the caller. 92 case strings.Contains(pg.ConstraintName, "requisitions_closed_at_chk"), 93 strings.Contains(pg.ConstraintName, "requisitions_held_since_chk"): 94 return fmt.Errorf("recruiting: requisition clock invariant %s violated: %w", pg.ConstraintName, err) 95 case strings.Contains(pg.ConstraintName, "status"): 96 return &ValidationError{Field: "status", Message: "is not a permitted value"} 97 // The VMS intake rules from migration 0102. They are named here rather than left to the generic 98 // fallback because both are ordinary data entry mistakes with an obvious fix, and "failed a database 99 // constraint, field ck_requisitions_vms_named" tells a recruiter nothing they can act on. 100 case strings.Contains(pg.ConstraintName, "ck_requisitions_vms_named"): 101 return &ValidationError{Field: "vms_name", 102 Message: "is required when the requisition came through a vendor management system, " + 103 "because a submission cannot be reconciled without knowing which portal it came from"} 104 case strings.Contains(pg.ConstraintName, "ck_requisitions_vms_counts"): 105 return &ValidationError{Field: "competing_vendors", 106 Message: "and max_submissions cannot be negative"} 107 default: 108 return &ValidationError{Field: pg.ConstraintName, Message: "failed a database constraint"} 109 } 110 case "23503": // foreign_key_violation 111 // The composite key added in 0052 carries client_id, so this fires when a contact exists but works 112 // at a different client. "Not found" would be misleading, because the contact is right there. 113 if strings.Contains(pg.ConstraintName, "requisitions_hiring_manager_fkey") { 114 return &ValidationError{Field: "hiring_manager_id", Message: "is not a contact at this client"} 115 } 116 return ErrNotFound 117 case "23502": // not_null_violation 118 return &ValidationError{Field: pg.ColumnName, Message: "is required"} 119 } 120 return fmt.Errorf("recruiting: database error: %w", err) 121} 122