Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add web url launcher #2119

Merged
merged 5 commits into from Oct 2, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -1,3 +1,7 @@
## 5.1.5

* Update homepage url after moving to federated directory.

## 5.1.4

* Update and migrate iOS example project.
Expand Down
Expand Up @@ -2,8 +2,8 @@ name: url_launcher
description: Flutter plugin for launching a URL on Android and iOS. Supports
web, phone, SMS, and email schemes.
author: Flutter Team <flutter-dev@googlegroups.com>
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher
version: 5.1.4
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher
version: 5.1.5

flutter:
plugin:
Expand Down
3 changes: 3 additions & 0 deletions packages/url_launcher/url_launcher_web/CHANGELOG.md
@@ -0,0 +1,3 @@
# 0.0.1

- Initial open-source release.
27 changes: 27 additions & 0 deletions packages/url_launcher/url_launcher_web/LICENSE
@@ -0,0 +1,27 @@
// Copyright 2019 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 changes: 24 additions & 0 deletions packages/url_launcher/url_launcher_web/README.md
@@ -0,0 +1,24 @@
# url_launcher_web

The web implementation of [`url_launcher`][1].

## Usage

To use this plugin in your Flutter Web app, simply add it as a dependency in
your pubspec using a `git` dependency. This is only temporary: in the future
we hope to make this package an "endorsed" implementation of `url_launcher`,
so that it is automatically included in your Flutter Web app when you depend
on `package:url_launcher`.

```yaml
dependencies:
url_launcher: ^5.1.4
url_launcher_web:
git: git@github.com:flutter/plugins.git
path: packages/url_launcher/url_launcher_web
```

Once you have the `url_launcher_web` dependency in your pubspec, you should
be able to use `package:url_launcher` as normal.

[1]: ../url_launcher
@@ -0,0 +1,20 @@
#
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = 'url_launcher_web'
s.version = '0.0.1'
s.summary = 'No-op implementation of url_launcher_web web plugin to avoid build issues on iOS'
s.description = <<-DESC
temp fake url_launcher_web plugin
DESC
s.homepage = 'https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher_web'
s.license = { :file => '../LICENSE' }
s.author = { 'Flutter Team' => 'flutter-dev@googlegroups.com' }
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.public_header_files = 'Classes/**/*.h'
s.dependency 'Flutter'

s.ios.deployment_target = '8.0'
end
43 changes: 43 additions & 0 deletions packages/url_launcher/url_launcher_web/lib/url_launcher_web.dart
@@ -0,0 +1,43 @@
import 'dart:async';
import 'dart:html' as html;

import 'package:flutter/services.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';

class UrlLauncherPlugin {
static void registerWith(Registrar registrar) {
final MethodChannel channel = MethodChannel(
'plugins.flutter.io/url_launcher',
const StandardMethodCodec(),
registrar.messenger);
final UrlLauncherPlugin instance = UrlLauncherPlugin();
channel.setMethodCallHandler(instance.handleMethodCall);
}

Future<dynamic> handleMethodCall(MethodCall call) async {
switch (call.method) {
case 'canLaunch':
final String url = call.arguments['url'];
return _canLaunch(url);
case 'launch':
final String url = call.arguments['url'];
return _launch(url);
default:
throw PlatformException(
code: 'Unimplemented',
details: "The url_launcher plugin for web doesn't implement "
"the method '${call.method}'");
}
}

bool _canLaunch(String url) {
final Uri parsedUrl = Uri.tryParse(url);
if (parsedUrl == null) return false;

return parsedUrl.isScheme('http') || parsedUrl.isScheme('https');
}

bool _launch(String url) {
return html.window.open(url, '') != null;
}
}
28 changes: 28 additions & 0 deletions packages/url_launcher/url_launcher_web/pubspec.yaml
@@ -0,0 +1,28 @@
name: url_launcher_web
description: Web platform implementation of url_launcher
author: Flutter Team <flutter-dev@googlegroups.com>
homepage: https://github.com/flutter/plugins/tree/master/packages/url_launcher/url_launcher_web
version: 0.0.1

flutter:
plugin:
platforms:
web:
pluginClass: UrlLauncherPlugin
fileName: url_launcher_web.dart

dependencies:
flutter:
sdk: flutter
flutter_web_plugins:
sdk: flutter

dev_dependencies:
flutter_test:
sdk: flutter
url_launcher:
path: ../url_launcher

environment:
sdk: ">=2.0.0-dev.28.0 <3.0.0"
flutter: ">=1.5.0 <2.0.0"
@@ -0,0 +1,34 @@
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

@TestOn('chrome') // Uses web-only Flutter SDK

import 'package:flutter_test/flutter_test.dart';
import 'package:flutter_web_plugins/flutter_web_plugins.dart';
import 'package:url_launcher/url_launcher.dart';
import 'package:url_launcher_web/url_launcher_web.dart';

void main() {
group('URL Launcher for Web', () {
setUp(() {
TestWidgetsFlutterBinding.ensureInitialized();
webPluginRegistry.registerMessageHandler();
final Registrar registrar =
webPluginRegistry.registrarFor(UrlLauncherPlugin);
UrlLauncherPlugin.registerWith(registrar);
});

test('can launch "http" URLs', () {
expect(canLaunch('http://google.com'), completion(isTrue));
});

test('can launch "https" URLs', () {
expect(canLaunch('https://google.com'), completion(isTrue));
});

test('cannot launch "tel" URLs', () {
expect(canLaunch('tel:5551234567'), completion(isFalse));
});
});
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a way to test launch ?

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 would require a lot of extra code. Rather than running the test using flutter test --platform chrome we would have to spin up our own instance of Chrome, somehow build the JS getting the Flutter Web SDK from somewhere, call launch, and determine that a new tab was opened with the correct API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added some basic tests for launch

}
10 changes: 5 additions & 5 deletions script/check_publish.sh
Expand Up @@ -12,8 +12,8 @@ source "$SCRIPT_DIR/common.sh"

function check_publish() {
local failures=()
for package_name in "$@"; do
local dir="$REPO_DIR/packages/$package_name"
for dir in $(pub global run flutter_plugin_tools list --plugins="$1"); do
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems wrong to only look at the first argument (prior to this change it would check the packages for all arguments)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That was because previously, check_publish was called with the dereferenced CHANGED_PACKAGE_LIST array, which passed the array items as separate arguments. Now there is only one argument, the packages list in a comma-separated list.

local package_name=$(basename "$dir")
echo "Checking that $package_name can be published."
if [[ $(cd "$dir" && cat pubspec.yaml | grep -E "^publish_to: none") ]]; then
echo "Package $package_name is marked as unpublishable. Skipping."
Expand All @@ -33,9 +33,9 @@ function check_publish() {
return "${#failures[@]}"
}

# Sets CHANGED_PACKAGE_LIST
# Sets CHANGED_PACKAGE_LIST and CHANGED_PACKAGES
check_changed_packages

if [[ "${#CHANGED_PACKAGE_LIST[@]}" != 0 ]]; then
check_publish "${CHANGED_PACKAGE_LIST[@]}"
fi
check_publish "${CHANGED_PACKAGES}"
fi
9 changes: 2 additions & 7 deletions script/common.sh
Expand Up @@ -23,16 +23,11 @@ function check_changed_packages() {
return 1
fi

# Filter out any packages that don't have a pubspec.yaml: they have probably
# been deleted in this PR. Also filter out `location_background` since it
# should be removed soon.
CHANGED_PACKAGES=""
CHANGED_PACKAGE_LIST=()
for package in "${packages[@]}"; do
if [ -f "$REPO_DIR/packages/$package/pubspec.yaml" ] && [ $package != "location_background" ]; then
CHANGED_PACKAGES="${CHANGED_PACKAGES},$package"
CHANGED_PACKAGE_LIST=("${CHANGED_PACKAGE_LIST[@]}" "$package")
fi
CHANGED_PACKAGES="${CHANGED_PACKAGES},$package"
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like the pubspec.yaml logic was introduced to prevent a deleted package to be running on CI, maybe we can just check that the directory exists instead?

cc @gspencergoog who originally introduce this logic.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this to check if the directory exists

CHANGED_PACKAGE_LIST=("${CHANGED_PACKAGE_LIST[@]}" "$package")
done

if [[ "${#CHANGED_PACKAGE_LIST[@]}" == 0 ]]; then
Expand Down