x-fidelity 3.16.0 → 3.17.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.17.0](https://github.com/zotoio/x-fidelity/compare/v3.16.0...v3.17.0) (2025-03-20)
+
+
+### Features
+
+* **canary:** example with proxy support for canary installs in ci ([6b5aff3](https://github.com/zotoio/x-fidelity/commit/6b5aff317d0d4fedfccd6cf79304722e8e7a7556))
+
 # [3.16.0](https://github.com/zotoio/x-fidelity/compare/v3.15.0...v3.16.0) (2025-03-19)
 
 

package/{canary-install-example.sh → canary-install/canary-install-example.sh}

@@ -3,10 +3,8 @@
 # This script uses the LaunchDarkly Node SDK to evaluate a feature flag
 # and conditionally run a command based on the flag’s value.
 #
-# Requirements:
-#   - Node.js installed.
-#   - LaunchDarkly Node SDK installed:
-#       yarn global add launchdarkly-node-client-sdk
+# global-agent is used to make the launchdarkly connection via proxy set in environment
+# to run a local test proxy: DEBUG=* npx proxy --port 3128
 #
 # Set your LaunchDarkly clientid and feature flag key here.
 # note that the clientid is not a secret, as it is public in the client-side SDKs
@@ -23,7 +21,9 @@ echo "XFI_LD_CLIENT_ID: $XFI_LD_CLIENT_ID"
 echo "XFI_VERSION_FLAG_KEY: $XFI_VERSION_FLAG_KEY"
 
 # Run a Node.js script to evaluate the flag.
-FLAG_VALUE=$(node ./flagCheck.js $XFI_CONTEXT_KEY)
+export GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE=
+FLAG_VALUE=$(yarn add -s global-agent launchdarkly-node-client-sdk --ignore-engines \
+  && node ./flagCheck.js $XFI_CONTEXT_KEY)
 echo "FLAG_VALUE: $FLAG_VALUE"
 
 # Check if the Node.js command succeeded.
@@ -34,11 +34,11 @@ fi
 
 # Decide which command to run based on the flag value.
 if [ "$FLAG_VALUE" == "true" ]; then
-  echo "Installing the NEW version of xfi"
-  # add your canary CI install command here
-  # eg. yarn global add x-fidelity@3.9.1 --ignore-engines
+  export XFI_VERSION=$(cat ./xfi-version-new.txt)
+  echo "Installing the NEW version of xfi $XFI_VERSION"
+  yarn global add x-fidelity@$XFI_VERSION --ignore-engines
 else
-  echo "Installing the current version of xfi"
-  # add your current CI install command here
-  # eg. yarn global add x-fidelity@2.17.2 --ignore-engines
+  export XFI_VERSION=$(cat ./xfi-version-current.txt)
+  echo "Installing the current version of xfi $XFI_VERSION"
+  yarn global add x-fidelity@$XFI_VERSION --ignore-engines
 fi

package/{flagCheck.js → canary-install/flagCheck.js}

@@ -1,3 +1,5 @@
+
+const bootstrap = require('global-agent/bootstrap');
 const ldclient = require('launchdarkly-node-client-sdk');
 
 (async function main(contextKey) {

package/canary-install/xfi-version-current.txt

@@ -0,0 +1 @@
+2.17.2

package/canary-install/xfi-version-new.txt

@@ -0,0 +1 @@
+3.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-fidelity",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "cli for opinionated framework adherence checks",
   "main": "dist/index",
   "types": "dist/index.d.ts",
@@ -88,6 +88,7 @@
     "esprima": "^4.0.1",
     "express": "^4.21.2",
     "express-rate-limit": "^7.5.0",
+    "global-agent": "^3.0.0",
     "helmet": "^8.0.0",
     "json-rules-engine": "^7.3.1",
     "jsonpath-plus": "^10.3.0",