x-fidelity 3.9.1 → 3.10.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.10.0](https://github.com/zotoio/x-fidelity/compare/v3.9.1...v3.10.0) (2025-03-08)
+
+
+### Features
+
+* **canary:** add example canary rollout script using launchdarkly ([73fbcfb](https://github.com/zotoio/x-fidelity/commit/73fbcfb4eca11be8af7eb9fca20f7ed132898a83))
+
 ## [3.9.1](https://github.com/zotoio/x-fidelity/compare/v3.9.0...v3.9.1) (2025-03-02)
 
 

package/canary-install-example.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+#
+# 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
+#
+# 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
+#
+# export XFI_LD_CLIENT_ID="YOUR_LAUNCHDARKLY_CLIENT_ID"
+# export XFI_VERSION_FLAG_KEY="your-feature-flag-key"
+
+# get the first commit on this repo to use as the context key
+XFI_CONTEXT_KEY=$(git rev-list --max-parents=0 HEAD | head -n 1)
+
+# print config
+echo "XFI_CONTEXT_KEY: $XFI_CONTEXT_KEY"
+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)
+echo "FLAG_VALUE: $FLAG_VALUE"
+
+# Check if the Node.js command succeeded.
+if [ $? -ne 0 ]; then
+  echo 'Error: Failed to evaluate the feature flag.'
+  exit 0
+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
+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
+fi

package/flagCheck.js

@@ -0,0 +1,26 @@
+const ldclient = require('launchdarkly-node-client-sdk');
+
+(async function main(contextKey) {
+  try {
+    const context = { kind: 'user', key: contextKey };
+    const options = {
+        logger: ldclient.basicLogger({
+          level: 'error',
+        }),
+      };
+    const client = ldclient.initialize(process.env.XFI_LD_CLIENT_ID, context, options);
+
+    await client.waitForInitialization(10);
+
+    const flagValue = await client.variation(process.env.XFI_VERSION_FLAG_KEY, "false");
+    console.log(flagValue);
+    process.exit(0);
+
+  } catch (error) {
+    console.log(`*** SDK failed to initialize: ${error}`);
+    process.exit(0);  // exit with 0 to avoid failing the build
+    
+  }
+
+})(process.argv[2]);
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "x-fidelity",
-  "version": "3.9.1",
+  "version": "3.10.0",
   "description": "cli for opinionated framework adherence checks",
   "main": "dist/index",
   "types": "dist/index.d.ts",
@@ -89,6 +89,7 @@
     "json-rules-engine": "^7.3.1",
     "jsonpath-plus": "^10.3.0",
     "kill-port": "^2.0.1",
+    "launchdarkly-node-client-sdk": "^3.3.0",
     "lodash": "^4.17.21",
     "nodemon": "^3.1.9",
     "openai": "^4.86.1",
@@ -96,9 +97,9 @@
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
     "prettyjson": "^1.2.5",
+    "sanitize-filename": "^1.6.3",
     "semver": "^7.7.1",
-    "yarn": "^1.22.22",
-    "sanitize-filename": "^1.6.3"
+    "yarn": "^1.22.22"
   },
   "peerDependencies": {
     "artillery": "^2.0.22"