Send config events

README.md

@@ -260,6 +260,18 @@ DfE::Analytics.config.anonymise_web_request_user_id = false
 
 Anonymisation of `user_id` would be required if the source field in the schema is in `analytics_pii.yml` so that analysts can join the IDs together. If the `user_id` is not in `analytics_pii.yml` but is in `analytics.yml` then `user_id` anonymisation would *not* be required so that the IDs could still be joined together.
 
+### Data Anonymisation Algorithm
+
+Generally all PII data should be anonymised, including data that directly or indirect references PII, for example database IDs.
+
+The `dfe-analytics` gem also anonymises such data, if it is configured to do so. If you are anonymising database IDs in your code (in custom events for example), then you should uses the same hashing algorithm for anonymisation that the gem uses.
+
+The following method should be used in your code for anonymisation:
+
+```ruby
+DfE::Analytics.anonymise(value)
+```
+
 ### Adding specs
 
 #### Testing modes
@@ -432,8 +444,11 @@ Please note that page caching is project specific and each project must carefull
 > 	It could be nice to have tests to prove that connectivity to GCP still works after an update, but we aren't setup for that yet.
 3. (Optional) Verify committed `CHANGELOG.md` changes and alter if necessary: `git show`
 4. Push the branch: `git push origin v${NEW_VERSION}-release`, e.g. `git push origin v1.3.0-release`
-5. Push the tags: `git push --tags`
-6. Cut a PR on GitHub with the label `version-release`, and merge once approved
+5. Cut a PR on GitHub with the label `version-release`, and wait for approval 
+6. Once the PR is approved push the tags, immediately prior to merging: `git push --tags`
+7. Merge the PR.
+
+IMPORTANT:  Pushing the tags will immediately make the release available even on a unmerged branch. Therefore, push the tags to Github only when the PR is approved and immediately prior to merging the PR.
 
 ## License
 

lib/dfe/analytics.rb

@@ -12,6 +12,7 @@
 require 'dfe/analytics/load_entities'
 require 'dfe/analytics/load_entity_batch'
 require 'dfe/analytics/requests'
+require 'dfe/analytics/initialise'
 require 'dfe/analytics/version'
 require 'dfe/analytics/middleware/request_identity'
 require 'dfe/analytics/middleware/send_cached_page_request_event'
@@ -103,6 +104,9 @@ def self.initialize!
           model.include(DfE::Analytics::Entities)
         end
       end
+
+      DfE::Analytics::Initialise.trigger_initialise_event
+
     rescue ActiveRecord::PendingMigrationError
       Rails.logger.info('Database requires migration; DfE Analytics not initialized')
     rescue ActiveRecord::ActiveRecordError

lib/dfe/analytics/event.rb

@@ -5,7 +5,14 @@
 module DfE
   module Analytics
     class Event
-      EVENT_TYPES = %w[web_request create_entity update_entity delete_entity import_entity].freeze
+      EVENT_TYPES = %w[
+        web_request
+        create_entity
+        update_entity
+        delete_entity
+        import_entity
+        analytics_initialise
+      ].freeze
 
       def initialize
         time_zone = 'London'
@@ -24,9 +31,7 @@ def with_type(type)
         allowed_types = EVENT_TYPES + DfE::Analytics.custom_events
         raise 'Invalid analytics event type' unless allowed_types.include?(type.to_s)
 
-        @event_hash.merge!(
-          event_type: type
-        )
+        @event_hash.merge!(event_type: type)
 
         self
       end

lib/dfe/analytics/initialise.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DfE
+  module Analytics
+    # Send event on dfe analytics startup during initialisation
+    # - Event contains the dfe analytics version, config and other items
+    class Initialise
+      def self.trigger_initialise_event
+        new.send_initialise_event
+      end
+
+      def send_initialise_event
+        return unless DfE::Analytics.enabled?
+
+        initialise_event = DfE::Analytics::Event.new
+                                              .with_type('analytics_initialise')
+                                              .with_data(initialise_data)
+
+        DfE::Analytics::SendEvents.do([initialise_event.as_json])
+      end
+
+      private
+
+      def initialise_data
+        {
+          analytics_version: DfE::Analytics::VERSION,
+          config: {
+            anonymise_web_request_user_id: DfE::Analytics.config.anonymise_web_request_user_id
+          }
+        }
+      end
+    end
+  end
+end

spec/dfe/analytics/entities_spec.rb

@@ -64,7 +64,7 @@
       it 'sends events that are valid according to the schema' do
         Candidate.create
 
-        expect(DfE::Analytics::SendEvents).to have_received(:perform_later) do |payload|
+        expect(DfE::Analytics::SendEvents).to have_received(:perform_later).twice do |payload|
           schema = DfE::Analytics::EventSchema.new.as_json
           schema_validator = JSONSchemaValidator.new(schema, payload.first)
 
@@ -162,7 +162,7 @@
         entity = Candidate.create
         entity.update(email_address: 'bar@baz.com')
 
-        expect(DfE::Analytics::SendEvents).to have_received(:perform_later).twice do |payload|
+        expect(DfE::Analytics::SendEvents).to have_received(:perform_later).thrice do |payload|
           schema = DfE::Analytics::EventSchema.new.as_json
           schema_validator = JSONSchemaValidator.new(schema, payload.first)
 

spec/dfe/analytics/initialise_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec.describe DfE::Analytics::Initialise do
+  before do
+    allow(DfE::Analytics::SendEvents).to receive(:perform_later)
+    allow(DfE::Analytics).to receive(:enabled?).and_return(true)
+  end
+
+  describe 'trigger_initialise_event ' do
+    it 'includes the expected attributes' do
+      described_class.trigger_initialise_event
+
+      expect(DfE::Analytics::SendEvents).to have_received(:perform_later)
+        .with([a_hash_including({
+          'event_type' => 'analytics_initialise',
+          'data' => [
+            { 'key' => 'analytics_version', 'value' => [DfE::Analytics::VERSION] },
+            { 'key' => 'config',
+              'value' => ['{"anonymise_web_request_user_id":false}'] }
+          ]
+        })])
+    end
+  end
+end

spec/dfe/analytics_spec.rb

@@ -176,4 +176,12 @@
       end
     end
   end
+
+  it 'triggers the initialisation event' do
+     allow(DfE::Analytics::Initialise).to receive(:trigger_initialise_event)
+
+     DfE::Analytics.initialize!
+
+     expect(DfE::Analytics::Initialise).to have_received(:trigger_initialise_event)
+  end
 end