4.12.0 Release checklist

[compulim]

Checklist

Build

1. Bump MockBot to Bot Framework SDK release 4.12.0
   • https://www.npmjs.com/package/botbuilder/v/4.12.0
   • (We will not bump for patch release)
2. Bump botframework-directlinejs to 0.14.1
   • No newer version
3. Bump to 4.12.0
   • Update CHANGELOG.md to mark specific changes in 4.12.0
   • Run npm version --no-git-tag-version 4.12.0
   • Merged into master, the PR number is Bump version number to 4.12.0 #3739
   • Commit is 63bb97a
   • Do not merge any other unrelated changes after this PR. Any other PR merged, will need to be re-tested
4. Run daily pipeline manually, set "generate release version number" to true
   • (This will not push to NPM or CDN)
   • Pipeline name is BotFramework-WebChat-daily
   • The build number is 218799 and commit is 63bb97a

Test

The test should run against the build artifacts from Azure Pipelines.

1. Manual testing on major browsers using webchat-release-testing
   • Before starting testing, update all the browser version to latest
   • Chrome 88.0.4324.190
   • Edge 88.0.705.81
   • Firefox 86.0
   • IE11 (Windows 10 21322.1000)
   • macOS Safari 13.1.3 (15609.4.1)
     • DLSpeech: Web Socket connection to westus2.convai.speech.microsoft.com closed instantly after connected, it also repro on previous versions of Web Chat (failed on 4.9.0, 4.8.1)
       • WebSocket connection immediately closed on macOS cognitive-services-speech-sdk-js#221
   • iOS Safari 14.4
   • Android Chrome 88.0.4324.181
2. Test specific fixes related to 4.12.0 and previous releases
   • Auto scroll snapping
   • Multi-line send box
   • Suggested actions flow layout
   • Suggested actions with multiple lines

Release

1. Verify on WebChat-release-testing
2. Make sure you are on master or qfe branch, run git status to check
3. git pull
4. Verify /package.json, /package-lock.json, and CHANGELOG.md has a version of 4.12.0
5. git log
   • Verify the latest commit is 63bb97a
6. git tag v4.12.0
7. git push -u upstream v4.12.0
   • You do not need to kick off a build again, use the previous build
8. Create a new GitHub release, copy entries from CHANGELOG.md
   • Subresource Integrity can be generated by
     • From CDN: curl -H 'Accept-Encoding: gzip' https://cdn.botframework.com/botframework-webchat/4.12.0/webchat.js | gunzip - | openssl dgst -sha384 -binary | openssl base64 -A
     • From local: cat webchat.js | openssl dgst -sha384 -binary | openssl base64 -A
   • Attach assets including 3 JS files, stats.json and 5 tarballs
     • You can copy the artifacts from webchat-release-testing/drops
     • Tarballs download from npmjs

       curl -L -o botframework-directlinespeech-sdk-4.12.0.tgz https://registry.npmjs.org/botframework-directlinespeech-sdk/-/botframework-directlinespeech-sdk-4.12.0.tgz
       curl -L -o botframework-webchat-4.12.0.tgz https://registry.npmjs.org/botframework-webchat/-/botframework-webchat-4.12.0.tgz
       curl -L -o botframework-webchat-core-4.12.0.tgz https://registry.npmjs.org/botframework-webchat-core/-/botframework-webchat-core-4.12.0.tgz
       curl -L -o botframework-webchat-api-4.12.0.tgz https://registry.npmjs.org/botframework-webchat-api/-/botframework-webchat-api-4.12.0.tgz
       curl -L -o botframework-webchat-component-4.12.0.tgz https://registry.npmjs.org/botframework-webchat-component/-/botframework-webchat-component-4.12.0.tgz
       

9. Kick off release to NPM
   • Release name is [[PROD]]Push-WebChat-to-npmjs
   • The build number is 218799 release number is 29 and commit is 63bb97a
   • Retain the build indefinitely
10. Kick off release to CDN (CDN CUTOFF TIME IS 2PM PST)
    1. Prepare the email for approval
    • Release name is [[PROD]]Push-WebChat-to-Prod-CDN-with-approval
    • The build number is 218799, release number is 34 and commit is 63bb97a
    • Script build number is 131156 (this is fixed)
    1. Send reminder email to approvers
    • Retain the build indefinitely

Post-release check

• Test using webchat-release-testing
  1. Clone https://github.com/corinagum/WebChat-release-testing/
  2. 01.create-react-app
     1. Nuke 01.create-react-app/node_modules
     2. npm install
     3. npm install botframework-webchat@4.12.0 (just install the bundle package)
     4. npm run build
  3. Others
     • Using script tags from https://github.com/microsoft/BotFramework-WebChat/releases/tag/v4.12.0, with subresource integrity

       <script
          crossorigin="anonymous"
          integrity="sha384-"
          src="https://cdn.botframework.com/botframework-webchat/latest/webchat-es5.js"
       ></script>
       

  4. npx serve (at repo root)
  5. Go to http://localhost:5000/ to test, including IE11

Notification to interested parties

• Update partner page on Adaptive Cards doc
  • https://docs.microsoft.com/en-us/adaptive-cards/resources/partners
  • PR at Update Web Chat to 4.12.0 with Adaptive Cards 2.5.0 MicrosoftDocs/AdaptiveCards#370
• Notify related parties for the following fixes
  • SDK team
  • Omnichannel
  • Pooja
• Update root README.md with feature notes
• Update R12 Release Checklist botframework-sdk#6200

Changelog

[4.12.0] - 2021-02-18

Added

• Resolves #2745. Added new flow layout to suggested actions, by @compulim in PR #3641 and PR #3748
• Added new style options to customize auto-scroll, by @compulim in PR #3653
  • Set autoScrollSnapOnActivity to true to pause auto-scroll after more than one activity is shown, or a number to pause after X number of activities
  • Set autoScrollSnapOnPage to true to pause auto-scroll when a page is filled, or a number between 0 and 1 to pause after % of page is filled
  • Set autoScrollSnapOnActivityOffset and autoScrollSnapOnPageOffset to a number (in pixels) to overscroll/underscroll after the pause
• Supports multiple transcripts in a single composition, by @compulim in PR #3653
• Resolves #3368. Added new sendBoxButtonAlignment for button alignment in multi-line text mode, by @compulim in PR #3668
• Resolves #3666. Added support of sovereign clouds when using Direct Line Speech, by @compulim in PR #3694
  • Please refer to DIRECT_LINE_SPEECH.md for instructions
• Resolves #2996. Added transcript navigation by keyboard navigation keys, by @compulim in PR #3703
• Resolves #3544. Send user ID from props to chat adapter, by @timenick in PR [Pass userID prop to chat adapter setUserId() #3544)(https://github.com/Pass userID prop to chat adapter setUserId() #3544).
• Resolves #3562. Add button word wrap to suggested actions stacked layout, by @corinagum, in PR #3728 and #3745
• Resolves #3658. Added new containerRole to default style options, by @nfreear in PR #3669
• Resolves #3754. Added new useObserveTranscriptFocus hook, by @compulim in PR #3755
• Translation for Yue, by @compulim in PR #3749

Fixed

• Fixes #3278. Update HOOKS.md verbiage, by @corinagum in PR #3564
• Fixes #3534. Remove 2020 deprecations, by @corinagum in PR #3564 and #3728
• Fixes #3561. Remove MyGet mentions from samples, by @corinagum in PR #3564
• Fixes #3537. Fix some carousels improperly using aria-roledescription, by @corinagum in PR #3599
• Fixes #3483. IE11 anchors fixed to open securely without 'noreferrer' or 'noopener', by @corinagum in PR #3607
• Fixes #3565. Allow strikethrough <s> on sanitize markdown, by @corinagum in PR #3646
• Fixes #3672. Center the icon of send box buttons vertically and horizontally, by @compulim in PR #3673
• Fixes #3683. Activities should be acknowledged when user scrolls to bottom, by @compulim in PR #3684
• Fixes #3431. Race condition between the first bot activity and first user activity should not cause the first bot activity to be delayed, by @compulim in PR #3705
• Fixes #3676. Activities without text should not generate bogus aria-labelledby, by @compulim in PR #3697
• Fixes #3625. Update 'no screen reader for custom activity middleware' warning and add screen reader renderer documentation to ACCESSIBILITY.md, by @corinagum in PR #3689
• Fixes #3453. Fixes plain text file attachments to show download link when uploaded, by @corinagum in PR #3711
• Fixes #3612. Carousel flippers in suggested actions are given extra padding, by @compulim and @Quirinevwm in PR #3704
• Fixes #3411. With Direct Line Speech, clicking on microphone button during speech recognition should no longer stop working, by @compulim in PR #3694
  • Although it no locker lock up microphone, clicking on the microphone button has no effect because Direct Line Speech does not support aborting speech recognition
• Fixes #3421. With Direct Line Speech, after not able to recognize any speech, it should no longer stop working, by @compulim in PR #3694
• Fixes #3616. [Accessibility documentation] Update activity timestamp grouping to match visual UI, by @amal-khalaf in PR #3708
• Fixes #3718. Fixed webpack.config.js to use default settings of ['browser', 'module', 'main'] and resolved issues with uuid package in IE11, by @compulim in PR #3726
• Fixes #3622. Apply pushed button style options and aria-pressed on Adaptive Cards selected buttons, by @amal-khalaf in PR #3710
• Fixes #3618. Fix Adaptive Cards anchors being disabled when Adaptive Cards is obsolete, by @corinagum in PR #3687
• Fixes #3747. aria-pressed and aria-role is not properly set on Adaptive Cards submit buttons, by @amal-khalaf in PR #3744
• Fixes #3750. Debump Node.js engines requirements for some packages to 12.0.0, by @compulim in PR #3753
• Fixes #3760. Use <ErrorBoundary> to wrap around attachment renderer, by @compulim in PR #3761
• Fixes #3764. Added role="group" to the focusable transcript to enable aria-activedescendant, by @compulim in PR #3765

Changed

• Bumped all dependencies to the latest versions, by @compulim in PR #3594, PR #3694, and PR #3544
  • Development dependencies
    • @babel/cli@7.12.1
    • @babel/core@7.12.3
    • @babel/plugin-proposal-class-properties@7.12.1
    • @babel/plugin-proposal-object-rest-spread@7.12.1
    • @babel/plugin-transform-runtime@7.12.1
    • @babel/preset-env@7.12.1
    • @babel/preset-react@7.12.5
    • @babel/preset-typescript@7.12.1
    • @babel/runtime@7.12.5
    • @types/node@14.14.6
    • @types/react@16.9.55
    • @typescript-eslint/eslint-plugin@4.6.1
    • @typescript-eslint/parser@4.6.1
    • babel-jest@26.6.3
    • eslint-plugin-prettier@3.1.4
    • eslint-plugin-react-hooks@4.2.0
    • eslint-plugin-react@7.21.5
    • eslint@7.12.1
    • husky@4.3.0
    • jest-image-snapshot@4.2.0
    • jest-junit@12.0.0
    • jest-trx-results-processor@2.2.0
    • jest@26.6.3
    • lint-staged@10.5.1
    • lolex@6.0.0
    • node-dev@6.2.0
    • node-fetch@2.6.1
    • prettier@2.1.2
    • source-map-loader@1.1.2
    • terser-webpack-plugin@4.2.3
    • typescript@4.0.5
    • webpack-cli@4.2.0
    • webpack-stats-plugin@1.0.2
    • webpack@4.44.2
  • Production dependencies
    • @babel/runtime@7.12.5
    • botframework-directlinejs@0.14.1
    • globalize@1.6.0
    • markdown-it@12.0.2
    • microsoft-cognitiveservices-speech-sdk@1.15.1
    • react-redux@7.2.2
    • redux@4.0.5
    • sanitize-html@2.1.2
    • web-speech-cognitive-services@7.1.0
    • whatwg-fetch@3.4.1
• Resolves #3392 Bumped Adaptive Cards to the 2.5.0, by @corinagum in PR #3630

Samples

• Fixes #3473. Fix samples using activityMiddleware (from 4.10.0 breaking changes), by @corinagum in PR #3601
• Fixes #3582. Fix Disable Adaptive Cards sample, by @corinagum in PR #3687
• Fixes #3434. Dispatched event, postBack, or messageBack + activityMiddleware causes fatal error, by @amal-khalaf in PR #3671
• Fixes #3215. Fix SSO samples window.opener.postMessage, by @corinagum in PR #3696

[compulim]

Done.