Adding github action to validate contextual survey json (#104)

* Adding schema + yml for workflow * Use action with dart file instead * Using dart code to validate json instead * Delete contextual-survey-schema.json * Formatting * Set upper bound for sampling rate * Update contextual-json-validator.yml * Revert "Update contextual-json-validator.yml" This reverts commit e93cf9e. * Update contextual-json-validator.yml * Update contextual-json-validator.yml * Apply suggestions from code review Co-authored-by: Parker Lougheed <[email protected]> * Apply analysis fixes * Variable for `surveyObject` keys * Apply suggestions from code review * Adding new analyze job --------- Co-authored-by: Parker Lougheed <[email protected]>
flutter · Aug 22, 2023 · e8d9eee · e8d9eee
1 parent a4e5fc1
commit e8d9eee
Show file tree

Hide file tree

Showing 3 changed files with 204 additions and 2 deletions.
diff --git a/.github/workflows/contextual-json-validator.yml b/.github/workflows/contextual-json-validator.yml
@@ -0,0 +1,36 @@
+name: contextual-json-validator
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 0' # weekly
+
+permissions:
+  contents: read
+
+jobs:
+  json-yaml-validate:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+        - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
+
+        - run: dart surveys/validator/json-validator.dart
+
+  analyze:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: surveys/validator
+    steps:
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
+      - uses: dart-lang/setup-dart@d6a63dab3335f427404425de0fbfed4686d93c4f
+
+      - name: Verify formatting
+        run: dart format --output=none --set-exit-if-changed .
+
+      - name: Analyze Dart files
+        run: dart analyze --fatal-infos
diff --git a/surveys/contextual-survey-metadata.json b/surveys/contextual-survey-metadata.json
@@ -4,8 +4,8 @@
         "startDate": "2023-07-01T09:00:00-07:00",
         "endDate": "2023-08-31T09:00:00-07:00",
         "description": "Help improve Flutter's release builds with this 3-question survey!",
-        "snoozeForMinutes": "7200",
-        "samplingRate": "0.1",
+        "snoozeForMinutes": 7200,
+        "samplingRate": 0.1,
         "conditions": [
             {
                 "field": "logFileStats.recordCount",

diff --git a/surveys/validator/json-validator.dart b/surveys/validator/json-validator.dart
@@ -0,0 +1,166 @@
+import 'dart:convert';
+import 'dart:io';
+
+void main() {
+  final contextualSurveyFile = File('surveys/contextual-survey-metadata.json');
+  final jsonContents = jsonDecode(contextualSurveyFile.readAsStringSync());
+
+  if (jsonContents is! List) {
+    throw ArgumentError('The json file must be a list');
+  }
+
+  for (final surveyObject in jsonContents) {
+    // Ensure that each list item is a json object / map
+    if (surveyObject is! Map) {
+      throw ArgumentError('Each item in the array must be a map');
+    }
+
+    // Ensure that the number of keys found in each object is correct
+    if (surveyObject.keys.length != requiredKeys.length) {
+      throw ArgumentError(
+          'There should only be ${requiredKeys.length} keys per survey object');
+    }
+
+    // Ensure that the keys themselves match what has been defined
+    final surveyObjectKeySet = surveyObject.keys.toSet();
+    if (surveyObjectKeySet.intersection(requiredKeys).length !=
+        requiredKeys.length) {
+      throw ArgumentError('Missing the following keys: '
+          '${requiredKeys.difference(surveyObjectKeySet).join(', ')}');
+    }
+
+    final uniqueId = surveyObject['uniqueId'] as String;
+    final startDate = DateTime.parse(surveyObject['startDate'] as String);
+    final endDate = DateTime.parse(surveyObject['endDate'] as String);
+    final description = surveyObject['description'] as String;
+    final snoozeForMinutes = surveyObject['snoozeForMinutes'] as int;
+    final samplingRate = surveyObject['samplingRate'] as double;
+    final conditionList = surveyObject['conditions'] as List;
+    final buttonList = surveyObject['buttons'] as List;
+
+    // Ensure all of the string values are not empty
+    if (uniqueId.isEmpty) {
+      throw ArgumentError('Unique ID cannot be an empty string');
+    }
+    if (description.isEmpty) {
+      throw ArgumentError('Description cannot be an empty string');
+    }
+
+    // Validation on the periods
+    if (startDate.isAfter(endDate)) {
+      throw ArgumentError('End date is before the start date');
+    }
+
+    // Ensure the numbers are greater than zero and valid
+    if (snoozeForMinutes == 0) {
+      throw ArgumentError('Snooze minutes must be greater than 0');
+    }
+    if (samplingRate == 0) {
+      throw ArgumentError('Sampling rate must be between 0 and 1 inclusive');
+    }
+    if (samplingRate > 1) {
+      throw ArgumentError('Sampling rate must be between 0 and 1 inclusive');
+    }
+
+    // Validation on the condition array
+    for (final conditionObject in conditionList) {
+      if (conditionObject is! Map) {
+        throw ArgumentError('Each item in the condition array must '
+            'be a map for survey: $uniqueId');
+      }
+      if (conditionObject.keys.length != conditionRequiredKeys.length) {
+        throw ArgumentError('Each condition object should only have '
+            '${conditionRequiredKeys.length} keys');
+      }
+
+      final field = conditionObject['field'] as String;
+      final operator = conditionObject['operator'] as String;
+      final value = conditionObject['value'] as int;
+
+      if (field.isEmpty) {
+        throw ArgumentError('Field in survey: $uniqueId must not be empty');
+      }
+      if (!allowedConditionOperators.contains(operator)) {
+        throw ArgumentError(
+            'Non-valid operator found in condition for survey: $uniqueId');
+      }
+      if (value < 0) {
+        throw ArgumentError('Value for each condition must not be negative');
+      }
+    }
+
+    // Validation on the button array
+    for (final buttonObject in buttonList) {
+      if (buttonObject is! Map) {
+        throw ArgumentError('Each item in the button array must '
+            'be a map for survey: $uniqueId');
+      }
+      if (buttonObject.keys.length != buttonRequiredKeys.length) {
+        throw ArgumentError('Each button object should only have '
+            '${buttonRequiredKeys.length} keys');
+      }
+
+      final buttonText = buttonObject['buttonText'] as String;
+      final action = buttonObject['action'] as String;
+      final url = buttonObject['url'] as String?;
+      // ignore: unused_local_variable
+      final promptRemainsVisible = buttonObject['promptRemainsVisible'] as bool;
+
+      if (buttonText.isEmpty) {
+        throw ArgumentError(
+            'Cannot have empty text for a given button in survey: $uniqueId');
+      }
+      if (!allowedButtonActions.contains(action)) {
+        throw ArgumentError('The action: "$action" is not allowed');
+      }
+      if (url != null && url.isEmpty) {
+        throw ArgumentError('URL values must be a non-empty string or "null"');
+      }
+    }
+  }
+}
+
+/// The allowed action strings for a given button
+const allowedButtonActions = {
+  'accept',
+  'dismiss',
+  'snooze',
+};
+
+/// The allowed operators for a given condition item
+const allowedConditionOperators = {
+  '>=',
+  '<=',
+  '>',
+  '<',
+  '==',
+  '!=',
+};
+
+/// Required keys for the button object
+const buttonRequiredKeys = [
+  'buttonText',
+  'action',
+  'url',
+  'promptRemainsVisible',
+];
+
+/// Required keys for the condition object
+const conditionRequiredKeys = [
+  'field',
+  'operator',
+  'value',
+];
+
+/// The top level keys that must exist for each json object
+/// in the array
+const requiredKeys = {
+  'uniqueId',
+  'startDate',
+  'endDate',
+  'description',
+  'snoozeForMinutes',
+  'samplingRate',
+  'conditions',
+  'buttons',
+};