Compare commits

..
55 changed files with 814 additions and 2140 deletions

No files matched your search

+2 -11
View File
@@ -8,20 +8,11 @@ This is the log of notable changes to EAS CLI and related packages.
### 🎉 New features
- Show bundler output by default for eas update command. ([#1171](https://github.com/expo/eas-cli/pull/1171) by [@kgc00](https://github.com/kgc00/))
- Allow users to skip metadata validation. ([#1175](https://github.com/expo/eas-cli/pull/1175) by [@byCedric](https://github.com/byCedric))
- Add experimental `--resource-class` flag for Build commands. ([#1138](https://github.com/expo/eas-cli/pull/1138) by [@christopherwalter](https://github.com/christopherwalter))
- Truncate long messages for `eas update` command, rather than failing. ([#1178](https://github.com/expo/eas-cli/pull/1178) by [@kgc00](https://github.com/kgc00))
- Add review details to metadata store configuration. ([#1184](https://github.com/expo/eas-cli/pull/1184) by [@byCedric](https://github.com/byCedric))
### 🐛 Bug fixes
- Fix submission archive URLs. ([#1179](https://github.com/expo/eas-cli/pull/1179) by [@dsokal](https://github.com/dsokal))
### 🧹 Chores
- Update validation rules for metadata info locales. ([#1174](https://github.com/expo/eas-cli/pull/1174) by [@byCedric](https://github.com/byCedric))
- Improve store configuration defaults and schema documentation. ([#1183](https://github.com/expo/eas-cli/pull/1183) by [@byCedric](https://github.com/byCedric))
- Refactor metadata telemetry to handle errors better. ([#1169](https://github.com/expo/eas-cli/pull/1169) by [@byCedric](https://github.com/byCedric))
## [0.54.1](https://github.com/expo/eas-cli/releases/tag/v0.54.1) - 2022-06-15
@@ -32,7 +23,6 @@ This is the log of notable changes to EAS CLI and related packages.
### 🐛 Bug fixes
- Surface ASC errors in metadata for normal API rejections. ([#1167](https://github.com/expo/eas-cli/pull/1167) by [@byCedric](https://github.com/byCedric))
- Add metadata schema to bundled eas-cli package. ([#1166](https://github.com/expo/eas-cli/pull/1166) by [@byCedric](https://github.com/byCedric))
## [0.54.0](https://github.com/expo/eas-cli/releases/tag/v0.54.0) - 2022-06-15
@@ -49,6 +39,7 @@ This is the log of notable changes to EAS CLI and related packages.
- Improved support for working on branches with many updates. ([#1144](https://github.com/expo/eas-cli/pull/1144), [#1148](https://github.com/expo/eas-cli/pull/1148) by [@kgc00](https://github.com/kgc00/))
- `eas update` project links no longer contain a `)` on unsupported terminals. ([#1152](https://github.com/expo/eas-cli/pull/1152) by [@kgc00](https://github.com/kgc00/))
- Add metadata schema to bundled eas-cli package. ([#1166](https://github.com/expo/eas-cli/pull/1166) by [@byCedric](https://github.com/byCedric))
### 🧹 Chores
-1
View File
@@ -6,7 +6,6 @@ packages/eas-cli/src/commands/build @dsokal @wkozyra95
packages/eas-cli/src/submit @barthap @dsokal
packages/eas-cli/src/commands/submit.ts @barthap @dsokal
packages/eas-cli/schema @bycedric
packages/eas-cli/src/metadata @bycedric
packages/eas-cli/src/commands/metadata @bycedric
+1 -127
View File
@@ -10209,7 +10209,7 @@
"args": [
{
"name": "assetContentTypes",
"description": "max 1400",
"description": "max 600",
"type": {
"kind": "NON_NULL",
"name": null,
@@ -10763,22 +10763,6 @@
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maxBuildTimeSeconds",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metrics",
"description": null,
@@ -10899,18 +10883,6 @@
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "resourceClass",
"description": null,
"args": [],
"type": {
"kind": "ENUM",
"name": "BuildResourceClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "runtimeVersion",
"description": null,
@@ -12308,18 +12280,6 @@
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "buildParams",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "BuildParamsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "job",
"description": null,
@@ -12381,18 +12341,6 @@
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "buildParams",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "BuildParamsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "job",
"description": null,
@@ -12544,33 +12492,6 @@
}
]
},
{
"kind": "INPUT_OBJECT",
"name": "BuildParamsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "resourceClass",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "BuildResourceClass",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BuildPriority",
@@ -12590,12 +12511,6 @@
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NORMAL_PLUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
@@ -12953,47 +12868,6 @@
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BuildResourceClass",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ANDROID_DEFAULT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ANDROID_LARGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IOS_DEFAULT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IOS_LARGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LEGACY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "BuildStatus",
+212 -295
View File
@@ -19,18 +19,10 @@
]
},
"AppleKidsAge": {
"enum": [
"FIVE_AND_UNDER",
"SIX_TO_EIGHT",
"NINE_TO_ELEVEN"
]
"enum": ["FIVE_AND_UNDER", "SIX_TO_EIGHT", "NINE_TO_ELEVEN"]
},
"AppleRating": {
"enum": [
"NONE",
"INFREQUENT_OR_MILD",
"FREQUENT_OR_INTENSE"
]
"enum": ["NONE", "INFREQUENT_OR_MILD", "FREQUENT_OR_INTENSE"]
},
"AppleCategory": {
"enum": [
@@ -102,15 +94,15 @@
"type": "object",
"additionalProperties": false,
"defaultSnippets": [
{
"body": {
"servesAds": false,
"attributesAppInstallationToPreviousAd": false,
"attributesActionWithPreviousAd": false,
"honorsLimitedAdTracking": false
{
"body": {
"servesAds": false,
"attributesAppInstallationToPreviousAd": false,
"attributesActionWithPreviousAd": false,
"honorsLimitedAdTracking": false
}
}
}
],
],
"properties": {
"servesAds": {
"type": "boolean"
@@ -131,278 +123,240 @@
"additionalProperties": false,
"required": [
"title",
"subtitle",
"description",
"keywords",
"marketingUrl",
"supportUrl",
"privacyPolicyUrl"
],
"defaultSnippets": [
{
"label": "Basic",
"description": "Create the minimum required locale properties",
"body": {
"title": "${1:App title}",
"privacyPolicyUrl": "https://${3:www.}"
}
},
{
"label": "Full",
"description": "Create all available locale properties",
"label": "Interactive",
"description": "Creates localized app info",
"body": {
"title": "${1:App title}",
"subtitle": "${2:Subtitle for your app}",
"description": "${3:A longer description of what your app does}",
"keywords": [
"${4:keyword}"
],
"releaseNotes": "${5:Bug fixes and improved stability}",
"promoText": "${6:Short tagline for your app}",
"marketingUrl": "https://${7:www.}",
"supportUrl": "https://${8:www.}",
"privacyPolicyUrl": "https://${9:www.}",
"privacyChoicesUrl": "https://${10:www.}"
"title": "$1",
"subtitle": "$2",
"description": "$3",
"keywords": [],
"marketingUrl": "",
"supportUrl": "",
"privacyPolicyUrl": ""
}
}
],
"properties": {
"title": {
"type": "string",
"description": "Name of the app in the store. This should be similar to the installed app name.",
"minLength": 2,
"type": "string",
"maxLength": 30,
"meta": {
"storeInfo": "The name will be reviewed before it is made available on the App Store."
}
},
"subtitle": {
"type": "string",
"description": "Subtext for the app. Example: 'A Fun Game For Friends'",
"type": "string",
"maxLength": 30,
"meta": {
"storeInfo": "The subtitle will be reviewed before it is made available on the App Store."
}
},
"description": {
"type": "string",
"description": "Main description of what the app does",
"minLength": 10,
"maxLength": 4000,
"meta": {
"versioned": true,
"liveEdits": true
}
},
"keywords": {
"type": "array",
"description": "List of keywords to help users find the app in the App Store",
"uniqueItems": true,
"items": {
"maxLength": 100,
"type": "string"
},
"meta": {
"versioned": true
}
},
"releaseNotes": {
"type": "string",
"description": "Changes since the last public version",
"maxLength": 4000,
"meta": {
"versioned": true,
"liveEdits": true
}
"description": "Main description of what the app does",
"type": "string"
},
"promoText": {
"type": "string",
"description": "Short tagline for the app",
"maxLength": 170,
"meta": {
"versioned": true,
"liveEdits": true,
"aso": false
}
},
"maxLength": 170,
"description": "Short tagline for the app",
"type": "string"
},
"marketingUrl": {
"type": "string",
"description": "URL to the app marketing page",
"maxLength": 255,
"keywords": {
"meta": {
"versioned": true,
"liveEdits": true
}
},
"supportUrl": {
"type": "string",
"description": "URL to the app support page",
"maxLength": 255,
"meta": {
"versioned": true,
"liveEdits": true
"versioned": true
},
"description": "List of keywords to help users find the app in the App Store",
"type": "array",
"uniqueItems": true,
"items": {
"maxLength": 100,
"type": "string"
}
},
"privacyPolicyText": {
"type": "string",
"description": "Privacy policy for Apple TV"
},
"privacyPolicyUrl": {
"type": "string",
"description": "A URL that links to your privacy policy. A privacy policy is required for all apps.",
"maxLength": 255,
"whatsNew": {
"meta": {
"versioned": true,
"liveEdits": true
}
},
"maxLength": 4000,
"description": "Changes since the last public version",
"type": "string"
},
"marketingUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"description": "URL to the app marketing page",
"type": "string"
},
"supportUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"description": "URL to the app support page",
"type": "string"
},
"privacyPolicyUrl": {
"meta": {
"versioned": true,
"liveEdits": true
},
"maxLength": 255,
"description": "A URL that links to your privacy policy. A privacy policy is required for all apps.",
"type": "string"
},
"privacyChoicesUrl": {
"type": "string",
"description": "A URL where users can modify and delete the data collected from the app, or decide how their data is used and shared.",
"maxLength": 255,
"meta": {
"versioned": true,
"liveEdits": true,
"optional": true
}
},
"maxLength": 255,
"description": "A URL where users can modify and delete the data collected from the app, or decide how their data is used and shared.",
"type": "string"
}
}
},
"AppleAdvisory": {
"type": "object",
"additionalProperties": false,
"required": [
"alcoholTobaccoOrDrugUseOrReferences",
"contests",
"gamblingSimulated",
"horrorOrFearThemes",
"matureOrSuggestiveThemes",
"medicalOrTreatmentInformation",
"profanityOrCrudeHumor",
"sexualContentGraphicAndNudity",
"sexualContentOrNudity",
"violenceCartoonOrFantasy",
"violenceRealistic",
"violenceRealisticProlongedGraphicOrSadistic",
"gambling",
"unrestrictedWebAccess",
"kidsAgeBand",
"seventeenPlus"
],
"defaultSnippets": [
{
"label": "Basic",
"description": "Create an advisory that disables all age-rated properties, for when your app does nothing",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "NONE",
"contests": "NONE",
"gamblingSimulated": "NONE",
"horrorOrFearThemes": "NONE",
"matureOrSuggestiveThemes": "NONE",
"medicalOrTreatmentInformation": "NONE",
"profanityOrCrudeHumor": "NONE",
"sexualContentGraphicAndNudity": "NONE",
"sexualContentOrNudity": "NONE",
"violenceCartoonOrFantasy": "NONE",
"violenceRealistic": "NONE",
"violenceRealisticProlongedGraphicOrSadistic": "NONE",
"gambling": false,
"unrestrictedWebAccess": false,
"kidsAgeBand": null,
"seventeenPlus": false
{
"label": "Minimum",
"description": "The bare minimum rating, your app does nothing",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "NONE",
"contests": "NONE",
"gamblingSimulated": "NONE",
"medicalOrTreatmentInformation": "NONE",
"profanityOrCrudeHumor": "NONE",
"sexualContentGraphicAndNudity": "NONE",
"sexualContentOrNudity": "NONE",
"horrorOrFearThemes": "NONE",
"matureOrSuggestiveThemes": "NONE",
"violenceCartoonOrFantasy": "NONE",
"violenceRealisticProlongedGraphicOrSadistic": "NONE",
"violenceRealistic": "NONE",
"gamblingAndContests":false,
"gambling": false,
"kidsAgeBand": null,
"seventeenPlus": false,
"unrestrictedWebAccess": false
}
},
{
"label": "Interactive",
"description": "Step through options",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "${1|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"contests": "${2|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"gamblingSimulated": "${3|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"medicalOrTreatmentInformation": "${4|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"profanityOrCrudeHumor": "${5|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentGraphicAndNudity": "${6|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentOrNudity": "${7|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"horrorOrFearThemes": "${8|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"matureOrSuggestiveThemes": "${9|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceCartoonOrFantasy": "${10|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealisticProlongedGraphicOrSadistic": "${11|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealistic": "${12|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"gamblingAndContests":false,
"gambling": false,
"kidsAgeBand": null,
"seventeenPlus": false,
"unrestrictedWebAccess": false
}
}
},
{
"label": "Full",
"description": "Create an advisory that enables some of the age-rated properties",
"body": {
"alcoholTobaccoOrDrugUseOrReferences": "${1|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"contests": "${2|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"gamblingSimulated": "${3|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"horrorOrFearThemes": "${4|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"matureOrSuggestiveThemes": "${5|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"medicalOrTreatmentInformation": "${6|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"profanityOrCrudeHumor": "${7|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentGraphicAndNudity": "${8|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"sexualContentOrNudity": "${9|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceCartoonOrFantasy": "${10|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealistic": "${11|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"violenceRealisticProlongedGraphicOrSadistic": "${12|NONE,INFREQUENT_OR_MILD,FREQUENT_OR_INTENSE|}",
"unrestrictedWebAccess": false,
"gambling": false,
"kidsAgeBand": null,
"seventeenPlus": false
}
}
],
],
"properties": {
"alcoholTobaccoOrDrugUseOrReferences": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain alcohol, tobacco, or drug use or references?"
"$ref": "#/definitions/apple/AppleRating"
},
"contests": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain contests?"
"$ref": "#/definitions/apple/AppleRating"
},
"gamblingSimulated": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain simulated gambling?"
},
"medicalOrTreatmentInformation": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain medical or treatment information?"
},
"profanityOrCrudeHumor": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain profanity or crude humor?"
},
"sexualContentGraphicAndNudity": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain graphic sexual content and nudity?"
},
"sexualContentOrNudity": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain sexual content or nudity?"
},
"horrorOrFearThemes": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain horror or fear themes?"
},
"matureOrSuggestiveThemes": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain mature or suggestive themes?"
},
"violenceCartoonOrFantasy": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain cartoon or fantasy violence?"
},
"violenceRealisticProlongedGraphicOrSadistic": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain prolonged graphic or sadistic realistic violence?"
},
"violenceRealistic": {
"$ref": "#/definitions/apple/AppleRating",
"description": "Does the app contain realistic violence?"
},
"unrestrictedWebAccess": {
"type": "boolean",
"description": "Does your app contain unrestricted web access, such as with an embedded browser?"
"gamblingAndContests": {
"type": "boolean"
},
"gambling": {
"type": "boolean",
"description": "Does your app contain gambling?"
"type": "boolean"
},
"gamblingSimulated": {
"$ref": "#/definitions/apple/AppleRating"
},
"kidsAgeBand": {
"oneOf": [
{
"type": "null"
},
"anyOf": [
{
"$ref": "#/definitions/apple/AppleKidsAge"
},
{
"type": "null"
}
],
"description": "When parents visit the Kids category on the App Store, they expect the apps they find will protect their children’s data, provide only age-appropriate content, and require a parental gate in order to link out of the app, request permissions, or present purchasing opportunities. It’s critical that no personally identifiable information or device information be transmitted to third parties, and that advertisements are human-reviewed for age appropriateness in order to be displayed.\n@see https://developer.apple.com/news/?id=091202019a",
"markdownDescription": "When parents visit the Kids category on the App Store, they expect the apps they find will protect their children’s data, provide only age-appropriate content, and require a parental gate in order to link out of the app, request permissions, or present purchasing opportunities. It’s critical that no personally identifiable information or device information be transmitted to third parties, and that advertisements are human-reviewed for age appropriateness in order to be displayed.\n\n[Learn more](https://developer.apple.com/news/?id=091202019a)"
]
},
"medicalOrTreatmentInformation": {
"$ref": "#/definitions/apple/AppleRating"
},
"profanityOrCrudeHumor": {
"$ref": "#/definitions/apple/AppleRating"
},
"sexualContentGraphicAndNudity": {
"$ref": "#/definitions/apple/AppleRating"
},
"sexualContentOrNudity": {
"$ref": "#/definitions/apple/AppleRating"
},
"seventeenPlus": {
"type": "boolean",
"description": "If your app rates 12+ or lower, and you believe its content may not be suitable for children under 17, you can manually set the age rating to 17+.\n@see https://help.apple.com/app-store-connect/#/dev599d50efb",
"markdownDescription": "If your app rates 12+ or lower, and you believe its content may not be suitable for children under 17, you can manually set the age rating to 17+.\n\n[Learn more](https://help.apple.com/app-store-connect/#/dev599d50efb)"
"type": "boolean"
},
"horrorOrFearThemes": {
"$ref": "#/definitions/apple/AppleRating"
},
"matureOrSuggestiveThemes": {
"$ref": "#/definitions/apple/AppleRating"
},
"unrestrictedWebAccess": {
"type": "boolean"
},
"violenceCartoonOrFantasy": {
"$ref": "#/definitions/apple/AppleRating"
},
"violenceRealisticProlongedGraphicOrSadistic": {
"$ref": "#/definitions/apple/AppleRating"
},
"violenceRealistic": {
"$ref": "#/definitions/apple/AppleRating"
}
}
},
@@ -448,8 +402,8 @@
}
},
"shouldResetRatings": {
"type": "boolean",
"description": "Should App Store ratings be reset for this version of the app.",
"type": "boolean",
"meta": {
"storeInfo": "You can reset your app’s summary rating for all countries or regions when you release this version. Keep in mind that once this version is released, you won’t be able to restore the rating. Your app’s existing customer reviews will still appear on the App Store."
}
@@ -458,96 +412,67 @@
"type": "boolean"
},
"automaticRelease": {
"type": "boolean",
"description": "Should the app automatically be released when approved by App Store review."
"description": "Should the app automatically be released when approved by App Store review.",
"type": "boolean"
},
"usesNonExemptEncryption": {
"type": "boolean",
"description": "Alternative to setting `ITSAppUsesNonExemptEncryption` in the binary's `Info.plist`."
"description": "Alternative to setting `ITSAppUsesNonExemptEncryption` in the binary's `Info.plist`.",
"type": "boolean"
}
}
},
"AppleReview": {
"type": "object",
"description": "Info provided to the App Store review team to help them understand how to use your app.",
"required": [
"firstName",
"lastName",
"email",
"phone"
],
"required": ["firstName", "lastName"],
"defaultSnippets": [
{
"label": "Basic",
"description": "Only define the contact details in case communcation is needed with the App Store review team.",
"body": {
"firstName": "$1",
"lastName": "$2",
"email": "$3",
"phone": "+$4"
}
},
{
"label": "Full",
"description": "Define the demo account credentials, additional info, and contact details for the App Store review team.",
"body": {
"firstName": "$1",
"lastName": "$2",
"email": "$3",
"phone": "+$4",
"demoUsername": "$5",
"demoPassword": "$6",
"demoRequired": true,
"notes": "$7"
"lastName": "$2"
}
}
],
"properties": {
"firstName": {
"type": "string",
"description": "First name of contact in case communication is needed with the App Store review team.",
"minLength": 1
},
"lastName": {
"type": "string",
"description": "Last name of contact in case communication is needed with the App Store review team.",
"minLength": 1
},
"email": {
"type": "string",
"description": "Email address of contact in case communication is needed with the App Store review team.",
"format": "email"
},
"phone": {
"type": "string",
"description": "Phone number of contact in case communication is needed with the App Store review team. Preface the phone number with ‘+’ followed by the country code (for example, +44 844 209 0611)"
},
"demoUsername": {
"type": "string",
"description": "The user name to sign in to your app to review its features."
"description": "Optional username for testing the app.",
"type": "string"
},
"demoPassword": {
"type": "string",
"description": "The password to sign in to your app to review its features."
"description": "Optional password for testing the app.",
"type": "string"
},
"demoRequired": {
"type": "boolean",
"description": "A Boolean value that indicates if sign-in information is required to review all the features of your app. If users sign in using social media, provide information for an account for review. Credentials must be valid and active for duration of review.",
"markdownDescription": "A Boolean value that indicates if sign-in information is required to review all the features of your app. If users sign in using social media, provide information for an account for review.\n\n**Credentials must be valid and active for duration of review.**"
"attachment": {
"description": "Local file path to upload to the review team.",
"type": "string"
},
"firstName": {
"description": "Developer first name for the reviewer to contact.",
"type": "string"
},
"lastName": {
"description": "Developer last name (surname) for the reviewer to contact.",
"type": "string"
},
"phone": {
"description": "Developer phone number for the reviewer to contact.",
"type": "string"
},
"email": {
"description": "Developer email address for the reviewer to contact.",
"type": "string",
"format": "email"
},
"notes": {
"type": "string",
"description": "Additional information about your app that can help during the review process. Do not include demo account details.",
"markdownDescription": "Additional information about your app that can help during the review process.\n\n**Do not include demo account details.**",
"minLength": 2,
"maxLength": 4000
"description": "Any additional notes for the App Store reviewer.",
"type": "string"
}
}
}
},
"AppleConfig": {
"type": "object",
"description": "Configuration that is specific to the Apple App Store.",
"type": "object",
"additionalProperties": false,
"properties": {
"advisory": {
@@ -567,9 +492,7 @@
"maxItems": 2,
"items": [
{
"enum": [
"GAMES"
]
"enum": ["GAMES"]
},
{
"enum": [
@@ -599,9 +522,7 @@
"maxItems": 2,
"items": [
{
"enum": [
"STICKERS"
]
"enum": ["STICKERS"]
},
{
"enum": [
@@ -629,8 +550,6 @@
}
},
"copyright": {
"type": "string",
"description": "The updated company copyright. Example: 2021 Evan Bacon",
"defaultSnippets": [
{
"body": "$CURRENT_YEAR ${1:name}"
@@ -640,7 +559,9 @@
"versioned": true,
"liveEdits": true,
"storeInfo": "The name of the person or entity that owns the exclusive rights to your app, preceded by the year the rights were obtained (for example, \"2008 Acme Inc.\"). Do not provide a URL."
}
},
"description": "The updated company copyright. Example: 2021 Evan Bacon",
"type": "string"
},
"idfa": {
"$ref": "#/definitions/apple/AppleIdfa"
@@ -980,32 +901,28 @@
]
},
"release": {
"$ref": "#/definitions/apple/AppleRelease",
"description": "Release strategy"
"description": "Release strategy",
"$ref": "#/definitions/apple/AppleRelease"
},
"review": {
"$ref": "#/definitions/apple/AppleReview",
"description": "Info for the App Store reviewer"
"description": "Info for the App Store reviewer",
"$ref": "#/definitions/apple/AppleReview"
},
"priceTier": {
"type": "number",
"description": "App price tier. 0 is Free."
"description": "App price tier. 0 is Free.",
"type": "number"
}
}
}
},
"properties": {
"configVersion": {
"const": 0,
"description": "The EAS metadata store configuration version"
"const": 0
},
"apple": {
"$ref": "#/definitions/AppleConfig"
}
},
"additionalProperties": false,
"required": [
"configVersion",
"apple"
]
"required": ["configVersion", "apple"]
}
@@ -1,17 +0,0 @@
import { fixArchiveUrl } from '../uploads';
describe(fixArchiveUrl, () => {
it('fixes broken links', () => {
const input =
'https://submission-service-archives.s3.amazonaws.com/production%2Fdc98ca84-1473-4cb3-ae81-8c7b291cb27e%2F4424aa95-b985-4e2f-8755-9507b1037c1c';
const expectedOutput =
'https://submission-service-archives.s3.amazonaws.com/production/dc98ca84-1473-4cb3-ae81-8c7b291cb27e/4424aa95-b985-4e2f-8755-9507b1037c1c';
expect(fixArchiveUrl(input)).toBe(expectedOutput);
});
it('does not change correct urls', () => {
const correctUrl =
'https://submission-service-archives.s3.amazonaws.com/production/dc98ca84-1473-4cb3-ae81-8c7b291cb27e/4424aa95-b985-4e2f-8755-9507b1037c1c';
expect(fixArchiveUrl(correctUrl)).toBe(correctUrl);
});
});
+1 -4
View File
@@ -5,7 +5,6 @@ import nullthrows from 'nullthrows';
import AndroidCredentialsProvider, {
AndroidCredentials,
} from '../../credentials/android/AndroidCredentialsProvider';
import { BuildParamsInput } from '../../graphql/generated';
import { BuildMutation, BuildResult } from '../../graphql/mutations/BuildMutation';
import Log from '../../log';
import {
@@ -88,8 +87,7 @@ export async function prepareAndroidBuildAsync(
sendBuildRequestAsync: async (
appId: string,
job: Android.Job,
metadata: Metadata,
buildParams: BuildParamsInput
metadata: Metadata
): Promise<BuildResult> => {
const graphqlMetadata = transformMetadata(metadata);
const graphqlJob = transformJob(job);
@@ -97,7 +95,6 @@ export async function prepareAndroidBuildAsync(
appId,
job: graphqlJob,
metadata: graphqlMetadata,
buildParams,
});
},
});
+4 -19
View File
@@ -11,7 +11,6 @@ import { getExpoWebsiteBaseUrl } from '../api';
import {
AppPlatform,
BuildFragment,
BuildParamsInput,
BuildPriority,
BuildStatus,
UploadSessionType,
@@ -54,22 +53,11 @@ interface Builder<TPlatform extends Platform, Credentials, TJob extends Job> {
): Promise<CredentialsResult<Credentials> | undefined>;
syncProjectConfigurationAsync(ctx: BuildContext<TPlatform>): Promise<void>;
prepareJobAsync(ctx: BuildContext<TPlatform>, jobData: JobData<Credentials>): Promise<Job>;
sendBuildRequestAsync(
appId: string,
job: TJob,
metadata: Metadata,
buildParams: BuildParamsInput
): Promise<BuildResult>;
sendBuildRequestAsync(appId: string, job: TJob, metadata: Metadata): Promise<BuildResult>;
}
export type BuildRequestSender = () => Promise<BuildFragment | undefined>;
function resolveBuildParamsInput<T extends Platform>(ctx: BuildContext<T>): BuildParamsInput {
return {
resourceClass: ctx.resourceClass,
};
}
export async function prepareBuildRequestForPlatformAsync<
TPlatform extends Platform,
Credentials,
@@ -112,7 +100,6 @@ export async function prepareBuildRequestForPlatformAsync<
} as const);
const metadata = await collectMetadataAsync(ctx);
const buildParams = resolveBuildParamsInput(ctx);
const job = await builder.prepareJobAsync(ctx, {
projectArchive,
credentials: credentialsResult?.credentials,
@@ -124,7 +111,7 @@ export async function prepareBuildRequestForPlatformAsync<
return undefined;
} else {
try {
return await sendBuildRequestAsync(builder, job, metadata, buildParams);
return await sendBuildRequestAsync(builder, job, metadata);
} catch (error: any) {
handleBuildRequestError(error, job.platform);
}
@@ -210,8 +197,7 @@ async function uploadProjectAsync<TPlatform extends Platform>(
async function sendBuildRequestAsync<TPlatform extends Platform, Credentials, TJob extends Job>(
builder: Builder<TPlatform, Credentials, TJob>,
job: TJob,
metadata: Metadata,
buildParams: BuildParamsInput
metadata: Metadata
): Promise<BuildFragment> {
const { ctx } = builder;
return await withAnalyticsAsync(
@@ -223,8 +209,7 @@ async function sendBuildRequestAsync<TPlatform extends Platform, Credentials, TJ
const { build, deprecationInfo } = await builder.sendBuildRequestAsync(
ctx.projectId,
job,
metadata,
buildParams
metadata
);
printDeprecationWarnings(deprecationInfo);
-2
View File
@@ -6,7 +6,6 @@ import type { XCBuildConfiguration } from 'xcode';
import { TrackingContext } from '../analytics/common';
import { CredentialsContext } from '../credentials/context';
import { Target } from '../credentials/ios/types';
import { BuildResourceClass } from '../graphql/generated';
import { GradleBuildContext } from '../project/android/gradle';
import { XcodeBuildContext } from '../project/ios/scheme';
import { Actor } from '../user/User';
@@ -31,7 +30,6 @@ export interface BuildContext<T extends Platform> {
accountName: string;
buildProfile: BuildProfile<T>;
buildProfileName: string;
resourceClass: BuildResourceClass;
clearCache: boolean;
credentialsCtx: CredentialsContext;
exp: ExpoConfig;
@@ -7,7 +7,6 @@ import { v4 as uuidv4 } from 'uuid';
import { TrackingContext } from '../analytics/common';
import { Analytics, BuildEvent } from '../analytics/events';
import { CredentialsContext } from '../credentials/context';
import { BuildResourceClass } from '../graphql/generated';
import { getExpoConfig } from '../project/expoConfig';
import { getProjectAccountName, getProjectIdAsync } from '../project/projectUtils';
import { resolveWorkflowAsync } from '../project/workflow';
@@ -26,7 +25,6 @@ export async function createBuildContextAsync<T extends Platform>({
nonInteractive = false,
platform,
projectDir,
resourceClass,
}: {
buildProfileName: string;
buildProfile: BuildProfile<T>;
@@ -35,7 +33,6 @@ export async function createBuildContextAsync<T extends Platform>({
nonInteractive: boolean;
platform: T;
projectDir: string;
resourceClass: BuildResourceClass;
}): Promise<BuildContext<T>> {
const exp = getExpoConfig(projectDir, { env: buildProfile.env });
@@ -73,7 +70,6 @@ export async function createBuildContextAsync<T extends Platform>({
accountName,
buildProfile,
buildProfileName,
resourceClass,
clearCache,
credentialsCtx,
exp,
+1 -4
View File
@@ -3,7 +3,6 @@ import { Ios, Job, Metadata, Platform, Workflow } from '@expo/eas-build-job';
import type { XCBuildConfiguration } from 'xcode';
import { IosCredentials, Target } from '../../credentials/ios/types';
import { BuildParamsInput } from '../../graphql/generated';
import { BuildMutation, BuildResult } from '../../graphql/mutations/BuildMutation';
import { ensureBundleIdentifierIsDefinedForManagedProjectAsync } from '../../project/ios/bundleIdentifier';
import { resolveXcodeBuildContextAsync } from '../../project/ios/scheme';
@@ -83,8 +82,7 @@ export async function prepareIosBuildAsync(
sendBuildRequestAsync: async (
appId: string,
job: Ios.Job,
metadata: Metadata,
buildParams: BuildParamsInput
metadata: Metadata
): Promise<BuildResult> => {
const graphqlMetadata = transformMetadata(metadata);
const graphqlJob = transformJob(job);
@@ -92,7 +90,6 @@ export async function prepareIosBuildAsync(
appId,
job: graphqlJob,
metadata: graphqlMetadata,
buildParams,
});
},
});
@@ -3,13 +3,7 @@ import { BuildProfile, EasJsonReader, SubmitProfile } from '@expo/eas-json';
import chalk from 'chalk';
import nullthrows from 'nullthrows';
import {
AppPlatform,
BuildFragment,
BuildResourceClass,
BuildStatus,
SubmissionFragment,
} from '../graphql/generated';
import { AppPlatform, BuildFragment, BuildStatus, SubmissionFragment } from '../graphql/generated';
import { toAppPlatform, toPlatform } from '../graphql/types/AppPlatform';
import Log from '../log';
import {
@@ -36,7 +30,6 @@ import { BuildContext } from './context';
import { createBuildContextAsync } from './createContext';
import { prepareIosBuildAsync } from './ios/build';
import { LocalBuildOptions } from './local';
import { UserInputResourceClass } from './types';
import { ensureExpoDevClientInstalledForDevClientBuildsAsync } from './utils/devClient';
import { printBuildResults, printLogsUrls } from './utils/printBuildInfo';
import { ensureRepoIsCleanAsync } from './utils/repository';
@@ -54,23 +47,8 @@ export interface BuildFlags {
autoSubmit: boolean;
submitProfile?: string;
localBuildOptions: LocalBuildOptions;
userInputResourceClass?: UserInputResourceClass;
}
const platformToGraphQLResourceClassMapping: Record<
Platform,
Record<UserInputResourceClass, BuildResourceClass>
> = {
[Platform.ANDROID]: {
[UserInputResourceClass.DEFAULT]: BuildResourceClass.AndroidDefault,
[UserInputResourceClass.LARGE]: BuildResourceClass.AndroidLarge,
},
[Platform.IOS]: {
[UserInputResourceClass.DEFAULT]: BuildResourceClass.IosDefault,
[UserInputResourceClass.LARGE]: BuildResourceClass.IosLarge,
},
};
export async function runBuildAndSubmitAsync(projectDir: string, flags: BuildFlags): Promise<void> {
await getVcsClient().ensureRepoExistsAsync();
await ensureRepoIsCleanAsync(flags.nonInteractive);
@@ -107,10 +85,6 @@ export async function runBuildAndSubmitAsync(projectDir: string, flags: BuildFla
flags,
moreBuilds: platforms.length > 1,
buildProfile,
resourceClass:
platformToGraphQLResourceClassMapping[buildProfile.platform][
flags.userInputResourceClass ?? UserInputResourceClass.DEFAULT
],
});
if (maybeBuild) {
startedBuilds.push({ build: maybeBuild, buildProfile });
@@ -187,17 +161,14 @@ async function prepareAndStartBuildAsync({
flags,
moreBuilds,
buildProfile,
resourceClass,
}: {
projectDir: string;
flags: BuildFlags;
moreBuilds: boolean;
buildProfile: ProfileData<'build'>;
resourceClass: BuildResourceClass;
}): Promise<{ build: BuildFragment | undefined; buildCtx: BuildContext<Platform> }> {
const buildCtx = await createBuildContextAsync({
buildProfileName: buildProfile.profileName,
resourceClass,
clearCache: flags.clearCache,
buildProfile: buildProfile.profile,
nonInteractive: flags.nonInteractive,
-5
View File
@@ -12,8 +12,3 @@ export enum BuildDistributionType {
INTERNAL = 'internal',
SIMULATOR = 'simulator',
}
export enum UserInputResourceClass {
DEFAULT = 'default',
LARGE = 'large',
}
+17 -47
View File
@@ -17,24 +17,23 @@ import { getExpoConfig } from '../../project/expoConfig';
import { findProjectRootAsync, getProjectIdAsync } from '../../project/projectUtils';
import { UPDATE_COLUMNS, formatUpdate, getPlatformsForGroup } from '../../update/utils';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
export const BRANCHES_LIMIT = 50;
const BRANCHES_LIMIT = 10_000;
export async function listBranchesAsync({
appId,
limit = BRANCHES_LIMIT,
offset = 0,
}: BranchesByAppQueryVariables): Promise<UpdateBranchFragment[]> {
projectId,
}: {
projectId: string;
}): Promise<UpdateBranchFragment[]> {
const data = await withErrorHandlingAsync(
graphqlClient
.query<BranchesByAppQuery, BranchesByAppQueryVariables>(
gql`
query BranchesByAppQuery($appId: String!, $limit: Int!, $offset: Int!) {
query BranchesByAppQuery($appId: String!, $limit: Int!) {
app {
byId(appId: $appId) {
id
updateBranches(offset: $offset, limit: $limit) {
updateBranches(offset: 0, limit: $limit) {
id
...UpdateBranchFragment
}
@@ -44,9 +43,8 @@ export async function listBranchesAsync({
${print(UpdateBranchFragmentNode)}
`,
{
appId,
limit,
offset,
appId: projectId,
limit: BRANCHES_LIMIT,
},
{ additionalTypenames: ['UpdateBranch'] }
)
@@ -75,28 +73,9 @@ export default class BranchList extends EasCommand {
const projectDir = await findProjectRootAsync();
const exp = getExpoConfig(projectDir);
const projectId = await getProjectIdAsync(exp);
await queryForPaginatedBranchesAsync(projectId, flags);
}
}
async function queryForPaginatedBranchesAsync(
projectId: string,
flags: { json: boolean } & { json: boolean | undefined }
): Promise<void> {
const queryAdditionalBranchesAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<UpdateBranchFragment>> => {
const branches = await listBranchesAsync({ appId: projectId, limit: pageSize, offset });
return {
queryResponse: branches,
queryResponseRawLength: branches.length,
};
};
const renderPageOfBranches = (currentPage: UpdateBranchFragment[]): void => {
const branches = await listBranchesAsync({ projectId });
if (flags.json) {
printJsonOnlyOutput(currentPage);
printJsonOnlyOutput(branches);
} else {
const table = new CliTable({
head: ['Branch', ...UPDATE_COLUMNS],
@@ -104,7 +83,7 @@ async function queryForPaginatedBranchesAsync(
});
table.push(
...currentPage.map(branch => [
...branches.map(branch => [
branch.name,
formatUpdate(branch.updates[0]),
branch.updates[0]?.runtimeVersion ?? 'N/A',
@@ -117,20 +96,11 @@ async function queryForPaginatedBranchesAsync(
);
Log.addNewLineIfNone();
Log.log(chalk.bold('Branches:'));
Log.addNewLineIfNone();
Log.log(chalk.bold('Branches with their most recent update group:'));
Log.log(table.toString());
if (branches.length >= BRANCHES_LIMIT) {
Log.warn(`Showing first ${BRANCHES_LIMIT} branches, some results might be omitted.`);
}
}
};
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryAdditionalBranchesAsync,
promptOptions: {
type: 'confirm',
title: 'Fetch next page of branches?',
renderListItems: renderPageOfBranches,
},
});
}
}
+31 -80
View File
@@ -3,7 +3,6 @@ import chalk from 'chalk';
import Table from 'cli-table3';
import EasCommand from '../../commandUtils/EasCommand';
import { ViewBranchUpdatesQuery } from '../../graphql/generated';
import { UpdateQuery } from '../../graphql/queries/UpdateQuery';
import Log from '../../log';
import { getExpoConfig } from '../../project/expoConfig';
@@ -13,7 +12,6 @@ import { UPDATE_COLUMNS, formatUpdate, getPlatformsForGroup } from '../../update
import groupBy from '../../utils/expodash/groupBy';
import formatFields from '../../utils/formatFields';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
export default class BranchView extends EasCommand {
static description = 'view a branch';
@@ -59,97 +57,50 @@ export default class BranchView extends EasCommand {
}));
}
await queryForPaginatedBranchesAsync(projectId, name, { json: jsonFlag });
}
}
type BranchUpdateObject = Exclude<
ViewBranchUpdatesQuery['app']['byId']['updateBranchByName'],
null | undefined
>['updates'][0];
async function queryForPaginatedBranchesAsync(
projectId: string,
name: string,
flags: { json: boolean } & { json: boolean | undefined }
): Promise<void> {
const queryAdditionalBranchesAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<BranchUpdateObject>> => {
const { app } = await UpdateQuery.viewBranchAsync({
appId: projectId,
name,
limit: pageSize,
offset,
});
const UpdateBranch = app?.byId.updateBranchByName;
if (!UpdateBranch) {
throw new Error(`Could not find branch "${name}"`);
}
const updateGroups = Object.values(groupBy(UpdateBranch.updates, u => u.group)).map(
updateGroup => ({
...updateGroup[0],
platform: getPlatformsForGroup({
updates: updateGroup,
group: updateGroup[0].group,
}),
})
const updates = Object.values(groupBy(UpdateBranch.updates, u => u.group)).map(
group => group[0]
);
return {
queryResponse: updateGroups,
queryResponseRawLength: UpdateBranch.updates.length,
};
};
const renderPageOfBranches = (currentPage: BranchUpdateObject[]): void => {
if (flags.json) {
printJsonOnlyOutput(currentPage);
if (jsonFlag) {
printJsonOnlyOutput({ ...UpdateBranch, updates });
} else {
if (flags.json) {
printJsonOnlyOutput({ currentPage });
} else {
const groupTable = new Table({
head: UPDATE_COLUMNS,
wordWrap: true,
});
const groupTable = new Table({
head: UPDATE_COLUMNS,
wordWrap: true,
});
for (const update of currentPage) {
groupTable.push([
formatUpdate(update),
update.runtimeVersion,
update.group,
getPlatformsForGroup({
updates: currentPage,
group: update.group,
}),
]);
}
Log.addNewLineIfNone();
Log.log(chalk.bold('Branch:'));
Log.log(
formatFields([
{ label: 'Name', value: currentPage[0]['branch']['name'] },
{ label: 'ID', value: currentPage[0]['branch']['id'] },
])
);
Log.addNewLineIfNone();
Log.log(groupTable.toString());
for (const update of updates) {
groupTable.push([
formatUpdate(update),
update.runtimeVersion,
update.group,
getPlatformsForGroup({
updates: UpdateBranch.updates,
group: update.group,
}),
]);
}
}
};
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryAdditionalBranchesAsync,
promptOptions: {
type: 'confirm',
title: 'Fetch next page of branches?',
renderListItems: renderPageOfBranches,
},
});
Log.addNewLineIfNone();
Log.log(chalk.bold('Branch:'));
Log.log(
formatFields([
{ label: 'Name', value: UpdateBranch.name },
{ label: 'ID', value: UpdateBranch.id },
])
);
Log.addNewLineIfNone();
Log.log(chalk.bold('Recently published update groups:'));
Log.log(groupTable.toString());
}
}
}
+44 -71
View File
@@ -5,7 +5,6 @@ import EasCommand from '../../commandUtils/EasCommand';
import { graphqlClient, withErrorHandlingAsync } from '../../graphql/client';
import {
Build,
BuildFragment,
BuildStatus,
CancelBuildMutation,
CancelBuildMutationVariables,
@@ -20,8 +19,7 @@ import {
getProjectFullNameAsync,
getProjectIdAsync,
} from '../../project/projectUtils';
import { confirmAsync } from '../../prompts';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
import { confirmAsync, selectAsync } from '../../prompts';
async function cancelBuildAsync(buildId: string): Promise<Pick<Build, 'id' | 'status'>> {
const data = await withErrorHandlingAsync(
@@ -61,6 +59,48 @@ function formatUnfinishedBuild(
return `${platform} Started at: ${startTime}, Status: ${status}, Id: ${build.id}`;
}
async function selectBuildToCancelAsync(
projectId: string,
projectFullName: string
): Promise<string | null> {
const spinner = ora().start('Fetching the uncompleted builds…');
let builds;
try {
const [newBuilds, inQueueBuilds, inProgressBuilds] = await Promise.all([
BuildQuery.allForAppAsync(projectId, { filter: { status: BuildStatus.New } }),
BuildQuery.allForAppAsync(projectId, { filter: { status: BuildStatus.InQueue } }),
BuildQuery.allForAppAsync(projectId, { filter: { status: BuildStatus.InProgress } }),
]);
spinner.stop();
builds = [...newBuilds, ...inQueueBuilds, ...inProgressBuilds];
} catch (error) {
spinner.fail(
`Something went wrong and we couldn't fetch the builds for the project ${projectFullName}.`
);
throw error;
}
if (builds.length === 0) {
Log.warn(`There aren't any uncompleted builds for the project ${projectFullName}.`);
return null;
} else if (builds.length === 1) {
Log.log('Found one build');
Log.log(formatUnfinishedBuild(builds[0]));
await confirmAsync({
message: 'Do you want to cancel it?',
});
return builds[0].id;
} else {
const buildId = await selectAsync<string>(
'Which build do you want to cancel?',
builds.map(build => ({
title: formatUnfinishedBuild(build),
value: build.id,
}))
);
return buildId;
}
}
async function ensureBuildExistsAsync(buildId: string): Promise<void> {
try {
await BuildQuery.byIdAsync(buildId);
@@ -86,8 +126,7 @@ export default class BuildCancel extends EasCommand {
await ensureBuildExistsAsync(buildIdFromArg);
}
const buildId =
buildIdFromArg || (await queryForBuildToCancelAsync(projectId, projectFullName));
const buildId = buildIdFromArg || (await selectBuildToCancelAsync(projectId, projectFullName));
if (!buildId) {
return;
}
@@ -107,69 +146,3 @@ export default class BuildCancel extends EasCommand {
}
}
}
async function queryForBuildToCancelAsync(
projectId: string,
projectFullName: string
): Promise<string | null> {
const queryToPerformAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<BuildFragment>> => {
const [newBuilds, inQueueBuilds, inProgressBuilds] = await Promise.all([
BuildQuery.allForAppAsync(projectId, {
limit: pageSize,
offset,
filter: { status: BuildStatus.New },
}),
BuildQuery.allForAppAsync(projectId, {
limit: pageSize,
offset,
filter: { status: BuildStatus.InQueue },
}),
BuildQuery.allForAppAsync(projectId, {
limit: pageSize,
offset,
filter: { status: BuildStatus.InProgress },
}),
]);
// this variable controls whether performPaginatedQueryAsync will query the next page.
// force another query if we have hit the query limit for any of these 3 queries.
const queryResponseLength =
newBuilds.length < pageSize &&
inQueueBuilds.length < pageSize &&
inProgressBuilds.length < pageSize
? pageSize - 1
: pageSize;
return {
queryResponse: [...newBuilds, ...inQueueBuilds, ...inProgressBuilds],
queryResponseRawLength: queryResponseLength,
};
};
const getIdentifierForQueryItem = (buildFragment: BuildFragment): string => buildFragment.id;
const selectedBuild = (
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryToPerformAsync,
promptOptions: {
type: 'select',
title: 'Which build would you like to cancel?',
getIdentifierForQueryItem,
createDisplayTextForSelectionPromptListItem: formatUnfinishedBuild,
},
})
).pop();
if (!selectedBuild) {
Log.warn(`There aren't any uncompleted builds for the project ${projectFullName}.`);
return null;
}
const userConfirmedCancellation = await confirmAsync({
message: `Are you sure you want to cancel ${formatUnfinishedBuild(selectedBuild)}?`,
});
return userConfirmedCancellation ? selectedBuild.id : null;
}
@@ -2,7 +2,6 @@ import { Errors, Flags } from '@oclif/core';
import path from 'path';
import { BuildFlags, runBuildAndSubmitAsync } from '../../build/runBuildAndSubmit';
import { UserInputResourceClass } from '../../build/types';
import EasCommand from '../../commandUtils/EasCommand';
import Log from '../../log';
import { RequestedPlatform, selectRequestedPlatformAsync } from '../../platform';
@@ -22,7 +21,6 @@ interface RawBuildFlags {
json: boolean;
'auto-submit': boolean;
'auto-submit-with-profile'?: string;
'resource-class'?: UserInputResourceClass;
}
export default class Build extends EasCommand {
@@ -81,11 +79,6 @@ export default class Build extends EasCommand {
helpValue: 'PROFILE_NAME',
exclusive: ['auto-submit'],
}),
'resource-class': Flags.enum({
options: Object.values(UserInputResourceClass),
hidden: true,
description: 'The instance type that will be used to run this build [experimental]',
}),
};
async runAsync(): Promise<void> {
@@ -162,7 +155,6 @@ export default class Build extends EasCommand {
json: flags['json'],
autoSubmit: flags['auto-submit'] || flags['auto-submit-with-profile'] !== undefined,
submitProfile: flags['auto-submit-with-profile'] ?? profile,
userInputResourceClass: flags['resource-class'] ?? UserInputResourceClass.DEFAULT,
};
}
}
+49 -75
View File
@@ -6,12 +6,12 @@ import { formatGraphQLBuild } from '../../build/utils/formatBuild';
import EasCommand from '../../commandUtils/EasCommand';
import {
AppPlatform,
BuildFragment,
DistributionType,
BuildStatus as GraphQLBuildStatus,
} from '../../graphql/generated';
import { BuildQuery, BuildsQuery } from '../../graphql/queries/BuildQuery';
import { BuildQuery } from '../../graphql/queries/BuildQuery';
import Log from '../../log';
import { ora } from '../../ora';
import { RequestedPlatform } from '../../platform';
import { getExpoConfig } from '../../project/expoConfig';
import {
@@ -20,7 +20,6 @@ import {
getProjectIdAsync,
} from '../../project/projectUtils';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
export default class BuildList extends EasCommand {
static description = 'list all builds for your project';
@@ -57,6 +56,7 @@ export default class BuildList extends EasCommand {
appIdentifier: Flags.string(),
buildProfile: Flags.string(),
gitCommitHash: Flags.string(),
limit: Flags.integer(),
};
async runAsync(): Promise<void> {
@@ -66,6 +66,7 @@ export default class BuildList extends EasCommand {
platform: requestedPlatform,
status: buildStatus,
distribution: buildDistribution,
limit = 10,
} = flags;
if (json) {
enableJsonOutput();
@@ -80,24 +81,51 @@ export default class BuildList extends EasCommand {
const projectId = await getProjectIdAsync(exp);
const projectName = await getProjectFullNameAsync(exp);
await queryForPaginatedBuildsAsync(
projectId,
projectName,
{
platform,
status: graphqlBuildStatus,
distribution: graphqlBuildDistribution,
channel: flags.channel,
appVersion: flags.appVersion,
appBuildVersion: flags.appBuildVersion,
sdkVersion: flags.sdkVersion,
runtimeVersion: flags.runtimeVersion,
appIdentifier: flags.appIdentifier,
buildProfile: flags.buildProfile,
gitCommitHash: flags.gitCommitHash,
},
flags
);
const spinner = ora().start('Fetching the build list for the project…');
try {
const builds = await BuildQuery.allForAppAsync(projectId, {
limit,
filter: {
platform,
status: graphqlBuildStatus,
distribution: graphqlBuildDistribution,
channel: flags.channel,
appVersion: flags.appVersion,
appBuildVersion: flags.appBuildVersion,
sdkVersion: flags.sdkVersion,
runtimeVersion: flags.runtimeVersion,
appIdentifier: flags.appIdentifier,
buildProfile: flags.buildProfile,
gitCommitHash: flags.gitCommitHash,
},
});
if (builds.length) {
if (platform || graphqlBuildStatus) {
spinner.succeed(
`Showing ${builds.length} matching builds for the project ${projectName}`
);
} else {
spinner.succeed(`Showing last ${builds.length} builds for the project ${projectName}`);
}
if (json) {
printJsonOnlyOutput(builds);
} else {
const list = builds
.map(build => formatGraphQLBuild(build))
.join(`\n\n${chalk.dim('———')}\n\n`);
Log.log(`\n${list}`);
}
} else {
spinner.fail(`Couldn't find any builds for the project ${projectName}`);
}
} catch (e) {
spinner.fail(`Something went wrong and we couldn't fetch the build list ${projectName}`);
throw e;
}
}
}
@@ -142,57 +170,3 @@ const toGraphQLBuildDistribution = (
return undefined;
}
};
async function queryForPaginatedBuildsAsync(
projectId: string,
projectName: string,
filter: BuildsQuery['filter'],
flags: { json: boolean } & { json: boolean | undefined }
): Promise<void> {
const queryAdditionalBuildsAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<BuildFragment>> => {
const builds = await BuildQuery.allForAppAsync(projectId, {
limit: pageSize,
offset,
filter,
});
return {
queryResponse: builds,
queryResponseRawLength: builds.length,
};
};
const renderPageOfBuilds = (currentPage: BuildFragment[]): void => {
if (flags.json) {
printJsonOnlyOutput(currentPage);
} else {
if (currentPage.length) {
const list = currentPage
.map(build => formatGraphQLBuild(build))
.join(`\n\n${chalk.dim('———')}\n\n`);
Log.addNewLineIfNone();
Log.withTick(chalk.bold(`Builds for ${projectName}:`));
Log.log(`\n${list}`);
Log.addNewLineIfNone();
} else {
Log.withCross(chalk.bold(`Couldn't find any builds for the project ${projectName}`));
Log.addNewLineIfNone();
}
}
};
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryAdditionalBuildsAsync,
promptOptions: {
type: 'confirm',
title: 'Fetch next page of builds?',
renderListItems: renderPageOfBuilds,
},
});
}
+19 -100
View File
@@ -1,5 +1,4 @@
import { Flags } from '@oclif/core';
import chalk from 'chalk';
import gql from 'graphql-tag';
import EasCommand from '../../commandUtils/EasCommand';
@@ -13,41 +12,31 @@ import { getExpoConfig } from '../../project/expoConfig';
import { findProjectRootAsync, getProjectIdAsync } from '../../project/projectUtils';
import formatFields from '../../utils/formatFields';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
import { BRANCHES_LIMIT } from '../branch/list';
import { logChannelDetails } from './view';
const CHANNEL_LIMIT = 50;
const CHANNEL_LIMIT = 10_000;
async function getAllUpdateChannelForAppAsync({
appId,
channelLimit = CHANNEL_LIMIT,
channelOffset = 0,
branchLimit = BRANCHES_LIMIT,
branchOffset = 0,
}: GetAllChannelsForAppQueryVariables): Promise<GetAllChannelsForAppQuery> {
}: {
appId: string;
}): Promise<GetAllChannelsForAppQuery> {
return await withErrorHandlingAsync(
graphqlClient
.query<GetAllChannelsForAppQuery, GetAllChannelsForAppQueryVariables>(
gql`
query GetAllChannelsForApp(
$appId: String!
$channelOffset: Int!
$channelLimit: Int!
$branchLimit: Int!
$branchOffset: Int!
) {
query GetAllChannelsForApp($appId: String!, $offset: Int!, $limit: Int!) {
app {
byId(appId: $appId) {
id
updateChannels(offset: $channelOffset, limit: $channelLimit) {
updateChannels(offset: $offset, limit: $limit) {
id
name
branchMapping
updateBranches(offset: $branchOffset, limit: $branchLimit) {
updateBranches(offset: 0, limit: $limit) {
id
name
updates(offset: 0, limit: 1) {
updates(offset: 0, limit: 10) {
id
group
message
@@ -70,7 +59,7 @@ async function getAllUpdateChannelForAppAsync({
}
}
`,
{ appId, channelOffset, channelLimit, branchLimit, branchOffset },
{ appId, offset: 0, limit: CHANNEL_LIMIT },
{ additionalTypenames: ['UpdateChannel', 'UpdateBranch', 'Update'] }
)
.toPromise()
@@ -99,77 +88,18 @@ export default class ChannelList extends EasCommand {
const exp = getExpoConfig(projectDir);
const projectId = await getProjectIdAsync(exp);
await queryForChannelsAsync(projectId, jsonFlag);
}
}
const getAllUpdateChannelForAppResult = await getAllUpdateChannelForAppAsync({
appId: projectId,
});
const channels = getAllUpdateChannelForAppResult.app?.byId.updateChannels;
if (!channels) {
throw new Error(`Could not find channels on project with id ${projectId}`);
}
type UpdateChannelObject = GetAllChannelsForAppQuery['app']['byId']['updateChannels'][0];
async function queryForChannelsAsync(projectId: string, jsonFlag: boolean): Promise<void> {
const queryToPerformAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<UpdateChannelObject>> => {
let queriedAllBranches = false;
let branchOffset = 0;
const branchLimit = 10;
const paginatedQuery: PaginatedQueryResponse<UpdateChannelObject> = {
queryResponse: [],
queryResponseRawLength: 0,
};
const branchesForChannels: Record<string, UpdateChannelObject['updateBranches']> = {};
// we need to paginate our paginated query. Each channel (N) can have M branches
// and we need to fetch all branches to populate our 'branch mapping' portion
// of the UI properly.
do {
const getAllUpdateChannelForAppResult = await getAllUpdateChannelForAppAsync({
appId: projectId,
channelLimit: pageSize,
channelOffset: offset,
branchLimit,
branchOffset,
});
const channels = getAllUpdateChannelForAppResult.app?.byId.updateChannels;
if (!channels) {
throw new Error(`Could not find channels on project with id ${projectId}`);
}
queriedAllBranches = true;
// save each array of branches using a record so we can lookup in O(1) later on
channels.forEach(channel => {
if (channel.updateBranches.length === branchLimit) {
queriedAllBranches = false;
}
branchesForChannels[channel.id] = [
...(branchesForChannels[channel.id] ? branchesForChannels[channel.id] : []),
...channel.updateBranches,
];
});
if (!paginatedQuery.queryResponse.length) {
paginatedQuery.queryResponse = channels;
} else {
paginatedQuery.queryResponse.forEach(channel => {
channel.updateBranches = branchesForChannels[channel.id];
});
}
paginatedQuery.queryResponseRawLength = channels.length;
branchOffset += branchLimit + 1;
} while (!queriedAllBranches);
return paginatedQuery;
};
const renderListItems = (currentPage: UpdateChannelObject[]): void => {
if (jsonFlag) {
printJsonOnlyOutput(currentPage);
printJsonOnlyOutput(channels);
} else {
Log.addNewLineIfNone();
Log.log(chalk.bold('Channels:'));
Log.addNewLineIfNone();
for (const channel of currentPage) {
for (const channel of channels) {
Log.addNewLineIfNone();
Log.log(
formatFields([
@@ -180,16 +110,5 @@ async function queryForChannelsAsync(projectId: string, jsonFlag: boolean): Prom
logChannelDetails(channel);
}
}
};
await performPaginatedQueryAsync({
pageSize: 25, // lower, because we need to query all branches per channel O(N*M)
offset: 0,
queryToPerform: queryToPerformAsync,
promptOptions: {
type: 'confirm',
title: 'Fetch next page of channels?',
renderListItems,
},
});
}
}
@@ -351,8 +351,6 @@ export default class ChannelRollout extends EasCommand {
const channel = await ChannelQuery.getUpdateChannelByNameForAppAsync({
appId: projectId,
channelName: channelName!,
offset: 0,
limit: 50,
});
if (!channel) {
throw new Error(
@@ -111,7 +111,7 @@ export function logChannelDetails(channel: {
}
const { branchId } = branchMapping.data[index];
const branch = channel.updateBranches.find(branch => branch.id === branchId);
const branch = channel.updateBranches.filter(branch => branch.id === branchId)[0];
if (!branch) {
throw new Error('Branch mapping is pointing at a missing branch.');
}
@@ -184,8 +184,6 @@ export default class ChannelView extends EasCommand {
const channel = await ChannelQuery.getUpdateChannelByNameForAppAsync({
appId: projectId,
channelName,
offset: 0,
limit: 50,
});
if (!channel) {
throw new Error(`Could not find a channel with name: ${channelName}`);
+115 -126
View File
@@ -19,7 +19,6 @@ import {
Robot,
RootQueryUpdatesByGroupArgs,
Update,
UpdateBranchFragment,
UpdateInfoGroup,
UpdatePublishMutation,
User,
@@ -45,7 +44,7 @@ import {
uploadAssetsAsync,
} from '../../project/publish';
import { resolveWorkflowAsync } from '../../project/workflow';
import { confirmAsync, promptAsync } from '../../prompts';
import { confirmAsync, promptAsync, selectAsync } from '../../prompts';
import { formatUpdate } from '../../update/utils';
import { ensureLoggedInAsync } from '../../user/actions';
import {
@@ -54,9 +53,9 @@ import {
getManifestBodyAsync,
signManifestBody,
} from '../../utils/code-signing';
import uniqBy from '../../utils/expodash/uniqBy';
import formatFields from '../../utils/formatFields';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
import { getVcsClient } from '../../vcs';
import { createUpdateBranchOnAppAsync } from '../branch/create';
import { listBranchesAsync } from '../branch/list';
@@ -129,8 +128,8 @@ export async function ensureBranchExistsAsync({
}: {
appId: string;
name: string;
limit: number;
offset: number;
limit?: number;
offset?: number;
}): Promise<{
id: string;
updates: Exclude<
@@ -283,16 +282,40 @@ export default class UpdatePublish extends EasCommand {
}
if (!branchName) {
const validationMessage = 'Branch name may not be empty.';
if (nonInteractive) {
throw new Error('Must supply --branch or use --auto when in non-interactive mode');
}
const validationMessage = 'Branch name may not be empty.';
if (jsonFlag) {
throw new Error(validationMessage);
}
branchName = await getBranchNameToPublishOnAsync(projectId, validationMessage);
const branches = await listBranchesAsync({ projectId });
if (branches.length === 0) {
({ name: branchName } = await promptAsync({
type: 'text',
name: 'name',
message: 'No branches found. Creating a new one. Please name the new branch:',
initial:
(await getVcsClient().getBranchNameAsync()) ||
`branch-${Math.random().toString(36).substr(2, 4)}`,
validate: value => (value ? true : validationMessage),
}));
} else {
branchName = await selectAsync<string>(
'Which branch would you like to publish on?',
branches.map(branch => {
return {
title: `${branch.name} ${chalk.grey(
`- current update: ${formatUpdate(branch.updates[0])}`
)}`,
value: branch.name,
};
})
);
}
assert(branchName, 'Branch name must be specified.');
}
let unsortedUpdateInfoGroups: UpdateInfoGroup = {};
@@ -318,7 +341,12 @@ export default class UpdatePublish extends EasCommand {
throw new Error('You must specify the update group to republish.');
}
updatesToRepublish = await getUpdatesToRepublishAsync(projectId, branchName, platformFlag);
updatesToRepublish = await getUpdatesToRepublishInteractiveAsync(
projectId,
branchName,
platformFlag,
50
);
}
const updatesToRepublishFilteredByPlatform = updatesToRepublish.filter(
// Only republish to the specified platforms
@@ -383,6 +411,7 @@ export default class UpdatePublish extends EasCommand {
if (nonInteractive) {
throw new Error('Must supply --message or use --auto when in non-interactive mode');
}
const validationMessage = 'publish message may not be empty.';
if (jsonFlag) {
throw new Error(validationMessage);
@@ -428,8 +457,6 @@ export default class UpdatePublish extends EasCommand {
}
}
const truncatedMessage = truncatePublishUpdateMessage(message!);
const runtimeToPlatformMapping: Record<string, string[]> = {};
for (const runtime of new Set(Object.values(runtimeVersions))) {
runtimeToPlatformMapping[runtime] = Object.entries(runtimeVersions)
@@ -441,7 +468,6 @@ export default class UpdatePublish extends EasCommand {
appId: projectId,
name: branchName,
limit: 0,
offset: 0,
});
// Sort the updates into different groups based on their platform specific runtime versions
@@ -463,7 +489,7 @@ export default class UpdatePublish extends EasCommand {
branchId,
updateInfoGroup: localUpdateInfoGroup,
runtimeVersion: republish ? oldRuntimeVersion : runtime,
message: truncatedMessage,
message,
awaitingCodeSigningInfo: !!codeSigningInfo,
};
}
@@ -561,7 +587,7 @@ export default class UpdatePublish extends EasCommand {
? [{ label: 'Android update ID', value: newAndroidUpdate.id }]
: []),
...(newIosUpdate ? [{ label: 'iOS update ID', value: newIosUpdate.id }] : []),
{ label: 'Message', value: truncatedMessage },
{ label: 'Message', value: message! },
{ label: 'Website link', value: updateGroupLink },
])
);
@@ -571,52 +597,71 @@ export default class UpdatePublish extends EasCommand {
}
}
export async function getUpdatesToRepublishAsync(
export async function getUpdatesToRepublishInteractiveAsync(
projectId: string,
branchName: string,
platformFlag: string
): Promise<AppUpdateObject[]> {
const queryUpdatesForBranchAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<AppUpdateObject>> => {
const { updates } = await ensureBranchExistsAsync({
appId: projectId,
name: branchName!,
limit: pageSize,
offset,
});
if (!updates.length) {
throw new Error(
`There are no updates on branch "${branchName}" published for the platform(s) ${platformFlag}. Did you mean to publish a new update instead?`
);
}
const relevantUpdates =
platformFlag === 'all'
? updates
: updates.filter(update => {
// Only show groups that have updates on the specified platform(s).
return update.platform === platformFlag;
});
return {
queryResponse: relevantUpdates,
queryResponseRawLength: updates.length,
};
};
platformFlag: string,
pageSize: number,
offset: number = 0,
cumulativeUpdates: Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates'] = []
): Promise<
Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates']
> {
const fetchMoreValue = '_fetchMore';
const getUpdateIdentifier = (update: AppUpdateObject): string => update.group;
return await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryUpdatesForBranchAsync,
promptOptions: {
type: 'select',
title: 'Which update would you like to republish?',
createDisplayTextForSelectionPromptListItem: formatUpdateTitle,
getIdentifierForQueryItem: getUpdateIdentifier,
},
const { updates } = await ensureBranchExistsAsync({
appId: projectId,
name: branchName,
limit: pageSize + 1, // fetch an extra item so we know if there are additional pages
offset,
});
cumulativeUpdates = [
...cumulativeUpdates,
// drop that extra item used for pagination from our render logic
...updates.slice(0, updates.length - 1),
];
const cumulativeUpdatesForTargetPlatforms =
platformFlag === 'all'
? cumulativeUpdates
: cumulativeUpdates.filter(update => {
// Only show groups that have updates on the specified platform(s).
return update.platform === platformFlag;
});
const updateGroups = uniqBy(cumulativeUpdatesForTargetPlatforms, u => u.group).map(update => ({
title: formatUpdateTitle(update),
value: update.group,
}));
if (!updateGroups.length) {
throw new Error(
`There are no updates on branch "${branchName}" published for the platform(s) ${platformFlag}. Did you mean to publish a new update instead?`
);
}
if (updates.length > pageSize) {
updateGroups.push({ title: 'Next page...', value: fetchMoreValue });
}
const selectedUpdateGroup = await selectAsync<string>(
'Which update would you like to republish?',
updateGroups
);
if (selectedUpdateGroup === fetchMoreValue) {
return await getUpdatesToRepublishInteractiveAsync(
projectId,
branchName,
platformFlag,
pageSize,
offset + pageSize,
cumulativeUpdates
);
}
return cumulativeUpdates.filter(update => update.group === selectedUpdateGroup);
}
async function getRuntimeVersionObjectAsync(
@@ -649,24 +694,12 @@ async function getRuntimeVersionObjectAsync(
);
}
async function checkEASUpdateURLIsSetAsync(exp: ExpoConfig): Promise<void> {
const configuredURL = exp.updates?.url;
const projectId = await getProjectIdAsync(exp);
const expectedURL = getEASUpdateURL(projectId);
if (configuredURL !== expectedURL) {
throw new Error(
`The update URL is incorrectly configured for EAS Update. Please set updates.url to ${expectedURL} in your app.json.`
);
}
}
export type AppUpdateObject = Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates'][0];
export function formatUpdateTitle(update: AppUpdateObject): string {
function formatUpdateTitle(
update: Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates'][number]
): string {
const { message, createdAt, actor, runtimeVersion } = update;
let actorName: string;
@@ -689,58 +722,14 @@ export function formatUpdateTitle(update: AppUpdateObject): string {
)} by ${actorName}, runtimeVersion: ${runtimeVersion}] ${message}`;
}
async function getBranchNameToPublishOnAsync(
projectId: string,
validationMessage: string
): Promise<string> {
const queryForBanchesToPublishOnAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<UpdateBranchFragment>> => {
const branches = await listBranchesAsync({ appId: projectId, limit: pageSize, offset });
if (branches.length === 0) {
const { name: newBranchName } = await promptAsync({
type: 'text',
name: 'name',
message: 'No branches found. Creating a new one. Please name the new branch:',
initial:
(await getVcsClient().getBranchNameAsync()) ||
`branch-${Math.random().toString(36).substring(2, 7)}`,
validate: value => (value ? true : validationMessage),
});
branches.push({
id: '_defaultId',
name: newBranchName,
updates: [],
});
}
return { queryResponse: branches, queryResponseRawLength: branches.length };
};
const formatBranchTitle = (branch: UpdateBranchFragment): string =>
`${branch.name} ${chalk.grey(`- current update: ${formatUpdate(branch.updates[0])}`)}`;
const getBranchIdentifier = (branch: UpdateBranchFragment): string => branch.id;
async function checkEASUpdateURLIsSetAsync(exp: ExpoConfig): Promise<void> {
const configuredURL = exp.updates?.url;
const projectId = await getProjectIdAsync(exp);
const expectedURL = getEASUpdateURL(projectId);
const branches = await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryForBanchesToPublishOnAsync,
promptOptions: {
type: 'select',
createDisplayTextForSelectionPromptListItem: formatBranchTitle,
getIdentifierForQueryItem: getBranchIdentifier,
title: 'Which branch would you like to publish on?',
},
});
const branchName = branches?.pop()?.name;
assert(branchName, validationMessage);
return branchName;
}
export const truncatePublishUpdateMessage = (originalMessage: string): string => {
if (originalMessage.length > 1024) {
Log.warn('Update message exceeds the allowed 1024 character limit. Truncating message...');
return originalMessage.substring(0, 1021) + '...';
if (configuredURL !== expectedURL) {
throw new Error(
`The update URL is incorrectly configured for EAS Update. Please set updates.url to ${expectedURL} in your app.json.`
);
}
return originalMessage;
};
}
+39 -110
View File
@@ -4,7 +4,7 @@ import chalk from 'chalk';
import CliTable from 'cli-table3';
import EasCommand from '../../commandUtils/EasCommand';
import { ViewAllUpdatesQuery, ViewBranchUpdatesQuery } from '../../graphql/generated';
import { ViewAllUpdatesQuery } from '../../graphql/generated';
import { UpdateQuery } from '../../graphql/queries/UpdateQuery';
import Log from '../../log';
import { getExpoConfig } from '../../project/expoConfig';
@@ -13,7 +13,6 @@ import { promptAsync } from '../../prompts';
import { FormatUpdateParameter, UPDATE_COLUMNS, formatUpdate } from '../../update/utils';
import groupBy from '../../utils/expodash/groupBy';
import { enableJsonOutput, printJsonOnlyOutput } from '../../utils/json';
import { PaginatedQueryResponse, performPaginatedQueryAsync } from '../../utils/queries';
import { getVcsClient } from '../../vcs';
type UpdateGroupDescription = FormatUpdateParameter & {
@@ -54,8 +53,12 @@ export default class BranchView extends EasCommand {
const exp = getExpoConfig(projectDir);
const projectId = await getProjectIdAsync(exp);
let updateGroupDescriptions: UpdateGroupDescription[];
if (all) {
await fetchAllUpdatesForAppAsync(projectId, jsonFlag);
const branchesAndUpdates = await UpdateQuery.viewAllAsync({ appId: projectId });
updateGroupDescriptions = getUpdateGroupDescriptions(
branchesAndUpdates.app.byId.updateBranches
);
} else {
let branchInteractive: string | undefined;
if (!branchFlag) {
@@ -74,120 +77,46 @@ export default class BranchView extends EasCommand {
const branch = branchFlag ?? branchInteractive;
assert(branch, 'Branch name may not be empty.');
fetchAllUpdatesForBranchAsync(projectId, branch, jsonFlag);
const branchesAndUpdates = await UpdateQuery.viewBranchAsync({
appId: projectId,
name: branch,
});
const UpdateBranch = branchesAndUpdates.app?.byId.updateBranchByName;
if (!UpdateBranch) {
throw new Error(`Could not find branch "${branch}"`);
}
updateGroupDescriptions = getUpdateGroupDescriptions([UpdateBranch]);
}
if (jsonFlag) {
printJsonOnlyOutput(updateGroupDescriptions);
} else {
logAsTable(updateGroupDescriptions);
}
}
}
type BranchUpdateObject = Exclude<
ViewBranchUpdatesQuery['app']['byId']['updateBranchByName'],
null | undefined
>['updates'][0];
type AppUpdateObject = ViewAllUpdatesQuery['app']['byId']['updates'][0];
async function fetchAllUpdatesForBranchAsync(
projectId: string,
branchName: string,
jsonFlag: boolean
): Promise<void> {
const queryToPerformAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<BranchUpdateObject>> => {
const branchesAndUpdates = await UpdateQuery.viewBranchAsync({
appId: projectId,
name: branchName,
limit: pageSize,
offset,
});
const UpdateBranch = branchesAndUpdates.app?.byId.updateBranchByName;
if (!UpdateBranch) {
throw new Error(`Could not find branch "${branchName}"`);
}
return {
queryResponse: UpdateBranch.updates,
queryResponseRawLength: UpdateBranch.updates.length,
};
};
const renderListItems = (currentPage: BranchUpdateObject[]): void => {
const updateGroupDescriptions = getUpdateGroupDescriptions(currentPage);
if (jsonFlag) {
printJsonOnlyOutput(updateGroupDescriptions);
} else {
logAsTable(updateGroupDescriptions);
}
};
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryToPerformAsync,
promptOptions: {
type: 'confirm',
title: 'View next page of updates?',
renderListItems,
},
});
}
async function fetchAllUpdatesForAppAsync(projectId: string, jsonFlag: boolean): Promise<void> {
const queryToPerformAsync = async (
pageSize: number,
offset: number
): Promise<PaginatedQueryResponse<AppUpdateObject>> => {
const viewAllUpdates = await UpdateQuery.viewAllAsync({
appId: projectId,
limit: pageSize,
offset,
});
const { updates } = viewAllUpdates.app.byId;
return {
queryResponse: updates,
queryResponseRawLength: updates.length,
};
};
const renderListItems = (currentPage: AppUpdateObject[]): void => {
const updateGroupDescriptions = getUpdateGroupDescriptions(currentPage);
if (jsonFlag) {
printJsonOnlyOutput(updateGroupDescriptions);
} else {
logAsTable(updateGroupDescriptions);
}
};
await performPaginatedQueryAsync({
pageSize: 50,
offset: 0,
queryToPerform: queryToPerformAsync,
promptOptions: {
type: 'confirm',
title: 'View next page of updates?',
renderListItems,
},
});
}
function getUpdateGroupDescriptions(
updates: (BranchUpdateObject | AppUpdateObject)[]
branchesAndUpdates: ViewAllUpdatesQuery['app']['byId']['updateBranches']
): UpdateGroupDescription[] {
return Object.values(groupBy(updates, update => update.group))
.map(updateGroup => {
return {
platforms: updateGroup
.map(update => update.platform)
.sort()
.join(', '),
...updateGroup[0],
branch: updateGroup[0].branch.name,
} as UpdateGroupDescription;
const flattenedBranchesAndUpdates = branchesAndUpdates.flatMap(branch =>
branch.updates.map(update => {
return { branch: branch.name, ...update };
})
.sort((a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime());
);
const updateGroupDescriptions = Object.values(
groupBy(flattenedBranchesAndUpdates, update => update.group)
).map(updateGroup => {
const platforms = updateGroup
.map(update => update.platform)
.sort()
.join(', ');
return { ...updateGroup[0], platforms };
});
updateGroupDescriptions.sort(
(a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime()
);
return updateGroupDescriptions;
}
function logAsTable(updateGroupDescriptions: UpdateGroupDescription[]): void {
+5 -30
View File
@@ -1584,7 +1584,6 @@ export type Build = ActivityTimelineProjectActivity & BuildOrBuildJob & {
iosEnterpriseProvisioning?: Maybe<BuildIosEnterpriseProvisioning>;
isGitWorkingTreeDirty?: Maybe<Scalars['Boolean']>;
logFiles: Array<Scalars['String']>;
maxBuildTimeSeconds: Scalars['Int'];
metrics?: Maybe<BuildMetrics>;
parentBuild?: Maybe<Build>;
platform: AppPlatform;
@@ -1595,7 +1594,6 @@ export type Build = ActivityTimelineProjectActivity & BuildOrBuildJob & {
queuePosition?: Maybe<Scalars['Int']>;
reactNativeVersion?: Maybe<Scalars['String']>;
releaseChannel?: Maybe<Scalars['String']>;
resourceClass?: Maybe<BuildResourceClass>;
runtimeVersion?: Maybe<Scalars['String']>;
sdkVersion?: Maybe<Scalars['String']>;
status: BuildStatus;
@@ -1785,7 +1783,6 @@ export type BuildMutationCancelBuildArgs = {
export type BuildMutationCreateAndroidBuildArgs = {
appId: Scalars['ID'];
buildParams?: InputMaybe<BuildParamsInput>;
job: AndroidJobInput;
metadata?: InputMaybe<BuildMetadataInput>;
};
@@ -1793,7 +1790,6 @@ export type BuildMutationCreateAndroidBuildArgs = {
export type BuildMutationCreateIosBuildArgs = {
appId: Scalars['ID'];
buildParams?: InputMaybe<BuildParamsInput>;
job: IosJobInput;
metadata?: InputMaybe<BuildMetadataInput>;
};
@@ -1812,14 +1808,9 @@ export type BuildOrBuildJob = {
id: Scalars['ID'];
};
export type BuildParamsInput = {
resourceClass: BuildResourceClass;
};
export enum BuildPriority {
High = 'HIGH',
Normal = 'NORMAL',
NormalPlus = 'NORMAL_PLUS'
Normal = 'NORMAL'
}
/** Publicly visible data for a Build. */
@@ -1884,14 +1875,6 @@ export type BuildQueryByIdArgs = {
buildId: Scalars['ID'];
};
export enum BuildResourceClass {
AndroidDefault = 'ANDROID_DEFAULT',
AndroidLarge = 'ANDROID_LARGE',
IosDefault = 'IOS_DEFAULT',
IosLarge = 'IOS_LARGE',
Legacy = 'LEGACY'
}
export enum BuildStatus {
Canceled = 'CANCELED',
Errored = 'ERRORED',
@@ -3851,7 +3834,6 @@ export type DeleteUpdateBranchMutation = { __typename?: 'RootMutation', updateBr
export type BranchesByAppQueryVariables = Exact<{
appId: Scalars['String'];
limit: Scalars['Int'];
offset: Scalars['Int'];
}>;
@@ -3913,10 +3895,8 @@ export type UpdateChannelBranchMappingMutation = { __typename?: 'RootMutation',
export type GetAllChannelsForAppQueryVariables = Exact<{
appId: Scalars['String'];
channelOffset: Scalars['Int'];
channelLimit: Scalars['Int'];
branchLimit: Scalars['Int'];
branchOffset: Scalars['Int'];
offset: Scalars['Int'];
limit: Scalars['Int'];
}>;
@@ -4339,7 +4319,6 @@ export type CreateAndroidBuildMutationVariables = Exact<{
appId: Scalars['ID'];
job: AndroidJobInput;
metadata?: InputMaybe<BuildMetadataInput>;
buildParams?: InputMaybe<BuildParamsInput>;
}>;
@@ -4349,7 +4328,6 @@ export type CreateIosBuildMutationVariables = Exact<{
appId: Scalars['ID'];
job: IosJobInput;
metadata?: InputMaybe<BuildMetadataInput>;
buildParams?: InputMaybe<BuildParamsInput>;
}>;
@@ -4481,8 +4459,6 @@ export type GetAllBuildsForAppQuery = { __typename?: 'RootQuery', app: { __typen
export type GetChannelByNameForAppQueryVariables = Exact<{
appId: Scalars['String'];
channelName: Scalars['String'];
limit: Scalars['Int'];
offset: Scalars['Int'];
}>;
@@ -4538,11 +4514,10 @@ export type GetAllSubmissionsForAppQuery = { __typename?: 'RootQuery', app: { __
export type ViewAllUpdatesQueryVariables = Exact<{
appId: Scalars['String'];
limit: Scalars['Int'];
offset: Scalars['Int'];
}>;
export type ViewAllUpdatesQuery = { __typename?: 'RootQuery', app: { __typename?: 'AppQuery', byId: { __typename?: 'App', id: string, updates: Array<{ __typename?: 'Update', id: string, group: string, message?: string | null, createdAt: any, runtimeVersion: string, platform: string, actor?: { __typename?: 'Robot', firstName?: string | null, id: string } | { __typename?: 'User', username: string, id: string } | null, branch: { __typename?: 'UpdateBranch', id: string, name: string } }> } } };
export type ViewAllUpdatesQuery = { __typename?: 'RootQuery', app: { __typename?: 'AppQuery', byId: { __typename?: 'App', id: string, updateBranches: Array<{ __typename?: 'UpdateBranch', id: string, name: string, updates: Array<{ __typename?: 'Update', id: string, group: string, message?: string | null, createdAt: any, runtimeVersion: string, platform: string, actor?: { __typename?: 'Robot', firstName?: string | null, id: string } | { __typename?: 'User', username: string, id: string } | null }> }> } } };
export type ViewBranchUpdatesQueryVariables = Exact<{
appId: Scalars['String'];
@@ -4552,7 +4527,7 @@ export type ViewBranchUpdatesQueryVariables = Exact<{
}>;
export type ViewBranchUpdatesQuery = { __typename?: 'RootQuery', app: { __typename?: 'AppQuery', byId: { __typename?: 'App', id: string, updateBranchByName?: { __typename?: 'UpdateBranch', id: string, name: string, updates: Array<{ __typename?: 'Update', id: string, group: string, message?: string | null, createdAt: any, runtimeVersion: string, platform: string, manifestFragment: string, actor?: { __typename?: 'Robot', firstName?: string | null, id: string } | { __typename?: 'User', username: string, id: string } | null, branch: { __typename?: 'UpdateBranch', id: string, name: string } }> } | null } } };
export type ViewBranchUpdatesQuery = { __typename?: 'RootQuery', app: { __typename?: 'AppQuery', byId: { __typename?: 'App', id: string, updateBranchByName?: { __typename?: 'UpdateBranch', id: string, name: string, updates: Array<{ __typename?: 'Update', id: string, group: string, message?: string | null, createdAt: any, runtimeVersion: string, platform: string, manifestFragment: string, actor?: { __typename?: 'Robot', firstName?: string | null, id: string } | { __typename?: 'User', username: string, id: string } | null }> } | null } } };
export type CurrentUserQueryVariables = Exact<{ [key: string]: never; }>;
@@ -7,7 +7,6 @@ import {
AndroidJobInput,
BuildFragment,
BuildMetadataInput,
BuildParamsInput,
CreateAndroidBuildMutation,
CreateAndroidBuildMutationVariables,
CreateIosBuildMutation,
@@ -27,7 +26,6 @@ export const BuildMutation = {
appId: string;
job: AndroidJobInput;
metadata: BuildMetadataInput;
buildParams: BuildParamsInput;
}): Promise<BuildResult> {
const data = await withErrorHandlingAsync(
graphqlClient
@@ -37,15 +35,9 @@ export const BuildMutation = {
$appId: ID!
$job: AndroidJobInput!
$metadata: BuildMetadataInput
$buildParams: BuildParamsInput
) {
build {
createAndroidBuild(
appId: $appId
job: $job
metadata: $metadata
buildParams: $buildParams
) {
createAndroidBuild(appId: $appId, job: $job, metadata: $metadata) {
build {
id
...BuildFragment
@@ -70,7 +62,6 @@ export const BuildMutation = {
appId: string;
job: IosJobInput;
metadata: BuildMetadataInput;
buildParams: BuildParamsInput;
}): Promise<BuildResult> {
const data = await withErrorHandlingAsync(
graphqlClient
@@ -80,15 +71,9 @@ export const BuildMutation = {
$appId: ID!
$job: IosJobInput!
$metadata: BuildMetadataInput
$buildParams: BuildParamsInput
) {
build {
createIosBuild(
appId: $appId
job: $job
metadata: $metadata
buildParams: $buildParams
) {
createIosBuild(appId: $appId, job: $job, metadata: $metadata) {
build {
id
...BuildFragment
@@ -14,7 +14,7 @@ import {
} from '../generated';
import { BuildFragmentNode } from '../types/Build';
export type BuildsQuery = {
type BuildsQuery = {
offset?: number;
limit?: number;
filter?: {
@@ -3,14 +3,10 @@ import gql from 'graphql-tag';
import { graphqlClient, withErrorHandlingAsync } from '../client';
import { GetChannelByNameForAppQuery, GetChannelByNameForAppQueryVariables } from '../generated';
const BRANCHES_LIMIT = 50;
export const ChannelQuery = {
async getUpdateChannelByNameForAppAsync({
appId,
channelName,
offset = 0,
limit = BRANCHES_LIMIT,
}: GetChannelByNameForAppQueryVariables): Promise<
GetChannelByNameForAppQuery['app']['byId']['updateChannelByName']
> {
@@ -22,12 +18,7 @@ export const ChannelQuery = {
graphqlClient
.query<GetChannelByNameForAppQuery, GetChannelByNameForAppQueryVariables>(
gql`
query GetChannelByNameForApp(
$appId: String!
$channelName: String!
$limit: Int!
$offset: Int!
) {
query GetChannelByNameForApp($appId: String!, $channelName: String!) {
app {
byId(appId: $appId) {
id
@@ -36,10 +27,10 @@ export const ChannelQuery = {
name
createdAt
branchMapping
updateBranches(offset: $offset, limit: $limit) {
updateBranches(offset: 0, limit: 1000) {
id
name
updates(offset: 0, limit: 1) {
updates(offset: 0, limit: 10) {
id
group
message
@@ -62,7 +53,7 @@ export const ChannelQuery = {
}
}
`,
{ appId, channelName, offset, limit },
{ appId, channelName },
{ additionalTypenames: ['UpdateChannel', 'UpdateBranch', 'Update'] }
)
.toPromise()
@@ -8,41 +8,41 @@ import {
ViewBranchUpdatesQueryVariables,
} from '../generated';
const UPDATE_LIMIT = 50;
export const viewBranchUpdatesQueryUpdateLimit = 300;
type ViewBranchUpdatesQueryVariablesWithOptionalLimitAndOffset =
Partial<ViewBranchUpdatesQueryVariables> &
Pick<ViewBranchUpdatesQueryVariables, 'appId' | 'name'>;
export const UpdateQuery = {
async viewAllAsync({
appId,
limit = UPDATE_LIMIT,
offset = 0,
}: ViewAllUpdatesQueryVariables): Promise<ViewAllUpdatesQuery> {
async viewAllAsync({ appId }: { appId: string }): Promise<ViewAllUpdatesQuery> {
return withErrorHandlingAsync(
graphqlClient
.query<ViewAllUpdatesQuery, ViewAllUpdatesQueryVariables>(
gql`
query ViewAllUpdates($appId: String!, $limit: Int!, $offset: Int!) {
query ViewAllUpdates($appId: String!, $limit: Int!) {
app {
byId(appId: $appId) {
id
updates(offset: $offset, limit: $limit) {
updateBranches(offset: 0, limit: $limit) {
id
group
message
createdAt
runtimeVersion
platform
actor {
name
updates(offset: 0, limit: $limit) {
id
... on User {
username
group
message
createdAt
runtimeVersion
platform
actor {
id
... on User {
username
}
... on Robot {
firstName
}
}
... on Robot {
firstName
}
}
branch {
id
name
}
}
}
@@ -51,8 +51,7 @@ export const UpdateQuery = {
`,
{
appId,
limit,
offset,
limit: viewBranchUpdatesQueryUpdateLimit,
},
{ additionalTypenames: ['UpdateBranch', 'Update'] }
)
@@ -62,9 +61,9 @@ export const UpdateQuery = {
async viewBranchAsync({
appId,
name,
limit = UPDATE_LIMIT,
limit = viewBranchUpdatesQueryUpdateLimit,
offset = 0,
}: ViewBranchUpdatesQueryVariables) {
}: ViewBranchUpdatesQueryVariablesWithOptionalLimitAndOffset) {
return withErrorHandlingAsync<ViewBranchUpdatesQuery>(
graphqlClient
.query<ViewBranchUpdatesQuery, ViewBranchUpdatesQueryVariables>(
@@ -93,10 +92,6 @@ export const UpdateQuery = {
firstName
}
}
branch {
id
name
}
}
}
}
@@ -4,7 +4,7 @@ export const UpdateBranchFragmentNode = gql`
fragment UpdateBranchFragment on UpdateBranch {
id
name
updates(offset: 0, limit: 1) {
updates(offset: 0, limit: 10) {
id
actor {
__typename
-4
View File
@@ -49,10 +49,6 @@ export default class Log {
Log.log(`${chalk.green(logSymbols.success)} ${message}`);
}
public static withCross(...args: any[]): void {
Log.consoleLog(chalk.red(figures.cross), ...args);
}
public static withTick(...args: any[]): void {
Log.consoleLog(chalk.green(figures.tick), ...args);
}
@@ -1,84 +1,23 @@
import { AgeRatingDeclaration, KidsAge, Rating } from '@expo/apple-utils';
import { AgeRatingDeclaration, KidsAge } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
// @ts-expect-error: Deprecated property `gamblingAndContests` needs to be deleted from the types
// These attributes is what we get from the API when no questions are answered
export const emptyAdvisory: AttributesOf<AgeRatingDeclaration> = {
export const kidsSixToEightAdvisory: AttributesOf<AgeRatingDeclaration> = {
alcoholTobaccoOrDrugUseOrReferences: null,
contests: null,
gamblingSimulated: null,
horrorOrFearThemes: null,
matureOrSuggestiveThemes: null,
gambling: null,
contests: null,
medicalOrTreatmentInformation: null,
profanityOrCrudeHumor: null,
sexualContentGraphicAndNudity: null,
sexualContentOrNudity: null,
horrorOrFearThemes: null,
matureOrSuggestiveThemes: null,
violenceCartoonOrFantasy: null,
violenceRealistic: null,
violenceRealisticProlongedGraphicOrSadistic: null,
gambling: false,
violenceRealistic: null,
unrestrictedWebAccess: false,
kidsAgeBand: null,
seventeenPlus: false,
};
// @ts-expect-error: Deprecated property `gamblingAndContests` needs to be deleted from the types
export const leastRestrictiveAdvisory: AttributesOf<AgeRatingDeclaration> = {
alcoholTobaccoOrDrugUseOrReferences: Rating.NONE,
contests: Rating.NONE,
gamblingSimulated: Rating.NONE,
horrorOrFearThemes: Rating.NONE,
matureOrSuggestiveThemes: Rating.NONE,
medicalOrTreatmentInformation: Rating.NONE,
profanityOrCrudeHumor: Rating.NONE,
sexualContentGraphicAndNudity: Rating.NONE,
sexualContentOrNudity: Rating.NONE,
violenceCartoonOrFantasy: Rating.NONE,
violenceRealistic: Rating.NONE,
violenceRealisticProlongedGraphicOrSadistic: Rating.NONE,
gambling: false,
unrestrictedWebAccess: false,
kidsAgeBand: null,
seventeenPlus: false,
};
// @ts-expect-error: Deprecated property `gamblingAndContests` needs to be deleted from the types
export const mostRestrictiveAdvisory: AttributesOf<AgeRatingDeclaration> = {
alcoholTobaccoOrDrugUseOrReferences: Rating.FREQUENT_OR_INTENSE,
contests: Rating.FREQUENT_OR_INTENSE,
gamblingSimulated: Rating.FREQUENT_OR_INTENSE,
horrorOrFearThemes: Rating.FREQUENT_OR_INTENSE,
matureOrSuggestiveThemes: Rating.FREQUENT_OR_INTENSE,
medicalOrTreatmentInformation: Rating.FREQUENT_OR_INTENSE,
profanityOrCrudeHumor: Rating.FREQUENT_OR_INTENSE,
sexualContentGraphicAndNudity: Rating.FREQUENT_OR_INTENSE,
sexualContentOrNudity: Rating.FREQUENT_OR_INTENSE,
violenceCartoonOrFantasy: Rating.FREQUENT_OR_INTENSE,
violenceRealistic: Rating.FREQUENT_OR_INTENSE,
violenceRealisticProlongedGraphicOrSadistic: Rating.FREQUENT_OR_INTENSE,
gambling: true,
unrestrictedWebAccess: true,
kidsAgeBand: null,
seventeenPlus: true,
};
// @ts-expect-error: Deprecated property `gamblingAndContests` needs to be deleted from the types
export const kidsSixToEightAdvisory: AttributesOf<AgeRatingDeclaration> = {
alcoholTobaccoOrDrugUseOrReferences: Rating.NONE,
contests: Rating.NONE,
gamblingSimulated: Rating.NONE,
horrorOrFearThemes: Rating.NONE,
matureOrSuggestiveThemes: Rating.NONE,
medicalOrTreatmentInformation: Rating.NONE,
profanityOrCrudeHumor: Rating.NONE,
sexualContentGraphicAndNudity: Rating.NONE,
sexualContentOrNudity: Rating.NONE,
violenceCartoonOrFantasy: Rating.NONE,
violenceRealistic: Rating.NONE,
violenceRealisticProlongedGraphicOrSadistic: Rating.NONE,
gambling: false,
unrestrictedWebAccess: false,
kidsAgeBand: KidsAge.SIX_TO_EIGHT,
seventeenPlus: false,
gamblingAndContests: false,
};
@@ -1,25 +0,0 @@
import { AppStoreReviewDetail } from '@expo/apple-utils';
import { AttributesOf } from '../../../../utils/asc';
export const nameOnlyReviewDetails: AttributesOf<AppStoreReviewDetail> = {
contactFirstName: 'Evan',
contactLastName: 'Bacon',
contactEmail: '[email protected]',
contactPhone: '+1 (555) 555-5555',
demoAccountName: null,
demoAccountPassword: null,
demoAccountRequired: null,
notes: null,
};
export const nameAndDemoReviewDetails: AttributesOf<AppStoreReviewDetail> = {
contactFirstName: 'Evan',
contactLastName: 'Bacon',
contactEmail: '[email protected]',
contactPhone: '+1 (555) 555-5555',
demoAccountName: '[email protected]',
demoAccountPassword: 'secretpassword',
demoAccountRequired: true,
notes: null,
};
@@ -1,19 +0,0 @@
import { AppleConfigReader } from '../reader';
import { leastRestrictiveAdvisory, mostRestrictiveAdvisory } from './fixtures/ageRatingDeclaration';
describe('setAgeRating', () => {
it('ignores advisory when not set', () => {
const reader = new AppleConfigReader({ advisory: undefined });
expect(reader.getAgeRating()).toBeNull();
});
it('auto-fills least restrictive advisory', () => {
const reader = new AppleConfigReader({ advisory: {} });
expect(reader.getAgeRating()).toMatchObject(leastRestrictiveAdvisory);
});
it('returns most restrictive advisory', () => {
const reader = new AppleConfigReader({ advisory: mostRestrictiveAdvisory });
expect(reader.getAgeRating()).toMatchObject(mostRestrictiveAdvisory);
});
});
@@ -1,13 +1,7 @@
import { AppleConfigWriter } from '../writer';
import {
emptyAdvisory,
kidsSixToEightAdvisory,
leastRestrictiveAdvisory,
mostRestrictiveAdvisory,
} from './fixtures/ageRatingDeclaration';
import { kidsSixToEightAdvisory } from './fixtures/ageRatingDeclaration';
import { primaryAndSecondaryCategory, secondaryOnlyCategory } from './fixtures/appInfo';
import { dutchInfo, englishInfo } from './fixtures/appInfoLocalization';
import { nameAndDemoReviewDetails, nameOnlyReviewDetails } from './fixtures/appStoreReviewDetail';
import { automaticRelease, manualRelease, scheduledRelease } from './fixtures/appStoreVersion';
import { dutchVersion, englishVersion } from './fixtures/appStoreVersionLocalization';
@@ -22,23 +16,11 @@ describe('toSchema', () => {
});
describe('setAgeRating', () => {
it('auto-fills least restrictive advisory', () => {
const writer = new AppleConfigWriter();
writer.setAgeRating(emptyAdvisory);
expect(writer.schema.advisory).toMatchObject(leastRestrictiveAdvisory);
});
it('modifies kids band rating', () => {
it('modifies the advisory', () => {
const writer = new AppleConfigWriter();
writer.setAgeRating(kidsSixToEightAdvisory);
expect(writer.schema.advisory).toMatchObject(kidsSixToEightAdvisory);
});
it('modifies most restrictive advisory', () => {
const writer = new AppleConfigWriter();
writer.setAgeRating(mostRestrictiveAdvisory);
expect(writer.schema.advisory).toMatchObject(mostRestrictiveAdvisory);
});
});
describe('setInfoLocale', () => {
@@ -117,16 +99,18 @@ describe('setVersionRelease', () => {
});
});
it('does not modify manual release', () => {
it('modifies manual release', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(manualRelease);
expect(writer.schema.release).toBeUndefined();
expect(writer.schema.release).toMatchObject({
automaticRelease: false,
});
});
it('overwrites all release fields', () => {
const writer = new AppleConfigWriter();
writer.setVersionRelease(scheduledRelease);
writer.setVersionRelease(automaticRelease);
writer.setVersionRelease(manualRelease);
expect(writer.schema.release).not.toHaveProperty('autoReleaseDate');
});
});
@@ -165,46 +149,3 @@ describe('setVersionLocale', () => {
});
});
});
describe('setReviewDetails', () => {
it('modifies name only review details', () => {
const writer = new AppleConfigWriter();
writer.setReviewDetails(nameOnlyReviewDetails);
expect(writer.schema.review).toMatchObject({
firstName: nameOnlyReviewDetails.contactFirstName,
lastName: nameOnlyReviewDetails.contactLastName,
email: nameOnlyReviewDetails.contactEmail,
phone: nameOnlyReviewDetails.contactPhone,
demoUsername: undefined,
demoPassword: undefined,
demoRequired: undefined,
notes: undefined,
});
});
it('modifies name and demo review details', () => {
const writer = new AppleConfigWriter();
writer.setReviewDetails(nameAndDemoReviewDetails);
expect(writer.schema.review).toMatchObject({
firstName: nameAndDemoReviewDetails.contactFirstName,
lastName: nameAndDemoReviewDetails.contactLastName,
email: nameAndDemoReviewDetails.contactEmail,
phone: nameAndDemoReviewDetails.contactPhone,
demoUsername: nameAndDemoReviewDetails.demoAccountName,
demoPassword: nameAndDemoReviewDetails.demoAccountPassword,
demoRequired: nameAndDemoReviewDetails.demoAccountRequired,
notes: undefined,
});
});
it('replaces existing review details', () => {
const writer = new AppleConfigWriter();
writer.setReviewDetails(nameAndDemoReviewDetails);
writer.setReviewDetails(nameOnlyReviewDetails);
expect(writer.schema.review).toMatchObject({
demoUsername: undefined,
demoPassword: undefined,
demoRequired: undefined,
});
});
});
@@ -1,11 +1,9 @@
import {
AgeRatingDeclaration,
AppInfoLocalization,
AppStoreReviewDetail,
AppStoreVersion,
AppStoreVersionLocalization,
CategoryIds,
Rating,
ReleaseType,
} from '@expo/apple-utils';
@@ -27,31 +25,7 @@ export class AppleConfigReader {
public constructor(public readonly schema: AppleMetadata) {}
public getAgeRating(): Partial<AttributesOf<AgeRatingDeclaration>> | null {
const attributes = this.schema.advisory;
if (!attributes) {
return null;
}
return {
alcoholTobaccoOrDrugUseOrReferences:
attributes.alcoholTobaccoOrDrugUseOrReferences ?? Rating.NONE,
contests: attributes.contests ?? Rating.NONE,
gamblingSimulated: attributes.gamblingSimulated ?? Rating.NONE,
horrorOrFearThemes: attributes.horrorOrFearThemes ?? Rating.NONE,
matureOrSuggestiveThemes: attributes.matureOrSuggestiveThemes ?? Rating.NONE,
medicalOrTreatmentInformation: attributes.medicalOrTreatmentInformation ?? Rating.NONE,
profanityOrCrudeHumor: attributes.profanityOrCrudeHumor ?? Rating.NONE,
sexualContentGraphicAndNudity: attributes.sexualContentGraphicAndNudity ?? Rating.NONE,
sexualContentOrNudity: attributes.sexualContentOrNudity ?? Rating.NONE,
violenceCartoonOrFantasy: attributes.violenceCartoonOrFantasy ?? Rating.NONE,
violenceRealistic: attributes.violenceRealistic ?? Rating.NONE,
violenceRealisticProlongedGraphicOrSadistic:
attributes.violenceRealisticProlongedGraphicOrSadistic ?? Rating.NONE,
gambling: attributes.gambling ?? false,
unrestrictedWebAccess: attributes.unrestrictedWebAccess ?? false,
kidsAgeBand: attributes.kidsAgeBand ?? null,
seventeenPlus: attributes.seventeenPlus ?? false,
};
return this.schema.advisory || null;
}
public getLocales(): string[] {
@@ -69,7 +43,7 @@ export class AppleConfigReader {
return {
locale,
name: info.title,
name: info.title ?? 'no name provided',
subtitle: info.subtitle,
privacyChoicesUrl: info.privacyChoicesUrl,
privacyPolicyText: info.privacyPolicyText,
@@ -145,23 +119,4 @@ export class AppleConfigReader {
supportUrl: info.supportUrl,
};
}
public getReviewDetails(): Partial<AttributesOf<AppStoreReviewDetail>> | null {
const review = this.schema.review;
if (!review) {
return null;
}
return {
contactFirstName: review.firstName,
contactLastName: review.lastName,
contactEmail: review.email,
contactPhone: review.phone,
demoAccountName: review.demoUsername,
demoAccountPassword: review.demoPassword,
demoAccountRequired: review.demoRequired,
notes: review.notes,
// TODO: add attachment
};
}
}
@@ -2,10 +2,8 @@ import {
AgeRatingDeclaration,
AppInfo,
AppInfoLocalization,
AppStoreReviewDetail,
AppStoreVersion,
AppStoreVersionLocalization,
Rating,
ReleaseType,
} from '@expo/apple-utils';
@@ -28,26 +26,7 @@ export class AppleConfigWriter {
}
public setAgeRating(attributes: AttributesOf<AgeRatingDeclaration>): void {
this.schema.advisory = {
alcoholTobaccoOrDrugUseOrReferences:
attributes.alcoholTobaccoOrDrugUseOrReferences ?? Rating.NONE,
contests: attributes.contests ?? Rating.NONE,
gamblingSimulated: attributes.gamblingSimulated ?? Rating.NONE,
horrorOrFearThemes: attributes.horrorOrFearThemes ?? Rating.NONE,
matureOrSuggestiveThemes: attributes.matureOrSuggestiveThemes ?? Rating.NONE,
medicalOrTreatmentInformation: attributes.medicalOrTreatmentInformation ?? Rating.NONE,
profanityOrCrudeHumor: attributes.profanityOrCrudeHumor ?? Rating.NONE,
sexualContentGraphicAndNudity: attributes.sexualContentGraphicAndNudity ?? Rating.NONE,
sexualContentOrNudity: attributes.sexualContentOrNudity ?? Rating.NONE,
violenceCartoonOrFantasy: attributes.violenceCartoonOrFantasy ?? Rating.NONE,
violenceRealistic: attributes.violenceRealistic ?? Rating.NONE,
violenceRealisticProlongedGraphicOrSadistic:
attributes.violenceRealisticProlongedGraphicOrSadistic ?? Rating.NONE,
gambling: attributes.gambling ?? false,
unrestrictedWebAccess: attributes.unrestrictedWebAccess ?? false,
kidsAgeBand: attributes.kidsAgeBand ?? null,
seventeenPlus: attributes.seventeenPlus ?? false,
};
this.schema.advisory = attributes;
}
public setInfoLocale(attributes: AttributesOf<AppInfoLocalization>): void {
@@ -56,7 +35,7 @@ export class AppleConfigWriter {
this.schema.info[attributes.locale] = {
...existing,
title: attributes.name ?? '',
title: attributes.name ?? 'no name provided',
subtitle: optional(attributes.subtitle),
privacyPolicyUrl: optional(attributes.privacyPolicyUrl),
privacyPolicyText: optional(attributes.privacyPolicyText),
@@ -98,9 +77,9 @@ export class AppleConfigWriter {
}
if (attributes.releaseType === ReleaseType.MANUAL) {
// ReleaseType.MANUAL is the default behavior, so we don't need to configure it.
// Setting `"automaticRelease": false` is a bit confusing for people who don't know what automaticRelease does.
this.schema.release = undefined;
this.schema.release = {
automaticRelease: false,
};
}
}
@@ -120,20 +99,6 @@ export class AppleConfigWriter {
supportUrl: optional(attributes.supportUrl),
};
}
public setReviewDetails(attributes: AttributesOf<AppStoreReviewDetail>): void {
this.schema.review = {
firstName: attributes.contactFirstName ?? '',
lastName: attributes.contactLastName ?? '',
email: attributes.contactEmail ?? '',
phone: attributes.contactPhone ?? '',
demoUsername: optional(attributes.demoAccountName),
demoPassword: optional(attributes.demoAccountPassword),
demoRequired: optional(attributes.demoAccountRequired),
notes: optional(attributes.notes),
// TODO: add attachment
};
}
}
/** Helper function to convert `T | null` to `T | undefined`, required for the entity properties */
+1 -2
View File
@@ -2,14 +2,13 @@ import type { App } from '@expo/apple-utils';
import type { AgeRatingData } from './tasks/age-rating';
import type { AppInfoData } from './tasks/app-info';
import type { AppReviewData } from './tasks/app-review-detail';
import type { AppVersionData } from './tasks/app-version';
/**
* The fully prepared apple data, used within the `downloadAsync` or `uploadAsync` tasks.
* It contains references to each individual models, to either upload or download App Store data.
*/
export type AppleData = { app: App } & AppInfoData & AppVersionData & AgeRatingData & AppReviewData;
export type AppleData = { app: App } & AppInfoData & AppVersionData & AgeRatingData;
/**
* The unprepared partial apple data, used within the `prepareAsync` tasks.
@@ -1,151 +0,0 @@
import { AppStoreReviewAttachment, AppStoreReviewDetail, AppStoreVersion } from '@expo/apple-utils';
import nock from 'nock';
import { AppleConfigReader } from '../../config/reader';
import { AppleConfigWriter } from '../../config/writer';
import { AppReviewDetailTask } from '../app-review-detail';
import { requestContext } from './fixtures/requestContext';
jest.mock('../../../../ora');
jest.mock('../../config/writer');
describe(AppReviewDetailTask, () => {
describe('prepareAsync', () => {
it('aborts when version is not loaded', async () => {
const promise = new AppReviewDetailTask().prepareAsync({ context: {} as any });
await expect(promise).rejects.toThrow('version not init');
});
it('loads review details from app version', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.get(`/v1/${AppStoreVersion.type}/stub-id/appStoreReviewDetail`)
.query((params: any) => params['include'] === AppStoreReviewAttachment.type)
.reply(200, require('./fixtures/appStoreVersions/get-appStoreReviewDetail-200.json'));
const context: any = {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
};
await new AppReviewDetailTask().prepareAsync({ context });
expect(context.reviewDetail).toBeInstanceOf(AppStoreReviewDetail);
expect(scope.isDone()).toBeTruthy();
});
});
describe('downloadAsync', () => {
it('sets review details when loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
const reviewDetail = new AppStoreReviewDetail(requestContext, 'stub-id', {} as any);
await new AppReviewDetailTask().downloadAsync({
config: writer,
context: { reviewDetail } as any,
});
expect(writer.setReviewDetails).toBeCalledWith(reviewDetail.attributes);
});
it('skips when no review details are loaded', async () => {
const writer = jest.mocked(new AppleConfigWriter());
await new AppReviewDetailTask().downloadAsync({
config: writer,
context: {} as any,
});
expect(writer.setReviewDetails).not.toBeCalled();
});
});
describe('uploadAsync', () => {
it('skips when review details are not configured', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.post(`/v1/${AppStoreReviewDetail.type}`)
.reply(201, require('./fixtures/appStoreReviewDetails/post-201.json'));
await new AppReviewDetailTask().uploadAsync({
config: new AppleConfigReader({
review: undefined,
}),
context: {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
} as any,
});
expect(scope.isDone()).toBeFalsy();
nock.cleanAll();
});
it('aborts when version is not loaded', async () => {
const promise = new AppReviewDetailTask().uploadAsync({
config: new AppleConfigReader({
review: {
firstName: 'Evan',
lastName: 'Bacon',
email: '[email protected]',
phone: '+1 555 555 5555',
},
}),
context: {} as any,
});
await expect(promise).rejects.toThrow('version not init');
});
it('updates review details when loaded', async () => {
const scope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppStoreReviewDetail.type}/APP_STORE_REVIEW_DETAILS_1`)
.reply(200, require('./fixtures/appStoreReviewDetails/patch-200.json'));
await new AppReviewDetailTask().uploadAsync({
config: new AppleConfigReader({
review: {
firstName: 'Evan',
lastName: 'Bacon',
email: '[email protected]',
phone: '+1 555 555 5555',
},
}),
context: {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
reviewDetail: new AppStoreReviewDetail(
requestContext,
'APP_STORE_REVIEW_DETAILS_1',
{} as any
),
} as any,
});
expect(scope.isDone()).toBeTruthy();
});
it('creates and updates review details when not loaded', async () => {
const createReviewDetailScope = nock('https://api.appstoreconnect.apple.com')
.post(`/v1/${AppStoreReviewDetail.type}`)
.reply(201, require('./fixtures/appStoreReviewDetails/post-201.json'));
const updateReviewDetailScope = nock('https://api.appstoreconnect.apple.com')
.patch(`/v1/${AppStoreReviewDetail.type}/APP_STORE_REVIEW_DETAILS_1`)
.reply(200, require('./fixtures/appStoreReviewDetails/patch-200.json'));
await new AppReviewDetailTask().uploadAsync({
config: new AppleConfigReader({
review: {
firstName: 'Evan',
lastName: 'Bacon',
email: '[email protected]',
phone: '+1 555 555 5555',
},
}),
context: {
version: new AppStoreVersion(requestContext, 'stub-id', {} as any),
} as any,
});
expect(createReviewDetailScope.isDone()).toBeTruthy();
expect(updateReviewDetailScope.isDone()).toBeTruthy();
});
});
});
@@ -1,36 +0,0 @@
{
"data": {
"type": "appStoreReviewDetails",
"id": "APP_STORE_REVIEW_DETAILS_1",
"attributes": {
"contactFirstName": "Evan",
"contactLastName": "Bacon",
"contactPhone": "+1-555-555-5555",
"contactEmail": "[email protected]",
"demoAccountName": null,
"demoAccountPassword": null,
"demoAccountRequired": false,
"notes": ""
},
"relationships": {
"appStoreReviewAttachments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appStoreReviewAttachments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appStoreReviewAttachments"
}
},
"appSandboxEntitlementUsages": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appSandboxEntitlementUsages",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appSandboxEntitlementUsages"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1"
}
}
@@ -1,36 +0,0 @@
{
"data": {
"type": "appStoreReviewDetails",
"id": "APP_STORE_REVIEW_DETAILS_1",
"attributes": {
"contactFirstName": "Evan",
"contactLastName": "Bacon",
"contactPhone": "+1-555-555-5555",
"contactEmail": "[email protected]",
"demoAccountName": null,
"demoAccountPassword": null,
"demoAccountRequired": false,
"notes": ""
},
"relationships": {
"appStoreReviewAttachments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appStoreReviewAttachments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appStoreReviewAttachments"
}
},
"appSandboxEntitlementUsages": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appSandboxEntitlementUsages",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appSandboxEntitlementUsages"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails"
}
}
@@ -1,6 +0,0 @@
{
"data": null,
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreVersions/APP_STORE_VERSION_1/appStoreReviewDetail?include=appStoreReviewAttachments"
}
}
@@ -1,36 +0,0 @@
{
"data": {
"type": "appStoreReviewDetails",
"id": "APP_STORE_REVIEW_DETAILS_1",
"attributes": {
"contactFirstName": "Evan",
"contactLastName": "Bacon",
"contactPhone": "+1-555-555-5555",
"contactEmail": "[email protected]",
"demoAccountName": null,
"demoAccountPassword": null,
"demoAccountRequired": false,
"notes": ""
},
"relationships": {
"appStoreReviewAttachments": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appStoreReviewAttachments",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appStoreReviewAttachments"
}
},
"appSandboxEntitlementUsages": {
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/relationships/appSandboxEntitlementUsages",
"related": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1/appSandboxEntitlementUsages"
}
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1"
}
},
"links": {
"self": "https://appstoreconnect.apple.com/iris/v1/appStoreReviewDetails/APP_STORE_REVIEW_DETAILS_1"
}
}
@@ -1,58 +0,0 @@
import { AppStoreReviewDetail } from '@expo/apple-utils';
import assert from 'assert';
import chalk from 'chalk';
import Log from '../../../log';
import { logAsync } from '../../utils/log';
import { AppleTask, TaskDownloadOptions, TaskPrepareOptions, TaskUploadOptions } from '../task';
export type AppReviewData = {
/** The current app info that should be edited */
reviewDetail: AppStoreReviewDetail;
};
/** Handle all contact, demo account, or instruction info that are required for the App Store review team. */
export class AppReviewDetailTask extends AppleTask {
public name = (): string => 'app review detail';
public async prepareAsync({ context }: TaskPrepareOptions): Promise<void> {
assert(context.version, `App version not initialized, can't download store review details`);
context.reviewDetail = (await context.version.getAppStoreReviewDetailAsync()) ?? undefined;
}
public async downloadAsync({ config, context }: TaskDownloadOptions): Promise<void> {
if (context.reviewDetail) {
config.setReviewDetails(context.reviewDetail.attributes);
}
}
public async uploadAsync({ config, context }: TaskUploadOptions): Promise<void> {
const reviewDetail = config.getReviewDetails();
if (!reviewDetail) {
return Log.log(chalk`{dim - Skipped store review details, not configured}`);
}
assert(context.version, `App version not initialized, can't upload store review details`);
const { versionString } = context.version.attributes;
if (!context.reviewDetail) {
// We can't set the demo required property when creating, omit it from the request
const { demoAccountRequired, ...reviewDetailsToCreate } = reviewDetail;
context.reviewDetail = await logAsync(
() => context.version.createReviewDetailAsync(reviewDetailsToCreate),
{
pending: `Creating store review details for ${chalk.bold(versionString)}...`,
success: `Created store review details for ${chalk.bold(versionString)}`,
failure: `Failed creating store review details for ${chalk.bold(versionString)}`,
}
);
}
context.reviewDetail = await logAsync(() => context.reviewDetail.updateAsync(reviewDetail), {
pending: `Updating store review details for ${chalk.bold(versionString)}...`,
success: `Updated store review details for ${chalk.bold(versionString)}`,
failure: `Failed updating store review details for ${chalk.bold(versionString)}`,
});
}
}
@@ -80,8 +80,8 @@ export class AppVersionTask extends AppleTask {
() => context.version.updateAsync({ ...version, ...release }),
{
pending: `Updating ${description} info for ${chalk.bold(versionString)}...`,
success: `Updated ${description} info for ${chalk.bold(versionString)}`,
failure: `Failed updating ${description} info for ${chalk.bold(versionString)}`,
success: `Updated ${description} info for ${chalk.bold(versionString)}...`,
failure: `Failed updating ${description} info for ${chalk.bold(versionString)}...`,
}
);
}
@@ -2,12 +2,11 @@ import { MetadataContext } from '../../context';
import { AppleTask } from '../task';
import { AgeRatingTask } from './age-rating';
import { AppInfoTask } from './app-info';
import { AppReviewDetailTask } from './app-review-detail';
import { AppVersionTask } from './app-version';
/**
* List of all eligible tasks to sync local store configuration to the App store.
*/
export function createAppleTasks(_ctx: MetadataContext): AppleTask[] {
return [new AppVersionTask(), new AppInfoTask(), new AgeRatingTask(), new AppReviewDetailTask()];
return [new AppVersionTask(), new AppInfoTask(), new AgeRatingTask()];
}
+5 -6
View File
@@ -45,13 +45,12 @@ export interface AppleInfo {
}
export interface AppleReview {
firstName: string;
lastName: string;
phone: string;
email: string;
firstName?: string;
lastName?: string;
phone?: string;
email?: string;
demoUsername?: string;
demoPassword?: string;
demoRequired?: boolean;
notes?: string;
// attachment?: string;
attachment?: string;
}
+23 -29
View File
@@ -4,12 +4,12 @@ import path from 'path';
import { MetadataEvent } from '../analytics/events';
import Log from '../log';
import { confirmAsync } from '../prompts';
import { AppleData } from './apple/data';
import { AppleData, PartialAppleData } from './apple/data';
import { createAppleTasks } from './apple/tasks';
import { createAppleWriter } from './config';
import { MetadataContext, ensureMetadataAppStoreAuthenticatedAsync } from './context';
import { MetadataDownloadError, MetadataValidationError } from './errors';
import { subscribeTelemetry } from './utils/telemetry';
import { withTelemetryAsync } from './utils/telemetry';
/**
* Generate a local store configuration from the stores.
@@ -29,44 +29,38 @@ export async function downloadMetadataAsync(metadataCtx: MetadataContext): Promi
}
const { app, auth } = await ensureMetadataAppStoreAuthenticatedAsync(metadataCtx);
const { unsubscribeTelemetry, executionId } = subscribeTelemetry(
MetadataEvent.APPLE_METADATA_DOWNLOAD,
{ app, auth }
);
Log.addNewLineIfNone();
Log.log('Downloading App Store configuration...');
const errors: Error[] = [];
const config = createAppleWriter();
const tasks = createAppleTasks(metadataCtx);
const taskCtx = { app };
await withTelemetryAsync(MetadataEvent.APPLE_METADATA_DOWNLOAD, { app, auth }, async () => {
const errors: Error[] = [];
const config = createAppleWriter();
const tasks = createAppleTasks(metadataCtx);
const taskCtx: PartialAppleData = { app };
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
}
}
}
for (const task of tasks) {
try {
await task.downloadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
for (const task of tasks) {
try {
await task.downloadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
}
}
}
try {
await fs.writeJson(filePath, config.toSchema(), { spaces: 2 });
} finally {
unsubscribeTelemetry();
}
if (errors.length > 0) {
throw new MetadataDownloadError(errors, executionId);
}
if (errors.length > 0) {
throw new MetadataDownloadError(errors);
}
});
return filePath;
}
+25 -19
View File
@@ -14,6 +14,17 @@ export class MetadataValidationError extends Error {
}
}
/**
* During telemetry actions, a random exection ID is generated.
* This ID should be communicated to users and reported to us.
* With that ID, we can look up the failed requests and help solve the issue.
*/
export class MetadataTelemetryError extends Error {
public constructor(public readonly originalError: Error, public readonly executionId: string) {
super(originalError.message);
}
}
/**
* If a single entity failed to update, we don't block the other entities from uploading.
* We still attempt to update the data in the stores as much as possible.
@@ -21,7 +32,7 @@ export class MetadataValidationError extends Error {
* It contains that list of encountered errors to present to the user.
*/
export class MetadataUploadError extends Error {
public constructor(public readonly errors: Error[], public readonly executionId: string) {
public constructor(public readonly errors: Error[]) {
super(
`Store configuration upload encountered ${
errors.length === 1 ? 'an error' : `${errors.length} errors`
@@ -32,12 +43,12 @@ export class MetadataUploadError extends Error {
/**
* If a single entity failed to download, we don't block the other entities from downloading.
* We sill attempt to pull in the data from the stores as much as possible.
* Because of that, we keep track of any errors envountered and throw this generic error.
* We still attempt to pull in the data from the stores as much as possible.
* Because of that, we keep track of any errors encountered and throw this generic error.
* It contains that list of encountered errors to present to the user.
*/
export class MetadataDownloadError extends Error {
public constructor(public readonly errors: Error[], public readonly executionId: string) {
public constructor(public readonly errors: Error[]) {
super(
`Store configuration download encountered ${
errors.length === 1 ? 'an error' : `${errors.length} errors`
@@ -46,26 +57,21 @@ export class MetadataDownloadError extends Error {
}
}
/**
* Log the encountered metadata validation error in detail for the user.
* This should help communicate any possible configuration error and help the user resolve it.
*/
export function logMetadataValidationError(error: MetadataValidationError): void {
Log.newLine();
Log.error(chalk.bold(error.message));
if (error.errors?.length > 0) {
// TODO(cedric): group errors by property to make multiple errors for same property more readable
Log.log(error.errors.map(err => ` - ${chalk.bold(err.dataPath)} ${err.message}`).join('\n'));
}
}
/**
* Handle a thrown metadata error by informing the user what went wrong.
* If a normal error is thrown, this method will re-throw that error to avoid consuming it.
*/
export function handleMetadataError(error: Error): void {
export function handleMetadataError(thrownError: Error): void {
const error =
thrownError instanceof MetadataTelemetryError ? thrownError.originalError : thrownError;
if (error instanceof MetadataValidationError) {
return logMetadataValidationError(error);
Log.newLine();
Log.error(chalk.bold(error.message));
if (error.errors?.length > 0) {
Log.log(error.errors.map(err => ` - ${err.dataPath} ${err.message}`).join('\n'));
}
return;
}
if (error instanceof MetadataDownloadError || error instanceof MetadataUploadError) {
+26 -43
View File
@@ -3,13 +3,12 @@ import path from 'path';
import { MetadataEvent } from '../analytics/events';
import Log from '../log';
import { confirmAsync } from '../prompts';
import { AppleData } from './apple/data';
import { AppleData, PartialAppleData } from './apple/data';
import { createAppleTasks } from './apple/tasks';
import { createAppleReader, validateConfig } from './config';
import { MetadataContext, ensureMetadataAppStoreAuthenticatedAsync } from './context';
import { MetadataUploadError, MetadataValidationError, logMetadataValidationError } from './errors';
import { subscribeTelemetry } from './utils/telemetry';
import { MetadataUploadError, MetadataValidationError } from './errors';
import { withTelemetryAsync } from './utils/telemetry';
/**
* Sync a local store configuration with the stores.
@@ -23,58 +22,42 @@ export async function uploadMetadataAsync(
throw new MetadataValidationError(`Store configuration file not found "${filePath}"`);
}
const { app, auth } = await ensureMetadataAppStoreAuthenticatedAsync(metadataCtx);
const fileData = await fs.readJson(filePath);
const { valid, errors: validationErrors } = validateConfig(fileData);
if (!valid) {
const error = new MetadataValidationError(`Store configuration errors found`, validationErrors);
logMetadataValidationError(error);
Log.newLine();
Log.warn(
'Without further updates, the current store configuration may fail to be synchronized with the App Store or pass App Store review.'
);
const attempt = await confirmAsync({
message: 'Do you still want to push the store configuration?',
});
if (!attempt) {
throw error;
}
throw new MetadataValidationError(`Store configuration errors found`, validationErrors);
}
const { app, auth } = await ensureMetadataAppStoreAuthenticatedAsync(metadataCtx);
const { unsubscribeTelemetry, executionId } = subscribeTelemetry(
MetadataEvent.APPLE_METADATA_UPLOAD,
{ app, auth }
);
Log.addNewLineIfNone();
Log.log('Uploading App Store configuration...');
const errors: Error[] = [];
const config = createAppleReader(fileData);
const tasks = createAppleTasks(metadataCtx);
const taskCtx = { app };
await withTelemetryAsync(MetadataEvent.APPLE_METADATA_UPLOAD, { app, auth }, async () => {
const errors: Error[] = [];
const config = createAppleReader(fileData);
const tasks = createAppleTasks(metadataCtx);
const taskCtx: PartialAppleData = { app };
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
for (const task of tasks) {
try {
await task.prepareAsync({ context: taskCtx });
} catch (error: any) {
errors.push(error);
}
}
}
for (const task of tasks) {
try {
await task.uploadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
for (const task of tasks) {
try {
await task.uploadAsync({ config, context: taskCtx as AppleData });
} catch (error: any) {
errors.push(error);
}
}
}
unsubscribeTelemetry();
if (errors.length > 0) {
throw new MetadataUploadError(errors, executionId);
}
if (errors.length > 0) {
throw new MetadataUploadError(errors);
}
});
return { appleLink: `https://appstoreconnect.apple.com/apps/${app.id}/appstore` };
}
@@ -1,23 +1,73 @@
import { App } from '@expo/apple-utils';
import { App, getRequestClient } from '@expo/apple-utils';
import { TelemetryContext, makeDataScrubber } from '../telemetry';
import { MetadataEvent } from '../../../analytics/events';
import { MetadataTelemetryError } from '../../errors';
import { TelemetryContext, makeDataScrubber, withTelemetryAsync } from '../telemetry';
const stub: TelemetryContext = {
// Only the App ID is considered to be sensitive
app: new App({} as any, 'SECRET_APP_ID', {} as any),
// Only the token properties and user credentials are considered to be sensitive
auth: {
username: 'SECRET_USERNAME',
password: 'SECRET_PASSWORD',
context: {
token: 'SECRET_TOKEN',
teamId: 'SECRET_TEAM_ID',
providerId: 1337,
},
} as any,
};
describe(withTelemetryAsync, () => {
afterEach(() => {
jest.clearAllMocks();
});
it('detaches interceptors after action resolved', async () => {
const { interceptors } = getRequestClient();
const ejectInterceptor = jest.spyOn(interceptors.response, 'eject');
await withTelemetryAsync(MetadataEvent.APPLE_METADATA_DOWNLOAD, stub, async () => {
return 'testing resolved telemetry action';
});
expect(ejectInterceptor).toBeCalledWith(expect.any(Number));
});
it('detaches interceptors after action rejected', async () => {
const { interceptors } = getRequestClient();
const ejectInterceptor = jest.spyOn(interceptors.response, 'eject');
try {
await withTelemetryAsync(MetadataEvent.APPLE_METADATA_DOWNLOAD, stub, async () => {
throw new Error('testing rejected telemetry action');
});
} catch {
// intentional failure
}
expect(ejectInterceptor).toBeCalledWith(expect.any(Number));
});
it('adds executionId to thrown errors', async () => {
let caughtError: null | Error = null;
try {
await withTelemetryAsync(MetadataEvent.APPLE_METADATA_DOWNLOAD, stub, async () => {
throw new Error('testing exectution ID');
});
} catch (error: any) {
caughtError = error;
}
expect(caughtError).toBeInstanceOf(MetadataTelemetryError);
expect(caughtError).toHaveProperty('executionId', expect.any(String));
expect(caughtError).toHaveProperty('originalError', expect.any(Error));
});
});
describe(makeDataScrubber, () => {
const stub: TelemetryContext = {
// Only the App ID is considered to be sensitive
app: new App({} as any, 'SECRET_APP_ID', {} as any),
// Only the token properties and user credentials are considered to be sensitive
auth: {
username: 'SECRET_USERNAME',
password: 'SECRET_PASSWORD',
context: {
token: 'SECRET_TOKEN',
teamId: 'SECRET_TEAM_ID',
providerId: 1337,
},
} as any,
};
it('scrubs the app.id', () => {
expect(makeDataScrubber(stub)('some text SECRET_APP_ID')).toBe('some text {APPLE_APP_ID}');
});
@@ -3,26 +3,18 @@ import type { AxiosError } from 'axios';
import { v4 as uuidv4 } from 'uuid';
import { Analytics, MetadataEvent } from '../../analytics/events';
import { MetadataTelemetryError } from '../errors';
export type TelemetryContext = {
app: App;
auth: Partial<Session.AuthState>;
};
/**
* Subscribe the telemetry to the ongoing metadata requests and responses.
* When providing the app and auth info, we can scrub that data from the telemetry.
* Returns an execution ID to group all events of a single run together, and a unsubscribe function.
*/
export function subscribeTelemetry(
export async function withTelemetryAsync<T>(
event: MetadataEvent,
options: TelemetryContext
): {
/** Unsubscribe the telemetry from all apple-utils events */
unsubscribeTelemetry: () => void;
/** The unique id added to all telemetry events from a single execution */
executionId: string;
} {
options: TelemetryContext,
action: () => Promise<T>
): Promise<T> {
const executionId = uuidv4();
const scrubber = makeDataScrubber(options);
const { interceptors } = getRequestClient();
@@ -59,11 +51,13 @@ export function subscribeTelemetry(
}
);
function unsubscribeTelemetry(): void {
try {
return await action();
} catch (error: any) {
throw new MetadataTelemetryError(error, executionId);
} finally {
interceptors.response.eject(responseInterceptorId);
}
return { unsubscribeTelemetry, executionId };
}
/** Exposed for testing */
+6 -7
View File
@@ -11,6 +11,7 @@ import { AssetMetadataStatus, PartialManifestAsset } from '../graphql/generated'
import { PublishMutation } from '../graphql/mutations/PublishMutation';
import { PresignedPost } from '../graphql/mutations/UploadSessionMutation';
import { PublishQuery } from '../graphql/queries/PublishQuery';
import Log from '../log';
import { uploadWithPresignedPostAsync } from '../uploads';
import { expoCommandAsync } from '../utils/expoCli';
import uniqBy from '../utils/expodash/uniqBy';
@@ -157,13 +158,11 @@ export async function buildBundlesAsync({
throw new Error('Could not locate package.json');
}
await expoCommandAsync(projectDir, [
'export',
'--output-dir',
inputDir,
'--experimental-bundle',
'--non-interactive',
]);
await expoCommandAsync(
projectDir,
['export', '--output-dir', inputDir, '--experimental-bundle'],
{ silent: !Log.isDebug }
);
}
export async function resolveInputDirectoryAsync(customInputDirectory: string): Promise<string> {
@@ -1,15 +1,13 @@
import { v4 as uuidv4 } from 'uuid';
import {
AppUpdateObject,
PublishPlatformFlag,
ensureBranchExistsAsync,
getUpdatesToRepublishAsync,
truncatePublishUpdateMessage,
getUpdatesToRepublishInteractiveAsync,
} from '../../commands/update';
import { graphqlClient } from '../../graphql/client';
import { ViewBranchUpdatesQuery } from '../../graphql/generated';
import Log from '../../log';
import { viewBranchUpdatesQueryUpdateLimit } from '../../graphql/queries/UpdateQuery';
import { selectAsync } from '../../prompts';
const appId = '6c94sxe6-37d2-4700-52fa-1b813204dad2';
@@ -22,6 +20,7 @@ jest.mock('../../graphql/queries/UpdateQuery', () => {
const actual = jest.requireActual('../../graphql/queries/UpdateQuery');
return {
...actual,
getViewBranchUpdatesQueryUpdateLimit: jest.fn(actual.getViewBranchUpdatesQueryUpdateLimit),
};
});
jest.mock('../../prompts', () => ({
@@ -32,7 +31,7 @@ jest.mock('../../commands/update', () => {
return {
...actual,
ensureBranchExistsAsync: jest.fn(actual.ensureBranchExistsAsync),
getUpdatesToRepublishAsync: jest.fn(actual.getUpdatesToRepublishAsync),
getUpdatesToRepublishInteractiveAsync: jest.fn(actual.getUpdatesToRepublishInteractiveAsync),
};
});
const updatesToResolve = jest.fn(
@@ -96,8 +95,14 @@ function createMockUpdates(
updateCount: 1,
platformFlag: 'all',
}
): AppUpdateObject[] {
let updates: Partial<AppUpdateObject>[] = [];
): Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates'] {
let updates: Exclude<
Exclude<ViewBranchUpdatesQuery['app'], null | undefined>['byId']['updateBranchByName'],
null | undefined
>['updates'] = [];
if (platformFlag === 'all') {
updateCount = Math.ceil(updateCount / 2);
}
@@ -138,7 +143,7 @@ function createMockUpdates(
break;
}
}
return updates as AppUpdateObject[];
return updates;
}
describe('UpdatePublish', () => {
@@ -148,6 +153,18 @@ describe('UpdatePublish', () => {
jest.mocked(graphqlClient.mutation).mockClear();
});
it('defaults limit to viewBranchUpdatesQueryUpdateLimit and offset to 0 when none are provided', async () => {
await ensureBranchExistsAsync({ appId, name: appName });
const [[, bindings]] = jest.mocked(graphqlClient.query).mock.calls;
expect(bindings).toEqual({
appId,
name: appName,
limit: viewBranchUpdatesQueryUpdateLimit,
offset: 0,
});
});
it.each([
[0, 0],
[10, 50],
@@ -166,20 +183,19 @@ describe('UpdatePublish', () => {
});
});
describe('getUpdatesToRepublishAsync', () => {
const pageSize = 50;
describe('getUpdatesToRepublishInteractiveAsync', () => {
beforeEach(() => {
jest.mocked(graphqlClient.query).mockClear();
jest.mocked(graphqlClient.mutation).mockClear();
jest.mocked(getUpdatesToRepublishAsync).mockClear();
jest.mocked(getUpdatesToRepublishInteractiveAsync).mockClear();
jest.mocked(selectAsync).mockClear();
});
it('throws when there are no updates', async () => {
const platformFlag = 'all';
await expect(
async () => await getUpdatesToRepublishAsync(projectName, branchName, platformFlag)
async () =>
await getUpdatesToRepublishInteractiveAsync(projectName, branchName, platformFlag, 50)
).rejects.toThrow(
`There are no updates on branch "${branchName}" published for the platform(s) ${platformFlag}. Did you mean to publish a new update instead?`
);
@@ -187,6 +203,7 @@ describe('UpdatePublish', () => {
it('fetches multiple pages of updates and can select an update from the most recent page', async () => {
const mockSelectedGroupId = uuidv4();
const pageSize = 2;
updatesToResolve
.mockReturnValueOnce(createMockUpdates({ updateCount: pageSize + 1 }))
.mockReturnValueOnce(
@@ -197,12 +214,18 @@ describe('UpdatePublish', () => {
.mockResolvedValueOnce('_fetchMore')
.mockResolvedValueOnce(mockSelectedGroupId);
const selectedUpdates = await getUpdatesToRepublishAsync(projectName, branchName, 'all');
const selectedUpdates = await getUpdatesToRepublishInteractiveAsync(
projectName,
branchName,
'all',
pageSize
);
expect(selectedUpdates.every(update => update.group === mockSelectedGroupId)).toBeTruthy();
});
it('fetches multiple pages of updates and can return an update from a previous page', async () => {
const mockSelectedGroupId = uuidv4();
const pageSize = 5;
updatesToResolve
.mockReturnValueOnce(
createMockUpdates({ updateCount: pageSize + 1, groupId: mockSelectedGroupId })
@@ -213,12 +236,18 @@ describe('UpdatePublish', () => {
.mockResolvedValueOnce('_fetchMore')
.mockResolvedValueOnce(mockSelectedGroupId);
const selectedUpdates = await getUpdatesToRepublishAsync(projectName, branchName, 'all');
const selectedUpdates = await getUpdatesToRepublishInteractiveAsync(
projectName,
branchName,
'all',
pageSize
);
expect(selectedUpdates.every(update => update.group === mockSelectedGroupId)).toBeTruthy();
});
it('displays the option to fetch more pages as long as there are unfetched updates left', async () => {
const mockSelectedGroupId = uuidv4();
const pageSize = 10;
updatesToResolve
.mockReturnValueOnce(
createMockUpdates({ updateCount: pageSize + 1, groupId: mockSelectedGroupId })
@@ -231,7 +260,7 @@ describe('UpdatePublish', () => {
.mockResolvedValueOnce('_fetchMore')
.mockResolvedValueOnce(mockSelectedGroupId);
await getUpdatesToRepublishAsync(projectName, branchName, 'all');
await getUpdatesToRepublishInteractiveAsync(projectName, branchName, 'all', pageSize);
const { calls } = jest.mocked(selectAsync).mock;
expect(calls.length).toEqual(3);
const [[, firstOptions], [, secondOptions], [, thirdOptions]] = calls;
@@ -246,6 +275,7 @@ describe('UpdatePublish', () => {
it('paginates update requests as expected', async () => {
const mockSelectedGroupId = uuidv4();
const pageSize = 50;
updatesToResolve
.mockReturnValueOnce(
createMockUpdates({ updateCount: pageSize + 1, groupId: mockSelectedGroupId })
@@ -260,7 +290,7 @@ describe('UpdatePublish', () => {
.mockResolvedValueOnce('_fetchMore')
.mockResolvedValueOnce(mockSelectedGroupId);
await getUpdatesToRepublishAsync(projectName, branchName, 'all');
await getUpdatesToRepublishInteractiveAsync(projectName, branchName, 'all', pageSize);
const gqlBindings = jest.mocked(graphqlClient.query).mock.calls.map(call => call[1]);
expect(gqlBindings).toEqual([
expect.objectContaining({ limit: pageSize + 1, offset: pageSize * 0 }),
@@ -270,28 +300,4 @@ describe('UpdatePublish', () => {
]);
});
});
describe(truncatePublishUpdateMessage.name, () => {
const warnSpy = jest.spyOn(Log, 'warn');
beforeEach(() => {
warnSpy.mockClear();
});
it('does not alter messages with less than 1024 characters', () => {
const message = 'Small message =)';
const truncatedMessage = truncatePublishUpdateMessage(message);
expect(truncatedMessage).toEqual(message);
expect(warnSpy).not.toBeCalled();
});
it('truncates messages to a length of 1024, including ellipses', () => {
const longMessage = Array.from({ length: 2024 }, () => 'a').join('');
const truncatedMessage = truncatePublishUpdateMessage(longMessage);
expect(truncatedMessage.length).toEqual(1024);
expect(truncatedMessage.slice(-3)).toEqual('...');
expect(warnSpy).toBeCalledWith(
'Update message exceeds the allowed 1024 character limit. Truncating message...'
);
});
});
});
+1 -8
View File
@@ -36,18 +36,11 @@ export function getPlatformsForGroup({
.join(', ');
}
export const truncateUpdateMessage = (originalMessage: string, length: number = 512): string => {
if (originalMessage.length > length) {
return originalMessage.substring(0, length - 3) + '...';
}
return originalMessage;
};
export function formatUpdate(update: FormatUpdateParameter): string {
if (!update) {
return 'N/A';
}
const message = update.message ? `"${truncateUpdateMessage(update.message)}" ` : '';
const message = update.message ? `"${update.message}" ` : '';
return `${message}(${format(update.createdAt, 'en_US')} by ${getActorDisplayName(
update.actor as any
)})`;
+2 -14
View File
@@ -1,7 +1,6 @@
import assert from 'assert';
import FormData from 'form-data';
import fs from 'fs-extra';
import { URL } from 'url';
import fetch from './fetch';
import { UploadSessionType } from './graphql/generated';
@@ -55,24 +54,13 @@ export async function uploadWithPresignedPostAsync(
try {
const response = await uploadPromise;
handleProgressEvent({ isComplete: true });
return fixArchiveUrl(String(response.headers.get('location')));
return String(response.headers.get('location'));
} catch (error: any) {
handleProgressEvent({ isComplete: true, error });
throw error;
}
} else {
const response = await uploadPromise;
return fixArchiveUrl(String(response.headers.get('location')));
return String(response.headers.get('location'));
}
}
/**
* S3 returns broken URLs, sth like:
* https://submission-service-archives.s3.amazonaws.com/production%2Fdc98ca84-1473-4cb3-ae81-8c7b291cb27e%2F4424aa95-b985-4e2f-8755-9507b1037c1c
* This function replaces %2F with /.
*/
export function fixArchiveUrl(archiveUrl: string): string {
const parsed = new URL(archiveUrl);
parsed.pathname = decodeURIComponent(parsed.pathname);
return parsed.toString();
}
-107
View File
@@ -1,107 +0,0 @@
import { confirmAsync, selectAsync } from '../prompts';
import uniqBy from './expodash/uniqBy';
export type PaginatedQueryResponse<QueryReturnType extends Record<string, any>> = {
queryResponse: QueryReturnType[];
queryResponseRawLength: number;
};
export type PromptSelectionListItem = {
title: string;
value: string;
};
export type PaginatedQueryArguments<QueryReturnType extends Record<string, any>> = {
pageSize: number;
offset: number;
queryToPerform: (
pageSize: number,
offset: number
) => Promise<PaginatedQueryResponse<QueryReturnType>>;
promptOptions: PaginatedQueryPromptOptions<QueryReturnType>;
};
export interface PaginatedQuerySelectPrompt<QueryReturnType extends Record<string, any>> {
readonly title: string;
readonly type: 'select';
createDisplayTextForSelectionPromptListItem: (queryItem: QueryReturnType) => string;
getIdentifierForQueryItem: (queryItem: QueryReturnType) => string;
}
export interface PaginatedQueryConfirmPrompt<QueryReturnType extends Record<string, any>> {
readonly type: 'confirm';
readonly title: string;
renderListItems: (currentPage: QueryReturnType[]) => void;
}
type PaginatedQueryPromptOptions<QueryReturnType extends Record<string, any>> =
| PaginatedQueryConfirmPrompt<QueryReturnType>
| PaginatedQuerySelectPrompt<QueryReturnType>;
/**
* Return an empty array when the promptOptions type is PaginatedQueryConfirmPrompt
* Returns an array of the selected items when the promptOptions type is PaginatedQuerySelectPrompt
*/
export async function performPaginatedQueryAsync<QueryReturnType extends Record<string, any>>(
{ pageSize, offset, queryToPerform, promptOptions }: PaginatedQueryArguments<QueryReturnType>,
accumulator?: QueryReturnType[]
): Promise<QueryReturnType[]> {
const fetchMoreValue = '_fetchMore';
// query an extra item to determine if there are more pages left
const { queryResponse: items, queryResponseRawLength } = await queryToPerform(
pageSize + 1,
offset
);
const areMorePagesAvailable = queryResponseRawLength > pageSize;
// drop that extra item used for pagination from our render logic when extra pages are available
const currentPage = items.slice(0, areMorePagesAvailable ? items.length - 1 : undefined);
accumulator = [...(accumulator ?? []), ...currentPage];
let valueOfUserSelectedListItem = '';
if (promptOptions.type === 'confirm') {
promptOptions.renderListItems(currentPage);
if (areMorePagesAvailable) {
valueOfUserSelectedListItem = (await confirmAsync({ message: promptOptions.title }))
? fetchMoreValue
: '';
}
} else {
const selectionPromptListItems = uniqBy(accumulator, queryItem =>
promptOptions.getIdentifierForQueryItem(queryItem)
).map(queryItem => ({
title: promptOptions.createDisplayTextForSelectionPromptListItem(queryItem),
value: promptOptions.getIdentifierForQueryItem(queryItem),
}));
if (areMorePagesAvailable) {
selectionPromptListItems.push({ title: 'Next page...', value: fetchMoreValue });
}
if (selectionPromptListItems.length) {
valueOfUserSelectedListItem = await selectAsync<string>(
promptOptions.title,
selectionPromptListItems
);
}
}
if (valueOfUserSelectedListItem === fetchMoreValue) {
return await performPaginatedQueryAsync(
{
pageSize,
offset: offset + pageSize,
queryToPerform,
promptOptions,
},
accumulator
);
}
if (promptOptions.type === 'select') {
return accumulator.filter(
update => promptOptions.getIdentifierForQueryItem(update) === valueOfUserSelectedListItem
);
}
return [];
}