Skip to content

chore: track startup times #22

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
skyrpex merged 12 commits into from
Sep 4, 2025
Merged

chore: track startup times #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4eef0e8
chore: track extension startup times
skyrpex Sep 4, 2025
ae8bd5c
wip
skyrpex Sep 4, 2025
9138bcd
wip
skyrpex Sep 4, 2025
93932f9
wip
skyrpex Sep 4, 2025
a53a239
fix race conditions
skyrpex Sep 4, 2025
7e6ea8c
reuse time tracker helper
skyrpex Sep 4, 2025
f53816a
wip
skyrpex Sep 4, 2025
1ec6f76
Update src/extension.ts
skyrpex Sep 4, 2025
93c82fe
Update src/extension.ts
skyrpex Sep 4, 2025
62494cf
Update src/utils/setup-status.ts
skyrpex Sep 4, 2025
b224ef7
Update src/utils/setup-status.ts
skyrpex Sep 4, 2025
2d3628c
format
skyrpex Sep 4, 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
9 changes: 9 additions & 0 deletions package-lock.json
View file
Open in desktop

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

2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@
"@eslint/js": "^9.34.0",
"@types/fs-extra": "^11.0.4",
"@types/mocha": "^10.0.10",
"@types/ms": "^2.1.0",
"@types/node": "20.x",
"@types/vscode": "^1.83.0",
"@vscode/test-cli": "^0.0.11",
Expand All @@ -135,6 +136,7 @@
"eslint": "^9.34.0",
"eslint-plugin-import": "^2.32.0",
"fs-extra": "^11.3.1",
"ms": "^2.1.3",
"npm-run-all": "^4.1.5",
"p-min-delay": "^4.1.0",
"typescript": "^5.9.2",
Expand Down
99 changes: 74 additions & 25 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import ms from "ms";
import { StatusBarAlignment, window } from "vscode";
import type { ExtensionContext } from "vscode";

Expand All @@ -13,6 +14,7 @@ import { createLocalStackStatusTracker } from "./utils/localstack-status.ts";
import { getOrCreateExtensionSessionId } from "./utils/manage.ts";
import { createSetupStatusTracker } from "./utils/setup-status.ts";
import { createTelemetry } from "./utils/telemetry.ts";
import { createTimeTracker } from "./utils/time-tracker.ts";

const plugins = new PluginManager([
setup,
Expand All @@ -29,36 +31,83 @@ export async function activate(context: ExtensionContext) {
});
context.subscriptions.push(outputChannel);

const statusBarItem = window.createStatusBarItem(StatusBarAlignment.Left, -1);
context.subscriptions.push(statusBarItem);
statusBarItem.text = "$(loading~spin) LocalStack";
statusBarItem.show();
const timeTracker = createTimeTracker({ outputChannel });

const containerStatusTracker = await createContainerStatusTracker(
"localstack-main",
outputChannel,
);
context.subscriptions.push(containerStatusTracker);

const localStackStatusTracker = await createLocalStackStatusTracker(
containerStatusTracker,
outputChannel,
);
context.subscriptions.push(localStackStatusTracker);

const setupStatusTracker = await createSetupStatusTracker(outputChannel);

const sessionId = await getOrCreateExtensionSessionId(context);
const telemetry = createTelemetry(outputChannel, sessionId);

await plugins.activate({
context,
outputChannel,
statusBarItem,
const {
containerStatusTracker,
localStackStatusTracker,
setupStatusTracker,
statusBarItem,
telemetry,
} = await timeTracker.run("extension.dependencies", async () => {
const statusBarItem = window.createStatusBarItem(
StatusBarAlignment.Left,
-1,
);
context.subscriptions.push(statusBarItem);
statusBarItem.text = "$(loading~spin) LocalStack";
statusBarItem.show();

const containerStatusTracker = await createContainerStatusTracker(
"localstack-main",
outputChannel,
timeTracker,
);
context.subscriptions.push(containerStatusTracker);

const localStackStatusTracker = await createLocalStackStatusTracker(
containerStatusTracker,
outputChannel,
timeTracker,
);
context.subscriptions.push(localStackStatusTracker);

outputChannel.trace(`[setup-status]: Starting...`);
const startStatusTracker = Date.now();
const setupStatusTracker = await createSetupStatusTracker(
outputChannel,
timeTracker,
);
context.subscriptions.push(setupStatusTracker);
const endStatusTracker = Date.now();
outputChannel.trace(
`[setup-status]: Completed in ${ms(
endStatusTracker - startStatusTracker,
{ long: true },
)}`,
);

const startTelemetry = Date.now();
outputChannel.trace(`[telemetry]: Starting...`);
const sessionId = await getOrCreateExtensionSessionId(context);
const telemetry = createTelemetry(outputChannel, sessionId);
const endTelemetry = Date.now();
outputChannel.trace(
`[telemetry]: Completed in ${ms(endTelemetry - startTelemetry, {
long: true,
})}`,
);

return {
statusBarItem,
containerStatusTracker,
localStackStatusTracker,
setupStatusTracker,
telemetry,
};
});
Comment on lines +91 to +98
Copy link
Collaborator

@anisaoshafi anisaoshafi Sep 4, 2025

Choose a reason for hiding this comment

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

what is the reason of returning these now? 👀

Copy link
Collaborator Author

@skyrpex skyrpex Sep 4, 2025

Choose a reason for hiding this comment

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

statusBarItem, telemetry, etc. are now created inside of a timeTracker.run(...) callback, so they aren't available outside of the callback. To solve this, we take advantage of timeTracker.run(...) returning back the stuff from the callback.

	const {
		statusBarItem,
	} = await timeTracker.run("extension.dependencies", async () => {
		// Not available outside of this callback.
		const statusBarItem = window.createStatusBarItem(
			StatusBarAlignment.Left,
			-1,
		);
		// ...
		// Return them so they can be grabbed outside.
		return {
			statusBarItem,
		};
	});

Copy link
Collaborator

@anisaoshafi anisaoshafi Sep 4, 2025

Choose a reason for hiding this comment

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

got it, thanks for clarifying that!


await timeTracker.run("extension.activatePlugins", async () => {
await plugins.activate({
context,
outputChannel,
statusBarItem,
containerStatusTracker,
localStackStatusTracker,
setupStatusTracker,
telemetry,
timeTracker,
});
});
}

Expand Down
41 changes: 31 additions & 10 deletions src/plugins.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import ms from "ms";
import type { ExtensionContext, LogOutputChannel, StatusBarItem } from "vscode";

import type { ContainerStatusTracker } from "./utils/container-status.ts";
import type { LocalStackStatusTracker } from "./utils/localstack-status.ts";
import type { SetupStatusTracker } from "./utils/setup-status.ts";
import type { Telemetry } from "./utils/telemetry.ts";
import type { TimeTracker } from "./utils/time-tracker.ts";

export type Deactivate = () => Promise<void> | void;

Expand All @@ -15,40 +17,59 @@ export interface PluginOptions {
localStackStatusTracker: LocalStackStatusTracker;
setupStatusTracker: SetupStatusTracker;
telemetry: Telemetry;
timeTracker: TimeTracker;
}

export interface Plugin {
deactivate: Deactivate;
}

export type PluginFactory = (options: PluginOptions) => Promise<Plugin>;
export type PluginDefinition = {
name: string;
factory: (options: PluginOptions) => Promise<Plugin>;
};

export const createPlugin = (
name: string,
// biome-ignore lint/suspicious/noConfusingVoidType: required
handler: (options: PluginOptions) => Promise<Deactivate | void> | void,
): PluginFactory => {
return async (options) => {
const deactivate = (await handler(options)) ?? (() => {});
return {
deactivate,
};
): PluginDefinition => {
return {
name,
async factory(options: PluginOptions): Promise<Plugin> {
const deactivate = (await handler(options)) ?? (() => {});
return {
deactivate,
};
},
};
};

export class PluginManager {
private plugins: PluginFactory[];
private plugins: PluginDefinition[];

private deactivatables: Plugin[];

constructor(plugins: PluginFactory[]) {
constructor(plugins: PluginDefinition[]) {
this.plugins = plugins;
this.deactivatables = [];
}

async activate(options: PluginOptions) {
for (const activate of this.plugins) {
const deactivatable = await activate(options);
const startPlugin = Date.now();
options.outputChannel.trace(
`[extension.plugins]: Activating plugin "${activate.name}"...`,
);
const deactivatable = await activate.factory(options);
this.deactivatables.push(deactivatable);
const endPlugin = Date.now();
options.outputChannel.trace(
`[extension.plugins]: Activated plugin "${activate.name}" in ${ms(
endPlugin - startPlugin,
{ long: true },
)}`,
);
}
}

Expand Down
Loading