Update test running instructions in README and other housekeeping (#186)

* Update test running instructions in README.

* Don't format shared test data.

* Run formatter.

* Set husky pre-commit script as executable.

Author: phiggins

.github/workflows/publish.yml

@@ -1,25 +1,25 @@
 name: Publish NPM Package
 
 on:
-  push:
-    tags:
-      - '*'
+    push:
+        tags:
+            - '*'
 
 jobs:
-  package:
-    runs-on: ubuntu-latest
-    name: Publish NPM Package
+    package:
+        runs-on: ubuntu-latest
+        name: Publish NPM Package
 
-    steps:
-      - name: Cloning repo
-        uses: actions/checkout@v3
+        steps:
+            - name: Cloning repo
+              uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '18.x'
-          registry-url: 'https://registry.npmjs.org'
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '18.x'
+                  registry-url: 'https://registry.npmjs.org'
 
-      - run: npm ci
-      - run: npm run deploy
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+            - run: npm ci
+            - run: npm run deploy
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/pull_request.yaml

@@ -1,37 +1,37 @@
 name: Unit/Integration Tests
 
 on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-      - ready_for_review
-  push:
-    branches:
-      - main
+    pull_request:
+        types:
+            - opened
+            - synchronize
+            - reopened
+            - ready_for_review
+    push:
+        branches:
+            - main
 jobs:
-  build-and-test:
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: true
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "${{ matrix.node-version }}"
-      - name: cache node modules
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-          key: npm-${{ matrix.node-version }}-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            npm-${{ matrix.node-version }}-${{ hashFiles('package-lock.json') }}
-            npm-
-      - run: npm ci
-      - run: npm test
-        env:
-          CI: true
+    build-and-test:
+        strategy:
+            matrix:
+                node-version: [18.x, 20.x, 22.x]
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: true
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '${{ matrix.node-version }}'
+            - name: cache node modules
+              uses: actions/cache@v4
+              with:
+                  path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
+                  key: npm-${{ matrix.node-version }}-${{ hashFiles('package-lock.json') }}
+                  restore-keys: |
+                      npm-${{ matrix.node-version }}-${{ hashFiles('package-lock.json') }}
+                      npm-
+            - run: npm ci
+            - run: npm test
+              env:
+                  CI: true

.husky/pre-commit

@@ -1 +1,2 @@
-*.json
+*.json
+tests/engine/engine-tests/engine-test-data

.prettierignore

@@ -21,10 +21,11 @@ If you encounter a bug or feature request we would like to hear about it. Before
 
 ## Testing
 
-To run the local tests you need to run following command beforehand:
+To run the local tests you need to run following commands beforehand:
 
 ```bash
 git submodule add [email protected]:Flagsmith/engine-test-data.git tests/engine/engine-tests/engine-test-data/
+git submodule update --init --recursive
 ```
 
 ## Get in touch

README.md

@@ -15,8 +15,8 @@ export function buildEnvironmentModel(environmentJSON: any) {
     );
     environmentModel.featureStates = featureStates;
     if (!!environmentJSON.identity_overrides) {
-        environmentModel.identityOverrides = environmentJSON.identity_overrides.map((identityData: any) =>
-            buildIdentityModel(identityData)
+        environmentModel.identityOverrides = environmentJSON.identity_overrides.map(
+            (identityData: any) => buildIdentityModel(identityData)
         );
     }
     return environmentModel;

flagsmith-engine/environments/util.ts

@@ -1,4 +1,4 @@
-import { randomUUID as uuidv4 } from "node:crypto";
+import { randomUUID as uuidv4 } from 'node:crypto';
 import { getHashedPercentateForObjIds } from '../utils/hashing/index.js';
 
 export class FeatureModel {

flagsmith-engine/features/models.ts

@@ -19,23 +19,23 @@ export function buildFeatureStateModel(featuresStateModelJSON: any): FeatureStat
         featuresStateModelJSON.featurestate_uuid
     );
 
-    featureStateModel.featureSegment = featuresStateModelJSON.feature_segment ?
-        buildFeatureSegment(featuresStateModelJSON.feature_segment) :
-        undefined;
+    featureStateModel.featureSegment = featuresStateModelJSON.feature_segment
+        ? buildFeatureSegment(featuresStateModelJSON.feature_segment)
+        : undefined;
 
     const multivariateFeatureStateValues = featuresStateModelJSON.multivariate_feature_state_values
         ? featuresStateModelJSON.multivariate_feature_state_values.map((fsv: any) => {
-            const featureOption = new MultivariateFeatureOptionModel(
-                fsv.multivariate_feature_option.value,
-                fsv.multivariate_feature_option.id
-            );
-            return new MultivariateFeatureStateValueModel(
-                featureOption,
-                fsv.percentage_allocation,
-                fsv.id,
-                fsv.mv_fs_value_uuid
-            );
-        })
+              const featureOption = new MultivariateFeatureOptionModel(
+                  fsv.multivariate_feature_option.value,
+                  fsv.multivariate_feature_option.id
+              );
+              return new MultivariateFeatureStateValueModel(
+                  featureOption,
+                  fsv.percentage_allocation,
+                  fsv.id,
+                  fsv.mv_fs_value_uuid
+              );
+          })
         : [];
 
     featureStateModel.multivariateFeatureStateValues = multivariateFeatureStateValues;

flagsmith-engine/features/util.ts

@@ -19,7 +19,7 @@ export class IdentityModel {
         environmentApiKey: string,
         identifier: string,
         identityUuid?: string,
-        djangoID?: number,
+        djangoID?: number
     ) {
         this.identityUuid = identityUuid || uuidv4();
         this.createdDate = Date.parse(created_date) || Date.now();

flagsmith-engine/identities/models.ts

@@ -67,11 +67,10 @@ export function traitsMatchSegmentCondition(
     }
     const traits = identityTraits.filter(t => t.traitKey === condition.property_);
     const trait = traits.length > 0 ? traits[0] : undefined;
-    if (condition.operator === IS_SET ) {
+    if (condition.operator === IS_SET) {
         return !!trait;
-    } else if (condition.operator === IS_NOT_SET){
+    } else if (condition.operator === IS_NOT_SET) {
         return trait == undefined;
     }
     return trait ? condition.matchesTraitValue(trait.traitValue) : false;
-
 }