AppFlowy/frontend/app_flowy/lib/startup/startup.dart
2022-02-20 09:59:52 +08:00

126 lines
3.8 KiB
Dart

import 'dart:io';
import 'package:app_flowy/startup/tasks/prelude.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:get_it/get_it.dart';
import 'package:app_flowy/workspace/infrastructure/deps_resolver.dart';
import 'package:app_flowy/user/infrastructure/deps_resolver.dart';
import 'package:flowy_sdk/flowy_sdk.dart';
// [[diagram: flowy startup flow]]
// ┌──────────┐
// │ FlowyApp │
// └──────────┘
// │ impl
// ▼
// ┌────────┐ 1.run ┌──────────┐
// │ System │───┬───▶│EntryPoint│
// └────────┘ │ └──────────┘ ┌─────────────────┐
// │ ┌──▶ │ RustSDKInitTask │
// │ ┌───────────┐ │ └─────────────────┘
// └──▶ │AppLauncher│───┤
// 2.launch └───────────┘ │ ┌─────────────┐ ┌──────────────────┐ ┌───────────────┐
// └───▶│AppWidgetTask│────────▶│ApplicationWidget │─────▶│ SplashScreen │
// └─────────────┘ └──────────────────┘ └───────────────┘
//
// 3.build MeterialApp
final getIt = GetIt.instance;
abstract class EntryPoint {
Widget create();
}
class FlowySystem {
static Future<void> run(EntryPoint f) async {
// Specify the env
final env = integrationEnv();
initGetIt(getIt, env, f);
// add task
getIt<AppLauncher>().addTask(InitRustSDKTask());
if (!env.isTest()) {
getIt<AppLauncher>().addTask(ApplicationWidgetTask());
getIt<AppLauncher>().addTask(InitPlatformService());
}
// execute the tasks
getIt<AppLauncher>().launch();
}
}
Future<void> initGetIt(
GetIt getIt,
IntegrationEnv env,
EntryPoint f,
) async {
getIt.registerFactory<EntryPoint>(() => f);
getIt.registerLazySingleton<FlowySDK>(() => const FlowySDK());
getIt.registerLazySingleton<AppLauncher>(() => AppLauncher(env, getIt));
await UserDepsResolver.resolve(getIt);
await HomeDepsResolver.resolve(getIt);
}
class LaunchContext {
GetIt getIt;
IntegrationEnv env;
LaunchContext(this.getIt, this.env);
}
enum LaunchTaskType {
dataProcessing,
appLauncher,
}
/// The interface of an app launch task, which will trigger
/// some nonresident indispensable task in app launching task.
abstract class LaunchTask {
LaunchTaskType get type => LaunchTaskType.dataProcessing;
Future<void> initialize(LaunchContext context);
}
class AppLauncher {
List<LaunchTask> tasks;
IntegrationEnv env;
GetIt getIt;
AppLauncher(this.env, this.getIt) : tasks = List.from([]);
void addTask(LaunchTask task) {
tasks.add(task);
}
Future<void> launch() async {
final context = LaunchContext(getIt, env);
for (var task in tasks) {
await task.initialize(context);
}
}
}
enum IntegrationEnv {
develop,
release,
test,
}
extension IntegrationEnvExt on IntegrationEnv {
bool isTest() {
return this == IntegrationEnv.test;
}
}
IntegrationEnv integrationEnv() {
if (Platform.environment.containsKey('FLUTTER_TEST')) {
return IntegrationEnv.test;
}
if (kReleaseMode) {
return IntegrationEnv.release;
}
return IntegrationEnv.develop;
}