Removed outdated logic for determining survey creation status

proto/src/ground/v1beta1/survey.proto

@@ -70,6 +70,21 @@ message Survey {
   // Defines the terms data collectors must agree to before
   // collecting data.
   DataSharingTerms data_sharing_terms = 6;
+
+  // Defines the survey's current state.
+  enum State {
+    // Default value when status is missing.
+    STATE_UNSPECIFIED = 0;
+
+    // Indicates the survey organizer has not yet completed the survey creation flow.
+    DRAFT = 1;
+
+    // Survey is ready to be used/edited.
+    READY = 2;
+  }
+
+  // Defines the survey's current state.
+  State state = 7;
 }
 
 // Defines a user's role in a survey.

web/src/app/components/survey-list/survey-list.component.spec.ts

@@ -30,7 +30,7 @@ import {of} from 'rxjs';
 import {AclEntry} from 'app/models/acl-entry.model';
 import {Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {DataSharingType, Survey} from 'app/models/survey.model';
+import {DataSharingType, Survey, SurveyState} from 'app/models/survey.model';
 import {Task, TaskType} from 'app/models/task/task.model';
 import {AuthService} from 'app/services/auth/auth.service';
 import {NavigationService} from 'app/services/navigation/navigation.service';
@@ -88,7 +88,8 @@ describe('SurveyListComponent', () => {
       ),
     }),
     /* acl= */ Map(),
-    {type: DataSharingType.PRIVATE}
+    {type: DataSharingType.PRIVATE},
+    SurveyState.READY
   );
 
   const surveyServiceSpy = jasmine.createSpyObj('SurveyService', [

web/src/app/components/survey-list/survey-list.component.ts

@@ -18,7 +18,7 @@ import {Component, OnDestroy, OnInit} from '@angular/core';
 import {List} from 'immutable';
 import {Subscription} from 'rxjs';
 
-import {Survey} from 'app/models/survey.model';
+import {Survey, SurveyState} from 'app/models/survey.model';
 import {NavigationService} from 'app/services/navigation/navigation.service';
 import {SurveyService} from 'app/services/survey/survey.service';
 
@@ -62,6 +62,7 @@ export class SurveyListComponent implements OnInit, OnDestroy {
   onNewSurvey() {
     this.navigationService.navigateToCreateSurvey(null);
   }
+
   /**
    * Clean up Rx subscription when cleaning up the component.
    */
@@ -70,19 +71,6 @@ export class SurveyListComponent implements OnInit, OnDestroy {
   }
 
   private isSetupFinished(survey: Survey): boolean {
-    // To make it simple we are not checking the LOIs here since defining tasks is the step after defining LOIs.
-    return this.hasTitle(survey) && this.hasJob(survey) && this.hasTask(survey);
-  }
-
-  private hasTitle(survey: Survey): boolean {
-    return survey.title.trim().length > 0;
-  }
-
-  private hasJob(survey: Survey): boolean {
-    return survey.jobs.size > 0;
-  }
-
-  private hasTask(survey: Survey): boolean {
-    return survey.jobs.valueSeq().some(job => (job.tasks?.size || 0) > 0);
+    return survey.state === SurveyState.READY;
   }
 }

web/src/app/converters/firebase-data-converter.ts

@@ -15,7 +15,7 @@
  */
 
 import {DocumentData, Timestamp} from '@angular/fire/firestore';
-import {List, Map} from 'immutable';
+import {Map} from 'immutable';
 
 import {AuditInfo} from 'app/models/audit-info.model';
 import {Job} from 'app/models/job.model';

web/src/app/converters/proto-model-converter.ts

@@ -21,7 +21,7 @@ import {List, Map} from 'immutable';
 
 import {Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {DataSharingType} from 'app/models/survey.model';
+import {DataSharingType, SurveyState} from 'app/models/survey.model';
 import {
   Cardinality,
   MultipleChoice,
@@ -38,6 +38,11 @@ const PB_ROLES = Map([
   [Role.VIEWER, Pb.Role.VIEWER],
 ]);
 
+const PB_STATES = Map([
+  [SurveyState.DRAFT, Pb.Survey.State.DRAFT],
+  [SurveyState.READY, Pb.Survey.State.READY],
+]);
+
 /**
  * Converts Role instance to its proto message type.
  */
@@ -72,29 +77,39 @@ export function newSurveyToDocument(
   name: string,
   description: string,
   acl: Map<string, Role>,
-  ownerId: string
+  ownerId: string,
+  state: SurveyState
 ): DocumentData | Error {
   return toDocumentData(
     new Pb.Survey({
       name,
       description,
       acl: acl.map(role => roleToProtoRole(role)).toObject(),
       ownerId,
+      state: PB_STATES.get(state),
     })
   );
 }
 
 /**
  * Returns the proto representation of a partial Survey model object.
  */
-export function partialSurveyToDocument(
-  name: string,
-  description?: string
-): DocumentData | Error {
+export function partialSurveyToDocument({
+  name,
+  description,
+  state,
+}: {
+  name?: string;
+  description?: string;
+  state?: SurveyState;
+}): DocumentData | Error {
   return toDocumentData(
     new Pb.Survey({
-      name,
+      ...(name && {name}),
       ...(description && {description}),
+      ...(state && {
+        state: PB_STATES.get(state),
+      }),
     })
   );
 }

web/src/app/converters/survey-data-converter.ts

@@ -20,7 +20,7 @@
 
 import {DataCollectionStrategy, Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {DataSharingType, Survey} from 'app/models/survey.model';
+import {DataSharingType, Survey, SurveyState} from 'app/models/survey.model';
 import {
   Cardinality,
   MultipleChoice,
@@ -73,6 +73,11 @@
   [Pb.Survey.DataSharingTerms.Type.CUSTOM, DataSharingType.CUSTOM],
 ]);
 
+const MODEL_STATES = Map([
+  [Pb.Survey.State.DRAFT, SurveyState.DRAFT],
+  [Pb.Survey.State.READY, SurveyState.READY],
+]);
+
 function dataSharingTypeFromProto(
   protoType?: Pb.Survey.DataSharingTerms.Type | null
 ) {
@@ -230,7 +235,8 @@
     {
       type: dataSharingTypeFromProto(pb.dataSharingTerms?.type),
       customText: pb.dataSharingTerms?.customText ?? undefined,
-    }
+    },
+    MODEL_STATES.get(pb.state)
   );
 }
 
@@ -262,7 +268,8 @@
       {
         type: dataSharingTypeFromProto(data.dataSharingTerms.type),
         customText: data.dataSharingTerms.customText,
-      }
+      },
+      data.state
     );
   }
 
@@ -384,7 +391,7 @@
     return new TaskCondition(
       map?.matchType,
       List(
         map?.expressions?.map((expression: any) => ({
           expressionType: expression.expressionType,
           taskId: expression.taskId,
           optionIds: List(expression.optionIds),

web/src/app/models/survey.model.ts

@@ -27,6 +27,13 @@ export enum DataSharingType {
   CUSTOM = 3,
 }
 
+/** Enum for survey's current state. */
+export enum SurveyState {
+  UNSAVED = 0,
+  DRAFT = 1,
+  READY = 2,
+}
+
 export class Survey extends Copiable {
   static readonly UNSAVED_NEW = new Survey(
     /* id= */
@@ -40,7 +47,8 @@ export class Survey extends Copiable {
     /* acl= */
     Map<string, Role>(),
     /* dataSharingTerms= */
-    {type: DataSharingType.PRIVATE}
+    {type: DataSharingType.PRIVATE},
+    SurveyState.UNSAVED
   );
 
   constructor(
@@ -49,7 +57,8 @@ export class Survey extends Copiable {
     readonly description: string,
     readonly jobs: Map<string, Job>,
     readonly acl: Map<string, Role>,
-    readonly dataSharingTerms: {type: DataSharingType; customText?: string}
+    readonly dataSharingTerms: {type: DataSharingType; customText?: string},
+    readonly state?: SurveyState
   ) {
     super();
   }
@@ -58,16 +67,6 @@ export class Survey extends Copiable {
     return this.jobs.get(jobId);
   }
 
-  isUnsavedNew() {
-    return (
-      !this.id &&
-      !this.title &&
-      !this.description &&
-      !this.jobs.size &&
-      !this.acl.size
-    );
-  }
-
   getJobsSorted(): List<Job> {
     return this.jobs.sortBy(job => job.index).toList();
   }

web/src/app/pages/create-survey/create-survey.component.spec.ts

@@ -28,9 +28,9 @@ import {ActivatedRoute} from '@angular/router';
 import {List, Map} from 'immutable';
 import {Observable, Subject} from 'rxjs';
 
-import {DataCollectionStrategy, Job} from 'app/models/job.model';
+import {Job} from 'app/models/job.model';
 import {LocationOfInterest} from 'app/models/loi.model';
-import {DataSharingType, Survey} from 'app/models/survey.model';
+import {DataSharingType, Survey, SurveyState} from 'app/models/survey.model';
 import {Task, TaskType} from 'app/models/task/task.model';
 import {
   CreateSurveyComponent,
@@ -118,7 +118,8 @@ describe('CreateSurveyComponent', () => {
       job001: jobWithTask,
     }),
     /* acl= */ Map(),
-    {type: DataSharingType.PRIVATE}
+    {type: DataSharingType.PRIVATE},
+    SurveyState.READY
   );
   beforeEach(waitForAsync(() => {
     navigationServiceSpy = jasmine.createSpyObj<NavigationService>(

web/src/app/pages/create-survey/create-survey.component.ts

@@ -20,7 +20,7 @@ import {filter, first, firstValueFrom} from 'rxjs';
 
 import {Job} from 'app/models/job.model';
 import {LocationOfInterest} from 'app/models/loi.model';
-import {Survey} from 'app/models/survey.model';
+import {Survey, SurveyState} from 'app/models/survey.model';
 import {DataSharingTermsComponent} from 'app/pages/create-survey/data-sharing-terms/data-sharing-terms.component';
 import {JobDetailsComponent} from 'app/pages/create-survey/job-details/job-details.component';
 import {SurveyDetailsComponent} from 'app/pages/create-survey/survey-details/survey-details.component';
@@ -100,15 +100,14 @@ export class CreateSurveyComponent implements OnInit {
   }
 
   private isSetupFinished(survey: Survey): boolean {
-    // To make it simple we are not checking the LOIs here since defining tasks is the step after defining LOIs.
-    return this.hasTitle(survey) && this.hasJob(survey) && this.hasTask(survey);
+    return survey.state === SurveyState.READY;
   }
 
   private getSetupPhase(
     survey: Survey,
     lois: Immutable.List<LocationOfInterest>
   ): SetupPhase {
-    if (this.hasTask(survey)) {
+    if (survey.state === SurveyState.READY) {
       return SetupPhase.DEFINE_DATA_SHARING_TERMS;
     }
     if (!lois.isEmpty()) {
@@ -127,14 +126,6 @@ export class CreateSurveyComponent implements OnInit {
     return survey.title.trim().length > 0;
   }
 
-  private hasJob(survey: Survey): boolean {
-    return survey.jobs.size > 0;
-  }
-
-  private hasTask(survey: Survey): boolean {
-    return survey.jobs.valueSeq().some(job => (job.tasks?.size || 0) > 0);
-  }
-
   readonly setupPhaseToTitle = new Map<SetupPhase, String>([
     [SetupPhase.SURVEY_DETAILS, 'Create survey'],
     [SetupPhase.JOB_DETAILS, 'Add a job'],
@@ -287,13 +278,19 @@ export class CreateSurveyComponent implements OnInit {
 
   private async saveDataSharingTerms() {
     const type = this.dataSharingTerms?.formGroup.controls.type.value;
+
     const customText =
       this.dataSharingTerms?.formGroup.controls.customText.value ?? undefined;
-    await this.surveyService.updateDataSharingTerms(
-      this.survey!.id,
-      type,
-      customText
-    );
+
+    await Promise.all([
+      this.surveyService.updateDataSharingTerms(
+        this.survey!.id,
+        type,
+        customText
+      ),
+
+      this.surveyService.updateStatus(this.survey!.id, SurveyState.READY),
+    ]);
   }
 
   @ViewChild('surveyLoi')

web/src/app/pages/main-page-container/main-page/main-page.component.ts

@@ -19,7 +19,7 @@ import {MatDialog} from '@angular/material/dialog';
 import {Observable, Subscription} from 'rxjs';
 import {take} from 'rxjs/operators';
 
-import {Survey} from 'app/models/survey.model';
+import {Survey, SurveyState} from 'app/models/survey.model';
 import {AuthService} from 'app/services/auth/auth.service';
 import {LocationOfInterestService} from 'app/services/loi/loi.service';
 import {NavigationService} from 'app/services/navigation/navigation.service';
@@ -109,9 +109,10 @@ export class MainPageComponent implements OnInit {
       this.dialog.open(JobDialogComponent, {
         autoFocus: jobId === NavigationService.JOB_ID_NEW,
         data: {
-          surveyId: survey.isUnsavedNew()
-            ? NavigationService.SURVEY_ID_NEW
-            : survey.id,
+          surveyId:
+            survey.state === SurveyState.UNSAVED
+              ? NavigationService.SURVEY_ID_NEW
+              : survey.id,
           createJob: jobId === NavigationService.SURVEY_ID_NEW,
           job: survey.jobs?.get(jobId),
         },