Turn on Share Link in nightly builds #5153

pierremtb · 2025-01-27T13:56:03Z

Turns on the 'code' command previously added in Add support for creating a file via link, and add ability to generate and share such links #4088
Adds consistency to electron-builder scripts between package.json and CI/CD
Cleans up unused Electron Forge configs
Adds required configs for deep links to Electron Builder (and fix protocol constant)

Whole loop (share link, open in browser, open in desktop app) tested on installed apps on:

Windows
macOS
Linux (left out of this PR)

How to test: Grab a build from https://github.com/KittyCAD/modeling-app/actions/runs/13080529925 (just one commit before current HEAD), will point to this branch's vercel deployment, as it includes a quick fix there that app.dev.zoo.dev doesn't have.

Fixes #5136

qa-wolf · 2025-01-27T13:56:06Z

QA Wolf here! As you write new code it's important that your test coverage is keeping up.
Click here to request test coverage for this PR!

vercel · 2025-01-27T13:56:07Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
modeling-app	✅ Ready (Inspect)	Visit Preview	Jan 31, 2025 9:16pm

…u-8-cores)

…r electron; enable share cmd

…u-8-cores)

…released-apps-with-electron-builder

…u-8-cores)

…released-apps-with-electron-builder

package.json

src/main.ts

pierremtb · 2025-01-31T18:31:04Z

forge.config.ts

-    osxSign: (process.env.BUILD_RELEASE === 'true' && {}) || undefined,
-    osxNotarize:
-      (process.env.BUILD_RELEASE === 'true' && {
-        appleId: process.env.APPLE_ID || '',
-        appleIdPassword: process.env.APPLE_PASSWORD || '',
-        teamId: process.env.APPLE_TEAM_ID || '',
-      }) ||
-      undefined,


Taking the change to remove this, as we're not using forge for codesign anymore

pierremtb · 2025-01-31T18:31:42Z

forge.config.ts

-    protocols: [
-      {
-        name: 'Zoo Studio',
-        schemes: ['zoo-studio'],
-      },
-    ],
-    extendInfo: 'Info.plist', // Information for file associations.


Moved this to electron-builder.yml, that we're using to package the app. This was added before the migration to builder.

pierremtb · 2025-01-31T18:32:28Z

src/lib/constants.ts

@@ -68,8 +68,6 @@ export const KCL_DEFAULT_DEGREE = `360`
 /** localStorage key for the playwright test-specific app settings file */
 export const TEST_SETTINGS_FILE_KEY = 'playwright-test-settings'

-export const DEFAULT_HOST = 'https://api.zoo.dev'
-export const PROD_APP_URL = 'https://app.zoo.dev'


Moved this one to an env variable controlled by vite on build, this way we can flip between dev and prod easier

pierremtb · 2025-01-31T18:32:42Z

src/lib/constants.ts

@@ -68,8 +68,6 @@ export const KCL_DEFAULT_DEGREE = `360`
 /** localStorage key for the playwright test-specific app settings file */
 export const TEST_SETTINGS_FILE_KEY = 'playwright-test-settings'

-export const DEFAULT_HOST = 'https://api.zoo.dev'


Couldn't find any use for this so I 🔪d it

pierremtb · 2025-01-31T18:33:03Z

src/lib/constants.ts

@@ -145,7 +143,7 @@ export const VIEW_NAMES_SEMANTIC = {
 export const SIDEBAR_BUTTON_SUFFIX = '-pane-button'

 /** Custom URL protocol our desktop registers */
-export const ZOO_STUDIO_PROTOCOL = 'zoo-studio:'


This was one of the biggest blockers to working deep links.

pierremtb · 2025-01-31T18:33:40Z

src/lib/kclCommands.ts

+    {
+      name: 'share-file-link',
+      displayName: 'Share file',
+      hide: IS_NIGHTLY_OR_DEBUG ? undefined : 'desktop',


Nightly only for now until we can make sure it all works in prod.

pierremtb · 2025-01-31T18:33:58Z

src/components/ProjectSidebarMenu.tsx

@@ -191,7 +192,7 @@ function ProjectMenuPopover({
          id: 'share-link',
          Element: 'button',
          children: 'Share link to file',
-          disabled: !DEV,
+          disabled: IS_NIGHTLY_OR_DEBUG || !findCommand(shareCommandInfo),


Nightly only for now until we can make sure it all works in prod.

pierremtb · 2025-01-31T18:34:30Z

src/components/OpenInDesktopAppHandler.tsx

@@ -33,7 +33,7 @@ export const OpenInDesktopAppHandler = (props: React.PropsWithChildren) => {
  function onOpenInDesktopApp() {
    const newSearchParams = new URLSearchParams(globalThis.location.search)
    newSearchParams.delete(ASK_TO_OPEN_QUERY_PARAM)
-    const newURL = `${ZOO_STUDIO_PROTOCOL}${globalThis.location.pathname.replace(
+    const newURL = `${ZOO_STUDIO_PROTOCOL}://${globalThis.location.pathname.replace(


This was missing from the web app in order to properly open the app. Might be related to the change in the ZOO_STUDIO_PROTOCOL var too.

pierremtb · 2025-01-31T18:35:12Z

package.json

@@ -103,11 +103,11 @@
    "make:dev": "make dev",
    "generate:machine-api": "npx openapi-typescript ./openapi/machine-api.json -o src/lib/machine-api.d.ts",
    "tron:start": "electron-forge start",
-    "tron:package": "electron-forge package",


Removing this in favor of a more widespead use of electron-builder for packaged apps. Trying to make it easier for people to run 'the prime packaging' path that we actually deploy.

pierremtb · 2025-01-31T18:35:53Z

.env.production

+NODE_ENV=production
+DEV=false


For consistency with .env.development

…released-apps-with-electron-builder

pierremtb · 2025-01-31T21:04:29Z

src/main.ts

+// default vite values based on mode
+process.env.NODE_ENV ??= viteEnv.MODE
+process.env.DEV ??= viteEnv.DEV + ''
+process.env.BASE_URL ??= viteEnv.VITE_KC_API_BASE_URL
+process.env.VITE_KC_API_WS_MODELING_URL ??= viteEnv.VITE_KC_API_WS_MODELING_URL
+process.env.VITE_KC_API_BASE_URL ??= viteEnv.VITE_KC_API_BASE_URL
+process.env.VITE_KC_SITE_BASE_URL ??= viteEnv.VITE_KC_SITE_BASE_URL
+process.env.VITE_KC_SITE_APP_URL ??= viteEnv.VITE_KC_SITE_APP_URL
+process.env.VITE_KC_SKIP_AUTH ??= viteEnv.VITE_KC_SKIP_AUTH
+process.env.VITE_KC_CONNECTION_TIMEOUT_MS ??=
+  viteEnv.VITE_KC_CONNECTION_TIMEOUT_MS
+
+// Likely convenient to keep for debugging
+console.log('process.env', process.env)


Instead of default prod values for packaged apps (outside of the repo dev env), we let the vite mode assign the right ones. This way we can package dev and prod apps.

pierremtb added 2 commits January 27, 2025 09:40

WIP: Turn on link sharing in released apps with electron-builder

0b0b338

Fixes #5136

Add import.meta.env defaults

f6d8a02

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

34b2c61

…u-8-cores)

vercel bot deployed to Preview January 27, 2025 14:15 View deployment

Add convenience scripts for windows development; fix protocol name fo…

6b58d18

…r electron; enable share cmd

vercel bot deployed to Preview January 27, 2025 19:13 View deployment

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

99505f7

…u-8-cores)

vercel bot deployed to Preview January 27, 2025 19:30 View deployment

pierremtb and others added 2 commits January 27, 2025 19:31

Force release builds

df9e46f

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

0a2ff32

…u-8-cores)

vercel bot deployed to Preview January 27, 2025 19:56 View deployment

pierremtb changed the title ~~Pierremtb/issue5136 turn on link sharing in released apps with electron builder~~ WIP: turn on Share command for releases Jan 28, 2025

pierremtb and others added 3 commits January 27, 2025 19:38

Trigger CI

9f35f5a

Fix lint

6c464ab

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

f797bc8

…u-8-cores)

vercel bot deployed to Preview January 28, 2025 01:15 View deployment

pierremtb and others added 3 commits January 27, 2025 20:35

Merge branch 'main' into pierremtb/issue5136-Turn-on-link-sharing-in-…

ca29670

…released-apps-with-electron-builder

CSC_FOR_PULL_REQUEST: true for release build testing

1b5717b

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

cff416f

…u-8-cores)

vercel bot deployed to Preview January 28, 2025 02:13 View deployment

pierremtb and others added 2 commits January 28, 2025 15:45

Adding ://

4bd9e91

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

3516e71

…u-8-cores)

vercel bot deployed to Preview January 28, 2025 21:10 View deployment

pierremtb and others added 4 commits January 28, 2025 16:11

Back to debug builds

feb8d16

A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubunt…

1c3d27f

…u-8-cores)

Back to debug builds

5975ac7

Merge branch 'main' into pierremtb/issue5136-Turn-on-link-sharing-in-…

a5a9ede

…released-apps-with-electron-builder

vercel bot deployed to Preview January 28, 2025 21:36 View deployment

Remove test app

b5fd605

vercel bot deployed to Preview January 31, 2025 16:56 View deployment

pierremtb commented Jan 31, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

Update package.json

b1c7a07

pierremtb commented Jan 31, 2025

View reviewed changes

src/main.ts Outdated Show resolved Hide resolved

Update src/main.ts

0781691

pierremtb changed the title ~~Turn on Share Link on Nightly builds~~ Turn on Share Link in nightly builds Jan 31, 2025

Remove fetch:wasm:windows

684cc67

pierremtb commented Jan 31, 2025

View reviewed changes

Final line

d3aaead

pierremtb commented Jan 31, 2025

View reviewed changes

.env.production

Comment on lines +1 to +2

NODE_ENV=production

DEV=false

Copy link

Collaborator Author

pierremtb Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with .env.development

pierremtb added 2 commits January 31, 2025 13:38

Clean up

38f3a3e

Back to test app for final test

2d52931

vercel bot deployed to Preview January 31, 2025 19:01 View deployment

pierremtb and others added 3 commits January 31, 2025 15:39

Merge branch 'main' into pierremtb/issue5136-Turn-on-link-sharing-in-…

f61e268

…released-apps-with-electron-builder

Fix tsc

921bc4c

Back to https://app.dev.zoo.dev from vercel branch deploy

8f7301c

pierremtb marked this pull request as ready for review January 31, 2025 21:02

pierremtb requested review from franknoirot and nadr0 January 31, 2025 21:02

pierremtb commented Jan 31, 2025

View reviewed changes

vercel bot deployed to Preview January 31, 2025 21:16 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Turn on Share Link in nightly builds #5153

Turn on Share Link in nightly builds #5153

pierremtb commented Jan 27, 2025 •

edited

Loading

qa-wolf bot commented Jan 27, 2025

vercel bot commented Jan 27, 2025 •

edited

Loading

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

pierremtb Jan 31, 2025

Turn on Share Link in nightly builds #5153

Are you sure you want to change the base?

Turn on Share Link in nightly builds #5153

Conversation

pierremtb commented Jan 27, 2025 • edited Loading

qa-wolf bot commented Jan 27, 2025

vercel bot commented Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pierremtb commented Jan 27, 2025 •

edited

Loading

vercel bot commented Jan 27, 2025 •

edited

Loading