feat(signage/playlists): add approvals (#409)

Author: stakach

OPENAPI_DOC.yml

@@ -15750,6 +15750,75 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
+  /api/engine/v2/signage/playlists/{id}/approve:
+    post:
+      summary: approve a playlist for publication on displays
+      tags:
+      - Playlist
+      operationId: PlaceOS::Api::Playlist_approve_media
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Bool'
+        409:
+          description: Conflict
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
+        401:
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
+        403:
+          description: Forbidden
+        404:
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
+        408:
+          description: Request Timeout
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__CommonError'
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
+        422:
+          description: Unprocessable Entity
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__ParameterError'
+        406:
+          description: Not Acceptable
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
+        415:
+          description: Unsupported Media Type
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PlaceOS__Api__Application__ContentError'
   /api/engine/v2/signage/playlists/{id}/media:
     get:
       summary: get the current list of media for the playlist
@@ -21240,6 +21309,10 @@ components:
               type: integer
               format: Int64
               nullable: true
+            logged_out_at:
+              type: string
+              format: date-time
+              nullable: true
             work_preferences:
               type: array
               items:
@@ -22484,6 +22557,13 @@ components:
         makebreak:
           type: boolean
           nullable: true
+        analytics_enabled:
+          type: boolean
+          nullable: true
+        analytics_interval_minutes:
+          type: integer
+          format: Int32
+          nullable: true
         uri:
           type: string
           nullable: true
@@ -23362,6 +23442,13 @@ components:
               makebreak:
                 type: boolean
                 nullable: true
+              analytics_enabled:
+                type: boolean
+                nullable: true
+              analytics_interval_minutes:
+                type: integer
+                format: Int32
+                nullable: true
               uri:
                 type: string
                 nullable: true
@@ -25327,6 +25414,19 @@ components:
         user_name:
           type: string
           nullable: true
+        approved:
+          type: boolean
+          nullable: true
+        approved_by_id:
+          type: string
+          nullable: true
+        approved_by_name:
+          type: string
+          nullable: true
+        approved_by_email:
+          type: string
+          format: email
+          nullable: true
         items:
           type: array
           items:
@@ -25793,6 +25893,13 @@ components:
               makebreak:
                 type: boolean
                 nullable: true
+              analytics_enabled:
+                type: boolean
+                nullable: true
+              analytics_interval_minutes:
+                type: integer
+                format: Int32
+                nullable: true
               uri:
                 type: string
                 nullable: true
@@ -27923,6 +28030,10 @@ components:
           type: integer
           format: Int64
           nullable: true
+        logged_out_at:
+          type: string
+          format: date-time
+          nullable: true
         work_preferences:
           type: array
           items:
@@ -28506,6 +28617,13 @@ components:
                   makebreak:
                     type: boolean
                     nullable: true
+                  analytics_enabled:
+                    type: boolean
+                    nullable: true
+                  analytics_interval_minutes:
+                    type: integer
+                    format: Int32
+                    nullable: true
                   uri:
                     type: string
                     nullable: true

shard.lock

@@ -207,15 +207,15 @@ shards:
 
   placeos-frontend-loader:
     git: https://github.com/placeos/frontend-loader.git
-    version: 2.7.1+git.commit.b304dfada352b629a1bebed20583af3a00dd947e
+    version: 2.7.1+git.commit.bb0732a60a0a098e84d4affde4867f9cbe2c470c
 
   placeos-log-backend:
     git: https://github.com/place-labs/log-backend.git
     version: 0.13.0
 
   placeos-models:
     git: https://github.com/placeos/models.git
-    version: 9.72.0
+    version: 9.72.2
 
   placeos-resource:
     git: https://github.com/place-labs/resource.git
@@ -263,7 +263,7 @@ shards:
 
   search-ingest:
     git: https://github.com/placeos/search-ingest.git
-    version: 2.11.2+git.commit.0ce589c38e8cabcba8870a3f2592be3b87c48c41
+    version: 2.11.2+git.commit.2d95f483042dbb34439daa42ba9f2317446d6853
 
   secrets-env: # Overridden
     git: https://github.com/spider-gazelle/secrets-env.git

spec/controllers/signage_spec.cr

@@ -22,6 +22,7 @@ module PlaceOS::Api
         item2_id = item2.id.as(String)
 
         revision.items = [item1_id, item2_id]
+        revision.approved = true
         revision.save!
         playlist = revision.playlist.as(Model::Playlist)
         playlist_id = playlist.id.as(String)
@@ -67,6 +68,7 @@ module PlaceOS::Api
         item2_id = item2.id.as(String)
 
         revision.items = [item1_id, item2_id]
+        revision.approved = true
         revision.save!
         playlist = revision.playlist.as(Model::Playlist)
         playlist_id = playlist.id.as(String)
@@ -106,6 +108,74 @@ module PlaceOS::Api
         item2.reload!
         item2.play_count.should eq 2
       end
+
+      it "can approve digital signage playlists" do
+        revision = Model::Generator.revision
+
+        item = Model::Generator.item
+        item.save!
+        item1_id = item.id.as(String)
+        item2 = Model::Generator.item
+        item2.save!
+        item2_id = item2.id.as(String)
+
+        revision.items = [item1_id, item2_id]
+        revision.save!
+        revision.approved.should be_false
+        playlist = revision.playlist.as(Model::Playlist)
+        playlist_id = playlist.id.as(String)
+
+        system = Model::Generator.control_system
+        system.signage = true
+        system.playlists = [playlist_id]
+        system.save!
+        system_id = system.id.as(String)
+
+        headers = Spec::Authentication.headers
+
+        result = client.get(
+          path: "#{Signage.base_route}/#{system_id}",
+          headers: headers,
+        )
+
+        json = JSON.parse result.body
+        json["playlist_mappings"].should eq({system_id => [playlist_id]})
+        json["playlist_config"][playlist_id][0]["id"].should eq playlist_id
+        json["playlist_config"][playlist_id][1].should eq [] of String
+
+        # skip forward a moment to avoid a 304
+        sleep 1
+
+        # we should now approve the playlist
+        approved = client.post(
+          path: "#{Signage.base_route}/playlists/#{playlist_id}/approve",
+          headers: Spec::Authentication.headers,
+        )
+        approved.status_code.should eq 200
+
+        # revision timestamp should have changed
+        updated_at = revision.updated_at
+        revision.reload!
+        revision.approved.should be_true
+        revision.updated_at.should_not eq updated_at
+
+        system.playlists_last_updated.should eq revision.updated_at
+
+        # the route should have modified
+        headers["If-Modified-Since"] = result.headers["Last-Modified"]
+        result = client.get(
+          path: "#{Signage.base_route}/#{system_id}",
+          headers: headers,
+        )
+        result.status_code.should_not eq 304
+
+        json = JSON.parse result.body
+        json["playlist_mappings"].should eq({system_id => [playlist_id]})
+        json["playlist_config"][playlist_id][0]["id"].should eq playlist_id
+        json["playlist_config"][playlist_id][1].should eq [item1_id, item2_id]
+        json["playlist_media"][0]["id"].should eq item1_id
+        json["playlist_media"][1]["id"].should eq item2_id
+      end
     end
   end
 end

src/placeos-rest-api/controllers/signage/playlists.cr

@@ -39,15 +39,21 @@ module PlaceOS::Api
 
     @[AC::Route::Filter(:before_action, except: [:index, :create])]
     def check_access_level
-      return if user_support?
+      ensure_access
+    end
 
-      # find the org zone
-      org_zone_id = authority.config["org_zone"]?.try(&.as_s?)
-      raise Error::Forbidden.new unless org_zone_id
+    # find the org zone
+    getter org_zone_id : String do
+      zone_id = authority.config["org_zone"]?.try(&.as_s?)
+      raise Error::Forbidden.new unless zone_id
+      zone_id
+    end
 
+    def ensure_access(admin : Bool = false)
+      return if user_support?
       access = check_access(current_user.groups, [org_zone_id])
-      return if access.can_manage?
-
+      granted = admin ? access.admin? : access.can_manage?
+      return if granted
       raise Error::Forbidden.new
     end
 
@@ -99,6 +105,18 @@ module PlaceOS::Api
       current_playlist.destroy
     end
 
+    # approve a playlist for publication on displays
+    @[AC::Route::POST("/:id/approve")]
+    def approve_media : Bool
+      ensure_access(admin: true)
+      revision = media_revisions(1).first?
+      raise Error::NotFound.new("no media in playlist") unless revision
+
+      revision.approver = current_user
+      raise Error::ModelValidation.new(revision.errors) unless revision.save
+      true
+    end
+
     # Playlist Revisions
     # ==================
 

src/placeos-rest-api/controllers/systems.cr

@@ -404,6 +404,7 @@ module PlaceOS::Api
     #
     protected def self.module_running_state(control_system : ::PlaceOS::Model::ControlSystem, running : Bool, single_occurrence : Bool = true)
       modules = single_occurrence ? control_system.modules_with_single_occurrence.map(&.id) : control_system.modules
+      return if modules.empty?
       ::PlaceOS::Model::Module.where(id: modules, ignore_startstop: false).update_all(running: running)
     end