Add lock and rename content functionality to Publisher Command Center #138

fizzboop · 2025-05-20T21:44:07Z

Intent

Addresses the last two items of the #122

Approach

Created two endpoints to handle locking/unlocking content and rename content.

Example

Publisher Command Center Test on DogFood

Screenshots

fizzboop · 2025-05-21T19:42:22Z

extensions/publisher-command-center/src/components/RenameModal.js

+            ]),
+            m("input", {
+              oninput: function(e) {
+                RenameModalForm.isValid = e.target.validity.valid;


This ensures that the value from the input has a minimum of 3 characters and a max of 1024. This is based off of a warning a user will receive on the Info Pane of the Settings Panel.

fizzboop · 2025-05-21T19:44:09Z

extensions/publisher-command-center/src/models/Contents.js

+      url: `api/content/${guid}/lock`,
+    }).then((response) => {
+      const targetContent = this.data.find((c) => c.guid === guid);
+      Object.assign(targetContent, response);


Since Mihtril.JS doesn't have reactivity like Vue or React, we need to change the content of the data in order to reflect the new changes to the UI via the automatic m.redraw(). Without this, we would need a page reload to refresh the UI.

Good call adjusting the data so we don't need the slower API call.

dotNomad · 2025-05-22T00:22:29Z

extensions/publisher-command-center/app.py

+    visitor = get_visitor_client(posit_connect_user_session_token)
+    content = visitor.content.get(content_id)


My first thought with both of these was "do we already have the content data?". If we do we could avoid an API call here.

It looks like there isn't a good way, given only a GUID, to call content.update(title = title) from the SDK though, perhaps that is something we could request to make things like this a bit easier so this could be faster.

Actually there is!

We can do:

visitor = get_visitor_client(posit_connect_user_session_token) context = connect.Context(visitor) content = connect.ContentItem(context, content_id) content.update(title = title)

with the additional imports:

from posit.connect.context import Context from posit.connect.content import ContentItem

We can make a Context for the ContentItem and pass the guid. Since ContentItem only needs a Context and guid and all other attributes are optional this is enough to do the rename.

The lock has is_locked = content.locked which relies on the Content's locked attribute. If we can pass that in the FastAPI /api/content/{content_id}/lock API (or create two one for unlock and one for lock) then we can do the same there speeding it up by 2 times.

I don't think any of this is necessary in this PR to be fair. If it is very easy we can get it in otherwise we can follow-up since it would be good deal faster.

Yeah, that looks good @dotNomad! For what it's worth, I wouldn't worry about the additional API call to retrieve the content in order to update it. It's all happening across the local network, so the overhead is fairly negligible.

For what it's worth, I wouldn't worry about the additional API call to retrieve the content in order to update it. It's all happening across the local network, so the overhead is fairly negligible.

Oh that is a good point - it will be much faster than local dev 👍

dotNomad · 2025-05-22T00:26:38Z

extensions/publisher-command-center/src/components/ContentsComponent.js

+                m(LockContentButton, {
+                  contentId: guid,
+                  contentTitle: title,
+                  isLocked: content["locked"],


Oh sweet we have isLocked for the component, we can use that in Contents.lock and send it up to the API (or have two endpoints)

dotNomad · 2025-05-22T00:32:39Z

extensions/publisher-command-center/src/components/ContentsComponent.js

                m("a", {
                  class: "fa-solid fa-arrow-up-right-from-square",
                  href: content["content_url"],
+                  title: `Open ${title} (opens in new tab)`,


Suggested change

title: `Open ${title} (opens in new tab)`,

title: `Open ${title}`,

The "(opens in a new tab)" feels a bit verbose to me, but I'm not that adamant about removing it.

I can move the "(opens in new tab)" portion to the aria-label instead of the tooltip. In general, if a link opens a new window or tab, the screen reader should alert the user of the action.

In general, if a link opens a new window or tab, the screen reader should alert the user of the action.

Do screen readers not give that information when target="_blank"? I guess they don't

Added aria-label in commit 3e93e62.

Do screen readers not give that information when target="_blank"? I guess they don't

Unfortunately, not. It would be a nice add-on to automatically provide that information.

dotNomad · 2025-05-22T00:35:44Z

extensions/publisher-command-center/src/components/LockContentButton.js

+import m from "mithril";
+import Contents from "../models/Contents";
+
+const LockedContentButton = {  


I found this button a bit tricky on first use and accidentally clicked it twice - partly because the API was slow since we do two Connect calls, but also because there wasn't any feedback.

I did a quick edit of the component that may be a good starting point for adjust this

Code

import m from "mithril"; import Contents from "../models/Contents"; const LockedContentButton = { oninit: function () { this.isLoading = false; }, view: function (vnode) { const labelMessage = vnode.attrs.isLocked ? `Unlock ${vnode.attrs.contentTitle}` : `Lock Content ${vnode.attrs.contentTitle}`; const iconClassName = vnode.attrs.isLocked ? "fa-lock" : "fa-lock-open"; return m("button", { class: "action-btn" + (this.isLoading ? " disabled" : ""), ariaLabel: labelMessage, title: labelMessage, disabled: this.isLoading, onclick: async () => { if (this.isLoading) return; this.isLoading = true; m.redraw(); try { await Contents.lock(vnode.attrs.contentId); } finally { this.isLoading = false; m.redraw(); } } }, [ m("i", { class: `fa-solid ${this.isLoading ? "fa-spinner fa-spin" : iconClassName}` }) ]) } }; export default LockedContentButton;

This changes the button to a disabled spinner while the API call is going. This made is much easier to tell what was going on and avoid a double lock call.

Added improvements to the locking/unlocking functionality in commit 3e93e62.

dotNomad · 2025-05-22T00:36:03Z

extensions/publisher-command-center/src/components/RenameModal.js

+      const modal = Modal.getInstance(modalEl);
+      modal.hide();
+
+      RenameModalForm.newName = "";


Good catch!

dotNomad · 2025-05-22T00:37:04Z

extensions/publisher-command-center/src/models/Contents.js

+      url: `api/content/${guid}/lock`,
+    }).then((response) => {
+      const targetContent = this.data.find((c) => c.guid === guid);
+      Object.assign(targetContent, response);


Good call adjusting the data so we don't need the slower API call.

dotNomad

Both #146 and this PR are seeking to upgrade Publisher Command Center. Lets get both merged, then do a version bump. So we can take the manifest.json changes out of this PR.

dotNomad

Looks fantastic thank you for those changes 🎉

Add lock and rename endpoint, lock button, and functionality

22e9353

fizzboop self-assigned this May 20, 2025

Add rename API endpoint, rename modal, and update tooltip wording

0cc11cc

fizzboop commented May 21, 2025

View reviewed changes

jonkeane changed the title ~~Add lock and rename content functionality to Publisher~~ Add lock and rename content functionality to Publisher Command Center May 21, 2025

fizzboop added 2 commits May 21, 2025 16:41

Fix hiding modal and import for bootstrap

45ce6c9

Update manifest and bump version

9d0cac8

fizzboop marked this pull request as ready for review May 21, 2025 21:55

fizzboop added the content: Publisher Command Center label May 21, 2025

fizzboop requested review from dotNomad, tdstein and toph-allen May 21, 2025 21:55

dotNomad reviewed May 22, 2025

View reviewed changes

dotNomad mentioned this pull request May 22, 2025

Publisher Command Center: One-click add integration for first-deploy workflow #146

Merged

fizzboop added 3 commits May 22, 2025 11:24

Add loading state for lock, add aria-label

3e93e62

Merge main into branch

a1719b4

Remove changes to manifest

8efa8c0

fizzboop force-pushed the bh-publisher-lock-rename branch from 43074b8 to 8efa8c0 Compare May 22, 2025 17:06

fizzboop requested a review from dotNomad May 22, 2025 17:17

dotNomad approved these changes May 22, 2025

View reviewed changes

fizzboop merged commit 86db2de into main May 22, 2025
14 checks passed

fizzboop deleted the bh-publisher-lock-rename branch May 22, 2025 17:29

fizzboop mentioned this pull request May 22, 2025

Publisher Command Center: Change buttons on content table rows #122

Closed

4 tasks

		visitor = get_visitor_client(posit_connect_user_session_token)
		content = visitor.content.get(content_id)

	title: `Open ${title} (opens in new tab)`,
	title: `Open ${title}`,

Add lock and rename content functionality to Publisher Command Center #138

Add lock and rename content functionality to Publisher Command Center #138

Uh oh!

Conversation

fizzboop commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Intent

Approach

Example

Screenshots

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dotNomad left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dotNomad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fizzboop commented May 20, 2025 •

edited

Loading

dotNomad left a comment •

edited

Loading