paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

Remove unused context package

Browse Source 
Signed-off-by: Johan Haals <johan.haals@gmail.com>
This commit is contained in:
Johan Haals
2021-10-12 10:33:00 +02:00
parent ac7f177291
commit 37d131ab2f
6 changed files with 0 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/catalog-backend/src/next/Context/BackgroundContext.ts
-26
View File
@@ -1,26 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Context, ContextKey } from './types';
/**
* A base Context implementation that does not hold any value.
*/
export class BackgroundContext implements Context {
getContextValue<T>(key: ContextKey<T>): T {
return key.defaultValue;
}
}
plugins/catalog-backend/src/next/Context/ContextWithValue.ts
-39
View File
@@ -1,39 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Context, ContextKey } from './types';
/**
* A Context implementation that holds a single value, optionally extending an existing context.
*/
export class ContextWithValue implements Context {
static create(parent: Context, key: ContextKey<unknown>, value: unknown) {
return new ContextWithValue(parent, key, value);
}
private constructor(
private readonly parent: Context,
private readonly key: ContextKey<unknown>,
private readonly value: unknown,
) {}
getContextValue<T>(key: ContextKey<T>): T {
if (this.key === key) {
return this.value as T;
}
return this.parent.getContextValue(key);
}
}
plugins/catalog-backend/src/next/Context/TransactionValue.test.ts
-37
View File
@@ -1,37 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { TransactionValue } from './TransactionValue';
import { Knex } from 'knex';
import { BackgroundContext } from './BackgroundContext';
describe('TransactionValue Context', () => {
it('should be able to store tx values and retrieve them from a context', () => {
const tx = {} as Knex.Transaction;
const ctx = new BackgroundContext();
const nextCtx = TransactionValue.in(ctx, tx);
expect(TransactionValue.from(nextCtx)).toBe(tx);
});
it('should throw when there is no tx value in the context', () => {
const ctx = new BackgroundContext();
expect(() => TransactionValue.from(ctx)).toThrow(
/No transaction available in context/,
);
});
});
plugins/catalog-backend/src/next/Context/TransactionValue.ts
-40
View File
@@ -1,40 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Context, ContextKey } from './types';
import { Knex } from 'knex';
import { ContextWithValue } from './ContextWithValue';
const transactionContextKey = new ContextKey<Knex.Transaction | undefined>(
undefined,
);
/**
* TransactionValue handles the wrapping of a knex transaction in a Context.
*/
export class TransactionValue {
static in(parent: Context, tx: Knex.Transaction) {
return ContextWithValue.create(parent, transactionContextKey, tx);
}
static from(context: Context): Knex.Transaction {
const transaction = context.getContextValue(transactionContextKey);
if (!transaction) {
throw new Error(`No transaction available in context`);
}
return transaction;
}
}
plugins/catalog-backend/src/next/Context/index.ts
-21
View File
@@ -1,21 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { BackgroundContext } from './BackgroundContext';
export { ContextWithValue } from './ContextWithValue';
export { TransactionValue } from './TransactionValue';
export { ContextKey } from './types';
export type { Context } from './types';
plugins/catalog-backend/src/next/Context/types.ts
-23
View File
@@ -1,23 +0,0 @@
/*
* Copyright 2021 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export class ContextKey<T> {
constructor(readonly defaultValue: T) {}
}
export interface Context {
getContextValue<T>(key: ContextKey<T>): T;
}