@newfold/huapi-js 2.0.0-alpha.1 → 2.1.0-beta.1

package/.babelrc

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    [
+      "@nrwl/web/babel",
+      {
+        "useBuiltIns": "usage"
+      }
+    ]
+  ]
+}

package/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

package/Jenkinsfile

@@ -0,0 +1,205 @@
+name = "lib-js-nd-mfe-tools"
+dir = "libs/huapi-js"
+
+server = "https://api.provo1.endurancemb.com:6443"
+
+test_output_file = "/tmp/result"
+exec_bin = "/bin/sh"
+
+actions = [
+    build: true,
+    test: false, // Skip for now, as there is no real testing happening
+    test_prod: false,
+    test_catalog: false,
+    deploy: true,
+    deploy_script: true
+]
+
+init = [:]
+init2 = [:]
+fin = [:]
+fin2 = [:]
+
+branch_type = ''
+
+ns_prod = "${name}-prod"
+ns_beta = "${name}-beta"
+
+if (env.BRANCH_NAME == 'main') {
+    init = [ ns: "${name}-prod", name: "test-staging" ]
+    init2 = [ ns: "${name}-prod", name: "test-prod" ]
+    fin = [ ns: "${name}-prod", name: "prod" ]
+    fin2 = [ ns: "${name}-prod", name: "staging" ]
+
+    branch_type = 'main'
+}
+else if (env.BRANCH_NAME == 'beta') {
+    init = [ ns: "${name}-beta", name: "beta" ]
+
+    // needed for credential name
+    fin = [ ns: "${name}-beta", name: "beta" ]
+    branch_type = 'beta'
+}
+else if (env.BRANCH_NAME == 'huapi-js-version2') {
+    init = [ ns: "${name}-alpha", name: branch_name ]
+    fin = [ ns: "${name}-alpha", name: branch_name ]
+
+    branch_type = 'major-prerelease'
+}
+
+def kubectl(namespace, cmd) {
+    token_name = "\$token_${namespace.replace('-', '_')}"
+    sh "kubectl --token $token_name --server $server -n $namespace $cmd"
+}
+
+def oc(namespace, cmd) {
+    token_name = "\$token_${namespace.replace('-', '_')}"
+    sh "oc --token $token_name --server $server -n $namespace $cmd"
+}
+
+def exec(namespace, deploy_name, cmd, bin="/bin/bash", action) {
+    pod_result_file = "/tmp/${action}-result"
+    pod_done_file = "/tmp/${action}-done"
+    token_name = "\$token_${namespace.replace('-', '_')}"
+
+    param_script = ""
+    for (item in params) {
+        param_script += "export ${item.key}=${item.value}; "
+    }
+
+    sh """
+        pod=\$(oc --token $token_name --server $server --namespace ${namespace} get pods -l'app.kubernetes.io/name=${deploy_name}' --sort-by ".metadata.creationTimestamp" | awk '{ print \$1 }' | tail -n1)
+        echo "Found pod for ${action}ing: \$pod"
+
+        kubectl --token $token_name --server $server --namespace ${namespace} exec pod/\$pod -- sh -c 'echo \"Executing ${action} step on \$HOSTNAME / \$OPENSHIFT_BUILD_NAME\"; $param_script ${bin} ${cmd}; echo \$? > ${pod_done_file}; echo DONE_${action.toUpperCase()}ING'
+
+        result=\$(for i in \$(seq 1000);
+            do
+            done=\$(kubectl --token $token_name --server $server exec --namespace ${namespace} pod/\$pod -- sh -c "(test -f ${pod_done_file} && echo 1) || true") || true;
+            if [[ "\$done" == "1" ]]
+                then
+                    kubectl --token $token_name --server $server exec --namespace ${namespace} pod/\$pod -- cat ${pod_result_file}"";
+                    break;
+                else
+                    sleep 10; test \$k_verbose == "1" && echo "waiting for pod: \$result";
+            fi;
+            done)
+
+        echo "DONE!"
+
+        echo \$result > cmd_output
+
+        echo "Checking exit status"
+        exit_status=\$( kubectl --token $token_name --server $server exec --namespace ${namespace} pod/\$pod -- cat ${pod_done_file})
+        echo \$exit_status > cmd_exit_status
+        """
+}
+
+node('master') {
+    withCredentials([
+        string(credentialsId:"${init.ns}-okdtoken", variable: "token_${init.ns.replace('-', '_')}"),
+        string(credentialsId:"${fin.ns}-okdtoken", variable: "token_${fin.ns.replace('-', '_')}"),
+    ])
+    {
+        stage('Build') {
+            if (!actions['build']) {
+                sh "echo Jenkinsfile set to skip build"
+                return
+            }
+
+            param_script = ""
+            for (item in params) {
+                param_script += "--build-arg ${item.key}=${item.value} "
+            }
+
+            if (branch_type == 'main') {
+                oc(ns_prod, "start-build --wait --follow prod $param_script")
+            }
+            else {
+                oc(init.ns, "start-build --wait --follow ${init.name} $param_script")
+            }
+        }
+        // stage('Stage') {
+        //     //kubectl(init.ns, "get pods -l'app.kubernetes.io/name=${init.name}'")
+        //     //kubectl(init.ns, "get pods -l'app.kubernetes.io/name=${init.name}'")
+        // }
+        stage('Test') {
+            if (!actions['test']) {
+                sh "echo Jenkinsfile set to skip tests"
+                return
+            }
+
+            action = "test"
+
+            if (branch_type == "main") {
+                kubectl(ns_prod, "rollout restart deployment/test-staging")
+                kubectl(ns_prod, "rollout status deployment/test-staging")
+            }
+            else {
+                kubectl(init.ns, "rollout restart deployment/${init.name}")
+                kubectl(init.ns, "rollout status deployment/${init.name}")
+            }
+
+            sh "echo Running Primary Tests"
+            // Test output from nx does not get captured correctly
+            exec(init.ns, init.name, "${dir}/cicd/test.sh", exec_bin, action)
+
+            if (actions.test_catalog) {
+                sh "echo Ensure tests passed"
+                junit 'cmd_output'
+                sh "test ${currentBuild.currentResult} != UNSTABLE"
+                sh "test \$(cat cmd_exit_status) = 0"
+            }
+
+            if (branch_type == 'main' && actions.test_prod) {
+                sh "echo Running Prod Tests"
+                kubectl(ns_prod, "rollout restart deployment/test-prod")
+                kubectl(ns_prod, "rollout status deployment/test-prod")
+
+                // There is not yet a test-prod.sh for huapi-js
+                exec(ns_prod, "test-prod", "${dir}/cicd/test-prod.sh", exec_bin, action)
+            }
+
+        }
+        stage('Deploy') {
+            if (!actions['deploy']) {
+                sh "echo Jenkinsfile set to skip deploy"
+                return
+            }
+
+            action = "deploy"
+
+            if (branch_type == 'main') {
+                // STAGING
+                sh "echo Deploy Prod and Staging"
+                oc(ns_prod, "tag prod:test prod:latest")
+
+                kubectl(ns_prod, "rollout restart deployment/staging")
+                kubectl(ns_prod, "rollout restart deployment/prod")
+
+                kubectl(ns_prod, "rollout status deployment/staging")
+                kubectl(ns_prod, "rollout status deployment/prod")
+            }
+            else {
+                sh "echo Not on Main branch, skipping prod deploy stage"
+            }
+
+            // We could have alpha and/or beta builds deploy a separate npm module for testing changes on HUAPI alpha or feature branches
+            if (actions['deploy_script'] && branch_type == 'main') {
+                echo "Running deploy script step"
+                exec(fin.ns, fin.name, "${dir}/cicd/deploy.sh", exec_bin, action)
+                sh "echo check deploy exit status"
+                sh "test \$(cat cmd_exit_status) = 0"
+            }
+
+            else if (actions['deploy_script'] && branch_type == 'major-prerelease') {
+                echo "Running deploy script step"
+                exec(fin.ns, fin.name, "${dir}/cicd/deploy-major-prerelease.sh", exec_bin, action)
+                sh "echo check deploy exit status"
+                sh "test \$(cat cmd_exit_status) = 0"
+            }
+
+        }
+    }
+}
+

package/cicd/deploy-major-prerelease.sh

@@ -0,0 +1,11 @@
+set -o pipefail
+cd dist/libs/huapi-js
+echo "starting deploy script. dir: $(pwd)"
+
+npm set //registry.npmjs.org/:_authToken='${NPM_TOKEN}'
+npm version prerelease --preid=beta
+npm publish --cache=/tmp/npmcache --tag=beta 2>&1 | tee /tmp/deploy-result
+
+echo "finished deploy script"
+
+

package/cicd/deploy.sh

@@ -0,0 +1,10 @@
+set -o pipefail
+cd dist/libs/huapi-js
+echo "starting deploy script. dir: $(pwd)"
+
+npm set //registry.npmjs.org/:_authToken='${NPM_TOKEN}'
+npm publish --cache=/tmp/npmcache 2>&1 | tee /tmp/deploy-result
+
+echo "finished deploy script"
+
+

package/cicd/test.sh

@@ -0,0 +1,5 @@
+echo "starting test script"
+
+yarn nx test huapi-js
+
+echo "finished testing"

package/deploy/alpha.yaml

@@ -0,0 +1 @@
+env: alpha

package/deploy/base.yaml

@@ -0,0 +1,14 @@
+git: ndp/vision
+name: lib-js-nd-mfe-tools
+port: '5000'
+health_url: ''
+image:
+  prefix: 'image-registry.openshift-image-registry.svc:5000'
+  from: 'node:20-alpine'
+build:
+  resources:
+    limits:
+      memory: '4Gi'
+      ephemeral-storage: '30Gi'
+# env_vars:
+#  name: value

package/deploy/beta.yaml

@@ -0,0 +1 @@
+env: beta

package/deploy/branch.yaml

@@ -0,0 +1 @@
+env: branch

package/deploy/prod.yaml

@@ -0,0 +1,2 @@
+env: prod
+replicaCount: 1

package/deploy/staging.yaml

@@ -0,0 +1 @@
+env: staging

package/deploy/test-prod.yaml

@@ -0,0 +1 @@
+env: test-prod

package/deploy/test-staging.yaml

@@ -0,0 +1 @@
+env: test-staging

package/jest.config.ts

@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+  displayName: 'huapi-js',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/huapi-js',
+};

package/orval.config.ts

@@ -0,0 +1,39 @@
+import { defineConfig } from 'orval';
+
+export default defineConfig({
+  huapi: {
+    input: {
+      target: './openapi.json',
+      // validation: true,
+    },
+    output: {
+      mode: 'split',
+      target: './src/index.ts',
+      client: 'react-query',
+      mock: true,
+      clean: false,
+      override: {
+        mock: {
+          delay: 0,
+          generateEachHttpStatus: true,
+        },
+        operations: {
+          sites_error_logs: {
+            query: {
+              useQuery: true,
+              useInfinite: true,
+              useInfiniteQueryParam: 'page_id',
+            },
+          },
+          sites_access_logs: {
+            query: {
+              useQuery: true,
+              useInfinite: true,
+              useInfiniteQueryParam: 'page_id',
+            },
+          },
+        },
+      },
+    },
+  },
+});

package/package.json

@@ -1,18 +1,14 @@
 {
   "name": "@newfold/huapi-js",
   "peerDependencies": {
-    "@faker-js/faker": "^6.1.2",
+    "@faker-js/faker": "^8.0.0",
     "@tanstack/react-query": "^5.51.1",
     "axios": "^0.27.2",
-    "msw": "^0.42.1",
+    "msw": "^2.0.0",
     "react": "^17.0.0 || ^18.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0",
-    "tslib": "2.7.0"
+    "react-dom": "^17.0.0 || ^18.0.0"
   },
   "module": "dist/index.ts",
-  "version": "2.0.0-alpha.1",
-  "sideEffects": false,
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts",
-  "dependencies": {}
+  "version": "2.1.0-beta.1",
+  "sideEffects": false
 }

package/project.json

@@ -0,0 +1,69 @@
+{
+  "name": "huapi-js",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/huapi-js/src",
+  "projectType": "library",
+  "targets": {
+    "prepare": {
+      "executor": "nx:run-commands",
+      "options": {
+        "parallel": false,
+        "commands": [
+          {
+            "command": "echo NX_API_URL=${NX_API_URL:=https://huapi.beta.bh2.hosting.newfold.com/openapi.json}; curl -o libs/huapi-js/openapi.json $NX_API_URL"
+          },
+          {
+            "command": "orval --config libs/huapi-js/orval.config.ts"
+          },
+          {
+            "command": "node libs/huapi-js/scripts/update-version.js"
+          }
+        ]
+      }
+    },
+    "build": {
+      "executor": "@nrwl/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/huapi-js",
+        "main": "libs/huapi-js/src/index.ts",
+        "tsConfig": "libs/huapi-js/tsconfig.lib.json",
+        "assets": ["libs/huapi-js/*.md"]
+      },
+      "dependsOn": [
+        {
+          "target": "prepare",
+          "projects": "self"
+        }
+      ]
+    },
+    "publish": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "node tools/scripts/publish.mjs huapi-js {args.ver} {args.tag}"
+      },
+      "dependsOn": [
+        {
+          "projects": "self",
+          "target": "build"
+        }
+      ]
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/huapi-js/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/libs/huapi-js"],
+      "options": {
+        "jestConfig": "libs/huapi-js/jest.config.ts",
+        "passWithNoTests": true
+      }
+    }
+  },
+  "tags": []
+}

package/scripts/update-version.js

@@ -0,0 +1,43 @@
+const fs = require('fs');
+
+// get version from openapi spec
+const openapi = require('../openapi.json');
+const openAPIVersion = openapi?.info?.version || 'unknown-version';
+
+// The MINOR and PATCH versions represent huapi's openapi version
+// The MAJOR version can manually change to reflect breaking changes in haupi-js
+const versionParts = openAPIVersion.split('.');
+versionParts[0] = '2'; // Bumping the major version to 2 via the React Query v4 to v5 upgrade
+const version = versionParts.join('.');
+
+// print cli alert
+console.log(
+  `[update-version.js] updating package.json version to ${version}...`
+);
+
+// path to packge.json file
+// TODO: update to be more robust when run from different directories
+const filePath = 'libs/huapi-js/package.json';
+
+// read the file
+fs.readFile(filePath, 'utf-8', (err, data) => {
+  if (err) throw err;
+
+  // print to the file
+  fs.writeFile(
+    filePath,
+    // replace the version and re-stringify into json format
+    // use two spaces and a tab at the end of the file for `pretty` formatting
+    `${JSON.stringify({ ...JSON.parse(data), version }, null, '  ')}\n`,
+    'utf-8',
+
+    (err) => {
+      if (err) throw err;
+
+      // notify the user the operation is complete
+      console.log(
+        `[update-version.js] package.json update to ${version} > DONE <`
+      );
+    }
+  );
+});

package/src/tests/huapi-js.spec.ts

@@ -0,0 +1,7 @@
+import { useSitesInfo } from '..';
+
+describe('huapiJs', () => {
+  it('should have a function useSitesInfo', () => {
+    expect(typeof useSitesInfo).toBe('function');
+  });
+});

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ES6",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "sourceMap": false
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": []
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts", "node_modules"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}

package/orval.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("@orval/core").ConfigExternal;
-export default _default;

package/orval.config.js

@@ -1,33 +0,0 @@
-import { defineConfig } from 'orval';
-export default defineConfig({
-    huapi: {
-        input: {
-            target: './openapi.json',
-            // validation: true,
-        },
-        output: {
-            mode: 'split',
-            target: './src/index.ts',
-            client: 'react-query',
-            mock: true,
-            prettier: true,
-            clean: false,
-            override: {
-                operations: {
-                    sites_error_logs: {
-                        query: {
-                            useQuery: true,
-                            useInfinite: true,
-                        },
-                    },
-                    sites_access_logs: {
-                        query: {
-                            useQuery: true,
-                            useInfinite: true,
-                        },
-                    },
-                },
-            },
-        },
-    },
-});