Cinder Message API create failure "'NoneType' object is not subscriptable"

[Abhinav Shrivastava]

Tried to create message from cinder message api where 'action' was None.

2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server   File "/usr/lib/python3.9/site-packages/oslo_utils/excutils.py", line 227, in __exit__
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server     self.force_reraise()
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server   File "/usr/lib/python3.9/site-packages/oslo_utils/excutils.py", line 200, in force_reraise
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server     raise self.value
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server   File "/usr/lib/python3.9/site-packages/cinder/backup/manager.py", line 489, in continue_backup
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server     self.message_api.create_from_request_context(
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server   File "/usr/lib/python3.9/site-packages/cinder/message/api.py", line 140, in create_from_request_context
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server     self.create(context=context,
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server   File "/usr/lib/python3.9/site-packages/cinder/message/api.py", line 104, in create
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server     action[0],
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server TypeError: 'NoneType' object is not subscriptable
2023-03-06 03:56:13.919 420861 ERROR oslo_messaging.rpc.server

[Abhinav Shrivastava (abshriva)]

Changing this:
        message_record = {'project_id': context.project_id,
                          'request_id': context.request_id,
                          'resource_type': resource_type,
                          'resource_uuid': resource_uuid,
                          'action_id': action[0] if action else '',
                          'message_level': level,
                          'event_id': "VOLUME_%s_%s_%s" % (resource_type,
                                                           action[0],
                                                           detail_id),
                          'detail_id': detail_id,
                          'expires_at': expires_at}

to following fixes the issue:

        action_id = action[0] if action else ''
        message_record = {'project_id': context.project_id,
                          'request_id': context.request_id,
                          'resource_type': resource_type,
                          'resource_uuid': resource_uuid,
                          'action_id': action_id,
                          'message_level': level,
                          'event_id': "VOLUME_%s_%s_%s" % (resource_type,
                                                           action_id,
                                                           detail_id),
                          'detail_id': detail_id,
                          'expires_at': expires_at}

[Abhinav Shrivastava (abshriva)]

https://review.opendev.org/c/openstack/cinder/+/876587

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/877966

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/877967

[Pete Zaitcev (zaitcev)]

So, what if we raise a better defined, more specific exception instead of TypeError? Would that be satisfactory? Seems like arbitrary screwing with action_id is asking for trouble. The existing code puts '' in there silently, but that is not necessarily correct.

For reference:
https://docs.openstack.org/cinder/latest/contributor/user_messages.html

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/909688

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Eric Harney <email address hidden>" on branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/877966
Reason: Resolved by https://review.opendev.org/c/openstack/cinder/+/846303

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Eric Harney <email address hidden>" on branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/909688
Reason: Handled in https://review.opendev.org/c/openstack/cinder/+/846303