-
Notifications
You must be signed in to change notification settings - Fork 3.8k
refactor(audit): derive updatedFields through one shared helper #6604
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| export { recordAudit, recordAuditBatch } from './log' | ||
| export type { AuditActionType, AuditResourceTypeValue } from './types' | ||
| export { AuditAction, AuditResourceType } from './types' | ||
| export { auditUpdatedFields } from './updated-fields' | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import { auditMock } from '@sim/testing' | ||
| import { describe, expect, it } from 'vitest' | ||
| import { auditUpdatedFields } from './updated-fields' | ||
|
|
||
| describe('auditUpdatedFields', () => { | ||
| it('returns the written columns', () => { | ||
| expect(auditUpdatedFields({ name: 'Renamed', url: 'https://example.com' })).toEqual([ | ||
| 'name', | ||
| 'url', | ||
| ]) | ||
| }) | ||
|
|
||
| it('drops updatedAt, which every write moves', () => { | ||
| expect(auditUpdatedFields({ name: 'Renamed', updatedAt: new Date() })).toEqual(['name']) | ||
| }) | ||
|
|
||
| it('keeps columns explicitly written as null — clearing a value is a change', () => { | ||
| expect(auditUpdatedFields({ lastConnected: null, lastError: null })).toEqual([ | ||
| 'lastConnected', | ||
| 'lastError', | ||
| ]) | ||
| }) | ||
|
|
||
| it('returns an empty list when only updatedAt was written', () => { | ||
| expect(auditUpdatedFields({ updatedAt: new Date() })).toEqual([]) | ||
| }) | ||
|
|
||
| /** | ||
| * `auditMock` carries its own copy because `@sim/audit` devDepends on | ||
| * `@sim/testing` — importing the real helper there would close a package | ||
| * cycle. The copy is pinned from this side instead, where the dependency | ||
| * already runs the safe direction. | ||
| */ | ||
| it('stays in step with the copy @sim/testing hands to mocked callers', () => { | ||
| const cases: object[] = [ | ||
| { name: 'Renamed', url: 'https://example.com' }, | ||
| { name: 'Renamed', updatedAt: new Date() }, | ||
| { lastConnected: null, lastError: null }, | ||
| { updatedAt: new Date() }, | ||
| {}, | ||
| ] | ||
| for (const updateValues of cases) { | ||
| expect(auditMock.auditUpdatedFields(updateValues)).toEqual(auditUpdatedFields(updateValues)) | ||
| } | ||
| }) | ||
| }) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| /** | ||
| * Columns a write touched, ready for an audit row's `updatedFields` metadata. | ||
| * | ||
| * Pass the update object the write actually applied — never the caller's | ||
| * params. A param is not a write: an unchanged value still arrives, and a | ||
| * writer often sets columns nobody asked for (a status reset forced by some | ||
| * other change). Deriving names from input is what makes audit rows name fields | ||
| * that were never written and omit the ones that were. | ||
| * | ||
| * `updatedAt` is excluded because every write moves it, so it is noise in every | ||
| * row. Keeping that rule here means it is one edit if the set ever grows. | ||
| */ | ||
| export function auditUpdatedFields(updateValues: object): string[] { | ||
| return Object.keys(updateValues).filter((key) => key !== 'updatedAt') | ||
| } |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.