under dart_gdbc standard.

CorvusYe · CorvusYe · commit af5e332dcf2f · 2023-05-06T07:54:44.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+
+.dart_tool/
+.vscode/
+
+**/pubspec.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.
diff --git a/README.md b/README.md
@@ -0,0 +1,2 @@
+A sample command-line application with an entrypoint in `bin/`, library code
+in `lib/`, and example unit test in `test/`.
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -0,0 +1,30 @@
+# 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: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
diff --git a/bin/nebula_dart_gdbc.dart b/bin/nebula_dart_gdbc.dart
@@ -0,0 +1,3 @@
+import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart' as nebula_dart_gdbc;
+
+void main(List<String> arguments) {}
diff --git a/example/.gitignore b/example/.gitignore
@@ -0,0 +1,3 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
diff --git a/example/CHANGELOG.md b/example/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,2 @@
+A sample command-line application with an entrypoint in `bin/`, library code
+in `lib/`, and example unit test in `test/`.
diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml
@@ -0,0 +1,30 @@
+# 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: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
diff --git a/example/bin/example.dart b/example/bin/example.dart
@@ -0,0 +1,3 @@
+import 'package:example/example.dart' as example;
+
+void main(List<String> arguments) {}
diff --git a/example/lib/example.dart b/example/lib/example.dart
@@ -0,0 +1,27 @@
+// use driver
+
+import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart';
+
+void main(List<String> args) async {
+  DriverManager.registerDriver(NgDriver());
+
+  var conn = await DriverManager.getConnection(
+    'gdbc.nebula://127.0.0.1:9669/?username=root&password=nebula&space=test',
+    properties: <String, dynamic>{
+      // properties is optional
+      DriverManager.usrKey: 'root',
+      DriverManager.pwdKey: 'nebula',
+      'timeout': 1000,
+      'space': 'test',
+    },
+    username: 'root', // username is optional
+    password: 'nebula', // password is optional
+  );
+
+  var stmt = await conn.createStatement();
+  await conn.executeQuery('use test');
+  var rs = await stmt.executeQuery('MATCH (n) RETURN n LIMIT 10;');
+
+  print(rs);
+  await conn.close();
+}
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -0,0 +1,15 @@
+name: example
+description: A sample command-line application.
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: '>=2.19.0 <3.0.0'
+
+dependencies:
+  nebula_dart_gdbc:
+    path: ..
+
+dev_dependencies:
+  lints: ^2.0.0
+  test: ^1.21.0
diff --git a/example/test/example_test.dart b/example/test/example_test.dart
@@ -0,0 +1,4 @@
+import 'package:example/example.dart';
+import 'package:test/test.dart';
+
+void main() {}
diff --git a/lib/nebula_dart_gdbc.dart b/lib/nebula_dart_gdbc.dart
@@ -0,0 +1,17 @@
+library nebula_dart_gdbc;
+
+import 'dart:convert';
+import 'dart:typed_data';
+
+import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart';
+import 'package:nebula_graph/nebula_graph.dart';
+
+// export all dart_gdbc and alias it to gdbc
+export 'package:dart_gdbc/dart_gdbc.dart';
+
+part 'src/ng_driver.dart';
+part 'src/ng_connection.dart';
+part 'src/ng_statement.dart';
+part 'src/ng_prepared_statement.dart';
+part 'src/ng_result_set.dart';
+part 'src/ng_result_set_meta_data.dart';
diff --git a/lib/src/ng_connection.dart b/lib/src/ng_connection.dart
@@ -0,0 +1,165 @@
+part of nebula_dart_gdbc;
+
+/// Create by [DriverManager.getConnection]
+///
+/// 通过 [DriverManager.getConnection] 创建
+///
+/// For example:
+/// ```dart
+/// DriverManager.getConnection(
+///   'gdbc.nebula://127.0.0.1:9669/?username=root&password=nebula&space=nb',
+///   properties: {// properties is optional
+///     DriverManager.usrKey: 'root',
+///     DriverManager.pwdKey: 'nebula',
+///     'timeout': '1000',
+///     'space': 'nb',
+///   },
+///   username: 'root', // username is optional
+///   password: 'nebula', // password is optional
+/// );
+/// ```
+class NgConnection implements Connection {
+  static const String timeoutKey = 'timeout';
+
+  NgConnection._();
+
+  late TSocketTransport socketTransport;
+  late TFramedTransport transport;
+  late THeaderProtocol protocol;
+  late GraphServiceClient client;
+  late Map<String, dynamic> properties;
+  int? _sessionId;
+  int? timezoneOffset;
+  int timeout = 0;
+
+  /// Invoked in [DriverManager.getConnection],
+  /// you should not call this method directly.
+  /// Because connection is not open yet.
+  ///
+  /// 通过 [DriverManager.getConnection] 调用，
+  /// 不应该直接调用这个方法。
+  /// 因为连接还没有打开。
+  NgConnection._create(Uri address, {Map<String, dynamic>? properties}) {
+    this.properties = properties ?? <String, dynamic>{};
+    socketTransport = TSocketTransport(
+      host: address.host,
+      port: address.port,
+      connectionTimeout: properties?[timeoutKey] ?? 6000,
+    );
+
+    transport = THeaderTransport(
+        transport: socketTransport,
+        clientTypes: [ClientTypes.HEADERS],
+        supportedClients: [false]);
+
+    protocol = THeaderProtocol(transport);
+    client = GraphServiceClient(protocol);
+  }
+
+  /// Invoked in [DriverManager.getConnection], after the connection created.
+  ///
+  /// 在 [DriverManager.getConnection] 内创建了连接之后调用。
+  Future<void> _open() async {
+    if (!socketTransport.isOpen) await socketTransport.open();
+
+    /// check the version of client and server
+    await verifyVersion();
+    await authencate();
+  }
+
+  /// check the version of client and server
+  /// if the version is not compatible, throw an exception
+  ///
+  /// 检查客户端和服务端的版本是否兼容
+  /// 如果不兼容，抛出异常
+  Future<void> verifyVersion() async {
+    VerifyClientVersionResp resp =
+        await client.verifyClientVersion(VerifyClientVersionReq());
+
+    if (resp.error_code != ErrorCode.SUCCEEDED) {
+      throw VersionException(
+          message: String.fromCharCodes(resp.error_msg ?? []));
+    }
+  }
+
+  /// authenticate the user
+  ///
+  /// 认证用户
+  Future<void> authencate() async {
+    AuthResponse resp = await client.authenticate(
+      Int8List.fromList(utf8.encode(properties[DriverManager.usrKey] ?? '')),
+      Int8List.fromList(utf8.encode(properties[DriverManager.pwdKey] ?? '')),
+    );
+
+    if (resp.error_code != ErrorCode.SUCCEEDED) {
+      if (resp.error_msg != null) {
+        throw ConnectException(message: String.fromCharCodes(resp.error_msg!));
+      } else {
+        throw ConnectException(message: "Auth failed");
+      }
+    }
+
+    _sessionId = resp.session_id;
+    timezoneOffset = resp.time_zone_offset_seconds ?? 0;
+  }
+
+  @override
+  Future<void> close() async {
+    await transport.close();
+  }
+
+  @override
+  Future<void> commit() async {}
+
+  @override
+  Future<Statement> createStatement() async {
+    return NgStatement(this);
+  }
+
+  @override
+  Future<ResultSet> executeQuery(String gql) async {
+    return await NgStatement(this).executeQuery(gql);
+  }
+
+  @override
+  Future<int> executeUpdate(String gql) async {
+    return await NgStatement(this).executeUpdate(gql);
+  }
+
+  @override
+  Future<bool> getAutoCommit() async {
+    return true;
+  }
+
+  @override
+  Future<ResultSetMetaData> getMetaData() {
+    // TODO: implement getMetaData
+    throw UnimplementedError();
+  }
+
+  @override
+  Future<bool> isClosed() async {
+    return !transport.isOpen;
+  }
+
+  @override
+  Future<PreparedStatement> prepareStatement(String gql) async {
+    return NgPreparedStatement(this);
+  }
+
+  @override
+  Future<PreparedStatement> prepareStatementWithParameters(
+      String gql, List<ParameterMetaData> parameters) async {
+    return NgPreparedStatement(this, parameters: parameters);
+  }
+
+  @override
+  Future<void> rollback() {
+    throw DbFeatureException('No support for rollback');
+  }
+
+  @override
+  Future<void> setAutoCommit(bool autoCommit) {
+    throw DbFeatureException('No support for setAutoCommit');
+  }
+}
diff --git a/lib/src/ng_driver.dart b/lib/src/ng_driver.dart
@@ -0,0 +1,31 @@
+part of nebula_dart_gdbc;
+
+class NgDriver extends Driver {
+  @override
+  bool acceptsURL(String url) {
+    return url.startsWith('gdbc.nebula:');
+  }
+
+  @override
+  Future<Connection> connect(
+    String url, {
+    Map<String, dynamic>? properties,
+  }) async {
+    var address = _parseURL(url);
+    address.queryParameters.forEach((key, value) {
+      properties![key] = value;
+    });
+    print(properties);
+    var conn = NgConnection._create(address, properties: properties);
+    await conn._open();
+    return conn;
+  }
+
+  Uri _parseURL(String url) {
+    var uri = Uri.parse(url);
+    if (uri.scheme != 'gdbc.nebula' || uri.host.isEmpty || uri.port <= 0) {
+      throw ArgumentError('Invalid URL: $url');
+    }
+    return uri;
+  }
+}
diff --git a/lib/src/ng_prepared_statement.dart b/lib/src/ng_prepared_statement.dart
@@ -0,0 +1,23 @@
+part of nebula_dart_gdbc;
+
+class NgPreparedStatement extends NgStatement implements PreparedStatement {
+  List<ParameterMetaData>? parameters;
+  NgPreparedStatement(super.conn, {this.parameters});
+
+  @override
+  Future<bool> execute([String? gql, Map<String, dynamic>? params]) async {
+    var rs = await executeQuery(gql, params);
+    return rs.success;
+  }
+
+  @override
+  Future<ResultSet> executeQuery(
+      [String? gql, Map<String, dynamic>? params]) async {
+    return super.executeQuery(gql);
+  }
+
+  @override
+  Future<int> executeUpdate(String? gql, [Map<String, dynamic>? params]) async {
+    return super.executeUpdate(gql);
+  }
+}
diff --git a/lib/src/ng_result_set.dart b/lib/src/ng_result_set.dart
@@ -0,0 +1,3 @@
+part of '../nebula_dart_gdbc.dart';
+
+class NgResultSet extends ResultSet {}
diff --git a/lib/src/ng_result_set_meta_data.dart b/lib/src/ng_result_set_meta_data.dart
@@ -0,0 +1,3 @@
+part of '../nebula_dart_gdbc.dart';
+
+class NgResultSetMetaData implements ResultSetMetaData {}
diff --git a/lib/src/ng_statement.dart b/lib/src/ng_statement.dart
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/nebula_dart_gdbc_test.dart b/test/nebula_dart_gdbc_test.dart

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 1.0.0`
	`2`	`+`
	`3`	`+- Initial version.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+A sample command-line application with an entrypoint in `bin/`, library code
	`2`	+in `lib/`, and example unit test in `test/`.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import 'package:nebula_dart_gdbc/nebula_dart_gdbc.dart' as nebula_dart_gdbc;`
	`2`	`+`
	`3`	`+void main(List<String> arguments) {}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# https://dart.dev/guides/libraries/private-files`
	`2`	+# Created by `dart pub`
	`3`	`+.dart_tool/`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import 'package:example/example.dart' as example;`
	`2`	`+`
	`3`	`+void main(List<String> arguments) {}`