fix(condo): DOMA-11144 renamed MeterUserData to MeterUserSetting (#5870)

* fix(condo): DOMA-11144 fixed access, tests and deleted unnecessary client schema

* refactor(condo): DOMA-11144 made schema names more obvious and intuitive

* refactor(condo): DOMA-11144 renamed model MeterUserData to MeterUserSetting

* fix(condo): DOMA-11144 pr fixes

* fix(condo): DOMA-11144 fixed typos

Author: abshnko

apps/condo/domains/meter/access/MeterUserData.js

@@ -0,0 +1,75 @@
+/**
+ * Generated by `createschema meter.MeterUserSetting 'user:Relationship:User:CASCADE; meter:Relationship:Meter:CASCADE; name:Text'`
+ */
+
+const get = require('lodash/get')
+
+const { throwAuthenticationError } = require('@open-condo/keystone/apolloErrorFormatter')
+const { find } = require('@open-condo/keystone/schema')
+
+const { getAvailableResidentMeters } = require('@condo/domains/meter/utils/serverSchema')
+const { RESIDENT } = require('@condo/domains/user/constants/common')
+
+async function canReadMeterUserSetting ({ authentication: { item: user } }) {
+    if (!user) return throwAuthenticationError()
+    if (user.deletedAt) return false
+    if (user.isAdmin || user.isSupport) return {}
+
+    if (user.type === RESIDENT) {
+        return {
+            user: { id: user.id },
+        }
+    }
+
+    return false
+}
+
+
+async function canManageMeterUserSetting ({ authentication: { item: user }, originalInput, operation, itemId, itemIds }) {
+    if (!user) return throwAuthenticationError()
+    if (user.deletedAt) return false
+    if (user.isAdmin || user.isSupport) return true
+
+    if (user.type === RESIDENT) {
+        if (operation === 'update') {
+            const ids = itemIds || [itemId]
+            if (ids.length !== new Set(ids).size) return false
+
+            const items = await find('MeterUserSetting', {
+                id_in: ids,
+                deletedAt: null,
+            })
+            if (items.length !== ids.length || items.some(item => !item.user)) return false
+
+            return items.every(item => item.user === user.id)
+        }
+
+        if (operation === 'create') {
+            const inputs = Array.isArray(originalInput) ? originalInput : [originalInput]
+            const otherUserIds = inputs.map(inp => get(inp, ['user', 'connect', 'id'])).filter(id => id !== user.id)
+            if (otherUserIds.length) return false
+
+            const inputMeterIds = inputs.map(inp => get(inp, ['meter', 'connect', 'id']))
+            // restrict meter: { create: {} } case
+            if (!inputMeterIds.every(Boolean)) return false
+
+            const availableMeters = await getAvailableResidentMeters(user.id)
+            const availableMetersIds = new Set(availableMeters.map((meter) => meter.id))
+
+            return inputMeterIds.every(id => availableMetersIds.has(id))
+        }
+    }
+
+    return false
+}
+
+
+
+/*
+  Rules are logical functions that used for list access, and may return a boolean (meaning
+  all or no items are available) or a set of filters that limit the available items.
+*/
+module.exports = {
+    canManageMeterUserSetting,
+    canReadMeterUserSetting,
+}

apps/condo/domains/meter/access/MeterUserSetting.js

@@ -89,8 +89,8 @@ const MeterReadingsImportTask = generateGqlQueries('MeterReadingsImportTask', ME
 const METER_READING_EXPORT_TASK_FIELDS = `{ status format exportedRecordsCount totalRecordsCount file { id originalFilename publicUrl mimetype } meta where sortBy locale timeZone user { id } ${COMMON_FIELDS} }`
 const MeterReadingExportTask = generateGqlQueries('MeterReadingExportTask', METER_READING_EXPORT_TASK_FIELDS)
 
-const METER_USER_DATA_FIELDS = `{ user { id } meter { id } name ${COMMON_FIELDS} }`
-const MeterUserData = generateGqlQueries('MeterUserData', METER_USER_DATA_FIELDS)
+const METER_USER_SETTING_FIELDS = `{ user { id } meter { id } name ${COMMON_FIELDS} }`
+const MeterUserSetting = generateGqlQueries('MeterUserSetting', METER_USER_SETTING_FIELDS)
 
 /* AUTOGENERATE MARKER <CONST> */
 
@@ -113,7 +113,7 @@ module.exports = {
     REGISTER_PROPERTY_METERS_READINGS_MUTATION,
     MeterReadingsImportTask,
     MeterReadingExportTask,
-    MeterUserData,
+    MeterUserSetting,
 /* AUTOGENERATE MARKER <EXPORTS> */
 }
 

apps/condo/domains/meter/gql.js

@@ -1,21 +1,20 @@
 /**
- * Generated by `createschema meter.MeterUserData 'user:Relationship:User:CASCADE; meter:Relationship:Meter:CASCADE; name:Text'`
+ * Generated by `createschema meter.MeterUserSetting 'user:Relationship:User:CASCADE; meter:Relationship:Meter:CASCADE; name:Text'`
  */
 
 const { historical, versioned, uuided, tracked, softDeleted, dvAndSender } = require('@open-condo/keystone/plugins')
 const { GQLListSchema } = require('@open-condo/keystone/schema')
 
-const access = require('@condo/domains/meter/access/MeterUserData')
+const access = require('@condo/domains/meter/access/MeterUserSetting')
 const { RESIDENT } = require('@condo/domains/user/constants/common')
 
 
-const MeterUserData = new GQLListSchema('MeterUserData', {
-    schemaDoc: `Custom user data that a user with type ${RESIDENT} can assign to a specific meter device to make it easier to understand what kind of device it is`,
-    plural: 'MeterUserData',
+const MeterUserSetting = new GQLListSchema('MeterUserSetting', {
+    schemaDoc: `Custom user setting that a user with type ${RESIDENT} can assign to a specific meter device to make it easier to understand what kind of device it is`,
     fields: {
 
         user: {
-            schemaDoc: 'User that created their custom meter data',
+            schemaDoc: 'User that created their custom meter setting',
             type: 'Relationship',
             ref: 'User',
             isRequired: true,
@@ -24,7 +23,7 @@ const MeterUserData = new GQLListSchema('MeterUserData', {
         },
 
         meter: {
-            schemaDoc: 'Meter for which the user created custom data',
+            schemaDoc: 'Meter for which the user created custom setting',
             type: 'Relationship',
             ref: 'Meter',
             isRequired: true,
@@ -45,20 +44,20 @@ const MeterUserData = new GQLListSchema('MeterUserData', {
                 type: 'models.UniqueConstraint',
                 fields: ['user', 'meter'],
                 condition: 'Q(deletedAt__isnull=True)',
-                name: 'Meter_user_data_unique_user_meter',
+                name: 'Meter_user_setting_unique_user_meter',
             },
         ],
     },
     plugins: [uuided(), versioned(), tracked(), softDeleted(), dvAndSender(), historical()],
     access: {
-        read: access.canReadMeterUserData,
-        create: access.canManageMeterUserData,
-        update: access.canManageMeterUserData,
+        read: access.canReadMeterUserSetting,
+        create: access.canManageMeterUserSetting,
+        update: access.canManageMeterUserSetting,
         delete: false,
         auth: true,
     },
 })
 
 module.exports = {
-    MeterUserData,
+    MeterUserSetting,
 }