Skip to content

[cloud_functions] Prepare for web implementation #1826

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
Merged
merged 8 commits into from
Jan 22, 2020
Merged

[cloud_functions] Prepare for web implementation #1826

merged 8 commits into from
Jan 22, 2020

Conversation

sbeitzel
Copy link
Contributor

Description

Based on the layout of the firebase_auth plugin, this change sets the stage for a web implementation of the cloud_functions plugin. It adds a new package, cloud_functions_platform_interface.

Related Issues

This PR addresses issue flutter/flutter#45299

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • If the pull request affects only one plugin, the PR title starts with the name of the plugin in brackets (e.g. [cloud_firestore])
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

collinjackson
collinjackson reviewed Jan 16, 2020
View reviewed changes
Copy link
Contributor

@collinjackson collinjackson left a comment

Choose a reason for hiding this comment

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

This is fantastic! Thank you so much for the contribution. Can you please update to use the new plugin_platform_interface class?

ditman
ditman reviewed Jan 16, 2020
View reviewed changes
Copy link
Contributor

@ditman ditman left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for tackling this!

In addition to what Collin said, I'd also recommend that you started by moving the current contents of the cloud_functions plugin to cloud_functions/cloud_functions; that should be a very quick PR, and it'll allow you to work on the rest of the packages without "inheriting" code or config from the old plugin.

@sbeitzel sbeitzel requested a review from kroikie as a code owner January 17, 2020 00:22
@collinjackson collinjackson self-requested a review January 17, 2020 19:56
harryterkelsen
harryterkelsen suggested changes Jan 17, 2020
View reviewed changes
...oud_functions/cloud_functions_platform_interface/lib/src/method_channel_cloud_functions.dart
'app': appName,
'region': region,
'origin': origin,
'timeoutMicroseconds': timeout?.inMicroseconds,
Copy link

Choose a reason for hiding this comment

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

I think this should be 'timeoutMilliseconds': timeout?.inMilliseconds, based on https://github.com/FirebaseExtended/flutterfire/blob/master/packages/cloud_functions/android/src/main/java/io/flutter/plugins/firebase/cloudfunctions/CloudFunctionsPlugin.java#L52

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does that mean that the existing implementation is a bug?
https://github.com/FirebaseExtended/flutterfire/blob/master/packages/cloud_functions/lib/src/https_callable.dart#L38

I mean, I'm happy to make the change if it's the right thing to do, but I don't want to break something that works, currently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems that the Android code is the odd one out. iOS is also using microseconds:

NSNumber *timeoutMicroseconds = call.arguments[@"timeoutMicroseconds"];

https://github.com/FirebaseExtended/flutterfire/blob/master/packages/cloud_functions/ios/Classes/CloudFunctionsPlugin.m#L48

Copy link

Choose a reason for hiding this comment

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

Yes, it looks like a bug in the Android implementation

harryterkelsen
harryterkelsen suggested changes Jan 21, 2020
View reviewed changes
@ditman ditman mentioned this pull request Jan 21, 2020
Closed
harryterkelsen
harryterkelsen approved these changes Jan 22, 2020
View reviewed changes
Copy link

@harryterkelsen harryterkelsen left a comment

Choose a reason for hiding this comment

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

LGTM

collinjackson
collinjackson approved these changes Jan 22, 2020
View reviewed changes
Copy link
Contributor

@collinjackson collinjackson left a comment

Choose a reason for hiding this comment

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

LGTM

@harryterkelsen harryterkelsen merged commit caacd00 into firebase:master Jan 22, 2020
@harryterkelsen
Copy link

Thanks, @sbeitzel ! Just merged this and uploaded cloud_functions_platform_interface to pub

@sbeitzel sbeitzel mentioned this pull request Jan 22, 2020
Merged
12 tasks
@firebase firebase locked and limited conversation to collaborators Aug 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ditman ditman ditman left review comments

@collinjackson collinjackson collinjackson approved these changes

@harryterkelsen harryterkelsen harryterkelsen approved these changes

@kroikie kroikie Awaiting requested review from kroikie

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sbeitzel @harryterkelsen @collinjackson @ditman @googlebot