Fix importing a dataset from disk (#6615)

* fix importing a dataset that hasn't got a datasource-properties.json yet * remove unnecessary import * update changelog * fix missing largest segment id input for segmentation layers when importing a dataset from disk without pre-existing datasource-properties.json Co-authored-by: Florian M <[email protected]>
scalableminds · Nov 10, 2022 · ffc5ded · ffc5ded
1 parent 2a28b18
commit ffc5ded
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 30 deletions.
diff --git a/CHANGELOG.unreleased.md b/CHANGELOG.unreleased.md
@@ -16,6 +16,7 @@ For upgrade instructions, please check the [migration guide](MIGRATIONS.released
 - When merging annotations, bounding boxes are no longer duplicated. [#6576](https://github.com/scalableminds/webknossos/pull/6576)
 
 ### Fixed
+- Fixed importing a dataset from disk. [#6615](https://github.com/scalableminds/webknossos/pull/6615)
 
 ### Removed
 

diff --git a/frontend/javascripts/admin/dataset/dataset_add_zarr_view.tsx b/frontend/javascripts/admin/dataset/dataset_add_zarr_view.tsx
@@ -169,8 +169,8 @@ function DatasetAddZarrView(props: Props) {
             {/* Only the component's visibility is changed, so that the form is always rendered.
                 This is necessary so that the form's structure is always populated. */}
             <DatasetSettingsDataTab
-              isEditingMode={false}
               isReadOnlyDataset={false}
+              allowRenamingDataset
               form={form}
               activeDataSourceEditMode={dataSourceEditMode}
               onChange={(activeEditMode) => {

diff --git a/frontend/javascripts/admin/dataset/dataset_components.tsx b/frontend/javascripts/admin/dataset/dataset_components.tsx
@@ -52,7 +52,7 @@ export const layerNameRules = [
 
 export const getDatasetNameRules = (
   activeUser: APIUser | null | undefined,
-  isEditing: boolean = false,
+  allowRenaming: boolean = true,
 ) => [
   {
     required: true,
@@ -61,7 +61,8 @@ export const getDatasetNameRules = (
   ...layerNameRules,
   {
     validator: async (_rule: any, value: string) => {
-      if (isEditing) {
+      if (!allowRenaming) {
+        // Renaming is not allowed. No need to validate the (existing) name then.
         return Promise.resolve();
       }
       if (!activeUser) throw new Error("Can't do operation if no user is logged in.");

diff --git a/frontend/javascripts/dashboard/dataset/dataset_settings_data_tab.tsx b/frontend/javascripts/dashboard/dataset/dataset_settings_data_tab.tsx
@@ -30,6 +30,7 @@ import { getDatasetNameRules, layerNameRules } from "admin/dataset/dataset_compo
 import { useSelector } from "react-redux";
 import { DeleteOutlined } from "@ant-design/icons";
 import { APIDataLayer } from "types/api_flow_types";
+import { Vector3 } from "oxalis/constants";
 
 const FormItem = Form.Item;
 
@@ -59,14 +60,14 @@ export const syncDataSourceFields = (
 };
 
 export default function DatasetSettingsDataTab({
-  isEditingMode,
+  allowRenamingDataset,
   isReadOnlyDataset,
   form,
   activeDataSourceEditMode,
   onChange,
   additionalAlert,
 }: {
-  isEditingMode: boolean;
+  allowRenamingDataset: boolean;
   isReadOnlyDataset: boolean;
   form: FormInstance;
   activeDataSourceEditMode: "simple" | "advanced";
@@ -125,7 +126,7 @@ export default function DatasetSettingsDataTab({
       <Hideable hidden={activeDataSourceEditMode !== "simple"}>
         <RetryingErrorBoundary>
           <SimpleDatasetForm
-            isEditingMode={isEditingMode}
+            allowRenamingDataset={allowRenamingDataset}
             isReadOnlyDataset={isReadOnlyDataset}
             form={form}
             dataSource={dataSource}
@@ -156,12 +157,12 @@ export default function DatasetSettingsDataTab({
 }
 
 function SimpleDatasetForm({
-  isEditingMode,
+  allowRenamingDataset,
   isReadOnlyDataset,
   dataSource,
   form,
 }: {
-  isEditingMode: boolean;
+  allowRenamingDataset: boolean;
   isReadOnlyDataset: boolean;
   dataSource: Record<string, any>;
   form: FormInstance;
@@ -205,11 +206,11 @@ function SimpleDatasetForm({
                 label="Name"
                 info="The name of the dataset"
                 validateFirst
-                rules={getDatasetNameRules(activeUser, isEditingMode)}
+                rules={getDatasetNameRules(activeUser, allowRenamingDataset)}
               >
                 <Input
                   // Renaming an existing DS is not supported right now
-                  disabled={isReadOnlyDataset || isEditingMode}
+                  disabled={isReadOnlyDataset || !allowRenamingDataset}
                   style={{
                     width: 400,
                   }}
@@ -228,8 +229,7 @@ function SimpleDatasetForm({
                   },
                   {
                     validator: syncValidator(
-                      // @ts-expect-error ts-migrate(7006) FIXME: Parameter 'el' implicitly has an 'any' type.
-                      (value) => value && value.every((el) => el > 0),
+                      (value: Vector3) => value && value.every((el) => el > 0),
                       "Each component of the scale must be greater than 0",
                     ),
                   },
@@ -478,13 +478,15 @@ function SimpleLayerForm({
           </Form.Item>
 
           {/* The in-condition is only necessary to satisfy TypeScript */}
-          {isSegmentation && "largestSegmentId" in layer ? (
+          {isSegmentation ? (
             <FormItemWithInfo
               name={["dataSource", "dataLayers", index, "largestSegmentId"]}
               label="Largest segment ID"
               info="The largest segment ID specifies the highest id which exists in this segmentation layer. When users extend this segmentation, new IDs will be assigned starting from that value."
               initialValue={
-                layer.largestSegmentId != null ? `${layer.largestSegmentId}` : undefined
+                "largestSegmentId" in layer && layer.largestSegmentId != null
+                  ? `${layer.largestSegmentId}`
+                  : undefined
               }
               rules={[
                 {

diff --git a/frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx b/frontend/javascripts/dashboard/dataset/dataset_settings_view.tsx
@@ -26,8 +26,9 @@ import type {
   MutableAPIDataSource,
   APIDatasetId,
   APIMessage,
+  APIUnimportedDatasource,
 } from "types/api_flow_types";
-import { Unicode } from "oxalis/constants";
+import { Unicode, Vector3 } from "oxalis/constants";
 import type { DatasetConfiguration, OxalisState } from "oxalis/store";
 import DatasetCacheProvider, { datasetCache } from "dashboard/dataset/dataset_cache_provider";
 import LinkButton from "components/link_button";
@@ -95,7 +96,7 @@ type State = {
   isLoading: boolean;
   activeDataSourceEditMode: "simple" | "advanced";
   activeTabKey: TabKey;
-  savedDataSourceOnServer: APIDataSource | null | undefined;
+  savedDataSourceOnServer: APIDataSource | APIUnimportedDatasource | null | undefined;
   inferredDataSource: APIDataSource | null | undefined;
   differenceBetweenDataSources: Record<string, any>;
   hasNoAllowedTeams: boolean;
@@ -110,25 +111,35 @@ export type FormData = {
 };
 
 function ensureValidScaleOnInferredDataSource(
-  savedDataSourceOnServer: APIDataSource | null | undefined,
+  savedDataSourceOnServer: APIDataSource | APIUnimportedDatasource | null | undefined,
   inferredDataSource: APIDataSource | null | undefined,
 ): APIDataSource | null | undefined {
   if (savedDataSourceOnServer == null || inferredDataSource == null) {
     // If one of the data sources is null, return the other.
-    return savedDataSourceOnServer || inferredDataSource;
+    const potentialSource = savedDataSourceOnServer || inferredDataSource;
+    if (potentialSource && "dataLayers" in potentialSource) {
+      return potentialSource;
+    } else {
+      return null;
+    }
   }
 
   const inferredDataSourceClone = _.cloneDeep(inferredDataSource) as any as MutableAPIDataSource;
 
-  if (
-    _.isEqual(inferredDataSource.scale, [0, 0, 0]) &&
-    !_.isEqual(savedDataSourceOnServer.scale, [0, 0, 0])
-  ) {
-    inferredDataSourceClone.scale = savedDataSourceOnServer.scale;
+  const savedScale =
+    "dataLayers" in savedDataSourceOnServer
+      ? savedDataSourceOnServer.scale
+      : ([0, 0, 0] as Vector3);
+  if (_.isEqual(inferredDataSource.scale, [0, 0, 0]) && !_.isEqual(savedScale, [0, 0, 0])) {
+    inferredDataSourceClone.scale = savedScale;
   }
 
   // Trying to use the saved value for largestSegmentId instead of 0.
-  if (savedDataSourceOnServer.dataLayers != null && inferredDataSourceClone.dataLayers != null) {
+  if (
+    "dataLayers" in savedDataSourceOnServer &&
+    savedDataSourceOnServer.dataLayers != null &&
+    inferredDataSourceClone.dataLayers != null
+  ) {
     const segmentationLayerSettings = inferredDataSourceClone.dataLayers.find(
       (layer) => layer.category === "segmentation",
     );
@@ -250,7 +261,11 @@ class DatasetSettingsView extends React.PureComponent<PropsWithFormAndRouter, St
 
       // Ensure that zarr layers (which aren't inferred by the back-end) are still
       // included in the inferred data source
-      if (savedDataSourceOnServer != null && inferredDataSource != null) {
+      if (
+        savedDataSourceOnServer &&
+        "dataLayers" in savedDataSourceOnServer &&
+        inferredDataSource != null
+      ) {
         const layerDict = _.keyBy(inferredDataSource.dataLayers, "name");
         for (const layer of savedDataSourceOnServer.dataLayers) {
           if (layer.dataFormat === "zarr" && layerDict[layer.name] == null) {
@@ -425,8 +440,8 @@ class DatasetSettingsView extends React.PureComponent<PropsWithFormAndRouter, St
       message = (
         <div>
           The current datasource-properties.json on the server seems to be in an invalid JSON format
-          and webKnossos could not parse this file. The settings below are suggested by webKnossos
-          and should be adjusted. <br />
+          (or is missing completely). The settings below are suggested by webKnossos and should be
+          adjusted. <br />
           Be aware that webKnossos cannot guess properties like the voxel size or the largest
           segment id. You must set them yourself.
         </div>
@@ -853,7 +868,7 @@ class DatasetSettingsView extends React.PureComponent<PropsWithFormAndRouter, St
                     {form && (
                       <DatasetSettingsDataTab
                         key="SimpleAdvancedDataForm"
-                        isEditingMode={this.props.isEditingMode}
+                        allowRenamingDataset={false}
                         isReadOnlyDataset={
                           this.state.dataset != null && this.state.dataset.dataStore.isConnector
                         }

diff --git a/frontend/javascripts/types/api_flow_types.ts b/frontend/javascripts/types/api_flow_types.ts
@@ -65,7 +65,7 @@ type MutableAPIDataSourceBase = {
   status?: string;
 };
 type APIDataSourceBase = Readonly<MutableAPIDataSourceBase>;
-type APIUnimportedDatasource = APIDataSourceBase;
+export type APIUnimportedDatasource = APIDataSourceBase;
 export type MutableAPIDataSource = MutableAPIDataSourceBase & {
   dataLayers: Array<APIDataLayer>;
   scale: Vector3;
@@ -148,7 +148,7 @@ type APIUnimportedDataset = APIDatasetBase & {
 export type APIMaybeUnimportedDataset = APIUnimportedDataset | APIDataset;
 export type APIDataSourceWithMessages = {
   readonly dataSource?: APIDataSource;
-  readonly previousDataSource?: APIDataSource;
+  readonly previousDataSource?: APIDataSource | APIUnimportedDatasource;
   readonly messages: Array<APIMessage>;
 };
 export type APITeamMembership = {