Merge pull request #43 from flippercloud/fix/gate-keys

Ensure snake_case gate keys for Ruby compatibility

Author: jonmagic

packages/flipper-sequelize/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @flippercloud/flipper-sequelize
 
+## 1.0.1 (2025-12-31)
+
+### Fixes
+
+- Normalize percentage gate storage to snake_case and read both snake_case/camelCase, keeping rollouts set by Ruby and TypeScript in sync and visible in the UI.
+- Added regression coverage to ensure Sequelize reads existing snake_case gates and writes the canonical form going forward.
+
 ## 1.0.0
 
 Initial release of Sequelize adapter for Flipper feature flags.

packages/flipper-sequelize/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flippercloud/flipper-sequelize",
   "description": "Sequelize adapter for Flipper feature flags",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Jonathan Hoyt",
   "license": "MIT",
   "main": "./dist/cjs/index.js",

packages/flipper-sequelize/src/SequelizeAdapter.ts

@@ -374,7 +374,7 @@ class SequelizeAdapter implements IAdapter {
     try {
       await this.Gate.create({
         featureKey: feature.key,
-        key: gate.key,
+        key: this.storageKey(gate),
         value: String(thing.value),
       })
     } catch (error) {
@@ -412,7 +412,7 @@ class SequelizeAdapter implements IAdapter {
     try {
       await this.Gate.create({
         featureKey: feature.key,
-        key: gate.key,
+        key: this.storageKey(gate),
         value,
       })
     } catch (error) {
@@ -434,7 +434,7 @@ class SequelizeAdapter implements IAdapter {
     await this.Gate.destroy({
       where: {
         featureKey: feature.key,
-        key: gate.key,
+        key: this.storageKeys(gate),
       },
     })
   }
@@ -446,7 +446,7 @@ class SequelizeAdapter implements IAdapter {
     await this.Gate.destroy({
       where: {
         featureKey: feature.key,
-        key: gate.key,
+        key: this.storageKeys(gate),
         value,
       },
     })
@@ -465,7 +465,7 @@ class SequelizeAdapter implements IAdapter {
 
     for (const gate of feature.gates) {
       const gateKey = gate.key
-      const gateRows = validRows.filter(row => row.key === gateKey)
+      const gateRows = validRows.filter(row => this.storageKeys(gate).includes(row.key ?? ''))
 
       if (gateRows.length === 0) {
         continue
@@ -541,6 +541,32 @@ class SequelizeAdapter implements IAdapter {
       return value
     }
   }
+
+  /**
+   * Return the primary storage key for a gate, using snake_case for cross-language compatibility.
+   * Ruby Flipper stores percentage gates as `percentage_of_actors`/`percentage_of_time`, so we
+   * mirror that format while still accepting camelCase keys that may already exist in the DB.
+   */
+  private storageKey(gate: IGate): string {
+    return this.toSnakeCase(gate.key)
+  }
+
+  /**
+   * Return all accepted storage keys for a gate (camelCase + snake_case) so we can read and clean
+   * up data regardless of which client wrote it.
+   */
+  private storageKeys(gate: IGate): string[] {
+    const keys = [gate.key]
+    const snake = this.toSnakeCase(gate.key)
+    if (!keys.includes(snake)) {
+      keys.push(snake)
+    }
+    return keys
+  }
+
+  private toSnakeCase(key: string): string {
+    return key.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase()
+  }
 }
 
 export default SequelizeAdapter

packages/flipper-sequelize/src/index.test.ts

@@ -253,6 +253,37 @@ describe('SequelizeAdapter', () => {
     })
   })
 
+  describe('Ruby compatibility for percentage gate keys', () => {
+    it('reads percentage gates stored in snake_case', async () => {
+      const featureKey = 'ruby-feature'
+      await FeatureModel.create({ key: featureKey })
+      await GateModel.create({ featureKey, key: 'percentage_of_actors', value: '10' })
+      await GateModel.create({ featureKey, key: 'percentage_of_time', value: '15' })
+
+      const feature = new Feature(featureKey, adapter, {})
+      const state = await adapter.get(feature)
+
+      expect(state.percentageOfActors).toBe(10)
+      expect(state.percentageOfTime).toBe(15)
+    })
+
+    it('writes percentage gates using snake_case for storage', async () => {
+      await flipper.enablePercentageOfActors('ts-feature', 20)
+      await flipper.enablePercentageOfTime('ts-feature', 30)
+
+      const gates = await GateModel.findAll({
+        where: { featureKey: 'ts-feature' },
+        order: [['key', 'ASC']],
+      })
+
+      const keys = gates.map((g: { key: string }) => g.key).sort()
+      expect(keys).toEqual(expect.arrayContaining(['percentage_of_actors', 'percentage_of_time']))
+      // Ensure we did not leave camelCase duplicates
+      expect(keys).not.toContain('percentageOfActors')
+      expect(keys).not.toContain('percentageOfTime')
+    })
+  })
+
   describe('export', () => {
     it('exports features as JSON', async () => {
       await flipper.enable('test-feature')
@@ -335,11 +366,14 @@ describe('SequelizeAdapter', () => {
 
       // Assertions
       expect(spyFindAll).toHaveBeenCalled()
-      const findAllArgs = spyFindAll.mock.calls[0]?.[0]
+      const findAllArgs = spyFindAll.mock.calls[0]?.[0] as { useMaster?: boolean } | undefined
       expect(findAllArgs).toMatchObject({ useMaster: true })
 
       // Ensure at least one findOne received useMaster true
-      const findOneCallWithUseMaster = spyFindOne.mock.calls.find(call => call[0]?.useMaster === true)
+      const findOneCallWithUseMaster = spyFindOne.mock.calls.find(call => {
+        const args = call[0] as { useMaster?: boolean } | undefined
+        return args?.useMaster === true
+      })
       expect(findOneCallWithUseMaster).toBeTruthy()
 
       // Cleanup spies
@@ -350,7 +384,7 @@ describe('SequelizeAdapter', () => {
     it('defaults to replica (no useMaster) when option not set', async () => {
       const spyFindAll = jest.spyOn(FeatureModel, 'findAll')
       await adapter.features()
-      const findAllArgs = spyFindAll.mock.calls[0]?.[0]
+      const findAllArgs = spyFindAll.mock.calls[0]?.[0] as { useMaster?: boolean } | undefined
       expect(findAllArgs?.useMaster).toBe(false)
       spyFindAll.mockRestore()
     })