# -*- 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 import threading from api import accounts_api from api import blink_components_api from api import component_users from api import components_users from api import channels_api from api import comments_api from api import cues_api from api import features_api from api import feature_links_api from api import login_api from api import logout_api from api import metricsdata from api import origin_trials_api 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 feature_links from internals import maintenance_scripts from internals import notifier from internals import data_backup from internals import inactive_users from internals import search_fulltext from internals import reminders from pages import featurelist from pages import guide from pages import intentpreview from pages import metrics from pages import ot_requests from pages import users import settings # Patch treading library to work-around bug with Google Cloud Logging. original_delete = threading.Thread._delete # type: ignore def safe_delete(self): try: original_delete(self) except KeyError: pass threading.Thread._delete = safe_delete # type: ignore # 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.setup_logging() # Note: In the URLs below, parameters like 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/', 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/', features_api.FeaturesAPI), Route(f'{API_BASE}/features/create', features_api.FeaturesAPI), Route(f'{API_BASE}/feature_links', feature_links_api.FeatureLinksAPI), Route(f'{API_BASE}/feature_links_summary', feature_links_api.FeatureLinksSummaryAPI), Route(f'{API_BASE}/feature_links_samples', feature_links_api.FeatureLinksSamplesAPI), Route(f'{API_BASE}/features//votes', reviews_api.VotesAPI), Route(f'{API_BASE}/features//votes/', reviews_api.VotesAPI), Route(f'{API_BASE}/features//gates', reviews_api.GatesAPI), Route(f'{API_BASE}/features//approvals/comments', comments_api.CommentsAPI), Route(f'{API_BASE}/features//approvals//comments', comments_api.CommentsAPI), Route(f'{API_BASE}/features//process', processes_api.ProcessesAPI), Route(f'{API_BASE}/features//progress', processes_api.ProgressAPI), Route(f'{API_BASE}/features//stages', stages_api.StagesAPI), Route(f'{API_BASE}/features//stages/', stages_api.StagesAPI), Route(f'{API_BASE}/blinkcomponents', blink_components_api.BlinkComponentsAPI), Route(f'{API_BASE}/componentsusers', components_users.ComponentsUsersAPI), Route(f'{API_BASE}/components//users/', component_users.ComponentUsersAPI), 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/', accounts_api.AccountsAPI), Route(f'{API_BASE}/channels', channels_api.ChannelsAPI), # omaha data # (f'{API_BASE}/schedule', TODO), # chromiumdash data # (f'{API_BASE}/metrics/', TODO), # uma-export data # (f'{API_BASE}/metrics//', TODO), Route(f'{API_BASE}/origintrials', origin_trials_api.OriginTrialsAPI), ] # The Routes below that have no handler specified use SPAHandler. # The guide.* handlers each call get_spa_template_data(). spa_page_routes = [ Route('/'), Route('/roadmap'), Route('/myfeatures', defaults={'require_signin': True}), Route('/newfeatures'), Route('/feature/'), Route('/feature//activity'), Route('/guide/new', guide.FeatureCreateHandler, defaults={'require_create_feature': True}), Route('/guide/enterprise/new', guide.EnterpriseFeatureCreateHandler, defaults={'require_signin': True, 'require_create_feature': True, 'is_enterprise_page': True}), Route('/guide/edit/', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/stage///', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/stage//', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/edit//', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/editall/', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/verify_accuracy/', guide.FeatureEditHandler, defaults={'require_edit_feature': True}), Route('/guide/stage//metadata', defaults={'require_edit_feature': True}), Route('/ot_creation_request//'), Route('/metrics'), Route('/metrics/css'), Route('/metrics/css/popularity'), Route('/metrics/css/animated'), Route('/metrics/css/timeline/popularity'), Route('/metrics/css/timeline/popularity/'), Route('/metrics/css/timeline/animated'), Route('/metrics/css/timeline/animated/'), Route('/metrics/feature/popularity'), Route('/metrics/feature/timeline/popularity'), Route('/metrics/feature/timeline/popularity/'), Route('/settings', defaults={'require_signin': True}), Route('/enterprise'), Route( '/enterprise/releasenotes', defaults={'require_signin': True, 'is_enterprise_page': True}), # Admin pages Route('/admin/blink', defaults={'require_admin_site': True, 'require_signin': True}), Route('/admin/feature_links', defaults={'require_admin_site': True, 'require_signin': True}), Route('/admin/slo_report', reminders.SLOReportHandler), ] mpa_page_routes: list[Route] = [ Route('/admin/users/new', users.UserListHandler), Route('/admin/ot_requests', ot_requests.OriginTrialsRequests), Route('/admin/features/launch/', intentpreview.IntentEmailPreviewHandler), Route('/admin/features/launch//', 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/', 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('/cron/update_all_feature_links', feature_links.UpdateAllFeatureLinksHandlers), Route('/cron/associate_origin_trials', maintenance_scripts.AssociateOTs), Route('/admin/find_stop_words', search_fulltext.FindStopWords), Route('/tasks/email-subscribers', notifier.FeatureChangeHandler), Route('/tasks/detect-intent', detect_intent.IntentEmailHandler), Route('/tasks/email-reviewers', notifier.FeatureReviewHandler), Route('/tasks/email-comments', notifier.FeatureCommentHandler), Route('/tasks/update-feature-links', feature_links.FeatureLinksUpdateHandler), Route('/tasks/email-ot-creation-request', notifier.OriginTrialCreationRequestHandler), # Maintenance scripts. Route('/scripts/evaluate_gate_status', maintenance_scripts.EvaluateGateStatus), Route('/scripts/write_missing_gates', maintenance_scripts.WriteMissingGates), Route('/scripts/migrate_gecko_views', maintenance_scripts.MigrateGeckoViews), Route('/scripts/backfill_responded_on', maintenance_scripts.BackfillRespondedOn), Route('/scripts/backfill_stage_created', maintenance_scripts.BackfillStageCreated), Route('/scripts/backfill_feature_links', maintenance_scripts.BackfillFeatureLinks), ] 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), Route('/dev/mock_login', login_api.MockLogin), ] # 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)) # 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)