Merge pull request #17782 from jmchilton/private_object_store_ui

[24.0] Prompt user to change default history permissions...

client/src/components/History/CurrentHistory/SelectPreferredStore.vue

@@ -2,6 +2,7 @@
 import axios from "axios";
 import { computed, ref } from "vue";
 
+import { getPermissions, isHistoryPrivate, makePrivate, type PermissionsResponse } from "@/components/History/services";
 import { prependPath } from "@/utils/redirect";
 import { errorMessageAsString } from "@/utils/simple-error";
 
@@ -48,7 +49,26 @@ const emit = defineEmits<{
     (e: "updated", id: string | null): void;
 }>();
 
-async function handleSubmit(preferredObjectStoreId: string | null) {
+async function handleSubmit(preferredObjectStoreId: string | null, isPrivate: boolean) {
+    if (isPrivate) {
+        const { data } = await getPermissions(props.history.id);
+        const permissionResponse = data as PermissionsResponse;
+        const historyPrivate = await isHistoryPrivate(permissionResponse);
+        if (!historyPrivate) {
+            if (
+                confirm(
+                    "Your history is set to create sharable datasets, but the target storage location is private. Change the history configuration so new datasets are private by default?"
+                )
+            ) {
+                try {
+                    await makePrivate(props.history.id, permissionResponse);
+                } catch {
+                    error.value = "Failed to update default permissions for history.";
+                }
+            }
+        }
+    }
+
     const payload = { preferred_object_store_id: preferredObjectStoreId };
     const url = prependPath(`api/histories/${props.history.id}`);
     try {

client/src/components/History/HistoryDatasetPermissions.vue

@@ -1,9 +1,9 @@
 <script lang="ts" setup>
-import axios from "axios";
 import { computed, ref } from "vue";
 
 import { initRefs, updateRefs, useCallbacks } from "@/composables/datasetPermissions";
-import { withPrefix } from "@/utils/redirect";
+
+import { getPermissions, getPermissionsUrl, setPermissions } from "./services";
 
 import DatasetPermissionsForm from "@/components/Dataset/DatasetPermissionsForm.vue";
 
@@ -24,7 +24,7 @@ const {
 } = initRefs();
 
 const inputsUrl = computed(() => {
-    return `/history/permissions?id=${props.historyId}`;
+    return getPermissionsUrl(props.historyId);
 });
 
 const title = "Change default dataset permissions for history";
@@ -48,11 +48,11 @@ async function change(value: unknown) {
         DATASET_MANAGE_PERMISSIONS: [managePermissionValue],
         DATASET_ACCESS: access,
     };
-    axios.put(withPrefix(inputsUrl.value), formValue).then(onSuccess).catch(onError);
+    setPermissions(props.historyId, formValue).then(onSuccess).catch(onError);
 }
 
 async function init() {
-    const { data } = await axios.get(withPrefix(inputsUrl.value));
+    const { data } = await getPermissions(props.historyId);
     updateRefs(data.inputs, managePermissionsOptions, accessPermissionsOptions, managePermissions, accessPermissions);
     loading.value = false;
 }

client/src/components/History/services.ts

@@ -1,5 +1,9 @@
+import axios from "axios";
+
 import { fetcher } from "@/api/schema";
+import { type Input, permissionInputParts } from "@/composables/datasetPermissions";
 import type Filtering from "@/utils/filtering";
+import { withPrefix } from "@/utils/redirect";
 
 const publishedHistoriesFetcher = fetcher.path("/api/histories/published").method("get").create();
 export async function getPublishedHistories(
@@ -27,3 +31,37 @@ export async function getPublishedHistories(
 
     return data;
 }
+
+export function getPermissionsUrl(historyId: string) {
+    return `/history/permissions?id=${historyId}`;
+}
+
+export interface PermissionsResponse {
+    inputs: Input[];
+}
+
+export function getPermissions(historyId: string) {
+    const permissionsUrl = getPermissionsUrl(historyId);
+    return axios.get(withPrefix(permissionsUrl));
+}
+
+export function setPermissions(historyId: string, formContents: object) {
+    const permissionsUrl = getPermissionsUrl(historyId);
+    return axios.put(withPrefix(permissionsUrl), formContents);
+}
+
+export function makePrivate(historyId: string, permissionResponse: PermissionsResponse) {
+    const { manageInput } = permissionInputParts(permissionResponse.inputs);
+    const managePermissionValue: number = manageInput.value[0] as number;
+    const access = [managePermissionValue];
+    const formValue = {
+        DATASET_MANAGE_PERMISSIONS: [managePermissionValue],
+        DATASET_ACCESS: access,
+    };
+    return setPermissions(historyId, formValue);
+}
+
+export async function isHistoryPrivate(permissionResponse: PermissionsResponse) {
+    const { accessInput } = permissionInputParts(permissionResponse.inputs);
+    return accessInput.value.length >= 1;
+}

client/src/components/ObjectStore/SelectObjectStore.vue

@@ -2,6 +2,7 @@
 import { storeToRefs } from "pinia";
 import { computed, ref } from "vue";
 
+import { ConcreteObjectStoreModel } from "@/api";
 import { useObjectStoreStore } from "@/stores/objectStoreStore";
 
 import ObjectStoreSelectButton from "./ObjectStoreSelectButton.vue";
@@ -42,15 +43,17 @@ function variant(objectStoreId: string) {
 }
 
 const emit = defineEmits<{
-    (e: "onSubmit", id: string | null): void;
+    (e: "onSubmit", id: string | null, isPrivate: boolean): void;
 }>();
 
 const error = computed(() => {
     return props.parentError || loadErrorMessage.value;
 });
 
-async function handleSubmit(preferredObjectStoreId: string) {
-    emit("onSubmit", preferredObjectStoreId);
+async function handleSubmit(preferredObjectStore: ConcreteObjectStoreModel | null) {
+    const id: string | null = (preferredObjectStore ? preferredObjectStore.object_store_id : null) as string | null;
+    const isPrivate: boolean = preferredObjectStore ? preferredObjectStore.private : false;
+    emit("onSubmit", id, isPrivate);
 }
 </script>
 
@@ -79,7 +82,7 @@ async function handleSubmit(preferredObjectStoreId: string) {
                             :object-store="objectStore"
                             :variant="variant(objectStore.object_store_id)"
                             class="preferred-object-store-select-button"
-                            @click="handleSubmit(objectStore.object_store_id)" />
+                            @click="handleSubmit(objectStore)" />
                     </b-button-group>
                 </b-col>
                 <b-col cols="5">

client/src/composables/datasetPermissions.ts

@@ -10,7 +10,7 @@ interface InputOption {
     roleValue: number;
 }
 
-interface Input {
+export interface Input {
     value: number[];
     options: [string, number][];
 }
@@ -46,15 +46,20 @@ export function initRefs() {
     };
 }
 
+export function permissionInputParts(inputs: Input[]) {
+    const manageInput: Input = inputs[0] as Input;
+    const accessInput: Input = inputs[1] as Input;
+    return { manageInput, accessInput };
+}
+
 export function updateRefs(
     inputs: Input[],
     managePermissionsOptions: Ref<InputOption[]>,
     accessPermissionsOptions: Ref<InputOption[]>,
     managePermissions: Ref<number[]>,
     accessPermissions: Ref<number[]>
 ) {
-    const manageInput: Input = inputs[0] as Input;
-    const accessInput: Input = inputs[1] as Input;
+    const { manageInput, accessInput } = permissionInputParts(inputs);
     managePermissionsOptions.value = manageInput.options.map((v: [string, number]) => {
         return <InputOption>{ roleName: v[0], roleValue: v[1] };
     });