287 строки
12 KiB
Python
287 строки
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2021 Google Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License")
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from dataclasses import dataclass, field
|
|
from typing import Any, Type
|
|
|
|
from api import accounts_api, dev_api
|
|
from api import approvals_api
|
|
from api import blink_components_api
|
|
from api import channels_api
|
|
from api import comments_api
|
|
from api import cues_api
|
|
from api import features_api
|
|
from api import login_api
|
|
from api import logout_api
|
|
from api import metricsdata
|
|
from api import permissions_api
|
|
from api import processes_api
|
|
from api import reviews_api
|
|
from api import settings_api
|
|
from api import stages_api
|
|
from api import stars_api
|
|
from api import token_refresh_api
|
|
from framework import basehandlers
|
|
from framework import csp
|
|
from framework import sendemail
|
|
from internals import detect_intent
|
|
from internals import fetchmetrics
|
|
from internals import notifier
|
|
from internals import data_backup
|
|
from internals import inactive_users
|
|
from internals import search_fulltext
|
|
from internals import schema_migration
|
|
from internals import reminders
|
|
from pages import blink_handler
|
|
from pages import featurelist
|
|
from pages import guide
|
|
from pages import intentpreview
|
|
from pages import metrics
|
|
from pages import users
|
|
import settings
|
|
|
|
# Sets up Cloud Logging client library.
|
|
if not settings.UNIT_TEST_MODE and not settings.DEV_MODE:
|
|
import google.cloud.logging
|
|
client = google.cloud.logging.Client()
|
|
client.get_default_handler()
|
|
client.setup_logging()
|
|
|
|
# Sets up Cloud Debugger client library.
|
|
if not settings.UNIT_TEST_MODE and not settings.DEV_MODE:
|
|
try:
|
|
import googleclouddebugger
|
|
googleclouddebugger.enable(breakpoint_enable_canary=False)
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
# Note: In the URLs below, parameters like <int:feature_id> are
|
|
# required for the URL to match the route, but we still accecpt
|
|
# those parameters as keywords in those handlers where the same
|
|
# handler might be used for multiple routes that have the field
|
|
# or not.
|
|
|
|
@dataclass
|
|
class Route:
|
|
path: str
|
|
handler_class: Type[basehandlers.BaseHandler] = basehandlers.SPAHandler
|
|
defaults: dict[str, Any] = field(default_factory=dict)
|
|
|
|
|
|
metrics_chart_routes: list[Route] = [
|
|
Route('/data/timeline/cssanimated', metricsdata.AnimatedTimelineHandler),
|
|
Route('/data/timeline/csspopularity', metricsdata.PopularityTimelineHandler),
|
|
Route('/data/timeline/featurepopularity',
|
|
metricsdata.FeatureObserverTimelineHandler),
|
|
Route('/data/csspopularity', metricsdata.CSSPopularityHandler),
|
|
Route('/data/cssanimated', metricsdata.CSSAnimatedHandler),
|
|
Route('/data/featurepopularity',
|
|
metricsdata.FeatureObserverPopularityHandler),
|
|
Route('/data/blink/<string:prop_type>', metricsdata.FeatureBucketsHandler),
|
|
]
|
|
|
|
# TODO(jrobbins): Advance this to v1 once we have it fleshed out
|
|
API_BASE = '/api/v0'
|
|
api_routes: list[Route] = [
|
|
Route(f'{API_BASE}/features', features_api.FeaturesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>', features_api.FeaturesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/approvals',
|
|
approvals_api.ApprovalsAPI),
|
|
# TODO(jrobbins): Phase out approvals_api.
|
|
Route(f'{API_BASE}/features/<int:feature_id>/approvals/<int:field_id>',
|
|
approvals_api.ApprovalsAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/configs',
|
|
approvals_api.ApprovalConfigsAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/votes/<int:gate_id>',
|
|
reviews_api.VotesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/gates',
|
|
reviews_api.GatesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/approvals/comments',
|
|
comments_api.CommentsAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/approvals/<int:field_id>/comments',
|
|
comments_api.CommentsAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/process',
|
|
processes_api.ProcessesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/progress',
|
|
processes_api.ProgressAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/stages',
|
|
stages_api.StagesAPI),
|
|
Route(f'{API_BASE}/features/<int:feature_id>/stages/<int:stage_id>',
|
|
stages_api.StagesAPI),
|
|
|
|
Route(f'{API_BASE}/blinkcomponents',
|
|
blink_components_api.BlinkComponentsAPI),
|
|
|
|
Route(f'{API_BASE}/login', login_api.LoginAPI),
|
|
Route(f'{API_BASE}/logout', logout_api.LogoutAPI),
|
|
Route(f'{API_BASE}/currentuser/permissions', permissions_api.PermissionsAPI),
|
|
Route(f'{API_BASE}/currentuser/settings', settings_api.SettingsAPI),
|
|
Route(f'{API_BASE}/currentuser/stars', stars_api.StarsAPI),
|
|
Route(f'{API_BASE}/currentuser/cues', cues_api.CuesAPI),
|
|
Route(f'{API_BASE}/currentuser/token', token_refresh_api.TokenRefreshAPI),
|
|
# (f'{API_BASE}/currentuser/autosaves', TODO),
|
|
|
|
# Admin operations for user accounts
|
|
Route(f'{API_BASE}/accounts', accounts_api.AccountsAPI),
|
|
Route(f'{API_BASE}/accounts/<int:account_id>', accounts_api.AccountsAPI),
|
|
|
|
Route(f'{API_BASE}/channels', channels_api.ChannelsAPI), # omaha data
|
|
# (f'{API_BASE}/schedule', TODO), # chromiumdash data
|
|
# (f'{API_BASE}/metrics/<str:kind>', TODO), # uma-export data
|
|
# (f'{API_BASE}/metrics/<str:kind>/<int:bucket_id>', TODO),
|
|
]
|
|
|
|
spa_page_routes = [
|
|
Route('/'),
|
|
Route('/roadmap'),
|
|
Route('/myfeatures', defaults={'require_signin': True}),
|
|
Route('/newfeatures'),
|
|
Route('/feature/<int:feature_id>'),
|
|
Route('/guide/new',
|
|
defaults={'require_create_feature': True}),
|
|
Route('/guide/edit/<int:feature_id>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/stage/<int:feature_id>/<int:stage_id>/<int:intent_stage>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/stage/<int:feature_id>/<int:stage_id>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/edit/<int:feature_id>/<int:stage_id>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/editall/<int:feature_id>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/verify_accuracy/<int:feature_id>',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/guide/stage/<int:feature_id>/metadata',
|
|
defaults={'require_edit_feature': True}),
|
|
Route('/metrics'),
|
|
Route('/metrics/css'),
|
|
Route('/metrics/css/popularity'),
|
|
Route('/metrics/css/animated'),
|
|
Route('/metrics/css/timeline/popularity'),
|
|
Route('/metrics/css/timeline/popularity/<int:bucket_id>'),
|
|
Route('/metrics/css/timeline/animated'),
|
|
Route('/metrics/css/timeline/animated/<int:bucket_id>'),
|
|
Route('/metrics/feature/popularity'),
|
|
Route('/metrics/feature/timeline/popularity'),
|
|
Route('/metrics/feature/timeline/popularity/<int:bucket_id>'),
|
|
Route('/settings', defaults={'require_signin': True}),
|
|
Route('/enterprise'),
|
|
]
|
|
|
|
spa_page_post_routes: list[Route] = [
|
|
Route('/guide/new', guide.FeatureCreateHandler),
|
|
Route('/guide/edit/<int:feature_id>', guide.FeatureEditHandler),
|
|
Route('/guide/stage/<int:feature_id>/<int:intent_stage>',
|
|
guide.FeatureEditHandler),
|
|
Route('/guide/stage/<int:feature_id>/<int:intent_stage>/<int:stage_id>/',
|
|
guide.FeatureEditHandler),
|
|
Route('/guide/editall/<int:feature_id>', guide.FeatureEditHandler),
|
|
Route('/guide/verify_accuracy/<int:feature_id>', guide.FeatureEditHandler),
|
|
]
|
|
|
|
mpa_page_routes: list[Route] = [
|
|
Route('/admin/subscribers', blink_handler.SubscribersHandler),
|
|
Route('/admin/blink', blink_handler.BlinkHandler),
|
|
Route('/admin/users/new', users.UserListHandler),
|
|
|
|
Route('/admin/features/launch/<int:feature_id>',
|
|
intentpreview.IntentEmailPreviewHandler),
|
|
Route('/admin/features/launch/<int:feature_id>/<int:stage_id>',
|
|
intentpreview.IntentEmailPreviewHandler),
|
|
|
|
# Note: The only requests being made now hit /features.json and
|
|
# /features_v2.json, but both of those cause version == 2.
|
|
# There was logic to accept another version value, but it it was not used.
|
|
Route(r'/features.json', featurelist.FeaturesJsonHandler),
|
|
Route(r'/features_v2.json', featurelist.FeaturesJsonHandler),
|
|
|
|
Route('/features', featurelist.FeatureListHandler),
|
|
Route('/features/<int:feature_id>', featurelist.FeatureListHandler),
|
|
Route('/features.xml', basehandlers.ConstHandler,
|
|
defaults={'template_path': 'farewell-rss.xml'}),
|
|
Route('/samples', basehandlers.ConstHandler,
|
|
defaults={'template_path': 'farewell-samples.html'}),
|
|
|
|
Route('/omaha_data', metrics.OmahaDataHandler),
|
|
]
|
|
|
|
internals_routes: list[Route] = [
|
|
Route('/cron/metrics', fetchmetrics.YesterdayHandler),
|
|
Route('/cron/histograms', fetchmetrics.HistogramsHandler),
|
|
Route('/cron/update_blink_components', fetchmetrics.BlinkComponentHandler),
|
|
Route('/cron/export_backup', data_backup.BackupExportHandler),
|
|
Route('/cron/send_accuracy_notifications', reminders.FeatureAccuracyHandler),
|
|
Route('/cron/send_prepublication', reminders.PrepublicationHandler),
|
|
Route('/cron/warn_inactive_users', notifier.NotifyInactiveUsersHandler),
|
|
Route('/cron/remove_inactive_users',
|
|
inactive_users.RemoveInactiveUsersHandler),
|
|
Route('/cron/reindex_all', search_fulltext.ReindexAllFeatures),
|
|
|
|
Route('/admin/find_stop_words', search_fulltext.FindStopWords),
|
|
|
|
Route('/tasks/email-subscribers', notifier.FeatureChangeHandler),
|
|
Route('/tasks/detect-intent', detect_intent.IntentEmailHandler),
|
|
|
|
Route('/admin/schema_migration_delete_entities',
|
|
schema_migration.DeleteNewEntities),
|
|
Route('/admin/schema_migration_comment_activity',
|
|
schema_migration.MigrateCommentsToActivities),
|
|
Route('/admin/schema_migration_write_entities',
|
|
schema_migration.MigrateEntities),
|
|
Route('/admin/schema_migration_approval_vote',
|
|
schema_migration.MigrateApprovalsToVotes),
|
|
Route('/admin/schema_migration_gate_status',
|
|
schema_migration.EvaluateGateStatus),
|
|
Route('/admin/schema_migration_updated_field',
|
|
schema_migration.WriteUpdatedField),
|
|
Route('/admin/schema_migration_update_views',
|
|
schema_migration.UpdateDeprecatedViews),
|
|
Route('/admin/schema_migration_missing_gates',
|
|
schema_migration.WriteMissingGates),
|
|
Route('/admin/schema_migration_active_stage',
|
|
schema_migration.CalcActiveStages),
|
|
Route('/admin/schema_migration_extension_stages',
|
|
schema_migration.CreateTrialExtensionStages),
|
|
]
|
|
|
|
dev_routes: list[Route] = []
|
|
if settings.DEV_MODE:
|
|
dev_routes = [
|
|
|
|
## These routes can be uncommented for local environment use. ##
|
|
|
|
# Route('/dev/clear_entities', dev_api.ClearEntities),
|
|
# Route('/dev/write_dev_data', dev_api.WriteDevData)
|
|
]
|
|
# All requests to the app-py3 GAE service are handled by this Flask app.
|
|
app = basehandlers.FlaskApplication(
|
|
__name__,
|
|
(metrics_chart_routes + api_routes + mpa_page_routes + spa_page_routes +
|
|
internals_routes + dev_routes), spa_page_post_routes)
|
|
|
|
# TODO(jrobbins): Make the CSP handler be a class like our others.
|
|
app.add_url_rule(
|
|
'/csp', view_func=csp.report_handler,
|
|
methods=['POST'])
|
|
|
|
sendemail.add_routes(app)
|
|
|
|
if __name__ == '__main__':
|
|
# This is used when running locally only. When deploying to Google App
|
|
# Engine, a webserver process such as Gunicorn will serve the app. This
|
|
# can be configured by adding an `entrypoint` to app.yaml.
|
|
app.run(host='127.0.0.1', port=8080)
|