Merge pull request #20888 from davelopez/improve_typing_in_share_ui

Refactor sharing logic for unified type handling

Author: davelopez

client/src/api/index.ts

@@ -338,3 +338,12 @@ export type CreateNewCollectionPayload = components["schemas"]["CreateNewCollect
 export type UnprivilegedToolResponse = components["schemas"]["UnprivilegedToolResponse"];
 export type UserToolSource = components["schemas"]["UserToolSource-Input"];
 export type DynamicUnprivilegedToolCreatePayload = components["schemas"]["DynamicUnprivilegedToolCreatePayload"];
+
+export type ShareableItemWithStatus = components["schemas"]["ShareWithStatus"];
+export type ShareableHistoryWithStatus = components["schemas"]["ShareHistoryWithStatus"];
+export type AnyShareableItemWithStatus = ShareableItemWithStatus | ShareableHistoryWithStatus;
+export type ShareOption = components["schemas"]["SharingOptions"];
+
+export function isShareableHistoryWithStatus(item: AnyShareableItemWithStatus): item is ShareableHistoryWithStatus {
+    return item.extra != null && "accessible_count" in item.extra;
+}

client/src/components/Sharing/SharingPage.vue

@@ -5,14 +5,14 @@ import axios from "axios";
 import { BFormCheckbox } from "bootstrap-vue";
 import { computed, nextTick, reactive, ref, watch } from "vue";
 
+import type { AnyShareableItemWithStatus, ShareOption } from "@/api";
+import { isShareableHistoryWithStatus } from "@/api";
 import { getGalaxyInstance } from "@/app";
 import { getFullAppUrl } from "@/app/utils";
 import { useToast } from "@/composables/toast";
 import { getAppRoot } from "@/onload/loadConfig";
 import { errorMessageAsString } from "@/utils/simple-error";
 
-import type { Item, ShareOption } from "./item";
-
 import EditableUrl from "./EditableUrl.vue";
 import PageEmbed from "./Embeds/PageEmbed.vue";
 import WorkflowEmbed from "./Embeds/WorkflowEmbed.vue";
@@ -40,19 +40,15 @@ function onErrorDismissed(index: number) {
     errors.value.splice(index, 1);
 }
 
-const defaultExtra = () =>
-    ({
-        can_change: [],
-        cannot_change: [],
-    }) as Item["extra"];
-
-const item = ref<Item>({
+const item = ref<AnyShareableItemWithStatus>({
+    id: "_placeholder_",
     title: "title",
     username_and_slug: "__username__/__slug__",
     importable: false,
     published: false,
     users_shared_with: [],
-    extra: defaultExtra(),
+    extra: null,
+    errors: [],
 });
 
 const itemUrl = reactive({
@@ -112,8 +108,8 @@ async function getSharing() {
 
 getSharing();
 
-function permissionsChangeRequired(data: Item) {
-    if (data.extra) {
+function permissionsChangeRequired(data: AnyShareableItemWithStatus) {
+    if (isShareableHistoryWithStatus(data)) {
         return data.extra.can_change.length > 0 || data.extra.cannot_change.length > 0;
     } else {
         return false;
@@ -167,16 +163,12 @@ async function setSharing(
 
 const userSharing = ref<InstanceType<typeof UserSharing>>();
 
-async function assignItem(newItem: Item, overwriteCandidates: boolean) {
+async function assignItem(newItem: AnyShareableItemWithStatus, overwriteCandidates: boolean) {
     if (newItem.errors) {
         errors.value = newItem.errors;
     }
     item.value = newItem;
 
-    if ((!item.value.extra || newItem.errors?.length) ?? 0 > 0) {
-        item.value.extra = defaultExtra();
-    }
-
     if (overwriteCandidates) {
         await nextTick();
         //@ts-ignore incorrect property not found error

client/src/components/Sharing/UserSharing.vue

@@ -15,17 +15,17 @@ import { storeToRefs } from "pinia";
 import { computed, ref } from "vue";
 import Multiselect from "vue-multiselect";
 
+import type { AnyShareableItemWithStatus, ShareOption } from "@/api";
+import { isShareableHistoryWithStatus } from "@/api";
 import { useConfig } from "@/composables/config";
 import { getAppRoot } from "@/onload";
 import { useUserStore } from "@/stores/userStore";
 import { assertArray } from "@/utils/assertions";
 
-import type { Item, ShareOption } from "./item";
-
 import Heading from "../Common/Heading.vue";
 
 const props = defineProps<{
-    item: Item;
+    item: AnyShareableItemWithStatus;
     modelClass: string;
 }>();
 
@@ -39,7 +39,7 @@ const { currentUser } = storeToRefs(useUserStore());
 const { config, isConfigLoaded } = useConfig(false);
 
 const permissionsChangeRequired = computed(() => {
-    if (props.item.extra) {
+    if (isShareableHistoryWithStatus(props.item)) {
         return props.item.extra.can_change.length > 0 || props.item.extra.cannot_change.length > 0;
     } else {
         return false;
@@ -123,8 +123,21 @@ const noChanges = computed(() => {
     return !(newCandidates.length !== 0 || removedShared.length !== 0);
 });
 
-const canChangeCount = computed(() => props.item.extra?.can_change.length ?? 0);
-const cannotChangeCount = computed(() => props.item.extra?.cannot_change.length ?? 0);
+const canChangeCount = computed(() => {
+    return isShareableHistoryWithStatus(props.item) ? props.item.extra.can_change.length : 0;
+});
+
+const cannotChangeCount = computed(() => {
+    return isShareableHistoryWithStatus(props.item) ? props.item.extra.cannot_change.length : 0;
+});
+
+const canChangeDatasets = computed(() => {
+    return isShareableHistoryWithStatus(props.item) ? props.item.extra.can_change : [];
+});
+
+const cannotChangeDatasets = computed(() => {
+    return isShareableHistoryWithStatus(props.item) ? props.item.extra.cannot_change : [];
+});
 
 const selectedSharingOption = ref<ShareOption>("make_public");
 
@@ -251,7 +264,7 @@ defineExpose({
                     v-if="canChangeCount > 0"
                     header="The following datasets can be shared by updating their permissions">
                     <BListGroup>
-                        <BListGroupItem v-for="dataset in props.item.extra?.can_change ?? []" :key="dataset.id">
+                        <BListGroupItem v-for="dataset in canChangeDatasets" :key="dataset.id">
                             {{ dataset.name }}
                         </BListGroupItem>
                     </BListGroup>
@@ -261,7 +274,7 @@ defineExpose({
                     v-if="cannotChangeCount > 0"
                     header="The following datasets cannot be shared, you are not authorized to change their permissions">
                     <BListGroup>
-                        <BListGroupItem v-for="dataset in props.item.extra?.cannot_change ?? []" :key="dataset.id">
+                        <BListGroupItem v-for="dataset in cannotChangeDatasets" :key="dataset.id">
                             {{ dataset.name }}
                         </BListGroupItem>
                     </BListGroup>