@planningcenter/topbar 8.2.0-rc.0 → 8.2.0-rc.3

package/CHANGELOG.md

@@ -5,13 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [8.1.1] - 2021-04-11
+## [8.2.0] - 2021-05-11
+
+### Added
+
+- Make whether Jolt sends its logs to console configurable (`enableJoltLogging` prop) and default to `false`
+
+### Changed
+
+- Add more info regarding troubleshooting `yalc` issues to the README
+- Send a `fetchAuthTokenFn` to `jolt-client` instead of `authToken`. Over time, the auth token can get stale. Sending a function instead of a value allows the client to refresh itself when required.
+- Instead of fetching the WSS URLs for authorization from an api endpoint, hard-code them instead. After the change adding `fetchAuthTokenFn`, this change reduces required API calls by 1.
+
+### Fixed
+
+- fix: hook into `pco-page-expired` to `disconnect` jolt instance when session is changed
+
+## [8.1.1] - 2022-04-11
 
 ### Changed
 
 - fix: don't send a `timeZone` key to `@churchcenter/datetime-fmt` if it doesn't have a value
 
-## [8.1.0] - 2021-04-11
+## [8.1.0] - 2022-04-11
 
 ### Changed
 
@@ -22,14 +38,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix dark mode text styles in notifications inbox
 - Fix notification date timezone not displaying in the org's time zone
 
-## [8.0.1] - 2021-03-29
+## [8.0.1] - 2022-03-29
 
 ### Changed
 
 - Correct the capitalization of "Check-Ins" in order to set the correct color for notifications
 - Bring back the `notifications` prop for topbars so that if notifications are not enabled, it will render the `notifications` prop instead
 
-## [8.0.0] - 2021-03-24
+## [8.0.0] - 2022-03-24
 
 ### Added
 

package/README.md

@@ -34,6 +34,11 @@ If a Jolt connection is not shared with topbar, it will gladly initiate its own
 To reuse your app's Jolt connection, topbar requires a Promise that resolves into a [Jolt client](https://github.com/ministrycentered/jolt-client/) connection.
 If nothing is passed—or if a Promise is passed that resolves to `undefined` or `void`—topbar will initiate its own connection.
 
+Topbar hooks into `pco-page-expired` and will `disconnect` when the session is invalidated (i.e. logged out in a different tab).
+This occurs for `topbar`-created jolt instances as well as jolt instances provided to `topbar` via the `joltPromise` prop.
+CSRF tokens are invalidated when the session is invalidated. 
+Non-GET APIv2 requests (i.e. auth/subscribe) require a valid CSRF token and will never succeed in that state.
+
 #### Example
 
 As an example, we'll use what Services has done for the v7.3 alpha.
@@ -52,14 +57,12 @@ As a layout partial, they attach two Jolt-related things to `window`:
 In their Topbar implementation component, they then create the function that provides topbar the required Promise...
 
 ```jsx
-const waitForWindowJolt = async () => {
-  const listener = Promise.resolve(window.joltListenerPromise)
-  return listener.then((listener) => {
+const waitForWindowJolt = async () =>
+  window.joltListenerPromise.then(listener => {
     if (listener && listener.jolt) {
       return listener.jolt
     }
   })
-}
 ```
 
 ...and passes that function in for the `JoltPromise` prop to topbar.
@@ -98,6 +101,19 @@ When you make `topbar` changes, run `yalc publish --push` to update your product
 
 When you're done, in your product directory run `yalc remove @planningcenter/topbar`.
 
+If you are not seeing published updates after running `yalc publish --push` or things break in your app after running `yalc remove @planningcenter/topbar` then in your product you will want to be running `bin/webpack-dev-server`.
+From experience, we have seen that the People app will automatically reload while running `bin/webpack-dev-server`.
+Unfortunately, in the Services app we have had to restart `bin/webpack-dev-server` every time for a change to come in.
+This may change depending on what app you're adding your yalc changes to.
+
+### Debugging Jolt
+
+The `jolt-client` library has the ability to log debug information to the console.
+This functionality is configured when creating a client and is disabled by default.
+If you are passing your own Jolt client object into Topbar via props, you can configure it as required before providing it to Topbar.
+If you are relying on Topbar to create its own Jolt connection and would like to enable logging, pass `enableJoltLogging={true}` as a prop to whichever topbar
+you are using (`SmallTopbar`/`NotSmallTopbar`).
+
 ## Migrate
 
 These migration docs will guide you thru the process of updating to recent major releases.