Skip to content

Commit dc4ddc3

Browse files
[UTS] Add some exclusions to private API reporting
These are APIs that for the purposes of the unified test suite we can not consider as private for the time being (so as to not clutter up the private API reporting data).
1 parent e2109c0 commit dc4ddc3

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

scripts/processPrivateApiData/exclusions.ts

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,25 @@ type ExclusionRule = {
66
helper?: string;
77
};
88

9-
/**
10-
* This exclusions mechanism is not currently being used on `main`, but I will use it on a separate unified test suite branch in order to exclude some private API usage that can currently be disregarded in the context of the unified test suite.
11-
*/
129
export function applyingExclusions(usageDtos: PrivateApiUsageDto[]) {
13-
const exclusionRules: ExclusionRule[] = [];
10+
const exclusionRules: ExclusionRule[] = [
11+
// This is all helper stuff that we could pull into the test suite, and which for now we could just continue using the version privately exposed by ably-js, even in the UTS.
12+
{ privateAPIIdentifier: 'call.BufferUtils.areBuffersEqual' },
13+
{ privateAPIIdentifier: 'call.BufferUtils.base64Decode' },
14+
{ privateAPIIdentifier: 'call.BufferUtils.base64Encode' },
15+
{ privateAPIIdentifier: 'call.BufferUtils.hexEncode' },
16+
{ privateAPIIdentifier: 'call.BufferUtils.isBuffer' },
17+
{ privateAPIIdentifier: 'call.BufferUtils.toArrayBuffer' },
18+
{ privateAPIIdentifier: 'call.BufferUtils.utf8Encode' },
19+
{ privateAPIIdentifier: 'call.Utils.copy' },
20+
{ privateAPIIdentifier: 'call.Utils.inspectError' },
21+
{ privateAPIIdentifier: 'call.Utils.keysArray' },
22+
{ privateAPIIdentifier: 'call.Utils.mixin' },
23+
{ privateAPIIdentifier: 'call.Utils.toQueryString' },
24+
{ privateAPIIdentifier: 'call.msgpack.decode' },
25+
{ privateAPIIdentifier: 'call.msgpack.encode' },
26+
{ privateAPIIdentifier: 'call.http.doUri', helper: 'getJWT' },
27+
];
1428

1529
return usageDtos.filter(
1630
(usageDto) =>

0 commit comments

Comments
 (0)