Read Submissions from Firestore using new proto-based format (#1918)

Co-authored-by: Sufyan Abbasi <[email protected]>

Author: rfontanarosa

functions/src/common/datastore.ts

@@ -17,6 +17,7 @@
 import * as functions from 'firebase-functions';
 import {firestore} from 'firebase-admin';
 import {DocumentData, GeoPoint, QuerySnapshot} from 'firebase-admin/firestore';
+import {FieldNumbers} from '@ground/lib/dist/proto-field-numbers';
 
 /**
  *
@@ -119,7 +120,7 @@ export class Datastore {
   fetchSubmissionsByJobId(surveyId: string, jobId: string) {
     return this.db_
       .collection(submissions(surveyId))
-      .where('jobId', '==', jobId)
+      .where(FieldNumbers.Submission.job_id, '==', jobId)
       .get();
   }
 
@@ -133,7 +134,7 @@ export class Datastore {
   ): Promise<QuerySnapshot<DocumentData, DocumentData>> {
     return this.db_
       .collection(lois(surveyId))
-      .where('jobId', '==', jobId)
+      .where(FieldNumbers.LocationOfInterest.job_id, '==', jobId)
       .get();
   }
 
@@ -150,7 +151,11 @@ export class Datastore {
     loiId: string
   ): Promise<number> {
     const submissionsRef = this.db_.collection(submissions(surveyId));
-    const submissionsForLoiQuery = submissionsRef.where('loiId', '==', loiId);
+    const submissionsForLoiQuery = submissionsRef.where(
+      FieldNumbers.Submission.loi_id,
+      '==',
+      loiId
+    );
     const snapshot = await submissionsForLoiQuery.count().get();
     return snapshot.data().count;
   }

functions/src/on-write-submission.spec.ts

@@ -25,6 +25,7 @@ import * as functions from './index';
 import {loi} from './common/datastore';
 import {Firestore} from 'firebase-admin/firestore';
 import {resetDatastore} from './common/context';
+import {FieldNumbers} from '@ground/lib';
 
 const test = require('firebase-functions-test')();
 
@@ -62,7 +63,7 @@ describe('onWriteSubmission()', () => {
       .and.returnValue({
         where: jasmine
           .createSpy('where')
-          .withArgs('loiId', '==', loiId)
+          .withArgs(FieldNumbers.Submission.loi_id, '==', loiId)
           .and.returnValue(newCountQuery(count)),
       } as any);
   }

lib/src/firestore-to-proto.ts

@@ -118,6 +118,8 @@ function toFieldValue(
     case 'bool':
     case 'double':
       return firestoreValue;
+    case '.google.protobuf.Timestamp':
+      return toMessageOrEnumValue(['google', 'protobuf'], 'Timestamp', firestoreValue);
     default:
       return toMessageOrEnumValue(messageTypePath, fieldType, firestoreValue);
   }

lib/src/index.ts

@@ -17,3 +17,4 @@
 export {toDocumentData} from './proto-to-firestore';
 export {toMessage} from './firestore-to-proto';
 export {deleteEmpty, isEmpty} from './obj-util';
+export {FieldNumbers} from './proto-field-numbers';

lib/src/proto-field-numbers.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright 2024 The Ground Authors.
+ *
+ * Licensed 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
+ *
+ *     https://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.
+ */
+
+export const FieldNumbers = {
+  LocationOfInterest: {
+    job_id: '2',
+    owner_id: '5',
+    source: '9'
+  },
+  Submission: {
+    loi_id: '2',
+    job_id: '4',
+    owner_id: '5'
+  },
+  Survey: {
+    acl: '4',
+    owner_id: '5'
+  }
+};

package-lock.json

@@ -12,7 +12,7 @@
     "build-all-and-test": "npm run build-all && npm run test",
     "watch": "npm run build -- --watch",
     "start": "npm run build && ng serve -c $npm_config_config",
-    "build-and-start": "npm run build && npm run start",    
+    "build-and-start": "npm run build && npm run start",
     "build-all-and-start": "npm run build-all && npm run start",
     "pretest": "./pretest.sh",
     "test": "ng test",
@@ -50,6 +50,7 @@
     "functions": "^1.0.9",
     "hammerjs": "^2.0.8",
     "immutable": "^4.3.6",
+    "long": "^5.2.3",
     "ngx-autosize-input": "^17",
     "ngx-color": "^9.0.0",
     "rxjs": "^7.5.7",

web/package.json

@@ -14,141 +14,11 @@
  * limitations under the License.
  */
 
-import {Timestamp} from '@angular/fire/firestore';
-import {List, Map} from 'immutable';
-
-import {Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {Submission} from 'app/models/submission/submission.model';
-import {
-  Cardinality,
-  MultipleChoice,
-} from 'app/models/task/multiple-choice.model';
-import {Option} from 'app/models/task/option.model';
-import {Task, TaskType} from 'app/models/task/task.model';
 
 import {FirebaseDataConverter} from './firebase-data-converter';
 
-class MockFirebaseData {
-  static submission001 = {
-    created: {
-      clientTimestamp: undefined,
-      serverTimestamp: undefined,
-      user: {
-        displayName: 'Creator',
-        email: '[email protected]',
-        id: 'creator001',
-      },
-    },
-    lastModified: {
-      clientTimestamp: undefined,
-      serverTimestamp: undefined,
-      user: {
-        displayName: 'Modifier',
-        email: '[email protected]',
-        id: 'modifier001',
-      },
-    },
-    loiId: 'loi001',
-    jobId: 'job001',
-    data: {
-      task001: 'text result',
-      task002: ['option001', 'option002'],
-      task003: 123,
-      task004: new Timestamp(1641533340, 0),
-      task005: new Timestamp(1641534444, 0),
-    },
-  };
-}
-
-class MockModel {
-  static task001: Task = new Task(
-    'task001',
-    TaskType.TEXT,
-    'Text Field',
-    /*required=*/ true,
-    0
-  );
-
-  static task002: Task = new Task(
-    'task002',
-    TaskType.MULTIPLE_CHOICE,
-    'Multiple Select',
-    /*required=*/ true,
-    1,
-    new MultipleChoice(
-      Cardinality.SELECT_MULTIPLE,
-      List([
-        new Option(
-          'option001',
-          'code001',
-          'option 1',
-          /* index= */
-          0
-        ),
-        new Option(
-          'option002',
-          'code002',
-          'option 2',
-          /* index= */
-          0
-        ),
-      ])
-    )
-  );
-
-  static task003: Task = new Task(
-    'task003',
-    TaskType.NUMBER,
-    'How many sloths are there?',
-    /*required=*/ true,
-    2
-  );
-
-  static task004: Task = new Task(
-    'task004',
-    TaskType.DATE,
-    'What is the current date?',
-    /*required=*/ true,
-    2
-  );
-
-  static task005: Task = new Task(
-    'task005',
-    TaskType.TIME,
-    'What time is it?',
-    /*required=*/ true,
-    2
-  );
-
-  static job001: Job = new Job(
-    /* id= */ 'job001',
-    /* index= */ 0,
-    '#ffffff',
-    'Test job',
-    Map({
-      task001: MockModel.task001,
-      task002: MockModel.task002,
-      task003: MockModel.task003,
-      task004: MockModel.task004,
-      task005: MockModel.task005,
-    })
-  );
-}
-
 describe('FirebaseDataConverter', () => {
-  it('Submission converts back and forth without loosing data.', () => {
-    expect(
-      FirebaseDataConverter.submissionToJS(
-        FirebaseDataConverter.toSubmission(
-          MockModel.job001,
-          'submission001',
-          MockFirebaseData.submission001
-        ) as Submission
-      )
-    ).toEqual(MockFirebaseData.submission001);
-  });
-
   describe('toRole()', () => {
     it('converts enums to strings', () => {
       expect(FirebaseDataConverter.toRoleId(Role.OWNER)).toEqual('OWNER');