Merge pull request #194 from gql-dart/nullsafety

Null Safety

Author: micimize

.github/check_package.sh

@@ -0,0 +1,48 @@
+#/bin/bash
+
+# NOTE:
+#  This is a temporary utility script to help mitigate the need for github action
+#  troubleshooting, and will be deleted either pre-merge or when melos replaces it
+#  (https://github.com/gql-dart/gql/pull/192)
+
+set -e
+
+PACKAGE=$1
+
+git diff --exit-code
+
+clean_up () {
+    ARG=$?
+    git checkout .
+    exit $ARG
+} 
+
+trap clean_up EXIT
+
+# Check pubspec
+multipack --only $PACKAGE pubspec clean
+multipack --only $PACKAGE exec git diff --exit-code pubspec.yaml
+
+# Override local dependencies
+multipack pubspec hard_override
+
+multipack --only $PACKAGE pub get
+
+# Check formatting
+echo ""
+echo "A list of incorrectly formatted files may follow:"
+echo ""
+multipack --only $PACKAGE fmt -n . --set-exit-if-changed
+echo ""
+
+# Analyze package
+multipack --only $PACKAGE analyze --version
+multipack --only $PACKAGE analyze --fatal-warnings --no-hints .
+
+# Run tests
+# mockito requires build runner now
+multipack --only $PACKAGE pub run build_runner build --delete-conflicting-outputs || true
+multipack --only $PACKAGE exec [ -d ./test ] || exit 0
+multipack --only $PACKAGE pub run test
+
+git checkout .

.github/workflows/dart.yml

@@ -4,6 +4,7 @@ on: pull_request
 jobs:
   packages:
     strategy:
+      fail-fast: false
       matrix:
         package:
           - gql
@@ -16,13 +17,11 @@ jobs:
           - gql_error_link
           - gql_http_link
           - gql_websocket_link
-          - gql_link
           - gql_transform_link
           - cats
-          - gql_example_http_auth_link
     runs-on: ubuntu-latest
     container:
-      image: google/dart:latest
+      image: google/dart
     name: Check ${{ matrix.package }}
     env:
       PACKAGE: ${{ matrix.package }}
@@ -50,24 +49,32 @@ jobs:
           echo ""
           multipack --only $PACKAGE fmt -n . --set-exit-if-changed
           echo ""
+      - name: Run build_runner if necessary
+        run: |
+          multipack --only $PACKAGE pub run \
+            build_runner build --delete-conflicting-outputs || true
       - name: Analyze package
         run: |
           multipack --only $PACKAGE analyze --version
           multipack --only $PACKAGE analyze --fatal-warnings --no-hints .
       - name: Run tests
         run: |
-          multipack --only $PACKAGE exec [ ! -d ./test ] && exit 0
+          multipack --only $PACKAGE exec [ -d ./test ] || exit 0
           multipack --only $PACKAGE pub run test
   examples:
     strategy:
+      fail-fast: false
       matrix:
         package:
           - gql_example_cli
           - gql_example_cli_github
           - gql_example_build
+          - gql_example_http_auth_link
+          - gql_example_dio_link
+          # gql_example_flutter would require flutter
     runs-on: ubuntu-latest
     container:
-      image: google/dart:latest
+      image: google/dart
     name: Check ${{ matrix.package }}
     env:
       PACKAGE: ${{ matrix.package }}
@@ -90,7 +97,8 @@ jobs:
           multipack --only $PACKAGE pub get
       - name: Run builders
         run: |
-          multipack --only $PACKAGE pub run build_runner build --delete-conflicting-outputs
+          multipack --only $PACKAGE pub run \
+            build_runner build --delete-conflicting-outputs || true
       - name: Check build diff
         run: |
           multipack --only $PACKAGE exec git diff --exit-code **/*.gql.dart
@@ -112,7 +120,7 @@ jobs:
           - end_to_end_test
     runs-on: ubuntu-latest
     container:
-      image: google/dart:latest
+      image: google/dart
     name: Check ${{ matrix.package }}
     env:
       PACKAGE: ${{ matrix.package }}
@@ -152,13 +160,13 @@ jobs:
           multipack --only $PACKAGE analyze --fatal-warnings --no-hints .
       - name: Run tests
         run: |
-          multipack --only $PACKAGE exec [ ! -d ./test ] && exit 0
+          multipack --only $PACKAGE exec [ -d ./test ] || exit 0
           multipack --only $PACKAGE pub run test
 
   publish_dry_run:
     runs-on: ubuntu-latest
     container:
-      image: google/dart:latest
+      image: google/dart
     env:
       PACKAGES: 'gql,gql_build,gql_code_builder,gql_dedupe_link,gql_dio_link,gql_exec,gql_http_link,gql_link,gql_pedantic,gql_transform_link,gql_error_link,gql_websocket_link'
       PUB_ACCESS_TOKEN: ${{ secrets.PUB_ACCESS_TOKEN }}
@@ -177,13 +185,26 @@ jobs:
         run: |
           multipack --only $PACKAGES pubspec sync-versions
       - name: Publish packages
+        shell: bash
+        continue-on-error: true
         run: |
           echo "{\"accessToken\":\"$PUB_ACCESS_TOKEN\",\"refreshToken\":\"$PUB_REFRESH_TOKEN\",\"idToken\":null,\"tokenEndpoint\":\"https://accounts.google.com/o/oauth2/token\",\"scopes\":[\"openid\",\"https://www.googleapis.com/auth/userinfo.email\"],\"expiration\":1588334512218}" > $HOME/.pub-cache/credentials.json
-          multipack --only $PACKAGES pub publish --dry-run
+
+          ## BEGIN TEMPORARY WORKAROUND FOR https://github.com/google/built_value.dart/issues/1032
+          ## See dry_run_workaround_helpers.sh for more details
+          source .github/workflows/dry_run_workaround_helpers.sh
+
+          multipack --only $PACKAGES exec 'pub publish --dry-run 2>&1' | cap
+
+          ignore_err_when_stdout_contains \
+            'Publishing gql_build' \
+            'Package has 1 warning' \
+            'package:built_value_generator/built_value_generator.dart is opting out of null safety' \
+
   check_svg:
     runs-on: ubuntu-latest
     container:
-      image: google/dart:latest
+      image: google/dart
     steps:
       - name: Clone repository
         uses: actions/checkout@v2

.github/workflows/dry_run_workaround_helpers.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+##
+## TEMPORARY WORKAROUND HELPERS FOR https://github.com/google/built_value.dart/issues/1032
+##
+## once built_value_generator is implemented nullsafe this can be deleted
+## and the workflow can be reset to just:
+## `multipack --only $PACKAGES pub publish --dry-run`
+##
+
+# capture the output of a command so it can be retrieved with ret
+cap () { tee /tmp/capture.out; }
+
+# return the output of the most recent command that was captured by cap
+ret () { cat /tmp/capture.out; }
+
+# ignore err when stdout contains all of the given strings
+ignore_err_when_stdout_contains() {
+  code=$?
+  if [[ "$code" == "0" ]]; then
+    return 0
+  fi
+  output=`ret`
+  for search in $@
+  do
+    if [[ "$output" != *"$search"* ]]; then
+      return $code
+    fi
+  done
+}
+

.gitignore

@@ -15,3 +15,5 @@ doc/api/
 .vscode/
 
 **/*.iml
+
+**/test/**/*.mocks.dart

cats/lib/src/cat_builder.dart

@@ -67,7 +67,7 @@ class CatBuilder {
     );
   }
 
-  Iterable<TestCase> buildTests(YamlNode node, Directory folder) {
+  Iterable<TestCase>? buildTests(YamlNode? node, Directory folder) {
     if (node is YamlList) {
       return node.map((n) => buildTest(n, folder));
     }
@@ -110,7 +110,7 @@ class CatBuilder {
     );
   }
 
-  Action buildAction(YamlMap node) {
+  Action? buildAction(YamlMap node) {
     if (node.containsKey('parse')) {
       return ParsingAction();
     }
@@ -135,7 +135,7 @@ class CatBuilder {
     return null;
   }
 
-  Iterable<Assertion> buildAssertions(YamlNode node) {
+  Iterable<Assertion?>? buildAssertions(YamlNode? node) {
     if (node is YamlList) {
       return node.map((n) => buildAssertion(n));
     }
@@ -147,17 +147,17 @@ class CatBuilder {
     return null;
   }
 
-  Assertion buildAssertion(YamlNode node) {
+  Assertion? buildAssertion(YamlNode? node) {
     if (node is YamlMap) {
       if (node.containsKey('passes')) {
         return PassesAssertion(
-          passes: node['passes'] as bool,
+          passes: node['passes'] as bool?,
         );
       }
 
       if (node.containsKey('syntax-error')) {
         return SyntaxErrorAssertion(
-          syntaxError: node['syntax-error'] as bool,
+          syntaxError: node['syntax-error'] as bool?,
         );
       }