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

Serve /documentation URLs through default service (frontend). #1551

Merged
merged 2 commits into from Aug 24, 2018
Merged
Show file tree
Hide file tree
Changes from all 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
5 changes: 5 additions & 0 deletions app/bin/service/frontend.dart
Expand Up @@ -13,6 +13,7 @@ import 'package:logging/logging.dart';
import 'package:pub_server/shelf_pubserver.dart';
import 'package:shelf/shelf.dart' as shelf;

import 'package:pub_dartlang_org/dartdoc/backend.dart';
import 'package:pub_dartlang_org/history/backend.dart';
import 'package:pub_dartlang_org/history/models.dart';
import 'package:pub_dartlang_org/job/backend.dart';
Expand Down Expand Up @@ -69,6 +70,10 @@ Future<shelf.Handler> setupServices(Configuration configuration) async {
registerAnalyzerClient(analyzerClient);
registerScopeExitCallback(analyzerClient.close);

final Bucket dartdocBucket = await getOrCreateBucket(
storageService, activeConfiguration.dartdocStorageBucketName);
registerDartdocBackend(new DartdocBackend(db.dbService, dartdocBucket));

registerDartdocMemcache(new DartdocMemcache(memcacheService));
final dartdocClient = new DartdocClient();
registerDartdocClient(dartdocClient);
Expand Down
4 changes: 2 additions & 2 deletions app/lib/dartdoc/handlers.dart
Expand Up @@ -31,7 +31,7 @@ Future<shelf.Response> dartdocServiceHandler(shelf.Request request) async {
if (handler != null) {
return await handler(request);
} else if (path.startsWith('/documentation')) {
return _documentationHandler(request);
return documentationHandler(request);
} else if (path == '/robots.txt' && !isProductionHost(request)) {
return rejectRobotsHandler(request);
} else if (path == '/robots.txt') {
Expand All @@ -56,7 +56,7 @@ Future<shelf.Response> _robotsTxtHandler(shelf.Request request) async {

/// Handles requests for:
/// - /documentation/<package>/<version>
Future<shelf.Response> _documentationHandler(shelf.Request request) async {
Future<shelf.Response> documentationHandler(shelf.Request request) async {
final docFilePath = parseRequestUri(request.requestedUri);
if (docFilePath == null) {
return _indexHandler(request);
Expand Down
10 changes: 10 additions & 0 deletions app/lib/frontend/handlers.dart
Expand Up @@ -13,6 +13,7 @@ import 'package:logging/logging.dart';
import 'package:path/path.dart' as path;
import 'package:shelf/shelf.dart' as shelf;

import '../dartdoc/handlers.dart' show documentationHandler;
import '../history/backend.dart';
import '../shared/analyzer_client.dart';
import '../shared/dartdoc_client.dart';
Expand Down Expand Up @@ -59,6 +60,12 @@ Future<shelf.Response> appHandler(

_logPubHeaders(request);

final host = request.requestedUri.host;
if (host == 'www.dartdocs.org' || host == 'dartdocs.org') {
return redirectResponse(
request.requestedUri.replace(host: 'pub.dartlang.org').toString());
}

if (path.startsWith('/experimental')) {
var newPath = path.substring('/experimental'.length);
if (newPath.isEmpty) newPath = '/';
Expand All @@ -85,6 +92,9 @@ Future<shelf.Response> appHandler(
return await shelfPubApi(request);
} else if (path.startsWith('/packages/')) {
return await _packageHandler(request);
} else if (path.startsWith('/documentation')) {
return documentationHandler(
request.context['_originalRequest'] as shelf.Request ?? request);
} else if (path.startsWith('/doc')) {
return _docHandler(request);
} else if (path == '/robots.txt' && !isProductionHost(request)) {
Expand Down
7 changes: 6 additions & 1 deletion app/lib/shared/handler_helpers.dart
Expand Up @@ -114,7 +114,7 @@ shelf.Request _sanitizeRequestedUri(shelf.Request request) {
// (The pub client will not remove it and instead directly try to request
// "GET //api/..." :-/ )
final changedUri = uri.replace(path: normalizedResource);
return new shelf.Request(
final sanitized = new shelf.Request(
request.method,
changedUri,
protocolVersion: request.protocolVersion,
Expand All @@ -123,5 +123,10 @@ shelf.Request _sanitizeRequestedUri(shelf.Request request) {
encoding: request.encoding,
context: request.context,
);
if (!sanitized.context.containsKey('_originalRequest')) {
return sanitized.change(context: {'_originalRequest': request});
} else {
return sanitized;
}
}
}
52 changes: 52 additions & 0 deletions app/test/frontend/handlers_test.dart
Expand Up @@ -9,6 +9,7 @@ import 'dart:async';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart';

import 'package:pub_dartlang_org/dartdoc/backend.dart';
import 'package:pub_dartlang_org/frontend/backend.dart';
import 'package:pub_dartlang_org/frontend/handlers_redirects.dart';
import 'package:pub_dartlang_org/frontend/models.dart';
Expand All @@ -18,6 +19,7 @@ import 'package:pub_dartlang_org/shared/analyzer_client.dart';
import 'package:pub_dartlang_org/shared/dartdoc_client.dart';
import 'package:pub_dartlang_org/shared/search_service.dart';

import '../dartdoc/handlers_test.dart' show DartdocBackendMock;
import '../shared/handlers_test_utils.dart';
import '../shared/utils.dart';

Expand Down Expand Up @@ -441,6 +443,56 @@ void main() {
});
});

group('/documentation', () {
test('/documentation/flutter redirect', () async {
expectRedirectResponse(
await issueGet('/documentation/flutter'),
'https://docs.flutter.io/',
);
});

test('/documentation/flutter/version redirect', () async {
expectRedirectResponse(
await issueGet('/documentation/flutter/version'),
'https://docs.flutter.io/',
);
});

test('/documentation/foo/bar redirect', () async {
expectRedirectResponse(
await issueGet('/documentation/foor/bar'),
'https://pub.dartlang.org/documentation/foor/bar/',
);
});

scopedTest('trailing slash redirect', () async {
expectRedirectResponse(
await issueGet('/documentation/foo'), '/documentation/foo/latest/');
});

scopedTest('/documentation/no_pkg redirect', () async {
registerDartdocBackend(new DartdocBackendMock());
expectRedirectResponse(await issueGet('/documentation/no_pkg/latest/'),
'/packages/no_pkg/versions');
});

test('dartdocs.org redirect', () async {
expectRedirectResponse(
await issueGetUri(
Uri.parse('https://dartdocs.org/documentation/pkg/latest/')),
'https://pub.dartlang.org/documentation/pkg/latest/',
);
});

test('www.dartdocs.org redirect', () async {
expectRedirectResponse(
await issueGetUri(
Uri.parse('https://www.dartdocs.org/documentation/pkg/latest/')),
'https://pub.dartlang.org/documentation/pkg/latest/',
);
});
});

group('old api', () {
scopedTest('/packages.json', () async {
final backend =
Expand Down
10 changes: 7 additions & 3 deletions app/test/frontend/handlers_test_utils.dart
Expand Up @@ -2,7 +2,7 @@
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

library pub_dartlang_org.handlers_test;
library pub_dartlang_org.frontend.handlers_test;

import 'dart:async';

Expand All @@ -22,9 +22,13 @@ import 'package:pub_dartlang_org/shared/search_client.dart';
import 'package:pub_dartlang_org/shared/search_service.dart';
import 'package:pub_dartlang_org/shared/urls.dart';

Future<shelf.Response> issueGet(String path) async {
Future<shelf.Response> issueGet(String path) {
final uri = '$siteRoot$path';
final request = new shelf.Request('GET', Uri.parse(uri));
return issueGetUri(Uri.parse(uri));
}

Future<shelf.Response> issueGetUri(Uri uri) async {
final request = new shelf.Request('GET', uri);
return appHandler(request, null);
}

Expand Down
8 changes: 2 additions & 6 deletions dispatch.yaml
@@ -1,10 +1,6 @@
dispatch:
- url: "*.dartdocs.org/*"
service: dartdoc
- url: "pub.dartlang.org/documentation"
service: dartdoc
- url: "pub.dartlang.org/documentation/*"
service: dartdoc
service: default
- url: "dartdocs.org/*"
service: dartdoc
service: default