Skip to content

First stab at supporting Gutenberg projects #7

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

Draft
wants to merge 1 commit into
base: create-pr
Choose a base branch
from
Draft

First stab at supporting Gutenberg projects #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
200 changes: 161 additions & 39 deletions src/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,30 @@ const { simpleParser } = require('mailparser');

const WORDPRESS_ZIP_URL = 'https://github.com/WordPress/wordpress-develop/archive/refs/heads/trunk.zip';
const WORDPRESS_GIT_URL = 'https://github.com/WordPress/wordpress-develop.git';
const GUTENBERG_GIT_URL = 'https://github.com/WordPress/gutenberg.git';

const PROJECT_CONFIGS = {
wordpress: {
key: 'wordpress',
displayName: 'WordPress Core',
repoUrl: WORDPRESS_GIT_URL,
upstreamSlug: 'WordPress/wordpress-develop',
repoName: 'wordpress-develop',
defaultBranch: 'trunk',
defaultDir: 'wordpress-develop-trunk'
},
gutenberg: {
key: 'gutenberg',
displayName: 'Gutenberg',
repoUrl: GUTENBERG_GIT_URL,
upstreamSlug: 'WordPress/gutenberg',
repoName: 'gutenberg',
defaultBranch: 'trunk',
defaultDir: 'gutenberg-trunk'
}
};

const DEFAULT_SITE_TYPE = 'wordpress';
const GITHUB_CLIENT_ID = '05eaaa972c8117f72465'; // GitHub OAuth App Client ID for device flow

// GitHub authentication state
Expand Down Expand Up @@ -96,8 +120,22 @@ async function getStore() {
return store;
}

async function mergeSiteMeta(sitePath, updates = {}) {
const s = await getStore();
const meta = s.get('siteMeta') || {};
const current = meta[sitePath] || {};
const next = { ...current, ...updates };
meta[sitePath] = next;
s.set('siteMeta', meta);
return next;
}

function resolveSiteType(metaEntry) {
return metaEntry?.type === 'gutenberg' ? 'gutenberg' : DEFAULT_SITE_TYPE;
}

function findAvailableDirName(rootDir, baseName) {
const sanitizedBase = baseName || 'wordpress-develop-trunk';
const sanitizedBase = baseName || project.defaultDir;
let candidate = sanitizedBase;
let counter = 2;
while (fs.existsSync(path.join(rootDir, candidate))) {
Expand All @@ -106,6 +144,10 @@ function findAvailableDirName(rootDir, baseName) {
return candidate;
}

function getProjectConfig(type) {
return PROJECT_CONFIGS[type] || PROJECT_CONFIGS.wordpress;
}

/** @type {Record<string, import('child_process').ChildProcess>} */
const runningInstalls = {};
/** @type {Record<string, import('child_process').ChildProcess>} */
Expand Down Expand Up @@ -455,18 +497,18 @@ async function pollDeviceOAuth(deviceCode, interval, shouldAbort) {
}

// Check if user has a fork
async function checkForFork(username) {
async function checkForFork(username, repoName) {
try {
await githubAPI(`/repos/${username}/wordpress-develop`);
await githubAPI(`/repos/${username}/${repoName}`);
return true;
} catch {
return false;
}
}

// Create a fork
async function createFork() {
await githubAPI('/repos/WordPress/wordpress-develop/forks', {
async function createFork(upstreamSlug) {
await githubAPI(`/repos/${upstreamSlug}/forks`, {
method: 'POST'
});

Expand All @@ -481,8 +523,9 @@ async function getAuthenticatedUser() {
}

// Submit PR workflow
async function submitPR(sitePath, onProgress, abortState) {
async function submitPR(sitePath, projectConfig, onProgress, abortState) {
try {
const repoConfig = typeof projectConfig === 'string' ? getProjectConfig(projectConfig) : (projectConfig || getProjectConfig('wordpress'));
const ensureNotAborted = () => {
if (abortState?.aborted) {
const err = new Error('Aborted by user');
Expand Down Expand Up @@ -530,14 +573,14 @@ async function submitPR(sitePath, onProgress, abortState) {
// Step 2: Get username and check for fork
safeProgress({ step: 'fork', message: 'Checking for fork...' });
const username = await getAuthenticatedUser();
const hasFork = await checkForFork(username);
const hasFork = await checkForFork(username, repoConfig.repoName);

if (!hasFork) {
safeProgress({ step: 'fork', message: 'Creating fork...' });
await createFork();
safeProgress({ step: 'fork', message: `Fork created: https://github.com/${username}/wordpress-develop` });
await createFork(repoConfig.upstreamSlug);
safeProgress({ step: 'fork', message: `Fork created: https://github.com/${username}/${repoConfig.repoName}` });
} else {
safeProgress({ step: 'fork', message: `Using existing fork: https://github.com/${username}/wordpress-develop` });
safeProgress({ step: 'fork', message: `Using existing fork: https://github.com/${username}/${repoConfig.repoName}` });
}

ensureNotAborted();
Expand Down Expand Up @@ -615,22 +658,28 @@ async function submitPR(sitePath, onProgress, abortState) {
}
}

safeProgress({
step: 'commit',
message: 'Committing changes...',
gitCommand: 'git commit -m "WordPress core patch"'
});
const commitMessage = repoConfig.key === 'gutenberg' ? 'Gutenberg contribution' : 'WordPress core patch';
const hasChanges = changed.length > 0;
if (!hasChanges) {
safeProgress({ step: 'commit', message: 'No changes detected. Skipping commit.' });
} else {
safeProgress({
step: 'commit',
message: 'Committing changes...',
gitCommand: `git commit -m "${commitMessage}"`
});

ensureNotAborted();
await git.commit({
fs,
dir: sitePath,
message: 'WordPress core patch',
author: {
name: username,
email: `${username}@users.noreply.github.com`
}
});
ensureNotAborted();
await git.commit({
fs,
dir: sitePath,
message: commitMessage,
author: {
name: username,
email: `${username}@users.noreply.github.com`
}
});
}

// Step 5: Add fork remote if it doesn't exist
ensureNotAborted();
Expand All @@ -641,14 +690,14 @@ async function submitPR(sitePath, onProgress, abortState) {
safeProgress({
step: 'push',
message: 'Adding fork remote...',
gitCommand: `git remote add fork https://github.com/${username}/wordpress-develop.git`
gitCommand: `git remote add fork https://github.com/${username}/${repoConfig.repoName}.git`
});
ensureNotAborted();
await git.addRemote({
fs,
dir: sitePath,
remote: 'fork',
url: `https://github.com/${username}/wordpress-develop.git`
url: `https://github.com/${username}/${repoConfig.repoName}.git`
});
}

Expand Down Expand Up @@ -731,7 +780,7 @@ async function submitPR(sitePath, onProgress, abortState) {
}

// Step 7: Open PR URL
const prUrl = `https://github.com/WordPress/wordpress-develop/compare/trunk...${username}:wordpress-develop:${branchName}?expand=1`;
const prUrl = `https://github.com/${repoConfig.upstreamSlug}/compare/${repoConfig.defaultBranch}...${username}:${repoConfig.repoName}:${branchName}?expand=1`;
safeProgress({ step: 'done', message: 'Opening PR page...', prUrl });

return { ok: true, prUrl, branch: branchName };
Expand Down Expand Up @@ -801,11 +850,20 @@ ipcMain.handle('git:save-patch-content', async (_e, payload) => {
}
});

ipcMain.handle('git:submit-pr', async (event, sitePath) => {
ipcMain.handle('git:submit-pr', async (event, payload) => {
const input = (payload && typeof payload === 'object' && 'sitePath' in payload) ? payload : { sitePath: payload };
const sitePath = input?.sitePath;
if (!sitePath) throw new Error('Missing site path for PR submission');
const s = await getStore();
const meta = s.get('siteMeta') || {};
const entry = meta[sitePath] || {};
const resolvedType = input.siteType || resolveSiteType(entry);
const projectConfig = getProjectConfig(resolvedType);

const abortState = { aborted: false, controller: null };
submitPrAbortStates.set(event.sender.id, abortState);
try {
const result = await submitPR(sitePath, (progress) => {
const result = await submitPR(sitePath, projectConfig, (progress) => {
event.sender.send('git:submit-pr:progress', progress);
}, abortState);
return result;
Expand Down Expand Up @@ -859,21 +917,38 @@ ipcMain.handle('sites:getAll', async () => {
return { sites: s.get('sites'), siteMeta: s.get('siteMeta') };
});

ipcMain.handle('sites:update-meta', async (_e, sitePath, updates = {}) => {
if (!sitePath || typeof sitePath !== 'string') return null;
return mergeSiteMeta(sitePath, updates);
});

ipcMain.handle('site:status', async (_e, sitePath) => {
try {
const nmDir = path.join(sitePath, 'node_modules');
const hasNodeModules = fs.existsSync(nmDir) && (() => { try { return fs.readdirSync(nmDir).length > 0; } catch { return false; } })();

const distDir = path.join(sitePath, 'build', 'wp-includes', 'js', 'dist');
const hasBuilt = fs.existsSync(distDir);

const s = await getStore();
const meta = s.get('siteMeta') || {};
const m = meta[sitePath] || {};
const siteType = resolveSiteType(m);

if (siteType === 'gutenberg') {
return {
type: siteType,
hasNodeModules,
hasBuilt: false,
skipInitWizard: false,
initialized: Boolean(m.initialized),
hasGutenbergDev: Boolean(m.gutenbergDevRan)
};
}

const distDir = path.join(sitePath, 'build', 'wp-includes', 'js', 'dist');
const hasBuilt = fs.existsSync(distDir);

return { hasNodeModules, hasBuilt, skipInitWizard: Boolean(m.skipInitWizard), initialized: Boolean(m.initialized) };
return { type: siteType, hasNodeModules, hasBuilt, skipInitWizard: Boolean(m.skipInitWizard), initialized: Boolean(m.initialized) };
} catch (e) {
return { hasNodeModules: false, hasBuilt: false, skipInitWizard: false, initialized: false };
return { type: DEFAULT_SITE_TYPE, hasNodeModules: false, hasBuilt: false, skipInitWizard: false, initialized: false };
}
});

Expand All @@ -895,7 +970,8 @@ ipcMain.handle('sites:add', async (_e, sitePath) => {
meta[sitePath] = meta[sitePath] || {
initialized: false,
createdAt: new Date().toISOString(),
label: path.basename(sitePath)
label: path.basename(sitePath),
type: DEFAULT_SITE_TYPE
};
s.set('siteMeta', meta);
}
Expand All @@ -917,6 +993,8 @@ ipcMain.handle('wordpress:setup', async (event, destDir, options = {}) => {

await fse.ensureDir(destDir);

const project = getProjectConfig('wordpress');

const requestedName = typeof options.siteName === 'string' ? options.siteName.trim() : '';
const sanitizedName = requestedName.replace(/[\\/:*?"<>|]+/g, '-').replace(/\s+/g, '-').replace(/^-+|-+$/g, '') || 'wordpress-develop-trunk';
const uniqueName = findAvailableDirName(destDir, sanitizedName);
Expand All @@ -927,11 +1005,11 @@ ipcMain.handle('wordpress:setup', async (event, destDir, options = {}) => {
await git.clone({
http,
fs,
url: WORDPRESS_GIT_URL,
url: project.repoUrl,
dir: siteDir,
singleBranch: true,
depth: 1,
ref: 'trunk',
ref: project.defaultBranch,
onProgress: (evt) => {
// evt: {phase,total,loaded,lengthComputable} - forward as terminal-like output
const msg = `${evt.phase || 'clone'} ${evt.loaded || 0}/${evt.total || 0}`;
Expand All @@ -952,7 +1030,51 @@ ipcMain.handle('wordpress:setup', async (event, destDir, options = {}) => {
const siteLabel = typeof options.siteLabel === 'string' && options.siteLabel.trim().length
? options.siteLabel.trim()
: uniqueName;
meta[siteDir] = { initialized: false, createdAt: new Date().toISOString(), label: siteLabel };
meta[siteDir] = { initialized: false, createdAt: new Date().toISOString(), label: siteLabel, type: 'wordpress' };
s.set('siteMeta', meta);
}
event.sender.send('download:status', { phase: 'done', target: siteDir, sitePath: siteDir });
return siteDir;
});

ipcMain.handle('gutenberg:setup', async (event, destDir, options = {}) => {
if (!destDir) {
throw new Error('No destination directory specified');
}

await fse.ensureDir(destDir);

const project = getProjectConfig('gutenberg');
const requestedName = typeof options.siteName === 'string' ? options.siteName.trim() : '';
const sanitizedName = requestedName.replace(/[\/:*?"<>|]+/g, '-').replace(/\s+/g, '-').replace(/^-+|-+$/g, '') || project.defaultDir;
const uniqueName = findAvailableDirName(destDir, sanitizedName);
const siteDir = path.join(destDir, uniqueName);
await fse.ensureDir(siteDir);
event.sender.send('download:status', { phase: 'cloning', target: siteDir });
await git.clone({
http,
fs,
url: project.repoUrl,
dir: siteDir,
singleBranch: true,
depth: 1,
ref: project.defaultBranch,
onProgress: (evt) => {
const msg = `${evt.phase || 'clone'} ${evt.loaded || 0}/${evt.total || 0}`;
event.sender.send('download:progress', { target: siteDir, message: msg });
}
});

const s = await getStore();
const sites = s.get('sites');
if (!sites.includes(siteDir)) {
sites.push(siteDir);
s.set('sites', sites);
const meta = s.get('siteMeta');
const siteLabel = typeof options.siteLabel === 'string' && options.siteLabel.trim().length
? options.siteLabel.trim()
: uniqueName;
meta[siteDir] = { initialized: false, createdAt: new Date().toISOString(), label: siteLabel, type: 'gutenberg' };
s.set('siteMeta', meta);
}
event.sender.send('download:status', { phase: 'done', target: siteDir, sitePath: siteDir });
Expand Down
15 changes: 12 additions & 3 deletions src/preload.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ contextBridge.exposeInMainWorld('api', {
addSite: (dir) => ipcRenderer.invoke('sites:add', dir),
chooseDirectory: () => ipcRenderer.invoke('dialog:choose-dir'),
setupWordPress: (dir, options = {}) => ipcRenderer.invoke('wordpress:setup', dir, options),
setupGutenberg: (dir, options = {}) => ipcRenderer.invoke('gutenberg:setup', dir, options),
openDirectory: (dir) => ipcRenderer.invoke('dir:open', dir),
openInEditor: (dir, editor) => ipcRenderer.invoke('editor:open', dir, editor),
checkEditorsAvailable: () => ipcRenderer.invoke('editor:check-available'),
Expand Down Expand Up @@ -75,16 +76,24 @@ contextBridge.exposeInMainWorld('api', {
,
savePatchContent: (sitePath, patchText) => ipcRenderer.invoke('git:save-patch-content', { sitePath, patch: patchText })
,
submitPR: async (sitePath, onProgress) => {
submitPR: async (sitePath, maybeType, onProgress) => {
let siteType = maybeType;
let progressHandlerInput = onProgress;
if (typeof maybeType === 'function' && onProgress === undefined) {
progressHandlerInput = maybeType;
siteType = undefined;
}
const progressHandler = (_e, progress) => {
if (onProgress) onProgress(progress);
if (progressHandlerInput) progressHandlerInput(progress);
};
ipcRenderer.on('git:submit-pr:progress', progressHandler);
const result = await ipcRenderer.invoke('git:submit-pr', sitePath);
const result = await ipcRenderer.invoke('git:submit-pr', { sitePath, siteType });
ipcRenderer.removeListener('git:submit-pr:progress', progressHandler);
return result;
},
abortSubmitPR: () => ipcRenderer.invoke('git:submit-pr:abort')
,
updateSiteMeta: (sitePath, updates) => ipcRenderer.invoke('sites:update-meta', sitePath, updates)
,
startWpDebug: async (sitePath, onData) => {
const handler = (_e, payload) => {
Expand Down
Loading