Malarg commented on code in PR #23378: URL: https://github.com/apache/beam/pull/23378#discussion_r983111884
########## playground/frontend/playground_components/test/src/services/symbols/symbols_notifier_test.dart: ########## @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import 'package:flutter_test/flutter_test.dart'; +import 'package:highlight/highlight_core.dart'; +import 'package:playground_components/src/models/symbols_dictionary.dart'; +import 'package:playground_components/src/services/symbols/loaders/abstract.dart'; +import 'package:playground_components/src/services/symbols/symbols_notifier.dart'; + +void main() { + test( + 'SymbolsNotifier loads symbols from a loader and notifies listeners', + () async { + const symbols = ['a', 'b', 'c']; + final mode = Mode(); + final notifier = SymbolsNotifier(); + int notified = 0; + List<String>? loadedSymbols; + + notifier.addListener(() { + notified++; + loadedSymbols = + List<String>.from(notifier.getDictionary(mode)!.symbols); + }); + notifier.addLoader(mode, const TestLoader(symbols)); + await Future.delayed(Duration.zero); Review Comment: Why is it necessary here? Provide comment, please ########## playground/frontend/playground_components/test/src/services/symbols/symbols_notifier_test.dart: ########## @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import 'package:flutter_test/flutter_test.dart'; +import 'package:highlight/highlight_core.dart'; +import 'package:playground_components/src/models/symbols_dictionary.dart'; +import 'package:playground_components/src/services/symbols/loaders/abstract.dart'; +import 'package:playground_components/src/services/symbols/symbols_notifier.dart'; + +void main() { + test( + 'SymbolsNotifier loads symbols from a loader and notifies listeners', + () async { + const symbols = ['a', 'b', 'c']; + final mode = Mode(); + final notifier = SymbolsNotifier(); + int notified = 0; + List<String>? loadedSymbols; + + notifier.addListener(() { + notified++; + loadedSymbols = + List<String>.from(notifier.getDictionary(mode)!.symbols); + }); + notifier.addLoader(mode, const TestLoader(symbols)); + await Future.delayed(Duration.zero); + + expect(notified, 1); + expect(loadedSymbols, symbols); + }, + ); +} + +class TestLoader extends AbstractSymbolsLoader { + final List<String> symbols; + + const TestLoader(this.symbols); + + @override + // TODO: implement future Review Comment: irrelevant comment ########## playground/frontend/playground_components/test/src/services/symbols/symbols_notifier_test.dart: ########## @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import 'package:flutter_test/flutter_test.dart'; +import 'package:highlight/highlight_core.dart'; +import 'package:playground_components/src/models/symbols_dictionary.dart'; +import 'package:playground_components/src/services/symbols/loaders/abstract.dart'; +import 'package:playground_components/src/services/symbols/symbols_notifier.dart'; + +void main() { + test( + 'SymbolsNotifier loads symbols from a loader and notifies listeners', + () async { + const symbols = ['a', 'b', 'c']; + final mode = Mode(); + final notifier = SymbolsNotifier(); + int notified = 0; + List<String>? loadedSymbols; + + notifier.addListener(() { + notified++; + loadedSymbols = + List<String>.from(notifier.getDictionary(mode)!.symbols); + }); + notifier.addLoader(mode, const TestLoader(symbols)); + await Future.delayed(Duration.zero); + + expect(notified, 1); + expect(loadedSymbols, symbols); + }, + ); +} + +class TestLoader extends AbstractSymbolsLoader { Review Comment: this class should be private ########## playground/frontend/playground_components/test/src/services/symbols/loaders/yaml_test.dart: ########## @@ -0,0 +1,63 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +// ignore_for_file: unnecessary_lambdas + +import 'package:flutter_test/flutter_test.dart'; +import 'package:playground_components/playground_components.dart'; + +void main() { + setUp(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + test('YamlSymbolsLoader', () async { + final loader = YamlSymbolsLoader( + path: 'assets/symbols/python.yaml', + package: PlaygroundComponents.packageName, + ); + + final symbolsDictionary = await loader.future; + + expect( Review Comment: Why don't you follow rule "one check per one test"? It will be more clear to split this test to 3, and join them into group ########## playground/frontend/playground_components/lib/src/services/symbols/loaders/yaml.dart: ########## @@ -0,0 +1,77 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import 'package:flutter/services.dart'; +import 'package:yaml/yaml.dart'; + +import '../../../models/symbols_dictionary.dart'; +import 'abstract.dart'; + +class YamlSymbolsLoader extends AbstractSymbolsLoader { + final String path; + final String? package; + Future<SymbolsDictionary>? _future; + + YamlSymbolsLoader({ + required this.path, + this.package, + }); + + static const _methodsKey = 'methods'; + + @override + Future<SymbolsDictionary> get future { Review Comment: it's still getter. I think we should use lazy initialization [provided](https://dart.dev/guides/language/language-tour#late-variables) by dart here. You just can write: ``` late final Future<SymbolsDictionary>? future = _load(); ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
