feat: better first-run experience in Usage Metrics Dashboard (#128)

* update renv.lock to get things working

* add first draft of an improved integration workflow

* remove print statements

* remove leftovers

* improve text

* change one word

* more text improvements

* work around connectapi package manager weirdness

* add comments for planned connectapi work

Author: toph-allen

extensions/usage-metrics-dashboard/app.R

@@ -15,6 +15,7 @@ shinyOptions(
 )
 
 source("get_usage.R")
+source("integrations.R")
 
 app_mode_groups <- list(
   "API" = c("api", "python-fastapi", "python-api", "tensorflow-saved-model"),
@@ -274,25 +275,84 @@ ui <- function(request) {
 server <- function(input, output, session) {
   # Set up Connect client; handle error if Visitor API Key integration isn't
   # present.
+
+  publisher_client <- connect()
+
+  selected_integration_guid <- reactiveVal(NULL)
+  observeEvent(input$auto_add_integration, {
+    auto_add_integration(publisher_client, selected_integration_guid())
+    # Hard refresh so that the sidebar gets the up to date info
+    runjs("window.top.location.reload(true);")
+  })
+
   client <- NULL
   tryCatch(
     client <- connect(
       token = session$request$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN
     ),
     error = function(e) {
-      showModal(modalDialog(
-        title = "Additional Setup Required",
-        footer = NULL,
-        HTML(paste(
-          "In the Access panel to the right, click <strong>\"Add integration\"</strong>,",
-          "then select a <strong>Visitor API Key</strong> integration.",
-          "If you don't see one in the list, an administrator must enable this feature on your Connect server.",
-          "See the <a href='https://docs.posit.co/connect/admin/integrations/oauth-integrations/connect/' target='_blank'>Admin Guide</a> for setup instructions.",
+      eligible_integrations <- get_eligible_integrations(publisher_client)
+      selected_integration <- slice_head(eligible_integrations, n = 1)
+      selected_integration_guid(selected_integration$guid)
+
+      if (nrow(selected_integration) == 1) {
+        message <- paste0(
+          "This content uses a <strong>Visitor API Key</strong> ",
+          "integration to show users the content they have access to. ",
+          "A compatible integration is displayed below.",
+          "<br><br>",
+          "For more information, see ",
+          "<a href='https://docs.posit.co/connect/user/oauth-integrations/#obtaining-a-visitor-api-key' ",
+          "target='_blank'>documentation on Visitor API Key integrations</a>."
+        )
+      } else if (nrow(selected_integration) == 0) {
+        integration_settings_url <- publisher_client$server_url(connectapi:::unversioned_url(
+          "connect",
+          "#",
+          "system",
+          "integrations"
+        ))
+        message <- paste0(
+          "This content needs permission to ",
+          " show users the content they have access to.",
+          "<br><br>",
+          "To allow this, an Administrator must configure a ",
+          "<strong>Connect API</strong> integration on the ",
+          "<strong><a href='",
+          integration_settings_url,
+          "' target='_blank'>Integration Settings</a></strong> page. ",
           "<br><br>",
-          "For guidance on using visitor-scoped permissions in your own Connect apps, see the",
-          "<a href='https://docs.posit.co/connect/user/oauth-integrations/#obtaining-a-visitor-api-key' target='_blank'>User Guide</a>.",
-          sep = " "
+          "On that page, select <strong>'+ Add Integration'</strong>. ",
+          "In the 'Select Integration' dropdown, choose <strong>'Connect API'</strong>. ",
+          "The 'Max Role' field must be set to <strong>'Administrator'</strong> ",
+          "or <strong>'Publisher'</strong>; 'Viewer' will not work. ",
+          "<br><br>",
+          "See the <a href='https://docs.posit.co/connect/admin/integrations/oauth-integrations/connect/' ",
+          "target='_blank'>Connect API section of the Admin Guide</a> for more detailed setup instructions."
+        )
+      }
+
+      footer <- if (nrow(selected_integration) == 1) {
+        button_label <- HTML(paste0(
+          "Add the ",
+          "<strong>'",
+          selected_integration$name,
+          "'</strong> ",
+          "Integration"
         ))
+        actionButton(
+          "auto_add_integration",
+          button_label,
+          icon = icon("plus")
+        )
+      } else if (nrow(selected_integration) == 0) {
+        NULL
+      }
+
+      showModal(modalDialog(
+        # title = "Additional Setup Required",
+        footer = footer,
+        HTML(message)
       ))
     }
   )

extensions/usage-metrics-dashboard/integrations.R

@@ -0,0 +1,57 @@
+library(connectapi)
+library(purrr)
+library(dplyr)
+
+get_eligible_integrations <- function(client) {
+  tryCatch(
+    {
+      # TODO When https://github.com/posit-dev/connectapi/issues/413 is closed,
+      # remove this and use that functionality instead.
+      integrations <- client$GET("v1/oauth/integrations")
+
+      integrations_df <- map_dfr(integrations, function(record) {
+        # Extract main fields
+        main_fields <- discard(record, is.list) # Discard list fields like 'config'
+
+        # Extract and combine the config fields with field names and values
+        config <- paste(
+          imap_chr(record$config, ~ paste(.y, .x, sep = ": ")),
+          collapse = ", "
+        )
+
+        # Combine both into a single list
+        c(main_fields, config = config)
+      })
+
+      print(integrations_df)
+
+      eligible_integrations <- integrations_df |>
+        filter(
+          template == "connect",
+          config %in% c("max_role: Admin", "max_role: Publisher")
+        ) |>
+        arrange(desc(config))
+    },
+    error = function(e) {
+      data.frame()
+    }
+  )
+}
+
+auto_add_integration <- function(client, integration_guid) {
+  print("About to PUT the integration!")
+
+  # TODO When https://github.com/posit-dev/connectapi/issues/414 is implemented,
+  # delete this and use that instead.
+  client$PUT(
+    connectapi:::v1_url(
+      "content",
+      Sys.getenv("CONNECT_CONTENT_GUID"),
+      "oauth",
+      "integrations",
+      "associations"
+    ),
+    body = list(list(oauth_integration_guid = integration_guid))
+  )
+  print("Done adding the integration")
+}