Add post history tracking and restructure timestamps #379
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a new post_logs table to track post creation details. - Updated post creation logic to include a public_id and log the post details upon creation. - Modified post update logic to ensure proper handling of public_id for querying and deletion.
- Added the post ID to the values inserted into the post_logs table to enhance tracking of post creation details.
- Introduced public_id generation during user creation in the userApp. - Updated related tests to include public_id in user insertion for consistency.
- Modified the post update schema to require the content field. - Removed the updated_at field assertions from tests to reflect schema changes. - Updated the user_id assignment in post creation logic for consistency with the new structure.
WalkthroughThis PR removes the Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
… logic - Cleaned up the user creation logic by directly generating public_id during insertion. - Updated related test files to remove FIXME comments and ensure consistency in public_id handling.
- Replaced crypto.randomUUID() with faker.string.uuid() for public_id generation in user and post test files. - Ensured consistency in public_id handling across user and post creation logic in tests.
…st cases - Removed the updated_at field from the post schema and updated the required fields accordingly. - Modified test cases to reflect the changes in the post schema, ensuring consistency in content field requirements.
- Replaced crypto.randomUUID() with faker.string.uuid() for public_id generation in post test files. - Ensured consistency in public_id handling across post creation logic in tests.
- Enhanced the post update logic to insert relevant post details into the post_logs table after a successful update. - This addition improves tracking and auditing of post updates by capturing essential information such as public_id and content.
- Updated post test cases to include assertions for the post_logs table, ensuring that post details are logged correctly upon post creation and updates. - Enhanced the test logic to verify the presence and correctness of logged post information, including public_id, user_id, and content.
- Updated the post creation logic to generate public_id directly within the values insertion, ensuring consistency and clarity in the code. - This change simplifies the transaction process by removing the separate declaration of public_id.
- Introduced the updated_at field in the post schema to track the last modification timestamp. - Updated relevant test cases to include assertions for the updated_at field, ensuring accurate verification of post details. - Adjusted post creation logic to set the updated_at field upon post creation.
- Introduced the updated_at field in the post schema to track the last modification timestamp. - Updated the required fields to include updated_at, ensuring comprehensive post detail tracking.
- Added the updated_at field to the post response object to ensure that the last modification timestamp is included when retrieving post details.
- Modified test cases to set the updated_at field to null instead of expecting a string, ensuring alignment with the current post response structure.
…components - Modified the updated_at field in the Post interface to accept null values, reflecting the possibility of no updates. - Adjusted related components and mock response functions to accommodate the updated field type, ensuring consistent handling of post update timestamps.
- Updated the mock post creation function in PostCard stories to set the updated_at field to null, aligning with the recent schema changes that allow null values for this field.
…ted logic - Added first_created_at field to the post schema to track the original creation timestamp. - Updated post creation and response logic to handle first_created_at, transforming it to created_at for consistency. - Adjusted tests to ensure first_created_at is correctly set and maintained during post operations.
…t and remove updated_at - Refactored the post schema to include first_created_at and removed the updated_at field, aligning with recent changes. - Updated mock data generation in response functions to reflect the new schema, ensuring consistency in post creation and retrieval. - Adjusted related types to streamline the post structure and improve clarity in the codebase.
…ng structure - Introduced a new "post" schema definition to encapsulate post properties, including public_id, content, first_created_at, and created_at. - Updated the post response structure to utilize the new schema, ensuring a more organized and maintainable codebase. - Removed redundant property definitions in favor of schema references, streamlining the overall schema design.
…_at field - Enhanced the post schema to include the updated_at field, ensuring accurate tracking of post modifications. - Adjusted response structures and mock data to reflect the new schema, maintaining consistency across the application. - Removed the first_created_at field from the schema and updated required fields accordingly, streamlining the post data model.
…ions - Removed the previous response schema definitions and replaced them with transformation functions to convert database post data into the API response format. - Introduced `transformPost` and `transformPostWithUser` functions to enhance clarity and maintainability in response handling. - Updated routes to utilize the new transformation functions, ensuring consistent response structures across post operations.
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@packages/backend_app/src/apps/posts/dto.ts`:
- Around line 6-41: postSchema currently requires updated_at and transformPost
always sets it, preventing signaling "never updated"; make updated_at nullable
in postSchema (allow null in the OpenAPI schema) and update transformPost to
return updated_at as null when the post was never edited by comparing timestamps
(use millisecond-safe comparison like first_created_at.getTime() ===
created_at.getTime()) otherwise return the ISO string; reference postSchema and
transformPost when making these changes and ensure the OpenAPI metadata reflects
nullability.
In `@packages/backend_app/src/db/schema.ts`:
- Around line 37-43: The post_logs table defines id as integer().primaryKey()
but should be auto-generated like other tables; update postLogsTable's id column
to use generatedAlwaysAsIdentity() (i.e., change id to
integer().primaryKey().generatedAlwaysAsIdentity()) so inserts no longer require
manual id assignment and align schema behavior with other tables (refer to
postLogsTable, "post_logs", and the id column).
In
`@packages/frontend_app/src/components/pages/post/components/PostCard/index.tsx`:
- Around line 27-28: The code treats updated_at as nullable which makes
isUpdated truthy for every post; in the PostCard component keep updated_at as a
non-null string (remove the "| null" from the local type declaration or align
with generated client types) and change the updated check to compare timestamps
(set isUpdated = post.updated_at !== post.created_at) so the "Updated"
badge/date only renders when updated_at differs from created_at; update any
usages that assume nullable updated_at accordingly (symbols: updated_at,
created_at, isUpdated, PostCard).
Comment on lines
+6
to
41
| export const postSchema = z | ||
| .object({ | ||
| public_id: z.uuid().openapi({ | ||
| description: "Public ID", | ||
| example: "123e4567-e89b-12d3-a456-426614174000", | ||
| }), | ||
| content: (schema) => | ||
| schema.openapi({ | ||
| content: z.string().openapi({ | ||
| description: "The content of the post", | ||
| example: "test", | ||
| }), | ||
| created_at: (schema) => | ||
| schema.openapi({ | ||
| description: "The date and time the post was created", | ||
| created_at: z.iso.datetime().openapi({ | ||
| description: "The date and time the post was originally created", | ||
| example: "2025-01-01T00:00:00Z", | ||
| format: "date-time", | ||
| }), | ||
| updated_at: (schema) => | ||
| schema.openapi({ | ||
| description: "The date and time the post was updated", | ||
| updated_at: z.iso.datetime().openapi({ | ||
| description: | ||
| "The date and time the post was created (or last updated in case of delete&insert)", | ||
| example: "2025-01-01T00:00:00Z", | ||
| format: "date-time", | ||
| }), | ||
| }) | ||
| .pick(postPublicFields) | ||
| .strict() | ||
| }) | ||
| .openapi("post"); | ||
|
|
||
| export const postWithUserSelectSchema = postSelectSchema.extend({ | ||
| user: userSelectSchema, | ||
| // DB データから API レスポンス形式への変換関数 | ||
| export const transformPost = (post: { | ||
| public_id: string; | ||
| content: string; | ||
| first_created_at: Date; | ||
| created_at: Date; | ||
| }): z.infer<typeof postSchema> => ({ | ||
| public_id: post.public_id, | ||
| content: post.content, | ||
| created_at: post.first_created_at.toISOString(), // first_created_at → created_at | ||
| updated_at: post.created_at.toISOString(), // created_at → updated_at | ||
| }); |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the file exists and examine its content
if [ -f "packages/backend_app/src/apps/posts/dto.ts" ]; then
wc -l packages/backend_app/src/apps/posts/dto.ts
echo "---"
cat -n packages/backend_app/src/apps/posts/dto.ts
else
echo "File not found. Searching for dto files..."
find . -name "dto.ts" -type f 2>/dev/null | grep -i post
fiRepository: mikan3rd/hono-next-example
Length of output: 3473
🏁 Script executed:
#!/bin/bash
# Check if zod supports nullable chaining
# Also search for any tests or usages of transformPost
rg "transformPost" --type ts --type js -A 3 -B 3Repository: mikan3rd/hono-next-example
Length of output: 3431
🏁 Script executed:
#!/bin/bash
# Look for database schema or models that define the post structure
fd -t f -e ts -e js | xargs grep -l "first_created_at\|created_at" 2>/dev/null | head -20Repository: mikan3rd/hono-next-example
Length of output: 378
🏁 Script executed:
#!/bin/bash
# Check the database schema to understand first_created_at vs created_at
cat -n packages/backend_app/src/db/schema.ts | grep -A 30 "postsTable\|first_created_at\|created_at"Repository: mikan3rd/hono-next-example
Length of output: 1160
🏁 Script executed:
#!/bin/bash
# Check test file to understand expected behavior
wc -l packages/backend_app/src/apps/posts/index.test.ts
head -100 packages/backend_app/src/apps/posts/index.test.tsRepository: mikan3rd/hono-next-example
Length of output: 3348
🏁 Script executed:
#!/bin/bash
# Check if created_at is ever explicitly set to first_created_at or if timestamps differ in practice
rg "created_at" packages/backend_app/src/apps/posts/ -A 2 -B 2 | head -40Repository: mikan3rd/hono-next-example
Length of output: 2687
🏁 Script executed:
#!/bin/bash
# Check the zod version and confirm nullable() support
cat packages/backend_app/package.json | grep -A 5 '"@hono/zod-openapi"'Repository: mikan3rd/hono-next-example
Length of output: 263
updated_at always populated; consider nullable to distinguish unedited posts.
The API currently always sets updated_at to a value, making it impossible to signal whether a post has been edited. The database design supports this distinction via first_created_at (immutable) vs created_at (updates on delete&insert pattern), but the API doesn't expose it. If the intent is to indicate "never updated," make updated_at nullable in the schema and conditionally null it when first_created_at === created_at. Note: exact timestamp comparison may be unreliable due to microsecond differences; consider row timestamp precision or an explicit edit flag if strict equality checking is needed.
🤖 Prompt for AI Agents
In `@packages/backend_app/src/apps/posts/dto.ts` around lines 6 - 41, postSchema
currently requires updated_at and transformPost always sets it, preventing
signaling "never updated"; make updated_at nullable in postSchema (allow null in
the OpenAPI schema) and update transformPost to return updated_at as null when
the post was never edited by comparing timestamps (use millisecond-safe
comparison like first_created_at.getTime() === created_at.getTime()) otherwise
return the ISO string; reference postSchema and transformPost when making these
changes and ensure the OpenAPI metadata reflects nullability.
Comment on lines
+37
to
+43
| export const postLogsTable = pgTable("post_logs", { | ||
| id: integer().primaryKey(), | ||
| public_id: uuid().notNull(), | ||
| user_id: integer().notNull(), | ||
| content: text().notNull(), | ||
| ...timestamps, | ||
| }); |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, examine the schema file to see the current state
cat -n packages/backend_app/src/db/schema.ts | head -60Repository: mikan3rd/hono-next-example
Length of output: 1529
🏁 Script executed:
# Search for insert statements related to postLogsTable
rg "postLogsTable" --type ts --context 5Repository: mikan3rd/hono-next-example
Length of output: 6302
🏁 Script executed:
# Search for any insert patterns into post_logs
rg "post_logs\|postLogsTable" --type ts -A 3 -B 3Repository: mikan3rd/hono-next-example
Length of output: 52
🏁 Script executed:
# Check if there are other table definitions to compare id generation patterns
rg "primaryKey()" --type ts -B 2 -A 2 | head -50Repository: mikan3rd/hono-next-example
Length of output: 1510
post_logs.id should be auto-generated for consistency.
Other tables use generatedAlwaysAsIdentity(), but postLogsTable requires manual ID assignment on insert. While current inserts work by copying IDs from posts, this creates inconsistency and fragility. Align with the rest of the schema.
🛠️ Suggested fix
export const postLogsTable = pgTable("post_logs", {
- id: integer().primaryKey(),
+ id: integer().primaryKey().generatedAlwaysAsIdentity(),
public_id: uuid().notNull(),
user_id: integer().notNull(),
content: text().notNull(),
...timestamps,
});📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| export const postLogsTable = pgTable("post_logs", { | |
| id: integer().primaryKey(), | |
| public_id: uuid().notNull(), | |
| user_id: integer().notNull(), | |
| content: text().notNull(), | |
| ...timestamps, | |
| }); | |
| export const postLogsTable = pgTable("post_logs", { | |
| id: integer().primaryKey().generatedAlwaysAsIdentity(), | |
| public_id: uuid().notNull(), | |
| user_id: integer().notNull(), | |
| content: text().notNull(), | |
| ...timestamps, | |
| }); |
🤖 Prompt for AI Agents
In `@packages/backend_app/src/db/schema.ts` around lines 37 - 43, The post_logs
table defines id as integer().primaryKey() but should be auto-generated like
other tables; update postLogsTable's id column to use
generatedAlwaysAsIdentity() (i.e., change id to
integer().primaryKey().generatedAlwaysAsIdentity()) so inserts no longer require
manual id assignment and align schema behavior with other tables (refer to
postLogsTable, "post_logs", and the id column).
Comment on lines
+27
to
28
| updated_at: string | null; | ||
| user: { |
There was a problem hiding this comment.
Align updated_at handling with the API contract to avoid always showing “Updated”.
The OpenAPI schema and generated client types still define updated_at as a required string, and backend tests expect it to be present. With the null check, isUpdated will always be true and the badge/date will render for every post. Either make updated_at nullable end-to-end (API + schema + responses) or keep it non-null here and compare to created_at.
🛠️ Suggested fix (keep current API contract)
- updated_at: string | null;
+ updated_at: string;- const isUpdated = post.updated_at !== null;
+ const isUpdated = post.updated_at !== post.created_at;- {post.updated_at !== null && (
+ {isUpdated && (
<span suppressHydrationWarning>
Updated: {formatDate(post.updated_at)}
</span>
)}Also applies to: 45-46, 186-189
🤖 Prompt for AI Agents
In
`@packages/frontend_app/src/components/pages/post/components/PostCard/index.tsx`
around lines 27 - 28, The code treats updated_at as nullable which makes
isUpdated truthy for every post; in the PostCard component keep updated_at as a
non-null string (remove the "| null" from the local type declaration or align
with generated client types) and change the updated check to compare timestamps
(set isUpdated = post.updated_at !== post.created_at) so the "Updated"
badge/date only renders when updated_at differs from created_at; update any
usages that assume nullable updated_at accordingly (symbols: updated_at,
created_at, isUpdated, PostCard).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #374
Summary by CodeRabbit
Release Notes
New Features
Improvements
API Changes
✏️ Tip: You can customize this high-level summary in your review settings.