Skip to content

support: Configure biome for some app server services #10574

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
yuki-takei merged 10 commits into from
Dec 8, 2025
Merged

support: Configure biome for some app server services #10574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b0bb415
configure biome for some app server services
arafubeatbox Nov 23, 2025
adf89bf
ignore some app server service files in eslint
arafubeatbox Nov 23, 2025
68756c3
fix non-autofixable biome errors (type annotations, forEach fix)
arafubeatbox Dec 7, 2025
797fd64
fix non-autofixable biome errors (axios import)
arafubeatbox Dec 7, 2025
3bab385
Merge branch 'dev/7.4.x' into support/156162-174669-app-server-servic…
arafubeatbox Dec 7, 2025
55fe077
fix non-autofixable biome errors (add type annotations)
arafubeatbox Dec 7, 2025
24f6187
fix type annotation
arafubeatbox Dec 7, 2025
94a7730
fix type annotations
arafubeatbox Dec 7, 2025
d21ce01
remove unnecessary import
arafubeatbox Dec 7, 2025
20ee7b9
Merge branch 'dev/7.4.x' into support/156162-174669-app-server-servic…
yuki-takei Dec 8, 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
3 changes: 2 additions & 1 deletion apps/app/.eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ module.exports = {
'src/server/routes/apiv3/app-settings/**',
'src/server/routes/apiv3/page/**',
'src/server/routes/apiv3/*.ts',
'src/server/routes/apiv3/*.js',
'src/server/service/*.ts',
'src/server/service/*.js',
],
settings: {
// resolve path aliases by eslint-import-resolver-typescript
Expand Down
68 changes: 32 additions & 36 deletions apps/app/src/server/service/acl.integ.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,24 @@ import type { MockInstance } from 'vitest';
import { aclService } from './acl';
import { configManager } from './config-manager';


describe('AclService', () => {
test("has consts 'isLabeledStatement'", () => {
expect(aclService.labels.SECURITY_RESTRICT_GUEST_MODE_DENY).toBe('Deny');
expect(aclService.labels.SECURITY_RESTRICT_GUEST_MODE_READONLY).toBe('Readonly');
expect(aclService.labels.SECURITY_RESTRICT_GUEST_MODE_READONLY).toBe(
'Readonly',
);
expect(aclService.labels.SECURITY_REGISTRATION_MODE_OPEN).toBe('Open');
expect(aclService.labels.SECURITY_REGISTRATION_MODE_RESTRICTED).toBe('Restricted');
expect(aclService.labels.SECURITY_REGISTRATION_MODE_RESTRICTED).toBe(
'Restricted',
);
expect(aclService.labels.SECURITY_REGISTRATION_MODE_CLOSED).toBe('Closed');
});
});

describe('AclService test', () => {

const initialEnv = process.env;

beforeAll(async() => {
beforeAll(async () => {
await configManager.loadConfigs();
});

Expand All @@ -27,8 +29,7 @@ describe('AclService test', () => {
});

describe('isAclEnabled()', () => {

test('to be false when FORCE_WIKI_MODE is undefined', async() => {
test('to be false when FORCE_WIKI_MODE is undefined', async () => {
delete process.env.FORCE_WIKI_MODE;

// reload
Expand All @@ -41,7 +42,7 @@ describe('AclService test', () => {
expect(result).toBe(true);
});

test('to be false when FORCE_WIKI_MODE is dummy string', async() => {
test('to be false when FORCE_WIKI_MODE is dummy string', async () => {
process.env.FORCE_WIKI_MODE = 'dummy string';

// reload
Expand All @@ -54,7 +55,7 @@ describe('AclService test', () => {
expect(result).toBe(true);
});

test('to be true when FORCE_WIKI_MODE=private', async() => {
test('to be true when FORCE_WIKI_MODE=private', async () => {
process.env.FORCE_WIKI_MODE = 'private';

// reload
Expand All @@ -67,7 +68,7 @@ describe('AclService test', () => {
expect(result).toBe(true);
});

test('to be false when FORCE_WIKI_MODE=public', async() => {
test('to be false when FORCE_WIKI_MODE=public', async () => {
process.env.FORCE_WIKI_MODE = 'public';

// reload
Expand All @@ -79,13 +80,10 @@ describe('AclService test', () => {
expect(wikiMode).toBe('public');
expect(result).toBe(false);
});

});


describe('isWikiModeForced()', () => {

test('to be false when FORCE_WIKI_MODE is undefined', async() => {
test('to be false when FORCE_WIKI_MODE is undefined', async () => {
delete process.env.FORCE_WIKI_MODE;

// reload
Expand All @@ -98,7 +96,7 @@ describe('AclService test', () => {
expect(result).toBe(false);
});

test('to be false when FORCE_WIKI_MODE is dummy string', async() => {
test('to be false when FORCE_WIKI_MODE is dummy string', async () => {
process.env.FORCE_WIKI_MODE = 'dummy string';

// reload
Expand All @@ -111,7 +109,7 @@ describe('AclService test', () => {
expect(result).toBe(false);
});

test('to be true when FORCE_WIKI_MODE=private', async() => {
test('to be true when FORCE_WIKI_MODE=private', async () => {
process.env.FORCE_WIKI_MODE = 'private';

// reload
Expand All @@ -124,7 +122,7 @@ describe('AclService test', () => {
expect(result).toBe(true);
});

test('to be false when FORCE_WIKI_MODE=public', async() => {
test('to be false when FORCE_WIKI_MODE=public', async () => {
process.env.FORCE_WIKI_MODE = 'public';

// reload
Expand All @@ -136,19 +134,17 @@ describe('AclService test', () => {
expect(wikiMode).toBe('public');
expect(result).toBe(true);
});

});


describe('isGuestAllowedToRead()', () => {
let getConfigSpy: MockInstance<typeof configManager.getConfig>;

beforeEach(async() => {
beforeEach(async () => {
// prepare spy for ConfigManager.getConfig
getConfigSpy = vi.spyOn(configManager, 'getConfig');
});

test('to be false when FORCE_WIKI_MODE=private', async() => {
test('to be false when FORCE_WIKI_MODE=private', async () => {
process.env.FORCE_WIKI_MODE = 'private';

// reload
Expand All @@ -158,11 +154,13 @@ describe('AclService test', () => {

const wikiMode = configManager.getConfig('security:wikiMode');
expect(wikiMode).toBe('private');
expect(getConfigSpy).not.toHaveBeenCalledWith('security:restrictGuestMode');
expect(getConfigSpy).not.toHaveBeenCalledWith(
'security:restrictGuestMode',
);
expect(result).toBe(false);
});

test('to be true when FORCE_WIKI_MODE=public', async() => {
test('to be true when FORCE_WIKI_MODE=public', async () => {
process.env.FORCE_WIKI_MODE = 'public';

// reload
Expand All @@ -172,22 +170,23 @@ describe('AclService test', () => {

const wikiMode = configManager.getConfig('security:wikiMode');
expect(wikiMode).toBe('public');
expect(getConfigSpy).not.toHaveBeenCalledWith('security:restrictGuestMode');
expect(getConfigSpy).not.toHaveBeenCalledWith(
'security:restrictGuestMode',
);
expect(result).toBe(true);
});

/* eslint-disable indent */
describe.each`
restrictGuestMode | expected
${undefined} | ${false}
${'Deny'} | ${false}
${'Readonly'} | ${true}
${'Open'} | ${false}
${'Restricted'} | ${false}
${'closed'} | ${false}
restrictGuestMode | expected
${undefined} | ${false}
${'Deny'} | ${false}
${'Readonly'} | ${true}
${'Open'} | ${false}
${'Restricted'} | ${false}
${'closed'} | ${false}
`('to be $expected', ({ restrictGuestMode, expected }) => {
test(`when FORCE_WIKI_MODE is undefined and 'security:restrictGuestMode' is '${restrictGuestMode}`, async() => {

test(`when FORCE_WIKI_MODE is undefined and 'security:restrictGuestMode' is '${restrictGuestMode}`, async () => {
// reload
await configManager.loadConfigs();

Expand All @@ -210,8 +209,5 @@ describe('AclService test', () => {
expect(result).toBe(expected);
});
});

});


});
12 changes: 5 additions & 7 deletions apps/app/src/server/service/acl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@ import { configManager } from './config-manager';
const logger = loggerFactory('growi:service:AclService');

export interface AclService {
get labels(): { [key: string]: string },
isAclEnabled(): boolean,
isWikiModeForced(): boolean,
isGuestAllowedToRead(): boolean,
getGuestModeValue(): string,
get labels(): { [key: string]: string };
isAclEnabled(): boolean;
isWikiModeForced(): boolean;
isGuestAllowedToRead(): boolean;
getGuestModeValue(): string;
}

/**
* the service class of AclService
*/
class AclServiceImpl implements AclService {

get labels() {
return {
SECURITY_RESTRICT_GUEST_MODE_DENY: 'Deny',
Expand Down Expand Up @@ -73,7 +72,6 @@ class AclServiceImpl implements AclService {
? this.labels.SECURITY_RESTRICT_GUEST_MODE_READONLY
: this.labels.SECURITY_RESTRICT_GUEST_MODE_DENY;
}

}

export const aclService = new AclServiceImpl();
Loading
Loading