| commit | 07f1f7c49db464e95adc2c3dca8e27521d4e3640 | [log] [tgz] |
|---|---|---|
| author | Casey Hillers <chillers@google.com> | Wed Aug 25 16:16:01 2021 -0700 |
| committer | GitHub <noreply@github.com> | Wed Aug 25 16:16:01 2021 -0700 |
| tree | 9c77354d844ed80c9e27e5ec56cafa2cd37a002d | |
| parent | 5fdcd2a0a0e0bc463a33ac4052eba24f564ee808 [diff] |
Rename app_flutter to dashboard (#1339)
Cocoon is a Dart App Engine custom runtime (backend) with a frontend of Flutter apps (build and repository dashboard). Cocoon coordinates and aggregates the results of flutter/flutter builds. It is not designed to help developers build Flutter apps. Cocoon is not a Google product.
The server is driven by commits made to https://github.com/flutter/flutter repo. It periodically syncs new commits. If you need to manually force a refresh, query https://flutter-dashboard.appspot.com/api/refresh-github-commits. You will need to be authenticated with Cocoon to do this.
Cocoon has several components:
A server, which coordinates everything. This is a Dart App Engine application. If you have never used that before, you may want to peruse the samples for Dart App Engine. The server is found in app_dart.
A Flutter app (generally used as a Web app) for the build dashboards. The dashboard is found in dashboard.
Cocoon creates a checklist for each Flutter commit. A checklist is made of multiple tasks. Tasks are performed by LUCI bots.
First, set up a Flutter development environment. This will, as a side-effect, provide you with a Dart SDK. Your life will be easier if you add that (.../flutter/bin/cache/dart-sdk/bin/) to your path.
To update the production server, you will need the Google Cloud SDK. Since there is no Dart SDK, we just use the command line tools.
All the commands in this section assume that you are in the app_dart/ directory.
This is useful for developing backend functionality locally. This local dev server can be connected to the frontend applications by running dart dev/deploy.dart --project test --version test, and answering N when asked about deploying to App Engine. This will build the frontend files and copy them to the directory from which the server will serve them.
Set the environment variables GCLOUD_PROJECT and GCLOUD_KEY. Running dart bin/server.dart will give more explanation on what these values should be. You should also set COCOON_USE_IN_MEMORY_CACHE to true as you typically don't have access to the remote redis instance during local development.
If you see Serving requests at 0.0.0.0:8080 the dev server is working.
To develop and test some features, you need to have a local service account(key.json) with access to the project you will be connecting to.
If you work for Google you can use the key with flutter-dashboard project via internal doc.
To run tests, build the app, and provide instructions for deploying to Google App Engine, run this command:
dart dev/deploy.dart --project {PROJECT} --version {VERSION}
You can test the new version by accessing {VERSION}-dot-flutter-dashboard.appspot.com in your browser. If the result is satisfactory, the new version can be activated by using the Cloud Console UI: https://pantheon.corp.google.com/appengine/versions?project=flutter-dashboard&serviceId=default
--profile: Deploy a profile mode of dashboard application for debugging purposes.
The dashboard application will use dummy data when it is not connected to the server, so it can be developed locally without a dev server.
To run the dashboard locally, go into the dashboard directory and run flutter run -d chrome. The dashboard will be served from localhost (the exact address will be given on the console); copy the URL into your browser to view the application. (The dashboard should also be able to run on non-Web platforms, but since the Web is our main target that is the one that should generally be used for development.)
You may need to run flutter config --enable-web to enable Web support if you haven't done so in the past.
You can run flutter packages upgrade to update the dependencies. This may be necessary if you see a failure in the dependencies.
