Adds Survey General Access (proto, model, converter) (#2151)

Author: rfontanarosa

proto/src/ground/v1beta1/survey.proto

@@ -71,7 +71,7 @@ message Survey {
   // collecting data.
   DataSharingTerms data_sharing_terms = 6;
 
-  // Defines the survey's current state.
+  // Possible values for the survey's current state.
   enum State {
     // Default value when status is missing.
     STATE_UNSPECIFIED = 0;
@@ -85,6 +85,24 @@ message Survey {
 
   // Defines the survey's current state.
   State state = 7;
+
+  // Possible values for who can access the survey beyond users in the ACLs.
+  enum GeneralAccess {
+    // Default value when general_access is missing.
+    GENERAL_ACCESS_UNSPECIFIED = 0;
+
+    // Only users with the DATA_COLLECTOR role in the survey ACLs can contribute.
+    RESTRICTED = 1;
+
+    // Anyone with a link or QR Code can contribute.
+    UNLISTED = 2;
+
+    // Anyone can contribute.
+    PUBLIC = 3;
+  }
+
+  // Defines who can access the survey beyond users in the ACLs.
+  GeneralAccess general_access = 8;
 }
 
 // Defines a user's role in a survey.

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

@@ -13,14 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import {DocumentData} from '@angular/fire/firestore';
 import {toMessage} from '@ground/lib';
 import {GroundProtos} from '@ground/proto';
 import {List, Map} from 'immutable';
 
 import {DataCollectionStrategy, Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {DataSharingType, Survey, SurveyState} from 'app/models/survey.model';
+import {
+  DataSharingType,
+  Survey,
+  SurveyGeneralAccess,
+  SurveyState,
+} from 'app/models/survey.model';
 import {
   Cardinality,
   MultipleChoice,
@@ -47,7 +53,7 @@ export const MODEL_ROLES = Map([
   [Pb.Role.VIEWER, Role.VIEWER],
 ]);
 
-const DATA_SHARING_MODEL_TYPE = Map([
+const MODEL_SHARING_MODEL_TYPES = Map([
   [Pb.Survey.DataSharingTerms.Type.PRIVATE, DataSharingType.PRIVATE],
   [Pb.Survey.DataSharingTerms.Type.PUBLIC_CC0, DataSharingType.PUBLIC],
   [Pb.Survey.DataSharingTerms.Type.CUSTOM, DataSharingType.CUSTOM],
@@ -58,14 +64,20 @@ const MODEL_STATES = Map([
   [Pb.Survey.State.READY, SurveyState.READY],
 ]);
 
+const MODEL_VISIBILITIES = Map([
+  [Pb.Survey.GeneralAccess.RESTRICTED, SurveyGeneralAccess.RESTRICTED],
+  [Pb.Survey.GeneralAccess.UNLISTED, SurveyGeneralAccess.UNLISTED],
+  [Pb.Survey.GeneralAccess.PUBLIC, SurveyGeneralAccess.PUBLIC],
+]);
+
 function dataSharingTypeFromProto(
   protoType?: Pb.Survey.DataSharingTerms.Type | null
 ) {
   if (!protoType) {
     return DataSharingType.PRIVATE;
   }
 
-  const dataSharingType = DATA_SHARING_MODEL_TYPE.get(protoType);
+  const dataSharingType = MODEL_SHARING_MODEL_TYPES.get(protoType);
 
   if (!dataSharingType) {
     return DataSharingType.PRIVATE;
@@ -212,6 +224,7 @@ export function surveyDocToModel(
       type: dataSharingTypeFromProto(pb.dataSharingTerms?.type),
       customText: pb.dataSharingTerms?.customText ?? undefined,
     },
-    MODEL_STATES.get(pb.state)
+    MODEL_STATES.get(pb.state),
+    MODEL_VISIBILITIES.get(pb.generalAccess) || SurveyGeneralAccess.RESTRICTED
   );
 }

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

@@ -50,6 +50,13 @@ export enum SurveyState {
   READY = 2,
 }
 
+/** Enum for survey's current general access. */
+export enum SurveyGeneralAccess {
+  RESTRICTED = 1,
+  UNLISTED = 2,
+  PUBLIC = 3,
+}
+
 export class Survey extends Copiable {
   static readonly UNSAVED_NEW = new Survey(
     /* id= */
@@ -66,7 +73,8 @@ export class Survey extends Copiable {
     '',
     /* dataSharingTerms= */
     {type: DataSharingType.PRIVATE},
-    SurveyState.UNSAVED
+    SurveyState.UNSAVED,
+    SurveyGeneralAccess.RESTRICTED
   );
 
   constructor(
@@ -77,7 +85,8 @@ export class Survey extends Copiable {
     readonly acl: ImmutableMap<string, Role>,
     readonly ownerId: string,
     readonly dataSharingTerms: {type: DataSharingType; customText?: string},
-    readonly state?: SurveyState
+    readonly state?: SurveyState,
+    readonly generalAccess?: SurveyGeneralAccess
   ) {
     super();
   }

web/src/testing/test-data.ts

@@ -18,7 +18,12 @@ import {Map} from 'immutable';
 
 import {DataCollectionStrategy, Job} from 'app/models/job.model';
 import {Role} from 'app/models/role.model';
-import {DataSharingType, Survey, SurveyState} from 'app/models/survey.model';
+import {
+  DataSharingType,
+  Survey,
+  SurveyGeneralAccess,
+  SurveyState,
+} from 'app/models/survey.model';
 import {Task} from 'app/models/task/task.model';
 import {User} from 'app/models/user.model';
 
@@ -56,7 +61,8 @@ export class TestData {
       {
         type: DataSharingType.PRIVATE,
       },
-      SurveyState.DRAFT
+      SurveyState.DRAFT,
+      SurveyGeneralAccess.RESTRICTED
     );
   }