Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make project_metadata mandatory in scan_request #316

Closed
wants to merge 5 commits into from
Closed

Make project_metadata mandatory in scan_request #316

wants to merge 5 commits into from

Conversation

aryx
Copy link
Collaborator

@aryx aryx commented Nov 26, 2024 •
edited
Loading

Step1 towards getting rid of meta.

test plan:
see related PR in semgrep-pro

@aryx
Make project_metadata mandatory in scan_request
e574692 
Step1 towards getting rid of meta.

test plan:
see related PR in semgrep-pro
@aryx aryx requested review from a team, IagoAbal and chmccreery and removed request for a team and IagoAbal November 26, 2024 18:20
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 26, 2024 •
edited
Loading

Backwards compatibility summary:

Checking backward compatibility of semgrep_output_v1.atd against past version v1.49.0
--- before.txt
+++ after.txt
@@ -13,6 +13,16 @@
 The following types are affected:
   fix_regex
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.49.0
Skipping v1.50.0 because commit 857682f41eb09e0b330a247ff1adf3bfeaf9d9ca has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.52.0
--- before.txt
+++ after.txt
@@ -8,6 +8,16 @@
   core_output
   matching_explanation
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.52.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.53.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.53.0
Skipping v1.54.0 because commit 3b72d494260258497e796d094b1a4916501a6df1 has already been checked
Skipping v1.54.1 because commit 3b72d494260258497e796d094b1a4916501a6df1 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.54.2
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.54.2
Skipping v1.54.3 because commit 9f1c50383a9a9969e2fe7a5f9bff9ca0a7c837bb has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.55.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.55.0
Skipping v1.55.1 because commit 6dffeaa692153fd33b4f154fddaefde1f2f1ae27 has already been checked
Skipping v1.55.2 because commit 6dffeaa692153fd33b4f154fddaefde1f2f1ae27 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.56.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.56.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.57.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.57.0
Skipping v1.58.0 because commit 4cc11b00d411c02fc611aa8c78a336520438fb48 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.59.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.59.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.59.1
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.59.1
Checking backward compatibility of semgrep_output_v1.atd against past version v1.60.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.60.0
Skipping v1.60.1 because commit eed58a091fd7d19e402a6d4cf2d287e137215d03 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.61.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.61.0
Skipping v1.61.1 because commit bbfd1c5b91bd411bceffc3de73f5f0b37f04433d has already been checked
Skipping v1.62.0 because commit bbfd1c5b91bd411bceffc3de73f5f0b37f04433d has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.63.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.63.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.64.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.64.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.65.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.65.0
Skipping v1.66.0 because commit 3e7bbafa2b7e722d893303a7fb90a83dab6737a7 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.66.1
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.66.1
Skipping v1.66.2 because commit 215a54782174de84f97188632b4a37e35ba0f827 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.67.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.67.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.68.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.68.0
Skipping v1.69.0 because commit d5b91fa4f6a03240db31e9bbbc5376a99bc8eeea has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.70.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.70.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.71.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.71.0
Skipping v1.72.0 because commit 75abf193687b84ab341d8267d865ad68d81a89c9 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.73.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.73.0
Skipping v1.74.0 because commit 9f38254957c50c68ea402eebae0f7aa40dd01cbf has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.75.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.75.0
Skipping v1.76.0 because commit 9102031608aa4154e1c37f557550ec4eabc8780c has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.77.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.77.0
Skipping v1.78.0 because commit dcb5d77b420ddee61f58aadd3c2c7aef38778154 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.79.0
--- before.txt
+++ after.txt
@@ -5,6 +5,16 @@
   tests_result
   todo
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.79.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.80.0
--- before.txt
+++ after.txt
@@ -1,3 +1,13 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.80.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.81.0
--- before.txt
+++ after.txt
@@ -1,3 +1,13 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.81.0
Skipping v1.82.0 because commit 9e0f3bec26b07b4fb6753a32cb75277f45f2572c has already been checked
Skipping v1.83.0 because commit 9e0f3bec26b07b4fb6753a32cb75277f45f2572c has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.84.0
--- before.txt
+++ after.txt
@@ -1,7 +1,17 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.84.0
Skipping v1.84.1 because commit 3daef49297ada205359cc1d2996354c94b628b0d has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.85.0
--- before.txt
+++ after.txt
@@ -1,7 +1,17 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.85.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.86.0
--- before.txt
+++ after.txt
@@ -1,7 +1,17 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.86.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.87.0
--- before.txt
+++ after.txt
@@ -1,7 +1,17 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [3cb750d6] Backward incompatibility:
 Formerly optional field 'version' is now required.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.87.0
Skipping v1.88.0 because commit 512c0bd97db59c48a5705b2741662a338776e438 has already been checked
Skipping v1.89.0 because commit 512c0bd97db59c48a5705b2741662a338776e438 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.90.0
--- before.txt
+++ after.txt
@@ -12,10 +12,20 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.90.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.91.0
--- before.txt
+++ after.txt
@@ -12,10 +12,20 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.91.0
Skipping v1.92.0 because commit 2351c5e528cb7430422208dc66707894c066b508 has already been checked
Checking backward compatibility of semgrep_output_v1.atd against past version v1.93.0
--- before.txt
+++ after.txt
@@ -12,10 +12,20 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.93.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.94.0
--- before.txt
+++ after.txt
@@ -12,10 +12,20 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.94.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.95.0
--- before.txt
+++ after.txt
@@ -12,10 +12,20 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [346efceb] Incompatibility in both directions:
 Incompatible tuple lengths
 The following types are affected:
   function_call
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
 
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
ERROR: semgrep_output_v1.atd is not backward compatible with v1.95.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.96.0
--- before.txt
+++ after.txt
@@ -12,6 +12,16 @@
   function_return
   resolution_result
 
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
 [385fcd66] Incompatibility in both directions:
 Incompatible kinds of types: sum type or enum is now a list/array.
 The following types are affected:
ERROR: semgrep_output_v1.atd is not backward compatible with v1.96.0
Checking backward compatibility of semgrep_output_v1.atd against past version v1.97.0
--- before.txt
+++ after.txt
@@ -0,0 +1,10 @@
+[30f71484] Backward incompatibility:
+Formerly optional field 'scan_metadata' is now required.
+The following types are affected:
+  scan_request
+
+[347e962d] Backward incompatibility:
+Formerly optional field 'project_metadata' is now required.
+The following types are affected:
+  scan_request
+
ERROR: semgrep_output_v1.atd is not backward compatible with v1.97.0

@chmccreery
Copy link
Contributor

For example, the Semgrep backend need to still be able to consume data generated
by Semgrep 1.17.0.

Probably time to update this text to say 1.50.0 😄

chmccreery
chmccreery reviewed Nov 27, 2024
View reviewed changes
semgrep_output_v1.atd Outdated
Comment on lines 1447 to 1450
project_metadata: project_metadata; (* replacing meta *)
project_config: ci_config_from_repo;
scan_metadata: scan_metadata;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll let you know when it's safe to roll this out. Not yet.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've put back project_config as an option. There might not be a .semgrepconfig.yml in the repo so I think it's more logical to have an option here.

@aryx
Copy link
Collaborator Author

aryx commented Nov 27, 2024

Note that the backward compatiblity failures are expected. We are breaking backward compatibility on purpose.
We're supporting only versions since 1.50.0 and we know we've been producing those fields since that version for sure (we in fact started in 1.43.0 so we're good).

aryx added a commit that referenced this pull request Dec 4, 2024
@aryx
Make project_metadata mandatory in scan_request (try 2)
4943191 
try2 of #316

Step1 towards getting rid of meta.

test plan:
see related PR in semgrep-pro
@aryx aryx mentioned this pull request Dec 4, 2024
Merged
2 tasks
@aryx
Copy link
Collaborator Author

aryx commented Dec 4, 2024

new version in #324

@aryx aryx closed this Dec 4, 2024
aryx added a commit that referenced this pull request Dec 9, 2024
@aryx @chmccreery
Make project_metadata mandatory in scan_request (try 2) (#324)
1de5ce7 
try2 of #316

Step1 towards getting rid of meta.

test plan:
see related PR in semgrep-pro


- [x] I ran `make setup && make` to update the generated code after
editing a `.atd` file (TODO: have a CI check)
- [x] I made sure we're still backward compatible with old versions of
the CLI.
For example, the Semgrep backend need to still be able to *consume* data
	  generated by Semgrep 1.50.0.
See
https://atd.readthedocs.io/en/latest/atdgen-tutorial.html#smooth-protocol-upgrades
	  Note that the types related to the semgrep-core JSON output or the
	  semgrep-core RPC do not need to be backward compatible!

---------

Co-authored-by: Clara McCreery <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chmccreery chmccreery chmccreery approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aryx @chmccreery