DataStore error when deleting optional @hasOne relationship when empty

[mmoulton]

Before opening, please confirm:

• I have searched for duplicate or closed issues and discussions.
• I have read the guide for submitting bug reports.
• I have done my best to include a minimal, self-contained set of instructions for consistently reproducing the issue.

JavaScript Framework

React

Amplify APIs

DataStore

Amplify Categories

No response

Environment information

# Put output below this line
  System:
    OS: macOS 12.6
    CPU: (10) arm64 Apple M1 Max
    Memory: 274.03 MB / 64.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 14.18.2 - ~/.nvm/versions/node/v14.18.2/bin/node
    Yarn: 1.22.1 - /opt/homebrew/bin/yarn
    npm: 8.19.2 - ~/.nvm/versions/node/v14.18.2/bin/npm
  Browsers:
    Chrome: 107.0.5304.110
    Firefox: 94.0.2
    Safari: 16.0
  npmPackages:
    aws-amplify: ^4.3.43 => 4.3.43 
    typescript: ^4.5.5 => 4.7.4 (3.9.10, 4.4.4)
  npmGlobalPackages:
    @aws-amplify/cli: 8.5.1

Describe the bug

DataStore is throwing Failed to execute 'get' on 'IDBIndex': The parameter is not a valid key. when attempting to delete a model that contains a @hasOne relationship that is optional and that relationship is not set on the model being removed.

The original error starts here:

amplify-js/packages/datastore/src/storage/adapter/IndexedDBAdapter.ts

Line 911 in b3c507f

.get(this.canonicalKeyPath(values))

However I traced the root of the issue to this block here:

amplify-js/packages/datastore/src/storage/adapter/IndexedDBAdapter.ts

Lines 889 to 890 in b3c507f

	const value = model[targetName];
	values = [value];

It seems that when the relationship is not defined value will be null, making values equal [null].

This is a problem for the break condition defined here:

amplify-js/packages/datastore/src/storage/adapter/IndexedDBAdapter.ts

Line 904 in b3c507f

if (!values || !index) break;

Since values being [null] will not satisfy this condition, as it should.

Expected behavior

To be able to delete models with @hasOne relationships.

Reproduction steps

1. Define a model with a @hasOne relationship to another model where the relationship is not required.
2. Create a now instance of the 'parent' model.
3. Attempt to delete the 'parent' model.

Code Snippet

// Put your code below this line.

Log output

// Put your logs below this line

aws-exports.js

No response

Manual configuration

No response

Additional configuration

No response

Mobile Device

No response

Mobile Operating System

No response

Mobile Browser

No response

Mobile Browser Version

No response

Additional information and screenshots

No response

[dpilch]

I was able to reproduce. Investigating a fix.

[dpilch]

A patch was released in V5. Please upgrade to aws-amplify@5.0.3 or downgrade to aws-amplify@4.3.37. The patch will be backported to V4 in the next few days.

[chrisbonifacio]

@mmoulton closing this as fixed. Please upgrade and let us know if this is resolved on your end afterwards. Thank you!