@cdmbase/wiki-browser 12.0.18-alpha.5

package/lib/templates/content/docs/devops/app-deploy-new-version.md

@@ -0,0 +1,30 @@
+---
+meta:
+    title: Procedure to deploy
+    description: Procedure to deploy
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Procedure to deploy...
+headers:
+    Cache-Control: no-cache
+---
+
+## Procedure to deploy new version of application
+
+## Below is the procedure to spin up a new development env in new namespace
+
+Lets take an example of `admin-layout` project. Assuming `v9` version is already deployed in `admin-layout-v1` namespace. Now task is to deploy new env with version `v9.1` in `example-namespace` namespace.
+
+1. Create new version setup in the Git repository of the targeted project.
+   Run the versioning script to change the version of the project by following `update versionon the project link`
+
+2. Deploy new env with Jenkins job.
+
+    Ensure that the `PUBLISH_BRANCH`, `REPOSITORY_BRANCH`, `DEVELOP_BRANCH`, and `VERSION` parameters in the Jenkins job are updated to match the new version (example v9.1) as specified in the updated Jenkinsfile.
+
+- Set `version of the deployment` to `v9-1`
+- Set `the branch of repository` to `develop9-1`
+- Set `the public branch` to `develop9-1`
+- Set `develop branch` to `develop9-1`
+
+Note: The version number should be different. Otherwise, it will override the existing setup.

package/lib/templates/content/docs/devops/index.md

@@ -0,0 +1,14 @@
+---
+meta:
+    title: DevOps
+    description: DevOps
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: DevOps...
+headers:
+    Cache-Control: no-cache
+---
+
+## Devops
+
+**[Spin a Clone Deployment](/docs/devops/app-deploy-new-version)**

package/lib/templates/content/docs/devops/mobile-jenkins-build.md

@@ -0,0 +1,40 @@
+---
+meta:
+    title: Mobile Jenkins Build
+    description: Mobile Jenkins Build
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Mobile Jenkins Build...
+headers:
+    Cache-Control: no-cache
+---
+
+1. Select the pipeline to run.
+
+eg: here we using `messenger-box`
+
+<img width="1256" alt="image" src="https://user-images.githubusercontent.com/3382355/236802390-26806466-d7e6-4774-95dc-9248daefebe6.png"/>
+
+2. Click on `Build with Parameters`
+
+<img width="1370" alt="image" src="https://user-images.githubusercontent.com/3382355/236802500-caadae9f-bf5a-48f0-9582-4107652204a5.png"/>
+
+3. Update
+
+a) `REPOSIOTRY_BRANCH` fill with the the branch you want to test.
+
+b) Update ENV_CHOICE. Following are mobile build options available to select.
+
+- `mobileProdSubmit` : Will build prod app and submits to app store
+- `mobileProd`: Will build prod app but won't submit
+- `mobileBuild`: Will build and generate a tar file to use locally
+- `mobilePreview`: Will use dev environment, to build for preview
+- `mobileLocalPreview`: Will use dev enviornment to build a local preview.
+
+c) MOBILE_CHOICE
+
+- `ios`: builds for ios only
+- `android`: builds for android only
+- `all`: builds both ios and android
+
+<img width="661" alt="image" src="https://user-images.githubusercontent.com/3382355/236803202-2c635b7e-eb49-4a63-91d2-cfa2ad187286.png"/>

package/lib/templates/content/docs/devops/versioning-the-project.md

@@ -0,0 +1,128 @@
+---
+meta:
+    title: Versioning the Project
+    description: Versioning the Project
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Versioning the Project...
+headers:
+    Cache-Control: no-cache
+---
+
+# Versioning the Project
+
+## How to Change the Version of the Project
+
+To update the project version, run the following command. This process will update the necessary files, including `Jenkinsfile`, `lerna.json`, `eas.json` and `values-dev.yaml`, based on the provided version. For instance, to change from `v9` to `v9.1`:
+
+### Run
+
+```bash
+cd tools
+node deployVersionUpdate.js v9.1
+git checkout -b develop9-1
+git add .
+git commit -m 'prep for version 9.1'
+```
+
+1. **Jenkinsfile**  
+   The Jenkinsfile will be updated with the new version in branch names and variables.
+
+    Example:
+
+```diff
+@@ -13,17 +13,17 @@ pipeline {
+-    string(name: 'VERSION', defaultValue: 'v9', description: 'version of the deployment', trim: true)
++    string(name: 'VERSION', defaultValue: 'v9-1', description: 'version of the deployment', trim: true)
+     string(name: 'HEMERA_LOG_LEVEL', defaultValue: 'info', description: 'log level for hemera')
+     string(name: 'LOG_LEVEL', defaultValue: 'info', description: 'log level')
+     string(name: 'DEPLOYMENT_PATH', defaultValue: '/servers', description: 'folder path to load helm charts')
+-    string(name: 'PUBLISH_BRANCH', defaultValue: 'devpublish', description: 'the publish branch for packages release')
++    string(name: 'PUBLISH_BRANCH', defaultValue: 'devpublish9-1', description: 'the publish branch for packages release')
+....
+-    string(name: 'REPOSITORY_BRANCH', defaultValue: 'develop', description: 'the branch with changes')
+-    string(name: 'DEVELOP_BRANCH', defaultValue: 'develop', description: 'the branch for the development')
++    string(name: 'REPOSITORY_BRANCH', defaultValue: 'develop9-1', description: 'the branch with changes')
++    string(name: 'DEVELOP_BRANCH', defaultValue: 'develop9-1', description: 'the branch for the development')
+     string(name: 'MASTER_BRANCH', defaultValue: 'master', description: 'Master branch as default branch for production.')
+```
+
+2. **lerna.json**  
+   `lerna.json` will be updated with the new version and appropriate branch names under `allowBranch`.
+
+    Example:
+
+```diff
+@@ -17,7 +17,8 @@
+                 "devpublish7",
+                 "devpublish8",
+                 "devpublish9",
+-                "devpublish9"
++                "devpublish9",
++                "devpublish9-1"
+             ],
+             "message": "chore(release): publish",
+             "ignoreChanges": ["**/__fixtures__/**", "**/__tests__/**", "**/*.md", "**/example/**"]
+@@ -38,7 +39,9 @@
+                 "devpublish8",
+                 "devpublish9",
+                 "devpublish9",
+-                "develop9"
++                "develop9",
++                "devpublish9-1",
++                "develop9-1"
+             ],
+             "private": true,
+             "conventionalCommits": true,
+@@ -48,5 +51,5 @@
+     "npmClient": "yarn",
+     "useNx": true,
+     "packages": ["packages-modules/**", "packages/**", "servers/*", "portable-devices/*"],
+-    "version": "9.0.3"
++    "version": "9.1.0"
+ }
+```
+
+1. **portable-devices/mobile/eas.json**
+   This file will update the `GRAPHQL_URL` and/or `CLIENT_URL` fields.
+
+    Example:
+
+```diff
+-    \"GRAPHQL_URL\": \"https://ideback.example-namespace-v1.cdebase.io/graphql\",
++    \"GRAPHQL_URL\": \"https://idefront.example-namespace-v9-1.cdebase.io/graphql\",
+```
+
+3. **values-dev.yaml**  
+   This file will update the `VERSION`, `CONNECTION_ID`, and `CLIENT_URL` fields.
+
+    Example:
+
+```diff
+frontend:
+  env:
+    AUTH0_TOKEN_GRANTED_TIME: "2592000000"
+-   CLIENT_URL: "https://idefront.example-namespace-v9.cdebase.dev"
++   CLIENT_URL: "https://idefront.example-namespace-v9-1.cdebase.dev"
+    STRIPE_PUBLISHABLE_KEY: ""
+...
+env:
+  GA_ID: "GXXXXXX"
+- CONNECTION_ID: v9
++ CONNECTION_ID: v9.1
+  CONFIG_PATH: "/tmp"
+ ....
+- CLIENT_URL: "https://idefront.example-namespace-v9.cdebase.dev"
+- VERSION: v9
++ CLIENT_URL: "https://idefront.example-namespace-v9-1.cdebase.dev"
++ VERSION: v9-1
+external:
+```
+
+### Scripts
+
+The versioning command `deployVersionUpdate.js` sequentially calls these scripts:
+
+- **updateJenkinsfileVersion.js**: Updates `Jenkinsfile` with the new version in branches and environment variables【14†source】.
+- **updateLernaVersion.js**: Adjusts `lerna.json` to reflect the new version and branch configurations【15†source】.
+- **updateYamlSettings.js**: Updates `values-dev.yaml` by modifying fields like `VERSION`, `CONNECTION_ID`, and `CLIENT_URL`【16†source】.

package/lib/templates/content/docs/error-handler/application-error-handler.md

@@ -0,0 +1,40 @@
+---
+meta:
+    title: Application Error Handler
+    description: Application Error Handler
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Application Error Handler...
+headers:
+    Cache-Control: no-cache
+---
+
+# Application Error Handler
+
+It is a wrapper component that wraps around the main component or routes to handle all the application related errors. Along with Application errors it also take care of backend error and renders the fallback component via slot fill.
+
+# Usage
+
+For web applications we can simply import it from `'@admin-layout/ant-ui'` and use it like below
+
+    <ApplicationErrorHandler  plugins={plugins}>
+       <ThemeProvider  theme={theme}>{routes}</ThemeProvider>
+    </<ApplicationErrorHandler>
+
+In mobile applications you don't need to wrap it around routes instead you can render it along with the routes and make sure to render it inside `NavigationContainer` otherwise it will throw an error while navigating to any screen.
+
+    <NavigationContainerComponent  configurableRoutes=
+        {routes}
+        <PluginArea  />
+        <ApplicationErrorHandler  plugins={plugins}  />
+    </NavigationContainerComponent>
+
+# Working
+
+Application Error handler checks redux state for any application related errors and then it checks all the registered plugins to find if any specific slot/fill is registered against the error, if yes then it renders that slot else it will ignore the error.
+
+We have a common component in admin-layout/client which takes three props `FallbackComponent` which will be rendered incase of backend error, `Slot` if provided it will render that specific slot ( previously needed for mobile since we use it from different package ) and the third parameter is `RendererComponent` which will control the rendering inside ApplicationErrorHandler. Right now `RendererComponent` is required for mobile application use case only as for mobile we don't wrap it around `routes` so it will render that screen on top of existing screens
+
+![Usage](/assets/images/aeh-usage.png)
+
+![Implementation](/assets/images/aeh-implementation.png)

package/lib/templates/content/docs/error-handler/error-handling.md

@@ -0,0 +1,26 @@
+---
+meta:
+    title: Error Handling
+    description: Error Handling
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Error Handling...
+headers:
+    Cache-Control: no-cache
+---
+
+## Error Handling
+
+We have two types of errors, Graphql Errors and Network errors. Errors like server not responding or errors produced in middleware are all network errors whereas errors produced due to invalid query syntax etc are graphql errors. To read more about these two types follow this [link](https://www.apollographql.com/docs/react/data/error-handling/)
+
+### Error Link:
+
+We are using multiple Apollo links to facilitate the modification of data between Apollo Client and Backend Server. Among these links one is ErrorLink that handles the error and modifies the result before it reaches to the frontend and this is how the Implementations of Error Link look like
+
+![error-link](/assets/images/error-link.png)
+
+Once we receive the error, we get the actionName from error extension and dispatches the redux action on basis of actionName. We construct the redux action type using actionName and set the payload as the error itself. This is what our Error looks like.
+
+![error-link](/assets/images/error-sample.png)
+
+This is how we construct error. We set the actionName as the type of action that we want to dispatch to redux store and payload is the action payload.

package/lib/templates/content/docs/error-handler/index.md

@@ -0,0 +1,16 @@
+---
+meta:
+    title: Error Handler
+    description: Error Handler
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Error Handler...
+headers:
+    Cache-Control: no-cache
+---
+
+## Error Handler
+
+**[Application Error Handler](/docs/error-handler/application-error-handler)**
+
+**[Error Handling](/docs/error-handler/error-handling)**

package/lib/templates/content/docs/error-handler/logging-errors.md

@@ -0,0 +1,14 @@
+---
+meta:
+    title: Logins Errors
+    description: Logins Errors
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Logins Errors...
+headers:
+    Cache-Control: no-cache
+---
+
+Below are few example to do it in right way
+
+<img width="1930" alt="image" src="https://github.com/cdmbase/cdebase-wiki/assets/3382355/88eab7c7-90fc-41ef-b33c-3092c9023827" />