考えたこと・気になったことリンク集

日々の業務で疑問に思ったこと、調べたいこと、参考になった資料のリンク集(技術系のみ抜粋)。

ソフトウェアエンジニアリング

API

RESTAPIのデザインについて
- 「WebAPI 設計のベストプラクティス」に対する所感 #rest - Qiita
APIのエラーハンドリングのやり方調べておいたほうが良さそう #エラーハンドリング
システムパフォーマンスについて
- プロセスとスレッド
  - Node.jsだとどうなっている？
  - プロセス中に複数スレッドがあるけど、いくらでも作れるの？てかどうやって作られるんだろう
  - コンテナって１コンテナ１プロセスだけど、中でマルチプロセスってどうやるの？
- メモリ管理
  - https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Memory_management
  - クラスが生成されるときのメモリの使われ方について見ておいたほうが良さそう
  - I/Oについて
    - 非同期
      - Node.js の非同期処理の仕組み｜ラキール公式｜株式会社ラキールのエンジニアたちによるTECH BLOG
- 知っておいた方がいいおおまかな計算について
  - Google Pro Tip: Use Back-of-the-envelope-calculations to Choose the Best Design - High Scalability -
  - Numbers Every Programmer Should Know By Year
- システムデザイン
  - https://github.com/donnemartin/system-design-primer
  - System Design Primer
- SLAについて
  - Compute Engine Service Level Agreement (SLA) | Google Cloud
画像について
- ブロブに入れて引張る
QRコードのトランザクションについて
- https://medium.com/@shivam_99875/system-design-of-qr-code-based-payment-transactions-9b1b7276335b
- https://docs.antom.com/ac/transactionqrcodenew/intro
- paypayのQRコード用ツール
  - https://github.com/paypay/paypayopa-sdk-node
URLに状態をもたせる
- Your URL Is Your State
ファイルアプロードの設計について
- 至高のファイルアップロード #Java - Qiita
- ファイルアップロード - kawasima

テスト

priate constructorを持つエンティティをどうやってモックしていくのか
アプリケーション層、ドメイン層のテストで最低限やっておくこと
テストダブルの分類とかがうまく書かれている
- xUTPによるテストダブルの定義とその図解 - NTT docomo Business Engineers’ Blog
[B! テスト] ソフトウェアテストの古典から現在まで
PlaywrightとGitHub Actionsを用いたE2Eテスト自動実行環境の構築と、リリース頻度向上の取り組み - M3Career Techblog
伊藤淳一が考える「コードレビューの観点とアプローチ」 - レバテックLAB
翻訳記事「AIコーディングツールによって加速するコード生成に品質保証活動はどう立ち向かうか」 - ブロッコリーのブログ
runn と Skills ではじめる結合テスト
Blog > Writing Good Unit Tests
保守しやすく変化に強いソフトウェアを支える柱　自動テストとテスト駆動開発、その全体像～Software Design 2022年3月号「そろそろはじめるテスト駆動開発」より | gihyo.jp

Javascript/Typescript

Framework

NestJS

NestJSのDIを理解したい
- ソースコードで理解するNestJS①: @Controllerは何をするのか #TypeScript - Qiita
SWC (fast compiler) | NestJS - A progressive Node.js framework
NestJSのヘルスチェック
- terminusの中身について
  - Promise.race() - JavaScript | MDN

Fastify

BackEnd

FrontEnd

Webフロントエンド設計ガイドライン | フューチャー株式会社
SSRとか、SPAとかマジでわからない　
How modern browsers work - by Addy Osmani - Elevate
https://github.com/catnose99/timeline/tree/main
ChromeDevTools/devtools-frontend: The Chrome DevTools UI

エラーハンドリング

5 Reasons Why Business Exceptions Are a Bad Idea
エラーハンドリング
- エラーハンドリングを少しずつ改善していく / improving error handling little by little - Speaker Deck
Notification Pattern
- エラーを複数返したい場合が存在する
- Notification
- php - Domain validation using the notification pattern - Stack Overflow
- AggregateError - JavaScript | MDN
- Replacing Throwing Exceptions with Notification in Validations
error handling
- 例外処理コードレビュー集
- Exception filters | NestJS - A progressive Node.js framework
- 例外処理についていくつかあるが状況に応じてどれを使うかを分析した方がいいかもしれない
  - null を返す場合
  - throw errorする場合
  - return errorする場合
  - Result型を使う場合
findメソッドを書くときにnullを返すか？
- https://dev.classmethod.jp/articles/error-handling-practice-of-typescript/
- nullを返すのは基本的に良くない
  - 後続の処理でnullチェックが発生する
- typescriptではnull ではなく、undefindが推奨されている
  - MSのコーディングガイドより
- 解決策
  - エラーを返す
  - nullオブジェクトを返す
    - TSだとNullオブジェクトってあるのか？
  - PrismaとかでfindUnique使用時にnullが返る。このとき、findUniquメソッドをラップして、新しいfindメソッドを作成して、その中でエラーをかせせば良い
  - Error型を作るのが一番良さそう
    - カスタムエラークラスの作成
      - https://go-to-k.hatenablog.com/entry/typescript-custom-error-class
    - 無効な引数やロジックのエラーを示す際
      - Invalidから始まる名前にする
        
        InvalidEmailAdress
    - 実行時例外を返す場合
      - “Sorry, I … .” で終わるワードを名前にする
      - CouldNotFindProduct, CouldNotStoreFile, CouldNotConnect
early returnにもメリデメがあるぽい
- https://medium.com/swlh/return-early-pattern-3d18a41bba8
- 基本的には、早くフェイルパスを書いてしまい、ハッピーパスは最後に返すことになる

開発メモ

インフラ層の責務について
https://terasolunaorg.github.io/guideline/public_review/ImplementationAtEachLayer/DomainLayer.html#id3
- DBを複数回叩く場合、インフラ層の責務はどうなるんだろう
  - →基本的にアプリケーション層で書く
クラスをステートレスに設計しろとは具体的にどういうこと？
- クラスが状態を、ライフサイクルをもたないということ。具体的には、毎回、new して新しいインスタンス化を行うということ
変数名に、オブジェクトの名前も加えるか？
- 例えば、求人タイトルとした場合、jobTitleのような命名にするか
- こうすれば、変数名単体としてはわかりやすいが、コードの中では、job.JobTitleのようになり冗長な気もする
現在、VOの実装としてDTOを定義しているが、これで正しいのだろうか？
- Is it a DTO or a Value Object? | Matthias Noback
DTOの変更容易性を高めたい #DTO
- どうすればいいのだろうか
- DTOをあたいオブジェクトで生成してしまっている
非同期処理について #asyncronous
- TypescriptのPromiseやasync/awaitとイベントソーシングによる非同期の違いがわからなくなってきた
- おそらく、そもそも、どうやって、非同期処理を受け取っているかをちゃんと理解する必要がありそう
- どういう時に非同期が欲しいのか、いらないのかを理解した方が良さそう
QR Code について　#QRcode
- QRcodeにはhttpのメソッドとかも含めるの？
- System Design — QR code generation | by Krutsilin Siarhei | Medium
- Dynamic QR Code - PayPay Open Payment API Documentation
- QRコードのトランザクションについて
  - https://medium.com/@shivam_99875/system-design-of-qr-code-based-payment-transactions-9b1b7276335b
  - https://docs.antom.com/ac/transactionqrcodenew/intro
  - paypayのQRコード用ツール
    - https://github.com/paypay/paypayopa-sdk-node
- QRコード生成パッケージ
  - https://github.com/soldair/node-qrcode
  - https://github.com/ushelp/EasyQRCodeJS-NodeJS
- 画像のエンコード方法がわからないから、何を取ればいいかがわかっていない
- JWT(JSON Web Token)をQRコードに埋め込んで表示 / 処理してみる #QRcode - Qiita
アプリケーションで時間をどう扱うか？
- Branded Typesで日時の複雑さと戦う - Speaker Deck

DDD (Domain-Driven Design)

Modeling Relationships in a DDD Way · Enterprise Craftsmanship
関連のモデリング - kawasima
How Shopify Handles 30TB of Data Every Minute with a Monolithic Architecture | by Himanshu Singour | Medium
- モジュラーモノリスの作り方として参考になりそう

エンティティ

状態遷移の設計

値オブジェクト

値オブジェクトと構造
- 再帰的な構造のデータの同値性判定はどうしたらいいか - 貳佰伍拾陸夜日記
- 値のコレクションクラスから取得するときに、readonlyで取得するやつ
  - 読み取り専用の配列 (readonly array) | TypeScript入門『サバイバルTypeScript』

集約

集約とトランザクション

イベント駆動

ドメインイベントについて #ドメインイベント
- ドメインイベントはある出来事を時系列に保管するためのオブジェクト
- ドメインイベントはイミュータブルである必要がある、なぜなら、過去に起こった出来事は未来においてもその状態が不変でなければいけないから
集約間の通信について #集約
- [DDD] 戦術的設計パターン Part 4 整合性
- イベント発行はオブザーバーパターンを使うべきか
イベント駆動について
- How does it differs from CQRS EventBus ? · Issue #44 · nestjs/event-emitter
モジュラーモノリス
- NestJSによるモジュラーモノリスの実装 - 複数ベンダーでの協業開発 #Node.js - Qiita
- モジュラーモノリス導入がもたらした功罪 - hacomono TECH BLOG

業務ロジックの実装

型の粒度設計 - kawasima

DB

DBの中身

マイグレーションコンテナは一緒に書いて良い？
compose.dev.yamlとかcompose.stag.yamlとかに書いたほうがいいかも
マイグレーションする場合、どうやるか検討が必要かも
- O/Rマッパー×コンテナ技術使用時のマイグレーション実行タイミングについて
DBとメモリのIOについて
mysqlのcharとvarchrの違い
- ７文字を占有した場合に、なぜ8バイトが占有されるのか、1文字分は、ポインタとからしいが、仕組みが分からない
- 関連するキーワード
  - メモリ
    - allocate
    - ポインタを引き回す
    - javaのvmだとヒープに入る
    - ＧＣで遅くなる
DBの自作とか面白そう
- 自作RDBMSやろうぜ! |
Postgresqlの仕組みを知る

コネクションプール

Go 1.26 の database/sql 内部実装から読み解くコネクションプールの挙動と設定方針 - CADDi Tech Blog

インデックス

検索時のインデックスについて #index
- hashとか使うのだろうか？
- データベースのカラムにハッシュを持って検索効率を上げるのってない気がする
- なぜインデックスを使うと早くなるのか
- どの値にインデックスをつけるとよいのか

パフォーマンス

Transaction

トランザクション
- https://note.com/watanabe_kf1983/n/n41f57b690c56
- トランザクションで囲う範囲はどのように決めるのか？
  - 集約で囲んだ範囲は本当にトランザクションなのか
- 2相ロックと楽観並行制御を使い分ける基準を見極められるようにしたい
- MVCC
- MySQLのネクストキー
- 合意アルゴリズム
  - 2相コミット
- ある集約でトランザクションを貼るときを考える。そこでは、別の集約からreadを呼び出し検証してから、集約の更新などを行う。この時、別集約のreadはトランザクションの内部に入れるべきか？
- prismaのトランザクションの挙動が分からない
  - rollbackってどうなっている？
  - データベースのisolation levelをどうやって満たしている
- ACIDの亜種
  - L2AW theorem
バッチについて
- とあるコドモン開発部の日常〜大規模データメンテナンスバッチの設計編〜 - コドモン Product Team Blog
- 非機能要件についても、イベントストーミングやるとうまくいきそう
- バッチとストリームの処理がわからない
  - ストリームって何？
- バッチ処理の改善〜トランザクション範囲の最小化〜 - Timee Product Team Blog
  - 「トランザクション張っておけば大丈夫」と思ってませんか？バグの温床になる、よくある実装パターン
  - MySQL/Postgres におけるトランザクション分離レベルと発生するアノマリーを整理する
databaseでカウンタなどの実装について
トランザクションそろそろ使いこなしたい、囲う範囲とロックをどこでかけるか
- SELECT FOR UPDATE = 悲観ロック という理解が誤りであると気づいた話 - HackMD
- The LMAX Architecture
- JavaのORMの作者　トランザクションの知見がやばい
コンピュータ・サイエンティストのための会計知識よさげ
- Accounting for Computer Scientists — Martin Kleppmann’s blog
For Updateは修羅の道になるかもしれない
- Timee Product Team Blog
輻輳に着想を得たTransaction制御

データベース (PostgreSQL)

分散システム

分散トランザクション

テーブル設計

ステータスってDBのテーブルで管理するものなのだろうか？違う気がする
- https://zenn.dev/rsugi/articles/8a939d7bd2f60a
- https://amamanamam.hatenablog.com/entry/2023/09/21/192858
- 静的なenumをデータベースのテーブルで表現すんの本当にやめてほしい by nonakasan
- 「失敗から学ぶRDBの正しい歩き方」第5章　フラグの闇
テーブルのカラム名に迷ったんで、英語圏で仕事しているエンジニアに聞いてみた | かきエンジン
ユーザーテーブル作る際に参考になった
- ユーザ情報を保存する時のテーブル設計 - そーだいなるらくがき帳
updateするのと、delete insertどっちがいいのだろうか？
- upsertはアンチパターンなのか？どういうときに使うのか？
updateをする場合と、createとdeleteでupdateする場合、どちらがいいのか
削除系について
- 論理削除
- 物理削除
- ゴミ箱テーブル　退会テーブルなど

ORM

Prisma

prisma
- prismaのトランザクションの仕組みがよくわからない
  - AsyncLocalStargeの仕組みがわからない
  - 局所スレッドストレージみたいので調べればよい？
- prismaちょっとあぶないかも
  - Should You Stop Using Prisma? Why Database ORMs Might Be the Worst Thing That Happened to Backend Development | by Sohail Saifi | Medium
- prismaのE2Eテストどうする門外
  - The Ultimate Guide to Testing with Prisma: End-To-End Testing
Prisma 応用
- prismaでクエリ時の型を作成する
  - Prisma validator | Prisma Documentation
  - How TypeScript 4.9 satisfies Your Prisma Workflows
Prisma & データバリデーション
コネクションプール
- prismaのエンジンをnodejs-postgresql
  - PostgreSQL database connector | Prisma Documentation
  - Welcome – node-postgres

SQL

SQL
- SQLが実行される順番がわかっていない
- SQLが書けない
実行計画
- PostgreSQL実行計画可視化ツールおすすめ #PostgreSQL - Qiita
CTEについて
- Good CTE, bad CTE | boringSQL

検索

The Evolution of Uber’s Search Platform | Uber Blog

クラウド

AWS

ECS

SecretManagerを更新すると、サーキットブレーカーが動き、ロールバックが走るコレがあまり良くわからなかたので、メモ
- Amazon ECS デプロイサーキットブレーカーが障害を検出する方法 - Amazon Elastic Container Service
AWS コンテナ運用設計に関するアプローチ #ECS - Qiita
Amazon Route 53を整理してみた #AWS - Qiita

Storage

S3
- ウイルススキャンについて
  - sa7mon/S3Scanner: Scan for misconfigured S3 buckets across S3-compatible APIs!
- 署名付きURLについて

メッセージング

Review: Leases: An Efficient Fault-Tolerant Mechanism for Distributed File Cache Consistency
Leases.pdf
The advantages of queues on logs — Jack Vanlightly
Message Delivery Reliability • Akka core
乗り越えられないキューバックログの回避
Amazon Simple Queue Serviceとは? - Amazon Simple Queue Service
SNSとSQSのFIFOについて
Lambda SNS SQS Lambdaを行うために必要なこと
- SNS SQS間のセキュリティ
- terraformのdepends onがLambdaのロールで必要だったので
  - depends_on meta-argument reference | Terraform | HashiCorp Developer
  - aws_sns_topic_subscription | Resources | hashicorp/aws | Terraform | Terraform Registry
- power-toolsでログの取得も行った
  - Logger - Powertools for AWS Lambda (TypeScript)

ElastiCashe

クラスタモードについて理解したいお気持ち

DynamoDB

DynamoDBの細かい設定とかわからない
DynamoDB + ElastiCashe
DynamoのTTL対策
- https://github.com/aws/aws-dotnet-distributed-cache-provider/blob/main/src/AWS.DistributedCacheProvider/DynamoDBDistributedCache.cs#L440-L446
DynamoDB TTL Best Practices | Aman | 2022 | Medium | Medium
DynamoDBでできないこと
AWS の NoSQL 入門〜Amazon ElastiCache, Amazon DynamoDB〜
Scaling DynamoDB: How partitions, hot keys, and split for heat impact performance (Part 1: Loading) | AWS Database Blog

Aurora

設定もよくわかっていない
- タイミーで蓄積された Aurora MySQL 運用ナレッジ─ 障害・チューニング・実践知を特別公開 - Timee Product Team Blog
- Ruby on Railsのテーブル設計とトランザクション処理 LT Night - connpass
結局postgresqlな気がする
AutoScaringとか、自動で落とす設定とか書けていない

ネットワーク

セキュリティ

AWS セキュリティの全体像を理解しよう - 初学者が知るべき脅威と対策 | ドクセル

IaC

Terraform
- きれいに書きたい
- tf stateの管理方法がいまだによくわかっていない
- Terraform 変更を安全にレビューする — plan の読み方・CI destroy 検知・承認フロー設計
- Cyclenerd/terraform-google-wif-github: Terraform module to create a Google Cloud Workload Identity Pool and Provider for GitHub Actions

セキュリティ

Webブラウザセキュリティをあまり理解できていない
- 新卒エンジニア向けセキュリティ研修を開催しました - 弁護士ドットコム株式会社 Creators’ blog
- 設計・開発・テストにおけるセキュリティの実践と考え方を知ろう | ドクセル
少しTrivyのMisconfigurationが気になる
セキュリティエンジニアがビジネスに貢献するには
Google Cloud が推奨セキュリティチェックリストを公開しました | DevelopersIO

脅威モデリング

認証認可

opt認証
フェデレーションとは何か？
OAuth
- Auth屋さんの本
【Flutter】Flutterで安全にOAuthトークンを保存するための完全ガイド #Dart - Qiita
セキュリティエンジニアはこう見る。開発時に認可制御不備を怪しむべき実装パターン10選 - GMO Flatt Security Blog
JWT
- 仕組みよくわかってないし、cookieとの違いわかっていない
- OAuthとOIDCの前にJWTから勉強しよう
- JWTの検証はちゃんとするべき
- Mike Jones: self-issued – Musings on Digital Identity
- セキュリティ視点からの JWT 入門 - blog of morioka12
- OAuthの仕組みを説明してHonoで実装してみる

認可の設計

DevOps

Git

commit messageについて #git
- 一応推奨のルールが有る
  - サマリーを命令形で50文字以内で書く
  - それ以上のテキストを書く場合は、2行めを空行にする
  - 好きなだけテキストを追加してよいが、幅が72文字以内になるようにフォーマットする
  - 日本語で書く場合は半分にする
- 何をどのように変更したのかという質問に対する答えは他の場所で見つけられます。したがって、コミットメッセージはなぜその変更をしたのか、なぜその形になっているのかを説明する
- 次のように書いていけばいいかな
  - 何をしたのか？
  - それによって何が嬉しいのか？なぜそうしたのか？
- tbaggery - A Note About Git Commit Messages
- 過去形ではなく、命令形で書く
pull Requests #git
- 10 tips for better Pull Requests
- プルリクエストの粒度を決めて、レビューを楽にしたい
  - Findyの爆速開発を支える、価値提供を最優先にするための開発手法 - Findy Tech Blog