cloud: add isInTrial helper function by TattdCodeMonkey · Pull Request #239210 · elastic/kibana

TattdCodeMonkey · 2025-10-15T17:30:12Z

Summary

Added the isInTrial helper function to the cloud plugin setup & start interfaces that allow checking if the deployment or serverless project are in trial based on either the trial_end_date or serverless.in_trial config values being set. Adding a function allows the date comparison to be handled by the cloud plugin and possibly updated in the future without consumers needing to know the details of how we verify if the cluster is within a trial cloud organization.

This is a follow-up to #232703 where I added the serverless.in_trial config value. In subsequent PRs it was discussed we should have a helper on the cloud function to give uniform way to access "in trial".

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.~~
Flaky Test Runner was used on any tests changed
~~The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines~~
Review the backport guidelines and apply applicable backport:* labels.

TattdCodeMonkey · 2025-10-15T17:31:11Z

cc: @afharo & @jloleysens

x-pack/platform/plugins/shared/cloud/public/plugin.tsx

Dosant

Nice!

jgowdyelastic

ML changes LGTM

elasticmachine · 2025-10-16T18:17:48Z

Pinging @elastic/fleet (Team:Fleet)

jbudz

packages/kbn-optimizer/limits.yml LGTM

jen-huang

Fleet changes LGTM

TattdCodeMonkey · 2025-10-22T19:28:45Z

@elasticmachine merge upstream

jloleysens

Approving to unblock progress. Thanks for cleaning this up @TattdCodeMonkey.

I'd like to get your thoughts about removing trialEndDate from the setup contract before merging!

jloleysens · 2025-10-24T09:49:50Z

src/platform/plugins/shared/navigation/public/plugin.test.ts

    });

-    it('should set the feedback button visibility to "false" for deployment in trial', async () => {
+    it('should set the feedback button visibility to "false" for deployment in trial via endDate', async () => {


Suggested change

it('should set the feedback button visibility to "false" for deployment in trial via endDate', async () => {

it('should set the feedback button visibility to "false" for deployment in trial', async () => {

Seems like we're removing knowledge of "endDate"?

yes, other plugins should just use the function and let the cloud plugin handle all the logic around endDate.

jloleysens · 2025-10-24T09:55:37Z

x-pack/platform/plugins/shared/cloud/public/plugin.test.ts

+
+          expect(setup.getInTrial()).toBe(false);
+        });
+        it('is `false` when `serverless.in_trial` & `trial_end_date` are not set', () => {


What happens when both serverless.in_trial and trial_end_date are set? IMO we should throw and remove all serverless.in_trial test cases from this set of tests and scope those to the serverless:true config tests below.

@jloleysens serverless.in_trial will override any trial_end_date for the purpose of getInTrial.

I will remove all serverless.in_trial case from here.

I can add code to throw if both are set, but that makes me a little uneasy since both of these config values are set from other systems. I feel like it's more likely someone will break Kibana unwittingly.

remove all serverless.in_trial test cases from this set of tests and scope those to the serverless:true config tests below.

The tests below are testing the start interface. These tests are testing setup. Technically we're exposing the same function, but I'd prefer to have the function tests for both contracts.

I will move the serverless.in_trial test cases into the is serverless enabled section.

x-pack/platform/plugins/shared/cloud/public/plugin.tsx

jloleysens · 2025-10-24T10:00:48Z

x-pack/platform/plugins/shared/cloud/server/plugin.ts

      cloudDefaultPort: decodedId?.defaultPort,
      isCloudEnabled,
-      trialEndDate: this.config.trial_end_date ? new Date(this.config.trial_end_date) : undefined,
+      trialEndDate: this.trialEndDate,


Can we remove this from the setup contract for now? Or does someone need the actual date?

We could, the actual date could be useful in the frontend if we wanted to show something like "5 days left in trial" which I've seen product interested in before.

But currently it is not used like that. So I'm fine removing it if we things thats the best option.

github-actions · 2025-10-24T10:02:59Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

jloleysens · 2025-10-24T10:03:02Z

Oh, and can we test this on serverless before merging, I added the project deploy labels!

Added the getInTrial helper function to the cloud plugin setup & start interfaces that allow checking if the deployment or serverless project are in trial based on either the trial_end_date or serverless.in_trial config values being set. Adding a function allows the date comparison to be handled by the cloud plugin and possibly updated in the future without consumers needing to know the details of how we verify if the cluster is within a trial cloud organization.

Worked on reducing page load bundle size for cloud, but still needed to increase the limit slightly. While working on that change I also added some extra code to handle if the configured `trial_end_date` does not parse, which should never happen but is possible so I ultimately decided to make sure it was handled and logged.

elasticmachine · 2025-10-28T23:19:24Z

⏳ Build in-progress

Buildkite Build
Commit: 122d8af
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-239210-122d8afb3e13
Security Deployment
Elasticsearch Serverless Deployment

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #84 / Alerting builtin alertTypes es_query Query DSL only runs correctly: _source: false field for esQuery search type
[job] [logs] FTR Configs #61 / Serverless Observability - Deployment-agnostic API integration tests Observability Alerting Custom Threshold rule AVG - TICKS - FIRED "after all" hook in "AVG - TICKS - FIRED"
[job] [logs] FTR Configs #28 / Serverless Observability feature flag testing - Deployment-agnostic API integration tests SyntheticsAlertOnNoData "after all" hook for "should change the message if monitor goes from pending to down and recover the alert if monitor goes from pending to up"

History

💔 Build #355897 failed 14b5783
💔 Build #355889 failed 54419eb
💔 Build #355476 failed 87075c8
💛 Build #354445 was flaky bc8f5b1
💚 Build #353796 succeeded 30517ac

## Summary Added the isInTrial helper function to the cloud plugin setup & start interfaces that allow checking if the deployment or serverless project are in trial based on either the trial_end_date or serverless.in_trial config values being set. Adding a function allows the date comparison to be handled by the cloud plugin and possibly updated in the future without consumers needing to know the details of how we verify if the cluster is within a trial cloud organization. This is a follow-up to [elastic#232703](elastic#232703) where I added the `serverless.in_trial` config value. In subsequent PRs it was discussed we should have a helper on the cloud function to give uniform way to access "in trial". ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] ~Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)~ - [ ] ~[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials~ - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] ~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~ - [ ] ~This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations.~ - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] ~The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)~ - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels.

TattdCodeMonkey added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Oct 15, 2025

TattdCodeMonkey requested review from a team as code owners October 15, 2025 17:30

TattdCodeMonkey added the Team:Search label Oct 15, 2025

TattdCodeMonkey requested a review from a team as a code owner October 15, 2025 17:30

TattdCodeMonkey added the v9.3.0 label Oct 15, 2025

TattdCodeMonkey commented Oct 15, 2025

View reviewed changes

x-pack/platform/plugins/shared/cloud/public/plugin.tsx Outdated Show resolved Hide resolved

Dosant approved these changes Oct 15, 2025

View reviewed changes

TattdCodeMonkey force-pushed the cloud-in-trial-func branch from a5bfe92 to dc06931 Compare October 15, 2025 21:25

peteharverson requested a review from jgowdyelastic October 16, 2025 08:20

jgowdyelastic approved these changes Oct 16, 2025

View reviewed changes

TattdCodeMonkey requested a review from a team as a code owner October 16, 2025 18:17

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 16, 2025

TattdCodeMonkey requested a review from a team as a code owner October 16, 2025 21:09

jbudz approved these changes Oct 16, 2025

View reviewed changes

jen-huang approved these changes Oct 16, 2025

View reviewed changes

TattdCodeMonkey force-pushed the cloud-in-trial-func branch from 1189647 to 7eabc4c Compare October 20, 2025 13:53

jloleysens approved these changes Oct 24, 2025

View reviewed changes

jloleysens added ci:project-deploy-elasticsearch Create an Elasticsearch Serverless project ci:project-deploy-observability Create an Observability project ci:project-deploy-security Create a Security Serverless Project labels Oct 24, 2025

TattdCodeMonkey added 3 commits October 27, 2025 20:09

chore: fix types in tests with addition of getInTrial

25f3834

test: update to mock getInTrial

76802f2

TattdCodeMonkey added 4 commits October 27, 2025 20:10

test: update to mock getInTrial

76802f2

cloud: rename getInTrial to isInTrial

c55cb10

test(cloud): improve grouping of isInTrial tests

7eac841

test(cloud): fix broken tests

87075c8

TattdCodeMonkey force-pushed the cloud-in-trial-func branch 2 times, most recently from 54419eb to 14b5783 Compare October 28, 2025 16:36

TattdCodeMonkey force-pushed the cloud-in-trial-func branch from 14b5783 to 122d8af Compare October 28, 2025 21:52

TattdCodeMonkey changed the title ~~cloud: add getInTrial helper function~~ cloud: add isInTrial helper function Oct 29, 2025

TattdCodeMonkey merged commit 7a9460f into elastic:main Oct 29, 2025
13 checks passed

	it('should set the feedback button visibility to "false" for deployment in trial via endDate', async () => {
	it('should set the feedback button visibility to "false" for deployment in trial', async () => {

Conversation

TattdCodeMonkey commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

TattdCodeMonkey commented Oct 15, 2025

Uh oh!

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

jgowdyelastic left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Oct 16, 2025

Uh oh!

jbudz left a comment

Choose a reason for hiding this comment

Uh oh!

jen-huang left a comment

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey commented Oct 22, 2025

Uh oh!

jloleysens left a comment

Choose a reason for hiding this comment

Uh oh!

jloleysens Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

jloleysens Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jloleysens Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 24, 2025

🤖 GitHub comments

Uh oh!

jloleysens commented Oct 24, 2025

Uh oh!

elasticmachine commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⏳ Build in-progress

Failed CI Steps

Test Failures

History

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

TattdCodeMonkey commented Oct 15, 2025 •

edited

Loading

elasticmachine commented Oct 28, 2025 •

edited

Loading