Skip to content

Commit

Permalink
chore(core): expose utility to determine if db cache is enabled (#28262)
Browse files Browse the repository at this point in the history
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

There is no function to determine if the db cache is enabled

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

There is a function to determine if the db cache is enabled.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
  • Loading branch information
FrozenPandaz authored Oct 3, 2024
1 parent 8c59a7e commit 84a5c7a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions packages/nx/src/tasks-runner/cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,17 @@ export type CachedResult = {
};
export type TaskWithCachedResult = { task: Task; cachedResult: CachedResult };

export function dbCacheEnabled(nxJson: NxJsonConfiguration = readNxJson()) {
return (
process.env.NX_DISABLE_DB !== 'true' &&
(nxJson.enableDbCache === true || process.env.NX_DB_CACHE === 'true')
);
}

// Do not change the order of these arguments as this function is used by nx cloud
export function getCache(options: DefaultTasksRunnerOptions): DbCache | Cache {
const nxJson = readNxJson();
return process.env.NX_DISABLE_DB !== 'true' &&
(nxJson.enableDbCache === true || process.env.NX_DB_CACHE === 'true')
return dbCacheEnabled(nxJson)
? new DbCache({
// Remove this in Nx 21
nxCloudRemoteCache: isNxCloudUsed(nxJson) ? options.remoteCache : null,
Expand Down

0 comments on commit 84a5c7a

Please sign in to comment.