Skip to content
New issue

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

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

Track peer dependencies mismatches #6946

Merged
merged 5 commits into from
Jan 13, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
7 changes: 7 additions & 0 deletions scripts/ci-deno.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,10 @@ deno run \
--allow-net \
--allow-env="GITHUB_TOKEN,CAPI_KEY" \
scripts/deno/iframe-titles.ts

deno run \
--no-check=remote \
--allow-net \
--allow-env="GITHUB_TOKEN" \
--allow-run=make \
scripts/deno/peer-dependencies.ts
105 changes: 105 additions & 0 deletions scripts/deno/peer-dependencies.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import { octokit } from './github.ts';

const peers = async () => {
// yarn install --check-files
const process = Deno.run({
cwd: './dotcom-rendering/',
cmd: ['make', 'reinstall'],
stdout: 'null',
stderr: 'piped',
});

const [{ code }, rawOutput] = await Promise.all([
process.status(),
process.stderrOutput(),
]);
if (code !== 0) Deno.exit(code);

return new TextDecoder()
.decode(rawOutput)
.split('\n')
.filter((line) => line.includes('has incorrect peer dependency'))
Copy link
Member

Choose a reason for hiding this comment

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

this will break if yarn output changes (or this project gets a new package manager) – what about using something like https://www.npmjs.com/package/validate-peer-dependencies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that might be a good future improvement! I’m not massively interested in fixing straight away, as PNPM should make this unnecessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I’ve actually tried this package, but could not get it to work at all!

.map((line) => line.replace(/workspace-aggregator-[a-z0-9-]+ > /, ''));
};

const { dcr, ar, cr } = (await peers())
.map((line) => {
const matches = line.match(
/warning "(.+?) > (.+?)" has incorrect peer dependency "(.+)"./,
);
if (!matches) throw new Error('Invalid string');

const [, workspace, dependency, peer] = matches;

return { workspace, dependency, peer };
})
.reduce<{ dcr: string[]; cr: string[]; ar: string[] }>(
(acc, { workspace, dependency, peer }) => {
const line = `- [ ] \`${dependency}\` requires peer \`${peer}\``;
switch (workspace) {
case '@guardian/dotcom-rendering':
return {
...acc,
dcr: acc.dcr.concat(line),
};

case '@guardian/common-rendering ':
return {
...acc,
cr: acc.cr.concat(line),
};

case '@guardian/apps-rendering ':
return {
...acc,
ar: acc.ar.concat(line),
};
default:
return acc;
}
},
{ dcr: [], cr: [], ar: [] },
);
// .sort(({ workspace: a }, { workspace: b }) => a.localeCompare(b));

const body = `## Current peer dependencies mismatch

### dotcom-rendering
${dcr.length ? dcr.join('\n') : '- [X] all peer deps matched!'}

### apps-rendering
${ar.length ? ar.join('\n') : '- [X] all peer deps matched!'}

### common-rendering
${cr.length ? cr.join('\n') : '- [X] all peer deps matched!'}
`;

if (!octokit) {
console.log(body);
Deno.exit();
}

/** https://github.com/guardian/dotcom-rendering/issues/6945 */
const issue_number = 6945;

try {
const {
data: { html_url },
} = await octokit.rest.issues.update({
owner: 'guardian',
repo: 'dotcom-rendering',
issue_number,
body,
});

console.info(`Updated list of issues for dotcom-rendering#${issue_number}`);
console.info(html_url);
} catch (error) {
// do_something
console.warn(`Failed to update issue #${issue_number}`);
console.error(error);

console.log(body);
}

Deno.exit();