Add commands to rekey device and create packages #509

fumer-fubotv · 2023-10-13T17:37:37Z

Added support for the following commands:

Rekey Device: Rekey specified device based on the signing password ("brightscript.remoteControl.signingPassword") and package file ("brightscript.remoteControl.signedPackagePath") provided.
Create Package: This will present user a list of available launch configs to choose from. Once selected it will create a .zip file and .pkg file based on the config and will save them to the ${workspacefolder}/out
Rekey Device and Create Package: This will first rekey device and then create package for the selected launch config

Here's a demo of the "Rekey Device" command:

rekey.mp4

1. Added support to show preview of screenshot 2. Fixed a linter issue

Added support for the following commands: 1. Rekey Device: Rekey specified device based on the signing password ("brightscript.remoteControl.signingPassword") and package file ("brightscript.remoteControl.signedPackagePath") provided. 2. Create Package: This will present user a list of available launch configs to choose from. Once selected it will create a .zip file and .pkg file based on the config and will save them to the ${workspacefolder}/out 3. Rekey Device and Create Package: This will first rekey device and then create package for the selected launch config

TwitchBronBron

Hey, after I started looking over this, I realized we need to tweak the design a bit. We should sync up about this so I can explain in more detail. But we shouldn't use the "last used device" stuff like we did with the screenshot logic. Here's a rough overview of how the flow should work:

rekey: 
a) "How do you want to enter your stuff?"
 - "Pick from json file"
 - "Enter manually"
b) prompt for host (prepopulated from json above if possible)
c) Prompt for password (prepopulated from json above if possible)
d) Prompt for signed package path (prepopulated from json above if available)

package: 
a) "What should we package?"
 - "Pick a folder"
 - "Pick a zip"
 - "Pick from a launch.json"
    - show a launch.json option picker
 - "Pick a rokudeploy.json"
	- 

b) prompt for host (prepopulated from json above if possible)
c) Prompt for password (prepopulated from json above if possible)
d) Prompt for signed package path (prepopulated from json above if available)
e) Show a summary of stuff, ask to click "Yes, do it" or "No, something's wrong, cancel".

rekeyAndPackage: same as "package" but do the rekey first, no new input necessary

TwitchBronBron · 2023-10-16T17:03:06Z

src/BrightScriptCommands.ts

+        await this.getRemoteHost();
+        await this.getRemotePassword();
+        await this.getSigningPassword();
+        await this.getSignedPackagePath();


We should show a file picker for this.

Updates based on below reqs: rekey: a) "How do you want to enter your stuff?" - "Pick from json file" - "Enter manually" b) prompt for host (prepopulated from json above if possible) c) Prompt for password (prepopulated from json above if possible) d) Prompt for signed package path (prepopulated from json above if available) package: a) "What should we package?" - "Pick a folder" - "Pick from a launch.json" - show a launch.json option picker - "Pick a rokudeploy.json" - b) prompt for host (prepopulated from json above if possible) c) Prompt for password (prepopulated from json above if possible) d) Prompt for signed package path (prepopulated from json above if available) e) Show a summary of stuff, ask to click "Yes, do it" or "No, something's wrong, cancel".

TwitchBronBron

I have a few suggestions:

This stuff in this file getting a bit large, so let's move all this new logic out of BrightScriptCommands.ts into a separate src/commands/RekeyAndPackageCommands.ts file.
There seem to be a few bugs around picking a json file for the "Rekey device" flow. When I pick a rokudeploy.json with only rekeySignedPackage, devId, signingPassword, convertToSquashFS, it fails with an error "A system error occurred (getaddrinfo ENOTFOUND :80). I'm assuming it's because the logic currently assumes that everything was supposed to be included in the json. That's not how it should work. We should load any values we find in the json, but then still walk through the manual prompts to allow the user to confirm those are the values they want, and fill in any missing values.
When running "Rekey Device", and choosing "enter manually". after I enter my signing password, it just pops up a new file picker dialog, but there was no messaging around WHAT I'm supposed to pick. I think we need another intermediary dropdown with instructions saying "pick your pkg" so they know why the file picker appears.
After running the manual rekey for our internal app, I get this error at the end.

src/BrightScriptCommands.ts

fumer-fubotv · 2023-10-27T17:31:07Z

I have a few suggestions:

This stuff in this file getting a bit large, so let's move all this new logic out of BrightScriptCommands.ts into a separate src/commands/RekeyAndPackageCommands.ts file.

There seem to be a few bugs around picking a json file for the "Rekey device" flow. When I pick a rokudeploy.json with only rekeySignedPackage, devId, signingPassword, convertToSquashFS, it fails with an error "A system error occurred (getaddrinfo ENOTFOUND :80). I'm assuming it's because the logic currently assumes that everything was supposed to be included in the json. That's not how it should work. We should load any values we find in the json, but then still walk through the manual prompts to allow the user to confirm those are the values they want, and fill in any missing values.

When running "Rekey Device", and choosing "enter manually". after I enter my signing password, it just pops up a new file picker dialog, but there was no messaging around WHAT I'm supposed to pick. I think we need another intermediary dropdown with instructions saying "pick your pkg" so they know why the file picker appears.

After running the manual rekey for our internal app, I get this error at the end.

Most of the suggestions are addressed in the update. However i was not able to reproduce the error in #4 you mentioned

…htscript-language into TBD-126

TwitchBronBron · 2024-01-29T21:10:38Z

@fumer-fubotv I finally got a chance to look over this. I've pushed some changes to optimize the flow a bit....somehow I had these sitting in an uncommited branch since November!

The biggest change here is that we really need to prompt the user for all the details every time (either from json or from input boxes). We can't use values like the last password or last host used, because that might not be the device they want to rekey.

One thing we need to tweak, is for the file picker modal, we should add information showing the currently selected zip (if there is one from rokudeploy.json), and add another button in that case saying "I want to change it". I see it having 2 flows:

there is no package picked yet, so they have "Pick a file" and "cancel".
There is already a default package set, so they have "Use the current file", "Pick a different file", and "cancel"

It would be great if you could run through this workflow a few times to test it out, and iron out any rough edges. Then It should probably be good to go.

…htscript-language into TBD-126

1. Added support to show existing pkg file for rekey confirmation 2. Updated create package flow to confirm all the entries with user and ti update - if needed

TwitchBronBron

Here are a few things to change:

when choosing "I want to change something", it's not showing the previously-selected host in the host picker. That userInputManager.promptForHost() function accepts a default value. We should pass in rekeyConfig?host ?? defaultValues?.host
the "create package" flow doesn't remember the previously selected "what do you want to package" option when I choose "I want to change something".
the "rekey device and create package" command feels quirky. It seems like it just runs the rekey command and then the create package command next. It should collect all user input first (for rekey AND packaging inputs), and THEN show a summary at the end including all rekey inputs AND package/sign inputs. At that point, run both actions.

src/commands/RekeyAndPackageCommand.ts

Added support to maintain status of previously selected host and config

…ghtscript-language into TBD-126

fumer-fubotv · 2024-02-08T18:20:31Z

Host and create package flows have been updated as per feedback

TwitchBronBron

Found a few more issues.

For "Create package" and choosing "use folder", it expects there to be a zip. But my folder has the source files, not a zip. We need to zip that folder as part of this flow.
For "Create Package", when I choose "Use a rokudeploy.json" file, and if that file doesn't have rootDir specified, the packaging fails.
For "Create package", when choosing "use launch.json", it appears to grab all the right values, but then the flow fails

updated rekey and create package flow

fumer-fubotv · 2024-02-13T18:52:43Z

I tried to reproduce the scenarios mentioned above and below are the findings:

Create package using "use folder" works successfully if the specified folder has a manifest in it. Otherwise it will throw an error (Just fyi- Current implementation already zip the source folder user selects)
Create package using "use a rokudeploy.json" expects source to be specified.
Create Package using launch.json has been working fine for me. Lets connect to reproduce/resolve this issue

1. updated outfile name to be the source folder name only 2. Fixed a bug for outdir that only supported mac paths 3. Added title to all inputboxes 4. Added a prompt for rootDir incase it is missing during create package 5. Added outfile path in dialog upon successful packaging

…ghtscript-language into TBD-126

Added support to show package path in successful dialog and an option to open package in file explorer

…htscript-language into TBD-126

fumer-fubotv added 4 commits October 9, 2023 09:20

Add ability to capture device screenshots

52c6de5

Add ability to capture device screenshots

a564c7b

1. Added support to show preview of screenshot 2. Fixed a linter issue

Merge branch 'master' into ROKU-1008

323c4f1

fumer-fubotv self-assigned this Oct 13, 2023

fumer-fubotv requested a review from TwitchBronBron October 13, 2023 17:37

fumer-fubotv added 3 commits October 13, 2023 10:40

Conflict resoluiton

a83dc75

remove stale code

273d71c

remove redundent code

53ee647

TwitchBronBron requested changes Oct 17, 2023

View reviewed changes

TwitchBronBron requested changes Oct 25, 2023

View reviewed changes

src/BrightScriptCommands.ts Outdated Show resolved Hide resolved

fumer-fubotv added 2 commits October 27, 2023 10:24

TBD-126

b83a203

Update BrightScriptCommands.ts

1a1320e

TwitchBronBron added 2 commits November 8, 2023 11:51

Merge branch 'master' of https://github.com/rokucommunity/vscode-brig…

ddb09fc

…htscript-language into TBD-126

Refined the flow a bit

6aed36a

TwitchBronBron and others added 3 commits January 29, 2024 16:14

Merge branch 'master' of https://github.com/rokucommunity/vscode-brig…

ac5dc9b

…htscript-language into TBD-126

TBD-126:

7255903

1. Added support to show existing pkg file for rekey confirmation 2. Updated create package flow to confirm all the entries with user and ti update - if needed

Merge branch 'master' into TBD-126

c000830

TwitchBronBron requested changes Feb 7, 2024

View reviewed changes

src/commands/RekeyAndPackageCommand.ts Show resolved Hide resolved

fumer-fubotv added 2 commits February 8, 2024 10:18

TBD-126

af5fb8b

Added support to maintain status of previously selected host and config

Merge branch 'TBD-126' of https://github.com/rokucommunity/vscode-bri…

cc1d493

…ghtscript-language into TBD-126

TwitchBronBron reviewed Feb 9, 2024

View reviewed changes

TBD-126

18ffa58

updated rekey and create package flow

fumer-fubotv added 2 commits February 13, 2024 10:56

Merge branch 'master' into TBD-126

b4c9e93

Merge branch 'TBD-126' of https://github.com/rokucommunity/vscode-bri…

f1d28ed

…ghtscript-language into TBD-126

TwitchBronBron changed the title ~~Feature request: add ability to rekey/sign apps~~ Add commands to rekey device and create packages Feb 14, 2024

fumer-fubotv and others added 9 commits February 16, 2024 09:48

TBD-126

a9f1f6b

Added support to show package path in successful dialog and an option to open package in file explorer

Use open to open folder instead of custom function

804c139

Normalize a few file paths

c131512

Better rekeySignedPackage handling when empty string

d947737

simplify default config

efabd97

Show .pkg in summary

b0ddb52

Use correct file paths in more dialogs

63d251c

Merge branch 'master' of https://github.com/rokucommunity/vscode-brig…

2f75871

…htscript-language into TBD-126

Remove unused funcs in BrightScriptCommands.ts

c65fa35

TwitchBronBron approved these changes Mar 12, 2024

View reviewed changes

TwitchBronBron merged commit b05f3a3 into master Mar 12, 2024
5 checks passed

TwitchBronBron deleted the TBD-126 branch March 12, 2024 23:12

TwitchBronBron mentioned this pull request Nov 14, 2024

Add a package generation and signing option to the VS Code BrighScript extension #431

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add commands to rekey device and create packages #509

Add commands to rekey device and create packages #509

fumer-fubotv commented Oct 13, 2023 •

edited by TwitchBronBron

Loading

TwitchBronBron left a comment

TwitchBronBron Oct 16, 2023

TwitchBronBron left a comment

fumer-fubotv commented Oct 27, 2023

TwitchBronBron commented Jan 29, 2024 •

edited

Loading

TwitchBronBron left a comment

fumer-fubotv commented Feb 8, 2024 •

edited

Loading

TwitchBronBron left a comment

fumer-fubotv commented Feb 13, 2024 •

edited

Loading

Add commands to rekey device and create packages #509

Add commands to rekey device and create packages #509

Conversation

fumer-fubotv commented Oct 13, 2023 • edited by TwitchBronBron Loading

TwitchBronBron left a comment

Choose a reason for hiding this comment

TwitchBronBron Oct 16, 2023

Choose a reason for hiding this comment

TwitchBronBron left a comment

Choose a reason for hiding this comment

fumer-fubotv commented Oct 27, 2023

TwitchBronBron commented Jan 29, 2024 • edited Loading

TwitchBronBron left a comment

Choose a reason for hiding this comment

fumer-fubotv commented Feb 8, 2024 • edited Loading

TwitchBronBron left a comment

Choose a reason for hiding this comment

fumer-fubotv commented Feb 13, 2024 • edited Loading

fumer-fubotv commented Oct 13, 2023 •

edited by TwitchBronBron

Loading

TwitchBronBron commented Jan 29, 2024 •

edited

Loading

fumer-fubotv commented Feb 8, 2024 •

edited

Loading

fumer-fubotv commented Feb 13, 2024 •

edited

Loading