do not double encode the value

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

plugins/user-settings-backend/package.json

@@ -32,6 +32,7 @@
     "@backstage/catalog-model": "^1.1.0",
     "@backstage/errors": "^1.1.0",
     "@backstage/plugin-auth-node": "^0.2.5-next.1",
+    "@backstage/types": "^1.0.0",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",

plugins/user-settings-backend/src/database/DatabaseUserSettingsStore.test.ts

@@ -84,13 +84,13 @@ describe.each(databases.eachSupportedId())(
             user_entity_ref: 'user-1',
             bucket: 'bucket-a',
             key: 'key-a',
-            value: 'value-a',
+            value: JSON.stringify('value-a'),
           },
           {
             user_entity_ref: 'user-2',
             bucket: 'bucket-c',
             key: 'key-c',
-            value: 'value-c',
+            value: JSON.stringify('value-c'),
           },
         ]);
 
@@ -122,7 +122,7 @@ describe.each(databases.eachSupportedId())(
             user_entity_ref: 'user-1',
             bucket: 'bucket-a',
             key: 'key-a',
-            value: 'value-a',
+            value: JSON.stringify('value-a'),
           },
         ]);
       });
@@ -147,7 +147,7 @@ describe.each(databases.eachSupportedId())(
             user_entity_ref: 'user-1',
             bucket: 'bucket-a',
             key: 'key-a',
-            value: 'value-b',
+            value: JSON.stringify('value-b'),
           },
         ]);
       });
@@ -170,13 +170,13 @@ describe.each(databases.eachSupportedId())(
             user_entity_ref: 'user-1',
             bucket: 'bucket-a',
             key: 'key-a',
-            value: 'value-a',
+            value: JSON.stringify('value-a'),
           },
           {
             user_entity_ref: 'user-2',
             bucket: 'bucket-c',
             key: 'key-c',
-            value: 'value-c',
+            value: JSON.stringify('value-c'),
           },
         ]);
 
@@ -190,7 +190,7 @@ describe.each(databases.eachSupportedId())(
             user_entity_ref: 'user-2',
             bucket: 'bucket-c',
             key: 'key-c',
-            value: 'value-c',
+            value: JSON.stringify('value-c'),
           },
         ]);
       });

plugins/user-settings-backend/src/database/DatabaseUserSettingsStore.ts

@@ -19,8 +19,9 @@ import {
   resolvePackagePath,
 } from '@backstage/backend-common';
 import { NotFoundError } from '@backstage/errors';
+import { JsonValue } from '@backstage/types';
 import { Knex } from 'knex';
-import { type UserSetting, UserSettingsStore } from './UserSettingsStore';
+import { UserSettingsStore, type UserSetting } from './UserSettingsStore';
 
 const migrationsDir = resolvePackagePath(
   '@backstage/plugin-user-settings-backend',
@@ -79,21 +80,25 @@ export class DatabaseUserSettingsStore implements UserSettingsStore {
       );
     }
 
-    return rows[0];
+    return {
+      bucket: rows[0].bucket,
+      key: rows[0].key,
+      value: JSON.parse(rows[0].value),
+    };
   }
 
   async set(options: {
     userEntityRef: string;
     bucket: string;
     key: string;
-    value: string;
+    value: JsonValue;
   }): Promise<void> {
     await this.db<RawDbUserSettingsRow>('user_settings')
       .insert({
         user_entity_ref: options.userEntityRef,
         bucket: options.bucket,
         key: options.key,
-        value: options.value,
+        value: JSON.stringify(options.value),
       })
       .onConflict(['user_entity_ref', 'bucket', 'key'])
       .merge(['value']);

plugins/user-settings-backend/src/database/UserSettingsStore.ts

@@ -14,13 +14,15 @@
  * limitations under the License.
  */
 
+import { JsonValue } from '@backstage/types';
+
 /**
  * A single setting in a bucket
  */
 export type UserSetting = {
   bucket: string;
   key: string;
-  value: string;
+  value: JsonValue;
 };
 
 /**
@@ -37,7 +39,7 @@ export interface UserSettingsStore {
     userEntityRef: string;
     bucket: string;
     key: string;
-    value: string;
+    value: JsonValue;
   }): Promise<void>;
 
   delete(options: {

plugins/user-settings-backend/src/service/router.test.ts

@@ -148,7 +148,7 @@ describe('createRouter', () => {
       });
     });
 
-    it('returns an error if the value is not a string', async () => {
+    it('returns an error if the value is not given', async () => {
       authenticateMock.mockResolvedValue({
         identity: { userEntityRef: 'user-1' },
       });
@@ -156,7 +156,7 @@ describe('createRouter', () => {
       const responses = await request(app)
         .put('/buckets/my-bucket/keys/my-key')
         .set('Authorization', 'Bearer foo')
-        .send({ value: { invalid: 'because not a string' } });
+        .send({});
 
       expect(responses.status).toEqual(400);
 

plugins/user-settings-backend/src/service/router.ts

@@ -96,8 +96,8 @@ export async function createRouterInternal(options: {
     const { bucket, key } = req.params;
     const { value } = req.body;
 
-    if (typeof value !== 'string') {
-      throw new InputError('Value must be a string');
+    if (value === undefined) {
+      throw new InputError('Missing required field "value"');
     }
 
     await options.userSettingsStore.set({