Decouple botframework-directlinejs #4644
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog Entry
Added
botframework-directlinejs
from business logic of Web Chat for better tree-shaking, by @compulim, in PR #4644Description
Outside of
createDirectLine
, Web Chat should decouple itself frombotframework-directlinejs
.We found that the only coupling is at
connectSaga.js
, which it imported implementation code frombf-dljs
. For other places, it is importing only the types.After this is done, we saw a 11.5% decrease in bundle size, if only our root UI component is imported.
Design
Web Chat generally decouple itself from
bf-dljs
. Only typing (non-runtime code) and explicit-import (import { createDirectLine } from 'bf-wc'
) is coupled tobf-dljs
.Once this is done, when importing our root UI component, we saw a sharp decrease of app bundle size:
However, note should be taken.
ReactWebChat
is NOT expected to be imported viabf-wc/lib/ReactWebChat
. Web Chat should carefully design its named exports for this to fully work. And named exports could means breaking changes for web devs who use NPM version of Web Chat.Specific Changes
connectSaga.js
and bring DLJSConnectionStatus
inconnectSaga
I have added tests and executed them locallyCHANGELOG.md
I have updated documentationReview Checklist
Accessibility reviewed (tab order, content readability, alt text, color contrast)Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index
)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.json
andpackage-lock.json
reviewedSecurity reviewed (no data URIs, check for nonce leak)Tests reviewed (coverage, legitimacy)