chromium-dashboard/main.py

# -*- 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 api import accounts_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 settings_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 schema_migration
from internals import deprecate_field
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.


metrics_chart_routes = [
    ('/data/timeline/cssanimated', metricsdata.AnimatedTimelineHandler),
    ('/data/timeline/csspopularity', metricsdata.PopularityTimelineHandler),
    ('/data/timeline/featurepopularity',
     metricsdata.FeatureObserverTimelineHandler),
    ('/data/csspopularity', metricsdata.CSSPopularityHandler),
    ('/data/cssanimated', metricsdata.CSSAnimatedHandler),
    ('/data/featurepopularity', metricsdata.FeatureObserverPopularityHandler),
    ('/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 = [
    (API_BASE + '/features', features_api.FeaturesAPI),
    (API_BASE + '/features/<int:feature_id>', features_api.FeaturesAPI),
    (API_BASE + '/features/<int:feature_id>/approvals',
     approvals_api.ApprovalsAPI),
    (API_BASE + '/features/<int:feature_id>/approvals/<int:field_id>',
     approvals_api.ApprovalsAPI),
    (API_BASE + '/features/<int:feature_id>/configs',
     approvals_api.ApprovalConfigsAPI),
    (API_BASE + '/features/<int:feature_id>/approvals/comments',
     comments_api.CommentsAPI),
    (API_BASE + '/features/<int:feature_id>/approvals/<int:field_id>/comments',
     comments_api.CommentsAPI),
    (API_BASE + '/features/<int:feature_id>/process', processes_api.ProcessesAPI),
    (API_BASE + '/features/<int:feature_id>/progress', processes_api.ProgressAPI),

    (API_BASE + '/blinkcomponents', blink_components_api.BlinkComponentsAPI),

    (API_BASE + '/login', login_api.LoginAPI),
    (API_BASE + '/logout', logout_api.LogoutAPI),
    (API_BASE + '/currentuser/permissions', permissions_api.PermissionsAPI),
    (API_BASE + '/currentuser/settings', settings_api.SettingsAPI),
    (API_BASE + '/currentuser/stars', stars_api.StarsAPI),
    (API_BASE + '/currentuser/cues', cues_api.CuesAPI),
    (API_BASE + '/currentuser/token', token_refresh_api.TokenRefreshAPI),
    # (API_BASE + '/currentuser/autosaves', TODO),

    # Admin operations for user accounts
    (API_BASE + '/accounts', accounts_api.AccountsAPI),
    (API_BASE + '/accounts/<int:account_id>', accounts_api.AccountsAPI),

    (API_BASE + '/channels', channels_api.ChannelsAPI),  # omaha data
    # (API_BASE + '/schedule', TODO),  # chromiumdash data
    # (API_BASE + '/metrics/<str:kind>', TODO),  # uma-export data
    # (API_BASE + '/metrics/<str:kind>/<int:bucket_id>', TODO),
]

spa_pages = [
  '/',
  '/roadmap',
  ('/myfeatures', {'require_signin': True}),
  '/newfeatures',
  '/feature/<int:feature_id>',
  ('/guide/new', {'require_create_feature': True}),
  ('/guide/edit/<int:feature_id>', {'require_edit_feature': True}),
  ('/guide/stage/<int:feature_id>/<int:stage_id>', {'require_edit_feature': True}),
  ('/guide/editall/<int:feature_id>', {'require_edit_feature': True}),
  ('/guide/verify_accuracy/<int:feature_id>', {'require_edit_feature': True}),
  '/metrics',
  '/metrics/css',
  '/metrics/css/popularity',
  '/metrics/css/animated',
  '/metrics/css/timeline/popularity',
  '/metrics/css/timeline/popularity/<int:bucket_id>',
  '/metrics/css/timeline/animated',
  '/metrics/css/timeline/animated/<int:bucket_id>',
  '/metrics/feature/popularity',
  '/metrics/feature/timeline/popularity',
  '/metrics/feature/timeline/popularity/<int:bucket_id>',
  ('/settings', {'require_signin': True}),
]

spa_page_routes = []
for route in spa_pages:
  page_defaults = {}
  if isinstance(route, tuple):
    route, additional_defaults = route
    page_defaults.update(additional_defaults)
  spa_page_routes.append((route, basehandlers.SPAHandler, page_defaults))

spa_page_post_routes = [
  ('/guide/new', guide.FeatureCreateHandler),
  ('/guide/edit/<int:feature_id>', guide.FeatureEditHandler),
  ('/guide/stage/<int:feature_id>/<int:stage_id>', guide.FeatureEditHandler),
  ('/guide/editall/<int:feature_id>', guide.FeatureEditHandler),
  ('/guide/verify_accuracy/<int:feature_id>', guide.FeatureEditHandler),
]

mpa_page_routes = [
    ('/admin/subscribers', blink_handler.SubscribersHandler),
    ('/admin/blink', blink_handler.BlinkHandler),
    ('/admin/users/new', users.UserListHandler),

    ('/admin/features/launch/<int:feature_id>',
     intentpreview.IntentEmailPreviewHandler),
    ('/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.
    (r'/features.json', featurelist.FeaturesJsonHandler),
    (r'/features_v2.json', featurelist.FeaturesJsonHandler),

    ('/features', featurelist.FeatureListHandler),
    ('/features/<int:feature_id>', featurelist.FeatureListHandler),
    ('/features.xml', basehandlers.ConstHandler,
     {'template_path': 'farewell-rss.xml'}),

    ('/omaha_data', metrics.OmahaDataHandler),
]

internals_routes = [
  ('/cron/metrics', fetchmetrics.YesterdayHandler),
  ('/cron/histograms', fetchmetrics.HistogramsHandler),
  ('/cron/update_blink_components', fetchmetrics.BlinkComponentHandler),
  ('/cron/export_backup', data_backup.BackupExportHandler),
  ('/cron/send_accuracy_notifications', notifier.FeatureAccuracyHandler),
  ('/cron/warn_inactive_users', notifier.NotifyInactiveUsersHandler),
  ('/cron/remove_inactive_users', inactive_users.RemoveInactiveUsersHandler),
  ('/cron/schema_migration_comment_activity', schema_migration.MigrateCommentsToActivities),
  ('/cron/write_standard_maturity', deprecate_field.WriteStandardMaturityHandler),

  ('/tasks/email-subscribers', notifier.FeatureChangeHandler),

  ('/tasks/detect-intent', detect_intent.IntentEmailHandler),
]


# 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), 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)