[Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults #77698

cee-chen · 2020-09-17T01:27:23Z

Summary

Promise I'm not trying to steal your thunder @JasonStoltz - just want to keep commits as modular as possible, + this way it makes it easier for us to have a convo about this separately from the credentials logic :)

Per Jason's explanation on what Kea paths accomplish, these changes should:

Make debugging w/ Redux DevTools: See https://kea.js.org/docs/guide/debugging/#logic-path

Make initializing values via resetContext easier: https://kea.js.org/docs/api/context/#resetcontext

kibana/x-pack/plugins/enterprise_search/public/applications/app_search/components/credentials/credentials_logic.test.ts

Lines 21 to 33 in b0fcf4a

    
             resetContext({ 
        
               // the enterprise_search.app_search.credentials namespace is set in `path` in credentials_logic 
        
               defaults: { 
        
                 enterprise_search: { 
        
                   app_search: { 
        
                     credentials: { 
        
                       ...defaults, 
        
                     }, 
        
                   }, 
        
                 }, 
        
               }, 
        
             }); 
        
           }

Checklist

All tests pass as before

cee-chen · 2020-09-17T01:29:30Z

x-pack/plugins/enterprise_search/public/applications/app_search/app_logic.ts

@@ -16,6 +16,7 @@ export interface IAppActions {
 }

 export const AppLogic = kea<MakeLogicType<IAppValues, IAppActions>>({
+  path: ['enterpriseSearch', 'appSearch', 'app'],


@JasonStoltz changed from snake_case to camelCase, hope that's cool 🤔

Also... do we have any strong thoughts about using our common/constants.ts strings here? In theory this could be:

path: [ENTERPRISE_SEARCH_PLUGIN.ID, APP_SEARCH_PLUGIN.ID, 'app']

instead... but I don't know if that's necessarily better/easier to read lol? (I'm pretty lazy about constant strings when it comes to dev-only strings tbh though, it's one of my many failings)

tbh I like camel case because it matches the directory/file structure. If I saw enterprise_search -> app_search -> app_logic I know exactly what I need to type into the file jumper in vscode to get there. Otherwise if we use camelcase these should be names of the components and Logics [EnterpriseSearch, AppSearchConfigured, AppLogic]. If this is meant to ease debugging it should give me something I can easily search our codebase for to get to.

Doesn't matter to me which we go with, I just want to get this merged

tbh I like camel case

assuming you mean snake case, just to confirm?

re: names lining up with directory / file names:

I think if we want to guarantee that, we should just install babel-plugin-kea to automatically handle that for us. Otherwise, there's absolutely no guarantee that someone will name all logic files correctly in the future (for example, this line in question is app, not even appLogic).

I can definitely switch this PR over to just being yarn install if we're cool with it. Yay/nay?

assuming you mean snake case, just to confirm?

yeah sorry, I'm a idiot lmao

10000% for using this babel plugin

Awesome possum. Imma do it here shortly

After a bit more digging: sadly it's not that straightforward 😞 Since Kibana maintains it's own babel package/settings, we'll have to open an issue and get approval from the ops team after they evaluate the plugin.

Additionally, after looking at the plugin source code, it camelCases file names so it actually wouldn't achieve what Byron wants in any case (doh).

@byronhulcher it sounds like you have the strongest feelings here re: path names, so I'll go ahead and rename to snake_case as well as matching file names exactly. I'm also going to update our documentation/README to note our use of Kea and path names, and why we're specifically using snake_case for those lines.

scottybollinger

LGTM. I personally lean against the constants in path, since this is dev-only

…me for last path key

cee-chen · 2020-09-17T17:25:03Z

.../plugins/enterprise_search/public/applications/shared/flash_messages/flash_messages_logic.ts

@@ -32,6 +32,7 @@ const convertToArray = (messages: IFlashMessage | IFlashMessage[]) =>
  !Array.isArray(messages) ? [messages] : messages;

 export const FlashMessagesLogic = kea<MakeLogicType<IFlashMessagesValues, IFlashMessagesActions>>({
+  path: ['enterprise_search', 'flash_messages_logic'],


@byronhulcher just wanted to highlight that this still doesn't "exactly" follow the file path (i.e. enterprise_search/public/applications/shared/flash_messages/flash_messages/logic), but hopefully the important part is the last key for file finding purposes 🤷

cee-chen · 2020-09-17T17:26:11Z

Re-requesting reviews from everyone (particularly on the docs!) 📖

cee-chen · 2020-09-17T17:27:21Z

Final output:

BTW, I don't know if it's just me, but the Redux Devtools only works for me in Chrome and not Firefox. sad trombone noises

JasonStoltz

Thank you.

kibanamachine · 2020-09-17T19:01:03Z

💚 Build Succeeded

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

Build metrics

async chunks size

id	value	diff	baseline
enterpriseSearch	434.0KB	+353.0B	433.7KB

History

💛 Build #75054 was flaky 8da3ce2

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

…ng/defaults (#77698) (#77820) * Add Kea logic paths for easier debugging/defaults * PR feedback: prefer snake_case to match file names, use exact file name for last path key * Document Kea + casing logic

* master: (92 commits) [ILM] Data tiers for 7.10 (elastic#76126) [ML] Transforms: Fixes styling of preview grid pagination in summary step (elastic#77789) [Drilldowns] Beta badge support. Mark URL Drilldown as Beta (elastic#75654) Re-enable session lifespan, idle timeout api integration tests and use unique names for the security test reports. (elastic#77746) [Alerting] renames code in alerting RBAC exemption to make it easier to maintain (elastic#77598) [Alerting & Actions] Overwrite SOs when updating instead of partially updating (elastic#73688) fixed react warning in Suspense in alert flyout (elastic#77777) [APM] Track usage of Gold+ features (elastic#77630) Visualize: Bad request when working with histogram aggregation (elastic#77684) remove legacy ES plugin (elastic#77703) [Lens] change name of custom query to filters (elastic#77725) skip flaky suite (elastic#76239) remove visual aspects of baseline job (elastic#77815) skip flaky suite (elastic#77835) Fixes typo in data recognizer text (elastic#77691) management/update trusted_apps jest snapshot [build] Use Elastic hosted UBI minimal base image (elastic#77776) [APM] Add transaction error rate alert (elastic#76933) [Security Solution] [Detections] Remove file validation on import route (elastic#77770) [Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults (elastic#77698) ...

Add Kea logic paths for easier debugging/defaults

8da3ce2

cee-chen added Feature:Plugins release_note:skip Skip the PR/issue when compiling release notes v7.10.0 labels Sep 17, 2020

cee-chen requested review from JasonStoltz, scottybollinger and a team September 17, 2020 01:27

cee-chen commented Sep 17, 2020

View reviewed changes

scottybollinger approved these changes Sep 17, 2020

View reviewed changes

JasonStoltz approved these changes Sep 17, 2020

View reviewed changes

cee-chen added 2 commits September 17, 2020 10:15

PR feedback: prefer snake_case to match file names, use exact file na…

0d43d01

…me for last path key

Document Kea + casing logic

bc89e3a

cee-chen commented Sep 17, 2020

View reviewed changes

cee-chen requested review from JasonStoltz, scottybollinger and byronhulcher September 17, 2020 17:26

JasonStoltz approved these changes Sep 17, 2020

View reviewed changes

cee-chen merged commit 0a21d70 into elastic:master Sep 17, 2020

cee-chen deleted the kea-paths branch September 17, 2020 20:04

cee-chen mentioned this pull request Sep 17, 2020

[7.x] [Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults (#77698) #77820

Merged

cee-chen mentioned this pull request Sep 17, 2020

[Enterprise Search] Added Logic for the Credentials View #77626

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults #77698

[Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults #77698

cee-chen commented Sep 17, 2020 •

edited

Loading

cee-chen Sep 17, 2020 •

edited

Loading

byronhulcher Sep 17, 2020

JasonStoltz Sep 17, 2020 •

edited

Loading

cee-chen Sep 17, 2020 •

edited

Loading

byronhulcher Sep 17, 2020

cee-chen Sep 17, 2020

cee-chen Sep 17, 2020

scottybollinger left a comment

cee-chen Sep 17, 2020

cee-chen commented Sep 17, 2020 •

edited

Loading

cee-chen commented Sep 17, 2020

JasonStoltz left a comment

kibanamachine commented Sep 17, 2020

	resetContext({
	// the enterprise_search.app_search.credentials namespace is set in `path` in credentials_logic
	defaults: {
	enterprise_search: {
	app_search: {
	credentials: {
	...defaults,
	},
	},
	},
	},
	});
	}

[Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults #77698

[Enterprise Search][tech debt] Add Kea logic paths for easier debugging/defaults #77698

Conversation

cee-chen commented Sep 17, 2020 • edited Loading

Summary

Checklist

cee-chen Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

byronhulcher Sep 17, 2020

Choose a reason for hiding this comment

JasonStoltz Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

cee-chen Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

byronhulcher Sep 17, 2020

Choose a reason for hiding this comment

cee-chen Sep 17, 2020

Choose a reason for hiding this comment

cee-chen Sep 17, 2020

Choose a reason for hiding this comment

scottybollinger left a comment

Choose a reason for hiding this comment

cee-chen Sep 17, 2020

Choose a reason for hiding this comment

cee-chen commented Sep 17, 2020 • edited Loading

cee-chen commented Sep 17, 2020

JasonStoltz left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 17, 2020

💚 Build Succeeded

Build metrics

async chunks size

History

cee-chen commented Sep 17, 2020 •

edited

Loading

cee-chen Sep 17, 2020 •

edited

Loading

JasonStoltz Sep 17, 2020 •

edited

Loading

cee-chen Sep 17, 2020 •

edited

Loading

cee-chen commented Sep 17, 2020 •

edited

Loading