Skip to content

Commit f8acaf2

Browse files
ekjotmultaniekjotmultani
authored
chore(firehose): firehose client followup (#6905)
* fix: address PR #6845 review comments - Add @VisibleForTesting to RecordClient.storage getter (#9) - Replace partitionKey! with StateError in KinesisSender (#2) - Mark amplify_record_cache_dart as @internal (#10) - Add LICENSE and README to amplify_record_cache_dart (#11) - Make partitionKey column nullable in Drift schema (#13) - Regenerate .g.dart for nullable partitionKey * docs: add error handling documentation to RecordClient.flush * fix: remove @internal annotation that blocks cross-package imports The @internal annotation prevents other packages in the monorepo from importing amplify_record_cache_dart. The publish_to: none in pubspec.yaml is sufficient to mark it as internal — it prevents pub.dev publication without restricting monorepo-internal usage. * fix: use readNullable for partitionKey in SqliteRecordStorage After making the partitionKey column nullable in the Drift schema, the read path was still using row.read<String> which throws when the value is null. Changed to row.readNullable<String> to handle null partitionKey values (used by Firehose which has no partition key). * chore: make amplify_record_cache_dart publishable Remove publish_to: none and add standard pub.dev metadata (homepage, repository, issue_tracker) so the package can be published as an internal dependency — same pattern as aws_common and amplify_db_common_dart.
1 parent ebd1bf8 commit f8acaf2

9 files changed

Lines changed: 243 additions & 32 deletions

File tree

‎packages/kinesis/amplify_kinesis_dart/lib/src/impl/kinesis_sender.dart‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ class KinesisSender implements Sender {
3333
);
3434
}
3535

36-
final requestEntries = records
37-
.map(
38-
(record) => PutRecordsRequestEntry(
39-
data: record.data,
40-
partitionKey: record.partitionKey!,
41-
),
42-
)
43-
.toList();
36+
final requestEntries = records.map((record) {
37+
final pk = record.partitionKey;
38+
if (pk == null) {
39+
throw StateError(
40+
'KinesisSender requires a non-null partitionKey for every '
41+
'record, but record ${record.id} has a null partitionKey.',
42+
);
43+
}
44+
return PutRecordsRequestEntry(data: record.data, partitionKey: pk);
45+
}).toList();
4446

4547
final request = PutRecordsRequest(
4648
streamName: streamName,

‎packages/kinesis/amplify_record_cache_dart/LICENSE‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.

‎packages/kinesis/amplify_record_cache_dart/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# amplify_record_cache_dart
2+
3+
Shared record caching infrastructure for Amplify streaming clients (Kinesis Data Streams, Firehose).
4+
5+
This package is internal to the Amplify Flutter monorepo and is not published to pub.dev.

‎packages/kinesis/amplify_record_cache_dart/lib/amplify_record_cache_dart.dart‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
// SPDX-License-Identifier: Apache-2.0
33

44
/// Shared record caching infrastructure for Amplify streaming clients.
5+
///
6+
/// This package is internal to the Amplify Flutter monorepo and is not
7+
/// intended for direct use by customers.
58
library;
69

710
// Client

‎packages/kinesis/amplify_record_cache_dart/lib/src/client/record_client.dart‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import 'package:amplify_record_cache_dart/src/model/record_data.dart';
88
import 'package:amplify_record_cache_dart/src/model/record_input.dart';
99
import 'package:amplify_record_cache_dart/src/sender/sender.dart';
1010
import 'package:amplify_record_cache_dart/src/storage/record_storage.dart';
11+
import 'package:meta/meta.dart';
1112
import 'package:smithy/smithy.dart'
1213
show SmithyHttpException, UnknownSmithyHttpException;
1314

@@ -37,6 +38,7 @@ class RecordClient {
3738
bool _flushing = false;
3839

3940
/// Provides access to the underlying storage (for testing).
41+
@visibleForTesting
4042
RecordStorage get storage => _storage;
4143

4244
/// Records data to the local cache.
@@ -55,6 +57,25 @@ class RecordClient {
5557
/// Single-pass: retrieves one batch of records per stream, sends each
5658
/// batch, and returns. Records beyond the per-stream limit are picked
5759
/// up in the next flush cycle.
60+
///
61+
/// ## Error handling
62+
///
63+
/// When `Sender.sendBatch` (e.g. `PutRecordBatch` / `PutRecords`)
64+
/// succeeds at the HTTP level, the response may contain per-record
65+
/// errors. These are categorized by [splitResults]:
66+
/// - Successful records are deleted from the cache.
67+
/// - Retryable records (retry count < maxRetries) have their retry
68+
/// count incremented and remain in the cache for the next flush.
69+
/// - Failed records (retry count >= maxRetries) are deleted.
70+
///
71+
/// When the entire SDK call fails with a [SmithyHttpException]
72+
/// (e.g. throttling, invalid stream, auth error), the error is
73+
/// logged and that stream is skipped — other streams can still
74+
/// flush. All records in the failed batch have their retry count
75+
/// incremented (or are deleted if they've exceeded maxRetries).
76+
///
77+
/// Non-SDK errors (e.g. network failure, storage error) abort the
78+
/// flush entirely and are rethrown to the caller.
5879
Future<FlushData> flush() async {
5980
if (_flushing) return const FlushData(flushInProgress: true);
6081
_flushing = true;

‎packages/kinesis/amplify_record_cache_dart/lib/src/db/record_cache_database.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ class KinesisRecords extends Table {
2323
/// The name of the target stream.
2424
TextColumn get streamName => text()();
2525

26-
/// The partition key (empty string for services that don't use it).
27-
TextColumn get partitionKey => text().withDefault(const Constant(''))();
26+
/// The partition key (null for services that don't use it, e.g. Firehose).
27+
TextColumn get partitionKey => text().nullable()();
2828

2929
/// The data blob to send.
3030
BlobColumn get data => blob()();

0 commit comments

Comments
 (0)