proto-processing-lib is a library that provides utility functionality for proto field scrubbing.
The field mask implementation in this library currently has some minor inconsistencies with the AIP-161 specification, particularly around resource update behavior. While the current functionality is robust for most use cases, please be aware of this nuance when working with field masks in your applications.
Proto Processing Library's Field Mask Implementation: Differences from AIP-161 Standard
Proto Processing Library's implementation of field masks diverges from the AIP-161 standard in the following key ways. This table summarizes the similarities/differences:
| Feature | AIP-161 (Standard) | Library Implementation |
|---|---|---|
| Repeated fields | Restricted except at path end | No restriction, allowed on non-leaf nodes |
| Map keys | String or integer | String (escaped) |
| Wildcards | Supported for repeated fields/maps | Supported |
| Struct traversal | Supported using '.' | Supported |
| Map traversal | Supported using '.', keys: string/int | Supported (string/int keys), '.' insertion not supported |
| Validation | Ignore invalid reads, error on writes | Error on invalid field names |
| Update behavior | Read after masked update returns same | Not supported |
| Intersection | Not explicitly mentioned | Supported, returns intersection of two FieldMask trees |