ゴリ押しでどうにかするHasuraのPermission Testing

HasuraではPermissionを細かく・わかりやすく設定可能です。しかしテストを実施しないかぎりは設定したPermissionが想定通りであることを保証できません。今回は実際に開発・運用しているマルチテナントアプリケーションを例に、Permissionのテストにおける辛みと共通化の可能性について紹介します。

Transcript

1. ゴリ押しでどうにかする HasuraのPermission Testing Hasura User Group Tokyo #3, 2023/10/20 こばやしとおる@DHH, LLC
2. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
3. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
4. 自己紹介 - こばやしとおる - Webアプリケーション開発者 - DHH, LLCのCTO - Hasura歴 1年 - PostgreSQL歴 10+N年
5. アジェンダ - 自己紹介 - 所属企業について - アプリケーションについて - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみについて
6. 所属企業 - DHH, LLC https://dhh.co.jp/ - Ruby on Railsの作者・DHH(David Heinemeier Hansson) のビジネス感覚が好き な2人が作った会社 - http://www.turnyourideasintoreality.com/2014/02/dhh/ - 自社サービスと受託開発の両輪
7. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみについて
8. アプリケーションについて - H
9. アプリケーション - Hooolders Analytics https://lp.hooolders.com/ - 株式会社 Figurout https://figurout.co.jp/ が開発/サービス提供 - DHH, LLC.はシステム設計・開発を担当
10. アプリケーション - Hooolders Analytics https://lp.hooolders.com/ - 株式会社 Figurout https://figurout.co.jp/ が開発/サービス提供 - DHH, LLC.はシステム設計・開発を担当 - 企業と投資家とのエンゲージメントプラットフォーム / IRアナリティクスツール - 自社分析機能 - 企業比較機能 - ニュース検索機能 - カスタムアラート機能
11. アプリケーション - Demo
12. アプリケーション - 構成
13. アプリケーション Firebase Hosting Firebase Auth Hasura Cloud Run Hasura Actions Backend Cloud Functions PostgreSQL Cloud SQL Cloud Storage Transfer/Parser Cloud Functions Hasura Actions Backend Cloud Functions PostgreSQL Cloud SQL Hasura Cloud Run Firebase Auth Firebase Hosting Scheduled Notification Cloud Functions
14. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
15. マルチテナントの実現方法
16. マルチテナントの実現方法
17. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
18. パーミッション
19. パーミッション - Hasura上のRole - staff: サービスの運営 - user: 契約ユーザー - system: バックエンドからのアクセス用
20. パーミッション - Hasura上のRole - staff: サービスの運営 - user: 契約ユーザー - system: バックエンドからのアクセス用 - 論理的なRole - GroupでのRoleにuserを分割 - staff: サービスの運営 - owner: 所属グループのリソースへのアクセス、所属グループへの招待、 ownerへの昇格 - member: 所属グループのリソースへのアクセス - invitee: あるグループから招待を受けている - system: バックエンドからのアクセス
21. パーミッション staff owner invitee member
22. パーミッション - groupsに対するRole×操作のパーミッション Role insert select update delete staff ◯ ◯ ◯ ◯ owner - ◯ ◯ - member - ◯ - - invitee - ◯ - -
23. - Hasura上のGroupsに対するstaff のパーミッション - DBの内容とJWTが乖離する可能 性があるので毎通信staffであるこ とを特定 パーミッション
24. - Hasura上のGroupsに対する owner/member/inviteeのselect パーミッション - 招待中のユーザーはgroup名など を知る必要がある パーミッション
25. - Hasura上のGroupsに対する owner/member/inviteeのupdate パーミッション - ownerのみがgroup名を更新可 パーミッション
26. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
27. テストのやり方 - テーブルに対して各ロールがCRUD表の動作を満たすか確認 - テーブル - permissionを構成するテーブル 7個 (users, staffs, staffInvitations, memberships, ownerships, groupInvitaitons, groups) - 機能を構成するテーブル N個 (groupWatchLists, groupWatchListStocks, stockIssues, stockPrices, ….) - ロール 6種 (staff, owner, member, invitee, anonymous, system) - CRUD 条件によって様々ある
28. テストのやり方 - 道具 - TypeScript + URQL+ Jest - 構成 - /test - /utils/clients/ 各パーミッションのクライアントを生成するファンクション - /permissions/ - /groups, /memberships, /ownerships,… 各テーブル毎 - /queries GraphQLのQuery/Mutation - /insert.ts, /select.ts, /update.ts, /delete.ts, /fragment.ts - /insert, /select, /update, /delete CRUD毎 - /staff.test.ts, member.test.ts,... Permission毎のテストコード
29. テストのやり方 - 時間があればテストコードを眺めてみる
30. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ
31. つらみ - 数が多くてつらい - テーブル数 58 (2023/10/20時点) - Role 6 - CRUD 4 - 可不可を両方テストする必要があるので 2 - 58 x 6 x 4 x 2 = 2592ケース
32. つらみ - 数が多くてつらい - テーブル数 58 (2023/10/20時点) - Role 6 - CRUD 4 - 可不可を両方テストする必要があるので 2 - 58 x 6 x 4 x 2 = 2592ケース ゴリ押し！！！
33. アジェンダ - 自己紹介 - 所属企業 - アプリケーション - マルチテナントの実現方法 - パーミッション - テストのやり方 - つらみ - 共通化
34. 共通化
35. 共通化 permissionを 実現するための テーブル
36. 共通化 permissionを 実現するための テーブル ログインしてい れば誰でも閲 覧可能
37. 共通化 permissionを 実現するための テーブル ログインしてい れば誰でも閲 覧可能 グループに所 属していれば 閲覧可能
38. 共通化 - permission
39. 共通化
40. 共通化 - テストの共通化
41. 共通化 - テストの共通化 - 基本的には共通化するべきでない
42. 共通化 - テストの共通化 - 基本的には共通化するべきでない - コピペ + sedでどうにかできる
43. 共通化 - テストの共通化 - 基本的には共通化するべきでない - コピペ + sedでどうにかできる - cp -r hasura/test/permissions/templateTable hasura/test/permissions/targetTable - sed -e ‘s/templateTable/targetTable/g’ hasura/test/permissions/targetTable/**/*.ts -i
44. 共通化 - テストの共通化 -> 省力化 - 基本的には共通化するべきでない - コピペ + sedでどうにかできる - cp -r hasura/test/permissions/templateTable hasura/test/permissions/targetTable - sed -e ‘s/templateTable/targetTable/g’ hasura/test/permissions/targetTable/**/*.ts -i
45. まとめ - Hasuraにおけるマルチテナントの実現方法例を示した - もちろん違う方法もある - JWTにgroupIdをもたせる方法でもできるよ - HasuraにおけるPermissionテストのやり方を示した - ロジックは単純 - まともにやったら数はすごい ゴリ押しでどうにかしてはならない - 共通化・省力化は設計しだいで可能だよ
46. ゴリ押しでどうにかする HasuraのPermission Testing Hasura User Group Tokyo #3, 2023/10/20 こばやしとおる@DHH, LLC
47. スマートに解決する HasuraのPermission Testing Hasura User Group Tokyo #3, 2023/10/20 こばやしとおる@DHH, LLC
48. Enjoy Development With Hasura