chore(db_studio): Update linter/style preferences (#408)

- Ensures `celest_lints` is used
- Applies latest linter/style preferences using dart fix
- Re-formats using Dart 3.8

Author: dnys1

.github/workflows/celest_db_studio.yaml

@@ -15,6 +15,26 @@ permissions:
   contents: read
 
 jobs:
+  analyze_and_format:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2
+      - name: Setup Flutter
+        uses: subosito/flutter-action@e938fdf56512cc96ef2f93601a5a40bde3801046 # 2.19.0
+        with:
+          channel: beta
+          cache: true
+      - name: Get Packages
+        working-directory: packages/celest_db_studio
+        run: dart pub upgrade
+      - name: Analyze
+        working-directory: packages/celest_db_studio
+        run: dart analyze
+      - name: Format
+        working-directory: packages/celest_db_studio
+        run: dart format --language-version=latest --set-exit-if-changed .
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 10

packages/celest_db_studio/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 1.0.0
+## 0.1.0
 
 - Initial version.

packages/celest_db_studio/analysis_options.yaml

@@ -1,30 +1,5 @@
-# This file configures the static analysis results for your project (errors,
-# warnings, and lints).
-#
-# This enables the 'recommended' set of lints from `package:lints`.
-# This set helps identify many issues that may lead to problems when running
-# or consuming Dart code, and enforces writing Dart using a single, idiomatic
-# style and format.
-#
-# If you want a smaller set of lints you can change this to specify
-# 'package:lints/core.yaml'. These are just the most critical lints
-# (the recommended set includes the core lints).
-# The core lints are also what is used by pub.dev for scoring packages.
+include: package:celest_lints/library.yaml
 
-include: package:lints/recommended.yaml
-
-# Uncomment the following section to specify additional rules.
-
-# linter:
-#   rules:
-#     - camel_case_types
-
-# analyzer:
-#   exclude:
-#     - path/to/excluded/files/**
-
-# For more information about the core and recommended set of lints, see
-# https://dart.dev/go/core-lints
-
-# For additional information about configuring this file, see
-# https://dart.dev/guides/language/analysis-options
+analyzer:
+  errors:
+    public_member_api_docs: ignore

packages/celest_db_studio/bin/server.dart

@@ -5,27 +5,31 @@ import 'package:shelf/shelf.dart';
 import 'package:shelf/shelf_io.dart';
 
 Future<void> main(List<String> args) async {
-  final databaseUrl = Platform.environment['DATABASE_URL'];
+  final String? databaseUrl = Platform.environment['DATABASE_URL'];
   if (databaseUrl == null) {
-    print('DATABASE_URL environment variable is not set.');
+    stderr.writeln('DATABASE_URL environment variable is not set.');
     exit(1);
   }
-  final authToken = Platform.environment['DATABASE_AUTH_TOKEN'];
+  final String? authToken = Platform.environment['DATABASE_AUTH_TOKEN'];
 
-  final dbStudio = await CelestDbStudio.create(
+  final CelestDbStudio dbStudio = await CelestDbStudio.create(
     databaseUri: Uri.parse(databaseUrl),
     authToken: authToken,
   );
-  final handler = Pipeline()
+  final Handler handler = const Pipeline()
       .addMiddleware(logRequests())
       .addHandler(dbStudio.call);
 
-  final port = int.parse(Platform.environment['PORT'] ?? '8080');
-  final server = await serve(handler, InternetAddress.loopbackIPv4, port);
-  print('Server listening on http://localhost:${server.port}');
+  final int port = int.parse(Platform.environment['PORT'] ?? '8080');
+  final HttpServer server = await serve(
+    handler,
+    InternetAddress.loopbackIPv4,
+    port,
+  );
+  stdout.writeln('Server listening on http://localhost:${server.port}');
 
   await ProcessSignal.sigint.watch().first;
 
-  print('Stopping server...');
+  stdout.writeln('Stopping server...');
   await server.close(force: true);
 }

packages/celest_db_studio/lib/celest_db_studio.dart

@@ -11,24 +11,27 @@ export 'package:celest_db_studio/src/driver.dart';
 /// {@template celest_db_studio.celest_db_studio}
 /// A simple server which serves an instance of Outerbase Studio as an embedded
 /// iframe and responds to query requests from the iframe.
-///
-/// The server connects to a database using the provided [databaseUri] and
-/// proxies requests from the iframe to the database.
 /// {@endtemplate}
 final class CelestDbStudio {
+  CelestDbStudio.from({this.pageTitle = defaultTitle, required Driver driver})
+    : _driver = driver;
+
   /// {@macro celest_db_studio.celest_db_studio}
+  ///
+  /// The server connects to a database using the provided [databaseUri] and
+  /// proxies requests from the iframe to the database.
   static Future<CelestDbStudio> create({
     String pageTitle = defaultTitle,
     required Uri databaseUri,
     String? authToken,
   }) async {
-    final driver = await Driver.connect(databaseUri, authToken: authToken);
+    final Driver driver = await Driver.connect(
+      databaseUri,
+      authToken: authToken,
+    );
     return CelestDbStudio.from(pageTitle: pageTitle, driver: driver);
   }
 
-  CelestDbStudio.from({this.pageTitle = defaultTitle, required Driver driver})
-    : _driver = driver;
-
   /// The default title of the page.
   static const String defaultTitle = 'DB Studio';
 
@@ -68,7 +71,7 @@ final class CelestDbStudio {
       if (request.method == 'OPTIONS') {
         return Response.ok(null, headers: corsHeaders);
       }
-      final response = await innerHandler(request);
+      final Response response = await innerHandler(request);
       return response.change(headers: corsHeaders);
     };
   }
@@ -102,7 +105,7 @@ final class CelestDbStudio {
 
   /// Responds to query requests from the Outerbase Studio iframe.
   Future<Response> _query(Request request) async {
-    final json = await JsonUtf8.decodeStream(request.read());
+    final Object? json = await JsonUtf8.decodeStream(request.read());
     if (json
         case {
               'id': final int id,
@@ -115,7 +118,7 @@ final class CelestDbStudio {
               'statement': final String statement,
             }) {
       try {
-        final result = await _driver.execute(statement);
+        final DriverResultSet result = await _driver.execute(statement);
         return Response.ok(
           jsonEncode({
             'type': type,

packages/celest_db_studio/lib/src/driver.dart

@@ -2,12 +2,13 @@
 import 'package:hrana/src/rpc_client.dart' as hrana;
 import 'package:hrana/src/rpc_http_client.dart' as hrana;
 import 'package:sqlite3/sqlite3.dart' show Database, sqlite3;
+import 'package:sqlite3/src/result_set.dart';
 
 sealed class Driver {
   static Future<Driver> connect(Uri uri, {String? authToken}) async {
     switch (uri) {
       case Uri(scheme: 'libsql' || 'https' || 'http'):
-        return await HranaDriver.connect(uri, jwtToken: authToken);
+        return HranaDriver.connect(uri, jwtToken: authToken);
       case Uri(scheme: 'file', path: '/:memory:'):
         return NativeDriver.memory();
       case Uri(scheme: 'file'):
@@ -34,8 +35,8 @@ final class NativeDriver extends Driver {
 
   @override
   Future<DriverResultSet> execute(String sql) async {
-    final result = _database.select(sql);
-    final headers = [
+    final ResultSet result = _database.select(sql);
+    final List<DriverResultHeader> headers = [
       for (final column in result.columnNames)
         DriverResultHeader(
           name: column,
@@ -56,7 +57,7 @@ final class HranaDriver extends Driver {
   HranaDriver(this._client);
 
   static Future<HranaDriver> connect(Uri uri, {String? jwtToken}) async {
-    final client = await hrana.HranaHttpClient.connect(
+    final hrana.HranaHttpClient client = await hrana.HranaHttpClient.connect(
       uri.replace(
         scheme: switch (uri.scheme) {
           'wss' || 'libsql' || 'https' => 'https',
@@ -73,12 +74,12 @@ final class HranaDriver extends Driver {
 
   @override
   Future<DriverResultSet> execute(String sql) async {
-    final session = await _client.openStream();
+    final hrana.HranaStream session = await _client.openStream();
     try {
-      final result = await session.executeStatement(
+      final hrana.StatementResult result = await session.executeStatement(
         hrana.SqlStatement(sql: sql, args: [], namedArgs: [], wantRows: true),
       );
-      final headers = [
+      final List<DriverResultHeader> headers = [
         for (final column in result.columns)
           DriverResultHeader(
             name: column.name ?? '',

packages/celest_db_studio/test/e2e_test.dart

@@ -18,7 +18,7 @@ void main() {
     late Process p;
 
     setUpAll(() async {
-      final sqldPort = await selectFreePort();
+      final int sqldPort = await selectFreePort();
       sqld = await startSqld(sqldPort);
 
       port = await selectFreePort();
@@ -83,7 +83,7 @@ void main() {
       await p.exitCode;
       try {
         await dbDir.delete(recursive: true);
-      } catch (e) {
+      } on Object {
         // OK
       }
     });
@@ -130,7 +130,7 @@ void main() {
         'E2E',
         skip: hasChromeDriver ? null : 'Chromedriver not installed',
         () async {
-          final chromedriver = await Process.start('chromedriver', [
+          final Process chromedriver = await Process.start('chromedriver', [
             '--port=4444',
             '--url-base=wd/hub',
           ]);
@@ -153,7 +153,7 @@ void main() {
                 .then(fail),
           ]);
 
-          final driver = await createDriver(
+          final WebDriver driver = await createDriver(
             spec: WebDriverSpec.JsonWire,
             desired: {
               ...Capabilities.chrome,
@@ -167,31 +167,31 @@ void main() {
           addTearDown(driver.quit);
 
           await driver.get('http://localhost:$port');
-          final iframe = await driver.waitForElement(
+          final WebElement iframe = await driver.waitForElement(
             const By.tagName('iframe'),
             timeout: const Duration(seconds: 10),
           );
-          final src = await iframe.attributes['src'];
+          final String? src = await iframe.attributes['src'];
           expect(src, 'https://studio.outerbase.com/embed/sqlite');
 
           // Ensure that sending `SELECT 1;` works and returns `1` in the result cell.
 
           await driver.switchTo.frame(iframe);
 
-          final input = await driver.waitForElement(
+          final WebElement input = await driver.waitForElement(
             const By.className('cm-content'),
           );
           await input.click();
           await input.sendKeys('SELECT 1;');
 
-          final runButton = await driver.findElement(
+          final WebElement runButton = await driver.findElement(
             const By.cssSelector(
               r'body > div.flex.h-screen.w-screen.flex-col > div > div:nth-child(3) > div.flex.h-full.w-full.flex-col > div.relative.grow > div > div > div:nth-child(1) > div > div.flex.border-b.bg-neutral-50.py-3.pr-1.pl-3.dark\:bg-neutral-950 > div.flex.gap-2 > div > button.inline-flex.items-center.justify-center.whitespace-nowrap.font-medium.transition-colors.focus-visible\:outline-hidden.focus-visible\:ring-1.focus-visible\:ring-ring.disabled\:pointer-events-none.disabled\:opacity-50.bg-primary.text-primary-foreground.shadow-sm.hover\:bg-primary\/90.h-8.rounded-md.px-3.text-sm.rounded-r-none',
             ),
           );
           await runButton.click();
 
-          final resultCell = await driver.waitForElement(
+          final WebElement resultCell = await driver.waitForElement(
             const By.cssSelector(
               r'body > div.flex.h-screen.w-screen.flex-col > div > div:nth-child(3) > div.flex.h-full.w-full.flex-col > div.relative.grow > div > div > div:nth-child(3) > div.flex.h-full.w-full.flex-col > div.relative.grow > div:nth-child(1) > div > div.grow.overflow-hidden > div > div > table > tbody > tr > td.overflow-hidden.border-r.border-b.box-border.hover\:bg-neutral-100.dark\:hover\:bg-neutral-800.bg-transparent',
             ),
@@ -207,7 +207,7 @@ bool get hasChromeDriver {
   try {
     Process.runSync('chromedriver', ['--version']);
     return true;
-  } catch (e) {
+  } on Object {
     return false;
   }
 }
@@ -221,10 +221,10 @@ extension on SearchContext {
     while (stopwatch.elapsed < timeout) {
       try {
         return await findElement(by);
-      } catch (e) {
+      } on Object {
         // Ignore and retry
       }
-      await Future.delayed(const Duration(milliseconds: 100));
+      await Future<void>.delayed(const Duration(milliseconds: 100));
     }
     throw TimeoutException(null, 'Element not found within $timeout');
   }

packages/celest_db_studio/test/server_test.dart

@@ -4,6 +4,8 @@ import 'dart:io';
 import 'package:celest_db_studio/celest_db_studio.dart';
 import 'package:http/http.dart' as http;
 import 'package:shelf/shelf_io.dart';
+import 'package:shelf/src/request.dart';
+import 'package:shelf/src/response.dart';
 import 'package:shelf_router/shelf_router.dart';
 import 'package:test/test.dart';
 
@@ -16,10 +18,10 @@ void main() {
         late http.Client client;
 
         setUpAll(() async {
-          final studio = await CelestDbStudio.create(
+          final CelestDbStudio studio = await CelestDbStudio.create(
             databaseUri: Uri.parse('file::memory:'),
           );
-          final handler =
+          final Future<Response> Function(Request request) handler =
               basePath.isEmpty
                   ? studio.call
                   : (Router()..mount(basePath, studio.call)).call;
@@ -37,7 +39,7 @@ void main() {
 
         for (final url in validUrls) {
           test('GET $url', () async {
-            final response = await client.send(
+            final http.StreamedResponse response = await client.send(
               http.Request('GET', Uri.parse('$uri$url'))
                 ..followRedirects = true,
             );
@@ -51,7 +53,7 @@ void main() {
         }
 
         test('POST /query', () async {
-          final response = await client.post(
+          final http.Response response = await client.post(
             Uri.parse('$uri/query'),
             body: jsonEncode({
               'id': 1,
@@ -72,7 +74,7 @@ void main() {
 
         for (final url in invalidUrls) {
           test('GET $url', () async {
-            final response = await client.get(uri.resolve(url));
+            final http.Response response = await client.get(uri.resolve(url));
             expect(response.statusCode, 404);
             expect(response.body, contains('Route not found'));
           });

packages/celest_db_studio/test/start_server.dart

@@ -3,7 +3,7 @@ import 'dart:io';
 import 'package:docker_process/docker_process.dart';
 
 Future<DockerProcess> startSqld(int port) async {
-  final process = await DockerProcess.start(
+  final DockerProcess process = await DockerProcess.start(
     image: 'ghcr.io/tursodatabase/libsql-server:latest',
     name: 'dart-hrana-test-$port',
     readySignal: (line) => line.contains('serving internal rpc server'),
@@ -14,8 +14,11 @@ Future<DockerProcess> startSqld(int port) async {
 }
 
 Future<int> selectFreePort() async {
-  final socket = await ServerSocket.bind(InternetAddress.anyIPv4, 0);
-  final port = socket.port;
+  final ServerSocket socket = await ServerSocket.bind(
+    InternetAddress.anyIPv4,
+    0,
+  );
+  final int port = socket.port;
   await socket.close();
   return port;
 }