Datastore contains predicate typescript operand is never

ShreyasBhandari commented 3 years ago

Before opening, please confirm:

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

JavaScript Framework

React

Amplify APIs

Authentication, GraphQL API, DataStore, Storage

Amplify Categories

No response

Environment information

``` # Put output below this line System: OS: macOS 11.5.1 CPU: (4) x64 Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz Memory: 468.38 MB / 8.00 GB Shell: 5.8 - /bin/zsh Binaries: Node: 12.16.3 - /usr/local/bin/node npm: 6.14.4 - /usr/local/bin/npm Browsers: Chrome: 94.0.4606.81 Safari: 14.1.2 npmPackages: @aws-amplify/api: ^3.3.3 => 3.3.3 @aws-amplify/auth: ^3.4.34 => 3.4.34 @aws-amplify/core: ^3.8.24 => 3.8.24 @aws-amplify/datastore: ^2.10.1 => 2.10.1 @aws-amplify/storage: ^3.4.4 => 3.4.4 @craco/craco: ^6.2.0 => 6.2.0 @date-io/date-fns: ^1.3.13 => 1.3.13 @emotion/css: ^11.1.3 => 11.1.3 (10.0.27) @hookform/devtools: ^2.2.1 => 2.2.1 @hookform/error-message: 0.0.5 => 0.0.5 @material-ui/core: ^4.11.4 => 4.12.3 @material-ui/icons: ^4.9.1 => 4.11.2 @material-ui/lab: ^4.0.0-alpha.58 => 4.0.0-alpha.60 @material-ui/pickers: ^3.3.10 => 3.3.10 @react-pdf/renderer: ^1.6.13 => 1.6.16 @reduxjs/toolkit: ^1.5.1 => 1.6.1 @reduxjs/toolkit-query: 1.0.0 @reduxjs/toolkit-query-react: 1.0.0 @sentry/react: ^6.13.3 => 6.13.3 @testing-library/jest-dom: ^5.12.0 => 5.14.1 @testing-library/react: ^11.2.7 => 11.2.7 @testing-library/user-event: ^12.6.0 => 12.8.3 @types/file-saver: ^2.0.3 => 2.0.3 @types/jest: ^26.0.24 => 26.0.24 @types/lodash: ^4.14.172 => 4.14.172 @types/node: ^16.4.7 => 16.9.0 @types/react: ^17.0.15 => 17.0.20 @types/react-dom: ^17.0.9 => 17.0.9 @types/react-virtualized: ^9.21.12 => 9.21.13 @typescript-eslint/eslint-plugin: ^4.24.0 => 4.31.0 @typescript-eslint/parser: ^4.24.0 => 4.31.0 aws-amplify: ^3.4.3 => 3.4.3 babel-eslint: ^10.1.0 => 10.1.0 clsx: ^1.1.1 => 1.1.1 craco-alias: ^3.0.1 => 3.0.1 date-fns: ^2.23.0 => 2.23.0 dayjs: ^1.10.3 => 1.10.6 eslint: ^7.26.0 => 7.32.0 eslint-config-react-app: ^6.0.0 => 6.0.0 eslint-plugin-flowtype: ^5.7.2 => 5.9.2 eslint-plugin-import: ^2.23.2 => 2.24.2 eslint-plugin-jsx-a11y: ^6.4.1 => 6.4.1 eslint-plugin-react: ^7.22.0 => 7.25.1 eslint-plugin-react-hooks: ^4.2.0 => 4.2.0 eslint-plugin-testing-library: ^4.10.1 => 4.12.2 (3.10.2) file-saver: ^2.0.5 => 2.0.5 fontsource-roboto: ^3.0.3 => 3.1.5 history: ^5.0.0 => 5.0.1 husky: ^4.3.8 => 4.3.8 i18next: ^19.8.4 => 19.9.2 i18next-browser-languagedetector: ^6.1.1 => 6.1.2 i18next-http-backend: ^1.2.4 => 1.3.1 lint-staged: ^10.5.4 => 10.5.4 lodash: ^4.17.21 => 4.17.21 logrocket: ^1.3.0 => 1.3.0 material-ui-dropzone: ^3.5.0 => 3.5.0 prettier: ^2.3.0 => 2.4.0 react: ^17.0.1 => 17.0.2 react-contextmenu: ^2.14.0 => 2.14.0 react-csv: ^2.0.3 => 2.0.3 react-data-grid: 7.0.0-beta.0 => 7.0.0-beta.0 react-data-grid-addons: ^7.0.0-alpha.24 => 7.0.0-alpha.24 react-date-picker: ^8.2.0 => 8.3.2 react-dom: ^17.0.1 => 17.0.2 react-error-boundary: ^3.1.3 => 3.1.3 react-hook-form: ^6.15.7 => 6.15.8 react-i18next: ^11.8.15 => 11.12.0 react-infinite-scroll-component: ^5.1.0 => 5.1.0 react-redux: ^7.2.4 => 7.2.5 react-router: ^6.0.0-beta.0 => 6.0.0-beta.3 react-router-dom: ^6.0.0-beta.0 => 6.0.0-beta.3 react-scripts: 4.0.1 => 4.0.1 react-toastify: ^7.0.4 => 7.0.4 react-virtualized: ^9.22.2 => 9.22.3 redux: ^4.1.0 => 4.1.1 (3.7.2) typescript: ^4.3.5 => 4.4.2 web-vitals: ^0.2.4 => 0.2.4 workbox-background-sync: ^5.1.4 => 5.1.4 workbox-broadcast-update: ^5.1.4 => 5.1.4 workbox-cacheable-response: ^5.1.4 => 5.1.4 workbox-core: ^5.1.4 => 5.1.4 workbox-expiration: ^5.1.4 => 5.1.4 workbox-google-analytics: ^5.1.4 => 5.1.4 workbox-navigation-preload: ^5.1.4 => 5.1.4 workbox-precaching: ^5.1.4 => 5.1.4 workbox-range-requests: ^5.1.4 => 5.1.4 workbox-routing: ^5.1.4 => 5.1.4 workbox-strategies: ^5.1.4 => 5.1.4 workbox-streams: ^5.1.4 => 5.1.4 npmGlobalPackages: @aws-amplify/cli: 5.5.0 modernizr: 3.11.3 netlify-cli: 2.59.1 nodemon: 2.0.4 npm: 6.14.4 ```

Describe the bug

Trying to query using datastore, using the contains predicate to find specific ids in an array, however typescript throws an error that expected operand is 'never'

Expected behavior

Expecting the query to accept a string as the operand, and fetch the results

Reproduction steps

Create a model Quote with a field(offlineIds) with array of ids
Use datastore to query the model Quote where you check if field offlineIds contains a particular id

Code Snippet

// Put your code below this line.
export const getOfflineQuotes = createAsyncThunk<
  ReduxQuote,
  { userId: string },
  {
    state: RootState
    rejectValue: string
  }
>('quote/getOfflineQuotes', async ({ userId }, { getState, rejectWithValue }) => {
  try {
    const { auth } = getState()
    let quoteDetails
    try {
      quoteDetails = await DataStore.query(Quote, item =>
        item.offlineIds('contains', userId).activeFlag('eq', true)
      )
    } catch (err) {
      console.log(err)
    }
    const parsedQuote = JSON.parse(JSON.stringify(quoteDetails))
    const accessibleQuote: ReduxQuote = checkIfQuoteIsAccessible(auth.userInfo, parsedQuote[0])
    if (accessibleQuote) {
      return accessibleQuote as ReduxQuote
    } else {
      makeErrorToast(msg)
      return rejectWithValue('Error Fetching Quote')
    }
  } catch (err: any) {
    makeErrorToast(msg)
    return rejectWithValue(err)
  }
})

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

alharris-at commented 2 years ago

I've reproduced this issue with the following graphQL Schema:

# This "input" configures a global authorization rule to enable public access to
# all models in this schema. Learn more about authorization rules here: https://docs.amplify.aws/cli/graphql/authorization-rules
input AMPLIFY { globalAuthRule: AuthRule = { allow: public } } # FOR TESTING ONLY!

type Todo @model {
  id: ID!
  listOfIds1: [String]
  listOfIds2: [String]!
  listOfIds3: [String!]
  listOfIds4: [String!]!
}

import { DataStore } from "aws-amplify";
import { Todo } from "./models";

const loadRecords = async () => {
  await DataStore.query(Todo, item => item
    .listOfIds1('contains', 'hi there')
    .listOfIds2('contains', 'hi there')
    .listOfIds3('contains', 'hi there')
    .listOfIds4('contains', 'hi there')
  );
};

The .listOfIds1 and .listOfIds2 do trigger a Argument of type 'string' is not assignable to parameter of type 'never'.ts(2345) error.

dpilch commented 1 year ago

This is no longer an issue with the new predicate syntax.

aws-amplify / amplify-js