From 7417514e7ceb9273a3dbb9d8de9c8954f44a6f1d Mon Sep 17 00:00:00 2001
From: Tom Moor <tom.moor@gmail.com>
Date: Wed, 31 Jan 2024 20:08:01 -0500
Subject: [PATCH] chore: Deprecate collection.url on client

---
 app/actions/definitions/collections.tsx       |  4 ++--
 app/components/DocumentBreadcrumb.tsx         |  2 +-
 .../Sidebar/components/CollectionLink.tsx     |  4 ++--
 app/hooks/useCollectionTrees.ts               |  2 +-
 app/models/Collection.ts                      |  8 +++++++
 app/models/Notification.ts                    |  2 +-
 app/scenes/Collection.tsx                     | 24 +++++++++----------
 app/scenes/CollectionNew.tsx                  |  2 +-
 app/scenes/DocumentDelete.tsx                 |  2 +-
 app/stores/CollectionsStore.ts                |  4 ++--
 app/utils/routeHelpers.ts                     |  2 +-
 11 files changed, 32 insertions(+), 24 deletions(-)

diff --git a/app/actions/definitions/collections.tsx b/app/actions/definitions/collections.tsx
index bc58398d8..6fc2539e3 100644
--- a/app/actions/definitions/collections.tsx
+++ b/app/actions/definitions/collections.tsx
@@ -34,11 +34,11 @@ export const openCollection = createAction({
     return collections.map((collection) => ({
       // Note: using url which includes the slug rather than id here to bust
       // cache if the collection is renamed
-      id: collection.url,
+      id: collection.path,
       name: collection.name,
       icon: <ColorCollectionIcon collection={collection} />,
       section: CollectionSection,
-      perform: () => history.push(collection.url),
+      perform: () => history.push(collection.path),
     }));
   },
 });
diff --git a/app/components/DocumentBreadcrumb.tsx b/app/components/DocumentBreadcrumb.tsx
index fae86a31e..5dcd5300b 100644
--- a/app/components/DocumentBreadcrumb.tsx
+++ b/app/components/DocumentBreadcrumb.tsx
@@ -79,7 +79,7 @@ const DocumentBreadcrumb: React.FC<Props> = ({
       type: "route",
       title: collection.name,
       icon: <CollectionIcon collection={collection} expanded />,
-      to: collectionPath(collection.url),
+      to: collectionPath(collection.path),
     };
   } else if (document.isCollectionDeleted) {
     collectionNode = {
diff --git a/app/components/Sidebar/components/CollectionLink.tsx b/app/components/Sidebar/components/CollectionLink.tsx
index 9ee02ad28..c8e760854 100644
--- a/app/components/Sidebar/components/CollectionLink.tsx
+++ b/app/components/Sidebar/components/CollectionLink.tsx
@@ -54,7 +54,7 @@ const CollectionLink: React.FC<Props> = ({
       await collection.save({
         name,
       });
-      history.replace(collection.url, history.location.state);
+      history.replace(collection.path, history.location.state);
     },
     [collection, history]
   );
@@ -133,7 +133,7 @@ const CollectionLink: React.FC<Props> = ({
         <DropToImport collectionId={collection.id}>
           <SidebarLink
             to={{
-              pathname: collection.url,
+              pathname: collection.path,
               state: { starred: inStarredSection },
             }}
             expanded={expanded}
diff --git a/app/hooks/useCollectionTrees.ts b/app/hooks/useCollectionTrees.ts
index 6ce03bc24..c53cba0b0 100644
--- a/app/hooks/useCollectionTrees.ts
+++ b/app/hooks/useCollectionTrees.ts
@@ -65,7 +65,7 @@ export default function useCollectionTrees(): NavigationNode[] {
     const collectionNode: NavigationNode = {
       id: collection.id,
       title: collection.name,
-      url: collection.url,
+      url: collection.path,
       type: NavigationNodeType.Collection,
       children: collection.documents
         ? sortNavigationNodes(collection.documents, collection.sort, true)
diff --git a/app/models/Collection.ts b/app/models/Collection.ts
index 9be651e79..2c0ccb7a8 100644
--- a/app/models/Collection.ts
+++ b/app/models/Collection.ts
@@ -65,6 +65,9 @@ export default class Collection extends ParanoidModel {
   @observable
   documents?: NavigationNode[];
 
+  /**
+   * @deprecated Use path instead.
+   */
   @observable
   url: string;
 
@@ -139,6 +142,11 @@ export default class Collection extends ParanoidModel {
     return (this.name ? this.name[0] : "?").toUpperCase();
   }
 
+  @computed
+  get path() {
+    return this.url;
+  }
+
   fetchDocuments = async (options?: { force: boolean }) => {
     if (this.isFetching) {
       return;
diff --git a/app/models/Notification.ts b/app/models/Notification.ts
index e22c8bb17..54438017a 100644
--- a/app/models/Notification.ts
+++ b/app/models/Notification.ts
@@ -166,7 +166,7 @@ class Notification extends Model {
         const collection = this.collectionId
           ? this.store.rootStore.collections.get(this.collectionId)
           : undefined;
-        return collection ? collectionPath(collection.url) : "";
+        return collection ? collectionPath(collection.path) : "";
       }
       case NotificationEventType.AddUserToDocument:
       case NotificationEventType.MentionedInDocument: {
diff --git a/app/scenes/Collection.tsx b/app/scenes/Collection.tsx
index 8353e3c6a..090cddc5a 100644
--- a/app/scenes/Collection.tsx
+++ b/app/scenes/Collection.tsx
@@ -179,27 +179,27 @@ function CollectionScene() {
 
               <Documents>
                 <Tabs>
-                  <Tab to={collectionPath(collection.url)} exact>
+                  <Tab to={collectionPath(collection.path)} exact>
                     {t("Documents")}
                   </Tab>
-                  <Tab to={collectionPath(collection.url, "updated")} exact>
+                  <Tab to={collectionPath(collection.path, "updated")} exact>
                     {t("Recently updated")}
                   </Tab>
-                  <Tab to={collectionPath(collection.url, "published")} exact>
+                  <Tab to={collectionPath(collection.path, "published")} exact>
                     {t("Recently published")}
                   </Tab>
-                  <Tab to={collectionPath(collection.url, "old")} exact>
+                  <Tab to={collectionPath(collection.path, "old")} exact>
                     {t("Least recently updated")}
                   </Tab>
                   <Tab
-                    to={collectionPath(collection.url, "alphabetical")}
+                    to={collectionPath(collection.path, "alphabetical")}
                     exact
                   >
                     {t("A–Z")}
                   </Tab>
                 </Tabs>
                 <Switch>
-                  <Route path={collectionPath(collection.url, "alphabetical")}>
+                  <Route path={collectionPath(collection.path, "alphabetical")}>
                     <PaginatedDocumentList
                       key="alphabetical"
                       documents={documents.alphabeticalInCollection(
@@ -211,7 +211,7 @@ function CollectionScene() {
                       }}
                     />
                   </Route>
-                  <Route path={collectionPath(collection.url, "old")}>
+                  <Route path={collectionPath(collection.path, "old")}>
                     <PaginatedDocumentList
                       key="old"
                       documents={documents.leastRecentlyUpdatedInCollection(
@@ -223,12 +223,12 @@ function CollectionScene() {
                       }}
                     />
                   </Route>
-                  <Route path={collectionPath(collection.url, "recent")}>
+                  <Route path={collectionPath(collection.path, "recent")}>
                     <Redirect
-                      to={collectionPath(collection.url, "published")}
+                      to={collectionPath(collection.path, "published")}
                     />
                   </Route>
-                  <Route path={collectionPath(collection.url, "published")}>
+                  <Route path={collectionPath(collection.path, "published")}>
                     <PaginatedDocumentList
                       key="published"
                       documents={documents.recentlyPublishedInCollection(
@@ -241,7 +241,7 @@ function CollectionScene() {
                       showPublished
                     />
                   </Route>
-                  <Route path={collectionPath(collection.url, "updated")}>
+                  <Route path={collectionPath(collection.path, "updated")}>
                     <PaginatedDocumentList
                       key="updated"
                       documents={documents.recentlyUpdatedInCollection(
@@ -253,7 +253,7 @@ function CollectionScene() {
                       }}
                     />
                   </Route>
-                  <Route path={collectionPath(collection.url)} exact>
+                  <Route path={collectionPath(collection.path)} exact>
                     <PaginatedDocumentList
                       documents={documents.rootInCollection(collection.id)}
                       fetch={documents.fetchPage}
diff --git a/app/scenes/CollectionNew.tsx b/app/scenes/CollectionNew.tsx
index 8e629fbad..55cb571c4 100644
--- a/app/scenes/CollectionNew.tsx
+++ b/app/scenes/CollectionNew.tsx
@@ -65,7 +65,7 @@ class CollectionNew extends React.Component<Props> {
     try {
       await collection.save();
       this.props.onSubmit();
-      history.push(collection.url);
+      history.push(collection.path);
     } catch (err) {
       toast.error(err.message);
     } finally {
diff --git a/app/scenes/DocumentDelete.tsx b/app/scenes/DocumentDelete.tsx
index 5304a15ae..6bccba417 100644
--- a/app/scenes/DocumentDelete.tsx
+++ b/app/scenes/DocumentDelete.tsx
@@ -51,7 +51,7 @@ function DocumentDelete({ document, onSubmit }: Props) {
           }
 
           // otherwise, redirect to the collection home
-          history.push(collectionPath(collection?.url || "/"));
+          history.push(collectionPath(collection?.path || "/"));
         }
 
         onSubmit();
diff --git a/app/stores/CollectionsStore.ts b/app/stores/CollectionsStore.ts
index 2bad4313c..813814806 100644
--- a/app/stores/CollectionsStore.ts
+++ b/app/stores/CollectionsStore.ts
@@ -121,13 +121,13 @@ export default class CollectionsStore extends Store<Collection> {
 
     if (this.isLoaded) {
       this.data.forEach((collection) => {
-        const { id, name, url } = collection;
+        const { id, name, path } = collection;
         const node = {
           type: DocumentPathItemType.Collection,
           id,
           collectionId: id,
           title: name,
-          url,
+          url: path,
         };
         results.push([node]);
 
diff --git a/app/utils/routeHelpers.ts b/app/utils/routeHelpers.ts
index 840330a97..9f64ab1af 100644
--- a/app/utils/routeHelpers.ts
+++ b/app/utils/routeHelpers.ts
@@ -42,7 +42,7 @@ export function updateCollectionPath(
   // Update url to match the current one
   return oldUrl.replace(
     new RegExp("/collection/[0-9a-zA-Z-_~]*"),
-    collection.url
+    collection.path
   );
 }