feat: adding pkg:gcp (#358)

Author: kevmoo

.github/workflows/lint.yml

@@ -39,16 +39,16 @@ jobs:
       - name: mono_repo self validate
         run: dart pub global run mono_repo generate --validate
   job_002:
-    name: "analyze_format; Dart 2.18.0; PKGS: dartfn, functions_framework, functions_framework_builder; `dart analyze`"
+    name: "analyze_format; Dart 2.18.0; PKGS: dartfn, functions_framework, functions_framework_builder, gcp; `dart analyze`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework-functions_framework_builder;commands:analyze_1"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework-functions_framework_builder-gcp;commands:analyze_1"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework-functions_framework_builder
+            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework-functions_framework_builder-gcp
             os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -86,17 +86,26 @@ jobs:
         run: dart analyze
         if: "always() && steps.functions_framework_builder_pub_upgrade.conclusion == 'success'"
         working-directory: functions_framework_builder
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart analyze
+        run: dart analyze
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
   job_003:
-    name: "analyze_format; Dart dev; PKGS: dartfn, functions_framework, functions_framework_builder, integration_test; `dart format --output=none --set-exit-if-changed .`, `dart analyze --fatal-infos`"
+    name: "analyze_format; Dart dev; PKGS: dartfn, functions_framework, functions_framework_builder, gcp, integration_test; `dart format --output=none --set-exit-if-changed .`, `dart analyze --fatal-infos`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework-functions_framework_builder-integration_test;commands:format-analyze_0"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework-functions_framework_builder-gcp-integration_test;commands:format-analyze_0"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework-functions_framework_builder-integration_test
+            os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework-functions_framework_builder-gcp-integration_test
             os:ubuntu-latest;pub-cache-hosted;sdk:dev
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -146,6 +155,19 @@ jobs:
         run: dart analyze --fatal-infos
         if: "always() && steps.functions_framework_builder_pub_upgrade.conclusion == 'success'"
         working-directory: functions_framework_builder
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: "gcp; dart format --output=none --set-exit-if-changed ."
+        run: "dart format --output=none --set-exit-if-changed ."
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
+      - name: "gcp; dart analyze --fatal-infos"
+        run: dart analyze --fatal-infos
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
       - id: integration_test_pub_upgrade
         name: integration_test; dart pub upgrade
         run: dart pub upgrade

.github/workflows/unit.yml

@@ -16,16 +16,16 @@ permissions: read-all
 
 jobs:
   job_001:
-    name: "unit_test; Dart 2.18.0; PKGS: dartfn, functions_framework_builder, integration_test; `dart test`"
+    name: "unit_test; linux; Dart 2.18.0; PKGS: dartfn, functions_framework_builder, gcp, integration_test; `dart test`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework_builder-integration_test;commands:test_0"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework_builder-gcp-integration_test;commands:test_0"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework_builder-integration_test
+            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:dartfn-functions_framework_builder-gcp-integration_test
             os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -54,6 +54,15 @@ jobs:
         run: dart test
         if: "always() && steps.functions_framework_builder_pub_upgrade.conclusion == 'success'"
         working-directory: functions_framework_builder
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart test
+        run: dart test
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
       - id: integration_test_pub_upgrade
         name: integration_test; dart pub upgrade
         run: dart pub upgrade
@@ -64,7 +73,37 @@ jobs:
         if: "always() && steps.integration_test_pub_upgrade.conclusion == 'success'"
         working-directory: integration_test
   job_002:
-    name: "unit_test; Dart dev; PKGS: dartfn, functions_framework, integration_test; `dart test --run-skipped -t presubmit-only`"
+    name: "unit_test; linux; Dart 2.18.0; PKG: gcp; `./tool/docker_test_script.sh`"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cache Pub hosted dependencies
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        with:
+          path: "~/.pub-cache/hosted"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:gcp;commands:command"
+          restore-keys: |
+            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0;packages:gcp
+            os:ubuntu-latest;pub-cache-hosted;sdk:2.18.0
+            os:ubuntu-latest;pub-cache-hosted
+            os:ubuntu-latest
+      - name: Setup Dart SDK
+        uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d
+        with:
+          sdk: "2.18.0"
+      - id: checkout
+        name: Checkout repository
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; ./tool/docker_test_script.sh
+        run: ./tool/docker_test_script.sh
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
+  job_003:
+    name: "unit_test; linux; Dart dev; PKGS: dartfn, functions_framework, integration_test; `dart test --run-skipped -t presubmit-only`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
@@ -111,17 +150,17 @@ jobs:
         run: dart test --run-skipped -t presubmit-only
         if: "always() && steps.integration_test_pub_upgrade.conclusion == 'success'"
         working-directory: integration_test
-  job_003:
-    name: "unit_test; Dart dev; PKGS: dartfn, functions_framework_builder, integration_test; `dart test`"
+  job_004:
+    name: "unit_test; linux; Dart dev; PKGS: dartfn, functions_framework_builder, gcp, integration_test; `dart test`"
     runs-on: ubuntu-latest
     steps:
       - name: Cache Pub hosted dependencies
         uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
         with:
           path: "~/.pub-cache/hosted"
-          key: "os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework_builder-integration_test;commands:test_0"
+          key: "os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework_builder-gcp-integration_test;commands:test_0"
           restore-keys: |
-            os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework_builder-integration_test
+            os:ubuntu-latest;pub-cache-hosted;sdk:dev;packages:dartfn-functions_framework_builder-gcp-integration_test
             os:ubuntu-latest;pub-cache-hosted;sdk:dev
             os:ubuntu-latest;pub-cache-hosted
             os:ubuntu-latest
@@ -150,6 +189,15 @@ jobs:
         run: dart test
         if: "always() && steps.functions_framework_builder_pub_upgrade.conclusion == 'success'"
         working-directory: functions_framework_builder
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart test
+        run: dart test
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
       - id: integration_test_pub_upgrade
         name: integration_test; dart pub upgrade
         run: dart pub upgrade
@@ -159,7 +207,87 @@ jobs:
         run: dart test
         if: "always() && steps.integration_test_pub_upgrade.conclusion == 'success'"
         working-directory: integration_test
-  job_004:
+  job_005:
+    name: "unit_test; macos; Dart 2.18.0; PKG: gcp; `dart test`"
+    runs-on: macos-latest
+    steps:
+      - name: Cache Pub hosted dependencies
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        with:
+          path: "~/.pub-cache/hosted"
+          key: "os:macos-latest;pub-cache-hosted;sdk:2.18.0;packages:gcp;commands:test_0"
+          restore-keys: |
+            os:macos-latest;pub-cache-hosted;sdk:2.18.0;packages:gcp
+            os:macos-latest;pub-cache-hosted;sdk:2.18.0
+            os:macos-latest;pub-cache-hosted
+            os:macos-latest
+      - name: Setup Dart SDK
+        uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d
+        with:
+          sdk: "2.18.0"
+      - id: checkout
+        name: Checkout repository
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart test
+        run: dart test
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
+  job_006:
+    name: "unit_test; macos; Dart dev; PKG: gcp; `dart test`"
+    runs-on: macos-latest
+    steps:
+      - name: Cache Pub hosted dependencies
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7
+        with:
+          path: "~/.pub-cache/hosted"
+          key: "os:macos-latest;pub-cache-hosted;sdk:dev;packages:gcp;commands:test_0"
+          restore-keys: |
+            os:macos-latest;pub-cache-hosted;sdk:dev;packages:gcp
+            os:macos-latest;pub-cache-hosted;sdk:dev
+            os:macos-latest;pub-cache-hosted
+            os:macos-latest
+      - name: Setup Dart SDK
+        uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d
+        with:
+          sdk: dev
+      - id: checkout
+        name: Checkout repository
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart test
+        run: dart test
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
+  job_007:
+    name: "unit_test; windows; Dart dev; PKG: gcp; `dart test`"
+    runs-on: windows-latest
+    steps:
+      - name: Setup Dart SDK
+        uses: dart-lang/setup-dart@6a218f2413a3e78e9087f638a238f6b40893203d
+        with:
+          sdk: dev
+      - id: checkout
+        name: Checkout repository
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8
+      - id: gcp_pub_upgrade
+        name: gcp; dart pub upgrade
+        run: dart pub upgrade
+        if: "always() && steps.checkout.conclusion == 'success'"
+        working-directory: gcp
+      - name: gcp; dart test
+        run: dart test
+        if: "always() && steps.gcp_pub_upgrade.conclusion == 'success'"
+        working-directory: gcp
+  job_008:
     name: Notify failure
     runs-on: ubuntu-latest
     if: "(github.event_name == 'push' || github.event_name == 'schedule') && failure()"
@@ -174,3 +302,7 @@ jobs:
       - job_001
       - job_002
       - job_003
+      - job_004
+      - job_005
+      - job_006
+      - job_007

.markdownlint.yaml

@@ -11,5 +11,5 @@ line_length:              # MD013 max line length
   line_length: 80
 html:                     # MD033 no html
   allowed_elements: [br]
-headings: true            # MD041 require heading at top of file
 images: false             # MD045: image alt text
+first-line-h1: false      # MD041: First line in a file should be a top-level heading

functions_framework/lib/serve.dart

@@ -25,11 +25,10 @@ library serve;
 import 'dart:async';
 import 'dart:io';
 
+import 'package:gcp/gcp.dart';
 import 'package:io/ansi.dart';
 import 'package:io/io.dart';
 
-import 'src/bad_configuration.dart';
-import 'src/cloud_metadata.dart';
 import 'src/function_config.dart';
 import 'src/function_target.dart';
 import 'src/logging.dart';
@@ -89,43 +88,18 @@ Future<void> _serve(
     );
   }
 
-  final projectId = await CloudMetadata.projectId();
-  final loggingMiddleware = createLoggingMiddleware(projectId);
-
-  final completer = Completer<bool>.sync();
-
-  // sigIntSub is copied below to avoid a race condition - ignoring this lint
-  // ignore: cancel_subscriptions
-  StreamSubscription<ProcessSignal>? sigIntSub, sigTermSub;
-
-  Future<void> signalHandler(ProcessSignal signal) async {
-    print('Received signal $signal - closing');
-
-    final subCopy = sigIntSub;
-    if (subCopy != null) {
-      sigIntSub = null;
-      await subCopy.cancel();
-      sigIntSub = null;
-      if (sigTermSub != null) {
-        await sigTermSub!.cancel();
-        sigTermSub = null;
-      }
-      completer.complete(true);
-    }
-  }
-
-  sigIntSub = ProcessSignal.sigint.watch().listen(signalHandler);
-
-  // SIGTERM is not supported on Windows. Attempting to register a SIGTERM
-  // handler raises an exception.
-  if (!Platform.isWindows) {
-    sigTermSub = ProcessSignal.sigterm.watch().listen(signalHandler);
+  String? projectId;
+  try {
+    projectId = await currentProjectId(metadataServerOnly: true);
+  } on BadConfigurationException {
+    // NOOP! - we aren't on GCP, so use normal logging
   }
+  final loggingMiddleware = createLoggingMiddleware(projectId);
 
   await run(
     config.port,
     functionTarget.handler,
-    completer.future,
+    waitForTerminate().then((value) => true),
     loggingMiddleware,
   );
 }