feat: configure Segment plugin to be able to send data to Red Hat (enabled by default) #1028

kadel · 2024-02-28T20:22:14Z

Description

This PR adds configuration for the Segment plugin to send data to Red Hat. The plugin is ENABLED by default. If user doesn't want that, the plugin needs to be disabled in the Helm or Operator configuration.

I'm having issues with this plugin when running locally. The Segment plugin fails to load correctly, and it shows a warning in the browser console (https://issues.redhat.com/browse/RHIDP-1451):

Segment.ts:58 Failed to read configuration value at 'app.analytics.segment.writeKey' as it is not visible. See https://backstage.io/docs/conf/defining#visibility for instructions on how to make it visible.

This issue is present only when running locally (yarn start). When running from the image, everything is OK. Because o that I don't consider this a blocker for this PR, it might be issue with local configuration.

TODOs:

add documentation and information on how to enable and disable
provide the production key to the production Dockerfile (this will be done in downstream https://gitlab.cee.redhat.com/rhidp/rhdh/-/merge_requests/10/diffs?commit_id=35426e292eda191d0b3ecf649695ecc416ff73a7#86d2a35e6325bba5ceaf29e203b14cd809af55fd_175_184)

Which issue(s) does this PR fix

Related to: https://issues.redhat.com/browse/RHIDP-1311

PR acceptance criteria

Please make sure that the following steps are complete:

GitHub Actions are completed and successful
Unit Tests are updated and passing
E2E Tests are updated and passing
Documentation is updated if necessary (requirement for new features)
Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

github-actions · 2024-02-28T20:48:43Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

github-actions · 2024-03-01T13:30:31Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

janus-idp · 2024-03-01T14:30:34Z

backstage-showcase Tests on commit 58f3b9d finished successfully.
View test log

nickboldt

instead of a chore should this be a feat since it changes default behaviour and enables "phone home" delivery of telemetry data?

nickboldt · 2024-03-01T14:37:08Z

.rhdh/docker/Dockerfile

@@ -229,6 +229,11 @@ ENV CHOKIDAR_USEPOLLING='1' CHOKIDAR_INTERVAL='10000'
 # To avoid running scripts when using `npm pack` to install dynamic plugins
 ENV NPM_CONFIG_ignore-scripts='true'

+# Segment key for production
+#TODO
+ENV SEGMENT_WRITE_KEY=""


would it make sense to have the dev key enabled by default here SEGMENT_WRITE_KEY=gGVM6sYRK0D0ndVX22BOtS7NRcxPej8t and then switch to the production key ONLY in downstream builds here?

https://gitlab.cee.redhat.com/rhidp/rhdh/-/blob/rhdh-1-rhel-9/build/ci/sync-midstream.sh#L321

Sure, we can do that.
I assume that you will be doing something like sed 's/SEGMENT_WRITE_KEY=.*$/SEGMENT_WRITE_KEY=<prodkey>/'. It would be nice to have this in place before we merge this PR. Can you please make the necessary changes to sync-midstream.sh script?

Occurs to me the only value in having one public key here and the other public key in gitlab is to obfuscate the prod key, but it's public and plain text in the container sources, so why bother?

On the other hand, if we put the prod key here as default, then we could toggle it off only for some builds downstream (eg. anything built from the main branch)

transformation code to switch keys once we create the 1.2.x branch: https://gitlab.cee.redhat.com/rhidp/rhdh/-/merge_requests/10/diffs?commit_id=35426e292eda191d0b3ecf649695ecc416ff73a7#86d2a35e6325bba5ceaf29e203b14cd809af55fd_175_184

dynamic-plugins.default.yaml

github-actions · 2024-03-01T16:04:10Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

schultzp2020

/lgtm
/approve

github-actions · 2024-03-08T15:41:10Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

github-actions · 2024-03-08T16:23:21Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

github-actions · 2024-03-08T19:40:16Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

github-actions · 2024-03-09T19:21:36Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

.ibm/pipelines/openshift-tests.sh

.rhdh/docker/Dockerfile

Co-authored-by: Shipra Singh <94683525+shipsing@users.noreply.github.com>

Co-authored-by: Nick Boldt <nboldt@redhat.com>

github-actions · 2024-05-16T14:43:33Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

kadel · 2024-05-17T11:08:55Z

/retest

github-actions · 2024-05-17T11:33:22Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

github-actions · 2024-05-17T12:29:01Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

kadel · 2024-05-17T12:58:29Z

/retest

sonarcloud · 2024-05-20T09:39:34Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
2.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-05-20T10:03:32Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1028!

kadel · 2024-05-20T11:43:06Z

/retest


    "beforeAll" hook timeout of 80000ms exceeded.
      14 |     'https://github.com/janus-qe/custom-catalog-entities/blob/main/timestamp-catalog-info.yaml';
      15 |
    > 16 |   test.beforeAll(async ({ browser }, testInfo) => {
         |        ^
      17 |     page = (await setupBrowser(browser, testInfo)).page;
      18 |
      19 |     common = new Common(page);
        at /tmp/backstage-showcase/e2e-tests/playwright/e2e/catalog-timestamp.spec.ts:16:8
    "beforeAll" hook timeout of 80000ms exceeded.
      14 |     'https://github.com/janus-qe/custom-catalog-entities/blob/main/timestamp-catalog-info.yaml';
      15 |
    > 16 |   test.beforeAll(async ({ browser }, testInfo) => {
         |        ^
      17 |     page = (await setupBrowser(browser, testInfo)).page;
      18 |
      19 |     common = new Common(page);
        at /tmp/backstage-showcase/e2e-tests/playwright/e2e/catalog-timestamp.spec.ts:16:8
    Error: expect(locator).toBeHidden()
    Locator: locator('#app_totp')
    Expected: hidden
    Received: visible
    Call log:
      - expect.toBeHidden with timeout 120000ms
      - waiting for locator('#app_totp')
      -   locator resolved to <input value="" type="text" id="app_totp" name="app_otp…/>
      -   unexpected value "visible"

kadel · 2024-05-20T13:07:03Z

/lgtm

openshift-ci · 2024-05-20T13:07:05Z

@kadel: you cannot LGTM your own PR.

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

invincibleJai · 2024-05-20T13:23:07Z

/lgtm

openshift-ci · 2024-05-20T13:23:16Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: invincibleJai, kadel, schultzp2020

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [invincibleJai,kadel,schultzp2020]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kadel requested a review from a team as a code owner February 28, 2024 20:22

openshift-ci bot added the do-not-merge/work-in-progress label Feb 28, 2024

openshift-ci bot requested review from nickboldt and Zaperex February 28, 2024 20:22

kadel force-pushed the enable-telemetry branch 2 times, most recently from c5f392c to 46fdb5d Compare March 1, 2024 13:03

nickboldt reviewed Mar 1, 2024

View reviewed changes

dynamic-plugins.default.yaml Show resolved Hide resolved

kadel force-pushed the enable-telemetry branch from 46fdb5d to e96c1d4 Compare March 1, 2024 15:38

schultzp2020 previously approved these changes Mar 1, 2024

View reviewed changes

openshift-ci bot assigned schultzp2020 Mar 1, 2024

openshift-ci bot added lgtm approved labels Mar 1, 2024

kadel changed the title ~~WIP: chore: enable and configure Segment plugin to start sending data~~ WIP: feat: enable and configure Segment plugin to start sending data Mar 8, 2024

kadel force-pushed the enable-telemetry branch from 0775037 to a57b75e Compare March 8, 2024 15:14

openshift-ci bot removed the lgtm label Mar 8, 2024

kadel force-pushed the enable-telemetry branch from 673563c to c9d698a Compare March 8, 2024 19:13

kadel force-pushed the enable-telemetry branch from c9d698a to bdd4f34 Compare March 9, 2024 18:54

nickboldt reviewed Mar 12, 2024

View reviewed changes

.ibm/pipelines/openshift-tests.sh Outdated Show resolved Hide resolved

nickboldt reviewed Mar 12, 2024

View reviewed changes

.ibm/pipelines/openshift-tests.sh Outdated Show resolved Hide resolved

nickboldt reviewed Mar 12, 2024

View reviewed changes

.rhdh/docker/Dockerfile Show resolved Hide resolved

kadel and others added 10 commits May 16, 2024 16:11

Apply suggestions from code review

31b2165

Co-authored-by: Shipra Singh <94683525+shipsing@users.noreply.github.com>

apply more suggestions from code review

1b389f7

Apply suggestions from code review

295d5a1

Co-authored-by: Nick Boldt <nboldt@redhat.com>

add suggestions from code review

7e5c661

remove removed openshift-tests.sh

e39c7f8

Update getting-started.md

e2e879e

fix wording and formatting

134b949

enable telemetry by default

0e4d980

set SEGMENT_TEST_MODE=true in CI deployments

d3ba44f

debug test

c09bb85

kadel force-pushed the enable-telemetry branch from 1cf3e03 to 18d874d Compare May 16, 2024 14:11

ci: use value_files instead of hack with yq

9ba69fc

kadel force-pushed the enable-telemetry branch from 18d874d to 9ba69fc Compare May 16, 2024 14:12

kadel force-pushed the enable-telemetry branch from 97a7f69 to 9ba69fc Compare May 17, 2024 12:02

Merge branch 'main' into enable-telemetry

63b9a57

openshift-ci bot assigned invincibleJai May 20, 2024

openshift-ci bot added the lgtm label May 20, 2024

openshift-merge-bot bot merged commit 6a64308 into janus-idp:main May 20, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: configure Segment plugin to be able to send data to Red Hat (enabled by default) #1028

feat: configure Segment plugin to be able to send data to Red Hat (enabled by default) #1028

kadel commented Feb 28, 2024 •

edited

github-actions bot commented Feb 28, 2024

github-actions bot commented Mar 1, 2024

janus-idp bot commented Mar 1, 2024 •

edited

nickboldt left a comment

nickboldt Mar 1, 2024

kadel Mar 8, 2024

nickboldt Mar 12, 2024

nickboldt Apr 29, 2024 •

edited

github-actions bot commented Mar 1, 2024

schultzp2020 left a comment

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 9, 2024

github-actions bot commented May 16, 2024

kadel commented May 17, 2024

github-actions bot commented May 17, 2024

github-actions bot commented May 17, 2024

kadel commented May 17, 2024

sonarcloud bot commented May 20, 2024

github-actions bot commented May 20, 2024

kadel commented May 20, 2024

kadel commented May 20, 2024

openshift-ci bot commented May 20, 2024

invincibleJai commented May 20, 2024

openshift-ci bot commented May 20, 2024

feat: configure Segment plugin to be able to send data to Red Hat (enabled by default) #1028

feat: configure Segment plugin to be able to send data to Red Hat (enabled by default) #1028

Conversation

kadel commented Feb 28, 2024 • edited

Description

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

github-actions bot commented Feb 28, 2024

github-actions bot commented Mar 1, 2024

janus-idp bot commented Mar 1, 2024 • edited

nickboldt left a comment

Choose a reason for hiding this comment

nickboldt Mar 1, 2024

Choose a reason for hiding this comment

kadel Mar 8, 2024

Choose a reason for hiding this comment

nickboldt Mar 12, 2024

Choose a reason for hiding this comment

nickboldt Apr 29, 2024 • edited

Choose a reason for hiding this comment

github-actions bot commented Mar 1, 2024

schultzp2020 left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

github-actions bot commented Mar 9, 2024

github-actions bot commented May 16, 2024

kadel commented May 17, 2024

github-actions bot commented May 17, 2024

github-actions bot commented May 17, 2024

kadel commented May 17, 2024

sonarcloud bot commented May 20, 2024

Quality Gate passed

github-actions bot commented May 20, 2024

kadel commented May 20, 2024

kadel commented May 20, 2024

openshift-ci bot commented May 20, 2024

invincibleJai commented May 20, 2024

openshift-ci bot commented May 20, 2024

kadel commented Feb 28, 2024 •

edited

janus-idp bot commented Mar 1, 2024 •

edited

nickboldt Apr 29, 2024 •

edited