From 9ac86154c8a5066e994d15e2145845df30fd951d Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 19:27:19 -0500 Subject: [PATCH 01/10] See if a text document provider helps --- src/extension.ts | 5 +++++ src/utils/listenToJob.ts | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/src/extension.ts b/src/extension.ts index e1619dd7..428e1b4d 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -7,6 +7,7 @@ import Delayer from './classes/Delayer'; import Job from './classes/Job'; import JobProvider from './classes/JobProvider'; import LicenseProvider from './classes/LicenseProvider'; +import LogProvider from './classes/LogProvider'; import { COMMITTED_IMAGE_NAMESPACE, CREATE_CONFIG_FILE_COMMAND, @@ -83,6 +84,10 @@ export function activate(context: vscode.ExtensionContext): void { vscode.commands.registerCommand(`${JOB_TREE_VIEW_ID}.refresh`, () => jobProvider.hardRefresh() ), + vscode.workspace.registerTextDocumentContentProvider( + 'local-ci.log', + new LogProvider() + ), vscode.commands.registerCommand(PROCESS_TRY_AGAIN_COMMAND, async () => { // There might have been a problem with the dynamic config file, so remove it. const dynamicConfig = getDynamicConfigPath( diff --git a/src/utils/listenToJob.ts b/src/utils/listenToJob.ts index 0a9d5bf1..d9bd3094 100644 --- a/src/utils/listenToJob.ts +++ b/src/utils/listenToJob.ts @@ -96,6 +96,11 @@ export default function listenToJob( handleExit(job, logFilePath, true); commitProcess.kill(); + const doc = await vscode.workspace.openTextDocument( + vscode.Uri.parse(`local-ci.log:${logFilePath}`) + ); + await vscode.window.showTextDocument(doc, { preview: true }); + if (doesJobCreateDynamicConfig) { jobProvider.hardRefresh(); const dynamicConfig = getConfigFromPath( From 4edef56a14008dab7d7aedcaa8e7006ff02d0009 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 19:48:03 -0500 Subject: [PATCH 02/10] Add a command to show the log file, and open the file when it runs --- src/classes/Log.ts | 3 ++- src/classes/LogProvider.ts | 8 ++++++++ src/constants/index.ts | 1 + src/extension.ts | 5 +++++ src/utils/listenToJob.ts | 14 +++----------- src/utils/showLogFile.ts | 8 ++++++++ 6 files changed, 27 insertions(+), 12 deletions(-) create mode 100644 src/classes/LogProvider.ts create mode 100644 src/utils/showLogFile.ts diff --git a/src/classes/Log.ts b/src/classes/Log.ts index cbb1ea97..da878055 100644 --- a/src/classes/Log.ts +++ b/src/classes/Log.ts @@ -1,4 +1,5 @@ import * as vscode from 'vscode'; +import { SHOW_LOG_FILE_COMMAND } from '../constants'; export default class Log extends vscode.TreeItem { constructor(public readonly label: string, public readonly filePath: string) { @@ -7,7 +8,7 @@ export default class Log extends vscode.TreeItem { this.collapsibleState = vscode.TreeItemCollapsibleState.None; this.command = { title: label, - command: 'vscode.open', + command: SHOW_LOG_FILE_COMMAND, tooltip, arguments: [filePath], }; diff --git a/src/classes/LogProvider.ts b/src/classes/LogProvider.ts new file mode 100644 index 00000000..22670dfe --- /dev/null +++ b/src/classes/LogProvider.ts @@ -0,0 +1,8 @@ +import * as fs from 'fs'; +import * as vscode from 'vscode'; + +export default class LogProvider implements vscode.TextDocumentContentProvider { + provideTextDocumentContent(uri: vscode.Uri): string { + return fs.readFileSync(uri.fsPath, 'utf8'); + } +} diff --git a/src/constants/index.ts b/src/constants/index.ts index c2c8d509..f594fdb3 100644 --- a/src/constants/index.ts +++ b/src/constants/index.ts @@ -56,6 +56,7 @@ export const DYNAMIC_CONFIG_PATH_IN_CONTAINER = path.join( export const HOST_TMP_DIRECTORY = '/tmp/local-ci'; // Also hard-coded in node/uninstall.js, change that if this changes. Be careful changing this, as there's an rm -rf for it. export const RUN_JOB_COMMAND = 'local-ci.job.run'; export const CREATE_CONFIG_FILE_COMMAND = 'local-ci.create.config'; +export const SHOW_LOG_FILE_COMMAND = 'local-ci.show.log-file'; export const CONTINUE_PIPELINE_STEP_NAME = 'Continue the pipeline'; export const SCHEDULE_INTERVIEW_URL = 'https://tidycal.com/localci/30-minute-meeting'; diff --git a/src/extension.ts b/src/extension.ts index 428e1b4d..e5695ef2 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -22,6 +22,7 @@ import { PROCESS_TRY_AGAIN_COMMAND, RUN_JOB_COMMAND, SELECTED_CONFIG_PATH, + SHOW_LOG_FILE_COMMAND, TELEMETRY_KEY, TRIAL_STARTED_TIMESTAMP, } from './constants'; @@ -39,6 +40,7 @@ import getStarterConfig from './utils/getStarterConfig'; import prepareConfig from './utils/prepareConfig'; import runJob from './utils/runJob'; import showLicenseInput from './utils/showLicenseInput'; +import showLogFile from './utils/showLogFile'; const reporter = new TelemetryReporter( EXTENSION_ID, @@ -390,6 +392,9 @@ export function activate(context: vscode.ExtensionContext): void { { detail: 'Starter config file' } ); jobProvider.hardRefresh(); + }), + vscode.commands.registerCommand(SHOW_LOG_FILE_COMMAND, (logFilePath) => { + showLogFile(logFilePath); }) ); diff --git a/src/utils/listenToJob.ts b/src/utils/listenToJob.ts index d9bd3094..53c072a3 100644 --- a/src/utils/listenToJob.ts +++ b/src/utils/listenToJob.ts @@ -8,6 +8,7 @@ import getConfigFilePath from './getConfigFilePath'; import getConfigFromPath from './getConfigFromPath'; import getDynamicConfigPath from './getDynamicConfigPath'; import getSpawnOptions from './getSpawnOptions'; +import showLogFile from './showLogFile'; function handleExit( job: Job | undefined, @@ -30,13 +31,9 @@ function handleExit( title: showJobOutput, } ) - .then(async (clicked) => { + .then((clicked) => { if (clicked?.title === showJobOutput) { - vscode.window.showTextDocument( - folderUri.with({ - path: logFilePath, - }) - ); + showLogFile(logFilePath); } }); } @@ -96,11 +93,6 @@ export default function listenToJob( handleExit(job, logFilePath, true); commitProcess.kill(); - const doc = await vscode.workspace.openTextDocument( - vscode.Uri.parse(`local-ci.log:${logFilePath}`) - ); - await vscode.window.showTextDocument(doc, { preview: true }); - if (doesJobCreateDynamicConfig) { jobProvider.hardRefresh(); const dynamicConfig = getConfigFromPath( diff --git a/src/utils/showLogFile.ts b/src/utils/showLogFile.ts new file mode 100644 index 00000000..d14dcb55 --- /dev/null +++ b/src/utils/showLogFile.ts @@ -0,0 +1,8 @@ +import * as vscode from 'vscode'; + +export default async function showLogFile(logFilePath: string): Promise { + const doc = await vscode.workspace.openTextDocument( + vscode.Uri.parse(`local-ci.log:${logFilePath}`) + ); + await vscode.window.showTextDocument(doc, { preview: true }); +} From f1a3e77244213689986defbcc249b1edc7aadda1 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 19:51:44 -0500 Subject: [PATCH 03/10] Remove 'Trending' badge It's been months since Local CI was trending. --- package.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/package.json b/package.json index a42a8edd..06e3356d 100644 --- a/package.json +++ b/package.json @@ -246,11 +246,6 @@ "href": "https://getlocalci.com/pricing/?utm_medium=extension&utm_source=badge", "description": "15 day free preview" }, - { - "url": "https://vsmarketplacebadge.apphb.com/trending-monthly/LocalCI.local-ci.svg?logo=tinder&color=orange&logoColor=white&label=trending%20monthly", - "href": "https://marketplace.visualstudio.com/items?itemName=LocalCI.local-ci", - "description": "Trending Monthly" - }, { "url": "https://img.shields.io/badge/platform-macOS-yellow", "href": "https://en.wikipedia.org/wiki/MacOS", From b2639141efd4f0725be3be2448d11facb61f8d1e Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 19:55:04 -0500 Subject: [PATCH 04/10] Remove uninstall of /tmp file on extension uninstall It's a tmp file, so it will be deleted anyway. This seems to have more risk than reward. --- node/binary.d.ts | 1 - node/uninstall.js | 3 --- package.json | 3 +-- src/constants/index.ts | 2 +- 4 files changed, 2 insertions(+), 7 deletions(-) delete mode 100644 node/uninstall.js diff --git a/node/binary.d.ts b/node/binary.d.ts index 3043d0e6..f94e7b57 100644 --- a/node/binary.d.ts +++ b/node/binary.d.ts @@ -1,3 +1,2 @@ export function install(): void; -export function uninstall(): void; export function getBinaryPath(): string; diff --git a/node/uninstall.js b/node/uninstall.js deleted file mode 100644 index 86ff432c..00000000 --- a/node/uninstall.js +++ /dev/null @@ -1,3 +0,0 @@ -const fs = require('fs'); - -fs.rmSync('/tmp/local-ci', { recursive: true, force: true }); diff --git a/package.json b/package.json index 06e3356d..c036e6ae 100644 --- a/package.json +++ b/package.json @@ -272,8 +272,7 @@ "pretest": "npm run test-compile && npm run lint", "lint": "eslint src --ext ts", "lint:fix": "eslint src --ext ts --fix", - "test": "node ./out/test/runTest.js", - "vscode:uninstall": "node ./node/uninstall" + "test": "node ./out/test/runTest.js" }, "devDependencies": { "@cloudflare/binary-install": "^0.2.0", diff --git a/src/constants/index.ts b/src/constants/index.ts index f594fdb3..1fbf725e 100644 --- a/src/constants/index.ts +++ b/src/constants/index.ts @@ -53,7 +53,7 @@ export const DYNAMIC_CONFIG_PATH_IN_CONTAINER = path.join( CONTAINER_STORAGE_DIRECTORY, DYNAMIC_CONFIG_FILE_NAME ); -export const HOST_TMP_DIRECTORY = '/tmp/local-ci'; // Also hard-coded in node/uninstall.js, change that if this changes. Be careful changing this, as there's an rm -rf for it. +export const HOST_TMP_DIRECTORY = '/tmp/local-ci'; export const RUN_JOB_COMMAND = 'local-ci.job.run'; export const CREATE_CONFIG_FILE_COMMAND = 'local-ci.create.config'; export const SHOW_LOG_FILE_COMMAND = 'local-ci.show.log-file'; From 8d670842f624f38498b073c63f95d2fe103692c0 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 21:24:24 -0500 Subject: [PATCH 05/10] Store the scheme in a constant --- src/constants/index.ts | 1 + src/extension.ts | 3 ++- src/utils/showLogFile.ts | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/constants/index.ts b/src/constants/index.ts index 1fbf725e..33f552ec 100644 --- a/src/constants/index.ts +++ b/src/constants/index.ts @@ -57,6 +57,7 @@ export const HOST_TMP_DIRECTORY = '/tmp/local-ci'; export const RUN_JOB_COMMAND = 'local-ci.job.run'; export const CREATE_CONFIG_FILE_COMMAND = 'local-ci.create.config'; export const SHOW_LOG_FILE_COMMAND = 'local-ci.show.log-file'; +export const LOG_SCHEME = 'local-ci-log'; export const CONTINUE_PIPELINE_STEP_NAME = 'Continue the pipeline'; export const SCHEDULE_INTERVIEW_URL = 'https://tidycal.com/localci/30-minute-meeting'; diff --git a/src/extension.ts b/src/extension.ts index e5695ef2..184fe0ce 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -19,6 +19,7 @@ import { HELP_URL, HOST_TMP_DIRECTORY, JOB_TREE_VIEW_ID, + LOG_SCHEME, PROCESS_TRY_AGAIN_COMMAND, RUN_JOB_COMMAND, SELECTED_CONFIG_PATH, @@ -87,7 +88,7 @@ export function activate(context: vscode.ExtensionContext): void { jobProvider.hardRefresh() ), vscode.workspace.registerTextDocumentContentProvider( - 'local-ci.log', + LOG_SCHEME, new LogProvider() ), vscode.commands.registerCommand(PROCESS_TRY_AGAIN_COMMAND, async () => { diff --git a/src/utils/showLogFile.ts b/src/utils/showLogFile.ts index d14dcb55..5be6594c 100644 --- a/src/utils/showLogFile.ts +++ b/src/utils/showLogFile.ts @@ -1,8 +1,9 @@ import * as vscode from 'vscode'; +import { LOG_SCHEME } from '../constants'; export default async function showLogFile(logFilePath: string): Promise { const doc = await vscode.workspace.openTextDocument( - vscode.Uri.parse(`local-ci.log:${logFilePath}`) + vscode.Uri.parse(`${LOG_SCHEME}:${logFilePath}`) ); await vscode.window.showTextDocument(doc, { preview: true }); } From 2397c49c21c2ab4c56bb145abd75832c007814b6 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 21:27:19 -0500 Subject: [PATCH 06/10] Remove a needless constant --- src/utils/showLogFile.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/utils/showLogFile.ts b/src/utils/showLogFile.ts index 5be6594c..51e94091 100644 --- a/src/utils/showLogFile.ts +++ b/src/utils/showLogFile.ts @@ -2,8 +2,9 @@ import * as vscode from 'vscode'; import { LOG_SCHEME } from '../constants'; export default async function showLogFile(logFilePath: string): Promise { - const doc = await vscode.workspace.openTextDocument( - vscode.Uri.parse(`${LOG_SCHEME}:${logFilePath}`) + await vscode.window.showTextDocument( + await vscode.workspace.openTextDocument( + vscode.Uri.parse(`${LOG_SCHEME}:${logFilePath}`) + ) ); - await vscode.window.showTextDocument(doc, { preview: true }); } From 144ea4b2e466eb58de6529e9ccb46cdfb874a1a9 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 21:29:37 -0500 Subject: [PATCH 07/10] Rename constant to LOG_FILE_SCHEME --- src/constants/index.ts | 2 +- src/extension.ts | 4 ++-- src/utils/showLogFile.ts | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/constants/index.ts b/src/constants/index.ts index 33f552ec..8f835636 100644 --- a/src/constants/index.ts +++ b/src/constants/index.ts @@ -57,7 +57,7 @@ export const HOST_TMP_DIRECTORY = '/tmp/local-ci'; export const RUN_JOB_COMMAND = 'local-ci.job.run'; export const CREATE_CONFIG_FILE_COMMAND = 'local-ci.create.config'; export const SHOW_LOG_FILE_COMMAND = 'local-ci.show.log-file'; -export const LOG_SCHEME = 'local-ci-log'; +export const LOG_FILE_SCHEME = 'local-ci-log'; export const CONTINUE_PIPELINE_STEP_NAME = 'Continue the pipeline'; export const SCHEDULE_INTERVIEW_URL = 'https://tidycal.com/localci/30-minute-meeting'; diff --git a/src/extension.ts b/src/extension.ts index 184fe0ce..7bb6abce 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -19,7 +19,7 @@ import { HELP_URL, HOST_TMP_DIRECTORY, JOB_TREE_VIEW_ID, - LOG_SCHEME, + LOG_FILE_SCHEME, PROCESS_TRY_AGAIN_COMMAND, RUN_JOB_COMMAND, SELECTED_CONFIG_PATH, @@ -88,7 +88,7 @@ export function activate(context: vscode.ExtensionContext): void { jobProvider.hardRefresh() ), vscode.workspace.registerTextDocumentContentProvider( - LOG_SCHEME, + LOG_FILE_SCHEME, new LogProvider() ), vscode.commands.registerCommand(PROCESS_TRY_AGAIN_COMMAND, async () => { diff --git a/src/utils/showLogFile.ts b/src/utils/showLogFile.ts index 51e94091..c9a6725e 100644 --- a/src/utils/showLogFile.ts +++ b/src/utils/showLogFile.ts @@ -1,10 +1,10 @@ import * as vscode from 'vscode'; -import { LOG_SCHEME } from '../constants'; +import { LOG_FILE_SCHEME } from '../constants'; export default async function showLogFile(logFilePath: string): Promise { await vscode.window.showTextDocument( await vscode.workspace.openTextDocument( - vscode.Uri.parse(`${LOG_SCHEME}:${logFilePath}`) + vscode.Uri.parse(`${LOG_FILE_SCHEME}:${logFilePath}`) ) ); } From 060723c671e495503ddd6942a37c26bda2556974 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 21:31:21 -0500 Subject: [PATCH 08/10] Bump price to per month --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27deaa17..0e6233ac 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Find out in seconds whether the setup is right, all in your local. ## License Key -Local CI requires a [license key](https://getlocalci.com/pricing/?utm_medium=extension&utm_source=readme) for $10 per month. +Local CI requires a [license key](https://getlocalci.com/pricing/?utm_medium=extension&utm_source=readme) for $15 per month. But first you'll get a free 15-day preview, no sign-up or credit card needed. From bfcb0ecc56acdc91a7de37d5196f3df40ec15ead Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 21:54:13 -0500 Subject: [PATCH 09/10] Add support for Linux arm64 --- node/binary.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/node/binary.js b/node/binary.js index eb86b791..5545e4e4 100644 --- a/node/binary.js +++ b/node/binary.js @@ -17,6 +17,11 @@ const supportedPlatforms = [ architecture: "x64", url: "https://github.com/CircleCI-Public/circleci-cli/releases/download/v0.1.17554/circleci-cli_0.1.17554_linux_amd64.tar.gz", }, + { + type: "Linux", + architecture: "arm64", + url: "https://github.com/CircleCI-Public/circleci-cli/releases/download/v0.1.17554/circleci-cli_0.1.17554_linux_arm64.tar.gz", + }, { type: "Darwin", architecture: "x64", From 756b856055de6f69a8e4f54a3a90a077413121b2 Mon Sep 17 00:00:00 2001 From: Ryan Kienstra Date: Fri, 13 May 2022 22:27:20 -0500 Subject: [PATCH 10/10] Bump version to 1.6.3 and add a CHANGELOG entry --- CHANGELOG.md | 6 ++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b0601013..89301749 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 1.6.3 - 13 May 2022 + +### Added +- Improve log file UI, prevent editing. [#115](https://github.com/getlocalci/local-ci/pull/115) +- Possibly add support for Linux arm64. [#116](https://github.com/getlocalci/local-ci/pull/116) + ## 1.6.2 - 12 May 2022 ### Added diff --git a/package-lock.json b/package-lock.json index 7544c586..7e024751 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "local-ci", - "version": "1.6.2", + "version": "1.6.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "local-ci", - "version": "1.6.2", + "version": "1.6.3", "hasInstallScript": true, "license": "GPL-2.0-or-later", "os": [ diff --git a/package.json b/package.json index c036e6ae..14d9ac1e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "local-ci", "displayName": "Local CI", "description": "Debug CircleCI® workflows locally, with Bash access during and after. Free preview, then paid.", - "version": "1.6.2", + "version": "1.6.3", "publisher": "LocalCI", "contributors": [ "Ryan Kienstra"