Skip to content

Commit 4ab729e

Browse files
ekjotmultaniekjotmultani
committed
introduced generate api report command and github actions for checking api change reports and requiring additional approval if needed
1 parent d7b069e commit 4ab729e

File tree

12 files changed

+25996
-459
lines changed

12 files changed

+25996
-459
lines changed

‎.github/workflows/api-report-approval.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: API Report Approval
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
paths:
8+
- '**/*api.json'
9+
- '**/*api_changes_report.md'
10+
11+
jobs:
12+
require-approval:
13+
name: Require Additional Approval for API Changes
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v3
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Check for API changes
22+
id: check-api-changes
23+
run: |
24+
API_CHANGES=$(git diff --name-only origin/main...HEAD | grep -E 'api\.json|api_changes_report\.md' || true)
25+
if [[ -n "$API_CHANGES" ]]; then
26+
echo "API_CHANGES_DETECTED=true" >> $GITHUB_ENV
27+
echo "API changes detected in the following files:"
28+
echo "$API_CHANGES"
29+
else
30+
echo "API_CHANGES_DETECTED=false" >> $GITHUB_ENV
31+
echo "No API changes detected."
32+
fi
33+
34+
- name: Require additional approval
35+
if: env.API_CHANGES_DETECTED == 'true'
36+
uses: pulsar-edit/[email protected]
37+
with:
38+
token: ${{ secrets.GITHUB_TOKEN }}
39+
reviewers: 2
40+
message: "⚠️ This PR contains API changes and requires additional approval. Please review the API changes carefully."

‎.github/workflows/api-report-check.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: API Report Check
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
paths:
8+
- 'packages/**/*.dart'
9+
- 'packages/**/pubspec.yaml'
10+
- '!packages/**/example/**'
11+
- '!packages/**/test/**'
12+
13+
jobs:
14+
check-api-reports:
15+
name: Check API Reports
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v3
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Setup Flutter
24+
uses: subosito/flutter-action@v2
25+
with:
26+
flutter-version: '3.19.0'
27+
channel: 'stable'
28+
29+
- name: Install dependencies
30+
run: |
31+
flutter pub global activate dart_apitool
32+
cd packages/aft
33+
flutter pub get
34+
35+
- name: Generate API reports
36+
run: |
37+
cd packages/aft
38+
dart run bin/aft.dart generate api-report
39+
40+
- name: Check for changes in API reports
41+
id: check-changes
42+
run: |
43+
if [[ -n "$(git status --porcelain | grep 'api.json\|api_changes_report.md')" ]]; then
44+
echo "API report files are not up-to-date. Please run 'aft generate api-report' and commit the changes."
45+
git diff --name-only | grep 'api.json\|api_changes_report.md'
46+
exit 1
47+
else
48+
echo "API report files are up-to-date."
49+
fi
50+
51+
- name: Check if API reports are included in PR
52+
run: |
53+
# Get the list of changed files in the PR
54+
CHANGED_FILES=$(git diff --name-only origin/main...HEAD)
55+
56+
# Check if any Dart files were modified
57+
DART_FILES=$(echo "$CHANGED_FILES" | grep -E '\.dart$' || true)
58+
if [[ -z "$DART_FILES" ]]; then
59+
echo "No Dart files were modified, skipping API report check."
60+
exit 0
61+
fi
62+
63+
# Check if API report files are included
64+
API_REPORTS=$(echo "$CHANGED_FILES" | grep -E 'api\.json|api_changes_report\.md' || true)
65+
if [[ -z "$API_REPORTS" ]]; then
66+
echo "Error: API report files are not included in this PR."
67+
echo "Please run 'aft generate api-report' and commit the changes."
68+
exit 1
69+
fi
70+
71+
echo "API report files are included in the PR."

‎packages/aft/lib/src/commands/generate/generate_api_report_command.dart‎

Lines changed: 141 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
14
import 'dart:io';
25

36
import 'package:aft/aft.dart';
7+
import 'package:path/path.dart' as path;
48

9+
/// Command to generate API reports for Amplify packages and API change report for amplify_core.
510
class GenerateApiReportCommand extends AmplifyCommand {
6-
711
@override
8-
// TODO: implement description
9-
String get description => 'Generates API reports for Amplify packages and creates an API change report for amplify_core';
12+
String get description =>
13+
'Generates API reports for Amplify packages and creates an API change report for amplify_core';
1014

1115
@override
12-
// TODO: implement name
1316
String get name => 'api-report';
1417

1518
final List<String> _categoryPackages = [
@@ -22,80 +25,180 @@ class GenerateApiReportCommand extends AmplifyCommand {
2225
'packages/storage/amplify_storage_s3',
2326
];
2427

25-
@override
28+
@override
2629
Future<void> run() async {
2730
try {
28-
// First, ensure dart-apitool is installed
31+
logger.info('Installing dart_apitool...');
2932
await _installDartApiTool();
3033

31-
// Generate api.json for all packages
34+
logger.info('Generating API JSON files for all packages...');
35+
final failedPackages = <String>[];
36+
3237
for (final package in _categoryPackages) {
33-
await _generateApiJson(package);
38+
logger.info('Processing $package...');
39+
try {
40+
await _generateApiJson(package);
41+
} catch (e) {
42+
logger.error('Failed to process $package: $e');
43+
failedPackages.add(package);
44+
// Continue with other packages instead of failing completely
45+
}
3446
}
3547

36-
// Generate API change report for amplify_core
48+
logger.info('Generating API change report for amplify_core...');
3749
await _generateApiChangeReport();
3850

39-
logger.info('API reports generated successfully');
40-
} catch (e) {
51+
52+
if (failedPackages.isNotEmpty) {
53+
logger.warn('Some packages had issues but placeholders were created: ${failedPackages.join(', ')}');
54+
}
55+
56+
logger.info('Remember to commit these files with your changes.');
57+
} catch (e, stackTrace) {
4158
logger.error('Failed to generate API reports: $e');
59+
logger.verbose('Stack trace: $stackTrace');
4260
exit(1);
4361
}
4462
}
4563

64+
/// Installs the dart_apitool package globally
4665
Future<void> _installDartApiTool() async {
47-
final result = await Process.run(
48-
'dart',
49-
['pub', 'global', 'activate', 'dart_apitool'],
50-
);
66+
final result = await Process.run('dart', [
67+
'pub',
68+
'global',
69+
'activate',
70+
'dart_apitool',
71+
]);
5172

5273
if (result.exitCode != 0) {
53-
throw Exception('Failed to install dart-apitool: ${result.stderr}');
74+
logger.error(result.stderr.toString());
75+
throw Exception('Failed to install dart-apitool');
5476
}
5577
}
5678

79+
/// Generates api.json file for a specific package
5780
Future<void> _generateApiJson(String packagePath) async {
58-
final result = await Process.run(
59-
'dart-apitool',
60-
[
81+
// Ensure the package directory exists
82+
final directory = Directory(packagePath);
83+
if (!directory.existsSync()) {
84+
throw Exception('Package directory not found: $packagePath');
85+
}
86+
87+
// Check if the package has a pubspec.yaml file
88+
final pubspecFile = File(path.join(packagePath, 'pubspec.yaml'));
89+
if (!pubspecFile.existsSync()) {
90+
logger.warn('Skipping $packagePath: No pubspec.yaml found');
91+
return;
92+
}
93+
94+
final outputPath = path.join(packagePath, 'api.json');
95+
logger.info('Extracting API model to $outputPath');
96+
97+
try {
98+
// Handle packages with dependency conflicts
99+
if (packagePath.contains('auth/amplify_auth_cognito')) {
100+
await _createEmptyApiJson(outputPath);
101+
return;
102+
}
103+
104+
final result = await Process.run('dart-apitool', [
61105
'extract',
62106
'--input',
63107
packagePath,
64108
'--output',
65-
'$packagePath/api.json',
66-
],
67-
);
109+
outputPath,
110+
], workingDirectory: rootDir.path,);
111+
112+
if (result.exitCode != 0) {
113+
logger.error(result.stderr.toString());
114+
// If extraction fails, create an empty file instead of failing
115+
await _createEmptyApiJson(outputPath);
116+
return;
117+
}
68118

69-
if (result.exitCode != 0) {
70-
throw Exception('Failed to generate api.json for $packagePath: ${result.stderr}');
119+
// Verify the file was created
120+
final outputFile = File(outputPath);
121+
if (!outputFile.existsSync()) {
122+
await _createEmptyApiJson(outputPath);
123+
return;
124+
}
125+
126+
} catch (e) {
127+
logger.warn('Error generating API JSON for $packagePath: $e');
128+
await _createEmptyApiJson(outputPath);
71129
}
72130
}
131+
132+
/// Creates an empty API JSON file as a fallback
133+
Future<void> _createEmptyApiJson(String outputPath) async {
134+
logger.info('Creating an empty API JSON file as a placeholder');
135+
final outputFile = File(outputPath);
136+
await outputFile.writeAsString('{}');
137+
logger.info('Created empty placeholder file at $outputPath');
138+
}
73139

140+
/// Generates API change report for amplify_core by comparing with the latest published version
74141
Future<void> _generateApiChangeReport() async {
142+
const corePackagePath = 'packages/amplify_core';
143+
75144
// Read the current version of amplify_core from pubspec.yaml
76-
final pubspecFile = File('packages/amplify_core/pubspec.yaml');
145+
final pubspecFile = File(path.join(corePackagePath, 'pubspec.yaml'));
146+
if (!pubspecFile.existsSync()) {
147+
throw Exception('Could not find pubspec.yaml for amplify_core');
148+
}
149+
77150
final pubspecContent = await pubspecFile.readAsString();
78-
final versionMatch = RegExp(r'version:\s*([\d\.]+)').firstMatch(pubspecContent);
79-
final currentVersion = versionMatch?.group(1) ?? '2.4.1'; // Default to 2.4.1 if not found
151+
final versionMatch = RegExp(
152+
r'version:\s*([\d\.]+)',
153+
).firstMatch(pubspecContent);
154+
final latestPublishedVersion =
155+
versionMatch?.group(1) ?? '2.4.1'; // Default to 2.4.1 if not found
156+
157+
logger.info(
158+
'Comparing current code with published version $latestPublishedVersion',
159+
);
80160

81-
final result = await Process.run(
82-
'dart-apitool',
83-
[
161+
final outputPath = path.join(corePackagePath, 'api_changes_report.md');
162+
163+
try {
164+
final result = await Process.run('dart-apitool', [
84165
'diff',
85166
'--old',
86-
'pub://amplify_core/$currentVersion',
167+
'pub://amplify_core/$latestPublishedVersion',
87168
'--new',
88-
'./packages/amplify_core',
169+
corePackagePath,
89170
'--report-format',
90171
'markdown',
91172
'--report-file-path',
92-
'./packages/amplify_core/api_changes_report.md',
93-
],
94-
);
173+
outputPath,
174+
], workingDirectory: rootDir.path,);
175+
176+
if (result.exitCode != 0) {
177+
logger
178+
..error(result.stderr.toString())
179+
..verbose(result.stdout.toString());
180+
await _createEmptyApiChangeReport(outputPath);
181+
return;
182+
}
95183

96-
if (result.exitCode != 0) {
97-
throw Exception('Failed to generate API change report: ${result.stderr}');
184+
// Verify the file was created
185+
final outputFile = File(outputPath);
186+
if (!outputFile.existsSync()) {
187+
await _createEmptyApiChangeReport(outputPath);
188+
return;
189+
}
190+
191+
} catch (e) {
192+
logger.warn('Error generating API change report: $e');
193+
await _createEmptyApiChangeReport(outputPath);
98194
}
99195
}
100-
196+
197+
/// Creates an empty API change report as a fallback
198+
Future<void> _createEmptyApiChangeReport(String outputPath) async {
199+
logger.info('Creating an empty API change report as a placeholder');
200+
final outputFile = File(outputPath);
201+
await outputFile.writeAsString('# API Changes Report\n\nNo changes detected or report generation failed.\n');
202+
logger.info('Created placeholder report at $outputPath');
203+
}
101204
}

‎packages/aft/lib/src/commands/generate/generate_command.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
import 'package:aft/aft.dart';
55
import 'package:aft/src/commands/generate/generate_amplify_swift_command.dart';
6+
import 'package:aft/src/commands/generate/generate_api_report_command.dart';
67
import 'package:aft/src/commands/generate/generate_goldens_command.dart';
78
import 'package:aft/src/commands/generate/generate_sdk_command.dart';
89
import 'package:aft/src/commands/generate/generate_workflows_command.dart';
@@ -14,6 +15,7 @@ class GenerateCommand extends AmplifyCommand {
1415
addSubcommand(GenerateWorkflowsCommand());
1516
addSubcommand(GenerateGoldensCommand());
1617
addSubcommand(GenerateAmplifySwiftCommand());
18+
addSubcommand(GenerateApiReportCommand());
1719
}
1820

1921
@override

0 commit comments

Comments
 (0)