Hash windows paths

Jenkinsfile

@@ -101,7 +101,7 @@ pipeline {
       steps {
         nvm(env.NODE_VERSION) {
           // Install dependencies
-          sh 'npm install'
+          sh 'npm ci'
           // Update the version
           script {
             if (PUBLISH == 'true') {

RELEASENOTES.md

@@ -2,7 +2,8 @@
 
 ### Enhancements
 
-- None
+- Added hashing of the paths that Realms gets downloaded to on Windows. This is to avoid hitting the 260 character limit. ([#1172](https://github.com/realm/realm-studio/pull/1172))
+- Added a menu item to "Copy local Realm path" to the users clipboard. ([#1172](https://github.com/realm/realm-studio/pull/1172))
 
 ### Fixed
 

src/services/ros/realms.ts

@@ -18,6 +18,9 @@
 
 import * as Realm from 'realm';
 
+import * as crypto from 'crypto';
+import * as fs from 'fs-extra';
+import * as path from 'path';
 import { fetchAuthenticated, IRealmFile, RealmType, UserStatus } from '.';
 import { showError } from '../../ui/reusable/errors';
 
@@ -49,9 +52,11 @@ export const open = async (params: {
   const url = getUrl(params.user, params.realmPath);
 
   let clientResetOcurred = false;
+
   const realmPromise = Realm.open({
     encryptionKey: params.encryptionKey,
     schema: params.schema,
+    path: getPathOnDisk(params.user, params.realmPath),
     sync: {
       url,
       user: params.user,
@@ -82,6 +87,27 @@ export const open = async (params: {
   return realm;
 };
 
+// We rewrite the path on disk on Windows because default realm paths
+// may hit the 260 character limits, especially with partial realms.
+const getPathOnDisk = (
+  user: Realm.Sync.User,
+  realmPath: string,
+): string | undefined => {
+  // Only Windows have path limits, so it's fine to default to whatever OS generates.
+  if (process.platform === 'win32') {
+    const userPath = path.join(process.cwd(), user.identity);
+    fs.ensureDirSync(userPath);
+
+    return path.join(
+      userPath,
+      crypto
+        .createHash('md5')
+        .update(realmPath)
+        .digest('hex'),
+    );
+  }
+};
+
 export const create = (
   user: Realm.Sync.User,
   realmPath: string,
@@ -101,6 +127,7 @@ export const create = (
         ssl: { validate: validateCertificates },
       },
       schema,
+      path: getPathOnDisk(user, realmPath),
     }).then(resolve, reject);
   });
 };

src/ui/RealmBrowser/index.tsx

@@ -253,6 +253,15 @@ class RealmBrowserContainer
       ],
     };
 
+    const copyRealmPathItem: MenuItemConstructorOptions = {
+      label: 'Copy local Realm path',
+      click: () => {
+        this.copyRealmPathToClipboard().then(null, err => {
+          showError('Failed to copy Realm path', err);
+        });
+      },
+    };
+
     return menu.performModifications(template, [
       {
         action: 'append',
@@ -262,7 +271,12 @@ class RealmBrowserContainer
       {
         action: 'prepend',
         id: 'close',
-        items: [exportSchemaMenu, exportDataMenu, { type: 'separator' }],
+        items: [
+          exportSchemaMenu,
+          exportDataMenu,
+          copyRealmPathItem,
+          { type: 'separator' },
+        ],
       },
       {
         action: 'append',
@@ -728,6 +742,14 @@ class RealmBrowserContainer
       }
     }
   }
+
+  private async copyRealmPathToClipboard(): Promise<void> {
+    if (this.realm) {
+      await navigator.clipboard.writeText(this.realm.path);
+    } else {
+      throw new Error('Realm was not loaded');
+    }
+  }
 }
 
 export { RealmBrowserContainer as RealmBrowser };