Skip to content

Cleanup error handling #36

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
DamianZaremba merged 5 commits into from
Jun 27, 2026
Merged

Cleanup error handling #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c5ae40
Check json_decode in Http::unserialize
DamianZaremba Jun 25, 2026
a50e2d2
Handle complete data sets (no query-continue)
DamianZaremba Jun 25, 2026
2aec556
Check response fields before access
DamianZaremba Jun 25, 2026
b8edaf7
Check page/revision data is returned
DamianZaremba Jun 25, 2026
79ca095
ci - skip building container (lib)
DamianZaremba Jun 27, 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
18 changes: 0 additions & 18 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,3 @@ jobs:
run: |
composer exec phpunit -- tests/
if: matrix.target == 'phpunit'

build-container:
runs-on: ubuntu-latest
permissions:
security-events: write
pull-requests: write
steps:
- uses: actions/checkout@v6

- name: Build container
uses: infrabits/ci-pack@main
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
image: ghcr.io/${{ github.repository }}:${{ github.sha }}
use_builder: latest
buildpack: heroku/php
publish_image: false
runtime_release: ${{ github.sha }}
59 changes: 31 additions & 28 deletions src/Wikipedia/Api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public function recentchanges($count = 10, $namespace = null, $dir = 'older', $t
'|flags|timestamp|title|ids|sizes&format=json&rclimit=' . $count . $append
);
$x = $this->http->unserialize($x);
return $x['query']['recentchanges'];
return $x['query']['recentchanges'] ?? [];
}

/**
Expand Down Expand Up @@ -158,7 +158,7 @@ public function search($search, $limit = 10, $offset = 0, $namespace = 0, $what
urlencode($search) . $append
);
$x = $this->http->unserialize($x);
return $x['query']['search'];
return $x['query']['search'] ?? [];
}

/**
Expand Down Expand Up @@ -213,7 +213,7 @@ public function logs(
'title|type|user|timestamp|comment|details' . $append
);
$x = $this->http->unserialize($x);
return $x['query']['logevents'];
return $x['query']['logevents'] ?? [];
}

/**
Expand Down Expand Up @@ -241,13 +241,9 @@ public function usercontribs($user, $count = 50, &$continue = null, $dir = 'olde
urlencode($user) . '&uclimit=' . urlencode($count) . '&ucdir=' . urlencode($dir) . $append
);
$x = $this->http->unserialize($x);
if (array_key_exists('ucstart', $x['query-continue']['usercontribs'])) {
$continue = $x['query-continue']['usercontribs']['ucstart'];
} else {
$continue = null;
}
$continue = $x['query-continue']['usercontribs']['ucstart'] ?? null;

return $x['query']['usercontribs'];
return $x['query']['usercontribs'] ?? [];
}

/**
Expand Down Expand Up @@ -278,12 +274,12 @@ public function users($start = null, $limit = 1, $group = null, $requirestart =
'blockinfo|editcount|registration|groups&aulimit=' . urlencode($limit) . $append
);
$x = $this->http->unserialize($x);
$continue = $x['query-continue']['allusers']['aufrom'];
if (($requirestart == true) and ($x['query']['allusers'][0]['name'] != $start)) {
$continue = $x['query-continue']['allusers']['aufrom'] ?? null;
if ($requirestart == true && ($x['query']['allusers'][0]['name'] ?? null) != $start) {
return false;
}

return $x['query']['allusers'];
return $x['query']['allusers'] ?? [];
}

/**
Expand Down Expand Up @@ -311,9 +307,9 @@ public function categorymembers($category, $count = 500, &$continue = null)
);
$x = $this->http->unserialize($x);

$continue = $x['query-continue']['categorymembers']['cmcontinue'];
$continue = $x['query-continue']['categorymembers']['cmcontinue'] ?? null;

return $x['query']['categorymembers'];
return $x['query']['categorymembers'] ?? [];
}

/**
Expand Down Expand Up @@ -352,9 +348,9 @@ public function listcategories(&$start = null, $limit = 50, $dir = 'ascending',
);
$x = $this->http->unserialize($x);

$start = $x['query-continue']['allcategories']['acfrom'];
$start = $x['query-continue']['allcategories']['acfrom'] ?? null;

return $x['query']['allcategories'];
return $x['query']['allcategories'] ?? [];
}

/**
Expand Down Expand Up @@ -398,7 +394,7 @@ public function backlinks($page, $count = 500, &$continue = null, $filter = null
$continue = null;
}

return $x['query']['backlinks'];
return $x['query']['backlinks'] ?? [];
}

/**
Expand Down Expand Up @@ -436,7 +432,7 @@ public function embeddedin($page, $count = 500, &$continue = null)
$continue = null;
}

return $x['query']['embeddedin'];
return $x['query']['embeddedin'] ?? [];
}

/**
Expand Down Expand Up @@ -475,7 +471,7 @@ public function listprefix($prefix, $namespace = 0, $count = 500, &$continue = n
$continue = null;
}

return $x['query']['allpages'];
return $x['query']['allpages'] ?? [];
}

/**
Expand Down Expand Up @@ -539,10 +535,10 @@ public function edit(
$x = $this->http->post($this->apiurl, $params);
$x = $this->http->unserialize($x);

if ($x['edit']['result'] == 'Success') {
if (isset($x['edit']['result']) && $x['edit']['result'] == 'Success') {
return true;
}
if ($x['error']['code'] == 'badtoken') {
if (isset($x['error']['code']) && $x['error']['code'] == 'badtoken') {
if ($this->login($this->user, $this->pass, $this->assert_auth)) {
return $this->edit($page, $data, $summary, $minor, $bot, $wpStarttime, $wpEdittime, $checkrun);
} else {
Expand Down Expand Up @@ -574,7 +570,7 @@ public function gettoken($title)
);
$x = $this->http->unserialize($x);

return $x['query']['tokens']['csrftoken'];
return $x['query']['tokens']['csrftoken'] ?? null;
}

/**
Expand All @@ -588,7 +584,7 @@ public function getLoginToken()
'&action=query&meta=tokens&type=login');
$x = $this->http->unserialize($x);

return $x['query']['tokens']['logintoken'];
return $x['query']['tokens']['logintoken'] ?? null;
}


Expand All @@ -613,7 +609,7 @@ public function login($user, $pass, $assert_auth = true)

$x = $this->http->unserialize($x);

return $x['login']['result'] == 'Success';
return isset($x['login']['result']) && $x['login']['result'] == 'Success';
}

/**
Expand All @@ -630,11 +626,15 @@ public function loggedin()
'?action=query&meta=userinfo&format=json');
$x = $this->http->unserialize($x);

if (!isset($x['query']['userinfo'])) {
return false;
}

if (!$this->user) {
return !array_key_exists('anon', $x['query']['userinfo']);
}

return $x['query']['userinfo']['name'] === $this->user;
return ($x['query']['userinfo']['name'] ?? null) === $this->user;
}

/**
Expand Down Expand Up @@ -693,7 +693,7 @@ public function rollback($title, $user, $reason, $token = null, $checkrun = true
$x = $this->http->get($this->apiurl . '?action=query&meta=tokens&type=rollback&format=json');
$x = $this->http->unserialize($x);

$token = $x['query']['tokens']['rollbacktoken'];
$token = $x['query']['tokens']['rollbacktoken'] ?? null;

$params = array(
'action' => 'rollback',
Expand Down Expand Up @@ -792,9 +792,12 @@ public function revisions(
}
}

if (!isset($x['query']['pages']) || !is_array($x['query']['pages'])) {
return [];
}
foreach (array_values($x['query']['pages']) as $data) {
return $data['revisions'];
return $data['revisions'] ?? [];
}
return array();
return [];
}
}
9 changes: 7 additions & 2 deletions src/Wikipedia/Http.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,15 +142,20 @@ public function unserialize($response)

$response = json_decode($response, true);

if (!is_array($response)) {
if ($this->logger !== null) {
$this->logger->error('Failed to decode API response');
}
return [];
}

if ($this->logger !== null) {
// Handle errors
if (array_key_exists('error', $response)) {
$caller = (new \Exception())->getTrace()[1]['function'];
$this->logger->error($caller . ' API Error: ' .
var_export($response['error'], true));
}

// Handle warnings
if (array_key_exists('warnings', $response)) {
$caller = (new \Exception())->getTrace()[1]['function'];
$this->logger->warning($caller . ' API Warnings: ' .
Expand Down
2 changes: 1 addition & 1 deletion src/Wikipedia/Query.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function getpage($page)
$this->checkurl();
$ret = $this->api->revisions($page, 1, 'older', true, null, true, false, false);

if (is_array($ret) && array_key_exists(0, $ret) && array_key_exists('*', $ret[0]['slots']['main'])) {
if (is_array($ret) && isset($ret[0]['slots']['main']['*'])) {
return $ret[0]['slots']['main']['*'];
}
}
Expand Down