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.

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

refactor(devbox): Refactor schema and improve logging #33978

Merged
merged 22 commits into from
Jan 31, 2025
+117 −221
Merged

refactor(devbox): Refactor schema and improve logging #33978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
f200c96
feat(manager): add devbox manager module
burritobill Sep 16, 2024
9adb832
Merge branch 'main' into devbox-manager
burritobill Jan 16, 2025
ee855b7
Fix coverage
burritobill Jan 16, 2025
824c5df
Merge branch 'main' into devbox-manager
burritobill Jan 16, 2025
199907e
Address PR comments
burritobill Jan 17, 2025
070b113
Merge branch 'main' into devbox-manager
burritobill Jan 17, 2025
534fb7a
Address PR comments
burritobill Jan 19, 2025
246ad42
Merge branch 'main' into devbox-manager
burritobill Jan 19, 2025
b293bbe
Update extract.ts
burritobill Jan 20, 2025
a18e0ff
Merge branch 'main' into devbox-manager
burritobill Jan 20, 2025
4f66bc6
Merge branch 'main' into devbox-manager
burritobill Jan 22, 2025
8129711
Merge branch 'main' into devbox-manager
burritobill Jan 29, 2025
95c19f1
Move devbox packages variation logic into zod transform
burritobill Jan 29, 2025
92de509
Move all dep logic to transformer
burritobill Jan 29, 2025
bef0720
Fix eslint issues
burritobill Jan 29, 2025
1f58bd9
Apply suggestions
zharinov Jan 30, 2025
35ff40e
Merge branch 'main' into refactor/devbox-changes
zharinov Jan 31, 2025
1dadb2a
Better logging
zharinov Jan 31, 2025
d2b7289
Remove redundant schema test
zharinov Jan 31, 2025
bce2320
test(logger): Fix mock for `withMeta` function
zharinov Jan 31, 2025
804afd1
Merge branch 'fix/logger-mock-meta' into refactor/devbox-changes
zharinov Jan 31, 2025
c064b19
Merge branch 'main' into refactor/devbox-changes
viceice Jan 31, 2025
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
132 changes: 56 additions & 76 deletions lib/modules/manager/devbox/extract.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ describe('modules/manager/devbox/extract', () => {
it('returns a package dependency when the devbox JSON file has a single package', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": ["nodejs@20.1.8"]
}
`,
{
"packages": ["nodejs@20.1.8"]
}
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -33,7 +33,6 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
],
});
Expand All @@ -42,12 +41,12 @@ describe('modules/manager/devbox/extract', () => {
it('returns a package dependency when the devbox JSON file has a single package with a version object', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": "20.1.8"
{
"packages": {
"nodejs": "20.1.8"
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -56,7 +55,6 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
],
});
Expand All @@ -65,12 +63,12 @@ describe('modules/manager/devbox/extract', () => {
it('returns invalid-version when the devbox JSON file has a single package with an invalid version', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": "^20.1.8"
{
"packages": {
"nodejs": "^20.1.8"
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -79,7 +77,6 @@ describe('modules/manager/devbox/extract', () => {
currentValue: '^20.1.8',
datasource: 'devbox',
depName: 'nodejs',
packageName: 'nodejs',
skipReason: 'invalid-version',
},
],
Expand All @@ -89,10 +86,10 @@ describe('modules/manager/devbox/extract', () => {
it('returns a package dependency when the devbox JSON file has multiple packages', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": ["nodejs@20.1.8", "yarn@1.22.10"]
}
`,
{
"packages": ["nodejs@20.1.8", "yarn@1.22.10"]
}
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -101,13 +98,11 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
],
});
Expand All @@ -116,13 +111,13 @@ describe('modules/manager/devbox/extract', () => {
it('returns a package dependency when the devbox JSON file has multiple packages with in a packages object', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10"
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10"
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -131,13 +126,11 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
],
});
Expand All @@ -146,17 +139,17 @@ describe('modules/manager/devbox/extract', () => {
it('returns a package dependency when the devbox JSON file has multiple packages with package objects', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": {
"version": "20.1.8"
},
"yarn": {
"version": "1.22.10"
{
"packages": {
"nodejs": {
"version": "20.1.8"
},
"yarn": {
"version": "1.22.10"
}
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -165,13 +158,11 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
],
});
Expand All @@ -180,14 +171,14 @@ describe('modules/manager/devbox/extract', () => {
it('returns invalid dependencies', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10",
"invalid": "invalid"
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10",
"invalid": "invalid"
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -196,19 +187,16 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
{
currentValue: 'invalid',
datasource: 'devbox',
depName: 'invalid',
packageName: 'invalid',
skipReason: 'invalid-version',
},
],
Expand All @@ -218,16 +206,16 @@ describe('modules/manager/devbox/extract', () => {
it('returns invalid dependencies with package objects', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10",
"invalid": {
"version": "invalid"
{
"packages": {
"nodejs": "20.1.8",
"yarn": "1.22.10",
"invalid": {
"version": "invalid"
}
}
}
}
`,
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -236,19 +224,16 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
{
currentValue: 'invalid',
datasource: 'devbox',
depName: 'invalid',
packageName: 'invalid',
skipReason: 'invalid-version',
},
],
Expand All @@ -258,10 +243,10 @@ describe('modules/manager/devbox/extract', () => {
it('returns invalid dependencies from the packages array', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": ["nodejs@20.1.8", "yarn@1.22.10", "invalid@invalid", "invalid2"]
}
`,
{
"packages": ["nodejs@20.1.8", "yarn@1.22.10", "invalid@invalid", "invalid2"]
}
`,
'devbox.lock',
);
expect(result).toEqual({
Expand All @@ -270,26 +255,21 @@ describe('modules/manager/devbox/extract', () => {
depName: 'nodejs',
currentValue: '20.1.8',
datasource: 'devbox',
packageName: 'nodejs',
},
{
depName: 'yarn',
currentValue: '1.22.10',
datasource: 'devbox',
packageName: 'yarn',
},
{
currentValue: 'invalid',
datasource: 'devbox',
depName: 'invalid',
packageName: 'invalid',
skipReason: 'invalid-version',
},
{
currentValue: undefined,
datasource: 'devbox',
depName: 'invalid2',
packageName: 'invalid2',
skipReason: 'not-a-version',
},
],
Expand All @@ -299,10 +279,10 @@ describe('modules/manager/devbox/extract', () => {
it('returns null if there are no dependencies', () => {
const result = extractPackageFile(
codeBlock`
{
"packages": []
}
`,
{
"packages": []
}
`,
'devbox.lock',
);
expect(result).toBeNull();
Expand Down
20 changes: 5 additions & 15 deletions lib/modules/manager/devbox/extract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,17 @@
import { logger } from '../../../logger';
import { logger, withMeta } from '../../../logger';
import type { PackageFileContent } from '../types';
import { DevboxFileSchema } from './schema';
import { DevboxSchema } from './schema';

export function extractPackageFile(
content: string,
packageFile: string,
): PackageFileContent | null {
logger.trace('devbox.extractPackageFile()');

const parsedFile = DevboxFileSchema.safeParse(content);
if (parsedFile.error) {
logger.debug(
{ packageFile, error: parsedFile.error },
'Error parsing devbox.json',
);
const deps = withMeta({ packageFile }, () => DevboxSchema.parse(content));
if (!deps.length) {
return null;
}

const deps = parsedFile.data.packages;

if (deps.length) {
return { deps };
}

return null;
return { deps };
}
Loading