Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(portable): Adding support for unique dir on each portable app launch #6093

Merged
merged 7 commits into from Jul 29, 2021
Merged

feat(portable): Adding support for unique dir on each portable app launch #6093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4a5f21e
Allowing boolean flag to unpackDirName to utilize $PLUGINSDIR (uniqu…
mmaietta Apr 15, 2021
f2c3f55
fix await
mmaietta Apr 15, 2021
3db3afe
Merge commit '0d4d3056b440cc45a1f1a15ea4a27c688cb0e96e' into feat/por…
mmaietta Jul 11, 2021
aa879a0
running prettier
mmaietta Jul 11, 2021
4935bec
Merge branch 'master' into feat/portable-app-extract-dir
mmaietta Jul 24, 2021
bf60e46
Consolidating fixed path vs ksuid logic for string entries and 'false…
mmaietta Jul 24, 2021
210e05b
Merge branch 'master' into feat/portable-app-extract-dir
mmaietta Jul 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/app-builder-lib/scheme.json
View file
Open in desktop
Expand Up @@ -4401,8 +4401,11 @@
"type": "boolean"
},
"unpackDirName": {
"description": "The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\n\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).",
"type": "string"
"description": "The unpack directory for the portable app resources.\nIf set to a string, it will be the name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.\nIf set explicitly to `false`, it will use the Windows temp directory ($PLUGINSDIR) that is unique to each launch of the portable application.\nDefaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).",
"type": [
"string",
"boolean"
]
},
"useZip": {
"default": false,
Expand Down
14 changes: 9 additions & 5 deletions packages/app-builder-lib/src/targets/nsis/NsisTarget.ts
View file
Open in desktop
Expand Up @@ -247,12 +247,16 @@ export class NsisTarget extends Target {

this.configureDefinesForAllTypeOfInstaller(defines)
if (isPortable) {
const portableOptions = options as PortableOptions
defines.REQUEST_EXECUTION_LEVEL = portableOptions.requestExecutionLevel || "user"
defines.UNPACK_DIR_NAME = portableOptions.unpackDirName || (await executeAppBuilder(["ksuid"]))
const { unpackDirName, requestExecutionLevel, splashImage } = options as PortableOptions
defines.REQUEST_EXECUTION_LEVEL = requestExecutionLevel || "user"

if (portableOptions.splashImage != null) {
defines.SPLASH_IMAGE = path.resolve(packager.projectDir, portableOptions.splashImage)
// https://github.com/electron-userland/electron-builder/issues/5764
if (typeof unpackDirName === "string" || !unpackDirName) {
defines.UNPACK_DIR_NAME = unpackDirName || (await executeAppBuilder(["ksuid"]))
}

if (splashImage != null) {
defines.SPLASH_IMAGE = path.resolve(packager.projectDir, splashImage)
}
} else {
await this.configureDefines(oneClick, defines)
Expand Down
7 changes: 5 additions & 2 deletions packages/app-builder-lib/src/targets/nsis/nsisOptions.ts
View file
Open in desktop
Expand Up @@ -169,11 +169,14 @@ export interface PortableOptions extends TargetSpecificOptions, CommonNsisOption
readonly requestExecutionLevel?: "user" | "highest" | "admin"

/**
* The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.
* The unpack directory for the portable app resources.
*
* If set to a string, it will be the name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory
* If set explicitly to `false`, it will use the Windows temp directory ($PLUGINSDIR) that is unique to each launch of the portable application.
*
* Defaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).
*/
readonly unpackDirName?: string
readonly unpackDirName?: string | boolean

/**
* The image to show while the portable executable is extracting. This image must be a bitmap (`.bmp`) image.
Expand Down
8 changes: 6 additions & 2 deletions packages/app-builder-lib/templates/nsis/portable.nsi
View file
Open in desktop
Expand Up @@ -30,7 +30,11 @@ Section
HideWindow
!endif

StrCpy $INSTDIR "$TEMP\${UNPACK_DIR_NAME}"
StrCpy $INSTDIR "$PLUGINSDIR\app"
!ifdef UNPACK_DIR_NAME
StrCpy $INSTDIR "$TEMP\${UNPACK_DIR_NAME}"
!endif

RMDir /r $INSTDIR
SetOutPath $INSTDIR

Expand Down Expand Up @@ -82,6 +86,6 @@ Section
ExecWait "$INSTDIR\${APP_EXECUTABLE_FILENAME} $R0" $0
SetErrorLevel $0

SetOutPath $PLUGINSDIR
SetOutPath $EXEDIR
RMDir /r $INSTDIR
SectionEnd
2 changes: 2 additions & 0 deletions test/src/windows/portableTest.ts
View file
Open in desktop
Expand Up @@ -39,6 +39,7 @@ test.ifAll.ifNotCi(
publish: null,
portable: {
useZip: true,
unpackDirName: false,
},
compression: "store",
},
Expand All @@ -57,6 +58,7 @@ test.ifNotCiMac(
installerIcon: "foo test space.ico",
},
portable: {
unpackDirName: true,
requestExecutionLevel: "admin",
//tslint:disable-next-line:no-invalid-template-strings
artifactName: "${productName}Portable.${version}.${ext}",
Expand Down