You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2022/08/02 08:04:09 UTC
[GitHub] [beam] alexeyinkin opened a new pull request, #22553: Refactor the initial example loading in Playground (#22544)
alexeyinkin opened a new pull request, #22553:
URL: https://github.com/apache/beam/pull/22553
This refactors the initial loading of examples that used to be in `playground_page_providers.dart`:
- Example loading descriptors were introduced. Each descriptor contains all the info to load an example from a given source.
- `StandardExampleLoadingDescriptor` defines loading by an example name.
- `CatalogDefaultExampleLoadingDescriptor` defines loading the default example for a given SDK.
- `EmptyExampleLoadingDescriptor` defines loading empty content while setting a given SDK.
- An option to load arbitrary code with `code` query parameter was removed. It was not allowing to set SDK so it was likely not used in practice. It was only allowed in the embedded version thus introducing unwanted distinctions between the two views. Should we need this option, we must add a loading descriptor class for it.
- Example loaders were introduced. Each loader class loads an example from a given source using a particular descriptor class.
- `PlaygroundState` now links to `ExampleState`. This is because the loading complications were stemming from their separation. The loading code had to await events from both of them. `ExampleState` is no longer provided in the widget tree, all code consuming `ExampleState` from the tree was changed to consume `PlaygroundState`.
As we were completing 'Share any code' feature, this refactoring emerged as a requirement. Without it, adding another source of source code would render the old loading unmaintainable.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/get-started-contributing/#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] alexeyinkin closed pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
alexeyinkin closed pull request #22553: Refactor the initial example loading in Playground (#22544)
URL: https://github.com/apache/beam/pull/22553
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] alexeyinkin commented on a diff in pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
alexeyinkin commented on code in PR #22553:
URL: https://github.com/apache/beam/pull/22553#discussion_r935248249
##########
playground/frontend/lib/modules/examples/models/example_loading_descriptors/examples_loading_descriptor.dart:
##########
@@ -0,0 +1,41 @@
+/*
+ * 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:collection/collection.dart';
+
+import 'package:playground/modules/examples/models/example_loading_descriptors/example_loading_descriptor.dart';
+
+class ExamplesLoadingDescriptor {
+ final List<ExampleLoadingDescriptor> descriptors;
Review Comment:
We will soon need multiple examples at once when embedding into multi-SDK docs.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] alexeyinkin commented on a diff in pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
alexeyinkin commented on code in PR #22553:
URL: https://github.com/apache/beam/pull/22553#discussion_r935245967
##########
playground/frontend/lib/modules/examples/models/example_loading_descriptors/examples_loading_descriptor_factory.dart:
##########
@@ -0,0 +1,69 @@
+/*
+ * 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:playground/constants/params.dart';
+import 'package:playground/modules/examples/models/example_loading_descriptors/catalog_default_example_loading_descriptor.dart';
+import 'package:playground/modules/examples/models/example_loading_descriptors/empty_example_loading_descriptor.dart';
+import 'package:playground/modules/examples/models/example_loading_descriptors/example_loading_descriptor.dart';
+import 'package:playground/modules/examples/models/example_loading_descriptors/examples_loading_descriptor.dart';
+import 'package:playground/modules/examples/models/example_loading_descriptors/standard_example_loading_descriptor.dart';
+import 'package:playground/modules/sdk/models/sdk.dart';
+
+class ExamplesLoadingDescriptorFactory {
+ static ExamplesLoadingDescriptor fromUriParts({
+ required String path,
+ required Map<String, dynamic> params,
+ }) {
+ return _tryParseSingleExample(params) ??
+ _tryParseCatalogDefaultExample() ??
+ _oneEmptyWithDefaultSdk;
+ }
+
+ static ExamplesLoadingDescriptor? _tryParseSingleExample(
+ Map<String, dynamic> params,
+ ) {
+ final token = params[kExampleParam];
+ if (token is! String) {
+ return null;
+ }
+
+ return ExamplesLoadingDescriptor(
+ descriptors: [_parseSingleExample(token)],
+ );
+ }
+
+ static ExamplesLoadingDescriptor? _tryParseCatalogDefaultExample() {
+ if (isEmbedded()) {
+ return null;
+ }
+
+ return const ExamplesLoadingDescriptor(
+ descriptors: [CatalogDefaultExampleLoadingDescriptor(sdk: SDK.java)],
+ );
+ }
+
+ static ExampleLoadingDescriptor _parseSingleExample(String token) {
+ return StandardExampleLoadingDescriptor(path: token);
+ }
Review Comment:
A separate method because user-shared descriptor will also be created here.
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] alexeyinkin commented on pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
alexeyinkin commented on PR #22553:
URL: https://github.com/apache/beam/pull/22553#issuecomment-1202176587
R: @damondouglas
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] alexeyinkin commented on a diff in pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
alexeyinkin commented on code in PR #22553:
URL: https://github.com/apache/beam/pull/22553#discussion_r935258626
##########
playground/frontend/test/modules/editor/repository/code_repository/code_repository_test.mocks.dart:
##########
@@ -133,6 +134,4 @@ class MockCodeClient extends _i1.Mock implements _i5.CodeClient {
returnValue:
Future<_i4.OutputResponse>.value(_FakeOutputResponse_2()))
as _i6.Future<_i4.OutputResponse>);
- @override
Review Comment:
Will get rid of these in
- #22552
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] github-actions[bot] commented on pull request #22553: Refactor the initial example loading in Playground (#22544)
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #22553:
URL: https://github.com/apache/beam/pull/22553#issuecomment-1202177958
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org