✨ implement user role (#759)

* 🗃️ create migration for Role table

* 🗃️ Refactor Role table migration and seed data with UUID primary key

* 🗃️ Add UserRole table with permissions for skillz-admins and world roles

* ✨ Add role management components and update translations

* 🔨 add script to update role in seed

Author: bengeois

hasura/metadata/tables.yaml

@@ -237,6 +237,42 @@
     - role: skillz-admins
       permission:
         filter: {}
+- table:
+    name: Role
+    schema: public
+  insert_permissions:
+    - role: skillz-admins
+      permission:
+        check: {}
+        columns:
+          - name
+          - id
+  select_permissions:
+    - role: skillz-admins
+      permission:
+        columns:
+          - name
+          - id
+        filter: {}
+    - role: world
+      permission:
+        columns:
+          - name
+          - id
+        filter: {}
+        allow_aggregations: true
+  update_permissions:
+    - role: skillz-admins
+      permission:
+        columns:
+          - name
+          - id
+        filter: {}
+        check: {}
+  delete_permissions:
+    - role: skillz-admins
+      permission:
+        filter: {}
 - table:
     name: Skill
     schema: public
@@ -905,6 +941,72 @@
     - role: skillz-admins
       permission:
         filter: {}
+- table:
+    name: UserRole
+    schema: public
+  insert_permissions:
+    - role: skillz-admins
+      permission:
+        check: {}
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+    - role: world
+      permission:
+        check:
+          userEmail:
+            _eq: x-hasura-user-email
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+  select_permissions:
+    - role: skillz-admins
+      permission:
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+        filter: {}
+    - role: world
+      permission:
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+        filter: {}
+        allow_aggregations: true
+  update_permissions:
+    - role: skillz-admins
+      permission:
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+        filter: {}
+        check: {}
+    - role: world
+      permission:
+        columns:
+          - userEmail
+          - created_at
+          - roleId
+        filter:
+          userEmail:
+            _eq: x-hasura-user-email
+        check:
+          userEmail:
+            _eq: x-hasura-user-email
+  delete_permissions:
+    - role: skillz-admins
+      permission:
+        filter: {}
+    - role: world
+      permission:
+        filter:
+          userEmail:
+            _eq: x-hasura-user-email
 - table:
     name: UserSkillDesire
     schema: public

hasura/migrations/1733767326556_create_table_public_Role/down.sql

@@ -0,0 +1 @@
+DROP TABLE "public"."Role";

hasura/migrations/1733767326556_create_table_public_Role/up.sql

@@ -0,0 +1,2 @@
+CREATE TABLE "public"."Role" ("id" uuid NOT NULL DEFAULT gen_random_uuid(), "name" text NOT NULL, PRIMARY KEY ("id") , UNIQUE ("id"), UNIQUE ("name"));COMMENT ON TABLE "public"."Role" IS E'Role for a user';
+CREATE EXTENSION IF NOT EXISTS pgcrypto;

hasura/migrations/1733775421032_create_table_public_UserRole/down.sql

@@ -0,0 +1 @@
+DROP TABLE "public"."UserRole";

hasura/migrations/1733775421032_create_table_public_UserRole/up.sql

@@ -0,0 +1 @@
+CREATE TABLE "public"."UserRole" ("userEmail" text NOT NULL, "roleId" uuid NOT NULL, "created_at" timestamptz NOT NULL DEFAULT now(), PRIMARY KEY ("userEmail","roleId") , FOREIGN KEY ("userEmail") REFERENCES "public"."User"("email") ON UPDATE restrict ON DELETE cascade, FOREIGN KEY ("roleId") REFERENCES "public"."Role"("id") ON UPDATE restrict ON DELETE cascade, UNIQUE ("userEmail", "roleId"));COMMENT ON TABLE "public"."UserRole" IS E'Relations between user and role';

hasura/seeds/10-role.sql

@@ -0,0 +1,13 @@
+INSERT INTO "public"."Role" ("name") VALUES
+('Developer / Engineer'),
+('Technical Lead'),
+('Solution Architect'),
+('Technical Expert / Specialist'),
+('Product Owner'),
+('Product Manager'),
+('UX Designer'),
+('Engineering Manager'),
+('Delivery Manager'),
+('Coach (team, organisation)'),
+('Consultant')
+ ON CONFLICT ("name") DO NOTHING;

i18n/en.js

@@ -11,6 +11,7 @@ export default {
         noData: 'No data available.',
         requiredField: 'This field is required',
         tagRequired: 'Add at least 1 tag',
+        roleRequired: 'Add at least 1 role',
         topicRequired: 'Add at least 1 topic',
         duplicatedTag: "This tag already exists, you can't create it",
     },
@@ -240,6 +241,7 @@ export default {
         agency: 'Agency',
         contact: 'Preferred method of contact',
         topics: 'Preferred topics',
+        roles: 'Roles',
         certifications: 'Certifications',
         selectPlaceholder: 'Agency',
         validFrom: 'valid from',

i18n/fr.js

@@ -11,6 +11,7 @@ export default {
         noData: 'Aucune donnée disponible.',
         requiredField: 'Ce champs est obligatoire',
         tagRequired: 'Ajoutez au minimum 1 tag',
+        roleRequired: 'Ajoutez au minimum 1 rôle',
         topicRequired: 'Ajoutez au minimum 1 sujet',
         duplicatedTag: 'Ce tag existe déjà, vous ne pouvez pas le créer',
     },
@@ -246,6 +247,7 @@ export default {
         agency: 'Agence',
         contact: 'Méthode de contact préférée',
         topics: 'Sujets préférés',
+        roles: 'Rôles',
         certifications: 'Certifications',
         selectPlaceholder: 'Agence',
         validFrom: 'valide depuis',

scripts/update-role-referentiel.mjs

@@ -0,0 +1,51 @@
+import fetch from 'node-fetch'
+import fs from 'fs'
+
+/*
+ * ENVIRONMENT CHECK
+ */
+if (!process.env.NEXT_PUBLIC_BASE_URL) {
+    throw new Error(
+        "ERROR: App couldn't start because NEXT_PUBLIC_BASE_URL isn't defined"
+    )
+}
+
+if (!process.env.NEXT_API_BEARER_TOKEN) {
+    throw new Error(
+        "ERROR: App couldn't start because NEXT_API_BEARER_TOKEN isn't defined"
+    )
+}
+
+/*
+ * GET ALL ROLES FROM API
+ */
+const response = await fetch(`${process.env.NEXT_PUBLIC_BASE_URL}/api/roles`, {
+    method: 'GET',
+    headers: {
+        Authorization: process.env.NEXT_API_BEARER_TOKEN,
+    },
+})
+
+const { roles: rolesData } = await response.json()
+
+/*
+ * FORMAT DATA
+ */
+const roles = rolesData.map((role) => `('${role.name}')`)
+
+/*
+ * WRITE DATA TO FILE
+ */
+let writer = fs.createWriteStream('../hasura/seeds/10-roles.sql', {
+    flags: 'w',
+})
+
+writer.write('INSERT INTO "public"."Role" ("name") VALUES\n')
+
+writer.write(roles.join(',\n'))
+
+writer.write('\n ON CONFLICT ("name") DO NOTHING;')
+
+writer.close()
+
+console.log(`Referential Roles successfully updated (${roles.length} roles).`)

src/components/atoms/Role.tsx

@@ -0,0 +1,39 @@
+import { RoleItem } from '../../utils/types'
+
+type RoleType = 'common' | 'selected'
+
+type RoleProps = {
+    type: RoleType
+    role: RoleItem
+    keyId: string | number
+    readOnly?: boolean
+    callback?: (role: RoleItem) => void
+}
+
+export const roleTypeClasses: Record<RoleType, string> = {
+    common: 'font-bold gradient-red-faded text-light-ultrawhite hover:shadow-xl hover:shadow-light-graybutton hover:dark:shadow-lg hover:dark:shadow-dark-radargrid',
+    selected:
+        'text-light-dark text-light-ultrawhite gradient-red hover:drop-shadow-xl hover:dark:shadow-lg hover:dark:shadow-dark-radargrid',
+}
+
+export const roleClasses = {
+    base: 'text-base font-bold py-1 px-5 rounded-full',
+    disabled: 'disabled:pointer-events-none',
+    variant: roleTypeClasses,
+}
+
+const Role = ({ type, role, keyId, callback, readOnly = false }: RoleProps) => {
+    return (
+        <div className="flex-initial py-2" key={`role-${keyId}`}>
+            <button
+                className={`${roleClasses.base} ${roleClasses.disabled} ${roleClasses.variant[type]}`}
+                disabled={readOnly}
+                onClick={() => callback(role)}
+            >
+                <p className="text-sm">{role.name}</p>
+            </button>
+        </div>
+    )
+}
+
+export default Role