Mvom increment #750

philfuster · 2024-08-05T23:31:24Z

Summary

This PR implements the new increment operation.

TypeScript Changes

Created Input and Output types for new increment operation
Created async static method increment on dynamically generated Model class via compileModel.
Created transformPathToOrdinalPosition to transform an increment operation input key path to its ordinal position.
Updated Connection to handle new RecordNotFoundError.

UniBasic Changes

Created unibasicTemplate - increment.njk
- validates increment operation input
- Has a read lock loop to handle locked records.
  - sleeps according to the passed in retry delay.
  - returns RecordLockedError when retry max is exceeded
- returns new RecordNotFoundError error when else statement executes on readu.
- writes record after performing incrementing.
- returns the updated document

Testing Notes

Ran tests using MVOM:

incrementing a record that does not exist - received RecordNotFoundError
incrementing one field - field was incremented, updated document returned
incremented multiple fields - fields were incremented, updated document returned
incremented nested field - nested field was incremented, updated document returned
incremented value position - value position was incremented
incremented multiple value positions - value positions were incremented
incremented sub value positions - sub value positions were incremented
incremented while record was locked - retries were performed - RecordLockedError returned.

shawnmcknight

I've finished a first pass review and left several comments. Overall this looks good, but I had suggestions for improvement.

src/compileModel.ts

src/types/DbSubroutineOutput.ts

src/compileModel.ts

src/unibasicTemplates/subroutines/external/increment.njk

src/Schema.ts

philfuster · 2024-08-06T20:16:21Z

I've finished a first pass review and left several comments. Overall this looks good, but I had suggestions for improvement.

@shawnmcknight Thank you for your review. I have addressed your feedback in the latest series of commits. This is ready for another look.

switching to setting up the TS code so I can deploy and test.

… compileModel. Wrote tests.

Update tests.

…on the paths.

- remove unnecessary continue - fixed indentation in increment and save when creating null projection - added pattern match test

…ill not return null data. update the DbSubroutineOutputIncrement type. update tests.

…ccept the key paths. Throw an error when invalid path encountered and when paths length is 0 because returning anything else would result in bad data when the U2 code processes the paths. Consolidate buildOrdinalPaths within transformPathsToOrdinalPositions by making the logic simpler. Update tests

…ition. Its only use was for transforming a single path so no point in having it work for multiple and having to work around that. Updated tests accordingly. Updated compileModel to use it as necessary

shawnmcknight

Looks good. Just a few minor comments left.

src/Schema.ts

src/unibasicTemplates/subroutines/external/increment.njk

src/compileModel.ts

src/__tests__/Schema.test.ts

…ll assertion and checking for null.

…ansformPathToOrdinalPosition path parameter.

…Schema.transformPathToOrdinalPosition path parameter.

…ean check as it should be.

shawnmcknight

LGTM!

philfuster marked this pull request as draft August 5, 2024 23:31

philfuster requested a review from shawnmcknight August 5, 2024 23:38

philfuster assigned shawnmcknight Aug 5, 2024

philfuster marked this pull request as ready for review August 5, 2024 23:39

shawnmcknight requested changes Aug 6, 2024

View reviewed changes

philfuster force-pushed the mvom_increment branch 3 times, most recently from 418e62c to 752c858 Compare August 6, 2024 20:04

philfuster requested a review from shawnmcknight August 6, 2024 20:15

philfuster force-pushed the mvom_increment branch from a9ab65a to f85d958 Compare August 6, 2024 20:17

philfuster added 19 commits August 6, 2024 16:17

WIP. increment unibasic subroutine.

4d1ac6f

added to the loop read lock a bit.

44df676

switching to setting up the TS code so I can deploy and test.

add increment DbSubroutineInput and DbSubroutineOutput

086063d

implement Schema.transformToordinalPositions and write tests for it.

4e86900

Add increment static method to the dynamic Model class generated by…

8dffce0

… compileModel. Wrote tests.

Update Connection to handle new RecordNotFoundError.

0177849

Update tests.

working on increment. hoping this looks good lol

e3b6084

include increment in main so the code can get deployed.

1e7e2af

include status.njk for values of status()

3915c34

fix broken test

f152f64

remove un-intended change.

86bf6a8

update js doc

2287242

Export IncrementOperation for use by consumers to ensure type safety …

2f68ff2

…on the paths.

export RecordNotFoundError

759e144

ensure sentence casing on all js-doc comments.

6dd259f

- changed to closeReleaseAndReturnFromSub in else during readu

5907f1d

- remove unnecessary continue - fixed indentation in increment and save when creating null projection - added pattern match test

no longer throw error when data.result is null because the unibasic w…

96a28bc

…ill not return null data. update the DbSubroutineOutputIncrement type. update tests.

changed transformPathsToOrdinalPositions to transformPathToOrdinalPos…

c662c83

…ition. Its only use was for transforming a single path so no point in having it work for multiple and having to work around that. Updated tests accordingly. Updated compileModel to use it as necessary

remove unnecessary comment.

f85d958

shawnmcknight requested changes Aug 6, 2024

View reviewed changes

philfuster added 5 commits August 6, 2024 18:04

remove has an non-null assertion in favor of using get without non-nu…

b5bc91c

…ll assertion and checking for null.

update InferSchemaPaths with Extract<type, string> and remove from tr…

64a2af5

…ansformPathToOrdinalPosition path parameter.

update test description to match the test contents.

7dd46cf

add Extract to IncrementOperation type to match the signature of the …

006c28c

…Schema.transformPathToOrdinalPosition path parameter.

update pattern match check for path to be a 1 liner and resemble bool…

800ec25

…ean check as it should be.

philfuster requested a review from shawnmcknight August 6, 2024 22:28

shawnmcknight approved these changes Aug 6, 2024

View reviewed changes

shawnmcknight merged commit d035344 into main Aug 6, 2024
4 checks passed

shawnmcknight deleted the mvom_increment branch August 6, 2024 22:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mvom increment #750

Mvom increment #750

philfuster commented Aug 5, 2024 •

edited

Loading

shawnmcknight left a comment

philfuster commented Aug 6, 2024

shawnmcknight left a comment

shawnmcknight left a comment

Mvom increment #750

Mvom increment #750

Conversation

philfuster commented Aug 5, 2024 • edited Loading

Summary

TypeScript Changes

UniBasic Changes

Testing Notes

shawnmcknight left a comment

Choose a reason for hiding this comment

philfuster commented Aug 6, 2024

shawnmcknight left a comment

Choose a reason for hiding this comment

shawnmcknight left a comment

Choose a reason for hiding this comment

philfuster commented Aug 5, 2024 •

edited

Loading