fixup! feat(ng-dev): add support for uploading results of workflow testing to database

Author: josephperrott

.github/workflows/perf.yml

@@ -45,6 +45,10 @@ jobs:
       - uses: ./github-actions/npm/checkout-and-setup-node
       - uses: ./github-actions/bazel/setup
       - run: yarn install --immutable
+      # We utilize the google-github-actions/auth action to allow us to get an active credential using workflow
+      # identity federation. This allows us to request short lived credentials on demand, rather than storing
+      # credentials in secrets long term. More information can be found at:
+      # https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform
       - uses: 'google-github-actions/auth@v2'
         with:
           project_id: 'internal-200822'

ng-dev/perf/workflow/database.ts

@@ -8,12 +8,32 @@
 
 import {Spanner} from '@google-cloud/spanner';
 
+/**
+ * The workflow performance results are stored in a spanner database within our
+ * project to be able to retrieve later, The commit sha will be used as a foreign
+ * key to point to specific commits found in the table of commit shas expressing
+ * the full graph of commits within the git graph for the repository.
+ *
+ * The workflow performance table is defined with the following characteristics.
+ *
+ * |--------------------------------------------------------------------|
+ * |              Column              |     Type     |       Notes      |
+ * |--------------------------------------------------------------------|
+ * |     workflow_performance_id      |  STRING(36)  |   Autogenerated  |
+ * |     commit_sha                   |  STRING(40)  |                  |
+ * |     value                        |  FLOAT64     |                  |
+ * |     name                         |  STRING(256) |                  |
+ * |--------------------------------------------------------------------|
+ */
+
+/** The reuslt of workflow performance eresult to be stored in the database. */
 export interface WorkflowPerformanceRowResult {
   commit_sha: string;
   value: number;
   name: string;
 }
 
+/** Add a single workflow performance result to the spanner database. */
 export async function addWorkflowPerformanceResult(result: WorkflowPerformanceRowResult) {
   /** The spanner client instance. */
   const spanner = new Spanner({
@@ -27,7 +47,7 @@ export async function addWorkflowPerformanceResult(result: WorkflowPerformanceRo
   const workflowPerformanceTable = database.table('WorkflowPerformance');
 
   try {
-    await workflowPerformanceTable.insert([result]);
+    await workflowPerformanceTable.insert(result);
   } finally {
     await database.close();
   }