[Uptime] Migrate to TypeScript project references #90510

justinkambic · 2021-02-05T21:06:24Z

Summary

Resolves #87170.

Author checklist

Resolve all build errors running tsc from node_modules
Add project reference to references prop in tsconfig.refs.json
Add your plugin to references property and plugin folder to exclude property of the tsconfig.json it used to belong to (for example, for src/plugins/ it’s tsconfig.json; for x-pack/plugins/ it’s x-pack/tsconfig.json).
List the reference to your newly created project in all the Kibana tsconfig.json files that could import your project: tsconfig.json, test/tsconfig.json, x-pack/tsconfig.json, x-pack/test/tsconfig.json. And in all the plugin-specific tsconfig.refs.json for dependent plugins.
You can measure how your changes affect tsc compiler performance with node --max-old-space-size=4096 ./node_modules/.bin/tsc -p tsconfig.json --extendedDiagnostics --noEmit. Compare with master branch.

Checklist

Delete any items that are not applicable to this PR.

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
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

… `x-pack/tsconfig.json`.

elasticmachine · 2021-02-05T22:42:34Z

Pinging @elastic/uptime (Team:uptime)

justinkambic · 2021-02-05T22:46:57Z

x-pack/plugins/uptime/public/components/overview/monitor_list/monitor_list_drawer/data.json

@@ -261,7 +261,25 @@
          },
          "state": {
            "agent": null,
-            "checks": ,


A little concerning that this didn't cause anything to break (until now).

justinkambic · 2021-02-05T22:47:22Z

x-pack/plugins/uptime/common/constants/alerts.ts

+export type TLSActionGroup = ActionGroup<'xpack.uptime.alerts.actionGroups.tls'>;
+export type DurationAnomalyActionGroup = ActionGroup<'xpack.uptime.alerts.actionGroups.durationAnomaly'>;
+
+export const MONITOR_STATUS: MonitorStatusActionGroup = {


The compiler seemed to want these exported individually in the way we were referencing them.

justinkambic · 2021-02-05T22:47:46Z

x-pack/plugins/uptime/public/state/index.ts

@@ -12,6 +12,13 @@ import { rootReducer } from './reducers';

 export type AppState = ReturnType<typeof rootReducer>;

+type ComposeType = typeof compose;


This was copied from another plugin's solution for providing a global type for redux devtools.

justinkambic · 2021-02-05T22:48:17Z

x-pack/plugins/uptime/tsconfig.json

+    "public/**/*",
+    "server/**/*",
+    "../../../typings/**/*",
+    "public/**/*.json",


The glob syntax above appeared to ignore JSON files.

since there are just two json files, maybe it doesn't make sense to use wildcard pattern

Sure, we can make it more specific. The drawback will be when someone adds a dependency in the future this will need to be updated each time.

andrewvc

Mostly good, left some minor comments / questions

x-pack/plugins/uptime/server/lib/requests/get_journey_steps.ts

x-pack/plugins/uptime/public/state/index.ts

shahzad31 · 2021-02-08T11:14:10Z

x-pack/plugins/uptime/tsconfig.json

+    "server/**/*",
+    "../../../typings/**/*",
+    "public/**/*.json",
+    "server/**/*.json"


Suggested change

"server/**/*.json"

"server/lib/requests/__fixtures__/monitor_charts_mock.json"

shahzad31 · 2021-02-08T11:14:28Z

x-pack/plugins/uptime/tsconfig.json

+    "public/**/*",
+    "server/**/*",
+    "../../../typings/**/*",
+    "public/**/*.json",


Suggested change

"public/**/*.json",

"server/lib/requests/__fixtures__/monitor_charts_mock.json"

shahzad31 · 2021-02-08T11:19:23Z

x-pack/plugins/uptime/public/state/index.ts

+declare global {
+  interface Window {
+    __REDUX_DEVTOOLS_EXTENSION_COMPOSE__: ComposeType;
+  }
+}
+
 const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose;


i would prefer to use this here, this package is already part of kibana, so it would be easier to use.

import { composeWithDevTools } from 'redux-devtools-extension'; export const store = createStore(rootReducer, composeWithDevTools(applyMiddleware(sagaMW)));

shahzad31 · 2021-02-08T11:20:51Z

@elasticmachine merge upstream

…om:justinkambic/kibana into uptime-87170_migrate-to-typescript-project

justinkambic

I just implemented review feedback and pushed 3146d9a.

justinkambic · 2021-02-08T14:29:09Z

x-pack/plugins/uptime/tsconfig.json

+    "public/**/*",
+    "server/**/*",
+    "../../../typings/**/*",
+    "public/**/*.json",


Sure, we can make it more specific. The drawback will be when someone adds a dependency in the future this will need to be updated each time.

x-pack/plugins/uptime/server/lib/requests/get_journey_steps.ts

justinkambic · 2021-02-08T14:35:36Z

x-pack/plugins/uptime/public/state/index.ts

+declare global {
+  interface Window {
+    __REDUX_DEVTOOLS_EXTENSION_COMPOSE__: ComposeType;
+  }
+}
+
 const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose;


x-pack/plugins/uptime/public/state/index.ts

shahzad31

LGTM, WFG !!

andrewvc

LGTM

justinkambic · 2021-02-08T21:47:28Z

@elasticmachine merge upstream

kibanamachine · 2021-02-08T23:53:13Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: a11730b

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`uptime`	589	590	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`uptime`	908.6KB	909.2KB	+592.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`uptime`	19.4KB	19.5KB	+90.0B

History

💔 Build #104738 failed 27b536d
💚 Build #104639 succeeded cf3e479
💚 Build #104445 succeeded 51842a6
💚 Build #104421 succeeded 2119e40

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* Add reference to Uptime plugin to root tsconfig.refs.json. * Add Uptime path to excluded list, and reference to references prop in `x-pack/tsconfig.json`. * Add reference to Uptime project in `x-pack/test/tsconfig.json`. * Add `tsconfig.json` project file to Uptime. * Fix broken JSON structure in test fixture. * Fix broken type exports. Introduce missing types. * Implement PR feedback. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…timeline-and-rollover-info * 'master' of github.com:elastic/kibana: (47 commits) [Fleet] Use TS project references (elastic#87574) before/beforeEach clean up (elastic#90663) [Vega] user should be able to set a specific tilemap service using the mapStyle property (elastic#88440) [Security Solution][Case] ServiceNow SIR Connector (elastic#88655) [Search Sessions] Enable extend from management (elastic#90558) [ILM] Delete phase redesign (rework) (elastic#90291) [APM-UI][E2E] use withGithubStatus step (elastic#90651) Add folding in kb-monaco and update some viewers (elastic#90152) [Grok Debugger] Changed test to wait for grok debugger container to exist to fix test flakiness (elastic#90543) Strongly typed EUI theme for styled-components (elastic#90106) Fix vega renovate label (elastic#90591) [Uptime] Migrate to TypeScript project references (elastic#90510) [Monitoring] Migrate data source for legacy alerts to monitoring data directly (elastic#87377) [Upgrade Assistant] Add A11y Tests (elastic#90265) [Time to Visualize] Adds functional tests for linking/unlinking panel from embeddable library (elastic#89612) [dev-utils/ship-ci-stats] fail when CI stats is down (elastic#90678) chore(NA): remove write permissions on Bazel remote cache for PRs (elastic#90652) chore(NA): move bazel workspace status from bash script into nodejs executable (elastic#90560) Use default ES distribution for functional tests (elastic#88737) [Alerts] Jira: Disallow labels with spaces (elastic#90548) ... # Conflicts: # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/timeline/timeline.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/lib/absolute_timing_to_relative_timing.test.ts # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/lib/absolute_timing_to_relative_timing.ts

justinkambic · 2021-02-09T16:15:03Z

Backported to:

7.x/7.12.0 c8b1485
[7.x] [Uptime] Migrate to TypeScript project references (#90510) #90721

…astic#90721) * Add reference to Uptime plugin to root tsconfig.refs.json. * Add Uptime path to excluded list, and reference to references prop in `x-pack/tsconfig.json`. * Add reference to Uptime project in `x-pack/test/tsconfig.json`. * Add `tsconfig.json` project file to Uptime. * Fix broken JSON structure in test fixture. * Fix broken type exports. Introduce missing types. * Implement PR feedback. Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

justinkambic added v8.0.0 Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v7.12.0 labels Feb 5, 2021

justinkambic self-assigned this Feb 5, 2021

justinkambic added 6 commits February 5, 2021 17:18

Add reference to Uptime plugin to root tsconfig.refs.json.

b73060c

Add Uptime path to excluded list, and reference to references prop in…

f6147f9

… `x-pack/tsconfig.json`.

Add reference to Uptime project in x-pack/test/tsconfig.json.

ae7bea1

Add tsconfig.json project file to Uptime.

159440c

Fix broken JSON structure in test fixture.

e513411

Fix broken type exports. Introduce missing types.

51842a6

justinkambic force-pushed the uptime-87170_migrate-to-typescript-project branch from 2119e40 to 51842a6 Compare February 5, 2021 22:19

justinkambic requested review from andrewvc and shahzad31 February 5, 2021 22:21

justinkambic marked this pull request as ready for review February 5, 2021 22:42

justinkambic requested a review from a team as a code owner February 5, 2021 22:42

justinkambic added the release_note:skip Skip the PR/issue when compiling release notes label Feb 5, 2021

justinkambic commented Feb 5, 2021

View reviewed changes

andrewvc reviewed Feb 5, 2021

View reviewed changes

x-pack/plugins/uptime/server/lib/requests/get_journey_steps.ts Show resolved Hide resolved

x-pack/plugins/uptime/public/state/index.ts Outdated Show resolved Hide resolved

shahzad31 mentioned this pull request Feb 8, 2021

[Uptime] Add ts config file #87810

Closed

shahzad31 reviewed Feb 8, 2021

View reviewed changes

kibanamachine and others added 3 commits February 8, 2021 06:20

Merge branch 'master' into uptime-87170_migrate-to-typescript-project

cf3e479

Merge branch 'master' into uptime-87170_migrate-to-typescript-project

d934e20

Implement PR feedback.

3146d9a

Merge branch 'uptime-87170_migrate-to-typescript-project' of github.c…

de65d3f

…om:justinkambic/kibana into uptime-87170_migrate-to-typescript-project

justinkambic commented Feb 8, 2021

View reviewed changes

shahzad31 approved these changes Feb 8, 2021

View reviewed changes

Merge branch 'master' into uptime-87170_migrate-to-typescript-project

27b536d

andrewvc approved these changes Feb 8, 2021

View reviewed changes

Merge branch 'master' into uptime-87170_migrate-to-typescript-project

a11730b

justinkambic merged commit c7e23bf into elastic:master Feb 9, 2021

This was referenced Feb 9, 2021

[Meta] Migrate Kibana plugins to TS project references #80508

Closed

[7.x] [Uptime] Migrate to TypeScript project references (#90510) #90721

Merged

justinkambic deleted the uptime-87170_migrate-to-typescript-project branch February 9, 2021 16:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Migrate to TypeScript project references #90510

[Uptime] Migrate to TypeScript project references #90510

justinkambic commented Feb 5, 2021 •

edited

Loading

elasticmachine commented Feb 5, 2021

justinkambic Feb 5, 2021 •

edited

Loading

justinkambic Feb 5, 2021

justinkambic Feb 5, 2021

justinkambic Feb 5, 2021

shahzad31 Feb 8, 2021

justinkambic Feb 8, 2021

andrewvc left a comment

shahzad31 Feb 8, 2021

shahzad31 Feb 8, 2021

shahzad31 Feb 8, 2021

justinkambic Feb 8, 2021

shahzad31 commented Feb 8, 2021

justinkambic left a comment

justinkambic Feb 8, 2021

justinkambic Feb 8, 2021

shahzad31 left a comment

andrewvc left a comment

justinkambic commented Feb 8, 2021

kibanamachine commented Feb 8, 2021

justinkambic commented Feb 9, 2021

		@@ -12,6 +12,13 @@ import { rootReducer } from './reducers';

		export type AppState = ReturnType<typeof rootReducer>;

		type ComposeType = typeof compose;

	"server/*/.json"
	"server/lib/requests/__fixtures__/monitor_charts_mock.json"

	"public/*/.json",
	"server/lib/requests/__fixtures__/monitor_charts_mock.json"

[Uptime] Migrate to TypeScript project references #90510

[Uptime] Migrate to TypeScript project references #90510

Conversation

justinkambic commented Feb 5, 2021 • edited Loading

Summary

Author checklist

Checklist

For maintainers

elasticmachine commented Feb 5, 2021

justinkambic Feb 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewvc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shahzad31 commented Feb 8, 2021

justinkambic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shahzad31 left a comment

Choose a reason for hiding this comment

andrewvc left a comment

Choose a reason for hiding this comment

justinkambic commented Feb 8, 2021

kibanamachine commented Feb 8, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

justinkambic commented Feb 9, 2021

justinkambic commented Feb 5, 2021 •

edited

Loading

justinkambic Feb 5, 2021 •

edited

Loading