[tool] version-check publish-check commands can check against pub #3840

cyanglaz · 2021-04-30T21:20:10Z

Add a PubVersionFinder class to easily fetch the version from pub.

Add an against-pub flag to check-version command, which allows it to check the version against pub server

Make the 'publish-check' command to check against pub to determine if the specific versions of packages need to be published.
Add a log-status flag, which allows the publish-check command to log the final status of the result. This helps other ci tools to easily grab the results and use it to determine what to do next. See option 3 in flutter/flutter#81444

This PR also fixes some tests.

partially flutter/flutter#81444

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…version_check_pub

stuartmorgan-g · 2021-05-03T16:58:03Z

script/tool/lib/src/publish_check_command.dart

+        help:
+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'


s/need to/that needs to be/

stuartmorgan-g · 2021-05-03T16:58:21Z

script/tool/lib/src/publish_check_command.dart

+        help:
+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'


Remove training space since there's a \n

stuartmorgan-g · 2021-05-03T16:59:00Z

script/tool/lib/src/publish_check_command.dart

+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'
+            '    $_resultNoPublish: There are no packages need to be published. Either no pubspec change detected or the version has already been published. \n'


s/the version/all versions/, since there can be multiple packages.

stuartmorgan-g · 2021-05-03T17:48:00Z

script/tool/lib/src/publish_check_command.dart

    );
+    argParser.addFlag(_logStatusFlag,
+        help:
+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'


Mixing output for humans and output for machines is generally not a good idea; I would rather we make a --machine flag that switches entirely to an output meant for parsing.

stuartmorgan-g · 2021-05-03T17:51:19Z

script/tool/lib/src/publish_check_command.dart

+    final PubVersionFinder pubVersionFinder = PubVersionFinder(
+        package: packageName, httpClient: httpClient ?? http.Client());
+    final PubVersionFinderResponse pubVersionFinderResponse =
+        await pubVersionFinder.getPackageVersion();


Don't we want a try/catch here to deal with issues reaching pub?

We don't need try-catch, but we should check the status of pubVersionFinderResponse. Done.

cyanglaz

@stuartmorgan Updated per review comments. PTAL

cyanglaz · 2021-05-04T20:57:21Z

script/tool/lib/src/publish_check_command.dart

+        help:
+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'


cyanglaz · 2021-05-04T20:57:45Z

script/tool/lib/src/publish_check_command.dart

+        help:
+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'


cyanglaz · 2021-05-04T20:58:26Z

script/tool/lib/src/publish_check_command.dart

+            'Logs the check-publish final status to a defined string as the last line of the command output.\n'
+            'The possible values are:\n'
+            '    $_resultNeedsPublish: There is at least one package need to be published. They also passed all publish checks. \n'
+            '    $_resultNoPublish: There are no packages need to be published. Either no pubspec change detected or the version has already been published. \n'


cyanglaz · 2021-05-04T21:04:55Z

script/tool/lib/src/publish_check_command.dart

+    final PubVersionFinder pubVersionFinder = PubVersionFinder(
+        package: packageName, httpClient: httpClient ?? http.Client());
+    final PubVersionFinderResponse pubVersionFinderResponse =
+        await pubVersionFinder.getPackageVersion();


We don't need try-catch, but we should check the status of pubVersionFinderResponse. Done.

stuartmorgan-g · 2021-05-05T15:49:56Z

script/tool/CHANGELOG.md

+## NEXT
+
+- Add `against-pub` flag for version-check.
+- Add `log-status` flag for publish-check.


This needs to be updated.

stuartmorgan-g · 2021-05-05T15:51:26Z

script/tool/lib/src/common.dart

+  /// The pub host url, defaults to `https://pub.dev`.
+  final String pubHost;
+
+  /// The http client, can override for testing.


If it's required, then it's not really an override for testing.

script/tool/lib/src/common.dart

stuartmorgan-g · 2021-05-05T15:54:21Z

script/tool/lib/src/common.dart

+  final http.Response httpResponse;
+}
+
+/// An enum represents the result of [PubVersionFinder].


Nit: representing

stuartmorgan-g · 2021-05-05T15:55:04Z

script/tool/lib/src/common.dart


+/// Finding version of [package] that is published on pub.
+///
+/// Note: you should manually close the [httpClient] when done using the finder.


This seems worth noting on the constructor rather than the class.

stuartmorgan-g · 2021-05-05T15:56:12Z

script/tool/lib/src/common.dart

+  final http.Client httpClient;
+
+  /// Get the package version on pub.
+  Future<PubVersionFinderResponse> getPackageVersion() async {


It seems like the class would make more sense as a class if package were an argument here rather than on the constructor. I.e., you configure it for a given server/network setup, then you can query packages.

stuartmorgan-g · 2021-05-05T15:57:02Z

script/tool/lib/src/common.dart

+
+  /// The version finder failed to locate the package.
+  ///
+  /// This is usually OK when the package is new.


Why "usually"? When would it not be okay for a new package not to be found?

reworded, this was not what I meant.

stuartmorgan-g · 2021-05-05T15:59:33Z

script/tool/lib/src/publish_check_command.dart

-    final Colorize passedMessage =
-        Colorize('All packages passed publish check!')..green();
-    print(passedMessage);
+    // This has to be last output of this command because it is promised in the help section.


stuartmorgan-g · 2021-05-05T16:02:14Z

script/tool/lib/src/publish_check_command.dart

+        published = pubVersionFinderResponse.versions.contains(version);
+        break;
+      case PubVersionFinderResult.fail:
+        printErrorAndExit(errorMessage: '''


Won't this break the --machine case, because the final message will never print?

I was thinking this should return something, rather than bailing completely. Is the reason for this that we assume that all the other checks will fail the same way because it's likely a network issue?

If we do want to keep this construction, this line (and the line above) need comments explaining why they are doing what they are doing, since it's non-obvious.

ah ok, I updated to print the message and handled the error later

cyanglaz

Updated per your comments, PTAL @stuartmorgan

cyanglaz · 2021-05-05T17:55:41Z

script/tool/CHANGELOG.md

+## NEXT
+
+- Add `against-pub` flag for version-check.
+- Add `log-status` flag for publish-check.


cyanglaz · 2021-05-05T17:56:15Z

script/tool/lib/src/common.dart


+/// Finding version of [package] that is published on pub.
+///
+/// Note: you should manually close the [httpClient] when done using the finder.


cyanglaz · 2021-05-05T17:56:45Z

script/tool/lib/src/common.dart

+  /// The pub host url, defaults to `https://pub.dev`.
+  final String pubHost;
+
+  /// The http client, can override for testing.


cyanglaz · 2021-05-05T17:57:57Z

script/tool/lib/src/common.dart

+  final http.Client httpClient;
+
+  /// Get the package version on pub.
+  Future<PubVersionFinderResponse> getPackageVersion() async {


script/tool/lib/src/common.dart

cyanglaz · 2021-05-05T18:06:10Z

script/tool/lib/src/common.dart

+  final http.Response httpResponse;
+}
+
+/// An enum represents the result of [PubVersionFinder].


cyanglaz · 2021-05-05T18:07:07Z

script/tool/lib/src/common.dart

+
+  /// The version finder failed to locate the package.
+  ///
+  /// This is usually OK when the package is new.


reworded, this was not what I meant.

cyanglaz · 2021-05-05T18:07:31Z

script/tool/lib/src/publish_check_command.dart

-    final Colorize passedMessage =
-        Colorize('All packages passed publish check!')..green();
-    print(passedMessage);
+    // This has to be last output of this command because it is promised in the help section.


cyanglaz · 2021-05-05T18:12:13Z

script/tool/lib/src/publish_check_command.dart

+        published = pubVersionFinderResponse.versions.contains(version);
+        break;
+      case PubVersionFinderResult.fail:
+        printErrorAndExit(errorMessage: '''


stuartmorgan-g · 2021-05-05T18:36:11Z

script/tool/lib/src/publish_check_command.dart

+        published = pubVersionFinderResponse.versions.contains(version);
+        break;
+      case PubVersionFinderResult.fail:
+        printErrorAndExit(errorMessage: '''


I was thinking this should return something, rather than bailing completely. Is the reason for this that we assume that all the other checks will fail the same way because it's likely a network issue?

If we do want to keep this construction, this line (and the line above) need comments explaining why they are doing what they are doing, since it's non-obvious.

stuartmorgan-g · 2021-05-05T18:39:05Z

script/tool/lib/src/publish_check_command.dart

+Error fetching version on pub for $packageName.
+HTTP Status ${pubVersionFinderResponse.httpResponse.statusCode}
+HTTP response: ${pubVersionFinderResponse.httpResponse.body}
+''');


I'm realizing that failures here are going to be almost impossible to debug, because we won't have any information in the log.

Perhaps we should consider doing something like a JSON dictionary of output, with status and detailed log messages as separate keys? That would mean we'd need to consume the result with something like a Dart script that can parse the JSON, rather than just a one-liner in the GitHub Action. Thoughts?

Good Idea, updated the code to do exactly that

stuartmorgan-g · 2021-05-07T14:57:51Z

script/tool/lib/src/publish_check_command.dart

-      throw ToolExit(1);
+    } else {
+      final Colorize passedMessage =
+          Colorize('All packages passed publish check!')..green();


Looking at the new tests, it's very strange to have terminal color commands in the --machine output. I think we should replace all the Colorize calls with a utility method like:

_printImportantStatusMessage(String message, {@required bool isError}) { if (argResults[_machineFlag] as bool) { print('${isError ? 'ERROR' : 'SUCCESS'}: $message'); } else { final Colorize colorizedMessage = Colorize(message); if (isError) { colorizedMessage.red(); } else { colorizedMessage.green(); } print(colorizedMessage); } }

I updated so that both machine mesasge and human message include the error and success prefix.

cyanglaz

@stuartmorgan Updated the status message bit. PTAL

cyanglaz · 2021-05-10T16:25:46Z

script/tool/lib/src/publish_check_command.dart

-      throw ToolExit(1);
+    } else {
+      final Colorize passedMessage =
+          Colorize('All packages passed publish check!')..green();


I updated so that both machine mesasge and human message include the error and success prefix.

stuartmorgan-g

LGTM!

Chris Yang added 6 commits April 30, 2021 12:22

add version check against pub

b6a1cdd

close client when not used

cf26cd4

close client

46ca9ae

add log

7262ef3

fix tests

3f2d76d

add next flag

497292e

google-cla bot added the cla: yes label Apr 30, 2021

Merge branch 'master' into version_check_pub

c70da8f

cyanglaz requested a review from stuartmorgan-g April 30, 2021 21:21

publish check query pub

e5d149e

cyanglaz changed the title ~~[tool] version check command can check against pub~~ [tool] version-check publish-check commands can check against pub May 1, 2021

Chris Yang added 2 commits May 1, 2021 13:04

add changelog entry

453f8bf

Merge branch 'version_check_pub' of github.com:cyanglaz/plugins into …

8a29e36

…version_check_pub

stuartmorgan-g suggested changes May 3, 2021

View reviewed changes

revuiew

3880f2e

cyanglaz commented May 4, 2021

View reviewed changes

cyanglaz requested a review from stuartmorgan-g May 4, 2021 21:05

stuartmorgan-g suggested changes May 5, 2021

View reviewed changes

cyanglaz commented May 5, 2021

View reviewed changes

cyanglaz requested a review from stuartmorgan-g May 5, 2021 18:12

review

4cd1f65

stuartmorgan-g suggested changes May 5, 2021

View reviewed changes

review

3259241

stuartmorgan-g suggested changes May 7, 2021

View reviewed changes

merge master

6a96692

cyanglaz commented May 10, 2021

View reviewed changes

Chris Yang added 2 commits May 10, 2021 09:27

review

3242c8b

dartfmt

eb5ee5c

stuartmorgan-g approved these changes May 10, 2021

View reviewed changes

Merge branch 'master' into version_check_pub

fc26cbb

analyze

f083fe4

cyanglaz merged commit 0e0c75b into flutter:master May 11, 2021

cyanglaz deleted the version_check_pub branch May 11, 2021 19:48

engine-flutter-autoroll mentioned this pull request May 11, 2021

Roll Plugins from 26c45dc4d575 to 0e0c75b6c2c5 (16 revisions) flutter/flutter#82288

Closed

engine-flutter-autoroll mentioned this pull request May 11, 2021

Roll Plugins from 26c45dc4d575 to 0d6208309b02 (18 revisions) flutter/flutter#82294

Closed

engine-flutter-autoroll mentioned this pull request May 11, 2021

Roll Plugins from 26c45dc4d575 to e674e0dc2b23 (20 revisions) flutter/flutter#82299

Closed

engine-flutter-autoroll mentioned this pull request May 11, 2021

Roll Plugins from 26c45dc4d575 to ad5e88fbbe03 (21 revisions) flutter/flutter#82304

Closed

engine-flutter-autoroll mentioned this pull request May 12, 2021

Roll Plugins from 26c45dc4d575 to 146f54a07d83 (22 revisions) flutter/flutter#82352

Closed

engine-flutter-autoroll mentioned this pull request May 12, 2021

Roll Plugins from 26c45dc4d575 to e88b1d896842 (23 revisions) flutter/flutter#82355

Closed

engine-flutter-autoroll mentioned this pull request May 12, 2021

Roll Plugins from 26c45dc4d575 to 93529ecf8014 (24 revisions) flutter/flutter#82360

Closed

engine-flutter-autoroll mentioned this pull request May 19, 2021

Roll Plugins from 0c99a3ba749b to cb465b7f5418 (40 revisions) flutter/flutter#82923

Closed

engine-flutter-autoroll mentioned this pull request May 19, 2021

Roll Plugins from 0c99a3ba749b to db7e1a545682 (55 revisions) flutter/flutter#82927

Closed

engine-flutter-autoroll mentioned this pull request May 19, 2021

Roll Plugins from 0c99a3ba749b to 4277ce980af0 (58 revisions) flutter/flutter#82932

Merged

[tool] version-check publish-check commands can check against pub #3840

[tool] version-check publish-check commands can check against pub #3840

Uh oh!

Conversation

cyanglaz commented Apr 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

cyanglaz commented Apr 30, 2021 •

edited

Loading