Open Synthetics recorder directly from kibana via link #77

shahzad31 · 2021-11-17T08:28:57Z

⚠️ As requested by @shahzad31, I (@lucasfcosta) am now responsible for this PR, so I'll be the ones pushing commits and responding to comments in this issue.

Summary

This PR adds the ability to open Recorder directly from Kibana (or any other website) through a link using the elastic-synthetics-recorder-protocol.

You could, for example, use the following EuiLink to open the recorder:

<EuiLink href={`elastic-synthetics-recorder://`}>Open Script Recorder</EuiLink>

Please notice that this PR/task does not include adding the relevant links in Kibana, and that that will be covered separately in elastic/kibana#120638.

For now, there is no way to determine that the recorder is installed or not. Therefore, users which do not have the recorder installed will see the following standard error:

Below is a gif of the link working:

How to test this PR

Clone this branch and package the application using npm run package
Once the application is packaged, mount its dmg and install the .app into Applications.

Create a new folder example-folder and add the following HTML file as index.html to it:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Test Recorder Link</title>
</head>
<body>
  <a href="elastic-synthetics-recorder://">Open recorder</a>
</body>
</html>

Serve the HTML file in that folder using npx http-server example-folder
Access the localhost URL in which you're serving your file and click the Open recorder link. The script recorder should open.

justinkambic · 2021-11-17T17:07:41Z

I like this, curious to hear what @drewpost and @liciavale would think about it, as we haven't really discussed/refined for this functionality AFAIK.

The happy path seems really nice. When we say "it will throw an error" if the protocol isn't present, what does that end up looking like on the Kibana side? Something we can catch and toast about?

vigneshshanmugam · 2021-11-18T06:25:50Z

package.json

@@ -48,7 +48,14 @@
      "main": "build/electron.js"
    },
    "mac": {
-      "icon": "public/elastic.png"
+      "icon": "public/elastic.png",
+      "category": "elastic.synthetics.recorder"


Please remove this, Synthetics should be part of devtools category (https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8) and we will have to do this while notarizing the app #51

vigneshshanmugam · 2021-11-18T06:44:21Z

package.json

+    "protocols": {
+      "name": "ElasticSyntheticsRecorder-protocol",
+      "schemes": [
+        "ElasticSyntheticsRecorder"


please keep it URL spec compatible like keeping it lower case.

paulb-elastic · 2021-11-18T09:22:45Z

I agree with @justinkambic's comment, how does it look to the user if they don't have the script recorder installed?

shahzad31 · 2021-11-18T10:15:20Z

@paulb-elastic @justinkambic so that is UI problem, i mean in kibana, it won't break anything, if you click the link , it will just show standard error

there are many ways we can solve this on the UI, easiest would be to show a dismissable information first time, asking user to download the recorder , we can use EUI tour component to guide the user

Alternatively it's just a standard link, we can capture the error, and show our own dialog with info to download the recorder first.

Essentially, that has nothing to do with this PR, there isn't much we can do here.

apmmachine · 2021-11-29T09:13:41Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2021-12-07T14:55:22.120+0000
Duration: 8 min 50 sec
Commit: df8a462

Test stats 🧪

Test	Results
Failed	0
Passed	30
Skipped	0
Total	30

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

lucasfcosta · 2021-12-06T11:52:41Z

As discussed with @shahzad31 on Slack, I'll be picking this issue up as he's busy at the moment and I'll be working on the recorder more often.

justinkambic

I've looked into it a bit further and haven't found an OS-specific reason we can't merge this, so LGTM.

lucasfcosta · 2021-12-16T11:40:04Z

As mentioned on slack by @justinkambic we'll wait until we have heard back from the security team on whether this can impact notarization:

One thing I’m wondering about this, is will it impact our desire to notarize the app via Elastic’s Apple Dev account. I haven’t fully investigated this yet, it seems innocuous and a really minimal change, but it might be good to verify before we merge this.

shahzad31 · 2022-01-04T09:55:06Z

As mentioned on slack by @justinkambic we'll wait until we have heard back from the security team on whether this can impact notarization:

One thing I’m wondering about this, is will it impact our desire to notarize the app via Elastic’s Apple Dev account. I haven’t fully investigated this yet, it seems innocuous and a really minimal change, but it might be good to verify before we merge this.

I can't possibly think why it will impact notarisation? Did you hear back @lucasfcosta , let's push this otherwise, then we can see how we want to use it in Kibana.

lucasfcosta · 2022-01-04T13:57:42Z

@shahzad31 I've pinged the security team about this subject this morning, and will open a consulting request on their repo as I was instructed. I'll keep this PR up-to-date with their responses and with the issue once it's there.

EDIT: Issue opened on their repo for consultancy (private repo). The link will appear below for those with permissions.

lucasfcosta · 2022-02-11T10:20:25Z

Merging as per the security team's approval. Let's make sure we do another security review before passing data from Kibana to the recorder through the link.

shahzad31 marked this pull request as ready for review November 17, 2021 11:23

shahzad31 requested a review from justinkambic November 17, 2021 11:23

shahzad31 added the enhancement New feature or request label Nov 17, 2021

shahzad31 changed the title ~~added protocol~~ Open Synthetics recorder directly from kibana via link Nov 17, 2021

vigneshshanmugam reviewed Nov 18, 2021

View reviewed changes

lucasfcosta self-assigned this Dec 6, 2021

add protocol to allow opening the recorder from external links

df8a462

lucasfcosta force-pushed the open-app-from-kibana branch from 8915a85 to df8a462 Compare December 7, 2021 14:55

lucasfcosta mentioned this pull request Dec 7, 2021

[Uptime] Add links to open script-recorder from Kibana elastic/kibana#120638

Closed

vigneshshanmugam approved these changes Dec 15, 2021

View reviewed changes

justinkambic approved these changes Dec 15, 2021

View reviewed changes

lucasfcosta merged commit 73c9f1a into main Feb 11, 2022

lucasfcosta deleted the open-app-from-kibana branch February 11, 2022 10:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Open Synthetics recorder directly from kibana via link #77

Open Synthetics recorder directly from kibana via link #77

shahzad31 commented Nov 17, 2021 •

edited by lucasfcosta

Loading

justinkambic commented Nov 17, 2021

vigneshshanmugam Nov 18, 2021

vigneshshanmugam Nov 18, 2021 •

edited

Loading

paulb-elastic commented Nov 18, 2021

shahzad31 commented Nov 18, 2021

apmmachine commented Nov 29, 2021 •

edited

Loading

Build stats

Test stats 🧪

lucasfcosta commented Dec 6, 2021

justinkambic left a comment

lucasfcosta commented Dec 16, 2021

shahzad31 commented Jan 4, 2022

lucasfcosta commented Jan 4, 2022 •

edited

Loading

lucasfcosta commented Feb 11, 2022

Open Synthetics recorder directly from kibana via link #77

Open Synthetics recorder directly from kibana via link #77

Conversation

shahzad31 commented Nov 17, 2021 • edited by lucasfcosta Loading

Summary

How to test this PR

justinkambic commented Nov 17, 2021

vigneshshanmugam Nov 18, 2021

Choose a reason for hiding this comment

vigneshshanmugam Nov 18, 2021 • edited Loading

Choose a reason for hiding this comment

paulb-elastic commented Nov 18, 2021

shahzad31 commented Nov 18, 2021

apmmachine commented Nov 29, 2021 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

🤖 GitHub comments

lucasfcosta commented Dec 6, 2021

justinkambic left a comment

Choose a reason for hiding this comment

lucasfcosta commented Dec 16, 2021

shahzad31 commented Jan 4, 2022

lucasfcosta commented Jan 4, 2022 • edited Loading

lucasfcosta commented Feb 11, 2022

shahzad31 commented Nov 17, 2021 •

edited by lucasfcosta

Loading

vigneshshanmugam Nov 18, 2021 •

edited

Loading

apmmachine commented Nov 29, 2021 •

edited

Loading

lucasfcosta commented Jan 4, 2022 •

edited

Loading