use modals in matamo & origin

libs/remix-ui/app/src/lib/remix-app/actions/modals.ts

@@ -1,6 +1,6 @@
 import { AppModal } from '../interface'
 
-export type ActionMap<M extends { [index: string]: any }> = {
+type ActionMap<M extends { [index: string]: any }> = {
     [Key in keyof M]: M[Key] extends undefined
       ? {
           type: Key;
@@ -11,7 +11,7 @@ export type ActionMap<M extends { [index: string]: any }> = {
         }
 }
 
-export const enum actionTypes {
+export const enum modalActionTypes {
   setModal = 'SET_MODAL',
   setToast = 'SET_TOAST',
   handleHideModal = 'HANDLE_HIDE_MODAL',
@@ -19,10 +19,10 @@ export const enum actionTypes {
 }
 
 type ModalPayload = {
-  [actionTypes.setModal]: AppModal
-  [actionTypes.handleHideModal]: any
-  [actionTypes.setToast]: string
-  [actionTypes.handleToaster]: any
+  [modalActionTypes.setModal]: AppModal
+  [modalActionTypes.handleHideModal]: any
+  [modalActionTypes.setToast]: string
+  [modalActionTypes.handleToaster]: any
 }
 
 export type ModalAction = ActionMap<ModalPayload>[keyof ActionMap<

libs/remix-ui/app/src/lib/remix-app/components/modals/dialogs.tsx

@@ -8,16 +8,6 @@ const AppDialogs = () => {
   const { modal, toast, alert, handleHideModal, handleToaster } = useDialogDispatchers()
   const { focusModal, focusToaster } = useDialogs()
 
-  const ok = (returnedValue) => {
-    console.log('ok', returnedValue)
-  }
-
-  useEffect(() => {
-    modal('test', 'Enter gist url', 'yes', ok, 'cancel', () => { }, ModalTypes.prompt, 'wss://remix.ethereum.org:8545')
-    toast('test toast')
-    // alert('fat error')
-  }, [])
-
   return (
     <>
       <ModalWrapper {...focusModal } handleHide={handleHideModal}></ModalWrapper>

libs/remix-ui/app/src/lib/remix-app/components/modals/matomo.tsx

@@ -1,27 +1,40 @@
 import React, { useContext, useEffect, useState } from 'react'
-import { ModalDialog } from '@remix-ui/modal-dialog'
 import { AppContext } from '../../context/context'
+import { useDialogDispatchers } from '../../context/provider'
 const _paq = window._paq = window._paq || []
 
 const MatomoDialog = (props) => {
   const { settings, showMatamo, appManager } = useContext(AppContext)
+  const { modal } = useDialogDispatchers()
   const [visible, setVisible] = useState<boolean>(props.hide)
+
   useEffect(() => {
-    if (showMatamo) {
-      setVisible(true)
-    } else {
-      setVisible(false)
-    }
+
   }, [])
+
+  const message = () => {
+    return (<><p>An Opt-in version of <a href="https://matomo.org" target="_blank" rel="noreferrer">Matomo</a>, an open source data analytics platform is being used to improve Remix IDE.</p>
+      <p>We realize that our users have sensitive information in their code and that their privacy - your privacy - must be protected.</p>
+      <p>All data collected through Matomo is stored on our own server - no data is ever given to third parties.  Our analytics reports are public: <a href="https://matomo.ethereum.org/index.php?module=MultiSites&action=index&idSite=23&period=day&date=yesterday" target="_blank" rel="noreferrer">take a look</a>.</p>
+      <p>We do not collect nor store any personally identifiable information (PII).</p>
+      <p>For more info, see: <a href="https://medium.com/p/66ef69e14931/" target="_blank" rel="noreferrer">Matomo Analyitcs on Remix iDE</a>.</p>
+      <p>You can change your choice in the Settings panel anytime.</p></>)
+  }
+
+  useEffect(() => {
+    if (visible && showMatamo) {
+      console.log('show matomo')
+      modal('Help us to improve Remix IDE', message(), 'Accept', handleModalOkClick, 'Decline', declineModal)
+    }
+  }, [visible])
+
   const declineModal = async () => {
     settings.updateMatomoAnalyticsChoice(false)
     _paq.push(['optUserOut'])
     appManager.call('walkthrough', 'start')
     setVisible(false)
   }
-  const hideModal = async () => {
-    setVisible(false)
-  }
+
   const handleModalOkClick = async () => {
     _paq.push(['forgetUserOptOut'])
     // @TODO remove next line when https://github.com/matomo-org/matomo/commit/9e10a150585522ca30ecdd275007a882a70c6df5 is used
@@ -30,22 +43,8 @@ const MatomoDialog = (props) => {
     appManager.call('walkthrough', 'start')
     setVisible(false)
   }
-  return (<ModalDialog
-    handleHide={hideModal}
-    id="matomoDialog"
-    hide={!visible}
-    title="Help us to improve Remix IDE"
-    okLabel="Accept"
-    okFn={ handleModalOkClick }
-    cancelLabel="Decline"
-    cancelFn={declineModal}>
-    <p>An Opt-in version of <a href="https://matomo.org" target="_blank" rel="noreferrer">Matomo</a>, an open source data analytics platform is being used to improve Remix IDE.</p>
-    <p>We realize that our users have sensitive information in their code and that their privacy - your privacy - must be protected.</p>
-    <p>All data collected through Matomo is stored on our own server - no data is ever given to third parties.  Our analytics reports are public: <a href="https://matomo.ethereum.org/index.php?module=MultiSites&action=index&idSite=23&period=day&date=yesterday" target="_blank" rel="noreferrer">take a look</a>.</p>
-    <p>We do not collect nor store any personally identifiable information (PII).</p>
-    <p>For more info, see: <a href="https://medium.com/p/66ef69e14931/" target="_blank" rel="noreferrer">Matomo Analyitcs on Remix iDE</a>.</p>
-    <p>You can change your choice in the Settings panel anytime.</p>
-  </ModalDialog>)
+
+  return (<></>)
 }
 
 export default MatomoDialog

libs/remix-ui/app/src/lib/remix-app/components/modals/modal-wrapper.tsx

@@ -45,10 +45,13 @@ const ModalWrapper = (props: ModalWrapperProps) => {
           setState({ ...props })
           break
       }
+    } else {
+      setState({ ...props })
     }
   }, [props])
 
   return (
-    <ModalDialog id='appDialog' {...state} handleHide={props.handleHide} />)
+    <ModalDialog id='appDialog' {...state} handleHide={props.handleHide} />
+  )
 }
 export default ModalWrapper

libs/remix-ui/app/src/lib/remix-app/components/modals/origin-warning.tsx

@@ -1,9 +1,10 @@
 import React, { useEffect, useState } from 'react'
 import { ModalDialog } from '@remix-ui/modal-dialog'
+import { useDialogDispatchers } from '../../context/provider'
 
 const OriginWarning = () => {
-  const [visible, setVisible] = useState<boolean>(true)
-  const [content, setContent] = useState<string>('')
+  const { alert } = useDialogDispatchers()
+  const [content, setContent] = useState<string>(null)
 
   useEffect(() => {
     // check the origin and warn message
@@ -20,24 +21,15 @@ const OriginWarning = () => {
       This instance of Remix you are visiting WILL NOT BE UPDATED.\n
       Please make a backup of your contracts and start using http://remix.ethereum.org`)
     }
-    setVisible(content !== '')
   }, [])
 
-  const closeModal = async () => {
-    setVisible(false)
-  }
-  const handleModalOkClick = async () => {
-    setVisible(false)
-  }
-  return (<ModalDialog
-    handleHide={closeModal}
-    id="appAlert"
-    hide={!visible}
-    title="Alert"
-    okLabel="Ok"
-    okFn={ handleModalOkClick }
-    cancelLabel=""
-    cancelFn={closeModal}>{content}</ModalDialog>)
+  useEffect(() => {
+    if (content) {
+      alert(content)
+    }
+  }, [content])
+
+  return (<></>)
 }
 
 export default OriginWarning

libs/remix-ui/app/src/lib/remix-app/context/provider.tsx

@@ -1,5 +1,5 @@
 import React, { useReducer } from 'react'
-import { actionTypes } from '../actions/modals'
+import { modalActionTypes } from '../actions/modals'
 import { modalReducer } from '../reducer/modals'
 import { ModalInitialState } from '../state/modals'
 import { ModalTypes } from '../types'
@@ -10,7 +10,7 @@ export const ModalProvider = ({ children = [], reducer = modalReducer, initialSt
 
   const modal = (title: string, message: string | JSX.Element, okLabel: string, okFn: (value?:any) => void, cancelLabel?: string, cancelFn?: () => void, modalType?: ModalTypes, defaultValue?: string) => {
     dispatch({
-      type: actionTypes.setModal,
+      type: modalActionTypes.setModal,
       payload: { title, message, okLabel, okFn, cancelLabel, cancelFn, modalType: modalType || ModalTypes.default, defaultValue: defaultValue }
     })
   }
@@ -21,21 +21,21 @@ export const ModalProvider = ({ children = [], reducer = modalReducer, initialSt
 
   const handleHideModal = () => {
     dispatch({
-      type: actionTypes.handleHideModal,
+      type: modalActionTypes.handleHideModal,
       payload: null
     })
   }
 
   const toast = (message: string) => {
     dispatch({
-      type: actionTypes.setToast,
+      type: modalActionTypes.setToast,
       payload: message
     })
   }
 
   const handleToaster = () => {
     dispatch({
-      type: actionTypes.handleToaster,
+      type: modalActionTypes.handleToaster,
       payload: null
     })
   }

libs/remix-ui/app/src/lib/remix-app/reducer/modals.ts

@@ -1,11 +1,11 @@
-import { actionTypes, ModalAction } from '../actions/modals'
+import { modalActionTypes, ModalAction } from '../actions/modals'
 import { ModalInitialState } from '../state/modals'
 import { AppModal, ModalState } from '../interface'
 
 export const modalReducer = (state: ModalState = ModalInitialState, action: ModalAction) => {
   console.log(action)
   switch (action.type) {
-    case actionTypes.setModal: {
+    case modalActionTypes.setModal: {
       console.log('set modal', action, Date.now())
       let modalList:AppModal[] = state.modals
       modalList.push(action.payload)
@@ -28,12 +28,12 @@ export const modalReducer = (state: ModalState = ModalInitialState, action: Moda
       }
       return { ...state, modals: modalList }
     }
-    case actionTypes.handleHideModal:
+    case modalActionTypes.handleHideModal:
       console.log('handle hid', JSON.stringify(state.modals))
       state.focusModal = { ...state.focusModal, hide: true, message: null }
       return { ...state }
 
-    case actionTypes.setToast:
+    case modalActionTypes.setToast:
       state.toasters.push(action.payload)
       if (state.toasters.length > 0) {
         const focus = state.toasters[0]
@@ -42,7 +42,7 @@ export const modalReducer = (state: ModalState = ModalInitialState, action: Moda
       }
       return { ...state }
 
-    case actionTypes.handleToaster:
+    case modalActionTypes.handleToaster:
       return { ...state, focusToaster: '' }
   }
 }