Skip to content

feat: support for orbiter id for development #24

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

Merged
merged 2 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions plugins/plugin-tools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@
"plugin"
],
"homepage": "https://juno.build",
"dependencies": {
"@junobuild/config": "^0.1.5"
},
"peerDependencies": {
"@junobuild/config-loader": "^0.2.1"
},
"dependencies": {
"@junobuild/config": "^0.1.8"
}
}
100 changes: 90 additions & 10 deletions plugins/plugin-tools/src/config.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,19 +208,99 @@ describe('config', () => {
vi.clearAllMocks();
});

it('returns undefined if using docker', async () => {
const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBeUndefined();
describe(MODE_DEVELOPMENT, () => {
it('returns undefined in dev mode with container true and no config file', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(false);

const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBeUndefined();
});

it('returns orbiter ID from config if it exists', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {ids: {development: 'orb-dev-id'}}
} as unknown as JunoConfig);

const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBe('orb-dev-id');
});

it('returns undefined if config exists but development ID is not set', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {ids: {}}
} as unknown as JunoConfig);

const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBeUndefined();
});

it('returns undefined if config exists but only ID is set', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {id: 'orb-id'}
} as unknown as JunoConfig);

const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBeUndefined();
});

it('returns undefined if config exists but no ids', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {}
} as unknown as JunoConfig);

const id = await orbiterId({params: {container: true}, mode: MODE_DEVELOPMENT});
expect(id).toBeUndefined();
});
});

it('returns orbiter ID from config', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);
vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {id: 'orb-id'}
} as unknown as JunoConfig);
describe('no container', () => {
it('reads config and returns orbiter ID', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {id: 'orb-id'}
} as unknown as JunoConfig);

const id = await orbiterId({params: {container: false}, mode: 'production'});
expect(id).toBe('orb-id');
});

it('falls back to `orbiterId` if `id` is not present', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);

vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({
orbiter: {orbiterId: 'fallback-id'}
} as unknown as JunoConfig);

const id = await orbiterId({params: {}, mode: 'production'});
expect(id).toBe('fallback-id');
});

it('returns undefined if config has no orbiter key', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);
vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue({} as unknown as JunoConfig);

const id = await orbiterId({params: {}, mode: 'production'});
expect(id).toBeUndefined();
});

const id = await orbiterId({params: {}, mode: 'production'});
expect(id).toBe('orb-id');
it('returns undefined if config is undefined', async () => {
vi.spyOn(configLoader, 'junoConfigExist').mockResolvedValue(true);
vi.spyOn(configLoader, 'readJunoConfig').mockResolvedValue(
undefined as unknown as JunoConfig
);

const id = await orbiterId({params: {}, mode: 'production'});
expect(id).toBeUndefined();
});
});
});

Expand Down
26 changes: 25 additions & 1 deletion plugins/plugin-tools/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,36 @@ const containerSatelliteId = async ({mode}: ConfigArgs): Promise<string> => {

export const orbiterId = async (args: ConfigArgs): Promise<string | undefined> => {
if (useDockerContainer(args)) {
return undefined;
return await containerOrbiterId(args);
}

return await junoConfigOrbiterId(args);
};

const containerOrbiterId = async ({mode}: ConfigArgs): Promise<string | undefined> => {
const exist = await junoConfigExist();

if (!exist) {
return undefined;
}

const config = await readJunoConfig({mode});

if (config === undefined || !('orbiter' in config)) {
return undefined;
}

const {orbiter} = config;

if (orbiter === undefined) {
return undefined;
}

const {ids} = orbiter;

return ids?.[MODE_DEVELOPMENT];
};

const junoConfigOrbiterId = async (args: ConfigArgs): Promise<string | undefined> => {
await assertJunoConfig();

Expand Down