Skip to content

Add model name and raw data info to diagnostic errors #1846

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.

Sign up for GitHub

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

Open
pranavbabu wants to merge 2 commits into
base: master
Choose a base branch
from
+20 −0
Open

Add model name and raw data info to diagnostic errors #1846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27f533d
Add model name and raw data info to errors
Oct 21, 2024
4244056
Use verbose flag to show diagnostic errors with model name and record…
Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/Model/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@ export default class Model {
* @see {Database#batch}
*/
prepareUpdate(recordUpdater: (this) => void = noop): this {
this.__debugInvariant(
!this._preparedState,
`Model ${this.constructor.name}, Raw Data: ${JSON.stringify(this._raw)}`,
)
invariant(
!this._preparedState,
`Cannot update a record with pending changes (${this.__debugName})`,
Expand Down Expand Up @@ -182,6 +186,7 @@ export default class Model {
* @see {Database#batch}
*/
prepareMarkAsDeleted(): this {
this.__debugInvariant(!this._preparedState, `Model ${this.constructor.name}, Raw Data: ${JSON.stringify(this._raw)}`)
invariant(
!this._preparedState,
`Cannot mark a record with pending changes as deleted (${this.__debugName})`,
Expand Down Expand Up @@ -217,6 +222,7 @@ export default class Model {
* @see {Database#batch}
*/
prepareDestroyPermanently(): this {
this.__debugInvariant(!this._preparedState, `Model ${this.constructor.name}, Raw Data: ${JSON.stringify(this._raw)}`)
invariant(
!this._preparedState,
`Cannot destroy permanently record with pending changes (${this.__debugName})`,
Expand Down Expand Up @@ -485,4 +491,10 @@ export default class Model {
logger.debug(`${debugName}: ${this.__debugName}`)
}
}

__debugInvariant(condition: boolean, errorMessage: string): void {
if (this.db.experimentalIsVerbose && !condition) {
logger.debug(errorMessage)
}
}
}
8 changes: 8 additions & 0 deletions src/Model/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { field, date, readonly } from '../decorators'
import { noop } from '../utils/fp'
import sortBy from '../utils/fp/sortBy'
import { sanitizedRaw } from '../RawRecord'
import { logger } from '../utils/common'

import Model from './index'
import { fetchDescendants } from './helpers'
Expand Down Expand Up @@ -419,6 +420,9 @@ describe('Safety features', () => {
})
it('disallows operations on uncommited records', async () => {
const db = makeDatabase()
const spy = jest.spyOn(logger, 'debug')
db.experimentalIsVerbose = true

db.adapter.batch = jest.fn()
await db.write(async () => {
const model = MockModel._prepareCreate(db.get('mock'), () => {})
Expand All @@ -428,8 +432,12 @@ describe('Safety features', () => {
model.update(() => {}),
'with pending changes',
)
expect(spy).toHaveBeenCalledWith(expect.stringMatching('Model MockModel, Raw Data: {'))

await expectToRejectWithMessage(model.markAsDeleted(), 'with pending changes')

await expectToRejectWithMessage(model.destroyPermanently(), 'with pending changes')

expect(() => model.observe()).toThrow('uncommitted')
await db.batch(model)
})
Expand Down