packaging: dexc-desktop packaging for Darwin #2333

ukane-philemon · 2023-05-01T12:50:00Z

This builds on top of #1957.

EDIT: Decred DEX Client in the images have been shortened to Decred DEX.
Display:
View in the Applications folder.

DMG installer view.

Dock view.

TODO:

We might have to create icons of various sizes:
16x16 pixels (1x and 2x), 32x32 pixels (1x and 2x), 64x64 pixels (1x and 2x), 128x128 pixels (1x and 2x), 256x256 pixels (1x and 2x), 512x512 pixels (1x and 2x), 1024x1024 pixels (1x only) which will be converted to a single .icns file for MacOs to display the most appropriate icon anywhere.
This PR includes a background image to instruct users on how to install the .app folder but we can improve on that too.

@martonp, please I'd appreciate your feedback on this since you also use MacOS.

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

ukane-philemon · 2023-05-01T13:56:09Z

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

+# signs the dmg file given to it as an argument.
+function sign() {
+	if [[ -n "${SIGNATURE}" && "${SIGNATURE}" != "-null-" ]]; then
+		echo "Codesign started"
+		codesign -s "${SIGNATURE}" "$1"
+		dmgsignaturecheck="$(codesign --verify --deep --verbose=2 --strict "$1" 2>&1 >/dev/null)"
+		if [ $? -eq 0 ]; then
+			echo "The disk image is now codesigned"
+		else
+			echo "The signature seems invalid.."
+			exit 1
+		fi
+	fi
+}
+
+# notarizes the dmg file given to it as an argument.
+function notarize() {
+	if [[ -n "${NOTARIZE}" && "${NOTARIZE}" != "-null-" ]]; then
+		echo "Notarization started"
+		xcrun notarytool submit "$1" --keychain-profile "${NOTARIZE}" --wait
+		echo "Stapling the notarization ticket"
+		staple="$(xcrun stapler staple "$1")"
+		if [ $? -eq 0 ]; then
+			echo "The disk image is now notarized"
+		else
+			echo "$staple"
+			echo "The notarization failed with error $?"
+			exit 1
+		fi
+	fi
+}


These aren't been used atm since a $99 dev account is required to get an Apple dev signature for code signing. Notarizing the dexc-desktop dmg is debatable but IMO we might not need it.

chappjc · 2023-05-09T18:52:08Z

Can rebase with dexc-desktop merged. No rush though.

martonp

I was able to build, install, and run it. However when I start the program, I cannot see anything on the markets page and there is an error in the console:

ukane-philemon · 2023-05-10T19:26:02Z

Uhmm, I'm on the markets page and everything looks fine except I now noticed the order form is a mess, no js error. I will investigate further.

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

martonp

The open logs folder selector is not working.

Why don't we just include the create-dmg script in the repo and have pkg-darwin.sh call the create-dmg script? Then we can just grab any updates they make.

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

chappjc · 2023-05-13T14:24:47Z

The open logs folder selector is not working.

Did you guys try converting spaces as per my code comment:

dcrdex/client/app/fileurl_darwin.go

Lines 21 to 23 in c07ac71

    
           // url.Parse can be touchy, so consider replacing only spaces, manually: 
        
           // path = strings.ReplaceAll(path, " ", "%20") 
        
           return fileURL.String(), nil

My Mac VM is pretty much broken because it refuses to display graphics in a lot of apps, so can't test easily.

ukane-philemon · 2023-05-13T14:44:13Z

Did you guys try converting spaces as per my code comment:

There was no space in the resulting folder url.

ukane-philemon · 2023-05-13T14:47:22Z

Why don't we just include the create-dmg script in the repo and have pkg-darwin.sh call the create-dmg script? Then we can just grab any updates they make.

IMO, we can do with less code independently. Updates can be added if need be.

martonp · 2023-05-13T14:49:22Z

IMO, we can do with less code independently. Updates can be added if need be.

Why would it be more code to use their script? It seems like most of this is copy-pasted from there.

ukane-philemon · 2023-05-13T15:01:12Z

Why would it be more code to use their script? It seems like most of this is copy-pasted from there.

Yes, I had to use a chunk of their code since it solves the issue at hand. I thought we'd prefer a custom build flow but @chappjc can decide which is better.

ukane-philemon · 2023-05-13T15:57:47Z

Encountered these display issues and added commits to resolve them in this PR. @martonp please confirm if you can reproduce the weird display without these changes and if these changes fix them on your device.

ukane-philemon · 2023-05-13T16:33:21Z

When I resize the web view window on my Mac with the dev console open, it chops off the top of the page by an amount equal to the console's minimum height. This issue persists even after refreshing the page, but clicking on the resize icon at the top right corner when the dev console is closed resolves it. I haven't observed this problem on Safari or other browsers.

However, this behaviour doesn't occur when resizing the window with the dev console detached. It may be considered a non-issue since we don't anticipate users resizing the web view window while the dev console is open.

webview-window.mp4

chappjc · 2023-05-13T16:37:23Z

Why would it be more code to use their script? It seems like most of this is copy-pasted from there.

Yes, I had to use a chunk of their code since it solves the issue at hand. I thought we'd prefer a custom build flow but @chappjc can decide which is better.

I have no opinion on the issue. It's not clear to me what it would look like doing it the way @martonp suggests. Is it this? https://github.com/create-dmg/create-dmg
It's up to you guys.

ukane-philemon · 2023-05-13T17:39:41Z

Is it this? https://github.com/create-dmg/create-dmg

Yes, it is.

chappjc · 2023-05-16T16:10:50Z

I'm fixing up the "Open logs folder" functionality in #2351.
It shouldn't be trying to open a folder in a webview window. It should use the OS/window manager to do it, which is what the https://github.com/pkg/browser/blob/master/browser_darwin.go package does, although it's named in such a way to suggest it just opens browsers, when really it uses os-specific opening functions.

ukane-philemon · 2023-05-16T17:40:10Z

I'm fixing up the "Open logs folder" functionality in #2351.

Nice, tested well on MacOS.

ukane-philemon · 2023-05-16T23:05:05Z

Why don't we just include the create-dmg script in the repo and have pkg-darwin.sh call the create-dmg script? Then we can just grab any updates they make.

I agree this can eliminate additional complexity and maintenance overhead, regardless of the amount of code involved. We can have it if the others agree on this @martonp.

chappjc · 2023-05-19T12:43:06Z

I think you should use grab the create-dmg in full, and make the adjustments in our separate script, add @martonp says. Does that work out?

martonp

The UI is looking good now, however I see some other issues.

On the tray icon, when I click "Open" it is always opening a new window even if one is already open. Also if another App is in the foreground and I click the "Open", it will just create a new window behind the app that is in the foreground.

I actually think on Mac the tray icon is not the way to go. When there is an app running on mac, even if there is not a window open, it will still be displayed on the dock at the bottom of the screen. When you right click the icon at the bottom of the screen, there are usually some options. The "Open logs folder" option can go over there. It feels strange that the app is running but I see no icon on the bottom dock. Every other app is there.

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

chappjc · 2023-05-21T16:15:17Z

On the tray icon, when I click "Open" it is always opening a new window even if one is already open. Also if another App is in the foreground and I click the "Open", it will just create a new window behind the app that is in the foreground.

I was surprised by this too, but @buck54321 makes the point that this is like making multiple tabs, which webview does not support. EDIT: Note that this is not Mac-specific behavior.

I actually think on Mac the tray icon is not the way to go. When there is an app running on mac, even if there is not a window open, it will still be displayed on the dock at the bottom of the screen. When you right click the icon at the bottom of the screen, there are usually some options.

On all systems, I made my case in chat that the tray icon is pointless except when all windows are closed and it's just waiting for orders to settle or something. On this note, I still don't like that closing the "last window" should terminate the singular dex process running Core. I think that the sole utility of a tray icon is so that you can close all the windows and let it continue running, where the tray provides a way to resurrect a window.

On the Mac specific points, even if we adjust things as per my previous paragraph, it's debatable if the tray icon is desirable or not. Only the main dexc process that has the running Core serves this tray. Only that process would be capable of providing the same menu items but on the dock as you suggest, not the dummy webview processes.
Also jrick made the point in chat that it's still nice to have some visual other than the subtle black dots in the Dock.

I don't use Mac enough to have an informed opinion, but I do think the functionality of the tray icon on all systems is flawed (the "last window" kills the Core process design).

ukane-philemon · 2023-05-21T18:27:36Z

On the tray icon, when I click "Open" it is always opening a new window even if one is already open. Also if another App is in the foreground and I click the "Open", it will just create a new window behind the app that is in the foreground

I understand your concerns. We had some discussion around this on matrix, and as @chappjc has said, creating sub webview window is flawed. Also, creating a new webview window will make another icon appear in the dock and it was unpleasant to look at, so I had to add a .plist item to make it behave like a background app so users can create multiple windows without displaying unnecessary icons in the dock. Our use of a separate dexc process to create a new window allow for multiple webview window on Mac and I don't know if there's a workaround.

but I do think the functionality of the tray icon on all systems is flawed (the "last window" kills the Core process design).

I agree. We have the systray, whether or not an order is running I think we should remove this behaviour. Some applications behave this way though, but it's up to us and what's best in this case for users.

martonp · 2023-05-22T08:27:33Z

Why does anyone need to have multiple dexc windows open.

I don't see any subtle black dots. I see this:

On Mac, all the applications that are running, whether or not there is a window open, are displayed on the bottom dock like this, with a dot below them.

Even if I close all the windows, the app will still stay running. To actually terminate the program, you have to right click the icon and select "Quit." I think the ideal behavior would be that if there are no active trades it just quits. If there are active trades it should give a confirmation alert first.

I definitely don't think this should be a background app. I think there should just be one window allowed, get rid of the dock on top, and just have the bottom dock icon behavior as I wrote in the previous paragraph.

ukane-philemon · 2023-05-22T11:19:54Z

Doing it the "Mac way" using webview is a can of worms.

chappjc · 2023-05-22T12:13:33Z

Why does anyone need to have multiple dexc windows open.

I tend to agree. I was confused.

I don't see any subtle black dots. I see this:

On Mac, all the applications that are running, whether or not there is a window open, are displayed on the bottom dock like this, with a dot below them.

Those are the two options, yes. The black dots option I'm talking about is actually those gray dots there. If that's how mac users work, ok.

Even if I close all the windows, the app will still stay running. To actually terminate the program, you have to right click the icon and select "Quit." I think the ideal behavior would be that if there are no active trades it just quits. If there are active trades it should give a confirmation alert first.

I haven't tested this PR, but dexc-desktop right now kills the app when all the windows are closed, unless there are trades running.

I definitely don't think this should be a background app. I think there should just be one window allowed, get rid of the dock on top, and just have the bottom dock icon behavior as I wrote in the previous paragraph.

What is wrong with having it as a background app? You don't need the window when you have placed all your orders and just want to let it work. We don't need the systray bits to make that work on Mac because of how the dock works, I acknowledge you points, but I still think it's desirable. Are you saying that on mac it's just as good to minimize the window to achieve this?

The "Mac way" I have observed is that closing all the windows does not kill the app. You have to go to the menu and hit "Quit"

martonp

DMG stuff LGTM. I think it may be possible to have the application be hidden instead of closed when the window closes by calling some objective-c code in the cgo section, but I haven't figured out exactly how yet.

I remove the <key>LSUIElement</key><true/> element and also created the webview in the original process instead of using the subprocess. Then if I right click the icon and select "hide", that is the exact behavior we want when the red button is clicked.

buck54321 · 2023-05-24T16:43:49Z

Just that there will be no little dot below the icon in the dock. Users will have to use the systray to manage dexc-desktop

Are you saying when running in the background, they can't open a window by clicking on the app's icon in the dock?

buck54321 · 2023-05-24T16:49:24Z

(this didn't look right so i added <key>LSUIElement</key><true/> to make all the dock icons disappear even when there are multiple windows open)

Hmm. Do you mean that you can't pin an icon to the dock anymore?

Sorry for the questions. I'm trying to get a mac right now. Hopefully I'll be more helpful soon.

ukane-philemon · 2023-05-24T17:17:20Z

I remove the LSUIElement element and also created the webview in the original process instead of using the subprocess. Then if I right click the icon and select "hide", that is the exact behavior we want when the red button is clicked.

But sadly we don't have control over the red btn yet when running webview in the original process.

ukane-philemon · 2023-05-24T17:20:22Z

Are you saying when running in the background, they can't open a window by clicking on the app's icon in the dock?

Yep. But the systray will be visible and users can open new windows from there.

Hmm. Do you mean that you can't pin an icon to the dock anymore?

You can, for easy access.

Sorry for the questions. I'm trying to get a mac right now. Hopefully I'll be more helpful soon.

np.

martonp · 2023-05-25T10:25:47Z

If this returned 0 instead of 1, I think we'd be good...

https://github.com/webview/webview/blob/8387ff8945fc010e7c4203c021943ce4ca12a276/webview.h#LL832C27-L832C74

ukane-philemon · 2023-05-25T10:32:56Z

If this returned 0 instead of 1, I think we'd be good...

https://github.com/webview/webview/blob/8387ff8945fc010e7c4203c021943ce4ca12a276/webview.h#LL832C27-L832C74

This will cause dexc-desktop to continue running (without a window), but we won't be able to "resurrect" the window if the user clicks on the dock icon again.

It seems the trend is to clone webview and add the desired feature as other forks have so I did yesterday but I think we need total control over webview windows.

martonp · 2023-05-25T10:41:23Z

Would there be a way to add an option on the icon menu to create a new window?

ukane-philemon · 2023-05-25T12:44:18Z

Would there be a way to add an option on the icon menu to create a new window?

Other apps have this. But I don't know how we can achieve this with webview.

chappjc · 2023-05-26T16:11:00Z

@ukane-philemon Would you mind rebasing and squashing down with a new commit message? Thanks.

buck54321 · 2023-05-26T19:07:21Z

Are you saying when running in the background, they can't open a window by clicking on the app's icon in the dock?

Yep. But the systray will be visible and users can open new windows from there.

This is going to cause a lot of confusion. There's got to be some signal we can work with to catch them clicking the launcher icon, no? Or does Mac just completely ignore it because of the systray entry?

chappjc · 2023-05-26T20:09:18Z

Are you saying when running in the background, they can't open a window by clicking on the app's icon in the dock?

Yep. But the systray will be visible and users can open new windows from there.

This is going to cause a lot of confusion. There's got to be some signal we can work with to catch them clicking the launcher icon, no? Or does Mac just completely ignore it because of the systray entry?

I think @ukane-philemon is properly addressing this from #2372. This PR is primarily dealing with the dmg packaging.

chappjc · 2023-05-26T20:15:46Z

client/webserver/site/.stylelintrc

+        "scss/at-extend-no-missing-placeholder": null,
+        "declaration-block-no-redundant-longhand-properties": null,
+        "value-no-vendor-prefix": null


Why these changes?

To allow for changes fixing #2333 (comment)

chappjc · 2023-05-26T20:16:37Z

client/webserver/site/src/css/forms.scss

@@ -238,7 +238,10 @@ button.form-button {
  @extend .flex-center;

  position: fixed;
-  inset: 0;


Why undoing this? A linter update recently made us do this, and I don't think we should disable that linter.

Not supported on webkit. #2333 (comment)

Oh, right. That's kinda messed up that webkit doesn't support inset. It is supported in every major browser, including Safari since v14.1: https://caniuse.com/mdn-css_properties_inset
What do we know about the webkit version provided by macdrive?

I’m running Safari ver 15.6.1 but know nothing about the WebKit version provided by Macdrive. I think it will use whatever webkit version it finds.

To get Webkit Version on macOS run: defaults read /System/Library/Frameworks/WebKit.framework/Resources/Info.plist CFBundleShortVersionString I got 15609 which corresponds with Safari ver 15.6.1 according to the comment here

chappjc · 2023-05-26T20:17:31Z

client/webserver/site/src/html/orders.tmpl

@@ -35,12 +35,12 @@
        {{end}}
        <div class="apply-bttn d-hide"><button class="bg2 demi">[[[apply]]]</button></div>
      </div>
-      <div id="exportOrders" class="export-archived-records-bttn mt-3">
+      <div id="exportOrders" class="export-archived-records-bttn mt-3 pb-2">


Will you please comment on all these frontend changes? I didn't notice them in prior review, and I don't think they are relevant to the DMG package additions.

The display didn't look right on webkit. See #2333 (comment).

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

fix macOS multiple dock icons rebase changes build webpack bundle always fix webkit issue with unsupported inset property fix webkit backdrop-filter on login form fix css variable bug fix webkit rendering of market list, wallet select btns, order btns, and notification tabs remove redundant css class fix minor css style padding and bump cache martonp review changes dexc-desktop: catch os.Interrupt signal and shutdown gracefully Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

ukane-philemon · 2023-05-27T18:57:05Z

Installer view updated in aab9446:

EDIT: After the icon update in c6c1d5c

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

client/cmd/dexc-desktop/pkg/pkg-darwin.sh

buck54321 · 2023-06-01T17:10:48Z

Notably the window is stuck on top like a modal. But I'm guessing #2372 will fix that.

ukane-philemon · 2023-06-01T17:19:07Z

Notably the window is stuck on top like a modal.

Stuck? Can I see a video of what you mean?

buck54321 · 2023-06-01T18:03:56Z

Video

ukane-philemon · 2023-06-01T18:23:02Z

Video

Seen and was able to reproduce with our current use of webview but this is resolved in #2372 since we are using native macOS APIs directly.

ukane-philemon commented May 1, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Outdated Show resolved Hide resolved

ukane-philemon commented May 1, 2023

View reviewed changes

ukane-philemon mentioned this pull request May 1, 2023

dexc-desktop: prepare installable desktop app #1957

Merged

ukane-philemon force-pushed the darwin-click-installer branch from e2a3f17 to d16d1fb Compare May 10, 2023 10:03

martonp reviewed May 10, 2023

View reviewed changes

martonp reviewed May 12, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Outdated Show resolved Hide resolved

ukane-philemon force-pushed the darwin-click-installer branch from d16d1fb to 627114d Compare May 13, 2023 10:04

martonp reviewed May 13, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Outdated Show resolved Hide resolved

ukane-philemon force-pushed the darwin-click-installer branch from 26be2ab to b13927c Compare May 20, 2023 19:22

martonp reviewed May 21, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Outdated Show resolved Hide resolved

ukane-philemon force-pushed the darwin-click-installer branch from fc49ff7 to d7ff332 Compare May 23, 2023 18:00

martonp approved these changes May 24, 2023

View reviewed changes

ukane-philemon mentioned this pull request May 25, 2023

dexc-desktop: Use macdrive for Darwin #2372

Merged

chappjc reviewed May 26, 2023

View reviewed changes

buck54321 reviewed May 26, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Show resolved Hide resolved

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Show resolved Hide resolved

ukane-philemon force-pushed the darwin-click-installer branch from d7ff332 to ada396a Compare May 26, 2023 21:49

ukane-philemon added 2 commits May 26, 2023 22:54

dexc-desktop: move debian-package.sh to the pkg dir and rename

85ddf3a

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

improve dexc-desktop darwin installer

aab9446

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

add new dexc-desktop macOS icon

c6c1d5c

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

buck54321 approved these changes Jun 1, 2023

View reviewed changes

client/cmd/dexc-desktop/pkg/pkg-darwin.sh Show resolved Hide resolved

buck54321 merged commit 05ad13a into decred:master Jun 1, 2023
5 checks passed

norwnd mentioned this pull request Aug 2, 2023

Download links should lead to standalone DEX apps decred/dexweb#41

Open

buck54321 mentioned this pull request Nov 8, 2023

[v0.6] ui: filter out injected non-existent language #2596

Merged

packaging: dexc-desktop packaging for Darwin #2333

packaging: dexc-desktop packaging for Darwin #2333

Conversation

ukane-philemon commented May 1, 2023 • edited

ukane-philemon May 1, 2023

Choose a reason for hiding this comment

chappjc commented May 9, 2023

martonp left a comment

Choose a reason for hiding this comment

ukane-philemon commented May 10, 2023 • edited

martonp left a comment

Choose a reason for hiding this comment

chappjc commented May 13, 2023 • edited

ukane-philemon commented May 13, 2023

ukane-philemon commented May 13, 2023 • edited

martonp commented May 13, 2023

ukane-philemon commented May 13, 2023

ukane-philemon commented May 13, 2023

ukane-philemon commented May 13, 2023

chappjc commented May 13, 2023

ukane-philemon commented May 13, 2023

chappjc commented May 16, 2023

ukane-philemon commented May 16, 2023

ukane-philemon commented May 16, 2023

chappjc commented May 19, 2023

martonp left a comment

Choose a reason for hiding this comment

chappjc commented May 21, 2023 • edited

ukane-philemon commented May 21, 2023 • edited

martonp commented May 22, 2023

ukane-philemon commented May 22, 2023 • edited

chappjc commented May 22, 2023 • edited

martonp left a comment • edited

Choose a reason for hiding this comment

buck54321 commented May 24, 2023 • edited

buck54321 commented May 24, 2023

ukane-philemon commented May 24, 2023

ukane-philemon commented May 24, 2023 • edited

martonp commented May 25, 2023

ukane-philemon commented May 25, 2023 • edited

martonp commented May 25, 2023

ukane-philemon commented May 25, 2023 • edited

chappjc commented May 26, 2023

buck54321 commented May 26, 2023

chappjc commented May 26, 2023 • edited

chappjc May 26, 2023

Choose a reason for hiding this comment

ukane-philemon May 27, 2023

Choose a reason for hiding this comment

chappjc May 26, 2023

Choose a reason for hiding this comment

ukane-philemon May 26, 2023

Choose a reason for hiding this comment

chappjc May 31, 2023 • edited

Choose a reason for hiding this comment

ukane-philemon May 31, 2023 • edited

Choose a reason for hiding this comment

chappjc May 26, 2023

Choose a reason for hiding this comment

ukane-philemon May 26, 2023

Choose a reason for hiding this comment

ukane-philemon commented May 27, 2023 • edited

buck54321 commented Jun 1, 2023

ukane-philemon commented Jun 1, 2023

buck54321 commented Jun 1, 2023

ukane-philemon commented Jun 1, 2023 • edited

ukane-philemon commented May 1, 2023 •

edited

ukane-philemon commented May 10, 2023 •

edited

chappjc commented May 13, 2023 •

edited

ukane-philemon commented May 13, 2023 •

edited

chappjc commented May 21, 2023 •

edited

ukane-philemon commented May 21, 2023 •

edited

ukane-philemon commented May 22, 2023 •

edited

chappjc commented May 22, 2023 •

edited

martonp left a comment •

edited

buck54321 commented May 24, 2023 •

edited

ukane-philemon commented May 24, 2023 •

edited

ukane-philemon commented May 25, 2023 •

edited

ukane-philemon commented May 25, 2023 •

edited

chappjc commented May 26, 2023 •

edited

chappjc May 31, 2023 •

edited

ukane-philemon May 31, 2023 •

edited

ukane-philemon commented May 27, 2023 •

edited

ukane-philemon commented Jun 1, 2023 •

edited