[スキーマ変更] コメントにタイムスタンプを追加 (#346)

closes #338
cafeore-tkb · Oct 27, 2024 · c44a102 · c44a102
1 parent 9d7c849
commit c44a102
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 24 deletions.
diff --git a/common/models/order.test.ts b/common/models/order.test.ts
@@ -235,13 +235,10 @@ describe("[unit] order entity", () => {
 
     expect(order.comments).toEqual([]);
     order.addComment("cashier", "testAddComments");
-    expect(order.comments).toEqual([
-      { author: "cashier", text: "testAddComments" },
-    ]);
+    expect(order.comments[0].author).toBe("cashier");
+    expect(order.comments[0].text).toBe("testAddComments");
     order.addComment("master", "2");
-    expect(order.comments).toEqual([
-      { author: "cashier", text: "testAddComments" },
-      { author: "master", text: "2" },
-    ]);
+    expect(order.comments[1].author).toBe("master");
+    expect(order.comments[1].text).toBe("2");
   });
 });
diff --git a/common/models/order.ts b/common/models/order.ts
@@ -6,6 +6,12 @@ const AUTHORS = ["cashier", "master", "serve", "others"] as const;
 
 export type Author = (typeof AUTHORS)[number];
 
+const commentSchema = z.object({
+  author: z.enum(AUTHORS),
+  text: z.string(),
+  createdAt: z.date(),
+});
+
 export const orderSchema = z.object({
   id: z.string().optional(), // Firestore のドキュメント ID
   orderId: z.number(),
@@ -14,12 +20,7 @@ export const orderSchema = z.object({
   servedAt: z.date().nullable(),
   items: z.array(itemSchema.required()),
   total: z.number(), // sum of item.price
-  comments: z.array(
-    z.object({
-      author: z.enum(AUTHORS),
-      text: z.string(),
-    }),
-  ),
+  comments: z.array(commentSchema),
   billingAmount: z.number(), // total - discount
   received: z.number(), // お預かり金額
   discountOrderId: z.number().nullable(),
@@ -30,9 +31,38 @@ export const orderSchema = z.object({
 
 export type Order = z.infer<typeof orderSchema>;
 
+type Comment = z.infer<typeof commentSchema>;
+
 // 途中から割引額を変更する場合はこの値を変更する
 const STATIC_DISCOUNT_PER_CUP = 100;
 
+class CommentEntity implements Comment {
+  constructor(
+    public readonly author: Author,
+    public readonly text: string,
+    public readonly createdAt: Date,
+  ) {}
+
+  static fromComment(comment: Comment): CommentEntity {
+    return new CommentEntity(comment.author, comment.text, comment.createdAt);
+  }
+
+  static createNew({
+    author,
+    text,
+  }: Omit<Comment, "createdAt">): CommentEntity {
+    return new CommentEntity(author, text, new Date());
+  }
+
+  toComment(): Comment {
+    return {
+      author: this.author,
+      text: this.text,
+      createdAt: this.createdAt,
+    };
+  }
+}
+
 export class OrderEntity implements Order {
   order: ItemEntity | undefined;
   // 全てのプロパティを private にして外部からの直接アクセスを禁止
@@ -44,7 +74,7 @@ export class OrderEntity implements Order {
     private _servedAt: Date | null,
     private _items: WithId<ItemEntity>[],
     private _total: number,
-    private _comments: Order["comments"],
+    private _comments: CommentEntity[],
     private _billingAmount: number,
     private _received: number,
     private _discountOrderId: number | null,
@@ -85,7 +115,7 @@ export class OrderEntity implements Order {
       order.servedAt,
       order.items.map((item) => ItemEntity.fromItem(item)),
       order.total,
-      order.comments,
+      order.comments.map((comment) => CommentEntity.fromComment(comment)),
       order.billingAmount,
       order.received,
       order.discountOrderId,
@@ -140,13 +170,6 @@ export class OrderEntity implements Order {
   get comments() {
     return this._comments;
   }
-  // set comments(a) {
-  //   if (description === "") {
-  //     this._description = null;
-  //   } else {
-  //     this._description = description;
-  //   }
-  // }
 
   get billingAmount() {
     this._billingAmount = this.total - this.discount;
@@ -209,11 +232,16 @@ export class OrderEntity implements Order {
     this._readyAt = null;
   }
 
+  /**
+   * コメントを追加する
+   * @param author コメントの投稿者
+   * @param text コメントの内容
+   */
   addComment(author: Author, text: string) {
     if (text === "") {
       return;
     }
-    this._comments.push({ author, text });
+    this._comments.push(CommentEntity.createNew({ author, text }));
   }
 
   /**
@@ -285,7 +313,7 @@ export class OrderEntity implements Order {
       servedAt: this.servedAt,
       items: this.items.map((item) => item.toItem()),
       total: this.total,
-      comments: this.comments,
+      comments: this.comments.map((comment) => comment.toComment()),
       billingAmount: this.billingAmount,
       received: this.received,
       discountOrderId: this.discountOrderId,