Fix Darwin availability bits for command payloads: (#29468)

1) Add missing isForCommandPayload=true to declarations of the old command payload names. Otherwise we were ending up with SetUtcTime being marked provisional, which is not backwards-compatible. 2) We need to declare fields in the old-name command payloads with the right availability, since the availability in the super-class is "too new". The implementation then needs to use @dynamic. This is similar to how structs work. 3) SetUTCTime cannot be provisional (and hence unavailable) if SetUtcTime is supposed to be available and inherits from it. This requires exposing SetUTCTime and its fields in the first release where we will update Matter.framework in the Xcode SDK to the setup where we started doing "provisionally available". Items 1 and 2 are handled by using "completeDecl" for both the old and new name.
project-chip · Feb 17, 2024 · 5534825 · 5534825
1 parent 8632541
commit 5534825
Show file tree

Hide file tree

Showing 5 changed files with 1,583 additions and 191 deletions.
diff --git a/src/darwin/Framework/CHIP/templates/MTRCommandPayloadsObjc-src.zapt b/src/darwin/Framework/CHIP/templates/MTRCommandPayloadsObjc-src.zapt
@@ -116,6 +116,18 @@ NS_ASSUME_NONNULL_BEGIN
 {{#*inline "oldNameImpl"}}
 
 @implementation MTR{{cluster}}Cluster{{command}}Params
+{{#zcl_command_arguments}}
+{{#if (isSupported ../cluster command=../command commandField=(asStructPropertyName label))}}
+@dynamic {{asStructPropertyName label}};
+{{/if}}
+{{/zcl_command_arguments}}
+
+{{#if (isStrEqual source "client")}}
+@dynamic timedInvokeTimeoutMs;
+@dynamic serverSideProcessingTimeout;
+{{else if (wasIntroducedBeforeRelease "First major API revamp" cluster command=command)}}
+@dynamic timedInvokeTimeoutMs;
+{{/if}}
 @end
 {{/inline}}
 {{#if (isSupported (asUpperCamelCase parent.name preserveAcronyms=true) command=(asUpperCamelCase name preserveAcronyms=true))}}

diff --git a/src/darwin/Framework/CHIP/templates/MTRCommandPayloadsObjc.zapt b/src/darwin/Framework/CHIP/templates/MTRCommandPayloadsObjc.zapt
@@ -10,14 +10,18 @@ NS_ASSUME_NONNULL_BEGIN
 {{#*inline "completeDecl"}}
 {{#if (isSupported cluster command=command isForCommandPayload=true)}}
 
-{{availability cluster command=command isForCommandPayload=true deprecationMessage="This command has been removed"}}
-@interface MTR{{cluster}}Cluster{{command}}Params : NSObject <NSCopying>
+{{availability cluster command=command isForCommandPayload=true deprecationMessage=deprecationMessage}}
+@interface MTR{{cluster}}Cluster{{command}}Params : {{base}}
 {{#zcl_command_arguments}}
 
+{{#if (isSupported ../cluster command=../command commandField=(asStructPropertyName label))}}
 {{> struct_field_decl cluster=parent.parent.name type=type label=label}} {{availability ../cluster command=../command commandField=(asStructPropertyName label) deprecationMessage=(concat "The " (asStructPropertyName label) " field will be removed")}};
+{{/if}}
 {{#*inline "oldNameFieldDecl"}}
 
+{{#if (isSupported ../cluster command=../command commandField=commandField)}}
 {{> struct_field_decl cluster=parent.parent.name type=type label=commandField}} {{availability ../cluster command=../command commandField=commandField deprecationMessage=(concat "Please use " (asStructPropertyName label))}};
+{{/if}}
 {{/inline}}
 {{#if (and includeRenamedProperties
            (hasOldName ../cluster command=../command commandField=(asStructPropertyName label)))}}
@@ -68,7 +72,8 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, copy, nullable) NSNumber * timedInvokeTimeoutMs {{availability "" api="Timed Invoke for server to client commands" deprecationMessage="Timed invoke does not make sense for server to client commands"}};
 {{/if}}
-{{#if (isStrEqual source "server")}}
+{{#if (and (isStrEqual source "server")
+           includeInitWithResponseValue)}}
 
 /**
  * Initialize an MTR{{cluster}}Cluster{{command}}Params with a response-value dictionary
@@ -88,15 +93,21 @@ NS_ASSUME_NONNULL_BEGIN
 {{/inline}}
 {{#*inline "oldNameDecl"}}
 
-{{availability cluster command=command deprecationMessage=(concat "Please use MTR" (asUpperCamelCase parent.name preserveAcronyms=true) "Cluster" (asUpperCamelCase name preserveAcronyms=true) "Params")}}
-@interface MTR{{cluster}}Cluster{{command}}Params : MTR{{asUpperCamelCase parent.name preserveAcronyms=true}}Cluster{{asUpperCamelCase name}}Params
-@end
+{{> completeDecl cluster=cluster
+                 command=command
+                 includeRenamedProperties=true
+                 deprecationMessage=(concat "Please use MTR" (asUpperCamelCase parent.name preserveAcronyms=true) "Cluster" (asUpperCamelCase name preserveAcronyms=true) "Params")
+                 base=(concat "MTR" (asUpperCamelCase parent.name preserveAcronyms=true) "Cluster" (asUpperCamelCase name preserveAcronyms=true) "Params")
+                 includeInitWithResponseValue=false}}
 
 {{/inline}}
 {{#if (isSupported (asUpperCamelCase parent.name preserveAcronyms=true) command=(asUpperCamelCase name preserveAcronyms=true))}}
 {{> completeDecl cluster=(asUpperCamelCase parent.name preserveAcronyms=true)
                  command=(asUpperCamelCase name preserveAcronyms=true)
-                 includeRenamedProperties=false}}
+                 includeRenamedProperties=false
+                 deprecationMessage="This command has been removed"
+                 base="NSObject <NSCopying>"
+                 includeInitWithResponseValue=true}}
 {{#if (or (not (isStrEqual (asUpperCamelCase parent.name preserveAcronyms=true) (compatClusterNameRemapping parent.name)))
           (not (isStrEqual (asUpperCamelCase name preserveAcronyms=true) (compatCommandNameRemapping parent.name name))))}}
 {{> oldNameDecl cluster=(compatClusterNameRemapping parent.name)
@@ -123,7 +134,10 @@ NS_ASSUME_NONNULL_BEGIN
 {{else}}
 {{> completeDecl cluster=(compatClusterNameRemapping parent.name)
                  command=(compatCommandNameRemapping parent.name name)
-                 includeRenamedProperties=true}}
+                 includeRenamedProperties=true
+                 deprecationMessage="This command has been removed"
+                 base="NSObject <NSCopying>"
+                 includeInitWithResponseValue=true}}
 {{/if}}
 {{/zcl_commands}}
 {{/zcl_clusters}}

diff --git a/src/darwin/Framework/CHIP/templates/availability.yaml b/src/darwin/Framework/CHIP/templates/availability.yaml
@@ -6331,6 +6331,13 @@
       commands:
           BasicInformation:
               - MfgSpecificPing
+      command fields:
+          # Cases where the cluster/command got renamed and the fields got
+          # renamed, so the old command name never had the new fields.
+          OtaSoftwareUpdateProvider:
+              QueryImage:
+                  - vendorID
+                  - productID
       enums:
           # DoorLockUserStatus (non-spec) and UserStatusEnum (from the spec) end
           # up with the same enum name (MTRDoorLockUserStatus), so just remove
@@ -7577,6 +7584,15 @@
 - release: "Future"
   versions: "future"
   introduced:
+      command payloads:
+          TimeSynchronization:
+              - SetUTCTime
+      command fields:
+          TimeSynchronization:
+              SetUTCTime:
+                  - utcTime
+                  - granularity
+                  - timeSource
       enum values:
           OnOff:
               DelayedAllOffEffectVariantEnum: