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.

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

chore(developer): upgrade ngrok to v3 #10359

Merged
merged 5 commits into from Jan 24, 2024
Merged

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Jan 11, 2024

Fixes #10357.

User Testing

TEST_NGROK_UPGRADE: In Keyman Developer, Tools|Options|Server, Configure Server, click Download or update ngrok. Once the download completes, the label to the right of the button should show "ngrok version 3.5.0" or similar (it must be version 3.2 or later to pass).

TEST_NGROK_WORKING: In Keyman Developer, verify that you have enabled ngrok in Keyman Developer Server Options. Open a keyboard, and test it on web. Verify that a URL appears in the list of server web addresses, and that when you select it to Open in browser, the test web site works correctly.

Note: your ngrok entry will look different to this but will be a public website:
image

@keymanapp-test-bot keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Jan 11, 2024
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Jan 11, 2024

User Test Results

Test specification and instructions

  • TEST_NGROK_UPGRADE (PASSED): Retested with updated PR build (Keyman 17.0.242-alpha-test-10359) on Windows 11 OS (VM) and here is my observation: 1 . Able to update ngrok version to 3.5. Verified that the label name appeared with the version in the Keyman Developer Server Options window. It seems to be working fine. (notes)
  • TEST_NGROK_WORKING (PASSED): 1. After pasting the token key in Authentication token link, I restarted Keyman Developer build. 2. Opened an existing keyboard project. 3. Compiled it. Verified that a URL appeared in the list of server web address in the 'Build' view. 4. Clicked the ngrok-free.app link then clicked the Open in browser button. 5. It opened ngrok web site page with the 'VisitSite' button. 6. Verified that the test website is working correctly after clicking the 'VisitSite' button. It seems to be working fine. (notes)

Test Artifacts

Copy link
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

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

lgtm

@bharanidharanj
Copy link

Test Results

  • TEST_NGROK_UPGRADE (PASSED): Tested with the attached PR build Keyman 17.0.242-alpha-test-10359 on Windows 10 OS (Native machine) and here is my observation: 1. Able to upgrade ngrok version into 3.5 in Configure Server dialog. Verified that the version number 3.5.0 appeared with ngrok label name.

  • TEST_NGROK_WORKING (FAILED): 1. Verified that the option "Use ngrok to provide public URL for Server" was enabled. 2. Verified that the copy of the token has been pasted in the Authentication token text box. 3. Opened a keyboard project. Compiled keyboard. 4. Clicked the Build tab. 5. Clicked the "Test Keyboard on web" button. Here, I noticed that there is no URL (link with ngrok-free.pp name) appearing in the list of web addresses pane. Seems to be an issue.

@keymanapp-test-bot keymanapp-test-bot bot added user-test-failed and removed user-test-required User tests have not been completed labels Jan 12, 2024
@mcdurdin
Copy link
Member Author

  • TEST_NGROK_WORKING (FAILED):

@bharanidharanj can you re-test this? When you do, if it fails again, can you do the following steps:

  1. Right-click on the Keyman Developer Server icon in the tooltray, and select Show Console. (You may need to do this twice for the console to be made visible).
    image
  2. Locate the Node app in the taskbar and focus it.
    image
  3. Copy the contents of the Node window and paste them into your results.
    image

@keymanapp-test-bot retest TEST_NGROK_WORKING

@keymanapp-test-bot keymanapp-test-bot bot added user-test-required User tests have not been completed and removed user-test-failed labels Jan 17, 2024
@bharanidharanj
Copy link

Test Results

  • TEST_NGROK_WORKING (FAILED): Retested with the attached PR build Keyman 17.0.242-alpha-test-10359 on Windows 10 OS (Native machine) and here is my observation: 1. I got an error message in the Node window.

..on Windows 10

..on Windows 11 (VM)

@keymanapp-test-bot keymanapp-test-bot bot added user-test-failed and removed user-test-required User tests have not been completed labels Jan 18, 2024
@mcdurdin
Copy link
Member Author

@bharanidharanj can you try the following for me please and report on the results:

  • Open a command prompt and type the following commands:

    cd "%appdata%\keyman\Keyman Developer\Server\bin"
    .\ngrok.exe --version
    .\ngrok.exe http 80
    

Thank you!

@bharanidharanj
Copy link

bharanidharanj commented Jan 19, 2024

@bharanidharanj can you try the following for me please and report on the results:

* Open a command prompt and type the following commands:
  ```
  cd "%appdata%\keyman\Keyman Developer\Server\bin"
  .\ngrok.exe --version
  .\ngrok.exe http 80
  ```

Thank you!

@mcdurdin I am getting the following message after running the command lines,

@mcdurdin
Copy link
Member Author

Okay, I am a little bit stumped. Not sure what is causing the problem, perhaps we will need to do a remote desktop session on Monday?

@bharanidharanj
Copy link

Okay, I am a little bit stumped. Not sure what is causing the problem, perhaps we will need to do a remote desktop session on Monday?

@mcdurdin Okay, Thanks.

@mcdurdin
Copy link
Member Author

mcdurdin commented Jan 19, 2024

@bharanidharanj I have put in a fix to remove the region parameter. Can you retest once the build completes?

Thank you!

@keymanapp-test-bot retest

@keymanapp-test-bot keymanapp-test-bot bot added user-test-required User tests have not been completed and removed user-test-failed labels Jan 19, 2024
@bharanidharanj
Copy link

@bharanidharanj I have put in a fix to remove the region parameter. Can you retest once the build completes?

Thank you!

@keymanapp-test-bot retest

@mcdurdin Sure. I will do it.

@mcdurdin mcdurdin modified the milestones: A17S30, A17S31 Jan 20, 2024
@bharanidharanj
Copy link

Test Results

  • TEST_NGROK_UPGRADE (PASSED): Retested with updated PR build (Keyman 17.0.242-alpha-test-10359) on Windows 11 OS (VM) and here is my observation: 1 . Able to update ngrok version to 3.5. Verified that the label name appeared with the version in the Keyman Developer Server Options window. It seems to be working fine.

  • TEST_NGROK_WORKING (PASSED): 1. After pasting the token key in Authentication token link, I restarted Keyman Developer build. 2. Opened an existing keyboard project. 3. Compiled it. Verified that a URL appeared in the list of server web address in the 'Build' view. 4. Clicked the ngrok-free.app link then clicked the Open in browser button. 5. It opened ngrok web site page with the 'VisitSite' button. 6. Verified that the test website is working correctly after clicking the 'VisitSite' button. It seems to be working fine.

..ngrok website link

..ngrok test web page1

..ngrok test web page2

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Jan 22, 2024
@mcdurdin
Copy link
Member Author

mcdurdin commented Jan 22, 2024

TODO: remove the region parameter entirely now that we have verified that this works, and port this to 16.0x

@mcdurdin mcdurdin merged commit 5111e5b into master Jan 24, 2024
4 checks passed
@mcdurdin mcdurdin deleted the chore/developer/10357-ngrok-v3 branch January 24, 2024 08:29
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 17.0.251-alpha

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

chore(developer): upgrade ngrok to v3
4 participants