Skip to content

Fix handling of non-string values from repository properties API #3557

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mbg merged 7 commits into from
Mar 9, 2026
+126 −36
Merged

Fix handling of non-string values from repository properties API #3557

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8e70ae2
Update `GitHubRepositoryProperty` to match schema
mbg Mar 9, 2026
9c75a5f
Only validate property `value` type if we care about the property
mbg Mar 9, 2026
5899159
Validate `value` types returned by API against expectations
mbg Mar 9, 2026
58314dc
Export types that weren't already
mbg Mar 9, 2026
5311ed4
Include type in error message
mbg Mar 9, 2026
149fd14
Add unknown property with `string[]` value
mbg Mar 9, 2026
6f90eb6
Add changelog entry
mbg Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Only validate property value type if we care about the property
  • Loading branch information
@mbg
mbg committed Mar 9, 2026
commit 9c75a5f60ced7a336710741b803a179f74860d09
10 changes: 5 additions & 5 deletions lib/init-action.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions src/feature-flags/properties.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,29 @@ test.serial(
},
);

test.serial(
"loadPropertiesFromApi does not throw for unexpected value types of unknown properties",
async (t) => {
sinon.stub(api, "getRepositoryProperties").resolves({
headers: {},
status: 200,
url: "",
data: [{ property_name: "not-used-by-us", value: { foo: "bar" } }],
});
const logger = getRunnerLogger(true);
const mockRepositoryNwo = parseRepositoryNwo("owner/repo");
await t.notThrowsAsync(
properties.loadPropertiesFromApi(
{
type: util.GitHubVariant.DOTCOM,
},
logger,
mockRepositoryNwo,
),
);
},
);

test.serial(
"loadPropertiesFromApi returns empty object if on GHES",
async (t) => {
Expand Down
14 changes: 8 additions & 6 deletions src/feature-flags/properties.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,15 @@ export async function loadPropertiesFromApi(
);
}

if (typeof property.value !== "string") {
throw new Error(
`Expected repository property '${property.property_name}' to have a string value, but got: ${JSON.stringify(property)}`,
);
}

if (isKnownPropertyName(property.property_name)) {
// Only validate the type of `value` if this is a property we care about, to avoid throwing
// on unrelated properties that may use representations we do not support.
if (typeof property.value !== "string") {
throw new Error(
`Expected repository property '${property.property_name}' to have a string value, but got: ${JSON.stringify(property)}`,
);
}

setProperty(properties, property.property_name, property.value, logger);
}
}
Expand Down