fix(lib): include userid to data response from field plugin (#438)

* fix(SHAPE-7741): include userid in field plugin response data

* chore(SHAPE-7741): update validation and unit test

* chore(SHAPE-7741): update test user id

* chore(SHAPE-7741): remove console statement

Author: ECJ222

packages/field-plugin/src/createFieldPlugin/FieldPluginData.ts

@@ -8,6 +8,7 @@ export type FieldPluginData<Content> = {
   content: Content
   options: Record<string, string>
   spaceId: number | undefined
+  userId: number | undefined
   interfaceLang: string
   storyLang: string
   story: StoryData

packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginActions.test.ts

@@ -70,6 +70,7 @@ describe('createPluginActions', () => {
         interfaceLanguage: 'en',
         model: randomString,
         spaceId: null,
+        userId: undefined,
         blockId: undefined,
         releases: [],
         releaseId: undefined,

packages/field-plugin/src/createFieldPlugin/createPluginActions/createPluginMessageListener/handlePluginMessage.test.ts

@@ -60,6 +60,7 @@ describe('handlePluginMessage', () => {
       interfaceLanguage: 'en',
       model: 123,
       spaceId: 1234,
+      userId: 2345,
       story: { content: {} },
       schema: { options: [], field_type: 'avh', translatable: false },
       storyId: 1344,

packages/field-plugin/src/createFieldPlugin/createPluginActions/partialPluginStateFromStateChangeMessage.ts

@@ -23,6 +23,7 @@ export const pluginStateFromStateChangeMessage = <Content>(
   return {
     interfaceLang: message.interfaceLanguage,
     spaceId: message.spaceId ?? undefined,
+    userId: message.userId ?? undefined,
     story: message.story ?? undefined,
     storyId: message.storyId ?? undefined,
     storyLang: message.language === '' ? 'default' : message.language,

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/LoadedMessage.test.ts

@@ -5,6 +5,7 @@ const stub: LoadedMessage = {
   action: 'loaded',
   uid: '-preview',
   spaceId: null,
+  userId: undefined,
   model: undefined,
   isModalOpen: false,
   token: null,
@@ -18,7 +19,7 @@ const stub: LoadedMessage = {
   releaseId: undefined,
 }
 
-describe('StateChangedMessage', () => {
+describe('LoadedMessage', () => {
   it('should validate', () => {
     expect(isLoadedMessage(stub)).toEqual(true)
   })
@@ -128,4 +129,38 @@ describe('StateChangedMessage', () => {
       ).toEqual(true)
     })
   })
+  describe('The "userId" property', () => {
+    it('is a number', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: 123,
+        }),
+      ).toEqual(true)
+    })
+    it('is undefined', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: undefined,
+        }),
+      ).toEqual(true)
+    })
+    it('is not null', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a string', () => {
+      expect(
+        isLoadedMessage({
+          ...stub,
+          userId: '123',
+        }),
+      ).toEqual(false)
+    })
+  })
 })

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/LoadedMessage.ts

@@ -13,6 +13,7 @@ export type LoadedMessage = MessageToPlugin<'loaded'> & {
   language: string
   interfaceLanguage: string
   spaceId: number | null
+  userId: number | undefined
   story: StoryData
   storyId: number | undefined
   blockId: string | undefined
@@ -33,6 +34,8 @@ export const isLoadedMessage = (data: unknown): data is LoadedMessage =>
   typeof data.language === 'string' &&
   hasKey(data, 'schema') &&
   isFieldPluginSchema(data.schema) &&
+  hasKey(data, 'userId') &&
+  (typeof data.userId === 'number' || typeof data.userId === 'undefined') &&
   hasKey(data, 'story') &&
   isStoryData(data.story) &&
   hasKey(data, 'isModalOpen') &&

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/StateChangedMessage.test.ts

@@ -0,0 +1,166 @@
+import { isStateMessage, StateChangedMessage } from './StateChangedMessage'
+import { FieldPluginSchema } from './FieldPluginSchema'
+
+const stub: StateChangedMessage = {
+  action: 'state-changed',
+  uid: '-preview',
+  spaceId: null,
+  userId: undefined,
+  model: undefined,
+  isModalOpen: false,
+  token: null,
+  storyId: undefined,
+  blockId: undefined,
+  story: { content: {} },
+  language: '',
+  interfaceLanguage: 'en',
+  schema: { options: [], field_type: 'blah', translatable: false },
+  releases: [],
+  releaseId: undefined,
+}
+
+describe('StateChangedMessage', () => {
+  it('should validate', () => {
+    expect(isStateMessage(stub)).toEqual(true)
+  })
+  describe('The "action" property', () => {
+    it('equals "loaded"', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          action: 'anotherString',
+        }),
+      ).toEqual(false)
+    })
+  })
+  describe('the "uid" property', () => {
+    it('is a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: 'anything',
+        }),
+      ).toEqual(true)
+    })
+    it('is not undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          uid: 123,
+        }),
+      ).toEqual(false)
+    })
+  })
+
+  describe('the "language" property', () => {
+    it('is a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: 'anything',
+        }),
+      ).toEqual(true)
+    })
+    it('is not undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          language: 123,
+        }),
+      ).toEqual(false)
+    })
+  })
+  describe('The "schema" property', () => {
+    it('is required', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          schema: undefined,
+        }),
+      ).toEqual(false)
+    })
+    it('must be a schema', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          schema: {
+            field_type: 'my-field',
+            options: [
+              {
+                name: 'a',
+                value: 'ab',
+              },
+            ],
+            translatable: false,
+          } as FieldPluginSchema,
+        }),
+      ).toEqual(true)
+    })
+  })
+  describe('The "userId" property', () => {
+    it('is a number', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: 123,
+        }),
+      ).toEqual(true)
+    })
+    it('is undefined', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: undefined,
+        }),
+      ).toEqual(true)
+    })
+    it('is not null', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: null,
+        }),
+      ).toEqual(false)
+    })
+    it('is not a string', () => {
+      expect(
+        isStateMessage({
+          ...stub,
+          userId: '123',
+        }),
+      ).toEqual(false)
+    })
+  })
+})

packages/field-plugin/src/messaging/pluginMessage/containerToPluginMessage/StateChangedMessage.ts

@@ -13,6 +13,7 @@ export type StateChangedMessage = MessageToPlugin<'state-changed'> & {
   language: string
   interfaceLanguage: string
   spaceId: number | null
+  userId: number | undefined
   story: StoryData
   storyId: number | undefined
   blockId: string | undefined
@@ -33,6 +34,8 @@ export const isStateMessage = (data: unknown): data is StateChangedMessage =>
   typeof data.language === 'string' &&
   hasKey(data, 'schema') &&
   isFieldPluginSchema(data.schema) &&
+  hasKey(data, 'userId') &&
+  (typeof data.userId === 'number' || typeof data.userId === 'undefined') &&
   hasKey(data, 'story') &&
   isStoryData(data.story) &&
   hasKey(data, 'isModalOpen') &&

packages/lib-helpers/test/src/index.ts

@@ -27,6 +27,7 @@ const getContainer = (sendToFieldPlugin: (data: unknown) => void) => {
   const language = 'default'
   const storyId = 'test-story-id'
   const spaceId = 'test-space-id'
+  const userId = 1234
   const token = 'test-token'
   const story = {
     content: {},
@@ -49,6 +50,7 @@ const getContainer = (sendToFieldPlugin: (data: unknown) => void) => {
     language,
     storyId,
     spaceId,
+    userId,
     token,
     action,
   })

packages/sandbox/src/components/FieldPluginSandbox.tsx

@@ -133,6 +133,7 @@ const useSandbox = (
       blockId: undefined,
       language,
       spaceId: null,
+      userId: undefined,
       story,
       storyId: undefined,
       token: null,