Skip to content
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

fix: PubSub - Resolve ts strict errors in the AWSAppSyncRealTimeProvider #9731

Conversation

stocaaro
Copy link
Member

Description of changes

Using a tsconfig.json set to strict as a guide, resolve all errors found in pubsub/src/Providers/AWSAppSyncRealTimeProvider.ts.

Change includes a deprecation annotation for a constant that should have been included in the prior change.

Description of how you validated changes

yarn test is passing without issues

Manual testing exercising features in:

  • React app with IoT integration
  • React app with DataStore syncing over AppSync

Checklist

  • PR description included
  • yarn test passes
  • Tests apps manually test

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link
Contributor

@jamesaucode jamesaucode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall, just have a few questions 😄

@codecov-commenter
Copy link

codecov-commenter commented Mar 29, 2022

Codecov Report

Merging #9731 (0ee8236) into main (f50bd68) will decrease coverage by 0.09%.
The diff coverage is 9.00%.

@@            Coverage Diff             @@
##             main    #9731      +/-   ##
==========================================
- Coverage   78.91%   78.81%   -0.10%     
==========================================
  Files         252      252              
  Lines       18653    18676      +23     
  Branches     4018     4036      +18     
==========================================
  Hits        14720    14720              
- Misses       3801     3824      +23     
  Partials      132      132              
Impacted Files Coverage Δ
packages/core/src/constants.ts 100.00% <ø> (ø)
...pubsub/src/Providers/AWSAppSyncRealTimeProvider.ts 18.65% <9.00%> (-1.19%) ⬇️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@stocaaro stocaaro requested a review from iartemiev as a code owner April 5, 2022 16:40
Copy link
Contributor

@jamesaucode jamesaucode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more comment otherwise LGTM 😃

const handler = headerHandler[authenticationType];

if (typeof handler !== 'function') {
if (!authenticationType || !headerHandler[authenticationType]) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think maybe we can have 2 different debug statements here, one for authenticationType and then one for headerHandler[authenticationType]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, you're right that if authenticationType is null, we will under-log whats going on and this should be handled better. Will take a look.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going back and forth on this one. On one hand not providing an authenticationType is different than providing an auth type that doesn't map to one of our auth functions. Typing the input would make providing an incorrect auth function name, its optional, so it could be undefined and in the current implementation, I believe this is the only corner case you can get to in TS without overriding a string to tell ts that its one of the valid inputs.

Right now, we would log either:

Authentication type undefined not supported

or

Authentication type invalid_option not supported

Which seems clear enough to me. As a user with missing or incorrect auth type information, what logged output would you prefer to see to guide you to fixing your problem?

While working through this, I was bothered that the function type on our function map had any for the values, so I have narrowed that to specify what we know about them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that I look at it again I think Authentication type undefined not supported is clear enough to me. Another option which will make the code a bit more verbose will be to have a separate if to handle the case where authenticationType is undefined, logging something like authenticationType must be defined.

Copy link
Contributor

@elorzafe elorzafe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @stocaaro

I just have one minor issue to fix on that err['message']

const handler = headerHandler[authenticationType];

if (typeof handler !== 'function') {
if (!authenticationType || !headerHandler[authenticationType]) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, you're right that if authenticationType is null, we will under-log whats going on and this should be handled better. Will take a look.

@lgtm-com
Copy link

lgtm-com bot commented Apr 6, 2022

This pull request introduces 1 alert when merging 8a66730 into eaaa2c4 - view on LGTM.com

new alerts:

  • 1 for Ineffective parameter type

Copy link
Contributor

@elorzafe elorzafe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @stocaaro 🌮

@lgtm-com
Copy link

lgtm-com bot commented Apr 6, 2022

This pull request introduces 1 alert when merging eec19bb into eaaa2c4 - view on LGTM.com

new alerts:

  • 1 for Ineffective parameter type

@lgtm-com
Copy link

lgtm-com bot commented Apr 6, 2022

This pull request introduces 1 alert when merging 0ee8236 into f50bd68 - view on LGTM.com

new alerts:

  • 1 for Ineffective parameter type

@jamesaucode
Copy link
Contributor

Dont think the authenticationType thing is blocking, LGTM 🎉 !

@stocaaro stocaaro merged commit 0c9c401 into aws-amplify:main Apr 6, 2022
svidgen added a commit that referenced this pull request Apr 20, 2022
* chore(amazon-cognito-identity-js): Relicense to Apache-2.0 (#9632)

* chore(amazon-cognito-identity-js): 3p licenses

Clarified third-party licenses in amazon-cognito-identity-js

* chore(amazon-cognito-identity-js): relicense

Relicensed amazon-cognito-identity-js from the proprietary Amazon
Software License (AmzSL) to the open source Apache License 2.0,
consistent with the rest of the Amplify for JavaScript project.

* ci: update cypress docker image for firefox (#9676)

* fix(@aws-amplify/auth): Invalid session cleanup (#9628)

Co-authored-by: Francisco Rodriguez <elorzafe@amazon.com>

* refactor(amplify-js/scripts): replace npm-exec alias with npx, move watchman cmd into the script and remove unnecessary steps in the contribution guide (#9579)

* refactor: replace npm-exec with npx and remove step 2 in guide

* refactor: remove commented code

* refactor: grammar correction

* refactor: move watchman command into the script and update guide

* typo

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* expanding the link to more words

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* rephrasing

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* Added a note on having watchman installed

* removes conflicts

* rephrases the note

Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

Co-authored-by: Manoj NB <manojnb@amazon.com>
Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>

* chore: preparing release

* chore(release): Publish [ci skip]

 - amazon-cognito-identity-js@5.2.8
 - @aws-amplify/ui-angular@1.0.43
 - @aws-amplify/ui-components@1.9.14
 - @aws-amplify/ui-react@1.2.34
 - @aws-amplify/ui-storybook@2.0.34
 - @aws-amplify/ui-vue@1.1.28
 - @aws-amplify/analytics@5.2.1
 - @aws-amplify/api-graphql@2.2.23
 - @aws-amplify/api-rest@2.0.34
 - @aws-amplify/api@4.0.34
 - @aws-amplify/auth@4.4.3
 - aws-amplify-angular@6.0.34
 - aws-amplify-react@5.1.17
 - aws-amplify@4.3.16
 - @aws-amplify/cache@4.0.36
 - @aws-amplify/core@4.4.1
 - @aws-amplify/datastore-storage-adapter@1.2.8
 - @aws-amplify/datastore@3.7.8
 - @aws-amplify/geo@1.2.2
 - @aws-amplify/interactions@4.0.34
 - @aws-amplify/predictions@4.0.34
 - @aws-amplify/pubsub@4.2.10
 - @aws-amplify/pushnotification@4.3.13
 - @aws-amplify/storage@4.4.17
 - @aws-amplify/xr@3.0.34

* chore(release): update version.ts [ci skip]

* chore(data): update API docs (#9690)

* fix(pushnotification/android): return just the error message rather than the whole exception (#9641)

Co-authored-by: Manoj NB <manojnb@amazon.com>
Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* fix(@aws-amplify/datastore): fix mutations to retry indefinitely on network error (#9724)

* Use custom retry strategy in outbox processing

- Export `jitteredBackoff` from core
- Define custom strategy extending `jitteredBackoff` that retries indefinitely for network errors

* typo fix, testing for safe jittered backoff

* updated axios packet loss test

* Update packages/datastore/src/sync/processors/mutation.ts

Co-authored-by: Manuel Iglesias <6154160+manueliglesias@users.noreply.github.com>

* updated 20500 literal to show the math

Co-authored-by: Manuel Iglesias <6154160+manueliglesias@users.noreply.github.com>

* chore: preparing release

* chore(release): Publish [ci skip]

 - @aws-amplify/ui-angular@1.0.44
 - @aws-amplify/ui-components@1.9.15
 - @aws-amplify/ui-react@1.2.35
 - @aws-amplify/ui-storybook@2.0.35
 - @aws-amplify/ui-vue@1.1.29
 - @aws-amplify/analytics@5.2.2
 - @aws-amplify/api-graphql@2.2.24
 - @aws-amplify/api-rest@2.0.35
 - @aws-amplify/api@4.0.35
 - @aws-amplify/auth@4.4.4
 - aws-amplify-angular@6.0.35
 - aws-amplify-react@5.1.18
 - aws-amplify@4.3.17
 - @aws-amplify/cache@4.0.37
 - @aws-amplify/core@4.4.2
 - @aws-amplify/datastore-storage-adapter@1.2.9
 - @aws-amplify/datastore@3.7.9
 - @aws-amplify/geo@1.2.3
 - @aws-amplify/interactions@4.0.35
 - @aws-amplify/predictions@4.0.35
 - @aws-amplify/pubsub@4.2.11
 - @aws-amplify/pushnotification@4.3.14
 - @aws-amplify/storage@4.4.18
 - @aws-amplify/xr@3.0.35

* chore(release): update version.ts [ci skip]

* fix(storage): axios handler error handling fix (#9587)

* feat: PubSub Add Options objects for all Providers and fix: Spelling error and deprecation of old exports (#9683)

* fix: Spelling error and add deprecation warnings to deprecated interfaces

* feat: PubSub - Add options extensions for each provider

* fix(withAuthenticator): RN Set default usernameAttributes to username and autofill the username in ConfirmSignUp Page. (#9723)

* Set default usernameAttributes to username and autofill the username in ConfirmSignUp page

* Set default usernameAttributes in the Authenticator Component

Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* fix: upgrade CircleCI Cypress image to 12.22.8 (#9744)

* chore: preparing release

* chore(release): Publish [ci skip]

 - @aws-amplify/ui-angular@1.0.45
 - @aws-amplify/ui-components@1.9.16
 - @aws-amplify/ui-react@1.2.36
 - @aws-amplify/ui-storybook@2.0.36
 - @aws-amplify/ui-vue@1.1.30
 - @aws-amplify/analytics@5.2.3
 - @aws-amplify/api-graphql@2.3.0
 - @aws-amplify/api-rest@2.0.36
 - @aws-amplify/api@4.0.36
 - @aws-amplify/auth@4.5.0
 - aws-amplify-angular@6.0.36
 - aws-amplify-react-native@6.0.4
 - aws-amplify-react@5.1.19
 - aws-amplify@4.3.18
 - @aws-amplify/cache@4.0.38
 - @aws-amplify/core@4.5.0
 - @aws-amplify/datastore-storage-adapter@1.2.10
 - @aws-amplify/datastore@3.8.0
 - @aws-amplify/geo@1.2.4
 - @aws-amplify/interactions@4.0.36
 - @aws-amplify/predictions@4.0.36
 - @aws-amplify/pubsub@4.3.0
 - @aws-amplify/pushnotification@4.3.15
 - @aws-amplify/storage@4.4.19
 - @aws-amplify/xr@3.0.36

* chore(release): update version.ts [ci skip]

* feat: update DataStore observe / observeQuery to return all fields in local update snapshot (#9556)

* address PR feedback

* test(DataStore): add observe unit tests

Co-authored-by: Jon Wire <iambipedal@gmail.com>

* update types for internal / external subscription messages; minor update to datastore 'observe'

* chore(data): format DataStore with Prettier

* Revert "feat(@aws-amplify/geo): searchForSuggestions API (#9516)" (#9747)

This reverts commit bb60060.

* chore: update .github/CODEOWNERS (#9740)

Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* fix: upgraded commonmarker in Gemfile (#9692)

* upgraded commonmarker

* after running yarn docs

* Revert "after running yarn docs"

This reverts commit e8c813c.

Co-authored-by: David McAfee <mcafd@amazon.com>

* feat(@aws-amplify/geo): add geofence APIs (#9743)

* feat(@aws-amplify/geo): add geofence APIs (#9278)

* feat(@aws-amplify/geo): verify coordinates

* chore(@aws-amplify/geo): remove unused file

* feat(@aws-amplify/geo): add initial types for geofences

* chore(@aws-amplify/geo): add types and validation utils

* feat(@aws-amplify/geo): add createGeofence to provider

* feat(@aws-amplify/geo): add createGeofence to Geo

* fix(@aws-amplify/geo): remove bad import

* fix(@aws-amplify/geo): update jsdoc on createGeofence

Co-authored-by: Amplifiyer <51211245+Amplifiyer@users.noreply.github.com>

* fix(@aws-amplify/geo): update jsdoc on createGeofence in provider

Co-authored-by: Amplifiyer <51211245+Amplifiyer@users.noreply.github.com>

* fix(@aws-amplify/geo): update error message for bad polygon

Co-authored-by: Amplifiyer <51211245+Amplifiyer@users.noreply.github.com>

* fix(@aws-amplify/geo): first update from PR comments

* fix(@aws-amplify/geo): update #2 from PR comments

* fix(@aws-amplify/geo): update types and batch calls

* Update packages/geo/src/types/Geo.ts

Co-authored-by: Amplifiyer <51211245+Amplifiyer@users.noreply.github.com>

* fix(geo): update types from PR feedback

* chore(geo): add error handling on failed API call

* test(geo): add test for batch API calls

* test(geo): add test for bad api call in createGeofences

feat(geo): add getGeofence api (#9309)

* feat(@aws-amplify/geo): verify coordinates

* chore(@aws-amplify/geo): add types and validation utils

* feat(@aws-amplify/geo): add createGeofence to provider

* feat(@aws-amplify/geo): add createGeofence to provider

* feat(geo): add getGeofence api

* chore(geo): combine some try/catch blocks

* chore(geo): add > to jsdoc comment

feat(geo): add listGeofences api (#9310)

feat(geo): add updateGeofences api (#9312)

* feat(geo): add listGeofences api

* feat(geo): add initial updateGeofences api

* refactor(geo): optimize _batchPutGeofence function

feat(geo): add deleteGeofences api (#9314)

* feat(@aws-amplify/geo): verify coordinates

* feat(geo): batch deleteGeofences call

* chore(geo): fix issue with response

refactor(geo): update loggers and remove unused code

refactor(geo): create/updateGeofences => saveGeofences

chore(geo): split out testData and testFunctions

* fix(geo): update validations and error messages (#9670)

* chore(geo): remove unused `logger` function

* fix(geo): update validation error messages

* fix(geo): add validation for empty input arrays

* fix(geo): polygon if statement and nits

* fix(geo): get rid of that really bad extra space in comment

* fix(geo): fix nextToken type

* fix(geo): fix missspelling

* fix(geo): update batch array naming and types

* fix(geo): add GeofenceId type

* fix(geo): add test for tooManyVertices

* fix: PubSub - Resolve ts strict errors in the root import object (#9733)

fix: PubSub - Resolve ts strict errors in the PubSub root file

* chore: preparing release

* chore(release): Publish [ci skip]

 - @aws-amplify/ui-angular@1.0.46
 - @aws-amplify/ui-components@1.9.17
 - @aws-amplify/ui-react@1.2.37
 - @aws-amplify/ui-storybook@2.0.37
 - @aws-amplify/ui-vue@1.1.31
 - @aws-amplify/analytics@5.2.4
 - @aws-amplify/api-graphql@2.3.1
 - @aws-amplify/api-rest@2.0.37
 - @aws-amplify/api@4.0.37
 - @aws-amplify/auth@4.5.1
 - aws-amplify-angular@6.0.37
 - aws-amplify-react@5.1.20
 - aws-amplify@4.3.19
 - @aws-amplify/cache@4.0.39
 - @aws-amplify/core@4.5.1
 - @aws-amplify/datastore-storage-adapter@1.2.11
 - @aws-amplify/datastore@3.9.0
 - @aws-amplify/geo@1.3.0
 - @aws-amplify/interactions@4.0.37
 - @aws-amplify/predictions@4.0.37
 - @aws-amplify/pubsub@4.3.1
 - @aws-amplify/pushnotification@4.3.16
 - @aws-amplify/storage@4.4.20
 - @aws-amplify/xr@3.0.37

* chore(release): update version.ts [ci skip]

* fix(pushnotification): onTap of notification after the app is killed in Android Oreo or higher (#9729)

* fix: make the notification open intent explicit

* remove irrelavant gradle changes

Co-authored-by: Manoj NB <manojnb@amazon.com>
Co-authored-by: Caleb Pollman <cpollman@amazon.com>

* fix: PubSub - Resolve ts strict errors in the MqttOverWSProvider (#9732)

* fix: PubSub - Resolve ts strict errors in the AWSAppSyncRealTimeProvider (#9731)

* fix: PubSub - Resolve ts strict errors in the AWSAppSyncRealTimeProvider

* feat(data): Datastore Docs (#9753)

* fix(pushnotification): unused and androidX imports  (#9708)

Resolves #8023

Co-authored-by: ManojNB <manojnb95@gmail.com>

* gem update (#9808)

* chore: preparing release

* chore(release): Publish [ci skip]

 - @aws-amplify/ui-angular@1.0.47
 - @aws-amplify/ui-components@1.9.18
 - @aws-amplify/ui-react@1.2.38
 - @aws-amplify/ui-storybook@2.0.38
 - @aws-amplify/ui-vue@1.1.32
 - @aws-amplify/analytics@5.2.5
 - @aws-amplify/api-graphql@2.3.2
 - @aws-amplify/api-rest@2.0.38
 - @aws-amplify/api@4.0.38
 - @aws-amplify/auth@4.5.2
 - aws-amplify-angular@6.0.38
 - aws-amplify-react@5.1.21
 - aws-amplify@4.3.20
 - @aws-amplify/cache@4.0.40
 - @aws-amplify/core@4.5.2
 - @aws-amplify/datastore-storage-adapter@1.2.12
 - @aws-amplify/datastore@3.10.0
 - @aws-amplify/geo@1.3.1
 - @aws-amplify/interactions@4.0.38
 - @aws-amplify/predictions@4.0.38
 - @aws-amplify/pubsub@4.3.2
 - @aws-amplify/pushnotification@4.3.17
 - @aws-amplify/storage@4.4.21
 - @aws-amplify/xr@3.0.38

* chore(release): update version.ts [ci skip]

* fix(@aws-amplify/datastore-storage-adapter): SQLite adapter NULL handling and mutation queue management bugs (#9813)

* experimenting with sqlite adapter tests

* seemingly working react-native-sqlite-storage mock

* stash

* checkpoint: found a combo that creates  rogue mutations

* successfully detecting the mutation discrepency in jest

* replicated sqlite test for rogue mutations to indexeddb

* stash

* fix: outbox handling, sqlite adapter null comparison handling

* expanded test coverage for adapter comparison operators

* cleanup sqlite adapter test file

* cleanup debugging cruft

* trying to make sqlite3 bin work

* another attempt to make sqlite3 work

* seeing if we can shorten sqlite3 build  step

* cruft cleanup, comment update

* fix tslint and package version errors

* chore: fixed sqlite testing adapter, add sanity checks for batchSave, batchQuery (#9823)

* fix: sqlite mock, add sanity checks for batchSave, batchQuery

* chore: remove inadvertent VS Code auto-import

* test fix: ensure there's sql in the test log to assert on

Co-authored-by: Andrew Jorgensen <ajorgens@amazon.com>
Co-authored-by: Tré Ammatuna <16496746+TreTuna@users.noreply.github.com>
Co-authored-by: James Au <40404256+jamesaucode@users.noreply.github.com>
Co-authored-by: Francisco Rodriguez <elorzafe@amazon.com>
Co-authored-by: ManojNB <manojnb95@gmail.com>
Co-authored-by: Manoj NB <manojnb@amazon.com>
Co-authored-by: Chris F <5827964+cshfang@users.noreply.github.com>
Co-authored-by: ArkamJ <arkamj@amazon.com>
Co-authored-by: aws-amplify-bot <aws@amazon.com>
Co-authored-by: David McAfee <mcafd@amazon.com>
Co-authored-by: Caleb Pollman <cpollman@amazon.com>
Co-authored-by: Manuel Iglesias <6154160+manueliglesias@users.noreply.github.com>
Co-authored-by: Nick Arocho <nicaroch@amazon.com>
Co-authored-by: Aaron S <94858815+stocaaro@users.noreply.github.com>
Co-authored-by: chintannp <88387035+chintannp@users.noreply.github.com>
Co-authored-by: ArkamJ <67259466+ArkamJ@users.noreply.github.com>
Co-authored-by: James Au <auchu@amazon.com>
Co-authored-by: Simon-TechForm <73996878+Simon-TechForm@users.noreply.github.com>
Co-authored-by: Ashika <35131273+ashika01@users.noreply.github.com>
Co-authored-by: Ashika Kasiviswanathan Arumugakarthik <akasivis@amazon.com>
@github-actions
Copy link

github-actions bot commented Apr 7, 2023

This pull request has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server amplify-help forum.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants