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.

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

Sm/review qa read unlock #1121

Merged
merged 11 commits into from
Aug 7, 2024
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
6 changes: 6 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ jobs:
windows-unit-tests:
needs: linux-unit-tests
uses: salesforcecli/github-workflows/.github/workflows/unitTestsWindows.yml@main
nuts:
needs: linux-unit-tests
uses: salesforcecli/github-workflows/.github/workflows/nut.yml@main

xNuts:
needs: linux-unit-tests
uses: salesforcecli/github-workflows/.github/workflows/externalNut.yml@main
Expand All @@ -40,6 +44,8 @@ jobs:
command: 'yarn test:nuts'
os: ${{ matrix.os }}
useCache: false
# remove the test folder for sfdx-core
preBuildCommands: 'shx rm -rf test'
preSwapCommands: 'yarn upgrade @jsforce/jsforce-node@latest; npx yarn-deduplicate; yarn install'
preExternalBuildCommands: 'shx rm -rf node_modules/@salesforce/core/node_modules/@jsforce/jsforce-node shx rm -rf node_modules/@salesforce/sf-plugins-core/node_modules/@salesforce/core node_modules/@salesforce/cli-plugins-testkit/node_modules/@salesforce/core node_modules/@salesforce/source-tracking/node_modules/@salesforce/core node_modules/@salesforce/source-deploy-retrieve/node_modules/@salesforce/core node_modules/@salesforce/apex-node/node_modules/@salesforce/core'
secrets: inherit
Expand Down
2 changes: 1 addition & 1 deletion .mocharc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"require": "test/init.js, ts-node/register, source-map-support/register",
"require": "ts-node/register, source-map-support/register",
"watch-extensions": "ts",
"watch-files": ["src", "test"],
"recursive": true,
Expand Down
2 changes: 1 addition & 1 deletion .sfdevrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"test": {
"testsPath": "test/**/*Test.ts"
"testsPath": "test/unit/**/*.test.ts"
},
"wireit": {
"compile": {
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
"prepack": "sf-prepack",
"prepare": "sf-install",
"test": "wireit",
"test:nuts": "mocha \"test/**/*.nut.ts\" --timeout 500000",
"test:only": "wireit",
"test:perf": "ts-node test/perf/logger/main.test.ts"
},
Expand Down Expand Up @@ -146,7 +147,7 @@
"output": []
},
"test:only": {
"command": "nyc mocha \"test/**/*Test.ts\"",
"command": "nyc mocha \"test/unit/**/*.test.ts\"",
"env": {
"FORCE_COLOR": "2"
},
Expand Down
43 changes: 12 additions & 31 deletions src/util/fileLocking.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ import * as fs from 'node:fs';
import { dirname } from 'node:path';
import { lock, lockSync, check, checkSync } from 'proper-lockfile';
import { Duration } from '@salesforce/kit';
import { retryDecorator } from 'ts-retry-promise';
import { SfError } from '../sfError';
import { Logger } from '../logger/logger';
import { PollingClient } from '../status/pollingClient';
import { StatusResult } from '../status/types';
import { lockOptions, lockRetryOptions } from './lockRetryOptions';

type LockInitResponse = { writeAndUnlock: (data: string) => Promise<void>; unlock: () => Promise<void> };
Expand Down Expand Up @@ -105,35 +104,17 @@ export const lockInitSync = (filePath: string): LockInitSyncResponse => {
* @param filePath file path to check
*/
export const pollUntilUnlock = async (filePath: string): Promise<void> => {
const options: PollingClient.Options = {
async poll(): Promise<StatusResult> {
try {
const locked = await check(filePath, lockRetryOptions);
return { completed: !locked, payload: 'File unlocked' };
} catch (e) {
if (e instanceof SfError) {
return { completed: true, payload: e.toObject() };
}
if (e instanceof Error) {
return {
completed: true,
payload: {
name: e.name,
message: e.message,
stack: e.stack,
},
};
}

return { completed: true, payload: 'Error occurred' };
}
},
frequency: Duration.milliseconds(10),
timeout: Duration.minutes(1),
};

const client = await PollingClient.create(options);
await client.subscribe();
try {
await retryDecorator(check, {
timeout: Duration.minutes(1).milliseconds,
delay: 10,
until: (locked) => locked === false,
// don't retry errors (typically enoent or access on the lockfile, therefore not locked)
retryIf: () => false,
})(filePath, lockRetryOptions);
} catch (e) {
// intentionally swallow the error, same reason as above
}
};

export const pollUntilUnlockSync = (filePath: string): void => {
Expand Down
8 changes: 0 additions & 8 deletions test/init.js

This file was deleted.

31 changes: 31 additions & 0 deletions test/nut/concurrencyConfig.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Copyright (c) 2023, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { tmpdir } from 'node:os';
import { ConfigFile } from '../../src';

export const FILENAME = 'concurrency.json';

export class TestConfig extends ConfigFile<ConfigFile.Options> {
public static getOptions(
filename: string,
isGlobal: boolean,
isState?: boolean,
filePath?: string
): ConfigFile.Options {
return {
rootFolder: tmpdir(),
filename,
isGlobal,
isState,
filePath,
};
}

public static getFileName() {
return FILENAME;
}
}
22 changes: 22 additions & 0 deletions test/nut/concurrencyReadWrite.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Copyright (c) 2023, salesforce.com, inc.
* All rights reserved.
* Licensed under the BSD 3-Clause license.
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
*/
import { join } from 'node:path';
import { expect } from 'chai'; // Add this line to import the expect function
import { TestConfig } from './concurrencyConfig';

const sharedLocation = join('sfdx-core-ut', 'test', 'configFile');

/** ex: `yarn ts-node test/nut/concurrencyReadWrite.ts 1` */
(async function (i: number = parseInt(process.argv[2], 10)) {
const config = new TestConfig(TestConfig.getOptions('test', true, true, sharedLocation));
config.set('x', i);
await config.write();
const readConfig = await config.read(true, true);
expect(readConfig.x).to.be.a('number');
})().catch((err) => {
throw err;
});
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,15 @@
import { join } from 'node:path';
import { tmpdir } from 'node:os';
import { rm } from 'node:fs/promises';
import { exec } from 'node:child_process';
import { promisify } from 'node:util';
import { expect } from 'chai';
import { sleep } from '@salesforce/kit';
import { ConfigFile } from '../../../src';
import { TestConfig, FILENAME } from './concurrencyConfig';

const FILENAME = 'concurrency.json';
const sharedLocation = join('sfdx-core-ut', 'test', 'configFile');
const execProm = promisify(exec);

class TestConfig extends ConfigFile<ConfigFile.Options> {
public static getOptions(
filename: string,
isGlobal: boolean,
isState?: boolean,
filePath?: string
): ConfigFile.Options {
return {
rootFolder: tmpdir(),
filename,
isGlobal,
isState,
filePath,
};
}

public static getFileName() {
return FILENAME;
}
}
const sharedLocation = join('sfdx-core-ut', 'test', 'configFile');

/* file and node - clock timestamps aren't precise enough to run in a UT.
* the goal of this and the `sleep` is to put a bit of space between operations
Expand Down Expand Up @@ -190,4 +172,15 @@ describe('concurrency', () => {
expect(config4.get('x')).to.be.greaterThanOrEqual(7).and.lessThanOrEqual(9);
}
});

it('safe reads on parallel writes', async () => {
const configOriginal = new TestConfig(TestConfig.getOptions('test', true, true, sharedLocation));
configOriginal.set('x', 0);
await configOriginal.write();
await sleep(SLEEP_FUDGE_MS);

await Promise.all(
Array.from({ length: 50 }).map((_, i) => execProm(`yarn ts-node test/nut/concurrencyReadWrite.ts ${i}`))
);
});
});
2 changes: 1 addition & 1 deletion test/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"extends": "@salesforce/dev-config/tsconfig-test-strict",
"include": ["unit/**/*.ts", "perf/**/*.ts"],
"include": ["nut/**/*.ts", "unit/**/*.ts", "perf/**/*.ts"],
"compilerOptions": {
"noEmit": true,
"skipLibCheck": true,
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ describe('TTLConfig', () => {
it('should return the latest entry', async () => {
const config = await TestConfig.create();
config.set('1', { one: 'one' });
await sleep(1000);
await sleep(200);
config.set('2', { two: 'two' });
const latest = config.getLatestEntry();
expect(latest).to.deep.equal(['2', config.get('2')]);
Expand All @@ -68,7 +68,7 @@ describe('TTLConfig', () => {
it('should return the key of the latest entry', async () => {
const config = await TestConfig.create();
config.set('1', { one: 'one' });
await sleep(1000);
await sleep(200);
config.set('2', { two: 'two' });
const latest = config.getLatestKey();
expect(latest).to.equal('2');
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions test/unit/loggerTest.ts → test/unit/logger/logger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

import { expect, config as chaiConfig } from 'chai';
import { isString } from '@salesforce/ts-types';
import { Logger, LoggerLevel, computeLevel } from '../../src/logger/logger';
import { shouldThrowSync, TestContext } from '../../src/testSetup';
import { Logger, LoggerLevel, computeLevel } from '../../../src/logger/logger';
import { shouldThrowSync, TestContext } from '../../../src/testSetup';

// NOTE: These tests still use 'await' which is how it use to work and were left to make
// sure we didn't regress the way they were used.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions test/unit/sfErrorTest.ts → test/unit/sfError.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ describe('SfError', () => {
it('returned `name:message` when no cause', () => {
const err = new SfError('test');
expect(inspect(err)).to.include('SfError: test');
expect(inspect(err)).to.include('sfErrorTest.ts');
expect(inspect(err)).to.include('sfError.test.ts');
// there's always 1 cause from the `cause:` property, even if undefined
expect(inspect(err)?.match(causeRegex)).to.have.lengthOf(1);
});
it('1 cause', () => {
const nestedError = new Error('nested');
const err = new SfError('test', undefined, undefined, nestedError);
expect(inspect(err)).to.include('SfError: test');
expect(inspect(err)).to.include('sfErrorTest.ts');
expect(inspect(err)).to.include('sfError.test.ts');
expect(inspect(err)).to.include('nested');
expect(inspect(err)?.match(causeRegex)).to.have.lengthOf(1);
expect(inspect(err)?.match(nestedCauseRegex)).to.be.null;
Expand All @@ -97,7 +97,7 @@ describe('SfError', () => {
const nestedError2 = new Error('nested2', { cause: nestedError });
const err = new SfError('test', undefined, undefined, nestedError2);
expect(inspect(err)).to.include('SfError: test');
expect(inspect(err)).to.include('sfErrorTest.ts');
expect(inspect(err)).to.include('sfError.test.ts');
expect(inspect(err)).to.include('nested');
expect(inspect(err)).to.include('nested2');
expect(inspect(err)?.match(causeRegex)).to.have.lengthOf(1);
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading