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

Jump to bottom

fix(fcm): Fix error throw when data property exists but is undefined #1139

Open

italoiz wants to merge 2 commits into firebase:master from italoiz:fix/error-throw-when-data-is-undefined

italoiz commented Jan 20, 2021

When use messaging().sendToDevice(tokens, payload) where payload contains the data property, but it's contains undefined value, I given throws the follow error:

TypeError: Cannot use 'in' operator to search for 'from' in undefined

The following Pull Request contains the solution of the issue with the covered unit tests.


          fix(messaging): Fix error throw when data property exists but is unde…

483d3be

…fined value

google-cla bot commented Jan 20, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

Author

italoiz commented Jan 20, 2021

@googlebot I signed it!


          chore: fix the code standard

97e2f9d

aprilmintacpineda commented May 27, 2021

This has recently happened to me.

hiranya911 suggested changes

View reviewed changes

Contributor

hiranya911 left a comment

Sorry for the delay. This PR somehow slipped through the cracks. It looks mostly good, but some of the tests are not relevant to the fix. And the others require some assertions. I can take another look, if those issues are addressed.

src/messaging/messaging.ts

@@ @@ -857,7 +857,7 @@ export class Messaging implements MessagingInterface { @@
                   }
                   // Validate the data payload object does not contain blacklisted properties
-                  if ('data' in payloadCopy) {
+                  if ('data' in payloadCopy && payloadCopy.data !== undefined) {

Contributor

hiranya911 May 27, 2021

May be just if (payloadCopy.data)

test/unit/messaging/messaging.spec.ts

@@ @@ -566,6 +566,12 @@ describe('Messaging', () => { @@
                       { token: 'mock-token' },
                     ).should.eventually.be.rejected.and.have.property('code', 'messaging/invalid-argument');
                   });
+                  it('should not throws when the payload contains the data property with undefined value', () => {

Contributor

hiranya911 May 27, 2021

should not throw when

test/unit/messaging/messaging.spec.ts

@@ @@ -566,6 +566,12 @@ describe('Messaging', () => { @@
                       { token: 'mock-token' },
                     ).should.eventually.be.rejected.and.have.property('code', 'messaging/invalid-argument');
                   });
+                  it('should not throws when the payload contains the data property with undefined value', () => {

Contributor

hiranya911 May 27, 2021

This test case is actually irrelevant to the actual fix. The fix only applies to legacy FCM APIs like sendToDevice(). It has no effect on send(). We can remove this.

test/unit/messaging/messaging.spec.ts

@@ @@ -823,6 +829,29 @@ describe('Messaging', () => { @@
                       [validMessage],
                     ).should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
                   });
+                  it('should not throws when the payload contains the data property with undefined value', () => {

Contributor

hiranya911 May 27, 2021

Please remove. Not relevant to the fix.

test/unit/messaging/messaging.spec.ts

@@ @@ -1118,6 +1147,31 @@ describe('Messaging', () => { @@
                     ).should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
                   });
+                  it('should not throws when the payload contains the data property with undefined value', () => {

Contributor

hiranya911 May 27, 2021

Please remove.

test/unit/messaging/messaging.spec.ts

@@ @@ -1457,6 +1511,16 @@ describe('Messaging', () => { @@
                       expect(mockOptionsClone).to.deep.equal(mocks.messaging.options);
                     });
                   });
+                  it('should not throws when the payload contains the data property with undefined value', () => {

Contributor

hiranya911 May 27, 2021

should not throw when...

test/unit/messaging/messaging.spec.ts

+                      mocks.messaging.registrationToken,
+                      { ...mocks.messaging.payload, data: undefined },
+                      mocks.messaging.options,
+                    );

Contributor

hiranya911 May 27, 2021

We need an assertion here. May be at least .should.eventually.be.fulfilled.

hiranya911 assigned hiranya911 and italoiz

hiranya911 changed the title ~~fix(messaging): Fix error throw when data property exists but is undefined~~ fix(fcm): Fix error throw when data property exists but is undefined

Author

italoiz commented Mar 21, 2023

Hey @hiranya911, Is this PR still need a fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment