fix(almin): fix trouble emit StoreChangedPayload

azu · azu · commit 6aaaec959580 · 2018-01-27T23:31:45.000+09:00
In some case, LifeCycleEventHub#onDispatch receive StoreChangedPayload #328 This fixes that `StoreChangedPayload` always be `isTrust: true` payload. `LifeCycleEventHub#onDispatch` ignore trusted Payload. As a result, LifeCycleEventHub#onDispatch have not received StoreChangedPayload. fix #328
diff --git a/packages/almin/src/Context.ts b/packages/almin/src/Context.ts
@@ -158,25 +158,26 @@ export class Context<T> {
         if (this.config.strict) {
             this.storeGroup.useStrict();
         }
+        // If some stores are changed, emit StoreChangedPayload
         // Store -> StoreGroup -> LifeCycleEventHub
         const storeGroupOnChangeToStoreChangedPayload = (
             stores: Array<StoreLike<any>>,
             details?: StoreGroupReasonForChange
         ) => {
             stores.forEach(store => {
                 const payload = new StoreChangedPayload(store);
-                // FIXME: store#emitChange -> isTruest:false event
                 // Should not included in StoreChanged Event
-                const meta = details
-                    ? details.meta
-                    : new DispatcherPayloadMetaImpl({
-                          useCase: undefined,
-                          dispatcher: this.dispatcher,
-                          parentUseCase: null,
-                          isTrusted: true,
-                          isUseCaseFinished: false,
-                          transaction: undefined
-                      });
+                // inherit some context from the reason of change details
+                const transaction = details && details.meta && details.meta.transaction;
+                const isUseCaseFinished = details && details.meta && details.meta.isUseCaseFinished;
+                const meta = new DispatcherPayloadMetaImpl({
+                    useCase: undefined,
+                    dispatcher: this.dispatcher,
+                    parentUseCase: null,
+                    isTrusted: true, // <= StoreChangedPayload is always trusted
+                    isUseCaseFinished: isUseCaseFinished,
+                    transaction: transaction
+                });
                 this.dispatcher.dispatch(payload, meta);
             });
         };
diff --git a/packages/almin/src/UILayer/StoreGroup.ts b/packages/almin/src/UILayer/StoreGroup.ts
@@ -466,18 +466,13 @@ But, ${store.name}#getState() was called.`
     /**
      * Observe changes of the store group.
      *
-     * `details` is the reason of changing stores.
-     * If `details` it not found, the reason by system.
-     *
-     * For example, the user can change store using `Store#emitChange` manually.
+     * For example, the user can change store using `Store#setState` manually.
      * In this case, the `details` is defined and report.
      *
-     * Contrast, almin try to update store in a lifecycle.
+     * Contrast, almin try to update store in a lifecycle(didUseCase, completeUseCase etc...).
      * In this case, the `details` is not defined and report.
      *
-     * TODO(azu): we should always define `details`
-     *
-     * onChange workflow: https://code2flow.com/mHFviS
+     * StoreGroup#onChange workflow: https://code2flow.com/mHFviS
      */
     onChange(handler: (stores: Array<Store<T>>, details?: StoreGroupReasonForChange) => void): () => void {
         this.on(CHANGE_STORE_GROUP, handler);
