Merge pull request #1686 from open-data/feature/user-opt-ins

User Opt-in Feature w/ PD DataTable as First One

Author: RabiaSajjad

changes/1686.feature

@@ -0,0 +1 @@
+Users can now opt-in to the new PD DataTable on the Registry. Adds a general `canada-user-opt-in-feature` JS module, along with User validation for the opt-in features.

ckanext/canada/assets/datatables/pd_datatables.js

@@ -60,7 +60,10 @@ function load_pd_datatable(CKAN_MODULE){
   const chromoFields = CKAN_MODULE.options.chromo_fields;
   const isEditable = CKAN_MODULE.options.is_editable;
   const tableStyles = CKAN_MODULE.options.table_styles;
-  const EDITOR = pd_datatables__EDITOR;
+
+  // TODO: Disable Editor - enable Table Editor when ready...
+  // const EDITOR = pd_datatables__EDITOR;
+  const EDITOR = false;
 
   const selectAllLabel = _('Select All');
   const colSearchLabel = _('Search:');
@@ -167,6 +170,10 @@ function load_pd_datatable(CKAN_MODULE){
   let isCompactView = typeof tableState != 'undefined' && typeof tableState.compact_view != 'undefined' ? tableState.compact_view : true;
   let isFullScreen = is_page_fullscreen();
   let isEditMode = typeof tableState != 'undefined' && typeof tableState.edit_view != 'undefined' ? tableState.edit_view : false;
+
+  // TODO: Disable Editor - enable Table Editor when ready...
+  isEditMode = false;
+
   if( isEditMode ){
     $('.pd-datable-instructions').css({'display': 'none'});
   }
@@ -2002,22 +2009,33 @@ function load_pd_datatable(CKAN_MODULE){
         _data.selected = this.api().rows({selected: true})[0];
         _data.compact_view = isCompactView;
         _data.edit_view = isEditMode;
+
+        // TODO: Disable Editor - enable Table Editor when ready...
+        _data.edit_view = false;
+
         _data.editing_rows = editingRows;
         // TODO: save filledRows, erroredRows, requiredRows??? need to save the field values too???
         let localInstanceSelected = typeof tableState != 'undefined' ? tableState.selected : _data.selected;
         tableState = _data;
         tableState.selected = localInstanceSelected;
         tableState.edit_view = isEditMode;
+
+        // TODO: Disable Editor - enable Table Editor when ready...
+        tableState.edit_view = false;
+
         tableState.editing_rows = editingRows;
       },
       stateLoadParams: function(_settings, _data){
         let localInstanceSelected = typeof tableState != 'undefined' ? tableState.selected : _data.selected;
         tableState = _data;
         tableState.selected = localInstanceSelected;
+
+        // TODO: Disable Editor - enable Table Editor when ready...
+        tableState.edit_view = false;
       },
       buttons: get_available_buttons(),
     });
   }
   window.onbeforeunload = warn_unsaved_records;
   initialize_datatable();
-}
+}

ckanext/canada/assets/modules/user_opt_in.js

@@ -0,0 +1,89 @@
+this.ckan.module('canada-user-opt-in-feature', function($){
+  return {
+    /* options object can be extended using data-module-* attributes */
+    options: {
+      csrf_name: null,
+      csrf_value: null,
+      page_redirect: null,
+      label: null,
+      button_label: null,
+      user_id: null,
+      feature_key: null,
+      feature_value: true,
+    },
+    initialize: function (){
+      _load_user_opt_in(this);
+    }
+  };
+});
+
+function _load_user_opt_in(CKAN_MODULE){
+  const _ = CKAN_MODULE._;
+  const csrfTokenName = CKAN_MODULE.options.csrf_name;
+  const csrfTokenValue = CKAN_MODULE.options.csrf_value;
+  const pageRedirect = CKAN_MODULE.options.page_redirect;
+  const label = CKAN_MODULE.options.label;
+  const buttonLabel = CKAN_MODULE.options.button_label;
+  const userID = CKAN_MODULE.options.user_id;
+  const featureKey = CKAN_MODULE.options.feature_key;
+  const featureValue = CKAN_MODULE.options.feature_value;
+
+  let postData = {'id': userID};
+  postData[featureKey] = featureValue;
+  postData[csrfTokenName] = csrfTokenValue;
+
+  let container = $('[data-module="canada-user-opt-in-feature"][data-module-feature_key="' + featureKey + '"]');
+  let htmlContent = '<div class="alert alert-warning"><p>' + label + '</p><p><a role="button" class="btn btn-primary btn-small" href="javascript:void(0);">' + buttonLabel + '</a></p></div>';
+
+  function _render_failure(_consoleMessage, _message, _type){
+    console.warn(_consoleMessage);
+    $(container).find('#uoif_failure_message').remove();
+    $(container).append('<div id="uoif_failure_message" class="alert alert-dismissible show alert-' + _type + '"><p>' + _message + '</p></div>');
+  }
+
+  if( $(container).children('.alert').length == 0 ){
+    $(container).append(htmlContent);
+    let button = $(container).find('a.btn');
+    if( button.length > 0 ){
+      $(button).off('click.optInFeature');
+      $(button).on('click.optInFeature', function(_event){
+        $(button).addClass('disabled');
+        $(button).attr('disabled', 'disabled');
+        $.ajax({
+        'url': '/api/action/user_patch',
+        'type': 'POST',
+        'dataType': 'JSON',
+        'data': postData,
+        'complete': function(_data){
+          if( _data.responseJSON ){  // we have response JSON
+            if( _data.responseJSON.success ){  // successful patch
+              if(
+                _data.responseJSON.result[featureKey] == featureValue
+              ){
+                if( pageRedirect && pageRedirect.startsWith('#') ){
+                  window.location.hash = pageRedirect.replace('#', '');
+                  window.location.reload();
+                  return;
+                }else if( pageRedirect ){
+                  window.location.href = pageRedirect;
+                  return;
+                }
+                window.location.reload();
+                return;
+              }else{  // unexpected return dict
+                _render_failure('Opt-in Feature — Unexpected response data.', _('Failed to change user settings'), 'danger');
+                console.warn(_data.responseJSON);
+              }
+            }else{  // validation error
+              _render_failure('Opt-in Feature — ValidationError exception was raised.', _('Failed to change user settings'), 'danger');
+              console.warn(_data.responseJSON);
+            }
+          }else{  // fully flopped ajax request
+            _render_failure('Opt-in Feature — Failed to gather a JSON response.', _('Failed to change user settings'), 'danger');
+          }
+        }
+      });
+      });
+    }
+  }
+}

ckanext/canada/assets/modules/webassets.yml

@@ -0,0 +1,7 @@
+main_js:
+  contents:
+    - user_opt_in.js
+  extra:
+    preload:
+      - base/main  # need ckan JS and jQuery
+  output: canada_modules/%(version)s_user_opt_in.js

ckanext/canada/helpers.py

@@ -531,8 +531,13 @@ def get_pd_datatable(resource_name: str,
                         for fk_ci, fk_cc in enumerate(fk['child_columns']))
 
     # TODO: DEPRECATED: REMOVE AFTER FULL PD DATATABLES QA
-    snippet = 'pd_datatable.html' if config.get(
-        'ckanext.canada.enable_pd_datatable_editor') else 'pd_datatable_depr.html'
+    try:
+        user_dict = get_action('user_show')({'ignore_auth': True}, {'id': g.user})
+    except (ObjectNotFound, RuntimeError):
+        user_dict = {}
+    enable_new_template = user_dict.get('opt_in_features__pd_datatables', config.get(
+        'ckanext.canada.enable_pd_datatable_editor'))
+    snippet = 'pd_datatable.html' if enable_new_template else 'pd_datatable_depr.html'
 
     return h.snippet('snippets/%s' % snippet,
                      resource_name=resource_name,
@@ -1175,5 +1180,6 @@ def get_inline_script_nonce() -> str:
     return str(request.environ.get('CSP_NONCE', ''))
 
 
-def get_allowed_frame_hosts() -> Optional[list]:
+# type_ignore_reason: incomplete typing
+def get_allowed_frame_hosts() -> Optional[list]:  # type: ignore
     return config.get('ckanext.canada.allowed_frame_hosts')